sys/external/intel-public/acpica/dist/tools/acpisrc/asmain.c

   1
   2 /******************************************************************************
   3  *
   4  * Module Name: asmain - Main module for the acpi source processor utility
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp.
  13  * All rights reserved.
  14  *
  15  * 2. License
  16  *
  17  * 2.1. This is your license from Intel Corp. under its intellectual property
  18  * rights.  You may have additional license terms from the party that provided
  19  * you this software, covering your right to use that party's intellectual
  20  * property rights.
  21  *
  22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  23  * copy of the source code appearing in this file ("Covered Code") an
  24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  25  * base code distributed originally by Intel ("Original Intel Code") to copy,
  26  * make derivatives, distribute, use and display any portion of the Covered
  27  * Code in any form, with the right to sublicense such rights; and
  28  *
  29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  30  * license (with the right to sublicense), under only those claims of Intel
  31  * patents that are infringed by the Original Intel Code, to make, use, sell,
  32  * offer to sell, and import the Covered Code and derivative works thereof
  33  * solely to the minimum extent necessary to exercise the above copyright
  34  * license, and in no event shall the patent license extend to any additions
  35  * to or modifications of the Original Intel Code.  No other license or right
  36  * is granted directly or by implication, estoppel or otherwise;
  37  *
  38  * The above copyright and patent license is granted only if the following
  39  * conditions are met:
  40  *
  41  * 3. Conditions
  42  *
  43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  44  * Redistribution of source code of any substantial portion of the Covered
  45  * Code or modification with rights to further distribute source must include
  46  * the above Copyright Notice, the above License, this list of Conditions,
  47  * and the following Disclaimer and Export Compliance provision.  In addition,
  48  * Licensee must cause all Covered Code to which Licensee contributes to
  49  * contain a file documenting the changes Licensee made to create that Covered
  50  * Code and the date of any change.  Licensee must include in that file the
  51  * documentation of any changes made by any predecessor Licensee.  Licensee
  52  * must include a prominent statement that the modification is derived,
  53  * directly or indirectly, from Original Intel Code.
  54  *
  55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  56  * Redistribution of source code of any substantial portion of the Covered
  57  * Code or modification without rights to further distribute source must
  58  * include the following Disclaimer and Export Compliance provision in the
  59  * documentation and/or other materials provided with distribution.  In
  60  * addition, Licensee may not authorize further sublicense of source of any
  61  * portion of the Covered Code, and must include terms to the effect that the
  62  * license from Licensee to its licensee is limited to the intellectual
  63  * property embodied in the software Licensee provides to its licensee, and
  64  * not to intellectual property embodied in modifications its licensee may
  65  * make.
  66  *
  67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  68  * substantial portion of the Covered Code or modification must reproduce the
  69  * above Copyright Notice, and the following Disclaimer and Export Compliance
  70  * provision in the documentation and/or other materials provided with the
  71  * distribution.
  72  *
  73  * 3.4. Intel retains all right, title, and interest in and to the Original
  74  * Intel Code.
  75  *
  76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  77  * Intel shall be used in advertising or otherwise to promote the sale, use or
  78  * other dealings in products derived from or relating to the Covered Code
  79  * without prior written authorization from Intel.
  80  *
  81  * 4. Disclaimer and Export Compliance
  82  *
  83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  84  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  86  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  87  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  89  * PARTICULAR PURPOSE.
  90  *
  91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  98  * LIMITED REMEDY.
  99  *
 100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 101  * software or system incorporating such software without first obtaining any
 102  * required license or other approval from the U. S. Department of Commerce or
 103  * any other agency or department of the United States Government.  In the
 104  * event Licensee exports any such software from the United States or
 105  * re-exports any such software from a foreign destination, Licensee shall
 106  * ensure that the distribution and export/re-export of the software is in
 107  * compliance with all laws, regulations, orders, or other restrictions of the
 108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 109  * any of its subsidiaries will export/re-export any technical data, process,
 110  * software, or service, directly or indirectly, to any country for which the
 111  * United States government or any agency thereof requires an export license,
 112  * other governmental approval, or letter of assurance, without first obtaining
 113  * such license, approval or letter.
 114  *
 115  *****************************************************************************/
 116
 117
 118 #include "acpisrc.h"
 119 #include "acapps.h"
 120
 121 /* Local prototypes */
 122
 123 int
 124 AsStricmp (
 125     char                    *String1,
 126     char                    *String2);
 127
 128 int
 129 AsExaminePaths (
 130     ACPI_CONVERSION_TABLE   *ConversionTable,
 131     char                    *Source,
 132     char                    *Target,
 133     UINT32                  *SourceFileType);
 134
 135 void
 136 AsDisplayStats (
 137     void);
 138
 139 void
 140 AsDisplayUsage (
 141     void);
 142
 143 /* Globals */
 144
 145 UINT32                  Gbl_Tabs = 0;
 146 UINT32                  Gbl_MissingBraces = 0;
 147 UINT32                  Gbl_NonAnsiComments = 0;
 148 UINT32                  Gbl_Files = 0;
 149 UINT32                  Gbl_WhiteLines = 0;
 150 UINT32                  Gbl_CommentLines = 0;
 151 UINT32                  Gbl_SourceLines = 0;
 152 UINT32                  Gbl_LongLines = 0;
 153 UINT32                  Gbl_TotalLines = 0;
 154 UINT32                  Gbl_TotalSize = 0;
 155 UINT32                  Gbl_HeaderLines = 0;
 156 UINT32                  Gbl_HeaderSize = 0;
 157 void                    *Gbl_StructDefs = NULL;
 158
 159 struct stat             Gbl_StatBuf;
 160 char                    *Gbl_FileBuffer;
 161 UINT32                  Gbl_FileSize;
 162 UINT32                  Gbl_FileType;
 163 BOOLEAN                 Gbl_VerboseMode = FALSE;
 164 BOOLEAN                 Gbl_QuietMode = FALSE;
 165 BOOLEAN                 Gbl_BatchMode = FALSE;
 166 BOOLEAN                 Gbl_DebugStatementsMode = FALSE;
 167 BOOLEAN                 Gbl_MadeChanges = FALSE;
 168 BOOLEAN                 Gbl_Overwrite = FALSE;
 169 BOOLEAN                 Gbl_WidenDeclarations = FALSE;
 170 BOOLEAN                 Gbl_IgnoreLoneLineFeeds = FALSE;
 171 BOOLEAN                 Gbl_HasLoneLineFeeds = FALSE;
 172
 173
 174 /******************************************************************************
 175  *
 176  * FUNCTION:    AsStricmp
 177  *
 178  * DESCRIPTION: Implementation of the non-ANSI stricmp function (compare
 179  *              strings with no case sensitivity)
 180  *
 181  ******************************************************************************/
 182
 183 int
 184 AsStricmp (
 185     char                    *String1,
 186     char                    *String2)
 187 {
 188     int                     c1;
 189     int                     c2;
 190
 191
 192     do
 193     {
 194         c1 = tolower (*String1);
 195         c2 = tolower (*String2);
 196
 197         String1++;
 198         String2++;
 199     }
 200     while ((c1 == c2) && (c1));
 201
 202     return (c1 - c2);
 203 }
 204
 205
 206 /******************************************************************************
 207  *
 208  * FUNCTION:    AsExaminePaths
 209  *
 210  * DESCRIPTION: Source and Target pathname verification and handling
 211  *
 212  ******************************************************************************/
 213
 214 int
 215 AsExaminePaths (
 216     ACPI_CONVERSION_TABLE   *ConversionTable,
 217     char                    *Source,
 218     char                    *Target,
 219     UINT32                  *SourceFileType)
 220 {
 221     int                     Status;
 222     char                    Response;
 223
 224
 225     Status = stat (Source, &Gbl_StatBuf);
 226     if (Status)
 227     {
 228         printf ("Source path \"%s\" does not exist\n", Source);
 229         return -1;
 230     }
 231
 232     /* Return the filetype -- file or a directory */
 233
 234     *SourceFileType = 0;
 235     if (Gbl_StatBuf.st_mode & S_IFDIR)
 236     {
 237         *SourceFileType = S_IFDIR;
 238     }
 239
 240     /*
 241      * If we are in no-output mode or in batch mode, we are done
 242      */
 243     if ((ConversionTable->Flags & FLG_NO_FILE_OUTPUT) ||
 244         (Gbl_BatchMode))
 245     {
 246         return 0;
 247     }
 248
 249     if (!AsStricmp (Source, Target))
 250     {
 251         printf ("Target path is the same as the source path, overwrite?\n");
 252         scanf ("%c", &Response);
 253
 254         /* Check response */
 255
 256         if ((char) Response != 'y')
 257         {
 258             return -1;
 259         }
 260
 261         Gbl_Overwrite = TRUE;
 262     }
 263     else
 264     {
 265         Status = stat (Target, &Gbl_StatBuf);
 266         if (!Status)
 267         {
 268             printf ("Target path already exists, overwrite?\n");
 269             scanf ("%c", &Response);
 270
 271             /* Check response */
 272
 273             if ((char) Response != 'y')
 274             {
 275                 return -1;
 276             }
 277         }
 278     }
 279
 280     return 0;
 281 }
 282
 283
 284 /******************************************************************************
 285  *
 286  * FUNCTION:    AsDisplayStats
 287  *
 288  * DESCRIPTION: Display global statistics gathered during translation
 289  *
 290  ******************************************************************************/
 291
 292 void
 293 AsDisplayStats (
 294     void)
 295 {
 296
 297     if (Gbl_QuietMode)
 298     {
 299         return;
 300     }
 301
 302     printf ("\nAcpiSrc statistics:\n\n");
 303     printf ("%8u Files processed\n", Gbl_Files);
 304     printf ("%8u Total bytes (%.1fK/file)\n",
 305         Gbl_TotalSize, ((double) Gbl_TotalSize/Gbl_Files)/1024);
 306     printf ("%8u Tabs found\n", Gbl_Tabs);
 307     printf ("%8u Missing if/else braces\n", Gbl_MissingBraces);
 308     printf ("%8u Non-ANSI comments found\n", Gbl_NonAnsiComments);
 309     printf ("%8u Total Lines\n", Gbl_TotalLines);
 310     printf ("%8u Lines of code\n", Gbl_SourceLines);
 311     printf ("%8u Lines of non-comment whitespace\n", Gbl_WhiteLines);
 312     printf ("%8u Lines of comments\n", Gbl_CommentLines);
 313     printf ("%8u Long lines found\n", Gbl_LongLines);
 314     printf ("%8.1f Ratio of code to whitespace\n",
 315         ((float) Gbl_SourceLines / (float) Gbl_WhiteLines));
 316     printf ("%8.1f Ratio of code to comments\n",
 317         ((float) Gbl_SourceLines / (float) (Gbl_CommentLines + Gbl_NonAnsiComments)));
 318     printf ("         %u%% code, %u%% comments, %u%% whitespace, %u%% headers\n",
 319         (Gbl_SourceLines * 100) / Gbl_TotalLines,
 320         (Gbl_CommentLines * 100) / Gbl_TotalLines,
 321         (Gbl_WhiteLines * 100) / Gbl_TotalLines,
 322         (Gbl_HeaderLines * 100) / Gbl_TotalLines);
 323     return;
 324 }
 325
 326
 327 /******************************************************************************
 328  *
 329  * FUNCTION:    AsDisplayUsage
 330  *
 331  * DESCRIPTION: Usage message
 332  *
 333  ******************************************************************************/
 334
 335 void
 336 AsDisplayUsage (
 337     void)
 338 {
 339
 340     printf ("\n");
 341     printf ("Usage: acpisrc [-c|l|u] [-dsvy] <SourceDir> <DestinationDir>\n\n");
 342     printf ("Where: -c          Generate cleaned version of the source\n");
 343     printf ("       -l          Generate Linux version of the source\n");
 344     printf ("       -u          Generate Custom source translation\n");
 345     printf ("\n");
 346     printf ("       -d          Leave debug statements in code\n");
 347     printf ("       -s          Generate source statistics only\n");
 348     printf ("       -v          Verbose mode\n");
 349     printf ("       -y          Suppress file overwrite prompts\n");
 350     printf ("\n");
 351     return;
 352 }
 353
 354
 355 /******************************************************************************
 356  *
 357  * FUNCTION:    main
 358  *
 359  * DESCRIPTION: C main function
 360  *
 361  ******************************************************************************/
 362
 363 int ACPI_SYSTEM_XFACE
 364 main (
 365     int                     argc,
 366     char                    *argv[])
 367 {
 368     int                     j;
 369     ACPI_CONVERSION_TABLE   *ConversionTable = NULL;
 370     char                    *SourcePath;
 371     char                    *TargetPath;
 372     UINT32                  FileType;
 373
 374
 375     printf ("ACPI Source Code Conversion Utility");
 376     printf (" version %8.8X", ((UINT32) ACPI_CA_VERSION));
 377     printf (" [%s]\n\n",  __DATE__);
 378
 379     if (argc < 2)
 380     {
 381         AsDisplayUsage ();
 382         return 0;
 383     }
 384
 385     /* Command line options */
 386
 387     while ((j = AcpiGetopt (argc, argv, "cdlqsuvy")) != EOF) switch(j)
 388     {
 389     case 'l':
 390         /* Linux code generation */
 391
 392         printf ("Creating Linux source code\n");
 393         ConversionTable = &LinuxConversionTable;
 394         Gbl_WidenDeclarations = TRUE;
 395         Gbl_IgnoreLoneLineFeeds = TRUE;
 396         break;
 397
 398     case 'c':
 399         /* Cleanup code */
 400
 401         printf ("Code cleanup\n");
 402         ConversionTable = &CleanupConversionTable;
 403         break;
 404
 405     case 's':
 406         /* Statistics only */
 407
 408         break;
 409
 410     case 'u':
 411         /* custom conversion  */
 412
 413         printf ("Custom source translation\n");
 414         ConversionTable = &CustomConversionTable;
 415         break;
 416
 417     case 'v':
 418         /* Verbose mode */
 419
 420         Gbl_VerboseMode = TRUE;
 421         break;
 422
 423     case 'y':
 424         /* Batch mode */
 425
 426         Gbl_BatchMode = TRUE;
 427         break;
 428
 429     case 'd':
 430         /* Leave debug statements in */
 431
 432         Gbl_DebugStatementsMode = TRUE;
 433         break;
 434
 435     case 'q':
 436         /* Quiet mode */
 437
 438         Gbl_QuietMode = TRUE;
 439         break;
 440
 441     default:
 442         AsDisplayUsage ();
 443         return -1;
 444     }
 445
 446
 447     SourcePath = argv[AcpiGbl_Optind];
 448     if (!SourcePath)
 449     {
 450         printf ("Missing source path\n");
 451         AsDisplayUsage ();
 452         return -1;
 453     }
 454
 455     TargetPath = argv[AcpiGbl_Optind+1];
 456
 457     if (!ConversionTable)
 458     {
 459         /* Just generate statistics.  Ignore target path */
 460
 461         TargetPath = SourcePath;
 462
 463         printf ("Source code statistics only\n");
 464         ConversionTable = &StatsConversionTable;
 465     }
 466     else if (!TargetPath)
 467     {
 468         TargetPath = SourcePath;
 469     }
 470
 471     if (Gbl_DebugStatementsMode)
 472     {
 473         ConversionTable->SourceFunctions &= ~CVT_REMOVE_DEBUG_MACROS;
 474     }
 475
 476     /* Check source and target paths and files */
 477
 478     if (AsExaminePaths (ConversionTable, SourcePath, TargetPath, &FileType))
 479     {
 480         return -1;
 481     }
 482
 483     /* Source/target can be either directories or a files */
 484
 485     if (FileType == S_IFDIR)
 486     {
 487         /* Process the directory tree */
 488
 489         AsProcessTree (ConversionTable, SourcePath, TargetPath);
 490     }
 491     else
 492     {
 493         /* Process a single file */
 494
 495         /* Differentiate between source and header files */
 496
 497         if (strstr (SourcePath, ".h"))
 498         {
 499             AsProcessOneFile (ConversionTable, NULL, TargetPath, 0, SourcePath, FILE_TYPE_HEADER);
 500         }
 501         else
 502         {
 503             AsProcessOneFile (ConversionTable, NULL, TargetPath, 0, SourcePath, FILE_TYPE_SOURCE);
 504         }
 505     }
 506
 507     /* Always display final summary and stats */
 508
 509     AsDisplayStats ();
 510
 511     return 0;
 512 }