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

    22

#define GRFTAB  28

    23

#define TABSIZE 11

    24

    25

/**

    26

 * Explains the newgrf shift bit positionning.

    27

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

    28

 * jumping from standard langID scheme to the new one.

    29

 */

    30

typedef enum grf_base_languages {

    31

	GRFLB_AMERICAN    = 0x01,

    32

	GRFLB_ENGLISH     = 0x02,

    33

	GRFLB_GERMAN      = 0x04,

    34

	GRFLB_FRENCH      = 0x08,

    35

	GRFLB_SPANISH     = 0x10,

    36

	GRFLB_GENERIC     = 0x80,

    37

} grf_base_language;

    38

    39

typedef enum grf_extended_languages {

    40

	GRFLX_AMERICAN    = 0x00,

    41

	GRFLX_ENGLISH     = 0x01,

    42

	GRFLX_GERMAN      = 0x02,

    43

	GRFLX_FRENCH      = 0x03,

    44

	GRFLX_SPANISH     = 0x04,

    45

	GRFLX_RUSSIAN     = 0x07,

    46

	GRFLX_CZECH       = 0x15,

    47

	GRFLX_SLOVAK      = 0x16,

    48

	GRFLX_DUTCH       = 0x1F,

    49

	GRFLX_CATALAN     = 0x22,

    50

	GRFLX_HUNGARIAN   = 0x24,

    51

	GRFLX_ITALIAN     = 0x27,

    52

	GRFLX_ROMANIAN    = 0x28,

    53

	GRFLX_ICELANDIC   = 0x29,

    54

	GRFLX_LATVIAN     = 0x2A,

    55

	GRFLX_LITHUANIAN  = 0x2B,

    56

	GRFLX_SLOVENIAN   = 0x2C,

    57

	GRFLX_DANISH      = 0x2D,

    58

	GRFLX_SWEDISH     = 0x2E,

    59

	GRFLX_NORWEGIAN   = 0x2F,

    60

	GRFLX_POLISH      = 0x30,

    61

	GRFLX_GALICIAN    = 0x31,

    62

	GRFLX_FRISIAN     = 0x32,

    63

	GRFLX_ESTONIAN    = 0x34,

    64

	GRFLX_FINNISH     = 0x35,

    65

	GRFLX_PORTUGUESE  = 0x36,

    66

	GRFLX_BRAZILIAN   = 0x37,

    67

	GRFLX_TURKISH     = 0x3E,

    68

	GRFLX_UNSPECIFIED = 0x7F,

    69

} grf_language;

    70

    71

    72

typedef struct iso_grf {

    73

	char code[6];

    74

	byte grfLangID;

    75

} iso_grf;

    76

    77

/**

    78

 * ISO code VS NewGrf langID conversion array.

    79

 * This array is used in two ways:

    80

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

    81

 *   with newgrf bit positionning language id

    82

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

    83

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

    84

 */

    85

const iso_grf iso_codes[] = {

    86

	{"en_US", GRFLX_AMERICAN},

    87

	{"en_GB", GRFLX_ENGLISH},

    88

	{"de",    GRFLX_GERMAN},

    89

	{"fr",    GRFLX_FRENCH},

    90

	{"es",    GRFLX_SPANISH},

    91

	{"cs",    GRFLX_CZECH},

    92

	{"ca",    GRFLX_CATALAN},

    93

	{"da",    GRFLX_DANISH},

    94

	{"nl",    GRFLX_DUTCH},

    95

	{"et",    GRFLX_ESTONIAN},

    96

	{"fi",    GRFLX_FINNISH},

    97

	{"fy",    GRFLX_FRISIAN},

    98

	{"gl",    GRFLX_GALICIAN},

    99

	{"hu",    GRFLX_HUNGARIAN},

   100

	{"is",    GRFLX_ICELANDIC},

   101

	{"it",    GRFLX_ITALIAN},

   102

	{"lv",    GRFLX_LATVIAN},

   103

	{"lt",    GRFLX_LITHUANIAN},

   104

	{"nb",    GRFLX_NORWEGIAN},

   105

	{"pl",    GRFLX_POLISH},

   106

	{"pt",    GRFLX_PORTUGUESE},

   107

	{"pt_BR", GRFLX_BRAZILIAN},

   108

	{"ro",    GRFLX_ROMANIAN},

   109

	{"ru",    GRFLX_RUSSIAN},

   110

	{"sk",    GRFLX_SLOVAK},

   111

	{"sl",    GRFLX_SLOVENIAN},

   112

	{"sv",    GRFLX_SWEDISH},

   113

	{"tr",    GRFLX_TURKISH},

   114

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

   115

};

   116

   117

   118

static uint _num_grf_texts = 0;

   119

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

   120

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

   121

   122

   123

static void TranslateTTDPatchCodes(char *str)

   124

