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"

    42

#include "rail.h"

    43

#include "strings_func.h"

    44

#include "gfx_func.h"

    45

#include "date_func.h"

    46

#include "vehicle_func.h"

    47

#include "sound_func.h"

    48

#include "string_func.h"

    49

#include "road_func.h"

    50

#include "player.h"

    51

    52

/* TTDPatch extended GRF format codec

    53

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

    54

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

    55

 *

    56

 * Contains portions of documentation by TTDPatch team.

    57

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

    58

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

    59

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

    60

    61

    62

static int _skip_sprites; // XXX

    63

static uint _file_index; // XXX

    64

    65

static GRFFile *_cur_grffile;

    66

GRFFile *_first_grffile;

    67

static SpriteID _cur_spriteid;

    68

static GrfLoadingStage _cur_stage;

    69

static uint32 _nfo_line;

    70

    71

static GRFConfig *_cur_grfconfig;

    72

    73

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

    74

static byte _misc_grf_features = 0;

    75

    76

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

    77

static uint32 _ttdpatch_flags[8];

    78

    79

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

    80

static byte *_preload_sprite = NULL;

    81

    82

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

    83

GRFLoadedFeatures _loaded_newgrf_features;

    84

    85

enum GrfDataType {

    86

	GDT_SOUND,

    87

};

    88

    89

static byte _grf_data_blocks;

    90

static GrfDataType _grf_data_type;

    91

    92

    93

enum grfspec_feature {

    94

	GSF_TRAIN,

    95

	GSF_ROAD,

    96

	GSF_SHIP,

    97

	GSF_AIRCRAFT,

    98

	GSF_STATION,

    99

	GSF_CANAL,

   100

	GSF_BRIDGE,

   101

	GSF_TOWNHOUSE,

   102

	GSF_GLOBALVAR,

   103

	GSF_INDUSTRYTILES,

   104

	GSF_INDUSTRIES,

   105

	GSF_CARGOS,

   106

	GSF_SOUNDFX,

   107

};

   108

   109

   110

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

   111

   112

static const uint _vehcounts[4] = {

   113

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

   114

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

   115

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

   116

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

   117

};

   118

   119

static const uint _vehshifts[4] = {

   120

	/* GSF_TRAIN */    0,

   121

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

   122

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

   123

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

   124

};

   125

   126

enum {

   127

	MAX_STATIONS = 256,

   128

};

   129

   130

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

   131

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

   132

   133

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

   134

static uint32 _grm_engines[TOTAL_NUM_ENGINES];

   135

   136

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

   137

static uint32 _grm_cargos[NUM_CARGO];

   138

   139

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

   140

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

   141

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

   142

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

   143

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

   144

 * is no file information available during that time.

   145

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

   146

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

   147

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

   148

{

   149

	char buf[1024];

   150

	va_list va;

   151

   152

	va_start(va, str);

   153

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

   154

	va_end(va);

   155

   156

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

   157

}

   158

   159

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

   160

{

   161

	if (real >= wanted) return true;

   162

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

   163

	return false;

   164

}

   165

   166

static inline byte grf_load_byte(byte **buf)

   167

{

   168

	return *(*buf)++;

   169

}

   170

   171

static uint16 grf_load_word(byte **buf)

   172

{

   173

	uint16 val = grf_load_byte(buf);

   174

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

   175

}

   176

   177

static uint16 grf_load_extended(byte** buf)

   178

{

   179

	uint16 val;

   180

	val = grf_load_byte(buf);

   181

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

   182

	return val;

   183

}

   184

   185

static uint32 grf_load_dword(byte **buf)

   186

{

   187

	uint32 val = grf_load_word(buf);

   188

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

   189

}

   190

   191

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

   192

{

   193

	switch (size) {

   194

		case 1: return grf_load_byte(buf);

   195

		case 2: return grf_load_word(buf);

   196

		case 4: return grf_load_dword(buf);

   197

		default:

   198

			NOT_REACHED();

   199

			return 0;

   200

	}

   201

}

   202

   203

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

   204

