1 /******************************************************************************
3 * Module Name: asremove - Source conversion - removal functions
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2021, Intel Corp.
12 * All rights reserved.
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
37 * The above copyright and patent license is granted only if the following
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
72 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
80 * 4. Disclaimer and Export Compliance
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
150 *****************************************************************************/
154 /* Local prototypes */
163 /******************************************************************************
165 * FUNCTION: AsRemoveStatement
167 * DESCRIPTION: Remove all statements that contain the given keyword.
168 * Limitations: Removes text from the start of the line that
169 * contains the keyword to the next semicolon. Currently
170 * doesn't ignore comments.
172 ******************************************************************************/
185 KeywordLength = strlen (Keyword);
191 SubString = strstr (SubBuffer, Keyword);
195 SubBuffer = SubString;
197 if ((Type == REPLACE_WHOLE_WORD) &&
198 (!AsMatchExactWord (SubString, KeywordLength)))
204 /* Find start of this line */
206 while (*SubString != '\n')
212 /* Find end of this statement */
214 SubBuffer = AsSkipPastChar (SubBuffer, ';');
220 /* Find end of this line */
222 SubBuffer = AsSkipPastChar (SubBuffer, '\n');
228 /* If next line is blank, remove it too */
230 if (*SubBuffer == '\n')
235 /* Remove the lines */
237 SubBuffer = AsRemoveData (SubString, SubBuffer);
243 /******************************************************************************
245 * FUNCTION: AsRemoveConditionalCompile
247 * DESCRIPTION: Remove a "#ifdef" statement, and all text that it encompasses.
248 * Limitations: cannot handle nested ifdefs.
250 ******************************************************************************/
253 AsRemoveConditionalCompile (
266 KeywordLength = strlen (Keyword);
271 SubBuffer = strstr (SubString, Keyword);
278 * Check for translation escape string -- means to ignore
279 * blocks of code while replacing
281 if (Gbl_IgnoreTranslationEscapes)
287 Comment = strstr (SubString, AS_START_IGNORE);
291 (Comment < SubBuffer))
293 SubString = strstr (Comment, AS_STOP_IGNORE);
303 /* Check for ordinary comment */
305 Comment = strstr (SubString, "/*");
308 (Comment < SubBuffer))
310 SubString = strstr (Comment, "*/");
320 SubString = SubBuffer;
321 if (!AsMatchExactWord (SubString, KeywordLength))
327 /* Find start of this line */
329 while (*SubString != '\n' && (SubString > Buffer))
336 /* Find the "#ifxxxx" */
338 IfPtr = strstr (SubString, "#if");
344 if (IfPtr > SubBuffer)
346 /* Not the right #if */
348 SubString = SubBuffer + strlen (Keyword);
352 /* Find closing #endif or #else */
354 EndifPtr = strstr (SubBuffer, "#endif");
357 /* There has to be an #endif */
362 ElsePtr = strstr (SubBuffer, "#else");
364 (EndifPtr > ElsePtr))
366 /* This #ifdef contains an #else clause */
367 /* Find end of this line */
369 SubBuffer = AsSkipPastChar (ElsePtr, '\n');
375 /* Remove the #ifdef .... #else code */
377 AsRemoveData (SubString, SubBuffer);
379 /* Next, we will remove the #endif statement */
381 EndifPtr = strstr (SubString, "#endif");
384 /* There has to be an #endif */
389 SubString = EndifPtr;
392 /* Remove the ... #endif part */
393 /* Find end of this line */
395 SubBuffer = AsSkipPastChar (EndifPtr, '\n');
401 /* Remove the lines */
403 (void) AsRemoveData (SubString, SubBuffer);
408 #ifdef _OBSOLETE_FUNCTIONS
409 /******************************************************************************
411 * FUNCTION: AsRemoveMacro
413 * DESCRIPTION: Remove every line that contains the keyword. Does not
416 ******************************************************************************/
418 NOTE: This function is no longer used and is commented out for now.
420 Also, it appears to have one or more bugs in it. It can incorrectly remove
421 lines of code, producing some garbage.
438 SubString = strstr (SubBuffer, Keyword);
442 SubBuffer = SubString;
444 /* Find start of the macro parameters */
446 while (*SubString != '(')
452 /* Remove the macro name and opening paren */
454 SubString = AsRemoveData (SubBuffer, SubString);
459 if (*SubString == '(')
463 else if (*SubString == ')')
476 /* Remove the closing paren */
478 SubBuffer = AsRemoveData (SubString-1, SubString);
484 /******************************************************************************
486 * FUNCTION: AsRemoveLine
488 * DESCRIPTION: Remove every line that contains the keyword. Does not
491 ******************************************************************************/
507 SubString = strstr (SubBuffer, Keyword);
511 SubBuffer = SubString;
513 /* Find start of this line */
515 while (*SubString != '\n')
521 /* Find end of this line */
523 SubBuffer = AsSkipPastChar (SubBuffer, '\n');
529 /* Remove the line */
531 SubBuffer = AsRemoveData (SubString, SubBuffer);
537 /******************************************************************************
539 * FUNCTION: AsReduceTypedefs
541 * DESCRIPTION: Eliminate certain typedefs
543 ******************************************************************************/
561 SubString = strstr (SubBuffer, Keyword);
565 SubSubString = SubString + strlen (Keyword);
569 while (strchr(" \t\r\n", *SubSubString))
576 while (!strchr(" \t\r\n", *SubSubString))
583 while (strchr(" \t\r\n", *SubSubString))
588 if (*SubSubString == '{')
590 /* Remove the typedef itself */
592 SubBuffer = SubString + strlen ("typedef") + 1;
593 (void) AsRemoveData (SubString, SubBuffer);
595 /* Find the opening brace of the struct or union */
597 while (*SubString != '{')
603 /* Find the closing brace. Handles nested braces */
608 if (*SubString == '{')
612 else if (*SubString == '}')
625 /* Remove an extra line feed if present */
627 if (!strncmp (SubString - 3, "\n\n", 2))
629 *(SubString -2) = '}';
633 /* Find the end of the typedef name */
635 SubBuffer = AsSkipUntilChar (SubString, ';');
637 /* And remove the typedef name */
639 SubBuffer = AsRemoveData (SubString, SubBuffer);
643 /* Skip the entire definition */
645 SubString = strchr (SubString, ';') + 1;
646 SubBuffer = SubString;
653 /******************************************************************************
655 * FUNCTION: AsRemoveEmptyBlocks
657 * DESCRIPTION: Remove any C blocks (e.g., if {}) that contain no code. This
658 * can happen as a result of removing lines such as DEBUG_PRINT.
660 ******************************************************************************/
663 AsRemoveEmptyBlocks (
669 BOOLEAN EmptyBlock = TRUE;
670 BOOLEAN AnotherPassRequired = TRUE;
671 UINT32 BlockCount = 0;
674 while (AnotherPassRequired)
677 AnotherPassRequired = FALSE;
681 if (*SubBuffer == '{')
683 BlockStart = SubBuffer;
687 while (*SubBuffer != '}')
689 if ((*SubBuffer != ' ') &&
690 (*SubBuffer != '\n'))
701 /* Find start of the first line of the block */
703 while (*BlockStart != '\n')
708 /* Find end of the last line of the block */
710 SubBuffer = AsSkipUntilChar (SubBuffer, '\n');
716 /* Remove the block */
718 SubBuffer = AsRemoveData (BlockStart, SubBuffer);
720 AnotherPassRequired = TRUE;
731 Gbl_MadeChanges = TRUE;
732 AsPrint ("Code blocks deleted", BlockCount, Filename);
737 /******************************************************************************
739 * FUNCTION: AsRemoveDebugMacros
741 * DESCRIPTION: Remove all "Debug" macros -- macros that produce debug output.
743 ******************************************************************************/
746 AsRemoveDebugMacros (
749 AsRemoveConditionalCompile (Buffer, "ACPI_DEBUG_OUTPUT");
751 AsRemoveStatement (Buffer, "ACPI_DEBUG_PRINT", REPLACE_WHOLE_WORD);
752 AsRemoveStatement (Buffer, "ACPI_DEBUG_PRINT_RAW", REPLACE_WHOLE_WORD);
753 AsRemoveStatement (Buffer, "DEBUG_EXEC", REPLACE_WHOLE_WORD);
754 AsRemoveStatement (Buffer, "FUNCTION_ENTRY", REPLACE_WHOLE_WORD);
755 AsRemoveStatement (Buffer, "PROC_NAME", REPLACE_WHOLE_WORD);
756 AsRemoveStatement (Buffer, "FUNCTION_TRACE", REPLACE_SUBSTRINGS);
757 AsRemoveStatement (Buffer, "DUMP_", REPLACE_SUBSTRINGS);
759 AsReplaceString ("return_VOID", "return", REPLACE_WHOLE_WORD, Buffer);
760 AsReplaceString ("return_PTR", "return", REPLACE_WHOLE_WORD, Buffer);
761 AsReplaceString ("return_STR", "return", REPLACE_WHOLE_WORD, Buffer);
762 AsReplaceString ("return_ACPI_STATUS", "return", REPLACE_WHOLE_WORD, Buffer);
763 AsReplaceString ("return_acpi_status", "return", REPLACE_WHOLE_WORD, Buffer);
764 AsReplaceString ("return_VALUE", "return", REPLACE_WHOLE_WORD, Buffer);
768 /******************************************************************************
770 * FUNCTION: AsCleanupSpecialMacro
772 * DESCRIPTION: For special macro invocations (invoked without ";" at the end
773 * of the lines), do the following:
774 * 1. Remove spaces appended by indent at the beginning of lines.
775 * 2. Add an empty line between two special macro invocations.
777 ******************************************************************************/
780 AsCleanupSpecialMacro (
796 SubString = strstr (SubBuffer, Keyword);
800 /* Find start of the macro parameters */
802 while (*SubString != '(')
812 if (*SubString == '(')
816 else if (*SubString == ')')
831 /* Find end of the line */
834 while (!NewLine && *SubString)
836 if (*SubString == '\n' && *(SubString - 1) != '\\')
844 /* Find end of the line */
846 if (*SubString == '#' || *SubString == '\n')
851 SubBuffer = SubString;
853 /* Find start of the non-space */
855 while (*SubString == ' ')
860 /* Find end of the line */
862 if (*SubString == '#' || *SubString == '\n')
867 /* Find end of the line */
869 if (*SubString == '/' || *SubString == '*')
871 CommentEnd = strstr (SubString, "*/");
874 SubString = CommentEnd + 2;
879 SubString = AsRemoveData (SubBuffer, SubString);