import re\r
from CommonDataClass.DataClass import *\r
import Common.DataType as DT\r
-from .EccToolError import *\r
-from .MetaDataParser import ParseHeaderCommentSection\r
-from . import EccGlobalData\r
-from . import c\r
+from Ecc.EccToolError import *\r
+from Ecc.MetaDataParser import ParseHeaderCommentSection\r
+from Ecc import EccGlobalData\r
+from Ecc import c\r
from Common.LongFilePathSupport import OpenLongFilePath as open\r
from Common.MultipleWorkspace import MultipleWorkspace as mws\r
\r
def GeneralCheck(self):\r
self.GeneralCheckNonAcsii()\r
self.UniCheck()\r
+ self.GeneralCheckNoTab()\r
+ self.GeneralCheckLineEnding()\r
+ self.GeneralCheckTrailingWhiteSpaceLine()\r
+\r
+ # Check whether NO Tab is used, replaced with spaces\r
+ def GeneralCheckNoTab(self):\r
+ if EccGlobalData.gConfig.GeneralCheckNoTab == '1' or EccGlobalData.gConfig.GeneralCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
+ EdkLogger.quiet("Checking No TAB used in file ...")\r
+ SqlCommand = """select ID, FullPath, ExtName from File where ExtName in ('.dec', '.inf', '.dsc', 'c', 'h')"""\r
+ RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
+ for Record in RecordSet:\r
+ if Record[2].upper() not in EccGlobalData.gConfig.BinaryExtList:\r
+ op = open(Record[1]).readlines()\r
+ IndexOfLine = 0\r
+ for Line in op:\r
+ IndexOfLine += 1\r
+ IndexOfChar = 0\r
+ for Char in Line:\r
+ IndexOfChar += 1\r
+ if Char == '\t':\r
+ OtherMsg = "File %s has TAB char at line %s column %s" % (Record[1], IndexOfLine, IndexOfChar)\r
+ EccGlobalData.gDb.TblReport.Insert(ERROR_GENERAL_CHECK_NO_TAB, OtherMsg=OtherMsg, BelongsToTable='File', BelongsToItem=Record[0])\r
+\r
+ # Check Only use CRLF (Carriage Return Line Feed) line endings.\r
+ def GeneralCheckLineEnding(self):\r
+ if EccGlobalData.gConfig.GeneralCheckLineEnding == '1' or EccGlobalData.gConfig.GeneralCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
+ EdkLogger.quiet("Checking line ending in file ...")\r
+ SqlCommand = """select ID, FullPath, ExtName from File where ExtName in ('.dec', '.inf', '.dsc', 'c', 'h')"""\r
+ RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
+ for Record in RecordSet:\r
+ if Record[2].upper() not in EccGlobalData.gConfig.BinaryExtList:\r
+ op = open(Record[1], 'rb').readlines()\r
+ IndexOfLine = 0\r
+ for Line in op:\r
+ IndexOfLine += 1\r
+ if not Line.endswith('\r\n'):\r
+ OtherMsg = "File %s has invalid line ending at line %s" % (Record[1], IndexOfLine)\r
+ EccGlobalData.gDb.TblReport.Insert(ERROR_GENERAL_CHECK_INVALID_LINE_ENDING, OtherMsg=OtherMsg, BelongsToTable='File', BelongsToItem=Record[0])\r
+\r
+ # Check if there is no trailing white space in one line.\r
+ def GeneralCheckTrailingWhiteSpaceLine(self):\r
+ if EccGlobalData.gConfig.GeneralCheckTrailingWhiteSpaceLine == '1' or EccGlobalData.gConfig.GeneralCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
+ EdkLogger.quiet("Checking trailing white space line in file ...")\r
+ SqlCommand = """select ID, FullPath, ExtName from File where ExtName in ('.dec', '.inf', '.dsc', 'c', 'h')"""\r
+ RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
+ for Record in RecordSet:\r
+ if Record[2].upper() not in EccGlobalData.gConfig.BinaryExtList:\r
+ op = open(Record[1], 'rb').readlines()\r
+ IndexOfLine = 0\r
+ for Line in op:\r
+ IndexOfLine += 1\r
+ if Line.replace('\r', '').replace('\n', '').endswith(' '):\r
+ OtherMsg = "File %s has trailing white spaces at line %s" % (Record[1], IndexOfLine)\r
+ EccGlobalData.gDb.TblReport.Insert(ERROR_GENERAL_CHECK_TRAILING_WHITE_SPACE_LINE, OtherMsg=OtherMsg, BelongsToTable='File', BelongsToItem=Record[0])\r
\r
# Check whether file has non ACSII char\r
def GeneralCheckNonAcsii(self):\r
self.FunctionLayoutCheckPrototype()\r
self.FunctionLayoutCheckBody()\r
self.FunctionLayoutCheckLocalVariable()\r
+ self.FunctionLayoutCheckDeprecated()\r
+ \r
+ # To check if the deprecated functions are used\r
+ def FunctionLayoutCheckDeprecated(self):\r
+ if EccGlobalData.gConfig.CFunctionLayoutCheckNoDeprecated == '1' or EccGlobalData.gConfig.CFunctionLayoutCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
+ EdkLogger.quiet("Checking function no deprecated one being used ...")\r
+\r
+ DeprecatedFunctionSet = ('UnicodeValueToString',\r
+ 'AsciiValueToString',\r
+ 'StrCpy',\r
+ 'StrnCpy',\r
+ 'StrCat',\r
+ 'StrnCat',\r
+ 'UnicodeStrToAsciiStr',\r
+ 'AsciiStrCpy',\r
+ 'AsciiStrnCpy',\r
+ 'AsciiStrCat',\r
+ 'AsciiStrnCat',\r
+ 'AsciiStrToUnicodeStr',\r
+ 'PcdSet8',\r
+ 'PcdSet16',\r
+ 'PcdSet32',\r
+ 'PcdSet64',\r
+ 'PcdSetPtr',\r
+ 'PcdSetBool',\r
+ 'PcdSetEx8',\r
+ 'PcdSetEx16',\r
+ 'PcdSetEx32',\r
+ 'PcdSetEx64',\r
+ 'PcdSetExPtr',\r
+ 'PcdSetExBool',\r
+ 'LibPcdSet8',\r
+ 'LibPcdSet16',\r
+ 'LibPcdSet32',\r
+ 'LibPcdSet64',\r
+ 'LibPcdSetPtr',\r
+ 'LibPcdSetBool',\r
+ 'LibPcdSetEx8',\r
+ 'LibPcdSetEx16',\r
+ 'LibPcdSetEx32',\r
+ 'LibPcdSetEx64',\r
+ 'LibPcdSetExPtr',\r
+ 'LibPcdSetExBool',\r
+ 'GetVariable',\r
+ 'GetEfiGlobalVariable',\r
+ )\r
+\r
+ for IdentifierTable in EccGlobalData.gIdentifierTableList:\r
+ SqlCommand = """select ID, Name, BelongsToFile from %s\r
+ where Model = %s """ % (IdentifierTable, MODEL_IDENTIFIER_FUNCTION_CALLING)\r
+ RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
+ for Record in RecordSet:\r
+ for Key in DeprecatedFunctionSet:\r
+ if Key == Record[1]:\r
+ if not EccGlobalData.gException.IsException(ERROR_C_FUNCTION_LAYOUT_CHECK_NO_DEPRECATE, Key):\r
+ OtherMsg = 'The function [%s] is deprecated which should NOT be used' % Key\r
+ EccGlobalData.gDb.TblReport.Insert(ERROR_C_FUNCTION_LAYOUT_CHECK_NO_DEPRECATE,\r
+ OtherMsg=OtherMsg,\r
+ BelongsToTable=IdentifierTable,\r
+ BelongsToItem=Record[0])\r
\r
def WalkTree(self):\r
IgnoredPattern = c.GetIgnoredDirListPattern()\r
if EccGlobalData.gConfig.IncludeFileCheckData == '1' or EccGlobalData.gConfig.IncludeFileCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
EdkLogger.quiet("Checking header file data ...")\r
\r
+ # Get all typedef functions\r
+ gAllTypedefFun = []\r
+ for IdentifierTable in EccGlobalData.gIdentifierTableList:\r
+ SqlCommand = """select Name from %s\r
+ where Model = %s """ % (IdentifierTable, MODEL_IDENTIFIER_TYPEDEF)\r
+ RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
+ for Record in RecordSet:\r
+ if Record[0].startswith('('):\r
+ gAllTypedefFun.append(Record[0])\r
+\r
# for Dirpath, Dirnames, Filenames in self.WalkTree():\r
# for F in Filenames:\r
# if os.path.splitext(F)[1] in ('.h'):\r
# FullName = os.path.join(Dirpath, F)\r
# MsgList = c.CheckHeaderFileData(FullName)\r
for FullName in EccGlobalData.gHFileList:\r
- MsgList = c.CheckHeaderFileData(FullName)\r
+ MsgList = c.CheckHeaderFileData(FullName, gAllTypedefFun)\r
\r
# Doxygen document checking\r
def DoxygenCheck(self):\r
RecordSet = EccGlobalData.gDb.TblFile.Exec(SqlCommand)\r
for Record in RecordSet:\r
Name = Record[1].replace('#ifndef', '').strip()\r
- if Name[0] != '_' or Name[-1] != '_':\r
+ if Name[-1] != '_':\r
if not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_IFNDEF_STATEMENT, Name):\r
EccGlobalData.gDb.TblReport.Insert(ERROR_NAMING_CONVENTION_CHECK_IFNDEF_STATEMENT, OtherMsg="The #ifndef name [%s] does not follow the rules" % (Name), BelongsToTable=FileTable, BelongsToItem=Record[0])\r
\r