1

/* $Id$ */

     2

     3

/** @file strings.cpp Handling of translated strings. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "currency.h"

     8

#include "namegen_func.h"

     9

#include "station_base.h"

    10

#include "town.h"

    11

#include "screenshot.h"

    12

#include "waypoint.h"

    13

#include "industry.h"

    14

#include "variables.h"

    15

#include "newgrf_text.h"

    16

#include "music.h"

    17

#include "industry.h"

    18

#include "fileio_func.h"

    19

#include "cargotype.h"

    20

#include "group.h"

    21

#include "debug.h"

    22

#include "newgrf_townname.h"

    23

#include "signs_base.h"

    24

#include "newgrf_engine.h"

    25

#include "spritecache.h"

    26

#include "fontcache.h"

    27

#include "gui.h"

    28

#include "strings_func.h"

    29

#include "functions.h"

    30

#include "rev.h"

    31

#include "core/endian_func.hpp"

    32

#include "date_func.h"

    33

#include "vehicle_base.h"

    34

#include "string_func.h"

    35

#include "company_func.h"

    36

#include "company_base.h"

    37

#include "fios.h"

    38

#include "settings_type.h"

    39

#include "video/video_driver.hpp"

    40

#include "engine_func.h"

    41

#include "engine_base.h"

    42

#include "saveload.h"

    43

#include "strgen/strgen.h"

    44

    45

#include "table/strings.h"

    46

#include "table/control_codes.h"

    47

    48

DynamicLanguages _dynlang;

    49

uint64 _decode_parameters[20];

    50

    51

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

    52

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

    53

static char *GetSpecialNameString(char *buff, int ind, const int64 *argv, const char *last);

    54

    55

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

    56

    57

struct LanguagePack : public LanguagePackHeader {

    58

	char data[VARARRAY_SIZE]; // list of strings

    59

};

    60

    61

static char **_langpack_offs;

    62

static LanguagePack *_langpack;

    63

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

    64

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

    65

    66

    67

/** Read an int64 from the argv array. */

    68

static inline int64 GetInt64(const int64 **argv)

    69

{

    70

	assert(argv);

    71

	return *(*argv)++;

    72

}

    73

    74

/** Read an int32 from the argv array. */

    75

static inline int32 GetInt32(const int64 **argv)

    76

{

    77

	return (int32)GetInt64(argv);

    78

}

    79

    80

/** Read an array from the argv array. */

    81

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

    82

{

    83

	const int64 *result;

    84

	assert(*argv);

    85

	result = *argv;

    86

	(*argv) += n;

    87

	return result;

    88

}

    89

    90

    91

const char *GetStringPtr(StringID string)

    92

{

    93

	switch (GB(string, 11, 5)) {

    94

		case 28: return GetGRFStringPtr(GB(string, 0, 11));

    95

		case 29: return GetGRFStringPtr(GB(string, 0, 11) + 0x0800);

    96

		case 30: return GetGRFStringPtr(GB(string, 0, 11) + 0x1000);

    97

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

    98

	}

    99

}

   100

   101

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

   102

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

   103

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

   104

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

   105

 * @param buffr

   106

 * @param string

   107

 * @param argv

   108

 * @param last

   109

 * @return a formatted string of char

   110

 */

   111

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

   112

{

   113

	if (GB(string, 0, 16) == 0) return GetStringWithArgs(buffr, STR_UNDEFINED, argv, last);

   114

   115

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

   116

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

   117

   118

	switch (tab) {

   119

		case 4:

   120

			if (index >= 0xC0)

   121

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

   122

			break;

   123

   124

		case 14:

   125

			if (index >= 0xE4)

   126

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

   127

			break;

   128

   129

		case 15:

   130

			/* Old table for custom names. This is no longer used */

   131

			error("Incorrect conversion of custom name string.");

   132

   133

		case 26:

   134

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

   135

			if (HasBit(index, 10)) {

   136

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

   137

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

   138

			}

   139

			break;

   140

   141

		case 28:

   142

			return FormatString(buffr, GetGRFStringPtr(index), argv, 0, last);

   143

   144

		case 29:

   145

			return FormatString(buffr, GetGRFStringPtr(index + 0x0800), argv, 0, last);

   146

   147

		case 30:

   148

			return FormatString(buffr, GetGRFStringPtr(index + 0x1000), argv, 0, last);

   149

   150

		case 31:

   151

			NOT_REACHED();

   152

	}

   153

   154

	if (index >= _langtab_num[tab]) {

   155

		error(

   156

			"String 0x%X is invalid. "

   157

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

   158

		);

   159

	}

   160

   161

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

   162

}

   163

   164

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

   165

