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"

    20

#include "table/control_codes.h"

    21

#include "music.h"

    22

#include "date.h"

    23

#include "industry.h"

    24

#include "helpers.hpp"

    25

#include "cargotype.h"

    26

    27

/* for opendir/readdir/closedir */

    28

# include "fios.h"

    29

    30

DynamicLanguages _dynlang;

    31

char _userstring[128];

    32

    33

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

    34

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

    35

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

    36

    37

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

    38

    39

struct LanguagePack {

    40

	uint32 ident;

    41

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

    42

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

    43

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

    44

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

    45

	uint16 offsets[32]; // the offsets

    46

	byte plural_form;   // how to compute plural forms

    47

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

    48

	char data[VARARRAY_SIZE];

    49

};

    50

    51

static char **_langpack_offs;

    52

static LanguagePack *_langpack;

    53

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

    54

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

    55

    56

    57

// Read an int64 from the argv array.

    58

static inline int64 GetInt64(const int32 **argv)

    59

{

    60

	int64 result;

    61

    62

	assert(argv);

    63

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

    64

	(*argv)+=2;

    65

	return result;

    66

}

    67

    68

// Read an int32 from the argv array.

    69

static inline int32 GetInt32(const int32 **argv)

    70

{

    71

	assert(argv);

    72

	return *(*argv)++;

    73

}

    74

    75

// Read an array from the argv array.

    76

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

    77

{

    78

	const int32 *result;

    79

	assert(*argv);

    80

	result = *argv;

    81

	(*argv) += n;

    82

	return result;

    83

}

    84

    85

    86

#define NUM_BOUND_STRINGS 8

    87

    88

// Array to hold the bound strings.

    89

static const char *_bound_strings[NUM_BOUND_STRINGS];

    90

    91

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

    92

// slots for BindCString. NUM_BOUND_STRINGS slots are reserved.

    93

// Which means that after NUM_BOUND_STRINGS calls to BindCString,

    94

// the indices will be reused.

    95

static int _bind_index;

    96

    97

static const char *GetStringPtr(StringID string)

    98

{

    99

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

   100

}

   101

   102

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

   103

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

   104

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

   105

// should set those bits, therefore string CANNOT be StringID, but uint32.

   106

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

   107

{

   108

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

   109

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

   110

	char buff[512];

   111

   112

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

   113

   114

	switch (tab) {

   115

		case 4:

   116

			if (index >= 0xC0)

   117

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

   118

			break;

   119

   120

		case 14:

   121

			if (index >= 0xE4)

   122

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

   123

			break;

   124

   125

		// User defined name

   126

		case 15:

   127

			return GetName(buffr, index, last);

   128

   129

		case 26:

   130

			/* Include string within newgrf text (format code 81) */

   131

			if (HASBIT(index, 10)) {

   132

				StringID string = GetGRFStringID(0, 0xD000 + GB(index, 0, 10));

   133

				return GetStringWithArgs(buffr, string, argv, last);

   134

			}

   135

			break;

   136

   137

		case 28:

   138

			GetGRFString(buff, index, lastof(buff));

   139

			return FormatString(buffr, buff, argv, 0, last);

   140

   141

		case 29:

   142

			GetGRFString(buff, index + 0x800, lastof(buff));

   143

			return FormatString(buffr, buff, argv, 0, last);

   144

   145

		case 30:

   146

			GetGRFString(buff, index + 0x1000, lastof(buff));

   147

			return FormatString(buffr, buff, argv, 0, last);

   148

   149

		case 31:

   150

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

   151

			// but passed through verbatim.

   152

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

   153

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

   154

			}

   155

   156

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

   157

	}

   158

   159

	if (index >= _langtab_num[tab]) {

   160

		error(

   161

			"!String 0x%X is invalid. "

   162

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

   163

		);

   164

	}

   165

   166

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

   167

}

   168

   169

char *GetString(char *buffr, StringID string, const char* last)

   170

{

   171

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

   172

}

   173

   174

   175

char *InlineString(char *buf, StringID string)

   176

{

   177

	buf += Utf8Encode(buf, SCC_STRING_ID);

   178

	buf += Utf8Encode(buf, string);

   179

	return buf;

   180

}

   181

   182

   183

/**

   184

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

   185

 * The StringID of the bound string is valid until BindCString is called

   186

 * another NUM_BOUND_STRINGS times. So be careful when using it.

   187

 *

   188

 * @note formatting a DATE_TINY calls BindCString twice, thus reduces the

   189

 *       amount of 'user' bound strings by 2.

   190

 * @todo rewrite the BindCString system to make the limit flexible and

   191

 *       non-round-robin. For example by using smart pointers that free

   192

 *       the allocated StringID when they go out-of-scope/are freed.

   193

 */

   194

