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 "string.h"

    16

#include "strings.h"

    17

#include "variables.h"

    18

#include "macros.h"

    19

#include "table/strings.h"

    20

#include "newgrf.h"

    21

#include "newgrf_text.h"

    22

#include "table/control_codes.h"

    23

#include "helpers.hpp"

    24

    25

#define GRFTAB  28

    26

#define TABSIZE 11

    27

    28

/**

    29

 * Explains the newgrf shift bit positionning.

    30

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

    31

 * jumping from standard langID scheme to the new one.

    32

 */

    33

enum grf_base_languages {

    34

	GRFLB_AMERICAN    = 0x01,

    35

	GRFLB_ENGLISH     = 0x02,

    36

	GRFLB_GERMAN      = 0x04,

    37

	GRFLB_FRENCH      = 0x08,

    38

	GRFLB_SPANISH     = 0x10,

    39

	GRFLB_GENERIC     = 0x80,

    40

};

    41

    42

enum grf_extended_languages {

    43

	GRFLX_AMERICAN    = 0x00,

    44

	GRFLX_ENGLISH     = 0x01,

    45

	GRFLX_GERMAN      = 0x02,

    46

	GRFLX_FRENCH      = 0x03,

    47

	GRFLX_SPANISH     = 0x04,

    48

	GRFLX_RUSSIAN     = 0x07,

    49

	GRFLX_CZECH       = 0x15,

    50

	GRFLX_SLOVAK      = 0x16,

    51

	GRFLX_AFRIKAANS   = 0x1B,

    52

	GRFLX_GREEK       = 0x1E,

    53

	GRFLX_DUTCH       = 0x1F,

    54

	GRFLX_CATALAN     = 0x22,

    55

	GRFLX_HUNGARIAN   = 0x24,

    56

	GRFLX_ITALIAN     = 0x27,

    57

	GRFLX_ROMANIAN    = 0x28,

    58

	GRFLX_ICELANDIC   = 0x29,

    59

	GRFLX_LATVIAN     = 0x2A,

    60

	GRFLX_LITHUANIAN  = 0x2B,

    61

	GRFLX_SLOVENIAN   = 0x2C,

    62

	GRFLX_DANISH      = 0x2D,

    63

	GRFLX_SWEDISH     = 0x2E,

    64

	GRFLX_NORWEGIAN   = 0x2F,

    65

	GRFLX_POLISH      = 0x30,

    66

	GRFLX_GALICIAN    = 0x31,

    67

	GRFLX_FRISIAN     = 0x32,

    68

	GRFLX_UKRAINIAN   = 0x33,

    69

	GRFLX_ESTONIAN    = 0x34,

    70

	GRFLX_FINNISH     = 0x35,

    71

	GRFLX_PORTUGUESE  = 0x36,

    72

	GRFLX_BRAZILIAN   = 0x37,

    73

	GRFLX_CROATIAN    = 0x38,

    74

	GRFLX_TURKISH     = 0x3E,

    75

	GRFLX_UNSPECIFIED = 0x7F,

    76

};

    77

    78

    79

struct iso_grf {

    80

	char code[6];

    81

	byte grfLangID;

    82

};

    83

    84

/**

    85

 * ISO code VS NewGrf langID conversion array.

    86

 * This array is used in two ways:

    87

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

    88

 *   with newgrf bit positionning language id

    89

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

    90

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

    91

 */

    92

const iso_grf iso_codes[] = {

    93

	{"en_US", GRFLX_AMERICAN},

    94

	{"en_GB", GRFLX_ENGLISH},

    95

	{"de_DE", GRFLX_GERMAN},

    96

	{"fr_FR", GRFLX_FRENCH},

    97

	{"es_ES", GRFLX_SPANISH},

    98

	{"af_ZA", GRFLX_AFRIKAANS},

    99

	{"hr_HR", GRFLX_CROATIAN},

   100

	{"cs_CS", GRFLX_CZECH},

   101

	{"ca_ES", GRFLX_CATALAN},

   102

	{"da_DA", GRFLX_DANISH},

   103

	{"nl_NL", GRFLX_DUTCH},

   104

	{"et_ET", GRFLX_ESTONIAN},

   105

	{"fi_FI", GRFLX_FINNISH},

   106

	{"fy_NL", GRFLX_FRISIAN},

   107

	{"gl_ES", GRFLX_GALICIAN},

   108

	{"el_GR", GRFLX_GREEK},

   109

	{"hu_HU", GRFLX_HUNGARIAN},

   110

	{"is_IS", GRFLX_ICELANDIC},

   111

	{"it_IT", GRFLX_ITALIAN},

   112

	{"lv_LV", GRFLX_LATVIAN},

   113

	{"lt_LT", GRFLX_LITHUANIAN},

   114

	{"nb_NO", GRFLX_NORWEGIAN},

   115

	{"pl_PL", GRFLX_POLISH},

   116

	{"pt_PT", GRFLX_PORTUGUESE},

   117

	{"pt_BR", GRFLX_BRAZILIAN},

   118

	{"ro_RO", GRFLX_ROMANIAN},

   119

	{"ru_RU", GRFLX_RUSSIAN},

   120

	{"sk_SK", GRFLX_SLOVAK},

   121

	{"sl_SL", GRFLX_SLOVENIAN},

   122

	{"sv_SE", GRFLX_SWEDISH},

   123

	{"tr_TR", GRFLX_TURKISH},

   124

	{"uk_UA", GRFLX_UKRAINIAN},

   125

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

   126

};

   127

   128

   129

