aslascii.c revision 1.1.1.6.2.2 1 1.1.1.6.2.2 jdolecek /******************************************************************************
2 1.1.1.6.2.2 jdolecek *
3 1.1.1.6.2.2 jdolecek * Module Name: aslascii - ASCII detection and support routines
4 1.1.1.6.2.2 jdolecek *
5 1.1.1.6.2.2 jdolecek *****************************************************************************/
6 1.1.1.6.2.2 jdolecek
7 1.1.1.6.2.2 jdolecek /*
8 1.1.1.6.2.2 jdolecek * Copyright (C) 2000 - 2017, Intel Corp.
9 1.1.1.6.2.2 jdolecek * All rights reserved.
10 1.1.1.6.2.2 jdolecek *
11 1.1.1.6.2.2 jdolecek * Redistribution and use in source and binary forms, with or without
12 1.1.1.6.2.2 jdolecek * modification, are permitted provided that the following conditions
13 1.1.1.6.2.2 jdolecek * are met:
14 1.1.1.6.2.2 jdolecek * 1. Redistributions of source code must retain the above copyright
15 1.1.1.6.2.2 jdolecek * notice, this list of conditions, and the following disclaimer,
16 1.1.1.6.2.2 jdolecek * without modification.
17 1.1.1.6.2.2 jdolecek * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 1.1.1.6.2.2 jdolecek * substantially similar to the "NO WARRANTY" disclaimer below
19 1.1.1.6.2.2 jdolecek * ("Disclaimer") and any redistribution must be conditioned upon
20 1.1.1.6.2.2 jdolecek * including a substantially similar Disclaimer requirement for further
21 1.1.1.6.2.2 jdolecek * binary redistribution.
22 1.1.1.6.2.2 jdolecek * 3. Neither the names of the above-listed copyright holders nor the names
23 1.1.1.6.2.2 jdolecek * of any contributors may be used to endorse or promote products derived
24 1.1.1.6.2.2 jdolecek * from this software without specific prior written permission.
25 1.1.1.6.2.2 jdolecek *
26 1.1.1.6.2.2 jdolecek * Alternatively, this software may be distributed under the terms of the
27 1.1.1.6.2.2 jdolecek * GNU General Public License ("GPL") version 2 as published by the Free
28 1.1.1.6.2.2 jdolecek * Software Foundation.
29 1.1.1.6.2.2 jdolecek *
30 1.1.1.6.2.2 jdolecek * NO WARRANTY
31 1.1.1.6.2.2 jdolecek * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 1.1.1.6.2.2 jdolecek * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 1.1.1.6.2.2 jdolecek * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 1.1.1.6.2.2 jdolecek * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 1.1.1.6.2.2 jdolecek * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 1.1.1.6.2.2 jdolecek * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 1.1.1.6.2.2 jdolecek * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 1.1.1.6.2.2 jdolecek * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 1.1.1.6.2.2 jdolecek * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 1.1.1.6.2.2 jdolecek * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 1.1.1.6.2.2 jdolecek * POSSIBILITY OF SUCH DAMAGES.
42 1.1.1.6.2.2 jdolecek */
43 1.1.1.6.2.2 jdolecek
44 1.1.1.6.2.2 jdolecek #include "aslcompiler.h"
45 1.1.1.6.2.2 jdolecek #include <actables.h>
46 1.1.1.6.2.2 jdolecek #include <acapps.h>
47 1.1.1.6.2.2 jdolecek
48 1.1.1.6.2.2 jdolecek #define _COMPONENT ACPI_COMPILER
49 1.1.1.6.2.2 jdolecek ACPI_MODULE_NAME ("aslascii")
50 1.1.1.6.2.2 jdolecek
51 1.1.1.6.2.2 jdolecek
52 1.1.1.6.2.2 jdolecek /* Local prototypes */
53 1.1.1.6.2.2 jdolecek
54 1.1.1.6.2.2 jdolecek static void
55 1.1.1.6.2.2 jdolecek FlConsumeAnsiComment (
56 1.1.1.6.2.2 jdolecek FILE *Handle,
57 1.1.1.6.2.2 jdolecek ASL_FILE_STATUS *Status);
58 1.1.1.6.2.2 jdolecek
59 1.1.1.6.2.2 jdolecek static void
60 1.1.1.6.2.2 jdolecek FlConsumeNewComment (
61 1.1.1.6.2.2 jdolecek FILE *Handle,
62 1.1.1.6.2.2 jdolecek ASL_FILE_STATUS *Status);
63 1.1.1.6.2.2 jdolecek
64 1.1.1.6.2.2 jdolecek
65 1.1.1.6.2.2 jdolecek /*******************************************************************************
66 1.1.1.6.2.2 jdolecek *
67 1.1.1.6.2.2 jdolecek * FUNCTION: FlIsFileAsciiSource
68 1.1.1.6.2.2 jdolecek *
69 1.1.1.6.2.2 jdolecek * PARAMETERS: Filename - Full input filename
70 1.1.1.6.2.2 jdolecek * DisplayErrors - TRUE if error messages desired
71 1.1.1.6.2.2 jdolecek *
72 1.1.1.6.2.2 jdolecek * RETURN: Status
73 1.1.1.6.2.2 jdolecek *
74 1.1.1.6.2.2 jdolecek * DESCRIPTION: Verify that the input file is entirely ASCII. Ignores characters
75 1.1.1.6.2.2 jdolecek * within comments. Note: does not handle nested comments and does
76 1.1.1.6.2.2 jdolecek * not handle comment delimiters within string literals. However,
77 1.1.1.6.2.2 jdolecek * on the rare chance this happens and an invalid character is
78 1.1.1.6.2.2 jdolecek * missed, the parser will catch the error by failing in some
79 1.1.1.6.2.2 jdolecek * spectactular manner.
80 1.1.1.6.2.2 jdolecek *
81 1.1.1.6.2.2 jdolecek ******************************************************************************/
82 1.1.1.6.2.2 jdolecek
83 1.1.1.6.2.2 jdolecek ACPI_STATUS
84 1.1.1.6.2.2 jdolecek FlIsFileAsciiSource (
85 1.1.1.6.2.2 jdolecek char *Filename,
86 1.1.1.6.2.2 jdolecek BOOLEAN DisplayErrors)
87 1.1.1.6.2.2 jdolecek {
88 1.1.1.6.2.2 jdolecek UINT8 Byte;
89 1.1.1.6.2.2 jdolecek UINT32 BadBytes = 0;
90 1.1.1.6.2.2 jdolecek BOOLEAN OpeningComment = FALSE;
91 1.1.1.6.2.2 jdolecek ASL_FILE_STATUS Status;
92 1.1.1.6.2.2 jdolecek FILE *Handle;
93 1.1.1.6.2.2 jdolecek
94 1.1.1.6.2.2 jdolecek
95 1.1.1.6.2.2 jdolecek /* Open file in text mode so file offset is always accurate */
96 1.1.1.6.2.2 jdolecek
97 1.1.1.6.2.2 jdolecek Handle = fopen (Filename, "rb");
98 1.1.1.6.2.2 jdolecek if (!Handle)
99 1.1.1.6.2.2 jdolecek {
100 1.1.1.6.2.2 jdolecek perror ("Could not open input file");
101 1.1.1.6.2.2 jdolecek return (AE_ERROR);
102 1.1.1.6.2.2 jdolecek }
103 1.1.1.6.2.2 jdolecek
104 1.1.1.6.2.2 jdolecek Status.Line = 1;
105 1.1.1.6.2.2 jdolecek Status.Offset = 0;
106 1.1.1.6.2.2 jdolecek
107 1.1.1.6.2.2 jdolecek /* Read the entire file */
108 1.1.1.6.2.2 jdolecek
109 1.1.1.6.2.2 jdolecek while (fread (&Byte, 1, 1, Handle) == 1)
110 1.1.1.6.2.2 jdolecek {
111 1.1.1.6.2.2 jdolecek /* Ignore comment fields (allow non-ascii within) */
112 1.1.1.6.2.2 jdolecek
113 1.1.1.6.2.2 jdolecek if (OpeningComment)
114 1.1.1.6.2.2 jdolecek {
115 1.1.1.6.2.2 jdolecek /* Check for second comment open delimiter */
116 1.1.1.6.2.2 jdolecek
117 1.1.1.6.2.2 jdolecek if (Byte == '*')
118 1.1.1.6.2.2 jdolecek {
119 1.1.1.6.2.2 jdolecek FlConsumeAnsiComment (Handle, &Status);
120 1.1.1.6.2.2 jdolecek }
121 1.1.1.6.2.2 jdolecek
122 1.1.1.6.2.2 jdolecek if (Byte == '/')
123 1.1.1.6.2.2 jdolecek {
124 1.1.1.6.2.2 jdolecek FlConsumeNewComment (Handle, &Status);
125 1.1.1.6.2.2 jdolecek }
126 1.1.1.6.2.2 jdolecek
127 1.1.1.6.2.2 jdolecek /* Reset */
128 1.1.1.6.2.2 jdolecek
129 1.1.1.6.2.2 jdolecek OpeningComment = FALSE;
130 1.1.1.6.2.2 jdolecek }
131 1.1.1.6.2.2 jdolecek else if (Byte == '/')
132 1.1.1.6.2.2 jdolecek {
133 1.1.1.6.2.2 jdolecek OpeningComment = TRUE;
134 1.1.1.6.2.2 jdolecek }
135 1.1.1.6.2.2 jdolecek
136 1.1.1.6.2.2 jdolecek /* Check for an ASCII character */
137 1.1.1.6.2.2 jdolecek
138 1.1.1.6.2.2 jdolecek if (!ACPI_IS_ASCII (Byte))
139 1.1.1.6.2.2 jdolecek {
140 1.1.1.6.2.2 jdolecek if ((BadBytes < 10) && (DisplayErrors))
141 1.1.1.6.2.2 jdolecek {
142 1.1.1.6.2.2 jdolecek AcpiOsPrintf (
143 1.1.1.6.2.2 jdolecek "Found non-ASCII character in source text: "
144 1.1.1.6.2.2 jdolecek "0x%2.2X in line %u, file offset 0x%2.2X\n",
145 1.1.1.6.2.2 jdolecek Byte, Status.Line, Status.Offset);
146 1.1.1.6.2.2 jdolecek }
147 1.1.1.6.2.2 jdolecek BadBytes++;
148 1.1.1.6.2.2 jdolecek }
149 1.1.1.6.2.2 jdolecek
150 1.1.1.6.2.2 jdolecek /* Ensure character is either printable or a "space" char */
151 1.1.1.6.2.2 jdolecek
152 1.1.1.6.2.2 jdolecek else if (!isprint (Byte) && !isspace (Byte))
153 1.1.1.6.2.2 jdolecek {
154 1.1.1.6.2.2 jdolecek if ((BadBytes < 10) && (DisplayErrors))
155 1.1.1.6.2.2 jdolecek {
156 1.1.1.6.2.2 jdolecek AcpiOsPrintf (
157 1.1.1.6.2.2 jdolecek "Found invalid character in source text: "
158 1.1.1.6.2.2 jdolecek "0x%2.2X in line %u, file offset 0x%2.2X\n",
159 1.1.1.6.2.2 jdolecek Byte, Status.Line, Status.Offset);
160 1.1.1.6.2.2 jdolecek }
161 1.1.1.6.2.2 jdolecek BadBytes++;
162 1.1.1.6.2.2 jdolecek }
163 1.1.1.6.2.2 jdolecek
164 1.1.1.6.2.2 jdolecek /* Update line counter as necessary */
165 1.1.1.6.2.2 jdolecek
166 1.1.1.6.2.2 jdolecek if (Byte == 0x0A)
167 1.1.1.6.2.2 jdolecek {
168 1.1.1.6.2.2 jdolecek Status.Line++;
169 1.1.1.6.2.2 jdolecek }
170 1.1.1.6.2.2 jdolecek
171 1.1.1.6.2.2 jdolecek Status.Offset++;
172 1.1.1.6.2.2 jdolecek }
173 1.1.1.6.2.2 jdolecek
174 1.1.1.6.2.2 jdolecek fclose (Handle);
175 1.1.1.6.2.2 jdolecek
176 1.1.1.6.2.2 jdolecek /* Were there any non-ASCII characters in the file? */
177 1.1.1.6.2.2 jdolecek
178 1.1.1.6.2.2 jdolecek if (BadBytes)
179 1.1.1.6.2.2 jdolecek {
180 1.1.1.6.2.2 jdolecek fprintf (stderr,
181 1.1.1.6.2.2 jdolecek "File appears to be binary: found %u non-ASCII characters, disassembling\n",
182 1.1.1.6.2.2 jdolecek BadBytes);
183 1.1.1.6.2.2 jdolecek if (DisplayErrors)
184 1.1.1.6.2.2 jdolecek {
185 1.1.1.6.2.2 jdolecek AcpiOsPrintf (
186 1.1.1.6.2.2 jdolecek "Total %u invalid characters found in input source text, "
187 1.1.1.6.2.2 jdolecek "could be a binary file\n", BadBytes);
188 1.1.1.6.2.2 jdolecek AslError (ASL_ERROR, ASL_MSG_NON_ASCII, NULL, Filename);
189 1.1.1.6.2.2 jdolecek }
190 1.1.1.6.2.2 jdolecek
191 1.1.1.6.2.2 jdolecek return (AE_BAD_CHARACTER);
192 1.1.1.6.2.2 jdolecek }
193 1.1.1.6.2.2 jdolecek
194 1.1.1.6.2.2 jdolecek /* File is OK (100% ASCII) */
195 1.1.1.6.2.2 jdolecek
196 1.1.1.6.2.2 jdolecek return (AE_OK);
197 1.1.1.6.2.2 jdolecek }
198 1.1.1.6.2.2 jdolecek
199 1.1.1.6.2.2 jdolecek
200 1.1.1.6.2.2 jdolecek /*******************************************************************************
201 1.1.1.6.2.2 jdolecek *
202 1.1.1.6.2.2 jdolecek * FUNCTION: FlConsumeAnsiComment
203 1.1.1.6.2.2 jdolecek *
204 1.1.1.6.2.2 jdolecek * PARAMETERS: Handle - Open input file
205 1.1.1.6.2.2 jdolecek * Status - File current status struct
206 1.1.1.6.2.2 jdolecek *
207 1.1.1.6.2.2 jdolecek * RETURN: Number of lines consumed
208 1.1.1.6.2.2 jdolecek *
209 1.1.1.6.2.2 jdolecek * DESCRIPTION: Step over a normal slash-star type comment
210 1.1.1.6.2.2 jdolecek *
211 1.1.1.6.2.2 jdolecek ******************************************************************************/
212 1.1.1.6.2.2 jdolecek
213 1.1.1.6.2.2 jdolecek static void
214 1.1.1.6.2.2 jdolecek FlConsumeAnsiComment (
215 1.1.1.6.2.2 jdolecek FILE *Handle,
216 1.1.1.6.2.2 jdolecek ASL_FILE_STATUS *Status)
217 1.1.1.6.2.2 jdolecek {
218 1.1.1.6.2.2 jdolecek UINT8 Byte;
219 1.1.1.6.2.2 jdolecek BOOLEAN ClosingComment = FALSE;
220 1.1.1.6.2.2 jdolecek
221 1.1.1.6.2.2 jdolecek
222 1.1.1.6.2.2 jdolecek while (fread (&Byte, 1, 1, Handle) == 1)
223 1.1.1.6.2.2 jdolecek {
224 1.1.1.6.2.2 jdolecek /* Scan until comment close is found */
225 1.1.1.6.2.2 jdolecek
226 1.1.1.6.2.2 jdolecek if (ClosingComment)
227 1.1.1.6.2.2 jdolecek {
228 1.1.1.6.2.2 jdolecek if (Byte == '/')
229 1.1.1.6.2.2 jdolecek {
230 1.1.1.6.2.2 jdolecek Status->Offset++;
231 1.1.1.6.2.2 jdolecek return;
232 1.1.1.6.2.2 jdolecek }
233 1.1.1.6.2.2 jdolecek
234 1.1.1.6.2.2 jdolecek if (Byte != '*')
235 1.1.1.6.2.2 jdolecek {
236 1.1.1.6.2.2 jdolecek /* Reset */
237 1.1.1.6.2.2 jdolecek
238 1.1.1.6.2.2 jdolecek ClosingComment = FALSE;
239 1.1.1.6.2.2 jdolecek }
240 1.1.1.6.2.2 jdolecek }
241 1.1.1.6.2.2 jdolecek else if (Byte == '*')
242 1.1.1.6.2.2 jdolecek {
243 1.1.1.6.2.2 jdolecek ClosingComment = TRUE;
244 1.1.1.6.2.2 jdolecek }
245 1.1.1.6.2.2 jdolecek
246 1.1.1.6.2.2 jdolecek /* Maintain line count */
247 1.1.1.6.2.2 jdolecek
248 1.1.1.6.2.2 jdolecek if (Byte == 0x0A)
249 1.1.1.6.2.2 jdolecek {
250 1.1.1.6.2.2 jdolecek Status->Line++;
251 1.1.1.6.2.2 jdolecek }
252 1.1.1.6.2.2 jdolecek
253 1.1.1.6.2.2 jdolecek Status->Offset++;
254 1.1.1.6.2.2 jdolecek }
255 1.1.1.6.2.2 jdolecek }
256 1.1.1.6.2.2 jdolecek
257 1.1.1.6.2.2 jdolecek
258 1.1.1.6.2.2 jdolecek /*******************************************************************************
259 1.1.1.6.2.2 jdolecek *
260 1.1.1.6.2.2 jdolecek * FUNCTION: FlConsumeNewComment
261 1.1.1.6.2.2 jdolecek *
262 1.1.1.6.2.2 jdolecek * PARAMETERS: Handle - Open input file
263 1.1.1.6.2.2 jdolecek * Status - File current status struct
264 1.1.1.6.2.2 jdolecek *
265 1.1.1.6.2.2 jdolecek * RETURN: Number of lines consumed
266 1.1.1.6.2.2 jdolecek *
267 1.1.1.6.2.2 jdolecek * DESCRIPTION: Step over a slash-slash type of comment
268 1.1.1.6.2.2 jdolecek *
269 1.1.1.6.2.2 jdolecek ******************************************************************************/
270 1.1.1.6.2.2 jdolecek
271 1.1.1.6.2.2 jdolecek static void
272 1.1.1.6.2.2 jdolecek FlConsumeNewComment (
273 1.1.1.6.2.2 jdolecek FILE *Handle,
274 1.1.1.6.2.2 jdolecek ASL_FILE_STATUS *Status)
275 1.1.1.6.2.2 jdolecek {
276 1.1.1.6.2.2 jdolecek UINT8 Byte;
277 1.1.1.6.2.2 jdolecek
278 1.1.1.6.2.2 jdolecek
279 1.1.1.6.2.2 jdolecek while (fread (&Byte, 1, 1, Handle) == 1)
280 1.1.1.6.2.2 jdolecek {
281 1.1.1.6.2.2 jdolecek Status->Offset++;
282 1.1.1.6.2.2 jdolecek
283 1.1.1.6.2.2 jdolecek /* Comment ends at newline */
284 1.1.1.6.2.2 jdolecek
285 1.1.1.6.2.2 jdolecek if (Byte == 0x0A)
286 1.1.1.6.2.2 jdolecek {
287 1.1.1.6.2.2 jdolecek Status->Line++;
288 1.1.1.6.2.2 jdolecek return;
289 1.1.1.6.2.2 jdolecek }
290 1.1.1.6.2.2 jdolecek }
291 1.1.1.6.2.2 jdolecek }
292