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