1

/* $Id$ */

     2

     3

/** @file newgrf.cpp Base of all NewGRF support. */

     4

     5

#include "stdafx.h"

     6

     7

#include <stdarg.h>

     8

     9

#include "openttd.h"

    10

#include "debug.h"

    11

#include "fileio_func.h"

    12

#include "engine_func.h"

    13

#include "engine_base.h"

    14

#include "spritecache.h"

    15

#include "sprite.h"

    16

#include "newgrf.h"

    17

#include "variables.h"

    18

#include "bridge.h"

    19

#include "town.h"

    20

#include "newgrf_engine.h"

    21

#include "newgrf_text.h"

    22

#include "fontcache.h"

    23

#include "currency.h"

    24

#include "landscape.h"

    25

#include "newgrf_config.h"

    26

#include "newgrf_house.h"

    27

#include "newgrf_sound.h"

    28

#include "newgrf_spritegroup.h"

    29

#include "newgrf_station.h"

    30

#include "cargotype.h"

    31

#include "industry.h"

    32

#include "newgrf_canal.h"

    33

#include "newgrf_commons.h"

    34

#include "newgrf_townname.h"

    35

#include "newgrf_industries.h"

    36

#include "gfxinit.h"

    37

#include "rev.h"

    38

#include "fios.h"

    39

#include "rail.h"

    40

#include "strings_func.h"

    41

#include "gfx_func.h"

    42

#include "date_func.h"

    43

#include "vehicle_func.h"

    44

#include "sound_func.h"

    45

#include "string_func.h"

    46

#include "road_func.h"

    47

#include "company_base.h"

    48

#include "settings_type.h"

    49

#include "network/network.h"

    50

#include "map_func.h"

    51

#include <map>

    52

    53

#include "table/strings.h"

    54

#include "table/sprites.h"

    55

#include "table/town_land.h"

    56

#include "table/build_industry.h"

    57

#include "table/landscape_sprite.h"

    58

    59

/* TTDPatch extended GRF format codec

    60

 * (c) Petr Baudis 2004 (GPL'd)

    61

 * Changes by Florian octo Forster are (c) by the OpenTTD development team.

    62

 *

    63

 * Contains portions of documentation by TTDPatch team.

    64

 * Thanks especially to Josef Drexler for the documentation as well as a lot

    65

 * of help at #tycoon. Also thanks to Michael Blunck for is GRF files which

    66

 * served as subject to the initial testing of this codec. */

    67

    68

    69

static int _skip_sprites; // XXX

    70

static uint _file_index; // XXX

    71

    72

static GRFFile *_cur_grffile;

    73

GRFFile *_first_grffile;

    74

static SpriteID _cur_spriteid;

    75

static GrfLoadingStage _cur_stage;

    76

static uint32 _nfo_line;

    77

    78

static GRFConfig *_cur_grfconfig;

    79

    80

/* Miscellaneous GRF features, set by Action 0x0D, parameter 0x9E */

    81

static byte _misc_grf_features = 0;

    82

    83

/* 32 * 8 = 256 flags. Apparently TTDPatch uses this many.. */

    84

static uint32 _ttdpatch_flags[8];

    85

    86

/* Indicates which are the newgrf features currently loaded ingame */

    87

GRFLoadedFeatures _loaded_newgrf_features;

    88

    89

enum GrfDataType {

    90

	GDT_SOUND,

    91

};

    92

    93

static byte _grf_data_blocks;

    94

static GrfDataType _grf_data_type;

    95

    96

    97

typedef void (*SpecialSpriteHandler)(byte *buf, size_t len);

    98

    99

enum {

   100

	MAX_STATIONS = 256,

   101

};

   102

   103

/* Temporary data used when loading only */

   104

struct GRFTempEngineData {

   105

	uint16 cargo_allowed;

   106

	uint16 cargo_disallowed;

   107

};

   108

   109

static GRFTempEngineData *_gted;

   110

   111

/* Contains the GRF ID of the owner of a vehicle if it has been reserved.

   112

 * GRM for vehicles is only used if dynamic engine allocation is disabled,

   113

 * so 256 is the number of original engines. */

   114

static uint32 _grm_engines[256];

   115

   116

/* Contains the GRF ID of the owner of a cargo if it has been reserved */

   117

