BaseTools:ECC report errors on account of analyze special characters

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

## @file\r
# This file is used to be the c coding style checking of ECC tool\r
#\r
# Copyright (c) 2009 - 2019, Intel Corporation. All rights reserved.<BR>\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\r
#\r
\r
from __future__ import print_function\r
from __future__ import absolute_import\r
import sys\r
import Common.LongFilePathOs as os\r
import re\r
import string\r
from Ecc import CodeFragmentCollector\r
from Ecc import FileProfile\r
from CommonDataClass import DataClass\r
from Ecc import Database\r
from Common import EdkLogger\r
from Ecc.EccToolError import *\r
from Ecc import EccGlobalData\r
from Ecc import MetaDataParser\r
\r
IncludeFileListDict = {}\r
AllIncludeFileListDict = {}\r
IncludePathListDict = {}\r
ComplexTypeDict = {}\r
SUDict = {}\r
IgnoredKeywordList = ['EFI_ERROR']\r
\r
def GetIgnoredDirListPattern():\r
    skipList = list(EccGlobalData.gConfig.SkipDirList) + ['.svn']\r
    DirString = '|'.join(skipList)\r
    p = re.compile(r'.*[\\/](?:%s)[\\/]?.*' % DirString)\r
    return p\r
\r
def GetFuncDeclPattern():\r
    p = re.compile(r'(?:EFIAPI|EFI_BOOT_SERVICE|EFI_RUNTIME_SERVICE)?\s*[_\w]+\s*\(.*\)$', re.DOTALL)\r
    return p\r
\r
def GetArrayPattern():\r
    p = re.compile(r'[_\w]*\s*[\[.*\]]+')\r
    return p\r
\r
def GetTypedefFuncPointerPattern():\r
    p = re.compile('[_\w\s]*\([\w\s]*\*+\s*[_\w]+\s*\)\s*\(.*\)', re.DOTALL)\r
    return p\r
\r
def GetDB():\r
    return EccGlobalData.gDb\r
\r
def GetConfig():\r
    return EccGlobalData.gConfig\r
\r
def PrintErrorMsg(ErrorType, Msg, TableName, ItemId):\r
    Msg = Msg.replace('\n', '').replace('\r', '')\r
    MsgPartList = Msg.split()\r
    Msg = ''\r
    for Part in MsgPartList:\r
        Msg += Part\r
        Msg += ' '\r
    GetDB().TblReport.Insert(ErrorType, OtherMsg=Msg, BelongsToTable=TableName, BelongsToItem=ItemId)\r
\r
def GetIdType(Str):\r
    Type = DataClass.MODEL_UNKNOWN\r
    Str = Str.replace('#', '# ')\r
    List = Str.split()\r
    if List[1] == 'include':\r
        Type = DataClass.MODEL_IDENTIFIER_INCLUDE\r
    elif List[1] == 'define':\r
        Type = DataClass.MODEL_IDENTIFIER_MACRO_DEFINE\r
    elif List[1] == 'ifdef':\r
        Type = DataClass.MODEL_IDENTIFIER_MACRO_IFDEF\r
    elif List[1] == 'ifndef':\r
        Type = DataClass.MODEL_IDENTIFIER_MACRO_IFNDEF\r
    elif List[1] == 'endif':\r
        Type = DataClass.MODEL_IDENTIFIER_MACRO_ENDIF\r
    elif List[1] == 'pragma':\r
        Type = DataClass.MODEL_IDENTIFIER_MACRO_PROGMA\r
    else:\r
        Type = DataClass.MODEL_UNKNOWN\r
    return Type\r
\r
def SuOccurInTypedef (Su, TdList):\r
    for Td in TdList:\r
        if Su.StartPos[0] == Td.StartPos[0] and Su.EndPos[0] == Td.EndPos[0]:\r
            return True\r
    return False\r
\r
def GetIdentifierList():\r
    IdList = []\r
    for comment in FileProfile.CommentList:\r
        IdComment = DataClass.IdentifierClass(-1, '', '', '', comment.Content, DataClass.MODEL_IDENTIFIER_COMMENT, -1, -1, comment.StartPos[0], comment.StartPos[1], comment.EndPos[0], comment.EndPos[1])\r
        IdList.append(IdComment)\r
\r
    for pp in FileProfile.PPDirectiveList:\r
        Type = GetIdType(pp.Content)\r
        IdPP = DataClass.IdentifierClass(-1, '', '', '', pp.Content, Type, -1, -1, pp.StartPos[0], pp.StartPos[1], pp.EndPos[0], pp.EndPos[1])\r
        IdList.append(IdPP)\r
\r
    for pe in FileProfile.PredicateExpressionList:\r
        IdPE = DataClass.IdentifierClass(-1, '', '', '', pe.Content, DataClass.MODEL_IDENTIFIER_PREDICATE_EXPRESSION, -1, -1, pe.StartPos[0], pe.StartPos[1], pe.EndPos[0], pe.EndPos[1])\r
        IdList.append(IdPE)\r
\r
    FuncDeclPattern = GetFuncDeclPattern()\r
    ArrayPattern = GetArrayPattern()\r
    for var in FileProfile.VariableDeclarationList:\r
        DeclText = var.Declarator.lstrip()\r
        FuncPointerPattern = GetTypedefFuncPointerPattern()\r
        if FuncPointerPattern.match(DeclText):\r
            continue\r
        VarNameStartLine = var.NameStartPos[0]\r
        VarNameStartColumn = var.NameStartPos[1]\r
        FirstChar = DeclText[0]\r
        while not FirstChar.isalpha() and FirstChar != '_':\r
            if FirstChar == '*':\r
                var.Modifier += '*'\r
                VarNameStartColumn += 1\r
                DeclText = DeclText.lstrip('*')\r
            elif FirstChar == '\r':\r
                DeclText = DeclText.lstrip('\r\n').lstrip('\r')\r
                VarNameStartLine += 1\r
                VarNameStartColumn = 0\r
            elif FirstChar == '\n':\r
                DeclText = DeclText.lstrip('\n')\r
                VarNameStartLine += 1\r
                VarNameStartColumn = 0\r
            elif FirstChar == ' ':\r
                DeclText = DeclText.lstrip(' ')\r
                VarNameStartColumn += 1\r
            elif FirstChar == '\t':\r
                DeclText = DeclText.lstrip('\t')\r
                VarNameStartColumn += 8\r
            else:\r
                DeclText = DeclText[1:]\r
                VarNameStartColumn += 1\r
            FirstChar = DeclText[0]\r
\r
        var.Declarator = DeclText\r
        if FuncDeclPattern.match(var.Declarator):\r
            DeclSplitList = var.Declarator.split('(')\r
            FuncName = DeclSplitList[0].strip()\r
            FuncNamePartList = FuncName.split()\r
            if len(FuncNamePartList) > 1:\r
                FuncName = FuncNamePartList[-1].strip()\r
                NameStart = DeclSplitList[0].rfind(FuncName)\r
                var.Declarator = var.Declarator[NameStart:]\r
                if NameStart > 0:\r
                    var.Modifier += ' ' + DeclSplitList[0][0:NameStart]\r
                    Index = 0\r
                    PreChar = ''\r
                    while Index < NameStart:\r
                        FirstChar = DeclSplitList[0][Index]\r
                        if DeclSplitList[0][Index:].startswith('EFIAPI'):\r
                            Index += 6\r
                            VarNameStartColumn += 6\r
                            PreChar = ''\r
                            continue\r
                        elif FirstChar == '\r':\r
                            Index += 1\r
                            VarNameStartLine += 1\r
                            VarNameStartColumn = 0\r
                        elif FirstChar == '\n':\r
                            Index += 1\r
                            if PreChar != '\r':\r
                                VarNameStartLine += 1\r
                                VarNameStartColumn = 0\r
                        elif FirstChar == ' ':\r
                            Index += 1\r
                            VarNameStartColumn += 1\r
                        elif FirstChar == '\t':\r
                            Index += 1\r
                            VarNameStartColumn += 8\r
                        else:\r
                            Index += 1\r
                            VarNameStartColumn += 1\r
                        PreChar = FirstChar\r
            IdVar = DataClass.IdentifierClass(-1, var.Modifier, '', var.Declarator, FuncName, DataClass.MODEL_IDENTIFIER_FUNCTION_DECLARATION, -1, -1, var.StartPos[0], var.StartPos[1], VarNameStartLine, VarNameStartColumn)\r
            IdList.append(IdVar)\r
            continue\r
\r
        if var.Declarator.find('{') == -1:\r
            for decl in var.Declarator.split(','):\r
                DeclList = decl.split('=')\r
                Name = DeclList[0].strip()\r
                if ArrayPattern.match(Name):\r
                    LSBPos = var.Declarator.find('[')\r
                    var.Modifier += ' ' + Name[LSBPos:]\r
                    Name = Name[0:LSBPos]\r
\r
                IdVar = DataClass.IdentifierClass(-1, var.Modifier, '', Name, (len(DeclList) > 1 and [DeclList[1]]or [''])[0], DataClass.MODEL_IDENTIFIER_VARIABLE, -1, -1, var.StartPos[0], var.StartPos[1], VarNameStartLine, VarNameStartColumn)\r
                IdList.append(IdVar)\r
        else:\r
            DeclList = var.Declarator.split('=')\r
            Name = DeclList[0].strip()\r
            if ArrayPattern.match(Name):\r
                LSBPos = var.Declarator.find('[')\r
                var.Modifier += ' ' + Name[LSBPos:]\r
                Name = Name[0:LSBPos]\r
            IdVar = DataClass.IdentifierClass(-1, var.Modifier, '', Name, (len(DeclList) > 1 and [DeclList[1]]or [''])[0], DataClass.MODEL_IDENTIFIER_VARIABLE, -1, -1, var.StartPos[0], var.StartPos[1], VarNameStartLine, VarNameStartColumn)\r
            IdList.append(IdVar)\r
\r
    for enum in FileProfile.EnumerationDefinitionList:\r
        LBPos = enum.Content.find('{')\r
        RBPos = enum.Content.find('}')\r
        Name = enum.Content[4:LBPos].strip()\r
        Value = enum.Content[LBPos + 1:RBPos]\r
        IdEnum = DataClass.IdentifierClass(-1, '', '', Name, Value, DataClass.MODEL_IDENTIFIER_ENUMERATE, -1, -1, enum.StartPos[0], enum.StartPos[1], enum.EndPos[0], enum.EndPos[1])\r
        IdList.append(IdEnum)\r
\r
    for su in FileProfile.StructUnionDefinitionList:\r
        if SuOccurInTypedef(su, FileProfile.TypedefDefinitionList):\r
            continue\r
        Type = DataClass.MODEL_IDENTIFIER_STRUCTURE\r
        SkipLen = 6\r
        if su.Content.startswith('union'):\r
            Type = DataClass.MODEL_IDENTIFIER_UNION\r
            SkipLen = 5\r
        LBPos = su.Content.find('{')\r
        RBPos = su.Content.find('}')\r
        if LBPos == -1 or RBPos == -1:\r
            Name = su.Content[SkipLen:].strip()\r
            Value = ''\r
        else:\r
            Name = su.Content[SkipLen:LBPos].strip()\r
            Value = su.Content[LBPos:RBPos + 1]\r
        IdPE = DataClass.IdentifierClass(-1, '', '', Name, Value, Type, -1, -1, su.StartPos[0], su.StartPos[1], su.EndPos[0], su.EndPos[1])\r
        IdList.append(IdPE)\r
\r
    TdFuncPointerPattern = GetTypedefFuncPointerPattern()\r
    for td in FileProfile.TypedefDefinitionList:\r
        Modifier = ''\r
        Name = td.ToType\r
        Value = td.FromType\r
        if TdFuncPointerPattern.match(td.ToType):\r
            Modifier = td.FromType\r
            LBPos = td.ToType.find('(')\r
            TmpStr = td.ToType[LBPos + 1:].strip()\r
            StarPos = TmpStr.find('*')\r
            if StarPos != -1:\r
                Modifier += ' ' + TmpStr[0:StarPos]\r
            while TmpStr[StarPos] == '*':\r
#                Modifier += ' ' + '*'\r
                StarPos += 1\r
            TmpStr = TmpStr[StarPos:].strip()\r
            RBPos = TmpStr.find(')')\r
            Name = TmpStr[0:RBPos]\r
            Value = 'FP' + TmpStr[RBPos + 1:]\r
        else:\r
            while Name.startswith('*'):\r
                Value += ' ' + '*'\r
                Name = Name.lstrip('*').strip()\r
\r
        if Name.find('[') != -1:\r
            LBPos = Name.find('[')\r
            RBPos = Name.rfind(']')\r
            Value += Name[LBPos : RBPos + 1]\r
            Name = Name[0 : LBPos]\r
\r
        IdTd = DataClass.IdentifierClass(-1, Modifier, '', Name, Value, DataClass.MODEL_IDENTIFIER_TYPEDEF, -1, -1, td.StartPos[0], td.StartPos[1], td.EndPos[0], td.EndPos[1])\r
        IdList.append(IdTd)\r
\r
    for funcCall in FileProfile.FunctionCallingList:\r
        IdFC = DataClass.IdentifierClass(-1, '', '', funcCall.FuncName, funcCall.ParamList, DataClass.MODEL_IDENTIFIER_FUNCTION_CALLING, -1, -1, funcCall.StartPos[0], funcCall.StartPos[1], funcCall.EndPos[0], funcCall.EndPos[1])\r
        IdList.append(IdFC)\r
    return IdList\r
\r
def StripNonAlnumChars(Str):\r
    StrippedStr = ''\r
    for Char in Str:\r
        if Char.isalnum() or Char == '_':\r
            StrippedStr += Char\r
    return StrippedStr\r
\r
def GetParamList(FuncDeclarator, FuncNameLine=0, FuncNameOffset=0):\r
    FuncDeclarator = StripComments(FuncDeclarator)\r
    ParamIdList = []\r
    #DeclSplitList = FuncDeclarator.split('(')\r
    LBPos = FuncDeclarator.find('(')\r
    #if len(DeclSplitList) < 2:\r
    if LBPos == -1:\r
        return ParamIdList\r
    #FuncName = DeclSplitList[0]\r
    FuncName = FuncDeclarator[0:LBPos]\r
    #ParamStr = DeclSplitList[1].rstrip(')')\r
    ParamStr = FuncDeclarator[LBPos + 1:].rstrip(')')\r
    LineSkipped = 0\r
    OffsetSkipped = 0\r
    TailChar = FuncName[-1]\r
    while not TailChar.isalpha() and TailChar != '_':\r
\r
        if TailChar == '\n':\r
            FuncName = FuncName.rstrip('\r\n').rstrip('\n')\r
            LineSkipped += 1\r
            OffsetSkipped = 0\r
        elif TailChar == '\r':\r
            FuncName = FuncName.rstrip('\r')\r
            LineSkipped += 1\r
            OffsetSkipped = 0\r
        elif TailChar == ' ':\r
            FuncName = FuncName.rstrip(' ')\r
            OffsetSkipped += 1\r
        elif TailChar == '\t':\r
            FuncName = FuncName.rstrip('\t')\r
            OffsetSkipped += 8\r
        else:\r
            FuncName = FuncName[:-1]\r
        TailChar = FuncName[-1]\r
\r
    OffsetSkipped += 1 #skip '('\r
\r
    for p in ParamStr.split(','):\r
        ListP = p.split()\r
        if len(ListP) == 0:\r
            continue\r
        ParamName = ListP[-1]\r
        DeclText = ParamName.strip()\r
        RightSpacePos = p.rfind(ParamName)\r
        ParamModifier = p[0:RightSpacePos]\r
        if ParamName == 'OPTIONAL':\r
            if ParamModifier == '':\r
                ParamModifier += ' ' + 'OPTIONAL'\r
                DeclText = ''\r
            else:\r
                ParamName = ListP[-2]\r
                DeclText = ParamName.strip()\r
                RightSpacePos = p.rfind(ParamName)\r
                ParamModifier = p[0:RightSpacePos]\r
                ParamModifier += 'OPTIONAL'\r
        while DeclText.startswith('*'):\r
            ParamModifier += ' ' + '*'\r
            DeclText = DeclText.lstrip('*').strip()\r
        ParamName = DeclText\r
        # ignore array length if exists.\r
        LBIndex = ParamName.find('[')\r
        if LBIndex != -1:\r
            ParamName = ParamName[0:LBIndex]\r
