1

/* $Id$ */

     2

     3

/** @file strings.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "currency.h"

     8

#include "functions.h"

     9

#include "string.h"

    10

#include "strings.h"

    11

#include "table/strings.h"

    12

#include "namegen.h"

    13

#include "station.h"

    14

#include "town.h"

    15

#include "vehicle.h"

    16

#include "news.h"

    17

#include "screenshot.h"

    18

#include "waypoint.h"

    19

#include "industry.h"

    20

#include "variables.h"

    21

#include "newgrf_text.h"

    22

#include "table/control_codes.h"

    23

#include "music.h"

    24

#include "date.h"

    25

#include "industry.h"

    26

#include "fileio.h"

    27

#include "helpers.hpp"

    28

#include "cargotype.h"

    29

#include "group.h"

    30

#include "debug.h"

    32

    33

/* for opendir/readdir/closedir */

    34

# include "fios.h"

    35

    36

DynamicLanguages _dynlang;

    37

char _userstring[128];

    38

    39

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

    40

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

    41

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

    42

    43

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

    44

    45

struct LanguagePack {

    46

	uint32 ident;       // 32-bits identifier

    47

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

    48

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

    49

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

    50

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

    51

	uint16 offsets[32]; // the offsets

    52

	byte plural_form;   // how to compute plural forms

    53

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

    54

	char data[VARARRAY_SIZE]; // list of strings

    55

};

    56

    57

static char **_langpack_offs;

    58

static LanguagePack *_langpack;

    59

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

    60

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

    61

    62

    63

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

    64

static inline int64 GetInt64(const int32 **argv)

    65

{

    66

	int64 result;

    67

    68

	assert(argv);

    69

	result = (uint32)(*argv)[0] + ((uint64)(uint32)(*argv)[1] << 32);

    70

	(*argv) += 2;

    71

	return result;

    72

}

    73

    74

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

    75

static inline int32 GetInt32(const int32 **argv)

    76

{

    77

	assert(argv);

    78

	return *(*argv)++;

    79

}

    80

    81

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

    82

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

    83

{

    84

	const int32 *result;

    85

	assert(*argv);

    86

	result = *argv;

    87

	(*argv) += n;

    88

	return result;

    89

}

    90

    91

    92

#define NUM_BOUND_STRINGS 8

    93

    94

/* Array to hold the bound strings. */

    95

static const char *_bound_strings[NUM_BOUND_STRINGS];

    96

    97

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

    98

 * slots for BindCString. NUM_BOUND_STRINGS slots are reserved.

    99

 * Which means that after NUM_BOUND_STRINGS calls to BindCString,

   100

 * the indices will be reused. */

   101

static int _bind_index;

   102

   103

static const char *GetStringPtr(StringID string)

   104

{

   105

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

   106

}

   107

   108

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

   109

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

   110

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

   111

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

   112

 * @param buffr

   113

 * @param string

   114

 * @param argv

   115

 * @param last

   116

 * @return a formatted string of char

   117

 */

   118

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

   119

{

   120

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

   121

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

   122

	char buff[512];

   123

   124

	if (GB(string, 0, 16) == 0) error("!invalid string id 0 in GetString");

   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 GetSpecialPlayerNameString(buffr, index - 0xE4, argv, last);

   135

			break;

   136

   137

		case 15:

   138

			/* User defined name */

   139

			return GetName(buffr, index, last);

   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

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

   151

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

   152

   153

		case 29:

   154

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

   155

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

   156

   157

		case 30:

   158

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

   159

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

   160

   161

		case 31:

   162

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

   163

			 * but passed through verbatim. */

   164

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

   165

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

   166

			}

   167

   168

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

   169

	}

   170

   171

	if (index >= _langtab_num[tab]) {

   172

		error(

   173

			"!String 0x%X is invalid. "

   174

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

   175

		);

   176

	}

   177

   178

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

   179

}

   180

   181

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

   182

{

   183

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

   184

}

   185

   186

   187

char *InlineString(char *buf, StringID string)

   188

{

   189

	buf += Utf8Encode(buf, SCC_STRING_ID);

   190

	buf += Utf8Encode(buf, string);

   191

	return buf;

   192

}

   193

   194

   195

/**

   196

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

   197

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

   198

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

   199

 * @param str temp string to add

   200

 * @return the id of that temp string

   201

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

   202

 *       amount of 'user' bound strings by 2.

   203

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

   204

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

   205

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

   206

 */

   207

StringID BindCString(const char *str)

   208

{

   209

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

   210

	_bound_strings[idx] = str;

   211

	return idx + STR_SPEC_DYNSTRING;

   212

}

   213

   214

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

   215

 * @param n slot of the string

   216

 * @param str string to bind

   217

 */

   218

void SetDParamStr(uint n, const char *str)

   219

{

   220

	SetDParam(n, BindCString(str));

   221

}

   222

   223

void InjectDParam(int amount)

   224

{

   225

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

   226

}

   227

   228

static const uint32 _divisor_table[] = {

   229

	1000000000,

   230

	100000000,

   231

	10000000,

   232

	1000000,

   233

   234

	100000,

   235

	10000,

   236

	1000,

   237

	100,

   238

	10,

   239

	1

   240

};

   241

   242

