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