static uint32 _grm_cargos[NUM_CARGO * 2];

   118

   119

struct GRFLocation {

   120

	uint32 grfid;

   121

	uint32 nfoline;

   122

   123

	GRFLocation(uint32 grfid, uint32 nfoline) : grfid(grfid), nfoline(nfoline) { }

   124

   125

	bool operator<(const GRFLocation &other) const

   126

	{

   127

		return this->grfid < other.grfid || (this->grfid == other.grfid && this->nfoline < other.nfoline);

   128

	}

   129

   130

	bool operator==(const GRFLocation &other) const

   131

	{

   132

		return this->grfid == other.grfid && this->nfoline == other.nfoline;

   133

	}

   134

};

   135

   136

static std::map<GRFLocation, SpriteID> _grm_sprites;

   137

typedef std::map<GRFLocation, byte*> GRFLineToSpriteOverride;

   138

GRFLineToSpriteOverride _grf_line_to_action6_sprite_override;

   139

   140

/** DEBUG() function dedicated to newGRF debugging messages

   141

 * Function is essentialy the same as DEBUG(grf, severity, ...) with the

   142

 * addition of file:line information when parsing grf files.

   143

 * NOTE: for the above reason(s) grfmsg() should ONLY be used for

   144

 * loading/parsing grf files, not for runtime debug messages as there

   145

 * is no file information available during that time.

   146

 * @param severity debugging severity level, see debug.h

   147

 * @param str message in printf() format */

   148

void CDECL grfmsg(int severity, const char *str, ...)

   149

{

   150

	char buf[1024];

   151

	va_list va;

   152

   153

	va_start(va, str);

   154

	vsnprintf(buf, sizeof(buf), str, va);

   155

	va_end(va);

   156

   157

	DEBUG(grf, severity, "[%s:%d] %s", _cur_grfconfig->filename, _nfo_line, buf);

   158

}

   159

   160

static inline bool check_length(size_t real, size_t wanted, const char *str)

   161

{

   162

	if (real >= wanted) return true;

   163

	grfmsg(0, "%s: Invalid pseudo sprite length %d (expected %d)!", str, real, wanted);

   164

	return false;

   165

}

   166

   167

static inline byte grf_load_byte(byte **buf)

   168

{

   169

	return *(*buf)++;

   170

}

   171

   172

static uint16 grf_load_word(byte **buf)

   173

{

   174

	uint16 val = grf_load_byte(buf);

   175

	return val | (grf_load_byte(buf) << 8);

   176

}

   177

   178

static uint16 grf_load_extended(byte** buf)

   179

{

   180

	uint16 val;

   181

	val = grf_load_byte(buf);

   182

	if (val == 0xFF) val = grf_load_word(buf);

   183

	return val;

   184

}

   185

   186

static uint32 grf_load_dword(byte **buf)

   187

{

   188

	uint32 val = grf_load_word(buf);

   189

	return val | (grf_load_word(buf) << 16);

   190

}

   191

   192

static uint32 grf_load_var(byte size, byte **buf)

   193

{

   194

	switch (size) {

   195

		case 1: return grf_load_byte(buf);

   196

		case 2: return grf_load_word(buf);

   197

		case 4: return grf_load_dword(buf);

   198

		default:

   199

			NOT_REACHED();

   200

			return 0;

   201

	}

   202

}

   203

   204

static const char *grf_load_string(byte **buf, size_t max_len)

   205

{

   206

	const char *string   = *(const char **)buf;

   207

	size_t string_length = ttd_strnlen(string, max_len);

   208

   209

	if (string_length == max_len) {

   210

		/* String was not NUL terminated, so make sure it is now. */

   211

		(*buf)[string_length - 1] = '\0';

   212

		grfmsg(7, "String was not terminated with a zero byte.");

   213

	} else {

   214

		/* Increase the string length to include the NUL byte. */

   215

		string_length++;

   216

	}

   217

	*buf += string_length;

   218

   219

	return string;

   220

}

   221

   222

static GRFFile *GetFileByGRFID(uint32 grfid)

   223

{

   224

	GRFFile *file;

   225

   226

	for (file = _first_grffile; file != NULL; file = file->next) {

   227

		if (file->grfid == grfid) break;

   228

	}

   229

	return file;

   230

}

   231

   232

