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

## @file\r
# This file is used to be the main entrance of ECC tool\r
#\r
# Copyright (c) 2009 - 2010, 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, time, glob, sys\r
import Common.EdkLogger as EdkLogger\r
import Database\r
import EccGlobalData\r
from MetaDataParser import *\r
from optparse import OptionParser\r
from Configuration import Configuration\r
from Check import Check\r
from Common.InfClassObject import Inf\r
from Common.DecClassObject import Dec\r
from Common.DscClassObject import Dsc\r
from Common.FdfClassObject import Fdf\r
from Common.String import NormPath\r
from Common import BuildToolError\r
import c\r
import re, string\r
from Exception import *\r
\r
## Ecc\r
#\r
# This class is used to define Ecc main entrance\r
#\r
# @param object:          Inherited from object class\r
#\r
class Ecc(object):\r
    def __init__(self):\r
        # Version and Copyright\r
        self.VersionNumber = "0.01"\r
        self.Version = "%prog Version " + self.VersionNumber\r
        self.Copyright = "Copyright (c) 2009 - 2010, Intel Corporation  All rights reserved."\r
\r
        self.InitDefaultConfigIni()\r
        self.OutputFile = 'output.txt'\r
        self.ReportFile = 'Report.csv'\r
        self.ExceptionFile = 'exception.xml'\r
        self.IsInit = True\r
        self.ScanSourceCode = True\r
        self.ScanMetaData = True\r
\r
        # Parse the options and args\r
        self.ParseOption()\r
\r
        # Generate checkpoints list\r
        EccGlobalData.gConfig = Configuration(self.ConfigFile)\r
\r
        # Generate exception list\r
        EccGlobalData.gException = ExceptionCheck(self.ExceptionFile)\r
\r
        # Init Ecc database\r
        EccGlobalData.gDb = Database.Database(Database.DATABASE_PATH)\r
        EccGlobalData.gDb.InitDatabase(self.IsInit)\r
\r
        # Build ECC database\r
        self.BuildDatabase()\r
\r
        # Start to check\r
        self.Check()\r
\r
        # Show report\r
        self.GenReport()\r
\r
        # Close Database\r
        EccGlobalData.gDb.Close()\r
\r
    def InitDefaultConfigIni(self):\r
        paths = map(lambda p: os.path.join(p, 'Ecc', 'config.ini'), sys.path)\r
        paths = (os.path.realpath('config.ini'),) + tuple(paths)\r
        for path in paths:\r
            if os.path.exists(path):\r
                self.ConfigFile = path\r
                return\r
        self.ConfigFile = 'config.ini'\r
\r
    ## BuildDatabase\r
    #\r
    # Build the database for target\r
    #\r
    def BuildDatabase(self):\r
        # Clean report table\r
        EccGlobalData.gDb.TblReport.Drop()\r
        EccGlobalData.gDb.TblReport.Create()\r
\r
        # Build database\r
        if self.IsInit:\r
            if self.ScanSourceCode:\r
                EdkLogger.quiet("Building database for source code ...")\r
                c.CollectSourceCodeDataIntoDB(EccGlobalData.gTarget)\r
            if self.ScanMetaData:\r
                EdkLogger.quiet("Building database for source code done!")\r
                self.BuildMetaDataFileDatabase()\r
\r
        EccGlobalData.gIdentifierTableList = GetTableList((MODEL_FILE_C, MODEL_FILE_H), 'Identifier', EccGlobalData.gDb)\r
        EccGlobalData.gCFileList = GetFileList(MODEL_FILE_C, EccGlobalData.gDb)\r
        EccGlobalData.gHFileList = GetFileList(MODEL_FILE_H, EccGlobalData.gDb)\r
\r
    ## BuildMetaDataFileDatabase\r
    #\r
    # Build the database for meta data files\r
    #\r
    def BuildMetaDataFileDatabase(self):\r
        EdkLogger.quiet("Building database for meta data files ...")\r
        Op = open(EccGlobalData.gConfig.MetaDataFileCheckPathOfGenerateFileList, 'w+')\r
        #SkipDirs = Read from config file\r
        SkipDirs = EccGlobalData.gConfig.SkipDirList\r
        SkipDirString = string.join(SkipDirs, '|')\r
        p = re.compile(r'.*[\\/](?:%s)[\\/]?.*' % SkipDirString)\r
        for Root, Dirs, Files in os.walk(EccGlobalData.gTarget):\r
            if p.match(Root.upper()):\r
                continue\r
