1

/* $Id$ */

     2

     3

/** @file strings.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "currency.h"

     8

#include "namegen.h"

     9

#include "station.h"

    10

#include "town.h"

    11

#include "news.h"

    12

#include "screenshot.h"

    13

#include "waypoint.h"

    14

#include "industry.h"

    15

#include "variables.h"

    16

#include "newgrf_text.h"

    17

#include "music.h"

    18

#include "industry.h"

    19

#include "fileio.h"

    20

#include "cargotype.h"

    21

#include "group.h"

    22

#include "debug.h"

    23

#include "newgrf_townname.h"

    24

#include "signs.h"

    25

#include "newgrf_engine.h"

    26

#include "spritecache.h"

    27

#include "fontcache.h"

    28

#include "gui.h"

    29

#include "strings_func.h"

    30

#include "functions.h"

    31

#include "core/endian_func.hpp"

    32

#include "date_func.h"

    33

#include "vehicle_base.h"

    34

#include "string_func.h"

    35

#include "player_func.h"

    36

#include "player_base.h"

    37

#include "fios.h"

    38

#include "settings_type.h"

    39

#include "video/video_driver.hpp"

    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

static const char *GetStringPtr(StringID string)

   108

{

   109

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

   110

}

   111

   112

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

   113

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

   114

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

   115

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

   116

 * @param buffr

   117

 * @param string

   118

 * @param argv

   119

 * @param last

   120

 * @return a formatted string of char

   121

 */

   122

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

   123

{

   124

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

   125

   126

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

   127

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

   128

	char buff[512];

   129

   130

	switch (tab) {

   131

		case 4:

   132

			if (index >= 0xC0)

   133

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

   134

			break;

   135

   136

		case 14:

   137

			if (index >= 0xE4)

   138

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

   139

			break;

   140

   141

		case 15:

   142

			error("Boo!");

   143

   144

		case 26:

   145

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

   146

			if (HasBit(index, 10)) {

   147

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

   148

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

   149

			}

   150

			break;

   151

   152

		case 28:

   153

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

   154

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

   155

   156

		case 29:

   157

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

   158

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

   159

   160

		case 30:

   161

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

   162

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

   163

   164

		case 31:

   165

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

   166

			 * but passed through verbatim. */

   167

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

   168

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

   169

			}

   170

   171

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

   172

	}

   173

   174

	if (index >= _langtab_num[tab]) {

   175

		error(

   176

			"!String 0x%X is invalid. "

   177

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

   178

		);

   179

	}

   180

   181

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

   182

}

   183

   184

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

   185

{

   186

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

   187

}

   188

   189

   190

char *InlineString(char *buf, StringID string)

   191

{

   192

	buf += Utf8Encode(buf, SCC_STRING_ID);

   193

	buf += Utf8Encode(buf, string);

   194

	return buf;

   195

}

   196

   197

   198

/**

   199

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

   200

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

   201

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

   202

 * @param str temp string to add

   203

 * @return the id of that temp string

   204

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

   205

 *       amount of 'user' bound strings by 2.

   206

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

   207

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

   208

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

   209

 */

   210

StringID BindCString(const char *str)

   211

{

   212

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

   213

	_bound_strings[idx] = str;

   214

	return idx + STR_SPEC_DYNSTRING;

   215

}

   216

   217

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

   218

 * @param n slot of the string

   219

 * @param str string to bind

   220

 */

   221

void SetDParamStr(uint n, const char *str)

   222

{

   223

	SetDParam(n, BindCString(str));

   224

}

   225

   226

void InjectDParam(int amount)

   227

{

   228

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

   229

}

   230

   231

// TODO

   232

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

   233

{

   234

	uint64 divisor = 10000000000000000000ULL;

   235

	uint64 quot;

   236

	int i;

   237

	uint64 tot;

   238

	uint64 num;

   239

   240

	if (number < 0) {

   241

		*buff++ = '-';

   242

		number = -number;

   243

	}

   244

   245

	num = number;

   246

   247

	tot = 0;

   248

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

   249

		quot = 0;

   250

		if (num >= divisor) {

   251

			quot = num / divisor;

   252

			num = num % divisor;

   253

		}

   254

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

   255

			*buff++ = '0' + quot;

   256

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

   257

		}

   258

   259

		divisor /= 10;

   260

	}

   261

   262

	*buff = '\0';

   263

   264

	return buff;

   265

}

   266

   267

// TODO

   268

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

   269

