[mirror_edk2.git] / BaseTools / Source / Python / CommonDataClass / DataClass.py

## @file\r
# This file is used to define class for data structure used in ECC\r
#\r
# Copyright (c) 2008 - 2014, Intel Corporation. All rights reserved.<BR>\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
##\r
# Import Modules\r
#\r
import Common.EdkLogger as EdkLogger\r
\r
##\r
# Static values for data models\r
#\r
MODEL_UNKNOWN = 0\r
\r
MODEL_FILE_C = 1001\r
MODEL_FILE_H = 1002\r
MODEL_FILE_ASM = 1003\r
MODEL_FILE_INF = 1011\r
MODEL_FILE_DEC = 1012\r
MODEL_FILE_DSC = 1013\r
MODEL_FILE_FDF = 1014\r
MODEL_FILE_INC = 1015\r
MODEL_FILE_CIF = 1016\r
MODEL_FILE_UNI = 1017\r
MODEL_FILE_OTHERS = 1099\r
\r
MODEL_IDENTIFIER_FILE_HEADER = 2001\r
MODEL_IDENTIFIER_FUNCTION_HEADER = 2002\r
MODEL_IDENTIFIER_COMMENT = 2003\r
MODEL_IDENTIFIER_PARAMETER = 2004\r
MODEL_IDENTIFIER_STRUCTURE = 2005\r
MODEL_IDENTIFIER_VARIABLE = 2006\r
MODEL_IDENTIFIER_INCLUDE = 2007\r
MODEL_IDENTIFIER_PREDICATE_EXPRESSION = 2008\r
MODEL_IDENTIFIER_ENUMERATE = 2009\r
MODEL_IDENTIFIER_PCD = 2010\r
MODEL_IDENTIFIER_UNION = 2011\r
MODEL_IDENTIFIER_MACRO_IFDEF = 2012\r
MODEL_IDENTIFIER_MACRO_IFNDEF = 2013\r
MODEL_IDENTIFIER_MACRO_DEFINE = 2014\r
MODEL_IDENTIFIER_MACRO_ENDIF = 2015\r
MODEL_IDENTIFIER_MACRO_PROGMA = 2016\r
MODEL_IDENTIFIER_FUNCTION_CALLING = 2018\r
MODEL_IDENTIFIER_TYPEDEF = 2017\r
MODEL_IDENTIFIER_FUNCTION_DECLARATION = 2019\r
MODEL_IDENTIFIER_ASSIGNMENT_EXPRESSION = 2020\r
\r
MODEL_EFI_PROTOCOL = 3001\r
MODEL_EFI_PPI = 3002\r
MODEL_EFI_GUID = 3003\r
MODEL_EFI_LIBRARY_CLASS = 3004\r
MODEL_EFI_LIBRARY_INSTANCE = 3005\r
MODEL_EFI_PCD = 3006\r
MODEL_EFI_SOURCE_FILE = 3007\r
MODEL_EFI_BINARY_FILE = 3008\r
MODEL_EFI_SKU_ID = 3009\r
MODEL_EFI_INCLUDE = 3010\r
MODEL_EFI_DEPEX = 3011\r
MODEL_EFI_DEFAULT_STORES = 3012\r
\r
MODEL_PCD = 4000\r
MODEL_PCD_FIXED_AT_BUILD = 4001\r
MODEL_PCD_PATCHABLE_IN_MODULE = 4002\r
MODEL_PCD_FEATURE_FLAG = 4003\r
MODEL_PCD_DYNAMIC_EX = 4004\r
MODEL_PCD_DYNAMIC_EX_DEFAULT = 4005\r
MODEL_PCD_DYNAMIC_EX_VPD = 4006\r
MODEL_PCD_DYNAMIC_EX_HII = 4007\r
MODEL_PCD_DYNAMIC = 4008\r
MODEL_PCD_DYNAMIC_DEFAULT = 4009\r
MODEL_PCD_DYNAMIC_VPD = 4010\r
MODEL_PCD_DYNAMIC_HII = 4011\r
MODEL_PCD_TYPE_LIST = [MODEL_PCD_FIXED_AT_BUILD,\r
                        MODEL_PCD_PATCHABLE_IN_MODULE,\r
                        MODEL_PCD_FEATURE_FLAG,\r
                        MODEL_PCD_DYNAMIC_DEFAULT,\r
                        MODEL_PCD_DYNAMIC_HII,\r
                        MODEL_PCD_DYNAMIC_VPD,\r
                        MODEL_PCD_DYNAMIC_EX_DEFAULT,\r
                        MODEL_PCD_DYNAMIC_EX_HII,\r
                        MODEL_PCD_DYNAMIC_EX_VPD\r
                       ]\r