\r
        Start = RightSpacePos\r
        Index = 0\r
        PreChar = ''\r
        while Index < Start:\r
            FirstChar = p[Index]\r
\r
            if FirstChar == '\r':\r
                Index += 1\r
                LineSkipped += 1\r
                OffsetSkipped = 0\r
            elif FirstChar == '\n':\r
                Index += 1\r
                if PreChar != '\r':\r
                    LineSkipped += 1\r
                    OffsetSkipped = 0\r
            elif FirstChar == ' ':\r
                Index += 1\r
                OffsetSkipped += 1\r
            elif FirstChar == '\t':\r
                Index += 1\r
                OffsetSkipped += 8\r
            else:\r
                Index += 1\r
                OffsetSkipped += 1\r
            PreChar = FirstChar\r
\r
        ParamBeginLine = FuncNameLine + LineSkipped\r
        ParamBeginOffset = FuncNameOffset + OffsetSkipped\r
\r
        Index = Start + len(ParamName)\r
        PreChar = ''\r
        while Index < len(p):\r
            FirstChar = p[Index]\r
\r
            if FirstChar == '\r':\r
                Index += 1\r
                LineSkipped += 1\r
                OffsetSkipped = 0\r
            elif FirstChar == '\n':\r
                Index += 1\r
                if PreChar != '\r':\r
                    LineSkipped += 1\r
                    OffsetSkipped = 0\r
            elif FirstChar == ' ':\r
                Index += 1\r
                OffsetSkipped += 1\r
            elif FirstChar == '\t':\r
                Index += 1\r
                OffsetSkipped += 8\r
            else:\r
                Index += 1\r
                OffsetSkipped += 1\r
            PreChar = FirstChar\r
\r
        ParamEndLine = FuncNameLine + LineSkipped\r
        ParamEndOffset = FuncNameOffset + OffsetSkipped\r
        if ParamName != '...':\r
            ParamName = StripNonAlnumChars(ParamName)\r
        IdParam = DataClass.IdentifierClass(-1, ParamModifier, '', ParamName, '', DataClass.MODEL_IDENTIFIER_PARAMETER, -1, -1, ParamBeginLine, ParamBeginOffset, ParamEndLine, ParamEndOffset)\r
        ParamIdList.append(IdParam)\r
\r
        OffsetSkipped += 1 #skip ','\r
\r
    return ParamIdList\r
\r
def GetFunctionList():\r
    FuncObjList = []\r
    for FuncDef in FileProfile.FunctionDefinitionList:\r
        ParamIdList = []\r
        DeclText = FuncDef.Declarator.lstrip()\r
        FuncNameStartLine = FuncDef.NamePos[0]\r
        FuncNameStartColumn = FuncDef.NamePos[1]\r
        FirstChar = DeclText[0]\r
        while not FirstChar.isalpha() and FirstChar != '_':\r
            if FirstChar == '*':\r
                FuncDef.Modifier += '*'\r
                FuncNameStartColumn += 1\r
                DeclText = DeclText.lstrip('*')\r
            elif FirstChar == '\r':\r
                DeclText = DeclText.lstrip('\r\n').lstrip('\r')\r
                FuncNameStartLine += 1\r
                FuncNameStartColumn = 0\r
            elif FirstChar == '\n':\r
                DeclText = DeclText.lstrip('\n')\r
                FuncNameStartLine += 1\r
                FuncNameStartColumn = 0\r
            elif FirstChar == ' ':\r
                DeclText = DeclText.lstrip(' ')\r
                FuncNameStartColumn += 1\r
            elif FirstChar == '\t':\r
                DeclText = DeclText.lstrip('\t')\r
                FuncNameStartColumn += 8\r
            else:\r
                DeclText = DeclText[1:]\r
                FuncNameStartColumn += 1\r
            FirstChar = DeclText[0]\r
\r
        FuncDef.Declarator = DeclText\r
        DeclSplitList = FuncDef.Declarator.split('(')\r
        if len(DeclSplitList) < 2:\r
            continue\r
\r
        FuncName = DeclSplitList[0]\r
        FuncNamePartList = FuncName.split()\r
        if len(FuncNamePartList) > 1:\r
            FuncName = FuncNamePartList[-1]\r
            NameStart = DeclSplitList[0].rfind(FuncName)\r
            if NameStart > 0:\r
                FuncDef.Modifier += ' ' + DeclSplitList[0][0:NameStart]\r
                Index = 0\r
                PreChar = ''\r
                while Index < NameStart:\r
                    FirstChar = DeclSplitList[0][Index]\r
                    if DeclSplitList[0][Index:].startswith('EFIAPI'):\r
                        Index += 6\r
                        FuncNameStartColumn += 6\r
                        PreChar = ''\r
                        continue\r
                    elif FirstChar == '\r':\r
                        Index += 1\r
                        FuncNameStartLine += 1\r
                        FuncNameStartColumn = 0\r
                    elif FirstChar == '\n':\r
                        Index += 1\r
                        if PreChar != '\r':\r
                            FuncNameStartLine += 1\r
                            FuncNameStartColumn = 0\r
                    elif FirstChar == ' ':\r
                        Index += 1\r
                        FuncNameStartColumn += 1\r
                    elif FirstChar == '\t':\r
                        Index += 1\r
                        FuncNameStartColumn += 8\r
                    else:\r
                        Index += 1\r
                        FuncNameStartColumn += 1\r
                    PreChar = FirstChar\r
\r
        FuncObj = DataClass.FunctionClass(-1, FuncDef.Declarator, FuncDef.Modifier, FuncName.strip(), '', FuncDef.StartPos[0], FuncDef.StartPos[1], FuncDef.EndPos[0], FuncDef.EndPos[1], FuncDef.LeftBracePos[0], FuncDef.LeftBracePos[1], -1, ParamIdList, [], FuncNameStartLine, FuncNameStartColumn)\r
        FuncObjList.append(FuncObj)\r
\r
    return FuncObjList\r
\r
def GetFileModificationTimeFromDB(FullFileName):\r
    TimeValue = 0.0\r
    Db = GetDB()\r
    SqlStatement = """ select TimeStamp\r
                       from File\r
                       where FullPath = \'%s\'\r
                   """ % (FullFileName)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    for Result in ResultSet:\r
        TimeValue = Result[0]\r
    return TimeValue\r
\r
def CollectSourceCodeDataIntoDB(RootDir):\r
    FileObjList = []\r
    tuple = os.walk(RootDir)\r
    IgnoredPattern = GetIgnoredDirListPattern()\r
    ParseErrorFileList = []\r
    TokenReleaceList = EccGlobalData.gConfig.TokenReleaceList\r
    TokenReleaceList.extend(['L",\\\""'])\r
\r
    for dirpath, dirnames, filenames in tuple:\r
        if IgnoredPattern.match(dirpath.upper()):\r
            continue\r
