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

#include "saveload.h"

    41

    42

#include "table/strings.h"

    43

#include "table/control_codes.h"

    44

    45

DynamicLanguages _dynlang;

    46

char _userstring[128];

    47

uint64 _decode_parameters[20];

    48

    49

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

    50

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

    51

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

    52

    53

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

    54

    55

struct LanguagePack {

    56

	uint32 ident;       // 32-bits identifier

    57

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

    58

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

    59

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

    60

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

    61

	uint16 offsets[32]; // the offsets

    62

	byte plural_form;   // how to compute plural forms

    63

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

    64

	char data[VARARRAY_SIZE]; // list of strings

    65

};

    66

    67

static char **_langpack_offs;

    68

static LanguagePack *_langpack;

    69

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

    70

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

    71

    72

    73

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

    74

static inline int64 GetInt64(const int64 **argv)

    75

{

    76

	assert(argv);

    77

	return *(*argv)++;

    78

}

    79

    80

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

    81

static inline int32 GetInt32(const int64 **argv)

    82

{

    83

	return (int32)GetInt64(argv);

    84

}

    85

    86

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

    87

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

    88

{

    89

	const int64 *result;

    90

	assert(*argv);

    91

	result = *argv;

    92

	(*argv) += n;

    93

	return result;

    94

}

    95

    96

    97

#define NUM_BOUND_STRINGS 8

    98

    99

/* Array to hold the bound strings. */

   100

static const char *_bound_strings[NUM_BOUND_STRINGS];

   101

   102

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

   103

 * slots for BindCString. NUM_BOUND_STRINGS slots are reserved.

   104

 * Which means that after NUM_BOUND_STRINGS calls to BindCString,

   105

 * the indices will be reused. */

   106

static int _bind_index;

   107

   108

const char *GetStringPtr(StringID string)

   109

{

   110

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

   111

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

   112

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

   113

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

   114

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

   115

	}

   116

}

   117

   118

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

   119

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

   120

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

   121

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

   122

 * @param buffr

   123

 * @param string

   124

 * @param argv

   125

 * @param last

   126

 * @return a formatted string of char

   127

 */

   128

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

   129

{

   130

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

   131

   132

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

   133

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

   134

   135

	switch (tab) {

   136

		case 4:

   137

			if (index >= 0xC0)

   138

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

   139

			break;

   140

   141

		case 14:

   142

			if (index >= 0xE4)

   143

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

   144

			break;

   145

   146

		case 15:

   147

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

   148

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

   149

   150

		case 26:

   151

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

   152

			if (HasBit(index, 10)) {

   153

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

   154

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

   155

			}

   156

			break;

   157

   158

		case 28:

   159

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

   160

   161

		case 29:

   162

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

   163

   164

		case 30:

   165

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

   166

   167

		case 31:

   168

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

   169

			 * but passed through verbatim. */

   170

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

   171

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

   172

			}

   173

   174

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

   175

	}

   176

   177

	if (index >= _langtab_num[tab]) {

   178

		error(

   179

			"!String 0x%X is invalid. "

   180

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

   181

		);

   182

	}

   183

   184

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

   185

}

   186

   187

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

   188

{

   189

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

   190

}

   191

   192

   193

char *InlineString(char *buf, StringID string)

   194

{

   195

	buf += Utf8Encode(buf, SCC_STRING_ID);

   196

	buf += Utf8Encode(buf, string);

   197

	return buf;

   198

}

   199

   200

   201

/**

   202

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

   203

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

   204

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

   205

 * @param str temp string to add

   206

 * @return the id of that temp string

   207

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

   208

 *       amount of 'user' bound strings by 2.

   209

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

   210

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

   211

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

   212

 */

   213

StringID BindCString(const char *str)

   214

{

   215

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

   216

	_bound_strings[idx] = str;

   217

	return idx + STR_SPEC_DYNSTRING;

   218

}

   219

   220

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

   221

 * @param n slot of the string

   222

 * @param str string to bind

   223

 */

   224

void SetDParamStr(uint n, const char *str)

   225

{

   226

	SetDParam(n, BindCString(str));

   227

}

   228

   229

void InjectDParam(int amount)

   230

{

   231

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

   232

}

   233

   234

// TODO

   235

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

   236

{

   237

	uint64 divisor = 10000000000000000000ULL;

   238

	uint64 quot;

   239

	int i;

   240

	uint64 tot;

   241

	uint64 num;

   242

   243

	if (number < 0) {

   244

		*buff++ = '-';

   245

		number = -number;

   246

	}

   247

   248

	num = number;

   249

   250

	tot = 0;

   251

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

   252

		quot = 0;

   253

		if (num >= divisor) {

   254

			quot = num / divisor;

   255

			num = num % divisor;

   256

		}

   257

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

   258

			*buff++ = '0' + quot;

   259

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

   260

		}

   261

   262

		divisor /= 10;

   263

	}

   264

   265

	*buff = '\0';

   266

   267

	return buff;

   268

}

   269

   270

