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/control_codes.h"

    21

#include "music.h"

    22

#include "date.h"

    23

#include "industry.h"

    24

#include "helpers.hpp"

    25

#include "cargotype.h"

    26

    27

/* for opendir/readdir/closedir */

    28

# include "fios.h"

    29

    30

char _userstring[128];

    31

    32

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

    33

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

    34

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

    35

    36

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

    37

    38

typedef struct LanguagePack {

    39

	uint32 ident;

    40

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

    41

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

    42

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

    43

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

    44

	uint16 offsets[32]; // the offsets

    45

	byte plural_form;   // how to compute plural forms

    46

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

    47

	char data[VARARRAY_SIZE];

    48

} LanguagePack;

    49

    50

static char **_langpack_offs;

    51

static LanguagePack *_langpack;

    52

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

    53

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

    54

    55

    56

// Read an int64 from the argv array.

    57

static inline int64 GetInt64(const int32 **argv)

    58

{

    59

	int64 result;

    60

    61

	assert(argv);

    62

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

    63

	(*argv)+=2;

    64

	return result;

    65

}

    66

    67

// Read an int32 from the argv array.

    68

static inline int32 GetInt32(const int32 **argv)

    69

{

    70

	assert(argv);

    71

	return *(*argv)++;

    72

}

    73

    74

// Read an array from the argv array.

    75

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

    76

{

    77

	const int32 *result;

    78

	assert(*argv);

    79

	result = *argv;

    80

	(*argv) += n;

    81

	return result;

    82

}

    83

    84

    85

#define NUM_BOUND_STRINGS 8

    86

    87

// Array to hold the bound strings.

    88

static const char *_bound_strings[NUM_BOUND_STRINGS];

    89

    90

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

    91

// slots for BindCString. NUM_BOUND_STRINGS slots are reserved.

    92

// Which means that after NUM_BOUND_STRINGS calls to BindCString,

    93

// the indices will be reused.

    94

static int _bind_index;

    95

    96

static const char *GetStringPtr(StringID string)

    97

{

    98

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

    99

}

   100

   101

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

   102

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

   103

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

   104

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

   105

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

   106

{

   107

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

   108

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

   109

	char buff[512];

   110

   111

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

   112

   113

	switch (tab) {

   114

		case 4:

   115

			if (index >= 0xC0)

   116

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

   117

			break;

   118

   119

		case 14:

   120

			if (index >= 0xE4)

   121

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

   122

			break;

   123

   124

		// User defined name

   125

		case 15:

   126

			return GetName(buffr, index, last);

   127

   128

		case 26:

   129

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

   130

			if (HASBIT(index, 10)) {

   131

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

   132

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

   133

			}

   134

			break;

   135

   136

		case 28:

   137

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

   138

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

   139

   140

		case 29:

   141

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

   142

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

   143

   144

		case 30:

   145

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

   146

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

   147

   148

		case 31:

   149

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

   150

			// but passed through verbatim.

   151

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

   152

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

   153

			}

   154

   155

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

   156

	}

   157

   158

	if (index >= _langtab_num[tab]) {

   159

		error(

   160

			"!String 0x%X is invalid. "

   161

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

   162

		);

   163

	}

   164

   165

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

   166

}

   167

   168

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

   169

{

   170

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

   171

}

   172

   173

   174

char *InlineString(char *buf, StringID string)

   175

{

   176

	buf += Utf8Encode(buf, SCC_STRING_ID);

   177

	buf += Utf8Encode(buf, string);

   178

	return buf;

   179

}

   180

   181

   182

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

   183

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

   184

// so be careful.

   185

StringID BindCString(const char *str)

   186

{

   187

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

   188

	_bound_strings[idx] = str;

   189

	return idx + STR_SPEC_DYNSTRING;

   190

}

   191

   192

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

   193

void SetDParamStr(uint n, const char *str)

   194

