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

    12

#include "fileio.h"

    13

#include "functions.h"

    14

#include "engine.h"

    15

#include "spritecache.h"

    16

#include "station.h"

    17

#include "sprite.h"

    18

#include "newgrf.h"

    19

#include "variables.h"

    20

#include "string.h"

    21

#include "strings.h"

    22

#include "table/strings.h"

    23

#include "bridge.h"

    24

#include "town.h"

    25

#include "economy.h"

    26

#include "newgrf_engine.h"

    27

#include "vehicle.h"

    28

#include "newgrf_text.h"

    29

#include "table/sprites.h"

    30

#include "fontcache.h"

    31

#include "date.h"

    32

#include "currency.h"

    33

#include "landscape.h"

    34

#include "sound.h"

    35

#include "newgrf_config.h"

    36

#include "newgrf_house.h"

    37

#include "newgrf_sound.h"

    38

#include "newgrf_spritegroup.h"

    39

#include "helpers.hpp"

    40

#include "table/town_land.h"

    41

#include "cargotype.h"

    42

#include "industry.h"

    43

#include "newgrf_canal.h"

    44

#include "table/build_industry.h"

    45

#include "newgrf_commons.h"

    46

#include "newgrf_townname.h"

    47

#include "newgrf_industries.h"

    48

#include "table/landscape_sprite.h"

    49

#include "gfxinit.h"

    50

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

SpriteID _coast_base;

    65

    66

static GRFFile *_cur_grffile;

    67

GRFFile *_first_grffile;

    68

static SpriteID _cur_spriteid;

    69

static GrfLoadingStage _cur_stage;

    70

static uint32 _nfo_line;

    71

    72

static GRFConfig *_cur_grfconfig;

    73

    74

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

    75

static byte _misc_grf_features = 0;

    76

    77

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

    78

static uint32 _ttdpatch_flags[8];

    79

    80

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

    81

static byte *_preload_sprite = NULL;

    82

    83

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

    84

GRFLoadedFeatures _loaded_newgrf_features;

    85

    86

enum GrfDataType {

    87

	GDT_SOUND,

    88

};

    89

    90

static byte _grf_data_blocks;

    91

static GrfDataType _grf_data_type;

    92

    93

    94

enum grfspec_feature {

    95

	GSF_TRAIN,

    96

	GSF_ROAD,

    97

	GSF_SHIP,

    98

	GSF_AIRCRAFT,

    99

	GSF_STATION,

   100

	GSF_CANAL,

   101

	GSF_BRIDGE,

   102

	GSF_TOWNHOUSE,

   103

	GSF_GLOBALVAR,

   104

	GSF_INDUSTRYTILES,

   105

	GSF_INDUSTRIES,

   106

	GSF_CARGOS,

   107

	GSF_SOUNDFX,

   108

};

   109

   110

   111

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

   112

   113

static const uint _vehcounts[4] = {

   114

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

   115

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

   116

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

   117

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

   118

};

   119

   120

static const uint _vehshifts[4] = {

   121

	/* GSF_TRAIN */    0,

   122

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

   123

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

   124

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

   125

};

   126

   127

enum {

   128

	MAX_STATIONS = 256,

   129

};

   130

   131

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

   132

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

   133

   134

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

   135

static uint32 _grm_engines[TOTAL_NUM_ENGINES];

   136

   137

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

   138

static uint32 _grm_cargos[NUM_CARGO];

   139

   140

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

   141

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

   142

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

   143

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

   144

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

   145

 * is no file information available during that time.

   146

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

   147

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

   148

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

   149

{

   150

	char buf[1024];

   151

	va_list va;

   152

   153

	va_start(va, str);

   154

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

   155

	va_end(va);

   156

   157

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

   158

}

   159

   160

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

   161

{

   162

	if (real >= wanted) return true;

   163

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

   164

	return false;

   165

}

   166

   167

static inline byte grf_load_byte(byte **buf)

   168

{

   169

	return *(*buf)++;

   170

}

   171

   172

static uint16 grf_load_word(byte **buf)

   173

{

   174

	uint16 val = grf_load_byte(buf);

   175

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

   176

}

   177

   178

static uint16 grf_load_extended(byte** buf)

   179

