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.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 "player_base.h"

    48

#include "settings_type.h"

    49

#include "map_func.h"

    50

#include <map>

    51

    52

#include "table/strings.h"

    53

#include "table/sprites.h"

    54

#include "table/town_land.h"

    55

#include "table/build_industry.h"

    56

#include "table/landscape_sprite.h"

    57

    58

/* TTDPatch extended GRF format codec

    59

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

    60

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

    61

 *

    62

 * Contains portions of documentation by TTDPatch team.

    63

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

    64

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

    65

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

    66

    67

    68

static int _skip_sprites; // XXX

    69

static uint _file_index; // XXX

    70

    71

static GRFFile *_cur_grffile;

    72

GRFFile *_first_grffile;

    73

static SpriteID _cur_spriteid;

    74

static GrfLoadingStage _cur_stage;

    75

static uint32 _nfo_line;

    76

    77

static GRFConfig *_cur_grfconfig;

    78

    79

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

    80

static byte _misc_grf_features = 0;

    81

    82

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

    83

static uint32 _ttdpatch_flags[8];

    84

    85

/* Used by Action 0x06 to preload a pseudo sprite and modify its content */

    86

static byte *_preload_sprite = NULL;

    87

    88

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

    89

GRFLoadedFeatures _loaded_newgrf_features;

    90

    91

enum GrfDataType {

    92

	GDT_SOUND,

    93

};

    94

    95

static byte _grf_data_blocks;

    96

static GrfDataType _grf_data_type;

    97

    98

    99

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

   100

   101

enum {

   102

	MAX_STATIONS = 256,

   103

};

   104

   105

/* Temporary data used when loading only */

   106

struct GRFTempEngineData {

   107

	uint16 cargo_allowed;

   108

	uint16 cargo_disallowed;

   109

};

   110

   111

static GRFTempEngineData *_gted;

   112

   113

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

   114

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

   115

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

   116

static uint32 _grm_engines[256];

   117

   118

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

   119

static uint32 _grm_cargos[NUM_CARGO * 2];

   120

   121

struct GRFLocation {

   122

	uint32 grfid;

   123

	uint32 nfoline;

   124

   125

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

   126

   127

	bool operator<(const GRFLocation &other) const

   128

	{

   129

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

   130

	}

   131

};

   132

   133

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

   134

   135

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

   136

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

   137

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

   138

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

   139

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

   140

 * is no file information available during that time.

   141

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

   142

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

   143

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

   144

{

   145

	char buf[1024];

   146

	va_list va;

   147

   148

	va_start(va, str);

   149

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

   150

	va_end(va);

   151

   152

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

   153

}

   154

   155

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

   156

{

   157

	if (real >= wanted) return true;

   158

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

   159

	return false;

   160

}

   161

   162

static inline byte grf_load_byte(byte **buf)

   163

{

   164

	return *(*buf)++;

   165

}

   166

   167

static uint16 grf_load_word(byte **buf)

   168

{

   169

	uint16 val = grf_load_byte(buf);

   170

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

   171

}

   172

   173

static uint16 grf_load_extended(byte** buf)

   174

{

   175

	uint16 val;

   176

	val = grf_load_byte(buf);

   177

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

   178

	return val;

   179

}

   180

   181

static uint32 grf_load_dword(byte **buf)

   182

{

   183

	uint32 val = grf_load_word(buf);

   184

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

   185

}

   186

   187

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

   188

{

   189

	switch (size) {

   190

		case 1: return grf_load_byte(buf);

   191

		case 2: return grf_load_word(buf);

   192

		case 4: return grf_load_dword(buf);

   193

		default:

   194

			NOT_REACHED();

   195

			return 0;

   196

	}

   197

}

   198

   199

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

   200

{

   201

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

   202

	size_t string_length = ttd_strnlen(string, max_len);

   203

   204

	if (string_length == max_len) {

   205

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

   206

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

   207

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

   208

	} else {

   209

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

   210

		string_length++;

   211

	}

   212

	*buf += string_length;

   213

   214

	return string;

   215

}

   216

   217

static GRFFile *GetFileByGRFID(uint32 grfid)

   218

{

   219

	GRFFile *file;

   220

   221

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

   222

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

   223

	}

   224

	return file;

   225

}

   226

   227

static GRFFile *GetFileByFilename(const char *filename)

   228

{

   229

	GRFFile *file;

   230

   231

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

   232

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

   233

	}

   234

	return file;

   235

}

   236

   237

   238

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

   239

