1

/* $Id$ */

     2

     3

/** @file

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

    21

#include "table/control_codes.h"

    22

    23

#define GRFTAB  28

    24

#define TABSIZE 11

    25

    26

/**

    27

 * Explains the newgrf shift bit positionning.

    28

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

    29

 * jumping from standard langID scheme to the new one.

    30

 */

    31

typedef enum grf_base_languages {

    32

	GRFLB_AMERICAN    = 0x01,

    33

	GRFLB_ENGLISH     = 0x02,

    34

	GRFLB_GERMAN      = 0x04,

    35

	GRFLB_FRENCH      = 0x08,

    36

	GRFLB_SPANISH     = 0x10,

    37

	GRFLB_GENERIC     = 0x80,

    38

} grf_base_language;

    39

    40

typedef enum grf_extended_languages {

    41

	GRFLX_AMERICAN    = 0x00,

    42

	GRFLX_ENGLISH     = 0x01,

    43

	GRFLX_GERMAN      = 0x02,

    44

	GRFLX_FRENCH      = 0x03,

    45

	GRFLX_SPANISH     = 0x04,

    46

	GRFLX_RUSSIAN     = 0x07,

    47

	GRFLX_CZECH       = 0x15,

    48

	GRFLX_SLOVAK      = 0x16,

    49

	GRFLX_AFRIKAANS   = 0x1B,

    50

	GRFLX_GREEK       = 0x1E,

    51

	GRFLX_DUTCH       = 0x1F,

    52

	GRFLX_CATALAN     = 0x22,

    53

	GRFLX_HUNGARIAN   = 0x24,

    54

	GRFLX_ITALIAN     = 0x27,

    55

	GRFLX_ROMANIAN    = 0x28,

    56

	GRFLX_ICELANDIC   = 0x29,

    57

	GRFLX_LATVIAN     = 0x2A,

    58

	GRFLX_LITHUANIAN  = 0x2B,

    59

	GRFLX_SLOVENIAN   = 0x2C,

    60

	GRFLX_DANISH      = 0x2D,

    61

	GRFLX_SWEDISH     = 0x2E,

    62

	GRFLX_NORWEGIAN   = 0x2F,

    63

	GRFLX_POLISH      = 0x30,

    64

	GRFLX_GALICIAN    = 0x31,

    65

	GRFLX_FRISIAN     = 0x32,

    66

	GRFLX_UKRAINIAN   = 0x33,

    67

	GRFLX_ESTONIAN    = 0x34,

    68

	GRFLX_FINNISH     = 0x35,

    69

	GRFLX_PORTUGUESE  = 0x36,

    70

	GRFLX_BRAZILIAN   = 0x37,

    71

	GRFLX_CROATIAN    = 0x38,

    72

	GRFLX_TURKISH     = 0x3E,

    73

	GRFLX_UNSPECIFIED = 0x7F,

    74

} grf_language;

    75

    76

    77

typedef struct iso_grf {

    78

	char code[6];

    79

	byte grfLangID;

    80

} iso_grf;

    81

    82

/**

    83

 * ISO code VS NewGrf langID conversion array.

    84

 * This array is used in two ways:

    85

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

    86

 *   with newgrf bit positionning language id

    87

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

    88

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

    89

 */

    90

