git.sur5r.net Git - cc65/blob - src/ld65/scanner.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                 scanner.h                                 */
   4 /*                                                                           */
   5 /*              Configuration file scanner for the ld65 linker               */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 1998-2003 Ullrich von Bassewitz                                       */
  10 /*               Römerstrasse 52                                             */
  11 /*               D-70794 Filderstadt                                         */
  12 /* EMail:        uz@cc65.org                                                 */
  13 /*                                                                           */
  14 /*                                                                           */
  15 /* This software is provided 'as-is', without any expressed or implied       */
  16 /* warranty.  In no event will the authors be held liable for any damages    */
  17 /* arising from the use of this software.                                    */
  18 /*                                                                           */
  19 /* Permission is granted to anyone to use this software for any purpose,     */
  20 /* including commercial applications, and to alter it and redistribute it    */
  21 /* freely, subject to the following restrictions:                            */
  22 /*                                                                           */
  23 /* 1. The origin of this software must not be misrepresented; you must not   */
  24 /*    claim that you wrote the original software. If you use this software   */
  25 /*    in a product, an acknowledgment in the product documentation would be  */
  26 /*    appreciated but is not required.                                       */
  27 /* 2. Altered source versions must be plainly marked as such, and must not   */
  28 /*    be misrepresented as being the original software.                      */
  29 /* 3. This notice may not be removed or altered from any source              */
  30 /*    distribution.                                                          */
  31 /*                                                                           */
  32 /*****************************************************************************/
  33
  34
  35
  36 #ifndef SCANNER_H
  37 #define SCANNER_H
  38
  39
  40
  41 /*****************************************************************************/
  42 /*                                   Data                                    */
  43 /*****************************************************************************/
  44
  45
  46
  47 /* Config file tokens */
  48 typedef enum {
  49     CFGTOK_NONE,
  50     CFGTOK_INTCON,
  51     CFGTOK_STRCON,
  52     CFGTOK_IDENT,
  53     CFGTOK_LCURLY,
  54     CFGTOK_RCURLY,
  55     CFGTOK_SEMI,
  56     CFGTOK_COMMA,
  57     CFGTOK_EQ,
  58     CFGTOK_COLON,
  59     CFGTOK_DOT,
  60     CFGTOK_EOF,
  61
  62     /* Special identifiers */
  63     CFGTOK_MEMORY,
  64     CFGTOK_FILES,
  65     CFGTOK_SEGMENTS,
  66     CFGTOK_FORMATS,
  67     CFGTOK_FEATURES,
  68     CFGTOK_SYMBOLS,
  69
  70     CFGTOK_START,
  71     CFGTOK_SIZE,
  72     CFGTOK_TYPE,
  73     CFGTOK_FILE,
  74     CFGTOK_DEFINE,
  75     CFGTOK_FILL,
  76     CFGTOK_FILLVAL,
  77     CFGTOK_EXPORT,
  78     CFGTOK_IMPORT,
  79     CFGTOK_OS,
  80     CFGTOK_ID,
  81     CFGTOK_VERSION,
  82     CFGTOK_FORMAT,
  83
  84     CFGTOK_LOAD,
  85     CFGTOK_RUN,
  86     CFGTOK_ALIGN,
  87     CFGTOK_OFFSET,
  88     CFGTOK_OPTIONAL,
  89
  90     CFGTOK_RO,
  91     CFGTOK_RW,
  92     CFGTOK_BSS,
  93     CFGTOK_ZP,
  94     CFGTOK_WPROT,
  95
  96     CFGTOK_O65,
  97     CFGTOK_BIN,
  98
  99     CFGTOK_SMALL,
 100     CFGTOK_LARGE,
 101
 102     CFGTOK_TRUE,
 103     CFGTOK_FALSE,
 104
 105     CFGTOK_LUNIX,
 106     CFGTOK_OSA65,
 107     CFGTOK_CC65,
 108
 109     CFGTOK_CONDES,
 110     CFGTOK_STARTADDRESS,
 111
 112     CFGTOK_SEGMENT,
 113     CFGTOK_LABEL,
 114     CFGTOK_COUNT,
 115     CFGTOK_ORDER,
 116
 117     CFGTOK_CONSTRUCTOR,
 118     CFGTOK_DESTRUCTOR,
 119
 120     CFGTOK_DECREASING,
 121     CFGTOK_INCREASING,
 122
 123     CFGTOK_DEFAULT
 124
 125 } cfgtok_t;
 126
 127
 128
 129 /* Mapping table entry, special identifier --> token */
 130 typedef struct IdentTok IdentTok;
 131 struct IdentTok {
 132     const char* Ident;          /* Identifier */
 133     cfgtok_t    Tok;            /* Token for identifier */
 134 };
 135 #define ENTRY_COUNT(s)  (sizeof (s) / sizeof (s [0]))
 136
 137
 138
 139 /* Current token and attributes */
 140 #define CFG_MAX_IDENT_LEN  255
 141 extern cfgtok_t         CfgTok;
 142 extern char             CfgSVal [CFG_MAX_IDENT_LEN+1];
 143 extern unsigned long    CfgIVal;
 144
 145 /* Error location */
 146 extern unsigned         CfgErrorLine;
 147 extern unsigned         CfgErrorCol;
 148
 149
 150
 151 /*****************************************************************************/
 152 /*                                   Code                                    */
 153 /*****************************************************************************/
 154
 155
 156
 157 void CfgWarning (const char* Format, ...) attribute((format(printf,1,2)));
 158 /* Print a warning message adding file name and line number of the config file */
 159
 160 void CfgError (const char* Format, ...) attribute((format(printf,1,2)));
 161 /* Print an error message adding file name and line number of the config file */
 162
 163 void CfgNextTok (void);
 164 /* Read the next token from the input stream */
 165
 166 void CfgConsume (cfgtok_t T, const char* Msg);
 167 /* Skip a token, print an error message if not found */
 168
 169 void CfgConsumeSemi (void);
 170 /* Consume a semicolon */
 171
 172 void CfgConsumeColon (void);
 173 /* Consume a colon */
 174
 175 void CfgOptionalComma (void);
 176 /* Consume a comma if there is one */
 177
 178 void CfgOptionalAssign (void);
 179 /* Consume an equal sign if there is one */
 180
 181 void CfgAssureInt (void);
 182 /* Make sure the next token is an integer */
 183
 184 void CfgAssureStr (void);
 185 /* Make sure the next token is a string constant */
 186
 187 void CfgAssureIdent (void);
 188 /* Make sure the next token is an identifier */
 189
 190 void CfgRangeCheck (unsigned long Lo, unsigned long Hi);
 191 /* Check the range of CfgIVal */
 192
 193 void CfgSpecialToken (const IdentTok* Table, unsigned Size, const char* Name);
 194 /* Map an identifier to one of the special tokens in the table */
 195
 196 void CfgBoolToken (void);
 197 /* Map an identifier or integer to a boolean token */
 198
 199 void CfgSetName (const char* Name);
 200 /* Set a name for a config file */
 201
 202 const char* CfgGetName (void);
 203 /* Get the name of the config file */
 204
 205 void CfgSetBuf (const char* Buf);
 206 /* Set a memory buffer for the config */
 207
 208 int CfgAvail (void);
 209 /* Return true if we have a configuration available */
 210
 211 void CfgOpenInput (void);
 212 /* Open the input file if we have one */
 213
 214 void CfgCloseInput (void);
 215 /* Close the input file if we have one */
 216
 217
 218
 219 /* End of scanner.h */
 220 #endif
 221
 222
 223
 224