1

/* $Id$ */

     2

     3

/** @file strings_type.h Types related to strings. */

     4

     5

#ifndef STRINGS_TYPE_H

     6

#define STRINGS_TYPE_H

     7

     8

/**

     9

 * Numeric value that represents a string, independent of the selected language.

    10

 */

    11

typedef uint16 StringID;

    12

static const StringID INVALID_STRING_ID = 0xFFFF;  ///< Constant representing an invalid string

    13

    14

enum {

    15

	MAX_LANG = 64, ///< Maximal number of languages supported by the game

    16

};

    17

    18

/** Directions a text can go to */

    19

enum TextDirection {

    20

	TD_LTR, ///< Text is written left-to-right by default

    21

	TD_RTL, ///< Text is written right-to-left by default

    22

};

    23

    24

/** Information about a language */

    25

struct Language {

    26

	char *name; ///< The internal name of the language

    27

	char *file; ///< The name of the language as it appears on disk

    28

};

    29

    30

/** Used for dynamic language support */

    31

struct DynamicLanguages {

    32

	int num;                  ///< Number of languages

    33

	int curr;                 ///< Currently selected language index

    34

	char curr_file[MAX_PATH]; ///< Currently selected language file name without path (needed for saving the filename of the loaded language).

    35

	TextDirection text_dir;   ///< Text direction of the currently selected language

    36

	Language ent[MAX_LANG];   ///< Information about the languages

    37

};

    38

    39

/** Special string constants */

    40

enum SpecialStrings {

    41

    42

	// special strings for town names. the town name is generated dynamically on request.

    43

	SPECSTR_TOWNNAME_START     = 0x20C0,

    44

	SPECSTR_TOWNNAME_ENGLISH   = SPECSTR_TOWNNAME_START,

    45

	SPECSTR_TOWNNAME_FRENCH,

    46

	SPECSTR_TOWNNAME_GERMAN,

    47

	SPECSTR_TOWNNAME_AMERICAN,

    48

	SPECSTR_TOWNNAME_LATIN,

    49

	SPECSTR_TOWNNAME_SILLY,

    50

	SPECSTR_TOWNNAME_SWEDISH,

    51

	SPECSTR_TOWNNAME_DUTCH,

    52

	SPECSTR_TOWNNAME_FINNISH,

    53

	SPECSTR_TOWNNAME_POLISH,

    54

	SPECSTR_TOWNNAME_SLOVAKISH,

    55

	SPECSTR_TOWNNAME_NORWEGIAN,

    56

	SPECSTR_TOWNNAME_HUNGARIAN,

    57

	SPECSTR_TOWNNAME_AUSTRIAN,

    58

	SPECSTR_TOWNNAME_ROMANIAN,

    59

	SPECSTR_TOWNNAME_CZECH,

    60

	SPECSTR_TOWNNAME_SWISS,

    61

	SPECSTR_TOWNNAME_DANISH,

    62

	SPECSTR_TOWNNAME_TURKISH,

    63

	SPECSTR_TOWNNAME_ITALIAN,

    64

	SPECSTR_TOWNNAME_CATALAN,

    65

	SPECSTR_TOWNNAME_LAST      = SPECSTR_TOWNNAME_CATALAN,

    66

    67

	// special strings for player names on the form "TownName transport".

    68

	SPECSTR_PLAYERNAME_START   = 0x70EA,

    69

	SPECSTR_PLAYERNAME_ENGLISH = SPECSTR_PLAYERNAME_START,

    70

	SPECSTR_PLAYERNAME_FRENCH,

    71

	SPECSTR_PLAYERNAME_GERMAN,

    72

	SPECSTR_PLAYERNAME_AMERICAN,

    73

	SPECSTR_PLAYERNAME_LATIN,

    74

	SPECSTR_PLAYERNAME_SILLY,

    75

	SPECSTR_PLAYERNAME_LAST    = SPECSTR_PLAYERNAME_SILLY,

    76

    77

	SPECSTR_ANDCO_NAME         = 0x70E6,

    78

	SPECSTR_PRESIDENT_NAME     = 0x70E7,

    79

	SPECSTR_SONGNAME           = 0x70E8,

    80

    81

	// reserve MAX_LANG strings for the *.lng files

    82

	SPECSTR_LANGUAGE_START     = 0x7100,

    83

	SPECSTR_LANGUAGE_END       = SPECSTR_LANGUAGE_START + MAX_LANG - 1,

    84

    85

	// reserve 32 strings for various screen resolutions

    86

	SPECSTR_RESOLUTION_START   = SPECSTR_LANGUAGE_END + 1,

    87

	SPECSTR_RESOLUTION_END     = SPECSTR_RESOLUTION_START + 0x1F,

    88

    89

	// reserve 32 strings for screenshot formats

    90

	SPECSTR_SCREENSHOT_START   = SPECSTR_RESOLUTION_END + 1,

    91

	SPECSTR_SCREENSHOT_END     = SPECSTR_SCREENSHOT_START + 0x1F,

    92

};

    93

    94

#endif /* STRINGS_TYPE_H */