1. Sync pcd definition and parsing with the latest spec
[people/mcb30/basetools.git] / Source / Python / Common / DecClassObject.py
1 # Copyright (c) 2007, Intel Corporation\r
2 # All rights reserved. This program and the accompanying materials\r
3 # are licensed and made available under the terms and conditions of the BSD License\r
4 # which accompanies this distribution.    The full text of the license may be found at\r
5 # http://opensource.org/licenses/bsd-license.php\r
6 #\r
7 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
8 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
9 \r
10 #\r
11 #This file is used to define each component of DEC file\r
12 #\r
13 \r
14 import os\r
15 from String import *\r
16 from DataType import *\r
17 from Identification import *\r
18 from Dictionary import *\r
19 from CommonDataClass.PackageClass import *\r
20 from BuildToolError import *\r
21 \r
22 class DecObject(object):\r
23     def __init__(self):\r
24         object.__init__()\r
25 \r
26 class DecDefines(DecObject):\r
27     def __init__(self):\r
28         self.DefinesDictionary = {\r
29             #Req\r
30             TAB_DEC_DEFINES_DEC_SPECIFICATION           : [''],\r
31             TAB_DEC_DEFINES_PACKAGE_NAME                : [''],\r
32             TAB_DEC_DEFINES_PACKAGE_GUID                : [''],\r
33             TAB_DEC_DEFINES_PACKAGE_VERSION             : ['']\r
34         }\r
35         \r
36 class DecContents(DecObject):\r
37     def __init__(self):\r
38         self.Includes = []\r
39         self.Guids = []\r
40         self.Protocols = []\r
41         self.Ppis = []\r
42         self.LibraryClasses = []\r
43         self.PcdsFixedAtBuild = []\r
44         self.PcdsPatchableInModule = []\r
45         self.PcdsFeatureFlag = []\r
46         self.PcdsDynamic = []\r
47         self.PcdsDynamicEx = []\r
48 \r
49 class Dec(DecObject):\r
50     def __init__(self, filename = None, isMergeAllArches = False, isToPackage = False, WorkspaceDir = None):\r
51         self.Identification = Identification()\r
52         self.Defines = DecDefines()\r
53         self.UserExtensions = ''\r
54         self.Package = PackageClass()\r
55         self.WorkspaceDir = WorkspaceDir\r
56         \r
57         self.Contents = {}\r
58         for key in DataType.ARCH_LIST_FULL:\r
59             self.Contents[key] = DecContents()\r
60         \r
61         self.KeyList = [\r
62             TAB_INCLUDES, TAB_GUIDS, TAB_PROTOCOLS, TAB_PPIS, TAB_LIBRARY_CLASSES, \\r
63             TAB_PCDS_FIXED_AT_BUILD_NULL, TAB_PCDS_PATCHABLE_IN_MODULE_NULL, TAB_PCDS_FEATURE_FLAG_NULL, \\r
64             TAB_PCDS_DYNAMIC_NULL, TAB_PCDS_DYNAMIC_EX_NULL\r
65         ]\r
66     \r
67         if filename != None:\r
68             self.LoadDecFile(filename)\r
69             \r
70         if isMergeAllArches:\r
71             self.MergeAllArches()\r
72         \r
73         if isToPackage:\r
74             self.DecToPackage()\r
75     \r
76     def ParseDec(self, Lines, Key, KeyField):\r
77         newKey = SplitModuleType(Key)\r
78         if newKey[0].upper().find(DataType.TAB_LIBRARY_CLASSES.upper()) != -1:\r
79             GetLibraryClassesWithModuleType(Lines, Key, KeyField, TAB_COMMENT_SPLIT)\r
80         else:\r
81             GetMultipleValuesOfKeyFromLines(Lines, Key, KeyField, TAB_COMMENT_SPLIT)\r
82             \r
83     def MergeAllArches(self):\r
84         for key in self.KeyList:\r
85             for arch in DataType.ARCH_LIST:\r
86                 Command = "self.Contents[arch]." + key + ".extend(" + "self.Contents['" + DataType.TAB_ARCH_COMMON + "']." + key + ")"\r
87                 eval(Command)\r
88 \r
89     def LoadDecFile(self, Filename):\r
90         (Filepath, Name) = os.path.split(Filename)\r
91         self.Identification.FileName = Name\r
92         self.Identification.FileFullPath = Filename\r
93         self.Identification.FileRelativePath = Filepath\r
94         \r
95         F = open(Filename, 'r').read()\r
96         PreCheck(Filename, F, self.KeyList)\r
97         Sects = F.split(DataType.TAB_SECTION_START)\r
98         for Sect in Sects:\r
99             TabList = GetSplitValueList(Sect.split(TAB_SECTION_END, 1)[0], DataType.TAB_COMMA_SPLIT)\r
100             for Tab in TabList:\r
101                 if Tab.upper() == TAB_INF_DEFINES.upper():\r
102                     GetSingleValueOfKeyFromLines(Sect, self.Defines.DefinesDictionary, TAB_COMMENT_SPLIT, TAB_EQUAL_SPLIT, True, TAB_VALUE_SPLIT)\r
103                     continue\r
104                 for Arch in DataType.ARCH_LIST_FULL + [DataType.TAB_ARCH_NULL]:\r
105                     for Key in self.KeyList:\r
106                         if Arch != DataType.TAB_ARCH_NULL:\r
107                             Target = (Key + DataType.TAB_SPLIT + Arch).upper()\r
108                         else:\r
109                             Target = Key.upper()\r
110                         if Tab.upper() == Target:\r
111                             if Arch != DataType.TAB_ARCH_NULL:\r
112                                 Command = 'self.ParseDec(Sect, Tab, self.Contents[Arch].' + Key + ')'\r
113                                 eval(Command)\r
114                                 continue\r
115                             else:\r
116                                 Command = "self.ParseDec(Sect, Tab, self.Contents['" + DataType.TAB_ARCH_COMMON + "']." + Key + ')'\r
117                                 eval(Command)\r
118                                 continue\r
119         #EndFor\r
120 \r
121     def DecToPackage(self):\r
122         #\r
123         # Get value for Header\r
124         #\r
125         self.Package.Header.Name = self.Defines.DefinesDictionary[TAB_DEC_DEFINES_PACKAGE_NAME][0]\r
126         self.Package.Header.Guid = self.Defines.DefinesDictionary[TAB_DEC_DEFINES_PACKAGE_GUID][0]\r
127         self.Package.Header.Version = self.Defines.DefinesDictionary[TAB_DEC_DEFINES_PACKAGE_VERSION][0]\r
128         self.Package.Header.FileName = self.Identification.FileName\r
129         self.Package.Header.FullPath = self.Identification.FileFullPath\r
130         self.Package.Header.DecSpecification = self.Defines.DefinesDictionary[TAB_DEC_DEFINES_DEC_SPECIFICATION][0]\r
131         File = self.Package.Header.FullPath\r
132         \r
133         #\r
134         # Includes\r
135         # <IncludeDirectory>\r
136         #\r
137         Includes = {}\r
138         for Arch in DataType.ARCH_LIST:\r
139             for Item in self.Contents[Arch].Includes:\r
140                 MergeArches(Includes, Item, Arch)\r
141         for Key in Includes.keys():\r
142             Include = IncludeClass()\r
143             Include.FilePath = Key\r
144             Include.SupArchList = Includes[Key]\r
145             self.Package.Includes.append(Include)\r
146             \r
147         #\r
148         # Guids\r
149         # <CName>=<GuidValue>\r
150         #\r
151         Guids = {}\r
152         for Arch in DataType.ARCH_LIST:\r
153             for Item in self.Contents[Arch].Guids:\r
154                 List = GetSplitValueList(Item, DataType.TAB_EQUAL_SPLIT)\r
155                 if len(List) != 2:\r
156                     RaiseParserError(Item, 'Guids', File, '<CName>=<GuidValue>')\r
157                 else:\r
158                     MergeArches(Guids, (List[0], List[1]), Arch)\r
159         for Key in Guids.keys():\r
160             Guid = GuidClass()\r
161             Guid.CName = Key[0]\r
162             Guid.Guid = Key[1]\r
163             Guid.SupArchList = Guids[Key]\r
164             self.Package.GuidDeclarations.append(Guid)\r
165 \r
166         # \r
167         # Protocols\r
168         # <CName>=<GuidValue>\r
169         #\r
170         Protocols = {}\r
171         for Arch in DataType.ARCH_LIST:\r
172             for Item in self.Contents[Arch].Protocols:\r
173                 List = GetSplitValueList(Item, DataType.TAB_EQUAL_SPLIT)\r
174                 if len(List) != 2:\r
175                     RaiseParserError(Item, 'Protocols', File, '<CName>=<GuidValue>')\r
176                 else:\r
177                     MergeArches(Protocols, (List[0], List[1]), Arch)\r
178         for Key in Protocols.keys():\r
179             Protocol = ProtocolClass()\r
180             Protocol.CName = Key[0]\r
181             Protocol.Guid = Key[1]\r
182             Protocol.SupArchList = Protocols[Key]\r
183             self.Package.ProtocolDeclarations.append(Protocol)\r
184         \r
185         #\r
186         # Ppis\r
187         # <CName>=<GuidValue>\r
188         #\r
189         Ppis = {}\r
190         for Arch in DataType.ARCH_LIST:\r
191             for Item in self.Contents[Arch].Ppis:\r
192                 List = GetSplitValueList(Item, DataType.TAB_EQUAL_SPLIT)\r
193                 if len(List) != 2:\r
194                     RaiseParserError(Item, 'Ppis', File, '<CName>=<GuidValue>')\r
195                 else:\r
196                     MergeArches(Ppis, (List[0], List[1]), Arch)\r
197         for Key in Ppis.keys():\r
198             Ppi = PpiClass()\r
199             Ppi.CName = Key[0]\r
200             Ppi.Guid = Key[1]\r
201             Ppi.SupArchList = Ppis[Key]\r
202             self.Package.PpiDeclarations.append(Ppi)\r
203             \r
204         #\r
205         # LibraryClasses\r
206         # <LibraryClassName>|<LibraryClassInstance>\r
207         #\r
208         LibraryClasses = {}\r
209         for Arch in DataType.ARCH_LIST:\r
210             for Item in self.Contents[Arch].LibraryClasses:\r
211                 List = GetSplitValueList(Item[0], DataType.TAB_VALUE_SPLIT)\r
212                 if len(List) != 2:\r
213                     RaiseParserError(Item[0], 'LibraryClasses', File, '<LibraryClassName>|<LibraryClassInstanceFilename>')\r
214                 else:\r
215                     CheckFileExist(self.WorkspaceDir, os.path.join(self.Identification.FileRelativePath, List[1]), File, 'LibraryClasses', Item[0])\r
216                     if Item[1] == ['']:\r
217                             Item[1] = DataType.SUP_MODULE_LIST\r
218                     MergeArches(LibraryClasses, (List[0], List[1]) + tuple(Item[1]), Arch)\r
219         for Key in LibraryClasses.keys():\r
220             LibraryClass = LibraryClassClass()\r
221             LibraryClass.LibraryClass = Key[0]\r
222             LibraryClass.RecommendedInstance = Key[1]\r
223             LibraryClass.SupModuleList = list(Key[2:])\r
224             LibraryClass.SupArchList = LibraryClasses[Key]\r
225             self.Package.LibraryClassDeclarations.append(LibraryClass)\r
226         \r
227         #\r
228         # Pcds\r
229         # <TokenSpcCName>.<TokenCName>|<Value>|<DatumType>|<Token>\r
230         #\r
231         Pcds = {}\r
232         for Arch in DataType.ARCH_LIST:\r
233             for Item in self.Contents[Arch].PcdsFixedAtBuild:\r
234                 MergeArches(Pcds, self.GetPcdOfDec(Item, TAB_PCDS_FIXED_AT_BUILD, File), Arch)\r
235             \r
236             for Item in self.Contents[Arch].PcdsPatchableInModule:\r
237                 MergeArches(Pcds, self.GetPcdOfDec(Item, TAB_PCDS_PATCHABLE_IN_MODULE, File), Arch)\r
238             \r
239             for Item in self.Contents[Arch].PcdsFeatureFlag:\r
240                 MergeArches(Pcds, self.GetPcdOfDec(Item, TAB_PCDS_FEATURE_FLAG, File), Arch)\r
241             \r
242             for Item in self.Contents[Arch].PcdsDynamicEx:\r
243                 MergeArches(Pcds, self.GetPcdOfDec(Item, TAB_PCDS_DYNAMIC_EX, File), Arch)\r
244             \r
245             for Item in self.Contents[Arch].PcdsDynamic:\r
246                 MergeArches(Pcds, self.GetPcdOfDec(Item, TAB_PCDS_DYNAMIC, File), Arch)\r
247 \r
248         for Key in Pcds.keys():\r
249             Pcd = PcdClass()\r
250             Pcd.CName = Key[1]\r
251             Pcd.Token = Key[4]\r
252             Pcd.TokenSpaceGuidCName = Key[0]\r
253             Pcd.DatumType = Key[3]\r
254             Pcd.DefaultValue = Key[2]\r
255             Pcd.ItemType = Key[5]\r
256             Pcd.SupArchList = Pcds[Key]\r
257             self.Package.PcdDeclarations.append(Pcd)\r
258     \r
259     #\r
260     # Get Pcd of Dec as <TokenSpcCName>.<TokenCName>|<Value>|<DatumType>|<Token>\r
261     # Return (TokenSpcCName, TokenCName, Value, DatumType, Token, ItemType)\r
262     #\r
263     def GetPcdOfDec(self, Item, Type, File):\r
264         Format = '<TokenSpaceGuidCName>.<PcdCName>|<Value>|<DatumType>|<Token>'\r
265         List = GetSplitValueList(Item)\r
266         if len(List) != 4:\r
267             RaiseParserError(Item, 'Pcds' + Type, File, Format)\r
268         TokenInfo = GetSplitValueList(List[0], DataType.TAB_SPLIT)\r
269         if len(TokenInfo) != 2:\r
270             RaiseParserError(Item, 'Pcds' + Type, File, Format)\r
271         \r
272         return (TokenInfo[0], TokenInfo[1], List[1], List[2], List[3], Type)\r
273     \r
274     #\r
275     # Show detailed information of Dec\r
276     #\r
277     def ShowDec(self):\r
278         print TAB_SECTION_START + TAB_INF_DEFINES + TAB_SECTION_END\r
279         printDict(self.Defines.DefinesDictionary)\r
280 \r
281         for key in self.KeyList:\r
282             for arch in DataType.ARCH_LIST_FULL:\r
283                 Command = "printList(TAB_SECTION_START + '" + \\r
284                                     key + DataType.TAB_SPLIT + arch + \\r
285                                     "' + TAB_SECTION_END, self.Contents[arch]." + key + ')'\r
286                 eval(Command)\r
287     \r
288     #\r
289     # Show detailed information of Package\r
290     #\r
291     def ShowPackage(self):\r
292         m = self.Package\r
293         print 'Filename =', m.Header.FileName\r
294         print 'FullPath =', m.Header.FullPath\r
295         print 'BaseName =', m.Header.Name\r
296         print 'Guid =', m.Header.Guid\r
297         print 'Version =', m.Header.Version\r
298         print 'DecSpecification =', m.Header.DecSpecification\r
299         print '\nIncludes =', m.Includes\r
300         for Item in m.Includes:\r
301             print Item.FilePath, Item.SupArchList\r
302         print '\nGuids =', m.GuidDeclarations\r
303         for Item in m.GuidDeclarations:\r
304             print Item.CName, Item.Guid, Item.SupArchList\r
305         print '\nProtocols =', m.ProtocolDeclarations\r
306         for Item in m.ProtocolDeclarations:\r
307             print Item.CName, Item.Guid, Item.SupArchList\r
308         print '\nPpis =', m.PpiDeclarations\r
309         for Item in m.PpiDeclarations:\r
310             print Item.CName, Item.Guid, Item.SupArchList\r
311         print '\nLibraryClasses =', m.LibraryClassDeclarations\r
312         for Item in m.LibraryClassDeclarations:\r
313             print Item.LibraryClass, Item.RecommendedInstance, Item.SupModuleList, Item.SupArchList\r
314         print '\nPcds =', m.PcdDeclarations\r
315         for Item in m.PcdDeclarations:\r
316             print 'CName=', Item.CName, 'TokenSpaceGuidCName=', Item.TokenSpaceGuidCName, 'DefaultValue=', Item.DefaultValue, 'ItemType=', Item.ItemType, 'Token=', Item.Token, 'DatumType=', Item.DatumType, Item.SupArchList\r
317 \r
318 if __name__ == '__main__':\r
319     w = os.getenv('WORKSPACE')\r
320     f = os.path.join(w, 'Nt32Pkg/Nt32Pkg.dec')\r
321     p = Dec(os.path.normpath(f), True, True, w)\r
322     p.ShowPackage()\r