sys/contrib/dev/acpica-unix-20061109/tools/acpisrc/asmain.c

   1
   2 /******************************************************************************
   3  *
   4  * Module Name: asmain - Main module for the acpi source processor utility
   5  *              $Revision: 1.99 $
   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
 119 #include "acpisrc.h"
 120 #include "acapps.h"
 121
 122
 123 /* Globals */
 124
 125 UINT32                  Gbl_Tabs = 0;
 126 UINT32                  Gbl_MissingBraces = 0;
 127 UINT32                  Gbl_NonAnsiComments = 0;
 128 UINT32                  Gbl_Files = 0;
 129 UINT32                  Gbl_WhiteLines = 0;
 130 UINT32                  Gbl_CommentLines = 0;
 131 UINT32                  Gbl_SourceLines = 0;
 132 UINT32                  Gbl_LongLines = 0;
 133 UINT32                  Gbl_TotalLines = 0;
 134 void                    *Gbl_StructDefs = NULL;
 135
 136 struct stat             Gbl_StatBuf;
 137 char                    *Gbl_FileBuffer;
 138 UINT32                  Gbl_FileSize;
 139 UINT32                  Gbl_FileType;
 140 BOOLEAN                 Gbl_VerboseMode = FALSE;
 141 BOOLEAN                 Gbl_BatchMode = FALSE;
 142 BOOLEAN                 Gbl_DebugStatementsMode = FALSE;
 143 BOOLEAN                 Gbl_MadeChanges = FALSE;
 144 BOOLEAN                 Gbl_Overwrite = FALSE;
 145 BOOLEAN                 Gbl_WidenDeclarations = FALSE;
 146 BOOLEAN                 Gbl_IgnoreLoneLineFeeds = FALSE;
 147
 148
 149 /******************************************************************************
 150  *
 151  * FUNCTION:    AsExaminePaths
 152  *
 153  * DESCRIPTION: Source and Target pathname verification and handling
 154  *
 155  ******************************************************************************/
 156
 157 int
 158 AsExaminePaths (
 159     ACPI_CONVERSION_TABLE   *ConversionTable,
 160     char                    *Source,
 161     char                    *Target,
 162     UINT32                  *SourceFileType)
 163 {
 164     int                     Status;
 165     char                    Response;
 166
 167
 168     Status = stat (Source, &Gbl_StatBuf);
 169     if (Status)
 170     {
 171         printf ("Source path \"%s\" does not exist\n", Source);
 172         return -1;
 173     }
 174
 175     /* Return the filetype -- file or a directory */
 176
 177     *SourceFileType = 0;
 178     if (Gbl_StatBuf.st_mode & S_IFDIR)
 179     {
 180         *SourceFileType = S_IFDIR;
 181     }
 182
 183     /*
 184      * If we are in no-output mode or in batch mode, we are done
 185      */
 186     if ((ConversionTable->Flags & FLG_NO_FILE_OUTPUT) ||
 187         (Gbl_BatchMode))
 188     {
 189         return 0;
 190     }
 191
 192     if (!stricmp (Source, Target))
 193     {
 194         printf ("Target path is the same as the source path, overwrite?\n");
 195         scanf ("%c", &Response);
 196
 197         /* Check response */
 198
 199         if ((char) Response != 'y')
 200         {
 201             return -1;
 202         }
 203
 204         Gbl_Overwrite = TRUE;
 205     }
 206     else
 207     {
 208         Status = stat (Target, &Gbl_StatBuf);
 209         if (!Status)
 210         {
 211             printf ("Target path already exists, overwrite?\n");
 212             scanf ("%c", &Response);
 213
 214             /* Check response */
 215
 216             if ((char) Response != 'y')
 217             {
 218                 return -1;
 219             }
 220         }
 221     }
 222
 223     return 0;
 224 }
 225
 226
 227 /******************************************************************************
 228  *
 229  * FUNCTION:    AsDisplayStats
 230  *
 231  * DESCRIPTION: Display global statistics gathered during translation
 232  *
 233  ******************************************************************************/
 234
 235 void
 236 AsDisplayStats (void)
 237 {
 238
 239     printf ("\nAcpiSrc statistics:\n\n");
 240     printf ("%6d Files processed\n", Gbl_Files);
 241     printf ("%6d Tabs found\n", Gbl_Tabs);
 242     printf ("%6d Missing if/else braces\n", Gbl_MissingBraces);
 243     printf ("%6d Non-ANSI comments found\n", Gbl_NonAnsiComments);
 244     printf ("%6d Total Lines\n", Gbl_TotalLines);
 245     printf ("%6d Lines of code\n", Gbl_SourceLines);
 246     printf ("%6d Lines of non-comment whitespace\n", Gbl_WhiteLines);
 247     printf ("%6d Lines of comments\n", Gbl_CommentLines);
 248     printf ("%6d Long lines found\n", Gbl_LongLines);
 249     printf ("%6.1f Ratio of code to whitespace\n", ((float) Gbl_SourceLines / (float) Gbl_WhiteLines));
 250     printf ("%6.1f Ratio of code to comments\n", ((float) Gbl_SourceLines / (float) Gbl_CommentLines));
 251     return;
 252 }
 253
 254
 255 /******************************************************************************
 256  *
 257  * FUNCTION:    AsDisplayUsage
 258  *
 259  * DESCRIPTION: Usage message
 260  *
 261  ******************************************************************************/
 262
 263 void
 264 AsDisplayUsage (void)
 265 {
 266
 267     printf ("\n");
 268     printf ("Usage: acpisrc [-c|l|u] [-dsvy] <SourceDir> <DestinationDir>\n\n");
 269     printf ("Where: -c          Generate cleaned version of the source\n");
 270     printf ("       -l          Generate Linux version of the source\n");
 271     printf ("       -u          Generate Custom source translation\n");
 272     printf ("\n");
 273     printf ("       -d          Leave debug statements in code\n");
 274     printf ("       -s          Generate source statistics only\n");
 275     printf ("       -v          Verbose mode\n");
 276     printf ("       -y          Suppress file overwrite prompts\n");
 277     printf ("\n");
 278     return;
 279 }
 280
 281
 282 /******************************************************************************
 283  *
 284  * FUNCTION:    main
 285  *
 286  * DESCRIPTION: C main function
 287  *
 288  ******************************************************************************/
 289
 290 int ACPI_SYSTEM_XFACE
 291 main (
 292     int                     argc,
 293     char                    *argv[])
 294 {
 295     int                     j;
 296     ACPI_CONVERSION_TABLE   *ConversionTable = NULL;
 297     char                    *SourcePath;
 298     char                    *TargetPath;
 299     UINT32                  FileType;
 300
 301
 302     printf ("ACPI Source Code Conversion Utility");
 303     printf (" version %8.8X", ((UINT32) ACPI_CA_VERSION));
 304     printf (" [%s]\n\n",  __DATE__);
 305
 306     if (argc < 2)
 307     {
 308         AsDisplayUsage ();
 309         return 0;
 310     }
 311
 312     /* Command line options */
 313
 314     while ((j = AcpiGetopt (argc, argv, "lcsuvyd")) != EOF) switch(j)
 315     {
 316     case 'l':
 317         /* Linux code generation */
 318
 319         printf ("Creating Linux source code\n");
 320         ConversionTable = &LinuxConversionTable;
 321         Gbl_WidenDeclarations = TRUE;
 322         Gbl_IgnoreLoneLineFeeds = TRUE;
 323         break;
 324
 325     case 'c':
 326         /* Cleanup code */
 327
 328         printf ("Code cleanup\n");
 329         ConversionTable = &CleanupConversionTable;
 330         break;
 331
 332     case 's':
 333         /* Statistics only */
 334
 335         break;
 336
 337     case 'u':
 338         /* custom conversion  */
 339
 340         printf ("Custom source translation\n");
 341         ConversionTable = &CustomConversionTable;
 342         break;
 343
 344     case 'v':
 345         /* Verbose mode */
 346
 347         Gbl_VerboseMode = TRUE;
 348         break;
 349
 350     case 'y':
 351         /* Batch mode */
 352
 353         Gbl_BatchMode = TRUE;
 354         break;
 355
 356     case 'd':
 357         /* Leave debug statements in */
 358
 359         Gbl_DebugStatementsMode = TRUE;
 360         break;
 361
 362     default:
 363         AsDisplayUsage ();
 364         return -1;
 365     }
 366
 367
 368     SourcePath = argv[AcpiGbl_Optind];
 369     if (!SourcePath)
 370     {
 371         printf ("Missing source path\n");
 372         AsDisplayUsage ();
 373         return -1;
 374     }
 375
 376     TargetPath = argv[AcpiGbl_Optind+1];
 377
 378     if (!ConversionTable)
 379     {
 380         /* Just generate statistics.  Ignore target path */
 381
 382         TargetPath = SourcePath;
 383
 384         printf ("Source code statistics only\n");
 385         ConversionTable = &StatsConversionTable;
 386     }
 387     else if (!TargetPath)
 388     {
 389         TargetPath = SourcePath;
 390     }
 391
 392     if (Gbl_DebugStatementsMode)
 393     {
 394         ConversionTable->SourceFunctions &= ~CVT_REMOVE_DEBUG_MACROS;
 395     }
 396
 397     /* Check source and target paths and files */
 398
 399     if (AsExaminePaths (ConversionTable, SourcePath, TargetPath, &FileType))
 400     {
 401         return -1;
 402     }
 403
 404     /* Source/target can be either directories or a files */
 405
 406     if (FileType == S_IFDIR)
 407     {
 408         /* Process the directory tree */
 409
 410         AsProcessTree (ConversionTable, SourcePath, TargetPath);
 411     }
 412     else
 413     {
 414         /* Process a single file */
 415
 416         /* Differentiate between source and header files */
 417
 418         if (strstr (SourcePath, ".h"))
 419         {
 420             AsProcessOneFile (ConversionTable, NULL, TargetPath, 0, SourcePath, FILE_TYPE_HEADER);
 421         }
 422         else
 423         {
 424             AsProcessOneFile (ConversionTable, NULL, TargetPath, 0, SourcePath, FILE_TYPE_SOURCE);
 425         }
 426     }
 427
 428     /* Always display final summary and stats */
 429
 430     AsDisplayStats ();
 431
 432     return 0;
 433 }