Sync BaseTool trunk (version r2670) into EDKII BaseTools.

[mirror_edk2.git] / BaseTools / Source / Python / Ecc / Configuration.py

## @file\r
# This file is used to define class Configuration\r
#\r
# Copyright (c) 2008 - 2014, Intel Corporation. All rights reserved.<BR>\r
# This program and the accompanying materials\r
# are licensed and made available under the terms and conditions of the BSD License\r
# which accompanies this distribution.  The full text of the license may be found at\r
# http://opensource.org/licenses/bsd-license.php\r
#\r
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
#\r
\r
##\r
# Import Modules\r
#\r
import os\r
import Common.EdkLogger as EdkLogger\r
from Common.DataType import *\r
from Common.String import *\r
\r
## Configuration\r
#\r
# This class is used to define all items in configuration file\r
#\r
# @param Filename:  The name of configuration file, the default is config.ini\r
#\r
class Configuration(object):\r
    def __init__(self, Filename):\r
        self.Filename = Filename\r
\r
        self.Version = 0.1\r
\r
        ## Identify to if check all items\r
        # 1 - Check all items and ignore all other detailed items\r
        # 0 - Not check all items, the tool will go through all other detailed items to decide to check or not\r
        #\r
        self.CheckAll = 0\r
\r
        ## Identify to if automatically correct mistakes\r
        # 1 - Automatically correct\r
        # 0 - Not automatically correct\r
        # Only the following check points can be automatically corrected, others not listed below are not supported even it is 1\r
        #\r
        # GeneralCheckTab\r
        # GeneralCheckIndentation\r
        # GeneralCheckLine\r
        # GeneralCheckCarriageReturn\r
        # SpaceCheckAll\r
        #\r
        self.AutoCorrect = 0\r
\r
        # List customized Modifer here, split with ','\r
        # Defaultly use the definition in class DataType\r
        self.ModifierList = MODIFIER_LIST\r
\r
        ## General Checking\r
        self.GeneralCheckAll = 0\r
\r
        # Check whether NO Tab is used, replaced with spaces\r
        self.GeneralCheckNoTab = 1\r
        # The width of Tab\r
        self.GeneralCheckTabWidth = 2\r
        # Check whether the indentation is followed coding style\r
        self.GeneralCheckIndentation = 1\r
        # The width of indentation\r
        self.GeneralCheckIndentationWidth = 2\r
        # Check whether no line is exceeding defined widty\r
        self.GeneralCheckLine = 1\r
        # The width of a line\r
        self.GeneralCheckLineWidth = 120\r
        # Check whether no use of _asm in the source file\r
        self.GeneralCheckNo_Asm = 1\r
        # Check whether no use of "#progma" in source file except "#pragma pack(#)".\r
        self.GeneralCheckNoProgma = 1\r
        # Check whether there is a carriage return at the end of the file\r
        self.GeneralCheckCarriageReturn = 1\r
        # Check whether the file exists\r
        self.GeneralCheckFileExistence = 1\r
        # Check whether file has non ACSII char\r
        self.GeneralCheckNonAcsii = 1\r
\r
        ## Space Checking\r
        self.SpaceCheckAll = 1\r
\r
        ## Predicate Expression Checking\r
        self.PredicateExpressionCheckAll = 0\r
\r
        # Check whether Boolean values, variable type BOOLEAN not use explicit comparisons to TRUE or FALSE\r
        self.PredicateExpressionCheckBooleanValue = 1\r
        # Check whether Non-Boolean comparisons use a compare operator (==, !=, >, < >=, <=).\r
        self.PredicateExpressionCheckNonBooleanOperator = 1\r
        # Check whether a comparison of any pointer to zero must be done via the NULL type\r
        self.PredicateExpressionCheckComparisonNullType = 1\r
\r
        ## Headers Checking\r
        self.HeaderCheckAll = 0\r
\r
        # Check whether File header exists\r
        self.HeaderCheckFile = 1\r
        # Check whether Function header exists\r
        self.HeaderCheckFunction = 1\r
        # Check whether Meta data File header Comment End with '##'\r
        self.HeaderCheckFileCommentEnd = 1\r
        # Check whether C File header Comment content start with two spaces\r
        self.HeaderCheckCFileCommentStartSpacesNum = 1\r
        # Check whether C File header Comment's each reference at list should begin with a bullet character '-'\r
        self.HeaderCheckCFileCommentReferenceFormat = 1\r
        # Check whether C File header Comment have the License immediately after the ""Copyright"" line\r
        self.HeaderCheckCFileCommentLicenseFormat = 1\r
  \r
        ## C Function Layout Checking\r
        self.CFunctionLayoutCheckAll = 0\r
