git.sur5r.net Git - cc65/blob - src/ca65/toklist.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                 toklist.h                                 */
   4 /*                                                                           */
   5 /*                  Token list for the ca65 macroassembler                   */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 2000-2011, 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 #ifndef TOKLIST_H
  37 #define TOKLIST_H
  38
  39
  40
  41 /* common */
  42 #include "strbuf.h"
  43
  44 /* ca65 */
  45 #include "scanner.h"
  46
  47
  48
  49 /*****************************************************************************/
  50 /*                                   Data                                    */
  51 /*****************************************************************************/
  52
  53
  54
  55 /* Struct holding a token */
  56 typedef struct TokNode TokNode;
  57 struct TokNode {
  58     TokNode*    Next;                   /* For single linked list */
  59     Token       T;                      /* Token value */
  60 };
  61
  62 /* Struct holding a token list */
  63 typedef struct TokList TokList;
  64 struct TokList {
  65     TokList*    Next;                   /* Single linked list (for replay) */
  66     TokNode*    Root;                   /* First node in list */
  67     TokNode*    Last;                   /* Last node in list or replay */
  68     unsigned    RepCount;               /* Repeat counter (used for replay) */
  69     unsigned    RepMax;                 /* Maximum repeat count for replay */
  70     unsigned    Count;                  /* Token count */
  71     void        (*Check)(TokList*);     /* Token check function */
  72     void*       Data;                   /* Additional data for check */
  73 };
  74
  75
  76
  77 /* Return codes for TokCmp - higher numeric code means better match */
  78 enum TC {
  79     tcDifferent,                        /* Different tokents */
  80     tcSameToken,                        /* Same token, different attribute */
  81     tcIdentical                         /* Identical (token + attribute) */
  82 };
  83
  84
  85
  86 /*****************************************************************************/
  87 /*                                   Code                                    */
  88 /*****************************************************************************/
  89
  90
  91
  92 TokNode* NewTokNode (void);
  93 /* Create and return a token node with the current token value */
  94
  95 void FreeTokNode (TokNode* N);
  96 /* Free the given token node */
  97
  98 void TokSet (TokNode* N, int LineInfoSlot);
  99 /* Set the scanner token from the given token node. If the given line info
 100  * slot is not LI_SLOT_INV, it is used to store the position of the token fed
 101  * into the scanner.
 102  */
 103
 104 enum TC TokCmp (const TokNode* N);
 105 /* Compare the token given as parameter against the current token */
 106
 107 void InitTokList (TokList* T);
 108 /* Initialize a token list structure for later use */
 109
 110 TokList* NewTokList (void);
 111 /* Create a new, empty token list */
 112
 113 void FreeTokList (TokList* T);
 114 /* Delete the token list including all token nodes */
 115
 116 token_t GetTokListTerm (token_t Term);
 117 /* Determine if the following token list is enclosed in curly braces. This is
 118  * the case if the next token is the opening brace. If so, skip it and return
 119  * a closing brace, otherwise return Term.
 120  */
 121
 122 void AddCurTok (TokList* T);
 123 /* Add the current token to the token list */
 124
 125 void PushTokList (TokList* List, const char* Desc);
 126 /* Push a token list to be used as input for InputFromStack. This includes
 127  * several initializations needed in the token list structure, so don't use
 128  * PushInput directly.
 129  */
 130
 131
 132
 133 /* End of toklist.h */
 134
 135 #endif
 136
 137
 138
 139