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 "table/strings.h"

    22

#include "bridge.h"

    23

#include "town.h"

    24

#include "economy.h"

    25

#include "newgrf_engine.h"

    26

#include "vehicle.h"

    27

#include "newgrf_text.h"

    28

#include "table/sprites.h"

    29

#include "fontcache.h"

    30

#include "date.h"

    31

#include "currency.h"

    32

#include "landscape.h"

    33

#include "sound.h"

    34

#include "newgrf_config.h"

    35

#include "newgrf_house.h"

    36

#include "newgrf_sound.h"

    37

#include "newgrf_spritegroup.h"

    38

#include "helpers.hpp"

    39

#include "table/town_land.h"

    40

#include "cargotype.h"

    41

    42

/* TTDPatch extended GRF format codec

    43

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

    44

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

    45

 *

    46

 * Contains portions of documentation by TTDPatch team.

    47

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

    48

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

    49

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

    50

    51

    52

static int _skip_sprites; // XXX

    53

static uint _file_index; // XXX

    54

SpriteID _signal_base;

    55

SpriteID _coast_base;

    56

    57

static GRFFile *_cur_grffile;

    58

GRFFile *_first_grffile;

    59

static SpriteID _cur_spriteid;

    60

static GrfLoadingStage _cur_stage;

    61

static uint32 _nfo_line;

    62

    63

static GRFConfig *_cur_grfconfig;

    64

    65

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

    66

static byte _misc_grf_features = 0;

    67

    68

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

    69

static uint32 _ttdpatch_flags[8];

    70

    71

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

    72

static byte *_preload_sprite = NULL;

    73

    74

/* Set if any vehicle is loaded which uses 2cc (two company colours) */

    75

bool _have_2cc = false;

    76

    77

/* Set if there are any newhouses loaded. */

    78

bool _have_newhouses = false;

    79

    80

    81

enum GrfDataType {

    82

	GDT_SOUND,

    83

};

    84

    85

static byte _grf_data_blocks;

    86

static GrfDataType _grf_data_type;

    87

    88

    89

enum grfspec_feature {

    90

	GSF_TRAIN,

    91

	GSF_ROAD,

    92

	GSF_SHIP,

    93

	GSF_AIRCRAFT,

    94

	GSF_STATION,

    95

	GSF_CANAL,

    96

	GSF_BRIDGE,

    97

	GSF_TOWNHOUSE,

    98

	GSF_GLOBALVAR,

    99

	GSF_INDUSTRYTILES,

   100

	GSF_INDUSTRIES,

   101

	GSF_CARGOS,

   102

	GSF_SOUNDFX,

   103

};

   104

   105

   106

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

   107

   108

static const uint _vehcounts[4] = {

   109

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

   110

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

   111

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

   112

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

   113

};

   114

   115

static const uint _vehshifts[4] = {

   116

	/* GSF_TRAIN */    0,

   117

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

   118

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

   119

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

   120

};

   121

   122

enum {

   123

	MAX_STATIONS = 256,

   124

};

   125

   126

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

   127

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

   128

   129

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

   130

static uint32 _grm_engines[TOTAL_NUM_ENGINES];

   131

   132

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

   133

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

   134

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

   135

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

   136

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

   137

 * is no file information available during that time.

   138

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

   140

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

   141

{

   142

	char buf[1024];

   143

	va_list va;

   144

   145

	va_start(va, str);

   146

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

   147

	va_end(va);

   148

   149

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

   150

}

   151

   152

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

   153

{

   154

	if (real >= wanted) return true;

   155

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

   156

	return false;

   157

}

   158

   159

static inline byte grf_load_byte(byte **buf)

   160

{

   161

	return *(*buf)++;

   162

}

   163

   164

static uint16 grf_load_word(byte **buf)

   165

{

   166

	uint16 val = grf_load_byte(buf);

   167

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

   168

}

   169

   170

static uint16 grf_load_extended(byte** buf)

   171

{

   172

	uint16 val;

   173

	val = grf_load_byte(buf);

   174

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

   175

	return val;

   176

}

   177

   178

static uint32 grf_load_dword(byte **buf)

   179

{

   180

	uint32 val = grf_load_word(buf);

   181

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

   182

}

   183

   184

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

   185

{

   186

	switch (size) {

   187

		case 1: return grf_load_byte(buf);

   188

		case 2: return grf_load_word(buf);

   189

		case 4: return grf_load_dword(buf);

   190

		default:

   191

			NOT_REACHED();

   192

			return 0;

   193

	}

   194

}

   195

   196

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

   197