{

   166

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

   167

}

   168

   169

   170

char *InlineString(char *buf, StringID string)

   171

{

   172

	buf += Utf8Encode(buf, SCC_STRING_ID);

   173

	buf += Utf8Encode(buf, string);

   174

	return buf;

   175

}

   176

   177

   178

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

   179

 * @param n slot of the string

   180

 * @param str string to bind

   181

 */

   182

void SetDParamStr(uint n, const char *str)

   183

{

   184

	SetDParam(n, (uint64)(size_t)str);

   185

}

   186

   187

void InjectDParam(uint amount)

   188

{

   189

	assert((uint)amount < lengthof(_decode_parameters));

   190

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

   191

}

   192

   193

// TODO

   194

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

   195

{

   196

	uint64 divisor = 10000000000000000000ULL;

   197

	uint64 quot;

   198

	int i;

   199

	uint64 tot;

   200

	uint64 num;

   201

   202

	if (number < 0) {

   203

		*buff++ = '-';

   204

		number = -number;

   205

	}

   206

   207

	num = number;

   208

   209

	tot = 0;

   210

	for (i = 0; i < 20; i++) {

   211

		quot = 0;

   212

		if (num >= divisor) {

   213

			quot = num / divisor;

   214

			num = num % divisor;

   215

		}

   216

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

   217

			*buff++ = '0' + quot;

   218

			if ((i % 3) == 1 && i != 19) *buff++ = ',';

   219

		}

   220

   221

		divisor /= 10;

   222

	}

   223

   224

	*buff = '\0';

   225

   226

	return buff;

   227

}

   228

   229

// TODO

   230

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

   231

{

   232

	uint64 divisor = 10000000000000000000ULL;

   233

	uint64 quot;

   234

	int i;

   235

	uint64 tot;

   236

	uint64 num;

   237

   238

	if (number < 0) {

   239

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

   240

		number = -number;

   241

	}

   242

   243

	num = number;

   244

   245

	tot = 0;

   246

	for (i = 0; i < 20; i++) {

   247

		quot = 0;

   248

		if (num >= divisor) {

   249

			quot = num / divisor;

   250

			num = num % divisor;

   251

		}

   252

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

   253

			*buff++ = '0' + quot;

   254

		}

   255

   256

		divisor /= 10;

   257

	}

   258

   259

	*buff = '\0';

   260

   261

	return buff;

   262

}

   263

   264

static char *FormatHexNumber(char *buff, int64 number, const char *last)

   265

{

   266

	return buff + seprintf(buff, last, "0x%x", (uint32)number);

   267

}

   268

   269

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

   270

{

   271

	YearMonthDay ymd;

   272

	ConvertDateToYMD(date, &ymd);

   273

   274

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

   275

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

   276

}

   277

   278

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

   279

{

   280

	YearMonthDay ymd;

   281

	ConvertDateToYMD(date, &ymd);

   282

   283

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

   284

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

   285

}

   286

   287

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

   288

{

   289

	YearMonthDay ymd;

   290

	ConvertDateToYMD(date, &ymd);

   291

   292

	char day[3];

   293

	char month[3];

   294

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

   295

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

   296

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

   297

   298

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

   299

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

   300

}

   301

   302

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

   303

