1

/* $Id$ */

     2

     3

/** @file control_codes.h Control codes that are embedded in the translation strings. */

     4

     5

#ifndef CONTROL_CODES_H

     6

#define CONTROL_CODES_H

     7

     8

/**

     9

 * List of string control codes used for string formatting, displaying, and

    10

 * by strgen to generate the language files.

    11

 */

    12

enum StringControlCode {

    13

	SCC_CONTROL_START = 0xE000,

    14

	SCC_CONTROL_END   = 0xE1FF,

    15

    16

	SCC_SPRITE_START  = 0xE200,

    17

	SCC_SPRITE_END    = SCC_SPRITE_START + 0xFF,

    18

    19

	/* Display control codes */

    20

	SCC_SETX = SCC_CONTROL_START,

    21

	SCC_SETXY,

    22

	SCC_TINYFONT,

    23

	SCC_BIGFONT,

    24

    25

	/* Formatting control codes */

    26

	SCC_REVISION,

    27

	SCC_STATION_FEATURES,

    28

	SCC_INDUSTRY_NAME,

    29

	SCC_WAYPOINT_NAME,

    30

	SCC_STATION_NAME,

    31

	SCC_TOWN_NAME,

    32

	SCC_GROUP_NAME,

    33

	SCC_VEHICLE_NAME,

    34

	SCC_SIGN_NAME,

    35

	SCC_COMPANY_NAME,

    36

	SCC_COMPANY_NUM,

    37

	SCC_PLAYER_NAME,

    38

	SCC_ENGINE_NAME,

    39

    40

	SCC_CURRENCY_COMPACT,

    41

	SCC_CURRENCY,

    42

    43

	SCC_CARGO,

    44

	SCC_CARGO_SHORT,

    45

	SCC_POWER,

    46

	SCC_VOLUME,

    47

	SCC_VOLUME_SHORT,

    48

	SCC_WEIGHT,

    49

	SCC_WEIGHT_SHORT,

    50

	SCC_FORCE,

    51

	SCC_VELOCITY,

    52

    53

	SCC_DATE_TINY,

    54

	SCC_DATE_SHORT,

    55

	SCC_DATE_LONG,

    56

    57

	SCC_STRING1,

    58

	SCC_STRING2,

    59

	SCC_STRING3,

    60

	SCC_STRING4,

    61

	SCC_STRING5,

    62

    63

	SCC_SKIP,

    64

	SCC_STRING,

    65

	SCC_COMMA,

    66

	SCC_NUM,

    67

    68

	SCC_STRING_ID,

    69

	SCC_PLURAL_LIST,

    70

	SCC_GENDER_LIST,

    71

	SCC_GENDER_INDEX,

    72

	SCC_ARG_INDEX,

    73

	SCC_SETCASE,

    74

	SCC_SWITCH_CASE,

    75

    76

	/* Colour codes */

    77

	SCC_BLUE,

    78

	SCC_SILVER,

    79

	SCC_GOLD,

    80

	SCC_RED,

    81

	SCC_PURPLE,

    82

	SCC_LTBROWN,

    83

	SCC_ORANGE,

    84

	SCC_GREEN,

    85

	SCC_YELLOW,

    86

	SCC_DKGREEN,

    87

	SCC_CREAM,

    88

	SCC_BROWN,

    89

	SCC_WHITE,

    90

	SCC_LTBLUE,

    91

	SCC_GRAY,

    92

	SCC_DKBLUE,

    93

	SCC_BLACK,

    94

	SCC_PREVIOUS_COLOUR,

    95

    96

	/**

    97

	 * The next variables are part of a NewGRF subsystem for creating text strings.

    98

	 * It uses a "stack" of bytes and reads from there.

    99

	 */

   100

	SCC_NEWGRF_FIRST,

   101

	SCC_NEWGRF_PRINT_DWORD = SCC_NEWGRF_FIRST, ///< Read 4 bytes from the stack

   102

	SCC_NEWGRF_PRINT_SIGNED_WORD,              ///< Read 2 bytes from the stack as signed value

   103

	SCC_NEWGRF_PRINT_SIGNED_BYTE,              ///< Read 1 bytes from the stack as signed value

   104

	SCC_NEWGRF_PRINT_UNSIGNED_WORD,            ///< Read 2 bytes from the stack as unsigned value

   105

	SCC_NEWGRF_PRINT_DWORD_CURRENCY,           ///< Read 4 bytes from the stack as currency

   106

	SCC_NEWGRF_PRINT_STRING_ID,                ///< Read 2 bytes from the stack as String ID

   107

	SCC_NEWGRF_PRINT_DATE,                     ///< Read 2 bytes from the stack as base 1920 date

   108

	SCC_NEWGRF_PRINT_MONTH_YEAR,               ///< Read 2 bytes from the stack as base 1920 date

   109

	SCC_NEWGRF_PRINT_WORD_SPEED,               ///< Read 2 bytes from the stack as signed speed

   110

	SCC_NEWGRF_PRINT_WORD_LITRES,              ///< Read 2 bytes from the stack as signed litres

   111

	SCC_NEWGRF_PRINT_QWORD_CURRENCY,           ///< Read 8 bytes from the stack as currency

   112

	SCC_NEWGRF_PUSH_WORD,                      ///< Pushes 2 bytes onto the stack

   113

	SCC_NEWGRF_UNPRINT,                        ///< "Unprints" the given number of bytes from the string

   114

	SCC_NEWGRF_DISCARD_WORD,                   ///< Discard the next two bytes

   115

	SCC_NEWGRF_ROTATE_TOP_4_WORDS,             ///< Rotate the top 4 words of the stack (W4 W1 W2 W3)

   116

	SCC_NEWGRF_LAST = SCC_NEWGRF_ROTATE_TOP_4_WORDS,

   117

   118

	/* Special printable symbols.

   119

	 * These are mapped to the original glyphs */

   120

	SCC_LESSTHAN       = SCC_SPRITE_START + 0x3C,

   121

	SCC_GREATERTHAN    = SCC_SPRITE_START + 0x3E,

   122

	SCC_UPARROW        = SCC_SPRITE_START + 0xA0,

   123

	SCC_DOWNARROW      = SCC_SPRITE_START + 0xAA,

   124

	SCC_CHECKMARK      = SCC_SPRITE_START + 0xAC,

   125

	SCC_CROSS          = SCC_SPRITE_START + 0xAD,

   126

	SCC_RIGHTARROW     = SCC_SPRITE_START + 0xAF,

   127

	SCC_TRAIN          = SCC_SPRITE_START + 0xB4,

   128

	SCC_LORRY          = SCC_SPRITE_START + 0xB5,

   129

	SCC_BUS            = SCC_SPRITE_START + 0xB6,

   130

	SCC_PLANE          = SCC_SPRITE_START + 0xB7,

   131

	SCC_SHIP           = SCC_SPRITE_START + 0xB8,

   132

	SCC_SUPERSCRIPT_M1 = SCC_SPRITE_START + 0xB9,

   133

	SCC_SMALLUPARROW   = SCC_SPRITE_START + 0xBC,

   134

	SCC_SMALLDOWNARROW = SCC_SPRITE_START + 0xBD,

   135

};

   136

   137

#endif /* CONTROL_CODES_H */