\r
        for Dir in dirnames:\r
            Dirname = os.path.join(dirpath, 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
                    dirnames.remove(Dir)\r
                    dirnames.append(Dirname)\r
\r
        for f in filenames:\r
            if f.lower() in EccGlobalData.gConfig.SkipFileList:\r
                continue\r
            collector = None\r
            FullName = os.path.normpath(os.path.join(dirpath, f))\r
            model = DataClass.MODEL_FILE_OTHERS\r
            if os.path.splitext(f)[1] in ('.h', '.c'):\r
                EdkLogger.info("Parsing " + FullName)\r
                model = f.endswith('c') and DataClass.MODEL_FILE_C or DataClass.MODEL_FILE_H\r
                collector = CodeFragmentCollector.CodeFragmentCollector(FullName)\r
                collector.TokenReleaceList = TokenReleaceList\r
                try:\r
                    collector.ParseFile()\r
                except UnicodeError:\r
                    ParseErrorFileList.append(FullName)\r
                    collector.CleanFileProfileBuffer()\r
                    collector.ParseFileWithClearedPPDirective()\r
#                collector.PrintFragments()\r
            BaseName = os.path.basename(f)\r
            DirName = os.path.dirname(FullName)\r
            Ext = os.path.splitext(f)[1].lstrip('.')\r
            ModifiedTime = os.path.getmtime(FullName)\r
            FileObj = DataClass.FileClass(-1, BaseName, Ext, DirName, FullName, model, ModifiedTime, GetFunctionList(), GetIdentifierList(), [])\r
            FileObjList.append(FileObj)\r
            if collector:\r
                collector.CleanFileProfileBuffer()\r
\r
    if len(ParseErrorFileList) > 0:\r
        EdkLogger.info("Found unrecoverable error during parsing:\n\t%s\n" % "\n\t".join(ParseErrorFileList))\r
\r
    Db = GetDB()\r
    for file in FileObjList:\r
        if file.ExtName.upper() not in ['INF', 'DEC', 'DSC', 'FDF']:\r
            Db.InsertOneFile(file)\r
\r
    Db.UpdateIdentifierBelongsToFunction()\r
\r
def GetTableID(FullFileName, ErrorMsgList=None):\r
    if ErrorMsgList is None:\r
        ErrorMsgList = []\r
\r
    Db = GetDB()\r
    SqlStatement = """ select ID\r
                       from File\r
                       where FullPath like '%s'\r
                   """ % FullFileName\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
\r
    FileID = -1\r
    for Result in ResultSet:\r
        if FileID != -1:\r
            ErrorMsgList.append('Duplicate file ID found in DB for file %s' % FullFileName)\r
            return - 2\r
        FileID = Result[0]\r
    if FileID == -1:\r
        ErrorMsgList.append('NO file ID found in DB for file %s' % FullFileName)\r
        return - 1\r
    return FileID\r
\r
def GetIncludeFileList(FullFileName):\r
    if os.path.splitext(FullFileName)[1].upper() not in ('.H'):\r
        return []\r
    IFList = IncludeFileListDict.get(FullFileName)\r
    if IFList is not None:\r
        return IFList\r
\r
    FileID = GetTableID(FullFileName)\r
    if FileID < 0:\r
        return []\r
\r
    Db = GetDB()\r
    FileTable = 'Identifier' + str(FileID)\r
    SqlStatement = """ select Value\r
                       from %s\r
                       where Model = %d\r
                   """ % (FileTable, DataClass.MODEL_IDENTIFIER_INCLUDE)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    IncludeFileListDict[FullFileName] = ResultSet\r
    return ResultSet\r
\r
def GetFullPathOfIncludeFile(Str, IncludePathList):\r
    for IncludePath in IncludePathList:\r
        FullPath = os.path.join(IncludePath, Str)\r
        FullPath = os.path.normpath(FullPath)\r
        if os.path.exists(FullPath):\r
            return FullPath\r
    return None\r
\r
def GetAllIncludeFiles(FullFileName):\r
    if AllIncludeFileListDict.get(FullFileName) is not None:\r
        return AllIncludeFileListDict.get(FullFileName)\r
\r
    FileDirName = os.path.dirname(FullFileName)\r
    IncludePathList = IncludePathListDict.get(FileDirName)\r
    if IncludePathList is None:\r
        IncludePathList = MetaDataParser.GetIncludeListOfFile(EccGlobalData.gWorkspace, FullFileName, GetDB())\r
        if FileDirName not in IncludePathList:\r
            IncludePathList.insert(0, FileDirName)\r
        IncludePathListDict[FileDirName] = IncludePathList\r
    IncludeFileQueue = []\r
    for IncludeFile in GetIncludeFileList(FullFileName):\r
        FileName = IncludeFile[0].lstrip('#').strip()\r
        FileName = FileName.lstrip('include').strip()\r
        FileName = FileName.strip('\"')\r
        FileName = FileName.lstrip('<').rstrip('>').strip()\r
        FullPath = GetFullPathOfIncludeFile(FileName, IncludePathList)\r
        if FullPath is not None:\r
            IncludeFileQueue.append(FullPath)\r
\r
    i = 0\r
    while i < len(IncludeFileQueue):\r
        for IncludeFile in GetIncludeFileList(IncludeFileQueue[i]):\r
            FileName = IncludeFile[0].lstrip('#').strip()\r
            FileName = FileName.lstrip('include').strip()\r
            FileName = FileName.strip('\"')\r
            FileName = FileName.lstrip('<').rstrip('>').strip()\r
            FullPath = GetFullPathOfIncludeFile(FileName, IncludePathList)\r
            if FullPath is not None and FullPath not in IncludeFileQueue:\r
                IncludeFileQueue.insert(i + 1, FullPath)\r
        i += 1\r
\r
    AllIncludeFileListDict[FullFileName] = IncludeFileQueue\r
    return IncludeFileQueue\r
\r
def GetPredicateListFromPredicateExpStr(PES):\r
\r
    PredicateList = []\r
    i = 0\r
    PredicateBegin = 0\r
    #PredicateEnd = 0\r
    LogicOpPos = -1\r
    p = GetFuncDeclPattern()\r
    while i < len(PES) - 1:\r
        if (PES[i].isalnum() or PES[i] == '_' or PES[i] == '*') and LogicOpPos > PredicateBegin:\r
            PredicateBegin = i\r
        if (PES[i] == '&' and PES[i + 1] == '&') or (PES[i] == '|' and PES[i + 1] == '|'):\r
            LogicOpPos = i\r
            Exp = PES[PredicateBegin:i].strip()\r
            # Exp may contain '.' or '->'\r
            TmpExp = Exp.replace('.', '').replace('->', '')\r
            if p.match(TmpExp):\r
                PredicateList.append(Exp)\r
            else:\r
                PredicateList.append(Exp.rstrip(';').rstrip(')').strip())\r
        i += 1\r
\r
    if PredicateBegin > LogicOpPos:\r
        while PredicateBegin < len(PES):\r
            if PES[PredicateBegin].isalnum() or PES[PredicateBegin] == '_' or PES[PredicateBegin] == '*':\r
                break\r
            PredicateBegin += 1\r
        Exp = PES[PredicateBegin:len(PES)].strip()\r
        # Exp may contain '.' or '->'\r
        TmpExp = Exp.replace('.', '').replace('->', '')\r
        if p.match(TmpExp):\r
            PredicateList.append(Exp)\r
        else:\r
            PredicateList.append(Exp.rstrip(';').rstrip(')').strip())\r
    return PredicateList\r
\r
def GetCNameList(Lvalue, StarList=[]):\r
    Lvalue += ' '\r
    i = 0\r
    SearchBegin = 0\r
    VarStart = -1\r
    VarEnd = -1\r
    VarList = []\r
\r
    while SearchBegin < len(Lvalue):\r
        while i < len(Lvalue):\r
            if Lvalue[i].isalnum() or Lvalue[i] == '_':\r
                if VarStart == -1:\r
                    VarStart = i\r
                VarEnd = i\r
                i += 1\r
            elif VarEnd != -1:\r
                VarList.append(Lvalue[VarStart:VarEnd + 1])\r
                i += 1\r
                break\r
            else:\r
                if VarStart == -1 and Lvalue[i] == '*':\r
                    StarList.append('*')\r
                i += 1\r
        if VarEnd == -1:\r
            break\r
\r
\r
        DotIndex = Lvalue[VarEnd:].find('.')\r
        ArrowIndex = Lvalue[VarEnd:].find('->')\r
        if DotIndex == -1 and ArrowIndex == -1:\r
            break\r
        elif DotIndex == -1 and ArrowIndex != -1:\r
            SearchBegin = VarEnd + ArrowIndex\r
        elif ArrowIndex == -1 and DotIndex != -1:\r
            SearchBegin = VarEnd + DotIndex\r
        else:\r
            SearchBegin = VarEnd + ((DotIndex < ArrowIndex) and DotIndex or ArrowIndex)\r
\r
        i = SearchBegin\r
        VarStart = -1\r
        VarEnd = -1\r
\r
    return VarList\r
\r
def SplitPredicateByOp(Str, Op, IsFuncCalling=False):\r
\r
    Name = Str.strip()\r
    Value = None\r
\r
    if IsFuncCalling:\r
        Index = 0\r
        LBFound = False\r
        UnmatchedLBCount = 0\r
        while Index < len(Str):\r
            while not LBFound and Str[Index] != '_' and not Str[Index].isalnum():\r
                Index += 1\r
\r
            while not LBFound and (Str[Index].isalnum() or Str[Index] == '_'):\r
                Index += 1\r
            # maybe type-cast at the beginning, skip it.\r
            RemainingStr = Str[Index:].lstrip()\r
            if RemainingStr.startswith(')') and not LBFound:\r
                Index += 1\r
                continue\r
\r
            if RemainingStr.startswith('(') and not LBFound:\r
                LBFound = True\r
\r
            if Str[Index] == '(':\r
                UnmatchedLBCount += 1\r
                Index += 1\r
                continue\r
\r
            if Str[Index] == ')':\r
                UnmatchedLBCount -= 1\r
                Index += 1\r
                if UnmatchedLBCount == 0:\r
                    break\r
                continue\r
\r
            Index += 1\r
\r
        if UnmatchedLBCount > 0:\r
            return [Name]\r
\r
        IndexInRemainingStr = Str[Index:].find(Op)\r
        if IndexInRemainingStr == -1:\r
            return [Name]\r
\r
        Name = Str[0:Index + IndexInRemainingStr].strip()\r
        Value = Str[Index + IndexInRemainingStr + len(Op):].strip().strip(')')\r
        return [Name, Value]\r
\r
    TmpStr = Str.rstrip(';').rstrip(')')\r
    while True:\r
        Index = TmpStr.rfind(Op)\r
        if Index == -1:\r
            return [Name]\r
\r
        if Str[Index - 1].isalnum() or Str[Index - 1].isspace() or Str[Index - 1] == ')' or Str[Index - 1] == ']':\r
            Name = Str[0:Index].strip()\r
            Value = Str[Index + len(Op):].strip()\r
            return [Name, Value]\r
\r
        TmpStr = Str[0:Index - 1]\r
\r
def SplitPredicateStr(Str):\r
\r
    Str = Str.lstrip('(')\r
    IsFuncCalling = False\r
    p = GetFuncDeclPattern()\r
    TmpStr = Str.replace('.', '').replace('->', '')\r
    if p.match(TmpStr):\r
        IsFuncCalling = True\r
\r
    PredPartList = SplitPredicateByOp(Str, '==', IsFuncCalling)\r
    if len(PredPartList) > 1:\r
        return [PredPartList, '==']\r
\r
    PredPartList = SplitPredicateByOp(Str, '!=', IsFuncCalling)\r
    if len(PredPartList) > 1:\r
        return [PredPartList, '!=']\r
\r
    PredPartList = SplitPredicateByOp(Str, '>=', IsFuncCalling)\r
    if len(PredPartList) > 1:\r
        return [PredPartList, '>=']\r
\r
    PredPartList = SplitPredicateByOp(Str, '<=', IsFuncCalling)\r
    if len(PredPartList) > 1:\r
        return [PredPartList, '<=']\r
\r
    PredPartList = SplitPredicateByOp(Str, '>', IsFuncCalling)\r
    if len(PredPartList) > 1:\r
        return [PredPartList, '>']\r
\r
    PredPartList = SplitPredicateByOp(Str, '<', IsFuncCalling)\r
    if len(PredPartList) > 1:\r
        return [PredPartList, '<']\r
\r
    return [[Str, None], None]\r
\r
def GetFuncContainsPE(ExpLine, ResultSet):\r
    for Result in ResultSet:\r
        if Result[0] < ExpLine and Result[1] > ExpLine:\r
            return Result\r
    return None\r
\r
def PatternInModifier(Modifier, SubStr):\r
    PartList = Modifier.split()\r
    for Part in PartList:\r
        if Part == SubStr:\r
            return True\r
    return False\r
\r
def GetDataTypeFromModifier(ModifierStr):\r
    MList = ModifierStr.split()\r
    ReturnType = ''\r
    for M in MList:\r
        if M in EccGlobalData.gConfig.ModifierSet:\r
            continue\r
        # remove array suffix\r
        if M.startswith('[') or M.endswith(']'):\r
            continue\r
        ReturnType += M + ' '\r
\r
    ReturnType = ReturnType.strip()\r
    if len(ReturnType) == 0:\r
        ReturnType = 'VOID'\r
    return ReturnType\r
\r
def DiffModifier(Str1, Str2):\r
    PartList1 = Str1.split()\r
    PartList2 = Str2.split()\r
    if PartList1 == PartList2:\r
        return False\r
    else:\r
        return True\r
\r
def GetTypedefDict(FullFileName):\r
\r
    Dict = ComplexTypeDict.get(FullFileName)\r
    if Dict is not None:\r
        return Dict\r
\r
    FileID = GetTableID(FullFileName)\r
    FileTable = 'Identifier' + str(FileID)\r
    Db = GetDB()\r
    SqlStatement = """ select Modifier, Name, Value, ID\r
                       from %s\r
                       where Model = %d\r
                   """ % (FileTable, DataClass.MODEL_IDENTIFIER_TYPEDEF)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
\r
    Dict = {}\r
    for Result in ResultSet:\r
        if len(Result[0]) == 0:\r
            Dict[Result[1]] = Result[2]\r
\r
    IncludeFileList = GetAllIncludeFiles(FullFileName)\r
    for F in IncludeFileList:\r
        FileID = GetTableID(F)\r
        if FileID < 0:\r
            continue\r
\r
        FileTable = 'Identifier' + str(FileID)\r
        SqlStatement = """ select Modifier, Name, Value, ID\r
                       from %s\r
                       where Model = %d\r
                   """ % (FileTable, DataClass.MODEL_IDENTIFIER_TYPEDEF)\r
        ResultSet = Db.TblFile.Exec(SqlStatement)\r
\r
        for Result in ResultSet:\r
            if not Result[2].startswith('FP ('):\r
                Dict[Result[1]] = Result[2]\r
            else:\r
                if len(Result[0]) == 0:\r
                    Dict[Result[1]] = 'VOID'\r
                else:\r
                    Dict[Result[1]] = GetDataTypeFromModifier(Result[0])\r
\r
    ComplexTypeDict[FullFileName] = Dict\r
    return Dict\r
\r
def GetSUDict(FullFileName):\r
\r
    Dict = SUDict.get(FullFileName)\r
    if Dict is not None:\r
        return Dict\r
\r
    FileID = GetTableID(FullFileName)\r
    FileTable = 'Identifier' + str(FileID)\r
    Db = GetDB()\r
    SqlStatement = """ select Name, Value, ID\r
                       from %s\r
                       where Model = %d or Model = %d\r
                   """ % (FileTable, DataClass.MODEL_IDENTIFIER_STRUCTURE, DataClass.MODEL_IDENTIFIER_UNION)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
\r
    Dict = {}\r
    for Result in ResultSet:\r
        if len(Result[1]) > 0:\r
            Dict[Result[0]] = Result[1]\r
\r
    IncludeFileList = GetAllIncludeFiles(FullFileName)\r
    for F in IncludeFileList:\r
        FileID = GetTableID(F)\r
        if FileID < 0:\r
            continue\r
\r
        FileTable = 'Identifier' + str(FileID)\r
        SqlStatement = """ select Name, Value, ID\r
                       from %s\r
                       where Model = %d or Model = %d\r
                   """ % (FileTable, DataClass.MODEL_IDENTIFIER_STRUCTURE, DataClass.MODEL_IDENTIFIER_UNION)\r
        ResultSet = Db.TblFile.Exec(SqlStatement)\r
\r
        for Result in ResultSet:\r
            if len(Result[1]) > 0:\r
                Dict[Result[0]] = Result[1]\r
\r
    SUDict[FullFileName] = Dict\r
    return Dict\r
\r
def StripComments(Str):\r
    Str += '   '\r
    ListFromStr = list(Str)\r
\r
    InComment = False\r
    DoubleSlashComment = False\r
    Index = 0\r
    while Index < len(ListFromStr):\r
        # meet new line, then no longer in a comment for //\r
        if ListFromStr[Index] == '\n':\r
            if InComment and DoubleSlashComment:\r
                InComment = False\r
                DoubleSlashComment = False\r
            Index += 1\r
        # check for */ comment end\r
        elif InComment and not DoubleSlashComment and ListFromStr[Index] == '*' and ListFromStr[Index + 1] == '/':\r
            ListFromStr[Index] = ' '\r
            Index += 1\r
            ListFromStr[Index] = ' '\r
            Index += 1\r
            InComment = False\r
        # set comments to spaces\r
        elif InComment:\r
            ListFromStr[Index] = ' '\r
            Index += 1\r
        # check for // comment\r
        elif ListFromStr[Index] == '/' and ListFromStr[Index + 1] == '/':\r
            InComment = True\r
            DoubleSlashComment = True\r
\r
        # check for /* comment start\r
        elif ListFromStr[Index] == '/' and ListFromStr[Index + 1] == '*':\r
            ListFromStr[Index] = ' '\r
            Index += 1\r
            ListFromStr[Index] = ' '\r
            Index += 1\r
            InComment = True\r
        else:\r
            Index += 1\r
\r
    # restore from List to String\r
    Str = "".join(ListFromStr)\r
    Str = Str.rstrip(' ')\r
\r
    return Str\r
\r
def GetFinalTypeValue(Type, FieldName, TypedefDict, SUDict):\r
    Value = TypedefDict.get(Type)\r
    if Value is None:\r
        Value = SUDict.get(Type)\r
    if Value is None:\r
        return None\r
\r
    LBPos = Value.find('{')\r
    while LBPos == -1:\r
        FTList = Value.split()\r
        for FT in FTList:\r
            if FT not in ('struct', 'union'):\r
                Value = TypedefDict.get(FT)\r
                if Value is None:\r
                    Value = SUDict.get(FT)\r
                break\r
\r
        if Value is None:\r
            return None\r
\r
        LBPos = Value.find('{')\r
\r
#    RBPos = Value.find('}')\r
    Fields = Value[LBPos + 1:]\r
    Fields = StripComments(Fields)\r
    FieldsList = Fields.split(';')\r
    for Field in FieldsList:\r
        Field = Field.strip()\r
        Index = Field.rfind(FieldName)\r
        if Index < 1:\r
            continue\r
        if not Field[Index - 1].isalnum():\r
            if Index + len(FieldName) == len(Field):\r
                Type = GetDataTypeFromModifier(Field[0:Index])\r
                return Type.strip()\r
            else:\r
            # For the condition that the field in struct is an array with [] suffixes...\r
                if not Field[Index + len(FieldName)].isalnum():\r
                    Type = GetDataTypeFromModifier(Field[0:Index])\r
                    return Type.strip()\r
\r
    return None\r
\r
def GetRealType(Type, TypedefDict, TargetType=None):\r
    if TargetType is not None and Type == TargetType:\r
            return Type\r
    while TypedefDict.get(Type):\r
        Type = TypedefDict.get(Type)\r
        if TargetType is not None and Type == TargetType:\r
            return Type\r
    return Type\r
\r
def GetTypeInfo(RefList, Modifier, FullFileName, TargetType=None):\r
    TypedefDict = GetTypedefDict(FullFileName)\r
    SUDict = GetSUDict(FullFileName)\r
    Type = GetDataTypeFromModifier(Modifier).replace('*', '').strip()\r
\r
    Type = Type.split()[-1]\r
    Index = 0\r
    while Index < len(RefList):\r
        FieldName = RefList[Index]\r
        FromType = GetFinalTypeValue(Type, FieldName, TypedefDict, SUDict)\r
        if FromType is None:\r
            return None\r
        # we want to determine the exact type.\r
        if TargetType is not None:\r
            Type = FromType.split()[0]\r
        # we only want to check if it is a pointer\r
        else:\r
            Type = FromType\r
            if Type.find('*') != -1 and Index == len(RefList) - 1:\r
                return Type\r
            Type = FromType.split()[0]\r
\r
        Index += 1\r
\r
    Type = GetRealType(Type, TypedefDict, TargetType)\r
\r
    return Type\r
\r
def GetVarInfo(PredVarList, FuncRecord, FullFileName, IsFuncCall=False, TargetType=None, StarList=None):\r
\r
    PredVar = PredVarList[0]\r
    FileID = GetTableID(FullFileName)\r
\r
    Db = GetDB()\r
    FileTable = 'Identifier' + str(FileID)\r
    # search variable in include files\r
\r
    # it is a function call, search function declarations and definitions\r
    if IsFuncCall:\r
        SqlStatement = """ select Modifier, ID\r
                       from %s\r
                       where Model = %d and Value = \'%s\'\r
                   """ % (FileTable, DataClass.MODEL_IDENTIFIER_FUNCTION_DECLARATION, PredVar)\r
        ResultSet = Db.TblFile.Exec(SqlStatement)\r
\r
        for Result in ResultSet:\r
            Type = GetDataTypeFromModifier(Result[0]).split()[-1]\r
            TypedefDict = GetTypedefDict(FullFileName)\r
            Type = GetRealType(Type, TypedefDict, TargetType)\r
            return Type\r
\r
        IncludeFileList = GetAllIncludeFiles(FullFileName)\r
        for F in IncludeFileList:\r
            FileID = GetTableID(F)\r
            if FileID < 0:\r
                continue\r
\r
            FileTable = 'Identifier' + str(FileID)\r
            SqlStatement = """ select Modifier, ID\r
                           from %s\r
                           where Model = %d and Value = \'%s\'\r
                       """ % (FileTable, DataClass.MODEL_IDENTIFIER_FUNCTION_DECLARATION, PredVar)\r
            ResultSet = Db.TblFile.Exec(SqlStatement)\r
\r
            for Result in ResultSet:\r
                Type = GetDataTypeFromModifier(Result[0]).split()[-1]\r
                TypedefDict = GetTypedefDict(FullFileName)\r
                Type = GetRealType(Type, TypedefDict, TargetType)\r
                return Type\r
\r
        FileID = GetTableID(FullFileName)\r
        SqlStatement = """ select Modifier, ID\r
                       from Function\r
                       where BelongsToFile = %d and Name = \'%s\'\r
                   """ % (FileID, PredVar)\r
        ResultSet = Db.TblFile.Exec(SqlStatement)\r
\r
        for Result in ResultSet:\r
            Type = GetDataTypeFromModifier(Result[0]).split()[-1]\r
            TypedefDict = GetTypedefDict(FullFileName)\r
            Type = GetRealType(Type, TypedefDict, TargetType)\r
            return Type\r
\r
        for F in IncludeFileList:\r
            FileID = GetTableID(F)\r
            if FileID < 0:\r
                continue\r
\r
            FileTable = 'Identifier' + str(FileID)\r
            SqlStatement = """ select Modifier, ID\r
                           from Function\r
                           where BelongsToFile = %d and Name = \'%s\'\r
                       """ % (FileID, PredVar)\r
            ResultSet = Db.TblFile.Exec(SqlStatement)\r
\r
            for Result in ResultSet:\r
                Type = GetDataTypeFromModifier(Result[0]).split()[-1]\r
                TypedefDict = GetTypedefDict(FullFileName)\r
                Type = GetRealType(Type, TypedefDict, TargetType)\r
                return Type\r
\r
        return None\r
\r
    # really variable, search local variable first\r
    SqlStatement = """ select Modifier, ID\r
                       from %s\r
                       where Model = %d and Name = \'%s\' and StartLine >= %d and StartLine <= %d\r
                   """ % (FileTable, DataClass.MODEL_IDENTIFIER_VARIABLE, PredVar, FuncRecord[0], FuncRecord[1])\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    VarFound = False\r
    for Result in ResultSet:\r
        if len(PredVarList) > 1:\r
            Type = GetTypeInfo(PredVarList[1:], Result[0], FullFileName, TargetType)\r
            return Type\r
        else:\r
#            Type = GetDataTypeFromModifier(Result[0]).split()[-1]\r
            TypeList = GetDataTypeFromModifier(Result[0]).split()\r
            Type = TypeList[-1]\r
            if len(TypeList) > 1 and StarList is not None:\r
                for Star in StarList:\r
                    Type = Type.strip()\r
                    Type = Type.rstrip(Star)\r
                # Get real type after de-reference pointers.\r
                if len(Type.strip()) == 0:\r
                    Type = TypeList[-2]\r
            TypedefDict = GetTypedefDict(FullFileName)\r
            Type = GetRealType(Type, TypedefDict, TargetType)\r
            return Type\r
\r
    # search function parameters second\r
    ParamList = GetParamList(FuncRecord[2])\r
    for Param in ParamList:\r
        if Param.Name.strip() == PredVar:\r
            if len(PredVarList) > 1:\r
                Type = GetTypeInfo(PredVarList[1:], Param.Modifier, FullFileName, TargetType)\r
                return Type\r
            else:\r
                TypeList = GetDataTypeFromModifier(Param.Modifier).split()\r
                Type = TypeList[-1]\r
                if Type == '*' and len(TypeList) >= 2:\r
                    Type = TypeList[-2]\r
                if len(TypeList) > 1 and StarList is not None:\r
                    for Star in StarList:\r
                        Type = Type.strip()\r
                        Type = Type.rstrip(Star)\r
                    # Get real type after de-reference pointers.\r
                    if len(Type.strip()) == 0:\r
                        Type = TypeList[-2]\r
                TypedefDict = GetTypedefDict(FullFileName)\r
                Type = GetRealType(Type, TypedefDict, TargetType)\r
                return Type\r
\r
    # search global variable next\r
    SqlStatement = """ select Modifier, ID\r
           from %s\r
           where Model = %d and Name = \'%s\' and BelongsToFunction = -1\r
       """ % (FileTable, DataClass.MODEL_IDENTIFIER_VARIABLE, PredVar)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
\r
    for Result in ResultSet:\r
        if len(PredVarList) > 1:\r
            Type = GetTypeInfo(PredVarList[1:], Result[0], FullFileName, TargetType)\r
            return Type\r
        else:\r
            TypeList = GetDataTypeFromModifier(Result[0]).split()\r
            Type = TypeList[-1]\r
            if len(TypeList) > 1 and StarList is not None:\r
                for Star in StarList:\r
                    Type = Type.strip()\r
                    Type = Type.rstrip(Star)\r
                # Get real type after de-reference pointers.\r
                if len(Type.strip()) == 0:\r
                    Type = TypeList[-2]\r
            TypedefDict = GetTypedefDict(FullFileName)\r
            Type = GetRealType(Type, TypedefDict, TargetType)\r
            return Type\r
\r
    IncludeFileList = GetAllIncludeFiles(FullFileName)\r
    for F in IncludeFileList:\r
        FileID = GetTableID(F)\r
        if FileID < 0:\r
            continue\r
\r
        FileTable = 'Identifier' + str(FileID)\r
        SqlStatement = """ select Modifier, ID\r
                       from %s\r
                       where Model = %d and BelongsToFunction = -1 and Name = \'%s\'\r
                   """ % (FileTable, DataClass.MODEL_IDENTIFIER_VARIABLE, PredVar)\r
        ResultSet = Db.TblFile.Exec(SqlStatement)\r
\r
        for Result in ResultSet:\r
            if len(PredVarList) > 1:\r
                Type = GetTypeInfo(PredVarList[1:], Result[0], FullFileName, TargetType)\r
                return Type\r
            else:\r
                TypeList = GetDataTypeFromModifier(Result[0]).split()\r
                Type = TypeList[-1]\r
                if len(TypeList) > 1 and StarList is not None:\r
                    for Star in StarList:\r
                        Type = Type.strip()\r
                        Type = Type.rstrip(Star)\r
                    # Get real type after de-reference pointers.\r
                    if len(Type.strip()) == 0:\r
                        Type = TypeList[-2]\r
                TypedefDict = GetTypedefDict(FullFileName)\r
                Type = GetRealType(Type, TypedefDict, TargetType)\r
                return Type\r
\r
def GetTypeFromArray(Type, Var):\r
    Count = Var.count('[')\r
\r
    while Count > 0:\r
        Type = Type.strip()\r
        Type = Type.rstrip('*')\r
        Count = Count - 1\r
\r
    return Type\r
\r
def CheckFuncLayoutReturnType(FullFileName):\r
    ErrorMsgList = []\r
\r
    FileID = GetTableID(FullFileName, ErrorMsgList)\r
    if FileID < 0:\r
        return ErrorMsgList\r
\r
    Db = GetDB()\r
    FileTable = 'Identifier' + str(FileID)\r
    SqlStatement = """ select Modifier, ID, StartLine, StartColumn, EndLine, Value\r
                       from %s\r
                       where Model = %d\r
                   """ % (FileTable, DataClass.MODEL_IDENTIFIER_FUNCTION_DECLARATION)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    for Result in ResultSet:\r
        ReturnType = GetDataTypeFromModifier(Result[0])\r
        TypeStart = ReturnType.split()[0]\r
        FuncName = Result[5]\r
        if EccGlobalData.gException.IsException(ERROR_C_FUNCTION_LAYOUT_CHECK_RETURN_TYPE, FuncName):\r
            continue\r
        Result0 = Result[0]\r
        if Result0.upper().startswith('STATIC'):\r
            Result0 = Result0[6:].strip()\r
        Index = Result0.find(TypeStart)\r
        if Index != 0 or Result[3] != 0:\r
            PrintErrorMsg(ERROR_C_FUNCTION_LAYOUT_CHECK_RETURN_TYPE, '[%s] Return Type should appear at the start of line' % FuncName, FileTable, Result[1])\r
\r
        if Result[2] == Result[4]:\r
            PrintErrorMsg(ERROR_C_FUNCTION_LAYOUT_CHECK_RETURN_TYPE, '[%s] Return Type should appear on its own line' % FuncName, FileTable, Result[1])\r
\r
    SqlStatement = """ select Modifier, ID, StartLine, StartColumn, FunNameStartLine, Name\r
                       from Function\r
                       where BelongsToFile = %d\r
                   """ % (FileID)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    for Result in ResultSet:\r
        ReturnType = GetDataTypeFromModifier(Result[0])\r
        TypeStart = ReturnType.split()[0]\r
        FuncName = Result[5]\r
        if EccGlobalData.gException.IsException(ERROR_C_FUNCTION_LAYOUT_CHECK_RETURN_TYPE, FuncName):\r
            continue\r
        Result0 = Result[0]\r
        if Result0.upper().startswith('STATIC'):\r
            Result0 = Result0[6:].strip()\r
        Index = Result0.find(TypeStart)\r
        if Index != 0 or Result[3] != 0:\r
            PrintErrorMsg(ERROR_C_FUNCTION_LAYOUT_CHECK_RETURN_TYPE, '[%s] Return Type should appear at the start of line' % FuncName, 'Function', Result[1])\r
\r
def CheckFuncLayoutModifier(FullFileName):\r
    ErrorMsgList = []\r
\r
    FileID = GetTableID(FullFileName, ErrorMsgList)\r
    if FileID < 0:\r
        return ErrorMsgList\r
\r
    Db = GetDB()\r
    FileTable = 'Identifier' + str(FileID)\r
    SqlStatement = """ select Modifier, ID\r
                       from %s\r
                       where Model = %d\r
                   """ % (FileTable, DataClass.MODEL_IDENTIFIER_FUNCTION_DECLARATION)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    for Result in ResultSet:\r
        ReturnType = GetDataTypeFromModifier(Result[0])\r
        TypeStart = ReturnType.split()[0]\r
        Result0 = Result[0]\r
        if Result0.upper().startswith('STATIC'):\r
            Result0 = Result0[6:].strip()\r
        Index = Result0.find(TypeStart)\r
        if Index != 0:\r
            PrintErrorMsg(ERROR_C_FUNCTION_LAYOUT_CHECK_OPTIONAL_FUNCTIONAL_MODIFIER, '', FileTable, Result[1])\r
\r
    SqlStatement = """ select Modifier, ID\r
                       from Function\r
                       where BelongsToFile = %d\r
                   """ % (FileID)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    for Result in ResultSet:\r
        ReturnType = GetDataTypeFromModifier(Result[0])\r
        TypeStart = ReturnType.split()[0]\r
        Result0 = Result[0]\r
        if Result0.upper().startswith('STATIC'):\r
            Result0 = Result0[6:].strip()\r
        Index = Result0.find(TypeStart)\r
        if Index != 0:\r
            PrintErrorMsg(ERROR_C_FUNCTION_LAYOUT_CHECK_OPTIONAL_FUNCTIONAL_MODIFIER, '', 'Function', Result[1])\r
\r
def CheckFuncLayoutName(FullFileName):\r
    ErrorMsgList = []\r
    # Parameter variable format pattern.\r
    Pattern = re.compile(r'^[A-Z]+\S*[a-z]\S*$')\r
    ParamIgnoreList = ('VOID', '...')\r
    FileID = GetTableID(FullFileName, ErrorMsgList)\r
    if FileID < 0:\r
        return ErrorMsgList\r
\r
    Db = GetDB()\r
    FileTable = 'Identifier' + str(FileID)\r
    SqlStatement = """ select Name, ID, EndColumn, Value\r
                       from %s\r
                       where Model = %d\r
                   """ % (FileTable, DataClass.MODEL_IDENTIFIER_FUNCTION_DECLARATION)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    for Result in ResultSet:\r
        FuncName = Result[3]\r
        if EccGlobalData.gException.IsException(ERROR_C_FUNCTION_LAYOUT_CHECK_FUNCTION_NAME, FuncName):\r
            continue\r
        if Result[2] != 0:\r
            PrintErrorMsg(ERROR_C_FUNCTION_LAYOUT_CHECK_FUNCTION_NAME, 'Function name [%s] should appear at the start of a line' % FuncName, FileTable, Result[1])\r
        ParamList = GetParamList(Result[0])\r
        if len(ParamList) == 0:\r
            continue\r
        StartLine = 0\r
        for Param in ParamList:\r
            if Param.StartLine <= StartLine:\r
                PrintErrorMsg(ERROR_C_FUNCTION_LAYOUT_CHECK_FUNCTION_NAME, 'Parameter %s should be in its own line.' % Param.Name, FileTable, Result[1])\r
            if Param.StartLine - StartLine > 1:\r
                PrintErrorMsg(ERROR_C_FUNCTION_LAYOUT_CHECK_FUNCTION_NAME, 'Empty line appears before Parameter %s.' % Param.Name, FileTable, Result[1])\r
            if not Pattern.match(Param.Name) and not Param.Name in ParamIgnoreList and not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_VARIABLE_NAME, Param.Name):\r
                PrintErrorMsg(ERROR_NAMING_CONVENTION_CHECK_VARIABLE_NAME, 'Parameter [%s] NOT follow naming convention.' % Param.Name, FileTable, Result[1])\r
            StartLine = Param.StartLine\r
