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

#include "industry.h"

    42

    43

/* TTDPatch extended GRF format codec

    44

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

    45

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

    46

 *

    47

 * Contains portions of documentation by TTDPatch team.

    48

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

    49

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

    50

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

    51

    52

    53

static int _skip_sprites; // XXX

    54

static uint _file_index; // XXX

    55

SpriteID _signal_base;

    56

SpriteID _coast_base;

    57

    58

static GRFFile *_cur_grffile;

    59

GRFFile *_first_grffile;

    60

static SpriteID _cur_spriteid;

    61

static GrfLoadingStage _cur_stage;

    62

static uint32 _nfo_line;

    63

    64

static GRFConfig *_cur_grfconfig;

    65

    66

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

    67

static byte _misc_grf_features = 0;

    68

    69

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

    70

static uint32 _ttdpatch_flags[8];

    71

    72

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

    73

static byte *_preload_sprite = NULL;

    74

    75

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

    76

bool _have_2cc = false;

    77

    78

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

    79

bool _have_newhouses = false;

    80

    81

    82

enum GrfDataType {

    83

	GDT_SOUND,

    84

};

    85

    86

static byte _grf_data_blocks;

    87

static GrfDataType _grf_data_type;

    88

    89

    90

enum grfspec_feature {

    91

	GSF_TRAIN,

    92

	GSF_ROAD,

    93

	GSF_SHIP,

    94

	GSF_AIRCRAFT,

    95

	GSF_STATION,

    96

	GSF_CANAL,

    97

	GSF_BRIDGE,

    98

	GSF_TOWNHOUSE,

    99

	GSF_GLOBALVAR,

   100

	GSF_INDUSTRYTILES,

   101

	GSF_INDUSTRIES,

   102

	GSF_CARGOS,

   103

	GSF_SOUNDFX,

   104

};

   105

   106

   107

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

   108

   109

static const uint _vehcounts[4] = {

   110

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

   111

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

   112

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

   113

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

   114

};

   115

   116

static const uint _vehshifts[4] = {

   117

	/* GSF_TRAIN */    0,

   118

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

   119

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

   120

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

   121

};

   122

   123

enum {

   124

	MAX_STATIONS = 256,

   125

};

   126

   127

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

   128

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

   129

   130

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

   131

static uint32 _grm_engines[TOTAL_NUM_ENGINES];

   132

   133

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

   134

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

   135

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

   136

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

   137

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

   138

 * is no file information available during that time.

   139

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

   140

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

   141

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

   142

{

   143

	char buf[1024];

   144

	va_list va;

   145

   146

	va_start(va, str);

   147

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

   148

	va_end(va);

   149

   150

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

   151

}

   152

   153

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

   154

{

   155

	if (real >= wanted) return true;

   156

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

   157

	return false;

   158

}

   159

   160

static inline byte grf_load_byte(byte **buf)

   161

{

   162

	return *(*buf)++;

   163

}

   164

   165

static uint16 grf_load_word(byte **buf)

   166

{

   167

	uint16 val = grf_load_byte(buf);

   168

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

   169

}

   170

   171

static uint16 grf_load_extended(byte** buf)

   172

{

   173

	uint16 val;

   174

	val = grf_load_byte(buf);

   175

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

   176

	return val;

   177

}

   178

   179

static uint32 grf_load_dword(byte **buf)

   180

{

   181

	uint32 val = grf_load_word(buf);

   182

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

   183

}

   184

   185

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

   186

{

   187

	switch (size) {

   188

		case 1: return grf_load_byte(buf);

   189

		case 2: return grf_load_word(buf);

   190

		case 4: return grf_load_dword(buf);

   191

		default:

   192

			NOT_REACHED();

   193

			return 0;

   194

	}

   195

}

   196

   197

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

   198

{

   199

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

   200

	size_t string_length = ttd_strnlen(string, max_len);

   201

   202

	if (string_length == max_len) {

   203

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

   204

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

   205

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

   206

	} else {

   207

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

   208

		string_length++;

   209

	}

   210

	*buf += string_length;

   211

   212

	return string;

   213

}

   214

   215

static GRFFile *GetFileByGRFID(uint32 grfid)

   216

{

   217

	GRFFile *file;

   218

   219

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

   220

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

   221

	}

   222

	return file;

   223

}

   224

   225

static GRFFile *GetFileByFilename(const char *filename)

   226

{

   227

	GRFFile *file;

   228

   229

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

   230

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

   231

	}

   232

	return file;

   233

}

   234

   235

   236

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

   237

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

   238

 * @param grfid Id of the grf file

   239

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

   240

 * @return the properly adjusted StringID

   241

 */

   242

static StringID MapGRFStringID(uint32 grfid, StringID str)

   243

{

   244

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

   245

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

   246

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

   247

	 * grfid in which they are declared */

   248

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

   249

		return GetGRFStringID(grfid, str);

   250

	}

   251

   252

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

   253

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

   254

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

   255

   256

	/* Map building names according to our lang file changes

   257

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

   258

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

   259

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

   260

	 * to compensate for the difference */

   261

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

   262

   263

	return str;

   264

}

   265

   266

static uint8 MapDOSColour(uint8 colour)

   267

{

   268

	if (_use_dos_palette) return colour;

   269

   270

	if (colour < 10) {

   271

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

   272

		return dos_to_win_colour_map[colour];

   273

	}

   274

   275

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

   276

   277

	return colour;

   278

}

   279

   280

   281

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

   282

   283

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

   284

   285

static void dewagonize(int condition, int engine)

   286