\r
            for Dir in Dirs:\r
                Dirname = os.path.join(Root, Dir)\r
                if os.path.islink(Dirname):\r
                    Dirname = os.path.realpath(Dirname)\r
                    if os.path.isdir(Dirname):\r
                        # symlinks to directories are treated as directories\r
                        Dirs.remove(Dir)\r
                        Dirs.append(Dirname)\r
\r
            for File in Files:\r
                if len(File) > 4 and File[-4:].upper() == ".DEC":\r
                    Filename = os.path.normpath(os.path.join(Root, File))\r
                    EdkLogger.quiet("Parsing %s" % Filename)\r
                    Op.write("%s\r" % Filename)\r
                    Dec(Filename, True, True, EccGlobalData.gWorkspace, EccGlobalData.gDb)\r
                    continue\r
                if len(File) > 4 and File[-4:].upper() == ".DSC":\r
                    Filename = os.path.normpath(os.path.join(Root, File))\r
                    EdkLogger.quiet("Parsing %s" % Filename)\r
                    Op.write("%s\r" % Filename)\r
                    Dsc(Filename, True, True, EccGlobalData.gWorkspace, EccGlobalData.gDb)\r
                    continue\r
                if len(File) > 4 and File[-4:].upper() == ".INF":\r
                    Filename = os.path.normpath(os.path.join(Root, File))\r
                    EdkLogger.quiet("Parsing %s" % Filename)\r
                    Op.write("%s\r" % Filename)\r
                    Inf(Filename, True, True, EccGlobalData.gWorkspace, EccGlobalData.gDb)\r
                    continue\r
                if len(File) > 4 and File[-4:].upper() == ".FDF":\r
                    Filename = os.path.normpath(os.path.join(Root, File))\r
                    EdkLogger.quiet("Parsing %s" % Filename)\r
                    Op.write("%s\r" % Filename)\r
                    Fdf(Filename, True, EccGlobalData.gWorkspace, EccGlobalData.gDb)\r
                    continue\r
        Op.close()\r
\r
        # Commit to database\r
        EccGlobalData.gDb.Conn.commit()\r
\r
        EdkLogger.quiet("Building database for meta data files done!")\r
\r
    ##\r
    #\r
    # Check each checkpoint\r
    #\r
    def Check(self):\r
        EdkLogger.quiet("Checking ...")\r
        EccCheck = Check()\r
        EccCheck.Check()\r
        EdkLogger.quiet("Checking  done!")\r
\r
    ##\r
    #\r
    # Generate the scan report\r
    #\r
    def GenReport(self):\r
        EdkLogger.quiet("Generating report ...")\r
        EccGlobalData.gDb.TblReport.ToCSV(self.ReportFile)\r
        EdkLogger.quiet("Generating report done!")\r
\r
    def GetRealPathCase(self, path):\r
        TmpPath = path.rstrip(os.sep)\r
        PathParts = TmpPath.split(os.sep)\r
        if len(PathParts) == 0:\r
            return path\r
        if len(PathParts) == 1:\r
            if PathParts[0].strip().endswith(':'):\r
                return PathParts[0].upper()\r
            # Relative dir, list . current dir\r
            Dirs = os.listdir('.')\r
            for Dir in Dirs:\r
                if Dir.upper() == PathParts[0].upper():\r
                    return Dir\r
\r
        if PathParts[0].strip().endswith(':'):\r
            PathParts[0] = PathParts[0].upper()\r
        ParentDir = PathParts[0]\r
        RealPath = ParentDir\r
        if PathParts[0] == '':\r
            RealPath = os.sep\r
            ParentDir = os.sep\r
\r
        PathParts.remove(PathParts[0])    # need to remove the parent\r
        for Part in PathParts:\r
            Dirs = os.listdir(ParentDir + os.sep)\r
            for Dir in Dirs:\r
                if Dir.upper() == Part.upper():\r
                    RealPath += os.sep\r
                    RealPath += Dir\r
                    break\r
            ParentDir += os.sep\r
            ParentDir += Dir\r
\r
        return RealPath\r