const iso_grf iso_codes[] = {

    91

	{"en_US", GRFLX_AMERICAN},

    92

	{"en_GB", GRFLX_ENGLISH},

    93

	{"de_DE", GRFLX_GERMAN},

    94

	{"fr_FR", GRFLX_FRENCH},

    95

	{"es_ES", GRFLX_SPANISH},

    96

	{"af_ZA", GRFLX_AFRIKAANS},

    97

	{"hr_HR", GRFLX_CROATIAN},

    98

	{"cs_CZ", GRFLX_CZECH},

    99

	{"ca_ES", GRFLX_CATALAN},

   100

	{"da_DA", GRFLX_DANISH},

   101

	{"nl_NL", GRFLX_DUTCH},

   102

	{"et_ET", GRFLX_ESTONIAN},

   103

	{"fi_FI", GRFLX_FINNISH},

   104

	{"fy_NL", GRFLX_FRISIAN},

   105

	{"gl_ES", GRFLX_GALICIAN},

   106

	{"el_GR", GRFLX_GREEK},

   107

	{"hu_HU", GRFLX_HUNGARIAN},

   108

	{"is_IS", GRFLX_ICELANDIC},

   109

	{"it_IT", GRFLX_ITALIAN},

   110

	{"lv_LV", GRFLX_LATVIAN},

   111

	{"lt_LT", GRFLX_LITHUANIAN},

   112

	{"nb_NO", GRFLX_NORWEGIAN},

   113

	{"pl_PL", GRFLX_POLISH},

   114

	{"pt_PT", GRFLX_PORTUGUESE},

   115

	{"pt_BR", GRFLX_BRAZILIAN},

   116

	{"ro_RO", GRFLX_ROMANIAN},

   117

	{"ru_RU", GRFLX_RUSSIAN},

   118

	{"sk_SK", GRFLX_SLOVAK},

   119

	{"sl_SL", GRFLX_SLOVENIAN},

   120

	{"sv_SE", GRFLX_SWEDISH},

   121

	{"tr_TR", GRFLX_TURKISH},

   122

	{"uk_UA", GRFLX_UKRAINIAN},

   123

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

   124

};

   125

   126

   127

/**

   128

 * Element of the linked list.

   129

 * Each of those elements represent the string,

   130

 * but according to a different lang.

   131

 */

   132

typedef struct GRFText {

   133

	struct GRFText *next;

   134

	byte langid;

   135

	char text[VARARRAY_SIZE];

   136

} GRFText;

   137

   138

   139

/**

   140

 * Holder of the above structure.

   141

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

   142

 * since it is NOT SUPPOSED to happen.

   143

 */

   144

typedef struct GRFTextEntry {

   145

	uint32 grfid;

   146

	uint16 stringid;

   147

	StringID def_string;

   148

	GRFText *textholder;

   149

} GRFTextEntry;

   150

   151

   152

static uint _num_grf_texts = 0;

   153

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

   154

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

   155

   156

   157

char *TranslateTTDPatchCodes(const char *str)

   158

{

   159

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

   160

	char *d = tmp;

   161

	bool unicode = false;

   162

	WChar c;

   163

	size_t len = Utf8Decode(&c, str);

   164

   165

	if (c == 0x00DE) {

   166

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

   167

		unicode = true;

   168

		str += len;

   169

	}

   170

   171

	for (;;) {

   172

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

   173

   174

		c = (byte)*str++;

   175

		if (c == 0) break;

   176

   177

		switch (c) {

   178

			case 0x01:

   179

				d += Utf8Encode(d, SCC_SETX);

   180

				*d++ = *str++;

   181

				break;

   182

			case 0x0A: break;

   183

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

   184

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

   185

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

   186

			case 0x1F:

   187

				d += Utf8Encode(d, SCC_SETXY);

   188

				*d++ = *str++;

   189

				*d++ = *str++;

   190

				break;

   191

			case 0x7B:

   192

			case 0x7C:

   193

			case 0x7D:

   194

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

   195

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

   196

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

   197

			case 0x81: {

   198

				StringID string;

   199

				string  = *str++;

   200

				string |= *str++ << 8;

   201

				d += Utf8Encode(d, SCC_STRING_ID);

   202

				d += Utf8Encode(d, string);

   203

				break;

   204

			}

   205

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

   206

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

   207

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

   208

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

   209

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

   210

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

   211

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

   212

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

   213

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

   214

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

   215

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

   216

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

   217

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

   218

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

   219

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

   220

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

   221

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

   222

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

   223

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

   224

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

   225

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

   226

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

   227

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

   228

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

   229

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

   230

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

   231

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

   232

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

   233

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

   234

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

   235

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

   236

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

   237

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

   238

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

   239

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

   240

			default:

   241

				if (unicode) {

   242

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

   243

					str = tmp;

   244

					break;

   245

				}

   246

   247

				/* Validate any unhandled character */

   248

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

   249

				d += Utf8Encode(d, c);

   250

				break;

   251

		}

   252

	}

   253

   254

	*d = '\0';

   255

	return realloc(tmp, strlen(tmp) + 1);

   256

}

   257

   258

   259

/**

   260

 * Add the new read string into our structure.

   261

 */

   262

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

   263