\r
MODEL_META_DATA_HEADER_COMMENT = 5000\r
MODEL_META_DATA_HEADER = 5001\r
MODEL_META_DATA_INCLUDE = 5002\r
MODEL_META_DATA_DEFINE = 5003\r
MODEL_META_DATA_CONDITIONAL_STATEMENT_IF = 5004\r
MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSE = 5005\r
MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF = 5006\r
MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF = 5007\r
MODEL_META_DATA_CONDITIONAL_STATEMENT_ERROR = 5400\r
MODEL_META_DATA_BUILD_OPTION = 5008\r
MODEL_META_DATA_COMPONENT = 5009\r
MODEL_META_DATA_USER_EXTENSION = 5010\r
MODEL_META_DATA_PACKAGE = 5011\r
MODEL_META_DATA_NMAKE = 5012\r
MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSEIF = 5013\r
MODEL_META_DATA_CONDITIONAL_STATEMENT_ENDIF = 5014\r
MODEL_META_DATA_COMMENT = 5016\r
MODEL_META_DATA_GLOBAL_DEFINE = 5017\r
MODEL_META_DATA_SECTION_HEADER = 5100\r
MODEL_META_DATA_SUBSECTION_HEADER = 5200\r
MODEL_META_DATA_TAIL_COMMENT = 5300\r
\r
MODEL_EXTERNAL_DEPENDENCY = 10000\r
\r
MODEL_LIST = [('MODEL_UNKNOWN', MODEL_UNKNOWN),\r
              ('MODEL_FILE_C', MODEL_FILE_C),\r
              ('MODEL_FILE_H', MODEL_FILE_H),\r
              ('MODEL_FILE_ASM', MODEL_FILE_ASM),\r
              ('MODEL_FILE_INF', MODEL_FILE_INF),\r
              ('MODEL_FILE_DEC', MODEL_FILE_DEC),\r
              ('MODEL_FILE_DSC', MODEL_FILE_DSC),\r
              ('MODEL_FILE_FDF', MODEL_FILE_FDF),\r
              ('MODEL_FILE_INC', MODEL_FILE_INC),\r
              ('MODEL_FILE_CIF', MODEL_FILE_CIF),\r
              ('MODEL_FILE_OTHERS', MODEL_FILE_OTHERS),\r
              ('MODEL_IDENTIFIER_FILE_HEADER', MODEL_IDENTIFIER_FILE_HEADER),\r
              ('MODEL_IDENTIFIER_FUNCTION_HEADER', MODEL_IDENTIFIER_FUNCTION_HEADER),\r
              ('MODEL_IDENTIFIER_COMMENT', MODEL_IDENTIFIER_COMMENT),\r
              ('MODEL_IDENTIFIER_PARAMETER', MODEL_IDENTIFIER_PARAMETER),\r
              ('MODEL_IDENTIFIER_STRUCTURE', MODEL_IDENTIFIER_STRUCTURE),\r
              ('MODEL_IDENTIFIER_VARIABLE', MODEL_IDENTIFIER_VARIABLE),\r
              ('MODEL_IDENTIFIER_INCLUDE', MODEL_IDENTIFIER_INCLUDE),\r
              ('MODEL_IDENTIFIER_PREDICATE_EXPRESSION', MODEL_IDENTIFIER_PREDICATE_EXPRESSION),\r
              ('MODEL_IDENTIFIER_ENUMERATE', MODEL_IDENTIFIER_ENUMERATE),\r
              ('MODEL_IDENTIFIER_PCD', MODEL_IDENTIFIER_PCD),\r
              ('MODEL_IDENTIFIER_UNION', MODEL_IDENTIFIER_UNION),\r
              ('MODEL_IDENTIFIER_MACRO_IFDEF', MODEL_IDENTIFIER_MACRO_IFDEF),\r
              ('MODEL_IDENTIFIER_MACRO_IFNDEF', MODEL_IDENTIFIER_MACRO_IFNDEF),\r
              ('MODEL_IDENTIFIER_MACRO_DEFINE', MODEL_IDENTIFIER_MACRO_DEFINE),\r
              ('MODEL_IDENTIFIER_MACRO_ENDIF', MODEL_IDENTIFIER_MACRO_ENDIF),\r
              ('MODEL_IDENTIFIER_MACRO_PROGMA', MODEL_IDENTIFIER_MACRO_PROGMA),\r
              ('MODEL_IDENTIFIER_FUNCTION_CALLING', MODEL_IDENTIFIER_FUNCTION_CALLING),\r
              ('MODEL_IDENTIFIER_TYPEDEF', MODEL_IDENTIFIER_TYPEDEF),\r
              ('MODEL_IDENTIFIER_FUNCTION_DECLARATION', MODEL_IDENTIFIER_FUNCTION_DECLARATION),\r
              ('MODEL_IDENTIFIER_ASSIGNMENT_EXPRESSION', MODEL_IDENTIFIER_ASSIGNMENT_EXPRESSION),\r
              ('MODEL_EFI_PROTOCOL', MODEL_EFI_PROTOCOL),\r
              ('MODEL_EFI_PPI', MODEL_EFI_PPI),\r
              ('MODEL_EFI_GUID', MODEL_EFI_GUID),\r
              ('MODEL_EFI_LIBRARY_CLASS', MODEL_EFI_LIBRARY_CLASS),\r
              ('MODEL_EFI_LIBRARY_INSTANCE', MODEL_EFI_LIBRARY_INSTANCE),\r
              ('MODEL_EFI_PCD', MODEL_EFI_PCD),\r
              ('MODEL_EFI_SKU_ID', MODEL_EFI_SKU_ID),\r
              ('MODEL_EFI_INCLUDE', MODEL_EFI_INCLUDE),\r
              ('MODEL_EFI_DEPEX', MODEL_EFI_DEPEX),\r
              ('MODEL_IDENTIFIER_UNION', MODEL_IDENTIFIER_UNION),\r
              ('MODEL_EFI_SOURCE_FILE', MODEL_EFI_SOURCE_FILE),\r
              ('MODEL_EFI_BINARY_FILE', MODEL_EFI_BINARY_FILE),\r
              ('MODEL_PCD', MODEL_PCD),\r
              ('MODEL_PCD_FIXED_AT_BUILD', MODEL_PCD_FIXED_AT_BUILD),\r
              ('MODEL_PCD_PATCHABLE_IN_MODULE', MODEL_PCD_PATCHABLE_IN_MODULE),\r
              ('MODEL_PCD_FEATURE_FLAG', MODEL_PCD_FEATURE_FLAG),\r
              ('MODEL_PCD_DYNAMIC_EX', MODEL_PCD_DYNAMIC_EX),\r
              ('MODEL_PCD_DYNAMIC_EX_DEFAULT', MODEL_PCD_DYNAMIC_EX_DEFAULT),\r
              ('MODEL_PCD_DYNAMIC_EX_VPD', MODEL_PCD_DYNAMIC_EX_VPD),\r
              ('MODEL_PCD_DYNAMIC_EX_HII', MODEL_PCD_DYNAMIC_EX_HII),\r
              ('MODEL_PCD_DYNAMIC', MODEL_PCD_DYNAMIC),\r
              ('MODEL_PCD_DYNAMIC_DEFAULT', MODEL_PCD_DYNAMIC_DEFAULT),\r
              ('MODEL_PCD_DYNAMIC_VPD', MODEL_PCD_DYNAMIC_VPD),\r
              ('MODEL_PCD_DYNAMIC_HII', MODEL_PCD_DYNAMIC_HII),\r
              ("MODEL_META_DATA_HEADER", MODEL_META_DATA_HEADER),\r
              ("MODEL_META_DATA_INCLUDE", MODEL_META_DATA_INCLUDE),\r
              ("MODEL_META_DATA_DEFINE", MODEL_META_DATA_DEFINE),\r
              ("MODEL_META_DATA_CONDITIONAL_STATEMENT_IF", MODEL_META_DATA_CONDITIONAL_STATEMENT_IF),\r
              ("MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSE", MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSE),\r
              ("MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF", MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF),\r
              ("MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF", MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF),\r
              ("MODEL_META_DATA_CONDITIONAL_STATEMENT_ERROR", MODEL_META_DATA_CONDITIONAL_STATEMENT_ERROR),\r
              ("MODEL_META_DATA_BUILD_OPTION", MODEL_META_DATA_BUILD_OPTION),\r
              ("MODEL_META_DATA_COMPONENT", MODEL_META_DATA_COMPONENT),\r
              ('MODEL_META_DATA_USER_EXTENSION', MODEL_META_DATA_USER_EXTENSION),\r
              ('MODEL_META_DATA_PACKAGE', MODEL_META_DATA_PACKAGE),\r
              ('MODEL_META_DATA_NMAKE', MODEL_META_DATA_NMAKE),\r
              ('MODEL_META_DATA_COMMENT', MODEL_META_DATA_COMMENT)\r
             ]\r