static GRFFile *GetFileByFilename(const char *filename)

   233

{

   234

	GRFFile *file;

   235

   236

	for (file = _first_grffile; file != NULL; file = file->next) {

   237

		if (strcmp(file->filename, filename) == 0) break;

   238

	}

   239

	return file;

   240

}

   241

   242

/** Reset all NewGRFData that was used only while processing data */

   243

static void ClearTemporaryNewGRFData()

   244

{

   245

	/* Clear the GOTO labels used for GRF processing */

   246

	for (GRFLabel *l = _cur_grffile->label; l != NULL;) {

   247

		GRFLabel *l2 = l->next;

   248

		free(l);

   249

		l = l2;

   250

	}

   251

	_cur_grffile->label = NULL;

   252

   253

	/* Clear the list of spritegroups */

   254

	free(_cur_grffile->spritegroups);

   255

	_cur_grffile->spritegroups = NULL;

   256

	_cur_grffile->spritegroups_count = 0;

   257

}

   258

   259

   260

typedef std::map<StringID *, uint32> StringIDToGRFIDMapping;

   261

StringIDToGRFIDMapping _string_to_grf_mapping;

   262

   263

/** Used when setting an object's property to map to the GRF's strings

   264

 * while taking in consideration the "drift" between TTDPatch string system and OpenTTD's one

   265

 * @param grfid Id of the grf file

   266

 * @param str StringID that we want to have the equivalent in OoenTTD

   267

 * @return the properly adjusted StringID

   268

 */

   269

StringID MapGRFStringID(uint32 grfid, StringID str)

   270

{

   271

	/* StringID table for TextIDs 0x4E->0x6D */

   272

	static StringID units_volume[] = {

   273

		STR_NOTHING,    STR_PASSENGERS, STR_TONS,       STR_BAGS,

   274

		STR_LITERS,     STR_ITEMS,      STR_CRATES,     STR_TONS,

   275

		STR_TONS,       STR_TONS,       STR_TONS,       STR_BAGS,

   276

		STR_TONS,       STR_TONS,       STR_TONS,       STR_BAGS,

   277

		STR_TONS,       STR_TONS,       STR_BAGS,       STR_LITERS,

   278

		STR_TONS,       STR_LITERS,     STR_TONS,       STR_NOTHING,

   279

		STR_BAGS,       STR_LITERS,     STR_TONS,       STR_NOTHING,

   280

		STR_TONS,       STR_NOTHING,    STR_LITERS,     STR_NOTHING

   281

	};

   282

   283

	/* 0xD0 and 0xDC stand for all the TextIDs in the range

   284

	 * of 0xD000 (misc graphics texts) and 0xDC00 (misc persistent texts).

   285

	 * These strings are unique to each grf file, and thus require to be used with the

   286

	 * grfid in which they are declared */

   287

	switch (GB(str, 8, 8)) {

   288

		case 0xD0: case 0xD1: case 0xD2: case 0xD3:

   289

		case 0xDC:

   290

			return GetGRFStringID(grfid, str);

   291

   292

		case 0xD4: case 0xD5: case 0xD6: case 0xD7:

   293

			/* Strings embedded via 0x81 have 0x400 added to them (no real

   294

			 * explanation why...) */

   295

			return GetGRFStringID(grfid, str - 0x400);

   296

   297

		default: break;

   298

	}

   299

   300

#define TEXID_TO_STRINGID(begin, end, stringid) if (str >= begin && str <= end) return str + (stringid - begin)

   301

	/* We have some changes in our cargo strings, resulting in some missing. */

   302

	TEXID_TO_STRINGID(0x000E, 0x002D, STR_000E);

   303

	TEXID_TO_STRINGID(0x002E, 0x004D, STR_002E);

   304

	if (str >= 0x004E && str <= 0x006D) str = units_volume[str - 0x004E];

   305

	TEXID_TO_STRINGID(0x006E, 0x008D, STR_QUANTITY_NOTHING);

   306

	TEXID_TO_STRINGID(0x008E, 0x00AD, STR_ABBREV_NOTHING);

   307

   308

	/* Map building names according to our lang file changes. There are several

   309

	 * ranges of house ids, all of which need to be remapped to allow newgrfs

   310

	 * to use original house names. */

   311

	TEXID_TO_STRINGID(0x200F, 0x201F, STR_200F_TALL_OFFICE_BLOCK);

   312

	TEXID_TO_STRINGID(0x2036, 0x2041, STR_2036_COTTAGES);

   313

	TEXID_TO_STRINGID(0x2059, 0x205C, STR_2059_IGLOO);

   314

   315

	/* Same thing for industries, since the introduction of 4 new strings above STR_482A_PRODUCTION_LAST_MONTH */

   316

	TEXID_TO_STRINGID(0x482A, 0x483B, STR_482A_PRODUCTION_LAST_MONTH);

   317

#undef TEXTID_TO_STRINGID

   318

   319

	if (str == STR_NULL) return STR_EMPTY;

   320

   321

	return str;

   322

}

   323

   324