{

   195

	SetDParam(n, BindCString(str));

   196

}

   197

   198

void InjectDParam(int amount)

   199

{

   200

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

   201

}

   202

   203

static const uint32 _divisor_table[] = {

   204

	1000000000,

   205

	100000000,

   206

	10000000,

   207

	1000000,

   208

   209

	100000,

   210

	10000,

   211

	1000,

   212

	100,

   213

	10,

   214

	1

   215

};

   216

   217

// TODO

   218

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

   219

{

   220

	uint32 quot,divisor;

   221

	int i;

   222

	uint32 tot;

   223

	uint32 num;

   224

   225

	if (number < 0) {

   226

		*buff++ = '-';

   227

		number = -number;

   228

	}

   229

   230

	num = number;

   231

   232

	tot = 0;

   233

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

   234

		divisor = _divisor_table[i];

   235

		quot = 0;

   236

		if (num >= divisor) {

   237

			quot = num / _divisor_table[i];

   238

			num = num % _divisor_table[i];

   239

		}

   240

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

   241

			*buff++ = '0' + quot;

   242

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

   243

		}

   244

	}

   245

   246

	*buff = '\0';

   247

   248

	return buff;

   249

}

   250

   251

// TODO

   252

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

   253

{

   254

	uint32 quot,divisor;

   255

	int i;

   256

	uint32 tot;

   257

	uint32 num;

   258

   259

	if (number < 0) {

   260

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

   261

		number = -number;

   262

	}

   263

   264

	num = number;

   265

   266

	tot = 0;

   267

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

   268

		divisor = _divisor_table[i];

   269

		quot = 0;

   270

		if (num >= divisor) {

   271

			quot = num / _divisor_table[i];

   272

			num = num % _divisor_table[i];

   273

		}

   274

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

   275

			*buff++ = '0' + quot;

   276

		}

   277

	}

   278

   279

	*buff = '\0';

   280

   281

	return buff;

   282

}

   283

   284

   285

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

   286

{

   287

	YearMonthDay ymd;

   288

   289

	ConvertDateToYMD(date, &ymd);

   290

   291

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

   292

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

   293

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

   294

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

   295

   296

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

   297

}

   298

   299

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

   300

{

   301

	YearMonthDay ymd;

   302

   303

	ConvertDateToYMD(date, &ymd);

   304

   305

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

   306

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

   307

   308

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

   309

}

   310

   311

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

   312

{

   313

	YearMonthDay ymd;

   314

   315

	ConvertDateToYMD(date, &ymd);

   316

	buff += snprintf(

   317

		buff, last - buff + 1,

   318

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

   319

	);

   320

   321

	return buff;

   322

}

   323

   324

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

   325