\r
    ## ParseOption\r
    #\r
    # Parse options\r
    #\r
    def ParseOption(self):\r
        EdkLogger.quiet("Loading ECC configuration ... done")\r
        (Options, Target) = self.EccOptionParser()\r
\r
        if Options.Workspace:\r
            os.environ["WORKSPACE"] = Options.Workspace\r
\r
        # Check workspace envirnoment\r
        if "WORKSPACE" not in os.environ:\r
            EdkLogger.error("ECC", BuildToolError.ATTRIBUTE_NOT_AVAILABLE, "Environment variable not found",\r
                            ExtraData="WORKSPACE")\r
        else:\r
            EccGlobalData.gWorkspace = os.path.normpath(os.getenv("WORKSPACE"))\r
            if not os.path.exists(EccGlobalData.gWorkspace):\r
                EdkLogger.error("ECC", BuildToolError.FILE_NOT_FOUND, ExtraData="WORKSPACE = %s" % EccGlobalData.gWorkspace)\r
            os.environ["WORKSPACE"] = EccGlobalData.gWorkspace\r
        # Set log level\r
        self.SetLogLevel(Options)\r
\r
        # Set other options\r
        if Options.ConfigFile != None:\r
            self.ConfigFile = Options.ConfigFile\r
        if Options.OutputFile != None:\r
            self.OutputFile = Options.OutputFile\r
        if Options.ReportFile != None:\r
            self.ReportFile = Options.ReportFile\r
        if Options.ExceptionFile != None:\r
            self.ExceptionFile = Options.ExceptionFile\r
        if Options.Target != None:\r
            if not os.path.isdir(Options.Target):\r
                EdkLogger.error("ECC", BuildToolError.OPTION_VALUE_INVALID, ExtraData="Target [%s] does NOT exist" % Options.Target)\r
            else:\r
                EccGlobalData.gTarget = self.GetRealPathCase(os.path.normpath(Options.Target))\r
        else:\r
            EdkLogger.warn("Ecc", EdkLogger.ECC_ERROR, "The target source tree was not specified, using current WORKSPACE instead!")\r
            EccGlobalData.gTarget = os.path.normpath(os.getenv("WORKSPACE"))\r
        if Options.keepdatabase != None:\r
            self.IsInit = False\r
        if Options.metadata != None and Options.sourcecode != None:\r
            EdkLogger.error("ECC", BuildToolError.OPTION_CONFLICT, ExtraData="-m and -s can't be specified at one time")\r
        if Options.metadata != None:\r
            self.ScanSourceCode = False\r
        if Options.sourcecode != None:\r
            self.ScanMetaData = False\r
\r
    ## SetLogLevel\r
    #\r
    # Set current log level of the tool based on args\r
    #\r
    # @param Option:  The option list including log level setting\r
    #\r
    def SetLogLevel(self, Option):\r
        if Option.verbose != None:\r
            EdkLogger.SetLevel(EdkLogger.VERBOSE)\r
        elif Option.quiet != None:\r
            EdkLogger.SetLevel(EdkLogger.QUIET)\r
        elif Option.debug != None:\r
            EdkLogger.SetLevel(Option.debug + 1)\r
        else:\r
            EdkLogger.SetLevel(EdkLogger.INFO)\r
