1

/* $Id$ */

     2

     3

/** @file strings.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "currency.h"

     8

#include "string.h"

     9

#include "table/strings.h"

    10

#include "namegen.h"

    11

#include "station.h"

    12

#include "town.h"

    13

#include "vehicle.h"

    14

#include "news.h"

    15

#include "screenshot.h"

    16

#include "waypoint.h"

    17

#include "industry.h"

    18

#include "variables.h"

    19

#include "newgrf_text.h"

    20

#include "table/control_codes.h"

    21

#include "music.h"

    22

#include "date.h"

    23

#include "industry.h"

    24

#include "fileio.h"

    25

#include "cargotype.h"

    26

#include "group.h"

    27

#include "debug.h"

    28

#include "newgrf_townname.h"

    29

#include "signs.h"

    30

#include "vehicle.h"

    31

#include "newgrf_engine.h"

    32

#include "spritecache.h"

    33

#include "fontcache.h"

    34

#include "gui.h"

    35

#include "strings_func.h"

    37

#if defined(TTD_BIG_ENDIAN)

    38

#include "core/endian_func.hpp"

    39

#endif

    40

    41

/* for opendir/readdir/closedir */

    42

# include "fios.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

			/* User defined name */

   143

			return GetName(buffr, index, last);

   144

   145

		case 26:

   146

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

   147

			if (HasBit(index, 10)) {

   148

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

   149

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

   150

			}

   151

			break;

   152

   153

		case 28:

   154

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

   155

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

   156

   157

		case 29:

   158

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

   159

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

   160

   161

		case 30:

   162

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

   163

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

   164

   165

		case 31:

   166

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

   167

			 * but passed through verbatim. */

   168

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

   169

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

   170

			}

   171

   172

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

   173

	}

   174

   175

	if (index >= _langtab_num[tab]) {

   176

		error(

   177

			"!String 0x%X is invalid. "

   178

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

   179

		);

   180

	}

   181

   182

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

   183

}

   184

   185

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

   186

{

   187

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

   188

}

   189

   190

   191

char *InlineString(char *buf, StringID string)

   192

{

   193

	buf += Utf8Encode(buf, SCC_STRING_ID);

   194

	buf += Utf8Encode(buf, string);

   195

	return buf;

   196

}

   197

   198

   199

/**

   200

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

   201

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

   202

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

   203

 * @param str temp string to add

   204

 * @return the id of that temp string

   205

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

   206

 *       amount of 'user' bound strings by 2.

   207

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

   208

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

   209

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

   210

 */

   211

StringID BindCString(const char *str)

   212

{

   213

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

   214

	_bound_strings[idx] = str;

   215

	return idx + STR_SPEC_DYNSTRING;

   216

}

   217

   218

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

   219

 * @param n slot of the string

   220

 * @param str string to bind

   221

 */

   222

void SetDParamStr(uint n, const char *str)

   223

{

   224

	SetDParam(n, BindCString(str));

   225

}

   226

   227

void InjectDParam(int amount)

   228

{

   229

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

   230

}

   231

   232

// TODO

   233

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

   234

{

   235

	uint64 divisor = 10000000000000000000ULL;

   236

	uint64 quot;

   237

	int i;

   238

	uint64 tot;

   239

	uint64 num;

   240

   241

	if (number < 0) {

   242

		*buff++ = '-';

   243

		number = -number;

   244

	}

   245

   246

	num = number;

   247

   248

	tot = 0;

   249

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

   250

		quot = 0;

   251

		if (num >= divisor) {

   252

			quot = num / divisor;

   253

			num = num % divisor;

   254

		}

   255

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

   256

			*buff++ = '0' + quot;

   257

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

   258

		}

   259

   260

		divisor /= 10;

   261

	}

   262

   263

	*buff = '\0';

   264

   265

	return buff;

   266

}

   267

   268

// TODO

   269

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

   270

{

   271

	uint64 divisor = 10000000000000000000ULL;

   272

	uint64 quot;

   273

	int i;

   274

	uint64 tot;

   275

	uint64 num;

   276

   277

	if (number < 0) {

   278

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

   279

		number = -number;

   280

	}

   281

   282

	num = number;

   283

   284

	tot = 0;

   285

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

   286

		quot = 0;

   287

		if (num >= divisor) {

   288

			quot = num / divisor;

   289

			num = num % divisor;

   290

		}

   291

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

   292

			*buff++ = '0' + quot;

   293

		}

   294

   295

		divisor /= 10;

   296

	}

   297

   298

	*buff = '\0';

   299

   300

	return buff;

   301

}

   302

   303

   304

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

   305

