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

    49

/* TTDPatch extended GRF format codec

    50

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

    51

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

    52

 *

    53

 * Contains portions of documentation by TTDPatch team.

    54

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

    55

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

    56

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

    57

    58

    59

static int _skip_sprites; // XXX

    60

static uint _file_index; // XXX

    61

SpriteID _signal_base;

    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

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

   250

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

   251

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

   252

	 * grfid in which they are declared */

   253

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

   254

		return GetGRFStringID(grfid, str);

   255

	}

   256

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

   257

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

   258

	TEXID_TO_STRINGID(0x000E, 0x002D, STR_000E);

   259

	TEXID_TO_STRINGID(0x002E, 0x004D, STR_002E);

   260

	TEXID_TO_STRINGID(0x004E, 0x006D, STR_QUANTITY_NOTHING);

   261

	TEXID_TO_STRINGID(0x006E, 0x008D, STR_QUANTITY_NOTHING);

   262

	TEXID_TO_STRINGID(0x008E, 0x00AD, STR_ABBREV_NOTHING);

   263

   264

	/* Map building names according to our lang file changes

   265

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

   266

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

   267

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

   268

	 * to compensate for the difference */

   269

	TEXID_TO_STRINGID(0x200F, 0x201F, STR_200F_TALL_OFFICE_BLOCK);

   270

   271

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

   272

	TEXID_TO_STRINGID(0x482A, 0x483B, STR_482A_PRODUCTION_LAST_MONTH);

   273

#undef TEXTID_TO_STRINGID

   274

   275

	if (str == STR_NULL) return STR_EMPTY;

   276

   277

	return str;

   278

}

   279

   280

static uint8 MapDOSColour(uint8 colour)

   281

{

   282

	if (_use_dos_palette) return colour;

   283

   284

	if (colour < 10) {

   285

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

   286

		return dos_to_win_colour_map[colour];

   287

	}

   288

   289

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

   290

   291

	return colour;

   292

}

   293

   294

   295

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

   296

   297

static void dewagonize(int condition, int engine)

   298

{

   299

	EngineInfo *ei = &_engine_info[engine];

   300

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   301

   302

	if (condition != 0) {

   303

		ei->unk2 &= ~0x80;

   304

		if (rvi->railveh_type == RAILVEH_WAGON)

   305

			rvi->railveh_type = RAILVEH_SINGLEHEAD;

   306

	} else {

   307

		ei->unk2 |= 0x80;

   308

		rvi->railveh_type = RAILVEH_WAGON;

   309

	}

   310

}

   311

   312

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

   313