\r
        # Check whether return type exists and in the first line\r
        self.CFunctionLayoutCheckReturnType = 1\r
        # Check whether any optional functional modifiers exist and next to the return type\r
        self.CFunctionLayoutCheckOptionalFunctionalModifier = 1\r
        # Check whether the next line contains the function name, left justified, followed by the beginning of the parameter list\r
        # Check whether the closing parenthesis is on its own line and also indented two spaces\r
        self.CFunctionLayoutCheckFunctionName = 1\r
        # Check whether the function prototypes in include files have the same form as function definitions\r
        self.CFunctionLayoutCheckFunctionPrototype = 1\r
        # Check whether the body of a function is contained by open and close braces that must be in the first column\r
        self.CFunctionLayoutCheckFunctionBody = 1\r
        # Check whether the data declarations is the first code in a module.\r
        self.CFunctionLayoutCheckDataDeclaration = 1\r
        # Check whether no initialization of a variable as part of its declaration\r
        self.CFunctionLayoutCheckNoInitOfVariable = 1\r
        # Check whether no use of STATIC for functions\r
        self.CFunctionLayoutCheckNoStatic = 1\r
\r
        ## Include Files Checking\r
        self.IncludeFileCheckAll = 0\r
\r
        #Check whether having include files with same name\r
        self.IncludeFileCheckSameName = 1\r
        # Check whether all include file contents is guarded by a #ifndef statement.\r
        # the #ifndef must be the first line of code following the file header comment\r
        # the #endif must appear on the last line in the file\r
        self.IncludeFileCheckIfndefStatement = 1\r
        # Check whether include files contain only public or only private data\r
        # Check whether include files NOT contain code or define data variables\r
        self.IncludeFileCheckData = 1\r
\r
        ## Declarations and Data Types Checking\r
        self.DeclarationDataTypeCheckAll = 0\r
\r
        # Check whether no use of int, unsigned, char, void, static, long in any .c, .h or .asl files.\r
        self.DeclarationDataTypeCheckNoUseCType = 1\r
        # 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\r
        self.DeclarationDataTypeCheckInOutModifier = 1\r
        # Check whether the EFIAPI modifier should be used at the entry of drivers, events, and member functions of protocols\r
        self.DeclarationDataTypeCheckEFIAPIModifier = 1\r
        # Check whether Enumerated Type has a 'typedef' and the name is capital\r
        self.DeclarationDataTypeCheckEnumeratedType = 1\r
        # Check whether Structure Type has a 'typedef' and the name is capital\r
        self.DeclarationDataTypeCheckStructureDeclaration = 1\r
        # Check whether having same Structure\r
        self.DeclarationDataTypeCheckSameStructure = 1\r
        # Check whether Union Type has a 'typedef' and the name is capital\r
        self.DeclarationDataTypeCheckUnionType = 1\r
\r
        ## Naming Conventions Checking\r
        self.NamingConventionCheckAll = 0\r
\r
        # Check whether only capital letters are used for #define declarations\r
        self.NamingConventionCheckDefineStatement = 1\r
        # Check whether only capital letters are used for typedef declarations\r
        self.NamingConventionCheckTypedefStatement = 1\r
        # Check whether the #ifndef at the start of an include file uses both prefix and postfix underscore characters, '_'.\r
        self.NamingConventionCheckIfndefStatement = 1\r
        # Rule for path name, variable name and function name\r
        # 1. First character should be upper case\r
        # 2. Existing lower case in a word\r
        # 3. No space existence\r
        # Check whether the path name followed the rule\r
        self.NamingConventionCheckPathName = 1\r
        # Check whether the variable name followed the rule\r
        self.NamingConventionCheckVariableName = 1\r
        # Check whether the function name followed the rule\r
        self.NamingConventionCheckFunctionName = 1\r
        # Check whether NO use short variable name with single character\r
        self.NamingConventionCheckSingleCharacterVariable = 1\r
\r
        ## Doxygen Checking\r
        self.DoxygenCheckAll = 0\r
\r
        # Check whether the file headers are followed Doxygen special documentation blocks in section 2.3.5\r
        self.DoxygenCheckFileHeader = 1\r
        # Check whether the function headers are followed Doxygen special documentation blocks in section 2.3.5\r
        self.DoxygenCheckFunctionHeader = 1\r
        # Check whether the first line of text in a comment block is a brief description of the element being documented.\r
        # The brief description must end with a period.\r
        self.DoxygenCheckCommentDescription = 1\r
        # Check whether comment lines with '///< ... text ...' format, if it is used, it should be after the code section.\r
        self.DoxygenCheckCommentFormat = 1\r
        # Check whether only Doxygen commands allowed to mark the code are @bug and @todo.\r
        self.DoxygenCheckCommand = 1\r
