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

    37

#include "gfxinit.h"

    38

#include "rev.h"

    39

#include "fios.h"

    40

#include "rail.h"

    41

#include "strings_func.h"

    42

#include "gfx_func.h"

    43

#include "date_func.h"

    44

#include "vehicle_func.h"

    45

#include "sound_func.h"

    46

#include "string_func.h"

    47

#include "road_func.h"

    48

#include "player_base.h"

    49

#include "settings_type.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

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

    87

static byte *_preload_sprite = NULL;

    88

    89

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

    90

GRFLoadedFeatures _loaded_newgrf_features;

    91

    92

enum GrfDataType {

    93

	GDT_SOUND,

    94

};

    95

    96

static byte _grf_data_blocks;

    97

static GrfDataType _grf_data_type;

    98

    99

   100

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

   101

   102

enum {

   103

	MAX_STATIONS = 256,

   104

	MAX_FSM_PORTS = 256,

   105

};

   106

   107

/* Temporary data used when loading only */

   108

struct GRFTempEngineData {

   109

	uint16 cargo_allowed;

   110

	uint16 cargo_disallowed;

   111

};

   112

   113

static GRFTempEngineData *_gted;

   114

   115

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

   116

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

   117

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

   118

static uint32 _grm_engines[256];

   119

   120

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

   121

static uint32 _grm_cargos[NUM_CARGO * 2];

   122

   123

struct GRFLocation {

   124

	uint32 grfid;

   125

	uint32 nfoline;

   126

   127

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

   128

   129

	bool operator<(const GRFLocation &other) const

   130

	{

   131

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

   132

	}

   133

};

   134

   135

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

   136

   137

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

   138

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

   139

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

   140

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

   141

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

   142

 * is no file information available during that time.

   143

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

   144

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

   145

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

   146

{

   147

	char buf[1024];

   148

	va_list va;

   149

   150

	va_start(va, str);

   151

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

   152

	va_end(va);

   153

   154

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

   155

}

   156

   157

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

   158

{

   159

	if (real >= wanted) return true;

   160

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

   161

	return false;

   162

}

   163

   164

static inline byte grf_load_byte(byte **buf)

   165

{

   166

	return *(*buf)++;

   167

}

   168

   169

static uint16 grf_load_word(byte **buf)

   170

{

   171

	uint16 val = grf_load_byte(buf);

   172

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

   173

}

   174

   175

static uint16 grf_load_extended(byte** buf)

   176

{

   177

	uint16 val;

   178

	val = grf_load_byte(buf);

   179

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

   180

	return val;

   181

}

   182

   183

static uint32 grf_load_dword(byte **buf)

   184

{

   185

	uint32 val = grf_load_word(buf);

   186

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

   187

}

   188

   189

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

   190

{

   191

	switch (size) {

   192

		case 1: return grf_load_byte(buf);

   193

		case 2: return grf_load_word(buf);

   194

		case 4: return grf_load_dword(buf);

   195

		default:

   196

			NOT_REACHED();

   197

			return 0;

   198

	}

   199

}

   200

   201

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

   202

{

   203

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

   204

	size_t string_length = ttd_strnlen(string, max_len);

   205

   206

	if (string_length == max_len) {

   207

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

   208

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

   209

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

   210

	} else {

   211

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

   212

		string_length++;

   213

	}

   214

	*buf += string_length;

   215

   216

	return string;

   217

}

   218

   219

static GRFFile *GetFileByGRFID(uint32 grfid)

   220

{

   221

	GRFFile *file;

   222

   223

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

   224

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

   225

	}

   226

	return file;

   227

}

   228

   229

static GRFFile *GetFileByFilename(const char *filename)

   230

{

   231

	GRFFile *file;

   232

   233

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

   234

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

   235

	}

   236

	return file;

   237

}

   238

   239

   240

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

   241

