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 "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

/* 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

};

   105

   106

/* Temporary data used when loading only */

   107

struct GRFTempEngineData {

   108

	uint16 cargo_allowed;

   109

	uint16 cargo_disallowed;

   110

};

   111

   112

static GRFTempEngineData *_gted;

   113

   114

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

   115

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

   116

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

   117

static uint32 _grm_engines[256];

   118

   119

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

   120

static uint32 _grm_cargos[NUM_CARGO * 2];

   121

   122

struct GRFLocation {

   123

	uint32 grfid;

   124

	uint32 nfoline;

   125

   126

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

   127

   128

	bool operator<(const GRFLocation &other) const

   129

	{

   130

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

   131

	}

   132

};

   133

   134

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

   135

   136

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

   137

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

   138

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

   139

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

   140

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

   141

 * is no file information available during that time.

   142

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

   143

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

   144

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

   145

{

   146

	char buf[1024];

   147

	va_list va;

   148

   149

	va_start(va, str);

   150

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

   151

	va_end(va);

   152

   153

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

   154

}

   155

   156

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

   157

{

   158

	if (real >= wanted) return true;

   159

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

   160

	return false;

   161

}

   162

   163

static inline byte grf_load_byte(byte **buf)

   164

{

   165

	return *(*buf)++;

   166

}

   167

   168

static uint16 grf_load_word(byte **buf)

   169

{

   170

	uint16 val = grf_load_byte(buf);

   171

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

   172

}

   173

   174

static uint16 grf_load_extended(byte** buf)

   175

{

   176

	uint16 val;

   177

	val = grf_load_byte(buf);

   178

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

   179

	return val;

   180

}

   181

   182

static uint32 grf_load_dword(byte **buf)

   183

{

   184

	uint32 val = grf_load_word(buf);

   185

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

   186

}

   187

   188

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

   189

{

   190

	switch (size) {

   191

		case 1: return grf_load_byte(buf);

   192

		case 2: return grf_load_word(buf);

   193

		case 4: return grf_load_dword(buf);

   194

		default:

   195

			NOT_REACHED();

   196

			return 0;

   197

	}

   198

}

   199

   200

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

   201

{

   202

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

   203

	size_t string_length = ttd_strnlen(string, max_len);

   204

   205

	if (string_length == max_len) {

   206

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

   207

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

   208

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

   209

	} else {

   210

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

   211

		string_length++;

   212

	}

   213

	*buf += string_length;

   214

   215

	return string;

   216

}

   217

   218

static GRFFile *GetFileByGRFID(uint32 grfid)

   219

{

   220

	GRFFile *file;

   221

   222

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

   223

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

   224

	}

   225

	return file;

   226

}

   227

   228

static GRFFile *GetFileByFilename(const char *filename)

   229

{

   230

	GRFFile *file;

   231

   232

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

   233

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

   234

	}

   235

	return file;

   236

}

   237

   238

   239

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

   240

StringIDToGRFIDMapping _string_to_grf_mapping;

   241

   242

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

   243

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

   244

 * @param grfid Id of the grf file

   245

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

   246

 * @return the properly adjusted StringID

   247

 */

   248

StringID MapGRFStringID(uint32 grfid, StringID str)

   249

{

   250

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

   251

	static StringID units_volume[] = {

   252

		STR_NOTHING,    STR_PASSENGERS, STR_TONS,       STR_BAGS,

   253

		STR_LITERS,     STR_ITEMS,      STR_CRATES,     STR_TONS,

   254

		STR_TONS,       STR_TONS,       STR_TONS,       STR_BAGS,

   255

		STR_TONS,       STR_TONS,       STR_TONS,       STR_BAGS,

   256

		STR_TONS,       STR_TONS,       STR_BAGS,       STR_LITERS,

   257

		STR_TONS,       STR_LITERS,     STR_TONS,       STR_NOTHING,

   258

		STR_BAGS,       STR_LITERS,     STR_TONS,       STR_NOTHING,

   259

		STR_TONS,       STR_NOTHING,    STR_LITERS,     STR_NOTHING

   260

	};

   261

   262

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

   263

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

   264

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

   265

	 * grfid in which they are declared */

   266

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

   267

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

   268

		case 0xDC:

   269

			return GetGRFStringID(grfid, str);

   270

   271

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

   272

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

   273

			 * explanation why...) */

   274

			return GetGRFStringID(grfid, str - 0x400);

   275

   276

		default: break;

   277

	}

   278

   279

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

   280

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

   281

	TEXID_TO_STRINGID(0x000E, 0x002D, STR_000E);

   282

	TEXID_TO_STRINGID(0x002E, 0x004D, STR_002E);

   283

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

   284

	TEXID_TO_STRINGID(0x006E, 0x008D, STR_QUANTITY_NOTHING);

   285

	TEXID_TO_STRINGID(0x008E, 0x00AD, STR_ABBREV_NOTHING);

   286

   287

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

   288

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

   289

	 * to use original house names. */

   290

	TEXID_TO_STRINGID(0x200F, 0x201F, STR_200F_TALL_OFFICE_BLOCK);

   291

	TEXID_TO_STRINGID(0x2036, 0x2041, STR_2036_COTTAGES);

   292

	TEXID_TO_STRINGID(0x2059, 0x205C, STR_2059_IGLOO);

   293

   294

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

   295

	TEXID_TO_STRINGID(0x482A, 0x483B, STR_482A_PRODUCTION_LAST_MONTH);

   296

