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"

    31

#include "newgrf_townname.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 int64 *argv, const char* last);

    42

    43

static char *FormatString(char *buff, const char *str, const int64 *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 int64 **argv)

    65

{

    66

	assert(argv);

    67

	return *(*argv)++;

    68

}

    69

    70

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

    71

static inline int32 GetInt32(const int64 **argv)

    72

{

    73

	return (int32)GetInt64(argv);

    74

}

    75

    76

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

    77

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

    78

{

    79

	const int64 *result;

    80

	assert(*argv);

    81

	result = *argv;

    82

	(*argv) += n;

    83

	return result;

    84

}

    85

    86

    87

#define NUM_BOUND_STRINGS 8

    88

    89

/* Array to hold the bound strings. */

    90

static const char *_bound_strings[NUM_BOUND_STRINGS];

    91

    92

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

    93

 * slots for BindCString. NUM_BOUND_STRINGS slots are reserved.

    94

 * Which means that after NUM_BOUND_STRINGS calls to BindCString,

    95

 * the indices will be reused. */

    96

static int _bind_index;

    97

    98

static const char *GetStringPtr(StringID string)

    99

{

   100

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

   101

}

   102

   103

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

   104

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

   105

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

   106

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

   107

 * @param buffr

   108

 * @param string

   109

 * @param argv

   110

 * @param last

   111

 * @return a formatted string of char

   112

 */

   113

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

   114

{

   115

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

   116

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

   117

	char buff[512];

   118

   119

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

   120

   121

	switch (tab) {

   122

		case 4:

   123

			if (index >= 0xC0)

   124

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

   125

			break;

   126

   127

		case 14:

   128

			if (index >= 0xE4)

   129

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

   130

			break;

   131

   132

		case 15:

   133

			/* User defined name */

   134

			return GetName(buffr, index, last);

   135

   136

		case 26:

   137

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

   138

			if (HASBIT(index, 10)) {

   139

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

   140

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

   141

			}

   142

			break;

   143

   144

		case 28:

   145

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

   146

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

   147

   148

		case 29:

   149

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

   150

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

   151

   152

		case 30:

   153

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

   154

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

   155

   156

		case 31:

   157

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

   158

			 * but passed through verbatim. */

   159

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

   160

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

   161

			}

   162

   163

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

   164

	}

   165

   166

	if (index >= _langtab_num[tab]) {

   167

		error(

   168

			"!String 0x%X is invalid. "

   169

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

   170

		);

   171

	}

   172

   173

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

   174

}

   175

   176

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

   177

{

   178

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

   179

}

   180

   181

   182

char *InlineString(char *buf, StringID string)

   183

{

   184

	buf += Utf8Encode(buf, SCC_STRING_ID);

   185

	buf += Utf8Encode(buf, string);

   186

	return buf;

   187

}

   188

   189

   190

/**

   191

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

   192

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

   193

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

   194

 * @param str temp string to add

   195

 * @return the id of that temp string

   196

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

   197

 *       amount of 'user' bound strings by 2.

   198

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

   199

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

   200

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

   201

 */

   202

StringID BindCString(const char *str)

   203

{

   204

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

   205

	_bound_strings[idx] = str;

   206

	return idx + STR_SPEC_DYNSTRING;

   207

}

   208

   209

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

   210

 * @param n slot of the string

   211

 * @param str string to bind

   212

 */

   213

void SetDParamStr(uint n, const char *str)

   214

{

   215

	SetDParam(n, BindCString(str));

   216

}

   217

   218

void InjectDParam(int amount)

   219

{

   220

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

   221

}

   222

   223

static const uint32 _divisor_table[] = {

   224

	1000000000,

   225

	100000000,

   226

	10000000,

   227

	1000000,

   228

   229

	100000,

   230

	10000,

   231

	1000,

   232

	100,

   233

	10,

   234

	1

   235

};

   236

   237

// TODO

   238

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

   239

