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

   1
   2 /******************************************************************************
   3  *
   4  * Module Name: acpisrc.h - Include file for AcpiSrc utility
   5  *              $Revision: 34 $
   6  *
   7  *****************************************************************************/
   8
   9 /******************************************************************************
  10  *
  11  * 1. Copyright Notice
  12  *
  13  * Some or all of this work - Copyright (c) 1999 - 2005, 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_SPACES_TO_TABS4                 0x40000000  /* Tab conversion should be last */
 177 #define CVT_SPACES_TO_TABS8                 0x80000000  /* Tab conversion should be last */
 178
 179
 180 #define FLG_DEFAULT_FLAGS                   0x00000000
 181 #define FLG_NO_CARRIAGE_RETURNS             0x00000001
 182 #define FLG_NO_FILE_OUTPUT                  0x00000002
 183 #define FLG_LOWERCASE_DIRNAMES              0x00000004
 184
 185
 186 /* Globals */
 187
 188 extern UINT32                   Gbl_Files;
 189 extern UINT32                   Gbl_MissingBraces;
 190 extern UINT32                   Gbl_Tabs;
 191 extern UINT32                   Gbl_NonAnsiComments;
 192 extern UINT32                   Gbl_SourceLines;
 193 extern UINT32                   Gbl_WhiteLines;
 194 extern UINT32                   Gbl_CommentLines;
 195 extern UINT32                   Gbl_LongLines;
 196 extern UINT32                   Gbl_TotalLines;
 197 extern struct stat              Gbl_StatBuf;
 198 extern char                     *Gbl_FileBuffer;
 199 extern UINT32                   Gbl_FileSize;
 200 extern UINT32                   Gbl_FileType;
 201 extern BOOLEAN                  Gbl_VerboseMode;
 202 extern BOOLEAN                  Gbl_BatchMode;
 203 extern BOOLEAN                  Gbl_MadeChanges;
 204 extern BOOLEAN                  Gbl_Overwrite;
 205 extern BOOLEAN                  Gbl_WidenDeclarations;
 206 extern BOOLEAN                  Gbl_IgnoreLoneLineFeeds;
 207
 208 #define PARAM_LIST(pl)          pl
 209 #define TERSE_PRINT(a)          if (!Gbl_VerboseMode) printf PARAM_LIST(a)
 210 #define VERBOSE_PRINT(a)        if (Gbl_VerboseMode) printf PARAM_LIST(a)
 211
 212
 213 #define REPLACE_WHOLE_WORD      0x00
 214 #define REPLACE_SUBSTRINGS      0x01
 215 #define REPLACE_MASK            0x01
 216
 217 #define EXTRA_INDENT_C          0x02
 218 #define INDENT_MASK             0x02
 219
 220
 221 /* Conversion table structs */
 222
 223 typedef struct acpi_string_table
 224 {
 225     char                        *Target;
 226     char                        *Replacement;
 227     UINT8                       Type;
 228
 229 } ACPI_STRING_TABLE;
 230
 231
 232 typedef struct acpi_typed_identifier_table
 233 {
 234     char                        *Identifier;
 235     UINT8                       Type;
 236
 237 } ACPI_TYPED_IDENTIFIER_TABLE;
 238
 239 #define SRC_TYPE_SIMPLE         0
 240 #define SRC_TYPE_STRUCT         1
 241 #define SRC_TYPE_UNION          2
 242
 243
 244 typedef struct acpi_identifier_table
 245 {
 246     char                        *Identifier;
 247
 248 } ACPI_IDENTIFIER_TABLE;
 249
 250 typedef struct acpi_conversion_table
 251 {
 252     char                        *NewHeader;
 253     UINT32                      Flags;
 254
 255     ACPI_TYPED_IDENTIFIER_TABLE *LowerCaseTable;
 256
 257     ACPI_STRING_TABLE           *SourceStringTable;
 258     ACPI_IDENTIFIER_TABLE       *SourceLineTable;
 259     ACPI_IDENTIFIER_TABLE       *SourceConditionalTable;
 260     ACPI_IDENTIFIER_TABLE       *SourceMacroTable;
 261     ACPI_TYPED_IDENTIFIER_TABLE *SourceStructTable;
 262     UINT32                      SourceFunctions;
 263
 264     ACPI_STRING_TABLE           *HeaderStringTable;
 265     ACPI_IDENTIFIER_TABLE       *HeaderLineTable;
 266     ACPI_IDENTIFIER_TABLE       *HeaderConditionalTable;
 267     ACPI_IDENTIFIER_TABLE       *HeaderMacroTable;
 268     ACPI_TYPED_IDENTIFIER_TABLE *HeaderStructTable;
 269     UINT32                      HeaderFunctions;
 270
 271 } ACPI_CONVERSION_TABLE;
 272
 273
 274 /* Prototypes */
 275
 276 char *
 277 AsSkipUntilChar (
 278     char                    *Buffer,
 279     char                    Target);
 280
 281 char *
 282 AsSkipPastChar (
 283     char                    *Buffer,
 284     char                    Target);
 285
 286 char *
 287 AsReplaceData (
 288     char                    *Buffer,
 289     UINT32                  LengthToRemove,
 290     char                    *BufferToAdd,
 291     UINT32                  LengthToAdd);
 292
 293 int
 294 AsReplaceString (
 295     char                    *Target,
 296     char                    *Replacement,
 297     UINT8                   Type,
 298     char                    *Buffer);
 299
 300 int
 301 AsLowerCaseString (
 302     char                    *Target,
 303     char                    *Buffer);
 304
 305 void
 306 AsRemoveLine (
 307     char                    *Buffer,
 308     char                    *Keyword);
 309
 310 void
 311 AsRemoveMacro (
 312     char                    *Buffer,
 313     char                    *Keyword);
 314
 315 void
 316 AsCheckForBraces (
 317     char                    *Buffer,
 318     char                    *Filename);
 319
 320 void
 321 AsTrimLines (
 322     char                    *Buffer,
 323     char                    *Filename);
 324
 325 void
 326 AsMixedCaseToUnderscores (
 327     char                    *Buffer);
 328
 329 void
 330 AsCountTabs (
 331     char                    *Buffer,
 332     char                    *Filename);
 333
 334 void
 335 AsBracesOnSameLine (
 336     char                    *Buffer);
 337
 338 void
 339 AsLowerCaseIdentifiers (
 340     char                    *Buffer);
 341
 342 void
 343 AsReduceTypedefs (
 344     char                    *Buffer,
 345     char                    *Keyword);
 346
 347 void
 348 AsRemoveDebugMacros (
 349     char                    *Buffer);
 350
 351 void
 352 AsRemoveEmptyBlocks (
 353     char                    *Buffer,
 354     char                    *Filename);
 355
 356 void
 357 AsCountSourceLines (
 358     char                    *Buffer,
 359     char                    *Filename);
 360
 361 void
 362 AsCountNonAnsiComments (
 363     char                    *Buffer,
 364     char                    *Filename);
 365
 366 void
 367 AsTrimWhitespace (
 368     char                    *Buffer);
 369
 370 void
 371 AsTabify4 (
 372     char                    *Buffer);
 373
 374 void
 375 AsTabify8 (
 376     char                    *Buffer);
 377
 378 void
 379 AsRemoveConditionalCompile (
 380     char                    *Buffer,
 381     char                    *Keyword);
 382
 383 ACPI_NATIVE_INT
 384 AsProcessTree (
 385     ACPI_CONVERSION_TABLE   *ConversionTable,
 386     char                    *SourcePath,
 387     char                    *TargetPath);
 388
 389 int
 390 AsGetFile (
 391     char                    *FileName,
 392     char                    **FileBuffer,
 393     UINT32                  *FileSize);
 394
 395 int
 396 AsPutFile (
 397     char                    *Pathname,
 398     char                    *FileBuffer,
 399     UINT32                  SystemFlags);
 400
 401 void
 402 AsReplaceHeader (
 403     char                    *Buffer,
 404     char                    *NewHeader);
 405
 406 void
 407 AsConvertFile (
 408     ACPI_CONVERSION_TABLE   *ConversionTable,
 409     char                    *FileBuffer,
 410     char                    *Filename,
 411     ACPI_NATIVE_INT         FileType);
 412
 413 ACPI_NATIVE_INT
 414 AsProcessOneFile (
 415     ACPI_CONVERSION_TABLE   *ConversionTable,
 416     char                    *SourcePath,
 417     char                    *TargetPath,
 418     int                     MaxPathLength,
 419     char                    *Filename,
 420     ACPI_NATIVE_INT         FileType);
 421
 422 ACPI_NATIVE_INT
 423 AsCheckForDirectory (
 424     char                    *SourceDirPath,
 425     char                    *TargetDirPath,
 426     char                    *Filename,
 427     char                    **SourcePath,
 428     char                    **TargetPath);
 429
 430 BOOLEAN
 431 AsMatchExactWord (
 432     char                    *Word,
 433     UINT32                  WordLength);
 434
 435 void
 436 AsPrint (
 437     char                    *Message,
 438     UINT32                  Count,
 439     char                    *Filename);
 440
 441 void
 442 AsInsertPrefix (
 443     char                    *Buffer,
 444     char                    *Keyword,
 445     UINT8                   Type);
 446
 447 char *
 448 AsInsertData (
 449     char                    *Buffer,
 450     char                    *BufferToAdd,
 451     UINT32                  LengthToAdd);
 452
 453 char *
 454 AsRemoveData (
 455     char                    *StartPointer,
 456     char                    *EndPointer);
 457
 458 void
 459 AsInsertCarriageReturns (
 460     char                    *Buffer);
 461
 462 void
 463 AsConvertToLineFeeds (
 464     char                    *Buffer);
 465
 466