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

#include "newgrf_canal.h"

    43

#include "newgrf_commons.h"

    44

    45

/* TTDPatch extended GRF format codec

    46

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

    47

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

    48

 *

    49

 * Contains portions of documentation by TTDPatch team.

    50

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

    51

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

    52

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

    53

    54

    55

static int _skip_sprites; // XXX

    56

static uint _file_index; // XXX

    57

SpriteID _signal_base;

    58

SpriteID _coast_base;

    59

    60

static GRFFile *_cur_grffile;

    61

GRFFile *_first_grffile;

    62

static SpriteID _cur_spriteid;

    63

static GrfLoadingStage _cur_stage;

    64

static uint32 _nfo_line;

    65

    66

static GRFConfig *_cur_grfconfig;

    67

    68

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

    69

static byte _misc_grf_features = 0;

    70

    71

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

    72

static uint32 _ttdpatch_flags[8];

    73

    74

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

    75

static byte *_preload_sprite = NULL;

    76

    79

    80

enum GrfDataType {

    81

	GDT_SOUND,

    82

};

    83

    84

static byte _grf_data_blocks;

    85

static GrfDataType _grf_data_type;

    86

    87

    88

enum grfspec_feature {

    89

	GSF_TRAIN,

    90

	GSF_ROAD,

    91

	GSF_SHIP,

    92

	GSF_AIRCRAFT,

    93

	GSF_STATION,

    94

	GSF_CANAL,

    95

	GSF_BRIDGE,

    96

	GSF_TOWNHOUSE,

    97

	GSF_GLOBALVAR,

    98

	GSF_INDUSTRYTILES,

    99

	GSF_INDUSTRIES,

   100

	GSF_CARGOS,

   101

	GSF_SOUNDFX,

   102

};

   103

   104

   105

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

   106

   107

static const uint _vehcounts[4] = {

   108

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

   109

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

   110

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

   111

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

   112

};

   113

   114

static const uint _vehshifts[4] = {

   115

	/* GSF_TRAIN */    0,

   116

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

   117

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

   118

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

   119

};

   120

   121

enum {

   122

	MAX_STATIONS = 256,

   123

};

   124

   125

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

   126

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

   127

   128

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

   129

static uint32 _grm_engines[TOTAL_NUM_ENGINES];

   130

   134

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

   135

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

   136

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

   137

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

   138

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

   139

 * is no file information available during that time.

   140

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

   141

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

   142

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

   143

{

   144

	char buf[1024];

   145

	va_list va;

   146

   147

	va_start(va, str);

   148

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

   149

	va_end(va);

   150

   151

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

   152

}

   153

   154

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

   155

{

   156

	if (real >= wanted) return true;

   157

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

   158

	return false;

   159

}

   160

   161

static inline byte grf_load_byte(byte **buf)

   162

{

   163

	return *(*buf)++;

   164

}

   165

   166

static uint16 grf_load_word(byte **buf)

   167

{

   168

	uint16 val = grf_load_byte(buf);

   169

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

   170

}

   171

   172

static uint16 grf_load_extended(byte** buf)

   173

{

   174

	uint16 val;

   175

	val = grf_load_byte(buf);

   176

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

   177

	return val;

   178

}

   179

   180

static uint32 grf_load_dword(byte **buf)

   181

{

   182

	uint32 val = grf_load_word(buf);

   183

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

   184

}

   185

   186

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

   187

{

   188

	switch (size) {

   189

		case 1: return grf_load_byte(buf);

   190

		case 2: return grf_load_word(buf);

   191

		case 4: return grf_load_dword(buf);

   192

		default:

   193

			NOT_REACHED();

   194

			return 0;

   195

	}

   196

}

   197

   198

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

   199

{

   200

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

   201

	size_t string_length = ttd_strnlen(string, max_len);

   202

   203

	if (string_length == max_len) {

   204

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

   205

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

   206

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

   207

	} else {

   208

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

   209

		string_length++;

   210

	}

   211

	*buf += string_length;

   212

   213

	return string;

   214

}

   215

   216

static GRFFile *GetFileByGRFID(uint32 grfid)

   217

{

   218

	GRFFile *file;

   219

   220

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

   221

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

   222

	}

   223

	return file;

   224

}

   225

   226

static GRFFile *GetFileByFilename(const char *filename)

   227

{

   228

	GRFFile *file;

   229

   230

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

   231

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

   232

	}

   233

	return file;

   234

}

   235

   236

   237

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

   238

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

   239

 * @param grfid Id of the grf file

   240

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

   241

 * @return the properly adjusted StringID

   242

 */

   243

static StringID MapGRFStringID(uint32 grfid, StringID str)

   244

{

   245

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

   246

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

   247

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

   248

	 * grfid in which they are declared */

   249

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

   250

		return GetGRFStringID(grfid, str);

   251

	}

   252

   253

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

   254

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

   255

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

   256

   257

	/* Map building names according to our lang file changes

   258

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

   259

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

   260

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

   261

	 * to compensate for the difference */

   262

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

   263

   264

	return str;

   265

}

   266

   267

static uint8 MapDOSColour(uint8 colour)

   268

{

   269

	if (_use_dos_palette) return colour;

   270

   271

	if (colour < 10) {

   272

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

   273

		return dos_to_win_colour_map[colour];

   274

	}

   275

   276

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

   277

   278

	return colour;

   279

}

   280

   281

   282

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

   283

   284

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

   285

   286

static void dewagonize(int condition, int engine)

   287