\r
        if not Result[0].endswith('\n  )') and not Result[0].endswith('\r  )'):\r
            PrintErrorMsg(ERROR_C_FUNCTION_LAYOUT_CHECK_FUNCTION_NAME, '\')\' should be on a new line and indented two spaces', FileTable, Result[1])\r
\r
    SqlStatement = """ select Modifier, ID, FunNameStartColumn, Name\r
                       from Function\r
                       where BelongsToFile = %d\r
                   """ % (FileID)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    for Result in ResultSet:\r
        FuncName = Result[3]\r
        if EccGlobalData.gException.IsException(ERROR_C_FUNCTION_LAYOUT_CHECK_FUNCTION_NAME, FuncName):\r
            continue\r
        if Result[2] != 0:\r
            PrintErrorMsg(ERROR_C_FUNCTION_LAYOUT_CHECK_FUNCTION_NAME, 'Function name [%s] should appear at the start of a line' % FuncName, 'Function', Result[1])\r
        ParamList = GetParamList(Result[0])\r
        if len(ParamList) == 0:\r
            continue\r
        StartLine = 0\r
        for Param in ParamList:\r
            if Param.StartLine <= StartLine:\r
                PrintErrorMsg(ERROR_C_FUNCTION_LAYOUT_CHECK_FUNCTION_NAME, 'Parameter %s should be in its own line.' % Param.Name, 'Function', Result[1])\r
            if Param.StartLine - StartLine > 1:\r
                PrintErrorMsg(ERROR_C_FUNCTION_LAYOUT_CHECK_FUNCTION_NAME, 'Empty line appears before Parameter %s.' % Param.Name, 'Function', Result[1])\r
            if not Pattern.match(Param.Name) and not Param.Name in ParamIgnoreList and not EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_VARIABLE_NAME, Param.Name):\r
                PrintErrorMsg(ERROR_NAMING_CONVENTION_CHECK_VARIABLE_NAME, 'Parameter [%s] NOT follow naming convention.' % Param.Name, FileTable, Result[1])\r
            StartLine = Param.StartLine\r
        if not Result[0].endswith('\n  )') and not Result[0].endswith('\r  )'):\r
            PrintErrorMsg(ERROR_C_FUNCTION_LAYOUT_CHECK_FUNCTION_NAME, '\')\' should be on a new line and indented two spaces', 'Function', Result[1])\r
\r
def CheckFuncLayoutPrototype(FullFileName):\r
    ErrorMsgList = []\r
\r
    FileID = GetTableID(FullFileName, ErrorMsgList)\r
    if FileID < 0:\r
        return ErrorMsgList\r
\r
    FileTable = 'Identifier' + str(FileID)\r
    Db = GetDB()\r
    SqlStatement = """ select Modifier, Header, Name, ID\r
                       from Function\r
                       where BelongsToFile = %d\r
                   """ % (FileID)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    if len(ResultSet) == 0:\r
        return ErrorMsgList\r
\r
    FuncDefList = []\r
    for Result in ResultSet:\r
        FuncDefList.append(Result)\r
\r
    SqlStatement = """ select Modifier, Name, ID\r
                       from %s\r
                       where Model = %d\r
                   """ % (FileTable, DataClass.MODEL_IDENTIFIER_FUNCTION_DECLARATION)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    FuncDeclList = []\r
    for Result in ResultSet:\r
        FuncDeclList.append(Result)\r
\r
    UndeclFuncList = []\r
    for FuncDef in FuncDefList:\r
        FuncName = FuncDef[2].strip()\r
        FuncModifier = FuncDef[0]\r
        FuncDefHeader = FuncDef[1]\r
        for FuncDecl in FuncDeclList:\r
            LBPos = FuncDecl[1].find('(')\r
            DeclName = FuncDecl[1][0:LBPos].strip()\r
            DeclModifier = FuncDecl[0]\r
            if DeclName == FuncName:\r
                if DiffModifier(FuncModifier, DeclModifier) and not EccGlobalData.gException.IsException(ERROR_C_FUNCTION_LAYOUT_CHECK_FUNCTION_PROTO_TYPE, FuncName):\r
                    PrintErrorMsg(ERROR_C_FUNCTION_LAYOUT_CHECK_FUNCTION_PROTO_TYPE, 'Function [%s] modifier different with prototype.' % FuncName, 'Function', FuncDef[3])\r
                ParamListOfDef = GetParamList(FuncDefHeader)\r
                ParamListOfDecl = GetParamList(FuncDecl[1])\r
                if len(ParamListOfDef) != len(ParamListOfDecl) and not EccGlobalData.gException.IsException(ERROR_C_FUNCTION_LAYOUT_CHECK_FUNCTION_PROTO_TYPE_2, FuncName):\r
                    PrintErrorMsg(ERROR_C_FUNCTION_LAYOUT_CHECK_FUNCTION_PROTO_TYPE_2, 'Parameter number different in function [%s].' % FuncName, 'Function', FuncDef[3])\r
                    break\r