{

   306

	YearMonthDay ymd;

   307

	ConvertDateToYMD(date, &ymd);

   308

   309

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

   310

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

   311

}

   312

   313

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

   314

{

   315

	YearMonthDay ymd;

   316

	ConvertDateToYMD(date, &ymd);

   317

   318

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

   319

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

   320

}

   321

   322

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

   323

{

   324

	YearMonthDay ymd;

   325

	ConvertDateToYMD(date, &ymd);

   326

   327

	char day[3];

   328

	char month[3];

   329

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

   330

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

   331

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

   332

   333

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

   334

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

   335

}

   336

   337

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

   338

{

   339

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

   340

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

   341

	bool negative = number < 0;

   342

	const char *multiplier = "";

   343

	char buf[40];

   344

	char *p;

   345

	int j;

   346

   347

	number *= spec->rate;

   348

   349

	/* convert from negative */

   350

	if (number < 0) {

   351

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

   352

		buff += Utf8Encode(buff, SCC_RED);

   353

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

   354

		number = -number;

   355

	}

   356

   357

	/* Add prefix part, folowing symbol_pos specification.

   358

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

   359

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

   360

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

   361

   362

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

   363

	if (compact) {

   364

		if (number >= 1000000000) {

   365

			number = (number + 500000) / 1000000;

   366

			multiplier = "M";

   367

		} else if (number >= 1000000) {

   368

			number = (number + 500) / 1000;

   369

			multiplier = "k";

   370

		}

   371

	}

   372

   373

	/* convert to ascii number and add commas */

   374

	p = endof(buf);

   375

	*--p = '\0';

   376

	j = 4;

   377

	do {

   378

		if (--j == 0) {

   379

			*--p = spec->separator;

   380

			j = 3;

   381

		}

   382

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

   383

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

   384

	buff = strecpy(buff, p, last);

   385

   386

	buff = strecpy(buff, multiplier, last);

   387

   388

	/* Add suffix part, folowing symbol_pos specification.

   389

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

   390

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

   391

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

   392

   393

	if (negative) {

   394

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

   395

		buff += Utf8Encode(buff, SCC_PREVIOUS_COLOUR);

   396

		*buff = '\0';

   397

	}

   398

   399

	return buff;

   400

}

   401

   402

static int DeterminePluralForm(int64 cnt)

   403

{

   404

	uint64 n = cnt;

   405

	/* The absolute value determines plurality */

   406

	if (cnt < 0) n = -cnt;

   407

   408

	switch (_langpack->plural_form) {

   409

	/* Two forms, singular used for one only

   410

	 * Used in:

   411

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

   412

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

   413

	case 0:

   414

	default:

   415

		return n != 1;

   416

   417

	/* Only one form

   418

	 * Used in:

   419

	 *   Hungarian, Japanese, Korean, Turkish */

   420

	case 1:

   421

		return 0;

   422

   423

	/* Two forms, singular used for zero and one

   424

	 * Used in:

   425

	 *   French, Brazilian Portuguese */

   426

	case 2:

   427

		return n > 1;

   428

   429

	/* Three forms, special case for zero

   430

	 * Used in:

   431

	 *   Latvian */

   432

	case 3:

   433

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

   434

   435

	/* Three forms, special case for one and two

   436

	 * Used in:

   437

	 *   Gaelige (Irish) */

   438

	case 4:

   439

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

   440

   441

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

   442

	 * Used in:

   443

	 *   Lithuanian */

   444

	case 5:

   445

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

   446

   447

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

   448

	 * Used in:

   449

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

   450

	case 6:

   451

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

   452

   453

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

   454

	 * Used in:

   455

	 *   Polish */

   456

	case 7:

   457

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

   458

   459

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

   460

	 * Used in:

   461

	 *   Slovenian */

   462

	case 8:

   463

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

   464

	}

   465

}

   466

   467

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

   468

{

   469

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

   470

	uint n = (byte)*b++;

   471

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

   472

   473

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

   474

		uint len = (byte)*b++;

   475

		if (i == form) {

   476

			mypos = pos;

   477

			mylen = len;

   478

		}

   479

		pos += len;

   480

	}

   481

	*dstlen = mylen;

   482

	memcpy(dst, b + mypos, mylen);

   483

	return b + pos;

   484

}

   485