7d0dda1d6c1eae5066b24c2efcea18757affd6cf
[people/mcb30/basetools.git] / Source / Python / CommonDataClass / DataClass.py
1 ## @file\r
2 # This file is used to define class for data sturcture used in ECC\r
3 #\r
4 # Copyright (c) 2008, Intel Corporation\r
5 # All rights reserved. This program and the accompanying materials\r
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 \r
53 MODEL_EFI_PROTOCOL = 3001\r
54 MODEL_EFI_PPI = 3002\r
55 MODEL_EFI_GUID = 3003\r
56 MODEL_EFI_LIBRARY_CLASS = 3004\r
57 MODEL_EFI_LIBRARY_INSTANCE = 3005\r
58 MODEL_EFI_PCD = 3006\r
59 MODEL_EFI_SOURCE_FILE = 3007\r
60 MODEL_EFI_BINARY_FILE = 3008\r
61 MODEL_EFI_SKU_ID = 3009\r
62 MODEL_EFI_INCLUDE = 3010\r
63 MODEL_EFI_DEPEX = 3011\r
64 \r
65 MODEL_PCD = 4000\r
66 MODEL_PCD_FIXED_AT_BUILD = 4001\r
67 MODEL_PCD_PATCHABLE_IN_MODULE = 4002\r
68 MODEL_PCD_FEATURE_FLAG = 4003\r
69 MODEL_PCD_DYNAMIC_EX = 4004\r
70 MODEL_PCD_DYNAMIC_EX_DEFAULT = 4005\r
71 MODEL_PCD_DYNAMIC_EX_VPD = 4006\r
72 MODEL_PCD_DYNAMIC_EX_HII = 4007\r
73 MODEL_PCD_DYNAMIC = 4008\r
74 MODEL_PCD_DYNAMIC_DEFAULT = 4009\r
75 MODEL_PCD_DYNAMIC_VPD = 4010\r
76 MODEL_PCD_DYNAMIC_HII = 4011\r
77 \r
78 MODEL_META_DATA_HEADER = 5001\r
79 MODEL_META_DATA_INCLUDE = 5002\r
80 MODEL_META_DATA_DEFINE = 5003\r
81 MODEL_META_DATA_CONDITIONAL_STATEMENT_IF = 5004\r
82 MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSE = 5005\r
83 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF = 5006\r
84 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF = 5007\r
85 MODEL_META_DATA_BUILD_OPTION = 5008\r
86 MODEL_META_DATA_COMPONENT = 5009\r
87 MODEL_META_DATA_USER_EXTENSION = 5010\r
88 MODEL_META_DATA_PACKAGE = 5011\r
89 MODEL_META_DATA_NMAKE = 5012\r
90 MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSEIF = 50013\r
91 MODEL_META_DATA_CONDITIONAL_STATEMENT_ENDIF = 5014\r
92 \r
93 MODEL_LIST = [('MODEL_UNKNOWN', MODEL_UNKNOWN),\r
94               ('MODEL_FILE_C', MODEL_FILE_C),\r
95               ('MODEL_FILE_H', MODEL_FILE_H),\r
96               ('MODEL_FILE_ASM', MODEL_FILE_ASM),\r
97               ('MODEL_FILE_INF', MODEL_FILE_INF),\r
98               ('MODEL_FILE_DEC', MODEL_FILE_DEC),\r
99               ('MODEL_FILE_DSC', MODEL_FILE_DSC),\r
100               ('MODEL_FILE_FDF', MODEL_FILE_FDF),\r
101               ('MODEL_FILE_INC', MODEL_FILE_INC),\r
102               ('MODEL_IDENTIFIER_FILE_HEADER', MODEL_IDENTIFIER_FILE_HEADER),\r
103               ('MODEL_IDENTIFIER_FUNCTION_HEADER', MODEL_IDENTIFIER_FUNCTION_HEADER),\r
104               ('MODEL_IDENTIFIER_COMMENT', MODEL_IDENTIFIER_COMMENT),\r
105               ('MODEL_IDENTIFIER_PARAMETER', MODEL_IDENTIFIER_PARAMETER),\r
106               ('MODEL_IDENTIFIER_STRUCTURE', MODEL_IDENTIFIER_STRUCTURE),\r
107               ('MODEL_IDENTIFIER_VARIABLE', MODEL_IDENTIFIER_VARIABLE),\r
108               ('MODEL_IDENTIFIER_INCLUDE', MODEL_IDENTIFIER_INCLUDE),\r
109               ('MODEL_IDENTIFIER_PREDICATE_EXPRESSION', MODEL_IDENTIFIER_PREDICATE_EXPRESSION),\r
110               ('MODEL_IDENTIFIER_ENUMERATE', MODEL_IDENTIFIER_ENUMERATE),\r
111               ('MODEL_IDENTIFIER_PCD', MODEL_IDENTIFIER_PCD),\r
112               ('MODEL_IDENTIFIER_UNION', MODEL_IDENTIFIER_UNION),\r
113               ('MODEL_IDENTIFIER_MACRO_IFDEF', MODEL_IDENTIFIER_MACRO_IFDEF),\r
114               ('MODEL_IDENTIFIER_MACRO_IFNDEF', MODEL_IDENTIFIER_MACRO_IFNDEF),\r
115               ('MODEL_IDENTIFIER_MACRO_DEFINE', MODEL_IDENTIFIER_MACRO_DEFINE),\r
116               ('MODEL_IDENTIFIER_MACRO_ENDIF', MODEL_IDENTIFIER_MACRO_ENDIF),\r
117               ('MODEL_IDENTIFIER_MACRO_PROGMA', MODEL_IDENTIFIER_MACRO_PROGMA),\r
118               ('MODEL_IDENTIFIER_FUNCTION_CALLING', MODEL_IDENTIFIER_FUNCTION_CALLING),\r
119               ('MODEL_IDENTIFIER_TYPEDEF', MODEL_IDENTIFIER_TYPEDEF),\r
120               ('MODEL_IDENTIFIER_FUNCTION_DECLARATION', MODEL_IDENTIFIER_FUNCTION_DECLARATION),\r
121               ('MODEL_EFI_PROTOCOL', MODEL_EFI_PROTOCOL),\r
122               ('MODEL_EFI_PPI', MODEL_EFI_PPI),\r
123               ('MODEL_EFI_GUID', MODEL_EFI_GUID),\r
124               ('MODEL_EFI_LIBRARY_CLASS', MODEL_EFI_LIBRARY_CLASS),\r
125               ('MODEL_EFI_LIBRARY_INSTANCE', MODEL_EFI_LIBRARY_INSTANCE),\r
126               ('MODEL_EFI_PCD', MODEL_EFI_PCD),\r
127               ('MODEL_EFI_SKU_ID', MODEL_EFI_SKU_ID),\r
128               ('MODEL_EFI_INCLUDE', MODEL_EFI_INCLUDE),\r
129               ('MODEL_EFI_DEPEX', MODEL_EFI_DEPEX),\r
130               ('MODEL_IDENTIFIER_UNION', MODEL_IDENTIFIER_UNION),\r
131               ('MODEL_EFI_SOURCE_FILE', MODEL_EFI_SOURCE_FILE),\r
132               ('MODEL_EFI_BINARY_FILE', MODEL_EFI_BINARY_FILE),\r
133               ('MODEL_PCD', MODEL_PCD),\r
134               ('MODEL_PCD_FIXED_AT_BUILD', MODEL_PCD_FIXED_AT_BUILD),\r
135               ('MODEL_PCD_PATCHABLE_IN_MODULE', MODEL_PCD_PATCHABLE_IN_MODULE),\r
136               ('MODEL_PCD_FEATURE_FLAG', MODEL_PCD_FEATURE_FLAG),\r
137               ('MODEL_PCD_DYNAMIC_EX', MODEL_PCD_DYNAMIC_EX),\r
138               ('MODEL_PCD_DYNAMIC_EX_DEFAULT', MODEL_PCD_DYNAMIC_EX_DEFAULT),\r
139               ('MODEL_PCD_DYNAMIC_EX_VPD', MODEL_PCD_DYNAMIC_EX_VPD),\r
140               ('MODEL_PCD_DYNAMIC_EX_HII', MODEL_PCD_DYNAMIC_EX_HII),\r
141               ('MODEL_PCD_DYNAMIC', MODEL_PCD_DYNAMIC),\r
142               ('MODEL_PCD_DYNAMIC_DEFAULT', MODEL_PCD_DYNAMIC_DEFAULT),\r
143               ('MODEL_PCD_DYNAMIC_VPD', MODEL_PCD_DYNAMIC_VPD),\r
144               ('MODEL_PCD_DYNAMIC_HII', MODEL_PCD_DYNAMIC_HII),\r
145               ("MODEL_META_DATA_HEADER", MODEL_META_DATA_HEADER),\r
146               ("MODEL_META_DATA_INCLUDE", MODEL_META_DATA_INCLUDE),\r
147               ("MODEL_META_DATA_DEFINE", MODEL_META_DATA_DEFINE),\r
148               ("MODEL_META_DATA_CONDITIONAL_STATEMENT_IF", MODEL_META_DATA_CONDITIONAL_STATEMENT_IF),\r
149               ("MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSE", MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSE),\r
150               ("MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF", MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF),\r
151               ("MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF", MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF),\r
152               ("MODEL_META_DATA_BUILD_OPTION", MODEL_META_DATA_BUILD_OPTION),\r
153               ("MODEL_META_DATA_COMPONENT", MODEL_META_DATA_COMPONENT),\r
154               ('MODEL_META_DATA_USER_EXTENSION', MODEL_META_DATA_USER_EXTENSION),\r
155               ('MODEL_META_DATA_PACKAGE', MODEL_META_DATA_PACKAGE),\r
156               ('MODEL_META_DATA_NMAKE', MODEL_META_DATA_NMAKE)\r
157              ]\r
158 \r
159 ## FunctionClass\r
160 #\r
161 # This class defines a structure of a function\r
162\r
163 # @param ID:               ID of a Function\r
164 # @param Header:           Header of a Function\r
165 # @param Modifier:         Modifier of a Function \r
166 # @param Name:             Name of a Function\r
167 # @param ReturnStatement:  ReturnStatement of a Funciont\r
168 # @param StartLine:        StartLine of a Function\r
169 # @param StartColumn:      StartColumn of a Function\r
170 # @param EndLine:          EndLine of a Function\r
171 # @param EndColumn:        EndColumn of a Function\r
172 # @param BodyStartLine:    BodyStartLine of a Function Body\r
173 # @param BodyStartColumn:  BodyStartColumn of a Function Body\r
174 # @param BelongsToFile:    The Function belongs to which file\r
175 # @param IdentifierList:   IdentifierList of a File\r
176 # @param PcdList:          PcdList of a File\r
177 #\r
178 # @var ID:                 ID of a Function\r
179 # @var Header:             Header of a Function\r
180 # @var Modifier:           Modifier of a Function \r
181 # @var Name:               Name of a Function\r
182 # @var ReturnStatement:    ReturnStatement of a Funciont\r
183 # @var StartLine:          StartLine of a Function\r
184 # @var StartColumn:        StartColumn of a Function\r
185 # @var EndLine:            EndLine of a Function\r
186 # @var EndColumn:          EndColumn of a Function\r
187 # @var BodyStartLine:      StartLine of a Function Body\r
188 # @var BodyStartColumn:    StartColumn of a Function Body\r
189 # @var BelongsToFile:      The Function belongs to which file\r
190 # @var IdentifierList:     IdentifierList of a File\r
191 # @var PcdList:            PcdList of a File\r
192 #\r
193 class FunctionClass(object):\r
194     def __init__(self, ID = -1, Header = '', Modifier = '', Name = '', ReturnStatement = '', \\r
195                  StartLine = -1, StartColumn = -1, EndLine = -1, EndColumn = -1, \\r
196                  BodyStartLine = -1, BodyStartColumn = -1, BelongsToFile = -1, \\r
197                  IdentifierList = [], PcdList = []):\r
198         self.ID = ID\r
199         self.Header = Header\r
200         self.Modifier = Modifier                    \r
201         self.Name = Name\r
202         self.ReturnStatement = ReturnStatement\r
203         self.StartLine = StartLine\r
204         self.StartColumn = StartColumn\r
205         self.EndLine = EndLine\r
206         self.EndColumn = EndColumn\r
207         self.BodyStartLine = BodyStartLine\r
208         self.BodyStartColumn = BodyStartColumn\r
209         self.BelongsToFile = BelongsToFile\r
210         \r
211         self.IdentifierList = IdentifierList\r
212         self.PcdList = PcdList\r
213 \r
214 ## IdentifierClass\r
215 #\r
216 # This class defines a structure of a variable\r
217\r
218 # @param ID:                 ID of a Identifier\r
219 # @param Modifier:           Modifier of a Identifier\r
220 # @param Type:               Type of a Identifier\r
221 # @param Name:               Name of a Identifier\r
222 # @param Value:              Value of a Identifier\r
223 # @param Model:              Model of a Identifier\r
224 # @param BelongsToFile:      The Identifier belongs to which file\r
225 # @param BelongsToFunction:  The Identifier belongs to which function\r
226 # @param StartLine:          StartLine of a Identifier\r
227 # @param StartColumn:        StartColumn of a Identifier\r
228 # @param EndLine:            EndLine of a Identifier\r
229 # @param EndColumn:          EndColumn of a Identifier\r
230 #\r
231 # @var ID:                   ID of a Identifier\r
232 # @var Modifier:             Modifier of a Identifier\r
233 # @var Type:                 Type of a Identifier\r
234 # @var Name:                 Name of a Identifier\r
235 # @var Value:                Value of a Identifier\r
236 # @var Model:                Model of a Identifier\r
237 # @var BelongsToFile:        The Identifier belongs to which file\r
238 # @var BelongsToFunction:    The Identifier belongs to which function\r
239 # @var StartLine:            StartLine of a Identifier\r
240 # @var StartColumn:          StartColumn of a Identifier\r
241 # @var EndLine:              EndLine of a Identifier\r
242 # @var EndColumn:            EndColumn of a Identifier\r
243 #\r
244 class IdentifierClass(object):\r
245     def __init__(self, ID = -1, Modifier = '', Type = '', Name = '', Value = '', Model = MODEL_UNKNOWN, \\r
246                  BelongsToFile = -1, BelongsToFunction = -1, StartLine = -1, StartColumn = -1, EndLine = -1, EndColumn = -1):\r
247         self.ID = ID\r
248         self.Modifier = Modifier\r
249         self.Type = Type\r
250         self.Name = Name\r
251         self.Value = Value\r
252         self.Model = Model\r
253         self.BelongsToFile = BelongsToFile\r
254         self.BelongsToFunction = BelongsToFunction\r
255         self.StartLine = StartLine\r
256         self.StartColumn = StartColumn\r
257         self.EndLine = EndLine\r
258         self.EndColumn = EndColumn\r
259 \r
260 ## PcdClass\r
261 #\r
262 # This class defines a structure of a Pcd\r
263\r
264 # @param ID:                   ID of a Pcd\r
265 # @param CName:                CName of a Pcd\r
266 # @param TokenSpaceGuidCName:  TokenSpaceGuidCName of a Pcd\r
267 # @param Token:                Token of a Pcd\r
268 # @param DatumType:            DatumType of a Pcd\r
269 # @param Model:                Model of a Pcd\r
270 # @param BelongsToFile:        The Pcd belongs to which file\r
271 # @param BelongsToFunction:    The Pcd belongs to which function\r
272 # @param StartLine:            StartLine of a Pcd\r
273 # @param StartColumn:          StartColumn of a Pcd\r
274 # @param EndLine:              EndLine of a Pcd\r
275 # @param EndColumn:            EndColumn of a Pcd\r
276 #\r
277 # @var ID:                     ID of a Pcd\r
278 # @var CName:                  CName of a Pcd\r
279 # @var TokenSpaceGuidCName:    TokenSpaceGuidCName of a Pcd\r
280 # @var Token:                  Token of a Pcd\r
281 # @var DatumType:              DatumType of a Pcd\r
282 # @var Model:                  Model of a Pcd\r
283 # @var BelongsToFile:          The Pcd belongs to which file\r
284 # @var BelongsToFunction:      The Pcd belongs to which function\r
285 # @var StartLine:              StartLine of a Pcd\r
286 # @var StartColumn:            StartColumn of a Pcd\r
287 # @var EndLine:                EndLine of a Pcd\r
288 # @var EndColumn:              EndColumn of a Pcd\r
289 #\r
290 class PcdDataClass(object):\r
291     def __init__(self, ID = -1, CName = '', TokenSpaceGuidCName = '', Token = '', DatumType = '', Model = MODEL_UNKNOWN, \\r
292                  BelongsToFile = -1, BelongsToFunction = -1, StartLine = -1, StartColumn = -1, EndLine = -1, EndColumn = -1):\r
293         self.ID = ID\r
294         self.CName = CName\r
295         self.TokenSpaceGuidCName = TokenSpaceGuidCName\r
296         self.Token = Token\r
297         self.DatumType = DatumType\r
298         self.BelongsToFile = BelongsToFile\r
299         self.BelongsToFunction = BelongsToFunction\r
300         self.StartLine = StartLine\r
301         self.StartColumn = StartColumn\r
302         self.EndLine = EndLine\r
303         self.EndColumn = EndColumn\r
304 \r
305 ## FileClass\r
306 #\r
307 # This class defines a structure of a file\r
308\r
309 # @param ID:              ID of a File\r
310 # @param Name:            Name of a File\r
311 # @param ExtName:         ExtName of a File\r
312 # @param Path:            Path of a File\r
313 # @param FullPath:        FullPath of a File\r
314 # @param Model:           Model of a File\r
315 # @param TimeStamp:       TimeStamp of a File\r
316 # @param FunctionList:    FunctionList of a File\r
317 # @param IdentifierList:  IdentifierList of a File\r
318 # @param PcdList:         PcdList of a File\r
319 #\r
320 # @var ID:                ID of a File\r
321 # @var Name:              Name of a File\r
322 # @var ExtName:           ExtName of a File\r
323 # @var Path:              Path of a File\r
324 # @var FullPath:          FullPath of a File\r
325 # @var Model:             Model of a File\r
326 # @var TimeStamp:         TimeStamp of a File\r
327 # @var FunctionList:      FunctionList of a File\r
328 # @var IdentifierList:    IdentifierList of a File\r
329 # @var PcdList:           PcdList of a File\r
330 #\r
331 class FileClass(object):\r
332     def __init__(self, ID = -1, Name = '', ExtName = '', Path = '', FullPath = '', Model = MODEL_UNKNOWN, TimeStamp = '', \\r
333                  FunctionList = [], IdentifierList = [], PcdList = []):\r
334         self.ID = ID                                   \r
335         self.Name = Name\r
336         self.ExtName = ExtName                    \r
337         self.Path = Path\r
338         self.FullPath = FullPath\r
339         self.Model = Model\r
340         self.TimeStamp = TimeStamp\r
341         \r
342         self.FunctionList = FunctionList\r
343         self.IdentifierList = IdentifierList\r
344         self.PcdList = PcdList\r