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

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                 scanner.c                                 */
   4 /*                                                                           */
   5 /*            Configuration file scanner for the sim65 6502 simulator        */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 1998-2012, Ullrich von Bassewitz                                      */
  10 /*                Roemerstrasse 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 #include <stdarg.h>
  37 #include <stdio.h>
  38 #include <string.h>
  39 #include <errno.h>
  40 #include <ctype.h>
  41
  42 /* common */
  43 #include "chartype.h"
  44 #include "xsprintf.h"
  45
  46 /* sim65 */
  47 #include "error.h"
  48 #include "scanner.h"
  49
  50
  51
  52 /*****************************************************************************/
  53 /*                                   Data                                    */
  54 /*****************************************************************************/
  55
  56
  57
  58 /* Current token and attributes */
  59 cfgtok_t                CfgTok;
  60 StrBuf                  CfgSVal = STATIC_STRBUF_INITIALIZER;
  61 unsigned long           CfgIVal;
  62
  63 /* Error location */
  64 unsigned                CfgErrorLine;
  65 unsigned                CfgErrorCol;
  66
  67 /* Input sources for the configuration */
  68 static const char*      CfgName         = 0;
  69 static const char*      CfgBuf          = 0;
  70
  71 /* Other input stuff */
  72 static int              C               = ' ';
  73 static unsigned         InputLine       = 1;
  74 static unsigned         InputCol        = 0;
  75 static FILE*            InputFile       = 0;
  76
  77
  78
  79 /*****************************************************************************/
  80 /*                              Error handling                               */
  81 /*****************************************************************************/
  82
  83
  84
  85 void CfgWarning (const char* Format, ...)
  86 /* Print a warning message adding file name and line number of the config file */
  87 {
  88     char Buf [512];
  89     va_list ap;
  90
  91     va_start (ap, Format);
  92     xvsprintf (Buf, sizeof (Buf), Format, ap);
  93     va_end (ap);
  94
  95     Warning ("%s(%u): %s", CfgGetName(), CfgErrorLine, Buf);
  96 }
  97
  98
  99
 100 void CfgError (const char* Format, ...)
 101 /* Print an error message adding file name and line number of the config file */
 102 {
 103     char Buf [512];
 104     va_list ap;
 105
 106     va_start (ap, Format);
 107     xvsprintf (Buf, sizeof (Buf), Format, ap);
 108     va_end (ap);
 109
 110     Error ("%s(%u): %s", CfgGetName(), CfgErrorLine, Buf);
 111 }
 112
 113
 114
 115 /*****************************************************************************/
 116 /*                                   Code                                    */
 117 /*****************************************************************************/
 118
 119
 120
 121 static void NextChar (void)
 122 /* Read the next character from the input file */
 123 {
 124     if (CfgBuf) {
 125         /* Read from buffer */
 126         C = (unsigned char)(*CfgBuf);
 127         if (C == 0) {
 128             C = EOF;
 129         } else {
 130             ++CfgBuf;
 131         }
 132     } else {
 133         /* Read from the file */
 134         C = getc (InputFile);
 135     }
 136
 137     /* Count columns */
 138     if (C != EOF) {
 139         ++InputCol;
 140     }
 141
 142     /* Count lines */
 143     if (C == '\n') {
 144         ++InputLine;
 145         InputCol = 0;
 146     }
 147 }
 148
 149
 150
 151 static unsigned DigitVal (int C)
 152 /* Return the value for a numeric digit */
 153 {
 154     if (isdigit (C)) {
 155         return C - '0';
 156     } else {
 157         return toupper (C) - 'A' + 10;
 158     }
 159 }
 160
 161
 162
 163 void CfgNextTok (void)
 164 /* Read the next token from the input stream */
 165 {
 166     unsigned I;
 167
 168
 169 Again:
 170     /* Skip whitespace */
 171     while (isspace (C)) {
 172         NextChar ();
 173     }
 174
 175     /* Remember the current position */
 176     CfgErrorLine = InputLine;
 177     CfgErrorCol  = InputCol;
 178
 179     /* Identifier? */
 180     if (C == '_' || IsAlpha (C)) {
 181
 182         /* Read the identifier */
 183         I = 0;
 184         while (C == '_' || IsAlNum (C)) {
 185             if (I < CFG_MAX_IDENT_LEN) {
 186                 CfgSVal [I++] = C;
 187             }
 188             NextChar ();
 189         }
 190         CfgSVal [I] = '\0';
 191         CfgTok = CFGTOK_IDENT;
 192         return;
 193     }
 194
 195     /* Hex number? */
 196     if (C == '$') {
 197         NextChar ();
 198         if (!isxdigit (C)) {
 199             Error ("%s(%u): Hex digit expected", CfgName, InputLine);
 200         }
 201         CfgIVal = 0;
 202         while (isxdigit (C)) {
 203             CfgIVal = CfgIVal * 16 + DigitVal (C);
 204             NextChar ();
 205         }
 206         CfgTok = CFGTOK_INTCON;
 207         return;
 208     }
 209
 210     /* Decimal number? */
 211     if (isdigit (C)) {
 212         CfgIVal = 0;
 213         while (isdigit (C)) {
 214             CfgIVal = CfgIVal * 10 + DigitVal (C);
 215             NextChar ();
 216         }
 217         CfgTok = CFGTOK_INTCON;
 218         return;
 219     }
 220
 221     /* Other characters */
 222     switch (C) {
 223
 224         case '{':
 225             NextChar ();
 226             CfgTok = CFGTOK_LCURLY;
 227             break;
 228
 229         case '}':
 230             NextChar ();
 231             CfgTok = CFGTOK_RCURLY;
 232             break;
 233
 234         case ';':
 235             NextChar ();
 236             CfgTok = CFGTOK_SEMI;
 237             break;
 238
 239         case '.':
 240             NextChar ();
 241             if (C == '.') {
 242                 NextChar ();
 243                 CfgTok = CFGTOK_DOTDOT;
 244             } else {
 245                 CfgTok = CFGTOK_DOT;
 246             }
 247             break;
 248
 249         case ',':
 250             NextChar ();
 251             CfgTok = CFGTOK_COMMA;
 252             break;
 253
 254         case '=':
 255             NextChar ();
 256             CfgTok = CFGTOK_EQ;
 257             break;
 258
 259         case ':':
 260             NextChar ();
 261             CfgTok = CFGTOK_COLON;
 262             break;
 263
 264         case '\"':
 265             NextChar ();
 266             I = 0;
 267             while (C != '\"') {
 268                 if (C == EOF || C == '\n') {
 269                     Error ("%s(%u): Unterminated string", CfgName, InputLine);
 270                 }
 271                 if (I < CFG_MAX_IDENT_LEN) {
 272                     CfgSVal [I++] = C;
 273                 }
 274                 NextChar ();
 275             }
 276             NextChar ();
 277             CfgSVal [I] = '\0';
 278             CfgTok = CFGTOK_STRCON;
 279             break;
 280
 281         case '#':
 282             /* Comment */
 283             while (C != '\n' && C != EOF) {
 284                 NextChar ();
 285             }
 286             if (C != EOF) {
 287                 goto Again;
 288             }
 289             CfgTok = CFGTOK_EOF;
 290             break;
 291
 292         case EOF:
 293             CfgTok = CFGTOK_EOF;
 294             break;
 295
 296         default:
 297             Error ("%s(%u): Invalid character `%c'", CfgName, InputLine, C);
 298
 299     }
 300 }
 301
 302
 303
 304 void CfgConsume (cfgtok_t T, const char* Msg)
 305 /* Skip a token, print an error message if not found */
 306 {
 307     if (CfgTok != T) {
 308         CfgError ("%s", Msg);
 309     }
 310     CfgNextTok ();
 311 }
 312
 313
 314
 315 void CfgConsumeSemi (void)
 316 /* Consume a semicolon */
 317 {
 318     CfgConsume (CFGTOK_SEMI, "`;' expected");
 319 }
 320
 321
 322
 323 void CfgConsumeColon (void)
 324 /* Consume a colon */
 325 {
 326     CfgConsume (CFGTOK_COLON, "`:' expected");
 327 }
 328
 329
 330
 331 void CfgConsumeRCurly (void)
 332 /* Consume a right curly brace */
 333 {
 334     CfgConsume (CFGTOK_RCURLY, "`}' expected");
 335 }
 336
 337
 338
 339 void CfgOptionalComma (void)
 340 /* Consume a comma if there is one */
 341 {
 342     if (CfgTok == CFGTOK_COMMA) {
 343         CfgNextTok ();
 344     }
 345 }
 346
 347
 348
 349 void CfgOptionalAssign (void)
 350 /* Consume an equal sign if there is one */
 351 {
 352     if (CfgTok == CFGTOK_EQ) {
 353         CfgNextTok ();
 354     }
 355 }
 356
 357
 358
 359 void CfgAssureInt (void)
 360 /* Make sure the next token is an integer */
 361 {
 362     if (CfgTok != CFGTOK_INTCON) {
 363         CfgError ("Integer constant expected");
 364     }
 365 }
 366
 367
 368
 369 void CfgAssureStr (void)
 370 /* Make sure the next token is a string constant */
 371 {
 372     if (CfgTok != CFGTOK_STRCON) {
 373         CfgError ("String constant expected");
 374     }
 375 }
 376
 377
 378
 379 void CfgAssureIdent (void)
 380 /* Make sure the next token is an identifier */
 381 {
 382     if (CfgTok != CFGTOK_IDENT) {
 383         CfgError ("Identifier expected");
 384     }
 385 }
 386
 387
 388
 389 void CfgRangeCheck (unsigned long Lo, unsigned long Hi)
 390 /* Check the range of CfgIVal */
 391 {
 392     if (CfgIVal < Lo || CfgIVal > Hi) {
 393         CfgError ("Range error");
 394     }
 395 }
 396
 397
 398
 399 void CfgSpecialToken (const IdentTok* Table, unsigned Size, const char* Name)
 400 /* Map an identifier to one of the special tokens in the table */
 401 {
 402     unsigned I;
 403
 404     /* We need an identifier */
 405     if (CfgTok == CFGTOK_IDENT) {
 406
 407         /* Make it upper case */
 408         I = 0;
 409         while (CfgSVal [I]) {
 410             CfgSVal [I] = toupper (CfgSVal [I]);
 411             ++I;
 412         }
 413
 414         /* Linear search */
 415         for (I = 0; I < Size; ++I) {
 416             if (strcmp (CfgSVal, Table [I].Ident) == 0) {
 417                 CfgTok = Table [I].Tok;
 418                 return;
 419             }
 420         }
 421
 422     }
 423
 424     /* Not found or no identifier */
 425     Error ("%s(%u): %s expected", CfgName, InputLine, Name);
 426 }
 427
 428
 429
 430 void CfgBoolToken (void)
 431 /* Map an identifier or integer to a boolean token */
 432 {
 433     static const IdentTok Booleans [] = {
 434         {   "YES",      CFGTOK_TRUE     },
 435         {   "NO",       CFGTOK_FALSE    },
 436         {   "TRUE",     CFGTOK_TRUE     },
 437         {   "FALSE",    CFGTOK_FALSE    },
 438     };
 439
 440     /* If we have an identifier, map it to a boolean token */
 441     if (CfgTok == CFGTOK_IDENT) {
 442         CfgSpecialToken (Booleans, ENTRY_COUNT (Booleans), "Boolean");
 443     } else {
 444         /* We expected an integer here */
 445         if (CfgTok != CFGTOK_INTCON) {
 446             CfgError ("Boolean value expected");
 447         }
 448         CfgTok = (CfgIVal == 0)? CFGTOK_FALSE : CFGTOK_TRUE;
 449     }
 450 }
 451
 452
 453
 454 void CfgSetName (const char* Name)
 455 /* Set a name for a config file */
 456 {
 457     CfgName = Name;
 458 }
 459
 460
 461
 462 const char* CfgGetName (void)
 463 /* Get the name of the config file */
 464 {
 465     if (CfgName) {
 466         return CfgName;
 467     } else if (CfgBuf) {
 468         return "[builtin config]";
 469     } else {
 470         return "";
 471     }
 472 }
 473
 474
 475
 476 void CfgSetBuf (const char* Buf)
 477 /* Set a memory buffer for the config */
 478 {
 479     CfgBuf = Buf;
 480 }
 481
 482
 483
 484 int CfgAvail (void)
 485 /* Return true if we have a configuration available */
 486 {
 487     return CfgName != 0 || CfgBuf != 0;
 488 }
 489
 490
 491
 492 void CfgOpenInput (void)
 493 /* Open the input file if we have one */
 494 {
 495     /* If we have a config name given, open the file, otherwise we will read
 496      * from a buffer.
 497      */
 498     if (!CfgBuf) {
 499
 500         /* Open the file */
 501         InputFile = fopen (CfgName, "r");
 502         if (InputFile == 0) {
 503             Error ("Cannot open `%s': %s", CfgName, strerror (errno));
 504         }
 505
 506     }
 507
 508     /* Initialize variables */
 509     C         = ' ';
 510     InputLine = 1;
 511     InputCol  = 0;
 512
 513     /* Start the ball rolling ... */
 514     CfgNextTok ();
 515 }
 516
 517
 518
 519 void CfgCloseInput (void)
 520 /* Close the input file if we have one */
 521 {
 522     /* Close the input file if we had one */
 523     if (InputFile) {
 524         (void) fclose (InputFile);
 525         InputFile = 0;
 526     }
 527 }
 528
 529
 530