\r
                Index = 0\r
                while Index < len(ParamListOfDef):\r
                    if DiffModifier(ParamListOfDef[Index].Modifier, ParamListOfDecl[Index].Modifier) and not EccGlobalData.gException.IsException(ERROR_C_FUNCTION_LAYOUT_CHECK_FUNCTION_PROTO_TYPE_3, FuncName):\r
                        PrintErrorMsg(ERROR_C_FUNCTION_LAYOUT_CHECK_FUNCTION_PROTO_TYPE_3, 'Parameter %s has different modifier with prototype in function [%s].' % (ParamListOfDef[Index].Name, FuncName), 'Function', FuncDef[3])\r
                    Index += 1\r
                break\r
        else:\r
            UndeclFuncList.append(FuncDef)\r
\r
    IncludeFileList = GetAllIncludeFiles(FullFileName)\r
    FuncDeclList = []\r
    for F in IncludeFileList:\r
        FileID = GetTableID(F, ErrorMsgList)\r
        if FileID < 0:\r
            continue\r
\r
        FileTable = 'Identifier' + str(FileID)\r
        SqlStatement = """ select Modifier, Name, ID\r
                       from %s\r
                       where Model = %d\r
                   """ % (FileTable, DataClass.MODEL_IDENTIFIER_FUNCTION_DECLARATION)\r
        ResultSet = Db.TblFile.Exec(SqlStatement)\r
\r
        for Result in ResultSet:\r
            FuncDeclList.append(Result)\r
\r
    for FuncDef in UndeclFuncList:\r
        FuncName = FuncDef[2].strip()\r
        FuncModifier = FuncDef[0]\r
        FuncDefHeader = FuncDef[1]\r
        for FuncDecl in FuncDeclList:\r
            LBPos = FuncDecl[1].find('(')\r
            DeclName = FuncDecl[1][0:LBPos].strip()\r
            DeclModifier = FuncDecl[0]\r
            if DeclName == FuncName:\r
                if DiffModifier(FuncModifier, DeclModifier) and not EccGlobalData.gException.IsException(ERROR_C_FUNCTION_LAYOUT_CHECK_FUNCTION_PROTO_TYPE, FuncName):\r
                    PrintErrorMsg(ERROR_C_FUNCTION_LAYOUT_CHECK_FUNCTION_PROTO_TYPE, 'Function [%s] modifier different with prototype.' % FuncName, 'Function', FuncDef[3])\r
                ParamListOfDef = GetParamList(FuncDefHeader)\r
                ParamListOfDecl = GetParamList(FuncDecl[1])\r
                if len(ParamListOfDef) != len(ParamListOfDecl) and not EccGlobalData.gException.IsException(ERROR_C_FUNCTION_LAYOUT_CHECK_FUNCTION_PROTO_TYPE_2, FuncName):\r
                    PrintErrorMsg(ERROR_C_FUNCTION_LAYOUT_CHECK_FUNCTION_PROTO_TYPE_2, 'Parameter number different in function [%s].' % FuncName, 'Function', FuncDef[3])\r
                    break\r
\r
                Index = 0\r
                while Index < len(ParamListOfDef):\r
                    if DiffModifier(ParamListOfDef[Index].Modifier, ParamListOfDecl[Index].Modifier) and not EccGlobalData.gException.IsException(ERROR_C_FUNCTION_LAYOUT_CHECK_FUNCTION_PROTO_TYPE_3, FuncName):\r
                        PrintErrorMsg(ERROR_C_FUNCTION_LAYOUT_CHECK_FUNCTION_PROTO_TYPE_3, 'Parameter %s has different modifier with prototype in function [%s].' % (ParamListOfDef[Index].Name, FuncName), 'Function', FuncDef[3])\r
                    Index += 1\r
                break\r
\r
def CheckFuncLayoutBody(FullFileName):\r
    ErrorMsgList = []\r
\r
    FileID = GetTableID(FullFileName, ErrorMsgList)\r
    if FileID < 0:\r
        return ErrorMsgList\r
\r
    FileTable = 'Identifier' + str(FileID)\r
    Db = GetDB()\r
    SqlStatement = """ select BodyStartColumn, EndColumn, ID, Name\r
                       from Function\r
                       where BelongsToFile = %d\r
                   """ % (FileID)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    if len(ResultSet) == 0:\r
        return ErrorMsgList\r
    for Result in ResultSet:\r
        if Result[0] != 0:\r
            if not EccGlobalData.gException.IsException(ERROR_C_FUNCTION_LAYOUT_CHECK_FUNCTION_BODY, Result[3]):\r
                PrintErrorMsg(ERROR_C_FUNCTION_LAYOUT_CHECK_FUNCTION_BODY,\r
                              'The open brace should be at the very beginning of a line for the function [%s].' % Result[3],\r
                              'Function', Result[2])\r
        if Result[1] != 0:\r
            if not EccGlobalData.gException.IsException(ERROR_C_FUNCTION_LAYOUT_CHECK_FUNCTION_BODY, Result[3]):\r
                PrintErrorMsg(ERROR_C_FUNCTION_LAYOUT_CHECK_FUNCTION_BODY,\r
                              'The close brace should be at the very beginning of a line for the function [%s].' % Result[3],\r
                              'Function', Result[2])\r
\r
def CheckFuncLayoutLocalVariable(FullFileName):\r
    ErrorMsgList = []\r
\r
    FileID = GetTableID(FullFileName, ErrorMsgList)\r
    if FileID < 0:\r
        return ErrorMsgList\r
\r
    Db = GetDB()\r
    FileTable = 'Identifier' + str(FileID)\r
    SqlStatement = """ select ID\r
                       from Function\r
                       where BelongsToFile = %d\r
                   """ % (FileID)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    if len(ResultSet) == 0:\r
        return ErrorMsgList\r
    FL = []\r
    for Result in ResultSet:\r
        FL.append(Result)\r
\r
    for F in FL:\r
        SqlStatement = """ select Name, Value, ID, Modifier\r
                       from %s\r
                       where Model = %d and BelongsToFunction = %d\r
                   """ % (FileTable, DataClass.MODEL_IDENTIFIER_VARIABLE, F[0])\r
        ResultSet = Db.TblFile.Exec(SqlStatement)\r
        if len(ResultSet) == 0:\r
            continue\r
\r
        for Result in ResultSet:\r
            if len(Result[1]) > 0 and 'CONST' not in Result[3]:\r
                PrintErrorMsg(ERROR_C_FUNCTION_LAYOUT_CHECK_NO_INIT_OF_VARIABLE, 'Variable Name: %s' % Result[0], FileTable, Result[2])\r
\r
def CheckMemberVariableFormat(Name, Value, FileTable, TdId, ModelId):\r
    ErrMsgList = []\r
    # Member variable format pattern.\r
    Pattern = re.compile(r'^[A-Z]+\S*[a-z]\S*$')\r
\r
    LBPos = Value.find('{')\r
    RBPos = Value.rfind('}')\r
    if LBPos == -1 or RBPos == -1:\r
        return ErrMsgList\r
\r
    Fields = Value[LBPos + 1 : RBPos]\r
    Fields = StripComments(Fields).strip()\r
    NestPos = Fields.find ('struct')\r
    if NestPos != -1 and (NestPos + len('struct') < len(Fields)) and ModelId != DataClass.MODEL_IDENTIFIER_UNION:\r
        if not Fields[NestPos + len('struct') + 1].isalnum():\r
            if not EccGlobalData.gException.IsException(ERROR_DECLARATION_DATA_TYPE_CHECK_NESTED_STRUCTURE, Name):\r
                PrintErrorMsg(ERROR_DECLARATION_DATA_TYPE_CHECK_NESTED_STRUCTURE, 'Nested struct in [%s].' % (Name), FileTable, TdId)\r
            return ErrMsgList\r
    NestPos = Fields.find ('union')\r
    if NestPos != -1 and (NestPos + len('union') < len(Fields)):\r
        if not Fields[NestPos + len('union') + 1].isalnum():\r
            if not EccGlobalData.gException.IsException(ERROR_DECLARATION_DATA_TYPE_CHECK_NESTED_STRUCTURE, Name):\r
                PrintErrorMsg(ERROR_DECLARATION_DATA_TYPE_CHECK_NESTED_STRUCTURE, 'Nested union in [%s].' % (Name), FileTable, TdId)\r
            return ErrMsgList\r
    NestPos = Fields.find ('enum')\r
    if NestPos != -1 and (NestPos + len('enum') < len(Fields)):\r
        if not Fields[NestPos + len('enum') + 1].isalnum():\r
            if not EccGlobalData.gException.IsException(ERROR_DECLARATION_DATA_TYPE_CHECK_NESTED_STRUCTURE, Name):\r
                PrintErrorMsg(ERROR_DECLARATION_DATA_TYPE_CHECK_NESTED_STRUCTURE, 'Nested enum in [%s].' % (Name), FileTable, TdId)\r
            return ErrMsgList\r
\r
    if ModelId == DataClass.MODEL_IDENTIFIER_ENUMERATE:\r
        FieldsList = Fields.split(',')\r
        # deal with enum is pre-assigned a value by function call ( , , , ...)\r
        QuoteCount = 0\r
        Index = 0\r
        RemoveCurrentElement = False\r
        while Index < len(FieldsList):\r
            Field = FieldsList[Index]\r
\r
            if Field.find('(') != -1:\r
                QuoteCount += 1\r
                RemoveCurrentElement = True\r
                Index += 1\r
                continue\r
\r
            if Field.find(')') != -1 and QuoteCount > 0:\r
                QuoteCount -= 1\r
\r
            if RemoveCurrentElement:\r
                FieldsList.remove(Field)\r
                if QuoteCount == 0:\r
                    RemoveCurrentElement = False\r
                continue\r
\r
            if QuoteCount == 0:\r
                RemoveCurrentElement = False\r
\r
            Index += 1\r
    else:\r
        FieldsList = Fields.split(';')\r
\r
    for Field in FieldsList:\r
        Field = Field.strip()\r
        if Field == '':\r
            continue\r
        # For the condition that the field in struct is an array with [] suffixes...\r
        if Field[-1] == ']':\r
            LBPos = Field.find('[')\r
            Field = Field[0:LBPos]\r
        # For the condition that bit field ": Number"\r
        if Field.find(':') != -1:\r
            ColonPos = Field.find(':')\r
            Field = Field[0:ColonPos]\r
\r
        Field = Field.strip()\r
        if Field == '':\r
            continue\r
        if Field.startswith("#"):\r
            continue\r
        # Enum could directly assign value to variable\r
        Field = Field.split('=')[0].strip()\r
        TokenList = Field.split()\r
        # Remove pointers before variable\r
        Token = TokenList[-1]\r
        if Token in ['OPTIONAL']:\r
            Token = TokenList[-2]\r
        if not Pattern.match(Token.lstrip('*')):\r
            ErrMsgList.append(Token.lstrip('*'))\r
\r
    return ErrMsgList\r
\r
def CheckDeclTypedefFormat(FullFileName, ModelId):\r
    ErrorMsgList = []\r
\r
    FileID = GetTableID(FullFileName, ErrorMsgList)\r
    if FileID < 0:\r
        return ErrorMsgList\r
\r
    Db = GetDB()\r
    FileTable = 'Identifier' + str(FileID)\r
    SqlStatement = """ select Name, StartLine, EndLine, ID, Value\r
                       from %s\r
                       where Model = %d\r
                   """ % (FileTable, ModelId)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    ResultList = []\r
    for Result in ResultSet:\r
        ResultList.append(Result)\r
\r
    ErrorType = ERROR_DECLARATION_DATA_TYPE_CHECK_ALL\r
    if ModelId == DataClass.MODEL_IDENTIFIER_STRUCTURE:\r
        ErrorType = ERROR_DECLARATION_DATA_TYPE_CHECK_STRUCTURE_DECLARATION\r
    elif ModelId == DataClass.MODEL_IDENTIFIER_ENUMERATE:\r
        ErrorType = ERROR_DECLARATION_DATA_TYPE_CHECK_ENUMERATED_TYPE\r
    elif ModelId == DataClass.MODEL_IDENTIFIER_UNION:\r
        ErrorType = ERROR_DECLARATION_DATA_TYPE_CHECK_UNION_TYPE\r
\r
    SqlStatement = """ select Modifier, Name, Value, StartLine, EndLine, ID\r
                       from %s\r
                       where Model = %d\r
                   """ % (FileTable, DataClass.MODEL_IDENTIFIER_TYPEDEF)\r
    TdSet = Db.TblFile.Exec(SqlStatement)\r
    TdList = []\r
    for Td in TdSet:\r
        TdList.append(Td)\r
    # Check member variable name format that from typedefs of ONLY this file.\r
    for Td in TdList:\r
        Name = Td[1].strip()\r
        Value = Td[2].strip()\r
        if Value.startswith('enum'):\r
            ValueModelId = DataClass.MODEL_IDENTIFIER_ENUMERATE\r
        elif Value.startswith('struct'):\r
            ValueModelId = DataClass.MODEL_IDENTIFIER_STRUCTURE\r
        elif Value.startswith('union'):\r
            ValueModelId = DataClass.MODEL_IDENTIFIER_UNION\r
        else:\r
            continue\r
\r
        if ValueModelId != ModelId:\r
            continue\r
        # Check member variable format.\r
        ErrMsgList = CheckMemberVariableFormat(Name, Value, FileTable, Td[5], ModelId)\r
        for ErrMsg in ErrMsgList:\r
            if EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_VARIABLE_NAME, Name + '.' + ErrMsg):\r
                continue\r
            PrintErrorMsg(ERROR_NAMING_CONVENTION_CHECK_VARIABLE_NAME, 'Member variable [%s] NOT follow naming convention.' % (Name + '.' + ErrMsg), FileTable, Td[5])\r
\r
    # First check in current file to see whether struct/union/enum is typedef-ed.\r
    UntypedefedList = []\r
    for Result in ResultList:\r
        # Check member variable format.\r
        Name = Result[0].strip()\r
        Value = Result[4].strip()\r
        if Value.startswith('enum'):\r
            ValueModelId = DataClass.MODEL_IDENTIFIER_ENUMERATE\r
        elif Value.startswith('struct'):\r
            ValueModelId = DataClass.MODEL_IDENTIFIER_STRUCTURE\r
        elif Value.startswith('union'):\r
            ValueModelId = DataClass.MODEL_IDENTIFIER_UNION\r
        else:\r
            continue\r
\r
        if ValueModelId != ModelId:\r
            continue\r
        ErrMsgList = CheckMemberVariableFormat(Name, Value, FileTable, Result[3], ModelId)\r
        for ErrMsg in ErrMsgList:\r
            if EccGlobalData.gException.IsException(ERROR_NAMING_CONVENTION_CHECK_VARIABLE_NAME, Result[0] + '.' + ErrMsg):\r
                continue\r
            PrintErrorMsg(ERROR_NAMING_CONVENTION_CHECK_VARIABLE_NAME, 'Member variable [%s] NOT follow naming convention.' % (Result[0] + '.' + ErrMsg), FileTable, Result[3])\r
        # Check whether it is typedefed.\r
        Found = False\r
        for Td in TdList:\r
            # skip function pointer\r
            if len(Td[0]) > 0:\r
                continue\r
            if Result[1] >= Td[3] and Td[4] >= Result[2]:\r
                Found = True\r
                if not Td[1].isupper():\r
                    PrintErrorMsg(ErrorType, 'Typedef should be UPPER case', FileTable, Td[5])\r
            if Result[0] in Td[2].split():\r
                Found = True\r
                if not Td[1].isupper():\r
                    PrintErrorMsg(ErrorType, 'Typedef should be UPPER case', FileTable, Td[5])\r
            if Found:\r
                break\r