\r
## FunctionClass\r
#\r
# This class defines a structure of a function\r
#\r
# @param ID:               ID of a Function\r
# @param Header:           Header of a Function\r
# @param Modifier:         Modifier of a Function\r
# @param Name:             Name of a Function\r
# @param ReturnStatement:  ReturnStatement of a Function\r
# @param StartLine:        StartLine of a Function\r
# @param StartColumn:      StartColumn of a Function\r
# @param EndLine:          EndLine of a Function\r
# @param EndColumn:        EndColumn of a Function\r
# @param BodyStartLine:    BodyStartLine of a Function Body\r
# @param BodyStartColumn:  BodyStartColumn of a Function Body\r
# @param BelongsToFile:    The Function belongs to which file\r
# @param IdentifierList:   IdentifierList of a File\r
# @param PcdList:          PcdList of a File\r
#\r
# @var ID:                 ID of a Function\r
# @var Header:             Header of a Function\r
# @var Modifier:           Modifier of a Function\r
# @var Name:               Name of a Function\r
# @var ReturnStatement:    ReturnStatement of a Function\r
# @var StartLine:          StartLine of a Function\r
# @var StartColumn:        StartColumn of a Function\r
# @var EndLine:            EndLine of a Function\r
# @var EndColumn:          EndColumn of a Function\r
# @var BodyStartLine:      StartLine of a Function Body\r
# @var BodyStartColumn:    StartColumn of a Function Body\r
# @var BelongsToFile:      The Function belongs to which file\r
# @var IdentifierList:     IdentifierList of a File\r
# @var PcdList:            PcdList of a File\r
#\r
class FunctionClass(object):\r
    def __init__(self, ID = -1, Header = '', Modifier = '', Name = '', ReturnStatement = '', \\r
                 StartLine = -1, StartColumn = -1, EndLine = -1, EndColumn = -1, \\r
                 BodyStartLine = -1, BodyStartColumn = -1, BelongsToFile = -1, \\r
                 IdentifierList = [], PcdList = [], \\r
                 FunNameStartLine = -1, FunNameStartColumn = -1):\r
        self.ID = ID\r
        self.Header = Header\r
        self.Modifier = Modifier\r
        self.Name = Name\r
        self.ReturnStatement = ReturnStatement\r
        self.StartLine = StartLine\r
        self.StartColumn = StartColumn\r
        self.EndLine = EndLine\r
        self.EndColumn = EndColumn\r
        self.BodyStartLine = BodyStartLine\r
        self.BodyStartColumn = BodyStartColumn\r
        self.BelongsToFile = BelongsToFile\r
        self.FunNameStartLine = FunNameStartLine\r
        self.FunNameStartColumn = FunNameStartColumn\r
\r
        self.IdentifierList = IdentifierList\r
        self.PcdList = PcdList\r
\r
## IdentifierClass\r
#\r
# This class defines a structure of a variable\r
#\r
# @param ID:                 ID of a Identifier\r
# @param Modifier:           Modifier of a Identifier\r
# @param Type:               Type of a Identifier\r
# @param Name:               Name of a Identifier\r
# @param Value:              Value of a Identifier\r
# @param Model:              Model of a Identifier\r
# @param BelongsToFile:      The Identifier belongs to which file\r
# @param BelongsToFunction:  The Identifier belongs to which function\r
# @param StartLine:          StartLine of a Identifier\r
# @param StartColumn:        StartColumn of a Identifier\r
# @param EndLine:            EndLine of a Identifier\r
# @param EndColumn:          EndColumn of a Identifier\r
#\r
# @var ID:                   ID of a Identifier\r
# @var Modifier:             Modifier of a Identifier\r
# @var Type:                 Type of a Identifier\r
# @var Name:                 Name of a Identifier\r
# @var Value:                Value of a Identifier\r
# @var Model:                Model of a Identifier\r
# @var BelongsToFile:        The Identifier belongs to which file\r
# @var BelongsToFunction:    The Identifier belongs to which function\r
# @var StartLine:            StartLine of a Identifier\r
# @var StartColumn:          StartColumn of a Identifier\r
# @var EndLine:              EndLine of a Identifier\r
# @var EndColumn:            EndColumn of a Identifier\r
#\r
class IdentifierClass(object):\r
    def __init__(self, ID = -1, Modifier = '', Type = '', Name = '', Value = '', Model = MODEL_UNKNOWN, \\r
                 BelongsToFile = -1, BelongsToFunction = -1, StartLine = -1, StartColumn = -1, EndLine = -1, EndColumn = -1):\r
        self.ID = ID\r
        self.Modifier = Modifier\r
        self.Type = Type\r
        self.Name = Name\r
        self.Value = Value\r
        self.Model = Model\r
        self.BelongsToFile = BelongsToFile\r
        self.BelongsToFunction = BelongsToFunction\r
        self.StartLine = StartLine\r
        self.StartColumn = StartColumn\r
        self.EndLine = EndLine\r
        self.EndColumn = EndColumn\r
