1bc36eafdSMike Gerdts /******************************************************************************
2bc36eafdSMike Gerdts *
3bc36eafdSMike Gerdts * Module Name: prutils - Preprocessor utilities
4bc36eafdSMike Gerdts *
5bc36eafdSMike Gerdts *****************************************************************************/
6bc36eafdSMike Gerdts
7*35786f68SRobert Mustacchi /******************************************************************************
8*35786f68SRobert Mustacchi *
9*35786f68SRobert Mustacchi * 1. Copyright Notice
10*35786f68SRobert Mustacchi *
11*35786f68SRobert Mustacchi * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12bc36eafdSMike Gerdts * All rights reserved.
13bc36eafdSMike Gerdts *
14*35786f68SRobert Mustacchi * 2. License
15*35786f68SRobert Mustacchi *
16*35786f68SRobert Mustacchi * 2.1. This is your license from Intel Corp. under its intellectual property
17*35786f68SRobert Mustacchi * rights. You may have additional license terms from the party that provided
18*35786f68SRobert Mustacchi * you this software, covering your right to use that party's intellectual
19*35786f68SRobert Mustacchi * property rights.
20*35786f68SRobert Mustacchi *
21*35786f68SRobert Mustacchi * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22*35786f68SRobert Mustacchi * copy of the source code appearing in this file ("Covered Code") an
23*35786f68SRobert Mustacchi * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24*35786f68SRobert Mustacchi * base code distributed originally by Intel ("Original Intel Code") to copy,
25*35786f68SRobert Mustacchi * make derivatives, distribute, use and display any portion of the Covered
26*35786f68SRobert Mustacchi * Code in any form, with the right to sublicense such rights; and
27*35786f68SRobert Mustacchi *
28*35786f68SRobert Mustacchi * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29*35786f68SRobert Mustacchi * license (with the right to sublicense), under only those claims of Intel
30*35786f68SRobert Mustacchi * patents that are infringed by the Original Intel Code, to make, use, sell,
31*35786f68SRobert Mustacchi * offer to sell, and import the Covered Code and derivative works thereof
32*35786f68SRobert Mustacchi * solely to the minimum extent necessary to exercise the above copyright
33*35786f68SRobert Mustacchi * license, and in no event shall the patent license extend to any additions
34*35786f68SRobert Mustacchi * to or modifications of the Original Intel Code. No other license or right
35*35786f68SRobert Mustacchi * is granted directly or by implication, estoppel or otherwise;
36*35786f68SRobert Mustacchi *
37*35786f68SRobert Mustacchi * The above copyright and patent license is granted only if the following
38*35786f68SRobert Mustacchi * conditions are met:
39*35786f68SRobert Mustacchi *
40*35786f68SRobert Mustacchi * 3. Conditions
41*35786f68SRobert Mustacchi *
42*35786f68SRobert Mustacchi * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43*35786f68SRobert Mustacchi * Redistribution of source code of any substantial portion of the Covered
44*35786f68SRobert Mustacchi * Code or modification with rights to further distribute source must include
45*35786f68SRobert Mustacchi * the above Copyright Notice, the above License, this list of Conditions,
46*35786f68SRobert Mustacchi * and the following Disclaimer and Export Compliance provision. In addition,
47*35786f68SRobert Mustacchi * Licensee must cause all Covered Code to which Licensee contributes to
48*35786f68SRobert Mustacchi * contain a file documenting the changes Licensee made to create that Covered
49*35786f68SRobert Mustacchi * Code and the date of any change. Licensee must include in that file the
50*35786f68SRobert Mustacchi * documentation of any changes made by any predecessor Licensee. Licensee
51*35786f68SRobert Mustacchi * must include a prominent statement that the modification is derived,
52*35786f68SRobert Mustacchi * directly or indirectly, from Original Intel Code.
53*35786f68SRobert Mustacchi *
54*35786f68SRobert Mustacchi * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55*35786f68SRobert Mustacchi * Redistribution of source code of any substantial portion of the Covered
56*35786f68SRobert Mustacchi * Code or modification without rights to further distribute source must
57*35786f68SRobert Mustacchi * include the following Disclaimer and Export Compliance provision in the
58*35786f68SRobert Mustacchi * documentation and/or other materials provided with distribution. In
59*35786f68SRobert Mustacchi * addition, Licensee may not authorize further sublicense of source of any
60*35786f68SRobert Mustacchi * portion of the Covered Code, and must include terms to the effect that the
61*35786f68SRobert Mustacchi * license from Licensee to its licensee is limited to the intellectual
62*35786f68SRobert Mustacchi * property embodied in the software Licensee provides to its licensee, and
63*35786f68SRobert Mustacchi * not to intellectual property embodied in modifications its licensee may
64*35786f68SRobert Mustacchi * make.
65*35786f68SRobert Mustacchi *
66*35786f68SRobert Mustacchi * 3.3. Redistribution of Executable. Redistribution in executable form of any
67*35786f68SRobert Mustacchi * substantial portion of the Covered Code or modification must reproduce the
68*35786f68SRobert Mustacchi * above Copyright Notice, and the following Disclaimer and Export Compliance
69*35786f68SRobert Mustacchi * provision in the documentation and/or other materials provided with the
70*35786f68SRobert Mustacchi * distribution.
71*35786f68SRobert Mustacchi *
72*35786f68SRobert Mustacchi * 3.4. Intel retains all right, title, and interest in and to the Original
73*35786f68SRobert Mustacchi * Intel Code.
74*35786f68SRobert Mustacchi *
75*35786f68SRobert Mustacchi * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76*35786f68SRobert Mustacchi * Intel shall be used in advertising or otherwise to promote the sale, use or
77*35786f68SRobert Mustacchi * other dealings in products derived from or relating to the Covered Code
78*35786f68SRobert Mustacchi * without prior written authorization from Intel.
79*35786f68SRobert Mustacchi *
80*35786f68SRobert Mustacchi * 4. Disclaimer and Export Compliance
81*35786f68SRobert Mustacchi *
82*35786f68SRobert Mustacchi * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83*35786f68SRobert Mustacchi * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84*35786f68SRobert Mustacchi * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85*35786f68SRobert Mustacchi * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86*35786f68SRobert Mustacchi * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87*35786f68SRobert Mustacchi * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88*35786f68SRobert Mustacchi * PARTICULAR PURPOSE.
89*35786f68SRobert Mustacchi *
90*35786f68SRobert Mustacchi * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91*35786f68SRobert Mustacchi * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92*35786f68SRobert Mustacchi * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93*35786f68SRobert Mustacchi * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94*35786f68SRobert Mustacchi * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95*35786f68SRobert Mustacchi * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96*35786f68SRobert Mustacchi * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97*35786f68SRobert Mustacchi * LIMITED REMEDY.
98*35786f68SRobert Mustacchi *
99*35786f68SRobert Mustacchi * 4.3. Licensee shall not export, either directly or indirectly, any of this
100*35786f68SRobert Mustacchi * software or system incorporating such software without first obtaining any
101*35786f68SRobert Mustacchi * required license or other approval from the U. S. Department of Commerce or
102*35786f68SRobert Mustacchi * any other agency or department of the United States Government. In the
103*35786f68SRobert Mustacchi * event Licensee exports any such software from the United States or
104*35786f68SRobert Mustacchi * re-exports any such software from a foreign destination, Licensee shall
105*35786f68SRobert Mustacchi * ensure that the distribution and export/re-export of the software is in
106*35786f68SRobert Mustacchi * compliance with all laws, regulations, orders, or other restrictions of the
107*35786f68SRobert Mustacchi * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108*35786f68SRobert Mustacchi * any of its subsidiaries will export/re-export any technical data, process,
109*35786f68SRobert Mustacchi * software, or service, directly or indirectly, to any country for which the
110*35786f68SRobert Mustacchi * United States government or any agency thereof requires an export license,
111*35786f68SRobert Mustacchi * other governmental approval, or letter of assurance, without first obtaining
112*35786f68SRobert Mustacchi * such license, approval or letter.
113*35786f68SRobert Mustacchi *
114*35786f68SRobert Mustacchi *****************************************************************************
115*35786f68SRobert Mustacchi *
116*35786f68SRobert Mustacchi * Alternatively, you may choose to be licensed under the terms of the
117*35786f68SRobert Mustacchi * following license:
118*35786f68SRobert Mustacchi *
119bc36eafdSMike Gerdts * Redistribution and use in source and binary forms, with or without
120bc36eafdSMike Gerdts * modification, are permitted provided that the following conditions
121bc36eafdSMike Gerdts * are met:
122bc36eafdSMike Gerdts * 1. Redistributions of source code must retain the above copyright
123bc36eafdSMike Gerdts * notice, this list of conditions, and the following disclaimer,
124bc36eafdSMike Gerdts * without modification.
125bc36eafdSMike Gerdts * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126bc36eafdSMike Gerdts * substantially similar to the "NO WARRANTY" disclaimer below
127bc36eafdSMike Gerdts * ("Disclaimer") and any redistribution must be conditioned upon
128bc36eafdSMike Gerdts * including a substantially similar Disclaimer requirement for further
129bc36eafdSMike Gerdts * binary redistribution.
130bc36eafdSMike Gerdts * 3. Neither the names of the above-listed copyright holders nor the names
131bc36eafdSMike Gerdts * of any contributors may be used to endorse or promote products derived
132bc36eafdSMike Gerdts * from this software without specific prior written permission.
133bc36eafdSMike Gerdts *
134bc36eafdSMike Gerdts * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135bc36eafdSMike Gerdts * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136*35786f68SRobert Mustacchi * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137bc36eafdSMike Gerdts * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138*35786f68SRobert Mustacchi * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139*35786f68SRobert Mustacchi * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140*35786f68SRobert Mustacchi * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141*35786f68SRobert Mustacchi * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142*35786f68SRobert Mustacchi * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143*35786f68SRobert Mustacchi * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144*35786f68SRobert Mustacchi * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145*35786f68SRobert Mustacchi *
146*35786f68SRobert Mustacchi * Alternatively, you may choose to be licensed under the terms of the
147*35786f68SRobert Mustacchi * GNU General Public License ("GPL") version 2 as published by the Free
148*35786f68SRobert Mustacchi * Software Foundation.
149*35786f68SRobert Mustacchi *
150*35786f68SRobert Mustacchi *****************************************************************************/
151bc36eafdSMike Gerdts
152bc36eafdSMike Gerdts #include "aslcompiler.h"
153bc36eafdSMike Gerdts
154bc36eafdSMike Gerdts #define _COMPONENT ASL_PREPROCESSOR
155bc36eafdSMike Gerdts ACPI_MODULE_NAME ("prutils")
156bc36eafdSMike Gerdts
157bc36eafdSMike Gerdts
158bc36eafdSMike Gerdts /******************************************************************************
159bc36eafdSMike Gerdts *
160bc36eafdSMike Gerdts * FUNCTION: PrGetNextToken
161bc36eafdSMike Gerdts *
162bc36eafdSMike Gerdts * PARAMETERS: Buffer - Current line buffer
163bc36eafdSMike Gerdts * MatchString - String with valid token delimiters
164bc36eafdSMike Gerdts * Next - Set to next possible token in buffer
165bc36eafdSMike Gerdts *
166bc36eafdSMike Gerdts * RETURN: Next token (null-terminated). Modifies the input line.
167bc36eafdSMike Gerdts * Remainder of line is stored in *Next.
168bc36eafdSMike Gerdts *
169bc36eafdSMike Gerdts * DESCRIPTION: Local implementation of strtok() with local storage for the
170bc36eafdSMike Gerdts * next pointer. Not only thread-safe, but allows multiple
171bc36eafdSMike Gerdts * parsing of substrings such as expressions.
172bc36eafdSMike Gerdts *
173bc36eafdSMike Gerdts *****************************************************************************/
174bc36eafdSMike Gerdts
175bc36eafdSMike Gerdts char *
PrGetNextToken(char * Buffer,char * MatchString,char ** Next)176bc36eafdSMike Gerdts PrGetNextToken (
177bc36eafdSMike Gerdts char *Buffer,
178bc36eafdSMike Gerdts char *MatchString,
179bc36eafdSMike Gerdts char **Next)
180bc36eafdSMike Gerdts {
181bc36eafdSMike Gerdts char *TokenStart;
182bc36eafdSMike Gerdts
183bc36eafdSMike Gerdts
184bc36eafdSMike Gerdts if (!Buffer)
185bc36eafdSMike Gerdts {
186bc36eafdSMike Gerdts /* Use Next if it is valid */
187bc36eafdSMike Gerdts
188bc36eafdSMike Gerdts Buffer = *Next;
189bc36eafdSMike Gerdts if (!(*Next))
190bc36eafdSMike Gerdts {
191bc36eafdSMike Gerdts return (NULL);
192bc36eafdSMike Gerdts }
193bc36eafdSMike Gerdts }
194bc36eafdSMike Gerdts
195bc36eafdSMike Gerdts /* Skip any leading delimiters */
196bc36eafdSMike Gerdts
197bc36eafdSMike Gerdts while (*Buffer)
198bc36eafdSMike Gerdts {
199bc36eafdSMike Gerdts if (strchr (MatchString, *Buffer))
200bc36eafdSMike Gerdts {
201bc36eafdSMike Gerdts Buffer++;
202bc36eafdSMike Gerdts }
203bc36eafdSMike Gerdts else
204bc36eafdSMike Gerdts {
205bc36eafdSMike Gerdts break;
206bc36eafdSMike Gerdts }
207bc36eafdSMike Gerdts }
208bc36eafdSMike Gerdts
209bc36eafdSMike Gerdts /* Anything left on the line? */
210bc36eafdSMike Gerdts
211bc36eafdSMike Gerdts if (!(*Buffer))
212bc36eafdSMike Gerdts {
213bc36eafdSMike Gerdts *Next = NULL;
214bc36eafdSMike Gerdts return (NULL);
215bc36eafdSMike Gerdts }
216bc36eafdSMike Gerdts
217bc36eafdSMike Gerdts TokenStart = Buffer;
218bc36eafdSMike Gerdts
219bc36eafdSMike Gerdts /* Find the end of this token */
220bc36eafdSMike Gerdts
221bc36eafdSMike Gerdts while (*Buffer)
222bc36eafdSMike Gerdts {
223bc36eafdSMike Gerdts if (strchr (MatchString, *Buffer))
224bc36eafdSMike Gerdts {
225bc36eafdSMike Gerdts *Buffer = 0;
226bc36eafdSMike Gerdts *Next = Buffer+1;
227bc36eafdSMike Gerdts if (!**Next)
228bc36eafdSMike Gerdts {
229bc36eafdSMike Gerdts *Next = NULL;
230bc36eafdSMike Gerdts }
231bc36eafdSMike Gerdts
232bc36eafdSMike Gerdts return (TokenStart);
233bc36eafdSMike Gerdts }
234bc36eafdSMike Gerdts
235bc36eafdSMike Gerdts Buffer++;
236bc36eafdSMike Gerdts }
237bc36eafdSMike Gerdts
238bc36eafdSMike Gerdts *Next = NULL;
239bc36eafdSMike Gerdts return (TokenStart);
240bc36eafdSMike Gerdts }
241bc36eafdSMike Gerdts
242bc36eafdSMike Gerdts
243bc36eafdSMike Gerdts /*******************************************************************************
244bc36eafdSMike Gerdts *
245bc36eafdSMike Gerdts * FUNCTION: PrError
246bc36eafdSMike Gerdts *
247bc36eafdSMike Gerdts * PARAMETERS: Level - Seriousness (Warning/error, etc.)
248bc36eafdSMike Gerdts * MessageId - Index into global message buffer
249bc36eafdSMike Gerdts * Column - Column in current line
250bc36eafdSMike Gerdts *
251bc36eafdSMike Gerdts * RETURN: None
252bc36eafdSMike Gerdts *
253bc36eafdSMike Gerdts * DESCRIPTION: Preprocessor error reporting. Front end to AslCommonError2
254bc36eafdSMike Gerdts *
255bc36eafdSMike Gerdts ******************************************************************************/
256bc36eafdSMike Gerdts
257bc36eafdSMike Gerdts void
PrError(UINT8 Level,UINT16 MessageId,UINT32 Column)258bc36eafdSMike Gerdts PrError (
259bc36eafdSMike Gerdts UINT8 Level,
260bc36eafdSMike Gerdts UINT16 MessageId,
261bc36eafdSMike Gerdts UINT32 Column)
262bc36eafdSMike Gerdts {
263bc36eafdSMike Gerdts #if 0
264bc36eafdSMike Gerdts AcpiOsPrintf ("%s (%u) : %s", Gbl_Files[ASL_FILE_INPUT].Filename,
265bc36eafdSMike Gerdts Gbl_CurrentLineNumber, Gbl_CurrentLineBuffer);
266bc36eafdSMike Gerdts #endif
267bc36eafdSMike Gerdts
268bc36eafdSMike Gerdts
269bc36eafdSMike Gerdts if (Column > 120)
270bc36eafdSMike Gerdts {
271bc36eafdSMike Gerdts Column = 0;
272bc36eafdSMike Gerdts }
273bc36eafdSMike Gerdts
274bc36eafdSMike Gerdts /* TBD: Need Logical line number? */
275bc36eafdSMike Gerdts
276bc36eafdSMike Gerdts AslCommonError2 (Level, MessageId,
277bc36eafdSMike Gerdts Gbl_CurrentLineNumber, Column,
278bc36eafdSMike Gerdts Gbl_CurrentLineBuffer,
279bc36eafdSMike Gerdts Gbl_Files[ASL_FILE_INPUT].Filename, "Preprocessor");
280bc36eafdSMike Gerdts
281bc36eafdSMike Gerdts Gbl_PreprocessorError = TRUE;
282bc36eafdSMike Gerdts }
283bc36eafdSMike Gerdts
284bc36eafdSMike Gerdts
285bc36eafdSMike Gerdts /*******************************************************************************
286bc36eafdSMike Gerdts *
287bc36eafdSMike Gerdts * FUNCTION: PrReplaceData
288bc36eafdSMike Gerdts *
289bc36eafdSMike Gerdts * PARAMETERS: Buffer - Original(target) buffer pointer
290bc36eafdSMike Gerdts * LengthToRemove - Length to be removed from target buffer
291bc36eafdSMike Gerdts * BufferToAdd - Data to be inserted into target buffer
292bc36eafdSMike Gerdts * LengthToAdd - Length of BufferToAdd
293bc36eafdSMike Gerdts *
294bc36eafdSMike Gerdts * RETURN: None
295bc36eafdSMike Gerdts *
296bc36eafdSMike Gerdts * DESCRIPTION: Generic buffer data replacement.
297bc36eafdSMike Gerdts *
298bc36eafdSMike Gerdts ******************************************************************************/
299bc36eafdSMike Gerdts
300bc36eafdSMike Gerdts void
PrReplaceData(char * Buffer,UINT32 LengthToRemove,char * BufferToAdd,UINT32 LengthToAdd)301bc36eafdSMike Gerdts PrReplaceData (
302bc36eafdSMike Gerdts char *Buffer,
303bc36eafdSMike Gerdts UINT32 LengthToRemove,
304bc36eafdSMike Gerdts char *BufferToAdd,
305bc36eafdSMike Gerdts UINT32 LengthToAdd)
306bc36eafdSMike Gerdts {
307bc36eafdSMike Gerdts UINT32 BufferLength;
308bc36eafdSMike Gerdts
309bc36eafdSMike Gerdts
310bc36eafdSMike Gerdts /* Buffer is a string, so the length must include the terminating zero */
311bc36eafdSMike Gerdts
312bc36eafdSMike Gerdts BufferLength = strlen (Buffer) + 1;
313bc36eafdSMike Gerdts
314bc36eafdSMike Gerdts if (LengthToRemove != LengthToAdd)
315bc36eafdSMike Gerdts {
316bc36eafdSMike Gerdts /*
317bc36eafdSMike Gerdts * Move some of the existing data
318bc36eafdSMike Gerdts * 1) If adding more bytes than removing, make room for the new data
319bc36eafdSMike Gerdts * 2) if removing more bytes than adding, delete the extra space
320bc36eafdSMike Gerdts */
321bc36eafdSMike Gerdts if (LengthToRemove > 0)
322bc36eafdSMike Gerdts {
323bc36eafdSMike Gerdts memmove ((Buffer + LengthToAdd), (Buffer + LengthToRemove),
324bc36eafdSMike Gerdts (BufferLength - LengthToRemove));
325bc36eafdSMike Gerdts }
326bc36eafdSMike Gerdts }
327bc36eafdSMike Gerdts
328bc36eafdSMike Gerdts /* Now we can move in the new data */
329bc36eafdSMike Gerdts
330bc36eafdSMike Gerdts if (LengthToAdd > 0)
331bc36eafdSMike Gerdts {
332bc36eafdSMike Gerdts memmove (Buffer, BufferToAdd, LengthToAdd);
333bc36eafdSMike Gerdts }
334bc36eafdSMike Gerdts }
335bc36eafdSMike Gerdts
336bc36eafdSMike Gerdts
337bc36eafdSMike Gerdts /*******************************************************************************
338bc36eafdSMike Gerdts *
339bc36eafdSMike Gerdts * FUNCTION: PrOpenIncludeFile
340bc36eafdSMike Gerdts *
341bc36eafdSMike Gerdts * PARAMETERS: Filename - Filename or pathname for include file
342bc36eafdSMike Gerdts *
343bc36eafdSMike Gerdts * RETURN: None.
344bc36eafdSMike Gerdts *
345bc36eafdSMike Gerdts * DESCRIPTION: Open an include file and push it on the input file stack.
346bc36eafdSMike Gerdts *
347bc36eafdSMike Gerdts ******************************************************************************/
348bc36eafdSMike Gerdts
349bc36eafdSMike Gerdts FILE *
PrOpenIncludeFile(char * Filename,char * OpenMode,char ** FullPathname)350bc36eafdSMike Gerdts PrOpenIncludeFile (
351bc36eafdSMike Gerdts char *Filename,
352bc36eafdSMike Gerdts char *OpenMode,
353bc36eafdSMike Gerdts char **FullPathname)
354bc36eafdSMike Gerdts {
355bc36eafdSMike Gerdts FILE *IncludeFile;
356bc36eafdSMike Gerdts ASL_INCLUDE_DIR *NextDir;
357bc36eafdSMike Gerdts
358bc36eafdSMike Gerdts
359bc36eafdSMike Gerdts /* Start the actual include file on the next line */
360bc36eafdSMike Gerdts
361bc36eafdSMike Gerdts Gbl_CurrentLineOffset++;
362bc36eafdSMike Gerdts
363bc36eafdSMike Gerdts /* Attempt to open the include file */
364bc36eafdSMike Gerdts /* If the file specifies an absolute path, just open it */
365bc36eafdSMike Gerdts
366bc36eafdSMike Gerdts if ((Filename[0] == '/') ||
367bc36eafdSMike Gerdts (Filename[0] == '\\') ||
368bc36eafdSMike Gerdts (Filename[1] == ':'))
369bc36eafdSMike Gerdts {
370bc36eafdSMike Gerdts IncludeFile = PrOpenIncludeWithPrefix (
371bc36eafdSMike Gerdts "", Filename, OpenMode, FullPathname);
372bc36eafdSMike Gerdts if (!IncludeFile)
373bc36eafdSMike Gerdts {
374bc36eafdSMike Gerdts goto ErrorExit;
375bc36eafdSMike Gerdts }
376bc36eafdSMike Gerdts return (IncludeFile);
377bc36eafdSMike Gerdts }
378bc36eafdSMike Gerdts
379bc36eafdSMike Gerdts /*
380bc36eafdSMike Gerdts * The include filename is not an absolute path.
381bc36eafdSMike Gerdts *
382bc36eafdSMike Gerdts * First, search for the file within the "local" directory -- meaning
383bc36eafdSMike Gerdts * the same directory that contains the source file.
384bc36eafdSMike Gerdts *
385bc36eafdSMike Gerdts * Construct the file pathname from the global directory name.
386bc36eafdSMike Gerdts */
387bc36eafdSMike Gerdts IncludeFile = PrOpenIncludeWithPrefix (
388bc36eafdSMike Gerdts Gbl_DirectoryPath, Filename, OpenMode, FullPathname);
389bc36eafdSMike Gerdts if (IncludeFile)
390bc36eafdSMike Gerdts {
391bc36eafdSMike Gerdts return (IncludeFile);
392bc36eafdSMike Gerdts }
393bc36eafdSMike Gerdts
394bc36eafdSMike Gerdts /*
395bc36eafdSMike Gerdts * Second, search for the file within the (possibly multiple)
396bc36eafdSMike Gerdts * directories specified by the -I option on the command line.
397bc36eafdSMike Gerdts */
398bc36eafdSMike Gerdts NextDir = Gbl_IncludeDirList;
399bc36eafdSMike Gerdts while (NextDir)
400bc36eafdSMike Gerdts {
401bc36eafdSMike Gerdts IncludeFile = PrOpenIncludeWithPrefix (
402bc36eafdSMike Gerdts NextDir->Dir, Filename, OpenMode, FullPathname);
403bc36eafdSMike Gerdts if (IncludeFile)
404bc36eafdSMike Gerdts {
405bc36eafdSMike Gerdts return (IncludeFile);
406bc36eafdSMike Gerdts }
407bc36eafdSMike Gerdts
408bc36eafdSMike Gerdts NextDir = NextDir->Next;
409bc36eafdSMike Gerdts }
410bc36eafdSMike Gerdts
411bc36eafdSMike Gerdts /* We could not open the include file after trying very hard */
412bc36eafdSMike Gerdts
413bc36eafdSMike Gerdts ErrorExit:
414bc36eafdSMike Gerdts sprintf (Gbl_MainTokenBuffer, "%s, %s", Filename, strerror (errno));
415bc36eafdSMike Gerdts PrError (ASL_ERROR, ASL_MSG_INCLUDE_FILE_OPEN, 0);
416bc36eafdSMike Gerdts return (NULL);
417bc36eafdSMike Gerdts }
418bc36eafdSMike Gerdts
419bc36eafdSMike Gerdts
420bc36eafdSMike Gerdts /*******************************************************************************
421bc36eafdSMike Gerdts *
422bc36eafdSMike Gerdts * FUNCTION: FlOpenIncludeWithPrefix
423bc36eafdSMike Gerdts *
424bc36eafdSMike Gerdts * PARAMETERS: PrefixDir - Prefix directory pathname. Can be a zero
425bc36eafdSMike Gerdts * length string.
426bc36eafdSMike Gerdts * Filename - The include filename from the source ASL.
427bc36eafdSMike Gerdts *
428bc36eafdSMike Gerdts * RETURN: Valid file descriptor if successful. Null otherwise.
429bc36eafdSMike Gerdts *
430bc36eafdSMike Gerdts * DESCRIPTION: Open an include file and push it on the input file stack.
431bc36eafdSMike Gerdts *
432bc36eafdSMike Gerdts ******************************************************************************/
433bc36eafdSMike Gerdts
434bc36eafdSMike Gerdts FILE *
PrOpenIncludeWithPrefix(char * PrefixDir,char * Filename,char * OpenMode,char ** FullPathname)435bc36eafdSMike Gerdts PrOpenIncludeWithPrefix (
436bc36eafdSMike Gerdts char *PrefixDir,
437bc36eafdSMike Gerdts char *Filename,
438bc36eafdSMike Gerdts char *OpenMode,
439bc36eafdSMike Gerdts char **FullPathname)
440bc36eafdSMike Gerdts {
441bc36eafdSMike Gerdts FILE *IncludeFile;
442bc36eafdSMike Gerdts char *Pathname;
443bc36eafdSMike Gerdts
444bc36eafdSMike Gerdts
445bc36eafdSMike Gerdts /* Build the full pathname to the file */
446bc36eafdSMike Gerdts
447bc36eafdSMike Gerdts Pathname = FlMergePathnames (PrefixDir, Filename);
448bc36eafdSMike Gerdts
449bc36eafdSMike Gerdts DbgPrint (ASL_PARSE_OUTPUT, PR_PREFIX_ID
450bc36eafdSMike Gerdts "Include: Opening file - \"%s\"\n",
451bc36eafdSMike Gerdts Gbl_CurrentLineNumber, Pathname);
452bc36eafdSMike Gerdts
453bc36eafdSMike Gerdts /* Attempt to open the file, push if successful */
454bc36eafdSMike Gerdts
455bc36eafdSMike Gerdts IncludeFile = fopen (Pathname, OpenMode);
456bc36eafdSMike Gerdts if (!IncludeFile)
457bc36eafdSMike Gerdts {
458bc36eafdSMike Gerdts fprintf (stderr, "Could not open include file %s\n", Pathname);
459bc36eafdSMike Gerdts return (NULL);
460bc36eafdSMike Gerdts }
461bc36eafdSMike Gerdts
462bc36eafdSMike Gerdts /* Push the include file on the open input file stack */
463bc36eafdSMike Gerdts
464bc36eafdSMike Gerdts PrPushInputFileStack (IncludeFile, Pathname);
465bc36eafdSMike Gerdts *FullPathname = Pathname;
466bc36eafdSMike Gerdts return (IncludeFile);
467bc36eafdSMike Gerdts }
468bc36eafdSMike Gerdts
469bc36eafdSMike Gerdts
470bc36eafdSMike Gerdts /*******************************************************************************
471bc36eafdSMike Gerdts *
472bc36eafdSMike Gerdts * FUNCTION: AslPushInputFileStack
473bc36eafdSMike Gerdts *
474bc36eafdSMike Gerdts * PARAMETERS: InputFile - Open file pointer
475bc36eafdSMike Gerdts * Filename - Name of the file
476bc36eafdSMike Gerdts *
477bc36eafdSMike Gerdts * RETURN: None
478bc36eafdSMike Gerdts *
479bc36eafdSMike Gerdts * DESCRIPTION: Push the InputFile onto the file stack, and point the parser
480bc36eafdSMike Gerdts * to this file. Called when an include file is successfully
481bc36eafdSMike Gerdts * opened.
482bc36eafdSMike Gerdts *
483bc36eafdSMike Gerdts ******************************************************************************/
484bc36eafdSMike Gerdts
485bc36eafdSMike Gerdts void
PrPushInputFileStack(FILE * InputFile,char * Filename)486bc36eafdSMike Gerdts PrPushInputFileStack (
487bc36eafdSMike Gerdts FILE *InputFile,
488bc36eafdSMike Gerdts char *Filename)
489bc36eafdSMike Gerdts {
490bc36eafdSMike Gerdts PR_FILE_NODE *Fnode;
491bc36eafdSMike Gerdts
492bc36eafdSMike Gerdts
493bc36eafdSMike Gerdts Gbl_HasIncludeFiles = TRUE;
494bc36eafdSMike Gerdts
495bc36eafdSMike Gerdts /* Save the current state in an Fnode */
496bc36eafdSMike Gerdts
497bc36eafdSMike Gerdts Fnode = UtLocalCalloc (sizeof (PR_FILE_NODE));
498bc36eafdSMike Gerdts
499bc36eafdSMike Gerdts Fnode->File = Gbl_Files[ASL_FILE_INPUT].Handle;
500bc36eafdSMike Gerdts Fnode->Next = Gbl_InputFileList;
501bc36eafdSMike Gerdts Fnode->Filename = Gbl_Files[ASL_FILE_INPUT].Filename;
502bc36eafdSMike Gerdts Fnode->CurrentLineNumber = Gbl_CurrentLineNumber;
503bc36eafdSMike Gerdts
504bc36eafdSMike Gerdts /* Push it on the stack */
505bc36eafdSMike Gerdts
506bc36eafdSMike Gerdts Gbl_InputFileList = Fnode;
507bc36eafdSMike Gerdts
508bc36eafdSMike Gerdts DbgPrint (ASL_PARSE_OUTPUT, PR_PREFIX_ID
509bc36eafdSMike Gerdts "Push InputFile Stack: handle %p\n\n",
510bc36eafdSMike Gerdts Gbl_CurrentLineNumber, InputFile);
511bc36eafdSMike Gerdts
512bc36eafdSMike Gerdts /* Reset the global line count and filename */
513bc36eafdSMike Gerdts
514bc36eafdSMike Gerdts Gbl_Files[ASL_FILE_INPUT].Filename =
515*35786f68SRobert Mustacchi UtLocalCacheCalloc (strlen (Filename) + 1);
516bc36eafdSMike Gerdts strcpy (Gbl_Files[ASL_FILE_INPUT].Filename, Filename);
517bc36eafdSMike Gerdts
518bc36eafdSMike Gerdts Gbl_Files[ASL_FILE_INPUT].Handle = InputFile;
519bc36eafdSMike Gerdts Gbl_CurrentLineNumber = 1;
520bc36eafdSMike Gerdts
521bc36eafdSMike Gerdts /* Emit a new #line directive for the include file */
522bc36eafdSMike Gerdts
523bc36eafdSMike Gerdts FlPrintFile (ASL_FILE_PREPROCESSOR, "#line %u \"%s\"\n", 1, Filename);
524bc36eafdSMike Gerdts }
525bc36eafdSMike Gerdts
526bc36eafdSMike Gerdts
527bc36eafdSMike Gerdts /*******************************************************************************
528bc36eafdSMike Gerdts *
529bc36eafdSMike Gerdts * FUNCTION: AslPopInputFileStack
530bc36eafdSMike Gerdts *
531bc36eafdSMike Gerdts * PARAMETERS: None
532bc36eafdSMike Gerdts *
533bc36eafdSMike Gerdts * RETURN: 0 if a node was popped, -1 otherwise
534bc36eafdSMike Gerdts *
535bc36eafdSMike Gerdts * DESCRIPTION: Pop the top of the input file stack and point the parser to
536bc36eafdSMike Gerdts * the saved parse buffer contained in the fnode. Also, set the
537bc36eafdSMike Gerdts * global line counters to the saved values. This function is
538bc36eafdSMike Gerdts * called when an include file reaches EOF.
539bc36eafdSMike Gerdts *
540bc36eafdSMike Gerdts ******************************************************************************/
541bc36eafdSMike Gerdts
542bc36eafdSMike Gerdts BOOLEAN
PrPopInputFileStack(void)543bc36eafdSMike Gerdts PrPopInputFileStack (
544bc36eafdSMike Gerdts void)
545bc36eafdSMike Gerdts {
546bc36eafdSMike Gerdts PR_FILE_NODE *Fnode;
547bc36eafdSMike Gerdts
548bc36eafdSMike Gerdts
549bc36eafdSMike Gerdts Fnode = Gbl_InputFileList;
550bc36eafdSMike Gerdts DbgPrint (ASL_PARSE_OUTPUT, "\n" PR_PREFIX_ID
551bc36eafdSMike Gerdts "Pop InputFile Stack, Fnode %p\n\n",
552bc36eafdSMike Gerdts Gbl_CurrentLineNumber, Fnode);
553bc36eafdSMike Gerdts
554bc36eafdSMike Gerdts if (!Fnode)
555bc36eafdSMike Gerdts {
556bc36eafdSMike Gerdts return (FALSE);
557bc36eafdSMike Gerdts }
558bc36eafdSMike Gerdts
559bc36eafdSMike Gerdts /* Close the current include file */
560bc36eafdSMike Gerdts
561bc36eafdSMike Gerdts fclose (Gbl_Files[ASL_FILE_INPUT].Handle);
562bc36eafdSMike Gerdts
563bc36eafdSMike Gerdts /* Update the top-of-stack */
564bc36eafdSMike Gerdts
565bc36eafdSMike Gerdts Gbl_InputFileList = Fnode->Next;
566bc36eafdSMike Gerdts
567bc36eafdSMike Gerdts /* Reset global line counter and filename */
568bc36eafdSMike Gerdts
569bc36eafdSMike Gerdts Gbl_Files[ASL_FILE_INPUT].Filename = Fnode->Filename;
570bc36eafdSMike Gerdts Gbl_Files[ASL_FILE_INPUT].Handle = Fnode->File;
571bc36eafdSMike Gerdts Gbl_CurrentLineNumber = Fnode->CurrentLineNumber;
572bc36eafdSMike Gerdts
573bc36eafdSMike Gerdts /* Emit a new #line directive after the include file */
574bc36eafdSMike Gerdts
575bc36eafdSMike Gerdts FlPrintFile (ASL_FILE_PREPROCESSOR, "#line %u \"%s\"\n",
576bc36eafdSMike Gerdts Gbl_CurrentLineNumber, Fnode->Filename);
577bc36eafdSMike Gerdts
578bc36eafdSMike Gerdts /* All done with this node */
579bc36eafdSMike Gerdts
580bc36eafdSMike Gerdts ACPI_FREE (Fnode);
581bc36eafdSMike Gerdts return (TRUE);
582bc36eafdSMike Gerdts }
583