]>
git.proxmox.com Git - mirror_edk2.git/blob - BaseTools/Source/Python/Workspace/MetaFileTable.py
2 # This file is used to create/update/query/erase a meta file table
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
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.
19 import Common
.EdkLogger
as EdkLogger
21 from MetaDataTable
import Table
, TableFile
22 from MetaDataTable
import ConvertToSqlString
23 from CommonDataClass
.DataClass
import MODEL_FILE_DSC
, MODEL_FILE_DEC
, MODEL_FILE_INF
, \
26 class MetaFileTable(Table
):
27 # TRICK: use file ID as the part before '.'
28 _ID_STEP_
= 0.00000001
32 def __init__(self
, Cursor
, MetaFile
, FileType
, Temporary
):
33 self
.MetaFile
= MetaFile
35 self
._FileIndexTable
= TableFile(Cursor
)
36 self
._FileIndexTable
.Create(False)
38 FileId
= self
._FileIndexTable
.GetFileId(MetaFile
)
40 FileId
= self
._FileIndexTable
.InsertFile(MetaFile
, FileType
)
43 TableName
= "_%s_%s_%s" % (FileType
, FileId
, uuid
.uuid4().hex)
45 TableName
= "_%s_%s" % (FileType
, FileId
)
47 #Table.__init__(self, Cursor, TableName, FileId, False)
48 Table
.__init
__(self
, Cursor
, TableName
, FileId
, Temporary
)
49 self
.Create(not self
.IsIntegrity())
51 def IsIntegrity(self
):
53 Result
= self
.Cur
.execute("select ID from %s where ID<0" % (self
.Table
)).fetchall()
57 TimeStamp
= self
.MetaFile
.TimeStamp
58 if TimeStamp
!= self
._FileIndexTable
.GetFileTimeStamp(self
.IdBase
):
59 # update the timestamp in database
60 self
._FileIndexTable
.SetFileTimeStamp(self
.IdBase
, TimeStamp
)
62 except Exception, Exc
:
63 EdkLogger
.debug(EdkLogger
.DEBUG_5
, str(Exc
))
67 ## Python class representation of table storing module data
68 class ModuleTable(MetaFileTable
):
69 _ID_STEP_
= 0.00000001
73 Model INTEGER NOT NULL,
79 BelongsToItem REAL NOT NULL,
80 StartLine INTEGER NOT NULL,
81 StartColumn INTEGER NOT NULL,
82 EndLine INTEGER NOT NULL,
83 EndColumn INTEGER NOT NULL,
84 Enabled INTEGER DEFAULT 0
86 # used as table end flag, in case the changes to database is not committed to db file
87 _DUMMY_
= "-1, -1, '====', '====', '====', '====', '====', -1, -1, -1, -1, -1, -1"
90 def __init__(self
, Cursor
, MetaFile
, Temporary
):
91 MetaFileTable
.__init
__(self
, Cursor
, MetaFile
, MODEL_FILE_INF
, Temporary
)
93 ## Insert a record into table Inf
95 # @param Model: Model of a Inf item
96 # @param Value1: Value1 of a Inf item
97 # @param Value2: Value2 of a Inf item
98 # @param Value3: Value3 of a Inf item
99 # @param Scope1: Arch of a Inf item
100 # @param Scope2 Platform os a Inf item
101 # @param BelongsToItem: The item belongs to which another item
102 # @param StartLine: StartLine of a Inf item
103 # @param StartColumn: StartColumn of a Inf item
104 # @param EndLine: EndLine of a Inf item
105 # @param EndColumn: EndColumn of a Inf item
106 # @param Enabled: If this item enabled
108 def Insert(self
, Model
, Value1
, Value2
, Value3
, Scope1
='COMMON', Scope2
='COMMON',
109 BelongsToItem
=-1, StartLine
=-1, StartColumn
=-1, EndLine
=-1, EndColumn
=-1, Enabled
=0):
110 (Value1
, Value2
, Value3
, Scope1
, Scope2
) = ConvertToSqlString((Value1
, Value2
, Value3
, Scope1
, Scope2
))
129 # @param Model: The Model of Record
130 # @param Arch: The Arch attribute of Record
131 # @param Platform The Platform attribute of Record
133 # @retval: A recordSet of all found records
135 def Query(self
, Model
, Arch
=None, Platform
=None):
136 ConditionString
= "Model=%s AND Enabled>=0" % Model
137 ValueString
= "Value1,Value2,Value3,Scope1,Scope2,ID,StartLine"
139 if Arch
!= None and Arch
!= 'COMMON':
140 ConditionString
+= " AND (Scope1='%s' OR Scope1='COMMON')" % Arch
141 if Platform
!= None and Platform
!= 'COMMON':
142 ConditionString
+= " AND (Scope2='%s' OR Scope2='COMMON' OR Scope2='DEFAULT')" % Platform
144 SqlCommand
= "SELECT %s FROM %s WHERE %s" % (ValueString
, self
.Table
, ConditionString
)
145 return self
.Exec(SqlCommand
)
147 ## Python class representation of table storing package data
148 class PackageTable(MetaFileTable
):
151 Model INTEGER NOT NULL,
152 Value1 TEXT NOT NULL,
157 BelongsToItem REAL NOT NULL,
158 StartLine INTEGER NOT NULL,
159 StartColumn INTEGER NOT NULL,
160 EndLine INTEGER NOT NULL,
161 EndColumn INTEGER NOT NULL,
162 Enabled INTEGER DEFAULT 0
164 # used as table end flag, in case the changes to database is not committed to db file
165 _DUMMY_
= "-1, -1, '====', '====', '====', '====', '====', -1, -1, -1, -1, -1, -1"
168 def __init__(self
, Cursor
, MetaFile
, Temporary
):
169 MetaFileTable
.__init
__(self
, Cursor
, MetaFile
, MODEL_FILE_DEC
, Temporary
)
173 # Insert a record into table Dec
175 # @param Model: Model of a Dec item
176 # @param Value1: Value1 of a Dec item
177 # @param Value2: Value2 of a Dec item
178 # @param Value3: Value3 of a Dec item
179 # @param Scope1: Arch of a Dec item
180 # @param Scope2: Module type of a Dec item
181 # @param BelongsToItem: The item belongs to which another item
182 # @param StartLine: StartLine of a Dec item
183 # @param StartColumn: StartColumn of a Dec item
184 # @param EndLine: EndLine of a Dec item
185 # @param EndColumn: EndColumn of a Dec item
186 # @param Enabled: If this item enabled
188 def Insert(self
, Model
, Value1
, Value2
, Value3
, Scope1
='COMMON', Scope2
='COMMON',
189 BelongsToItem
=-1, StartLine
=-1, StartColumn
=-1, EndLine
=-1, EndColumn
=-1, Enabled
=0):
190 (Value1
, Value2
, Value3
, Scope1
, Scope2
) = ConvertToSqlString((Value1
, Value2
, Value3
, Scope1
, Scope2
))
209 # @param Model: The Model of Record
210 # @param Arch: The Arch attribute of Record
212 # @retval: A recordSet of all found records
214 def Query(self
, Model
, Arch
=None):
215 ConditionString
= "Model=%s AND Enabled>=0" % Model
216 ValueString
= "Value1,Value2,Value3,Scope1,ID,StartLine"
218 if Arch
!= None and Arch
!= 'COMMON':
219 ConditionString
+= " AND (Scope1='%s' OR Scope1='COMMON')" % Arch
221 SqlCommand
= "SELECT %s FROM %s WHERE %s" % (ValueString
, self
.Table
, ConditionString
)
222 return self
.Exec(SqlCommand
)
224 ## Python class representation of table storing platform data
225 class PlatformTable(MetaFileTable
):
228 Model INTEGER NOT NULL,
229 Value1 TEXT NOT NULL,
234 BelongsToItem REAL NOT NULL,
235 FromItem REAL NOT NULL,
236 StartLine INTEGER NOT NULL,
237 StartColumn INTEGER NOT NULL,
238 EndLine INTEGER NOT NULL,
239 EndColumn INTEGER NOT NULL,
240 Enabled INTEGER DEFAULT 0
242 # used as table end flag, in case the changes to database is not committed to db file
243 _DUMMY_
= "-1, -1, '====', '====', '====', '====', '====', -1, -1, -1, -1, -1, -1, -1"
246 def __init__(self
, Cursor
, MetaFile
, Temporary
):
247 MetaFileTable
.__init
__(self
, Cursor
, MetaFile
, MODEL_FILE_DSC
, Temporary
)
251 # Insert a record into table Dsc
253 # @param Model: Model of a Dsc item
254 # @param Value1: Value1 of a Dsc item
255 # @param Value2: Value2 of a Dsc item
256 # @param Value3: Value3 of a Dsc item
257 # @param Scope1: Arch of a Dsc item
258 # @param Scope2: Module type of a Dsc item
259 # @param BelongsToItem: The item belongs to which another item
260 # @param FromItem: The item belongs to which dsc file
261 # @param StartLine: StartLine of a Dsc item
262 # @param StartColumn: StartColumn of a Dsc item
263 # @param EndLine: EndLine of a Dsc item
264 # @param EndColumn: EndColumn of a Dsc item
265 # @param Enabled: If this item enabled
267 def Insert(self
, Model
, Value1
, Value2
, Value3
, Scope1
='COMMON', Scope2
='COMMON', BelongsToItem
=-1,
268 FromItem
=-1, StartLine
=-1, StartColumn
=-1, EndLine
=-1, EndColumn
=-1, Enabled
=1):
269 (Value1
, Value2
, Value3
, Scope1
, Scope2
) = ConvertToSqlString((Value1
, Value2
, Value3
, Scope1
, Scope2
))
289 # @param Model: The Model of Record
290 # @param Scope1: Arch of a Dsc item
291 # @param Scope2: Module type of a Dsc item
292 # @param BelongsToItem: The item belongs to which another item
293 # @param FromItem: The item belongs to which dsc file
295 # @retval: A recordSet of all found records
297 def Query(self
, Model
, Scope1
=None, Scope2
=None, BelongsToItem
=None, FromItem
=None):
298 ConditionString
= "Model=%s AND Enabled>0" % Model
299 ValueString
= "Value1,Value2,Value3,Scope1,Scope2,ID,StartLine"
301 if Scope1
!= None and Scope1
!= 'COMMON':
302 ConditionString
+= " AND (Scope1='%s' OR Scope1='COMMON')" % Scope1
303 if Scope2
!= None and Scope2
!= 'COMMON':
304 ConditionString
+= " AND (Scope2='%s' OR Scope2='COMMON' OR Scope2='DEFAULT')" % Scope2
306 if BelongsToItem
!= None:
307 ConditionString
+= " AND BelongsToItem=%s" % BelongsToItem
309 ConditionString
+= " AND BelongsToItem<0"
312 ConditionString
+= " AND FromItem=%s" % FromItem
314 SqlCommand
= "SELECT %s FROM %s WHERE %s" % (ValueString
, self
.Table
, ConditionString
)
315 return self
.Exec(SqlCommand
)
317 ## Factory class to produce different storage for different type of meta-file
318 class MetaFileStorage(object):
320 MODEL_FILE_INF
: ModuleTable
,
321 MODEL_FILE_DEC
: PackageTable
,
322 MODEL_FILE_DSC
: PlatformTable
,
323 MODEL_FILE_OTHERS
: MetaFileTable
,
327 ".inf" : MODEL_FILE_INF
,
328 ".dec" : MODEL_FILE_DEC
,
329 ".dsc" : MODEL_FILE_DSC
,
333 def __new__(Class
, Cursor
, MetaFile
, FileType
=None, Temporary
=False):
334 # no type given, try to find one
336 if MetaFile
.Type
in self
._FILE
_TYPE
_:
337 FileType
= Class
._FILE
_TYPE
_[MetaFile
.Type
]
339 FileType
= MODEL_FILE_OTHERS
341 # don't pass the type around if it's well known
342 if FileType
== MODEL_FILE_OTHERS
:
343 Args
= (Cursor
, MetaFile
, FileType
, Temporary
)
345 Args
= (Cursor
, MetaFile
, Temporary
)
347 # create the storage object and return it to caller
348 return Class
._FILE
_TABLE
_[FileType
](*Args
)