{

   125

	char *c;

   126

   127

	for (c = str; *c != '\0'; c++) {

   128

		switch ((byte)*c) {

   129

			case 0x01: c++; break;

   130

			case 0x0D: *c = 10; break;

   131

			case 0x0E: *c = 8; break;

   132

			case 0x0F: *c = 9; break;

   133

			case 0x1F: *c = 2; c += 2; break;

   134

			case 0x7B:

   135

			case 0x7C:

   136

			case 0x7D:

   137

			case 0x7E: *c = 0x8E; break;

   138

			case 0x81: c += 2; break;

   139

			case 0x85: *c = 0x86; break;

   140

			case 0x88: *c = 15; break;

   141

			case 0x89: *c = 16; break;

   142

			case 0x8A: *c = 17; break;

   143

			case 0x8B: *c = 18; break;

   144

			case 0x8C: *c = 19; break;

   145

			case 0x8D: *c = 20; break;

   146

			case 0x8E: *c = 21; break;

   147

			case 0x8F: *c = 22; break;

   148

			case 0x90: *c = 23; break;

   149

			case 0x91: *c = 24; break;

   150

			case 0x92: *c = 25; break;

   151

			case 0x93: *c = 26; break;

   152

			case 0x94: *c = 27; break;

   153

			case 0x95: *c = 28; break;

   154

			case 0x96: *c = 29; break;

   155

			case 0x97: *c = 30; break;

   156

			case 0x98: *c = 31; break;

   157

			default:

   158

				/* Validate any unhandled character */

   159

				if (!IsValidAsciiChar(*c)) *c = '?';

   160

				break;

   161

		}

   162

	}

   163

}

   164

   165

   166

/**

   167

 * Add the new read string into our structure.

   168

 */

   169

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

   170

{

   171

	GRFText *newtext;

   172

	uint id;

   173

   174

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

   175

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

   176

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

   177

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

   178

	 * actually translated.

   179

	 */

   180

	if (!new_scheme) {

   181

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

   182

			langid_to_add = GRFLX_ENGLISH;

   183

		} else {

   184

			StringID ret = STR_EMPTY;

   185

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

   186

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

   187

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

   188

			return ret;

   189

		}

   190

	}

   191

   192

	newtext = calloc(1, sizeof(*newtext));

   193

	newtext->langid = GB(langid_to_add, 0, 6);

   194

	newtext->text   = strdup(text_to_add);

   195

	newtext->next   = NULL;

   196

   197

	TranslateTTDPatchCodes(newtext->text);

   198

   199

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

   200

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

   201

			break;

   202

		}

   203

	}

   204

   205

	/* Too many strings allocated, return empty */

   206

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

   207

   208

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

   209

	if (id == _num_grf_texts) _num_grf_texts++;

   210

   211

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

   212

		_grf_text[id].grfid      = grfid;

   213

		_grf_text[id].stringid   = stringid;

   214

		_grf_text[id].def_string = def_string;

   215

		_grf_text[id].textholder = newtext;

   216

	} else {

   217

		GRFText *textptr = _grf_text[id].textholder;

   218

		while (textptr->next != NULL) textptr = textptr->next;

   219

		textptr->next = newtext;

   220

	}

   221

   222

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

   223

   224

	return (GRFTAB << TABSIZE) + id;

   225

}

   226

   227

   228

/**

   229

 * Returns the index for this stringid associated with its grfID

   230

 */

   231

StringID GetGRFStringID(uint32 grfid, uint16 stringid)

   232

{

   233

	uint id;

   234

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

   235

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

   236

			return (GRFTAB << TABSIZE) + id;

   237

		}

   238

	}

   239

   240

	return STR_UNDEFINED;

   241

}

   242

   243

   244

char *GetGRFString(char *buff, uint16 stringid)

   245

{

   246

	GRFText *search_text;

   247

	GRFText *default_text = NULL;

   248

   249

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

   250

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

   251

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

   252

		if (search_text->langid == _currentLangID) {

   253

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

   254

		}

   255

   256

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

   257

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

   258

		if (search_text->langid == GRFLX_ENGLISH || search_text->langid == GRFLX_AMERICAN) {

   259

			default_text = search_text;

   260

		}

   261

	}

   262

   263

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

   264

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

   265

   266

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

   267

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

   268

}

   269

   270

/**

   271

 * Equivalence Setter function between game and newgrf langID.

   272

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

   273

 * of the current language set by the user.

   274

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

   275

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

   276

 * This function is called after the user changed language,

   277

 * from strings.c:ReadLanguagePack

   278

 * @param iso code of current selection

   279

 */

   280

void SetCurrentGrfLangID(const char *iso_name)

   281

{

   282

	byte ret,i;

   283

   284

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

   285

	ret = GRFLX_ENGLISH;

   286

   287

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

   288

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

   289

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

   290

			ret = i;

   291

			break;

   292

		}

   293

	}

   294

	_currentLangID = ret;

   295

}

   296

   297

/**

   298

 * House cleaning.

   299

 * Remove all strings and reset the text counter.

   300

 */

   301

void CleanUpStrings(void)

   302

{

   303

	uint id;

   304

   305

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

   306

		GRFText *grftext = _grf_text[id].textholder;

   307

		while (grftext != NULL) {

   308

			GRFText *grftext2 = grftext->next;

   309

			free(grftext->text);

   310

			free(grftext);

   311

			grftext = grftext2;

   312

		}

   313

		_grf_text[id].grfid      = 0;

   314

		_grf_text[id].stringid   = 0;

   315

		_grf_text[id].textholder = NULL;

   316

	}

   317

   318

	_num_grf_texts = 0;

   319

}