1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "currency.h"

     6

#include "functions.h"

     7

#include "string.h"

     8

#include "strings.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/landscape_const.h"

    21

#include "table/control_codes.h"

    22

#include "music.h"

    23

#include "date.h"

    24

#include "industry.h"

    25

#include "helpers.hpp"

    26

    27

#ifdef WIN32

    28

/* for opendir/readdir/closedir */

    29

# include "fios.h"

    30

#else

    31

# include <sys/types.h>

    32

# include <dirent.h>

    33

#endif /* WIN32 */

    34

    35

char _userstring[128];

    36

    37

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

    38

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

    39

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

    40

    41

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

    42

    43

typedef struct LanguagePack {

    44

	uint32 ident;

    45

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

    46

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

    47

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

    48

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

    49

	uint16 offsets[32]; // the offsets

    50

	byte plural_form;   // how to compute plural forms

    51

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

    52

	char data[VARARRAY_SIZE];

    53

} LanguagePack;

    54

    55

static char **_langpack_offs;

    56

static LanguagePack *_langpack;

    57

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

    58

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

    59

    60

    61

// Read an int64 from the argv array.

    62

static inline int64 GetInt64(const int32 **argv)

    63

{

    64

	int64 result;

    65

    66

	assert(argv);

    67

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

    68

	(*argv)+=2;

    69

	return result;

    70

}

    71

    72

// Read an int32 from the argv array.

    73

static inline int32 GetInt32(const int32 **argv)

    74

{

    75

	assert(argv);

    76

	return *(*argv)++;

    77

}

    78

    79

// Read an array from the argv array.

    80

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

    81

{

    82

	const int32 *result;

    83

	assert(*argv);

    84

	result = *argv;

    85

	(*argv) += n;

    86

	return result;

    87

}

    88

    89

    90

#define NUM_BOUND_STRINGS 8

    91

    92

// Array to hold the bound strings.

    93

static const char *_bound_strings[NUM_BOUND_STRINGS];

    94

    95

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

    96

// slots for BindCString. NUM_BOUND_STRINGS slots are reserved.

    97

// Which means that after NUM_BOUND_STRINGS calls to BindCString,

    98

// the indices will be reused.

    99

static int _bind_index;

   100

   101

static const char *GetStringPtr(StringID string)

   102

{

   103

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

   104

}

   105

   106

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

   107

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

   108

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

   109

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

   110

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

   111

{

   112

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

   113

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

   114

	char buff[512];

   115

   116

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

   117

   118

	switch (tab) {

   119

		case 4:

   120

			if (index >= 0xC0)

   121

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

   122

			break;

   123

   124

		case 14:

   125

			if (index >= 0xE4)

   126

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

   127

			break;

   128

   129

		// User defined name

   130

		case 15:

   131

			return GetName(buffr, index, last);

   132

   133

		case 26:

   134

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

   135

			if (HASBIT(index, 10)) {

   136

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

   137

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

   138

			}

   139

			break;

   140

   141

		case 28:

   142

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

   143

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

   144

   145

		case 29:

   146

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

   147

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

   148

   149

		case 30:

   150

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

   151

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

   152

   153

		case 31:

   154

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

   155

			// but passed through verbatim.

   156

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

   157

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

   158

			}

   159

   160

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

   161

	}

   162

   163

	if (index >= _langtab_num[tab]) {

   164

		error(

   165

			"!String 0x%X is invalid. "

   166

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

   167

		);

   168

	}

   169

   170

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

   171

}

   172

   173

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

   174

{

   175

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

   176

}

   177

   178

   179

char *InlineString(char *buf, StringID string)

   180

{

   181

	buf += Utf8Encode(buf, SCC_STRING_ID);

   182

	buf += Utf8Encode(buf, string);

   183

	return buf;

   184

}

   185

   186

   187

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

   188

// The duration of the bound string is valid only until the next GetString,

   189

// so be careful.

   190

StringID BindCString(const char *str)

   191

{

   192

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

   193

	_bound_strings[idx] = str;

   194

	return idx + STR_SPEC_DYNSTRING;

   195

}

   196

   197

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

   198