\r
        ## Meta-Data File Processing Checking\r
        self.MetaDataFileCheckAll = 0\r
\r
        # Check whether each file defined in meta-data exists\r
        self.MetaDataFileCheckPathName = 1\r
        # Generate a list for all files defined in meta-data files\r
        self.MetaDataFileCheckGenerateFileList = 1\r
        # The path of log file\r
        self.MetaDataFileCheckPathOfGenerateFileList = 'File.log'\r
        # Check whether all Library Instances defined for a given module (or dependent library instance) match the module's type.\r
        # Each Library Instance must specify the Supported Module Types in its INF file,\r
        # and any module specifying the library instance must be one of the supported types.\r
        self.MetaDataFileCheckLibraryInstance = 1\r
        # Check whether a Library Instance has been defined for all dependent library classes\r
        self.MetaDataFileCheckLibraryInstanceDependent = 1\r
        # Check whether the Library Instances specified by the LibraryClasses sections are listed in order of dependencies\r
        self.MetaDataFileCheckLibraryInstanceOrder = 1\r
        # Check whether the unnecessary inclusion of library classes in the INF file\r
        self.MetaDataFileCheckLibraryNoUse = 1\r
        # 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\r
        self.MetaDataFileCheckBinaryInfInFdf = 1\r
        # Not to report error and warning related OS include file such as "windows.h" and "stdio.h"\r
        # Check whether a PCD is set in a DSC file or the FDF file, but not in both.\r
        self.MetaDataFileCheckPcdDuplicate = 1\r
        # Check whether PCD settings in the FDF file can only be related to flash.\r
        self.MetaDataFileCheckPcdFlash = 1\r
        # Check whether PCDs used in INF files but not specified in DSC or FDF files\r
        self.MetaDataFileCheckPcdNoUse = 1\r
        # Check whether having duplicate guids defined for Guid/Protocol/Ppi\r
        self.MetaDataFileCheckGuidDuplicate = 1\r
        # Check whether all files under module directory are described in INF files\r
        self.MetaDataFileCheckModuleFileNoUse = 1\r
        # Check whether the PCD is correctly used in C function via its type\r
        self.MetaDataFileCheckPcdType = 1\r
        # Check whether there are FILE_GUID duplication among different INF files\r
        self.MetaDataFileCheckModuleFileGuidDuplication = 1\r
\r
        #\r
        # The check points in this section are reserved\r
        #\r
        # GotoStatementCheckAll = 0\r
        #\r
        self.SpellingCheckAll = 0\r
\r
        # The directory listed here will not be parsed, split with ','\r
        self.SkipDirList = []\r
\r
        # A list for binary file ext name\r
        self.BinaryExtList = []\r
        \r
        # A list for only scanned folders\r
        self.ScanOnlyDirList = []\r
\r
        self.ParseConfig()\r
\r
    def ParseConfig(self):\r
        Filepath = os.path.normpath(self.Filename)\r
        if not os.path.isfile(Filepath):\r
            ErrorMsg = "Can't find configuration file '%s'" % Filepath\r
            EdkLogger.error("Ecc", EdkLogger.ECC_ERROR, ErrorMsg, File = Filepath)\r
\r
        LineNo = 0\r
        for Line in open(Filepath, 'r'):\r
            LineNo = LineNo + 1\r
            Line = CleanString(Line)\r
            if Line != '':\r
                List = GetSplitValueList(Line, TAB_EQUAL_SPLIT)\r
                if List[0] not in self.__dict__:\r
                    ErrorMsg = "Invalid configuration option '%s' was found" % List[0]\r
                    EdkLogger.error("Ecc", EdkLogger.ECC_ERROR, ErrorMsg, File = Filepath, Line = LineNo)\r
                if List[0] == 'ModifierList':\r
                    List[1] = GetSplitValueList(List[1], TAB_COMMA_SPLIT)\r
                if List[0] == 'MetaDataFileCheckPathOfGenerateFileList' and List[1] == "":\r
                    continue\r
                if List[0] == 'SkipDirList':\r
                    List[1] = GetSplitValueList(List[1], TAB_COMMA_SPLIT)\r
                if List[0] == 'BinaryExtList':\r
                    List[1] = GetSplitValueList(List[1], TAB_COMMA_SPLIT)\r
                self.__dict__[List[0]] = List[1]\r
\r
    def ShowMe(self):\r
        print self.Filename\r
        for Key in self.__dict__.keys():\r
            print Key, '=', self.__dict__[Key]\r