static inline uint8 MapDOSColour(uint8 colour)

   325

{

   326

	extern const byte _palmap_d2w[];

   327

	return (_use_palette == PAL_DOS ? colour : _palmap_d2w[colour]);

   328

}

   329

   330

static std::map<uint32, uint32> _grf_id_overrides;

   331

   332

static void SetNewGRFOverride(uint32 source_grfid, uint32 target_grfid)

   333

{

   334

	_grf_id_overrides[source_grfid] = target_grfid;

   335

	grfmsg(5, "SetNewGRFOverride: Added override of 0x%X to 0x%X", BSWAP32(source_grfid), BSWAP32(target_grfid));

   336

}

   337

   338

static Engine *GetNewEngine(const GRFFile *file, VehicleType type, uint16 internal_id)

   339

{

   340

	/* Hack for add-on GRFs that need to modify another GRF's engines. This lets

   341

	 * them use the same engine slots. */

   342

	const GRFFile *grf_match = NULL;

   343

	if (_settings_game.vehicle.dynamic_engines) {

   344

		uint32 override = _grf_id_overrides[file->grfid];

   345

		if (override != 0) {

   346

			grf_match = GetFileByGRFID(override);

   347

			if (grf_match == NULL) {

   348

				grfmsg(5, "Tried mapping from GRFID %x to %x but target is not loaded", BSWAP32(file->grfid), BSWAP32(override));

   349

			} else {

   350

				grfmsg(5, "Mapping from GRFID %x to %x", BSWAP32(file->grfid), BSWAP32(override));

   351

			}

   352

		}

   353

	}

   354

   355

	/* Check if this vehicle is already defined... */

   356

	Engine *e = NULL;

   357

	FOR_ALL_ENGINES(e) {

   358

		if (_settings_game.vehicle.dynamic_engines && e->grffile != NULL && e->grffile != file && e->grffile != grf_match) continue;

   359

		if (e->type != type) continue;

   360

		if (e->internal_id != internal_id) continue;

   361

   362

		if (e->grffile == NULL) {

   363

			e->grffile = file;

   364

			grfmsg(5, "Replaced engine at index %d for GRFID %x, type %d, index %d", e->index, BSWAP32(file->grfid), type, internal_id);

   365

		}

   366

		return e;

   367

	}

   368

   369

	uint engine_pool_size = GetEnginePoolSize();

   370

   371

	/* ... it's not, so create a new one based off an existing engine */

   372

	e = new Engine(type, internal_id);

   373

	e->grffile = file;

   374

   375

	if (engine_pool_size != GetEnginePoolSize()) {

   376

		/* Resize temporary engine data ... */

   377

		_gted = ReallocT(_gted, GetEnginePoolSize());

   378

   379

		/* and blank the new block. */

   380

		size_t len = (GetEnginePoolSize() - engine_pool_size) * sizeof(*_gted);

   381

		memset(_gted + engine_pool_size, 0, len);

   382

	}

   383

   384

	grfmsg(5, "Created new engine at index %d for GRFID %x, type %d, index %d", e->index, BSWAP32(file->grfid), type, internal_id);

   385

   386

	return e;

   387

}

   388

   389

EngineID GetNewEngineID(const GRFFile *file, VehicleType type, uint16 internal_id)

   390