// TODO

   271

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

   272

{

   273

	uint64 divisor = 10000000000000000000ULL;

   274

	uint64 quot;

   275

	int i;

   276

	uint64 tot;

   277

	uint64 num;

   278

   279

	if (number < 0) {

   280

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

   281

		number = -number;

   282

	}

   283

   284

	num = number;

   285

   286

	tot = 0;

   287

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

   288

		quot = 0;

   289

		if (num >= divisor) {

   290

			quot = num / divisor;

   291

			num = num % divisor;

   292

		}

   293

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

   294

			*buff++ = '0' + quot;

   295

		}

   296

   297

		divisor /= 10;

   298

	}

   299

   300

	*buff = '\0';

   301

   302

	return buff;

   303

}

   304

   305

   306

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

   307

{

   308

	YearMonthDay ymd;

   309

	ConvertDateToYMD(date, &ymd);

   310

   311

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

   312

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

   313

}

   314

   315

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

   316

{

   317

	YearMonthDay ymd;

   318

	ConvertDateToYMD(date, &ymd);

   319

   320

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

   321

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

   322

}

   323

   324

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

   325

{

   326

	YearMonthDay ymd;

   327

	ConvertDateToYMD(date, &ymd);

   328

   329

	char day[3];

   330

	char month[3];

   331

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

   332

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

   333

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

   334

   335

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

   336

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

   337

}

   338

   339

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

   340

{

   341

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

   342

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

   343

	bool negative = number < 0;

   344

	const char *multiplier = "";

   345

	char buf[40];

   346

	char *p;

   347

	int j;

   348

   349

	number *= spec->rate;

   350

   351

	/* convert from negative */

   352

	if (number < 0) {

   353

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

   354

		buff += Utf8Encode(buff, SCC_RED);

   355

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

   356

		number = -number;

   357

	}

   358

   359

	/* Add prefix part, folowing symbol_pos specification.

   360

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

   361

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

   362

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

   363

   364

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

   365

	if (compact) {

   366

		if (number >= 1000000000) {

   367

			number = (number + 500000) / 1000000;

   368

			multiplier = "M";

   369

		} else if (number >= 1000000) {

   370

			number = (number + 500) / 1000;

   371

			multiplier = "k";

   372

		}

   373

	}

   374

   375

	/* convert to ascii number and add commas */

   376

	p = endof(buf);

   377

	*--p = '\0';

   378

	j = 4;

   379

	do {

   380

		if (--j == 0) {

   381

			*--p = spec->separator;

   382

			j = 3;

   383

		}

   384

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

   385

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

   386

	buff = strecpy(buff, p, last);

   387

   388

	buff = strecpy(buff, multiplier, last);

   389

   390

	/* Add suffix part, folowing symbol_pos specification.

   391

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

   392

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

   393

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

   394

   395

	if (negative) {

   396

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

   397

		buff += Utf8Encode(buff, SCC_PREVIOUS_COLOUR);

   398

		*buff = '\0';

   399

	}

   400

   401

	return buff;

   402

}

   403

   404

static int DeterminePluralForm(int64 count)

   405

{

   406

	/* The absolute value determines plurality */

   407

	uint64 n = abs(count);

   408

   409

	switch (_langpack->plural_form) {

   410

		default:

   411

			NOT_REACHED();

   412

   413

		/* Two forms, singular used for one only

   414

		 * Used in:

   415

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

   416

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

   417

		case 0:

   418

			return n != 1;

   419

   420

		/* Only one form

   421

		 * Used in:

   422

		 *   Hungarian, Japanese, Korean, Turkish */

   423

		case 1:

   424

			return 0;

   425

   426

		/* Two forms, singular used for zero and one

   427

		 * Used in:

   428

		 *   French, Brazilian Portuguese */

   429

		case 2:

   430

			return n > 1;

   431

   432

		/* Three forms, special case for zero

   433

		 * Used in:

   434

		 *   Latvian */

   435

		case 3:

   436

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

   437

   438

		/* Three forms, special case for one and two

   439

		 * Used in:

   440

		 *   Gaelige (Irish) */

   441

		case 4:

   442

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

   443

   444

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

   445

		 * Used in:

   446

		 *   Lithuanian */

   447

		case 5:

   448

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

   449

   450

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

   451

		 * Used in:

   452

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

   453

		case 6:

   454

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

   455

   456

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

   457

		 * Used in:

   458

		 *   Polish */

   459

		case 7:

   460

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

   461

   462

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

   463

		 * Used in:

   464

		 *   Slovenian */

   465

		case 8:

   466

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

   467

   468

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

   469

		 * Used in:

   470

		 *   Icelandic */

   471

		case 9:

   472

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

   473

	}

   474

}

   475

   476

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

   477

{

   478

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

   479

	uint n = (byte)*b++;

   480

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

   481

   482

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

   483

		uint len = (byte)*b++;

   484

		if (i == form) {

   485

			mypos = pos;

   486

			mylen = len;