\r
    ## Parse command line options\r
    #\r
    # Using standard Python module optparse to parse command line option of this tool.\r
    #\r
    # @retval Opt   A optparse.Values object containing the parsed options\r
    # @retval Args  Target of build command\r
    #\r
    def EccOptionParser(self):\r
        Parser = OptionParser(description = self.Copyright, version = self.Version, prog = "Ecc.exe", usage = "%prog [options]")\r
        Parser.add_option("-t", "--target sourcepath", action="store", type="string", dest='Target',\r
            help="Check all files under the target workspace.")\r
        Parser.add_option("-c", "--config filename", action="store", type="string", dest="ConfigFile",\r
            help="Specify a configuration file. Defaultly use config.ini under ECC tool directory.")\r
        Parser.add_option("-o", "--outfile filename", action="store", type="string", dest="OutputFile",\r
            help="Specify the name of an output file, if and only if one filename was specified.")\r
        Parser.add_option("-r", "--reportfile filename", action="store", type="string", dest="ReportFile",\r
            help="Specify the name of an report file, if and only if one filename was specified.")\r
        Parser.add_option("-e", "--exceptionfile filename", action="store", type="string", dest="ExceptionFile",\r
            help="Specify the name of an exception file, if and only if one filename was specified.")\r
        Parser.add_option("-m", "--metadata", action="store_true", type=None, help="Only scan meta-data files information if this option is specified.")\r
        Parser.add_option("-s", "--sourcecode", action="store_true", type=None, help="Only scan source code files information if this option is specified.")\r
        Parser.add_option("-k", "--keepdatabase", action="store_true", type=None, help="The existing Ecc database will not be cleaned except report information if this option is specified.")\r
        Parser.add_option("-l", "--log filename", action="store", dest="LogFile", help="""If specified, the tool should emit the changes that\r
                                                                                          were made by the tool after printing the result message.\r
                                                                                          If filename, the emit to the file, otherwise emit to\r
                                                                                          standard output. If no modifications were made, then do not\r
                                                                                          create a log file, or output a log message.""")\r
        Parser.add_option("-q", "--quiet", action="store_true", type=None, help="Disable all messages except FATAL ERRORS.")\r
        Parser.add_option("-v", "--verbose", action="store_true", type=None, help="Turn on verbose output with informational messages printed, "\\r
                                                                                   "including library instances selected, final dependency expression, "\\r
                                                                                   "and warning messages, etc.")\r
        Parser.add_option("-d", "--debug", action="store", type="int", help="Enable debug messages at specified level.")\r
        Parser.add_option("-w", "--workspace", action="store", type="string", dest='Workspace', help="Specify workspace.")\r
\r
        (Opt, Args)=Parser.parse_args()\r
\r
        return (Opt, Args)\r
\r
##\r
#\r
# This acts like the main() function for the script, unless it is 'import'ed into another\r
# script.\r
#\r
if __name__ == '__main__':\r
    # Initialize log system\r
    EdkLogger.Initialize()\r
    EdkLogger.IsRaiseError = False\r
    EdkLogger.quiet(time.strftime("%H:%M:%S, %b.%d %Y ", time.localtime()) + "[00:00]" + "\n")\r
\r
    StartTime = time.clock()\r
    Ecc = Ecc()\r
    FinishTime = time.clock()\r
\r
    BuildDuration = time.strftime("%M:%S", time.gmtime(int(round(FinishTime - StartTime))))\r
    EdkLogger.quiet("\n%s [%s]" % (time.strftime("%H:%M:%S, %b.%d %Y", time.localtime()), BuildDuration))\r
Commit	Line	Data
30fdf114 LG	1	## @file\r
	2	# This file is used to be the main entrance of ECC tool\r
	3	#\r
40d841f6 LG	4	# Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
40d841f6 LG	5	# This program and the accompanying materials\r
30fdf114 LG	6	# are licensed and made available under the terms and conditions of the BSD License\r
	7	# which accompanies this distribution. The full text of the license may be found at\r
	8	# http://opensource.org/licenses/bsd-license.php\r
	9	#\r
	10	# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	12	#\r
	13	\r
	14	##\r
	15	# Import Modules\r
	16	#\r
	17	import os, time, glob, sys\r
	18	import Common.EdkLogger as EdkLogger\r
	19	import Database\r
	20	import EccGlobalData\r
	21	from MetaDataParser import *\r
	22	from optparse import OptionParser\r
	23	from Configuration import Configuration\r
	24	from Check import Check\r
	25	from Common.InfClassObject import Inf\r
	26	from Common.DecClassObject import Dec\r
	27	from Common.DscClassObject import Dsc\r
	28	from Common.FdfClassObject import Fdf\r
	29	from Common.String import NormPath\r
	30	from Common import BuildToolError\r
	31	import c\r
fd171542	32	import re, string\r
30fdf114 LG	33	from Exception import *\r
	34	\r
	35	## Ecc\r
	36	#\r
	37	# This class is used to define Ecc main entrance\r
	38	#\r
	39	# @param object: Inherited from object class\r
	40	#\r
	41	class Ecc(object):\r
	42	def __init__(self):\r
	43	# Version and Copyright\r
	44	self.VersionNumber = "0.01"\r
	45	self.Version = "%prog Version " + self.VersionNumber\r
