rubidium@8114: /* $Id$ */
rubidium@8114: 
rubidium@8114: /** @file strings_type.h Types related to strings. */
rubidium@8114: 
rubidium@8114: #ifndef STRINGS_TYPE_H
rubidium@8114: #define STRINGS_TYPE_H
rubidium@8114: 
rubidium@9773: /**
rubidium@9773:  * Numeric value that represents a string, independent of the selected language.
rubidium@9773:  */
rubidium@8114: typedef uint16 StringID;
rubidium@9773: static const StringID INVALID_STRING_ID = 0xFFFF;  ///< Constant representing an invalid string
rubidium@8114: 
rubidium@8114: enum {
rubidium@9773: 	MAX_LANG = 64, ///< Maximal number of languages supported by the game
rubidium@8114: };
rubidium@8114: 
rubidium@10249: /** Directions a text can go to */
rubidium@10249: enum TextDirection {
rubidium@10249: 	TD_LTR, ///< Text is written left-to-right by default
rubidium@10249: 	TD_RTL, ///< Text is written right-to-left by default
rubidium@10249: };
rubidium@10249: 
rubidium@8114: /** Information about a language */
rubidium@8114: struct Language {
rubidium@8114: 	char *name; ///< The internal name of the language
rubidium@8114: 	char *file; ///< The name of the language as it appears on disk
rubidium@8114: };
rubidium@8114: 
rubidium@8114: /** Used for dynamic language support */
rubidium@8114: struct DynamicLanguages {
glx@8321: 	int num;                  ///< Number of languages
glx@8321: 	int curr;                 ///< Currently selected language index
glx@8321: 	char curr_file[MAX_PATH]; ///< Currently selected language file name without path (needed for saving the filename of the loaded language).
rubidium@10249: 	TextDirection text_dir;   ///< Text direction of the currently selected language
glx@8321: 	Language ent[MAX_LANG];   ///< Information about the languages
rubidium@8114: };
rubidium@8114: 
rubidium@9773: /** Special string constants */
rubidium@8114: enum SpecialStrings {
rubidium@8114: 
rubidium@8114: 	// special strings for town names. the town name is generated dynamically on request.
rubidium@8114: 	SPECSTR_TOWNNAME_START     = 0x20C0,
rubidium@8114: 	SPECSTR_TOWNNAME_ENGLISH   = SPECSTR_TOWNNAME_START,
rubidium@8114: 	SPECSTR_TOWNNAME_FRENCH,
rubidium@8114: 	SPECSTR_TOWNNAME_GERMAN,
rubidium@8114: 	SPECSTR_TOWNNAME_AMERICAN,
rubidium@8114: 	SPECSTR_TOWNNAME_LATIN,
rubidium@8114: 	SPECSTR_TOWNNAME_SILLY,
rubidium@8114: 	SPECSTR_TOWNNAME_SWEDISH,
rubidium@8114: 	SPECSTR_TOWNNAME_DUTCH,
rubidium@8114: 	SPECSTR_TOWNNAME_FINNISH,
rubidium@8114: 	SPECSTR_TOWNNAME_POLISH,
rubidium@8114: 	SPECSTR_TOWNNAME_SLOVAKISH,
rubidium@8114: 	SPECSTR_TOWNNAME_NORWEGIAN,
rubidium@8114: 	SPECSTR_TOWNNAME_HUNGARIAN,
rubidium@8114: 	SPECSTR_TOWNNAME_AUSTRIAN,
rubidium@8114: 	SPECSTR_TOWNNAME_ROMANIAN,
rubidium@8114: 	SPECSTR_TOWNNAME_CZECH,
rubidium@8114: 	SPECSTR_TOWNNAME_SWISS,
rubidium@8114: 	SPECSTR_TOWNNAME_DANISH,
rubidium@8114: 	SPECSTR_TOWNNAME_TURKISH,
rubidium@8114: 	SPECSTR_TOWNNAME_ITALIAN,
rubidium@8114: 	SPECSTR_TOWNNAME_CATALAN,
rubidium@8114: 	SPECSTR_TOWNNAME_LAST      = SPECSTR_TOWNNAME_CATALAN,
rubidium@8114: 
rubidium@8114: 	// special strings for player names on the form "TownName transport".
rubidium@8114: 	SPECSTR_PLAYERNAME_START   = 0x70EA,
rubidium@8114: 	SPECSTR_PLAYERNAME_ENGLISH = SPECSTR_PLAYERNAME_START,
rubidium@8114: 	SPECSTR_PLAYERNAME_FRENCH,
rubidium@8114: 	SPECSTR_PLAYERNAME_GERMAN,
rubidium@8114: 	SPECSTR_PLAYERNAME_AMERICAN,
rubidium@8114: 	SPECSTR_PLAYERNAME_LATIN,
rubidium@8114: 	SPECSTR_PLAYERNAME_SILLY,
rubidium@8114: 	SPECSTR_PLAYERNAME_LAST    = SPECSTR_PLAYERNAME_SILLY,
rubidium@8114: 
rubidium@8114: 	SPECSTR_ANDCO_NAME         = 0x70E6,
rubidium@8114: 	SPECSTR_PRESIDENT_NAME     = 0x70E7,
rubidium@8114: 	SPECSTR_SONGNAME           = 0x70E8,
rubidium@8114: 
rubidium@8114: 	// reserve MAX_LANG strings for the *.lng files
rubidium@8114: 	SPECSTR_LANGUAGE_START     = 0x7100,
rubidium@8114: 	SPECSTR_LANGUAGE_END       = SPECSTR_LANGUAGE_START + MAX_LANG - 1,
rubidium@8114: 
rubidium@8114: 	// reserve 32 strings for various screen resolutions
rubidium@8114: 	SPECSTR_RESOLUTION_START   = SPECSTR_LANGUAGE_END + 1,
rubidium@8114: 	SPECSTR_RESOLUTION_END     = SPECSTR_RESOLUTION_START + 0x1F,
rubidium@8114: 
rubidium@8114: 	// reserve 32 strings for screenshot formats
rubidium@8114: 	SPECSTR_SCREENSHOT_START   = SPECSTR_RESOLUTION_END + 1,
rubidium@8114: 	SPECSTR_SCREENSHOT_END     = SPECSTR_SCREENSHOT_START + 0x1F,
rubidium@8114: };
rubidium@8114: 
rubidium@8114: #endif /* STRINGS_TYPE_H */