{

   205

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

   206

	size_t string_length = ttd_strnlen(string, max_len);

   207

   208

	if (string_length == max_len) {

   209

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

   210

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

   211

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

   212

	} else {

   213

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

   214

		string_length++;

   215

	}

   216

	*buf += string_length;

   217

   218

	return string;

   219

}

   220

   221

static GRFFile *GetFileByGRFID(uint32 grfid)

   222

{

   223

	GRFFile *file;

   224

   225

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

   226

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

   227

	}

   228

	return file;

   229

}

   230

   231

static GRFFile *GetFileByFilename(const char *filename)

   232

{

   233

	GRFFile *file;

   234

   235

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

   236

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

   237

	}

   238

	return file;

   239

}

   240

   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

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

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

   266

		return GetGRFStringID(grfid, str);

   267

	}

   268

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

   269

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

   270

	TEXID_TO_STRINGID(0x000E, 0x002D, STR_000E);

   271

	TEXID_TO_STRINGID(0x002E, 0x004D, STR_002E);

   272

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

   273

	TEXID_TO_STRINGID(0x006E, 0x008D, STR_QUANTITY_NOTHING);

   274

	TEXID_TO_STRINGID(0x008E, 0x00AD, STR_ABBREV_NOTHING);

   275

   276

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

   277

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

   278

	 * to use original house names. */

   279

	TEXID_TO_STRINGID(0x200F, 0x201F, STR_200F_TALL_OFFICE_BLOCK);

   280

	TEXID_TO_STRINGID(0x2036, 0x2041, STR_2036_COTTAGES);

   281

	TEXID_TO_STRINGID(0x2059, 0x205C, STR_2059_IGLOO);

   282

   283

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

   284

	TEXID_TO_STRINGID(0x482A, 0x483B, STR_482A_PRODUCTION_LAST_MONTH);

   285

#undef TEXTID_TO_STRINGID

   286

   287

	if (str == STR_NULL) return STR_EMPTY;

   288

   289

	return str;

   290

}

   291

   292

static uint8 MapDOSColour(uint8 colour)

   293

{

   294

	if (_use_dos_palette) return colour;

   295

   296

	if (colour < 10) {

   297

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

   298

		return dos_to_win_colour_map[colour];

   299

	}

   300

   301

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

   302

   303

	return colour;

   304

}

   305

   306

   307

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

   308

   309

static void dewagonize(int condition, int engine)

   310

{

   311

	EngineInfo *ei = &_engine_info[engine];

   312

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   313

   314

	if (condition != 0) {

   315

		ei->unk2 &= ~0x80;

   316

		if (rvi->railveh_type == RAILVEH_WAGON)

   317

			rvi->railveh_type = RAILVEH_SINGLEHEAD;

   318

	} else {

   319

		ei->unk2 |= 0x80;

   320

		rvi->railveh_type = RAILVEH_WAGON;

   321

	}

   322

}

   323

   324

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

   325