52302d4d	46	self.Copyright = "Copyright (c) 2009 - 2010, Intel Corporation All rights reserved."\r
30fdf114 LG	47	\r
	48	self.InitDefaultConfigIni()\r
	49	self.OutputFile = 'output.txt'\r
	50	self.ReportFile = 'Report.csv'\r
	51	self.ExceptionFile = 'exception.xml'\r
	52	self.IsInit = True\r
	53	self.ScanSourceCode = True\r
	54	self.ScanMetaData = True\r
fd171542	55	\r
30fdf114 LG	56	# Parse the options and args\r
	57	self.ParseOption()\r
	58	\r
	59	# Generate checkpoints list\r
	60	EccGlobalData.gConfig = Configuration(self.ConfigFile)\r
fd171542	61	\r
30fdf114 LG	62	# Generate exception list\r
30fdf114 LG	63	EccGlobalData.gException = ExceptionCheck(self.ExceptionFile)\r
fd171542	64	\r
30fdf114 LG	65	# Init Ecc database\r
	66	EccGlobalData.gDb = Database.Database(Database.DATABASE_PATH)\r
	67	EccGlobalData.gDb.InitDatabase(self.IsInit)\r
fd171542	68	\r
30fdf114 LG	69	# Build ECC database\r
30fdf114 LG	70	self.BuildDatabase()\r
fd171542	71	\r
30fdf114 LG	72	# Start to check\r
30fdf114 LG	73	self.Check()\r
fd171542	74	\r
30fdf114 LG	75	# Show report\r
30fdf114 LG	76	self.GenReport()\r
fd171542	77	\r
30fdf114 LG	78	# Close Database\r
	79	EccGlobalData.gDb.Close()\r
	80	\r
	81	def InitDefaultConfigIni(self):\r
	82	paths = map(lambda p: os.path.join(p, 'Ecc', 'config.ini'), sys.path)\r
	83	paths = (os.path.realpath('config.ini'),) + tuple(paths)\r
	84	for path in paths:\r
	85	if os.path.exists(path):\r
	86	self.ConfigFile = path\r
	87	return\r
	88	self.ConfigFile = 'config.ini'\r
	89	\r
	90	## BuildDatabase\r
	91	#\r
	92	# Build the database for target\r
	93	#\r
	94	def BuildDatabase(self):\r
	95	# Clean report table\r
	96	EccGlobalData.gDb.TblReport.Drop()\r
	97	EccGlobalData.gDb.TblReport.Create()\r
fd171542	98	\r
30fdf114 LG	99	# Build database\r
	100	if self.IsInit:\r
	101	if self.ScanSourceCode:\r
	102	EdkLogger.quiet("Building database for source code ...")\r
	103	c.CollectSourceCodeDataIntoDB(EccGlobalData.gTarget)\r
	104	if self.ScanMetaData:\r
	105	EdkLogger.quiet("Building database for source code done!")\r
	106	self.BuildMetaDataFileDatabase()\r
fd171542	107	\r
30fdf114	108	EccGlobalData.gIdentifierTableList = GetTableList((MODEL_FILE_C, MODEL_FILE_H), 'Identifier', EccGlobalData.gDb)\r
e56468c0	109	EccGlobalData.gCFileList = GetFileList(MODEL_FILE_C, EccGlobalData.gDb)\r
e56468c0	110	EccGlobalData.gHFileList = GetFileList(MODEL_FILE_H, EccGlobalData.gDb)\r
fd171542	111	\r
30fdf114 LG	112	## BuildMetaDataFileDatabase\r
	113	#\r
	114	# Build the database for meta data files\r
	115	#\r
	116	def BuildMetaDataFileDatabase(self):\r
	117	EdkLogger.quiet("Building database for meta data files ...")\r
	118	Op = open(EccGlobalData.gConfig.MetaDataFileCheckPathOfGenerateFileList, 'w+')\r
	119	#SkipDirs = Read from config file\r
	120	SkipDirs = EccGlobalData.gConfig.SkipDirList\r
