1

/* $Id$ */

     2

     3

/** @file strings.cpp */

     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.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 "core/endian_func.hpp"

    31

#include "date_func.h"

    32

#include "vehicle_base.h"

    33

#include "string_func.h"

    34

#include "player_func.h"

    35

#include "player_base.h"

    36

#include "fios.h"

    37

#include "settings_type.h"

    38

#include "video/video_driver.hpp"

    39

#include "engine_func.h"

    40

    41

#include "table/strings.h"

    42

#include "table/control_codes.h"

    43

    44

DynamicLanguages _dynlang;

    45

char _userstring[128];

    46

uint64 _decode_parameters[20];

    47

    48

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

    49

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

    50

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

    51

    52

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

    53

    54

struct LanguagePack {

    55

	uint32 ident;       // 32-bits identifier

    56

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

    57

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

    58

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

    59

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

    60

	uint16 offsets[32]; // the offsets

    61

	byte plural_form;   // how to compute plural forms

    62

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

    63

	char data[VARARRAY_SIZE]; // list of strings

    64

};

    65

    66

static char **_langpack_offs;

    67

static LanguagePack *_langpack;

    68

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

    69

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

    70

    71

    72

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

    73

static inline int64 GetInt64(const int64 **argv)

    74

{

    75

	assert(argv);

    76

	return *(*argv)++;

    77

}

    78

    79

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

    80

static inline int32 GetInt32(const int64 **argv)

    81

{

    82

	return (int32)GetInt64(argv);

    83

}

    84

    85

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

    86

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

    87

{

    88

	const int64 *result;

    89

	assert(*argv);

    90

	result = *argv;

    91

	(*argv) += n;

    92

	return result;

    93

}

    94

    95

    96

#define NUM_BOUND_STRINGS 8

    97

    98

/* Array to hold the bound strings. */

    99

static const char *_bound_strings[NUM_BOUND_STRINGS];

   100

   101

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

   102

 * slots for BindCString. NUM_BOUND_STRINGS slots are reserved.

   103

 * Which means that after NUM_BOUND_STRINGS calls to BindCString,

   104

 * the indices will be reused. */

   105

static int _bind_index;

   106

   107

const char *GetStringPtr(StringID string)

   108

{

   109

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

   110

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

   111

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

   112

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

   113

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

   114

	}

   115

}

   116

   117

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

   118

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

   119

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

   120

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

   121

 * @param buffr

   122

 * @param string

   123

 * @param argv

   124

 * @param last

   125

 * @return a formatted string of char

   126

 */

   127

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

   128

{

   129

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

   130

   131

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

   132

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

   133

   134

	switch (tab) {

   135

		case 4:

   136

			if (index >= 0xC0)

   137

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

   138

			break;

   139

   140

		case 14:

   141

			if (index >= 0xE4)

   142

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

   143

			break;

   144

   145

		case 15:

   146

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

   147

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

   148

   149

		case 26:

   150

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

   151

			if (HasBit(index, 10)) {

   152

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

   153

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

   154

			}

   155

			break;

   156

   157

		case 28:

   158

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

   159

   160

		case 29:

   161

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

   162

   163

		case 30:

   164

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

   165

   166

		case 31:

   167

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

   168

			 * but passed through verbatim. */

   169

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

   170

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

   171

			}

   172

   173

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

   174

	}

   175

   176

	if (index >= _langtab_num[tab]) {

   177

		error(

   178

			"!String 0x%X is invalid. "

   179

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

   180

		);

   181

	}

   182

   183

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

   184

}

   185

   186

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

   187

{

   188

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

   189

}

   190

   191

   192

char *InlineString(char *buf, StringID string)

   193

{

   194

	buf += Utf8Encode(buf, SCC_STRING_ID);

   195

	buf += Utf8Encode(buf, string);

   196

	return buf;

   197

}

   198

   199

   200

/**

   201

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

   202

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

   203

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

   204

 * @param str temp string to add

   205

 * @return the id of that temp string

   206

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

   207

 *       amount of 'user' bound strings by 2.

   208

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

   209

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

   210

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

   211

 */

   212

StringID BindCString(const char *str)

   213

{

   214

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

   215

	_bound_strings[idx] = str;

   216

	return idx + STR_SPEC_DYNSTRING;

   217

}

   218

   219

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

   220

 * @param n slot of the string

   221

 * @param str string to bind

   222

 */

   223

void SetDParamStr(uint n, const char *str)

   224

{

   225

	SetDParam(n, BindCString(str));

   226

}

   227

   228

void InjectDParam(int amount)

   229

{

   230

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

   231

}

   232

   233

// TODO

   234

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

   235

{

   236

	uint64 divisor = 10000000000000000000ULL;

   237

	uint64 quot;

   238

	int i;

   239

	uint64 tot;

   240

	uint64 num;

   241

   242

	if (number < 0) {

   243

		*buff++ = '-';

   244

		number = -number;

   245

	}

   246

   247

	num = number;

   248

   249

	tot = 0;

   250

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

   251

		quot = 0;

   252

		if (num >= divisor) {

   253

			quot = num / divisor;

   254

			num = num % divisor;

   255

		}

   256

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

   257

			*buff++ = '0' + quot;

   258

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

   259

		}

   260

   261

		divisor /= 10;

   262

	}

   263

   264

	*buff = '\0';

   265

   266

	return buff;

   267

}

   268

   269

