BaseTools/Source/Python/CommonDataClass/DataClass.py

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