// TODO

   243

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

   244

{

   245

	uint32 quot,divisor;

   246

	int i;

   247

	uint32 tot;

   248

	uint32 num;

   249

   250

	if (number < 0) {

   251

		*buff++ = '-';

   252

		number = -number;

   253

	}

   254

   255

	num = number;

   256

   257

	tot = 0;

   258

	for (i = 0; i != 10; i++) {

   259

		divisor = _divisor_table[i];

   260

		quot = 0;

   261

		if (num >= divisor) {

   262

			quot = num / _divisor_table[i];

   263

			num = num % _divisor_table[i];

   264

		}

   265

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

   266

			*buff++ = '0' + quot;

   267

			if (i == 0 || i == 3 || i == 6) *buff++ = ',';

   268

		}

   269

	}

   270

   271

	*buff = '\0';

   272

   273

	return buff;

   274

}

   275

   276

// TODO

   277

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

   278

{

   279

	uint32 quot,divisor;

   280

	int i;

   281

	uint32 tot;

   282

	uint32 num;

   283

   284

	if (number < 0) {

   285

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

   286

		number = -number;

   287

	}

   288

   289

	num = number;

   290

   291

	tot = 0;

   292

	for (i = 0; i != 10; i++) {

   293

		divisor = _divisor_table[i];

   294

		quot = 0;

   295

		if (num >= divisor) {

   296

			quot = num / _divisor_table[i];

   297

			num = num % _divisor_table[i];

   298

		}

   299

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

   300

			*buff++ = '0' + quot;

   301

		}

   302

	}

   303

   304

	*buff = '\0';

   305

   306

	return buff;

   307

}

   308

   309

   310

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

   311

{

   312

	YearMonthDay ymd;

   313

	ConvertDateToYMD(date, &ymd);

   314

   315

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

   316

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

   317

}

   318

   319

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

   320

{

   321

	YearMonthDay ymd;

   322

	ConvertDateToYMD(date, &ymd);

   323

   324

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

   325

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

   326

}

   327

   328

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

   329

{

   330

	YearMonthDay ymd;

   331

	ConvertDateToYMD(date, &ymd);

   332

   333

	char day[3];

   334

	char month[3];

   335

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

   336

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

   337

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

   338

   339

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

   340

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

   341

}

   342

   343

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

   344

{

   345

	const char* multiplier = "";

   346

	char buf[40];

   347

	char* p;

   348

	int j;

   349

   350

	/* multiply by exchange rate */

   351

	number *= spec->rate;

   352

   353

	/* convert from negative */

   354

	if (number < 0) {

   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' + 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

	return buff;

   396

}

   397

   398

static int DeterminePluralForm(int32 n)

   399

{

   400

	/* The absolute value determines plurality */

   401

	if (n < 0) n = -n;

   402

   403

	switch (_langpack->plural_form) {

   404

	/* Two forms, singular used for one only

   405

	 * Used in:

   406

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

   407

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

   408

	case 0:

   409

	default:

   410

		return n != 1;

   411

   412

	/* Only one form

   413

	 * Used in:

   414

	 *   Hungarian, Japanese, Korean, Turkish */

   415

	case 1:

   416

		return 0;

   417

   418

	/* Two forms, singular used for zero and one

   419

	 * Used in:

   420

	 *   French, Brazilian Portuguese */

   421

	case 2:

   422

		return n > 1;

   423

   424

	/* Three forms, special case for zero

   425

	 * Used in:

   426

	 *   Latvian */

   427

	case 3:

   428

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

   429

   430

	/* Three forms, special case for one and two

   431

	 * Used in:

   432

	 *   Gaelige (Irish) */

   433

	case 4:

   434

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

   435

   436

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

   437

	 * Used in:

   438

	 *   Lithuanian */

   439

	case 5:

   440

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

   441

   442

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

   443

	 * Used in:

   444

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

   445

	case 6:

   446

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

   447

   448

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

   449

	 * Used in:

   450

	 *   Polish */

   451

	case 7:

   452

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

   453

   454

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

   455

	 * Used in:

   456

	 *   Slovenian */

   457

	case 8:

   458

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

   459

	}

   460

}

   461

   462

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

   463

{

   464

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

   465

	uint n = (byte)*b++;

   466

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

   467

   468

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

   469

		uint len = (byte)*b++;

   470

		if (i == form) {

   471

			mypos = pos;

   472

			mylen = len;

   473

		}

   474

		pos += len;

   475

	}

   476

	*dstlen = mylen;

   477

	memcpy(dst, b + mypos, mylen);

   478

	return b + pos;

   479

}

   480

   481

struct Units {

   482

	int s_m;           ///< Multiplier for velocity

   483

	int s_s;           ///< Shift for velocity

   484

	StringID velocity; ///< String for velocity

   485

	int p_m;           ///< Multiplier for power

   486

	int p_s;           ///< Shift for power

   487

	StringID power;    ///< String for velocity

   488

	int w_m;           ///< Multiplier for weight

   489

	int w_s;           ///< Shift for weight

   490