1

/* $Id$ */

     2

     3

/** @file newgrf_text.cpp

     4

 * Implementation of  Action 04 "universal holder" structure and functions.

     5

 * This file implements a linked-lists of strings,

     6

 * holding everything that the newgrf action 04 will send over to OpenTTD.

     7

 * One of the biggest problems is that Dynamic lang Array uses ISO codes

     8

 * as way to identifying current user lang, while newgrf uses bit shift codes

     9

 * not related to ISO.  So equivalence functionnality had to be set.

    10

 */

    11

    12

#include "stdafx.h"

    13

#include "debug.h"

    14

#include "openttd.h"

    15

#include "variables.h"

    16

#include "newgrf.h"

    17

#include "newgrf_text.h"

    18

#include "strings_func.h"

    19

#include "core/alloc_func.hpp"

    20

#include "newgrf_storage.h"

    21

#include "string_func.h"

    22

    23

#include "table/strings.h"

    24

#include "table/control_codes.h"

    25

    26

#define GRFTAB  28

    27

#define TABSIZE 11

    28

    29

/**

    30

 * Explains the newgrf shift bit positionning.

    31

 * the grf base will not be used in order to find the string, but rather for

    32

 * jumping from standard langID scheme to the new one.

    33

 */

    34

enum grf_base_languages {

    35

	GRFLB_AMERICAN    = 0x01,

    36

	GRFLB_ENGLISH     = 0x02,

    37

	GRFLB_GERMAN      = 0x04,

    38

	GRFLB_FRENCH      = 0x08,

    39

	GRFLB_SPANISH     = 0x10,

    40

	GRFLB_GENERIC     = 0x80,

    41

};

    42

    43

enum grf_extended_languages {

    44

	GRFLX_AMERICAN    = 0x00,

    45

	GRFLX_ENGLISH     = 0x01,

    46

	GRFLX_GERMAN      = 0x02,

    47

	GRFLX_FRENCH      = 0x03,

    48

	GRFLX_SPANISH     = 0x04,

    49

	GRFLX_ESPERANTO   = 0x05,

    50

	GRFLX_RUSSIAN     = 0x07,

    51

	GRFLX_CZECH       = 0x15,

    52

	GRFLX_SLOVAK      = 0x16,

    53

	GRFLX_BULGARIAN   = 0x18,

    54

	GRFLX_AFRIKAANS   = 0x1B,

    55

	GRFLX_GREEK       = 0x1E,

    56

	GRFLX_DUTCH       = 0x1F,

    57

	GRFLX_CATALAN     = 0x22,

    58

	GRFLX_HUNGARIAN   = 0x24,

    59

	GRFLX_ITALIAN     = 0x27,

    60

	GRFLX_ROMANIAN    = 0x28,

    61

	GRFLX_ICELANDIC   = 0x29,

    62

	GRFLX_LATVIAN     = 0x2A,

    63

	GRFLX_LITHUANIAN  = 0x2B,

    64

	GRFLX_SLOVENIAN   = 0x2C,

    65

	GRFLX_DANISH      = 0x2D,

    66

	GRFLX_SWEDISH     = 0x2E,

    67

	GRFLX_NORWEGIAN   = 0x2F,

    68

	GRFLX_POLISH      = 0x30,

    69

	GRFLX_GALICIAN    = 0x31,

    70

	GRFLX_FRISIAN     = 0x32,

    71

	GRFLX_UKRAINIAN   = 0x33,

    72

	GRFLX_ESTONIAN    = 0x34,

    73

	GRFLX_FINNISH     = 0x35,

    74

	GRFLX_PORTUGUESE  = 0x36,

    75

	GRFLX_BRAZILIAN   = 0x37,

    76

	GRFLX_CROATIAN    = 0x38,

    77

	GRFLX_JAPANESE    = 0x39,

    78

	GRFLX_KOREAN      = 0x3A,

    79

	GRFLX_TURKISH     = 0x3E,

    80

	GRFLX_UNSPECIFIED = 0x7F,

