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

    44

#include "table/strings.h"

    45

#include "table/control_codes.h"

    46

    47

DynamicLanguages _dynlang;

    48

uint64 _decode_parameters[20];

    49

    50

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

    51

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

    52

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

    53

    54

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

    55

    56

struct LanguagePack {

    57

	uint32 ident;       // 32-bits identifier

    58

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

    59

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

    60

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

    61

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

    62

	uint16 offsets[32]; // the offsets

    63

	byte plural_form;   // how to compute plural forms

    64

	byte text_dir;      // default direction of the text

    65

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

    66

	char data[VARARRAY_SIZE]; // list of strings

    67

};

    68

    69

static char **_langpack_offs;

    70

static LanguagePack *_langpack;

    71

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

    72

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

    73

    74

    75

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

    76

static inline int64 GetInt64(const int64 **argv)

    77

{

    78

	assert(argv);

    79

	return *(*argv)++;

    80

}

    81

    82

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

    83

static inline int32 GetInt32(const int64 **argv)

    84

{

    85

	return (int32)GetInt64(argv);

    86

}

    87

    88

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

    89

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

    90

{

    91

	const int64 *result;

    92

	assert(*argv);

    93

	result = *argv;

    94

	(*argv) += n;

    95

	return result;

    96

}

    97

    98

    99

const char *GetStringPtr(StringID string)

   100

{

   101

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

   102

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

   103

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

   104

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

   105

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

   106

	}

   107

}

   108

   109

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

   110

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

   111

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

   112

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

   113

 * @param buffr

   114

 * @param string

   115

 * @param argv

   116

 * @param last

   117

 * @return a formatted string of char

   118

 */

   119

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

   120

{

   121

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

   122

   123

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

   124

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

   125

   126

	switch (tab) {

   127

		case 4:

   128

			if (index >= 0xC0)

   129

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

   130

			break;

   131

   132

		case 14:

   133

			if (index >= 0xE4)

   134

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

   135

			break;

   136

   137

		case 15:

   138

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

   139

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

   140

   141

		case 26:

   142

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

   143

			if (HasBit(index, 10)) {

   144

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

   145

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

   146

			}

   147

			break;

   148

   149

		case 28:

   150

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

   151

   152

		case 29:

   153

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

   154

   155

		case 30:

   156

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

   157

   158

		case 31:

   159

			NOT_REACHED();

   160

	}

   161

   162

	if (index >= _langtab_num[tab]) {

   163

		error(

   164

			"String 0x%X is invalid. "

   165

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

   166

		);

   167

	}

   168

   169

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

   170

}

   171

   172

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

   173

{

   174

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

   175

}

   176

   177

   178

char *InlineString(char *buf, StringID string)

   179

{

   180

	buf += Utf8Encode(buf, SCC_STRING_ID);

   181

	buf += Utf8Encode(buf, string);

   182

	return buf;

   183

}

   184

   185

   186

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

   187

 * @param n slot of the string

   188

 * @param str string to bind

   189

 */

   190

void SetDParamStr(uint n, const char *str)

   191

{

   192

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

   193

}

   194

   195

void InjectDParam(uint amount)

   196

{

   197

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

   198

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

   199

}

   200

   201

// TODO

   202

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

   203

{

   204

	uint64 divisor = 10000000000000000000ULL;

   205

	uint64 quot;

   206

	int i;

   207

	uint64 tot;

   208

	uint64 num;

   209

   210

	if (number < 0) {

   211

		*buff++ = '-';

   212

		number = -number;

   213

	}

   214

   215

	num = number;

   216

   217

	tot = 0;

   218

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

   219

		quot = 0;

   220

		if (num >= divisor) {

   221

			quot = num / divisor;

   222

			num = num % divisor;

   223

		}

   224

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

   225

			*buff++ = '0' + quot;

   226

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

   227

		}

   228

   229

		divisor /= 10;

   230

	}

   231

   232

	*buff = '\0';

   233

   234

	return buff;

   235

}

   236

   237

// TODO

   238

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

   239

{

   240

	uint64 divisor = 10000000000000000000ULL;

   241

	uint64 quot;

   242

	int i;

   243

	uint64 tot;

   244

	uint64 num;

   245

   246

	if (number < 0) {

   247

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

   248

		number = -number;

   249

	}

   250

   251

	num = number;

   252

   253

	tot = 0;

   254

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

   255

		quot = 0;

   256

		if (num >= divisor) {

   257

			quot = num / divisor;

   258

			num = num % divisor;

   259

		}

   260

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

   261

			*buff++ = '0' + quot;

   262

		}

   263

   264

		divisor /= 10;

   265

	}

   266

   267

	*buff = '\0';

   268

   269

	return buff;

   270

}

   271

   272

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

   273

{

   274

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

   275

}

   276

   277

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

   278

{

   279

	YearMonthDay ymd;

   280

	ConvertDateToYMD(date, &ymd);

   281

   282

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

   283

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

   284

}

   285

   286

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

   287

{

   288

	YearMonthDay ymd;

   289

	ConvertDateToYMD(date, &ymd);

   290

   291

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

   292

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

   293

}

   294

   295

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

   296