#undef TEXTID_TO_STRINGID

   297

   298

	if (str == STR_NULL) return STR_EMPTY;

   299

   300

	return str;

   301

}

   302

   303

static uint8 MapDOSColour(uint8 colour)

   304

{

   305

	if (_use_dos_palette) return colour;

   306

   307

	if (colour < 10) {

   308

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

   309

		return dos_to_win_colour_map[colour];

   310

	}

   311

   312

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

   313

   314

	return colour;

   315

}

   316

   317

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

   318

   319

static void SetNewGRFOverride(uint32 source_grfid, uint32 target_grfid)

   320

{

   321

	_grf_id_overrides[source_grfid] = target_grfid;

   322

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

   323

}

   324

   325

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

   326

{

   327

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

   328

	 * them use the same engine slots. */

   329

	const GRFFile *grf_match = NULL;

   330

	if (_settings_game.vehicle.dynamic_engines) {

   331

		uint32 override = _grf_id_overrides[file->grfid];

   332

		if (override != 0) {

   333

			grf_match = GetFileByGRFID(override);

   334

			if (grf_match == NULL) {

   335

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

   336

			} else {

   337

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

   338

			}

   339

		}

   340

	}

   341

   342

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

   343

	Engine *e = NULL;

   344

	FOR_ALL_ENGINES(e) {

   345

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

   346

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

   347

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

   348

   349

		if (e->grffile == NULL) {

   350

			e->grffile = file;

   351

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

   352

		}

   353

		return e;

   354

	}

   355

   356

	uint engine_pool_size = GetEnginePoolSize();

   357

   358

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

   359

	e = new Engine(type, internal_id);

   360

	e->grffile = file;

   361

   362

	if (engine_pool_size != GetEnginePoolSize()) {

   363

		/* Resize temporary engine data ... */

   364

		_gted = ReallocT(_gted, GetEnginePoolSize());

   365

   366

		/* and blank the new block. */

   367

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

   368

		memset(_gted + engine_pool_size, 0, len);

   369

	}

   370

   371

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

   372

   373

	return e;

   374

}

   375

   376

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

   377

{

   378

	extern uint32 GetNewGRFOverride(uint32 grfid);

   379

   380

	const GRFFile *grf_match = NULL;

   381

	if (_settings_game.vehicle.dynamic_engines) {

   382

		uint32 override = _grf_id_overrides[file->grfid];

   383

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

   384

	}

   385

   386

	const Engine *e = NULL;

   387

	FOR_ALL_ENGINES(e) {

   388

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

   389

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

   390

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

   391

   392

		return e->index;

   393

	}

   394

   395

	return INVALID_ENGINE;

   396

}

   397

   398

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

   399

 * @param grf_sprite pointer to the structure been modified

   400

 */

   401

static void MapSpriteMappingRecolour(PalSpriteID *grf_sprite)

   402

{

   403

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

   404

		ClrBit(grf_sprite->pal, 14);

   405

		SetBit(grf_sprite->sprite, SPRITE_MODIFIER_OPAQUE);

   406

	}

   407

   408

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

   409

		ClrBit(grf_sprite->sprite, 14);

   410

		SetBit(grf_sprite->sprite, PALETTE_MODIFIER_TRANSPARENT);

   411

	}

   412

   413

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

   414

		ClrBit(grf_sprite->sprite, 15);

   415

		SetBit(grf_sprite->sprite, PALETTE_MODIFIER_COLOR);

   416

	}

   417

}

   418

   419

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

   420

   421

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

   422

{

   423

	byte *buf = *bufp;

   424

	bool ret = false;

   425

   426

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

   427

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

   428

		EngineInfo *ei = &e->info;

   429

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

   430

   431

		switch (prop) {

   432

			case 0x05: { // Track type

   433

				uint8 tracktype = grf_load_byte(&buf);

   434

   435

				switch (tracktype) {

   436

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

   437

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

   438

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

   439

					default:

   440

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

   441

						break;

   442

				}

   443

			} break;

   444

   445

			case 0x08: // AI passenger service

   446

				/* Tells the AI that this engine is designed for

   447

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

   448

				rvi->ai_passenger_only = grf_load_byte(&buf);

   449

				break;

   450

   451

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

   452

				uint16 speed = grf_load_word(&buf);

   453

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

   454

   455

				rvi->max_speed = speed;

   456

			} break;

   457

   458

			case 0x0B: // Power

   459

				rvi->power = grf_load_word(&buf);

   460

   461

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

   462

				if (rvi->power != 0) {

   463

					if (rvi->railveh_type == RAILVEH_WAGON) {

   464

						rvi->railveh_type = RAILVEH_SINGLEHEAD;

   465

					}

   466

				} else {

   467

					rvi->railveh_type = RAILVEH_WAGON;

   468

				}

   469

				break;

   470

   471

			case 0x0D: // Running cost factor

   472

				rvi->running_cost = grf_load_byte(&buf);

   473

				break;

   474

   475

			case 0x0E: { // Running cost base

   476

				uint32 base = grf_load_dword(&buf);

   477

   478

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

   479

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

   480

				 */

   481

				if (base == 0) {

   482

					rvi->running_cost_class = 0xFF;

   483

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

   484

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

   485

				} else {

   486

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

   487