{

   198

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

   199

	size_t string_length = ttd_strnlen(string, max_len);

   200

   201

	if (string_length == max_len) {

   202

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

   203

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

   204

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

   205

	} else {

   206

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

   207

		string_length++;

   208

	}

   209

	*buf += string_length;

   210

   211

	return string;

   212

}

   213

   214

static GRFFile *GetFileByGRFID(uint32 grfid)

   215

{

   216

	GRFFile *file;

   217

   218

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

   219

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

   220

	}

   221

	return file;

   222

}

   223

   224

static GRFFile *GetFileByFilename(const char *filename)

   225

{

   226

	GRFFile *file;

   227

   228

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

   229

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

   230

	}

   231

	return file;

   232

}

   233

   234

   235

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

   236

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

   238

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

   239

 * @return the properly adjusted StringID

   240

 */

   241

static StringID MapGRFStringID(uint32 grfid, StringID str)

   242

{

   243

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

   244

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

   245

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

   246

	 * grfid in which they are declared */

   247

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

   248

		return GetGRFStringID(grfid, str);

   249

	}

   250

   251

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

   252

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

   253

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

   254

   255

	/* Map building names according to our lang file changes

   256

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

   257

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

   258

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

   259

	 * to compensate for the difference */

   260

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

   261

   262

	return str;

   263

}

   264

   265

static uint8 MapDOSColour(uint8 colour)

   266

{

   267

	if (_use_dos_palette) return colour;

   268

   269

	if (colour < 10) {

   270

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

   271

		return dos_to_win_colour_map[colour];

   272

	}

   273

   274

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

   275

   276

	return colour;

   277

}

   278

   279

   280

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

   281

   282

#define FOR_EACH_OBJECT for (i = 0; i < numinfo; i++)

   283

   284

static void dewagonize(int condition, int engine)

   285

{

   286

	EngineInfo *ei = &_engine_info[engine];

   287

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   288

   289

	if (condition != 0) {

   290

		ei->unk2 &= ~0x80;

   291

		if (rvi->railveh_type == RAILVEH_WAGON)

   292

			rvi->railveh_type = RAILVEH_SINGLEHEAD;

   293

	} else {

   294

		ei->unk2 |= 0x80;

   295

		rvi->railveh_type = RAILVEH_WAGON;

   296

	}

   297

}

   298

   299

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

   300

