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