{

   288

	EngineInfo *ei = &_engine_info[engine];

   289

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   290

   291

	if (condition != 0) {

   292

		ei->unk2 &= ~0x80;

   293

		if (rvi->railveh_type == RAILVEH_WAGON)

   294

			rvi->railveh_type = RAILVEH_SINGLEHEAD;

   295

	} else {

   296

		ei->unk2 |= 0x80;

   297

		rvi->railveh_type = RAILVEH_WAGON;

   298

	}

   299

}

   300

   301

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

   302

{

   303

	EngineInfo *ei = &_engine_info[engine];

   304

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   305

	byte *buf = *bufp;

   306

	int i;

   307

	bool ret = false;

   308

   309

	switch (prop) {

   310

		case 0x05: // Track type

   311

			FOR_EACH_OBJECT {

   312

				uint8 tracktype = grf_load_byte(&buf);

   313

   314

				switch (tracktype) {

   315

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

   316

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

   317

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

   318

					default:

   319

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

   320

						break;

   321

				}

   322

			}

   323

			break;

   324

   325

		case 0x08: // AI passenger service

   326

			/* @todo missing feature */

   327

			FOR_EACH_OBJECT grf_load_byte(&buf);

   328

			ret = true;

   329

			break;

   330

   331

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

   332

			FOR_EACH_OBJECT {

   333

				uint16 speed = grf_load_word(&buf);

   334

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

   335

   336

				rvi[i].max_speed = speed;

   337

			}

   338

			break;

   339

   340

		case 0x0B: // Power

   341

			FOR_EACH_OBJECT {

   342

				uint16 power = grf_load_word(&buf);

   343

   344

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

   345

   346

				rvi[i].power = power;

   347

				dewagonize(power, engine + i);

   348

			}

   349

			break;

   350

   351

		case 0x0D: // Running cost factor

   352

			FOR_EACH_OBJECT {

   353

				uint8 runcostfact = grf_load_byte(&buf);

   354

   355

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

   356

   357

				rvi[i].running_cost_base = runcostfact;

   358

			}

   359

			break;

   360

   361

		case 0x0E: // Running cost base

   362

			FOR_EACH_OBJECT {

   363

				uint32 base = grf_load_dword(&buf);

   364

   365

				switch (base) {

   366

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

   367

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

   368

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

   369

					case 0: break; // Used by wagons

   370

					default:

   371

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

   372

						break;

   373

				}

   374

			}

   375

			break;

   376

   377

		case 0x12: // Sprite ID

   378

			FOR_EACH_OBJECT {

   379

				uint8 spriteid = grf_load_byte(&buf);

   380

   381

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

   382

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

   383

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

   384

   385

				rvi[i].image_index = spriteid;

   386

			}

   387

			break;

   388

   389

		case 0x13: // Dual-headed

   390

			FOR_EACH_OBJECT {

   391

				uint8 dual = grf_load_byte(&buf);

   392

   393

				if (dual != 0) {

   394

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

   395

						// adjust power and running cost if needed

   396

						rvi[i].power /= 2;

   397

						rvi[i].running_cost_base /= 2;

   398

					}

   399

					rvi[i].railveh_type = RAILVEH_MULTIHEAD;

   400

				} else {

   401

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

   402

						// adjust power and running cost if needed

   403

						rvi[i].power *= 2;

   404

						rvi[i].running_cost_base *= 2;

   405

					}

   406

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

   407

						RAILVEH_WAGON : RAILVEH_SINGLEHEAD;

   408

				}

   409

			}

   410

			break;

   411

   412

		case 0x14: // Cargo capacity

   413

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

   414

			break;

   415

   416

		case 0x15: // Cargo type

   417

			FOR_EACH_OBJECT {

   418

				uint8 ctype = grf_load_byte(&buf);

   419

   420

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

   421

					rvi[i].cargo_type = ctype;

   422

				} else {

   423

					rvi[i].cargo_type = CT_INVALID;

   424

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

   425

				}

   426

			}

   427

			break;

   428

   429

		case 0x16: // Weight

   430

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

   431

			break;

   432

   433

		case 0x17: // Cost factor

   434

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

   435

			break;

   436

   437

		case 0x18: // AI rank

   438

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

   439

			break;

   440

   441

		case 0x19: // Engine traction type

   442

			/* What do the individual numbers mean?

   443

			 * 0x00 .. 0x07: Steam

   444

			 * 0x08 .. 0x27: Diesel

   445

			 * 0x28 .. 0x31: Electric

   446

			 * 0x32 .. 0x37: Monorail

   447

			 * 0x38 .. 0x41: Maglev

   448

			 */

   449

			FOR_EACH_OBJECT {

   450

				uint8 traction = grf_load_byte(&buf);

   451

				EngineClass engclass;

   452

   453

				if (traction <= 0x07) {

   454

					engclass = EC_STEAM;

   455

				} else if (traction <= 0x27) {

   456

					engclass = EC_DIESEL;

   457

				} else if (traction <= 0x31) {

   458

					engclass = EC_ELECTRIC;

   459

				} else if (traction <= 0x37) {

   460

					engclass = EC_MONORAIL;

   461

				} else if (traction <= 0x41) {

   462

					engclass = EC_MAGLEV;

   463

				} else {

   464

					break;

   465

				}

   466

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

   467

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

   468

   469

				rvi[i].engclass = engclass;

   470

			}

   471

			break;

   472

   473

		case 0x1A: // Alter purchase list sort order

   474

			FOR_EACH_OBJECT {

   475

				EngineID pos = grf_load_byte(&buf);

   476

   477

				if (pos < NUM_TRAIN_ENGINES) {

   478

					AlterRailVehListOrder(engine + i, pos);

   479

				} else {

   480

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

   481

				}

   482

			}

   483

			break;

   484

   485

		case 0x1B: // Powered wagons power bonus

   486

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