{

   326

	byte *buf = *bufp;

   327

	bool ret = false;

   328

   329

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

   330

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

   331

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

   332

   333

		switch (prop) {

   334

			case 0x05: { // Track type

   335

				uint8 tracktype = grf_load_byte(&buf);

   336

   337

				switch (tracktype) {

   338

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

   339

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

   340

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

   341

					default:

   342

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

   343

						break;

   344

				}

   345

			} break;

   346

   347

			case 0x08: // AI passenger service

   348

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

   349

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

   350

				grf_load_byte(&buf);

   351

				ret = true;

   352

				break;

   353

   354

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

   355

				uint16 speed = grf_load_word(&buf);

   356

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

   357

   358

				rvi->max_speed = speed;

   359

			} break;

   360

   361

			case 0x0B: { // Power

   362

				uint16 power = grf_load_word(&buf);

   363

   364

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

   365

   366

				rvi->power = power;

   367

				dewagonize(power, engine + i);

   368

			} break;

   369

   370

			case 0x0D: { // Running cost factor

   371

				uint8 runcostfact = grf_load_byte(&buf);

   372

   373

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

   374

   375

				rvi->running_cost_base = runcostfact;

   376

			} break;

   377

   378

			case 0x0E: { // Running cost base

   379

				uint32 base = grf_load_dword(&buf);

   380

   381

				switch (base) {

   382

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

   383

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

   384

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

   385

					case 0: break; // Used by wagons

   386

					default:

   387

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

   388

						break;

   389

				}

   390

			} break;

   391

   392

			case 0x12: { // Sprite ID

   393

				uint8 spriteid = grf_load_byte(&buf);

   394

   395

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

   396

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

   397

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

   398

   399

				rvi->image_index = spriteid;

   400

			} break;

   401

   402

			case 0x13: { // Dual-headed

   403

				uint8 dual = grf_load_byte(&buf);

   404

   405

				if (dual != 0) {

   406

					if (rvi->railveh_type != RAILVEH_MULTIHEAD) {

   407

						// adjust power and running cost if needed

   408

						rvi->power /= 2;

   409

						rvi->running_cost_base /= 2;

   410

					}

   411

					rvi->railveh_type = RAILVEH_MULTIHEAD;

   412

				} else {

   413

					if (rvi->railveh_type == RAILVEH_MULTIHEAD) {

   414

						// adjust power and running cost if needed

   415

						rvi->power *= 2;

   416

						rvi->running_cost_base *= 2;

   417

					}

   418

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

   419

						RAILVEH_WAGON : RAILVEH_SINGLEHEAD;

   420

				}

   421

			} break;

   422

   423

			case 0x14: // Cargo capacity

   424

				rvi->capacity = grf_load_byte(&buf);

   425

				break;

   426

   427

			case 0x15: { // Cargo type

   428

				uint8 ctype = grf_load_byte(&buf);

   429

   430

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

   431

					rvi->cargo_type = ctype;

   432

				} else {

   433

					rvi->cargo_type = CT_INVALID;

   434

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

   435

				}

   436

			} break;

   437

   438

			case 0x16: // Weight

   439

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

   440

				break;

   441

   442

			case 0x17: // Cost factor

   443

				rvi->base_cost = grf_load_byte(&buf);

   444

				break;

   445

   446

			case 0x18: // AI rank

   447

				rvi->ai_rank = grf_load_byte(&buf);

   448

				break;

   449

   450

			case 0x19: { // Engine traction type

   451

				/* What do the individual numbers mean?

   452

				 * 0x00 .. 0x07: Steam

   453

				 * 0x08 .. 0x27: Diesel

   454

				 * 0x28 .. 0x31: Electric

   455

				 * 0x32 .. 0x37: Monorail

   456

				 * 0x38 .. 0x41: Maglev

   457

				 */

   458

				uint8 traction = grf_load_byte(&buf);

   459

				EngineClass engclass;

   460

   461

				if (traction <= 0x07) {

   462

					engclass = EC_STEAM;

   463

				} else if (traction <= 0x27) {

   464

					engclass = EC_DIESEL;

   465

				} else if (traction <= 0x31) {

   466

					engclass = EC_ELECTRIC;

   467

				} else if (traction <= 0x37) {

   468

					engclass = EC_MONORAIL;

   469

				} else if (traction <= 0x41) {

   470

					engclass = EC_MAGLEV;

   471

				} else {

   472

					break;

   473

				}

   474

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

   475

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

   476

   477

				rvi->engclass = engclass;

   478

			} break;

   479

   480

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

   481

				EngineID pos = grf_load_byte(&buf);

   482

   483

				if (pos < NUM_TRAIN_ENGINES) {

   484

					AlterRailVehListOrder(engine + i, pos);

   485

				} else {

   486

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

   487

				}

   488

			} break;

   489

   490

			case 0x1B: // Powered wagons power bonus