xref: /freebsd/sys/contrib/dev/acpica/compiler/dtcompilerparser.l (revision 7fdf597e96a02165cfe22ff357b857d5fa15ed8a)
1 %{
2 /******************************************************************************
3  *
4  * Module Name: dtcompilerparser.l - Flex input file for table compiler lexer
5  *
6  *****************************************************************************/
7 
8 /******************************************************************************
9  *
10  * 1. Copyright Notice
11  *
12  * Some or all of this work - Copyright (c) 1999 - 2023, 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 "dtcompilerparser.y.h"
155 
156 
157 #define _COMPONENT          ACPI_COMPILER
158         ACPI_MODULE_NAME    ("dtcompilerscanner")
159 
160 /* handle locations */
161 
162 int DtCompilerParsercolumn = 1;
163 int DtLabelByteOffset = 0;
164 int DtCompilerParserByteOffset = 0;
165 
166 UINT32 DtTokenFirstLine = 0;
167 UINT32 DtTokenFirstColumn = 0;
168 
169 #define YY_USER_ACTION \
170             DtTokenFirstLine = DtCompilerParserlineno; \
171             DtTokenFirstColumn = DtCompilerParsercolumn; \
172             DtCompilerParsercolumn += DtCompilerParserleng; \
173             DtCompilerParserByteOffset += DtCompilerParserleng; \
174             DbgPrint (ASL_PARSE_OUTPUT,\
175                 "user action occurred. DtCompilerParserlloc.first_line: %u\n",\
176                 DtTokenFirstLine);
177 %}
178 
179 %option nounput noinput yylineno
180 
181     /* Indicates a state used for parsing multiline C comments */
182 %x ML_COMMENT
183 %x DATA_STATE
184 
185 WhiteSpace      [ \t\v\r]+
186 NewLines        [\n]+
187 
188     /* Avoid ", \n, and [] as a part of label name. These are not valid characters of a label name */
189 LabelName       [^ ":\n\[\]]([^":\n\[\]]*[^" :\n\[\]])?
190 
191     /* Avoid ", \n, \\, and [] as a part of data. These are not valid characters of data */
192 Data            [^ \\":\n\[\]]([^":\n\[\]\\]*[^" :\n\[\]\\])?
193 
194 Text            [^ ":\n][^":\n]*
195 Comment         \[[^\n\[\]]*\]
196 CommentField    {LabelName}{WhiteSpace}*:{WhiteSpace}{Comment}?$
197 
198 
199 %%
200 
201 <DATA_STATE>{WhiteSpace}"\\\n" {
202         DbgPrint(ASL_PARSE_OUTPUT,"Continuation matched\n");
203         return (DT_PARSEOP_LINE_CONTINUATION);
204     }
205 
206 ":" {
207         DbgPrint(ASL_PARSE_OUTPUT, ": Matched\n");
208         BEGIN (DATA_STATE);
209         return (':');
210     }
211 
212 <INITIAL,DATA_STATE>{WhiteSpace} { DbgPrint(ASL_PARSE_OUTPUT,"Whitespace matched\n"); }
213 
214 <INITIAL,DATA_STATE>{Comment}    { DbgPrint(ASL_PARSE_OUTPUT,"Comment matched\n"); }
215 
216 "/*"                     { BEGIN (ML_COMMENT); }
217 <ML_COMMENT>"*/"         { BEGIN (INITIAL); }
218 <ML_COMMENT>"*/\n"       { BEGIN (INITIAL); }
219 <ML_COMMENT>([^*]|\n)+|. /* Ignore */
220 "//".*                   /* Ignore */
221 
222 
223 <DATA_STATE>{Data} {
224       char *s;
225       int size = strlen (DtCompilerParsertext);
226       s=UtLocalCacheCalloc (size + 1);
227       AcpiUtSafeStrncpy (s, DtCompilerParsertext, size + 1);
228       DtCompilerParserlval.s = s;
229       DbgPrint (ASL_PARSE_OUTPUT, "Data: %s\n", s);
230       return (DT_PARSEOP_DATA);
231 }
232 
233 {CommentField}  /* ignore */
234 
235 {LabelName} {
236     char *s;
237     int size = strlen (DtCompilerParsertext);
238     s=UtLocalCacheCalloc (size + 1);
239     AcpiUtSafeStrncpy (s, DtCompilerParsertext, size + 1);
240     DtCompilerParserlval.u = (DT_TABLE_UNIT *) UtLocalCacheCalloc (sizeof (DT_TABLE_UNIT));
241     DtCompilerParserlval.u->Value = s;
242     DtCompilerParserlval.u->Line = DtCompilerParserlineno;
243     DtCompilerParserlval.u->Column = DtCompilerParsercolumn;
244     DtLabelByteOffset = DtCompilerParserByteOffset;
245     DbgPrint (ASL_PARSE_OUTPUT, "Label: %s\n", s);
246     return (DT_PARSEOP_LABEL);
247 }
248 
249 
250 <DATA_STATE>\"{Text}?\" { // remove outer quotes from the string, they are unnecessary
251     char *s;
252     int size = strlen (DtCompilerParsertext);
253     s=UtLocalCacheCalloc (size - 1);
254     AcpiUtSafeStrncpy (s, DtCompilerParsertext + 1, size - 1);
255     DtCompilerParserlval.s = s;
256     DbgPrint (ASL_PARSE_OUTPUT, "String Data: %s\n", s);
257     BEGIN (INITIAL);
258     return (DT_PARSEOP_STRING_DATA);
259 }
260 
261 
262 <INITIAL,DATA_STATE>{NewLines} {
263     DbgPrint(ASL_PARSE_OUTPUT,
264         "Newline matched (data state). Current line number: %u\n",DtCompilerParserlineno);
265     BEGIN (INITIAL); DtCompilerParsercolumn = 1;
266 }
267 
268 
269 %%
270 
271 
272 /*
273  * Local support functions
274  */
275 
276 void
277 DtCompilerInitLexer (
278     FILE                *inFile)
279 {
280     yyin = inFile;
281 }
282 
283 void
284 DtCompilerTerminateLexer (
285     void)
286 {
287     /*
288      * Flex/Bison increments the lineno for the EOF so decrement by 1 to get
289      * the correct number of lines.
290      */
291     AslGbl_CurrentLineNumber = DtCompilerParserlineno - 1;
292     AslGbl_InputByteCount = DtCompilerParserByteOffset;
293 }
294