\r
## PcdClass\r
#\r
# This class defines a structure of a Pcd\r
#\r
# @param ID:                   ID of a Pcd\r
# @param CName:                CName of a Pcd\r
# @param TokenSpaceGuidCName:  TokenSpaceGuidCName of a Pcd\r
# @param Token:                Token of a Pcd\r
# @param DatumType:            DatumType of a Pcd\r
# @param Model:                Model of a Pcd\r
# @param BelongsToFile:        The Pcd belongs to which file\r
# @param BelongsToFunction:    The Pcd belongs to which function\r
# @param StartLine:            StartLine of a Pcd\r
# @param StartColumn:          StartColumn of a Pcd\r
# @param EndLine:              EndLine of a Pcd\r
# @param EndColumn:            EndColumn of a Pcd\r
#\r
# @var ID:                     ID of a Pcd\r
# @var CName:                  CName of a Pcd\r
# @var TokenSpaceGuidCName:    TokenSpaceGuidCName of a Pcd\r
# @var Token:                  Token of a Pcd\r
# @var DatumType:              DatumType of a Pcd\r
# @var Model:                  Model of a Pcd\r
# @var BelongsToFile:          The Pcd belongs to which file\r
# @var BelongsToFunction:      The Pcd belongs to which function\r
# @var StartLine:              StartLine of a Pcd\r
# @var StartColumn:            StartColumn of a Pcd\r
# @var EndLine:                EndLine of a Pcd\r
# @var EndColumn:              EndColumn of a Pcd\r
#\r
class PcdDataClass(object):\r
    def __init__(self, ID = -1, CName = '', TokenSpaceGuidCName = '', Token = '', DatumType = '', Model = MODEL_UNKNOWN, \\r
                 BelongsToFile = -1, BelongsToFunction = -1, StartLine = -1, StartColumn = -1, EndLine = -1, EndColumn = -1):\r
        self.ID = ID\r
        self.CName = CName\r
        self.TokenSpaceGuidCName = TokenSpaceGuidCName\r
        self.Token = Token\r
        self.DatumType = DatumType\r
        self.BelongsToFile = BelongsToFile\r
        self.BelongsToFunction = BelongsToFunction\r
        self.StartLine = StartLine\r
        self.StartColumn = StartColumn\r
        self.EndLine = EndLine\r
        self.EndColumn = EndColumn\r
\r
## FileClass\r
#\r
# This class defines a structure of a file\r
#\r
# @param ID:              ID of a File\r
# @param Name:            Name of a File\r
# @param ExtName:         ExtName of a File\r
# @param Path:            Path of a File\r
# @param FullPath:        FullPath of a File\r
# @param Model:           Model of a File\r
# @param TimeStamp:       TimeStamp of a File\r
# @param FunctionList:    FunctionList of a File\r
# @param IdentifierList:  IdentifierList of a File\r
# @param PcdList:         PcdList of a File\r
#\r
# @var ID:                ID of a File\r
# @var Name:              Name of a File\r
# @var ExtName:           ExtName of a File\r
# @var Path:              Path of a File\r
# @var FullPath:          FullPath of a File\r
# @var Model:             Model of a File\r
# @var TimeStamp:         TimeStamp of a File\r
# @var FunctionList:      FunctionList of a File\r
# @var IdentifierList:    IdentifierList of a File\r
# @var PcdList:           PcdList of a File\r
#\r
class FileClass(object):\r
    def __init__(self, ID = -1, Name = '', ExtName = '', Path = '', FullPath = '', Model = MODEL_UNKNOWN, TimeStamp = '', \\r
                 FunctionList = [], IdentifierList = [], PcdList = []):\r
        self.ID = ID\r
        self.Name = Name\r
        self.ExtName = ExtName\r
        self.Path = Path\r
        self.FullPath = FullPath\r
        self.Model = Model\r
        self.TimeStamp = TimeStamp\r
\r
        self.FunctionList = FunctionList\r
        self.IdentifierList = IdentifierList\r
        self.PcdList = PcdList\r
Commit	Line	Data
30fdf114	1	## @file\r
9053bc51	2	# This file is used to define class for data structure used in ECC\r
30fdf114	3	#\r
97fa0ee9	4	# Copyright (c) 2008 - 2014, Intel Corporation. All rights reserved.<BR>\r
2e351cbe	5	# SPDX-License-Identifier: BSD-2-Clause-Patent\r
30fdf114 LG	6	\r
	7	##\r
	8	# Import Modules\r
	9	#\r
	10	import Common.EdkLogger as EdkLogger\r
	11	\r
	12	##\r
	13	# Static values for data models\r
	14	#\r
	15	MODEL_UNKNOWN = 0\r
	16	\r
	17	MODEL_FILE_C = 1001\r
	18	MODEL_FILE_H = 1002\r
	19	MODEL_FILE_ASM = 1003\r
	20	MODEL_FILE_INF = 1011\r
	21	MODEL_FILE_DEC = 1012\r
	22	MODEL_FILE_DSC = 1013\r
	23	MODEL_FILE_FDF = 1014\r
	24	MODEL_FILE_INC = 1015\r
	25	MODEL_FILE_CIF = 1016\r