fd171542	121	SkipDirString = string.join(SkipDirs, '\|')\r
fd171542	122	p = re.compile(r'.[\\/](?:%s)[\\/]?.' % SkipDirString)\r
30fdf114	123	for Root, Dirs, Files in os.walk(EccGlobalData.gTarget):\r
fd171542	124	if p.match(Root.upper()):\r
fd171542	125	continue\r
30fdf114 LG	126	\r
	127	for Dir in Dirs:\r
	128	Dirname = os.path.join(Root, Dir)\r
	129	if os.path.islink(Dirname):\r
	130	Dirname = os.path.realpath(Dirname)\r
	131	if os.path.isdir(Dirname):\r
	132	# symlinks to directories are treated as directories\r
	133	Dirs.remove(Dir)\r
	134	Dirs.append(Dirname)\r
	135	\r
	136	for File in Files:\r
	137	if len(File) > 4 and File[-4:].upper() == ".DEC":\r
	138	Filename = os.path.normpath(os.path.join(Root, File))\r
	139	EdkLogger.quiet("Parsing %s" % Filename)\r
	140	Op.write("%s\r" % Filename)\r
	141	Dec(Filename, True, True, EccGlobalData.gWorkspace, EccGlobalData.gDb)\r
	142	continue\r
	143	if len(File) > 4 and File[-4:].upper() == ".DSC":\r
	144	Filename = os.path.normpath(os.path.join(Root, File))\r
	145	EdkLogger.quiet("Parsing %s" % Filename)\r
	146	Op.write("%s\r" % Filename)\r
	147	Dsc(Filename, True, True, EccGlobalData.gWorkspace, EccGlobalData.gDb)\r
	148	continue\r
	149	if len(File) > 4 and File[-4:].upper() == ".INF":\r
	150	Filename = os.path.normpath(os.path.join(Root, File))\r
	151	EdkLogger.quiet("Parsing %s" % Filename)\r
	152	Op.write("%s\r" % Filename)\r
	153	Inf(Filename, True, True, EccGlobalData.gWorkspace, EccGlobalData.gDb)\r
	154	continue\r
	155	if len(File) > 4 and File[-4:].upper() == ".FDF":\r
	156	Filename = os.path.normpath(os.path.join(Root, File))\r
	157	EdkLogger.quiet("Parsing %s" % Filename)\r
	158	Op.write("%s\r" % Filename)\r
fd171542	159	Fdf(Filename, True, EccGlobalData.gWorkspace, EccGlobalData.gDb)\r
30fdf114 LG	160	continue\r
30fdf114 LG	161	Op.close()\r
fd171542	162	\r
30fdf114 LG	163	# Commit to database\r
30fdf114 LG	164	EccGlobalData.gDb.Conn.commit()\r
fd171542	165	\r
30fdf114	166	EdkLogger.quiet("Building database for meta data files done!")\r
fd171542	167	\r
30fdf114 LG	168	##\r
	169	#\r
	170	# Check each checkpoint\r
	171	#\r
	172	def Check(self):\r
	173	EdkLogger.quiet("Checking ...")\r
	174	EccCheck = Check()\r
	175	EccCheck.Check()\r
	176	EdkLogger.quiet("Checking done!")\r
fd171542	177	\r
30fdf114 LG	178	##\r
	179	#\r
	180	# Generate the scan report\r
	181	#\r
	182	def GenReport(self):\r
	183	EdkLogger.quiet("Generating report ...")\r
	184	EccGlobalData.gDb.TblReport.ToCSV(self.ReportFile)\r
	185	EdkLogger.quiet("Generating report done!")\r
fd171542	186	\r
30fdf114 LG	187	def GetRealPathCase(self, path):\r
	188	TmpPath = path.rstrip(os.sep)\r
	189	PathParts = TmpPath.split(os.sep)\r
	190	if len(PathParts) == 0:\r
	191	return path\r
	192	if len(PathParts) == 1:\r
	193	if PathParts[0].strip().endswith(':'):\r
	194	return PathParts[0].upper()\r
	195	# Relative dir, list . current dir\r
	196	Dirs = os.listdir('.')\r
	197	for Dir in Dirs:\r
	198	if Dir.upper() == PathParts[0].upper():\r
	199	return Dir\r
fd171542	200	\r
30fdf114 LG	201	if PathParts[0].strip().endswith(':'):\r
	202	PathParts[0] = PathParts[0].upper()\r
	203	ParentDir = PathParts[0]\r
	204	RealPath = ParentDir\r
	205	if PathParts[0] == '':\r
	206	RealPath = os.sep\r
	207	ParentDir = os.sep\r