{

   180

	uint16 val;

   181

	val = grf_load_byte(buf);

   182

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

   183

	return val;

   184

}

   185

   186

static uint32 grf_load_dword(byte **buf)

   187

{

   188

	uint32 val = grf_load_word(buf);

   189

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

   190

}

   191

   192

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

   193

{

   194

	switch (size) {

   195

		case 1: return grf_load_byte(buf);

   196

		case 2: return grf_load_word(buf);

   197

		case 4: return grf_load_dword(buf);

   198

		default:

   199

			NOT_REACHED();

   200

			return 0;

   201

	}

   202

}

   203

   204

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

   205

{

   206

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

   207

	size_t string_length = ttd_strnlen(string, max_len);

   208

   209

	if (string_length == max_len) {

   210

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

   211

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

   212

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

   213

	} else {

   214

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

   215

		string_length++;

   216

	}

   217

	*buf += string_length;

   218

   219

	return string;

   220

}

   221

   222

static GRFFile *GetFileByGRFID(uint32 grfid)

   223

{

   224

	GRFFile *file;

   225

   226

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

   227

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

   228

	}

   229

	return file;

   230

}

   231

   232

static GRFFile *GetFileByFilename(const char *filename)

   233

{

   234

	GRFFile *file;

   235

   236

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

   237

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

   238

	}

   239

	return file;

   240

}

   241

   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

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

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

   267

		return GetGRFStringID(grfid, str);

   268

	}

   269

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

   270

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

   271

	TEXID_TO_STRINGID(0x000E, 0x002D, STR_000E);

   272

	TEXID_TO_STRINGID(0x002E, 0x004D, STR_002E);

   273

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

   274

	TEXID_TO_STRINGID(0x006E, 0x008D, STR_QUANTITY_NOTHING);

   275

	TEXID_TO_STRINGID(0x008E, 0x00AD, STR_ABBREV_NOTHING);

   276

   277

	/* Map building names according to our lang file changes

   278

	 * 0x200F = Tall Office Block, first house name in the original data, the one that TTDPatch stil uses

   279

	 * 0x201F = Old houses is the last house name.

   280

	 * OpenTTD does not have exactly the same order aymore, so, the code below allows

   281

	 * to compensate for the difference */

   282

	TEXID_TO_STRINGID(0x200F, 0x201F, STR_200F_TALL_OFFICE_BLOCK);

   283

   284

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

   285

	TEXID_TO_STRINGID(0x482A, 0x483B, STR_482A_PRODUCTION_LAST_MONTH);

   286

#undef TEXTID_TO_STRINGID

   287

   288

	if (str == STR_NULL) return STR_EMPTY;

   289

   290

	return str;

   291

}

   292

   293

static uint8 MapDOSColour(uint8 colour)

   294

{

   295

	if (_use_dos_palette) return colour;

   296

   297

	if (colour < 10) {

   298

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

   299

		return dos_to_win_colour_map[colour];

   300

	}

   301

   302

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

   303

   304

	return colour;

   305

}

   306

   307

   308

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

   309

   310

static void dewagonize(int condition, int engine)

   311

{

   312

	EngineInfo *ei = &_engine_info[engine];

   313

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   314

   315

	if (condition != 0) {

   316

		ei->unk2 &= ~0x80;

   317

		if (rvi->railveh_type == RAILVEH_WAGON)

   318

			rvi->railveh_type = RAILVEH_SINGLEHEAD;

   319

	} else {

   320

		ei->unk2 |= 0x80;

   321

		rvi->railveh_type = RAILVEH_WAGON;

   322

	}

   323

}

   324

   325

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

   326