97fa0ee9	26	MODEL_FILE_UNI = 1017\r
e56468c0	27	MODEL_FILE_OTHERS = 1099\r
30fdf114 LG	28	\r
	29	MODEL_IDENTIFIER_FILE_HEADER = 2001\r
	30	MODEL_IDENTIFIER_FUNCTION_HEADER = 2002\r
	31	MODEL_IDENTIFIER_COMMENT = 2003\r
	32	MODEL_IDENTIFIER_PARAMETER = 2004\r
	33	MODEL_IDENTIFIER_STRUCTURE = 2005\r
	34	MODEL_IDENTIFIER_VARIABLE = 2006\r
	35	MODEL_IDENTIFIER_INCLUDE = 2007\r
	36	MODEL_IDENTIFIER_PREDICATE_EXPRESSION = 2008\r
	37	MODEL_IDENTIFIER_ENUMERATE = 2009\r
	38	MODEL_IDENTIFIER_PCD = 2010\r
	39	MODEL_IDENTIFIER_UNION = 2011\r
	40	MODEL_IDENTIFIER_MACRO_IFDEF = 2012\r
	41	MODEL_IDENTIFIER_MACRO_IFNDEF = 2013\r
	42	MODEL_IDENTIFIER_MACRO_DEFINE = 2014\r
	43	MODEL_IDENTIFIER_MACRO_ENDIF = 2015\r
	44	MODEL_IDENTIFIER_MACRO_PROGMA = 2016\r
	45	MODEL_IDENTIFIER_FUNCTION_CALLING = 2018\r
	46	MODEL_IDENTIFIER_TYPEDEF = 2017\r
	47	MODEL_IDENTIFIER_FUNCTION_DECLARATION = 2019\r
	48	MODEL_IDENTIFIER_ASSIGNMENT_EXPRESSION = 2020\r
	49	\r
	50	MODEL_EFI_PROTOCOL = 3001\r
	51	MODEL_EFI_PPI = 3002\r
	52	MODEL_EFI_GUID = 3003\r
	53	MODEL_EFI_LIBRARY_CLASS = 3004\r
	54	MODEL_EFI_LIBRARY_INSTANCE = 3005\r
	55	MODEL_EFI_PCD = 3006\r
	56	MODEL_EFI_SOURCE_FILE = 3007\r
	57	MODEL_EFI_BINARY_FILE = 3008\r
	58	MODEL_EFI_SKU_ID = 3009\r
	59	MODEL_EFI_INCLUDE = 3010\r
	60	MODEL_EFI_DEPEX = 3011\r
8518bf0b	61	MODEL_EFI_DEFAULT_STORES = 3012\r
30fdf114 LG	62	\r
	63	MODEL_PCD = 4000\r
	64	MODEL_PCD_FIXED_AT_BUILD = 4001\r
	65	MODEL_PCD_PATCHABLE_IN_MODULE = 4002\r
	66	MODEL_PCD_FEATURE_FLAG = 4003\r
	67	MODEL_PCD_DYNAMIC_EX = 4004\r
	68	MODEL_PCD_DYNAMIC_EX_DEFAULT = 4005\r
	69	MODEL_PCD_DYNAMIC_EX_VPD = 4006\r
	70	MODEL_PCD_DYNAMIC_EX_HII = 4007\r
	71	MODEL_PCD_DYNAMIC = 4008\r
	72	MODEL_PCD_DYNAMIC_DEFAULT = 4009\r
	73	MODEL_PCD_DYNAMIC_VPD = 4010\r
	74	MODEL_PCD_DYNAMIC_HII = 4011\r
ae7b6df8 LG	75	MODEL_PCD_TYPE_LIST = [MODEL_PCD_FIXED_AT_BUILD,\r
	76	MODEL_PCD_PATCHABLE_IN_MODULE,\r
	77	MODEL_PCD_FEATURE_FLAG,\r
	78	MODEL_PCD_DYNAMIC_DEFAULT,\r
	79	MODEL_PCD_DYNAMIC_HII,\r
	80	MODEL_PCD_DYNAMIC_VPD,\r
	81	MODEL_PCD_DYNAMIC_EX_DEFAULT,\r
	82	MODEL_PCD_DYNAMIC_EX_HII,\r
	83	MODEL_PCD_DYNAMIC_EX_VPD\r
	84	]\r
30fdf114	85	\r
e8a47801	86	MODEL_META_DATA_HEADER_COMMENT = 5000\r
30fdf114 LG	87	MODEL_META_DATA_HEADER = 5001\r
	88	MODEL_META_DATA_INCLUDE = 5002\r
	89	MODEL_META_DATA_DEFINE = 5003\r
	90	MODEL_META_DATA_CONDITIONAL_STATEMENT_IF = 5004\r
	91	MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSE = 5005\r
	92	MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF = 5006\r
	93	MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF = 5007\r
8d62ae35	94	MODEL_META_DATA_CONDITIONAL_STATEMENT_ERROR = 5400\r
30fdf114 LG	95	MODEL_META_DATA_BUILD_OPTION = 5008\r
	96	MODEL_META_DATA_COMPONENT = 5009\r
	97	MODEL_META_DATA_USER_EXTENSION = 5010\r
	98	MODEL_META_DATA_PACKAGE = 5011\r
	99	MODEL_META_DATA_NMAKE = 5012\r