// TODO

   270

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

   271

{

   272

	uint64 divisor = 10000000000000000000ULL;

   273

	uint64 quot;

   274

	int i;

   275

	uint64 tot;

   276

	uint64 num;

   277

   278

	if (number < 0) {

   279

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

   280

		number = -number;

   281

	}

   282

   283

	num = number;

   284

   285

	tot = 0;

   286

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

   287

		quot = 0;

   288

		if (num >= divisor) {

   289

			quot = num / divisor;

   290

			num = num % divisor;

   291

		}

   292

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

   293

			*buff++ = '0' + quot;

   294

		}

   295

   296

		divisor /= 10;

   297

	}

   298

   299

	*buff = '\0';

   300

   301

	return buff;

   302

}

   303

   304

   305

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

   306

{

   307

	YearMonthDay ymd;

   308

	ConvertDateToYMD(date, &ymd);

   309

   310

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

   311

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

   312

}

   313

   314

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

   315

{

   316

	YearMonthDay ymd;

   317

	ConvertDateToYMD(date, &ymd);

   318

   319

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

   320

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

   321

}

   322

   323

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

   324

{

   325

	YearMonthDay ymd;

   326

	ConvertDateToYMD(date, &ymd);

   327

   328

	char day[3];

   329

	char month[3];

   330

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

   331

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

   332

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

   333

   334

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

   335

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

   336

}

   337

   338

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

   339

{

   340

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

   341

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

   342

	bool negative = number < 0;

   343

	const char *multiplier = "";

   344

	char buf[40];

   345

	char *p;

   346

	int j;

   347

   348

	number *= spec->rate;

   349

   350

	/* convert from negative */

   351

	if (number < 0) {

   352

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

   353

		buff += Utf8Encode(buff, SCC_RED);

   354

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

   355

		number = -number;

   356

	}

   357

   358

	/* Add prefix part, folowing symbol_pos specification.

   359

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

   360

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

   361

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

   362

   363

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

   364

	if (compact) {

   365

		if (number >= 1000000000) {

   366

			number = (number + 500000) / 1000000;

   367

			multiplier = "M";

   368

		} else if (number >= 1000000) {

   369

			number = (number + 500) / 1000;

   370

			multiplier = "k";

   371

		}

   372

	}

   373

   374

	/* convert to ascii number and add commas */

   375

	p = endof(buf);

   376

	*--p = '\0';

   377

	j = 4;

   378

	do {

   379

		if (--j == 0) {

   380

			*--p = spec->separator;

   381

			j = 3;

   382

		}

   383

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

   384

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

   385

	buff = strecpy(buff, p, last);

   386

   387

	buff = strecpy(buff, multiplier, last);

   388

   389

	/* Add suffix part, folowing symbol_pos specification.

   390

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

   391

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

   392

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

   393

   394

	if (negative) {

   395

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

   396

		buff += Utf8Encode(buff, SCC_PREVIOUS_COLOUR);

   397

		*buff = '\0';

   398

	}

   399

   400

	return buff;

   401

}

   402

   403

static int DeterminePluralForm(int64 count)

   404

{

   405

	/* The absolute value determines plurality */

   406

	uint64 n = abs(count);

   407

   408

	switch (_langpack->plural_form) {

   409

		default:

   410

			NOT_REACHED();

   411

   412

		/* Two forms, singular used for one only

   413

		 * Used in:

   414

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

   415

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

   416

		case 0:

   417

			return n != 1;

   418

   419

		/* Only one form

   420

		 * Used in:

   421

		 *   Hungarian, Japanese, Korean, Turkish */

   422

		case 1:

   423

			return 0;

   424

   425

		/* Two forms, singular used for zero and one

   426

		 * Used in:

   427

		 *   French, Brazilian Portuguese */

   428

		case 2:

   429

			return n > 1;

   430

   431

		/* Three forms, special case for zero

   432

		 * Used in:

   433

		 *   Latvian */

   434

		case 3:

   435

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

   436

   437

		/* Three forms, special case for one and two

   438

		 * Used in:

   439

		 *   Gaelige (Irish) */

   440

		case 4:

   441

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

   442

   443

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

   444

		 * Used in:

   445

		 *   Lithuanian */

   446

		case 5:

   447

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

   448

   449

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

   450

		 * Used in:

   451

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

   452

		case 6:

   453

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

   454

   455

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

   456

		 * Used in:

   457

		 *   Polish */

   458

		case 7:

   459

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

   460

   461

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

   462

		 * Used in:

   463

		 *   Slovenian */

   464

		case 8:

   465

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

   466

   467

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

   468

		 * Used in:

   469

		 *   Icelandic */

   470

		case 9:

   471

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

   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;