src/table/control_codes.h

   1 /* $Id: control_codes.h 26244 2014-01-12 18:01:33Z frosch $ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * 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.
   6  * 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.
   7  * 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/>.
   8  */
   9
  10 /** @file control_codes.h Control codes that are embedded in the translation strings. */
  11
  12 #ifndef CONTROL_CODES_H
  13 #define CONTROL_CODES_H
  14
  15 /**
  16  * List of string control codes used for string formatting, displaying, and
  17  * by strgen to generate the language files.
  18  */
  19 enum StringControlCode {
  20         SCC_CONTROL_START = 0xE000,
  21         SCC_CONTROL_END   = 0xE1FF,
  22
  23         SCC_SPRITE_START  = 0xE200,
  24         SCC_SPRITE_END    = SCC_SPRITE_START + 0xFF,
  25
  26         /* This must be the first entry. It's encoded in strings that are saved. */
  27         SCC_ENCODED = SCC_CONTROL_START,
  28
  29         /* Display control codes */
  30         SCC_TINYFONT,  ///< Switch to small font
  31         SCC_BIGFONT,   ///< Switch to large font
  32
  33         /* Formatting control codes */
  34         SCC_REVISION,
  35         SCC_COMPANY_NUM,
  36         SCC_STATION_FEATURES,
  37         SCC_INDUSTRY_NAME,
  38         SCC_WAYPOINT_NAME,
  39         SCC_STATION_NAME,
  40         SCC_DEPOT_NAME,
  41         SCC_TOWN_NAME,
  42         SCC_GROUP_NAME,
  43         SCC_VEHICLE_NAME,
  44         SCC_SIGN_NAME,
  45         SCC_COMPANY_NAME,
  46         SCC_PRESIDENT_NAME,
  47         SCC_ENGINE_NAME,
  48
  49         SCC_CURRENCY_SHORT,
  50         SCC_CURRENCY_LONG,
  51
  52         SCC_CARGO_LONG,
  53         SCC_CARGO_SHORT,
  54         SCC_CARGO_TINY,
  55         SCC_CARGO_LIST,
  56         SCC_POWER,
  57         SCC_VOLUME_LONG,
  58         SCC_VOLUME_SHORT,
  59         SCC_WEIGHT_LONG,
  60         SCC_WEIGHT_SHORT,
  61         SCC_FORCE,
  62         SCC_VELOCITY,
  63         SCC_HEIGHT,
  64
  65         SCC_DATE_TINY,
  66         SCC_DATE_SHORT,
  67         SCC_DATE_LONG,
  68         SCC_DATE_ISO,
  69         SCC_TIME_TINY,
  70         SCC_TIME,
  71
  72         /* Must be consecutive */
  73         SCC_STRING1,
  74         SCC_STRING2,
  75         SCC_STRING3,
  76         SCC_STRING4,
  77         SCC_STRING5,
  78         SCC_STRING6,
  79         SCC_STRING7,
  80
  81
  82         SCC_STRING,
  83         SCC_COMMA,
  84         SCC_DECIMAL,
  85         SCC_NUM,
  86         SCC_ZEROFILL_NUM,
  87         SCC_HEX,
  88         SCC_BYTES,
  89
  90         SCC_RAW_STRING_POINTER,
  91         SCC_PLURAL_LIST,
  92         SCC_GENDER_LIST,
  93         SCC_GENDER_INDEX,
  94         SCC_ARG_INDEX,
  95         SCC_SET_CASE,
  96         SCC_SWITCH_CASE,
  97
  98         /* Colour codes */
  99         SCC_BLUE,
 100         SCC_SILVER,
 101         SCC_GOLD,
 102         SCC_RED,
 103         SCC_PURPLE,
 104         SCC_LTBROWN,
 105         SCC_ORANGE,
 106         SCC_GREEN,
 107         SCC_YELLOW,
 108         SCC_DKGREEN,
 109         SCC_CREAM,
 110         SCC_BROWN,
 111         SCC_WHITE,
 112         SCC_LTBLUE,
 113         SCC_GRAY,
 114         SCC_DKBLUE,
 115         SCC_BLACK,
 116         SCC_PREVIOUS_COLOUR,
 117
 118         /**
 119          * The next variables are part of a NewGRF subsystem for creating text strings.
 120          * It uses a "stack" of bytes and reads from there.
 121          */
 122         SCC_NEWGRF_FIRST,
 123         SCC_NEWGRF_PRINT_DWORD_SIGNED = SCC_NEWGRF_FIRST, ///< 7B: Read 4 bytes from the stack
 124         SCC_NEWGRF_PRINT_WORD_SIGNED,                     ///< 7C: Read 2 bytes from the stack as signed value
 125         SCC_NEWGRF_PRINT_BYTE_SIGNED,                     ///< 7D: Read 1 byte from the stack as signed value
 126         SCC_NEWGRF_PRINT_WORD_UNSIGNED,                   ///< 7E: Read 2 bytes from the stack as unsigned value
 127         SCC_NEWGRF_PRINT_DWORD_CURRENCY,                  ///< 8F: Read 4 bytes from the stack as currency
 128         SCC_NEWGRF_PRINT_WORD_STRING_ID,                  ///< 81: Read 2 bytes from the stack as String ID
 129         SCC_NEWGRF_PRINT_WORD_DATE_LONG,                  ///< 82: Read 2 bytes from the stack as base 1920 date
 130         SCC_NEWGRF_PRINT_WORD_DATE_SHORT,                 ///< 83: Read 2 bytes from the stack as base 1920 date
 131         SCC_NEWGRF_PRINT_WORD_SPEED,                      ///< 84: Read 2 bytes from the stack as signed speed
 132         SCC_NEWGRF_PRINT_WORD_VOLUME_LONG,                ///< 87: Read 2 bytes from the stack as long signed volume
 133         SCC_NEWGRF_PRINT_WORD_WEIGHT_LONG,                ///< 9A 0D: Read 2 bytes from the stack as long unsigned weight
 134         SCC_NEWGRF_PRINT_WORD_STATION_NAME,               ///< 9A 0C: Read 2 bytes from the stack as station name
 135         SCC_NEWGRF_PRINT_QWORD_CURRENCY,                  ///< 9A 01: Read 8 bytes from the stack as currency
 136         SCC_NEWGRF_PRINT_BYTE_HEX,                        ///< 9A 06: Read 1 byte from the stack and print it as hex
 137         SCC_NEWGRF_PRINT_WORD_HEX,                        ///< 9A 07: Read 2 bytes from the stack and print it as hex
 138         SCC_NEWGRF_PRINT_DWORD_HEX,                       ///< 9A 08: Read 4 bytes from the stack and print it as hex
 139         SCC_NEWGRF_PRINT_QWORD_HEX,                       ///< 9A 0B: Read 8 bytes from the stack and print it as hex
 140         SCC_NEWGRF_PRINT_DWORD_DATE_LONG,                 ///< 9A 16: Read 4 bytes from the stack as base 0 date
 141         SCC_NEWGRF_PRINT_DWORD_DATE_SHORT,                ///< 9A 17: Read 4 bytes from the stack as base 0 date
 142         SCC_NEWGRF_PRINT_WORD_POWER,                      ///< 9A 18: Read 2 bytes from the stack as unsigned power
 143         SCC_NEWGRF_PRINT_WORD_VOLUME_SHORT,               ///< 9A 19: Read 2 bytes from the stack as short signed volume
 144         SCC_NEWGRF_PRINT_WORD_WEIGHT_SHORT,               ///< 9A 1A: Read 2 bytes from the stack as short unsigned weight
 145         SCC_NEWGRF_PRINT_WORD_CARGO_LONG,                 ///< 9A 1B: Read 2 + 2 bytes from the stack as cargo type (translated) and unsigned cargo amount
 146         SCC_NEWGRF_PRINT_WORD_CARGO_SHORT,                ///< 9A 1C: Read 2 + 2 bytes from the stack as cargo type (translated) and unsigned cargo amount
 147         SCC_NEWGRF_PRINT_WORD_CARGO_TINY,                 ///< 9A 1D: Read 2 + 2 bytes from the stack as cargo type (translated) and unsigned cargo amount
 148         SCC_NEWGRF_PRINT_WORD_CARGO_NAME,                 ///< 9A 1E: Read 2 bytes from the stack as cargo name
 149         SCC_NEWGRF_PUSH_WORD,                             ///< 9A 03: Pushes 2 bytes onto the stack
 150         SCC_NEWGRF_UNPRINT,                               ///< 9A 04: "Unprints" the given number of bytes from the string
 151         SCC_NEWGRF_DISCARD_WORD,                          ///< 85: Discard the next two bytes
 152         SCC_NEWGRF_ROTATE_TOP_4_WORDS,                    ///< 86: Rotate the top 4 words of the stack (W4 W1 W2 W3)
 153         SCC_NEWGRF_LAST = SCC_NEWGRF_ROTATE_TOP_4_WORDS,
 154
 155         SCC_NEWGRF_STRINL,                                ///< Inline another string at the current position, StringID is encoded in the string
 156
 157         /* Special printable symbols.
 158          * These are mapped to the original glyphs */
 159         SCC_LESS_THAN        = SCC_SPRITE_START + 0x3C,
 160         SCC_GREATER_THAN     = SCC_SPRITE_START + 0x3E,
 161         SCC_UP_ARROW         = SCC_SPRITE_START + 0xA0,
 162         SCC_DOWN_ARROW       = SCC_SPRITE_START + 0xAA,
 163         SCC_CHECKMARK        = SCC_SPRITE_START + 0xAC,
 164         SCC_CROSS            = SCC_SPRITE_START + 0xAD,
 165         SCC_RIGHT_ARROW      = SCC_SPRITE_START + 0xAF,
 166         SCC_TRAIN            = SCC_SPRITE_START + 0xB4,
 167         SCC_LORRY            = SCC_SPRITE_START + 0xB5,
 168         SCC_BUS              = SCC_SPRITE_START + 0xB6,
 169         SCC_PLANE            = SCC_SPRITE_START + 0xB7,
 170         SCC_SHIP             = SCC_SPRITE_START + 0xB8,
 171         SCC_SUPERSCRIPT_M1   = SCC_SPRITE_START + 0xB9,
 172         SCC_SMALL_UP_ARROW   = SCC_SPRITE_START + 0xBC,
 173         SCC_SMALL_DOWN_ARROW = SCC_SPRITE_START + 0xBD,
 174 };
 175
 176 #endif /* CONTROL_CODES_H */