l4/pkg/acpica/lib-acpi/src/acpica/tools/acpisrc/asremove.c

   1 /******************************************************************************
   2  *
   3  * Module Name: asremove - Source conversion - removal functions
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2012, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  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
  19  * property rights.
  20  *
  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
  27  *
  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;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  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.
  53  *
  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
  64  * make.
  65  *
  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
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  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.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  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
  88  * PARTICULAR PURPOSE.
  89  *
  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
  97  * LIMITED REMEDY.
  98  *
  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.
 113  *
 114  *****************************************************************************/
 115
 116 #include "acpisrc.h"
 117
 118 /* Local prototypes */
 119
 120 void
 121 AsRemoveStatement (
 122     char                    *Buffer,
 123     char                    *Keyword,
 124     UINT32                  Type);
 125
 126
 127 /******************************************************************************
 128  *
 129  * FUNCTION:    AsRemoveStatement
 130  *
 131  * DESCRIPTION: Remove all statements that contain the given keyword.
 132  *              Limitations:  Removes text from the start of the line that
 133  *              contains the keyword to the next semicolon. Currently
 134  *              doesn't ignore comments.
 135  *
 136  ******************************************************************************/
 137
 138 void
 139 AsRemoveStatement (
 140     char                    *Buffer,
 141     char                    *Keyword,
 142     UINT32                  Type)
 143 {
 144     char                    *SubString;
 145     char                    *SubBuffer;
 146     int                     KeywordLength;
 147
 148
 149     KeywordLength = strlen (Keyword);
 150     SubBuffer = Buffer;
 151     SubString = Buffer;
 152
 153
 154     while (SubString)
 155     {
 156         SubString = strstr (SubBuffer, Keyword);
 157
 158         if (SubString)
 159         {
 160             SubBuffer = SubString;
 161
 162             if ((Type == REPLACE_WHOLE_WORD) &&
 163                 (!AsMatchExactWord (SubString, KeywordLength)))
 164             {
 165                 SubBuffer++;
 166                 continue;
 167             }
 168
 169             /* Find start of this line */
 170
 171             while (*SubString != '\n')
 172             {
 173                 SubString--;
 174             }
 175             SubString++;
 176
 177             /* Find end of this statement */
 178
 179             SubBuffer = AsSkipPastChar (SubBuffer, ';');
 180             if (!SubBuffer)
 181             {
 182                 return;
 183             }
 184
 185             /* Find end of this line */
 186
 187             SubBuffer = AsSkipPastChar (SubBuffer, '\n');
 188             if (!SubBuffer)
 189             {
 190                 return;
 191             }
 192
 193             /* If next line is blank, remove it too */
 194
 195             if (*SubBuffer == '\n')
 196             {
 197                 SubBuffer++;
 198             }
 199
 200             /* Remove the lines */
 201
 202             SubBuffer = AsRemoveData (SubString, SubBuffer);
 203         }
 204     }
 205 }
 206
 207
 208 /******************************************************************************
 209  *
 210  * FUNCTION:    AsRemoveConditionalCompile
 211  *
 212  * DESCRIPTION: Remove a "#ifdef" statement, and all text that it encompasses.
 213  *              Limitations: cannot handle nested ifdefs.
 214  *
 215  ******************************************************************************/
 216
 217 void
 218 AsRemoveConditionalCompile (
 219     char                    *Buffer,
 220     char                    *Keyword)
 221 {
 222     char                    *SubString;
 223     char                    *SubBuffer;
 224     char                    *IfPtr;
 225     char                    *EndifPtr;
 226     char                    *ElsePtr;
 227     char                    *Comment;
 228     int                     KeywordLength;
 229
 230
 231     KeywordLength = strlen (Keyword);
 232     SubBuffer = Buffer;
 233     SubString = Buffer;
 234
 235
 236     while (SubString)
 237     {
 238         SubBuffer = strstr (SubString, Keyword);
 239         if (!SubBuffer)
 240         {
 241             return;
 242         }
 243
 244         /*
 245          * Check for translation escape string -- means to ignore
 246          * blocks of code while replacing
 247          */
 248         Comment = strstr (SubString, AS_START_IGNORE);
 249
 250         if ((Comment) &&
 251             (Comment < SubBuffer))
 252         {
 253             SubString = strstr (Comment, AS_STOP_IGNORE);
 254             if (!SubString)
 255             {
 256                 return;
 257             }
 258
 259             SubString += 3;
 260             continue;
 261         }
 262
 263         /* Check for ordinary comment */
 264
 265         Comment = strstr (SubString, "/*");
 266
 267         if ((Comment) &&
 268             (Comment < SubBuffer))
 269         {
 270             SubString = strstr (Comment, "*/");
 271             if (!SubString)
 272             {
 273                 return;
 274             }
 275
 276             SubString += 2;
 277             continue;
 278         }
 279
 280         SubString = SubBuffer;
 281         if (!AsMatchExactWord (SubString, KeywordLength))
 282         {
 283             SubString++;
 284             continue;
 285         }
 286
 287         /* Find start of this line */
 288
 289         while (*SubString != '\n' && (SubString > Buffer))
 290         {
 291             SubString--;
 292         }
 293         SubString++;
 294
 295         /* Find the "#ifxxxx" */
 296
 297         IfPtr = strstr (SubString, "#if");
 298         if (!IfPtr)
 299         {
 300             return;
 301         }
 302
 303         if (IfPtr > SubBuffer)
 304         {
 305             /* Not the right #if */
 306
 307             SubString = SubBuffer + strlen (Keyword);
 308             continue;
 309         }
 310
 311         /* Find closing #endif or #else */
 312
 313         EndifPtr = strstr (SubBuffer, "#endif");
 314         if (!EndifPtr)
 315         {
 316             /* There has to be an #endif */
 317
 318             return;
 319         }
 320
 321         ElsePtr = strstr (SubBuffer, "#else");
 322         if ((ElsePtr) &&
 323             (EndifPtr > ElsePtr))
 324         {
 325             /* This #ifdef contains an #else clause */
 326             /* Find end of this line */
 327
 328             SubBuffer = AsSkipPastChar (ElsePtr, '\n');
 329             if (!SubBuffer)
 330             {
 331                 return;
 332             }
 333
 334             /* Remove the #ifdef .... #else code */
 335
 336             AsRemoveData (SubString, SubBuffer);
 337
 338             /* Next, we will remove the #endif statement */
 339
 340             EndifPtr = strstr (SubString, "#endif");
 341             if (!EndifPtr)
 342             {
 343                 /* There has to be an #endif */
 344
 345                 return;
 346             }
 347
 348             SubString = EndifPtr;
 349         }
 350
 351         /* Remove the ... #endif part */
 352         /* Find end of this line */
 353
 354         SubBuffer = AsSkipPastChar (EndifPtr, '\n');
 355         if (!SubBuffer)
 356         {
 357             return;
 358         }
 359
 360         /* Remove the lines */
 361
 362         SubBuffer = AsRemoveData (SubString, SubBuffer);
 363     }
 364 }
 365
 366
 367 /******************************************************************************
 368  *
 369  * FUNCTION:    AsRemoveMacro
 370  *
 371  * DESCRIPTION: Remove every line that contains the keyword. Does not
 372  *              skip comments.
 373  *
 374  ******************************************************************************/
 375
 376 void
 377 AsRemoveMacro (
 378     char                    *Buffer,
 379     char                    *Keyword)
 380 {
 381     char                    *SubString;
 382     char                    *SubBuffer;
 383     int                     NestLevel;
 384
 385
 386     SubBuffer = Buffer;
 387     SubString = Buffer;
 388
 389
 390     while (SubString)
 391     {
 392         SubString = strstr (SubBuffer, Keyword);
 393
 394         if (SubString)
 395         {
 396             SubBuffer = SubString;
 397
 398             /* Find start of the macro parameters */
 399
 400             while (*SubString != '(')
 401             {
 402                 SubString++;
 403             }
 404             SubString++;
 405
 406             /* Remove the macro name and opening paren */
 407
 408             SubString = AsRemoveData (SubBuffer, SubString);
 409
 410             NestLevel = 1;
 411             while (*SubString)
 412             {
 413                 if (*SubString == '(')
 414                 {
 415                     NestLevel++;
 416                 }
 417                 else if (*SubString == ')')
 418                 {
 419                     NestLevel--;
 420                 }
 421
 422                 SubString++;
 423
 424                 if (NestLevel == 0)
 425                 {
 426                     break;
 427                 }
 428             }
 429
 430             /* Remove the closing paren */
 431
 432             SubBuffer = AsRemoveData (SubString-1, SubString);
 433         }
 434     }
 435 }
 436
 437
 438 /******************************************************************************
 439  *
 440  * FUNCTION:    AsRemoveLine
 441  *
 442  * DESCRIPTION: Remove every line that contains the keyword. Does not
 443  *              skip comments.
 444  *
 445  ******************************************************************************/
 446
 447 void
 448 AsRemoveLine (
 449     char                    *Buffer,
 450     char                    *Keyword)
 451 {
 452     char                    *SubString;
 453     char                    *SubBuffer;
 454
 455
 456     SubBuffer = Buffer;
 457     SubString = Buffer;
 458
 459
 460     while (SubString)
 461     {
 462         SubString = strstr (SubBuffer, Keyword);
 463
 464         if (SubString)
 465         {
 466             SubBuffer = SubString;
 467
 468             /* Find start of this line */
 469
 470             while (*SubString != '\n')
 471             {
 472                 SubString--;
 473             }
 474             SubString++;
 475
 476             /* Find end of this line */
 477
 478             SubBuffer = AsSkipPastChar (SubBuffer, '\n');
 479             if (!SubBuffer)
 480             {
 481                 return;
 482             }
 483
 484             /* Remove the line */
 485
 486             SubBuffer = AsRemoveData (SubString, SubBuffer);
 487         }
 488     }
 489 }
 490
 491
 492 /******************************************************************************
 493  *
 494  * FUNCTION:    AsReduceTypedefs
 495  *
 496  * DESCRIPTION: Eliminate certain typedefs
 497  *
 498  ******************************************************************************/
 499
 500 void
 501 AsReduceTypedefs (
 502     char                    *Buffer,
 503     char                    *Keyword)
 504 {
 505     char                    *SubString;
 506     char                    *SubBuffer;
 507     int                     NestLevel;
 508
 509
 510     SubBuffer = Buffer;
 511     SubString = Buffer;
 512
 513
 514     while (SubString)
 515     {
 516         SubString = strstr (SubBuffer, Keyword);
 517
 518         if (SubString)
 519         {
 520             /* Remove the typedef itself */
 521
 522             SubBuffer = SubString + strlen ("typedef") + 1;
 523             SubBuffer = AsRemoveData (SubString, SubBuffer);
 524
 525             /* Find the opening brace of the struct or union */
 526
 527             while (*SubString != '{')
 528             {
 529                 SubString++;
 530             }
 531             SubString++;
 532
 533             /* Find the closing brace. Handles nested braces */
 534
 535             NestLevel = 1;
 536             while (*SubString)
 537             {
 538                 if (*SubString == '{')
 539                 {
 540                     NestLevel++;
 541                 }
 542                 else if (*SubString == '}')
 543                 {
 544                     NestLevel--;
 545                 }
 546
 547                 SubString++;
 548
 549                 if (NestLevel == 0)
 550                 {
 551                     break;
 552                 }
 553             }
 554
 555             /* Remove an extra line feed if present */
 556
 557             if (!strncmp (SubString - 3, "\n\n", 2))
 558             {
 559                 *(SubString -2) = '}';
 560                 SubString--;
 561             }
 562
 563             /* Find the end of the typedef name */
 564
 565             SubBuffer = AsSkipUntilChar (SubString, ';');
 566
 567             /* And remove the typedef name */
 568
 569             SubBuffer = AsRemoveData (SubString, SubBuffer);
 570         }
 571     }
 572 }
 573
 574
 575 /******************************************************************************
 576  *
 577  * FUNCTION:    AsRemoveEmptyBlocks
 578  *
 579  * DESCRIPTION: Remove any C blocks (e.g., if {}) that contain no code. This
 580  *              can happen as a result of removing lines such as DEBUG_PRINT.
 581  *
 582  ******************************************************************************/
 583
 584 void
 585 AsRemoveEmptyBlocks (
 586     char                    *Buffer,
 587     char                    *Filename)
 588 {
 589     char                    *SubBuffer;
 590     char                    *BlockStart;
 591     BOOLEAN                 EmptyBlock = TRUE;
 592     BOOLEAN                 AnotherPassRequired = TRUE;
 593     UINT32                  BlockCount = 0;
 594
 595
 596     while (AnotherPassRequired)
 597     {
 598         SubBuffer = Buffer;
 599         AnotherPassRequired = FALSE;
 600
 601         while (*SubBuffer)
 602         {
 603             if (*SubBuffer == '{')
 604             {
 605                 BlockStart = SubBuffer;
 606                 EmptyBlock = TRUE;
 607
 608                 SubBuffer++;
 609                 while (*SubBuffer != '}')
 610                 {
 611                     if ((*SubBuffer != ' ') &&
 612                         (*SubBuffer != '\n'))
 613                     {
 614                         EmptyBlock = FALSE;
 615                         break;
 616                     }
 617                     SubBuffer++;
 618                 }
 619
 620                 if (EmptyBlock)
 621                 {
 622                     /* Find start of the first line of the block */
 623
 624                     while (*BlockStart != '\n')
 625                     {
 626                         BlockStart--;
 627                     }
 628
 629                     /* Find end of the last line of the block */
 630
 631                     SubBuffer = AsSkipUntilChar (SubBuffer, '\n');
 632                     if (!SubBuffer)
 633                     {
 634                         break;
 635                     }
 636
 637                     /* Remove the block */
 638
 639                     SubBuffer = AsRemoveData (BlockStart, SubBuffer);
 640                     BlockCount++;
 641                     AnotherPassRequired = TRUE;
 642                     continue;
 643                 }
 644             }
 645
 646             SubBuffer++;
 647         }
 648     }
 649
 650     if (BlockCount)
 651     {
 652         Gbl_MadeChanges = TRUE;
 653         AsPrint ("Code blocks deleted", BlockCount, Filename);
 654     }
 655 }
 656
 657
 658 /******************************************************************************
 659  *
 660  * FUNCTION:    AsRemoveDebugMacros
 661  *
 662  * DESCRIPTION: Remove all "Debug" macros -- macros that produce debug output.
 663  *
 664  ******************************************************************************/
 665
 666 void
 667 AsRemoveDebugMacros (
 668     char                    *Buffer)
 669 {
 670     AsRemoveConditionalCompile (Buffer, "ACPI_DEBUG_OUTPUT");
 671
 672     AsRemoveStatement (Buffer, "ACPI_DEBUG_PRINT",      REPLACE_WHOLE_WORD);
 673     AsRemoveStatement (Buffer, "ACPI_DEBUG_PRINT_RAW",  REPLACE_WHOLE_WORD);
 674     AsRemoveStatement (Buffer, "DEBUG_EXEC",            REPLACE_WHOLE_WORD);
 675     AsRemoveStatement (Buffer, "FUNCTION_ENTRY",        REPLACE_WHOLE_WORD);
 676     AsRemoveStatement (Buffer, "PROC_NAME",             REPLACE_WHOLE_WORD);
 677     AsRemoveStatement (Buffer, "FUNCTION_TRACE",        REPLACE_SUBSTRINGS);
 678     AsRemoveStatement (Buffer, "DUMP_",                 REPLACE_SUBSTRINGS);
 679
 680     AsReplaceString ("return_VOID",         "return", REPLACE_WHOLE_WORD, Buffer);
 681     AsReplaceString ("return_PTR",          "return", REPLACE_WHOLE_WORD, Buffer);
 682     AsReplaceString ("return_ACPI_STATUS",  "return", REPLACE_WHOLE_WORD, Buffer);
 683     AsReplaceString ("return_acpi_status",  "return", REPLACE_WHOLE_WORD, Buffer);
 684     AsReplaceString ("return_VALUE",        "return", REPLACE_WHOLE_WORD, Buffer);
 685 }