{

   287

	EngineInfo *ei = &_engine_info[engine];

   288

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   289

   290

	if (condition != 0) {

   291

		ei->unk2 &= ~0x80;

   292

		if (rvi->railveh_type == RAILVEH_WAGON)

   293

			rvi->railveh_type = RAILVEH_SINGLEHEAD;

   294

	} else {

   295

		ei->unk2 |= 0x80;

   296

		rvi->railveh_type = RAILVEH_WAGON;

   297

	}

   298

}

   299

   300

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

   301

{

   302

	EngineInfo *ei = &_engine_info[engine];

   303

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   304

	byte *buf = *bufp;

   305

	int i;

   306

	bool ret = false;

   307

   308

	switch (prop) {

   309

		case 0x05: // Track type

   310

			FOR_EACH_OBJECT {

   311

				uint8 tracktype = grf_load_byte(&buf);

   312

   313

				switch (tracktype) {

   314

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

   315

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

   316

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

   317

					default:

   318

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

   319

						break;

   320

				}

   321

			}

   322

			break;

   323

   324

		case 0x08: // AI passenger service

   325

			/* @todo missing feature */

   326

			FOR_EACH_OBJECT grf_load_byte(&buf);

   327

			ret = true;

   328

			break;

   329

   330

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

   331

			FOR_EACH_OBJECT {

   332

				uint16 speed = grf_load_word(&buf);

   333

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

   334

   335

				rvi[i].max_speed = speed;

   336

			}

   337

			break;

   338

   339

		case 0x0B: // Power

   340

			FOR_EACH_OBJECT {

   341

				uint16 power = grf_load_word(&buf);

   342

   343

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

   344

   345

				rvi[i].power = power;

   346

				dewagonize(power, engine + i);

   347

			}

   348

			break;

   349

   350

		case 0x0D: // Running cost factor

   351

			FOR_EACH_OBJECT {

   352

				uint8 runcostfact = grf_load_byte(&buf);

   353

   354

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

   355

   356

				rvi[i].running_cost_base = runcostfact;

   357

			}

   358

			break;

   359

   360

		case 0x0E: // Running cost base

   361

			FOR_EACH_OBJECT {

   362

				uint32 base = grf_load_dword(&buf);

   363

   364

				switch (base) {

   365

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

   366

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

   367

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

   368

					case 0: break; // Used by wagons

   369

					default:

   370

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

   371

						break;

   372

				}

   373

			}

   374

			break;

   375

   376

		case 0x12: // Sprite ID

   377

			FOR_EACH_OBJECT {

   378

				uint8 spriteid = grf_load_byte(&buf);

   379

   380

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

   381

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

   382

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

   383

   384

				rvi[i].image_index = spriteid;

   385

			}

   386

			break;

   387

   388

		case 0x13: // Dual-headed

   389

			FOR_EACH_OBJECT {

   390

				uint8 dual = grf_load_byte(&buf);

   391

   392

				if (dual != 0) {

   393

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

   394

						// adjust power and running cost if needed

   395

						rvi[i].power /= 2;

   396

						rvi[i].running_cost_base /= 2;

   397

					}

   398

					rvi[i].railveh_type = RAILVEH_MULTIHEAD;

   399

				} else {

   400

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

   401

						// adjust power and running cost if needed

   402

						rvi[i].power *= 2;

   403

						rvi[i].running_cost_base *= 2;

   404

					}

   405

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

   406

						RAILVEH_WAGON : RAILVEH_SINGLEHEAD;

   407

				}

   408

			}

   409

			break;

   410

   411

		case 0x14: // Cargo capacity

   412

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

   413

			break;

   414

   415

		case 0x15: // Cargo type

   416

			FOR_EACH_OBJECT {

   417

				uint8 ctype = grf_load_byte(&buf);

   418

   419

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

   420

					rvi[i].cargo_type = ctype;

   421

				} else {

   422

					rvi[i].cargo_type = CT_INVALID;

   423

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

   424

				}

   425

			}

   426

			break;

   427

   428

		case 0x16: // Weight

   429

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

   430

			break;

   431

   432

		case 0x17: // Cost factor

   433

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

   434

			break;

   435

   436

		case 0x18: // AI rank

   437

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

   438

			break;

   439

   440

		case 0x19: // Engine traction type

   441

			/* What do the individual numbers mean?

   442

			 * 0x00 .. 0x07: Steam

   443

			 * 0x08 .. 0x27: Diesel

   444

			 * 0x28 .. 0x31: Electric

   445

			 * 0x32 .. 0x37: Monorail

   446

			 * 0x38 .. 0x41: Maglev

   447

			 */

   448

			FOR_EACH_OBJECT {

   449

				uint8 traction = grf_load_byte(&buf);

   450

				int engclass;

   451

   452

				if (traction <= 0x07) {

   453

					engclass = 0;

   454

				} else if (traction <= 0x27) {

   455

					engclass = 1;

   456

				} else if (traction <= 0x31) {

   457

					engclass = 2;

   458

				} else if (traction <= 0x41) {

   459

					engclass = 2;

   460

				} else {

   461

					break;

   462

				}

   463

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

   464

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

   465

   466

				rvi[i].engclass = engclass;

   467

			}

   468

			break;

   469

   470

		case 0x1A: // Alter purchase list sort order

   471

			FOR_EACH_OBJECT {

   472

				EngineID pos = grf_load_byte(&buf);

   473

   474

				if (pos < NUM_TRAIN_ENGINES) {

   475

					AlterRailVehListOrder(engine + i, pos);

   476

				} else {

   477

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

   478

				}

   479

			}

   480

			break;

   481

   482

		case 0x1B: // Powered wagons power bonus

   483

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

   484

			break;

   485

   486

		case 0x1C: // Refit cost