xref: /freebsd/sys/contrib/dev/acpica/compiler/prparser.l (revision 29fc4075e69fd27de0cded313ac6000165d99f8b)
1 %{
2 /******************************************************************************
3  *
4  * Module Name: prparser.l - Flex input file for preprocessor lexer
5  *
6  *****************************************************************************/
7 
8 /******************************************************************************
9  *
10  * 1. Copyright Notice
11  *
12  * Some or all of this work - Copyright (c) 1999 - 2022, Intel Corp.
13  * All rights reserved.
14  *
15  * 2. License
16  *
17  * 2.1. This is your license from Intel Corp. under its intellectual property
18  * rights. You may have additional license terms from the party that provided
19  * you this software, covering your right to use that party's intellectual
20  * property rights.
21  *
22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23  * copy of the source code appearing in this file ("Covered Code") an
24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25  * base code distributed originally by Intel ("Original Intel Code") to copy,
26  * make derivatives, distribute, use and display any portion of the Covered
27  * Code in any form, with the right to sublicense such rights; and
28  *
29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30  * license (with the right to sublicense), under only those claims of Intel
31  * patents that are infringed by the Original Intel Code, to make, use, sell,
32  * offer to sell, and import the Covered Code and derivative works thereof
33  * solely to the minimum extent necessary to exercise the above copyright
34  * license, and in no event shall the patent license extend to any additions
35  * to or modifications of the Original Intel Code. No other license or right
36  * is granted directly or by implication, estoppel or otherwise;
37  *
38  * The above copyright and patent license is granted only if the following
39  * conditions are met:
40  *
41  * 3. Conditions
42  *
43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44  * Redistribution of source code of any substantial portion of the Covered
45  * Code or modification with rights to further distribute source must include
46  * the above Copyright Notice, the above License, this list of Conditions,
47  * and the following Disclaimer and Export Compliance provision. In addition,
48  * Licensee must cause all Covered Code to which Licensee contributes to
49  * contain a file documenting the changes Licensee made to create that Covered
50  * Code and the date of any change. Licensee must include in that file the
51  * documentation of any changes made by any predecessor Licensee. Licensee
52  * must include a prominent statement that the modification is derived,
53  * directly or indirectly, from Original Intel Code.
54  *
55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56  * Redistribution of source code of any substantial portion of the Covered
57  * Code or modification without rights to further distribute source must
58  * include the following Disclaimer and Export Compliance provision in the
59  * documentation and/or other materials provided with distribution. In
60  * addition, Licensee may not authorize further sublicense of source of any
61  * portion of the Covered Code, and must include terms to the effect that the
62  * license from Licensee to its licensee is limited to the intellectual
63  * property embodied in the software Licensee provides to its licensee, and
64  * not to intellectual property embodied in modifications its licensee may
65  * make.
66  *
67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
68  * substantial portion of the Covered Code or modification must reproduce the
69  * above Copyright Notice, and the following Disclaimer and Export Compliance
70  * provision in the documentation and/or other materials provided with the
71  * distribution.
72  *
73  * 3.4. Intel retains all right, title, and interest in and to the Original
74  * Intel Code.
75  *
76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77  * Intel shall be used in advertising or otherwise to promote the sale, use or
78  * other dealings in products derived from or relating to the Covered Code
79  * without prior written authorization from Intel.
80  *
81  * 4. Disclaimer and Export Compliance
82  *
83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89  * PARTICULAR PURPOSE.
90  *
91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
98  * LIMITED REMEDY.
99  *
100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
101  * software or system incorporating such software without first obtaining any
102  * required license or other approval from the U. S. Department of Commerce or
103  * any other agency or department of the United States Government. In the
104  * event Licensee exports any such software from the United States or
105  * re-exports any such software from a foreign destination, Licensee shall
106  * ensure that the distribution and export/re-export of the software is in
107  * compliance with all laws, regulations, orders, or other restrictions of the
108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109  * any of its subsidiaries will export/re-export any technical data, process,
110  * software, or service, directly or indirectly, to any country for which the
111  * United States government or any agency thereof requires an export license,
112  * other governmental approval, or letter of assurance, without first obtaining
113  * such license, approval or letter.
114  *
115  *****************************************************************************
116  *
117  * Alternatively, you may choose to be licensed under the terms of the
118  * following license:
119  *
120  * Redistribution and use in source and binary forms, with or without
121  * modification, are permitted provided that the following conditions
122  * are met:
123  * 1. Redistributions of source code must retain the above copyright
124  *    notice, this list of conditions, and the following disclaimer,
125  *    without modification.
126  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
127  *    substantially similar to the "NO WARRANTY" disclaimer below
128  *    ("Disclaimer") and any redistribution must be conditioned upon
129  *    including a substantially similar Disclaimer requirement for further
130  *    binary redistribution.
131  * 3. Neither the names of the above-listed copyright holders nor the names
132  *    of any contributors may be used to endorse or promote products derived
133  *    from this software without specific prior written permission.
134  *
135  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
136  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
137  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
138  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
139  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
140  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
141  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
142  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
143  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
144  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
145  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146  *
147  * Alternatively, you may choose to be licensed under the terms of the
148  * GNU General Public License ("GPL") version 2 as published by the Free
149  * Software Foundation.
150  *
151  *****************************************************************************/
152 
153 #include <contrib/dev/acpica/compiler/aslcompiler.h>
154 #include "prparser.y.h"
155 
156 /* Buffer to pass strings to the parser */
157 
158 #define STRING_SETUP    strcpy (AslGbl_StringBuffer, PrParsertext);\
159     PrParserlval.str = AslGbl_StringBuffer
160 
161 #define _COMPONENT          ACPI_COMPILER
162         ACPI_MODULE_NAME    ("prscanner")
163 
164 
165 /* Local prototypes */
166 
167 static char
168 PrDoCommentType1 (
169     void);
170 
171 static char
172 PrDoCommentType2 (
173     void);
174 %}
175 
176 %option noyywrap
177 
178 Number          [0-9a-fA-F]+
179 HexNumber       0[xX][0-9a-fA-F]+
180 WhiteSpace      [ \t\v\r]+
181 NewLine         [\n]
182 Identifier      [a-zA-Z][0-9a-zA-Z]*
183 
184 %%
185 "/*"            { if (!PrDoCommentType1 ()) {yyterminate ();} }
186 "//"            { if (!PrDoCommentType2 ()) {yyterminate ();} }
187 
188 \(              return (EXPOP_PAREN_OPEN);
189 \)              return (EXPOP_PAREN_CLOSE);
190 \~              return (EXPOP_ONES_COMPLIMENT);
191 \!              return (EXPOP_LOGICAL_NOT);
192 \*              return (EXPOP_MULTIPLY);
193 \/              return (EXPOP_DIVIDE);
194 \%              return (EXPOP_MODULO);
195 \+              return (EXPOP_ADD);
196 \-              return (EXPOP_SUBTRACT);
197 ">>"            return (EXPOP_SHIFT_RIGHT);
198 "<<"            return (EXPOP_SHIFT_LEFT);
199 \<              return (EXPOP_LESS);
200 \>              return (EXPOP_GREATER);
201 "<="            return (EXPOP_LESS_EQUAL);
202 ">="            return (EXPOP_GREATER_EQUAL);
203 "=="            return (EXPOP_EQUAL);
204 "!="            return (EXPOP_NOT_EQUAL);
205 \&              return (EXPOP_AND);
206 \^              return (EXPOP_XOR);
207 \|              return (EXPOP_OR);
208 "&&"            return (EXPOP_LOGICAL_AND);
209 "||"            return (EXPOP_LOGICAL_OR);
210 
211 "defined"       return (EXPOP_DEFINE);
212 {Identifier}    {STRING_SETUP; return (EXPOP_IDENTIFIER);}
213 
214 <<EOF>>         return (EXPOP_EOF); /* null end-of-string */
215 
216 {Number}        return (EXPOP_NUMBER);
217 {HexNumber}     return (EXPOP_HEX_NUMBER);
218 {NewLine}       return (EXPOP_NEW_LINE);
219 {WhiteSpace}    /* Ignore */
220 
221 .               return (EXPOP_EOF);
222 %%
223 
224 /*
225  * Local support functions
226  */
227 static YY_BUFFER_STATE         LexBuffer;
228 
229 
230 /******************************************************************************
231  *
232  * FUNCTION:    PrInitLexer
233  *
234  * PARAMETERS:  String              - Input string to be parsed
235  *
236  * RETURN:      TRUE if parser returns NULL. FALSE otherwise.
237  *
238  * DESCRIPTION: Initialization routine for lexer. The lexer needs
239  *              a buffer to handle strings instead of a file.
240  *
241  *****************************************************************************/
242 
243 int
244 PrInitLexer (
245     char                    *String)
246 {
247 
248     LexBuffer = yy_scan_string (String);
249     return (LexBuffer == NULL);
250 }
251 
252 
253 /******************************************************************************
254  *
255  * FUNCTION:    PrTerminateLexer
256  *
257  * PARAMETERS:  None
258  *
259  * RETURN:      None
260  *
261  * DESCRIPTION: Termination routine for thelexer.
262  *
263  *****************************************************************************/
264 
265 void
266 PrTerminateLexer (
267     void)
268 {
269 
270     yy_delete_buffer (LexBuffer);
271 }
272 
273 
274 /********************************************************************************
275  *
276  * FUNCTION:    PrDoCommentType1
277  *
278  * PARAMETERS:  none
279  *
280  * RETURN:      none
281  *
282  * DESCRIPTION: Process a new legacy comment. Just toss it.
283  *
284  ******************************************************************************/
285 
286 static char
287 PrDoCommentType1 (
288     void)
289 {
290     int                 c;
291 
292 
293 Loop:
294     while (((c = input ()) != '*') && (c != EOF))
295     {
296     }
297     if (c == EOF)
298     {
299         return (FALSE);
300     }
301 
302     if (((c = input ()) != '/') && (c != EOF))
303     {
304         unput (c);
305         goto Loop;
306     }
307     if (c == EOF)
308     {
309         return (FALSE);
310     }
311 
312     return (TRUE);
313 }
314 
315 
316 /********************************************************************************
317  *
318  * FUNCTION:    PrDoCommentType2
319  *
320  * PARAMETERS:  none
321  *
322  * RETURN:      none
323  *
324  * DESCRIPTION: Process a new "//" comment. Just toss it.
325  *
326  ******************************************************************************/
327 
328 static char
329 PrDoCommentType2 (
330     void)
331 {
332     int                 c;
333 
334 
335     while (((c = input ()) != '\n') && (c != EOF))
336     {
337     }
338     if (c == EOF)
339     {
340         return (FALSE);
341     }
342 
343     return (TRUE);
344 }
345