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

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                 scanner.h                                 */
   4 /*                                                                           */
   5 /*            Configuration file scanner for the sim65 6502 simulator        */
   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_DOTDOT,
  61     CFGTOK_EOF,
  62
  63     /* Primary blocks */
  64     CFGTOK_MEMORY,
  65
  66     /* Special identifiers */
  67     CFGTOK_TRUE,
  68     CFGTOK_FALSE
  69
  70 } cfgtok_t;
  71
  72
  73
  74 /* Mapping table entry, special identifier --> token */
  75 typedef struct IdentTok IdentTok;
  76 struct IdentTok {
  77     const char* Ident;          /* Identifier */
  78     cfgtok_t    Tok;            /* Token for identifier */
  79 };
  80 #define ENTRY_COUNT(s)  (sizeof (s) / sizeof (s [0]))
  81
  82
  83
  84 /* Current token and attributes */
  85 #define CFG_MAX_IDENT_LEN  255
  86 extern cfgtok_t         CfgTok;
  87 extern char             CfgSVal [CFG_MAX_IDENT_LEN+1];
  88 extern unsigned long    CfgIVal;
  89
  90 /* Error location */
  91 extern unsigned         CfgErrorLine;
  92 extern unsigned         CfgErrorCol;
  93
  94
  95
  96 /*****************************************************************************/
  97 /*                                   Code                                    */
  98 /*****************************************************************************/
  99
 100
 101
 102 void CfgWarning (const char* Format, ...) attribute((format(printf,1,2)));
 103 /* Print a warning message adding file name and line number of the config file */
 104
 105 void CfgError (const char* Format, ...) attribute((format(printf,1,2)));
 106 /* Print an error message adding file name and line number of the config file */
 107
 108 void CfgNextTok (void);
 109 /* Read the next token from the input stream */
 110
 111 void CfgConsume (cfgtok_t T, const char* Msg);
 112 /* Skip a token, print an error message if not found */
 113
 114 void CfgConsumeSemi (void);
 115 /* Consume a semicolon */
 116
 117 void CfgConsumeColon (void);
 118 /* Consume a colon */
 119
 120 void CfgOptionalComma (void);
 121 /* Consume a comma if there is one */
 122
 123 void CfgOptionalAssign (void);
 124 /* Consume an equal sign if there is one */
 125
 126 void CfgAssureInt (void);
 127 /* Make sure the next token is an integer */
 128
 129 void CfgAssureStr (void);
 130 /* Make sure the next token is a string constant */
 131
 132 void CfgAssureIdent (void);
 133 /* Make sure the next token is an identifier */
 134
 135 void CfgRangeCheck (unsigned long Lo, unsigned long Hi);
 136 /* Check the range of CfgIVal */
 137
 138 void CfgSpecialToken (const IdentTok* Table, unsigned Size, const char* Name);
 139 /* Map an identifier to one of the special tokens in the table */
 140
 141 void CfgBoolToken (void);
 142 /* Map an identifier or integer to a boolean token */
 143
 144 void CfgSetName (const char* Name);
 145 /* Set a name for a config file */
 146
 147 const char* CfgGetName (void);
 148 /* Get the name of the config file */
 149
 150 void CfgSetBuf (const char* Buf);
 151 /* Set a memory buffer for the config */
 152
 153 int CfgAvail (void);
 154 /* Return true if we have a configuration available */
 155
 156 void CfgOpenInput (void);
 157 /* Open the input file if we have one */
 158
 159 void CfgCloseInput (void);
 160 /* Close the input file if we have one */
 161
 162
 163
 164 /* End of scanner.h */
 165 #endif
 166
 167
 168