StringIDToGRFIDMapping _string_to_grf_mapping;

   242

   243

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

   244

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

   245

 * @param grfid Id of the grf file

   246

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

   247

 * @return the properly adjusted StringID

   248

 */

   249

StringID MapGRFStringID(uint32 grfid, StringID str)

   250

{

   251

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

   252

	static StringID units_volume[] = {

   253

		STR_NOTHING,    STR_PASSENGERS, STR_TONS,       STR_BAGS,

   254

		STR_LITERS,     STR_ITEMS,      STR_CRATES,     STR_TONS,

   255

		STR_TONS,       STR_TONS,       STR_TONS,       STR_BAGS,

   256

		STR_TONS,       STR_TONS,       STR_TONS,       STR_BAGS,

   257

		STR_TONS,       STR_TONS,       STR_BAGS,       STR_LITERS,

   258

		STR_TONS,       STR_LITERS,     STR_TONS,       STR_NOTHING,

   259

		STR_BAGS,       STR_LITERS,     STR_TONS,       STR_NOTHING,

   260

		STR_TONS,       STR_NOTHING,    STR_LITERS,     STR_NOTHING

   261

	};

   262

   263

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

   264

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

   265

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

   266

	 * grfid in which they are declared */

   267

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

   268

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

   269

		case 0xDC:

   270

			return GetGRFStringID(grfid, str);

   271

   272

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

   273

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

   274

			 * explanation why...) */

   275

			return GetGRFStringID(grfid, str - 0x400);

   276

   277

		default: break;

   278

	}

   279

   280

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

   281

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

   282

	TEXID_TO_STRINGID(0x000E, 0x002D, STR_000E);

   283

	TEXID_TO_STRINGID(0x002E, 0x004D, STR_002E);

   284

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

   285

	TEXID_TO_STRINGID(0x006E, 0x008D, STR_QUANTITY_NOTHING);

   286

	TEXID_TO_STRINGID(0x008E, 0x00AD, STR_ABBREV_NOTHING);

   287

   288

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

   289

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

   290

	 * to use original house names. */

   291

	TEXID_TO_STRINGID(0x200F, 0x201F, STR_200F_TALL_OFFICE_BLOCK);

   292

	TEXID_TO_STRINGID(0x2036, 0x2041, STR_2036_COTTAGES);

   293

	TEXID_TO_STRINGID(0x2059, 0x205C, STR_2059_IGLOO);

   294

   295

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

   296

	TEXID_TO_STRINGID(0x482A, 0x483B, STR_482A_PRODUCTION_LAST_MONTH);

   297

#undef TEXTID_TO_STRINGID

   298

   299

	if (str == STR_NULL) return STR_EMPTY;

   300

   301

	return str;

   302

}

   303

   304

static uint8 MapDOSColour(uint8 colour)

   305

{

   306

	if (_use_dos_palette) return colour;

   307

   308

	if (colour < 10) {

   309

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

   310

		return dos_to_win_colour_map[colour];

   311

	}

   312

   313

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

   314

   315

	return colour;

   316

}

   317

   318

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

   319

   320

static void SetNewGRFOverride(uint32 source_grfid, uint32 target_grfid)

   321

{

   322

	_grf_id_overrides[source_grfid] = target_grfid;

   323

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

   324

}

   325

   326

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

   327

