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

    30

#include "industry.h"

    31

#include "newgrf_canal.h"

    32

#include "newgrf_commons.h"

    33

#include "newgrf_townname.h"

    34

#include "newgrf_industries.h"

    35

#include "gfxinit.h"

    36

#include "fios.h"

    37

#include "rail.h"

    38

#include "strings_func.h"

    39

#include "gfx_func.h"

    40

#include "date_func.h"

    41

#include "vehicle_func.h"

    42

#include "sound_func.h"

    43

#include "string_func.h"

    44

#include "road_func.h"

    45

#include "player_base.h"

    46

#include "settings_type.h"

    47

    48

#include "table/strings.h"

    49

#include "table/sprites.h"

    50

#include "table/town_land.h"

    51

#include "table/build_industry.h"

    52

#include "table/landscape_sprite.h"

    53

    54

/* TTDPatch extended GRF format codec

    55

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

    56

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

    57

 *

    58

 * Contains portions of documentation by TTDPatch team.

    59

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

    60

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

    61

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

    62

    63

    64

static int _skip_sprites; // XXX

    65

static uint _file_index; // XXX

    66

    67

static GRFFile *_cur_grffile;

    68

GRFFile *_first_grffile;

    69

static SpriteID _cur_spriteid;

    70

static GrfLoadingStage _cur_stage;

    71

static uint32 _nfo_line;

    72

    73

static GRFConfig *_cur_grfconfig;

    74

    75

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

    76

static byte _misc_grf_features = 0;

    77

    78

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

    79

static uint32 _ttdpatch_flags[8];

    80

    81

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

    82

static byte *_preload_sprite = NULL;

    83

    84

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

    85

GRFLoadedFeatures _loaded_newgrf_features;

    86

    87

enum GrfDataType {

    88

	GDT_SOUND,

    89

};

    90

    91

static byte _grf_data_blocks;

    92

static GrfDataType _grf_data_type;

    93

    94

    95

enum grfspec_feature {

    96

	GSF_TRAIN,

    97

	GSF_ROAD,

    98

	GSF_SHIP,

    99

	GSF_AIRCRAFT,

   100

	GSF_STATION,

   101

	GSF_CANAL,

   102

	GSF_BRIDGE,

   103

	GSF_TOWNHOUSE,

   104

	GSF_GLOBALVAR,

   105

	GSF_INDUSTRYTILES,

   106

	GSF_INDUSTRIES,

   107

	GSF_CARGOS,

   108

	GSF_SOUNDFX,

   109

};

   110

   111

   112

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

   113

   114

static const uint _vehcounts[4] = {

   115

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

   116

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

   117

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

   118

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

   119

};

   120

   121

static const uint _vehshifts[4] = {

   122

	/* GSF_TRAIN */    0,

   123

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

   124

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

   125

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

   126

};

   127

   128

enum {

   129

	MAX_STATIONS = 256,

   130

};

   131

   132

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

   133

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

   134

   135

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

   136

static uint32 _grm_engines[TOTAL_NUM_ENGINES];

   137

   138

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

   139

static uint32 _grm_cargos[NUM_CARGO];

   140

   141

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

   142

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

   143

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

   144

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

   145

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

   146

 * is no file information available during that time.

   147

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

   148

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

   149

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

   150

{

   151

	char buf[1024];

   152

	va_list va;

   153

   154

	va_start(va, str);

   155

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

   156

	va_end(va);

   157

   158

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

   159

}

   160

   161

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

   162

{

   163

	if (real >= wanted) return true;

   164

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

   165

	return false;

   166

}

   167

   168

static inline byte grf_load_byte(byte **buf)

   169

{

   170

	return *(*buf)++;

   171

}

   172

   173

static uint16 grf_load_word(byte **buf)

   174

{

   175

	uint16 val = grf_load_byte(buf);

   176

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

   177

}

   178

   179

static uint16 grf_load_extended(byte** buf)

   180

{

   181

	uint16 val;

   182

	val = grf_load_byte(buf);

   183

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

   184

	return val;

   185

}

   186

   187

static uint32 grf_load_dword(byte **buf)

   188

{

   189

	uint32 val = grf_load_word(buf);

   190

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

   191

}

   192

   193

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

   194

{

   195

	switch (size) {

   196

		case 1: return grf_load_byte(buf);

   197

		case 2: return grf_load_word(buf);

   198

		case 4: return grf_load_dword(buf);

   199

		default:

   200

			NOT_REACHED();

   201

			return 0;

   202

	}

   203

}

   204

   205

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

   206

