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

    19

#include "table/strings.h"

    20

#include "bridge.h"

    21

#include "town.h"

    22

#include "newgrf_engine.h"

    23

#include "newgrf_text.h"

    24

#include "table/sprites.h"

    25

#include "fontcache.h"

    26

#include "currency.h"

    27

#include "landscape.h"

    28

#include "newgrf_config.h"

    29

#include "newgrf_house.h"

    30

#include "newgrf_sound.h"

    31

#include "newgrf_spritegroup.h"

    32

#include "table/town_land.h"

    33

#include "cargotype.h"

    34

#include "industry.h"

    35

#include "newgrf_canal.h"

    36

#include "table/build_industry.h"

    37

#include "newgrf_commons.h"

    38

#include "newgrf_townname.h"

    39

#include "newgrf_industries.h"

    40

#include "table/landscape_sprite.h"

    41

#include "gfxinit.h"

    42

#include "fios.h"

    43

#include "rail.h"

    44

#include "strings_func.h"

    45

#include "gfx_func.h"

    46

#include "date_func.h"

    47

#include "vehicle_func.h"

    48

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

SpriteID _coast_base;

    63

    64

static GRFFile *_cur_grffile;

    65

GRFFile *_first_grffile;

    66

static SpriteID _cur_spriteid;

    67

static GrfLoadingStage _cur_stage;

    68

static uint32 _nfo_line;

    69

    70

static GRFConfig *_cur_grfconfig;

    71

    72

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

    73

static byte _misc_grf_features = 0;

    74

    75

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

    76

static uint32 _ttdpatch_flags[8];

    77

    78

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

    79

static byte *_preload_sprite = NULL;

    80

    81

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

    82

GRFLoadedFeatures _loaded_newgrf_features;

    83

    84

enum GrfDataType {

    85

	GDT_SOUND,

    86

};

    87

    88

static byte _grf_data_blocks;

    89

static GrfDataType _grf_data_type;

    90

    91

    92

enum grfspec_feature {

    93

	GSF_TRAIN,

    94

	GSF_ROAD,

    95

	GSF_SHIP,

    96

	GSF_AIRCRAFT,

    97

	GSF_STATION,

    98

	GSF_CANAL,

    99

	GSF_BRIDGE,

   100

	GSF_TOWNHOUSE,

   101

	GSF_GLOBALVAR,

   102

	GSF_INDUSTRYTILES,

   103

	GSF_INDUSTRIES,

   104

	GSF_CARGOS,

   105

	GSF_SOUNDFX,

   106

};

   107

   108

   109

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

   110

   111

static const uint _vehcounts[4] = {

   112

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

   113

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

   114

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

   115

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

   116

};

   117

   118

static const uint _vehshifts[4] = {

   119

	/* GSF_TRAIN */    0,

   120

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

   121

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

   122

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

   123

};

   124

   125

enum {

   126

	MAX_STATIONS = 256,

   127

};

   128

   129

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

   130

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

   131

   132

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

   133

static uint32 _grm_engines[TOTAL_NUM_ENGINES];

   134

   135

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

   136

static uint32 _grm_cargos[NUM_CARGO];

   137

   138

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

   139

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

   140

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

   141

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

   142

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

   143

 * is no file information available during that time.

   144

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

   145

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

   146

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

   147

{

   148

	char buf[1024];

   149

	va_list va;

   150

   151

	va_start(va, str);

   152

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

   153

	va_end(va);

   154

   155

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

   156

}

   157

   158

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

   159

{

   160

	if (real >= wanted) return true;

   161

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

   162

	return false;

   163

}

   164

   165

static inline byte grf_load_byte(byte **buf)

   166

{

   167

	return *(*buf)++;

   168

}

   169

   170

static uint16 grf_load_word(byte **buf)

   171

{

   172

	uint16 val = grf_load_byte(buf);

   173

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

   174

}

   175

   176

static uint16 grf_load_extended(byte** buf)

   177

{

   178

	uint16 val;

   179

	val = grf_load_byte(buf);

   180

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

   181

	return val;

   182

}

   183

   184

static uint32 grf_load_dword(byte **buf)

   185

