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

#include "signs.h"

    33

#include "vehicle.h"

    34

#include "newgrf_engine.h"

    35

    36

/* for opendir/readdir/closedir */

    37

# include "fios.h"

    38

    39

DynamicLanguages _dynlang;

    40

char _userstring[128];

    41

uint64 _decode_parameters[20];

    42

    43

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

    44

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

    45

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

    46

    47

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

    48

    49

struct LanguagePack {

    50

	uint32 ident;       // 32-bits identifier

    51

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

    52

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

    53

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

    54

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

    55

	uint16 offsets[32]; // the offsets

    56

	byte plural_form;   // how to compute plural forms

    57

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

    58

	char data[VARARRAY_SIZE]; // list of strings

    59

};

    60

    61

static char **_langpack_offs;

    62

static LanguagePack *_langpack;

    63

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

    64

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

    65

    66

    67

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

    68

static inline int64 GetInt64(const int64 **argv)

    69

{

    70

	assert(argv);

    71

	return *(*argv)++;

    72

}

    73

    74

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

    75

static inline int32 GetInt32(const int64 **argv)

    76

{

    77

	return (int32)GetInt64(argv);

    78

}

    79

    80

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

    81

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

    82

{

    83

	const int64 *result;

    84

	assert(*argv);

    85

	result = *argv;

    86

	(*argv) += n;

    87

	return result;

    88

}

    89

    90

    91

#define NUM_BOUND_STRINGS 8

    92

    93

/* Array to hold the bound strings. */

    94

static const char *_bound_strings[NUM_BOUND_STRINGS];

    95

    96

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

    97

 * slots for BindCString. NUM_BOUND_STRINGS slots are reserved.

    98

 * Which means that after NUM_BOUND_STRINGS calls to BindCString,

    99

 * the indices will be reused. */

   100

static int _bind_index;

   101

   102

static const char *GetStringPtr(StringID string)

   103

{

   104

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

   105

}

   106

   107

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

   108

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

   109

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

   110

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

   111

 * @param buffr

   112

 * @param string

   113

 * @param argv

   114

 * @param last

   115

 * @return a formatted string of char

   116

 */

   117

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

   118

{

   119

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

   120

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

   121

	char buff[512];

   122

   123

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

   124

   125

	switch (tab) {

   126

		case 4:

   127

			if (index >= 0xC0)

   128

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

   129

			break;

   130

   131

		case 14:

   132

			if (index >= 0xE4)

   133

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

   134

			break;

   135

   136

		case 15:

   137

			/* User defined name */

   138

			return GetName(buffr, index, last);

   139

   140

		case 26:

   141

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

   142

			if (HASBIT(index, 10)) {

   143

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

   144

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

   145

			}

   146

			break;

   147

   148

		case 28:

   149

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

   150

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

   151

   152

		case 29:

   153

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

   154

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

   155

   156

		case 30:

   157

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

   158

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

   159

   160

		case 31:

   161

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

   162

			 * but passed through verbatim. */

   163

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

   164

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

   165

			}

   166

   167

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

   168

	}

   169

   170

	if (index >= _langtab_num[tab]) {

   171

		error(

   172

			"!String 0x%X is invalid. "

   173

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

   174

		);

   175

	}

   176

   177

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

   178

}

   179

   180

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

   181

{

   182

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

   183

}

   184

   185

   186

char *InlineString(char *buf, StringID string)

   187

{

   188

	buf += Utf8Encode(buf, SCC_STRING_ID);

   189

	buf += Utf8Encode(buf, string);

   190

	return buf;

   191

}

   192

   193

   194

/**

   195

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

   196

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

   197

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

   198

 * @param str temp string to add

   199

 * @return the id of that temp string

   200

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

   201

 *       amount of 'user' bound strings by 2.

   202

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

   203

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

   204

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

   205

 */

   206

StringID BindCString(const char *str)

   207

{

   208

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

   209

	_bound_strings[idx] = str;

   210

	return idx + STR_SPEC_DYNSTRING;

   211

}

   212

   213

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

   214

 * @param n slot of the string

   215

 * @param str string to bind

   216

 */

   217

void SetDParamStr(uint n, const char *str)

   218

{

   219

	SetDParam(n, BindCString(str));

   220

}

   221

   222