{

   207

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

   208

	size_t string_length = ttd_strnlen(string, max_len);

   209

   210

	if (string_length == max_len) {

   211

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

   212

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

   213

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

   214

	} else {

   215

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

   216

		string_length++;

   217

	}

   218

	*buf += string_length;

   219

   220

	return string;

   221

}

   222

   223

static GRFFile *GetFileByGRFID(uint32 grfid)

   224

{

   225

	GRFFile *file;

   226

   227

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

   228

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

   229

	}

   230

	return file;

   231

}

   232

   233

static GRFFile *GetFileByFilename(const char *filename)

   234

{

   235

	GRFFile *file;

   236

   237

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

   238

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

   239

	}

   240

	return file;

   241

}

   242

   243

   244

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

   245

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

   246

 * @param grfid Id of the grf file

   247

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

   248

 * @return the properly adjusted StringID

   249

 */

   250

StringID MapGRFStringID(uint32 grfid, StringID str)

   251

{

   252

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

   253

	static StringID units_volume[] = {

   254

		STR_NOTHING,    STR_PASSENGERS, STR_TONS,       STR_BAGS,

   255

		STR_LITERS,     STR_ITEMS,      STR_CRATES,     STR_TONS,

   256

		STR_TONS,       STR_TONS,       STR_TONS,       STR_BAGS,

   257

		STR_TONS,       STR_TONS,       STR_TONS,       STR_BAGS,

   258

		STR_TONS,       STR_TONS,       STR_BAGS,       STR_LITERS,

   259

		STR_TONS,       STR_LITERS,     STR_TONS,       STR_NOTHING,

   260

		STR_BAGS,       STR_LITERS,     STR_TONS,       STR_NOTHING,

   261

		STR_TONS,       STR_NOTHING,    STR_LITERS,     STR_NOTHING

   262

	};

   263

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

   264

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

   265

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

   266

	 * grfid in which they are declared */

   267

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

   268

		return GetGRFStringID(grfid, str);

   269

	}

   270

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

   271

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

   272

	TEXID_TO_STRINGID(0x000E, 0x002D, STR_000E);

   273

	TEXID_TO_STRINGID(0x002E, 0x004D, STR_002E);

   274

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

   275

	TEXID_TO_STRINGID(0x006E, 0x008D, STR_QUANTITY_NOTHING);

   276

	TEXID_TO_STRINGID(0x008E, 0x00AD, STR_ABBREV_NOTHING);

   277

   278

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

   279

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

   280

	 * to use original house names. */

   281

	TEXID_TO_STRINGID(0x200F, 0x201F, STR_200F_TALL_OFFICE_BLOCK);

   282

	TEXID_TO_STRINGID(0x2036, 0x2041, STR_2036_COTTAGES);

   283

	TEXID_TO_STRINGID(0x2059, 0x205C, STR_2059_IGLOO);

   284

   285

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

   286

	TEXID_TO_STRINGID(0x482A, 0x483B, STR_482A_PRODUCTION_LAST_MONTH);

   287

#undef TEXTID_TO_STRINGID

   288

   289

	if (str == STR_NULL) return STR_EMPTY;

   290

   291

	return str;

   292

}

   293

   294

static uint8 MapDOSColour(uint8 colour)

   295

{

   296

	if (_use_dos_palette) return colour;

   297

   298

	if (colour < 10) {

   299

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

   300

		return dos_to_win_colour_map[colour];

   301

	}

   302

   303

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

   304

   305

	return colour;

   306

}

   307

   308

   309

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

   310

   311

static void dewagonize(int condition, int engine)

   312

{

   313

	EngineInfo *ei = &_engine_info[engine];

   314

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   315

   316

	if (condition != 0) {

   317

		ei->unk2 &= ~0x80;

   318

		if (rvi->railveh_type == RAILVEH_WAGON)

   319

			rvi->railveh_type = RAILVEH_SINGLEHEAD;

   320

	} else {

   321

		ei->unk2 |= 0x80;

   322

		rvi->railveh_type = RAILVEH_WAGON;

   323

	}

   324

}

   325

   326

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

   327