    81

};

    82

    83

    84

struct iso_grf {

    85

	char code[6];

    86

	byte grfLangID;

    87

};

    88

    89

/**

    90

 * ISO code VS NewGrf langID conversion array.

    91

 * This array is used in two ways:

    92

 * 1-its ISO part is matching OpenTTD dynamic language id

    93

 *   with newgrf bit positionning language id

    94

 * 2-its shift part is used to know what is the shift to

    95

 *   watch for when inserting new strings, hence analysing newgrf langid

    96

 */

    97

const iso_grf iso_codes[] = {

    98

	{"en_US", GRFLX_AMERICAN},

    99

	{"en_GB", GRFLX_ENGLISH},

   100

	{"de_DE", GRFLX_GERMAN},

   101

	{"fr_FR", GRFLX_FRENCH},

   102

	{"es_ES", GRFLX_SPANISH},

   103

	{"af_ZA", GRFLX_AFRIKAANS},

   104

	{"hr_HR", GRFLX_CROATIAN},

   105

	{"cs_CZ", GRFLX_CZECH},

   106

	{"ca_ES", GRFLX_CATALAN},

   107

	{"da_DA", GRFLX_DANISH},

   108

	{"nl_NL", GRFLX_DUTCH},

   109

	{"et_ET", GRFLX_ESTONIAN},

   110

	{"fi_FI", GRFLX_FINNISH},

   111

	{"fy_NL", GRFLX_FRISIAN},

   112

	{"gl_ES", GRFLX_GALICIAN},

   113

	{"el_GR", GRFLX_GREEK},

   114

	{"hu_HU", GRFLX_HUNGARIAN},

   115

	{"is_IS", GRFLX_ICELANDIC},

   116

	{"it_IT", GRFLX_ITALIAN},

   117

	{"lv_LV", GRFLX_LATVIAN},

   118

	{"lt_LT", GRFLX_LITHUANIAN},

   119

	{"nb_NO", GRFLX_NORWEGIAN},

   120

	{"pl_PL", GRFLX_POLISH},

   121

	{"pt_PT", GRFLX_PORTUGUESE},

   122

	{"pt_BR", GRFLX_BRAZILIAN},

   123

	{"ro_RO", GRFLX_ROMANIAN},

   124

	{"ru_RU", GRFLX_RUSSIAN},

   125

	{"sk_SK", GRFLX_SLOVAK},

   126

	{"sl_SL", GRFLX_SLOVENIAN},

   127

	{"sv_SE", GRFLX_SWEDISH},

   128

	{"tr_TR", GRFLX_TURKISH},

   129

	{"uk_UA", GRFLX_UKRAINIAN},

   130

	{"eo_EO", GRFLX_ESPERANTO},

   131

	{"bg_BG", GRFLX_BULGARIAN},

   132

	{"ja_JP", GRFLX_JAPANESE},

   133

	{"ko_KR", GRFLX_KOREAN},

   134

	{"gen",   GRFLB_GENERIC}   ///< this is not iso code, but there has to be something...

   135

};

   136

   137

   138

/**

   139

 * Element of the linked list.

   140

 * Each of those elements represent the string,

   141

 * but according to a different lang.

   142

 */

   143

struct GRFText {

   144

	public:

   145

		static GRFText* New(byte langid, const char* text)

   146

		{

   147

			return new(strlen(text) + 1) GRFText(langid, text);

   148

		}

   149

   150

	private:

   151

		GRFText(byte langid_, const char* text_) : next(NULL), langid(langid_)

   152

		{

   153

			strcpy(text, text_);

   154

		}

   155

   156

		void* operator new(size_t size, size_t extra)

   157

		{

   158

			return ::operator new(size + extra);

   159

		}

   160

   161

public:

   162

		/* dummy operator delete to silence VC8:

   163

		 * 'void *GRFText::operator new(size_t,size_t)' : no matching operator delete found;

   164

		 *     memory will not be freed if initialization throws an exception */