/**

   130

 * Element of the linked list.

   131

 * Each of those elements represent the string,

   132

 * but according to a different lang.

   133

 */

   134

struct GRFText {

   135

	public:

   136

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

   137

		{

   138

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

   139

		}

   140

   141

	private:

   142

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

   143

		{

   144

			strcpy(text, text_);

   145

		}

   146

   147

		void* operator new(size_t size, size_t extra)

   148

		{

   149

			return ::operator new(size + extra);

   150

		}

   151

   152

public:

   153

		/* dummy operator delete to silence VC8:

   154

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

   155

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

   156

		void operator delete(void *p, size_t extra)

   157

		{

   158

			return ::operator delete(p);

   159

		}

   160

   161

	public:

   162

		GRFText *next;

   163

		byte langid;

   164

		char text[VARARRAY_SIZE];

   165

};

   166

   167

   168

/**

   169

 * Holder of the above structure.

   170

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

   171

 * since it is NOT SUPPOSED to happen.

   172

 */

   173

struct GRFTextEntry {

   174

	uint32 grfid;

   175

	uint16 stringid;

   176

	StringID def_string;

   177

	GRFText *textholder;

   178

};

   179

   180

   181

static uint _num_grf_texts = 0;

   182

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

   183

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

   184

   185

   186

char *TranslateTTDPatchCodes(const char *str)

   187

{

   188

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

   189

	char *d = tmp;

   190

	bool unicode = false;

   191

	WChar c;

   192

	size_t len = Utf8Decode(&c, str);

   193

   194

	if (c == 0x00DE) {

   195

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

   196

		unicode = true;

   197

		str += len;

   198

	}

   199

   200

	for (;;) {

   201

		const char *tmp = str; // Used for UTF-8 decoding

   202

   203

		c = (byte)*str++;

   204

		if (c == 0) break;

   205

   206

		switch (c) {

   207

			case 0x01:

   208

				d += Utf8Encode(d, SCC_SETX);

   209

				*d++ = *str++;

   210

				break;

   211

			case 0x0A: break;

   212

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

   213

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

   214

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

   215

			case 0x1F:

   216

				d += Utf8Encode(d, SCC_SETXY);

   217

				*d++ = *str++;

   218

				*d++ = *str++;

   219

				break;

   220

			case 0x7B:

   221

			case 0x7C:

   222

			case 0x7D:

   223

			case 0x7E: d += Utf8Encode(d, SCC_NUM); break;

   224

			case 0x7F: d += Utf8Encode(d, SCC_CURRENCY); break;

   225

			case 0x80: d += Utf8Encode(d, SCC_STRING); break;

   226

			case 0x81: {

   227

				StringID string;

   228

				string  = *str++;

   229

				string |= *str++ << 8;

   230

				d += Utf8Encode(d, SCC_STRING_ID);

   231

				d += Utf8Encode(d, string);

   232

				break;

   233

			}

   234

			case 0x82: d += Utf8Encode(d, SCC_DATE_TINY); break;

   235

			case 0x83: d += Utf8Encode(d, SCC_DATE_SHORT); break;

   236

			case 0x84: d += Utf8Encode(d, SCC_VELOCITY); break;

   237

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

   238

			case 0x86: /* "Rotate down top 4 words on stack" */ break;

   239

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

   240

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

   241

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

   242

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

   243

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

   244

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

   245

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

   246

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

   247

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

   248

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

   249

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

   250

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

   251

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

   252

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

   253

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

   254

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

   255

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

   256

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

   257

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

   258

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

   259

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

   260

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

   261

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

   262

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

   263

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

   264

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

   265

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

   266

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

   267

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

   268

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

   269

			default:

   270

				if (unicode) {

   271

					d += Utf8Encode(d, Utf8Consume(&tmp));

   272

					str = tmp;

   273

					break;

   274

				}

   275

   276

				/* Validate any unhandled character */

   277

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

   278

				d += Utf8Encode(d, c);

   279

				break;

   280

		}

   281

	}

   282

   283

	*d = '\0';

   284

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

   285

	return tmp;

   286

}