void SetDParamStr(uint n, const char *str)

   199

{

   200

	SetDParam(n, BindCString(str));

   201

}

   202

   203

void InjectDParam(int amount)

   204

{

   205

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

   206

}

   207

   208

static const uint32 _divisor_table[] = {

   209

	1000000000,

   210

	100000000,

   211

	10000000,

   212

	1000000,

   213

   214

	100000,

   215

	10000,

   216

	1000,

   217

	100,

   218

	10,

   219

	1

   220

};

   221

   222

// TODO

   223

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

   224

{

   225

	uint32 quot,divisor;

   226

	int i;

   227

	uint32 tot;

   228

	uint32 num;

   229

   230

	if (number < 0) {

   231

		*buff++ = '-';

   232

		number = -number;

   233

	}

   234

   235

	num = number;

   236

   237

	tot = 0;

   238

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

   239

		divisor = _divisor_table[i];

   240

		quot = 0;

   241

		if (num >= divisor) {

   242

			quot = num / _divisor_table[i];

   243

			num = num % _divisor_table[i];

   244

		}

   245

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

   246

			*buff++ = '0' + quot;

   247

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

   248

		}

   249

	}

   250

   251

	*buff = '\0';

   252

   253

	return buff;

   254

}

   255

   256

// TODO

   257

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

   258

{

   259

	uint32 quot,divisor;

   260

	int i;

   261

	uint32 tot;

   262

	uint32 num;

   263

   264

	if (number < 0) {

   265

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

   266

		number = -number;

   267

	}

   268

   269

	num = number;

   270

   271

	tot = 0;

   272

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

   273

		divisor = _divisor_table[i];

   274

		quot = 0;

   275

		if (num >= divisor) {

   276

			quot = num / _divisor_table[i];

   277

			num = num % _divisor_table[i];

   278

		}

   279

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

   280

			*buff++ = '0' + quot;

   281

		}

   282

	}

   283

   284

	*buff = '\0';

   285

   286

	return buff;

   287

}

   288

   289

   290

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

   291

{

   292

	YearMonthDay ymd;

   293

   294

	ConvertDateToYMD(date, &ymd);

   295

   296

	buff = strecpy(buff, GetStringPtr(ymd.day + STR_01AC_1ST - 1), last);

   297

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

   298

	buff = strecpy(buff, GetStringPtr(STR_0162_JAN + ymd.month), last);

   299

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

   300

   301

	return FormatNoCommaNumber(buff, ymd.year, last);

   302

}

   303

   304

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

   305

{

   306

	YearMonthDay ymd;

   307

   308

	ConvertDateToYMD(date, &ymd);

   309

   310

	buff = strecpy(buff, GetStringPtr(STR_MONTH_JAN + ymd.month), last);

   311

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

   312

   313

	return FormatNoCommaNumber(buff, ymd.year, last);

   314

}

   315

   316

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

   317

{

   318

	YearMonthDay ymd;

   319

   320

	ConvertDateToYMD(date, &ymd);

   321

	buff += snprintf(

   322

		buff, last - buff + 1,

   323

		" %02i-%02i-%04i", ymd.day, ymd.month + 1, ymd.year

   324

	);

   325

   326

	return buff;

   327

}

   328

   329

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

   330

