1. Adjust the structure of TableFile
[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_DSC = 1014\r
30 \r
31 MODEL_IDENTIFIER_FILE_HEADER = 2001\r
32 MODEL_IDENTIFIER_FUNCTION_HEADER = 2002\r
33 MODEL_IDENTIFIER_COMMENT = 2003\r
34 MODEL_IDENTIFIER_PARAMETER = 2004\r
35 MODEL_IDENTIFIER_STRUCTURE = 2005\r
36 MODEL_IDENTIFIER_IDENTIFIER = 2006\r
37 MODEL_IDENTIFIER_INCLUDE = 2007\r
38 MODEL_IDENTIFIER_PREDICATE_EXPRESSION = 2008\r
39 MODEL_IDENTIFIER_ENUMERATE = 2009\r
40 MODEL_IDENTIFIER_PCD = 2010\r
41 MODEL_IDENTIFIER_UNION = 2011\r
42 MODEL_IDENTIFIER_MACRO_IFDEF = 2012\r
43 MODEL_IDENTIFIER_MACRO_IFNDEF = 2013\r
44 MODEL_IDENTIFIER_MACRO_DEFINE = 2014\r
45 MODEL_IDENTIFIER_MACRO_ENDIF = 2015\r
46 MODEL_IDENTIFIER_MACRO_PROGMA = 2016\r
47 \r
48 \r
49 MODEL_EFI_PROTOCOL = 3001\r
50 MODEL_EFI_PPI = 3002\r
51 MODEL_EFI_GUID = 3003\r
52 MODEL_EFI_LIBRARY_CLASS = 3004\r
53 MODEL_EFI_LIBRARY_INSTANCE = 3005\r
54 MODEL_EFI_PCD = 3006\r
55 MODEL_EFI_SOURCE_FILE = 3007\r
56 MODEL_EFI_BINARY_FILE = 3008\r
57 \r
58 MODEL_PCD_FIXED_AT_BUILD = 4001\r
59 MODEL_PCD_PATCHABLE_IN_MODULE = 4002\r
60 MODEL_PCD_FEATURE_FLAG = 4003\r
61 MODEL_PCD_DYNAMIC_EX = 4004\r
62 MODEL_PCD_DYNAMIC = 4005\r
63 \r
64 MODEL_META_DATA_HEADER = 5001\r
65 MODEL_META_DATA_INCLUDE = 5002\r
66 MODEL_META_DATA_DEFINE = 5003\r
67 MODEL_META_DATA_CONDITIONAL_STATEMENT_IF = 5004\r
68 MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSE = 5005\r
69 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF = 5006\r
70 MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF = 5007\r
71 MODEL_META_DATA_BUILD_OPTION = 5008\r
72 MODEL_META_DATA_COMPONENT = 5009\r
73 \r
74 MODEL_LIST = [('MODEL_UNKNOWN', MODEL_UNKNOWN),\r
75               ('MODEL_FILE_C', MODEL_FILE_C),\r
76               ('MODEL_FILE_H', MODEL_FILE_H),\r
77               ('MODEL_FILE_ASM', MODEL_FILE_ASM),\r
78               ('MODEL_FILE_INF', MODEL_FILE_INF),\r
79               ('MODEL_FILE_DEC', MODEL_FILE_DEC),\r
80               ('MODEL_FILE_DSC', MODEL_FILE_DSC),\r
81               ('MODEL_FILE_DSC', MODEL_FILE_DSC),\r
82               ('MODEL_IDENTIFIER_FILE_HEADER', MODEL_IDENTIFIER_FILE_HEADER),\r
83               ('MODEL_IDENTIFIER_FUNCTION_HEADER', MODEL_IDENTIFIER_FUNCTION_HEADER),\r
84               ('MODEL_IDENTIFIER_COMMENT', MODEL_IDENTIFIER_COMMENT),\r
85               ('MODEL_IDENTIFIER_PARAMETER', MODEL_IDENTIFIER_PARAMETER),\r
86               ('MODEL_IDENTIFIER_STRUCTURE', MODEL_IDENTIFIER_STRUCTURE),\r
87               ('MODEL_IDENTIFIER_IDENTIFIER', MODEL_IDENTIFIER_IDENTIFIER),\r
88               ('MODEL_IDENTIFIER_INCLUDE', MODEL_IDENTIFIER_INCLUDE),\r
89               ('MODEL_IDENTIFIER_PREDICATE_EXPRESSION', MODEL_IDENTIFIER_PREDICATE_EXPRESSION),\r
90               ('MODEL_IDENTIFIER_ENUMERATE', MODEL_IDENTIFIER_ENUMERATE),\r
91               ('MODEL_IDENTIFIER_PCD', MODEL_IDENTIFIER_PCD),\r
92               ('MODEL_IDENTIFIER_UNION', MODEL_IDENTIFIER_UNION),\r
93               ('MODEL_IDENTIFIER_MACRO_IFDEF', MODEL_IDENTIFIER_MACRO_IFDEF),\r
94               ('MODEL_IDENTIFIER_MACRO_IFNDEF', MODEL_IDENTIFIER_MACRO_IFNDEF),\r
95               ('MODEL_IDENTIFIER_MACRO_DEFINE', MODEL_IDENTIFIER_MACRO_DEFINE),\r
96               ('MODEL_IDENTIFIER_MACRO_ENDIF', MODEL_IDENTIFIER_MACRO_ENDIF),\r
97               ('MODEL_IDENTIFIER_MACRO_PROGMA', MODEL_IDENTIFIER_MACRO_PROGMA),\r
98               ('MODEL_EFI_PROTOCOL', MODEL_EFI_PROTOCOL),\r
99               ('MODEL_EFI_PPI', MODEL_EFI_PPI),\r
100               ('MODEL_EFI_GUID', MODEL_EFI_GUID),\r
101               ('MODEL_EFI_LIBRARY_CLASS', MODEL_EFI_LIBRARY_CLASS),\r
102               ('MODEL_EFI_LIBRARY_INSTANCE', MODEL_EFI_LIBRARY_INSTANCE),\r
103               ('MODEL_EFI_PCD', MODEL_EFI_PCD),\r
104               ('MODEL_IDENTIFIER_UNION', MODEL_IDENTIFIER_UNION),\r
105               ('MODEL_EFI_SOURCE_FILE', MODEL_EFI_SOURCE_FILE),\r
106               ('MODEL_EFI_BINARY_FILE', MODEL_EFI_BINARY_FILE),\r
107               ('MODEL_PCD_FIXED_AT_BUILD', MODEL_PCD_FIXED_AT_BUILD),\r
108               ('MODEL_PCD_PATCHABLE_IN_MODULE', MODEL_PCD_PATCHABLE_IN_MODULE),\r
109               ('MODEL_PCD_FEATURE_FLAG', MODEL_PCD_FEATURE_FLAG),\r
110               ('MODEL_PCD_DYNAMIC_EX', MODEL_PCD_DYNAMIC_EX),\r
111               ('MODEL_PCD_DYNAMIC', MODEL_PCD_DYNAMIC),\r
112               ("MODEL_META_DATA_HEADER", MODEL_META_DATA_HEADER),\r
113               ("MODEL_META_DATA_INCLUDE", MODEL_META_DATA_INCLUDE),\r
114               ("MODEL_META_DATA_DEFINE", MODEL_META_DATA_DEFINE),\r
115               ("MODEL_META_DATA_CONDITIONAL_STATEMENT_IF", MODEL_META_DATA_CONDITIONAL_STATEMENT_IF),\r
116               ("MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSE", MODEL_META_DATA_CONDITIONAL_STATEMENT_ELSE),\r
117               ("MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF", MODEL_META_DATA_CONDITIONAL_STATEMENT_IFDEF),\r
118               ("MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF", MODEL_META_DATA_CONDITIONAL_STATEMENT_IFNDEF),\r
119               ("MODEL_META_DATA_BUILD_OPTION", MODEL_META_DATA_BUILD_OPTION),\r
120               ("MODEL_META_DATA_COMPONENT", MODEL_META_DATA_COMPONENT)\r
121              ]\r
122 \r
123 ## FunctionClass\r
124 #\r
125 # This class defines a structure of a function\r
126\r
127 # @param ID:               ID of a Function\r
128 # @param Header:           Header of a Function\r
129 # @param Modifier:         Modifier of a Function \r
130 # @param Name:             Name of a Function\r
131 # @param ReturnStatement:  ReturnStatement of a Funciont\r
132 # @param StartLine:        StartLine of a Function\r
133 # @param StartColumn:      StartColumn of a Function\r
134 # @param EndLine:          EndLine of a Function\r
135 # @param EndColumn:        EndColumn of a Function\r
136 # @param BodyStartLine:    BodyStartLine of a Function Body\r
137 # @param BodyStartColumn:  BodyStartColumn of a Function Body\r
138 # @param BelongsToFile:    The Function belongs to which file\r
139 # @param IdentifierList:   IdentifierList of a File\r
140 # @param PcdList:          PcdList of a File\r
141 #\r
142 # @var ID:                 ID of a Function\r
143 # @var Header:             Header of a Function\r
144 # @var Modifier:           Modifier of a Function \r
145 # @var Name:               Name of a Function\r
146 # @var ReturnStatement:    ReturnStatement of a Funciont\r
147 # @var StartLine:          StartLine of a Function\r
148 # @var StartColumn:        StartColumn of a Function\r
149 # @var EndLine:            EndLine of a Function\r
150 # @var EndColumn:          EndColumn of a Function\r
151 # @var BodyStartLine:      StartLine of a Function Body\r
152 # @var BodyStartColumn:    StartColumn of a Function Body\r
153 # @var BelongsToFile:      The Function belongs to which file\r
154 # @var IdentifierList:     IdentifierList of a File\r
155 # @var PcdList:            PcdList of a File\r
156 #\r
157 class FunctionClass(object):\r
158     def __init__(self, ID = -1, Header = '', Modifier = '', Name = '', ReturnStatement = '', \\r
159                  StartLine = -1, StartColumn = -1, EndLine = -1, EndColumn = -1, \\r
160                  BodyStartLine = -1, BodyStartColumn = -1, BelongsToFile = -1, \\r
161                  IdentifierList = [], PcdList = []):\r
162         self.ID = ID\r
163         self.Header = Header\r
164         self.Modifier = Modifier                    \r
165         self.Name = Name\r
166         self.ReturnStatement = ReturnStatement\r
167         self.StartLine = StartLine\r
168         self.StartColumn = StartColumn\r
169         self.EndLine = EndLine\r
170         self.EndColumn = EndColumn\r
171         self.BodyStartLine = BodyStartLine\r
172         self.BodyStartColumn = BodyStartColumn\r
173         self.BelongsToFile = BelongsToFile\r
174         \r
175         self.IdentifierList = IdentifierList\r
176         self.PcdList = PcdList\r
177 \r
178 ## IdentifierClass\r
179 #\r
180 # This class defines a structure of a variable\r
181\r
182 # @param ID:                 ID of a Identifier\r
183 # @param Modifier:           Modifier of a Identifier\r
184 # @param Type:               Type of a Identifier\r
185 # @param Name:               Name of a Identifier\r
186 # @param Value:              Value of a Identifier\r
187 # @param Model:              Model of a Identifier\r
188 # @param BelongsToFile:      The Identifier belongs to which file\r
189 # @param BelongsToFunction:  The Identifier belongs to which function\r
190 # @param StartLine:          StartLine of a Identifier\r
191 # @param StartColumn:        StartColumn of a Identifier\r
192 # @param EndLine:            EndLine of a Identifier\r
193 # @param EndColumn:          EndColumn of a Identifier\r
194 #\r
195 # @var ID:                   ID of a Identifier\r
196 # @var Modifier:             Modifier of a Identifier\r
197 # @var Type:                 Type of a Identifier\r
198 # @var Name:                 Name of a Identifier\r
199 # @var Value:                Value of a Identifier\r
200 # @var Model:                Model of a Identifier\r
201 # @var BelongsToFile:        The Identifier belongs to which file\r
202 # @var BelongsToFunction:    The Identifier belongs to which function\r
203 # @var StartLine:            StartLine of a Identifier\r
204 # @var StartColumn:          StartColumn of a Identifier\r
205 # @var EndLine:              EndLine of a Identifier\r
206 # @var EndColumn:            EndColumn of a Identifier\r
207 #\r
208 class IdentifierClass(object):\r
209     def __init__(self, ID = -1, Modifier = '', Type = '', Name = '', Value = '', Model = MODEL_UNKNOWN, \\r
210                  BelongsToFile = -1, BelongsToFunction = -1, StartLine = -1, StartColumn = -1, EndLine = -1, EndColumn = -1):\r
211         self.ID = ID\r
212         self.Modifier = Modifier\r
213         self.Type = Type\r
214         self.Name = Name\r
215         self.Value = Value\r
216         self.Model = Model\r
217         self.BelongsToFile = BelongsToFile\r
218         self.BelongsToFunction = BelongsToFunction\r
219         self.StartLine = StartLine\r
220         self.StartColumn = StartColumn\r
221         self.EndLine = EndLine\r
222         self.EndColumn = EndColumn\r
223 \r
224 ## PcdClass\r
225 #\r
226 # This class defines a structure of a Pcd\r
227\r
228 # @param ID:                   ID of a Pcd\r
229 # @param CName:                CName of a Pcd\r
230 # @param TokenSpaceGuidCName:  TokenSpaceGuidCName of a Pcd\r
231 # @param Token:                Token of a Pcd\r
232 # @param DatumType:            DatumType of a Pcd\r
233 # @param Model:                Model of a Pcd\r
234 # @param BelongsToFile:        The Pcd belongs to which file\r
235 # @param BelongsToFunction:    The Pcd belongs to which function\r
236 # @param StartLine:            StartLine of a Pcd\r
237 # @param StartColumn:          StartColumn of a Pcd\r
238 # @param EndLine:              EndLine of a Pcd\r
239 # @param EndColumn:            EndColumn of a Pcd\r
240 #\r
241 # @var ID:                     ID of a Pcd\r
242 # @var CName:                  CName of a Pcd\r
243 # @var TokenSpaceGuidCName:    TokenSpaceGuidCName of a Pcd\r
244 # @var Token:                  Token of a Pcd\r
245 # @var DatumType:              DatumType of a Pcd\r
246 # @var Model:                  Model of a Pcd\r
247 # @var BelongsToFile:          The Pcd belongs to which file\r
248 # @var BelongsToFunction:      The Pcd belongs to which function\r
249 # @var StartLine:              StartLine of a Pcd\r
250 # @var StartColumn:            StartColumn of a Pcd\r
251 # @var EndLine:                EndLine of a Pcd\r
252 # @var EndColumn:              EndColumn of a Pcd\r
253 #\r
254 class PcdClass(object):\r
255     def __init__(self, ID = -1, CName = '', TokenSpaceGuidCName = '', Token = '', DatumType = '', Model = MODEL_UNKNOWN, \\r
256                  BelongsToFile = -1, BelongsToFunction = -1, StartLine = -1, StartColumn = -1, EndLine = -1, EndColumn = -1):\r
257         self.ID = ID\r
258         self.CName = CName\r
259         self.TokenSpaceGuidCName = TokenSpaceGuidCName\r
260         self.Token = Token\r
261         self.DatumType = DatumType\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 ## FileClass\r
270 #\r
271 # This class defines a structure of a file\r
272\r
273 # @param ID:              ID of a File\r
274 # @param Name:            Name of a File\r
275 # @param ExtName:         ExtName of a File\r
276 # @param Path:            Path of a File\r
277 # @param FullPath:        FullPath of a File\r
278 # @param Model:           Model of a File\r
279 # @param TimeStamp:       TimeStamp of a File\r
280 # @param FunctionList:    FunctionList of a File\r
281 # @param IdentifierList:  IdentifierList of a File\r
282 # @param PcdList:         PcdList of a File\r
283 #\r
284 # @var ID:                ID of a File\r
285 # @var Name:              Name of a File\r
286 # @var ExtName:           ExtName of a File\r
287 # @var Path:              Path of a File\r
288 # @var FullPath:          FullPath of a File\r
289 # @var Model:             Model of a File\r
290 # @var TimeStamp:         TimeStamp of a File\r
291 # @var FunctionList:      FunctionList of a File\r
292 # @var IdentifierList:    IdentifierList of a File\r
293 # @var PcdList:           PcdList of a File\r
294 #\r
295 class FileClass(object):\r
296     def __init__(self, ID = -1, Name = '', ExtName = '', Path = '', FullPath = '', Model = MODEL_UNKNOWN, TimeStamp = '', \\r
297                  FunctionList = [], IdentifierList = [], PcdList = []):\r
298         self.ID = ID                                   \r
299         self.Name = Name\r
300         self.ExtName = ExtName                    \r
301         self.Path = Path\r
302         self.FullPath = FullPath\r
303         self.Model = Model\r
304         self.TimeStamp = TimeStamp\r
305         \r
306         self.FunctionList = FunctionList\r
307         self.IdentifierList = IdentifierList\r
308         self.PcdList = PcdList\r