   165

		void operator delete(void *p, size_t extra)

   166

		{

   167

			return ::operator delete(p);

   168

		}

   169

   170

	public:

   171

		GRFText *next;

   172

		byte langid;

   173

		char text[VARARRAY_SIZE];

   174

};

   175

   176

   177

/**

   178

 * Holder of the above structure.

   179

 * Putting both grfid and stringid together allows us to avoid duplicates,

   180

 * since it is NOT SUPPOSED to happen.

   181

 */

   182

struct GRFTextEntry {

   183

	uint32 grfid;

   184

	uint16 stringid;

   185

	StringID def_string;

   186

	GRFText *textholder;

   187

};

   188

   189

   190

static uint _num_grf_texts = 0;

   191

static GRFTextEntry _grf_text[(1 << TABSIZE) * 3];

   192

static byte _currentLangID = GRFLX_ENGLISH;  ///< by default, english is used.

   193

   194

   195

char *TranslateTTDPatchCodes(uint32 grfid, const char *str)

   196

{

   197

	char *tmp = MallocT<char>(strlen(str) * 10 + 1); // Allocate space to allow for expansion

   198

	char *d = tmp;

   199

	bool unicode = false;

   200

	WChar c;

   201

	size_t len = Utf8Decode(&c, str);

   202

   203

	if (c == 0x00DE) {

   204

		/* The thorn ('þ') indicates a unicode string to TTDPatch */

   205

		unicode = true;

   206

		str += len;

   207

	}

   208

   209

	for (;;) {

   210

		if (unicode && Utf8EncodedCharLen(*str) != 0) {

   211

			c = Utf8Consume(&str);

   212

			/* 'Magic' range of control codes. */

   213

			if (GB(c, 8, 8) == 0xE0) c = GB(c, 0, 8);

   214

		} else {

   215

			c = (byte)*str++;

   216

		}

   217

		if (c == 0) break;

   218

   219

		switch (c) {

   220

			case 0x01:

   221

				d += Utf8Encode(d, SCC_SETX);

   222

				*d++ = *str++;

   223

				break;

   224

			case 0x0A: break;

   225

			case 0x0D: *d++ = 0x0A; break;

   226

			case 0x0E: d += Utf8Encode(d, SCC_TINYFONT); break;

   227

			case 0x0F: d += Utf8Encode(d, SCC_BIGFONT); break;

   228

			case 0x1F:

   229

				d += Utf8Encode(d, SCC_SETXY);

   230

				*d++ = *str++;

   231

				*d++ = *str++;

   232

				break;

   233

			case 0x7B:

   234

			case 0x7C:

   235

			case 0x7D:

   236

			case 0x7E:

   237

			case 0x7F:

   238

			case 0x80: d += Utf8Encode(d, SCC_NEWGRF_PRINT_DWORD + c - 0x7B); break;

   239

			case 0x81: {

   240

				StringID string;

   241

				string  = *str++;

   242

				string |= *str++ << 8;

   243

				d += Utf8Encode(d, SCC_STRING_ID);

   244

				d += Utf8Encode(d, MapGRFStringID(grfid, string));

   245

				break;

   246

			}

   247

			case 0x82:

   248

			case 0x83:

   249

			case 0x84: d += Utf8Encode(d, SCC_NEWGRF_PRINT_WORD_SPEED + c - 0x82); break;

   250

			case 0x85: d += Utf8Encode(d, SCC_NEWGRF_DISCARD_WORD);       break;

   251

			case 0x86: d += Utf8Encode(d, SCC_NEWGRF_ROTATE_TOP_4_WORDS); break;

   252

			case 0x87: d += Utf8Encode(d, SCC_NEWGRF_PRINT_WORD_LITRES);  break;

   253

			case 0x88: d += Utf8Encode(d, SCC_BLUE);    break;

   254

			case 0x89: d += Utf8Encode(d, SCC_SILVER);  break;

   255

			case 0x8A: d += Utf8Encode(d, SCC_GOLD);    break;

   256

			case 0x8B: d += Utf8Encode(d, SCC_RED);     break;

   257

			case 0x8C: d += Utf8Encode(d, SCC_PURPLE);  break;

   258

			case 0x8D: d += Utf8Encode(d, SCC_LTBROWN); break;

   259

			case 0x8E: d += Utf8Encode(d, SCC_ORANGE);  break;

   260

			case 0x8F: d += Utf8Encode(d, SCC_GREEN);   break;

   261

			case 0x90: d += Utf8Encode(d, SCC_YELLOW);  break;

   262

			case 0x91: d += Utf8Encode(d, SCC_DKGREEN); break;

   263

			case 0x92: d += Utf8Encode(d, SCC_CREAM);   break;

   264

			case 0x93: d += Utf8Encode(d, SCC_BROWN);   break;

   265

			case 0x94: d += Utf8Encode(d, SCC_WHITE);   break;

   266

			case 0x95: d += Utf8Encode(d, SCC_LTBLUE);  break;

   267

			case 0x96: d += Utf8Encode(d, SCC_GRAY);    break;

   268

			case 0x97: d += Utf8Encode(d, SCC_DKBLUE);  break;

   269

			case 0x98: d += Utf8Encode(d, SCC_BLACK);   break;

   270

			case 0x9A:

   271

				switch (*str++) {

   272

					case 0: /* FALL THROUGH */

   273

					case 1: d += Utf8Encode(d, SCC_NEWGRF_PRINT_QWORD_CURRENCY); break;

   274

					case 3: {

   275

						uint16 tmp = *str++;

   276

						tmp |= (*str++) << 8;

   277

						d += Utf8Encode(d, SCC_NEWGRF_PUSH_WORD); d += Utf8Encode(d, tmp);

   278

					} break;

   279

					case 4: d += Utf8Encode(d, SCC_NEWGRF_UNPRINT); d += Utf8Encode(d, *str++); break;

   280

					default: grfmsg(1, "missing handler for extended format code"); break;

   281

				}

   282

				break;

   283

   284

			case 0x9E: d += Utf8Encode(d, 0x20AC); break; // Euro

   285

			case 0x9F: d += Utf8Encode(d, 0x0178); break; // Y with diaeresis

   286

			case 0xA0: d += Utf8Encode(d, SCC_UPARROW); break;

   287

			case 0xAA: d += Utf8Encode(d, SCC_DOWNARROW); break;

   288

			case 0xAC: d += Utf8Encode(d, SCC_CHECKMARK); break;

   289

			case 0xAD: d += Utf8Encode(d, SCC_CROSS); break;

   290

			case 0xAF: d += Utf8Encode(d, SCC_RIGHTARROW); break;

   291

			case 0xB4: d += Utf8Encode(d, SCC_TRAIN); break;

   292

			case 0xB5: d += Utf8Encode(d, SCC_LORRY); break;

   293

			case 0xB6: d += Utf8Encode(d, SCC_BUS); break;

   294

			case 0xB7: d += Utf8Encode(d, SCC_PLANE); break;

   295

			case 0xB8: d += Utf8Encode(d, SCC_SHIP); break;

   296

			case 0xB9: d += Utf8Encode(d, SCC_SUPERSCRIPT_M1); break;

   297

			case 0xBC: d += Utf8Encode(d, SCC_SMALLUPARROW); break;

   298

			case 0xBD: d += Utf8Encode(d, SCC_SMALLDOWNARROW); break;

   299

			default:

   300

				/* Validate any unhandled character */

   301

				if (!IsValidChar(c, CS_ALPHANUMERAL)) c = '?';

   302

				d += Utf8Encode(d, c);

   303

				break;

   304

		}

   305

	}

   306

   307

	*d = '\0';

   308

	tmp = ReallocT(tmp, strlen(tmp) + 1);

   309

	return tmp;

   310

}

   311

   312

   313

