strgen_tables.h

Go to the documentation of this file.
00001 /* $Id$ */
00002 
00003 /*
00004  * This file is part of OpenTTD.
00005  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
00006  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
00007  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
00008  */
00009 
00012 #include "../core/enum_type.hpp"
00013 
00014 enum CmdFlags {
00015   C_NONE      = 0x0, 
00016   C_DONTCOUNT = 0x1, 
00017   C_CASE      = 0x2, 
00018   C_GENDER    = 0x4, 
00019 };
00020 DECLARE_ENUM_AS_BIT_SET(CmdFlags)
00021 
00022 struct Buffer;
00023 typedef void (*ParseCmdProc)(Buffer *buffer, char *buf, int value);
00024 
00025 struct CmdStruct {
00026   const char *cmd;
00027   ParseCmdProc proc;
00028   long value;
00029   uint8 consumes;
00030   CmdFlags flags;
00031 };
00032 
00033 extern void EmitSingleChar(Buffer *buffer, char *buf, int value);
00034 extern void EmitPlural(Buffer *buffer, char *buf, int value);
00035 extern void EmitGender(Buffer *buffer, char *buf, int value);
00036 
00037 static const CmdStruct _cmd_structs[] = {
00038   /* Font size */
00039   {"TINY_FONT",         EmitSingleChar, SCC_TINYFONT,           0, C_NONE},
00040   {"BIG_FONT",          EmitSingleChar, SCC_BIGFONT,            0, C_NONE},
00041 
00042   /* Colours */
00043   {"BLUE",              EmitSingleChar, SCC_BLUE,               0, C_NONE},
00044   {"SILVER",            EmitSingleChar, SCC_SILVER,             0, C_NONE},
00045   {"GOLD",              EmitSingleChar, SCC_GOLD,               0, C_NONE},
00046   {"RED",               EmitSingleChar, SCC_RED,                0, C_NONE},
00047   {"PURPLE",            EmitSingleChar, SCC_PURPLE,             0, C_NONE},
00048   {"LTBROWN",           EmitSingleChar, SCC_LTBROWN,            0, C_NONE},
00049   {"ORANGE",            EmitSingleChar, SCC_ORANGE,             0, C_NONE},
00050   {"GREEN",             EmitSingleChar, SCC_GREEN,              0, C_NONE},
00051   {"YELLOW",            EmitSingleChar, SCC_YELLOW,             0, C_NONE},
00052   {"DKGREEN",           EmitSingleChar, SCC_DKGREEN,            0, C_NONE},
00053   {"CREAM",             EmitSingleChar, SCC_CREAM,              0, C_NONE},
00054   {"BROWN",             EmitSingleChar, SCC_BROWN,              0, C_NONE},
00055   {"WHITE",             EmitSingleChar, SCC_WHITE,              0, C_NONE},
00056   {"LTBLUE",            EmitSingleChar, SCC_LTBLUE,             0, C_NONE},
00057   {"GRAY",              EmitSingleChar, SCC_GRAY,               0, C_NONE},
00058   {"DKBLUE",            EmitSingleChar, SCC_DKBLUE,             0, C_NONE},
00059   {"BLACK",             EmitSingleChar, SCC_BLACK,              0, C_NONE},
00060 
00061   {"REV",               EmitSingleChar, SCC_REVISION,           0, C_NONE}, // openttd revision string
00062 
00063   {"STRING1",           EmitSingleChar, SCC_STRING1,            2, C_CASE | C_GENDER}, // included string that consumes the string id and ONE argument
00064   {"STRING2",           EmitSingleChar, SCC_STRING2,            3, C_CASE | C_GENDER}, // included string that consumes the string id and TWO arguments
00065   {"STRING3",           EmitSingleChar, SCC_STRING3,            4, C_CASE | C_GENDER}, // included string that consumes the string id and THREE arguments
00066   {"STRING4",           EmitSingleChar, SCC_STRING4,            5, C_CASE | C_GENDER}, // included string that consumes the string id and FOUR arguments
00067   {"STRING5",           EmitSingleChar, SCC_STRING5,            6, C_CASE | C_GENDER}, // included string that consumes the string id and FIVE arguments
00068   {"STRING6",           EmitSingleChar, SCC_STRING6,            7, C_CASE | C_GENDER}, // included string that consumes the string id and SIX arguments
00069   {"STRING7",           EmitSingleChar, SCC_STRING7,            8, C_CASE | C_GENDER}, // included string that consumes the string id and SEVEN arguments
00070 
00071   {"STATION_FEATURES",  EmitSingleChar, SCC_STATION_FEATURES,   1, C_NONE}, // station features string, icons of the features
00072   {"INDUSTRY",          EmitSingleChar, SCC_INDUSTRY_NAME,      1, C_CASE | C_GENDER}, // industry, takes an industry #, can have cases
00073   {"CARGO_LONG",        EmitSingleChar, SCC_CARGO_LONG,         2, C_NONE | C_GENDER},
00074   {"CARGO_SHORT",       EmitSingleChar, SCC_CARGO_SHORT,        2, C_NONE}, // short cargo description, only ### tons, or ### litres
00075   {"CARGO_TINY",        EmitSingleChar, SCC_CARGO_TINY,         2, C_NONE}, // tiny cargo description with only the amount, not a specifier for the amount or the actual cargo name
00076   {"POWER",             EmitSingleChar, SCC_POWER,              1, C_NONE},
00077   {"VOLUME_LONG",       EmitSingleChar, SCC_VOLUME_LONG,        1, C_NONE},
00078   {"VOLUME_SHORT",      EmitSingleChar, SCC_VOLUME_SHORT,       1, C_NONE},
00079   {"WEIGHT_LONG",       EmitSingleChar, SCC_WEIGHT_LONG,        1, C_NONE},
00080   {"WEIGHT_SHORT",      EmitSingleChar, SCC_WEIGHT_SHORT,       1, C_NONE},
00081   {"FORCE",             EmitSingleChar, SCC_FORCE,              1, C_NONE},
00082   {"VELOCITY",          EmitSingleChar, SCC_VELOCITY,           1, C_NONE},
00083   {"HEIGHT",            EmitSingleChar, SCC_HEIGHT,             1, C_NONE},
00084 
00085   {"P",                 EmitPlural,     0,                      0, C_DONTCOUNT}, // plural specifier
00086   {"G",                 EmitGender,     0,                      0, C_DONTCOUNT}, // gender specifier
00087 
00088   {"DATE_TINY",         EmitSingleChar, SCC_DATE_TINY,          1, C_NONE},
00089   {"DATE_SHORT",        EmitSingleChar, SCC_DATE_SHORT,         1, C_CASE},
00090   {"DATE_LONG",         EmitSingleChar, SCC_DATE_LONG,          1, C_CASE},
00091   {"DATE_ISO",          EmitSingleChar, SCC_DATE_ISO,           1, C_NONE},
00092 
00093   {"STRING",            EmitSingleChar, SCC_STRING,             1, C_CASE | C_GENDER},
00094   {"RAW_STRING",        EmitSingleChar, SCC_RAW_STRING_POINTER, 1, C_NONE | C_GENDER},
00095 
00096   /* Numbers */
00097   {"COMMA",             EmitSingleChar, SCC_COMMA,              1, C_NONE}, // Number with comma
00098   {"DECIMAL",           EmitSingleChar, SCC_DECIMAL,            2, C_NONE}, // Number with comma and fractional part. Second parameter is number of fractional digits, first parameter is number times 10**(second parameter).
00099   {"NUM",               EmitSingleChar, SCC_NUM,                1, C_NONE}, // Signed number
00100   {"ZEROFILL_NUM",      EmitSingleChar, SCC_ZEROFILL_NUM,       2, C_NONE}, // Unsigned number with zero fill, e.g. "02". First parameter is number, second minimum length
00101   {"BYTES",             EmitSingleChar, SCC_BYTES,              1, C_NONE}, // Unsigned number with "bytes", i.e. "1.02 MiB or 123 KiB"
00102   {"HEX",               EmitSingleChar, SCC_HEX,                1, C_NONE}, // Hexadecimally printed number
00103 
00104   {"CURRENCY_LONG",     EmitSingleChar, SCC_CURRENCY_LONG,      1, C_NONE},
00105   {"CURRENCY_SHORT",    EmitSingleChar, SCC_CURRENCY_SHORT,     1, C_NONE}, // compact currency
00106 
00107   {"WAYPOINT",          EmitSingleChar, SCC_WAYPOINT_NAME,      1, C_NONE | C_GENDER}, // waypoint name
00108   {"STATION",           EmitSingleChar, SCC_STATION_NAME,       1, C_NONE | C_GENDER},
00109   {"DEPOT",             EmitSingleChar, SCC_DEPOT_NAME,         2, C_NONE | C_GENDER},
00110   {"TOWN",              EmitSingleChar, SCC_TOWN_NAME,          1, C_NONE | C_GENDER},
00111   {"GROUP",             EmitSingleChar, SCC_GROUP_NAME,         1, C_NONE | C_GENDER},
00112   {"SIGN",              EmitSingleChar, SCC_SIGN_NAME,          1, C_NONE | C_GENDER},
00113   {"ENGINE",            EmitSingleChar, SCC_ENGINE_NAME,        1, C_NONE | C_GENDER},
00114   {"VEHICLE",           EmitSingleChar, SCC_VEHICLE_NAME,       1, C_NONE | C_GENDER},
00115   {"COMPANY",           EmitSingleChar, SCC_COMPANY_NAME,       1, C_NONE | C_GENDER},
00116   {"COMPANY_NUM",       EmitSingleChar, SCC_COMPANY_NUM,        1, C_NONE},
00117   {"PRESIDENT_NAME",    EmitSingleChar, SCC_PRESIDENT_NAME,     1, C_NONE | C_GENDER},
00118 
00119   {"",                  EmitSingleChar, '\n',                   0, C_DONTCOUNT},
00120   {"{",                 EmitSingleChar, '{',                    0, C_DONTCOUNT},
00121   {"UP_ARROW",          EmitSingleChar, SCC_UP_ARROW,           0, C_DONTCOUNT},
00122   {"SMALL_UP_ARROW",    EmitSingleChar, SCC_SMALL_UP_ARROW,     0, C_DONTCOUNT},
00123   {"SMALL_DOWN_ARROW",  EmitSingleChar, SCC_SMALL_DOWN_ARROW,   0, C_DONTCOUNT},
00124   {"TRAIN",             EmitSingleChar, SCC_TRAIN,              0, C_DONTCOUNT},
00125   {"LORRY",             EmitSingleChar, SCC_LORRY,              0, C_DONTCOUNT},
00126   {"BUS",               EmitSingleChar, SCC_BUS,                0, C_DONTCOUNT},
00127   {"PLANE",             EmitSingleChar, SCC_PLANE,              0, C_DONTCOUNT},
00128   {"SHIP",              EmitSingleChar, SCC_SHIP,               0, C_DONTCOUNT},
00129   {"NBSP",              EmitSingleChar, 0xA0,                   0, C_DONTCOUNT},
00130   {"CENT",              EmitSingleChar, 0xA2,                   0, C_DONTCOUNT},
00131   {"POUND_SIGN",        EmitSingleChar, 0xA3,                   0, C_DONTCOUNT},
00132   {"EURO",              EmitSingleChar, 0x20AC,                 0, C_DONTCOUNT},
00133   {"YEN_SIGN",          EmitSingleChar, 0xA5,                   0, C_DONTCOUNT},
00134   {"COPYRIGHT",         EmitSingleChar, 0xA9,                   0, C_DONTCOUNT},
00135   {"DOWN_ARROW",        EmitSingleChar, SCC_DOWN_ARROW,         0, C_DONTCOUNT},
00136   {"CHECKMARK",         EmitSingleChar, SCC_CHECKMARK,          0, C_DONTCOUNT},
00137   {"CROSS",             EmitSingleChar, SCC_CROSS,              0, C_DONTCOUNT},
00138   {"REGISTERED",        EmitSingleChar, 0xAE,                   0, C_DONTCOUNT},
00139   {"RIGHT_ARROW",       EmitSingleChar, SCC_RIGHT_ARROW,        0, C_DONTCOUNT},
00140   {"SMALL_LEFT_ARROW",  EmitSingleChar, SCC_LESS_THAN,          0, C_DONTCOUNT},
00141   {"SMALL_RIGHT_ARROW", EmitSingleChar, SCC_GREATER_THAN,       0, C_DONTCOUNT},
00142 
00143   /* The following are directional formatting codes used to get the RTL strings right:
00144    * http://www.unicode.org/unicode/reports/tr9/#Directional_Formatting_Codes */
00145   {"LRM",               EmitSingleChar, CHAR_TD_LRM,            0, C_DONTCOUNT},
00146   {"RLM",               EmitSingleChar, CHAR_TD_RLM,            0, C_DONTCOUNT},
00147   {"LRE",               EmitSingleChar, CHAR_TD_LRE,            0, C_DONTCOUNT},
00148   {"RLE",               EmitSingleChar, CHAR_TD_RLE,            0, C_DONTCOUNT},
00149   {"LRO",               EmitSingleChar, CHAR_TD_LRO,            0, C_DONTCOUNT},
00150   {"RLO",               EmitSingleChar, CHAR_TD_RLO,            0, C_DONTCOUNT},
00151   {"PDF",               EmitSingleChar, CHAR_TD_PDF,            0, C_DONTCOUNT},
00152 };
00153 
00155 struct PluralForm {
00156   int plural_count;        
00157   const char *description; 
00158 };
00159 
00161 static const PluralForm _plural_forms[] = {
00162   { 2, "Two forms, singular used for 1 only" },
00163   { 1, "Only one form" },
00164   { 2, "Two forms, singular used for zero and 1" },
00165   { 3, "Three forms, special case for 0 and ending in 1, except those ending in 11" },
00166   { 5, "Five forms, special case for one, two, 3 to 6 and 7 to 10" },
00167   { 3, "Three forms, special case for numbers ending in 1[2-9]" },
00168   { 3, "Three forms, special cases for numbers ending in 1 and 2, 3, 4, except those ending in 1[1-4]" },
00169   { 3, "Three forms, special case for 1 and some numbers ending in 2, 3, or 4" },
00170   { 4, "Four forms, special case for 1 and all numbers ending in 02, 03, or 04" },
00171   { 2, "Two forms, singular used for everything ending in 1 but not in 11" },
00172   { 3, "Three forms, special case for 1 and 2, 3, or 4" },
00173   { 2, "Two forms, cases for numbers ending with a consonant and with a vowel" },
00174   { 4, "Four forms: one, 0 and everything ending in 02..10, everything ending in 11..19" },
00175 };
00176 
00177 /* Flags:
00178  * 0 = nothing
00179  * t = translator editable
00180  * l = ltr/rtl choice
00181  * p = plural choice
00182  * d = separator char (replace spaces with {NBSP})
00183  * x1 = hexadecimal number of 1 byte
00184  * x2 = hexadecimal number of 2 bytes
00185  * g = gender
00186  * c = cases
00187  * a = array, i.e. list of strings
00188  */
00190 static const char * const _pragmas[][4] = {
00191   /*  name         flags  default   description */
00192   { "name",        "0",   "",       "English name for the language" },
00193   { "ownname",     "t",   "",       "Localised name for the language" },
00194   { "isocode",     "0",   "",       "ISO code for the language" },
00195   { "plural",      "tp",  "0",      "Plural form to use" },
00196   { "textdir",     "tl",  "ltr",    "Text direction. Either ltr (left-to-right) or rtl (right-to-left)" },
00197   { "digitsep",    "td",  ",",      "Digit grouping separator for non-currency numbers" },
00198   { "digitsepcur", "td",  ",",      "Digit grouping seprarator for currency numbers" },
00199   { "decimalsep",  "td",  ".",      "Decimal separator" },
00200   { "winlangid",   "x2",  "0x0000", "Language ID for Windows" },
00201   { "grflangid",   "x1",  "0x00",   "Language ID for NewGRFs" },
00202   { "gender",      "tag", "",       "List of genders" },
00203   { "case",        "tac", "",       "List of cases" },
00204 };