StringID BindCString(const char *str)

   195

{

   196

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

   197

	_bound_strings[idx] = str;

   198

	return idx + STR_SPEC_DYNSTRING;

   199

}

   200

   201

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

   202

void SetDParamStr(uint n, const char *str)

   203

{

   204

	SetDParam(n, BindCString(str));

   205

}

   206

   207

void InjectDParam(int amount)

   208

{

   209

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

   210

}

   211

   212

static const uint32 _divisor_table[] = {

   213

	1000000000,

   214

	100000000,

   215

	10000000,

   216

	1000000,

   217

   218

	100000,

   219

	10000,

   220

	1000,

   221

	100,

   222

	10,

   223

	1

   224

};

   225

   226

// TODO

   227

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

   228

{

   229

	uint32 quot,divisor;

   230

	int i;

   231

	uint32 tot;

   232

	uint32 num;

   233

   234

	if (number < 0) {

   235

		*buff++ = '-';

   236

		number = -number;

   237

	}

   238

   239

	num = number;

   240

   241

	tot = 0;

   242

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

   243

		divisor = _divisor_table[i];

   244

		quot = 0;

   245

		if (num >= divisor) {

   246

			quot = num / _divisor_table[i];

   247

			num = num % _divisor_table[i];

   248

		}

   249

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

   250

			*buff++ = '0' + quot;

   251

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

   252

		}

   253

	}

   254

   255

	*buff = '\0';

   256

   257

	return buff;

   258

}

   259

   260

// TODO

   261

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

   262

{

   263

	uint32 quot,divisor;

   264

	int i;

   265

	uint32 tot;

   266

	uint32 num;

   267

   268

	if (number < 0) {

   269

		buff = strecpy(buff, "-", last);

   270

		number = -number;

   271

	}

   272

   273

	num = number;

   274

   275

	tot = 0;

   276

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

   277

		divisor = _divisor_table[i];

   278

		quot = 0;

   279

		if (num >= divisor) {

   280

			quot = num / _divisor_table[i];

   281

			num = num % _divisor_table[i];

   282

		}

   283

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

   284

			*buff++ = '0' + quot;

   285

		}

   286

	}

   287

   288

	*buff = '\0';

   289

   290

	return buff;

   291

}

   292

   293

   294

static char *FormatYmdString(char *buff, Date date, const char* last)

   295

{

   296

	YearMonthDay ymd;

   297

	ConvertDateToYMD(date, &ymd);

   298

   299

	int32 args[3] = { ymd.day + STR_01AC_1ST - 1, STR_0162_JAN + ymd.month, ymd.year };

   300

	return FormatString(buff, GetStringPtr(STR_DATE_LONG), args, 0, last);

   301

}

   302

   303

static char *FormatMonthAndYear(char *buff, Date date, const char* last)

   304

{

   305

	YearMonthDay ymd;

   306

	ConvertDateToYMD(date, &ymd);

   307

   308

	int32 args[2] = { STR_MONTH_JAN + ymd.month, ymd.year };

   309

	return FormatString(buff, GetStringPtr(STR_DATE_SHORT), args, 0, last);

   310

}

   311

   312

static char *FormatTinyDate(char *buff, Date date, const char* last)

   313

{

   314

	YearMonthDay ymd;

   315

	ConvertDateToYMD(date, &ymd);

   316

   317

	char day[3];

   318

	char month[3];

   319

	/* We want to zero-pad the days and months */

   320

	snprintf(day,   lengthof(day),   "%02i", ymd.day);

   321

	snprintf(month, lengthof(month), "%02i", ymd.month + 1);

   322

   323

	int32 args[3] = { BindCString(day), BindCString(month), ymd.year };

   324

	return FormatString(buff, GetStringPtr(STR_DATE_TINY), args, 0, last);

   325

}

   326

   327

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

   328

