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

    45

#include "newgrf_townname.h"

    46

    47

/* TTDPatch extended GRF format codec

    48

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

    49

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

    50

 *

    51

 * Contains portions of documentation by TTDPatch team.

    52

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

    53

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

    54

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

    55

    56

    57

static int _skip_sprites; // XXX

    58

static uint _file_index; // XXX

    59

SpriteID _signal_base;

    60

SpriteID _coast_base;

    61

    62

static GRFFile *_cur_grffile;

    63

GRFFile *_first_grffile;

    64

static SpriteID _cur_spriteid;

    65

static GrfLoadingStage _cur_stage;

    66

static uint32 _nfo_line;

    67

    68

static GRFConfig *_cur_grfconfig;

    69

    70

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

    71

static byte _misc_grf_features = 0;

    72

    73

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

    74

static uint32 _ttdpatch_flags[8];

    75

    76

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

    77

static byte *_preload_sprite = NULL;

    78

    79

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

    80

GRFLoadedFeatures _loaded_newgrf_features;

    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

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

   134

static uint32 _grm_cargos[NUM_CARGO];

   135

   136

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

   137

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

   138

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

   139

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

   140

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

   141

 * is no file information available during that time.

   142

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

   143

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

   144

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

   145

{

   146

	char buf[1024];

   147

	va_list va;

   148

   149

	va_start(va, str);

   150

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

   151

	va_end(va);

   152

   153

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

   154

}

   155

   156

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

   157

{

   158

	if (real >= wanted) return true;

   159

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

   160

	return false;

   161

}

   162

   163

static inline byte grf_load_byte(byte **buf)

   164

{

   165

	return *(*buf)++;

   166

}

   167

   168

static uint16 grf_load_word(byte **buf)

   169

{

   170

	uint16 val = grf_load_byte(buf);

   171

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

   172

}

   173

   174

static uint16 grf_load_extended(byte** buf)

   175

{

   176

	uint16 val;

   177

	val = grf_load_byte(buf);

   178

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

   179

	return val;

   180

}

   181

   182

static uint32 grf_load_dword(byte **buf)

   183

{

   184

	uint32 val = grf_load_word(buf);

   185

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

   186

}

   187

   188

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

   189

{

   190

	switch (size) {

   191

		case 1: return grf_load_byte(buf);

   192

		case 2: return grf_load_word(buf);

   193

		case 4: return grf_load_dword(buf);

   194

		default:

   195

			NOT_REACHED();

   196

			return 0;

   197

	}

   198

}

   199

   200

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

   201

{

   202

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

   203

	size_t string_length = ttd_strnlen(string, max_len);

   204

   205

	if (string_length == max_len) {

   206

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

   207

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

   208

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

   209

	} else {

   210

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

   211

		string_length++;

   212

	}

   213

	*buf += string_length;

   214

   215

	return string;

   216

}

   217

   218

static GRFFile *GetFileByGRFID(uint32 grfid)

   219

{

   220

	GRFFile *file;

   221

   222

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

   223

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

   224

	}

   225

	return file;

   226

}

   227

   228

static GRFFile *GetFileByFilename(const char *filename)

   229

{

   230

	GRFFile *file;

   231

   232

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

   233

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

   234

	}

   235

	return file;

   236

}

   237

   238

   239

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

   240

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

   241

 * @param grfid Id of the grf file

   242

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

   243

 * @return the properly adjusted StringID

   244

 */

   245

static StringID MapGRFStringID(uint32 grfid, StringID str)

   246

{

   247

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

   248

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

   249

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

   250

	 * grfid in which they are declared */

   251

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

   252

		return GetGRFStringID(grfid, str);

   253

	}

   254

   255

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

   256

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

   257

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

   258

   259

	/* Map building names according to our lang file changes

   260

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

   261

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

   262

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

   263

	 * to compensate for the difference */

   264

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

   265

   266

	return str;

   267

}

   268

   269

static uint8 MapDOSColour(uint8 colour)

   270

{

   271

	if (_use_dos_palette) return colour;

   272

   273

	if (colour < 10) {

   274

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

   275

		return dos_to_win_colour_map[colour];

   276

	}

   277

   278

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

   279

   280

	return colour;

   281

}

   282

   283

   284

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

   285

   286

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

   287

   288

static void dewagonize(int condition, int engine)

   289

{

   290

	EngineInfo *ei = &_engine_info[engine];

   291

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   292

   293

	if (condition != 0) {

   294

		ei->unk2 &= ~0x80;

   295

		if (rvi->railveh_type == RAILVEH_WAGON)

   296

			rvi->railveh_type = RAILVEH_SINGLEHEAD;

   297

	} else {

   298

		ei->unk2 |= 0x80;

   299

		rvi->railveh_type = RAILVEH_WAGON;

   300

	}

   301

}

   302

   303

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

   304