\r
        if not Found:\r
            UntypedefedList.append(Result)\r
            continue\r
\r
    if len(UntypedefedList) == 0:\r
        return\r
\r
    IncludeFileList = GetAllIncludeFiles(FullFileName)\r
    TdList = []\r
    for F in IncludeFileList:\r
        FileID = GetTableID(F, ErrorMsgList)\r
        if FileID < 0:\r
            continue\r
\r
        IncludeFileTable = 'Identifier' + str(FileID)\r
        SqlStatement = """ select Modifier, Name, Value, StartLine, EndLine, ID\r
                       from %s\r
                       where Model = %d\r
                   """ % (IncludeFileTable, DataClass.MODEL_IDENTIFIER_TYPEDEF)\r
        ResultSet = Db.TblFile.Exec(SqlStatement)\r
        TdList.extend(ResultSet)\r
\r
    for Result in UntypedefedList:\r
\r
        # Check whether it is typedefed.\r
        Found = False\r
        for Td in TdList:\r
\r
            if len(Td[0]) > 0:\r
                continue\r
            if Result[1] >= Td[3] and Td[4] >= Result[2]:\r
                Found = True\r
                if not Td[1].isupper():\r
                    PrintErrorMsg(ErrorType, 'Typedef should be UPPER case', FileTable, Td[5])\r
            if Result[0] in Td[2].split():\r
                Found = True\r
                if not Td[1].isupper():\r
                    PrintErrorMsg(ErrorType, 'Typedef should be UPPER case', FileTable, Td[5])\r
            if Found:\r
                break\r
\r
        if not Found:\r
            PrintErrorMsg(ErrorType, 'No Typedef for %s' % Result[0], FileTable, Result[3])\r
            continue\r
\r
def CheckDeclStructTypedef(FullFileName):\r
    CheckDeclTypedefFormat(FullFileName, DataClass.MODEL_IDENTIFIER_STRUCTURE)\r
\r
def CheckDeclEnumTypedef(FullFileName):\r
    CheckDeclTypedefFormat(FullFileName, DataClass.MODEL_IDENTIFIER_ENUMERATE)\r
\r
def CheckDeclUnionTypedef(FullFileName):\r
    CheckDeclTypedefFormat(FullFileName, DataClass.MODEL_IDENTIFIER_UNION)\r
\r
def CheckDeclArgModifier(FullFileName):\r
    ErrorMsgList = []\r
\r
    FileID = GetTableID(FullFileName, ErrorMsgList)\r
    if FileID < 0:\r
        return ErrorMsgList\r
\r
    Db = GetDB()\r
    FileTable = 'Identifier' + str(FileID)\r
    SqlStatement = """ select Modifier, Name, ID\r
                       from %s\r
                       where Model = %d\r
                   """ % (FileTable, DataClass.MODEL_IDENTIFIER_VARIABLE)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    ModifierTuple = ('IN', 'OUT', 'OPTIONAL', 'UNALIGNED')\r
    MAX_MODIFIER_LENGTH = 100\r
    for Result in ResultSet:\r
        for Modifier in ModifierTuple:\r
            if PatternInModifier(Result[0], Modifier) and len(Result[0]) < MAX_MODIFIER_LENGTH:\r
                PrintErrorMsg(ERROR_DECLARATION_DATA_TYPE_CHECK_IN_OUT_MODIFIER, 'Variable Modifier %s' % Result[0], FileTable, Result[2])\r
                break\r
\r
    SqlStatement = """ select Modifier, Name, ID\r
                       from %s\r
                       where Model = %d\r
                   """ % (FileTable, DataClass.MODEL_IDENTIFIER_FUNCTION_DECLARATION)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    for Result in ResultSet:\r
        for Modifier in ModifierTuple:\r
            if PatternInModifier(Result[0], Modifier):\r
                PrintErrorMsg(ERROR_DECLARATION_DATA_TYPE_CHECK_IN_OUT_MODIFIER, 'Return Type Modifier %s' % Result[0], FileTable, Result[2])\r
                break\r
\r
    SqlStatement = """ select Modifier, Header, ID\r
                       from Function\r
                       where BelongsToFile = %d\r
                   """ % (FileID)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    for Result in ResultSet:\r
        for Modifier in ModifierTuple:\r
            if PatternInModifier(Result[0], Modifier):\r
                PrintErrorMsg(ERROR_DECLARATION_DATA_TYPE_CHECK_IN_OUT_MODIFIER, 'Return Type Modifier %s' % Result[0], FileTable, Result[2])\r
                break\r
\r
def CheckDeclNoUseCType(FullFileName):\r
    ErrorMsgList = []\r
\r
    FileID = GetTableID(FullFileName, ErrorMsgList)\r
    if FileID < 0:\r
        return ErrorMsgList\r
\r
    Db = GetDB()\r
    FileTable = 'Identifier' + str(FileID)\r
    SqlStatement = """ select Modifier, Name, ID\r
                       from %s\r
                       where Model = %d\r
                   """ % (FileTable, DataClass.MODEL_IDENTIFIER_VARIABLE)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    CTypeTuple = ('int', 'unsigned', 'char', 'void', 'static', 'long')\r
    for Result in ResultSet:\r
        for Type in CTypeTuple:\r
            if PatternInModifier(Result[0], Type):\r
                if EccGlobalData.gException.IsException(ERROR_DECLARATION_DATA_TYPE_CHECK_NO_USE_C_TYPE,\r
                                                        Result[0] + ' ' + Result[1]):\r
                    continue\r
                PrintErrorMsg(ERROR_DECLARATION_DATA_TYPE_CHECK_NO_USE_C_TYPE,\r
                              'Invalid variable type (%s) in definition [%s]' % (Type, Result[0] + ' ' + Result[1]),\r
                              FileTable,\r
                              Result[2])\r
                break\r
\r
    SqlStatement = """ select Modifier, Name, ID, Value\r
                       from %s\r
                       where Model = %d\r
                   """ % (FileTable, DataClass.MODEL_IDENTIFIER_FUNCTION_DECLARATION)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    for Result in ResultSet:\r
        ParamList = GetParamList(Result[1])\r
        FuncName = Result[3]\r
        if EccGlobalData.gException.IsException(ERROR_DECLARATION_DATA_TYPE_CHECK_NO_USE_C_TYPE, FuncName):\r
            continue\r
        for Type in CTypeTuple:\r
            if PatternInModifier(Result[0], Type):\r
                PrintErrorMsg(ERROR_DECLARATION_DATA_TYPE_CHECK_NO_USE_C_TYPE, '%s Return type %s' % (FuncName, Result[0]), FileTable, Result[2])\r
\r
            for Param in ParamList:\r
                if PatternInModifier(Param.Modifier, Type):\r
                    PrintErrorMsg(ERROR_DECLARATION_DATA_TYPE_CHECK_NO_USE_C_TYPE, 'Parameter %s' % Param.Name, FileTable, Result[2])\r
\r
    SqlStatement = """ select Modifier, Header, ID, Name\r
                       from Function\r
                       where BelongsToFile = %d\r
                   """ % (FileID)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    for Result in ResultSet:\r
        ParamList = GetParamList(Result[1])\r
        FuncName = Result[3]\r
        if EccGlobalData.gException.IsException(ERROR_DECLARATION_DATA_TYPE_CHECK_NO_USE_C_TYPE, FuncName):\r
            continue\r
        for Type in CTypeTuple:\r
            if PatternInModifier(Result[0], Type):\r
                PrintErrorMsg(ERROR_DECLARATION_DATA_TYPE_CHECK_NO_USE_C_TYPE, '[%s] Return type %s' % (FuncName, Result[0]), FileTable, Result[2])\r
\r
            for Param in ParamList:\r
                if PatternInModifier(Param.Modifier, Type):\r
                    PrintErrorMsg(ERROR_DECLARATION_DATA_TYPE_CHECK_NO_USE_C_TYPE, 'Parameter %s' % Param.Name, FileTable, Result[2])\r
\r
\r
def CheckPointerNullComparison(FullFileName):\r
    ErrorMsgList = []\r
\r
    FileID = GetTableID(FullFileName, ErrorMsgList)\r
    if FileID < 0:\r
        return ErrorMsgList\r
\r
    # cache the found function return type to accelerate later checking in this file.\r
    FuncReturnTypeDict = {}\r
\r
    Db = GetDB()\r
    FileTable = 'Identifier' + str(FileID)\r
    SqlStatement = """ select Value, StartLine, ID\r
                       from %s\r
                       where Model = %d\r
                   """ % (FileTable, DataClass.MODEL_IDENTIFIER_PREDICATE_EXPRESSION)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    if len(ResultSet) == 0:\r
        return\r
    PSL = []\r
    for Result in ResultSet:\r
        PSL.append([Result[0], Result[1], Result[2]])\r
\r
    SqlStatement = """ select BodyStartLine, EndLine, Header, Modifier, ID\r
                       from Function\r
                       where BelongsToFile = %d\r
                   """ % (FileID)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    FL = []\r
    for Result in ResultSet:\r
        FL.append([Result[0], Result[1], Result[2], Result[3], Result[4]])\r
\r
    p = GetFuncDeclPattern()\r
    for Str in PSL:\r
        FuncRecord = GetFuncContainsPE(Str[1], FL)\r
        if FuncRecord is None:\r
            continue\r
\r
        for Exp in GetPredicateListFromPredicateExpStr(Str[0]):\r
            PredInfo = SplitPredicateStr(Exp)\r
            if PredInfo[1] is None:\r
                PredVarStr = PredInfo[0][0].strip()\r
                IsFuncCall = False\r
                SearchInCache = False\r
                # PredVarStr may contain '.' or '->'\r
                TmpStr = PredVarStr.replace('.', '').replace('->', '')\r
                if p.match(TmpStr):\r
                    PredVarStr = PredVarStr[0:PredVarStr.find('(')]\r
                    SearchInCache = True\r
                    # Only direct function call using IsFuncCall branch. Multi-level ref. function call is considered a variable.\r
                    if TmpStr.startswith(PredVarStr):\r
                        IsFuncCall = True\r
\r
                if PredVarStr.strip() in IgnoredKeywordList:\r
                    continue\r
                StarList = []\r
                PredVarList = GetCNameList(PredVarStr, StarList)\r
                # No variable found, maybe value first? like (0 == VarName)\r
                if len(PredVarList) == 0:\r
                    continue\r
                if SearchInCache:\r
                    Type = FuncReturnTypeDict.get(PredVarStr)\r
                    if Type is not None:\r
                        if Type.find('*') != -1 and Type != 'BOOLEAN*':\r
                            PrintErrorMsg(ERROR_PREDICATE_EXPRESSION_CHECK_COMPARISON_NULL_TYPE, 'Predicate Expression: %s' % Exp, FileTable, Str[2])\r
                        continue\r
\r
                    if PredVarStr in FuncReturnTypeDict:\r
                        continue\r
\r
                Type = GetVarInfo(PredVarList, FuncRecord, FullFileName, IsFuncCall, None, StarList)\r
                if SearchInCache:\r
                    FuncReturnTypeDict[PredVarStr] = Type\r
                if Type is None:\r
                    continue\r
                Type = GetTypeFromArray(Type, PredVarStr)\r
                if Type.find('*') != -1 and Type != 'BOOLEAN*':\r
                    PrintErrorMsg(ERROR_PREDICATE_EXPRESSION_CHECK_COMPARISON_NULL_TYPE, 'Predicate Expression: %s' % Exp, FileTable, Str[2])\r
\r
def CheckNonBooleanValueComparison(FullFileName):\r
    ErrorMsgList = []\r
\r
    FileID = GetTableID(FullFileName, ErrorMsgList)\r
    if FileID < 0:\r
        return ErrorMsgList\r
\r
    # cache the found function return type to accelerate later checking in this file.\r
    FuncReturnTypeDict = {}\r
\r
    Db = GetDB()\r
    FileTable = 'Identifier' + str(FileID)\r
    SqlStatement = """ select Value, StartLine, ID\r
                       from %s\r
                       where Model = %d\r
                   """ % (FileTable, DataClass.MODEL_IDENTIFIER_PREDICATE_EXPRESSION)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    if len(ResultSet) == 0:\r
        return\r
    PSL = []\r
    for Result in ResultSet:\r
        PSL.append([Result[0], Result[1], Result[2]])\r
\r
    SqlStatement = """ select BodyStartLine, EndLine, Header, Modifier, ID\r
                       from Function\r
                       where BelongsToFile = %d\r
                   """ % (FileID)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    FL = []\r
    for Result in ResultSet:\r
        FL.append([Result[0], Result[1], Result[2], Result[3], Result[4]])\r
\r
    p = GetFuncDeclPattern()\r
    for Str in PSL:\r
        FuncRecord = GetFuncContainsPE(Str[1], FL)\r
        if FuncRecord is None:\r
            continue\r
\r
        for Exp in GetPredicateListFromPredicateExpStr(Str[0]):\r
            PredInfo = SplitPredicateStr(Exp)\r
            if PredInfo[1] is None:\r
                PredVarStr = PredInfo[0][0].strip()\r
                IsFuncCall = False\r
                SearchInCache = False\r
                # PredVarStr may contain '.' or '->'\r
                TmpStr = PredVarStr.replace('.', '').replace('->', '')\r
                if p.match(TmpStr):\r
                    PredVarStr = PredVarStr[0:PredVarStr.find('(')]\r
                    SearchInCache = True\r
                    # Only direct function call using IsFuncCall branch. Multi-level ref. function call is considered a variable.\r
                    if TmpStr.startswith(PredVarStr):\r
                        IsFuncCall = True\r
\r
                if PredVarStr.strip() in IgnoredKeywordList:\r
                    continue\r
                StarList = []\r
                PredVarList = GetCNameList(PredVarStr, StarList)\r
                # No variable found, maybe value first? like (0 == VarName)\r
                if len(PredVarList) == 0:\r
                    continue\r
\r
                if SearchInCache:\r
                    Type = FuncReturnTypeDict.get(PredVarStr)\r
                    if Type is not None:\r
                        if Type.find('BOOLEAN') == -1:\r
                            PrintErrorMsg(ERROR_PREDICATE_EXPRESSION_CHECK_NO_BOOLEAN_OPERATOR, 'Predicate Expression: %s' % Exp, FileTable, Str[2])\r
                        continue\r
\r
                    if PredVarStr in FuncReturnTypeDict:\r
                        continue\r
                Type = GetVarInfo(PredVarList, FuncRecord, FullFileName, IsFuncCall, 'BOOLEAN', StarList)\r
                if SearchInCache:\r
                    FuncReturnTypeDict[PredVarStr] = Type\r
                if Type is None:\r
                    continue\r
                if Type.find('BOOLEAN') == -1:\r
                    PrintErrorMsg(ERROR_PREDICATE_EXPRESSION_CHECK_NO_BOOLEAN_OPERATOR, 'Predicate Expression: %s' % Exp, FileTable, Str[2])\r
\r
\r
def CheckBooleanValueComparison(FullFileName):\r
    ErrorMsgList = []\r
\r
    FileID = GetTableID(FullFileName, ErrorMsgList)\r
    if FileID < 0:\r
        return ErrorMsgList\r
\r
    # cache the found function return type to accelerate later checking in this file.\r
    FuncReturnTypeDict = {}\r
\r
    Db = GetDB()\r
    FileTable = 'Identifier' + str(FileID)\r
    SqlStatement = """ select Value, StartLine, ID\r
                       from %s\r
                       where Model = %d\r
                   """ % (FileTable, DataClass.MODEL_IDENTIFIER_PREDICATE_EXPRESSION)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    if len(ResultSet) == 0:\r
        return\r
    PSL = []\r
    for Result in ResultSet:\r
        PSL.append([Result[0], Result[1], Result[2]])\r