{

   301

	EngineInfo *ei = &_engine_info[engine];

   302

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   303

	byte *buf = *bufp;

   304

	int i;

   305

	bool ret = false;

   306

   307

	switch (prop) {

   308

		case 0x05: // Track type

   309

			FOR_EACH_OBJECT {

   310

				uint8 tracktype = grf_load_byte(&buf);

   311

   312

				switch (tracktype) {

   313

					case 0: rvi[i].railtype = rvi[i].engclass == 2 ? RAILTYPE_ELECTRIC : RAILTYPE_RAIL; break;

   314

					case 1: rvi[i].railtype = RAILTYPE_MONO; break;

   315

					case 2: rvi[i].railtype = RAILTYPE_MAGLEV; break;

   316

					default:

   317

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

   318

						break;

   319

				}

   320

			}

   321

			break;

   322

   323

		case 0x08: // AI passenger service

   324

			/* @todo missing feature */

   325

			FOR_EACH_OBJECT grf_load_byte(&buf);

   326

			ret = true;

   327

			break;

   328

   329

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

   330

			FOR_EACH_OBJECT {

   331

				uint16 speed = grf_load_word(&buf);

   332

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

   333

   334

				rvi[i].max_speed = speed;

   335

			}

   336

			break;

   337

   338

		case 0x0B: // Power

   339

			FOR_EACH_OBJECT {

   340

				uint16 power = grf_load_word(&buf);

   341

   342

				if (rvi[i].railveh_type == RAILVEH_MULTIHEAD) power /= 2;

   343

   344

				rvi[i].power = power;

   345

				dewagonize(power, engine + i);

   346

			}

   347

			break;

   348

   349

		case 0x0D: // Running cost factor

   350

			FOR_EACH_OBJECT {

   351

				uint8 runcostfact = grf_load_byte(&buf);

   352

   353

				if (rvi[i].railveh_type == RAILVEH_MULTIHEAD) runcostfact /= 2;

   354

   355

				rvi[i].running_cost_base = runcostfact;

   356

			}

   357

			break;

   358

   359

		case 0x0E: // Running cost base

   360

			FOR_EACH_OBJECT {

   361

				uint32 base = grf_load_dword(&buf);

   362

   363

				switch (base) {

   364

					case 0x4C30: rvi[i].running_cost_class = 0; break;

   365

					case 0x4C36: rvi[i].running_cost_class = 1; break;

   366

					case 0x4C3C: rvi[i].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

			}

   373

			break;

   374

   375

		case 0x12: // Sprite ID

   376

			FOR_EACH_OBJECT {

   377

				uint8 spriteid = grf_load_byte(&buf);

   378

   379

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

   380

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

   381

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

   382

   383

				rvi[i].image_index = spriteid;

   384

			}

   385

			break;

   386

   387

		case 0x13: // Dual-headed

   388

			FOR_EACH_OBJECT {

   389

				uint8 dual = grf_load_byte(&buf);

   390

   391

				if (dual != 0) {

   392

					if (rvi[i].railveh_type != RAILVEH_MULTIHEAD) {

   393

						// adjust power and running cost if needed

   394

						rvi[i].power /= 2;

   395

						rvi[i].running_cost_base /= 2;

   396

					}

   397

					rvi[i].railveh_type = RAILVEH_MULTIHEAD;

   398

				} else {

   399

					if (rvi[i].railveh_type == RAILVEH_MULTIHEAD) {

   400

						// adjust power and running cost if needed

   401

						rvi[i].power *= 2;

   402

						rvi[i].running_cost_base *= 2;

   403

					}

   404

					rvi[i].railveh_type = rvi[i].power == 0 ?

   405

						RAILVEH_WAGON : RAILVEH_SINGLEHEAD;

   406

				}

   407

			}

   408

			break;

   409

   410

		case 0x14: // Cargo capacity

   411

			FOR_EACH_OBJECT rvi[i].capacity = grf_load_byte(&buf);

   412

			break;

   413

   414

		case 0x15: // Cargo type

   415

			FOR_EACH_OBJECT {

   416

				uint8 ctype = grf_load_byte(&buf);

   417

   418

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

   419

					rvi[i].cargo_type = ctype;

   420

				} else {

   421

					rvi[i].cargo_type = CT_INVALID;

   422

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

   423

				}

   424

			}

   425

			break;

   426

   427

		case 0x16: // Weight

   428

			FOR_EACH_OBJECT SB(rvi[i].weight, 0, 8, grf_load_byte(&buf));

   429

			break;

   430

   431

		case 0x17: // Cost factor

   432

			FOR_EACH_OBJECT rvi[i].base_cost = grf_load_byte(&buf);

   433

			break;

   434

   435

		case 0x18: // AI rank

   436

			FOR_EACH_OBJECT rvi[i].ai_rank = grf_load_byte(&buf);

   437

			break;

   438

   439

		case 0x19: // Engine traction type

   440

			/* What do the individual numbers mean?

   441

			 * 0x00 .. 0x07: Steam

   442

			 * 0x08 .. 0x27: Diesel

   443

			 * 0x28 .. 0x31: Electric

   444

			 * 0x32 .. 0x37: Monorail

   445

			 * 0x38 .. 0x41: Maglev

   446

			 */

   447

			FOR_EACH_OBJECT {

   448

				uint8 traction = grf_load_byte(&buf);

   449

				int engclass;

   450

   451

				if (traction <= 0x07) {

   452

					engclass = 0;

   453

				} else if (traction <= 0x27) {

   454

					engclass = 1;

   455

				} else if (traction <= 0x31) {

   456

					engclass = 2;

   457

				} else if (traction <= 0x41) {

   458

					engclass = 2;

   459

				} else {

   460

					break;

   461

				}

   462

				if (rvi[i].railtype == RAILTYPE_RAIL     && engclass == 2) rvi[i].railtype = RAILTYPE_ELECTRIC;

   463

				if (rvi[i].railtype == RAILTYPE_ELECTRIC && engclass != 2) rvi[i].railtype = RAILTYPE_RAIL;

   464

   465

				rvi[i].engclass = engclass;

   466

			}

   467

			break;

   468

   469

		case 0x1A: // Alter purchase list sort order

   470

			FOR_EACH_OBJECT {

   471

				EngineID pos = grf_load_byte(&buf);

   472

   473

				if (pos < NUM_TRAIN_ENGINES) {

   474

					AlterRailVehListOrder(engine + i, pos);

   475

				} else {

   476

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

   477

				}

   478

			}

   479

			break;

   480

   481

		case 0x1B: // Powered wagons power bonus

   482

			FOR_EACH_OBJECT rvi[i].pow_wag_power = grf_load_word(&buf);

   483

			break;

   484

   485

		case 0x1C: // Refit cost

   486

			FOR_EACH_OBJECT ei[i].refit_cost = grf_load_byte(&buf);

   487

			break;