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"

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

    45

    46

/* TTDPatch extended GRF format codec

    47

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

    48

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

    49

 *

    50

 * Contains portions of documentation by TTDPatch team.

    51

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

    52

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

    53

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

    54

    55

    56

static int _skip_sprites; // XXX

    57

static uint _file_index; // XXX

    58

SpriteID _signal_base;

    59

SpriteID _coast_base;

    60

    61

static GRFFile *_cur_grffile;

    62

GRFFile *_first_grffile;

    63

static SpriteID _cur_spriteid;

    64

static GrfLoadingStage _cur_stage;

    65

static uint32 _nfo_line;

    66

    67

static GRFConfig *_cur_grfconfig;

    68

    69

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

    70

static byte _misc_grf_features = 0;

    71

    72

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

    73

static uint32 _ttdpatch_flags[8];

    74

    75

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

    76

static byte *_preload_sprite = NULL;

    77

    78

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

    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

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

   133

static uint32 _grm_cargos[NUM_CARGO];

   134

   135

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

   136

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

   137

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

   138

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

   139

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

   140

 * is no file information available during that time.

   141

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

   142

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

   143

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

   144

{

   145

	char buf[1024];

   146

	va_list va;

   147

   148

	va_start(va, str);

   149

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

   150

	va_end(va);

   151

   152

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

   153

}

   154

   155

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

   156

{

   157

	if (real >= wanted) return true;

   158

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

   159

	return false;

   160

}

   161

   162

static inline byte grf_load_byte(byte **buf)

   163

{

   164

	return *(*buf)++;

   165

}

   166

   167

static uint16 grf_load_word(byte **buf)

   168

{

   169

	uint16 val = grf_load_byte(buf);

   170

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

   171

}

   172

   173

static uint16 grf_load_extended(byte** buf)

   174

{

   175

	uint16 val;

   176

	val = grf_load_byte(buf);

   177

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

   178

	return val;

   179

}

   180

   181

static uint32 grf_load_dword(byte **buf)

   182

{

   183

	uint32 val = grf_load_word(buf);

   184

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

   185

}

   186

   187

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

   188

{

   189

	switch (size) {

   190

		case 1: return grf_load_byte(buf);

   191

		case 2: return grf_load_word(buf);

   192

		case 4: return grf_load_dword(buf);

   193

		default:

   194

			NOT_REACHED();

   195

			return 0;

   196

	}

   197

}

   198

   199

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

   200

{

   201

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

   202

	size_t string_length = ttd_strnlen(string, max_len);

   203

   204

	if (string_length == max_len) {

   205

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

   206

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

   207

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

   208

	} else {

   209

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

   210

		string_length++;

   211

	}

   212

	*buf += string_length;

   213

   214

	return string;

   215

}

   216

   217

static GRFFile *GetFileByGRFID(uint32 grfid)

   218

{

   219

	GRFFile *file;

   220

   221

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

   222

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

   223

	}

   224

	return file;

   225

}

   226

   227

static GRFFile *GetFileByFilename(const char *filename)

   228

{

   229

	GRFFile *file;

   230

   231

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

   232

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

   233

	}

   234

	return file;

   235

}

   236

   237

   238

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

   239

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

   240

 * @param grfid Id of the grf file

   241

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

   242

 * @return the properly adjusted StringID

   243

 */

   244

static StringID MapGRFStringID(uint32 grfid, StringID str)

   245

{

   246

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

   247

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

   248

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

   249

	 * grfid in which they are declared */

   250

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

   251

		return GetGRFStringID(grfid, str);

   252

	}

   253

   254

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

   255

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

   256

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

   257

   258

	/* Map building names according to our lang file changes

   259

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

   260

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

   261

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

   262

	 * to compensate for the difference */

   263

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

   264

   265

	return str;

   266

}

   267

   268

static uint8 MapDOSColour(uint8 colour)

   269

{

   270

	if (_use_dos_palette) return colour;

   271

   272

	if (colour < 10) {

   273

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

   274

		return dos_to_win_colour_map[colour];

   275

	}

   276

   277

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

   278

   279

	return colour;

   280

}

   281

   282

   283

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

   284

   285

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

   286

   287

static void dewagonize(int condition, int engine)

   288

{

   289

	EngineInfo *ei = &_engine_info[engine];

   290

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   291

   292

	if (condition != 0) {

   293

		ei->unk2 &= ~0x80;

   294

		if (rvi->railveh_type == RAILVEH_WAGON)

   295

			rvi->railveh_type = RAILVEH_SINGLEHEAD;

   296

	} else {

   297

		ei->unk2 |= 0x80;

   298

		rvi->railveh_type = RAILVEH_WAGON;

   299

	}

   300

}

   301

   302

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

   303

