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