{

   331

	const char* multiplier = "";

   332

	char buf[40];

   333

	char* p;

   334

	int j;

   335

   336

	// multiply by exchange rate

   337

	number *= spec->rate;

   338

   339

	// convert from negative

   340

	if (number < 0) {

   341

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

   342

		number = -number;

   343

	}

   344

   345

	/* Add prefix part, folowing symbol_pos specification.

   346

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

   347

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

   348

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

   349

   350

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

   351

	if (compact) {

   352

		if (number >= 1000000000) {

   353

			number = (number + 500000) / 1000000;

   354

			multiplier = "M";

   355

		} else if (number >= 1000000) {

   356

			number = (number + 500) / 1000;

   357

			multiplier = "k";

   358

		}

   359

	}

   360

   361

	// convert to ascii number and add commas

   362

	p = endof(buf);

   363

	*--p = '\0';

   364

	j = 4;

   365

	do {

   366

		if (--j == 0) {

   367

			*--p = spec->separator;

   368

			j = 3;

   369

		}

   370

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

   371

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

   372

	buff = strecpy(buff, p, last);

   373

   374

	buff = strecpy(buff, multiplier, last);

   375

   376

	/* Add suffix part, folowing symbol_pos specification.

   377

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

   378

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

   379

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

   380

   381

	return buff;

   382

}

   383

   384

static int DeterminePluralForm(int32 n)

   385

{

   386

	// The absolute value determines plurality

   387

	if (n < 0) n = -n;

   388

   389

	switch (_langpack->plural_form) {

   390

	// Two forms, singular used for one only

   391

	// Used in:

   392

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

   393

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

   394

	case 0:

   395

	default:

   396

		return n != 1;

   397

   398

	// Only one form

   399

	// Used in:

   400

	//   Hungarian, Japanese, Korean, Turkish

   401

	case 1:

   402

		return 0;

   403

   404

	// Two forms, singular used for zero and one

   405

	// Used in:

   406

	//   French, Brazilian Portuguese

   407

	case 2:

   408

		return n > 1;

   409

   410

	// Three forms, special case for zero

   411

	// Used in:

   412

	//   Latvian

   413

	case 3:

   414

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

   415

   416

	// Three forms, special case for one and two

   417

	// Used in:

   418

	//   Gaelige (Irish)

   419

	case 4:

   420

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

   421

   422

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

   423

	// Used in:

   424

	//   Lithuanian

   425

	case 5:

   426

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

   427

   428

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

   429

	// Used in:

   430

	//   Croatian, Czech, Russian, Slovak, Ukrainian

   431

	case 6:

   432

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

   433

   434

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

   435

	// Used in:

   436

	//   Polish

   437

	case 7:

   438

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

   439

   440

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

   441

	// Used in:

   442

	//   Slovenian

   443

	case 8:

   444

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

   445

	}

   446

}

   447

   448

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

   449

{

   450

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

   451

	uint n = (byte)*b++;

   452

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

   453

   454

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

   455

		uint len = (byte)*b++;

   456

		if (i == form) {

   457

			mypos = pos;

   458

			mylen = len;

   459

		}

   460

		pos += len;

   461

	}

   462

	*dstlen = mylen;

   463

	memcpy(dst, b + mypos, mylen);

   464

	return b + pos;

   465

}

   466

   467

typedef struct Units {

   468

	int s_m;           ///< Multiplier for velocity

   469

	int s_s;           ///< Shift for velocity

   470

	StringID velocity; ///< String for velocity

   471

	int p_m;           ///< Multiplier for power

   472

	int p_s;           ///< Shift for power

   473

	StringID power;    ///< String for velocity

   474

	int w_m;           ///< Multiplier for weight

   475

	int w_s;           ///< Shift for weight

   476

	StringID s_weight; ///< Short string for weight

   477

	StringID l_weight; ///< Long string for weight

   478

	int v_m;           ///< Multiplier for volume

   479

	int v_s;           ///< Shift for volume

   480

	StringID s_volume; ///< Short string for volume

   481

	StringID l_volume; ///< Long string for volume

   482

	int f_m;           ///< Multiplier for force

   483

	int f_s;           ///< Shift for force

   484

	StringID force;    ///< String for force

   485

} Units;

   486

   487

/* Unit conversions */

   488

static const Units units[] = {

   489

	{ // Imperial (Original, mph, hp, metric ton, litre, kN)

   490

		  10,  4, STR_UNITS_VELOCITY_IMPERIAL,

   491

		   1,  0, STR_UNITS_POWER_IMPERIAL,

   492

		   1,  0, STR_UNITS_WEIGHT_SHORT_METRIC, STR_UNITS_WEIGHT_LONG_METRIC,

   493

		1000,  0, STR_UNITS_VOLUME_SHORT_METRIC, STR_UNITS_VOLUME_LONG_METRIC,