{

   328

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

   329

	 * them use the same engine slots. */

   330

	const GRFFile *grf_match = NULL;

   331

	if (_settings_game.vehicle.dynamic_engines) {

   332

		uint32 override = _grf_id_overrides[file->grfid];

   333

		if (override != 0) {

   334

			grf_match = GetFileByGRFID(override);

   335

			if (grf_match == NULL) {

   336

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

   337

			} else {

   338

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

   339

			}

   340

		}

   341

	}

   342

   343

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

   344

	Engine *e = NULL;

   345

	FOR_ALL_ENGINES(e) {

   346

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

   347

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

   348

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

   349

   350

		if (e->grffile == NULL) {

   351

			e->grffile = file;

   352

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

   353

		}

   354

		return e;

   355

	}

   356

   357

	uint engine_pool_size = GetEnginePoolSize();

   358

   359

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

   360

	e = new Engine(type, internal_id);

   361

	e->grffile = file;

   362

   363

	if (engine_pool_size != GetEnginePoolSize()) {

   364

		/* Resize temporary engine data ... */

   365

		_gted = ReallocT(_gted, GetEnginePoolSize());

   366

   367

		/* and blank the new block. */

   368

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

   369

		memset(_gted + engine_pool_size, 0, len);

   370

	}

   371

   372

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

   373

   374

	return e;

   375

}

   376

   377

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

   378

{

   379

	extern uint32 GetNewGRFOverride(uint32 grfid);

   380

   381

	const GRFFile *grf_match = NULL;

   382

	if (_settings_game.vehicle.dynamic_engines) {

   383

		uint32 override = _grf_id_overrides[file->grfid];

   384

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

   385

	}

   386

   387

	const Engine *e = NULL;

   388

	FOR_ALL_ENGINES(e) {

   389

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

   390

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

   391

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

   392

   393

		return e->index;

   394

	}

   395

   396

	return INVALID_ENGINE;

   397

}

   398

   399

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

   400

 * @param grf_sprite pointer to the structure been modified

   401

 */

   402

static void MapSpriteMappingRecolour(PalSpriteID *grf_sprite)

   403

{

   404

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

   405

		ClrBit(grf_sprite->pal, 14);

   406

		SetBit(grf_sprite->sprite, SPRITE_MODIFIER_OPAQUE);

   407

	}

   408

   409

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

   410

		ClrBit(grf_sprite->sprite, 14);

   411

		SetBit(grf_sprite->sprite, PALETTE_MODIFIER_TRANSPARENT);

   412

	}

   413

   414

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

   415

		ClrBit(grf_sprite->sprite, 15);

   416

		SetBit(grf_sprite->sprite, PALETTE_MODIFIER_COLOR);

   417

	}

   418

}

   419

   420

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

   421

   422

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

   423

{

   424

	byte *buf = *bufp;

   425

	bool ret = false;

   426

   427

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

   428

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

   429

		EngineInfo *ei = &e->info;

   430

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

   431

   432

		switch (prop) {

   433

			case 0x05: { // Track type

   434

				uint8 tracktype = grf_load_byte(&buf);

   435

   436

				switch (tracktype) {

   437

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

   438

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

   439

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

   440

					default:

   441

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

   442

						break;

   443

				}

   444

			} break;

   445

   446

			case 0x08: // AI passenger service

   447

				/* Tells the AI that this engine is designed for

   448

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

   449

				rvi->ai_passenger_only = grf_load_byte(&buf);

   450

				break;

   451

   452

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

   453

				uint16 speed = grf_load_word(&buf);

   454

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

   455

   456

				rvi->max_speed = speed;

   457

			} break;

   458

   459

			case 0x0B: // Power

   460

				rvi->power = grf_load_word(&buf);

   461

   462

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

   463

				if (rvi->power != 0) {

   464

					if (rvi->railveh_type == RAILVEH_WAGON) {

   465

						rvi->railveh_type = RAILVEH_SINGLEHEAD;

   466

					}

   467

				} else {

   468

					rvi->railveh_type = RAILVEH_WAGON;

   469

				}

   470

				break;

   471

   472

			case 0x0D: // Running cost factor

   473

				rvi->running_cost = grf_load_byte(&buf);

   474

				break;

   475

   476

			case 0x0E: { // Running cost base

   477

				uint32 base = grf_load_dword(&buf);

   478

   479

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

   480

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

   481

				 */

   482

				if (base == 0) {

   483

					rvi->running_cost_class = 0xFF;

   484

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

   485

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

   486

				} else {

   487

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

   488

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