sys/contrib/dev/acpica-unix-20061109/tools/acpisrc/acpisrc.h

   1
   2 /******************************************************************************
   3  *
   4  * Module Name: acpisrc.h - Include file for AcpiSrc utility
   5  *              $Revision: 1.39 $
   6  *
   7  *****************************************************************************/
   8
   9 /******************************************************************************
  10  *
  11  * 1. Copyright Notice
  12  *
  13  * Some or all of this work - Copyright (c) 1999 - 2006, Intel Corp.
  14  * All rights reserved.
  15  *
  16  * 2. License
  17  *
  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
  21  * property rights.
  22  *
  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
  29  *
  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;
  38  *
  39  * The above copyright and patent license is granted only if the following
  40  * conditions are met:
  41  *
  42  * 3. Conditions
  43  *
  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.
  55  *
  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
  66  * make.
  67  *
  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
  72  * distribution.
  73  *
  74  * 3.4. Intel retains all right, title, and interest in and to the Original
  75  * Intel Code.
  76  *
  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.
  81  *
  82  * 4. Disclaimer and Export Compliance
  83  *
  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
  90  * PARTICULAR PURPOSE.
  91  *
  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
  99  * LIMITED REMEDY.
 100  *
 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.
 115  *
 116  *****************************************************************************/
 117
 118 #define LINES_IN_LEGAL_HEADER               105 /* See above */
 119
 120
 121 #include <stdio.h>
 122 #include <sys/stat.h>
 123 #include <sys/types.h>
 124 #include <fcntl.h>
 125 #include <ctype.h>
 126 #ifdef WIN32
 127 #include <io.h>
 128 #include <direct.h>
 129 #endif
 130 #include <errno.h>
 131
 132 #include "acpi.h"
 133
 134
 135 /* Fixups for non-Win32 compilation */
 136 #ifndef WIN32
 137
 138 static inline int
 139 max (int a, int b)
 140 {
 141     return (a > b ? a : b);
 142 }
 143
 144 #define O_BINARY    0x0
 145
 146 #define mkdir(x) mkdir(x, 0770)
 147 #define stricmp strcasecmp
 148
 149 char * strlwr(char* str);
 150
 151 #endif
 152
 153
 154 /* Constants */
 155
 156
 157 #define ASRC_MAX_FILE_SIZE                  (1024 * 100)
 158
 159 #define FILE_TYPE_SOURCE                    1
 160 #define FILE_TYPE_HEADER                    2
 161 #define FILE_TYPE_DIRECTORY                 3
 162
 163
 164 #define CVT_COUNT_TABS                      0x00000001
 165 #define CVT_COUNT_NON_ANSI_COMMENTS         0x00000002
 166 #define CVT_TRIM_LINES                      0x00000004
 167 #define CVT_CHECK_BRACES                    0x00000008
 168 #define CVT_COUNT_LINES                     0x00000010
 169 #define CVT_BRACES_ON_SAME_LINE             0x00000020
 170 #define CVT_MIXED_CASE_TO_UNDERSCORES       0x00000040
 171 #define CVT_LOWER_CASE_IDENTIFIERS          0x00000080
 172 #define CVT_REMOVE_DEBUG_MACROS             0x00000100
 173 #define CVT_TRIM_WHITESPACE                 0x00000200  /* Should be after all line removal */
 174 #define CVT_REMOVE_EMPTY_BLOCKS             0x00000400  /* Should be after trimming lines */
 175 #define CVT_REDUCE_TYPEDEFS                 0x00000800
 176 #define CVT_COUNT_SHORTMULTILINE_COMMENTS   0x00001000
 177 #define CVT_SPACES_TO_TABS4                 0x40000000  /* Tab conversion should be last */
 178 #define CVT_SPACES_TO_TABS8                 0x80000000  /* Tab conversion should be last */
 179
 180
 181 #define FLG_DEFAULT_FLAGS                   0x00000000
 182 #define FLG_NO_CARRIAGE_RETURNS             0x00000001
 183 #define FLG_NO_FILE_OUTPUT                  0x00000002
 184 #define FLG_LOWERCASE_DIRNAMES              0x00000004
 185
 186 #define AS_START_IGNORE                     "/*!"
 187 #define AS_STOP_IGNORE                      "!*/"
 188
 189
 190 /* Globals */
 191
 192 extern UINT32                   Gbl_Files;
 193 extern UINT32                   Gbl_MissingBraces;
 194 extern UINT32                   Gbl_Tabs;
 195 extern UINT32                   Gbl_NonAnsiComments;
 196 extern UINT32                   Gbl_SourceLines;
 197 extern UINT32                   Gbl_WhiteLines;
 198 extern UINT32                   Gbl_CommentLines;
 199 extern UINT32                   Gbl_LongLines;
 200 extern UINT32                   Gbl_TotalLines;
 201 extern struct stat              Gbl_StatBuf;
 202 extern char                     *Gbl_FileBuffer;
 203 extern UINT32                   Gbl_FileSize;
 204 extern UINT32                   Gbl_FileType;
 205 extern BOOLEAN                  Gbl_VerboseMode;
 206 extern BOOLEAN                  Gbl_BatchMode;
 207 extern BOOLEAN                  Gbl_MadeChanges;
 208 extern BOOLEAN                  Gbl_Overwrite;
 209 extern BOOLEAN                  Gbl_WidenDeclarations;
 210 extern BOOLEAN                  Gbl_IgnoreLoneLineFeeds;
 211 extern void                     *Gbl_StructDefs;
 212
 213 #define PARAM_LIST(pl)          pl
 214 #define TERSE_PRINT(a)          if (!Gbl_VerboseMode) printf PARAM_LIST(a)
 215 #define VERBOSE_PRINT(a)        if (Gbl_VerboseMode) printf PARAM_LIST(a)
 216
 217
 218 #define REPLACE_WHOLE_WORD      0x00
 219 #define REPLACE_SUBSTRINGS      0x01
 220 #define REPLACE_MASK            0x01
 221
 222 #define EXTRA_INDENT_C          0x02
 223
 224
 225 /* Conversion table structs */
 226
 227 typedef struct acpi_string_table
 228 {
 229     char                        *Target;
 230     char                        *Replacement;
 231     UINT8                       Type;
 232
 233 } ACPI_STRING_TABLE;
 234
 235
 236 typedef struct acpi_typed_identifier_table
 237 {
 238     char                        *Identifier;
 239     UINT8                       Type;
 240
 241 } ACPI_TYPED_IDENTIFIER_TABLE;
 242
 243 #define SRC_TYPE_SIMPLE         0
 244 #define SRC_TYPE_STRUCT         1
 245 #define SRC_TYPE_UNION          2
 246
 247
 248 typedef struct acpi_identifier_table
 249 {
 250     char                        *Identifier;
 251
 252 } ACPI_IDENTIFIER_TABLE;
 253
 254 typedef struct acpi_conversion_table
 255 {
 256     char                        *NewHeader;
 257     UINT32                      Flags;
 258
 259     ACPI_TYPED_IDENTIFIER_TABLE *LowerCaseTable;
 260
 261     ACPI_STRING_TABLE           *SourceStringTable;
 262     ACPI_IDENTIFIER_TABLE       *SourceLineTable;
 263     ACPI_IDENTIFIER_TABLE       *SourceConditionalTable;
 264     ACPI_IDENTIFIER_TABLE       *SourceMacroTable;
 265     ACPI_TYPED_IDENTIFIER_TABLE *SourceStructTable;
 266     UINT32                      SourceFunctions;
 267
 268     ACPI_STRING_TABLE           *HeaderStringTable;
 269     ACPI_IDENTIFIER_TABLE       *HeaderLineTable;
 270     ACPI_IDENTIFIER_TABLE       *HeaderConditionalTable;
 271     ACPI_IDENTIFIER_TABLE       *HeaderMacroTable;
 272     ACPI_TYPED_IDENTIFIER_TABLE *HeaderStructTable;
 273     UINT32                      HeaderFunctions;
 274
 275 } ACPI_CONVERSION_TABLE;
 276
 277
 278 /* Conversion tables */
 279
 280 extern ACPI_CONVERSION_TABLE       LinuxConversionTable;
 281 extern ACPI_CONVERSION_TABLE       CleanupConversionTable;
 282 extern ACPI_CONVERSION_TABLE       StatsConversionTable;
 283 extern ACPI_CONVERSION_TABLE       CustomConversionTable;
 284
 285
 286 /* Prototypes */
 287
 288 char *
 289 AsSkipUntilChar (
 290     char                    *Buffer,
 291     char                    Target);
 292
 293 char *
 294 AsSkipPastChar (
 295     char                    *Buffer,
 296     char                    Target);
 297
 298 char *
 299 AsReplaceData (
 300     char                    *Buffer,
 301     UINT32                  LengthToRemove,
 302     char                    *BufferToAdd,
 303     UINT32                  LengthToAdd);
 304
 305 int
 306 AsReplaceString (
 307     char                    *Target,
 308     char                    *Replacement,
 309     UINT8                   Type,
 310     char                    *Buffer);
 311
 312 int
 313 AsLowerCaseString (
 314     char                    *Target,
 315     char                    *Buffer);
 316
 317 void
 318 AsRemoveLine (
 319     char                    *Buffer,
 320     char                    *Keyword);
 321
 322 void
 323 AsRemoveMacro (
 324     char                    *Buffer,
 325     char                    *Keyword);
 326
 327 void
 328 AsCheckForBraces (
 329     char                    *Buffer,
 330     char                    *Filename);
 331
 332 void
 333 AsTrimLines (
 334     char                    *Buffer,
 335     char                    *Filename);
 336
 337 void
 338 AsMixedCaseToUnderscores (
 339     char                    *Buffer);
 340
 341 void
 342 AsCountTabs (
 343     char                    *Buffer,
 344     char                    *Filename);
 345
 346 void
 347 AsBracesOnSameLine (
 348     char                    *Buffer);
 349
 350 void
 351 AsLowerCaseIdentifiers (
 352     char                    *Buffer);
 353
 354 void
 355 AsReduceTypedefs (
 356     char                    *Buffer,
 357     char                    *Keyword);
 358
 359 void
 360 AsRemoveDebugMacros (
 361     char                    *Buffer);
 362
 363 void
 364 AsRemoveEmptyBlocks (
 365     char                    *Buffer,
 366     char                    *Filename);
 367
 368 void
 369 AsCountSourceLines (
 370     char                    *Buffer,
 371     char                    *Filename);
 372
 373 void
 374 AsCountNonAnsiComments (
 375     char                    *Buffer,
 376     char                    *Filename);
 377
 378 void
 379 AsTrimWhitespace (
 380     char                    *Buffer);
 381
 382 void
 383 AsTabify4 (
 384     char                    *Buffer);
 385
 386 void
 387 AsTabify8 (
 388     char                    *Buffer);
 389
 390 void
 391 AsRemoveConditionalCompile (
 392     char                    *Buffer,
 393     char                    *Keyword);
 394
 395 ACPI_NATIVE_INT
 396 AsProcessTree (
 397     ACPI_CONVERSION_TABLE   *ConversionTable,
 398     char                    *SourcePath,
 399     char                    *TargetPath);
 400
 401 int
 402 AsGetFile (
 403     char                    *FileName,
 404     char                    **FileBuffer,
 405     UINT32                  *FileSize);
 406
 407 int
 408 AsPutFile (
 409     char                    *Pathname,
 410     char                    *FileBuffer,
 411     UINT32                  SystemFlags);
 412
 413 void
 414 AsReplaceHeader (
 415     char                    *Buffer,
 416     char                    *NewHeader);
 417
 418 void
 419 AsConvertFile (
 420     ACPI_CONVERSION_TABLE   *ConversionTable,
 421     char                    *FileBuffer,
 422     char                    *Filename,
 423     ACPI_NATIVE_INT         FileType);
 424
 425 ACPI_NATIVE_INT
 426 AsProcessOneFile (
 427     ACPI_CONVERSION_TABLE   *ConversionTable,
 428     char                    *SourcePath,
 429     char                    *TargetPath,
 430     int                     MaxPathLength,
 431     char                    *Filename,
 432     ACPI_NATIVE_INT         FileType);
 433
 434 ACPI_NATIVE_INT
 435 AsCheckForDirectory (
 436     char                    *SourceDirPath,
 437     char                    *TargetDirPath,
 438     char                    *Filename,
 439     char                    **SourcePath,
 440     char                    **TargetPath);
 441
 442 BOOLEAN
 443 AsMatchExactWord (
 444     char                    *Word,
 445     UINT32                  WordLength);
 446
 447 void
 448 AsPrint (
 449     char                    *Message,
 450     UINT32                  Count,
 451     char                    *Filename);
 452
 453 void
 454 AsInsertPrefix (
 455     char                    *Buffer,
 456     char                    *Keyword,
 457     UINT8                   Type);
 458
 459 char *
 460 AsInsertData (
 461     char                    *Buffer,
 462     char                    *BufferToAdd,
 463     UINT32                  LengthToAdd);
 464
 465 char *
 466 AsRemoveData (
 467     char                    *StartPointer,
 468     char                    *EndPointer);
 469
 470 void
 471 AsInsertCarriageReturns (
 472     char                    *Buffer);
 473
 474 void
 475 AsConvertToLineFeeds (
 476     char                    *Buffer);
 477
 478