   287

   288

   289

/**

   290

 * Add the new read string into our structure.

   291

 */

   292

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

   293

{

   294

	char *translatedtext;

   295

	uint id;

   296

   297

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

   298

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

   299

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

   300

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

   301

	 * actually translated.

   302

	 */

   303

	if (!new_scheme) {

   304

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

   305

			langid_to_add = GRFLX_ENGLISH;

   306

		} else {

   307

			StringID ret = STR_EMPTY;

   308

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

   309

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

   310

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

   311

			return ret;

   312

		}

   313

	}

   314

   315

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

   316

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

   317

			break;

   318

		}

   319

	}

   320

   321

	/* Too many strings allocated, return empty */

   322

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

   323

   324

	translatedtext = TranslateTTDPatchCodes(text_to_add);

   325

   326

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

   327

   328

	free(translatedtext);

   329

   330

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

   331

	if (id == _num_grf_texts) _num_grf_texts++;

   332

   333

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

   334

		_grf_text[id].grfid      = grfid;

   335

		_grf_text[id].stringid   = stringid;

   336

		_grf_text[id].def_string = def_string;

   337

		_grf_text[id].textholder = newtext;

   338

	} else {

   339

		GRFText **ptext, *text;

   340

		bool replaced = false;

   341

   342

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

   343

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

   344

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

   345

			newtext->next = text->next;

   346

			*ptext = newtext;

   347

			delete text;

   348

			replaced = true;

   349

			break;

   350

		}

   351

   352

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

   353

		if (!replaced) *ptext = newtext;

   354

	}

   355

   356

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

   357

   358

	return (GRFTAB << TABSIZE) + id;

   359

}

   360

   361

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

   362

static uint32 _last_grfid = 0;

   363

   364

/**

   365

 * Returns the index for this stringid associated with its grfID

   366

 */

   367

StringID GetGRFStringID(uint32 grfid, uint16 stringid)

   368

{

   369

	uint id;

   370

   371

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

   372

	if (grfid == 0) grfid = _last_grfid;

   373

   374

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

   375

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

   376

			return (GRFTAB << TABSIZE) + id;

   377

		}

   378

	}

   379

   380

	return STR_UNDEFINED;

   381

}

   382

   383

   384

char *GetGRFString(char *buff, uint16 stringid, const char* last)

   385

{

   386

	const GRFText *default_text = NULL;

   387

	const GRFText *search_text;

   388

   389

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

   390

   391

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

   392

	_last_grfid = _grf_text[stringid].grfid;

   393

   394

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

   395

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

   396

		if (search_text->langid == _currentLangID) {

   397

			return strecpy(buff, search_text->text, last);

   398

		}

   399

   400

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

   401

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

   402

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

   403

			default_text = search_text;

   404

		}

   405

	}

   406

   407

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

   408

	if (default_text != NULL) return strecpy(buff, default_text->text, last);

   409

   410

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

   411

	return GetString(buff, _grf_text[stringid].def_string, last);

   412

}

   413

   414

/**

   415

 * Equivalence Setter function between game and newgrf langID.

   416

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

   417

 * of the current language set by the user.

   418

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

   419

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

   420

 * This function is called after the user changed language,

   423

 */

   424

void SetCurrentGrfLangID(const char *iso_name)

   425

{

   426

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

   427

	byte ret = GRFLX_ENGLISH;

   428

	byte i;

   429

   430

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

   431

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

   432

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

   433

			ret = i;

   434

			break;

   435

		}

   436

	}

   437

	_currentLangID = ret;

   438

}

   439

   440

/**

   441

 * House cleaning.

   442

 * Remove all strings and reset the text counter.

   443

 */

   444

void CleanUpStrings()

   445

{

   446

	uint id;

   447

   448

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

   449

		GRFText *grftext = _grf_text[id].textholder;

   450

		while (grftext != NULL) {

   451

			GRFText *grftext2 = grftext->next;

   452

			delete grftext;

   453

			grftext = grftext2;

   454

		}

   455

		_grf_text[id].grfid      = 0;

   456

		_grf_text[id].stringid   = 0;

   457

		_grf_text[id].textholder = NULL;

   458

	}

   459

   460

	_num_grf_texts = 0;

   461

}