\r
    SqlStatement = """ select BodyStartLine, EndLine, Header, Modifier, ID\r
                       from Function\r
                       where BelongsToFile = %d\r
                   """ % (FileID)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    FL = []\r
    for Result in ResultSet:\r
        FL.append([Result[0], Result[1], Result[2], Result[3], Result[4]])\r
\r
    p = GetFuncDeclPattern()\r
    for Str in PSL:\r
        FuncRecord = GetFuncContainsPE(Str[1], FL)\r
        if FuncRecord is None:\r
            continue\r
\r
        for Exp in GetPredicateListFromPredicateExpStr(Str[0]):\r
            PredInfo = SplitPredicateStr(Exp)\r
            if PredInfo[1] in ('==', '!=') and PredInfo[0][1] in ('TRUE', 'FALSE'):\r
                PredVarStr = PredInfo[0][0].strip()\r
                IsFuncCall = False\r
                SearchInCache = False\r
                # PredVarStr may contain '.' or '->'\r
                TmpStr = PredVarStr.replace('.', '').replace('->', '')\r
                if p.match(TmpStr):\r
                    PredVarStr = PredVarStr[0:PredVarStr.find('(')]\r
                    SearchInCache = True\r
                    # Only direct function call using IsFuncCall branch. Multi-level ref. function call is considered a variable.\r
                    if TmpStr.startswith(PredVarStr):\r
                        IsFuncCall = True\r
\r
                if PredVarStr.strip() in IgnoredKeywordList:\r
                    continue\r
                StarList = []\r
                PredVarList = GetCNameList(PredVarStr, StarList)\r
                # No variable found, maybe value first? like (0 == VarName)\r
                if len(PredVarList) == 0:\r
                    continue\r
\r
                if SearchInCache:\r
                    Type = FuncReturnTypeDict.get(PredVarStr)\r
                    if Type is not None:\r
                        if Type.find('BOOLEAN') != -1:\r
                            PrintErrorMsg(ERROR_PREDICATE_EXPRESSION_CHECK_BOOLEAN_VALUE, 'Predicate Expression: %s' % Exp, FileTable, Str[2])\r
                        continue\r
\r
                    if PredVarStr in FuncReturnTypeDict:\r
                        continue\r
\r
                Type = GetVarInfo(PredVarList, FuncRecord, FullFileName, IsFuncCall, 'BOOLEAN', StarList)\r
                if SearchInCache:\r
                    FuncReturnTypeDict[PredVarStr] = Type\r
                if Type is None:\r
                    continue\r
                if Type.find('BOOLEAN') != -1:\r
                    PrintErrorMsg(ERROR_PREDICATE_EXPRESSION_CHECK_BOOLEAN_VALUE, 'Predicate Expression: %s' % Exp, FileTable, Str[2])\r
\r
\r
def CheckHeaderFileData(FullFileName, AllTypedefFun=[]):\r
    ErrorMsgList = []\r
\r
    FileID = GetTableID(FullFileName, ErrorMsgList)\r
    if FileID < 0:\r
        return ErrorMsgList\r
\r
    Db = GetDB()\r
    FileTable = 'Identifier' + str(FileID)\r
    SqlStatement = """ select ID, Modifier\r
                       from %s\r
                       where Model = %d\r
                   """ % (FileTable, DataClass.MODEL_IDENTIFIER_VARIABLE)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    for Result in ResultSet:\r
        if not Result[1].startswith('extern'):\r
            for Item in AllTypedefFun:\r
                if '(%s)' % Result[1] in Item:\r
                    break\r
            else:\r
                PrintErrorMsg(ERROR_INCLUDE_FILE_CHECK_DATA, 'Variable definition appears in header file', FileTable, Result[0])\r
\r
    SqlStatement = """ select ID\r
                       from Function\r
                       where BelongsToFile = %d\r
                   """ % FileID\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    for Result in ResultSet:\r
        PrintErrorMsg(ERROR_INCLUDE_FILE_CHECK_DATA, 'Function definition appears in header file', 'Function', Result[0])\r
\r
    return ErrorMsgList\r
\r
def CheckHeaderFileIfndef(FullFileName):\r
    ErrorMsgList = []\r
\r
    FileID = GetTableID(FullFileName, ErrorMsgList)\r
    if FileID < 0:\r
        return ErrorMsgList\r
\r
    Db = GetDB()\r
    FileTable = 'Identifier' + str(FileID)\r
    SqlStatement = """ select Value, StartLine\r
                       from %s\r
                       where Model = %d order by StartLine\r
                   """ % (FileTable, DataClass.MODEL_IDENTIFIER_MACRO_IFNDEF)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    if len(ResultSet) == 0:\r
        PrintErrorMsg(ERROR_INCLUDE_FILE_CHECK_IFNDEF_STATEMENT_1, '', 'File', FileID)\r
        return ErrorMsgList\r
    for Result in ResultSet:\r
        SqlStatement = """ select Value, EndLine\r
                       from %s\r
                       where EndLine < %d\r
                   """ % (FileTable, Result[1])\r
        ResultSet = Db.TblFile.Exec(SqlStatement)\r
        for Result in ResultSet:\r
            if not Result[0].startswith('/*') and not Result[0].startswith('//'):\r
                PrintErrorMsg(ERROR_INCLUDE_FILE_CHECK_IFNDEF_STATEMENT_2, '', 'File', FileID)\r
        break\r
\r
    SqlStatement = """ select Value\r
                       from %s\r
                       where StartLine > (select max(EndLine) from %s where Model = %d)\r
                   """ % (FileTable, FileTable, DataClass.MODEL_IDENTIFIER_MACRO_ENDIF)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    for Result in ResultSet:\r
        if not Result[0].startswith('/*') and not Result[0].startswith('//'):\r
            PrintErrorMsg(ERROR_INCLUDE_FILE_CHECK_IFNDEF_STATEMENT_3, '', 'File', FileID)\r
    return ErrorMsgList\r
\r
def CheckDoxygenCommand(FullFileName):\r
    ErrorMsgList = []\r
\r
    FileID = GetTableID(FullFileName, ErrorMsgList)\r
    if FileID < 0:\r
        return ErrorMsgList\r
\r
    Db = GetDB()\r
    FileTable = 'Identifier' + str(FileID)\r
    SqlStatement = """ select Value, ID\r
                       from %s\r
                       where Model = %d or Model = %d\r
                   """ % (FileTable, DataClass.MODEL_IDENTIFIER_COMMENT, DataClass.MODEL_IDENTIFIER_FUNCTION_HEADER)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    DoxygenCommandList = ['bug', 'todo', 'example', 'file', 'attention', 'param', 'post', 'pre', 'retval',\r
                          'return', 'sa', 'since', 'test', 'note', 'par', 'endcode', 'code']\r
    for Result in ResultSet:\r
        CommentStr = Result[0]\r
        CommentPartList = CommentStr.split()\r
        for Part in CommentPartList:\r
            if Part.upper() == 'BUGBUG':\r
                PrintErrorMsg(ERROR_DOXYGEN_CHECK_COMMAND, 'Bug should be marked with doxygen tag @bug', FileTable, Result[1])\r
            if Part.upper() == 'TODO':\r
                PrintErrorMsg(ERROR_DOXYGEN_CHECK_COMMAND, 'ToDo should be marked with doxygen tag @todo', FileTable, Result[1])\r
            if Part.startswith('@'):\r
                if EccGlobalData.gException.IsException(ERROR_DOXYGEN_CHECK_COMMAND, Part):\r
                    continue\r
                if not Part.replace('@', '').strip():\r
                    continue\r
                if Part.lstrip('@') in ['{', '}']:\r
                    continue\r
                if Part.lstrip('@').isalpha():\r
                    if Part.lstrip('@') not in DoxygenCommandList:\r
                        PrintErrorMsg(ERROR_DOXYGEN_CHECK_COMMAND, 'Unknown doxygen command %s' % Part, FileTable, Result[1])\r
                else:\r
                    Index = Part.find('[')\r
                    if Index == -1:\r
                        PrintErrorMsg(ERROR_DOXYGEN_CHECK_COMMAND, 'Unknown doxygen command %s' % Part, FileTable, Result[1])\r
                    RealCmd = Part[1:Index]\r
                    if RealCmd not in DoxygenCommandList:\r
                        PrintErrorMsg(ERROR_DOXYGEN_CHECK_COMMAND, 'Unknown doxygen command %s' % Part, FileTable, Result[1])\r
\r
\r
def CheckDoxygenTripleForwardSlash(FullFileName):\r
    ErrorMsgList = []\r
\r
    FileID = GetTableID(FullFileName, ErrorMsgList)\r
    if FileID < 0:\r
        return ErrorMsgList\r
\r
    Db = GetDB()\r
\r
    SqlStatement = """ select ID, BodyStartLine, BodyStartColumn, EndLine, EndColumn\r
                       from Function\r
                       where BelongsToFile = %d\r
                   """ % (FileID)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    if len(ResultSet) == 0:\r
        return\r
\r
    FuncDefSet = []\r
    for Result in ResultSet:\r
        FuncDefSet.append(Result)\r
\r
\r
    FileTable = 'Identifier' + str(FileID)\r
    SqlStatement = """ select Value, ID, StartLine, StartColumn, EndLine, EndColumn\r
                       from %s\r
                       where Model = %d\r
\r
                   """ % (FileTable, DataClass.MODEL_IDENTIFIER_COMMENT)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    CommentSet = []\r
    try:\r
        for Result in ResultSet:\r
            CommentSet.append(Result)\r
    except:\r
        print('Unrecognized chars in comment of file %s', FullFileName)\r
\r
\r
    for Result in CommentSet:\r
        CommentStr = Result[0]\r
        StartLine = Result[2]\r
        StartColumn = Result[3]\r
        EndLine = Result[4]\r
        EndColumn = Result[5]\r
        if not CommentStr.startswith('///<'):\r
            continue\r
\r
        Found = False\r
        for FuncDef in FuncDefSet:\r
            if StartLine == FuncDef[1] and StartColumn > FuncDef[2] and EndLine == FuncDef[3] and EndColumn < FuncDef[4]:\r
                Found = True\r
                break\r
            if StartLine > FuncDef[1] and EndLine < FuncDef[3]:\r
                Found = True\r
                break\r
            if StartLine == FuncDef[1] and StartColumn > FuncDef[2] and EndLine < FuncDef[3]:\r
                Found = True\r
                break\r
            if StartLine > FuncDef[1] and EndLine == FuncDef[3] and EndColumn < FuncDef[4]:\r
                Found = True\r
                break\r
        if Found:\r
            PrintErrorMsg(ERROR_DOXYGEN_CHECK_COMMENT_FORMAT, '', FileTable, Result[1])\r
\r
\r
def CheckFileHeaderDoxygenComments(FullFileName):\r
    ErrorMsgList = []\r
\r
    FileID = GetTableID(FullFileName, ErrorMsgList)\r
    if FileID < 0:\r
        return ErrorMsgList\r
\r
    Db = GetDB()\r
    FileTable = 'Identifier' + str(FileID)\r
    SqlStatement = """ select Value, ID\r
                       from %s\r
                       where Model = %d and (StartLine = 1 or StartLine = 7 or StartLine = 8) and StartColumn = 0\r
                   """ % (FileTable, DataClass.MODEL_IDENTIFIER_COMMENT)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    if len(ResultSet) == 0:\r
        PrintErrorMsg(ERROR_HEADER_CHECK_FILE, 'No File License header appear at the very beginning of file.', 'File', FileID)\r
        return ErrorMsgList\r
\r
    NoHeaderCommentStartFlag = True\r
    NoHeaderCommentEndFlag = True\r
    NoHeaderCommentPeriodFlag = True\r
    NoCopyrightFlag = True\r
    NoLicenseFlag = True\r
    NoRevReferFlag = True\r
    NextLineIndex = 0\r
    for Result in ResultSet:\r
        FileStartFlag = False\r
        CommentStrList = []\r
        CommentStr = Result[0].strip()\r
        CommentStrListTemp = CommentStr.split('\n')\r
        if (len(CommentStrListTemp) <= 1):\r
            # For Mac\r
            CommentStrListTemp = CommentStr.split('\r')\r
        # Skip the content before the file  header\r
        for CommentLine in CommentStrListTemp:\r
            if CommentLine.strip().startswith('/** @file'):\r
                FileStartFlag = True\r
            if FileStartFlag ==  True:\r
                CommentStrList.append(CommentLine)\r
\r
        ID = Result[1]\r
        Index = 0\r
        if CommentStrList and CommentStrList[0].strip().startswith('/** @file'):\r
            NoHeaderCommentStartFlag = False\r
        else:\r
            continue\r
        if CommentStrList and CommentStrList[-1].strip().endswith('**/'):\r
            NoHeaderCommentEndFlag = False\r
        else:\r
            continue\r
\r
        for CommentLine in CommentStrList:\r
            Index = Index + 1\r
            NextLineIndex = Index\r
            if CommentLine.startswith('/** @file'):\r
                continue\r
            if CommentLine.startswith('**/'):\r
                break\r
            # Check whether C File header Comment content start with two spaces.\r
            if EccGlobalData.gConfig.HeaderCheckCFileCommentStartSpacesNum == '1' or EccGlobalData.gConfig.HeaderCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
                if CommentLine.startswith('/** @file') == False and CommentLine.startswith('**/') == False and CommentLine.strip() and CommentLine.startswith('  ') == False:\r
                    PrintErrorMsg(ERROR_HEADER_CHECK_FILE, 'File header comment content should start with two spaces at each line', FileTable, ID)\r
\r
            CommentLine = CommentLine.strip()\r
            if CommentLine.startswith('Copyright'):\r
                NoCopyrightFlag = False\r
                if CommentLine.find('All rights reserved') == -1:\r
                    for Copyright in EccGlobalData.gConfig.Copyright:\r
                        if CommentLine.find(Copyright) > -1:\r
                            PrintErrorMsg(ERROR_HEADER_CHECK_FILE, '""All rights reserved"" announcement should be following the ""Copyright"" at the same line', FileTable, ID)\r
                            break\r
                if CommentLine.endswith('<BR>') == -1:\r
                    PrintErrorMsg(ERROR_HEADER_CHECK_FILE, 'The ""<BR>"" at the end of the Copyright line is required', FileTable, ID)\r
                if NextLineIndex < len(CommentStrList) and CommentStrList[NextLineIndex].strip().startswith('Copyright') == False and CommentStrList[NextLineIndex].strip():\r
                    NoLicenseFlag = False\r
            if CommentLine.startswith('@par Revision Reference:'):\r
                NoRevReferFlag = False\r
                RefListFlag = False\r
                for RefLine in CommentStrList[NextLineIndex:]:\r
                    if RefLine.strip() and (NextLineIndex + 1) < len(CommentStrList) and CommentStrList[NextLineIndex+1].strip() and CommentStrList[NextLineIndex+1].strip().startswith('**/') == False:\r
                        RefListFlag = True\r
                    if RefLine.strip() == False or RefLine.strip().startswith('**/'):\r
                        RefListFlag = False\r
                        break\r
                    # Check whether C File header Comment's each reference at list should begin with a bullet character.\r
                    if EccGlobalData.gConfig.HeaderCheckCFileCommentReferenceFormat == '1' or EccGlobalData.gConfig.HeaderCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
                        if RefListFlag == True:\r
                            if RefLine.strip() and RefLine.strip().startswith('**/') == False and RefLine.startswith('  -') == False:\r
                                PrintErrorMsg(ERROR_HEADER_CHECK_FILE, 'Each reference on a separate line should begin with a bullet character ""-"" ', FileTable, ID)\r