/**

   314

 * Add the new read string into our structure.

   315

 */

   316

StringID AddGRFString(uint32 grfid, uint16 stringid, byte langid_to_add, bool new_scheme, const char *text_to_add, StringID def_string)

   317

{

   318

	char *translatedtext;

   319

	uint id;

   320

   321

	/* When working with the old language scheme (grf_version is less than 7) and

   322

	 * English or American is among the set bits, simply add it as English in

   323

	 * the new scheme, i.e. as langid = 1.

   324

	 * If English is set, it is pretty safe to assume the translations are not

   325

	 * actually translated.

   326

	 */

   327

	if (!new_scheme) {

   328

		if (HASBITS(langid_to_add, GRFLB_AMERICAN | GRFLB_ENGLISH)) {

   329

			langid_to_add = GRFLX_ENGLISH;

   330

		} else {

   331

			StringID ret = STR_EMPTY;

   332

			if (langid_to_add & GRFLB_GERMAN)  ret = AddGRFString(grfid, stringid, GRFLX_GERMAN,  true, text_to_add, def_string);

   333

			if (langid_to_add & GRFLB_FRENCH)  ret = AddGRFString(grfid, stringid, GRFLX_FRENCH,  true, text_to_add, def_string);

   334

			if (langid_to_add & GRFLB_SPANISH) ret = AddGRFString(grfid, stringid, GRFLX_SPANISH, true, text_to_add, def_string);

   335

			return ret;

   336

		}

   337

	}

   338

   339

	for (id = 0; id < _num_grf_texts; id++) {

   340

		if (_grf_text[id].grfid == grfid && _grf_text[id].stringid == stringid) {

   341

			break;

   342

		}

   343

	}

   344

   345

	/* Too many strings allocated, return empty */

   346

	if (id == lengthof(_grf_text)) return STR_EMPTY;

   347

   348

	translatedtext = TranslateTTDPatchCodes(grfid, text_to_add);

   349

   350

	GRFText *newtext = GRFText::New(langid_to_add, translatedtext);

   351

   352

	free(translatedtext);

   353

   354

	/* If we didn't find our stringid and grfid in the list, allocate a new id */

   355

	if (id == _num_grf_texts) _num_grf_texts++;

   356

   357

	if (_grf_text[id].textholder == NULL) {

   358

		_grf_text[id].grfid      = grfid;

   359

		_grf_text[id].stringid   = stringid;

   360

		_grf_text[id].def_string = def_string;

   361

		_grf_text[id].textholder = newtext;

   362

	} else {

   363

		GRFText **ptext, *text;

   364

		bool replaced = false;

   365

   366

		/* Loop through all languages and see if we can replace a string */

   367

		for (ptext = &_grf_text[id].textholder; (text = *ptext) != NULL; ptext = &text->next) {

   368

			if (text->langid != langid_to_add) continue;

   369

			newtext->next = text->next;

   370

			*ptext = newtext;

   371

			delete text;

   372

			replaced = true;

   373

			break;

   374

		}

   375

   376

		/* If a string wasn't replaced, then we must append the new string */

   377

		if (!replaced) *ptext = newtext;

   378

	}

   379

   380

	grfmsg(3, "Added 0x%X: grfid %08X string 0x%X lang 0x%X string '%s'", id, grfid, stringid, newtext->langid, newtext->text);

   381

   382

	return (GRFTAB << TABSIZE) + id;

   383

}

   384

   385