{

   240

	uint32 quot,divisor;

   241

	int i;

   242

	uint32 tot;

   243

	uint32 num;

   244

   245

	if (number < 0) {

   246

		*buff++ = '-';

   247

		number = -number;

   248

	}

   249

   250

	num = number;

   251

   252

	tot = 0;

   253

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

   254

		divisor = _divisor_table[i];

   255

		quot = 0;

   256

		if (num >= divisor) {

   257

			quot = num / _divisor_table[i];

   258

			num = num % _divisor_table[i];

   259

		}

   260

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

   261

			*buff++ = '0' + quot;

   262

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

   263

		}

   264

	}

   265

   266

	*buff = '\0';

   267

   268

	return buff;

   269

}

   270

   271

// TODO

   272

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

   273

{

   274

	uint32 quot,divisor;

   275

	int i;

   276

	uint32 tot;

   277

	uint32 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 != 10; i++) {

   288

		divisor = _divisor_table[i];

   289

		quot = 0;

   290

		if (num >= divisor) {

   291

			quot = num / _divisor_table[i];

   292

			num = num % _divisor_table[i];

   293

		}

   294

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

   295

			*buff++ = '0' + quot;

   296

		}

   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

	const char* multiplier = "";

   341

	char buf[40];

   342

	char* p;

   343

	int j;

   344

   345

	/* Multiply by exchange rate, but do it safely. */

   346

	CommandCost cs(number);

   347

	cs.MultiplyCost(spec->rate);

   348

	number = cs.GetCost();

   349

   350

	/* convert from negative */

   351

	if (number < 0) {

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

	return buff;

   393

}

   394

   395

static int DeterminePluralForm(int32 n)

   396

{

   397

	/* The absolute value determines plurality */

   398

	if (n < 0) n = -n;

   399

   400

	switch (_langpack->plural_form) {

   401

	/* Two forms, singular used for one only

   402

	 * Used in:

   403

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

   404

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

   405

	case 0:

   406

	default:

   407

		return n != 1;

   408

   409

	/* Only one form

   410

	 * Used in:

   411

	 *   Hungarian, Japanese, Korean, Turkish */

   412

	case 1:

   413

		return 0;

   414

   415

	/* Two forms, singular used for zero and one

   416

	 * Used in:

   417

	 *   French, Brazilian Portuguese */

   418

	case 2:

   419

		return n > 1;

   420

   421

	/* Three forms, special case for zero

   422

	 * Used in:

   423

	 *   Latvian */

   424

	case 3:

   425

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

   426

   427

	/* Three forms, special case for one and two

   428

	 * Used in:

   429

	 *   Gaelige (Irish) */

   430

	case 4:

   431

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

   432

   433

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

   434

	 * Used in:

   435

	 *   Lithuanian */

   436

	case 5:

   437

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

   438

   439

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

   440

	 * Used in:

   441

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

   442

	case 6:

   443

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

   444

   445

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

   446

	 * Used in:

   447

	 *   Polish */

   448

	case 7:

   449

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

   450

   451

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

   452

	 * Used in:

   453

	 *   Slovenian */

   454

	case 8:

   455

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

   456

	}

   457

}

   458

   459

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

   460

{

   461

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

   462

	uint n = (byte)*b++;

   463

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

   464

   465

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

   466

		uint len = (byte)*b++;

   467

		if (i == form) {

   468

			mypos = pos;

   469

			mylen = len;

   470

		}

   471

		pos += len;

   472

	}

   473

	*dstlen = mylen;

   474

	memcpy(dst, b + mypos, mylen);

   475

	return b + pos;

   476

}

   477

   478

struct Units {

   479

	int s_m;           ///< Multiplier for velocity

   480

	int s_s;           ///< Shift for velocity

   481

	StringID velocity; ///< String for velocity

   482

	int p_m;           ///< Multiplier for power

   483

	int p_s;           ///< Shift for power

   484

	StringID power;    ///< String for velocity

   485

	int w_m;           ///< Multiplier for weight

   486

	int w_s;           ///< Shift for weight

   487

	StringID s_weight; ///< Short string for weight

   488

	StringID l_weight; ///< Long string for weight

   489

	int v_m;           ///< Multiplier for volume