annotate src/strings_type.h @ 8284:dbb7bfe0e95c draft

(svn r11848) -Codechange: New class-based drop down list functionality. Lists are now dynamically generated, and can include parameters, or be extended however needed.
author peter1138 <peter1138@openttd.org>
date Mon, 14 Jan 2008 16:10:58 +0000
parents 2d6af5d7a142
children c361d51b1bb8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8114
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
1 /* $Id$ */
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
2
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
3 /** @file strings_type.h Types related to strings. */
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
4
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
5 #ifndef STRINGS_TYPE_H
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
6 #define STRINGS_TYPE_H
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
7
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
8 typedef uint16 StringID;
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
9 static const StringID INVALID_STRING_ID = 0xFFFF;
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
10
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
11 enum {
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
12 MAX_LANG = 64,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
13 };
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
14
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
15 /** Information about a language */
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
16 struct Language {
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
17 char *name; ///< The internal name of the language
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
18 char *file; ///< The name of the language as it appears on disk
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
19 };
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
20
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
21 /** Used for dynamic language support */
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
22 struct DynamicLanguages {
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
23 int num; ///< Number of languages
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
24 int curr; ///< Currently selected language index
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
25 char curr_file[MAX_PATH]; ///< Currently selected language file name without path (needed for saving the filename of the loaded language).
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
26 StringID dropdown[MAX_LANG + 1]; ///< List of languages in the settings gui
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
27 Language ent[MAX_LANG]; ///< Information about the languages
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
28 };
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
29
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
30 // special string constants
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
31 enum SpecialStrings {
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
32
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
33 // special strings for town names. the town name is generated dynamically on request.
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
34 SPECSTR_TOWNNAME_START = 0x20C0,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
35 SPECSTR_TOWNNAME_ENGLISH = SPECSTR_TOWNNAME_START,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
36 SPECSTR_TOWNNAME_FRENCH,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
37 SPECSTR_TOWNNAME_GERMAN,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
38 SPECSTR_TOWNNAME_AMERICAN,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
39 SPECSTR_TOWNNAME_LATIN,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
40 SPECSTR_TOWNNAME_SILLY,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
41 SPECSTR_TOWNNAME_SWEDISH,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
42 SPECSTR_TOWNNAME_DUTCH,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
43 SPECSTR_TOWNNAME_FINNISH,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
44 SPECSTR_TOWNNAME_POLISH,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
45 SPECSTR_TOWNNAME_SLOVAKISH,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
46 SPECSTR_TOWNNAME_NORWEGIAN,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
47 SPECSTR_TOWNNAME_HUNGARIAN,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
48 SPECSTR_TOWNNAME_AUSTRIAN,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
49 SPECSTR_TOWNNAME_ROMANIAN,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
50 SPECSTR_TOWNNAME_CZECH,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
51 SPECSTR_TOWNNAME_SWISS,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
52 SPECSTR_TOWNNAME_DANISH,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
53 SPECSTR_TOWNNAME_TURKISH,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
54 SPECSTR_TOWNNAME_ITALIAN,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
55 SPECSTR_TOWNNAME_CATALAN,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
56 SPECSTR_TOWNNAME_LAST = SPECSTR_TOWNNAME_CATALAN,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
57
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
58 // special strings for player names on the form "TownName transport".
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
59 SPECSTR_PLAYERNAME_START = 0x70EA,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
60 SPECSTR_PLAYERNAME_ENGLISH = SPECSTR_PLAYERNAME_START,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
61 SPECSTR_PLAYERNAME_FRENCH,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
62 SPECSTR_PLAYERNAME_GERMAN,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
63 SPECSTR_PLAYERNAME_AMERICAN,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
64 SPECSTR_PLAYERNAME_LATIN,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
65 SPECSTR_PLAYERNAME_SILLY,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
66 SPECSTR_PLAYERNAME_LAST = SPECSTR_PLAYERNAME_SILLY,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
67
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
68 SPECSTR_ANDCO_NAME = 0x70E6,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
69 SPECSTR_PRESIDENT_NAME = 0x70E7,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
70 SPECSTR_SONGNAME = 0x70E8,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
71
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
72 // reserve MAX_LANG strings for the *.lng files
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
73 SPECSTR_LANGUAGE_START = 0x7100,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
74 SPECSTR_LANGUAGE_END = SPECSTR_LANGUAGE_START + MAX_LANG - 1,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
75
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
76 // reserve 32 strings for various screen resolutions
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
77 SPECSTR_RESOLUTION_START = SPECSTR_LANGUAGE_END + 1,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
78 SPECSTR_RESOLUTION_END = SPECSTR_RESOLUTION_START + 0x1F,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
79
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
80 // reserve 32 strings for screenshot formats
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
81 SPECSTR_SCREENSHOT_START = SPECSTR_RESOLUTION_END + 1,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
82 SPECSTR_SCREENSHOT_END = SPECSTR_SCREENSHOT_START + 0x1F,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
83
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
84 // Used to implement SetDParamStr
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
85 STR_SPEC_DYNSTRING = 0xF800,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
86 STR_SPEC_USERSTRING = 0xF808,
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
87 };
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
88
2d6af5d7a142 (svn r11675) -Codechange: split the string types from the string functions.
rubidium <rubidium@openttd.org>
parents:
diff changeset
89 #endif /* STRINGS_TYPE_H */