0d2711a6	100	MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSEIF = 5013\r
30fdf114	101	MODEL_META_DATA_CONDITIONAL_STATEMENT_ENDIF = 5014\r
e56468c0	102	MODEL_META_DATA_COMMENT = 5016\r
e56468c0	103	MODEL_META_DATA_GLOBAL_DEFINE = 5017\r
0d2711a6 LG	104	MODEL_META_DATA_SECTION_HEADER = 5100\r
0d2711a6 LG	105	MODEL_META_DATA_SUBSECTION_HEADER = 5200\r
2bc3256c	106	MODEL_META_DATA_TAIL_COMMENT = 5300\r
30fdf114	107	\r
9053bc51	108	MODEL_EXTERNAL_DEPENDENCY = 10000\r
9053bc51	109	\r
30fdf114 LG	110	MODEL_LIST = [('MODEL_UNKNOWN', MODEL_UNKNOWN),\r
	111	('MODEL_FILE_C', MODEL_FILE_C),\r
	112	('MODEL_FILE_H', MODEL_FILE_H),\r
	113	('MODEL_FILE_ASM', MODEL_FILE_ASM),\r
	114	('MODEL_FILE_INF', MODEL_FILE_INF),\r
	115	('MODEL_FILE_DEC', MODEL_FILE_DEC),\r
	116	('MODEL_FILE_DSC', MODEL_FILE_DSC),\r
	117	('MODEL_FILE_FDF', MODEL_FILE_FDF),\r
	118	('MODEL_FILE_INC', MODEL_FILE_INC),\r
e56468c0	119	('MODEL_FILE_CIF', MODEL_FILE_CIF),\r
e56468c0	120	('MODEL_FILE_OTHERS', MODEL_FILE_OTHERS),\r
30fdf114 LG	121	('MODEL_IDENTIFIER_FILE_HEADER', MODEL_IDENTIFIER_FILE_HEADER),\r
	122	('MODEL_IDENTIFIER_FUNCTION_HEADER', MODEL_IDENTIFIER_FUNCTION_HEADER),\r
	123	('MODEL_IDENTIFIER_COMMENT', MODEL_IDENTIFIER_COMMENT),\r
	124	('MODEL_IDENTIFIER_PARAMETER', MODEL_IDENTIFIER_PARAMETER),\r
	125	('MODEL_IDENTIFIER_STRUCTURE', MODEL_IDENTIFIER_STRUCTURE),\r
	126	('MODEL_IDENTIFIER_VARIABLE', MODEL_IDENTIFIER_VARIABLE),\r
	127	('MODEL_IDENTIFIER_INCLUDE', MODEL_IDENTIFIER_INCLUDE),\r
	128	('MODEL_IDENTIFIER_PREDICATE_EXPRESSION', MODEL_IDENTIFIER_PREDICATE_EXPRESSION),\r
	129	('MODEL_IDENTIFIER_ENUMERATE', MODEL_IDENTIFIER_ENUMERATE),\r
	130	('MODEL_IDENTIFIER_PCD', MODEL_IDENTIFIER_PCD),\r
	131	('MODEL_IDENTIFIER_UNION', MODEL_IDENTIFIER_UNION),\r
	132	('MODEL_IDENTIFIER_MACRO_IFDEF', MODEL_IDENTIFIER_MACRO_IFDEF),\r
	133	('MODEL_IDENTIFIER_MACRO_IFNDEF', MODEL_IDENTIFIER_MACRO_IFNDEF),\r
	134	('MODEL_IDENTIFIER_MACRO_DEFINE', MODEL_IDENTIFIER_MACRO_DEFINE),\r
	135	('MODEL_IDENTIFIER_MACRO_ENDIF', MODEL_IDENTIFIER_MACRO_ENDIF),\r
	136	('MODEL_IDENTIFIER_MACRO_PROGMA', MODEL_IDENTIFIER_MACRO_PROGMA),\r
	137	('MODEL_IDENTIFIER_FUNCTION_CALLING', MODEL_IDENTIFIER_FUNCTION_CALLING),\r
	138	('MODEL_IDENTIFIER_TYPEDEF', MODEL_IDENTIFIER_TYPEDEF),\r
	139	('MODEL_IDENTIFIER_FUNCTION_DECLARATION', MODEL_IDENTIFIER_FUNCTION_DECLARATION),\r
	140	('MODEL_IDENTIFIER_ASSIGNMENT_EXPRESSION', MODEL_IDENTIFIER_ASSIGNMENT_EXPRESSION),\r
	141	('MODEL_EFI_PROTOCOL', MODEL_EFI_PROTOCOL),\r
	142	('MODEL_EFI_PPI', MODEL_EFI_PPI),\r
	143	('MODEL_EFI_GUID', MODEL_EFI_GUID),\r
	144	('MODEL_EFI_LIBRARY_CLASS', MODEL_EFI_LIBRARY_CLASS),\r
	145	('MODEL_EFI_LIBRARY_INSTANCE', MODEL_EFI_LIBRARY_INSTANCE),\r
	146	('MODEL_EFI_PCD', MODEL_EFI_PCD),\r
	147	('MODEL_EFI_SKU_ID', MODEL_EFI_SKU_ID),\r
	148	('MODEL_EFI_INCLUDE', MODEL_EFI_INCLUDE),\r
	149	('MODEL_EFI_DEPEX', MODEL_EFI_DEPEX),\r
	150	('MODEL_IDENTIFIER_UNION', MODEL_IDENTIFIER_UNION),\r
	151	('MODEL_EFI_SOURCE_FILE', MODEL_EFI_SOURCE_FILE),\r
	152	('MODEL_EFI_BINARY_FILE', MODEL_EFI_BINARY_FILE),\r
	153	('MODEL_PCD', MODEL_PCD),\r
	154	('MODEL_PCD_FIXED_AT_BUILD', MODEL_PCD_FIXED_AT_BUILD),\r
	155	('MODEL_PCD_PATCHABLE_IN_MODULE', MODEL_PCD_PATCHABLE_IN_MODULE),\r
	156	('MODEL_PCD_FEATURE_FLAG', MODEL_PCD_FEATURE_FLAG),\r
	157	('MODEL_PCD_DYNAMIC_EX', MODEL_PCD_DYNAMIC_EX),\r
	158	('MODEL_PCD_DYNAMIC_EX_DEFAULT', MODEL_PCD_DYNAMIC_EX_DEFAULT),\r
	159	('MODEL_PCD_DYNAMIC_EX_VPD', MODEL_PCD_DYNAMIC_EX_VPD),\r
	160	('MODEL_PCD_DYNAMIC_EX_HII', MODEL_PCD_DYNAMIC_EX_HII),\r
	161	('MODEL_PCD_DYNAMIC', MODEL_PCD_DYNAMIC),\r
	162	('MODEL_PCD_DYNAMIC_DEFAULT', MODEL_PCD_DYNAMIC_DEFAULT),\r
	163	('MODEL_PCD_DYNAMIC_VPD', MODEL_PCD_DYNAMIC_VPD),\r
	164	('MODEL_PCD_DYNAMIC_HII', MODEL_PCD_DYNAMIC_HII),\r
	165	("MODEL_META_DATA_HEADER", MODEL_META_DATA_HEADER),\r
	166	("MODEL_META_DATA_INCLUDE", MODEL_META_DATA_INCLUDE),\r
	167	("MODEL_META_DATA_DEFINE", MODEL_META_DATA_DEFINE),\r
	168	("MODEL_META_DATA_CONDITIONAL_STATEMENT_IF", MODEL_META_DATA_CONDITIONAL_STATEMENT_IF),\r
	169	("MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSE", MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSE),\r
	170	("MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF", MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF),\r
	171	("MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF", MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF),\r
8d62ae35	172	("MODEL_META_DATA_CONDITIONAL_STATEMENT_ERROR", MODEL_META_DATA_CONDITIONAL_STATEMENT_ERROR),\r
30fdf114 LG	173	("MODEL_META_DATA_BUILD_OPTION", MODEL_META_DATA_BUILD_OPTION),\r
	174	("MODEL_META_DATA_COMPONENT", MODEL_META_DATA_COMPONENT),\r
	175	('MODEL_META_DATA_USER_EXTENSION', MODEL_META_DATA_USER_EXTENSION),\r
	176	('MODEL_META_DATA_PACKAGE', MODEL_META_DATA_PACKAGE),\r
e56468c0	177	('MODEL_META_DATA_NMAKE', MODEL_META_DATA_NMAKE),\r
e56468c0	178	('MODEL_META_DATA_COMMENT', MODEL_META_DATA_COMMENT)\r
30fdf114 LG	179	]\r
	180	\r
	181	## FunctionClass\r
	182	#\r
	183	# This class defines a structure of a function\r