StringIDToGRFIDMapping _string_to_grf_mapping;

   240

   241

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

   242

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

   243

 * @param grfid Id of the grf file

   244

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

   245

 * @return the properly adjusted StringID

   246

 */

   247

StringID MapGRFStringID(uint32 grfid, StringID str)

   248

{

   249

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

   250

	static StringID units_volume[] = {

   251

		STR_NOTHING,    STR_PASSENGERS, STR_TONS,       STR_BAGS,

   252

		STR_LITERS,     STR_ITEMS,      STR_CRATES,     STR_TONS,

   253

		STR_TONS,       STR_TONS,       STR_TONS,       STR_BAGS,

   254

		STR_TONS,       STR_TONS,       STR_TONS,       STR_BAGS,

   255

		STR_TONS,       STR_TONS,       STR_BAGS,       STR_LITERS,

   256

		STR_TONS,       STR_LITERS,     STR_TONS,       STR_NOTHING,

   257

		STR_BAGS,       STR_LITERS,     STR_TONS,       STR_NOTHING,

   258

		STR_TONS,       STR_NOTHING,    STR_LITERS,     STR_NOTHING

   259

	};

   260

   261

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

   262

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

   263

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

   264

	 * grfid in which they are declared */

   265

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

   266

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

   267

		case 0xDC:

   268

			return GetGRFStringID(grfid, str);

   269

   270

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

   271

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

   272

			 * explanation why...) */

   273

			return GetGRFStringID(grfid, str - 0x400);

   274

   275

		default: break;

   276

	}

   277

   278

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

   279

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

   280

	TEXID_TO_STRINGID(0x000E, 0x002D, STR_000E);

   281

	TEXID_TO_STRINGID(0x002E, 0x004D, STR_002E);

   282

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

   283

	TEXID_TO_STRINGID(0x006E, 0x008D, STR_QUANTITY_NOTHING);

   284

	TEXID_TO_STRINGID(0x008E, 0x00AD, STR_ABBREV_NOTHING);

   285

   286

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

   287

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

   288

	 * to use original house names. */

   289

	TEXID_TO_STRINGID(0x200F, 0x201F, STR_200F_TALL_OFFICE_BLOCK);

   290

	TEXID_TO_STRINGID(0x2036, 0x2041, STR_2036_COTTAGES);

   291

	TEXID_TO_STRINGID(0x2059, 0x205C, STR_2059_IGLOO);

   292

   293

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

   294

	TEXID_TO_STRINGID(0x482A, 0x483B, STR_482A_PRODUCTION_LAST_MONTH);

   295

#undef TEXTID_TO_STRINGID

   296

   297

	if (str == STR_NULL) return STR_EMPTY;

   298

   299

	return str;

   300

}

   301

   302

static uint8 MapDOSColour(uint8 colour)

   303

{

   304

	if (_use_dos_palette) return colour;

   305

   306

	if (colour < 10) {

   307

		static uint8 dos_to_win_colour_map[] = { 0, 215, 216, 136, 88, 106, 32, 33, 40, 245 };

   308

		return dos_to_win_colour_map[colour];

   309

	}

   310

   311

	if (colour >= 245 && colour < 254) return colour - 28;

   312

   313

	return colour;

   314

}

   315

   316

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

   317

   318

static void SetNewGRFOverride(uint32 source_grfid, uint32 target_grfid)

   319

{

   320

	_grf_id_overrides[source_grfid] = target_grfid;

   321

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

   322

}

   323

   324

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

   325

{

   326

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

   327

	 * them use the same engine slots. */

   328

	const GRFFile *grf_match = NULL;

   329

	if (_settings_game.vehicle.dynamic_engines) {

   330

		uint32 override = _grf_id_overrides[file->grfid];

   331

		if (override != 0) {

   332

			grf_match = GetFileByGRFID(override);

   333

			if (grf_match == NULL) {

   334

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

   335

			} else {

   336

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

   337

			}

   338

		}

   339

	}

   340

   341

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

   342

	Engine *e = NULL;

   343

	FOR_ALL_ENGINES(e) {

   344

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

   345

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

   346

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

   347

   348

		if (e->grffile == NULL) {

   349

			e->grffile = file;

   350

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

   351

		}

   352

		return e;

   353

	}

   354

   355

	uint engine_pool_size = GetEnginePoolSize();

   356

   357

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

   358

	e = new Engine(type, internal_id);

   359

	e->grffile = file;

   360

   361

	if (engine_pool_size != GetEnginePoolSize()) {

   362

		/* Resize temporary engine data ... */

   363

		_gted = ReallocT(_gted, GetEnginePoolSize());

   364

   365

		/* and blank the new block. */

   366

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

   367

		memset(_gted + engine_pool_size, 0, len);

   368

	}

   369

   370

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

   371

   372

	return e;

   373

}

   374

   375

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

   376

