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