{

   186

	uint32 val = grf_load_word(buf);

   187

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

   188

}

   189

   190

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

   191

{

   192

	switch (size) {

   193

		case 1: return grf_load_byte(buf);

   194

		case 2: return grf_load_word(buf);

   195

		case 4: return grf_load_dword(buf);

   196

		default:

   197

			NOT_REACHED();

   198

			return 0;

   199

	}

   200

}

   201

   202

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

   203

{

   204

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

   205

	size_t string_length = ttd_strnlen(string, max_len);

   206

   207

	if (string_length == max_len) {

   208

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

   209

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

   210

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

   211

	} else {

   212

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

   213

		string_length++;

   214

	}

   215

	*buf += string_length;

   216

   217

	return string;

   218

}

   219

   220

static GRFFile *GetFileByGRFID(uint32 grfid)

   221

{

   222

	GRFFile *file;

   223

   224

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

   225

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

   226

	}

   227

	return file;

   228

}

   229

   230

static GRFFile *GetFileByFilename(const char *filename)

   231

{

   232

	GRFFile *file;

   233

   234

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

   235

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

   236

	}

   237

	return file;

   238

}

   239

   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

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

   261

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

   262

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

   263

	 * grfid in which they are declared */

   264

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

   265

		return GetGRFStringID(grfid, str);

   266

	}

   267

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

   268

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

   269

	TEXID_TO_STRINGID(0x000E, 0x002D, STR_000E);

   270

	TEXID_TO_STRINGID(0x002E, 0x004D, STR_002E);

   271

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

   272

	TEXID_TO_STRINGID(0x006E, 0x008D, STR_QUANTITY_NOTHING);

   273

	TEXID_TO_STRINGID(0x008E, 0x00AD, STR_ABBREV_NOTHING);

   274

   275

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

   276

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

   277

	 * to use original house names. */

   278

	TEXID_TO_STRINGID(0x200F, 0x201F, STR_200F_TALL_OFFICE_BLOCK);

   279

	TEXID_TO_STRINGID(0x2036, 0x2041, STR_2036_COTTAGES);

   280

	TEXID_TO_STRINGID(0x2059, 0x205C, STR_2059_IGLOO);

   281

   282

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

   283

	TEXID_TO_STRINGID(0x482A, 0x483B, STR_482A_PRODUCTION_LAST_MONTH);

   284

#undef TEXTID_TO_STRINGID

   285

   286

	if (str == STR_NULL) return STR_EMPTY;

   287

   288

	return str;

   289

}

   290

   291

static uint8 MapDOSColour(uint8 colour)

   292

{

   293

	if (_use_dos_palette) return colour;

   294

   295

	if (colour < 10) {

   296

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

   297

		return dos_to_win_colour_map[colour];

   298

	}

   299

   300

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

   301

   302

	return colour;

   303

}

   304

   305

   306

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

   307

   308

static void dewagonize(int condition, int engine)

   309

{

   310

	EngineInfo *ei = &_engine_info[engine];

   311

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   312

   313

	if (condition != 0) {

   314

		ei->unk2 &= ~0x80;

   315

		if (rvi->railveh_type == RAILVEH_WAGON)

   316

			rvi->railveh_type = RAILVEH_SINGLEHEAD;

   317

	} else {

   318

		ei->unk2 |= 0x80;

   319

		rvi->railveh_type = RAILVEH_WAGON;

   320

	}

   321

}

   322

   323

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

   324