e56468c0	184	#\r
30fdf114 LG	185	# @param ID: ID of a Function\r
30fdf114 LG	186	# @param Header: Header of a Function\r
e56468c0	187	# @param Modifier: Modifier of a Function\r
30fdf114	188	# @param Name: Name of a Function\r
fb0b35e0	189	# @param ReturnStatement: ReturnStatement of a Function\r
30fdf114 LG	190	# @param StartLine: StartLine of a Function\r
	191	# @param StartColumn: StartColumn of a Function\r
	192	# @param EndLine: EndLine of a Function\r
	193	# @param EndColumn: EndColumn of a Function\r
	194	# @param BodyStartLine: BodyStartLine of a Function Body\r
	195	# @param BodyStartColumn: BodyStartColumn of a Function Body\r
	196	# @param BelongsToFile: The Function belongs to which file\r
	197	# @param IdentifierList: IdentifierList of a File\r
	198	# @param PcdList: PcdList of a File\r
	199	#\r
	200	# @var ID: ID of a Function\r
	201	# @var Header: Header of a Function\r
e56468c0	202	# @var Modifier: Modifier of a Function\r
30fdf114	203	# @var Name: Name of a Function\r
fb0b35e0	204	# @var ReturnStatement: ReturnStatement of a Function\r
30fdf114 LG	205	# @var StartLine: StartLine of a Function\r
	206	# @var StartColumn: StartColumn of a Function\r
	207	# @var EndLine: EndLine of a Function\r
	208	# @var EndColumn: EndColumn of a Function\r
	209	# @var BodyStartLine: StartLine of a Function Body\r
	210	# @var BodyStartColumn: StartColumn of a Function Body\r
	211	# @var BelongsToFile: The Function belongs to which file\r
	212	# @var IdentifierList: IdentifierList of a File\r
	213	# @var PcdList: PcdList of a File\r
	214	#\r
	215	class FunctionClass(object):\r
	216	def __init__(self, ID = -1, Header = '', Modifier = '', Name = '', ReturnStatement = '', \\r
	217	StartLine = -1, StartColumn = -1, EndLine = -1, EndColumn = -1, \\r
	218	BodyStartLine = -1, BodyStartColumn = -1, BelongsToFile = -1, \\r
	219	IdentifierList = [], PcdList = [], \\r
	220	FunNameStartLine = -1, FunNameStartColumn = -1):\r
	221	self.ID = ID\r
	222	self.Header = Header\r
e56468c0	223	self.Modifier = Modifier\r
30fdf114 LG	224	self.Name = Name\r
	225	self.ReturnStatement = ReturnStatement\r
	226	self.StartLine = StartLine\r
	227	self.StartColumn = StartColumn\r
	228	self.EndLine = EndLine\r
	229	self.EndColumn = EndColumn\r
	230	self.BodyStartLine = BodyStartLine\r
	231	self.BodyStartColumn = BodyStartColumn\r
	232	self.BelongsToFile = BelongsToFile\r
	233	self.FunNameStartLine = FunNameStartLine\r
	234	self.FunNameStartColumn = FunNameStartColumn\r
e56468c0	235	\r
30fdf114 LG	236	self.IdentifierList = IdentifierList\r
	237	self.PcdList = PcdList\r
	238	\r
	239	## IdentifierClass\r
	240	#\r
	241	# This class defines a structure of a variable\r
