1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "currency.h"

     6

#include "functions.h"

     7

#include "string.h"

     8

#include "strings.h"

     9

#include "table/strings.h"

    10

#include "namegen.h"

    11

#include "station.h"

    12

#include "town.h"

    13

#include "vehicle.h"

    14

#include "news.h"

    15

#include "screenshot.h"

    16

#include "waypoint.h"

    17

#include "industry.h"

    18

#include "variables.h"

    19

#include "newgrf_text.h"

    21

    22

char _userstring[128];

    23

    24

static char *StationGetSpecialString(char *buff, int x);

    25

static char *GetSpecialTownNameString(char *buff, int ind, uint32 seed);

    26

static char *GetSpecialPlayerNameString(char *buff, int ind, const int32 *argv);

    27

    28

static char *FormatString(char *buff, const char *str, const int32 *argv, uint casei);

    29

    30

extern const char _openttd_revision[];

    31

    32

typedef struct LanguagePack {

    33

	uint32 ident;

    34

	uint32 version;			// 32-bits of auto generated version info which is basically a hash of strings.h

    35

	char name[32];			// the international name of this language

    36

	char own_name[32];	// the localized name of this language

    37

	char isocode[16];	// the ISO code for the language (not country code)

    38

	uint16 offsets[32];	// the offsets

    39

	byte plural_form;		// how to compute plural forms

    40

	byte pad[3];				// pad header to be a multiple of 4

    41

	char data[VARARRAY_SIZE];

    42

} LanguagePack;

    43

    44

static char **_langpack_offs;

    45

static LanguagePack *_langpack;

    46

static uint _langtab_num[32]; // Offset into langpack offs

    47

static uint _langtab_start[32]; // Offset into langpack offs

    48

    49

static const StringID _cargo_string_list[NUM_LANDSCAPE][NUM_CARGO] = {

    50

	{ /* LT_NORMAL */

    51

		STR_PASSENGERS,

    52

		STR_TONS,

    53

		STR_BAGS,

    54

		STR_LITERS,

    55

		STR_ITEMS,

    56

		STR_CRATES,

    57

		STR_TONS,

    58

		STR_TONS,

    59

		STR_TONS,

    60

		STR_TONS,

    61

		STR_BAGS,

    62

		STR_RES_OTHER

    63

	},

    64

    65

	{ /* LT_HILLY */

    66

		STR_PASSENGERS,

    67

		STR_TONS,

    68

		STR_BAGS,

    69

		STR_LITERS,

    70

		STR_ITEMS,

    71

		STR_CRATES,

    72

		STR_TONS,

    73

		STR_TONS,

    74

		STR_RES_OTHER,

    75

		STR_TONS,

    76

		STR_BAGS,

    77

		STR_TONS

    78

	},

    79

    80

	{ /* LT_DESERT */

    81

		STR_PASSENGERS,

    82

		STR_LITERS,

    83

		STR_BAGS,

    84

		STR_LITERS,

    85

		STR_TONS,

    86

		STR_CRATES,

    87

		STR_TONS,

    88

		STR_TONS,

    89

		STR_TONS,

    90

		STR_LITERS,

    91

		STR_BAGS,

    92

		STR_TONS

    93

	},

    94

    95

	{ /* LT_CANDY */

    96

		STR_PASSENGERS,

    97

		STR_TONS,

    98

		STR_BAGS,

    99

		STR_NOTHING,

   100

		STR_NOTHING,

   101

		STR_TONS,

   102

		STR_TONS,

   103

		STR_LITERS,

   104

		STR_TONS,

   105

		STR_NOTHING,

   106

		STR_LITERS,

   107

		STR_NOTHING

   108

	}

   109

};

   110

   111

   112

// Read an int64 from the argv array.

   113

static inline int64 GetInt64(const int32 **argv)

   114

{

   115

	int64 result;

   116

   117

	assert(argv);

   118

	result = (uint32)(*argv)[0] + ((uint64)(uint32)(*argv)[1] << 32);

   119

	(*argv)+=2;

   120

	return result;

   121

}

   122

   123

// Read an int32 from the argv array.

   124

static inline int32 GetInt32(const int32 **argv)

   125

{

   126

	assert(argv);

   127

	return *(*argv)++;

   128

}

   129

   130

// Read an array from the argv array.

   131