{

   314

	byte *buf = *bufp;

   315

	bool ret = false;

   316

   317

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

   318

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

   319

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

   320

   321

		switch (prop) {

   322

			case 0x05: { // Track type

   323

				uint8 tracktype = grf_load_byte(&buf);

   324

   325

				switch (tracktype) {

   326

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

   327

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

   328

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

   329

					default:

   330

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

   331

						break;

   332

				}

   333

			} break;

   334

   335

			case 0x08: // AI passenger service

   336

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

   337

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

   338

				grf_load_byte(&buf);

   339

				ret = true;

   340

				break;

   341

   342

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

   343

				uint16 speed = grf_load_word(&buf);

   344

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

   345

   346

				rvi->max_speed = speed;

   347

			} break;

   348

   349

			case 0x0B: { // Power

   350

				uint16 power = grf_load_word(&buf);

   351

   352

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

   353

   354

				rvi->power = power;

   355

				dewagonize(power, engine + i);

   356

			} break;

   357

   358

			case 0x0D: { // Running cost factor

   359

				uint8 runcostfact = grf_load_byte(&buf);

   360

   361

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

   362

   363

				rvi->running_cost_base = runcostfact;

   364

			} break;

   365

   366

			case 0x0E: { // Running cost base

   367

				uint32 base = grf_load_dword(&buf);

   368

   369

				switch (base) {

   370

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

   371

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

   372

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

   373

					case 0: break; // Used by wagons

   374

					default:

   375

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

   376

						break;

   377

				}

   378

			} break;

   379

   380

			case 0x12: { // Sprite ID

   381

				uint8 spriteid = grf_load_byte(&buf);

   382

   383

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

   384

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

   385

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

   386

   387

				rvi->image_index = spriteid;

   388

			} break;

   389

   390

			case 0x13: { // Dual-headed

   391

				uint8 dual = grf_load_byte(&buf);

   392

   393

				if (dual != 0) {

   394

					if (rvi->railveh_type != RAILVEH_MULTIHEAD) {

   395

						// adjust power and running cost if needed

   396

						rvi->power /= 2;

   397

						rvi->running_cost_base /= 2;

   398

					}

   399

					rvi->railveh_type = RAILVEH_MULTIHEAD;

   400

				} else {

   401

					if (rvi->railveh_type == RAILVEH_MULTIHEAD) {

   402

						// adjust power and running cost if needed

   403

						rvi->power *= 2;

   404

						rvi->running_cost_base *= 2;

   405

					}

   406

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

   407

						RAILVEH_WAGON : RAILVEH_SINGLEHEAD;

   408

				}

   409

			} break;

   410

   411

			case 0x14: // Cargo capacity

   412

				rvi->capacity = grf_load_byte(&buf);

   413

				break;

   414

   415

			case 0x15: { // Cargo type

   416

				uint8 ctype = grf_load_byte(&buf);

   417

   418

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

   419

					rvi->cargo_type = ctype;

   420

				} else {

   421

					rvi->cargo_type = CT_INVALID;

   422

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

   423

				}

   424

			} break;

   425

   426

			case 0x16: // Weight

   427

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

   428

				break;

   429

   430

			case 0x17: // Cost factor

   431

				rvi->base_cost = grf_load_byte(&buf);

   432

				break;

   433

   434

			case 0x18: // AI rank

   435

				rvi->ai_rank = grf_load_byte(&buf);

   436

				break;

   437

   438

			case 0x19: { // Engine traction type

   439

				/* What do the individual numbers mean?

   440

				 * 0x00 .. 0x07: Steam

   441

				 * 0x08 .. 0x27: Diesel

   442

				 * 0x28 .. 0x31: Electric

   443

				 * 0x32 .. 0x37: Monorail

   444

				 * 0x38 .. 0x41: Maglev

   445

				 */

   446

				uint8 traction = grf_load_byte(&buf);

   447

				EngineClass engclass;

   448

   449

				if (traction <= 0x07) {

   450

					engclass = EC_STEAM;

   451

				} else if (traction <= 0x27) {

   452

					engclass = EC_DIESEL;

   453

				} else if (traction <= 0x31) {

   454

					engclass = EC_ELECTRIC;

   455

				} else if (traction <= 0x37) {

   456

					engclass = EC_MONORAIL;

   457

				} else if (traction <= 0x41) {

   458

					engclass = EC_MAGLEV;

   459

				} else {

   460

					break;

   461

				}

   462

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

   463

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

   464

   465

				rvi->engclass = engclass;

   466

			} break;

   467

   468

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

   469

				EngineID pos = grf_load_byte(&buf);

   470

   471

				if (pos < NUM_TRAIN_ENGINES) {

   472

					AlterRailVehListOrder(engine + i, pos);

   473

				} else {

   474

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

   475

				}

   476

			} break;

   477

   478

			case 0x1B: // Powered wagons power bonus

   479

				rvi->pow_wag_power = grf_load_word(&buf);

   480

				break;

   481

   482

			case 0x1C: // Refit cost

   483

				ei->refit_cost = grf_load_byte(&buf);

   484

				break;

   485

   486

			case 0x1D: // Refit cargo

   487

				ei->refit_mask = grf_load_dword(&buf);

   488

				break;

   489

   490

			case 0x1E: // Callback

   491