BaseTools/Source/Python/Ecc/Configuration.py

   1 ## @file
   2 # This file is used to define class Configuration
   3 #
   4 # Copyright (c) 2008, Intel Corporation. All rights reserved.<BR>
   5 # This program and the accompanying materials
   6 # are licensed and made available under the terms and conditions of the BSD License
   7 # which accompanies this distribution.  The full text of the license may be found at
   8 # http://opensource.org/licenses/bsd-license.php
   9 #
  10 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12 #
  13
  14 ##
  15 # Import Modules
  16 #
  17 import os
  18 import Common.EdkLogger as EdkLogger
  19 from Common.DataType import *
  20 from Common.String import *
  21
  22 ## Configuration
  23 #
  24 # This class is used to define all items in configuration file
  25 #
  26 # @param Filename:  The name of configuration file, the default is config.ini
  27 #
  28 class Configuration(object):
  29     def __init__(self, Filename):
  30         self.Filename = Filename
  31
  32         self.Version = 0.1
  33
  34         ## Identify to if check all items
  35         # 1 - Check all items and ignore all other detailed items
  36         # 0 - Not check all items, the tool will go through all other detailed items to decide to check or not
  37         #
  38         self.CheckAll = 0
  39
  40         ## Identify to if automatically correct mistakes
  41         # 1 - Automatically correct
  42         # 0 - Not automatically correct
  43         # Only the following check points can be automatically corrected, others not listed below are not supported even it is 1
  44         #
  45         # GeneralCheckTab
  46         # GeneralCheckIndentation
  47         # GeneralCheckLine
  48         # GeneralCheckCarriageReturn
  49         # SpaceCheckAll
  50         #
  51         self.AutoCorrect = 0
  52
  53         # List customized Modifer here, split with ','
  54         # Defaultly use the definition in class DataType
  55         self.ModifierList = MODIFIER_LIST
  56
  57         ## General Checking
  58         self.GeneralCheckAll = 0
  59
  60         # Check whether NO Tab is used, replaced with spaces
  61         self.GeneralCheckNoTab = 1
  62         # The width of Tab
  63         self.GeneralCheckTabWidth = 2
  64         # Check whether the indentation is followed coding style
  65         self.GeneralCheckIndentation = 1
  66         # The width of indentation
  67         self.GeneralCheckIndentationWidth = 2
  68         # Check whether no line is exceeding defined widty
  69         self.GeneralCheckLine = 1
  70         # The width of a line
  71         self.GeneralCheckLineWidth = 120
  72         # Check whether no use of _asm in the source file
  73         self.GeneralCheckNo_Asm = 1
  74         # Check whether no use of "#progma" in source file except "#pragma pack(#)".
  75         self.GeneralCheckNoProgma = 1
  76         # Check whether there is a carriage return at the end of the file
  77         self.GeneralCheckCarriageReturn = 1
  78         # Check whether the file exists
  79         self.GeneralCheckFileExistence = 1
  80
  81         ## Space Checking
  82         self.SpaceCheckAll = 1
  83
  84         ## Predicate Expression Checking
  85         self.PredicateExpressionCheckAll = 0
  86
  87         # Check whether Boolean values, variable type BOOLEAN not use explicit comparisons to TRUE or FALSE
  88         self.PredicateExpressionCheckBooleanValue = 1
  89         # Check whether Non-Boolean comparisons use a compare operator (==, !=, >, < >=, <=).
  90         self.PredicateExpressionCheckNonBooleanOperator = 1
  91         # Check whether a comparison of any pointer to zero must be done via the NULL type
  92         self.PredicateExpressionCheckComparisonNullType = 1
  93
  94         ## Headers Checking
  95         self.HeaderCheckAll = 0
  96
  97         # Check whether File header exists
  98         self.HeaderCheckFile = 1
  99         # Check whether Function header exists
 100         self.HeaderCheckFunction = 1
 101
 102         ## C Function Layout Checking
 103         self.CFunctionLayoutCheckAll = 0
 104
 105         # Check whether return type exists and in the first line
 106         self.CFunctionLayoutCheckReturnType = 1
 107         # Check whether any optional functional modifiers exist and next to the return type
 108         self.CFunctionLayoutCheckOptionalFunctionalModifier = 1
 109         # Check whether the next line contains the function name, left justified, followed by the beginning of the parameter list
 110         # Check whether the closing parenthesis is on its own line and also indented two spaces
 111         self.CFunctionLayoutCheckFunctionName = 1
 112         # Check whether the function prototypes in include files have the same form as function definitions
 113         self.CFunctionLayoutCheckFunctionPrototype = 1
 114         # Check whether the body of a function is contained by open and close braces that must be in the first column
 115         self.CFunctionLayoutCheckFunctionBody = 1
 116         # Check whether the data declarations is the first code in a module.
 117         self.CFunctionLayoutCheckDataDeclaration = 1
 118         # Check whether no initialization of a variable as part of its declaration
 119         self.CFunctionLayoutCheckNoInitOfVariable = 1
 120         # Check whether no use of STATIC for functions
 121         self.CFunctionLayoutCheckNoStatic = 1
 122
 123         ## Include Files Checking
 124         self.IncludeFileCheckAll = 0
 125
 126         #Check whether having include files with same name
 127         self.IncludeFileCheckSameName = 1
 128         # Check whether all include file contents is guarded by a #ifndef statement.
 129         # the #ifndef must be the first line of code following the file header comment
 130         # the #endif must appear on the last line in the file
 131         self.IncludeFileCheckIfndefStatement = 1
 132         # Check whether include files contain only public or only private data
 133         # Check whether include files NOT contain code or define data variables
 134         self.IncludeFileCheckData = 1
 135
 136         ## Declarations and Data Types Checking
 137         self.DeclarationDataTypeCheckAll = 0
 138
 139         # Check whether no use of int, unsigned, char, void, static, long in any .c, .h or .asl files.
 140         self.DeclarationDataTypeCheckNoUseCType = 1
 141         # Check whether the modifiers IN, OUT, OPTIONAL, and UNALIGNED are used only to qualify arguments to a function and should not appear in a data type declaration
 142         self.DeclarationDataTypeCheckInOutModifier = 1
 143         # Check whether the EFIAPI modifier should be used at the entry of drivers, events, and member functions of protocols
 144         self.DeclarationDataTypeCheckEFIAPIModifier = 1
 145         # Check whether Enumerated Type has a 'typedef' and the name is capital
 146         self.DeclarationDataTypeCheckEnumeratedType = 1
 147         # Check whether Structure Type has a 'typedef' and the name is capital
 148         self.DeclarationDataTypeCheckStructureDeclaration = 1
 149         # Check whether having same Structure
 150         self.DeclarationDataTypeCheckSameStructure = 1
 151         # Check whether Union Type has a 'typedef' and the name is capital
 152         self.DeclarationDataTypeCheckUnionType = 1
 153
 154         ## Naming Conventions Checking
 155         self.NamingConventionCheckAll = 0
 156
 157         # Check whether only capital letters are used for #define declarations
 158         self.NamingConventionCheckDefineStatement = 1
 159         # Check whether only capital letters are used for typedef declarations
 160         self.NamingConventionCheckTypedefStatement = 1
 161         # Check whether the #ifndef at the start of an include file uses both prefix and postfix underscore characters, '_'.
 162         self.NamingConventionCheckIfndefStatement = 1
 163         # Rule for path name, variable name and function name
 164         # 1. First character should be upper case
 165         # 2. Existing lower case in a word
 166         # 3. No space existence
 167         # Check whether the path name followed the rule
 168         self.NamingConventionCheckPathName = 1
 169         # Check whether the variable name followed the rule
 170         self.NamingConventionCheckVariableName = 1
 171         # Check whether the function name followed the rule
 172         self.NamingConventionCheckFunctionName = 1
 173         # Check whether NO use short variable name with single character
 174         self.NamingConventionCheckSingleCharacterVariable = 1
 175
 176         ## Doxygen Checking
 177         self.DoxygenCheckAll = 0
 178
 179         # Check whether the file headers are followed Doxygen special documentation blocks in section 2.3.5
 180         self.DoxygenCheckFileHeader = 1
 181         # Check whether the function headers are followed Doxygen special documentation blocks in section 2.3.5
 182         self.DoxygenCheckFunctionHeader = 1
 183         # Check whether the first line of text in a comment block is a brief description of the element being documented.
 184         # The brief description must end with a period.
 185         self.DoxygenCheckCommentDescription = 1
 186         # Check whether comment lines with '///< ... text ...' format, if it is used, it should be after the code section.
 187         self.DoxygenCheckCommentFormat = 1
 188         # Check whether only Doxygen commands allowed to mark the code are @bug and @todo.
 189         self.DoxygenCheckCommand = 1
 190
 191         ## Meta-Data File Processing Checking
 192         self.MetaDataFileCheckAll = 0
 193
 194         # Check whether each file defined in meta-data exists
 195         self.MetaDataFileCheckPathName = 1
 196         # Generate a list for all files defined in meta-data files
 197         self.MetaDataFileCheckGenerateFileList = 1
 198         # The path of log file
 199         self.MetaDataFileCheckPathOfGenerateFileList = 'File.log'
 200         # Check whether all Library Instances defined for a given module (or dependent library instance) match the module's type.
 201         # Each Library Instance must specify the Supported Module Types in its INF file,
 202         # and any module specifying the library instance must be one of the supported types.
 203         self.MetaDataFileCheckLibraryInstance = 1
 204         # Check whether a Library Instance has been defined for all dependent library classes
 205         self.MetaDataFileCheckLibraryInstanceDependent = 1
 206         # Check whether the Library Instances specified by the LibraryClasses sections are listed in order of dependencies
 207         self.MetaDataFileCheckLibraryInstanceOrder = 1
 208         # Check whether the unnecessary inclusion of library classes in the INF file
 209         self.MetaDataFileCheckLibraryNoUse = 1
 210         # Check whether an INF file is specified in the FDF file, but not in the DSC file, then the INF file must be for a Binary module only
 211         self.MetaDataFileCheckBinaryInfInFdf = 1
 212         # Not to report error and warning related OS include file such as "windows.h" and "stdio.h"
 213         # Check whether a PCD is set in a DSC file or the FDF file, but not in both.
 214         self.MetaDataFileCheckPcdDuplicate = 1
 215         # Check whether PCD settings in the FDF file can only be related to flash.
 216         self.MetaDataFileCheckPcdFlash = 1
 217         # Check whether PCDs used in INF files but not specified in DSC or FDF files
 218         self.MetaDataFileCheckPcdNoUse = 1
 219         # Check whether having duplicate guids defined for Guid/Protocol/Ppi
 220         self.MetaDataFileCheckGuidDuplicate = 1
 221         # Check whether all files under module directory are described in INF files
 222         self.MetaDataFileCheckModuleFileNoUse = 1
 223         # Check whether the PCD is correctly used in C function via its type
 224         self.MetaDataFileCheckPcdType = 1
 225         # Check whether there are FILE_GUID duplication among different INF files
 226         self.MetaDataFileCheckModuleFileGuidDuplication = 1
 227
 228         #
 229         # The check points in this section are reserved
 230         #
 231         # GotoStatementCheckAll = 0
 232         #
 233         self.SpellingCheckAll = 0
 234
 235         # The directory listed here will not be parsed, split with ','
 236         self.SkipDirList = []
 237
 238         self.ParseConfig()
 239
 240     def ParseConfig(self):
 241         Filepath = os.path.normpath(self.Filename)
 242         if not os.path.isfile(Filepath):
 243             ErrorMsg = "Can't find configuration file '%s'" % Filepath
 244             EdkLogger.error("Ecc", EdkLogger.ECC_ERROR, ErrorMsg, File = Filepath)
 245
 246         LineNo = 0
 247         for Line in open(Filepath, 'r'):
 248             LineNo = LineNo + 1
 249             Line = CleanString(Line)
 250             if Line != '':
 251                 List = GetSplitValueList(Line, TAB_EQUAL_SPLIT)
 252                 if List[0] not in self.__dict__:
 253                     ErrorMsg = "Invalid configuration option '%s' was found" % List[0]
 254                     EdkLogger.error("Ecc", EdkLogger.ECC_ERROR, ErrorMsg, File = Filepath, Line = LineNo)
 255                 if List[0] == 'ModifierList':
 256                     List[1] = GetSplitValueList(List[1], TAB_COMMA_SPLIT)
 257                 if List[0] == 'MetaDataFileCheckPathOfGenerateFileList' and List[1] == "":
 258                     continue
 259                 if List[0] == 'SkipDirList':
 260                     List[1] = GetSplitValueList(List[1], TAB_COMMA_SPLIT)
 261                 self.__dict__[List[0]] = List[1]
 262
 263     def ShowMe(self):
 264         print self.Filename
 265         for Key in self.__dict__.keys():
 266             print Key, '=', self.__dict__[Key]