static inline const int32 *GetArgvPtr(const int32 **argv, int n)

   132

{

   133

	const int32 *result;

   134

	assert(*argv);

   135

	result = *argv;

   136

	(*argv) += n;

   137

	return result;

   138

}

   139

   140

   141

#define NUM_BOUND_STRINGS 8

   142

   143

// Array to hold the bound strings.

   144

static const char *_bound_strings[NUM_BOUND_STRINGS];

   145

   146

// This index is used to implement a "round-robin" allocating of

   147

// slots for BindCString. NUM_BOUND_STRINGS slots are reserved.

   148

// Which means that after NUM_BOUND_STRINGS calls to BindCString,

   149

// the indices will be reused.

   150

static int _bind_index;

   151

   152

static const char *GetStringPtr(StringID string)

   153

{

   154

	return _langpack_offs[_langtab_start[string >> 11] + (string & 0x7FF)];

   155

}

   156

   157

// The highest 8 bits of string contain the "case index".

   158

// These 8 bits will only be set when FormatString wants to print

   159

// the string in a different case. No one else except FormatString

   160

// should set those bits.

   161

char *GetStringWithArgs(char *buffr, uint string, const int32 *argv)

   162

{

   163

	uint index = GB(string,  0, 11);

   164

	uint tab   = GB(string, 11,  5);

   165

   166

	if (GB(string, 0, 16) == 0) error("!invalid string id 0 in GetString");

   167

   168

	switch (tab) {

   169

		case 4:

   170

			if (index >= 0xC0)

   171

				return GetSpecialTownNameString(buffr, index - 0xC0, GetInt32(&argv));

   172

			break;

   173

   174

		case 14:

   175

			if (index >= 0xE4)

   176

				return GetSpecialPlayerNameString(buffr, index - 0xE4, argv);

   177

			break;

   178

   179

		// User defined name

   180

		case 15:

   181

			return GetName(index, buffr);

   182

   183

		case 28:

   184

			return GetGRFString(buffr, index);

   185

   186

		case 29:

   187

			return GetGRFString(buffr, index + 0x800);

   188

   189

		case 30:

   190

			return GetGRFString(buffr, index + 0x1000);

   191

   192

		case 31:

   193

			// dynamic strings. These are NOT to be passed through the formatter,

   194

			// but passed through verbatim.

   195

			if (index < (STR_SPEC_USERSTRING & 0x7FF)) {

   196

				return strecpy(buffr, _bound_strings[index], NULL);

   197

			}

   198

   199

			return FormatString(buffr, _userstring, NULL, 0);

   200

	}

   201

   202

	if (index >= _langtab_num[tab]) {

   203

		error(

   204

			"!String 0x%X is invalid. "

   205

			"Probably because an old version of the .lng file.\n", string

   206

		);

   207

	}

   208

   209

	return FormatString(buffr, GetStringPtr(GB(string, 0, 16)), argv, GB(string, 24, 8));

   210

}

   211

   212

char *GetString(char *buffr, StringID string)

   213

{

   214

	return GetStringWithArgs(buffr, string, (int32*)_decode_parameters);

   215

}

   216

   217

   218

// This function takes a C-string and allocates a temporary string ID.

   219

// The duration of the bound string is valid only until the next GetString,

   220

// so be careful.

   221

StringID BindCString(const char *str)

   222

{

   223

	int idx = (++_bind_index) & (NUM_BOUND_STRINGS - 1);

   224

	_bound_strings[idx] = str;

   225

	return idx + STR_SPEC_DYNSTRING;

   226

}

   227

   228

// This function is used to "bind" a C string to a OpenTTD dparam slot.

   229

void SetDParamStr(uint n, const char *str)

   230

{

   231

	SetDParam(n, BindCString(str));

   232

}

   233

   234

void InjectDParam(int amount)

   235

{

   236

	memmove(_decode_parameters + amount, _decode_parameters, sizeof(_decode_parameters) - amount * sizeof(uint32));

   237

}

   238

   239

static const uint32 _divisor_table[] = {

   240

	1000000000,

   241

	100000000,

   242

	10000000,

   243

	1000000,

   244

   245

	100000,

   246

	10000,

   247

	1000,

   248

	100,

   249

	10,

   250

	1

   251

};

   252

   253