{

   328

	byte *buf = *bufp;

   329

	bool ret = false;

   330

   331

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

   332

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

   333

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

   334

   335

		switch (prop) {

   336

			case 0x05: { // Track type

   337

				uint8 tracktype = grf_load_byte(&buf);

   338

   339

				switch (tracktype) {

   340

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

   341

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

   342

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

   343

					default:

   344

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

   345

						break;

   346

				}

   347

			} break;

   348

   349

			case 0x08: // AI passenger service

   350

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

   351

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

   352

				grf_load_byte(&buf);

   353

				ret = true;

   354

				break;

   355

   356

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

   357

				uint16 speed = grf_load_word(&buf);

   358

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

   359

   360

				rvi->max_speed = speed;

   361

			} break;

   362

   363

			case 0x0B: { // Power

   364

				uint16 power = grf_load_word(&buf);

   365

   366

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

   367

   368

				rvi->power = power;

   369

				dewagonize(power, engine + i);

   370

			} break;

   371

   372

			case 0x0D: { // Running cost factor

   373

				uint8 runcostfact = grf_load_byte(&buf);

   374

   375

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

   376

   377

				rvi->running_cost_base = runcostfact;

   378

			} break;

   379

   380

			case 0x0E: { // Running cost base

   381

				uint32 base = grf_load_dword(&buf);

   382

   383

				switch (base) {

   384

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

   385

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

   386

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

   387

					case 0: break; // Used by wagons

   388

					default:

   389

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

   390

						break;

   391

				}

   392

			} break;

   393

   394

			case 0x12: { // Sprite ID

   395

				uint8 spriteid = grf_load_byte(&buf);

   396

   397

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

   398

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

   399

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

   400

   401

				rvi->image_index = spriteid;

   402

			} break;

   403

   404

			case 0x13: { // Dual-headed

   405

				uint8 dual = grf_load_byte(&buf);

   406

   407

				if (dual != 0) {

   408

					if (rvi->railveh_type != RAILVEH_MULTIHEAD) {

   409

						// adjust power and running cost if needed

   410

						rvi->power /= 2;

   411

						rvi->running_cost_base /= 2;

   412

					}

   413

					rvi->railveh_type = RAILVEH_MULTIHEAD;

   414

				} else {

   415

					if (rvi->railveh_type == RAILVEH_MULTIHEAD) {

   416

						// adjust power and running cost if needed

   417

						rvi->power *= 2;

   418

						rvi->running_cost_base *= 2;

   419

					}

   420

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

   421

						RAILVEH_WAGON : RAILVEH_SINGLEHEAD;

   422

				}

   423

			} break;

   424

   425

			case 0x14: // Cargo capacity

   426

				rvi->capacity = grf_load_byte(&buf);

   427

				break;

   428

   429

			case 0x15: { // Cargo type

   430

				uint8 ctype = grf_load_byte(&buf);

   431

   432

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

   433

					rvi->cargo_type = ctype;

   434

				} else {

   435

					rvi->cargo_type = CT_INVALID;

   436

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

   437

				}

   438

			} break;

   439

   440

			case 0x16: // Weight

   441

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

   442

				break;

   443

   444

			case 0x17: // Cost factor

   445

				rvi->base_cost = grf_load_byte(&buf);

   446

				break;

   447

   448

			case 0x18: // AI rank

   449

				rvi->ai_rank = grf_load_byte(&buf);

   450

				break;

   451

   452

			case 0x19: { // Engine traction type

   453

				/* What do the individual numbers mean?

   454

				 * 0x00 .. 0x07: Steam

   455

				 * 0x08 .. 0x27: Diesel

   456

				 * 0x28 .. 0x31: Electric

   457

				 * 0x32 .. 0x37: Monorail

   458

				 * 0x38 .. 0x41: Maglev

   459

				 */

   460

				uint8 traction = grf_load_byte(&buf);

   461

				EngineClass engclass;

   462

   463

				if (traction <= 0x07) {

   464

					engclass = EC_STEAM;

   465

				} else if (traction <= 0x27) {

   466

					engclass = EC_DIESEL;

   467

				} else if (traction <= 0x31) {

   468

					engclass = EC_ELECTRIC;

   469

				} else if (traction <= 0x37) {

   470

					engclass = EC_MONORAIL;

   471

				} else if (traction <= 0x41) {

   472

					engclass = EC_MAGLEV;

   473

				} else {

   474

					break;

   475

				}

   476

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

   477

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

   478

   479

				rvi->engclass = engclass;

   480

			} break;

   481

   482

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

   483

				EngineID pos = grf_load_byte(&buf);

   484

   485

				if (pos < NUM_TRAIN_ENGINES) {

   486

					AlterRailVehListOrder(engine + i, pos);

   487

				} else {

   488

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

   489

				}

   490

			} break;