{

   391

	extern uint32 GetNewGRFOverride(uint32 grfid);

   392

   393

	const GRFFile *grf_match = NULL;

   394

	if (_settings_game.vehicle.dynamic_engines) {

   395

		uint32 override = _grf_id_overrides[file->grfid];

   396

		if (override != 0) grf_match = GetFileByGRFID(override);

   397

	}

   398

   399

	const Engine *e = NULL;

   400

	FOR_ALL_ENGINES(e) {

   401

		if (_settings_game.vehicle.dynamic_engines && e->grffile != file && (grf_match == NULL || e->grffile != grf_match)) continue;

   402

		if (e->type != type) continue;

   403

		if (e->internal_id != internal_id) continue;

   404

   405

		return e->index;

   406

	}

   407

   408

	return INVALID_ENGINE;

   409

}

   410

   411

/** Map the colour modifiers of TTDPatch to those that Open is using.

   412

 * @param grf_sprite pointer to the structure been modified

   413

 */

   414

static void MapSpriteMappingRecolour(PalSpriteID *grf_sprite)

   415

{

   416

	if (HasBit(grf_sprite->pal, 14)) {

   417

		ClrBit(grf_sprite->pal, 14);

   418

		SetBit(grf_sprite->sprite, SPRITE_MODIFIER_OPAQUE);

   419

	}

   420

   421

	if (HasBit(grf_sprite->sprite, 14)) {

   422

		ClrBit(grf_sprite->sprite, 14);

   423

		SetBit(grf_sprite->sprite, PALETTE_MODIFIER_TRANSPARENT);

   424

	}

   425

   426

	if (HasBit(grf_sprite->sprite, 15)) {

   427

		ClrBit(grf_sprite->sprite, 15);

   428

		SetBit(grf_sprite->sprite, PALETTE_MODIFIER_COLOR);

   429

	}

   430

}

   431

   432

enum ChangeInfoResult {

   433

	CIR_SUCCESS,    ///< Variable was parsed and read

   434

	CIR_UNHANDLED,  ///< Variable was parsed but unread

   435

	CIR_UNKNOWN,    ///< Variable is unknown

   436

	CIR_INVALID_ID, ///< Attempt to modify an invalid ID

   437

};

   438

   439

typedef ChangeInfoResult (*VCI_Handler)(uint engine, int numinfo, int prop, byte **buf, int len);

   440

   441

static ChangeInfoResult CommonVehicleChangeInfo(EngineInfo *ei, int prop, byte **buf)

   442

{

   443

	switch (prop) {

   444

		case 0x00: // Introduction date

   445

			ei->base_intro = grf_load_word(buf) + DAYS_TILL_ORIGINAL_BASE_YEAR;

   446

			break;

   447

   448

		case 0x02: // Decay speed

   449

			ei->decay_speed = grf_load_byte(buf);

   450

			break;

   451

   452

		case 0x03: // Vehicle life

   453

			ei->lifelength = grf_load_byte(buf);

   454

			break;

   455

   456

		case 0x04: // Model life

   457

			ei->base_life = grf_load_byte(buf);

   458

			break;

   459

   460

		case 0x06: // Climates available

   461

			ei->climates = grf_load_byte(buf);

   462

			/* Sometimes a GRF wants hidden vehicles. Setting climates to

   463

			 * zero may cause the ID to be reallocated. */

   464

			if (ei->climates == 0) ei->climates = 0x80;

   465

			break;

   466

   467

		case 0x07: // Loading speed

   468

			/* Amount of cargo loaded during a vehicle's "loading tick" */

   469

			ei->load_amount = grf_load_byte(buf);

   470

			break;

   471

   472

		default:

   473

			return CIR_UNKNOWN;

   474

	}

   475

   476

	return CIR_SUCCESS;

   477

}

   478

   479

static ChangeInfoResult RailVehicleChangeInfo(uint engine, int numinfo, int prop, byte **bufp, int len)

   480

{

   481

	byte *buf = *bufp;

   482

	ChangeInfoResult ret = CIR_SUCCESS;

   483

   484

	for (int i = 0; i < numinfo; i++) {

   485

		Engine *e = GetNewEngine(_cur_grffile, VEH_TRAIN, engine + i);

   486

		EngineInfo *ei = &e->info;

   487

		RailVehicleInfo *rvi = &e->u.rail;

   488

   489

		switch (prop) {