{

   264

	char *translatedtext;

   265

	GRFText *newtext;

   266

	uint id;

   267

   268

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

   269

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

   270

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

   271

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

   272

	 * actually translated.

   273

	 */

   274

	if (!new_scheme) {

   275

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

   276

			langid_to_add = GRFLX_ENGLISH;

   277

		} else {

   278

			StringID ret = STR_EMPTY;

   279

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

   280

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

   281

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

   282

			return ret;

   283

		}

   284

	}

   285

   286

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

   287

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

   288

			break;

   289

		}

   290

	}

   291

   292

	/* Too many strings allocated, return empty */

   293

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

   294

   295

	translatedtext = TranslateTTDPatchCodes(text_to_add);

   296

   297

	newtext = malloc(sizeof(*newtext) + strlen(translatedtext) + 1);

   298

	newtext->next   = NULL;

   299

	newtext->langid = langid_to_add;

   300

	strcpy(newtext->text, translatedtext);

   301

   302

	free(translatedtext);

   303

   304

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

   305

	if (id == _num_grf_texts) _num_grf_texts++;

   306

   307

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

   308

		_grf_text[id].grfid      = grfid;

   309

		_grf_text[id].stringid   = stringid;

   310

		_grf_text[id].def_string = def_string;

   311

		_grf_text[id].textholder = newtext;

   312

	} else {

   313

		GRFText **ptext, *text;

   314

		bool replaced = false;

   315

   316

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

   317

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

   318

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

   319

			newtext->next = text->next;

   320

			*ptext = newtext;

   321

			free(text);

   322

			replaced = true;

   323

			break;

   324

		}

   325

   326

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

   327

		if (!replaced) *ptext = newtext;

   328

	}

   329

   330

	DEBUG(grf, 2)("Added 0x%X: grfid 0x%X string 0x%X lang 0x%X string %s", id, grfid, stringid, newtext->langid, newtext->text);

   331

   332

	return (GRFTAB << TABSIZE) + id;

   333

}

   334

   335

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

   336

static uint32 _last_grfid = 0;

   337

   338

/**

   339

 * Returns the index for this stringid associated with its grfID

   340

 */

   341

StringID GetGRFStringID(uint32 grfid, uint16 stringid)

   342

{

   343

	uint id;

   344

   345

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

   346

	if (grfid == 0) grfid = _last_grfid;

   347

   348

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

   349

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

   350

			return (GRFTAB << TABSIZE) + id;

   351

		}

   352

	}

   353

   354

	return STR_UNDEFINED;

   355

}

   356

   357

   358

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

   359

{

   360

	const GRFText *default_text = NULL;

   361

	const GRFText *search_text;

   362

   363

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

   364

   365

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

   366

	_last_grfid = _grf_text[stringid].grfid;

   367

   368

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

   369

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

   370

		if (search_text->langid == _currentLangID) {

   371

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

   372

		}

   373

   374

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

   375

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

   376

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

   377

			default_text = search_text;

   378

		}

   379

	}

   380

   381

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

   382

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

   383

   384

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

   385

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

   386

}

   387

   388

/**

   389

 * Equivalence Setter function between game and newgrf langID.

   390

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

   391

 * of the current language set by the user.

   392

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

   393

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

   394

 * This function is called after the user changed language,

   395

 * from strings.c:ReadLanguagePack

   396

 * @param iso code of current selection

   397

 */

   398

void SetCurrentGrfLangID(const char *iso_name)

   399

{

   400

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

   401

	byte ret = GRFLX_ENGLISH;

   402

	byte i;

   403

   404

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

   405

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

   406

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

   407

			ret = iso_codes[i].grfLangID;

   408

			break;

   409

		}

   410

	}

   411

	_currentLangID = ret;

   412

}

   413

   414

/**

   415

 * House cleaning.

   416

 * Remove all strings and reset the text counter.

   417

 */

   418

void CleanUpStrings(void)

   419

{

   420

	uint id;

   421

   422

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

   423

		GRFText *grftext = _grf_text[id].textholder;

   424

		while (grftext != NULL) {

   425

			GRFText *grftext2 = grftext->next;

   426

			free(grftext);

   427

			grftext = grftext2;

   428

		}

   429

		_grf_text[id].grfid      = 0;

   430

		_grf_text[id].stringid   = 0;

   431

		_grf_text[id].textholder = NULL;

   432

	}

   433

   434

	_num_grf_texts = 0;

   435

}