1

/* $Id$ */

     2

     3

/** @file newgrf.cpp */

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

    13

#include "spritecache.h"

    14

#include "station.h"

    15

#include "sprite.h"

    16

#include "newgrf.h"

    17

#include "variables.h"

    18

#include "table/strings.h"

    19

#include "bridge.h"

    20

#include "town.h"

    21

#include "newgrf_engine.h"

    22

#include "newgrf_text.h"

    23

#include "table/sprites.h"

    24

#include "fontcache.h"

    25

#include "currency.h"

    26

#include "landscape.h"

    27

#include "newgrf_config.h"

    28

#include "newgrf_house.h"

    29

#include "newgrf_sound.h"

    30

#include "newgrf_spritegroup.h"

    31

#include "table/town_land.h"

    32

#include "cargotype.h"

    33

#include "industry.h"

    34

#include "newgrf_canal.h"

    35

#include "table/build_industry.h"

    36

#include "newgrf_commons.h"

    37

#include "newgrf_townname.h"

    38

#include "newgrf_industries.h"

    39

#include "table/landscape_sprite.h"

    40

#include "gfxinit.h"

    41

#include "fios.h"

    49

    50

/* TTDPatch extended GRF format codec

    51

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

    52

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

    53

 *

    54

 * Contains portions of documentation by TTDPatch team.

    55

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

    56

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

    57

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

    58

    59

    60

static int _skip_sprites; // XXX

    61

static uint _file_index; // XXX

    62

    63

static GRFFile *_cur_grffile;

    64

GRFFile *_first_grffile;

    65

static SpriteID _cur_spriteid;

    66

static GrfLoadingStage _cur_stage;

    67

static uint32 _nfo_line;

    68

    69

static GRFConfig *_cur_grfconfig;

    70

    71

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

    72

static byte _misc_grf_features = 0;

    73

    74

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

    75

static uint32 _ttdpatch_flags[8];

    76

    77

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

    78

static byte *_preload_sprite = NULL;

    79

    80

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

    81

GRFLoadedFeatures _loaded_newgrf_features;

    82

    83

enum GrfDataType {

    84

	GDT_SOUND,

    85

};

    86

    87

static byte _grf_data_blocks;

    88

static GrfDataType _grf_data_type;

    89

    90

    91

enum grfspec_feature {

    92

	GSF_TRAIN,

    93

	GSF_ROAD,

    94

	GSF_SHIP,

    95

	GSF_AIRCRAFT,

    96

	GSF_STATION,

    97

	GSF_CANAL,

    98

	GSF_BRIDGE,

    99

	GSF_TOWNHOUSE,

   100

	GSF_GLOBALVAR,

   101

	GSF_INDUSTRYTILES,

   102

	GSF_INDUSTRIES,

   103

	GSF_CARGOS,

   104

	GSF_SOUNDFX,

   105

};

   106

   107

   108

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

   109

   110

static const uint _vehcounts[4] = {

   111

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

   112

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

   113

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

   114

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

   115

};

   116

   117

static const uint _vehshifts[4] = {

   118

	/* GSF_TRAIN */    0,

   119

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

   120

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

   121

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

   122

};

   123

   124

enum {

   125

	MAX_STATIONS = 256,

   126

};

   127

   128

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

   129

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

   130

   131

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

   132

static uint32 _grm_engines[TOTAL_NUM_ENGINES];

   133

   134

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

   135

