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