fd171542	208	\r
30fdf114 LG	209	PathParts.remove(PathParts[0]) # need to remove the parent\r
	210	for Part in PathParts:\r
	211	Dirs = os.listdir(ParentDir + os.sep)\r
	212	for Dir in Dirs:\r
	213	if Dir.upper() == Part.upper():\r
	214	RealPath += os.sep\r
	215	RealPath += Dir\r
	216	break\r
	217	ParentDir += os.sep\r
	218	ParentDir += Dir\r
fd171542	219	\r
30fdf114	220	return RealPath\r
fd171542	221	\r
30fdf114 LG	222	## ParseOption\r
	223	#\r
	224	# Parse options\r
	225	#\r
	226	def ParseOption(self):\r
	227	EdkLogger.quiet("Loading ECC configuration ... done")\r
	228	(Options, Target) = self.EccOptionParser()\r
fd171542	229	\r
52302d4d LG	230	if Options.Workspace:\r
52302d4d LG	231	os.environ["WORKSPACE"] = Options.Workspace\r
e56468c0	232	\r
30fdf114 LG	233	# Check workspace envirnoment\r
30fdf114 LG	234	if "WORKSPACE" not in os.environ:\r
fd171542	235	EdkLogger.error("ECC", BuildToolError.ATTRIBUTE_NOT_AVAILABLE, "Environment variable not found",\r
30fdf114 LG	236	ExtraData="WORKSPACE")\r
	237	else:\r
	238	EccGlobalData.gWorkspace = os.path.normpath(os.getenv("WORKSPACE"))\r
	239	if not os.path.exists(EccGlobalData.gWorkspace):\r
	240	EdkLogger.error("ECC", BuildToolError.FILE_NOT_FOUND, ExtraData="WORKSPACE = %s" % EccGlobalData.gWorkspace)\r
	241	os.environ["WORKSPACE"] = EccGlobalData.gWorkspace\r
	242	# Set log level\r
	243	self.SetLogLevel(Options)\r
fd171542	244	\r
30fdf114 LG	245	# Set other options\r
	246	if Options.ConfigFile != None:\r
	247	self.ConfigFile = Options.ConfigFile\r
	248	if Options.OutputFile != None:\r
	249	self.OutputFile = Options.OutputFile\r
	250	if Options.ReportFile != None:\r
	251	self.ReportFile = Options.ReportFile\r
52302d4d LG	252	if Options.ExceptionFile != None:\r
52302d4d LG	253	self.ExceptionFile = Options.ExceptionFile\r
30fdf114 LG	254	if Options.Target != None:\r
	255	if not os.path.isdir(Options.Target):\r
	256	EdkLogger.error("ECC", BuildToolError.OPTION_VALUE_INVALID, ExtraData="Target [%s] does NOT exist" % Options.Target)\r
	257	else:\r
	258	EccGlobalData.gTarget = self.GetRealPathCase(os.path.normpath(Options.Target))\r
	259	else:\r
	260	EdkLogger.warn("Ecc", EdkLogger.ECC_ERROR, "The target source tree was not specified, using current WORKSPACE instead!")\r
	261	EccGlobalData.gTarget = os.path.normpath(os.getenv("WORKSPACE"))\r
	262	if Options.keepdatabase != None:\r
	263	self.IsInit = False\r
	264	if Options.metadata != None and Options.sourcecode != None:\r
	265	EdkLogger.error("ECC", BuildToolError.OPTION_CONFLICT, ExtraData="-m and -s can't be specified at one time")\r
	266	if Options.metadata != None:\r
	267	self.ScanSourceCode = False\r
	268	if Options.sourcecode != None:\r
	269	self.ScanMetaData = False\r
fd171542	270	\r
30fdf114 LG	271	## SetLogLevel\r
	272	#\r
	273	# Set current log level of the tool based on args\r
	274	#\r