{

   326

	const char* multiplier = "";

   327

	char buf[40];

   328

	char* p;

   329

	int j;

   330

   331

	// multiply by exchange rate

   332

	number *= spec->rate;

   333

   334

	// convert from negative

   335

	if (number < 0) {

   336

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

   337

		number = -number;

   338

	}

   339

   340

	/* Add prefix part, folowing symbol_pos specification.

   341

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

   342

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

   343

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

   344

   345

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

   346

	if (compact) {

   347

		if (number >= 1000000000) {

   348

			number = (number + 500000) / 1000000;

   349

			multiplier = "M";

   350

		} else if (number >= 1000000) {

   351

			number = (number + 500) / 1000;

   352

			multiplier = "k";

   353

		}

   354

	}

   355

   356

	// convert to ascii number and add commas

   357

	p = endof(buf);

   358

	*--p = '\0';

   359

	j = 4;

   360

	do {

   361

		if (--j == 0) {

   362

			*--p = spec->separator;

   363

			j = 3;

   364

		}

   365

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

   366

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

   367

	buff = strecpy(buff, p, last);

   368

   369

	buff = strecpy(buff, multiplier, last);

   370

   371

	/* Add suffix part, folowing symbol_pos specification.

   372

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

   373

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

   374

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

   375

   376

	return buff;

   377

}

   378

   379

static int DeterminePluralForm(int32 n)

   380

{

   381

	// The absolute value determines plurality

   382

	if (n < 0) n = -n;

   383

   384

	switch (_langpack->plural_form) {

   385

	// Two forms, singular used for one only

   386

	// Used in:

   387

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

   388

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

   389

	case 0:

   390

	default:

   391

		return n != 1;

   392

   393

	// Only one form

   394

	// Used in:

   395

	//   Hungarian, Japanese, Korean, Turkish

   396

	case 1:

   397

		return 0;

   398

   399

	// Two forms, singular used for zero and one

   400

	// Used in:

   401

	//   French, Brazilian Portuguese

   402

	case 2:

   403

		return n > 1;

   404

   405

	// Three forms, special case for zero

   406

	// Used in:

   407

	//   Latvian

   408

	case 3:

   409

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

   410

   411

	// Three forms, special case for one and two

   412

	// Used in:

   413

	//   Gaelige (Irish)

   414

	case 4:

   415

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

   416

   417

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

   418

	// Used in:

   419

	//   Lithuanian

   420

	case 5:

   421

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

   422

   423

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

   424

	// Used in:

   425

	//   Croatian, Czech, Russian, Slovak, Ukrainian

   426

	case 6:

   427

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

   428

   429

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

   430

	// Used in:

   431

	//   Polish

   432

	case 7:

   433

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

   434

   435

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

   436

	// Used in:

   437

	//   Slovenian

   438

	case 8:

   439

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

   440

	}

   441

}

   442

   443

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

   444

{

   445

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

   446

	uint n = (byte)*b++;

   447

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

   448

   449

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

   450

		uint len = (byte)*b++;

   451

		if (i == form) {

   452

			mypos = pos;

   453

			mylen = len;

   454

		}

   455

		pos += len;

   456

	}

   457

	*dstlen = mylen;

   458

	memcpy(dst, b + mypos, mylen);

   459

	return b + pos;

   460

}

   461

   462

typedef struct Units {

   463

	int s_m;           ///< Multiplier for velocity

   464

	int s_s;           ///< Shift for velocity

   465

	StringID velocity; ///< String for velocity

   466

	int p_m;           ///< Multiplier for power

   467

	int p_s;           ///< Shift for power

   468

	StringID power;    ///< String for velocity

   469

	int w_m;           ///< Multiplier for weight

   470

	int w_s;           ///< Shift for weight

   471

	StringID s_weight; ///< Short string for weight

   472

	StringID l_weight; ///< Long string for weight

   473

	int v_m;           ///< Multiplier for volume

   474

	int v_s;           ///< Shift for volume

   475

	StringID s_volume; ///< Short string for volume

   476

	StringID l_volume; ///< Long string for volume

   477

	int f_m;           ///< Multiplier for force

   478

	int f_s;           ///< Shift for force

   479

	StringID force;    ///< String for force

   480

} Units;

   481

   482

/* Unit conversions */

   483

static const Units units[] = {

   484

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

   485

		   1,  0, STR_UNITS_VELOCITY_IMPERIAL,

   486

		   1,  0, STR_UNITS_POWER_IMPERIAL,

   487

		   1,  0, STR_UNITS_WEIGHT_SHORT_METRIC, STR_UNITS_WEIGHT_LONG_METRIC,

   488

		1000,  0, STR_UNITS_VOLUME_SHORT_METRIC, STR_UNITS_VOLUME_LONG_METRIC,

   489

		   1,  0, STR_UNITS_FORCE_SI,

   490

	},

   491

	{ // Metric (km/h, hp, metric ton, litre, kN)

   492

		 103,  6, STR_UNITS_VELOCITY_METRIC,

   493

		   1,  0, STR_UNITS_POWER_METRIC,