static char *FormatCommaNumber(char *buff, int32 number)

   254

{

   255

	uint32 quot,divisor;

   256

	int i;

   257

	uint32 tot;

   258

	uint32 num;

   259

   260

	if (number < 0) {

   261

		*buff++ = '-';

   262

		number = -number;

   263

	}

   264

   265

	num = number;

   266

   267

	tot = 0;

   268

	for (i = 0; i != 10; i++) {

   269

		divisor = _divisor_table[i];

   270

		quot = 0;

   271

		if (num >= divisor) {

   272

			quot = num / _divisor_table[i];

   273

			num = num % _divisor_table[i];

   274

		}

   275

		if (tot |= quot || i == 9) {

   276

			*buff++ = '0' + quot;

   277

			if (i == 0 || i == 3 || i == 6) *buff++ = ',';

   278

		}

   279

	}

   280

   281

	*buff = '\0';

   282

   283

	return buff;

   284

}

   285

   286

static char *FormatNoCommaNumber(char *buff, int32 number)

   287

{

   288

	uint32 quot,divisor;

   289

	int i;

   290

	uint32 tot;

   291

	uint32 num;

   292

   293

	if (number < 0) {

   294

		*buff++ = '-';

   295

		number = -number;

   296

	}

   297

   298

	num = number;

   299

   300

	tot = 0;

   301

	for (i = 0; i != 10; i++) {

   302

		divisor = _divisor_table[i];

   303

		quot = 0;

   304

		if (num >= divisor) {

   305

			quot = num / _divisor_table[i];

   306

			num = num % _divisor_table[i];

   307

		}

   308

		if (tot |= quot || i == 9) {

   309

			*buff++ = '0' + quot;

   310

		}

   311

	}

   312

   313

	*buff = '\0';

   314

   315

	return buff;

   316

}

   317

   318

   319

static char *FormatYmdString(char *buff, uint16 number)

   320

{

   321

	const char *src;

   322

	YearMonthDay ymd;

   323

   324

	ConvertDayToYMD(&ymd, number);

   325

   326

	for (src = GetStringPtr(ymd.day + STR_01AC_1ST - 1); (*buff++ = *src++) != '\0';) {}

   327

   328

	buff[-1] = ' ';

   329

	memcpy(buff, GetStringPtr(STR_0162_JAN + ymd.month), 4);

   330

	buff[3] = ' ';

   331

   332

	return FormatNoCommaNumber(buff + 4, ymd.year + MAX_YEAR_BEGIN_REAL);

   333

}

   334

   335

static char *FormatMonthAndYear(char *buff, uint16 number)

   336

{

   337

	const char *src;

   338

	YearMonthDay ymd;

   339

   340

	ConvertDayToYMD(&ymd, number);

   341

   342

	for (src = GetStringPtr(STR_MONTH_JAN + ymd.month); (*buff++ = *src++) != '\0';) {}

   343

	buff[-1] = ' ';

   344

   345

	return FormatNoCommaNumber(buff, ymd.year + MAX_YEAR_BEGIN_REAL);

   346

}

   347

   348

static char *FormatTinyDate(char *buff, uint16 number)

   349

{

   350

	YearMonthDay ymd;

   351

   352

	ConvertDayToYMD(&ymd, number);

   353

	buff += sprintf(buff, " %02i-%02i-%04i", ymd.day, ymd.month + 1, ymd.year + MAX_YEAR_BEGIN_REAL);

   354

   355

	return buff;

   356

}

   357

   358

static char *FormatGenericCurrency(char *buff, const CurrencySpec *spec, int64 number, bool compact)

   359

