]> git.proxmox.com Git - mirror_edk2.git/blame - Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/packaging/ui/SpdFileContents.java
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Added some checks to see if the attributes were set - clears up some warning messages...
[mirror_edk2.git] / Tools / Source / FrameworkWizard / src / org / tianocore / frameworkwizard / packaging / ui / SpdFileContents.java
CommitLineData
a13899c5 1/** @file\r
2 Java class SpdFileContents is used to parse spd xml file.\r
3 \r
4Copyright (c) 2006, Intel Corporation\r
5All rights reserved. This program and the accompanying materials\r
6are licensed and made available under the terms and conditions of the BSD License\r
7which accompanies this distribution. The full text of the license may be found at\r
8http://opensource.org/licenses/bsd-license.php\r
9\r
10THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12**/\r
13package org.tianocore.frameworkwizard.packaging.ui;\r
14\r
15import java.io.File;\r
16import java.io.IOException;\r
17import java.util.ArrayList;\r
18import java.util.List;\r
19import java.util.ListIterator;\r
20import java.util.Vector;\r
21\r
a13899c5 22\r
23import org.apache.xmlbeans.XmlObject;\r
24import org.apache.xmlbeans.XmlOptions;\r
25import org.apache.xmlbeans.XmlCursor;\r
26\r
a13899c5 27import org.tianocore.GuidDeclarationsDocument;\r
28\r
29import org.tianocore.LibraryClassDeclarationsDocument;\r
30\r
31import org.tianocore.ModuleTypeDef;\r
32import org.tianocore.MsaFilesDocument;\r
33import org.tianocore.PackageDefinitionsDocument;\r
34import org.tianocore.PackageHeadersDocument;\r
35import org.tianocore.PackageSurfaceAreaDocument;\r
36import org.tianocore.PcdDataTypes;\r
37import org.tianocore.PcdDeclarationsDocument;\r
a13899c5 38import org.tianocore.PpiDeclarationsDocument;\r
39import org.tianocore.ProtocolDeclarationsDocument;\r
40import org.tianocore.SpdHeaderDocument;\r
41import org.tianocore.GuidDeclarationsDocument.GuidDeclarations;\r
a13899c5 42\r
43/**\r
44 This class processes spd file contents such as add remove xml elements.\r
45 \r
46 @since PackageEditor 1.0\r
47**/\r
48\r
49public class SpdFileContents {\r
50\r
51 private File file = null;\r
52\r
53 private PackageSurfaceAreaDocument psad = null;\r
54\r
55 private PackageSurfaceAreaDocument.PackageSurfaceArea psaRoot = null;\r
56\r
57 private SpdHeaderDocument.SpdHeader spdHdr = null;\r
58 \r
59 private PackageDefinitionsDocument.PackageDefinitions spdPkgDefs = null;\r
60 \r
61 private LibraryClassDeclarationsDocument.LibraryClassDeclarations spdLibClassDeclarations = null;\r
62\r
63 private MsaFilesDocument.MsaFiles spdMsaFiles = null;\r
64\r
65 private PackageHeadersDocument.PackageHeaders spdModHdrs = null;\r
66\r
67 private GuidDeclarationsDocument.GuidDeclarations spdGuidDeclarations = null;\r
68\r
69 private ProtocolDeclarationsDocument.ProtocolDeclarations spdProtocolDeclarations = null;\r
70\r
71 private PpiDeclarationsDocument.PpiDeclarations spdPpiDeclarations = null;\r
72\r
73 private PcdDeclarationsDocument.PcdDeclarations spdPcdDefinitions = null;\r
74\r
75 /**\r
76 Constructor to create a new spd file\r
77 **/\r
78 public SpdFileContents() {\r
79\r
80 psad = PackageSurfaceAreaDocument.Factory.newInstance();\r
81 psaRoot = psad.addNewPackageSurfaceArea();\r
82\r
83 }\r
84\r
85 /**\r
86 Constructor for existing document object\r
87 @param psa\r
88 **/\r
89 public SpdFileContents(PackageSurfaceAreaDocument.PackageSurfaceArea psa) {\r
90 psaRoot = psa;\r
91 spdHdr = psaRoot.getSpdHeader();\r
92 spdPkgDefs = psaRoot.getPackageDefinitions();\r
93 }\r
94 /**\r
95 Constructor based on an existing spd file\r
96 \r
97 @param f Existing spd file\r
98 **/\r
99 public SpdFileContents(File f) {\r
100 try {\r
101 psad = PackageSurfaceAreaDocument.Factory.parse(f);\r
102 psaRoot = psad.getPackageSurfaceArea();\r
103 file = f;\r
104 } catch (Exception e) {\r
105 System.out.println(e.toString());\r
106 }\r
107 }\r
108\r
109 /**\r
110 Remove existing pcd definitions elements using XmlCursor\r
111 **/\r
112 public void removeSpdPcdDefinition() {\r
113 XmlObject o = psaRoot.getPcdDeclarations();\r
114 if (o == null)\r
115 return;\r
116 XmlCursor cursor = o.newCursor();\r
117 cursor.removeXml();\r
118 spdPcdDefinitions = null;\r
119 cursor.dispose();\r
120 }\r
121 \r
122 public void removeSpdPcdDefinition(int i){\r
123 XmlObject o = psaRoot.getPcdDeclarations();\r
124 if (o == null)\r
125 return;\r
126 XmlCursor cursor = o.newCursor();\r
127 if (cursor.toFirstChild()) {\r
128 for (int j = 0; j < i; ++j) {\r
129 cursor.toNextSibling();\r
130 }\r
131 cursor.removeXml();\r
af25df16 132 if (getSpdPcdDefinitionCount() == 0) {\r
133 cursor.toParent();\r
134 cursor.removeXml();\r
135 }\r
a13899c5 136 } \r
137 cursor.dispose();\r
138 }\r
139\r
140 /**\r
141 Remove existing ppi declarations using XmlCursor\r
142 **/\r
143 public void removeSpdPpiDeclaration() {\r
144 XmlObject o = psaRoot.getPpiDeclarations();\r
145 if (o == null)\r
146 return;\r
147 XmlCursor cursor = o.newCursor();\r
148 cursor.removeXml();\r
149 spdPpiDeclarations = null;\r
150 cursor.dispose();\r
151 }\r
152\r
153 public void removeSpdPpiDeclaration(int i){\r
154 XmlObject o = psaRoot.getPpiDeclarations();\r
155 if (o == null)\r
156 return;\r
157 XmlCursor cursor = o.newCursor();\r
158 if (cursor.toFirstChild()) {\r
159 for (int j = 0; j < i; ++j) {\r
160 cursor.toNextSibling();\r
161 }\r
162 cursor.removeXml();\r
af25df16 163 if (getSpdPpiDeclarationCount() == 0){\r
164 cursor.toParent();\r
165 cursor.removeXml();\r
166 }\r
a13899c5 167 } \r
168 cursor.dispose();\r
169 }\r
170 /**\r
171 Remove existing protocols declarations using XmlCursor\r
172 **/\r
173 public void removeSpdProtocolDeclaration() {\r
174 XmlObject o = psaRoot.getProtocolDeclarations();\r
175 if (o == null)\r
176 return;\r
177 XmlCursor cursor = o.newCursor();\r
178 cursor.removeXml();\r
179 spdProtocolDeclarations = null;\r
180 cursor.dispose();\r
181 }\r
182 \r
183 public void removeSpdProtocolDeclaration(int i) {\r
184 XmlObject o = psaRoot.getProtocolDeclarations();\r
185 if (o == null)\r
186 return;\r
187 XmlCursor cursor = o.newCursor();\r
188 if (cursor.toFirstChild()) {\r
189 for (int j = 0; j < i; ++j) {\r
190 cursor.toNextSibling();\r
191 }\r
192 cursor.removeXml();\r
af25df16 193 if (getSpdProtocolDeclarationCount() == 0) {\r
194 cursor.toParent();\r
195 cursor.removeXml();\r
196 }\r
a13899c5 197 }\r
198 cursor.dispose();\r
199 }\r
200 /**\r
201 Remove existing GUID declarations using XmlCursor\r
202 **/\r
203 public void removeSpdGuidDeclaration() {\r
204 XmlObject o = psaRoot.getGuidDeclarations();\r
205 if (o == null)\r
206 return;\r
207 XmlCursor cursor = o.newCursor();\r
208 cursor.removeXml();\r
209 spdGuidDeclarations = null; \r
210 cursor.dispose();\r
211 }\r
212 \r
213 public void removeSpdGuidDeclaration(int i) {\r
214 XmlObject o = psaRoot.getGuidDeclarations();\r
215 if (o == null)\r
216 return;\r
217 XmlCursor cursor = o.newCursor();\r
218 if (cursor.toFirstChild()) {\r
219 for (int j = 0; j < i; ++j) {\r
220 cursor.toNextSibling();\r
221 }\r
222 cursor.removeXml();\r
af25df16 223 if (getSpdGuidDeclarationCount() == 0) {\r
224 cursor.toParent();\r
225 cursor.removeXml();\r
226 }\r
a13899c5 227 } \r
228 cursor.dispose();\r
229 }\r
230\r
231 /**\r
232 Remove existing spd package include files using XmlCursor\r
233 **/\r
234 public void removeSpdPkgHeader() {\r
235 XmlObject o = psaRoot.getPackageHeaders();\r
236 if (o == null)\r
237 return;\r
238 XmlCursor cursor = o.newCursor();\r
239 cursor.removeXml();\r
240 spdModHdrs = null;\r
241 cursor.dispose();\r
242 }\r
243 \r
244 public void removeSpdPkgHeader(int i){\r
245 XmlObject o = psaRoot.getPackageHeaders();\r
246 if (o == null)\r
247 return;\r
248 XmlCursor cursor = o.newCursor();\r
249 if (cursor.toFirstChild()) {\r
250 for (int j = 0; j < i; ++j) {\r
251 cursor.toNextSibling();\r
252 }\r
253 cursor.removeXml();\r
af25df16 254 if (getSpdPackageHeaderCount() == 0) {\r
255 cursor.toParent();\r
256 cursor.removeXml();\r
257 }\r
a13899c5 258 } \r
259 cursor.dispose();\r
260 }\r
261\r
262 /**\r
263 Remove existing msa files using XmlCursor\r
264 **/\r
265 public void removeSpdMsaFile() {\r
266 XmlObject o = psaRoot.getMsaFiles();\r
267 if (o == null)\r
268 return;\r
269 XmlCursor cursor = o.newCursor();\r
270 cursor.removeXml();\r
271 spdMsaFiles = null;\r
272 cursor.dispose();\r
273 }\r
274 \r
275 public void removeSpdMsaFile(int i){\r
276 XmlObject o = psaRoot.getMsaFiles();\r
277 if (o == null)\r
278 return;\r
279 XmlCursor cursor = o.newCursor();\r
280 if (cursor.toFirstChild()) {\r
281 for (int j = 0; j < i; ++j) {\r
282 cursor.toNextSibling();\r
283 }\r
284 cursor.removeXml();\r
af25df16 285 if (getSpdMsaFileCount() == 0) {\r
286 cursor.toParent();\r
287 cursor.removeXml();\r
288 }\r
a13899c5 289 }\r
290 cursor.dispose();\r
291 }\r
292\r
293 /**\r
294 Remove existing library class declarations using XmlCursor\r
295 **/\r
296 public void removeSpdLibClass() {\r
297 XmlObject o = psaRoot.getLibraryClassDeclarations();\r
298 if (o == null)\r
299 return;\r
300 XmlCursor cursor = o.newCursor();\r
301 cursor.removeXml();\r
302 spdLibClassDeclarations = null;\r
303 cursor.dispose();\r
304 }\r
305 \r
306 public void removeSpdLibClass(int i) {\r
307 XmlObject o = psaRoot.getLibraryClassDeclarations();\r
308 if (o == null)\r
309 return;\r
310 XmlCursor cursor = o.newCursor();\r
311 if (cursor.toFirstChild()) {\r
312 for (int j = 0; j < i; ++j) {\r
313 cursor.toNextSibling();\r
314 }\r
315 cursor.removeXml();\r
af25df16 316 if (getSpdLibClassDeclarationCount() == 0) {\r
317 cursor.toParent();\r
318 cursor.removeXml();\r
319 }\r
a13899c5 320 }\r
321 cursor.dispose();\r
322 }\r
323 \r
324 public void updateSpdLibClass(int i, String lib, String hdr, String hlp, String clsUsage, String instanceVer, String hdrAttribArch, String hdrAttribModType) {\r
325 XmlObject o = psaRoot.getLibraryClassDeclarations();\r
326 if (o == null)\r
327 return;\r
328 \r
329 XmlCursor cursor = o.newCursor();\r
330 if (cursor.toFirstChild()) {\r
331 for (int j = 0; j < i; ++j) {\r
332 cursor.toNextSibling();\r
333 }\r
334 LibraryClassDeclarationsDocument.LibraryClassDeclarations.LibraryClass lc = (LibraryClassDeclarationsDocument.LibraryClassDeclarations.LibraryClass)cursor.getObject();\r
335 lc.setName(lib);\r
336 lc.setIncludeHeader(hdr);\r
337 lc.setHelpText(hlp);\r
338 if (clsUsage != null) {\r
97796eaa 339 lc.setRecommendedInstanceGuid(clsUsage);\r
340 if (instanceVer != null){\r
a13899c5 341 lc.setRecommendedInstanceVersion(instanceVer);\r
97796eaa 342 } else {\r
322b7723 343 if (lc.isSetRecommendedInstanceVersion()) {\r
344 lc.unsetRecommendedInstanceVersion();\r
345 }\r
97796eaa 346 }\r
347 } else {\r
322b7723 348 if (lc.isSetRecommendedInstanceGuid()) {\r
349 lc.unsetRecommendedInstanceGuid();\r
350 }\r
a13899c5 351 }\r
97796eaa 352\r
a13899c5 353 if (stringToList(hdrAttribArch) != null){\r
97796eaa 354 lc.setSupArchList(stringToList(hdrAttribArch));\r
355 } else {\r
322b7723 356 if (lc.isSetSupArchList()) {\r
357 lc.unsetSupArchList();\r
358 }\r
a13899c5 359 }\r
360 if (stringToList(hdrAttribModType) != null){\r
97796eaa 361 lc.setSupModuleList(stringToList(hdrAttribModType));\r
362 } else {\r
322b7723 363 if (lc.isSetSupModuleList()) {\r
364 lc.unsetSupModuleList();\r
365 }\r
a13899c5 366 }\r
367 }\r
368 \r
369 cursor.dispose();\r
370 }\r
371 \r
372 public void updateSpdMsaFile(int i, String msaFile, String mName, String v, String g){\r
373 XmlObject o = psaRoot.getMsaFiles();\r
374 if (o == null)\r
375 return;\r
376 \r
377 XmlCursor cursor = o.newCursor();\r
378 if (cursor.toFirstChild()) {\r
379 for (int j = 0; j < i; ++j) {\r
380 cursor.toNextSibling();\r
381 }\r
382 cursor.setTextValue(msaFile);\r
383\r
384 }\r
385 \r
386 cursor.dispose();\r
387 }\r
388\r
389 public void updateSpdGuidDecl(int i, String name, String cName, String guid, String hlp, String archList, \r
390 String modTypeList, String guidTypeList){\r
391 XmlObject o = psaRoot.getGuidDeclarations();\r
392 if (o == null){\r
393 return;\r
394 }\r
395 \r
396 XmlCursor cursor = o.newCursor();\r
397 if (cursor.toFirstChild()) {\r
398 for (int j = 0; j < i; ++j) {\r
399 cursor.toNextSibling();\r
400 }\r
401 GuidDeclarationsDocument.GuidDeclarations.Entry e = (GuidDeclarationsDocument.GuidDeclarations.Entry)cursor.getObject();\r
402 e.setName(name);\r
403 e.setCName(cName);\r
404 e.setGuidValue(guid);\r
405 e.setHelpText(hlp);\r
ce73a791 406 if (stringToList(guidTypeList) != null) {\r
322b7723 407 e.setGuidTypeList(stringToList(guidTypeList));\r
a13899c5 408 }\r
ce73a791 409 else{\r
322b7723 410 if (e.isSetGuidTypeList()) {\r
97796eaa 411 e.unsetGuidTypeList();\r
322b7723 412 }\r
ce73a791 413 }\r
a13899c5 414 if (stringToList(archList) != null){\r
415 e.setSupArchList(stringToList(archList));\r
416 }\r
ce73a791 417 else{\r
322b7723 418 if (e.isSetSupArchList()) {\r
97796eaa 419 e.unsetSupArchList();\r
322b7723 420 }\r
ce73a791 421 }\r
a13899c5 422 if (stringToList(modTypeList) != null) {\r
423 e.setSupModuleList(stringToList(modTypeList));\r
424 }\r
ce73a791 425 else{\r
322b7723 426 if (e.isSetSupModuleList()) {\r
97796eaa 427 e.unsetSupModuleList();\r
322b7723 428 }\r
ce73a791 429 }\r
a13899c5 430 \r
431 }\r
432 cursor.dispose();\r
433 }\r
434 \r
435 public void updateSpdPpiDecl(int i, String name, String cName, String guid, String hlp, String archList, \r
436 String modTypeList){\r
437 XmlObject o = psaRoot.getPpiDeclarations();\r
438 if (o == null){\r
439 return;\r
440 }\r
441 \r
442 XmlCursor cursor = o.newCursor();\r
443 if (cursor.toFirstChild()) {\r
444 for (int j = 0; j < i; ++j) {\r
445 cursor.toNextSibling();\r
446 }\r
447 PpiDeclarationsDocument.PpiDeclarations.Entry e = (PpiDeclarationsDocument.PpiDeclarations.Entry)cursor.getObject();\r
448 e.setName(name);\r
449 e.setCName(cName);\r
450 e.setGuidValue(guid);\r
451 e.setHelpText(hlp);\r
452 if (stringToList(archList) != null){\r
453 e.setSupArchList(stringToList(archList));\r
454 }\r
ce73a791 455 else{\r
322b7723 456 if (e.isSetSupArchList()) {\r
97796eaa 457 e.unsetSupArchList();\r
322b7723 458 }\r
ce73a791 459 }\r
a13899c5 460 if (stringToList(modTypeList) != null) {\r
461 e.setSupModuleList(stringToList(modTypeList));\r
462 }\r
ce73a791 463 else{\r
322b7723 464 if (e.isSetSupModuleList()) {\r
97796eaa 465 e.unsetSupModuleList();\r
322b7723 466 }\r
ce73a791 467 }\r
a13899c5 468 }\r
469 cursor.dispose();\r
470 }\r
471 \r
472 public void updateSpdProtocolDecl(int i, String name, String cName, String guid, String hlp, String archList, \r
473 String modTypeList){\r
474 XmlObject o = psaRoot.getProtocolDeclarations();\r
475 if (o == null){\r
476 return;\r
477 }\r
478 \r
479 XmlCursor cursor = o.newCursor();\r
480 if (cursor.toFirstChild()) {\r
481 for (int j = 0; j < i; ++j) {\r
482 cursor.toNextSibling();\r
483 }\r
484 ProtocolDeclarationsDocument.ProtocolDeclarations.Entry e = (ProtocolDeclarationsDocument.ProtocolDeclarations.Entry)cursor.getObject();\r
485 e.setName(name);\r
486 e.setCName(cName);\r
487 e.setGuidValue(guid);\r
488 e.setHelpText(hlp);\r
489 if (stringToList(archList) != null){\r
490 e.setSupArchList(stringToList(archList));\r
491 }\r
ce73a791 492 else{\r
322b7723 493 if (e.isSetSupArchList()) {\r
97796eaa 494 e.unsetSupArchList();\r
322b7723 495 }\r
ce73a791 496 }\r
a13899c5 497 if (stringToList(modTypeList) != null) {\r
498 e.setSupModuleList(stringToList(modTypeList));\r
499 }\r
ce73a791 500 else{\r
322b7723 501 if (e.isSetSupModuleList()) {\r
97796eaa 502 e.unsetSupModuleList();\r
322b7723 503 }\r
ce73a791 504 }\r
a13899c5 505 }\r
506 cursor.dispose();\r
507 }\r
508 \r
509 public void updateSpdPkgHdr(int i, String pkgName, String hdrName){\r
510 XmlObject o = psaRoot.getPackageHeaders();\r
511 if (o == null){\r
512 return;\r
513 }\r
514 \r
515 XmlCursor cursor = o.newCursor();\r
516 if (cursor.toFirstChild()) {\r
517 for (int j = 0; j < i; ++j) {\r
518 cursor.toNextSibling();\r
519 }\r
520 \r
521 PackageHeadersDocument.PackageHeaders.IncludePkgHeader iph = (PackageHeadersDocument.PackageHeaders.IncludePkgHeader)cursor.getObject();\r
522 iph.setModuleType(ModuleTypeDef.Enum.forString(pkgName));\r
523 iph.setStringValue(hdrName);\r
524 }\r
525 cursor.dispose();\r
526 }\r
527 \r
528 public void updateSpdPcdDefinition(int i, String cName, String token, String dataType, String pcdItemTypes, \r
529 String spaceGuid, String defaultString, String help, String archList, String modTypeList){\r
530 XmlObject o = psaRoot.getPcdDeclarations();\r
531 if (o == null)\r
532 return;\r
533 XmlCursor cursor = o.newCursor();\r
534 if (cursor.toFirstChild()) {\r
535 for (int j = 0; j < i; ++j) {\r
536 cursor.toNextSibling();\r
537 }\r
538 PcdDeclarationsDocument.PcdDeclarations.PcdEntry e = (PcdDeclarationsDocument.PcdDeclarations.PcdEntry)cursor.getObject();\r
539 e.setCName(cName);\r
540 e.setToken(token);\r
541 e.setDatumType(PcdDataTypes.Enum.forString(dataType));\r
542 if (pcdItemTypes != null && pcdItemTypes.length() > 0) {\r
543 String usage[] = pcdItemTypes.split("( )+");\r
544 List<String> l = new ArrayList<String>();\r
545 for (int k = 0; k < usage.length; ++k) {\r
546 l.add(usage[k]); \r
547 }\r
548 e.setValidUsage(l);\r
549 }\r
550 \r
551 e.setTokenSpaceGuidCName(spaceGuid);\r
552 e.setDefaultValue(defaultString);\r
553 e.setHelpText(help);\r
554 if (archList != null && archList.length() > 0){\r
555 e.setSupArchList(stringToList(archList));\r
556 }\r
557 if (modTypeList != null && modTypeList.length() > 0){\r
558 e.setSupModuleList(stringToList(modTypeList));\r
559 }\r
560 } \r
561 cursor.dispose();\r
562 }\r
563 /**\r
564 Get spd file header contents into String array\r
565 \r
566 @param s Caller allocated String array\r
567 **/\r
568 public void getSpdHdrDetails(String[] s) {\r
569 if (getSpdHdr() == null) {\r
570 spdHdr = psaRoot.addNewSpdHeader();\r
571 }\r
572 s[0] = getSpdHdrPkgName();\r
573 s[1] = getSpdHdr().getGuidValue();\r
574 s[2] = getSpdHdrVer();\r
575// s[3] = getSpdHdr().getAbstract();\r
576 s[4] = getSpdHdr().getDescription();\r
577 s[5] = getSpdHdr().getCopyright();\r
578 s[6] = getSpdHdrLicense();\r
579 \r
580 }\r
581\r
582 /**\r
583 Get the number of library class declarations from the size of List\r
584 \r
585 @return int\r
586 **/\r
587 public int getSpdLibClassDeclarationCount() {\r
588 if (psaRoot.getLibraryClassDeclarations() == null\r
589 || psaRoot.getLibraryClassDeclarations().getLibraryClassList() == null) {\r
590 return 0;\r
591 }\r
592 return psaRoot.getLibraryClassDeclarations().getLibraryClassList().size();\r
593 }\r
594\r
595 /**\r
596 Get available library class declaration into String array\r
597 @param libClass Caller allocated two-dimentional String array\r
598 **/\r
599 public void getSpdLibClassDeclarations(String[][] libClass) {\r
600 if (psaRoot.getLibraryClassDeclarations() == null){\r
601 return;\r
602 }\r
603 \r
604 List<LibraryClassDeclarationsDocument.LibraryClassDeclarations.LibraryClass> l = psaRoot.getLibraryClassDeclarations().getLibraryClassList();\r
605 int i = 0;\r
606 ListIterator li = l.listIterator();\r
607 while (li.hasNext()) {\r
608 LibraryClassDeclarationsDocument.LibraryClassDeclarations.LibraryClass lc = (LibraryClassDeclarationsDocument.LibraryClassDeclarations.LibraryClass) li.next();\r
609 if (lc != null) {\r
610 libClass[i][0] = lc.getName();\r
611 libClass[i][1] = lc.getIncludeHeader();\r
612 libClass[i][2] = lc.getHelpText();\r
2f8a7517 613// LAH added logic so you cannot set the version unless the GUID is defined.\r
97796eaa 614/* LAH do not set now\r
2f8a7517 615 if (lc.getRecommendedInstanceGuid() != null) {\r
616 libClass[i][3] = lc.getRecommendedInstanceGuid();\r
617 if (lc.getRecommendedInstanceVersion() != null) {\r
618 libClass[i][4] = lc.getRecommendedInstanceVersion();\r
619 }\r
620 }\r
97796eaa 621*/\r
a13899c5 622 if (lc.getSupArchList() != null) {\r
623 libClass[i][5] = listToString(lc.getSupArchList());\r
624 }\r
625 if (lc.getSupModuleList() != null) {\r
626 libClass[i][6] = listToString(lc.getSupModuleList());\r
627 }\r
628 \r
629 }\r
630 \r
631 i++;\r
632 }\r
633\r
634 }\r
635 \r
636 /**\r
637 Get the number of Msa files from the size of List\r
638 \r
639 @return int\r
640 **/\r
641 public int getSpdMsaFileCount() {\r
642 if (psaRoot.getMsaFiles() == null || psaRoot.getMsaFiles().getFilenameList() == null) {\r
643 return 0;\r
644 }\r
645 return psaRoot.getMsaFiles().getFilenameList().size();\r
646 }\r
647 \r
648 /**\r
649 Get available Msa file into String array\r
650 \r
651 @param msaFile Caller allocated two-dimentional String array\r
652 **/\r
653 public void getSpdMsaFiles(String[][] msaFile) {\r
654 if (psaRoot.getMsaFiles() == null) {\r
655 return;\r
656 }\r
657 List<String> l = psaRoot.getMsaFiles().getFilenameList();\r
658 int i = 0;\r
659 ListIterator li = l.listIterator();\r
660 while (li.hasNext()) {\r
661 msaFile[i][0] = (String)li.next();\r
662\r
663 i++;\r
664 }\r
665 }\r
666\r
667 /**\r
668 Get the number of include header files in PackageHeaders from the size of List\r
669 \r
670 @return int\r
671 **/\r
672 public int getSpdPackageHeaderCount() {\r
673 if (psaRoot.getPackageHeaders() == null || psaRoot.getPackageHeaders().getIncludePkgHeaderList() == null) {\r
674 return 0;\r
675 }\r
676 return psaRoot.getPackageHeaders().getIncludePkgHeaderList().size();\r
677 }\r
678\r
679 /**\r
680 Get available package header contents into String array\r
681 \r
682 @param pkgHeader Caller allocated two-dimentional String array\r
683 **/\r
684 public void getSpdPackageHeaders(String[][] pkgHeader) {\r
685 if (psaRoot.getPackageHeaders() == null) {\r
686 return;\r
687 }\r
688 \r
689 List<PackageHeadersDocument.PackageHeaders.IncludePkgHeader> l = psaRoot.getPackageHeaders().getIncludePkgHeaderList();\r
690 int i = 0;\r
691 ListIterator li = l.listIterator();\r
692 while (li.hasNext()) {\r
693 PackageHeadersDocument.PackageHeaders.IncludePkgHeader ih = (PackageHeadersDocument.PackageHeaders.IncludePkgHeader) li.next();\r
694 if (ih.getModuleType() != null) {\r
695 pkgHeader[i][0] = ih.getModuleType().toString();\r
696 }\r
697\r
698 pkgHeader[i][1] = ih.getStringValue();\r
699 i++;\r
700 }\r
701 }\r
702\r
703 /**\r
704 Get the number of GUID declarations from the size of List\r
705 \r
706 @return int\r
707 **/\r
708 public int getSpdGuidDeclarationCount() {\r
709 if (psaRoot.getGuidDeclarations() == null || psaRoot.getGuidDeclarations().getEntryList() == null) {\r
710 return 0;\r
711 }\r
712 return psaRoot.getGuidDeclarations().getEntryList().size();\r
713 }\r
714\r
715 /**\r
716 Get available Guid declaration contents into String array\r
717 \r
718 @param guid Caller allocated two-dimentional String array\r
719 **/\r
720 public void getSpdGuidDeclarations(String[][] guid) {\r
721 if (psaRoot.getGuidDeclarations() == null) {\r
722 return;\r
723 }\r
724 \r
725 List<GuidDeclarationsDocument.GuidDeclarations.Entry> l = psaRoot.getGuidDeclarations().getEntryList();\r
726 int i = 0;\r
727 ListIterator li = l.listIterator();\r
728 while (li.hasNext()) {\r
729 GuidDeclarationsDocument.GuidDeclarations.Entry e = (GuidDeclarationsDocument.GuidDeclarations.Entry) li\r
730 .next();\r
731 guid[i][0] = e.getName();\r
732 guid[i][1] = e.getCName();\r
733 if (e.getGuidValue() != null) {\r
734 guid[i][2] = e.getGuidValue();\r
735 }\r
736 guid[i][3] = e.getHelpText();\r
737 guid[i][4] = listToString(e.getSupArchList());\r
738 guid[i][5] = listToString(e.getSupModuleList());\r
739 guid[i][6] = listToString(e.getGuidTypeList());\r
740 i++;\r
741 }\r
742 }\r
743\r
744 /**\r
745 Get the number of protocol declarations from the size of List\r
746 \r
747 @return int\r
748 **/\r
749 public int getSpdProtocolDeclarationCount() {\r
750 if (psaRoot.getProtocolDeclarations() == null || psaRoot.getProtocolDeclarations().getEntryList() == null) {\r
751 return 0;\r
752 }\r
753 return psaRoot.getProtocolDeclarations().getEntryList().size();\r
754 }\r
755\r
756 /**\r
757 Get available protocol declaration contents into String array\r
758 \r
759 @param protocol Caller allocated two-dimentional String array\r
760 **/\r
761 public void getSpdProtocolDeclarations(String[][] protocol) {\r
762 if (psaRoot.getProtocolDeclarations() == null) {\r
763 return;\r
764 }\r
765 \r
766 List<ProtocolDeclarationsDocument.ProtocolDeclarations.Entry> l = psaRoot.getProtocolDeclarations()\r
767 .getEntryList();\r
768 int i = 0;\r
769 ListIterator li = l.listIterator();\r
770 while (li.hasNext()) {\r
771 ProtocolDeclarationsDocument.ProtocolDeclarations.Entry e = (ProtocolDeclarationsDocument.ProtocolDeclarations.Entry) li\r
772 .next();\r
773 protocol[i][0] = e.getName();\r
774 protocol[i][1] = e.getCName();\r
775 if (e.getGuidValue() != null) {\r
776 protocol[i][2] = e.getGuidValue();\r
777 }\r
778 protocol[i][3] = e.getHelpText();\r
779 protocol[i][4] = listToString(e.getSupArchList());\r
780 protocol[i][5] = listToString(e.getSupModuleList());\r
781 i++;\r
782 }\r
783 }\r
784\r
785 /**\r
786 Get the number of Ppi declarations from the size of List\r
787 \r
788 @return int\r
789 **/\r
790 public int getSpdPpiDeclarationCount() {\r
791 if (psaRoot.getPpiDeclarations() == null || psaRoot.getPpiDeclarations().getEntryList() == null) {\r
792 return 0;\r
793 }\r
794 return psaRoot.getPpiDeclarations().getEntryList().size();\r
795 }\r
796\r
797 /**\r
798 Get available Ppi declaration contents into String array\r
799 \r
800 @param ppi Caller allocated two-dimentional String array\r
801 **/\r
802 public void getSpdPpiDeclarations(String[][] ppi) {\r
803 if (psaRoot.getPpiDeclarations() == null) {\r
804 return;\r
805 }\r
806 \r
807 List<PpiDeclarationsDocument.PpiDeclarations.Entry> l = psaRoot.getPpiDeclarations().getEntryList();\r
808 int i = 0;\r
809 ListIterator li = l.listIterator();\r
810 while (li.hasNext()) {\r
811 PpiDeclarationsDocument.PpiDeclarations.Entry e = (PpiDeclarationsDocument.PpiDeclarations.Entry) li.next();\r
812 ppi[i][0] = e.getName();\r
813 ppi[i][1] = e.getCName();\r
814 if (e.getGuidValue() != null) {\r
815 ppi[i][2] = e.getGuidValue();\r
816 }\r
817 ppi[i][3] = e.getHelpText();\r
818 ppi[i][4] = listToString(e.getSupArchList());\r
819 ppi[i][5] = listToString(e.getSupModuleList());\r
820\r
821 i++;\r
822 }\r
823 }\r
824\r
825 /**\r
826 Get the number of Pcd definitions from the size of List\r
827 \r
828 @return int\r
829 **/\r
830 public int getSpdPcdDefinitionCount() {\r
831 if (psaRoot.getPcdDeclarations() == null || psaRoot.getPcdDeclarations().getPcdEntryList() == null) {\r
832 return 0;\r
833 }\r
834 return psaRoot.getPcdDeclarations().getPcdEntryList().size();\r
835 }\r
836\r
837 /**\r
838 Get available Pcd definition contents into String array\r
839 \r
840 @param pcd Caller allocated two-dimentional String array\r
841 **/\r
842 public void getSpdPcdDefinitions(String[][] pcd, String pcdUsage[][]) {\r
843 if (psaRoot.getPcdDeclarations() == null) {\r
844 return;\r
845 }\r
846 \r
847 List<PcdDeclarationsDocument.PcdDeclarations.PcdEntry> l = psaRoot.getPcdDeclarations().getPcdEntryList();\r
848 int i = 0;\r
849 while (i < l.size()) {\r
850 PcdDeclarationsDocument.PcdDeclarations.PcdEntry e = (PcdDeclarationsDocument.PcdDeclarations.PcdEntry)l.get(i);\r
851 pcd[i][0] = e.getCName();\r
852 pcd[i][1] = e.getToken() + ""; \r
853 pcd[i][2] = e.getTokenSpaceGuidCName();\r
854 if (e.getDatumType() != null) {\r
855 pcd[i][3] = e.getDatumType().toString();\r
856 }\r
857 pcd[i][4] = e.getDefaultValue()+"";\r
858 pcd[i][5] = e.getHelpText();\r
859 String archList = listToString(e.getSupArchList());\r
860 if (archList != null) {\r
861 pcd[i][6] = archList;\r
862 }\r
863 String modTypeList = listToString(e.getSupModuleList());\r
864 if (modTypeList != null) {\r
865 pcd[i][7] = modTypeList;\r
866 }\r
867 \r
868 int j = 0;\r
869 while (j < e.getValidUsage().size() && j < 5) {\r
870 pcdUsage[i][j] = (String)e.getValidUsage().get(j);\r
871 ++j;\r
872 }\r
873 i++;\r
874 }\r
875 }\r
876\r
877 /**\r
878 Save the processed xml contents to file\r
879 \r
880 @param spdFile The file to save xml contents\r
881 @throws IOException Exceptions during file operation\r
882 **/\r
883 public void saveAs(File spdFile) throws IOException {\r
884\r
885 XmlOptions options = new XmlOptions();\r
886\r
887 options.setCharacterEncoding("UTF-8");\r
888 options.setSavePrettyPrint();\r
889 options.setSavePrettyPrintIndent(2);\r
890 try {\r
891 psad.save(spdFile, options);\r
892 } catch (IOException e) {\r
893 e.printStackTrace();\r
894 }\r
895\r
896 }\r
897\r
898 /**\r
899 Generate SpdHeader contents using parameters passed in.\r
900 \r
901 @param pkgName PackageName \r
902 @param pkgGuid Guid\r
903 @param pkgVer Version\r
904 @param pkgAbs Abstract\r
905 @param pkgDes Description\r
906 @param pkgCpRight Copyright\r
907 @param pkgLicense License\r
908 @param pkgCreateDate Created\r
909 @param pkgUpdateDate Updated\r
910 @param pkgURL URL\r
911 @param pkgType PackageType\r
912 @param pkgRdOnly ReadOnly\r
913 @param pkgRePkg RePackage\r
914 @param pkgSpec Reserved\r
915 @param pkgOutDir Reserved\r
916 **/\r
917 public void genSpdHeader(String pkgName, String pkgGuid, String pkgVer, String pkgAbs, String pkgDes,\r
918 String pkgCpRight, String pkgLicense, String pkgCreateDate, String pkgUpdateDate,\r
919 String pkgURL, String pkgType, String pkgRdOnly, String pkgRePkg, String pkgSpec,\r
920 String pkgOutDir) {\r
921 if (getSpdHdr() == null) {\r
922 spdHdr = psaRoot.addNewSpdHeader();\r
923 }\r
924\r
925 setSpdHdrPkgName(pkgName);\r
926 setSpdHdrGuidValue(pkgGuid);\r
927 setSpdHdrVer(pkgVer);\r
928 setSpdHdrAbs(pkgAbs);\r
929 setSpdHdrDescription(pkgDes);\r
930 setSpdHdrCopyright(pkgCpRight);\r
931 setSpdHdrLicense(pkgLicense);\r
932 \r
933\r
934 setSpdHdrSpec(pkgSpec);\r
935 }\r
936\r
937 /**\r
938 Generate library class declaration element using parameters passed in\r
939 \r
940 @param libClassBaseName LibraryClass element value\r
941 @param libClassUsage Reserved\r
942 @param incHdrFileName IncludeHeader element value\r
943 @param incHdrAttribGuid Reserved\r
944 @param incHdrAttribArch Reserved\r
945 @param incHdrAttribPath Reserved\r
946 @param incHdrAttribClass Reserved\r
947 @param incHdrAttribVer Reserved\r
948 @param incHdrAttribOverrideID Reserved\r
949 @param incHdrAttribModuleType Reserved\r
950 **/\r
951 public void genSpdLibClassDeclarations(String libClassBaseName, String instanceUsage, String incHdrFileName,\r
952 String help, String incHdrAttribArch, String incHdrAttribPath,\r
953 String incHdrAttribClass, String incHdrAttribVer,\r
954 String incHdrAttribOverrideID, String incHdrAttribModuleType) {\r
955 if (getSpdLibClassDeclarations() == null) {\r
956 spdLibClassDeclarations = psaRoot.addNewLibraryClassDeclarations();\r
957 }\r
958 //\r
959 // add contents under LibraryClassDeclarations tag \r
960 //\r
961 setSpdLibClassDeclaration(libClassBaseName, instanceUsage, incHdrFileName, help, incHdrAttribArch,\r
962 incHdrAttribPath, incHdrAttribClass, incHdrAttribVer, incHdrAttribOverrideID,\r
963 incHdrAttribModuleType, spdLibClassDeclarations);\r
964 }\r
965\r
966 /**\r
967 Set library class declaration contents under parent tag\r
968 \r
969 @param clsName LibraryClass element value\r
970 @param clsUsage Reserved\r
971 @param hdrFile IncludeHeader element value\r
972 @param hdrAttribGuid Reserved\r
973 @param hdrAttribArch Reserved\r
974 @param hdrAttribPath Reserved\r
975 @param hdrAttribClass Reserved\r
976 @param hdrAttribVer Reserved\r
977 @param hdrAttribOverID Reserved\r
978 @param hdrAttribModType Reserved\r
979 @param parent The tag under which library class declaration goes to\r
980 **/\r
981 public void setSpdLibClassDeclaration(String clsName, String clsUsage, String hdrFile, String help,\r
982 String hdrAttribArch, String hdrAttribPath, String hdrAttribClass,\r
983 String instanceVer, String hdrAttribOverID, String hdrAttribModType,\r
984 XmlObject parent) {\r
985\r
986 setSpdLibraryClass(clsName, hdrFile, help, clsUsage, instanceVer, hdrAttribArch, hdrAttribModType, parent);\r
987\r
988 }\r
989\r
990 /**\r
991 Set the contents of LibraryClass under parent element\r
992 \r
993 @param clsName LibraryClass element value \r
994 @param clsUsage Reserved\r
995 @param parent The tag under which library class declaration goes to\r
996 **/\r
997 public void setSpdLibraryClass(String clsName, String clsIncludeFile, String help, String clsUsage, String instanceVer, String hdrAttribArch, String hdrAttribModType, XmlObject parent) {\r
998 LibraryClassDeclarationsDocument.LibraryClassDeclarations.LibraryClass lc = ((LibraryClassDeclarationsDocument.LibraryClassDeclarations) parent).addNewLibraryClass();\r
999 lc.setName(clsName);\r
1000 lc.setIncludeHeader(clsIncludeFile);\r
1001 lc.setHelpText(help);\r
2f8a7517 1002// LAH added logic so you cannot set the version unless the GUID is defined.\r
97796eaa 1003/* LAH\r
2f8a7517 1004 if (clsUsage != null) {\r
1005 lc.setRecommendedInstanceGuid(clsUsage);\r
1006 if (instanceVer != null) {\r
1007 lc.setRecommendedInstanceVersion(instanceVer);\r
1008 }\r
1009 }\r
97796eaa 1010*/\r
a13899c5 1011 if (hdrAttribArch != null) {\r
1012 lc.setSupArchList(stringToList(hdrAttribArch));\r
322b7723 1013 } else {\r
1014 if (lc.isSetSupArchList()) {\r
1015 lc.unsetSupArchList();\r
1016 }\r
a13899c5 1017 }\r
322b7723 1018\r
a13899c5 1019 if (hdrAttribModType != null) {\r
97796eaa 1020 lc.setSupModuleList(stringToList(hdrAttribModType));\r
1021 } else {\r
322b7723 1022 if (lc.isSetSupModuleList()) {\r
1023 lc.unsetSupModuleList();\r
1024 }\r
a13899c5 1025 }\r
1026 \r
1027 }\r
1028\r
1029 /**\r
1030 Set contents of IncludeHeader under parent element\r
1031 \r
1032 @param modType Reserved\r
1033 @param hdrFile IncludeHeader element value\r
1034 @param hdrAttribGuid Reserved\r
1035 @param hdrAttribArch Reserved\r
1036 @param hdrAttribPath Reserved\r
1037 @param hdrAttribClass Reserved\r
1038 @param hdrAttribVer Reserved\r
1039 @param hdrAttribOverID Reserved\r
1040 @param parent The tag under which library class declaration goes to\r
1041 **/\r
1042 public void setSpdIncludeHeader(String modType, String hdrFile, String hdrAttribGuid, String hdrAttribArch,\r
1043 String hdrAttribPath, String hdrAttribClass, String hdrAttribVer,\r
1044 String hdrAttribOverID, XmlObject parent) {\r
1045 \r
1046 if (parent instanceof LibraryClassDeclarationsDocument.LibraryClassDeclarations) {\r
1047 } else if (parent instanceof PackageHeadersDocument.PackageHeaders) {\r
1048 PackageHeadersDocument.PackageHeaders.IncludePkgHeader ih = null;\r
1049 ih = ((PackageHeadersDocument.PackageHeaders) parent).addNewIncludePkgHeader();\r
1050 ih.setStringValue(hdrFile);\r
1051 ih.setModuleType(ModuleTypeDef.Enum.forString(modType));\r
1052 } else {\r
1053 return;\r
1054 }\r
1055\r
1056 if (hdrAttribGuid != null) {\r
1057 }\r
1058 if (hdrAttribPath != null) {\r
1059 }\r
1060 if (hdrAttribClass != null) {\r
1061 }\r
1062 if (hdrAttribVer != null) {\r
1063 }\r
1064 if (hdrAttribOverID != null) {\r
1065 }\r
1066\r
1067 }\r
1068\r
1069 /**\r
1070 Generate MsaFile element.\r
1071 \r
1072 @param msaFileName MsaFile element value\r
1073 @param archType Reserved\r
1074 **/\r
1075 public void genSpdMsaFiles(String msaFileName, String moduleName, String ver, String guid) {\r
1076 if (getSpdMsaFiles() == null) {\r
1077 spdMsaFiles = psaRoot.addNewMsaFiles();\r
1078 }\r
1079 setSpdMsaFile(msaFileName, moduleName, ver, guid, spdMsaFiles);\r
1080 \r
1081 }\r
1082\r
1083 /**\r
1084 Set MsaFile contents under parent element.\r
1085 \r
1086 @param msaFileName MsaFile element value\r
1087 @param parent Element under which MsaFile goes to\r
1088 **/\r
1089 public void setSpdMsaFile(String msaFileName, String moduleName, String ver, String guid, XmlObject parent) {\r
1090 MsaFilesDocument.MsaFiles f = (MsaFilesDocument.MsaFiles)parent;\r
1091 f.addNewFilename().setStringValue(msaFileName);\r
1092// f.setFilename(msaFileName);\r
1093// f.setModuleName(moduleName);\r
1094// f.setModuleVersion(ver);\r
1095// f.setModuleGuid(guid);\r
1096 }\r
1097\r
1098 /**\r
1099 Generate PackageHeader element using parameters passed in.\r
1100 \r
1101 @param ModHdrModType ModuleType attribute of IncludeHeader element\r
1102 @param hdrFile IncludeHeader element value\r
1103 @param hdrAttribGuid Reserved\r
1104 @param hdrAttribArch Reserved\r
1105 @param hdrAttribPath Reserved\r
1106 @param hdrAttribClass Reserved\r
1107 @param hdrAttribVer Reserved\r
1108 @param hdrAttribOverID Reserved\r
1109 **/\r
1110 public void genSpdModuleHeaders(String ModHdrModType, String hdrFile, String hdrAttribGuid, String hdrAttribArch,\r
1111 String hdrAttribPath, String hdrAttribClass, String hdrAttribVer,\r
1112 String hdrAttribOverID) {\r
1113 if (getSpdModHdrs() == null) {\r
1114 spdModHdrs = psaRoot.addNewPackageHeaders();\r
1115 }\r
1116\r
1117 //\r
1118 // add IncludeHeader under PackageHeaders element\r
1119 //\r
1120 setSpdIncludeHeader(ModHdrModType, hdrFile, hdrAttribGuid, hdrAttribArch, hdrAttribPath, hdrAttribClass,\r
1121 hdrAttribVer, hdrAttribOverID, spdModHdrs);\r
1122 }\r
1123\r
1124 /**\r
1125 Generate GUID declaration element using parameters passed in.\r
1126 \r
1127 @param guidDeclEntryName Name attribute of Entry element\r
1128 @param guidDeclCName CName element value\r
1129 @param guidDeclGuid Guid element value\r
1130 @param guidDeclFeatureFlag Reserved\r
1131 **/\r
1132 public void genSpdGuidDeclarations(String guidDeclEntryName, String guidDeclCName, String guidDeclGuid,\r
1133 String guidDeclHelp, Vector<String> archList, Vector<String> modTypeList,\r
1134 Vector<String> guidTypeList) {\r
1135 if (getSpdGuidDeclarations() == null) {\r
1136 spdGuidDeclarations = psaRoot.addNewGuidDeclarations();\r
1137 }\r
1138\r
1139 setSpdEntry(guidDeclEntryName, guidDeclCName, guidDeclGuid, guidDeclHelp, archList, modTypeList, guidTypeList, spdGuidDeclarations);\r
1140 }\r
1141\r
1142 /**\r
1143 Generate protocol declaration element using parameters passed in.\r
1144 \r
1145 @param protocolDeclEntryName Name attribute of Entry element\r
1146 @param protocolDeclCName CName element value\r
1147 @param protocolDeclGuid Guid element value\r
1148 @param protocolDeclFeatureFlag Reserved\r
1149 **/\r
1150 public void genSpdProtocolDeclarations(String protocolDeclEntryName, String protocolDeclCName,\r
1151 String protocolDeclGuid, String protocolDeclFeatureFlag,\r
1152 Vector<String> archList, Vector<String> modTypeList) {\r
1153 if (getSpdProtocolDeclarations() == null) {\r
1154 spdProtocolDeclarations = psaRoot.addNewProtocolDeclarations();\r
1155 }\r
1156\r
1157 setSpdEntry(protocolDeclEntryName, protocolDeclCName, protocolDeclGuid, protocolDeclFeatureFlag,\r
1158 archList, modTypeList, null, spdProtocolDeclarations);\r
1159 }\r
1160\r
1161 /**\r
1162 Generate PPI declaration element using parameters passed in.\r
1163 \r
1164 @param ppiDeclEntryName Name attribute of Entry element\r
1165 @param ppiDeclCName CName element value\r
1166 @param ppiDeclGuid Guid element value\r
1167 @param ppiDeclFeatureFlag Reserved\r
1168 **/\r
1169 public void genSpdPpiDeclarations(String ppiDeclEntryName, String ppiDeclCName, String ppiDeclGuid,\r
1170 String ppiDeclFeatureFlag, Vector<String> archList, Vector<String> modTypeList) {\r
1171 if (getSpdPpiDeclarations() == null) {\r
1172 spdPpiDeclarations = psaRoot.addNewPpiDeclarations();\r
1173 }\r
1174\r
1175 setSpdEntry(ppiDeclEntryName, ppiDeclCName, ppiDeclGuid, ppiDeclFeatureFlag, archList, modTypeList, null, spdPpiDeclarations);\r
1176 }\r
1177\r
1178 /**\r
1179 Set Entry contents using parameters passed in\r
1180 \r
1181 @param entryName Name attribute of Entry element\r
1182 @param cName CName element value\r
1183 @param guid Guid element value\r
1184 @param featureFlag Reserved\r
1185 @param parent The tag under which Entry element goes to\r
1186 **/\r
1187 public void setSpdEntry(String entryName, String cName, String guid, String help, \r
1188 Vector<String> archList, Vector<String> modTypeList,\r
1189 Vector<String> guidTypeList, XmlObject parent) {\r
1190\r
1191 if (parent instanceof GuidDeclarationsDocument.GuidDeclarations) {\r
1192 GuidDeclarationsDocument.GuidDeclarations.Entry e = ((GuidDeclarations) parent).addNewEntry();\r
1193 e.setName(entryName);\r
1194 e.setCName(cName);\r
1195 e.setGuidValue(guid);\r
1196 e.setHelpText(help);\r
ce73a791 1197 e.setGuidTypeList(guidTypeList);\r
1198 e.setSupArchList(archList);\r
1199 e.setSupModuleList(modTypeList);\r
1200// if (guidTypeList != null && guidTypeList.size() > 0) {\r
1201// e.setGuidTypeList(new ArrayList<String>(guidTypeList));\r
1202// }\r
1203// if (archList != null && archList.size() > 0){\r
1204// e.setSupArchList(new ArrayList<String>(archList));\r
1205// }\r
1206// if (modTypeList != null && modTypeList.size() > 0) {\r
1207// e.setSupModuleList(new ArrayList<String>(modTypeList));\r
1208// }\r
a13899c5 1209 return;\r
1210 }\r
1211 if (parent instanceof ProtocolDeclarationsDocument.ProtocolDeclarations) {\r
1212 ProtocolDeclarationsDocument.ProtocolDeclarations.Entry pe = ((ProtocolDeclarationsDocument.ProtocolDeclarations) parent)\r
1213 .addNewEntry();\r
1214 pe.setName(entryName);\r
1215 pe.setCName(cName);\r
1216 pe.setGuidValue(guid);\r
1217 pe.setHelpText(help);\r
ce73a791 1218 pe.setSupArchList(archList);\r
1219 pe.setSupModuleList(modTypeList);\r
1220// if (archList != null && archList.size() > 0){\r
1221// pe.setSupArchList(new ArrayList<String>(archList));\r
1222// }\r
1223// if (modTypeList != null && modTypeList.size() > 0) {\r
1224// pe.setSupModuleList(new ArrayList<String>(modTypeList));\r
1225// }\r
a13899c5 1226 return;\r
1227 }\r
1228 if (parent instanceof PpiDeclarationsDocument.PpiDeclarations) {\r
1229 PpiDeclarationsDocument.PpiDeclarations.Entry ppe = ((PpiDeclarationsDocument.PpiDeclarations) parent)\r
1230 .addNewEntry();\r
1231 ppe.setName(entryName);\r
1232 ppe.setCName(cName);\r
1233 ppe.setGuidValue(guid);\r
1234 ppe.setHelpText(help);\r
ce73a791 1235 ppe.setSupArchList(archList);\r
1236 ppe.setSupModuleList(modTypeList);\r
1237// if (archList != null && archList.size() > 0){\r
1238// ppe.setSupArchList(new ArrayList<String>(archList));\r
1239// }\r
1240// if (archList != null && modTypeList.size() > 0) {\r
1241// ppe.setSupModuleList(new ArrayList<String>(modTypeList));\r
1242// }\r
a13899c5 1243 return;\r
1244 }\r
1245\r
1246 return;\r
1247\r
1248 }\r
1249\r
1250 /**\r
1251 Generate Pcd definition using parameters passed in\r
1252 \r
1253 @param pcdItemTypes ItemType attribute of PcdEntry element\r
1254 @param cName C_Name element value\r
1255 @param token Token element value\r
1256 @param dataType DatumType element value\r
1257 @param skuEnable Reserved\r
1258 @param sku Reserved\r
1259 @param maxSku Reserved\r
1260 @param hiiEnable Reserved\r
1261 @param varGuid Reserved\r
1262 @param varName Reserved\r
1263 @param defaultString DefaultString element value\r
1264 **/\r
1265 public void genSpdPcdDefinitions(String cName, String token, String dataType, String pcdItemTypes, \r
1266 String spaceGuid, String defaultString, String help, String archList,\r
1267 String modTypeList) {\r
1268 if (getSpdPcdDefinitions() == null) {\r
1269 spdPcdDefinitions = psaRoot.addNewPcdDeclarations();\r
1270 }\r
1271\r
1272 setSpdPcdEntry(pcdItemTypes, cName, token, dataType, spaceGuid, help,\r
1273 defaultString, archList, modTypeList, spdPcdDefinitions);\r
1274 }\r
1275\r
1276 /**\r
1277 Set Pcd entry contents under parent tag\r
1278 \r
1279 @param pcdItemTypes ItemType attribute of PcdEntry element\r
1280 @param cName C_Name element value\r
1281 @param token Token element value\r
1282 @param dataType DatumType element value\r
1283 @param spaceGuid Reserved\r
1284 @param help Reserved\r
1285 @param defaultString DefaultString element value\r
1286 @param parent Tag under which PcdEntry goes to\r
1287 **/\r
1288 public void setSpdPcdEntry(String pcdItemTypes, String cName, String token, String dataType, String spaceGuid, String help,\r
1289 String defaultString, String archList, String modTypeList, XmlObject parent) {\r
1290\r
1291 PcdDeclarationsDocument.PcdDeclarations.PcdEntry pe = ((PcdDeclarationsDocument.PcdDeclarations) parent).addNewPcdEntry();\r
1292 \r
1293 //ToDo: maybe multiple types in, need parse pcdItemTypes.\r
1294 String usage[] = pcdItemTypes.split("( )+");\r
1295 List<String> l = new ArrayList<String>();\r
1296 for (int i = 0; i < usage.length; ++i) {\r
1297 l.add(usage[i]); \r
1298 }\r
1299 pe.setValidUsage(l);\r
1300 pe.setCName(cName);\r
1301 pe.setToken(token);\r
1302 pe.setDatumType(PcdDataTypes.Enum.forString(dataType));\r
1303 pe.setDefaultValue(defaultString);\r
1304 pe.setTokenSpaceGuidCName(spaceGuid);\r
1305 pe.setHelpText(help);\r
1306 if (archList != null){\r
97796eaa 1307 pe.setSupArchList(stringToList(archList));\r
1308 } else {\r
322b7723 1309 if (pe.isSetSupArchList()) {\r
1310 pe.unsetSupArchList();\r
1311 }\r
a13899c5 1312 }\r
1313 if (modTypeList != null){\r
97796eaa 1314 pe.setSupModuleList(stringToList(modTypeList));\r
1315 } else {\r
322b7723 1316 if (pe.isSetSupModuleList()) {\r
1317 pe.unsetSupModuleList();\r
1318 }\r
a13899c5 1319 }\r
1320 }\r
1321\r
1322 /**\r
1323 Get PpiDeclarations element\r
1324 \r
1325 @return PpiDeclarationsDocument.PpiDeclarations\r
1326 **/\r
1327 public PpiDeclarationsDocument.PpiDeclarations getSpdPpiDeclarations() {\r
1328 if (spdPpiDeclarations == null) {\r
1329 spdPpiDeclarations = psaRoot.getPpiDeclarations();\r
1330 }\r
1331 return spdPpiDeclarations;\r
1332 }\r
1333\r
1334 /**\r
1335 Get ProtocolDeclarations element\r
1336 \r
1337 @return ProtocolDeclarationsDocument.ProtocolDeclarations\r
1338 **/\r
1339 public ProtocolDeclarationsDocument.ProtocolDeclarations getSpdProtocolDeclarations() {\r
1340 if (spdProtocolDeclarations == null) {\r
1341 spdProtocolDeclarations = psaRoot.getProtocolDeclarations();\r
1342 }\r
1343 return spdProtocolDeclarations;\r
1344 }\r
1345\r
1346 /**\r
1347 Get GuidDeclarations element\r
1348 \r
1349 @return GuidDeclarationsDocument.GuidDeclarations\r
1350 **/\r
1351 public GuidDeclarationsDocument.GuidDeclarations getSpdGuidDeclarations() {\r
1352 if (spdGuidDeclarations == null) {\r
1353 spdGuidDeclarations = psaRoot.getGuidDeclarations();\r
1354 }\r
1355 return spdGuidDeclarations;\r
1356 }\r
1357\r
1358 /**\r
1359 Get PcdDefinitions element\r
1360 \r
1361 @return PcdDefinitionsDocument.PcdDefinitions\r
1362 **/\r
1363 public PcdDeclarationsDocument.PcdDeclarations getSpdPcdDefinitions() {\r
1364 if (spdPcdDefinitions == null) {\r
1365 spdPcdDefinitions = psaRoot.getPcdDeclarations();\r
1366 }\r
1367 return spdPcdDefinitions;\r
1368 }\r
1369\r
1370 /**\r
1371 Get PackageHeaders element\r
1372 \r
1373 @return PackageHeadersDocument.PackageHeaders\r
1374 **/\r
1375 public PackageHeadersDocument.PackageHeaders getSpdModHdrs() {\r
1376 if (spdModHdrs == null) {\r
1377 spdModHdrs = psaRoot.getPackageHeaders();\r
1378 }\r
1379 return spdModHdrs;\r
1380 }\r
1381\r
1382 /**\r
1383 Get MsaFiles element\r
1384 \r
1385 @return MsaFilesDocument.MsaFiles\r
1386 **/\r
1387 public MsaFilesDocument.MsaFiles getSpdMsaFiles() {\r
1388 if (spdMsaFiles == null) {\r
1389 spdMsaFiles = psaRoot.getMsaFiles();\r
1390 }\r
1391 return spdMsaFiles;\r
1392 }\r
1393\r
1394 /**\r
1395 Get LibraryClassDeclarations element\r
1396 \r
1397 @return LibraryClassDeclarationsDocument.LibraryClassDeclarations\r
1398 **/\r
1399 public LibraryClassDeclarationsDocument.LibraryClassDeclarations getSpdLibClassDeclarations() {\r
1400 if (spdLibClassDeclarations == null) {\r
1401 spdLibClassDeclarations = psaRoot.getLibraryClassDeclarations();\r
1402 }\r
1403 return spdLibClassDeclarations;\r
1404 }\r
1405\r
1406 public PackageDefinitionsDocument.PackageDefinitions getSpdPkgDefs() {\r
1407 if (spdPkgDefs == null) {\r
1408 spdPkgDefs = psaRoot.addNewPackageDefinitions();\r
1409 }\r
1410 return spdPkgDefs;\r
1411 }\r
1412 /**\r
1413 Get SpdHeader element\r
1414 \r
1415 @return SpdHeaderDocument.SpdHeader\r
1416 **/\r
1417 public SpdHeaderDocument.SpdHeader getSpdHdr() {\r
1418 if (spdHdr == null) {\r
1419 spdHdr = psaRoot.addNewSpdHeader();\r
1420 }\r
1421 return spdHdr;\r
1422 }\r
1423\r
1424 /**\r
1425 Set value to Guid element\r
1426 \r
1427 @param guid The value set to Guid element\r
1428 **/\r
1429 public void setSpdHdrGuidValue(String guid) {\r
1430 getSpdHdr().setGuidValue(guid);\r
1431 }\r
1432\r
1433 /**\r
1434 Get Version element under SpdHdr\r
1435 \r
1436 @return String\r
1437 **/\r
1438 public String getSpdHdrVer() {\r
1439 return getSpdHdr().getVersion();\r
1440 }\r
1441\r
1442 /**\r
1443 Set value to Version element\r
1444 \r
1445 @param ver The value set to Version element\r
1446 **/\r
1447 public void setSpdHdrVer(String ver) {\r
1448 getSpdHdr().setVersion(ver);\r
1449 }\r
1450\r
1451 public String getSpdHdrAbs(){\r
1452 return getSpdHdr().getAbstract();\r
1453 \r
1454 }\r
1455 \r
1456 /**\r
1457 Set value to Abstract element\r
1458 \r
1459 @param abs The value set to Abstract element\r
1460 **/\r
1461 public void setSpdHdrAbs(String abs) {\r
1462\r
1463 getSpdHdr().setAbstract(abs);\r
1464 }\r
1465 \r
1466 public String getSpdHdrDescription(){\r
1467 return getSpdHdr().getDescription(); \r
1468 }\r
1469 /**\r
1470 Set value to Description element\r
1471 \r
1472 @param des The value set to Description element\r
1473 **/\r
1474 public void setSpdHdrDescription(String des) {\r
1475 getSpdHdr().setDescription(des);\r
1476 }\r
1477 \r
1478 public String getSpdHdrCopyright(){\r
1479 return getSpdHdr().getCopyright();\r
1480 }\r
1481 /**\r
1482 Set value to Copyright element\r
1483 \r
1484 @param cpRit The value set to Copyright element\r
1485 **/\r
1486 public void setSpdHdrCopyright(String cpRit) {\r
1487\r
1488 getSpdHdr().setCopyright(cpRit);\r
1489\r
1490 }\r
1491 /**\r
1492 Get License element under SpdHdr\r
1493 \r
1494 @return String\r
1495 **/\r
1496 public String getSpdHdrLicense() {\r
1497 if (getSpdHdr().getLicense() != null) {\r
1498 return getSpdHdr().getLicense().getStringValue();\r
1499 }\r
1500 return null;\r
1501 }\r
1502\r
1503 /**\r
1504 Set value to License element\r
1505 \r
1506 @param license The value set to License element\r
1507 **/\r
1508 public void setSpdHdrLicense(String license) {\r
1509 if (getSpdHdr().getLicense() == null){\r
1510 getSpdHdr().addNewLicense().setStringValue(license);\r
1511 }\r
1512 else {\r
1513 getSpdHdr().getLicense().setStringValue(license);\r
1514 }\r
1515 }\r
1516 \r
1517 public String getSpdHdrUrl(){\r
1518 if (getSpdHdr().getLicense() != null) {\r
1519 return getSpdHdr().getLicense().getURL();\r
1520 }\r
1521 return null;\r
1522 }\r
1523 \r
1524 public void setSpdHdrUrl(String url){\r
1525 getSpdHdr().getLicense().setURL(url);\r
1526 }\r
1527\r
1528 /**\r
1529 Get PackageName element under SpdHdr\r
1530 \r
1531 @return String\r
1532 **/\r
1533 public String getSpdHdrPkgName() {\r
1534 \r
1535 return getSpdHdr().getPackageName();\r
1536 }\r
1537\r
1538 /**\r
1539 Set value to PackageName element\r
1540 \r
1541 @param pkgName The value set to PackageName element\r
1542 **/\r
1543 public void setSpdHdrPkgName(String pkgName) {\r
1544 getSpdHdr().setPackageName(pkgName);\r
1545 }\r
1546\r
1547 public String getSpdHdrGuidValue(){\r
1548 return getSpdHdr().getGuidValue();\r
1549 }\r
1550 \r
1551 /**\r
1552 Reserved method\r
1553 \r
1554 @return SpecificationDocument.Specification\r
1555 **/\r
1556 public String getSpdHdrSpec() {\r
c06e8657 1557 return "FRAMEWORK_BUILD_PACKAGING_SPECIFICATION 0x00000052";\r
a13899c5 1558// return getSpdHdr().getSpecification();\r
1559 }\r
1560\r
1561 /**\r
1562 Reserved method\r
1563 \r
1564 @param spec \r
1565 **/\r
1566 public void setSpdHdrSpec(String spec) {\r
c06e8657 1567 spec = "FRAMEWORK_BUILD_PACKAGING_SPECIFICATION 0x00000052";\r
a13899c5 1568 getSpdHdr().setSpecification(spec);\r
1569 \r
1570 }\r
1571\r
1572 public String getSpdPkgDefsRdOnly(){\r
1573 return getSpdPkgDefs().getReadOnly() + "";\r
1574 }\r
1575 /**\r
1576 Set value to ReadOnly element\r
1577 \r
1578 @param rdOnly The value set to ReadOnly element\r
1579 **/\r
1580 public void setSpdPkgDefsRdOnly(String rdOnly) {\r
1581\r
1582 getSpdPkgDefs().setReadOnly(new Boolean(rdOnly));\r
1583 }\r
1584\r
1585 public String getSpdPkgDefsRePkg(){\r
1586 return getSpdPkgDefs().getRePackage() + "";\r
1587 }\r
1588 /**\r
1589 Set value to RePackage element\r
1590 \r
1591 @param rePkg The value set to RePackage element\r
1592 **/\r
1593 public void setSpdPkgDefsRePkg(String rePkg) {\r
1594\r
1595 getSpdPkgDefs().setRePackage(new Boolean(rePkg));\r
1596 }\r
1597\r
1598 /**\r
1599 Set value to URL element\r
1600 \r
1601 @param url The value set to URL element\r
1602 **/\r
1603// public void setSpdHdrURL(String url) {\r
1604// getSpdHdr().setURL(url);\r
1605// }\r
1606\r
1607 /**\r
1608 Get xml file\r
1609 \r
1610 @return File\r
1611 **/\r
1612 public File getFile() {\r
1613 return file;\r
1614 }\r
1615\r
1616 /**\r
1617 Set file\r
1618 \r
1619 @param file File with xml format\r
1620 **/\r
1621 public void setFile(File file) {\r
1622 this.file = file;\r
1623 }\r
1624 \r
1625 private List<String> stringToList(String s){\r
ce73a791 1626 if (s == null || s.length() == 0) {\r
a13899c5 1627 return null;\r
1628 }\r
ce73a791 1629 Vector<String> al = new Vector<String>();\r
a13899c5 1630 String[] sArray = s.split(" ");\r
1631 for(int i = 0; i < sArray.length; ++i){\r
1632 al.add(sArray[i]);\r
1633 }\r
1634 return al; \r
1635 }\r
1636 \r
ce73a791 1637 private String listToString(List l) {\r
a13899c5 1638 if (l == null) {\r
1639 return null;\r
1640 }\r
1641 String s = " ";\r
1642 ListIterator li = l.listIterator();\r
1643 while(li.hasNext()) {\r
1644 s += li.next();\r
1645 s += " ";\r
1646 }\r
1647 return s.trim();\r
1648 }\r
1649\r
1650}\r
EFI Development Kit II mirror for PVE