{

   297

	YearMonthDay ymd;

   298

	ConvertDateToYMD(date, &ymd);

   299

   300

	char day[3];

   301

	char month[3];

   302

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

   303

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

   304

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

   305

   306

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

   307

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

   308

}

   309

   310

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

   311

{

   312

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

   313

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

   314

	bool negative = number < 0;

   315

	const char *multiplier = "";

   316

	char buf[40];

   317

	char *p;

   318

	int j;

   319

   320

	number *= spec->rate;

   321

   322

	/* convert from negative */

   323

	if (number < 0) {

   324

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

   325

		buff += Utf8Encode(buff, SCC_RED);

   326

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

   327

		number = -number;

   328

	}

   329

   330

	/* Add prefix part, folowing symbol_pos specification.

   331

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

   332

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

   333

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

   334

   335

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

   336

	if (compact) {

   337

		if (number >= 1000000000) {

   338

			number = (number + 500000) / 1000000;

   339

			multiplier = "M";

   340

		} else if (number >= 1000000) {

   341

			number = (number + 500) / 1000;

   342

			multiplier = "k";

   343

		}

   344

	}

   345

   346

	/* convert to ascii number and add commas */

   347

	p = endof(buf);

   348

	*--p = '\0';

   349

	j = 4;

   350

	do {

   351

		if (--j == 0) {

   352

			*--p = spec->separator;

   353

			j = 3;

   354

		}

   355

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

   356

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

   357

	buff = strecpy(buff, p, last);

   358

   359

	buff = strecpy(buff, multiplier, last);

   360

   361

	/* Add suffix part, folowing symbol_pos specification.

   362

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

   363

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

   364

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

   365

   366

	if (negative) {

   367

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

   368

		buff += Utf8Encode(buff, SCC_PREVIOUS_COLOUR);

   369

		*buff = '\0';

   370

	}

   371

   372

	return buff;

   373

}

   374

   375

static int DeterminePluralForm(int64 count)

   376

{

   377

	/* The absolute value determines plurality */

   378

	uint64 n = abs(count);

   379

   380

	switch (_langpack->plural_form) {

   381

		default:

   382

			NOT_REACHED();

   383

   384

		/* Two forms, singular used for one only

   385

		 * Used in:

   386

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

   387

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

   388

		case 0:

   389

			return n != 1;

   390

   391

		/* Only one form

   392

		 * Used in:

   393

		 *   Hungarian, Japanese, Korean, Turkish */

   394

		case 1:

   395

			return 0;

   396

   397

		/* Two forms, singular used for zero and one

   398

		 * Used in:

   399

		 *   French, Brazilian Portuguese */

   400

		case 2:

   401

			return n > 1;

   402

   403

		/* Three forms, special case for zero

   404

		 * Used in:

   405

		 *   Latvian */

   406

		case 3:

   407

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

   408

   409

		/* Three forms, special case for one and two

   410

		 * Used in:

   411

		 *   Gaelige (Irish) */

   412

		case 4:

   413

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

   414

   415

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

   416

		 * Used in:

   417

		 *   Lithuanian */

   418

		case 5:

   419

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

   420

   421

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

   422

		 * Used in:

   423

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

   424

		case 6:

   425

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

   426

   427

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

   428

		 * Used in:

   429

		 *   Polish */

   430

		case 7:

   431

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

   432

   433

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

   434

		 * Used in:

   435

		 *   Slovenian */

   436

		case 8:

   437

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

   438

   439

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

   440

		 * Used in:

   441

		 *   Icelandic */

   442

		case 9:

   443

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

   444

	}

   445

}

   446

   447

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

   448

{

   449

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

   450

	uint n = (byte)*b++;

   451

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

   452

   453

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

   454

		uint len = (byte)*b++;

   455

		if (i == form) {

   456

			mypos = pos;

   457

			mylen = len;

   458

		}

   459

		pos += len;

   460

	}

   461

	*dstlen = mylen;

   462

	memcpy(dst, b + mypos, mylen);

   463

	return b + pos;

   464

}

   465

   466

struct Units {

   467

	int s_m;           ///< Multiplier for velocity

   468

	int s_s;           ///< Shift for velocity

   469

	StringID velocity; ///< String for velocity

   470

	int p_m;           ///< Multiplier for power

   471

	int p_s;           ///< Shift for power

   472

	StringID power;    ///< String for velocity

   473

	int w_m;           ///< Multiplier for weight

   474

	int w_s;           ///< Shift for weight

   475

	StringID s_weight; ///< Short string for weight

   476

	StringID l_weight; ///< Long string for weight

   477

	int v_m;           ///< Multiplier for volume

   478

	int v_s;           ///< Shift for volume

   479

	StringID s_volume; ///< Short string for volume

   480

	StringID l_volume; ///< Long string for volume

   481

	int f_m;           ///< Multiplier for force

   482

	int f_s;           ///< Shift for force

   483

	StringID force;    ///< String for force

   484

};

   485

   486

/* Unit conversions */