fd171542	275	# @param Option: The option list including log level setting\r
30fdf114 LG	276	#\r
	277	def SetLogLevel(self, Option):\r
	278	if Option.verbose != None:\r
	279	EdkLogger.SetLevel(EdkLogger.VERBOSE)\r
	280	elif Option.quiet != None:\r
	281	EdkLogger.SetLevel(EdkLogger.QUIET)\r
	282	elif Option.debug != None:\r
	283	EdkLogger.SetLevel(Option.debug + 1)\r
	284	else:\r
	285	EdkLogger.SetLevel(EdkLogger.INFO)\r
	286	\r
	287	## Parse command line options\r
	288	#\r
	289	# Using standard Python module optparse to parse command line option of this tool.\r
	290	#\r
	291	# @retval Opt A optparse.Values object containing the parsed options\r
	292	# @retval Args Target of build command\r
	293	#\r
	294	def EccOptionParser(self):\r
	295	Parser = OptionParser(description = self.Copyright, version = self.Version, prog = "Ecc.exe", usage = "%prog [options]")\r
	296	Parser.add_option("-t", "--target sourcepath", action="store", type="string", dest='Target',\r
	297	help="Check all files under the target workspace.")\r
	298	Parser.add_option("-c", "--config filename", action="store", type="string", dest="ConfigFile",\r
	299	help="Specify a configuration file. Defaultly use config.ini under ECC tool directory.")\r
	300	Parser.add_option("-o", "--outfile filename", action="store", type="string", dest="OutputFile",\r
	301	help="Specify the name of an output file, if and only if one filename was specified.")\r
	302	Parser.add_option("-r", "--reportfile filename", action="store", type="string", dest="ReportFile",\r
	303	help="Specify the name of an report file, if and only if one filename was specified.")\r
52302d4d LG	304	Parser.add_option("-e", "--exceptionfile filename", action="store", type="string", dest="ExceptionFile",\r
52302d4d LG	305	help="Specify the name of an exception file, if and only if one filename was specified.")\r
30fdf114 LG	306	Parser.add_option("-m", "--metadata", action="store_true", type=None, help="Only scan meta-data files information if this option is specified.")\r
	307	Parser.add_option("-s", "--sourcecode", action="store_true", type=None, help="Only scan source code files information if this option is specified.")\r
	308	Parser.add_option("-k", "--keepdatabase", action="store_true", type=None, help="The existing Ecc database will not be cleaned except report information if this option is specified.")\r
fd171542	309	Parser.add_option("-l", "--log filename", action="store", dest="LogFile", help="""If specified, the tool should emit the changes that\r
	310	were made by the tool after printing the result message.\r
	311	If filename, the emit to the file, otherwise emit to\r
	312	standard output. If no modifications were made, then do not\r
30fdf114 LG	313	create a log file, or output a log message.""")\r
	314	Parser.add_option("-q", "--quiet", action="store_true", type=None, help="Disable all messages except FATAL ERRORS.")\r
	315	Parser.add_option("-v", "--verbose", action="store_true", type=None, help="Turn on verbose output with informational messages printed, "\\r
	316	"including library instances selected, final dependency expression, "\\r
	317	"and warning messages, etc.")\r
	318	Parser.add_option("-d", "--debug", action="store", type="int", help="Enable debug messages at specified level.")\r
52302d4d	319	Parser.add_option("-w", "--workspace", action="store", type="string", dest='Workspace', help="Specify workspace.")\r
fd171542	320	\r
30fdf114	321	(Opt, Args)=Parser.parse_args()\r
fd171542	322	\r
30fdf114 LG	323	return (Opt, Args)\r
	324	\r
	325	##\r
	326	#\r
	327	# This acts like the main() function for the script, unless it is 'import'ed into another\r
	328	# script.\r
	329	#\r
	330	if __name__ == '__main__':\r
	331	# Initialize log system\r
	332	EdkLogger.Initialize()\r
	333	EdkLogger.IsRaiseError = False\r
	334	EdkLogger.quiet(time.strftime("%H:%M:%S, %b.%d %Y ", time.localtime()) + "[00:00]" + "\n")\r
	335	\r
	336	StartTime = time.clock()\r
	337	Ecc = Ecc()\r
	338	FinishTime = time.clock()\r
	339	\r
	340	BuildDuration = time.strftime("%M:%S", time.gmtime(int(round(FinishTime - StartTime))))\r
	341	EdkLogger.quiet("\n%s [%s]" % (time.strftime("%H:%M:%S, %b.%d %Y", time.localtime()), BuildDuration))\r