/* Used to remember the grfid that the last retrieved string came from */

   386

static uint32 _last_grfid = 0;

   387

   388

/**

   389

 * Returns the index for this stringid associated with its grfID

   390

 */

   391

StringID GetGRFStringID(uint32 grfid, uint16 stringid)

   392

{

   393

	uint id;

   394

   395

	/* grfid is zero when we're being called via an include */

   396

	if (grfid == 0) grfid = _last_grfid;

   397

   398

	for (id = 0; id < _num_grf_texts; id++) {

   399

		if (_grf_text[id].grfid == grfid && _grf_text[id].stringid == stringid) {

   400

			return (GRFTAB << TABSIZE) + id;

   401

		}

   402

	}

   403

   404

	return STR_UNDEFINED;

   405

}

   406

   407

   408

const char *GetGRFStringPtr(uint16 stringid)

   409

{

   410

	const GRFText *default_text = NULL;

   411

	const GRFText *search_text;

   412

   413

	assert(_grf_text[stringid].grfid != 0);

   414

   415

	/* Remember this grfid in case the string has included text */

   416

	_last_grfid = _grf_text[stringid].grfid;

   417

   418

	/*Search the list of lang-strings of this stringid for current lang */

   419

	for (search_text = _grf_text[stringid].textholder; search_text != NULL; search_text = search_text->next) {

   420

		if (search_text->langid == _currentLangID) {

   421

			return search_text->text;

   422

		}

   423

   424

		/* If the current string is English or American, set it as the

   425

		 * fallback language if the specific language isn't available. */

   426

		if (search_text->langid == GRFLX_UNSPECIFIED || (default_text == NULL && (search_text->langid == GRFLX_ENGLISH || search_text->langid == GRFLX_AMERICAN))) {

   427

			default_text = search_text;

   428

		}

   429

	}

   430

   431

	/* If there is a fallback string, return that */

   432

	if (default_text != NULL) return default_text->text;

   433

   434

	/* Use the default string ID if the fallback string isn't available */

   435

	return GetStringPtr(_grf_text[stringid].def_string);

   436

}

   437

   438