{

   377

	extern uint32 GetNewGRFOverride(uint32 grfid);

   378

   379

	const GRFFile *grf_match = NULL;

   380

	if (_settings_game.vehicle.dynamic_engines) {

   381

		uint32 override = _grf_id_overrides[file->grfid];

   382

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

   383

	}

   384

   385

	const Engine *e = NULL;

   386

	FOR_ALL_ENGINES(e) {

   387

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

   388

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

   389

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

   390

   391

		return e->index;

   392

	}

   393

   394

	return INVALID_ENGINE;

   395

}

   396

   397

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

   398

 * @param grf_sprite pointer to the structure been modified

   399

 */

   400

static void MapSpriteMappingRecolour(PalSpriteID *grf_sprite)

   401

{

   402

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

   403

		ClrBit(grf_sprite->pal, 14);

   404

		SetBit(grf_sprite->sprite, SPRITE_MODIFIER_OPAQUE);

   405

	}

   406

   407

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

   408

		ClrBit(grf_sprite->sprite, 14);

   409

		SetBit(grf_sprite->sprite, PALETTE_MODIFIER_TRANSPARENT);

   410

	}

   411

   412

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

   413

		ClrBit(grf_sprite->sprite, 15);

   414

		SetBit(grf_sprite->sprite, PALETTE_MODIFIER_COLOR);

   415

	}

   416

}

   417

   418

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

   419

   420

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

   421

{

   422

	byte *buf = *bufp;

   423

	bool ret = false;

   424

   425

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

   426

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

   427

		EngineInfo *ei = &e->info;

   428

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

   429

   430

		switch (prop) {

   431

			case 0x05: { // Track type

   432

				uint8 tracktype = grf_load_byte(&buf);

   433

   434

				switch (tracktype) {

   435

					case 0: rvi->railtype = rvi->engclass >= 2 ? RAILTYPE_ELECTRIC : RAILTYPE_RAIL; break;

   436

					case 1: rvi->railtype = RAILTYPE_MONO; break;

   437

					case 2: rvi->railtype = RAILTYPE_MAGLEV; break;

   438

					default:

   439

						grfmsg(1, "RailVehicleChangeInfo: Invalid track type %d specified, ignoring", tracktype);

   440

						break;

   441

				}

   442

			} break;

   443

   444

			case 0x08: // AI passenger service

   445

				/* Tells the AI that this engine is designed for

   446

				 * passenger services and shouldn't be used for freight. */

   447

				rvi->ai_passenger_only = grf_load_byte(&buf);

   448

				break;

   449

   450

			case 0x09: { // Speed (1 unit is 1 kmh)

   451

				uint16 speed = grf_load_word(&buf);

   452

				if (speed == 0xFFFF) speed = 0;

   453

   454

				rvi->max_speed = speed;

   455

			} break;

   456

   457

			case 0x0B: // Power

   458

				rvi->power = grf_load_word(&buf);

   459

   460

				/* Set engine / wagon state based on power */

   461

				if (rvi->power != 0) {

   462

					if (rvi->railveh_type == RAILVEH_WAGON) {

   463

						rvi->railveh_type = RAILVEH_SINGLEHEAD;

   464

					}

   465

				} else {

   466

					rvi->railveh_type = RAILVEH_WAGON;

   467

				}

   468

				break;

   469

   470

			case 0x0D: // Running cost factor

   471

				rvi->running_cost = grf_load_byte(&buf);

   472

				break;

   473

   474

			case 0x0E: { // Running cost base

   475

				uint32 base = grf_load_dword(&buf);

   476

   477

				/* These magic numbers are used in GRFs to specify the base cost:

   478

				 * http://wiki.ttdpatch.net/tiki-index.php?page=BaseCosts

   479

				 */

   480

				if (base == 0) {

   481

					rvi->running_cost_class = 0xFF;

   482

				} else if (base < 0x4B34 || base > 0x4C54 || (base - 0x4B34) % 6 != 0) {

   483

					grfmsg(1, "RailVehicleChangeInfo: Unsupported running cost base 0x%04X, ignoring", base);

   484

				} else {

   485

					/* Convert the magic number to an index into the price data */

   486

					rvi->running_cost_class = (base - 0x4B34) / 6;

   487

				}

   488

			} break;

   489