{

   304

	/* We are going to make number absolute for printing, so

   305

	 * keep this piece of data as we need it later on */

   306

	bool negative = number < 0;

   307

	const char *multiplier = "";

   308

	char buf[40];

   309

	char *p;

   310

	int j;

   311

   312

	number *= spec->rate;

   313

   314

	/* convert from negative */

   315

	if (number < 0) {

   316

		if (buff + Utf8CharLen(SCC_RED) > last) return buff;

   317

		buff += Utf8Encode(buff, SCC_RED);

   318

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

   319

		number = -number;

   320

	}

   321

   322

	/* Add prefix part, folowing symbol_pos specification.

   323

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

   324

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

   325

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

   326

   327

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

   328

	if (compact) {

   329

		if (number >= 1000000000) {

   330

			number = (number + 500000) / 1000000;

   331

			multiplier = "M";

   332

		} else if (number >= 1000000) {

   333

			number = (number + 500) / 1000;

   334

			multiplier = "k";

   335

		}

   336

	}

   337

   338

	/* convert to ascii number and add commas */

   339

	p = endof(buf);

   340

	*--p = '\0';

   341

	j = 4;

   342

	do {

   343

		if (--j == 0) {

   344

			*--p = spec->separator;

   345

			j = 3;

   346

		}

   347

		*--p = '0' + (char)(number % 10);

   348

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

   349

	buff = strecpy(buff, p, last);

   350

   351

	buff = strecpy(buff, multiplier, last);

   352

   353

	/* Add suffix part, folowing symbol_pos specification.

   354

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

   355

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

   356

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

   357

   358

	if (negative) {

   359

		if (buff + Utf8CharLen(SCC_PREVIOUS_COLOUR) > last) return buff;

   360

		buff += Utf8Encode(buff, SCC_PREVIOUS_COLOUR);

   361

		*buff = '\0';

   362

	}

   363

   364

	return buff;

   365

}

   366

   367

static int DeterminePluralForm(int64 count)

   368

{

   369

	/* The absolute value determines plurality */

   370

	uint64 n = abs(count);

   371

   372

	switch (_langpack->plural_form) {

   373

		default:

   374

			NOT_REACHED();

   375

   376

		/* Two forms, singular used for one only

   377

		 * Used in:

   378

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

   379

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

   380

		case 0:

   381

			return n != 1;

   382

   383

		/* Only one form

   384

		 * Used in:

   385

		 *   Hungarian, Japanese, Korean, Turkish */

   386

		case 1:

   387

			return 0;

   388

   389

		/* Two forms, singular used for zero and one

   390

		 * Used in:

   391

		 *   French, Brazilian Portuguese */

   392

		case 2:

   393

			return n > 1;

   394

   395

		/* Three forms, special case for zero

   396

		 * Used in:

   397

		 *   Latvian */

   398

		case 3:

   399

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

   400

   401

		/* Three forms, special case for one and two

   402

		 * Used in:

   403

		 *   Gaelige (Irish) */

   404

		case 4:

   405

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

   406

   407

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

   408

		 * Used in:

   409

		 *   Lithuanian */

   410

		case 5:

   411

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

   412

   413

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

   414

		 * Used in:

   415

		 *   Croatian, Czech, Russian, Slovak, Ukrainian */

   416

		case 6:

   417

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

   418

   419

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

   420

		 * Used in:

   421

		 *   Polish */

   422

		case 7:

   423

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

   424

   425

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

   426

		 * Used in:

   427

		 *   Slovenian */

   428

		case 8:

   429

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

   430

   431

		/* Two forms; singular used for everything ending in 1 but not in 11.

   432

		 * Used in:

   433

		 *   Icelandic */

   434

		case 9:

   435

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

   436

	}

   437

}

   438

   439

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

   440

{

   441

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

   442

	uint n = (byte)*b++;

   443

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

   444

   445

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

   446

		uint len = (byte)*b++;

   447

		if (i == form) {

   448

			mypos = pos;

   449

			mylen = len;

   450

		}

   451

		pos += len;

   452

	}

   453

	*dstlen = mylen;

   454

	memcpy(dst, b + mypos, mylen);

   455

	return b + pos;

   456

}

   457

   458

struct Units {

   459

	int s_m;           ///< Multiplier for velocity

   460

	int s_s;           ///< Shift for velocity

   461

	StringID velocity; ///< String for velocity

   462

	int p_m;           ///< Multiplier for power

   463

	int p_s;           ///< Shift for power

   464

	StringID power;    ///< String for velocity

   465

	int w_m;           ///< Multiplier for weight

   466

	int w_s;           ///< Shift for weight

   467

	StringID s_weight; ///< Short string for weight

   468

	StringID l_weight; ///< Long string for weight

   469

	int v_m;           ///< Multiplier for volume

   470

	int v_s;           ///< Shift for volume

   471

	StringID s_volume; ///< Short string for volume

   472

	StringID l_volume; ///< Long string for volume

   473

	int f_m;           ///< Multiplier for force

   474

	int f_s;           ///< Shift for force

   475

	StringID force;    ///< String for force

   476

};

   477

   478

/* Unit conversions */

   479

static const Units units[] = {

   480

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

   481

		   1,  0, STR_UNITS_VELOCITY_IMPERIAL,

   482

		   1,  0, STR_UNITS_POWER_IMPERIAL,

   483

		   1,  0, STR_UNITS_WEIGHT_SHORT_METRIC, STR_UNITS_WEIGHT_LONG_METRIC,

   484

		1000,  0, STR_UNITS_VOLUME_SHORT_METRIC, STR_UNITS_VOLUME_LONG_METRIC,

   485

		   1,  0, STR_UNITS_FORCE_SI,