void InjectDParam(int amount)

   223

{

   224

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

   225

}

   226

   227

// TODO

   228

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

   229

{

   230

	uint64 divisor = 10000000000000000000ULL;

   231

	uint64 quot;

   232

	int i;

   233

	uint64 tot;

   234

	uint64 num;

   235

   236

	if (number < 0) {

   237

		*buff++ = '-';

   238

		number = -number;

   239

	}

   240

   241

	num = number;

   242

   243

	tot = 0;

   244

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

   245

		quot = 0;

   246

		if (num >= divisor) {

   247

			quot = num / divisor;

   248

			num = num % divisor;

   249

		}

   250

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

   251

			*buff++ = '0' + quot;

   252

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

   253

		}

   254

   255

		divisor /= 10;

   256

	}

   257

   258

	*buff = '\0';

   259

   260

	return buff;

   261

}

   262

   263

// TODO

   264

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

   265

{

   266

	uint64 divisor = 10000000000000000000ULL;

   267

	uint64 quot;

   268

	int i;

   269

	uint64 tot;

   270

	uint64 num;

   271

   272

	if (number < 0) {

   273

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

   274

		number = -number;

   275

	}

   276

   277

	num = number;

   278

   279

	tot = 0;

   280

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

   281

		quot = 0;

   282

		if (num >= divisor) {

   283

			quot = num / divisor;

   284

			num = num % divisor;

   285

		}

   286

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

   287

			*buff++ = '0' + quot;

   288

		}

   289

   290

		divisor /= 10;

   291

	}

   292

   293

	*buff = '\0';

   294

   295

	return buff;

   296

}

   297

   298

   299

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

   300

{

   301

	YearMonthDay ymd;

   302

	ConvertDateToYMD(date, &ymd);

   303

   304

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

   305

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

   306

}

   307

   308

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

   309

{

   310

	YearMonthDay ymd;

   311

	ConvertDateToYMD(date, &ymd);

   312

   313

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

   314

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

   315

}

   316

   317

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

   318

{

   319

	YearMonthDay ymd;

   320

	ConvertDateToYMD(date, &ymd);

   321

   322

	char day[3];

   323

	char month[3];

   324

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

   325

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

   326

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

   327

   328

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

   329

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

   330

}

   331

   332

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

   333

{

   334

	const char* multiplier = "";

   335

	char buf[40];

   336

	char* p;

   337

	int j;

   338

   339

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

   340

	CommandCost cs(number);

   341

	cs.MultiplyCost(spec->rate);

   342

	number = cs.GetCost();

   343

   344

	/* convert from negative */

   345

	if (number < 0) {

   346

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

   347

		buff += Utf8Encode(buff, SCC_RED);

   348

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

   349

		number = -number;

   350

	}

   351

   352

	/* Add prefix part, folowing symbol_pos specification.

   353

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

   354

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

   355

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

   356

   357

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

   358

	if (compact) {

   359

		if (number >= 1000000000) {

   360

			number = (number + 500000) / 1000000;

   361

			multiplier = "M";

   362

		} else if (number >= 1000000) {

   363

			number = (number + 500) / 1000;

   364

			multiplier = "k";

   365

		}

   366

	}

   367

   368

	/* convert to ascii number and add commas */

   369

	p = endof(buf);

   370

	*--p = '\0';

   371

	j = 4;

   372

	do {

   373

		if (--j == 0) {

   374

			*--p = spec->separator;

   375

			j = 3;

   376

		}

   377

		*--p = '0' + number % 10;

   378

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

   379

	buff = strecpy(buff, p, last);

   380

   381

	buff = strecpy(buff, multiplier, last);

   382

   383

	/* Add suffix part, folowing symbol_pos specification.

   384

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

   385

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

   386

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

   387

   388

	if (cs.GetCost() < 0) {

   389

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

   390

		buff += Utf8Encode(buff, SCC_PREVIOUS_COLOUR);

   391

		*buff = '\0';

   392

	}

   393

   394

	return buff;

   395

}

   396

   397

static int DeterminePluralForm(int64 cnt)

   398

{

   399

	uint64 n = cnt;

   400

	/* The absolute value determines plurality */

   401

	if (cnt < 0) n = -cnt;

   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