{

   329

	const char* multiplier = "";

   330

	char buf[40];

   331

	char* p;

   332

	int j;

   333

   334

	// multiply by exchange rate

   335

	number *= spec->rate;

   336

   337

	// convert from negative

   338

	if (number < 0) {

   339

		buff = strecpy(buff, "-", last);

   340

		number = -number;

   341

	}

   342

   343

	/* Add prefix part, folowing symbol_pos specification.

   344

	 * Here, it can can be either 0 (prefix) or 2 (both prefix anf suffix).

   345

	 * The only remaining value is 1 (suffix), so everything that is not 1 */

   346

	if (spec->symbol_pos != 1) buff = strecpy(buff, spec->prefix, last);

   347

   348

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

   349

	if (compact) {

   350

		if (number >= 1000000000) {

   351

			number = (number + 500000) / 1000000;

   352

			multiplier = "M";

   353

		} else if (number >= 1000000) {

   354

			number = (number + 500) / 1000;

   355

			multiplier = "k";

   356

		}

   357

	}

   358

   359

	// convert to ascii number and add commas

   360

	p = endof(buf);

   361

	*--p = '\0';

   362

	j = 4;

   363

	do {

   364

		if (--j == 0) {

   365

			*--p = spec->separator;

   366

			j = 3;

   367

		}

   368

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

   369

	} while ((number /= 10) != 0);

   370

	buff = strecpy(buff, p, last);

   371

   372

	buff = strecpy(buff, multiplier, last);

   373

   374

	/* Add suffix part, folowing symbol_pos specification.

   375

	 * Here, it can can be either 1 (suffix) or 2 (both prefix anf suffix).

   376

	 * The only remaining value is 1 (prefix), so everything that is not 0 */

   377

	if (spec->symbol_pos != 0) buff = strecpy(buff, spec->suffix, last);

   378

   379

	return buff;

   380

}

   381

   382

static int DeterminePluralForm(int32 n)

   383

{

   384

	// The absolute value determines plurality

   385

	if (n < 0) n = -n;

   386

   387

	switch (_langpack->plural_form) {

   388

	// Two forms, singular used for one only

   389

	// Used in:

   390

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

   391

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

   392

	case 0:

   393

	default:

   394

		return n != 1;

   395

   396

	// Only one form

   397

	// Used in:

   398

	//   Hungarian, Japanese, Korean, Turkish

   399

	case 1:

   400

		return 0;

   401

   402

	// Two forms, singular used for zero and one

   403

	// Used in:

   404

	//   French, Brazilian Portuguese

   405

	case 2:

   406

		return n > 1;

   407

   408

	// Three forms, special case for zero

   409

	// Used in:

   410

	//   Latvian

   411

	case 3:

   412

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

   413

   414

	// Three forms, special case for one and two

   415

	// Used in:

   416

	//   Gaelige (Irish)

   417

	case 4:

   418

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

   419

   420

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

   421

	// Used in:

   422

	//   Lithuanian

   423

	case 5:

   424

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

   425

   426

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

   427

	// Used in:

   428

	//   Croatian, Czech, Russian, Slovak, Ukrainian

   429

	case 6:

   430

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

   431

   432

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

   433

	// Used in:

   434

	//   Polish

   435

	case 7:

   436

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

   437

   438

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

   439

	// Used in:

   440

	//   Slovenian

   441

	case 8:

   442

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

   443

	}

   444

}

   445

   446

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

   447

{

   448

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

   449

	uint n = (byte)*b++;

   450

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

   451

   452

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

   453

		uint len = (byte)*b++;

   454

		if (i == form) {

   455

			mypos = pos;

   456

			mylen = len;

   457

		}

   458

		pos += len;

   459

	}

   460

	*dstlen = mylen;

   461

	memcpy(dst, b + mypos, mylen);

   462

	return b + pos;

   463

}

   464

   465

struct Units {

   466

	int s_m;           ///< Multiplier for velocity

   467

	int s_s;           ///< Shift for velocity

   468

	StringID velocity; ///< String for velocity

   469

	int p_m;           ///< Multiplier for power

   470

	int p_s;           ///< Shift for power

   471

	StringID power;    ///< String for velocity

   472

	int w_m;           ///< Multiplier for weight

   473

	int w_s;           ///< Shift for weight

   474

	StringID s_weight; ///< Short string for weight

   475

	StringID l_weight; ///< Long string for weight

   476

	int v_m;           ///< Multiplier for volume

   477

	int v_s;           ///< Shift for volume

   478

	StringID s_volume; ///< Short string for volume

   479

	StringID l_volume; ///< Long string for volume

   480

	int f_m;           ///< Multiplier for force

   481

	int f_s;           ///< Shift for force

   482

	StringID force;    ///< String for force

   483

};

   484

   485

/* Unit conversions */

   486

static const Units units[] = {

   487

	{ // Imperial (Original, mph, hp, metric ton, litre, kN)

   488

		   1,  0, STR_UNITS_VELOCITY_IMPERIAL,

   489

		   1,  0, STR_UNITS_POWER_IMPERIAL,

   490

		   1,  0, STR_UNITS_WEIGHT_SHORT_METRIC, STR_UNITS_WEIGHT_LONG_METRIC,

   491

		1000,  0, STR_UNITS_VOLUME_SHORT_METRIC, STR_UNITS_VOLUME_LONG_METRIC,

   492

		   1,  0, STR_UNITS_FORCE_SI,

   493