{

   304

	EngineInfo *ei = &_engine_info[engine];

   305

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   306

	byte *buf = *bufp;

   307

	int i;

   308

	bool ret = false;

   309

   310

	switch (prop) {

   311

		case 0x05: // Track type

   312

			FOR_EACH_OBJECT {

   313

				uint8 tracktype = grf_load_byte(&buf);

   314

   315

				switch (tracktype) {

   316

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

   317

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

   318

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

   319

					default:

   320

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

   321

						break;

   322

				}

   323

			}

   324

			break;

   325

   326

		case 0x08: // AI passenger service

   327

			/* @todo missing feature */

   328

			FOR_EACH_OBJECT grf_load_byte(&buf);

   329

			ret = true;

   330

			break;

   331

   332

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

   333

			FOR_EACH_OBJECT {

   334

				uint16 speed = grf_load_word(&buf);

   335

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

   336

   337

				rvi[i].max_speed = speed;

   338

			}

   339

			break;

   340

   341

		case 0x0B: // Power

   342

			FOR_EACH_OBJECT {

   343

				uint16 power = grf_load_word(&buf);

   344

   345

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

   346

   347

				rvi[i].power = power;

   348

				dewagonize(power, engine + i);

   349

			}

   350

			break;

   351

   352

		case 0x0D: // Running cost factor

   353

			FOR_EACH_OBJECT {

   354

				uint8 runcostfact = grf_load_byte(&buf);

   355

   356

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

   357

   358

				rvi[i].running_cost_base = runcostfact;

   359

			}

   360

			break;

   361

   362

		case 0x0E: // Running cost base

   363

			FOR_EACH_OBJECT {

   364

				uint32 base = grf_load_dword(&buf);

   365

   366

				switch (base) {

   367

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

   368

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

   369

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

   370

					case 0: break; // Used by wagons

   371

					default:

   372

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

   373

						break;

   374

				}

   375

			}

   376

			break;

   377

   378

		case 0x12: // Sprite ID

   379

			FOR_EACH_OBJECT {

   380

				uint8 spriteid = grf_load_byte(&buf);

   381

   382

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

   383

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

   384

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

   385

   386

				rvi[i].image_index = spriteid;

   387

			}

   388

			break;

   389

   390

		case 0x13: // Dual-headed

   391

			FOR_EACH_OBJECT {

   392

				uint8 dual = grf_load_byte(&buf);

   393

   394

				if (dual != 0) {

   395

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

   396

						// adjust power and running cost if needed

   397

						rvi[i].power /= 2;

   398

						rvi[i].running_cost_base /= 2;

   399

					}

   400

					rvi[i].railveh_type = RAILVEH_MULTIHEAD;

   401

				} else {

   402

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

   403

						// adjust power and running cost if needed

   404

						rvi[i].power *= 2;

   405

						rvi[i].running_cost_base *= 2;

   406

					}

   407

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

   408

						RAILVEH_WAGON : RAILVEH_SINGLEHEAD;

   409

				}

   410

			}

   411

			break;

   412

   413

		case 0x14: // Cargo capacity

   414

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

   415

			break;

   416

   417

		case 0x15: // Cargo type

   418

			FOR_EACH_OBJECT {

   419

				uint8 ctype = grf_load_byte(&buf);

   420

   421

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

   422

					rvi[i].cargo_type = ctype;

   423

				} else {

   424

					rvi[i].cargo_type = CT_INVALID;

   425

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

   426

				}

   427

			}

   428

			break;

   429

   430

		case 0x16: // Weight

   431

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

   432

			break;

   433

   434

		case 0x17: // Cost factor

   435

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

   436

			break;

   437

   438

		case 0x18: // AI rank

   439

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

   440

			break;

   441

   442

		case 0x19: // Engine traction type

   443

			/* What do the individual numbers mean?

   444

			 * 0x00 .. 0x07: Steam

   445

			 * 0x08 .. 0x27: Diesel

   446

			 * 0x28 .. 0x31: Electric

   447

			 * 0x32 .. 0x37: Monorail

   448

			 * 0x38 .. 0x41: Maglev

   449

			 */

   450

			FOR_EACH_OBJECT {

   451

				uint8 traction = grf_load_byte(&buf);

   452

				EngineClass engclass;

   453

   454

				if (traction <= 0x07) {

   455

					engclass = EC_STEAM;

   456

				} else if (traction <= 0x27) {

   457

					engclass = EC_DIESEL;

   458

				} else if (traction <= 0x31) {

   459

					engclass = EC_ELECTRIC;

   460

				} else if (traction <= 0x37) {

   461

					engclass = EC_MONORAIL;

   462

				} else if (traction <= 0x41) {

   463

					engclass = EC_MAGLEV;

   464

				} else {

   465

					break;

   466

				}

   467

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

   468

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

   469

   470

				rvi[i].engclass = engclass;

   471

			}

   472

			break;

   473

   474

		case 0x1A: // Alter purchase list sort order

   475

			FOR_EACH_OBJECT {

   476

				EngineID pos = grf_load_byte(&buf);

   477

   478

				if (pos < NUM_TRAIN_ENGINES) {

   479

					AlterRailVehListOrder(engine + i, pos);

   480

				} else {

   481

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

   482

				}

   483

			}

   484

			break;

   485

   486

		case 0x1B: // Powered wagons power bonus