\r
    if NoHeaderCommentStartFlag:\r
        PrintErrorMsg(ERROR_DOXYGEN_CHECK_FILE_HEADER, 'File header comment should begin with ""/** @file""', FileTable, ID)\r
        return\r
    if NoHeaderCommentEndFlag:\r
        PrintErrorMsg(ERROR_HEADER_CHECK_FILE, 'File header comment should end with ""**/""', FileTable, ID)\r
        return\r
    if NoCopyrightFlag:\r
        PrintErrorMsg(ERROR_HEADER_CHECK_FILE, 'File header comment missing the ""Copyright""', FileTable, ID)\r
    #Check whether C File header Comment have the License immediately after the ""Copyright"" line.\r
    if EccGlobalData.gConfig.HeaderCheckCFileCommentLicenseFormat == '1' or EccGlobalData.gConfig.HeaderCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
        if NoLicenseFlag:\r
            PrintErrorMsg(ERROR_HEADER_CHECK_FILE, 'File header comment should have the License immediately after the ""Copyright"" line', FileTable, ID)\r
\r
def CheckFuncHeaderDoxygenComments(FullFileName):\r
    ErrorMsgList = []\r
\r
    FileID = GetTableID(FullFileName, ErrorMsgList)\r
    if FileID < 0:\r
        return ErrorMsgList\r
\r
    Db = GetDB()\r
    FileTable = 'Identifier' + str(FileID)\r
    SqlStatement = """ select Value, StartLine, EndLine, ID\r
                       from %s\r
                       where Model = %d\r
                   """ % (FileTable, DataClass.MODEL_IDENTIFIER_COMMENT)\r
\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    CommentSet = []\r
    try:\r
        for Result in ResultSet:\r
            CommentSet.append(Result)\r
    except:\r
        print('Unrecognized chars in comment of file %s', FullFileName)\r
\r
    # Func Decl check\r
    SqlStatement = """ select Modifier, Name, StartLine, ID, Value\r
                       from %s\r
                       where Model = %d\r
                   """ % (FileTable, DataClass.MODEL_IDENTIFIER_FUNCTION_DECLARATION)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    for Result in ResultSet:\r
        FuncName = Result[4]\r
        FunctionHeaderComment = CheckCommentImmediatelyPrecedeFunctionHeader(Result[1], Result[2], CommentSet)\r
        if FunctionHeaderComment:\r
            CheckFunctionHeaderConsistentWithDoxygenComment(Result[0], Result[1], Result[2], FunctionHeaderComment[0], FunctionHeaderComment[1], ErrorMsgList, FunctionHeaderComment[3], FileTable)\r
        else:\r
            if EccGlobalData.gException.IsException(ERROR_HEADER_CHECK_FUNCTION, FuncName):\r
                continue\r
            ErrorMsgList.append('Line %d :Function %s has NO comment immediately preceding it.' % (Result[2], Result[1]))\r
            PrintErrorMsg(ERROR_HEADER_CHECK_FUNCTION, 'Function [%s] has NO comment immediately preceding it.' % (FuncName), FileTable, Result[3])\r
\r
    # Func Def check\r
    SqlStatement = """ select Value, StartLine, EndLine, ID\r
                       from %s\r
                       where Model = %d\r
                   """ % (FileTable, DataClass.MODEL_IDENTIFIER_FUNCTION_HEADER)\r
\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    CommentSet = []\r
    try:\r
        for Result in ResultSet:\r
            CommentSet.append(Result)\r
    except:\r
        print('Unrecognized chars in comment of file %s', FullFileName)\r
\r
    SqlStatement = """ select Modifier, Header, StartLine, ID, Name\r
                       from Function\r
                       where BelongsToFile = %d\r
                   """ % (FileID)\r
    ResultSet = Db.TblFile.Exec(SqlStatement)\r
    for Result in ResultSet:\r
        FuncName = Result[4]\r
        FunctionHeaderComment = CheckCommentImmediatelyPrecedeFunctionHeader(Result[1], Result[2], CommentSet)\r
        if FunctionHeaderComment:\r
            CheckFunctionHeaderConsistentWithDoxygenComment(Result[0], Result[1], Result[2], FunctionHeaderComment[0], FunctionHeaderComment[1], ErrorMsgList, FunctionHeaderComment[3], FileTable)\r
        else:\r
            if EccGlobalData.gException.IsException(ERROR_HEADER_CHECK_FUNCTION, FuncName):\r
                continue\r
            ErrorMsgList.append('Line %d :Function [%s] has NO comment immediately preceding it.' % (Result[2], Result[1]))\r
            PrintErrorMsg(ERROR_HEADER_CHECK_FUNCTION, 'Function [%s] has NO comment immediately preceding it.' % (FuncName), 'Function', Result[3])\r
    return ErrorMsgList\r
\r
def CheckCommentImmediatelyPrecedeFunctionHeader(FuncName, FuncStartLine, CommentSet):\r
\r
    for Comment in CommentSet:\r
        if Comment[2] == FuncStartLine - 1:\r
            return Comment\r
    return None\r
\r
def GetDoxygenStrFromComment(Str):\r
    DoxygenStrList = []\r
    ParamTagList = Str.split('@param')\r
    if len(ParamTagList) > 1:\r
        i = 1\r
        while i < len(ParamTagList):\r
            DoxygenStrList.append('@param' + ParamTagList[i])\r
            i += 1\r
\r
    Str = ParamTagList[0]\r
\r
    RetvalTagList = ParamTagList[-1].split('@retval')\r
    if len(RetvalTagList) > 1:\r
        if len(ParamTagList) > 1:\r
            DoxygenStrList[-1] = '@param' + RetvalTagList[0]\r
        i = 1\r
        while i < len(RetvalTagList):\r
            DoxygenStrList.append('@retval' + RetvalTagList[i])\r
            i += 1\r
\r
    ReturnTagList = RetvalTagList[-1].split('@return')\r
    if len(ReturnTagList) > 1:\r
        if len(RetvalTagList) > 1:\r
            DoxygenStrList[-1] = '@retval' + ReturnTagList[0]\r
        elif len(ParamTagList) > 1:\r
            DoxygenStrList[-1] = '@param' + ReturnTagList[0]\r
        i = 1\r
        while i < len(ReturnTagList):\r
            DoxygenStrList.append('@return' + ReturnTagList[i])\r
            i += 1\r
\r
    if len(DoxygenStrList) > 0:\r
        DoxygenStrList[-1] = DoxygenStrList[-1].rstrip('--*/')\r
\r
    return DoxygenStrList\r
\r
def CheckGeneralDoxygenCommentLayout(Str, StartLine, ErrorMsgList, CommentId= -1, TableName=''):\r
    #/** --*/ @retval after @param\r
    if not Str.startswith('/**'):\r
        ErrorMsgList.append('Line %d : Comment does NOT have prefix /** ' % StartLine)\r
        PrintErrorMsg(ERROR_DOXYGEN_CHECK_FUNCTION_HEADER, 'Comment does NOT have prefix /** ', TableName, CommentId)\r
    if not Str.endswith('**/'):\r
        ErrorMsgList.append('Line %d : Comment does NOT have tail **/ ' % StartLine)\r
        PrintErrorMsg(ERROR_DOXYGEN_CHECK_FUNCTION_HEADER, 'Comment does NOT have tail **/ ', TableName, CommentId)\r
    FirstRetvalIndex = Str.find('@retval')\r
    LastParamIndex = Str.rfind('@param')\r
    if (FirstRetvalIndex > 0) and (LastParamIndex > 0) and (FirstRetvalIndex < LastParamIndex):\r
        ErrorMsgList.append('Line %d : @retval appear before @param ' % StartLine)\r
        PrintErrorMsg(ERROR_DOXYGEN_CHECK_FUNCTION_HEADER, 'in Comment, @retval appear before @param  ', TableName, CommentId)\r
\r
def CheckFunctionHeaderConsistentWithDoxygenComment(FuncModifier, FuncHeader, FuncStartLine, CommentStr, CommentStartLine, ErrorMsgList, CommentId= -1, TableName=''):\r
\r
    ParamList = GetParamList(FuncHeader)\r
    CheckGeneralDoxygenCommentLayout(CommentStr, CommentStartLine, ErrorMsgList, CommentId, TableName)\r
    DescriptionStr = CommentStr\r
    DoxygenStrList = GetDoxygenStrFromComment(DescriptionStr)\r
    if DescriptionStr.find('.') == -1:\r
        PrintErrorMsg(ERROR_DOXYGEN_CHECK_COMMENT_DESCRIPTION, 'Comment description should end with period \'.\'', TableName, CommentId)\r
    DoxygenTagNumber = len(DoxygenStrList)\r
    ParamNumber = len(ParamList)\r
    for Param in ParamList:\r
        if Param.Name.upper() == 'VOID' and ParamNumber == 1:\r
            ParamNumber -= 1\r
    Index = 0\r
    if ParamNumber > 0 and DoxygenTagNumber > 0:\r
        while Index < ParamNumber and Index < DoxygenTagNumber:\r
            ParamModifier = ParamList[Index].Modifier\r
            ParamName = ParamList[Index].Name.strip()\r
            Tag = DoxygenStrList[Index].strip(' ')\r
            if (not Tag[-1] == ('\n')) and (not Tag[-1] == ('\r')):\r
                ErrorMsgList.append('Line %d : in Comment, <%s> does NOT end with new line ' % (CommentStartLine, Tag.replace('\n', '').replace('\r', '')))\r
                PrintErrorMsg(ERROR_HEADER_CHECK_FUNCTION, 'in Comment, <%s> does NOT end with new line ' % (Tag.replace('\n', '').replace('\r', '')), TableName, CommentId)\r
            TagPartList = Tag.split()\r
            if len(TagPartList) < 2:\r
                ErrorMsgList.append('Line %d : in Comment, <%s> does NOT contain doxygen contents ' % (CommentStartLine, Tag.replace('\n', '').replace('\r', '')))\r
                PrintErrorMsg(ERROR_DOXYGEN_CHECK_FUNCTION_HEADER, 'in Comment, <%s> does NOT contain doxygen contents ' % (Tag.replace('\n', '').replace('\r', '')), TableName, CommentId)\r
                Index += 1\r
                continue\r
            LBPos = Tag.find('[')\r
            RBPos = Tag.find(']')\r
            ParamToLBContent = Tag[len('@param'):LBPos].strip()\r
            if LBPos > 0 and len(ParamToLBContent) == 0 and RBPos > LBPos:\r
                InOutStr = ''\r
                ModifierPartList = ParamModifier.split()\r
                for Part in ModifierPartList:\r
                    if Part.strip() == 'IN':\r
                        InOutStr += 'in'\r
                    if Part.strip() == 'OUT':\r
                        if InOutStr != '':\r
                            InOutStr += ', out'\r
                        else:\r
                            InOutStr = 'out'\r
\r
                if InOutStr != '':\r
                    if Tag.find('[' + InOutStr + ']') == -1:\r
                        if InOutStr != 'in, out':\r
                            ErrorMsgList.append('Line %d : in Comment, <%s> does NOT have %s ' % (CommentStartLine, (TagPartList[0] + ' ' + TagPartList[1]).replace('\n', '').replace('\r', ''), '[' + InOutStr + ']'))\r
                            PrintErrorMsg(ERROR_DOXYGEN_CHECK_FUNCTION_HEADER, 'in Comment, <%s> does NOT have %s ' % ((TagPartList[0] + ' ' + TagPartList[1]).replace('\n', '').replace('\r', ''), '[' + InOutStr + ']'), TableName, CommentId)\r
                        else:\r
                            if Tag.find('[in,out]') == -1:\r
                                ErrorMsgList.append('Line %d : in Comment, <%s> does NOT have %s ' % (CommentStartLine, (TagPartList[0] + ' ' + TagPartList[1]).replace('\n', '').replace('\r', ''), '[' + InOutStr + ']'))\r
                                PrintErrorMsg(ERROR_DOXYGEN_CHECK_FUNCTION_HEADER, 'in Comment, <%s> does NOT have %s ' % ((TagPartList[0] + ' ' + TagPartList[1]).replace('\n', '').replace('\r', ''), '[' + InOutStr + ']'), TableName, CommentId)\r
\r
\r
            if Tag.find(ParamName) == -1 and ParamName != 'VOID' and ParamName != 'void':\r
                ErrorMsgList.append('Line %d : in Comment, <%s> does NOT consistent with parameter name %s ' % (CommentStartLine, (TagPartList[0] + ' ' + TagPartList[1]).replace('\n', '').replace('\r', ''), ParamName))\r
                PrintErrorMsg(ERROR_DOXYGEN_CHECK_FUNCTION_HEADER, 'in Comment, <%s> does NOT consistent with parameter name %s ' % ((TagPartList[0] + ' ' + TagPartList[1]).replace('\n', '').replace('\r', ''), ParamName), TableName, CommentId)\r
            Index += 1\r
\r
        if Index < ParamNumber:\r
            ErrorMsgList.append('Line %d : Number of doxygen tags in comment less than number of function parameters' % CommentStartLine)\r
            PrintErrorMsg(ERROR_DOXYGEN_CHECK_FUNCTION_HEADER, 'Number of doxygen tags in comment less than number of function parameters ', TableName, CommentId)\r
        # VOID return type, NOT VOID*. VOID* should be matched with a doxygen tag.\r
        if (FuncModifier.find('VOID') != -1 or FuncModifier.find('void') != -1) and FuncModifier.find('*') == -1:\r
\r
            # assume we allow a return description tag for void func. return. that's why 'DoxygenTagNumber - 1' is used instead of 'DoxygenTagNumber'\r
            if Index < DoxygenTagNumber - 1 or (Index < DoxygenTagNumber and DoxygenStrList[Index].startswith('@retval')):\r
                ErrorMsgList.append('Line %d : VOID return type need NO doxygen tags in comment' % CommentStartLine)\r
                PrintErrorMsg(ERROR_DOXYGEN_CHECK_FUNCTION_HEADER, 'VOID return type need no doxygen tags in comment ', TableName, CommentId)\r
        else:\r
            if Index < DoxygenTagNumber and not DoxygenStrList[Index].startswith('@retval') and not DoxygenStrList[Index].startswith('@return'):\r
                ErrorMsgList.append('Line %d : Number of @param doxygen tags in comment does NOT match number of function parameters' % CommentStartLine)\r
                PrintErrorMsg(ERROR_DOXYGEN_CHECK_FUNCTION_HEADER, 'Number of @param doxygen tags in comment does NOT match number of function parameters ', TableName, CommentId)\r
    else:\r
        if ParamNumber == 0 and DoxygenTagNumber != 0 and ((FuncModifier.find('VOID') != -1 or FuncModifier.find('void') != -1) and FuncModifier.find('*') == -1):\r
            ErrorMsgList.append('Line %d : VOID return type need NO doxygen tags in comment' % CommentStartLine)\r
            PrintErrorMsg(ERROR_DOXYGEN_CHECK_FUNCTION_HEADER, 'VOID return type need NO doxygen tags in comment ', TableName, CommentId)\r
        if ParamNumber != 0 and DoxygenTagNumber == 0:\r
            ErrorMsgList.append('Line %d : No doxygen tags in comment' % CommentStartLine)\r
            PrintErrorMsg(ERROR_DOXYGEN_CHECK_FUNCTION_HEADER, 'No doxygen tags in comment ', TableName, CommentId)\r
\r
if __name__ == '__main__':\r
\r
#    EdkLogger.Initialize()\r
#    EdkLogger.SetLevel(EdkLogger.QUIET)\r
#    CollectSourceCodeDataIntoDB(sys.argv[1])\r
    try:\r
        test_file = sys.argv[1]\r
    except IndexError as v:\r
        print("Usage: %s filename" % sys.argv[0])\r
        sys.exit(1)\r
    MsgList = CheckFuncHeaderDoxygenComments(test_file)\r
    for Msg in MsgList:\r
        print(Msg)\r
    print('Done!')\r