{

   360

	const char *s;

   361

	char c;

   362

	char buf[40], *p;

   363

	int j;

   364

   365

	// multiply by exchange rate

   366

	number *= spec->rate;

   367

   368

	// convert from negative

   369

	if (number < 0) {

   370

		*buff++ = '-';

   371

		number = -number;

   372

	}

   373

   374

	// add prefix part

   375

	s = spec->prefix;

   376

	while (s != spec->prefix + lengthof(spec->prefix) && (c = *s++) != '\0') *buff++ = c;

   377

   378

	// for huge numbers, compact the number into k or M

   379

	if (compact) {

   380

		compact = 0;

   381

		if (number >= 1000000000) {

   382

			number = (number + 500000) / 1000000;

   383

			compact = 'M';

   384

		} else if (number >= 1000000) {

   385

			number = (number + 500) / 1000;

   386

			compact = 'k';

   387

		}

   388

	}

   389

   390

	// convert to ascii number and add commas

   391

	p = buf;

   392

	j = 4;

   393

	do {

   394

		if (--j == 0) {

   395

			*p++ = spec->separator;

   396

			j = 3;

   397

		}

   398

		*p++ = '0' + number % 10;

   399

	} while (number /= 10);

   400

	do *buff++ = *--p; while (p != buf);

   401

   402

	if (compact) *buff++ = compact;

   403

   404

	// add suffix part

   405

	s = spec->suffix;

   406

	while (s != spec->suffix + lengthof(spec->suffix) && (c = *s++) != '\0') *buff++ = c;

   407

   408

	return buff;

   409

}

   410

   411

static int DeterminePluralForm(int32 n)

   412

{

   413

	// The absolute value determines plurality

   414

	if (n < 0) n = -n;

   415

   416

	switch (_langpack->plural_form) {

   417

	// Two forms, singular used for one only

   418

	// Used in:

   419

	//   Danish, Dutch, English, German, Norwegian, Swedish, Estonian, Finnish,

   420

	//   Greek, Hebrew, Italian, Portuguese, Spanish, Esperanto

   421

	case 0:

   422

	default:

   423

		return n != 1;

   424

   425

	// Only one form

   426

	// Used in:

   427

	//   Hungarian, Japanese, Korean, Turkish

   428

	case 1:

   429

		return 0;

   430

   431

	// Two forms, singular used for zero and one

   432

	// Used in:

   433

	//   French, Brazilian Portuguese

   434

	case 2:

   435

		return n > 1;

   436

   437

	// Three forms, special case for zero

   438

	// Used in:

   439

	//   Latvian

   440

	case 3:

   441

		return n%10==1 && n%100!=11 ? 0 : n != 0 ? 1 : 2;

   442

   443

	// Three forms, special case for one and two

   444

	// Used in:

   445

	//   Gaelige (Irish)

   446

	case 4:

   447

		return n==1 ? 0 : n==2 ? 1 : 2;

   448

   449

	// Three forms, special case for numbers ending in 1[2-9]

   450

	// Used in:

   451

	//   Lithuanian

   452

	case 5:

   453

		return n%10==1 && n%100!=11 ? 0 : n%10>=2 && (n%100<10 || n%100>=20) ? 1 : 2;

   454

   455

	// Three forms, special cases for numbers ending in 1 and 2, 3, 4, except those ending in 1[1-4]

   456

	// Used in:

   457

	//   Croatian, Czech, Russian, Slovak, Ukrainian

   458

	case 6:

   459

		return n%10==1 && n%100!=11 ? 0 : n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2;

   460

   461

	// Three forms, special case for one and some numbers ending in 2, 3, or 4

   462

	// Used in:

   463

	//   Polish

   464

	case 7:

   465

		return n==1 ? 0 : n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2;

   466

   467

	// Four forms, special case for one and all numbers ending in 02, 03, or 04

   468

	// Used in:

   469

	//   Slovenian

   470

	case 8:

   471

		return n%100==1 ? 0 : n%100==2 ? 1 : n%100==3 || n%100==4 ? 2 : 3;

   472

	}

   473

}

   474

   475

static const char *ParseStringChoice(const char *b, uint form, char *dst, int *dstlen)

   476

{

   477

	//<NUM> {Length of each string} {each string}

   478

	uint n = (byte)*b++;

   479

	uint pos,i, mylen=0,mypos=0;

   480

   481

	for (i = pos = 0; i != n; i++) {

   482

		uint len = (byte)*b++;

   483

		if (i == form) {

   484

			mypos = pos;

   485

			mylen = len;

   486

		}

   487

		pos += len;

   488

	}

   489

	*dstlen = mylen;

   490

	memcpy(dst, b + mypos, mylen);

   491

	return b + pos;

   492

}

   493

   494

typedef struct Units {

   495

	int s_m;           ///< Multiplier for velocity

   496

	int s_s;           ///< Shift for velocity

   497

	StringID velocity; ///< String for velocity

   498

	int p_m;           ///< Multiplier for power