{

   325

	byte *buf = *bufp;

   326

	bool ret = false;

   327

   328

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

   329

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

   330

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

   331

   332

		switch (prop) {

   333

			case 0x05: { // Track type

   334

				uint8 tracktype = grf_load_byte(&buf);

   335

   336

				switch (tracktype) {

   337

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

   338

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

   339

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

   340

					default:

   341

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

   342

						break;

   343

				}

   344

			} break;

   345

   346

			case 0x08: // AI passenger service

   347

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

   348

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

   349

				grf_load_byte(&buf);

   350

				ret = true;

   351

				break;

   352

   353

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

   354

				uint16 speed = grf_load_word(&buf);

   355

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

   356

   357

				rvi->max_speed = speed;

   358

			} break;

   359

   360

			case 0x0B: { // Power

   361

				uint16 power = grf_load_word(&buf);

   362

   363

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

   364

   365

				rvi->power = power;

   366

				dewagonize(power, engine + i);

   367

			} break;

   368

   369

			case 0x0D: { // Running cost factor

   370

				uint8 runcostfact = grf_load_byte(&buf);

   371

   372

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

   373

   374

				rvi->running_cost_base = runcostfact;

   375

			} break;

   376

   377

			case 0x0E: { // Running cost base

   378

				uint32 base = grf_load_dword(&buf);

   379

   380

				switch (base) {

   381

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

   382

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

   383

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

   384

					case 0: break; // Used by wagons

   385

					default:

   386

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

   387

						break;

   388

				}

   389

			} break;

   390

   391

			case 0x12: { // Sprite ID

   392

				uint8 spriteid = grf_load_byte(&buf);

   393

   394

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

   395

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

   396

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

   397

   398

				rvi->image_index = spriteid;

   399

			} break;

   400

   401

			case 0x13: { // Dual-headed

   402

				uint8 dual = grf_load_byte(&buf);

   403

   404

				if (dual != 0) {

   405

					if (rvi->railveh_type != RAILVEH_MULTIHEAD) {

   406

						// adjust power and running cost if needed

   407

						rvi->power /= 2;

   408

						rvi->running_cost_base /= 2;

   409

					}

   410

					rvi->railveh_type = RAILVEH_MULTIHEAD;

   411

				} else {

   412

					if (rvi->railveh_type == RAILVEH_MULTIHEAD) {

   413

						// adjust power and running cost if needed

   414

						rvi->power *= 2;

   415

						rvi->running_cost_base *= 2;

   416

					}

   417

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

   418

						RAILVEH_WAGON : RAILVEH_SINGLEHEAD;

   419

				}

   420

			} break;

   421

   422

			case 0x14: // Cargo capacity

   423

				rvi->capacity = grf_load_byte(&buf);

   424

				break;

   425

   426

			case 0x15: { // Cargo type

   427

				uint8 ctype = grf_load_byte(&buf);

   428

   429

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

   430

					rvi->cargo_type = ctype;

   431

				} else {

   432

					rvi->cargo_type = CT_INVALID;

   433

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

   434

				}

   435

			} break;

   436

   437

			case 0x16: // Weight

   438

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

   439

				break;

   440

   441

			case 0x17: // Cost factor

   442

				rvi->base_cost = grf_load_byte(&buf);

   443

				break;

   444

   445

			case 0x18: // AI rank

   446

				rvi->ai_rank = grf_load_byte(&buf);

   447

				break;

   448

   449

			case 0x19: { // Engine traction type

   450

				/* What do the individual numbers mean?

   451

				 * 0x00 .. 0x07: Steam

   452

				 * 0x08 .. 0x27: Diesel

   453

				 * 0x28 .. 0x31: Electric

   454

				 * 0x32 .. 0x37: Monorail

   455

				 * 0x38 .. 0x41: Maglev

   456

				 */

   457

				uint8 traction = grf_load_byte(&buf);

   458

				EngineClass engclass;

   459

   460

				if (traction <= 0x07) {

   461

					engclass = EC_STEAM;

   462

				} else if (traction <= 0x27) {

   463

					engclass = EC_DIESEL;

   464

				} else if (traction <= 0x31) {

   465

					engclass = EC_ELECTRIC;

   466

				} else if (traction <= 0x37) {

   467

					engclass = EC_MONORAIL;

   468

				} else if (traction <= 0x41) {

   469

					engclass = EC_MAGLEV;

   470

				} else {

   471

					break;

   472

				}

   473

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

   474

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

   475

   476

				rvi->engclass = engclass;

   477

			} break;

   478

   479

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

   480

				EngineID pos = grf_load_byte(&buf);

   481

   482

				if (pos < NUM_TRAIN_ENGINES) {

   483

					AlterRailVehListOrder(engine + i, pos);

   484

				} else {

   485

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

   486

				}

   487

			} break;

   488

   489

			case 0x1B: // Powered wagons power bonus

   490

				rvi->pow_wag_power = grf_load_word(&buf);