BaseTools/Source/Python/Trim/Trim.py

   1 ## @file
   2 # Trim files preprocessed by compiler
   3 #
   4 # Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
   5 # SPDX-License-Identifier: BSD-2-Clause-Patent
   6 #
   7
   8 ##
   9 # Import Modules
  10 #
  11 import Common.LongFilePathOs as os
  12 import sys
  13 import re
  14 from io import BytesIO
  15 import codecs
  16 from optparse import OptionParser
  17 from optparse import make_option
  18 from Common.BuildToolError import *
  19 from Common.Misc import *
  20 from Common.DataType import *
  21 from Common.BuildVersion import gBUILD_VERSION
  22 import Common.EdkLogger as EdkLogger
  23 from Common.LongFilePathSupport import OpenLongFilePath as open
  24
  25 # Version and Copyright
  26 __version_number__ = ("0.10" + " " + gBUILD_VERSION)
  27 __version__ = "%prog Version " + __version_number__
  28 __copyright__ = "Copyright (c) 2007-2018, Intel Corporation. All rights reserved."
  29
  30 ## Regular expression for matching Line Control directive like "#line xxx"
  31 gLineControlDirective = re.compile('^\s*#(?:line)?\s+([0-9]+)\s+"*([^"]*)"')
  32 ## Regular expression for matching "typedef struct"
  33 gTypedefPattern = re.compile("^\s*typedef\s+struct(\s+\w+)?\s*[{]*$", re.MULTILINE)
  34 ## Regular expression for matching "#pragma pack"
  35 gPragmaPattern = re.compile("^\s*#pragma\s+pack", re.MULTILINE)
  36 ## Regular expression for matching "typedef"
  37 gTypedef_SinglePattern = re.compile("^\s*typedef", re.MULTILINE)
  38 ## Regular expression for matching "typedef struct, typedef union, struct, union"
  39 gTypedef_MulPattern = re.compile("^\s*(typedef)?\s+(struct|union)(\s+\w+)?\s*[{]*$", re.MULTILINE)
  40
  41 #
  42 # The following number pattern match will only match if following criteria is met:
  43 # There is leading non-(alphanumeric or _) character, and no following alphanumeric or _
  44 # as the pattern is greedily match, so it is ok for the gDecNumberPattern or gHexNumberPattern to grab the maximum match
  45 #
  46 ## Regular expression for matching HEX number
  47 gHexNumberPattern = re.compile("(?<=[^a-zA-Z0-9_])(0[xX])([0-9a-fA-F]+)(U(?=$|[^a-zA-Z0-9_]))?")
  48 ## Regular expression for matching decimal number with 'U' postfix
  49 gDecNumberPattern = re.compile("(?<=[^a-zA-Z0-9_])([0-9]+)U(?=$|[^a-zA-Z0-9_])")
  50 ## Regular expression for matching constant with 'ULL' 'LL' postfix
  51 gLongNumberPattern = re.compile("(?<=[^a-zA-Z0-9_])(0[xX][0-9a-fA-F]+|[0-9]+)U?LL(?=$|[^a-zA-Z0-9_])")
  52
  53 ## Regular expression for matching "Include ()" in asl file
  54 gAslIncludePattern = re.compile("^(\s*)[iI]nclude\s*\(\"?([^\"\(\)]+)\"\)", re.MULTILINE)
  55 ## Regular expression for matching C style #include "XXX.asl" in asl file
  56 gAslCIncludePattern = re.compile(r'^(\s*)#include\s*[<"]\s*([-\\/\w.]+)\s*([>"])', re.MULTILINE)
  57 ## Patterns used to convert EDK conventions to EDK2 ECP conventions
  58
  59 ## Regular expression for finding header file inclusions
  60 gIncludePattern = re.compile(r"^[ \t]*[%]?[ \t]*include(?:[ \t]*(?:\\(?:\r\n|\r|\n))*[ \t]*)*(?:\(?[\"<]?[ \t]*)([-\w.\\/() \t]+)(?:[ \t]*[\">]?\)?)", re.MULTILINE | re.UNICODE | re.IGNORECASE)
  61
  62
  63 ## file cache to avoid circular include in ASL file
  64 gIncludedAslFile = []
  65
  66 ## Trim preprocessed source code
  67 #
  68 # Remove extra content made by preprocessor. The preprocessor must enable the
  69 # line number generation option when preprocessing.
  70 #
  71 # @param  Source    File to be trimmed
  72 # @param  Target    File to store the trimmed content
  73 # @param  Convert   If True, convert standard HEX format to MASM format
  74 #
  75 def TrimPreprocessedFile(Source, Target, ConvertHex, TrimLong):
  76     CreateDirectory(os.path.dirname(Target))
  77     try:
  78         with open(Source, "r") as File:
  79             Lines = File.readlines()
  80     except IOError:
  81         EdkLogger.error("Trim", FILE_OPEN_FAILURE, ExtraData=Source)
  82     except:
  83         EdkLogger.error("Trim", AUTOGEN_ERROR, "TrimPreprocessedFile: Error while processing file", File=Source)
  84
  85     PreprocessedFile = ""
  86     InjectedFile = ""
  87     LineIndexOfOriginalFile = None
  88     NewLines = []
  89     LineControlDirectiveFound = False
  90     for Index in range(len(Lines)):
  91         Line = Lines[Index]
  92         #
  93         # Find out the name of files injected by preprocessor from the lines
  94         # with Line Control directive
  95         #
  96         MatchList = gLineControlDirective.findall(Line)
  97         if MatchList != []:
  98             MatchList = MatchList[0]
  99             if len(MatchList) == 2:
 100                 LineNumber = int(MatchList[0], 0)
 101                 InjectedFile = MatchList[1]
 102                 InjectedFile = os.path.normpath(InjectedFile)
 103                 InjectedFile = os.path.normcase(InjectedFile)
 104                 # The first injected file must be the preprocessed file itself
 105                 if PreprocessedFile == "":
 106                     PreprocessedFile = InjectedFile
 107             LineControlDirectiveFound = True
 108             continue
 109         elif PreprocessedFile == "" or InjectedFile != PreprocessedFile:
 110             continue
 111
 112         if LineIndexOfOriginalFile is None:
 113             #
 114             # Any non-empty lines must be from original preprocessed file.
 115             # And this must be the first one.
 116             #
 117             LineIndexOfOriginalFile = Index
 118             EdkLogger.verbose("Found original file content starting from line %d"
 119                               % (LineIndexOfOriginalFile + 1))
 120
 121         if TrimLong:
 122             Line = gLongNumberPattern.sub(r"\1", Line)
 123         # convert HEX number format if indicated
 124         if ConvertHex:
 125             Line = gHexNumberPattern.sub(r"0\2h", Line)
 126         else:
 127             Line = gHexNumberPattern.sub(r"\1\2", Line)
 128
 129         # convert Decimal number format
 130         Line = gDecNumberPattern.sub(r"\1", Line)
 131
 132         if LineNumber is not None:
 133             EdkLogger.verbose("Got line directive: line=%d" % LineNumber)
 134             # in case preprocessor removed some lines, like blank or comment lines
 135             if LineNumber <= len(NewLines):
 136                 # possible?
 137                 NewLines[LineNumber - 1] = Line
 138             else:
 139                 if LineNumber > (len(NewLines) + 1):
 140                     for LineIndex in range(len(NewLines), LineNumber-1):
 141                         NewLines.append(TAB_LINE_BREAK)
 142                 NewLines.append(Line)
 143             LineNumber = None
 144             EdkLogger.verbose("Now we have lines: %d" % len(NewLines))
 145         else:
 146             NewLines.append(Line)
 147
 148     # in case there's no line directive or linemarker found
 149     if (not LineControlDirectiveFound) and NewLines == []:
 150         MulPatternFlag = False
 151         SinglePatternFlag = False
 152         Brace = 0
 153         for Index in range(len(Lines)):
 154             Line = Lines[Index]
 155             if MulPatternFlag == False and gTypedef_MulPattern.search(Line) is None:
 156                 if SinglePatternFlag == False and gTypedef_SinglePattern.search(Line) is None:
 157                     # remove "#pragram pack" directive
 158                     if gPragmaPattern.search(Line) is None:
 159                         NewLines.append(Line)
 160                     continue
 161                 elif SinglePatternFlag == False:
 162                     SinglePatternFlag = True
 163                 if Line.find(";") >= 0:
 164                     SinglePatternFlag = False
 165             elif MulPatternFlag == False:
 166                 # found "typedef struct, typedef union, union, struct", keep its position and set a flag
 167                 MulPatternFlag = True
 168
 169             # match { and } to find the end of typedef definition
 170             if Line.find("{") >= 0:
 171                 Brace += 1
 172             elif Line.find("}") >= 0:
 173                 Brace -= 1
 174
 175             # "typedef struct, typedef union, union, struct" must end with a ";"
 176             if Brace == 0 and Line.find(";") >= 0:
 177                 MulPatternFlag = False
 178
 179     # save to file
 180     try:
 181         with open(Target, 'w') as File:
 182             File.writelines(NewLines)
 183     except:
 184         EdkLogger.error("Trim", FILE_OPEN_FAILURE, ExtraData=Target)
 185
 186 ## Trim preprocessed VFR file
 187 #
 188 # Remove extra content made by preprocessor. The preprocessor doesn't need to
 189 # enable line number generation option when preprocessing.
 190 #
 191 # @param  Source    File to be trimmed
 192 # @param  Target    File to store the trimmed content
 193 #
 194 def TrimPreprocessedVfr(Source, Target):
 195     CreateDirectory(os.path.dirname(Target))
 196
 197     try:
 198         with open(Source, "r") as File:
 199             Lines = File.readlines()
 200     except:
 201         EdkLogger.error("Trim", FILE_OPEN_FAILURE, ExtraData=Source)
 202     # read whole file
 203
 204     FoundTypedef = False
 205     Brace = 0
 206     TypedefStart = 0
 207     TypedefEnd = 0
 208     for Index in range(len(Lines)):
 209         Line = Lines[Index]
 210         # don't trim the lines from "formset" definition to the end of file
 211         if Line.strip() == 'formset':
 212             break
 213
 214         if FoundTypedef == False and (Line.find('#line') == 0 or Line.find('# ') == 0):
 215             # empty the line number directive if it's not aomong "typedef struct"
 216             Lines[Index] = "\n"
 217             continue
 218
 219         if FoundTypedef == False and gTypedefPattern.search(Line) is None:
 220             # keep "#pragram pack" directive
 221             if gPragmaPattern.search(Line) is None:
 222                 Lines[Index] = "\n"
 223             continue
 224         elif FoundTypedef == False:
 225             # found "typedef struct", keept its position and set a flag
 226             FoundTypedef = True
 227             TypedefStart = Index
 228
 229         # match { and } to find the end of typedef definition
 230         if Line.find("{") >= 0:
 231             Brace += 1
 232         elif Line.find("}") >= 0:
 233             Brace -= 1
 234
 235         # "typedef struct" must end with a ";"
 236         if Brace == 0 and Line.find(";") >= 0:
 237             FoundTypedef = False
 238             TypedefEnd = Index
 239             # keep all "typedef struct" except to GUID, EFI_PLABEL and PAL_CALL_RETURN
 240             if Line.strip("} ;\r\n") in [TAB_GUID, "EFI_PLABEL", "PAL_CALL_RETURN"]:
 241                 for i in range(TypedefStart, TypedefEnd+1):
 242                     Lines[i] = "\n"
 243
 244     # save all lines trimmed
 245     try:
 246         with open(Target, 'w') as File:
 247             File.writelines(Lines)
 248     except:
 249         EdkLogger.error("Trim", FILE_OPEN_FAILURE, ExtraData=Target)
 250
 251 ## Read the content  ASL file, including ASL included, recursively
 252 #
 253 # @param  Source            File to be read
 254 # @param  Indent            Spaces before the Include() statement
 255 # @param  IncludePathList   The list of external include file
 256 # @param  LocalSearchPath   If LocalSearchPath is specified, this path will be searched
 257 #                           first for the included file; otherwise, only the path specified
 258 #                           in the IncludePathList will be searched.
 259 #
 260 def DoInclude(Source, Indent='', IncludePathList=[], LocalSearchPath=None, IncludeFileList = None, filetype=None):
 261     NewFileContent = []
 262     if IncludeFileList is None:
 263         IncludeFileList = []
 264     try:
 265         #
 266         # Search LocalSearchPath first if it is specified.
 267         #
 268         if LocalSearchPath:
 269             SearchPathList = [LocalSearchPath] + IncludePathList
 270         else:
 271             SearchPathList = IncludePathList
 272
 273         for IncludePath in SearchPathList:
 274             IncludeFile = os.path.join(IncludePath, Source)
 275             if os.path.isfile(IncludeFile):
 276                 try:
 277                     with open(IncludeFile, "r") as File:
 278                         F = File.readlines()
 279                 except:
 280                     with codecs.open(IncludeFile, "r", encoding='utf-8') as File:
 281                         F = File.readlines()
 282                 break
 283         else:
 284             EdkLogger.warn("Trim", "Failed to find include file %s" % Source)
 285             return []
 286     except:
 287         EdkLogger.warn("Trim", FILE_OPEN_FAILURE, ExtraData=Source)
 288         return []
 289
 290
 291     # avoid A "include" B and B "include" A
 292     IncludeFile = os.path.abspath(os.path.normpath(IncludeFile))
 293     if IncludeFile in gIncludedAslFile:
 294         EdkLogger.warn("Trim", "Circular include",
 295                        ExtraData= "%s -> %s" % (" -> ".join(gIncludedAslFile), IncludeFile))
 296         return []
 297     gIncludedAslFile.append(IncludeFile)
 298     IncludeFileList.append(IncludeFile.strip())
 299     for Line in F:
 300         LocalSearchPath = None
 301         if filetype == "ASL":
 302             Result = gAslIncludePattern.findall(Line)
 303             if len(Result) == 0:
 304                 Result = gAslCIncludePattern.findall(Line)
 305                 if len(Result) == 0 or os.path.splitext(Result[0][1])[1].lower() not in [".asl", ".asi"]:
 306                     NewFileContent.append("%s%s" % (Indent, Line))
 307                     continue
 308                 #
 309                 # We should first search the local directory if current file are using pattern #include "XXX"
 310                 #
 311                 if Result[0][2] == '"':
 312                     LocalSearchPath = os.path.dirname(IncludeFile)
 313             CurrentIndent = Indent + Result[0][0]
 314             IncludedFile = Result[0][1]
 315             NewFileContent.extend(DoInclude(IncludedFile, CurrentIndent, IncludePathList, LocalSearchPath,IncludeFileList,filetype))
 316             NewFileContent.append("\n")
 317         elif filetype == "ASM":
 318             Result = gIncludePattern.findall(Line)
 319             if len(Result) == 0:
 320                 NewFileContent.append("%s%s" % (Indent, Line))
 321                 continue
 322
 323             IncludedFile = Result[0]
 324
 325             IncludedFile = IncludedFile.strip()
 326             IncludedFile = os.path.normpath(IncludedFile)
 327             NewFileContent.extend(DoInclude(IncludedFile, '', IncludePathList, LocalSearchPath,IncludeFileList,filetype))
 328             NewFileContent.append("\n")
 329
 330     gIncludedAslFile.pop()
 331
 332     return NewFileContent
 333
 334
 335 ## Trim ASL file
 336 #
 337 # Replace ASL include statement with the content the included file
 338 #
 339 # @param  Source          File to be trimmed
 340 # @param  Target          File to store the trimmed content
 341 # @param  IncludePathFile The file to log the external include path
 342 #
 343 def TrimAslFile(Source, Target, IncludePathFile,AslDeps = False):
 344     CreateDirectory(os.path.dirname(Target))
 345
 346     SourceDir = os.path.dirname(Source)
 347     if SourceDir == '':
 348         SourceDir = '.'
 349
 350     #
 351     # Add source directory as the first search directory
 352     #
 353     IncludePathList = [SourceDir]
 354
 355     #
 356     # If additional include path file is specified, append them all
 357     # to the search directory list.
 358     #
 359     if IncludePathFile:
 360         try:
 361             LineNum = 0
 362             with open(IncludePathFile, 'r') as File:
 363                 FileLines = File.readlines()
 364             for Line in FileLines:
 365                 LineNum += 1
 366                 if Line.startswith("/I") or Line.startswith ("-I"):
 367                     IncludePathList.append(Line[2:].strip())
 368                 else:
 369                     EdkLogger.warn("Trim", "Invalid include line in include list file.", IncludePathFile, LineNum)
 370         except:
 371             EdkLogger.error("Trim", FILE_OPEN_FAILURE, ExtraData=IncludePathFile)
 372     AslIncludes = []
 373     Lines = DoInclude(Source, '', IncludePathList,IncludeFileList=AslIncludes,filetype='ASL')
 374     AslIncludes = [item for item in AslIncludes if item !=Source]
 375     SaveFileOnChange(os.path.join(os.path.dirname(Target),os.path.basename(Source))+".trim.deps", " \\\n".join([Source+":"] +AslIncludes),False)
 376
 377     #
 378     # Undef MIN and MAX to avoid collision in ASL source code
 379     #
 380     Lines.insert(0, "#undef MIN\n#undef MAX\n")
 381
 382     # save all lines trimmed
 383     try:
 384         with open(Target, 'w') as File:
 385             File.writelines(Lines)
 386     except:
 387         EdkLogger.error("Trim", FILE_OPEN_FAILURE, ExtraData=Target)
 388
 389 ## Trim ASM file
 390 #
 391 # Output ASM include statement with the content the included file
 392 #
 393 # @param  Source          File to be trimmed
 394 # @param  Target          File to store the trimmed content
 395 # @param  IncludePathFile The file to log the external include path
 396 #
 397 def TrimAsmFile(Source, Target, IncludePathFile):
 398     CreateDirectory(os.path.dirname(Target))
 399
 400     SourceDir = os.path.dirname(Source)
 401     if SourceDir == '':
 402         SourceDir = '.'
 403
 404     #
 405     # Add source directory as the first search directory
 406     #
 407     IncludePathList = [SourceDir]
 408     #
 409     # If additional include path file is specified, append them all
 410     # to the search directory list.
 411     #
 412     if IncludePathFile:
 413         try:
 414             LineNum = 0
 415             with open(IncludePathFile, 'r') as File:
 416                 FileLines = File.readlines()
 417             for Line in FileLines:
 418                 LineNum += 1
 419                 if Line.startswith("/I") or Line.startswith ("-I"):
 420                     IncludePathList.append(Line[2:].strip())
 421                 else:
 422                     EdkLogger.warn("Trim", "Invalid include line in include list file.", IncludePathFile, LineNum)
 423         except:
 424             EdkLogger.error("Trim", FILE_OPEN_FAILURE, ExtraData=IncludePathFile)
 425     AsmIncludes = []
 426     Lines = DoInclude(Source, '', IncludePathList,IncludeFileList=AsmIncludes,filetype='ASM')
 427     AsmIncludes = [item for item in AsmIncludes if item != Source]
 428     if AsmIncludes:
 429         SaveFileOnChange(os.path.join(os.path.dirname(Target),os.path.basename(Source))+".trim.deps", " \\\n".join([Source+":"] +AsmIncludes),False)
 430     # save all lines trimmed
 431     try:
 432         with open(Target, 'w') as File:
 433             File.writelines(Lines)
 434     except:
 435         EdkLogger.error("Trim", FILE_OPEN_FAILURE, ExtraData=Target)
 436
 437 def GenerateVfrBinSec(ModuleName, DebugDir, OutputFile):
 438     VfrNameList = []
 439     if os.path.isdir(DebugDir):
 440         for CurrentDir, Dirs, Files in os.walk(DebugDir):
 441             for FileName in Files:
 442                 Name, Ext = os.path.splitext(FileName)
 443                 if Ext == '.c' and Name != 'AutoGen':
 444                     VfrNameList.append (Name + 'Bin')
 445
 446     VfrNameList.append (ModuleName + 'Strings')
 447
 448     EfiFileName = os.path.join(DebugDir, ModuleName + '.efi')
 449     MapFileName = os.path.join(DebugDir, ModuleName + '.map')
 450     VfrUniOffsetList = GetVariableOffset(MapFileName, EfiFileName, VfrNameList)
 451
 452     if not VfrUniOffsetList:
 453         return
 454
 455     try:
 456         fInputfile = open(OutputFile, "wb+")
 457     except:
 458         EdkLogger.error("Trim", FILE_OPEN_FAILURE, "File open failed for %s" %OutputFile, None)
 459
 460     # Use a instance of BytesIO to cache data
 461     fStringIO = BytesIO()
 462
 463     for Item in VfrUniOffsetList:
 464         if (Item[0].find("Strings") != -1):
 465             #
 466             # UNI offset in image.
 467             # GUID + Offset
 468             # { 0x8913c5e0, 0x33f6, 0x4d86, { 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66 } }
 469             #
 470             UniGuid = b'\xe0\xc5\x13\x89\xf63\x86M\x9b\xf1C\xef\x89\xfc\x06f'
 471             fStringIO.write(UniGuid)
 472             UniValue = pack ('Q', int (Item[1], 16))
 473             fStringIO.write (UniValue)
 474         else:
 475             #
 476             # VFR binary offset in image.
 477             # GUID + Offset
 478             # { 0xd0bc7cb4, 0x6a47, 0x495f, { 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2 } };
 479             #
 480             VfrGuid = b'\xb4|\xbc\xd0Gj_I\xaa\x11q\x07F\xda\x06\xa2'
 481             fStringIO.write(VfrGuid)
 482             type (Item[1])
 483             VfrValue = pack ('Q', int (Item[1], 16))
 484             fStringIO.write (VfrValue)
 485
 486     #
 487     # write data into file.
 488     #
 489     try :
 490         fInputfile.write (fStringIO.getvalue())
 491     except:
 492         EdkLogger.error("Trim", FILE_WRITE_FAILURE, "Write data to file %s failed, please check whether the file been locked or using by other applications." %OutputFile, None)
 493
 494     fStringIO.close ()
 495     fInputfile.close ()
 496
 497
 498 ## Parse command line options
 499 #
 500 # Using standard Python module optparse to parse command line option of this tool.
 501 #
 502 # @retval Options   A optparse.Values object containing the parsed options
 503 # @retval InputFile Path of file to be trimmed
 504 #
 505 def Options():
 506     OptionList = [
 507         make_option("-s", "--source-code", dest="FileType", const="SourceCode", action="store_const",
 508                           help="The input file is preprocessed source code, including C or assembly code"),
 509         make_option("-r", "--vfr-file", dest="FileType", const="Vfr", action="store_const",
 510                           help="The input file is preprocessed VFR file"),
 511         make_option("--Vfr-Uni-Offset", dest="FileType", const="VfrOffsetBin", action="store_const",
 512                           help="The input file is EFI image"),
 513         make_option("--asl-deps", dest="AslDeps", const="True", action="store_const",
 514                           help="Generate Asl dependent files."),
 515         make_option("-a", "--asl-file", dest="FileType", const="Asl", action="store_const",
 516                           help="The input file is ASL file"),
 517         make_option( "--asm-file", dest="FileType", const="Asm", action="store_const",
 518                           help="The input file is asm file"),
 519         make_option("-c", "--convert-hex", dest="ConvertHex", action="store_true",
 520                           help="Convert standard hex format (0xabcd) to MASM format (abcdh)"),
 521
 522         make_option("-l", "--trim-long", dest="TrimLong", action="store_true",
 523                           help="Remove postfix of long number"),
 524         make_option("-i", "--include-path-file", dest="IncludePathFile",
 525                           help="The input file is include path list to search for ASL include file"),
 526         make_option("-o", "--output", dest="OutputFile",
 527                           help="File to store the trimmed content"),
 528         make_option("--ModuleName", dest="ModuleName", help="The module's BASE_NAME"),
 529         make_option("--DebugDir", dest="DebugDir",
 530                           help="Debug Output directory to store the output files"),
 531         make_option("-v", "--verbose", dest="LogLevel", action="store_const", const=EdkLogger.VERBOSE,
 532                           help="Run verbosely"),
 533         make_option("-d", "--debug", dest="LogLevel", type="int",
 534                           help="Run with debug information"),
 535         make_option("-q", "--quiet", dest="LogLevel", action="store_const", const=EdkLogger.QUIET,
 536                           help="Run quietly"),
 537         make_option("-?", action="help", help="show this help message and exit"),
 538     ]
 539
 540     # use clearer usage to override default usage message
 541     UsageString = "%prog [-s|-r|-a|--Vfr-Uni-Offset] [-c] [-v|-d <debug_level>|-q] [-i <include_path_file>] [-o <output_file>] [--ModuleName <ModuleName>] [--DebugDir <DebugDir>] [<input_file>]"
 542
 543     Parser = OptionParser(description=__copyright__, version=__version__, option_list=OptionList, usage=UsageString)
 544     Parser.set_defaults(FileType="Vfr")
 545     Parser.set_defaults(ConvertHex=False)
 546     Parser.set_defaults(LogLevel=EdkLogger.INFO)
 547
 548     Options, Args = Parser.parse_args()
 549
 550     # error check
 551     if Options.FileType == 'VfrOffsetBin':
 552         if len(Args) == 0:
 553             return Options, ''
 554         elif len(Args) > 1:
 555             EdkLogger.error("Trim", OPTION_NOT_SUPPORTED, ExtraData=Parser.get_usage())
 556     if len(Args) == 0:
 557         EdkLogger.error("Trim", OPTION_MISSING, ExtraData=Parser.get_usage())
 558     if len(Args) > 1:
 559         EdkLogger.error("Trim", OPTION_NOT_SUPPORTED, ExtraData=Parser.get_usage())
 560
 561     InputFile = Args[0]
 562     return Options, InputFile
 563
 564 ## Entrance method
 565 #
 566 # This method mainly dispatch specific methods per the command line options.
 567 # If no error found, return zero value so the caller of this tool can know
 568 # if it's executed successfully or not.
 569 #
 570 # @retval 0     Tool was successful
 571 # @retval 1     Tool failed
 572 #
 573 def Main():
 574     try:
 575         EdkLogger.Initialize()
 576         CommandOptions, InputFile = Options()
 577         if CommandOptions.LogLevel < EdkLogger.DEBUG_9:
 578             EdkLogger.SetLevel(CommandOptions.LogLevel + 1)
 579         else:
 580             EdkLogger.SetLevel(CommandOptions.LogLevel)
 581     except FatalError as X:
 582         return 1
 583
 584     try:
 585         if CommandOptions.FileType == "Vfr":
 586             if CommandOptions.OutputFile is None:
 587                 CommandOptions.OutputFile = os.path.splitext(InputFile)[0] + '.iii'
 588             TrimPreprocessedVfr(InputFile, CommandOptions.OutputFile)
 589         elif CommandOptions.FileType == "Asl":
 590             if CommandOptions.OutputFile is None:
 591                 CommandOptions.OutputFile = os.path.splitext(InputFile)[0] + '.iii'
 592             TrimAslFile(InputFile, CommandOptions.OutputFile, CommandOptions.IncludePathFile,CommandOptions.AslDeps)
 593         elif CommandOptions.FileType == "VfrOffsetBin":
 594             GenerateVfrBinSec(CommandOptions.ModuleName, CommandOptions.DebugDir, CommandOptions.OutputFile)
 595         elif CommandOptions.FileType == "Asm":
 596             TrimAsmFile(InputFile, CommandOptions.OutputFile, CommandOptions.IncludePathFile)
 597         else :
 598             if CommandOptions.OutputFile is None:
 599                 CommandOptions.OutputFile = os.path.splitext(InputFile)[0] + '.iii'
 600             TrimPreprocessedFile(InputFile, CommandOptions.OutputFile, CommandOptions.ConvertHex, CommandOptions.TrimLong)
 601     except FatalError as X:
 602         import platform
 603         import traceback
 604         if CommandOptions is not None and CommandOptions.LogLevel <= EdkLogger.DEBUG_9:
 605             EdkLogger.quiet("(Python %s on %s) " % (platform.python_version(), sys.platform) + traceback.format_exc())
 606         return 1
 607     except:
 608         import traceback
 609         import platform
 610         EdkLogger.error(
 611                     "\nTrim",
 612                     CODE_ERROR,
 613                     "Unknown fatal error when trimming [%s]" % InputFile,
 614                     ExtraData="\n(Please send email to %s for help, attaching following call stack trace!)\n" % MSG_EDKII_MAIL_ADDR,
 615                     RaiseError=False
 616                     )
 617         EdkLogger.quiet("(Python %s on %s) " % (platform.python_version(), sys.platform) + traceback.format_exc())
 618         return 1
 619
 620     return 0
 621
 622 if __name__ == '__main__':
 623     r = Main()
 624     ## 0-127 is a safe return range, and 1 is a standard default error
 625     if r < 0 or r > 127: r = 1
 626     sys.exit(r)
 627