2 /******************************************************************************
4 * Module Name: ascase - Source conversion - lower/upper case utilities
7 *****************************************************************************/
9 /******************************************************************************
13 * Some or all of this work - Copyright (c) 1999 - 2006, Intel Corp.
14 * All rights reserved.
18 * 2.1. This is your license from Intel Corp. under its intellectual property
19 * rights. You may have additional license terms from the party that provided
20 * you this software, covering your right to use that party's intellectual
23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
24 * copy of the source code appearing in this file ("Covered Code") an
25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
26 * base code distributed originally by Intel ("Original Intel Code") to copy,
27 * make derivatives, distribute, use and display any portion of the Covered
28 * Code in any form, with the right to sublicense such rights; and
30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
31 * license (with the right to sublicense), under only those claims of Intel
32 * patents that are infringed by the Original Intel Code, to make, use, sell,
33 * offer to sell, and import the Covered Code and derivative works thereof
34 * solely to the minimum extent necessary to exercise the above copyright
35 * license, and in no event shall the patent license extend to any additions
36 * to or modifications of the Original Intel Code. No other license or right
37 * is granted directly or by implication, estoppel or otherwise;
39 * The above copyright and patent license is granted only if the following
44 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45 * Redistribution of source code of any substantial portion of the Covered
46 * Code or modification with rights to further distribute source must include
47 * the above Copyright Notice, the above License, this list of Conditions,
48 * and the following Disclaimer and Export Compliance provision. In addition,
49 * Licensee must cause all Covered Code to which Licensee contributes to
50 * contain a file documenting the changes Licensee made to create that Covered
51 * Code and the date of any change. Licensee must include in that file the
52 * documentation of any changes made by any predecessor Licensee. Licensee
53 * must include a prominent statement that the modification is derived,
54 * directly or indirectly, from Original Intel Code.
56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
57 * Redistribution of source code of any substantial portion of the Covered
58 * Code or modification without rights to further distribute source must
59 * include the following Disclaimer and Export Compliance provision in the
60 * documentation and/or other materials provided with distribution. In
61 * addition, Licensee may not authorize further sublicense of source of any
62 * portion of the Covered Code, and must include terms to the effect that the
63 * license from Licensee to its licensee is limited to the intellectual
64 * property embodied in the software Licensee provides to its licensee, and
65 * not to intellectual property embodied in modifications its licensee may
68 * 3.3. Redistribution of Executable. Redistribution in executable form of any
69 * substantial portion of the Covered Code or modification must reproduce the
70 * above Copyright Notice, and the following Disclaimer and Export Compliance
71 * provision in the documentation and/or other materials provided with the
74 * 3.4. Intel retains all right, title, and interest in and to the Original
77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78 * Intel shall be used in advertising or otherwise to promote the sale, use or
79 * other dealings in products derived from or relating to the Covered Code
80 * without prior written authorization from Intel.
82 * 4. Disclaimer and Export Compliance
84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
101 * 4.3. Licensee shall not export, either directly or indirectly, any of this
102 * software or system incorporating such software without first obtaining any
103 * required license or other approval from the U. S. Department of Commerce or
104 * any other agency or department of the United States Government. In the
105 * event Licensee exports any such software from the United States or
106 * re-exports any such software from a foreign destination, Licensee shall
107 * ensure that the distribution and export/re-export of the software is in
108 * compliance with all laws, regulations, orders, or other restrictions of the
109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110 * any of its subsidiaries will export/re-export any technical data, process,
111 * software, or service, directly or indirectly, to any country for which the
112 * United States government or any agency thereof requires an export license,
113 * other governmental approval, or letter of assurance, without first obtaining
114 * such license, approval or letter.
116 *****************************************************************************/
121 /******************************************************************************
123 * FUNCTION: AsLowerCaseString
125 * DESCRIPTION: LowerCase all instances of a target string with a replacement
126 * string. Returns count of the strings replaced.
128 ******************************************************************************/
139 int LowerCaseCount
= 0;
143 TargetLength
= strlen (Target
);
150 /* Find the target string */
152 SubString1
= strstr (SubBuffer
, Target
);
155 return LowerCaseCount
;
159 * Check for translation escape string -- means to ignore
160 * blocks of code while replacing
162 SubString2
= strstr (SubBuffer
, AS_START_IGNORE
);
165 (SubString2
< SubString1
))
167 /* Find end of the escape block starting at "Substring2" */
169 SubString2
= strstr (SubString2
, AS_STOP_IGNORE
);
172 /* Didn't find terminator */
174 return LowerCaseCount
;
177 /* Move buffer to end of escape block and continue */
179 SubBuffer
= SubString2
;
182 /* Do the actual replace if the target was found */
186 if (!AsMatchExactWord (SubString1
, TargetLength
))
188 SubBuffer
= SubString1
+ 1;
192 for (i
= 0; i
< TargetLength
; i
++)
194 SubString1
[i
] = (char) tolower (SubString1
[i
]);
197 SubBuffer
= SubString1
+ TargetLength
;
199 if ((Gbl_WidenDeclarations
) && (!Gbl_StructDefs
))
201 if ((SubBuffer
[0] == ' ') && (SubBuffer
[1] == ' '))
203 AsInsertData (SubBuffer
, " ", 8);
211 return LowerCaseCount
;
215 /******************************************************************************
217 * FUNCTION: AsMixedCaseToUnderscores
219 * DESCRIPTION: Converts mixed case identifiers to underscored identifiers.
222 * ThisUsefullyNamedIdentifier becomes:
224 * this_usefully_named_identifier
226 ******************************************************************************/
229 AsMixedCaseToUnderscores (
233 char *SubBuffer
= Buffer
;
235 char *TokenStart
= NULL
;
237 BOOLEAN HasLowerCase
= FALSE
;
242 /* Ignore whitespace */
244 if (*SubBuffer
== ' ')
246 while (*SubBuffer
== ' ')
251 HasLowerCase
= FALSE
;
257 if ((*SubBuffer
== ',') ||
258 (*SubBuffer
== '>') ||
263 HasLowerCase
= FALSE
;
267 /* Check for quoted string -- ignore */
269 if (*SubBuffer
== '"')
272 while (*SubBuffer
!= '"')
279 /* Handle embedded escape sequences */
281 if (*SubBuffer
== '\\')
291 if (islower (*SubBuffer
))
297 * Check for translation escape string -- means to ignore
298 * blocks of code while replacing
300 if ((SubBuffer
[0] == '/') &&
301 (SubBuffer
[1] == '*') &&
302 (SubBuffer
[2] == '!'))
304 SubBuffer
= strstr (SubBuffer
, "!*/");
312 /* Ignore hex constants */
314 if (SubBuffer
[0] == '0')
316 if ((SubBuffer
[1] == 'x') ||
317 (SubBuffer
[1] == 'X'))
320 while (isxdigit (*SubBuffer
))
328 // OBSOLETE CODE, all quoted strings now completely ignored.
330 /* Ignore format specification fields */
332 if (SubBuffer
[0] == '%')
336 while ((isalnum (*SubBuffer
)) || (*SubBuffer
== '.'))
345 /* Ignore standard escape sequences (\n, \r, etc.) Not Hex or Octal escapes */
347 if (SubBuffer
[0] == '\\')
354 * Ignore identifiers that already contain embedded underscores
355 * These are typically C macros or defines (all upper case)
356 * Note: there are some cases where identifiers have underscores
357 * AcpiGbl_* for example. HasLowerCase flag handles these.
359 if ((*SubBuffer
== '_') && (!HasLowerCase
) && (TokenStart
))
361 /* Check the rest of the identifier for any lower case letters */
363 SubString
= SubBuffer
;
364 while ((isalnum (*SubString
)) || (*SubString
== '_'))
366 if (islower (*SubString
))
373 /* If no lower case letters, we can safely ignore the entire token */
377 SubBuffer
= SubString
;
382 /* A capital letter may indicate the start of a token; save it */
384 if (isupper (SubBuffer
[0]))
386 TokenStart
= SubBuffer
;
390 * Convert each pair of letters that matches the form:
392 * <LowerCase><UpperCase>
394 * <LowerCase><Underscore><LowerCase>
396 else if ((islower (SubBuffer
[0]) || isdigit (SubBuffer
[0])) &&
397 (isupper (SubBuffer
[1])))
399 if (isdigit (SubBuffer
[0]))
401 /* Ignore <UpperCase><Digit><UpperCase> */
402 /* Ignore <Underscore><Digit><UpperCase> */
404 if (isupper (*(SubBuffer
-1)) ||
405 *(SubBuffer
-1) == '_')
413 * Matched the pattern.
414 * Find the end of this identifier (token)
416 TokenEnd
= SubBuffer
;
417 while ((isalnum (*TokenEnd
)) || (*TokenEnd
== '_'))
422 /* Force the UpperCase letter (#2) to lower case */
424 Gbl_MadeChanges
= TRUE
;
425 SubBuffer
[1] = (char) tolower (SubBuffer
[1]);
427 SubString
= TokenEnd
;
430 while (*SubString
!= '\n')
433 * If we have at least two trailing spaces, we can get rid of
434 * one to make up for the newly inserted underscore. This will
435 * help preserve the alignment of the text
437 if ((SubString
[0] == ' ') &&
438 (SubString
[1] == ' '))
440 Length
= SubString
- SubBuffer
- 2;
449 Length
= strlen (&SubBuffer
[1]);
452 memmove (&SubBuffer
[2], &SubBuffer
[1], Length
+ 1);
456 /* Lower case the leading character of the token */
460 *TokenStart
= (char) tolower (*TokenStart
);
470 /******************************************************************************
472 * FUNCTION: AsLowerCaseIdentifiers
474 * DESCRIPTION: Converts mixed case identifiers to lower case. Leaves comments,
475 * quoted strings, and all-upper-case macros alone.
477 ******************************************************************************/
480 AsLowerCaseIdentifiers (
483 char *SubBuffer
= Buffer
;
489 * Check for translation escape string -- means to ignore
490 * blocks of code while replacing
492 if ((SubBuffer
[0] == '/') &&
493 (SubBuffer
[1] == '*') &&
494 (SubBuffer
[2] == '!'))
496 SubBuffer
= strstr (SubBuffer
, "!*/");
503 /* Ignore comments */
505 if ((SubBuffer
[0] == '/') &&
506 (SubBuffer
[1] == '*'))
508 SubBuffer
= strstr (SubBuffer
, "*/");
517 /* Ignore quoted strings */
519 if ((SubBuffer
[0] == '\"') && (SubBuffer
[1] != '\''))
523 /* Find the closing quote */
527 /* Ignore escaped quote characters */
529 if (SubBuffer
[0] == '\\')
533 else if (SubBuffer
[0] == '\"')
548 * Only lower case if we have an upper followed by a lower
549 * This leaves the all-uppercase things (macros, etc.) intact
551 if ((isupper (SubBuffer
[0])) &&
552 (islower (SubBuffer
[1])))
554 Gbl_MadeChanges
= TRUE
;
555 *SubBuffer
= (char) tolower (*SubBuffer
);
563 /******************************************************************************
565 * FUNCTION: AsUppercaseTokens
567 * DESCRIPTION: Force to uppercase all tokens that begin with the prefix string.
568 * used to convert mixed-case macros and constants to uppercase.
570 ******************************************************************************/
588 SubBuffer
= strstr (SubBuffer
, PrefixString
);
591 TokenEnd
= SubBuffer
;
592 while ((isalnum (*TokenEnd
)) || (*TokenEnd
== '_'))
597 for (i
= 0; i
< (TokenEnd
- SubBuffer
); i
++)
599 if ((islower (SubBuffer
[i
])) &&
600 (isupper (SubBuffer
[i
+1])))
603 SubString
= TokenEnd
;
606 while (*SubString
!= '\n')
608 if ((SubString
[0] == ' ') &&
609 (SubString
[1] == ' '))
611 Length
= SubString
- &SubBuffer
[i
] - 2;
620 Length
= strlen (&SubBuffer
[i
+1]);
623 memmove (&SubBuffer
[i
+2], &SubBuffer
[i
+1], (Length
+1));
624 SubBuffer
[i
+1] = '_';
630 for (i
= 0; i
< (TokenEnd
- SubBuffer
); i
++)
632 SubBuffer
[i
] = (char) toupper (SubBuffer
[i
]);
635 SubBuffer
= TokenEnd
;