{

   305

	EngineInfo *ei = &_engine_info[engine];

   306

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   307

	byte *buf = *bufp;

   308

	int i;

   309

	bool ret = false;

   310

   311

	switch (prop) {

   312

		case 0x05: // Track type

   313

			FOR_EACH_OBJECT {

   314

				uint8 tracktype = grf_load_byte(&buf);

   315

   316

				switch (tracktype) {

   317

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

   318

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

   319

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

   320

					default:

   321

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

   322

						break;

   323

				}

   324

			}

   325

			break;

   326

   327

		case 0x08: // AI passenger service

   328

			/* @todo missing feature */

   329

			FOR_EACH_OBJECT grf_load_byte(&buf);

   330

			ret = true;

   331

			break;

   332

   333

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

   334

			FOR_EACH_OBJECT {

   335

				uint16 speed = grf_load_word(&buf);

   336

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

   337

   338

				rvi[i].max_speed = speed;

   339

			}

   340

			break;

   341

   342

		case 0x0B: // Power

   343

			FOR_EACH_OBJECT {

   344

				uint16 power = grf_load_word(&buf);

   345

   346

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

   347

   348

				rvi[i].power = power;

   349

				dewagonize(power, engine + i);

   350

			}

   351

			break;

   352

   353

		case 0x0D: // Running cost factor

   354

			FOR_EACH_OBJECT {

   355

				uint8 runcostfact = grf_load_byte(&buf);

   356

   357

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

   358

   359

				rvi[i].running_cost_base = runcostfact;

   360

			}

   361

			break;

   362

   363

		case 0x0E: // Running cost base

   364

			FOR_EACH_OBJECT {

   365

				uint32 base = grf_load_dword(&buf);

   366

   367

				switch (base) {

   368

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

   369

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

   370

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

   371

					case 0: break; // Used by wagons

   372

					default:

   373

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

   374

						break;

   375

				}

   376

			}

   377

			break;

   378

   379

		case 0x12: // Sprite ID

   380

			FOR_EACH_OBJECT {

   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[i].image_index = spriteid;

   388

			}

   389

			break;

   390

   391

		case 0x13: // Dual-headed

   392

			FOR_EACH_OBJECT {

   393

				uint8 dual = grf_load_byte(&buf);

   394

   395

				if (dual != 0) {

   396

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

   397

						// adjust power and running cost if needed

   398

						rvi[i].power /= 2;

   399

						rvi[i].running_cost_base /= 2;

   400

					}

   401

					rvi[i].railveh_type = RAILVEH_MULTIHEAD;

   402

				} else {

   403

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

   404

						// adjust power and running cost if needed

   405

						rvi[i].power *= 2;

   406

						rvi[i].running_cost_base *= 2;

   407

					}

   408

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

   409

						RAILVEH_WAGON : RAILVEH_SINGLEHEAD;

   410

				}

   411

			}

   412

			break;

   413

   414

		case 0x14: // Cargo capacity

   415

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

   416

			break;

   417

   418

		case 0x15: // Cargo type

   419

			FOR_EACH_OBJECT {

   420

				uint8 ctype = grf_load_byte(&buf);

   421

   422

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

   423

					rvi[i].cargo_type = ctype;

   424

				} else {

   425

					rvi[i].cargo_type = CT_INVALID;

   426

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

   427

				}

   428

			}

   429

			break;

   430

   431

		case 0x16: // Weight

   432

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

   433

			break;

   434

   435

		case 0x17: // Cost factor

   436

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

   437

			break;

   438

   439

		case 0x18: // AI rank

   440

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

   441

			break;

   442

   443

		case 0x19: // Engine traction type

   444

			/* What do the individual numbers mean?

   445

			 * 0x00 .. 0x07: Steam

   446

			 * 0x08 .. 0x27: Diesel

   447

			 * 0x28 .. 0x31: Electric

   448

			 * 0x32 .. 0x37: Monorail

   449

			 * 0x38 .. 0x41: Maglev

   450

			 */

   451

			FOR_EACH_OBJECT {

   452

				uint8 traction = grf_load_byte(&buf);

   453

				EngineClass engclass;

   454

   455

				if (traction <= 0x07) {

   456

					engclass = EC_STEAM;

   457

				} else if (traction <= 0x27) {

   458

					engclass = EC_DIESEL;

   459

				} else if (traction <= 0x31) {

   460

					engclass = EC_ELECTRIC;

   461

				} else if (traction <= 0x37) {

   462

					engclass = EC_MONORAIL;

   463

				} else if (traction <= 0x41) {

   464

					engclass = EC_MAGLEV;

   465

				} else {

   466

					break;

   467

				}

   468

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

   469

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

   470

   471

				rvi[i].engclass = engclass;

   472

			}

   473

			break;

   474

   475

		case 0x1A: // Alter purchase list sort order

   476

			FOR_EACH_OBJECT {

   477

				EngineID pos = grf_load_byte(&buf);

   478

   479

				if (pos < NUM_TRAIN_ENGINES) {

   480

					AlterRailVehListOrder(engine + i, pos);

   481

				} else {

   482

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

   483

				}

   484

			}

   485

			break;

   486

   487

		case 0x1B: // Powered wagons power bonus

   488

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

   489

			break;

   490

   491

		case 0x1C: // Refit cost