{

   327

	byte *buf = *bufp;

   328

	bool ret = false;

   329

   330

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

   331

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

   332

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

   333

   334

		switch (prop) {

   335

			case 0x05: { // Track type

   336

				uint8 tracktype = grf_load_byte(&buf);

   337

   338

				switch (tracktype) {

   339

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

   340

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

   341

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

   342

					default:

   343

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

   344

						break;

   345

				}

   346

			} break;

   347

   348

			case 0x08: // AI passenger service

   349

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

   350

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

   351

				grf_load_byte(&buf);

   352

				ret = true;

   353

				break;

   354

   355

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

   356

				uint16 speed = grf_load_word(&buf);

   357

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

   358

   359

				rvi->max_speed = speed;

   360

			} break;

   361

   362

			case 0x0B: { // Power

   363

				uint16 power = grf_load_word(&buf);

   364

   365

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

   366

   367

				rvi->power = power;

   368

				dewagonize(power, engine + i);

   369

			} break;

   370

   371

			case 0x0D: { // Running cost factor

   372

				uint8 runcostfact = grf_load_byte(&buf);

   373

   374

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

   375

   376

				rvi->running_cost_base = runcostfact;

   377

			} break;

   378

   379

			case 0x0E: { // Running cost base

   380

				uint32 base = grf_load_dword(&buf);

   381

   382

				switch (base) {

   383

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

   384

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

   385

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

   386

					case 0: break; // Used by wagons

   387

					default:

   388

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

   389

						break;

   390

				}

   391

			} break;

   392

   393

			case 0x12: { // Sprite ID

   394

				uint8 spriteid = grf_load_byte(&buf);

   395

   396

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

   397

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

   398

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

   399

   400

				rvi->image_index = spriteid;

   401

			} break;

   402

   403

			case 0x13: { // Dual-headed

   404

				uint8 dual = grf_load_byte(&buf);

   405

   406

				if (dual != 0) {

   407

					if (rvi->railveh_type != RAILVEH_MULTIHEAD) {

   408

						// adjust power and running cost if needed

   409

						rvi->power /= 2;

   410

						rvi->running_cost_base /= 2;

   411

					}

   412

					rvi->railveh_type = RAILVEH_MULTIHEAD;

   413

				} else {

   414

					if (rvi->railveh_type == RAILVEH_MULTIHEAD) {

   415

						// adjust power and running cost if needed

   416

						rvi->power *= 2;

   417

						rvi->running_cost_base *= 2;

   418

					}

   419

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

   420

						RAILVEH_WAGON : RAILVEH_SINGLEHEAD;

   421

				}

   422

			} break;

   423

   424

			case 0x14: // Cargo capacity

   425

				rvi->capacity = grf_load_byte(&buf);

   426

				break;

   427

   428

			case 0x15: { // Cargo type

   429

				uint8 ctype = grf_load_byte(&buf);

   430

   431

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

   432

					rvi->cargo_type = ctype;

   433

				} else {

   434

					rvi->cargo_type = CT_INVALID;

   435

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

   436

				}

   437

			} break;

   438

   439

			case 0x16: // Weight

   440

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

   441

				break;

   442

   443

			case 0x17: // Cost factor

   444

				rvi->base_cost = grf_load_byte(&buf);

   445

				break;

   446

   447

			case 0x18: // AI rank

   448

				rvi->ai_rank = grf_load_byte(&buf);

   449

				break;

   450

   451

			case 0x19: { // Engine traction type

   452

				/* What do the individual numbers mean?

   453

				 * 0x00 .. 0x07: Steam

   454

				 * 0x08 .. 0x27: Diesel

   455

				 * 0x28 .. 0x31: Electric

   456

				 * 0x32 .. 0x37: Monorail

   457

				 * 0x38 .. 0x41: Maglev

   458

				 */

   459

				uint8 traction = grf_load_byte(&buf);

   460

				EngineClass engclass;

   461

   462

				if (traction <= 0x07) {

   463

					engclass = EC_STEAM;

   464

				} else if (traction <= 0x27) {

   465

					engclass = EC_DIESEL;

   466

				} else if (traction <= 0x31) {

   467

					engclass = EC_ELECTRIC;

   468

				} else if (traction <= 0x37) {

   469

					engclass = EC_MONORAIL;

   470

				} else if (traction <= 0x41) {

   471

					engclass = EC_MAGLEV;

   472

				} else {

   473

					break;

   474

				}

   475

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

   476

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

   477

   478

				rvi->engclass = engclass;

   479

			} break;

   480

   481

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

   482

				EngineID pos = grf_load_byte(&buf);

   483

   484

				if (pos < NUM_TRAIN_ENGINES) {

   485

					AlterRailVehListOrder(engine + i, pos);

   486

				} else {

   487

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

   488

				}

   489

			} break;

   490