preprocess.h revision 1.1.1.1.4.2 1 1.1.1.1.4.2 rmind /******************************************************************************
2 1.1.1.1.4.2 rmind *
3 1.1.1.1.4.2 rmind * Module Name: preprocess.h - header for iASL Preprocessor
4 1.1.1.1.4.2 rmind *
5 1.1.1.1.4.2 rmind *****************************************************************************/
6 1.1.1.1.4.2 rmind
7 1.1.1.1.4.2 rmind /*
8 1.1.1.1.4.2 rmind * Copyright (C) 2000 - 2013, Intel Corp.
9 1.1.1.1.4.2 rmind * All rights reserved.
10 1.1.1.1.4.2 rmind *
11 1.1.1.1.4.2 rmind * Redistribution and use in source and binary forms, with or without
12 1.1.1.1.4.2 rmind * modification, are permitted provided that the following conditions
13 1.1.1.1.4.2 rmind * are met:
14 1.1.1.1.4.2 rmind * 1. Redistributions of source code must retain the above copyright
15 1.1.1.1.4.2 rmind * notice, this list of conditions, and the following disclaimer,
16 1.1.1.1.4.2 rmind * without modification.
17 1.1.1.1.4.2 rmind * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 1.1.1.1.4.2 rmind * substantially similar to the "NO WARRANTY" disclaimer below
19 1.1.1.1.4.2 rmind * ("Disclaimer") and any redistribution must be conditioned upon
20 1.1.1.1.4.2 rmind * including a substantially similar Disclaimer requirement for further
21 1.1.1.1.4.2 rmind * binary redistribution.
22 1.1.1.1.4.2 rmind * 3. Neither the names of the above-listed copyright holders nor the names
23 1.1.1.1.4.2 rmind * of any contributors may be used to endorse or promote products derived
24 1.1.1.1.4.2 rmind * from this software without specific prior written permission.
25 1.1.1.1.4.2 rmind *
26 1.1.1.1.4.2 rmind * Alternatively, this software may be distributed under the terms of the
27 1.1.1.1.4.2 rmind * GNU General Public License ("GPL") version 2 as published by the Free
28 1.1.1.1.4.2 rmind * Software Foundation.
29 1.1.1.1.4.2 rmind *
30 1.1.1.1.4.2 rmind * NO WARRANTY
31 1.1.1.1.4.2 rmind * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 1.1.1.1.4.2 rmind * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 1.1.1.1.4.2 rmind * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 1.1.1.1.4.2 rmind * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 1.1.1.1.4.2 rmind * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 1.1.1.1.4.2 rmind * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 1.1.1.1.4.2 rmind * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 1.1.1.1.4.2 rmind * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 1.1.1.1.4.2 rmind * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 1.1.1.1.4.2 rmind * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 1.1.1.1.4.2 rmind * POSSIBILITY OF SUCH DAMAGES.
42 1.1.1.1.4.2 rmind */
43 1.1.1.1.4.2 rmind
44 1.1.1.1.4.2 rmind #define __PREPROCESS_H__
45 1.1.1.1.4.2 rmind
46 1.1.1.1.4.2 rmind #ifndef _PREPROCESS
47 1.1.1.1.4.2 rmind #define _PREPROCESS
48 1.1.1.1.4.2 rmind
49 1.1.1.1.4.2 rmind #undef PR_EXTERN
50 1.1.1.1.4.2 rmind
51 1.1.1.1.4.2 rmind #ifdef _DECLARE_PR_GLOBALS
52 1.1.1.1.4.2 rmind #define PR_EXTERN
53 1.1.1.1.4.2 rmind #define PR_INIT_GLOBAL(a,b) (a)=(b)
54 1.1.1.1.4.2 rmind #else
55 1.1.1.1.4.2 rmind #define PR_EXTERN extern
56 1.1.1.1.4.2 rmind #define PR_INIT_GLOBAL(a,b) (a)
57 1.1.1.1.4.2 rmind #endif
58 1.1.1.1.4.2 rmind
59 1.1.1.1.4.2 rmind
60 1.1.1.1.4.2 rmind /*
61 1.1.1.1.4.2 rmind * Configuration
62 1.1.1.1.4.2 rmind */
63 1.1.1.1.4.2 rmind #define PR_MAX_MACRO_ARGS 32 /* Max number of macro args */
64 1.1.1.1.4.2 rmind #define PR_MAX_ARG_INSTANCES 24 /* Max instances of any one arg */
65 1.1.1.1.4.2 rmind #define PR_LINES_PER_BLOCK 4096 /* Max input source lines per block */
66 1.1.1.1.4.2 rmind
67 1.1.1.1.4.2 rmind
68 1.1.1.1.4.2 rmind /*
69 1.1.1.1.4.2 rmind * Local defines and macros
70 1.1.1.1.4.2 rmind */
71 1.1.1.1.4.2 rmind #define PR_TOKEN_SEPARATORS " ,(){}\t\n"
72 1.1.1.1.4.2 rmind #define PR_MACRO_SEPARATORS " ,(){}~!*/%+-<>=&^|\"\t\n"
73 1.1.1.1.4.2 rmind #define PR_MACRO_ARGUMENTS " ,\t\n"
74 1.1.1.1.4.2 rmind #define PR_EXPR_SEPARATORS " ,(){}~!*/%+-<>=&^|\"\t\n"
75 1.1.1.1.4.2 rmind
76 1.1.1.1.4.2 rmind #define PR_PREFIX_ID "Pr(%.4u) - " /* Used for debug output */
77 1.1.1.1.4.2 rmind
78 1.1.1.1.4.2 rmind #define THIS_TOKEN_OFFSET(t) ((t-Gbl_MainTokenBuffer) + 1)
79 1.1.1.1.4.2 rmind
80 1.1.1.1.4.2 rmind
81 1.1.1.1.4.2 rmind /*
82 1.1.1.1.4.2 rmind * Preprocessor structures
83 1.1.1.1.4.2 rmind */
84 1.1.1.1.4.2 rmind typedef struct pr_macro_arg
85 1.1.1.1.4.2 rmind {
86 1.1.1.1.4.2 rmind char *Name;
87 1.1.1.1.4.2 rmind UINT32 Offset[PR_MAX_ARG_INSTANCES];
88 1.1.1.1.4.2 rmind UINT16 UseCount;
89 1.1.1.1.4.2 rmind
90 1.1.1.1.4.2 rmind } PR_MACRO_ARG;
91 1.1.1.1.4.2 rmind
92 1.1.1.1.4.2 rmind typedef struct pr_define_info
93 1.1.1.1.4.2 rmind {
94 1.1.1.1.4.2 rmind struct pr_define_info *Previous;
95 1.1.1.1.4.2 rmind struct pr_define_info *Next;
96 1.1.1.1.4.2 rmind char *Identifier;
97 1.1.1.1.4.2 rmind char *Replacement;
98 1.1.1.1.4.2 rmind char *Body; /* Macro body */
99 1.1.1.1.4.2 rmind PR_MACRO_ARG *Args; /* Macro arg list */
100 1.1.1.1.4.2 rmind UINT16 ArgCount; /* Macro arg count */
101 1.1.1.1.4.2 rmind BOOLEAN Persist; /* Keep for entire compiler run */
102 1.1.1.1.4.2 rmind
103 1.1.1.1.4.2 rmind } PR_DEFINE_INFO;
104 1.1.1.1.4.2 rmind
105 1.1.1.1.4.2 rmind typedef struct pr_directive_info
106 1.1.1.1.4.2 rmind {
107 1.1.1.1.4.2 rmind char *Name; /* Directive name */
108 1.1.1.1.4.2 rmind UINT8 ArgCount; /* Required # of args */
109 1.1.1.1.4.2 rmind
110 1.1.1.1.4.2 rmind } PR_DIRECTIVE_INFO;
111 1.1.1.1.4.2 rmind
112 1.1.1.1.4.2 rmind typedef struct pr_operator_info
113 1.1.1.1.4.2 rmind {
114 1.1.1.1.4.2 rmind char *Op;
115 1.1.1.1.4.2 rmind
116 1.1.1.1.4.2 rmind } PR_OPERATOR_INFO;
117 1.1.1.1.4.2 rmind
118 1.1.1.1.4.2 rmind typedef struct pr_file_node
119 1.1.1.1.4.2 rmind {
120 1.1.1.1.4.2 rmind struct pr_file_node *Next;
121 1.1.1.1.4.2 rmind FILE *File;
122 1.1.1.1.4.2 rmind char *Filename;
123 1.1.1.1.4.2 rmind UINT32 CurrentLineNumber;
124 1.1.1.1.4.2 rmind
125 1.1.1.1.4.2 rmind } PR_FILE_NODE;
126 1.1.1.1.4.2 rmind
127 1.1.1.1.4.2 rmind #define MAX_ARGUMENT_LENGTH 24
128 1.1.1.1.4.2 rmind
129 1.1.1.1.4.2 rmind typedef struct directive_info
130 1.1.1.1.4.2 rmind {
131 1.1.1.1.4.2 rmind struct directive_info *Next;
132 1.1.1.1.4.2 rmind char Argument[MAX_ARGUMENT_LENGTH];
133 1.1.1.1.4.2 rmind int Directive;
134 1.1.1.1.4.2 rmind BOOLEAN IgnoringThisCodeBlock;
135 1.1.1.1.4.2 rmind
136 1.1.1.1.4.2 rmind } DIRECTIVE_INFO;
137 1.1.1.1.4.2 rmind
138 1.1.1.1.4.2 rmind
139 1.1.1.1.4.2 rmind /*
140 1.1.1.1.4.2 rmind * Globals
141 1.1.1.1.4.2 rmind */
142 1.1.1.1.4.2 rmind #if 0 /* TBD for macros */
143 1.1.1.1.4.2 rmind PR_EXTERN char PR_INIT_GLOBAL (*XXXEvalBuffer, NULL); /* [ASL_LINE_BUFFER_SIZE]; */
144 1.1.1.1.4.2 rmind #endif
145 1.1.1.1.4.2 rmind
146 1.1.1.1.4.2 rmind PR_EXTERN char PR_INIT_GLOBAL (*Gbl_MainTokenBuffer, NULL); /* [ASL_LINE_BUFFER_SIZE]; */
147 1.1.1.1.4.2 rmind PR_EXTERN char PR_INIT_GLOBAL (*Gbl_MacroTokenBuffer, NULL); /* [ASL_LINE_BUFFER_SIZE]; */
148 1.1.1.1.4.2 rmind PR_EXTERN char PR_INIT_GLOBAL (*Gbl_ExpressionTokenBuffer, NULL); /* [ASL_LINE_BUFFER_SIZE]; */
149 1.1.1.1.4.2 rmind
150 1.1.1.1.4.2 rmind PR_EXTERN UINT32 Gbl_PreprocessorLineNumber;
151 1.1.1.1.4.2 rmind PR_EXTERN int Gbl_IfDepth;
152 1.1.1.1.4.2 rmind PR_EXTERN PR_FILE_NODE *Gbl_InputFileList;
153 1.1.1.1.4.2 rmind PR_EXTERN PR_DEFINE_INFO PR_INIT_GLOBAL (*Gbl_DefineList, NULL);
154 1.1.1.1.4.2 rmind PR_EXTERN BOOLEAN PR_INIT_GLOBAL (Gbl_PreprocessorError, FALSE);
155 1.1.1.1.4.2 rmind PR_EXTERN BOOLEAN PR_INIT_GLOBAL (Gbl_IgnoringThisCodeBlock, FALSE);
156 1.1.1.1.4.2 rmind PR_EXTERN DIRECTIVE_INFO PR_INIT_GLOBAL (*Gbl_DirectiveStack, NULL);
157 1.1.1.1.4.2 rmind
158 1.1.1.1.4.2 rmind /*
159 1.1.1.1.4.2 rmind * prscan - Preprocessor entry
160 1.1.1.1.4.2 rmind */
161 1.1.1.1.4.2 rmind void
162 1.1.1.1.4.2 rmind PrInitializePreprocessor (
163 1.1.1.1.4.2 rmind void);
164 1.1.1.1.4.2 rmind
165 1.1.1.1.4.2 rmind void
166 1.1.1.1.4.2 rmind PrInitializeGlobals (
167 1.1.1.1.4.2 rmind void);
168 1.1.1.1.4.2 rmind
169 1.1.1.1.4.2 rmind void
170 1.1.1.1.4.2 rmind PrTerminatePreprocessor (
171 1.1.1.1.4.2 rmind void);
172 1.1.1.1.4.2 rmind
173 1.1.1.1.4.2 rmind void
174 1.1.1.1.4.2 rmind PrDoPreprocess (
175 1.1.1.1.4.2 rmind void);
176 1.1.1.1.4.2 rmind
177 1.1.1.1.4.2 rmind UINT64
178 1.1.1.1.4.2 rmind PrIsDefined (
179 1.1.1.1.4.2 rmind char *Identifier);
180 1.1.1.1.4.2 rmind
181 1.1.1.1.4.2 rmind UINT64
182 1.1.1.1.4.2 rmind PrResolveDefine (
183 1.1.1.1.4.2 rmind char *Identifier);
184 1.1.1.1.4.2 rmind
185 1.1.1.1.4.2 rmind int
186 1.1.1.1.4.2 rmind PrInitLexer (
187 1.1.1.1.4.2 rmind char *String);
188 1.1.1.1.4.2 rmind
189 1.1.1.1.4.2 rmind void
190 1.1.1.1.4.2 rmind PrTerminateLexer (
191 1.1.1.1.4.2 rmind void);
192 1.1.1.1.4.2 rmind
193 1.1.1.1.4.2 rmind
194 1.1.1.1.4.2 rmind /*
195 1.1.1.1.4.2 rmind * prmacros - Support for #defines and macros
196 1.1.1.1.4.2 rmind */
197 1.1.1.1.4.2 rmind void
198 1.1.1.1.4.2 rmind PrDumpPredefinedNames (
199 1.1.1.1.4.2 rmind void);
200 1.1.1.1.4.2 rmind
201 1.1.1.1.4.2 rmind PR_DEFINE_INFO *
202 1.1.1.1.4.2 rmind PrAddDefine (
203 1.1.1.1.4.2 rmind char *Token,
204 1.1.1.1.4.2 rmind char *Token2,
205 1.1.1.1.4.2 rmind BOOLEAN Persist);
206 1.1.1.1.4.2 rmind
207 1.1.1.1.4.2 rmind void
208 1.1.1.1.4.2 rmind PrRemoveDefine (
209 1.1.1.1.4.2 rmind char *DefineName);
210 1.1.1.1.4.2 rmind
211 1.1.1.1.4.2 rmind PR_DEFINE_INFO *
212 1.1.1.1.4.2 rmind PrMatchDefine (
213 1.1.1.1.4.2 rmind char *MatchString);
214 1.1.1.1.4.2 rmind
215 1.1.1.1.4.2 rmind void
216 1.1.1.1.4.2 rmind PrAddMacro (
217 1.1.1.1.4.2 rmind char *Name,
218 1.1.1.1.4.2 rmind char **Next);
219 1.1.1.1.4.2 rmind
220 1.1.1.1.4.2 rmind void
221 1.1.1.1.4.2 rmind PrDoMacroInvocation (
222 1.1.1.1.4.2 rmind char *TokenBuffer,
223 1.1.1.1.4.2 rmind char *MacroStart,
224 1.1.1.1.4.2 rmind PR_DEFINE_INFO *DefineInfo,
225 1.1.1.1.4.2 rmind char **Next);
226 1.1.1.1.4.2 rmind
227 1.1.1.1.4.2 rmind
228 1.1.1.1.4.2 rmind /*
229 1.1.1.1.4.2 rmind * prexpress - #if expression support
230 1.1.1.1.4.2 rmind */
231 1.1.1.1.4.2 rmind ACPI_STATUS
232 1.1.1.1.4.2 rmind PrResolveIntegerExpression (
233 1.1.1.1.4.2 rmind char *Line,
234 1.1.1.1.4.2 rmind UINT64 *ReturnValue);
235 1.1.1.1.4.2 rmind
236 1.1.1.1.4.2 rmind char *
237 1.1.1.1.4.2 rmind PrPrioritizeExpression (
238 1.1.1.1.4.2 rmind char *OriginalLine);
239 1.1.1.1.4.2 rmind
240 1.1.1.1.4.2 rmind /*
241 1.1.1.1.4.2 rmind * prparser - lex/yacc expression parser
242 1.1.1.1.4.2 rmind */
243 1.1.1.1.4.2 rmind UINT64
244 1.1.1.1.4.2 rmind PrEvaluateExpression (
245 1.1.1.1.4.2 rmind char *ExprString);
246 1.1.1.1.4.2 rmind
247 1.1.1.1.4.2 rmind
248 1.1.1.1.4.2 rmind /*
249 1.1.1.1.4.2 rmind * prutils - Preprocesor utilities
250 1.1.1.1.4.2 rmind */
251 1.1.1.1.4.2 rmind char *
252 1.1.1.1.4.2 rmind PrGetNextToken (
253 1.1.1.1.4.2 rmind char *Buffer,
254 1.1.1.1.4.2 rmind char *MatchString,
255 1.1.1.1.4.2 rmind char **Next);
256 1.1.1.1.4.2 rmind
257 1.1.1.1.4.2 rmind void
258 1.1.1.1.4.2 rmind PrError (
259 1.1.1.1.4.2 rmind UINT8 Level,
260 1.1.1.1.4.2 rmind UINT8 MessageId,
261 1.1.1.1.4.2 rmind UINT32 Column);
262 1.1.1.1.4.2 rmind
263 1.1.1.1.4.2 rmind void
264 1.1.1.1.4.2 rmind PrReplaceData (
265 1.1.1.1.4.2 rmind char *Buffer,
266 1.1.1.1.4.2 rmind UINT32 LengthToRemove,
267 1.1.1.1.4.2 rmind char *BufferToAdd,
268 1.1.1.1.4.2 rmind UINT32 LengthToAdd);
269 1.1.1.1.4.2 rmind
270 1.1.1.1.4.2 rmind void
271 1.1.1.1.4.2 rmind PrOpenIncludeFile (
272 1.1.1.1.4.2 rmind char *Filename);
273 1.1.1.1.4.2 rmind
274 1.1.1.1.4.2 rmind FILE *
275 1.1.1.1.4.2 rmind PrOpenIncludeWithPrefix (
276 1.1.1.1.4.2 rmind char *PrefixDir,
277 1.1.1.1.4.2 rmind char *Filename);
278 1.1.1.1.4.2 rmind
279 1.1.1.1.4.2 rmind void
280 1.1.1.1.4.2 rmind PrPushInputFileStack (
281 1.1.1.1.4.2 rmind FILE *InputFile,
282 1.1.1.1.4.2 rmind char *Filename);
283 1.1.1.1.4.2 rmind
284 1.1.1.1.4.2 rmind BOOLEAN
285 1.1.1.1.4.2 rmind PrPopInputFileStack (
286 1.1.1.1.4.2 rmind void);
287 1.1.1.1.4.2 rmind
288 1.1.1.1.4.2 rmind #endif
289