/**

   439

 * Equivalence Setter function between game and newgrf langID.

   440

 * This function will adjust _currentLangID as to what is the LangID

   441

 * of the current language set by the user.

   442

 * The array iso_codes will be used to find that match.

   443

 * If not found, it will have to be standard english

   444

 * This function is called after the user changed language,

   445

 * from strings.cpp:ReadLanguagePack

   446

 * @param iso_name iso code of current selection

   447

 */

   448

void SetCurrentGrfLangID(const char *iso_name)

   449

{

   450

	/* Use English by default, if we can't match up the iso_code. */

   451

	byte ret = GRFLX_ENGLISH;

   452

	byte i;

   453

   454

	for (i=0; i < lengthof(iso_codes); i++) {

   455

		if (strncmp(iso_codes[i].code, iso_name, strlen(iso_codes[i].code)) == 0) {

   456

			/* We found a match, so let's use it. */

   457

			ret = iso_codes[i].grfLangID;

   458

			break;

   459

		}

   460

	}

   461

	_currentLangID = ret;

   462

}

   463

   464

bool CheckGrfLangID(byte lang_id, byte grf_version)

   465

{

   466

	if (grf_version < 7) {

   467

		switch (_currentLangID) {

   468

			case GRFLX_GERMAN:  return (lang_id & GRFLB_GERMAN)  != 0;

   469

			case GRFLX_FRENCH:  return (lang_id & GRFLB_FRENCH)  != 0;

   470

			case GRFLX_SPANISH: return (lang_id & GRFLB_SPANISH) != 0;

   471

			default:            return (lang_id & (GRFLB_ENGLISH | GRFLB_AMERICAN)) != 0;

   472

		}

   473

	}

   474

   475

	return (lang_id == _currentLangID || lang_id == GRFLX_UNSPECIFIED);

   476

}

   477

   478

/**

   479

 * House cleaning.

   480

 * Remove all strings and reset the text counter.

   481

 */

   482

void CleanUpStrings()

   483

{

   484

	uint id;

   485

   486

	for (id = 0; id < _num_grf_texts; id++) {

   487

		GRFText *grftext = _grf_text[id].textholder;

   488

		while (grftext != NULL) {

   489

			GRFText *grftext2 = grftext->next;

   490

			delete grftext;

   491

			grftext = grftext2;

   492

		}

   493

		_grf_text[id].grfid      = 0;

   494

		_grf_text[id].stringid   = 0;

   495

		_grf_text[id].textholder = NULL;

   496

	}