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 "newgrf_fsmports.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 _signal_base;

    63

SpriteID _coast_base;

    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

	GSF_FSMPORTS,

   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

	MAX_FSM_PORTS = 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

static StringID MapGRFStringID(uint32 grfid, StringID str)

   251

{

   252

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

   253

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

   254

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

   255

	 * grfid in which they are declared */

   256

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

   257

		return GetGRFStringID(grfid, str);

   258

	}

   259

   260

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

   261

	if (str >= 0x006E && str <= 0x008D) return str - 0x20;

   262

	if (str >= 0x008E && str <= 0x00AD) return str - 0x20;

   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

	if (str >= 0x200F && str <= 0x201F) return str + (STR_200F_TALL_OFFICE_BLOCK - 0x200F);

   270

   271

	return str;

   272

}

   273

   274

static uint8 MapDOSColour(uint8 colour)

   275

{

   276

	if (_use_dos_palette) return colour;

   277

   278

	if (colour < 10) {

   279

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

   280

		return dos_to_win_colour_map[colour];

   281

	}

   282

   283

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

   284

   285

	return colour;

   286

}

   287

   288

   289

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

   290

   291

static void dewagonize(int condition, int engine)

   292

{

   293

	EngineInfo *ei = &_engine_info[engine];

   294

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   295

   296

	if (condition != 0) {

   297

		ei->unk2 &= ~0x80;

   298

		if (rvi->railveh_type == RAILVEH_WAGON)

   299

			rvi->railveh_type = RAILVEH_SINGLEHEAD;

   300

	} else {

   301

		ei->unk2 |= 0x80;

   302

		rvi->railveh_type = RAILVEH_WAGON;

   303

	}

   304

}

   305

   306

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

   307

{

   308

	byte *buf = *bufp;

   309

	bool ret = false;

   310

   311

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

   312

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

   313

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

   314

   315

		switch (prop) {

   316

			case 0x05: { // Track type

   317

				uint8 tracktype = grf_load_byte(&buf);

   318

   319

				switch (tracktype) {

   320

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

   321

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

   322

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

   323

					default:

   324

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

   325

						break;

   326

				}

   327

			} break;

   328

   329

			case 0x08: // AI passenger service

   330

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

   331

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

   332

				grf_load_byte(&buf);

   333

				ret = true;

   334

				break;

   335

   336

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

   337

				uint16 speed = grf_load_word(&buf);

   338

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

   339

   340

				rvi->max_speed = speed;

   341

			} break;

   342

   343

			case 0x0B: { // Power

   344

				uint16 power = grf_load_word(&buf);

   345

   346

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

   347

   348

				rvi->power = power;

   349

				dewagonize(power, engine + i);

   350

			} break;

   351

   352

			case 0x0D: { // Running cost factor

   353

				uint8 runcostfact = grf_load_byte(&buf);

   354

   355

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

   356

   357

				rvi->running_cost_base = runcostfact;

   358

			} break;

   359

   360

			case 0x0E: { // Running cost base

   361

				uint32 base = grf_load_dword(&buf);

   362

   363

				switch (base) {

   364

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

   365

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

   366

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

   367

					case 0: break; // Used by wagons

   368

					default:

   369

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

   370

						break;

   371

				}

   372

			} break;

   373

   374

			case 0x12: { // Sprite ID

   375

				uint8 spriteid = grf_load_byte(&buf);

   376

   377

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

   378

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

   379

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

   380

   381

				rvi->image_index = spriteid;

   382

			} break;

   383

   384

			case 0x13: { // Dual-headed

   385

				uint8 dual = grf_load_byte(&buf);

   386

   387

				if (dual != 0) {

   388

					if (rvi->railveh_type != RAILVEH_MULTIHEAD) {

   389

						// adjust power and running cost if needed

   390

						rvi->power /= 2;

   391

						rvi->running_cost_base /= 2;

   392

					}

   393

					rvi->railveh_type = RAILVEH_MULTIHEAD;

   394

				} else {

   395

					if (rvi->railveh_type == RAILVEH_MULTIHEAD) {

   396

						// adjust power and running cost if needed

   397

						rvi->power *= 2;

   398

						rvi->running_cost_base *= 2;

   399

					}

   400

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

   401

						RAILVEH_WAGON : RAILVEH_SINGLEHEAD;

   402

				}

   403

			} break;

   404

   405

			case 0x14: // Cargo capacity

   406

				rvi->capacity = grf_load_byte(&buf);

   407

				break;

   408

   409

			case 0x15: { // Cargo type

   410

				uint8 ctype = grf_load_byte(&buf);

   411

   412

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

   413

					rvi->cargo_type = ctype;

   414

				} else {

   415

					rvi->cargo_type = CT_INVALID;

   416

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

   417

				}

   418

			} break;

   419

   420

			case 0x16: // Weight

   421

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

   422

				break;

   423

   424

			case 0x17: // Cost factor

   425

				rvi->base_cost = grf_load_byte(&buf);

   426

				break;

   427

   428

			case 0x18: // AI rank

   429

				rvi->ai_rank = grf_load_byte(&buf);

   430

				break;

   431

   432

			case 0x19: { // Engine traction type

   433

				/* What do the individual numbers mean?

   434

				 * 0x00 .. 0x07: Steam

   435

				 * 0x08 .. 0x27: Diesel

   436

				 * 0x28 .. 0x31: Electric

   437

				 * 0x32 .. 0x37: Monorail

   438

				 * 0x38 .. 0x41: Maglev

   439

				 */

   440

				uint8 traction = grf_load_byte(&buf);

   441

				EngineClass engclass;

   442

   443

				if (traction <= 0x07) {

   444

					engclass = EC_STEAM;

   445

				} else if (traction <= 0x27) {

   446

					engclass = EC_DIESEL;

   447

				} else if (traction <= 0x31) {

   448

					engclass = EC_ELECTRIC;

   449

				} else if (traction <= 0x37) {

   450

					engclass = EC_MONORAIL;

   451

				} else if (traction <= 0x41) {

   452

					engclass = EC_MAGLEV;

   453

				} else {

   454

					break;

   455

				}

   456

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

   457

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

   458

   459

				rvi->engclass = engclass;

   460

			} break;

   461

   462

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

   463

				EngineID pos = grf_load_byte(&buf);

   464

   465

				if (pos < NUM_TRAIN_ENGINES) {

   466

					AlterRailVehListOrder(engine + i, pos);

   467

				} else {

   468

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

   469

				}

   470

			} break;

   471

   472

			case 0x1B: // Powered wagons power bonus

   473

				rvi->pow_wag_power = grf_load_word(&buf);

   474

				break;

   475

   476

			case 0x1C: // Refit cost

   477

				ei->refit_cost = grf_load_byte(&buf);

   478

				break;

   479

   480

			case 0x1D: // Refit cargo

   481

				ei->refit_mask = grf_load_dword(&buf);

   482

				break;

   483

   484

			case 0x1E: // Callback

   485

				ei->callbackmask = grf_load_byte(&buf);

   486

				break;

   487