e56468c0	242	#\r
30fdf114 LG	243	# @param ID: ID of a Identifier\r
	244	# @param Modifier: Modifier of a Identifier\r
	245	# @param Type: Type of a Identifier\r
	246	# @param Name: Name of a Identifier\r
	247	# @param Value: Value of a Identifier\r
	248	# @param Model: Model of a Identifier\r
	249	# @param BelongsToFile: The Identifier belongs to which file\r
	250	# @param BelongsToFunction: The Identifier belongs to which function\r
	251	# @param StartLine: StartLine of a Identifier\r
	252	# @param StartColumn: StartColumn of a Identifier\r
	253	# @param EndLine: EndLine of a Identifier\r
	254	# @param EndColumn: EndColumn of a Identifier\r
	255	#\r
	256	# @var ID: ID of a Identifier\r
	257	# @var Modifier: Modifier of a Identifier\r
	258	# @var Type: Type of a Identifier\r
	259	# @var Name: Name of a Identifier\r
	260	# @var Value: Value of a Identifier\r
	261	# @var Model: Model of a Identifier\r
	262	# @var BelongsToFile: The Identifier belongs to which file\r
	263	# @var BelongsToFunction: The Identifier belongs to which function\r
	264	# @var StartLine: StartLine of a Identifier\r
	265	# @var StartColumn: StartColumn of a Identifier\r
	266	# @var EndLine: EndLine of a Identifier\r
	267	# @var EndColumn: EndColumn of a Identifier\r
	268	#\r
	269	class IdentifierClass(object):\r
	270	def __init__(self, ID = -1, Modifier = '', Type = '', Name = '', Value = '', Model = MODEL_UNKNOWN, \\r
	271	BelongsToFile = -1, BelongsToFunction = -1, StartLine = -1, StartColumn = -1, EndLine = -1, EndColumn = -1):\r
	272	self.ID = ID\r
	273	self.Modifier = Modifier\r
	274	self.Type = Type\r
	275	self.Name = Name\r
	276	self.Value = Value\r
	277	self.Model = Model\r
	278	self.BelongsToFile = BelongsToFile\r
	279	self.BelongsToFunction = BelongsToFunction\r
	280	self.StartLine = StartLine\r
	281	self.StartColumn = StartColumn\r
	282	self.EndLine = EndLine\r
	283	self.EndColumn = EndColumn\r
	284	\r
	285	## PcdClass\r
	286	#\r
	287	# This class defines a structure of a Pcd\r
e56468c0	288	#\r
30fdf114 LG	289	# @param ID: ID of a Pcd\r
	290	# @param CName: CName of a Pcd\r
	291	# @param TokenSpaceGuidCName: TokenSpaceGuidCName of a Pcd\r
	292	# @param Token: Token of a Pcd\r
	293	# @param DatumType: DatumType of a Pcd\r
	294	# @param Model: Model of a Pcd\r
	295	# @param BelongsToFile: The Pcd belongs to which file\r
	296	# @param BelongsToFunction: The Pcd belongs to which function\r
	297	# @param StartLine: StartLine of a Pcd\r
	298	# @param StartColumn: StartColumn of a Pcd\r
	299	# @param EndLine: EndLine of a Pcd\r
	300	# @param EndColumn: EndColumn of a Pcd\r
	301	#\r
	302	# @var ID: ID of a Pcd\r
	303	# @var CName: CName of a Pcd\r
	304	# @var TokenSpaceGuidCName: TokenSpaceGuidCName of a Pcd\r
	305	# @var Token: Token of a Pcd\r
	306	# @var DatumType: DatumType of a Pcd\r
	307	# @var Model: Model of a Pcd\r
	308	# @var BelongsToFile: The Pcd belongs to which file\r
	309	# @var BelongsToFunction: The Pcd belongs to which function\r
	310	# @var StartLine: StartLine of a Pcd\r
	311	# @var StartColumn: StartColumn of a Pcd\r
	312	# @var EndLine: EndLine of a Pcd\r
	313	# @var EndColumn: EndColumn of a Pcd\r
	314	#\r
	315	class PcdDataClass(object):\r
	316	def __init__(self, ID = -1, CName = '', TokenSpaceGuidCName = '', Token = '', DatumType = '', Model = MODEL_UNKNOWN, \\r
	317	BelongsToFile = -1, BelongsToFunction = -1, StartLine = -1, StartColumn = -1, EndLine = -1, EndColumn = -1):\r
	318	self.ID = ID\r
	319	self.CName = CName\r
	320	self.TokenSpaceGuidCName = TokenSpaceGuidCName\r
	321	self.Token = Token\r
	322	self.DatumType = DatumType\r
	323	self.BelongsToFile = BelongsToFile\r
	324	self.BelongsToFunction = BelongsToFunction\r
	325	self.StartLine = StartLine\r
	326	self.StartColumn = StartColumn\r
	327	self.EndLine = EndLine\r
	328	self.EndColumn = EndColumn\r
	329	\r
	330	## FileClass\r
	331	#\r
	332	# This class defines a structure of a file\r
e56468c0	333	#\r
30fdf114 LG	334	# @param ID: ID of a File\r
	335	# @param Name: Name of a File\r
	336	# @param ExtName: ExtName of a File\r
	337	# @param Path: Path of a File\r
	338	# @param FullPath: FullPath of a File\r
	339	# @param Model: Model of a File\r
	340	# @param TimeStamp: TimeStamp of a File\r
	341	# @param FunctionList: FunctionList of a File\r
	342	# @param IdentifierList: IdentifierList of a File\r
	343	# @param PcdList: PcdList of a File\r
	344	#\r
	345	# @var ID: ID of a File\r
	346	# @var Name: Name of a File\r
	347	# @var ExtName: ExtName of a File\r
	348	# @var Path: Path of a File\r
	349	# @var FullPath: FullPath of a File\r
	350	# @var Model: Model of a File\r
	351	# @var TimeStamp: TimeStamp of a File\r
	352	# @var FunctionList: FunctionList of a File\r
	353	# @var IdentifierList: IdentifierList of a File\r
	354	# @var PcdList: PcdList of a File\r
	355	#\r
	356	class FileClass(object):\r
	357	def __init__(self, ID = -1, Name = '', ExtName = '', Path = '', FullPath = '', Model = MODEL_UNKNOWN, TimeStamp = '', \\r
	358	FunctionList = [], IdentifierList = [], PcdList = []):\r
e56468c0	359	self.ID = ID\r
30fdf114	360	self.Name = Name\r
e56468c0	361	self.ExtName = ExtName\r
30fdf114 LG	362	self.Path = Path\r
	363	self.FullPath = FullPath\r
	364	self.Model = Model\r
	365	self.TimeStamp = TimeStamp\r
e56468c0	366	\r
30fdf114 LG	367	self.FunctionList = FunctionList\r
	368	self.IdentifierList = IdentifierList\r
	369	self.PcdList = PcdList\r