static uint32 _grm_cargos[NUM_CARGO];

   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(int real, int 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

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

   241

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

   242

 * @param grfid Id of the grf file

   243

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

   244

 * @return the properly adjusted StringID

   245

 */

   246

StringID MapGRFStringID(uint32 grfid, StringID str)

   247

{

   248

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

   249

	static StringID units_volume[] = {

   250

		STR_NOTHING,    STR_PASSENGERS, STR_TONS,       STR_BAGS,

   251

		STR_LITERS,     STR_ITEMS,      STR_CRATES,     STR_TONS,

   252

		STR_TONS,       STR_TONS,       STR_TONS,       STR_BAGS,

   253

		STR_TONS,       STR_TONS,       STR_TONS,       STR_BAGS,

   254

		STR_TONS,       STR_TONS,       STR_BAGS,       STR_LITERS,

   255

		STR_TONS,       STR_LITERS,     STR_TONS,       STR_NOTHING,

   256

		STR_BAGS,       STR_LITERS,     STR_TONS,       STR_NOTHING,

   257

		STR_TONS,       STR_NOTHING,    STR_LITERS,     STR_NOTHING

   258

	};

   259

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

   260

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

   261

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

   262

	 * grfid in which they are declared */

   263

	if (GB(str, 8, 8) == 0xD0 || GB(str, 8, 8) == 0xDC) {

   264

		return GetGRFStringID(grfid, str);

   265

	}

   266

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

   267

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

   268

	TEXID_TO_STRINGID(0x000E, 0x002D, STR_000E);

   269

	TEXID_TO_STRINGID(0x002E, 0x004D, STR_002E);

   270

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

   271

	TEXID_TO_STRINGID(0x006E, 0x008D, STR_QUANTITY_NOTHING);

   272

	TEXID_TO_STRINGID(0x008E, 0x00AD, STR_ABBREV_NOTHING);

   273

   277

	TEXID_TO_STRINGID(0x200F, 0x201F, STR_200F_TALL_OFFICE_BLOCK);

   280

   281

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

   282

	TEXID_TO_STRINGID(0x482A, 0x483B, STR_482A_PRODUCTION_LAST_MONTH);

   283

#undef TEXTID_TO_STRINGID

   284

   285

	if (str == STR_NULL) return STR_EMPTY;

   286

   287

	return str;

   288

}

   289

   290

static uint8 MapDOSColour(uint8 colour)

   291

{

   292

	if (_use_dos_palette) return colour;

   293

   294

	if (colour < 10) {

   295

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

   296

		return dos_to_win_colour_map[colour];

   297

	}

   298

   299

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

   300

   301

	return colour;

   302

}

   303

   304

   305

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

   306

   307

static void dewagonize(int condition, int engine)

   308

{

   309

	EngineInfo *ei = &_engine_info[engine];

   310

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   311

   312

	if (condition != 0) {

   313

		ei->unk2 &= ~0x80;

   314

		if (rvi->railveh_type == RAILVEH_WAGON)

   315

			rvi->railveh_type = RAILVEH_SINGLEHEAD;

   316

	} else {

   317

		ei->unk2 |= 0x80;

   318

		rvi->railveh_type = RAILVEH_WAGON;

   319

	}

   320

}

   321

   322

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

   323

{

   324

	byte *buf = *bufp;

   325

	bool ret = false;

   326

   327

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

   328

		EngineInfo *ei       = &_engine_info[engine + i];

   329

		RailVehicleInfo *rvi = &_rail_vehicle_info[engine + i];

   330

   331

		switch (prop) {

   332

			case 0x05: { // Track type

   333

				uint8 tracktype = grf_load_byte(&buf);

   334

   335

				switch (tracktype) {

   336

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

   337

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

   338

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

   339

					default:

   340

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

   341

						break;

   342

				}

   343

			} break;

   344

   345

			case 0x08: // AI passenger service

   346

				/** @todo Tells the AI that this engine is designed for

   347

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

   348

				grf_load_byte(&buf);

   349

				ret = true;

   350

				break;

   351

   352

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

   353

				uint16 speed = grf_load_word(&buf);

   354

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

   355

   356

				rvi->max_speed = speed;

   357

			} break;

   358

   359

			case 0x0B: { // Power

   360

				uint16 power = grf_load_word(&buf);

   361

   362

				if (rvi->railveh_type == RAILVEH_MULTIHEAD) power /= 2;

   363

   364

				rvi->power = power;

   365

				dewagonize(power, engine + i);

   366

			} break;

   367

   368

			case 0x0D: { // Running cost factor

   369

				uint8 runcostfact = grf_load_byte(&buf);

   370

   371

				if (rvi->railveh_type == RAILVEH_MULTIHEAD) runcostfact /= 2;

   372

   373

				rvi->running_cost_base = runcostfact;

   374

			} break;

   375

   376

			case 0x0E: { // Running cost base

   377

				uint32 base = grf_load_dword(&buf);

   378

   379

				switch (base) {

   380

					case 0x4C30: rvi->running_cost_class = 0; break;

   381

					case 0x4C36: rvi->running_cost_class = 1; break;

   382

					case 0x4C3C: rvi->running_cost_class = 2; break;

   383

					case 0: break; // Used by wagons

   384

					default:

   385

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

   386

						break;

   387

				}

   388

			} break;

   389

   390

			case 0x12: { // Sprite ID

   391

				uint8 spriteid = grf_load_byte(&buf);

   392

   393

				/* TTD sprite IDs point to a location in a 16bit array, but we use it

   394

				 * as an array index, so we need it to be half the original value. */

   395

				if (spriteid < 0xFD) spriteid >>= 1;

   396

   397

				rvi->image_index = spriteid;

   398

			} break;

   399

   400

			case 0x13: { // Dual-headed

   401

				uint8 dual = grf_load_byte(&buf);

   402

   403

				if (dual != 0) {

   404

					if (rvi->railveh_type != RAILVEH_MULTIHEAD) {

   405

						// adjust power and running cost if needed

   406

						rvi->power /= 2;

   407

						rvi->running_cost_base /= 2;

   408

					}

   409

					rvi->railveh_type = RAILVEH_MULTIHEAD;

   410

				} else {

   411

					if (rvi->railveh_type == RAILVEH_MULTIHEAD) {

   412

						// adjust power and running cost if needed

   413

						rvi->power *= 2;

   414

						rvi->running_cost_base *= 2;

   415

					}

   416

					rvi->railveh_type = rvi->power == 0 ?

   417

						RAILVEH_WAGON : RAILVEH_SINGLEHEAD;

   418

				}

   419

			} break;

   420

   421

			case 0x14: // Cargo capacity

   422

				rvi->capacity = grf_load_byte(&buf);

   423

				break;

   424

   425

			case 0x15: { // Cargo type

   426

				uint8 ctype = grf_load_byte(&buf);

   427

   428

				if (ctype < NUM_CARGO && HasBit(_cargo_mask, ctype)) {

   429

					rvi->cargo_type = ctype;

   430

				} else {

   431

					rvi->cargo_type = CT_INVALID;

   432

					grfmsg(2, "RailVehicleChangeInfo: Invalid cargo type %d, using first refittable", ctype);

   433

				}

   434

			} break;

   435

   436

			case 0x16: // Weight

   437

				SB(rvi->weight, 0, 8, grf_load_byte(&buf));

   438

				break;

   439

   440

			case 0x17: // Cost factor

   441

				rvi->base_cost = grf_load_byte(&buf);

   442

				break;

   443

   444

			case 0x18: // AI rank

   445

				rvi->ai_rank = grf_load_byte(&buf);

   446

				break;

   447

   448

			case 0x19: { // Engine traction type

   449

				/* What do the individual numbers mean?

   450

				 * 0x00 .. 0x07: Steam

   451

				 * 0x08 .. 0x27: Diesel

   452

				 * 0x28 .. 0x31: Electric

   453

				 * 0x32 .. 0x37: Monorail

   454

				 * 0x38 .. 0x41: Maglev

   455

				 */

   456

				uint8 traction = grf_load_byte(&buf);

   457

				EngineClass engclass;

   458

   459

				if (traction <= 0x07) {

   460

					engclass = EC_STEAM;

   461

				} else if (traction <= 0x27) {

   462

					engclass = EC_DIESEL;

   463

				} else if (traction <= 0x31) {

   464

					engclass = EC_ELECTRIC;

   465

				} else if (traction <= 0x37) {

   466

					engclass = EC_MONORAIL;

   467

				} else if (traction <= 0x41) {

   468

					engclass = EC_MAGLEV;

   469

				} else {

   470

					break;

   471

				}

   472

				if (rvi->railtype == RAILTYPE_RAIL     && engclass >= EC_ELECTRIC) rvi->railtype = RAILTYPE_ELECTRIC;

   473

				if (rvi->railtype == RAILTYPE_ELECTRIC && engclass  < EC_ELECTRIC) rvi->railtype = RAILTYPE_RAIL;

   474

   475

				rvi->engclass = engclass;

   476

			} break;

   477

   478

			case 0x1A: { // Alter purchase list sort order

   479

				EngineID pos = grf_load_byte(&buf);

   480

   481

				if (pos < NUM_TRAIN_ENGINES) {

   482

					AlterRailVehListOrder(engine + i, pos);

   483

				} else {

   484

					grfmsg(2, "RailVehicleChangeInfo: Invalid train engine ID %d, ignoring", pos);

   485

				}

   486

			} break;

   487