{

   270

	uint64 divisor = 10000000000000000000ULL;

   271

	uint64 quot;

   272

	int i;

   273

	uint64 tot;

   274

	uint64 num;

   275

   276

	if (number < 0) {

   277

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

   278

		number = -number;

   279

	}

   280

   281

	num = number;

   282

   283

	tot = 0;

   284

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

   285

		quot = 0;

   286

		if (num >= divisor) {

   287

			quot = num / divisor;

   288

			num = num % divisor;

   289

		}

   290

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

   291

			*buff++ = '0' + quot;

   292

		}

   293

   294

		divisor /= 10;

   295

	}

   296

   297

	*buff = '\0';

   298

   299

	return buff;

   300

}

   301

   302

   303

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

   304

{

   305

	YearMonthDay ymd;

   306

	ConvertDateToYMD(date, &ymd);

   307

   308

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

   309

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

   310

}

   311

   312

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

   313

{

   314

	YearMonthDay ymd;

   315

	ConvertDateToYMD(date, &ymd);

   316

   317

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

   318

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

   319

}

   320

   321

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

   322

{

   323

	YearMonthDay ymd;

   324

	ConvertDateToYMD(date, &ymd);

   325

   326

	char day[3];

   327

	char month[3];

   328

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

   329

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

   330

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

   331

   332

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

   333

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

   334

}

   335

   336

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

   337

{

   338

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

   339

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

   340

	bool negative = number < 0;

   341

	const char *multiplier = "";

   342

	char buf[40];

   343

	char *p;

   344

	int j;

   345

   346

	number *= spec->rate;

   347

   348

	/* convert from negative */

   349

	if (number < 0) {

   350

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

   351

		buff += Utf8Encode(buff, SCC_RED);

   352

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

   353

		number = -number;

   354

	}

   355

   356

	/* Add prefix part, folowing symbol_pos specification.

   357

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

   358

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

   359

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

   360

   361

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

   362

	if (compact) {

   363

		if (number >= 1000000000) {

   364

			number = (number + 500000) / 1000000;

   365

			multiplier = "M";

   366

		} else if (number >= 1000000) {

   367

			number = (number + 500) / 1000;

   368

			multiplier = "k";

   369

		}

   370

	}

   371

   372

	/* convert to ascii number and add commas */

   373

	p = endof(buf);

   374

	*--p = '\0';

   375

	j = 4;

   376

	do {

   377

		if (--j == 0) {

   378

			*--p = spec->separator;

   379

			j = 3;

   380

		}

   381

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

   382

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

   383

	buff = strecpy(buff, p, last);

   384

   385

	buff = strecpy(buff, multiplier, last);

   386

   387

	/* Add suffix part, folowing symbol_pos specification.

   388

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

   389

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

   390

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

   391

   392

	if (negative) {

   393

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

   394

		buff += Utf8Encode(buff, SCC_PREVIOUS_COLOUR);

   395

		*buff = '\0';

   396

	}

   397

   398

	return buff;

   399

}

   400

   401

static int DeterminePluralForm(int64 cnt)

   402

{

   403

	uint64 n = cnt;

   404

	/* The absolute value determines plurality */

   405

	if (cnt < 0) n = -cnt;

   406

   407

	switch (_langpack->plural_form) {

   408

	/* Two forms, singular used for one only

   409

	 * Used in:

   410

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

   411

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

   412

	case 0:

   413

	default:

   414

		return n != 1;

   415

   416

	/* Only one form

   417

	 * Used in:

   418

	 *   Hungarian, Japanese, Korean, Turkish */

   419

	case 1:

   420

		return 0;

   421

   422

	/* Two forms, singular used for zero and one

   423

	 * Used in:

   424

	 *   French, Brazilian Portuguese */

   425

	case 2:

   426

		return n > 1;

   427

   428

	/* Three forms, special case for zero

   429

	 * Used in:

   430

	 *   Latvian */

   431

	case 3:

   432

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

   433

   434

	/* Three forms, special case for one and two

   435

	 * Used in:

   436

	 *   Gaelige (Irish) */

   437

	case 4:

   438

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

   439

   440

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

   441

	 * Used in:

   442

	 *   Lithuanian */

   443

	case 5:

   444

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

   445

   446

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

   447

	 * Used in:

   448

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

   449

	case 6:

   450

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

   451

   452

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

   453

	 * Used in:

   454

	 *   Polish */

   455

	case 7:

   456

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

   457

   458

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

   459

	 * Used in:

   460

	 *   Slovenian */

   461

	case 8:

   462

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

   463

	}

   464

}

   465

   466

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

   467

{

   468

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

   469

	uint n = (byte)*b++;

   470

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

   471

   472

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

   473

		uint len = (byte)*b++;

   474

		if (i == form) {

   475

			mypos = pos;

   476

			mylen = len;

   477

		}

   478

		pos += len;

   479

	}

   480

	*dstlen = mylen;

   481

	memcpy(dst, b + mypos, mylen);

   482

	return b + pos;

   483

}

   484

   485

struct Units {