1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
|
/** @file
Java class SpdFileContents is used to parse spd xml file.
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
package org.tianocore.packaging;
import java.io.File;
import java.io.IOException;
import java.util.List;
import java.util.ListIterator;
import java.math.*;
import org.apache.xmlbeans.XmlObject;
import org.apache.xmlbeans.XmlOptions;
import org.apache.xmlbeans.XmlCursor;
import org.tianocore.AbstractDocument;
import org.tianocore.GuidDeclarationsDocument;
import org.tianocore.GuidDocument;
import org.tianocore.IncludeHeaderDocument;
import org.tianocore.LibraryClassDeclarationDocument;
import org.tianocore.LibraryClassDeclarationsDocument;
import org.tianocore.LibraryClassDocument;
import org.tianocore.LibraryUsage;
import org.tianocore.LicenseDocument;
import org.tianocore.ModuleTypeDef;
import org.tianocore.MsaFilesDocument;
import org.tianocore.OutputDirectoryDocument;
import org.tianocore.PackageDependenciesDocument;
import org.tianocore.PackageHeadersDocument;
import org.tianocore.PackageNameDocument;
import org.tianocore.PackageSurfaceAreaDocument;
import org.tianocore.PackageType;
import org.tianocore.PackageUsage;
import org.tianocore.PcdDataTypes;
import org.tianocore.PcdDefinitionsDocument;
import org.tianocore.PcdItemTypes;
import org.tianocore.PpiDeclarationsDocument;
import org.tianocore.ProtocolDeclarationsDocument;
import org.tianocore.SpdHeaderDocument;
import org.tianocore.SpecificationDocument;
import org.tianocore.GuidDeclarationsDocument.GuidDeclarations;
/**
This class processes spd file contents such as add remove xml elements.
@since PackageEditor 1.0
**/
public class SpdFileContents {
private File file = null;
private PackageSurfaceAreaDocument psad = null;
private PackageSurfaceAreaDocument.PackageSurfaceArea psaRoot = null;
private SpdHeaderDocument.SpdHeader spdHdr = null;
private String spdHdrPkgName = null;
private GuidDocument.Guid spdHdrGuid = null;
private AbstractDocument.Abstract spdHdrAbs = null;
private LicenseDocument.License spdHdrLicense = null;
private SpecificationDocument.Specification spdHdrSpec = null;
private OutputDirectoryDocument.OutputDirectory spdHdrOutDir = null;
private LibraryClassDeclarationsDocument.LibraryClassDeclarations spdLibClassDeclarations = null;
private PackageDependenciesDocument.PackageDependencies spdPkgDeps = null;
private MsaFilesDocument.MsaFiles spdMsaFiles = null;
private PackageHeadersDocument.PackageHeaders spdModHdrs = null;
private GuidDeclarationsDocument.GuidDeclarations spdGuidDeclarations = null;
private ProtocolDeclarationsDocument.ProtocolDeclarations spdProtocolDeclarations = null;
private PpiDeclarationsDocument.PpiDeclarations spdPpiDeclarations = null;
private PcdDefinitionsDocument.PcdDefinitions spdPcdDefinitions = null;
/**
Constructor to create a new spd file
**/
public SpdFileContents() {
psad = PackageSurfaceAreaDocument.Factory.newInstance();
psaRoot = psad.addNewPackageSurfaceArea();
}
/**
Constructor based on an existing spd file
@param f Existing spd file
**/
public SpdFileContents(File f) {
try {
psad = PackageSurfaceAreaDocument.Factory.parse(f);
psaRoot = psad.getPackageSurfaceArea();
file = f;
} catch (Exception e) {
System.out.println(e.toString());
}
}
/**
Remove existing pcd definitions elements using XmlCursor
**/
public void removeSpdPcdDefinition() {
XmlObject o = psaRoot.getPcdDefinitions();
if (o == null)
return;
XmlCursor cursor = o.newCursor();
cursor.removeXml();
spdPcdDefinitions = null;
}
/**
Remove existing ppi declarations using XmlCursor
**/
public void removeSpdPpiDeclaration() {
XmlObject o = psaRoot.getPpiDeclarations();
if (o == null)
return;
XmlCursor cursor = o.newCursor();
cursor.removeXml();
spdPpiDeclarations = null;
}
/**
Remove existing protocols declarations using XmlCursor
**/
public void removeSpdProtocolDeclaration() {
XmlObject o = psaRoot.getProtocolDeclarations();
if (o == null)
return;
XmlCursor cursor = o.newCursor();
cursor.removeXml();
spdProtocolDeclarations = null;
}
/**
Remove existing GUID declarations using XmlCursor
**/
public void removeSpdGuidDeclaration() {
XmlObject o = psaRoot.getGuidDeclarations();
if (o == null)
return;
XmlCursor cursor = o.newCursor();
cursor.removeXml();
spdGuidDeclarations = null;
}
/**
Remove existing spd package include files using XmlCursor
**/
public void removeSpdPkgHeader() {
XmlObject o = psaRoot.getPackageHeaders();
if (o == null)
return;
XmlCursor cursor = o.newCursor();
cursor.removeXml();
spdModHdrs = null;
}
/**
Remove existing msa files using XmlCursor
**/
public void removeSpdMsaFile() {
XmlObject o = psaRoot.getMsaFiles();
if (o == null)
return;
XmlCursor cursor = o.newCursor();
cursor.removeXml();
spdMsaFiles = null;
}
/**
Remove existing library class declarations using XmlCursor
**/
public void removeSpdLibClass() {
XmlObject o = psaRoot.getLibraryClassDeclarations();
if (o == null)
return;
XmlCursor cursor = o.newCursor();
cursor.removeXml();
spdLibClassDeclarations = null;
}
/**
Get spd file header contents into String array
@param s Caller allocated String array
**/
public void getSpdHdrDetails(String[] s) {
if (getSpdHdr() == null) {
spdHdr = psaRoot.addNewSpdHeader();
}
s[0] = getSpdHdrPkgName();
s[1] = getSpdHdrGuid().getStringValue();
s[2] = getSpdHdrVer();
s[3] = getSpdHdrAbs().getStringValue();
s[4] = getSpdHdr().getDescription();
s[5] = getSpdHdr().getCopyright();
s[6] = getSpdHdrLicense().getStringValue();
s[7] = getSpdHdr().getCreated();
s[8] = getSpdHdr().getURL();
if (getSpdHdr().getPackageType() != null) {
s[9] = getSpdHdr().getPackageType().toString();
}
//
// convert boolean to String by adding empty String ""
//
s[10] = getSpdHdr().getReadOnly() + "";
s[11] = getSpdHdr().getReadOnly() + "";
}
/**
Get the number of library class declarations from the size of List
@return int
**/
public int getSpdLibClassDeclarationCount() {
if (psaRoot.getLibraryClassDeclarations() == null
|| psaRoot.getLibraryClassDeclarations().getLibraryClassDeclarationList() == null) {
return 0;
}
return psaRoot.getLibraryClassDeclarations().getLibraryClassDeclarationList().size();
}
/**
Get available library class declaration into String array
@param libClass Caller allocated two-dimentional String array
**/
public void getSpdLibClassDeclarations(String[][] libClass) {
List<LibraryClassDeclarationDocument.LibraryClassDeclaration> l = psaRoot.getLibraryClassDeclarations()
.getLibraryClassDeclarationList();
int i = 0;
ListIterator li = l.listIterator();
while (li.hasNext()) {
LibraryClassDeclarationDocument.LibraryClassDeclaration lcd = (LibraryClassDeclarationDocument.LibraryClassDeclaration) li
.next();
if (lcd.getLibraryClass() != null) {
libClass[i][0] = lcd.getLibraryClass().getStringValue();
}
if (lcd.getIncludeHeader() != null) {
libClass[i][1] = lcd.getIncludeHeader().getStringValue();
}
i++;
}
}
/**
Get the number of Msa files from the size of List
@return int
**/
public int getSpdMsaFileCount() {
if (psaRoot.getMsaFiles() == null || psaRoot.getMsaFiles().getMsaFileList() == null) {
return 0;
}
return psaRoot.getMsaFiles().getMsaFileList().size();
}
/**
Get available Msa file into String array
@param msaFile Caller allocated two-dimentional String array
**/
public void getSpdMsaFiles(String[][] msaFile) {
List<MsaFilesDocument.MsaFiles.MsaFile> l = psaRoot.getMsaFiles().getMsaFileList();
int i = 0;
ListIterator li = l.listIterator();
while (li.hasNext()) {
MsaFilesDocument.MsaFiles.MsaFile m = (MsaFilesDocument.MsaFiles.MsaFile) li.next();
if (m.getFilename() != null) {
msaFile[i][0] = m.getFilename().getStringValue();
}
i++;
}
}
/**
Get the number of include header files in PackageHeaders from the size of List
@return int
**/
public int getSpdPackageHeaderCount() {
if (psaRoot.getPackageHeaders() == null || psaRoot.getPackageHeaders().getIncludeHeaderList() == null) {
return 0;
}
return psaRoot.getPackageHeaders().getIncludeHeaderList().size();
}
/**
Get available package header contents into String array
@param pkgHeader Caller allocated two-dimentional String array
**/
public void getSpdPackageHeaders(String[][] pkgHeader) {
List<IncludeHeaderDocument.IncludeHeader> l = psaRoot.getPackageHeaders().getIncludeHeaderList();
int i = 0;
ListIterator li = l.listIterator();
while (li.hasNext()) {
IncludeHeaderDocument.IncludeHeader ih = (IncludeHeaderDocument.IncludeHeader) li.next();
if (ih.getModuleType() != null) {
pkgHeader[i][0] = ih.getModuleType().toString();
}
pkgHeader[i][1] = ih.getStringValue();
i++;
}
}
/**
Get the number of GUID declarations from the size of List
@return int
**/
public int getSpdGuidDeclarationCount() {
if (psaRoot.getGuidDeclarations() == null || psaRoot.getGuidDeclarations().getEntryList() == null) {
return 0;
}
return psaRoot.getGuidDeclarations().getEntryList().size();
}
/**
Get available Guid declaration contents into String array
@param guid Caller allocated two-dimentional String array
**/
public void getSpdGuidDeclarations(String[][] guid) {
List<GuidDeclarationsDocument.GuidDeclarations.Entry> l = psaRoot.getGuidDeclarations().getEntryList();
int i = 0;
ListIterator li = l.listIterator();
while (li.hasNext()) {
GuidDeclarationsDocument.GuidDeclarations.Entry e = (GuidDeclarationsDocument.GuidDeclarations.Entry) li
.next();
guid[i][0] = e.getName();
guid[i][1] = e.getCName();
if (e.getGuid() != null) {
guid[i][2] = e.getGuid().getStringValue();
}
i++;
}
}
/**
Get the number of protocol declarations from the size of List
@return int
**/
public int getSpdProtocolDeclarationCount() {
if (psaRoot.getProtocolDeclarations() == null || psaRoot.getProtocolDeclarations().getEntryList() == null) {
return 0;
}
return psaRoot.getProtocolDeclarations().getEntryList().size();
}
/**
Get available protocol declaration contents into String array
@param protocol Caller allocated two-dimentional String array
**/
public void getSpdProtocolDeclarations(String[][] protocol) {
List<ProtocolDeclarationsDocument.ProtocolDeclarations.Entry> l = psaRoot.getProtocolDeclarations()
.getEntryList();
int i = 0;
ListIterator li = l.listIterator();
while (li.hasNext()) {
ProtocolDeclarationsDocument.ProtocolDeclarations.Entry e = (ProtocolDeclarationsDocument.ProtocolDeclarations.Entry) li
.next();
protocol[i][0] = e.getName();
protocol[i][1] = e.getCName();
if (e.getGuid() != null) {
protocol[i][2] = e.getGuid().getStringValue();
}
i++;
}
}
/**
Get the number of Ppi declarations from the size of List
@return int
**/
public int getSpdPpiDeclarationCount() {
if (psaRoot.getPpiDeclarations() == null || psaRoot.getPpiDeclarations().getEntryList() == null) {
return 0;
}
return psaRoot.getPpiDeclarations().getEntryList().size();
}
/**
Get available Ppi declaration contents into String array
@param ppi Caller allocated two-dimentional String array
**/
public void getSpdPpiDeclarations(String[][] ppi) {
List<PpiDeclarationsDocument.PpiDeclarations.Entry> l = psaRoot.getPpiDeclarations().getEntryList();
int i = 0;
ListIterator li = l.listIterator();
while (li.hasNext()) {
PpiDeclarationsDocument.PpiDeclarations.Entry e = (PpiDeclarationsDocument.PpiDeclarations.Entry) li.next();
ppi[i][0] = e.getName();
ppi[i][1] = e.getCName();
if (e.getGuid() != null) {
ppi[i][2] = e.getGuid().getStringValue();
}
i++;
}
}
/**
Get the number of Pcd definitions from the size of List
@return int
**/
public int getSpdPcdDefinitionCount() {
if (psaRoot.getPcdDefinitions() == null || psaRoot.getPcdDefinitions().getPcdEntryList() == null) {
return 0;
}
return psaRoot.getPcdDefinitions().getPcdEntryList().size();
}
/**
Get available Pcd definition contents into String array
@param pcd Caller allocated two-dimentional String array
**/
public void getSpdPcdDefinitions(String[][] pcd) {
List<PcdDefinitionsDocument.PcdDefinitions.PcdEntry> l = psaRoot.getPcdDefinitions().getPcdEntryList();
int i = 0;
ListIterator li = l.listIterator();
while (li.hasNext()) {
PcdDefinitionsDocument.PcdDefinitions.PcdEntry e = (PcdDefinitionsDocument.PcdDefinitions.PcdEntry) li
.next();
if (e.getItemType() != null) {
pcd[i][0] = e.getItemType().toString();
}
pcd[i][1] = e.getCName();
pcd[i][2] = e.getToken();
if (e.getDatumType() != null) {
pcd[i][3] = e.getDatumType().toString();
}
if (e.getDefaultValue() != null) {
pcd[i][4] = e.getDefaultValue().toString();
}
i++;
}
}
/**
Save the processed xml contents to file
@param spdFile The file to save xml contents
@throws IOException Exceptions during file operation
**/
public void saveAs(File spdFile) throws IOException {
XmlOptions options = new XmlOptions();
options.setCharacterEncoding("UTF-8");
options.setSavePrettyPrint();
options.setSavePrettyPrintIndent(2);
try {
psad.save(spdFile, options);
} catch (IOException e) {
e.printStackTrace();
}
}
/**
Generate SpdHeader contents using parameters passed in.
@param pkgName PackageName
@param pkgGuid Guid
@param pkgVer Version
@param pkgAbs Abstract
@param pkgDes Description
@param pkgCpRight Copyright
@param pkgLicense License
@param pkgCreateDate Created
@param pkgUpdateDate Updated
@param pkgURL URL
@param pkgType PackageType
@param pkgRdOnly ReadOnly
@param pkgRePkg RePackage
@param pkgSpec Reserved
@param pkgOutDir Reserved
**/
public void genSpdHeader(String pkgName, String pkgGuid, String pkgVer, String pkgAbs, String pkgDes,
String pkgCpRight, String pkgLicense, String pkgCreateDate, String pkgUpdateDate,
String pkgURL, String pkgType, String pkgRdOnly, String pkgRePkg, String pkgSpec,
String pkgOutDir) {
if (getSpdHdr() == null) {
spdHdr = psaRoot.addNewSpdHeader();
}
setSpdHdrPkgName(pkgName);
setSpdHdrGuid(pkgGuid);
setSpdHdrVer(pkgVer);
setSpdHdrAbs(pkgAbs);
setSpdHdrDes(pkgDes);
setSpdHdrCpRit(pkgCpRight);
setSpdHdrLicense(pkgLicense);
setSpdHdrCreateDate(pkgCreateDate);
setSpdHdrUpdateDate(pkgUpdateDate);
setSpdHdrURL(pkgURL);
setSpdHdrPkgType(pkgType);
setSpdHdrRdOnly(pkgRdOnly);
setSpdHdrRePkg(pkgRePkg);
setSpdHdrSpec(pkgSpec);
setSpdHdrOutDir(pkgOutDir);
}
/**
Generate library class declaration element using parameters passed in
@param libClassBaseName LibraryClass element value
@param libClassUsage Reserved
@param incHdrFileName IncludeHeader element value
@param incHdrAttribGuid Reserved
@param incHdrAttribArch Reserved
@param incHdrAttribPath Reserved
@param incHdrAttribClass Reserved
@param incHdrAttribVer Reserved
@param incHdrAttribOverrideID Reserved
@param incHdrAttribModuleType Reserved
**/
public void genSpdLibClassDeclarations(String libClassBaseName, String libClassUsage, String incHdrFileName,
String incHdrAttribGuid, String incHdrAttribArch, String incHdrAttribPath,
String incHdrAttribClass, String incHdrAttribVer,
String incHdrAttribOverrideID, String incHdrAttribModuleType) {
if (getSpdLibClassDeclarations() == null) {
spdLibClassDeclarations = psaRoot.addNewLibraryClassDeclarations();
}
//
// add contents under LibraryClassDeclarations tag
//
setSpdLibClassDeclaration(libClassBaseName, libClassUsage, incHdrFileName, incHdrAttribGuid, incHdrAttribArch,
incHdrAttribPath, incHdrAttribClass, incHdrAttribVer, incHdrAttribOverrideID,
incHdrAttribModuleType, spdLibClassDeclarations);
}
/**
Set library class declaration contents under parent tag
@param clsName LibraryClass element value
@param clsUsage Reserved
@param hdrFile IncludeHeader element value
@param hdrAttribGuid Reserved
@param hdrAttribArch Reserved
@param hdrAttribPath Reserved
@param hdrAttribClass Reserved
@param hdrAttribVer Reserved
@param hdrAttribOverID Reserved
@param hdrAttribModType Reserved
@param parent The tag under which library class declaration goes to
**/
public void setSpdLibClassDeclaration(String clsName, String clsUsage, String hdrFile, String hdrAttribGuid,
String hdrAttribArch, String hdrAttribPath, String hdrAttribClass,
String hdrAttribVer, String hdrAttribOverID, String hdrAttribModType,
XmlObject parent) {
LibraryClassDeclarationDocument.LibraryClassDeclaration lcd = ((LibraryClassDeclarationsDocument.LibraryClassDeclarations) parent)
.addNewLibraryClassDeclaration();
setSpdLibraryClass(clsName, clsUsage, lcd);
setSpdIncludeHeader(null, hdrFile, hdrAttribGuid, hdrAttribArch, hdrAttribPath, hdrAttribClass, hdrAttribVer,
hdrAttribOverID, lcd);
}
/**
Set the contents of LibraryClass under parent element
@param clsName LibraryClass element value
@param clsUsage Reserved
@param parent The tag under which library class declaration goes to
**/
public void setSpdLibraryClass(String clsName, String clsUsage, XmlObject parent) {
LibraryClassDeclarationDocument.LibraryClassDeclaration.LibraryClass lc = ((LibraryClassDeclarationDocument.LibraryClassDeclaration) parent).addNewLibraryClass();
lc.setStringValue(clsName);
}
/**
Set contents of IncludeHeader under parent element
@param modType Reserved
@param hdrFile IncludeHeader element value
@param hdrAttribGuid Reserved
@param hdrAttribArch Reserved
@param hdrAttribPath Reserved
@param hdrAttribClass Reserved
@param hdrAttribVer Reserved
@param hdrAttribOverID Reserved
@param parent The tag under which library class declaration goes to
**/
public void setSpdIncludeHeader(String modType, String hdrFile, String hdrAttribGuid, String hdrAttribArch,
String hdrAttribPath, String hdrAttribClass, String hdrAttribVer,
String hdrAttribOverID, XmlObject parent) {
IncludeHeaderDocument.IncludeHeader ih = null;
if (parent instanceof LibraryClassDeclarationDocument.LibraryClassDeclaration) {
ih = ((LibraryClassDeclarationDocument.LibraryClassDeclaration) parent).addNewIncludeHeader();
} else if (parent instanceof PackageHeadersDocument.PackageHeaders) {
ih = ((PackageHeadersDocument.PackageHeaders) parent).addNewIncludeHeader();
} else {
return;
}
ih.setStringValue(hdrFile);
if (hdrAttribGuid != null) {
ih.setGuid(hdrAttribGuid);
}
if (hdrAttribPath != null) {
ih.setPath(hdrAttribPath);
}
if (hdrAttribClass != null) {
ih.setClass1(hdrAttribClass);
}
if (hdrAttribVer != null) {
ih.setVersion(hdrAttribVer);
}
if (hdrAttribOverID != null) {
ih.setOverrideID(Integer.parseInt(hdrAttribOverID));
}
if (modType != null) {
ih.setModuleType(ModuleTypeDef.Enum.forString(modType));
}
}
/**
Reserved method
@param pkgDepPkgName
@param pkgDepPkgAttribGuid
@param pkgDepPkgAttribVer
@param pkgDepPkgAttribType
@param pkgDepPkgAttribUsage
@param pkgDepPkgAttribInstallDate
@param pkgDepPkgAttribUpdateDate
@param pkgDepPkgAttribPath
**/
public void genSpdPackageDependencies(String pkgDepPkgName, String pkgDepPkgAttribGuid, String pkgDepPkgAttribVer,
String pkgDepPkgAttribType, String pkgDepPkgAttribUsage,
String pkgDepPkgAttribInstallDate, String pkgDepPkgAttribUpdateDate,
String pkgDepPkgAttribPath) {
if (spdPkgDeps == null) {
spdPkgDeps = psaRoot.addNewPackageDependencies();
}
setSpdPackageName(pkgDepPkgName, pkgDepPkgAttribGuid, pkgDepPkgAttribVer, pkgDepPkgAttribType,
pkgDepPkgAttribUsage, pkgDepPkgAttribInstallDate, pkgDepPkgAttribUpdateDate,
pkgDepPkgAttribPath, spdPkgDeps);
}
/**
Reserved method
@param pkgName
@param pkgAttribGuid
@param pkgAttribVer
@param pkgAttribType
@param pkgAttribUsage
@param pkgAttribInstallDate
@param pkgAttribUpdateDate
@param pkgAttribPath
@param parent
**/
public void setSpdPackageName(String pkgName, String pkgAttribGuid, String pkgAttribVer, String pkgAttribType,
String pkgAttribUsage, String pkgAttribInstallDate, String pkgAttribUpdateDate,
String pkgAttribPath, XmlObject parent) {
PackageNameDocument.PackageName pn = ((PackageDependenciesDocument.PackageDependencies) parent)
.addNewPackageName();
pn.setStringValue(pkgName);
pn.setPackageType(PackageType.Enum.forString(pkgAttribType));
pn.setUsage(PackageUsage.Enum.forString(pkgAttribUsage));
pn.setUpdatedDate(pkgAttribUpdateDate);
}
/**
Generate MsaFile element.
@param msaFileName MsaFile element value
@param archType Reserved
**/
public void genSpdMsaFiles(String msaFileName, String archType) {
if (getSpdMsaFiles() == null) {
spdMsaFiles = psaRoot.addNewMsaFiles();
}
setSpdMsaFile(msaFileName, spdMsaFiles);
}
/**
Set MsaFile contents under parent element.
@param msaFileName MsaFile element value
@param parent Element under which MsaFile goes to
**/
public void setSpdMsaFile(String msaFileName, XmlObject parent) {
((MsaFilesDocument.MsaFiles) parent).addNewMsaFile().addNewFilename().setStringValue(msaFileName);
}
/**
Generate PackageHeader element using parameters passed in.
@param ModHdrModType ModuleType attribute of IncludeHeader element
@param hdrFile IncludeHeader element value
@param hdrAttribGuid Reserved
@param hdrAttribArch Reserved
@param hdrAttribPath Reserved
@param hdrAttribClass Reserved
@param hdrAttribVer Reserved
@param hdrAttribOverID Reserved
**/
public void genSpdModuleHeaders(String ModHdrModType, String hdrFile, String hdrAttribGuid, String hdrAttribArch,
String hdrAttribPath, String hdrAttribClass, String hdrAttribVer,
String hdrAttribOverID) {
if (getSpdModHdrs() == null) {
spdModHdrs = psaRoot.addNewPackageHeaders();
}
//
// add IncludeHeader under PackageHeaders element
//
setSpdIncludeHeader(ModHdrModType, hdrFile, hdrAttribGuid, hdrAttribArch, hdrAttribPath, hdrAttribClass,
hdrAttribVer, hdrAttribOverID, spdModHdrs);
}
/**
Generate GUID declaration element using parameters passed in.
@param guidDeclEntryName Name attribute of Entry element
@param guidDeclCName CName element value
@param guidDeclGuid Guid element value
@param guidDeclFeatureFlag Reserved
**/
public void genSpdGuidDeclarations(String guidDeclEntryName, String guidDeclCName, String guidDeclGuid,
String guidDeclFeatureFlag) {
if (getSpdGuidDeclarations() == null) {
spdGuidDeclarations = psaRoot.addNewGuidDeclarations();
}
setSpdEntry(guidDeclEntryName, guidDeclCName, guidDeclGuid, guidDeclFeatureFlag, spdGuidDeclarations);
}
/**
Generate protocol declaration element using parameters passed in.
@param protocolDeclEntryName Name attribute of Entry element
@param protocolDeclCName CName element value
@param protocolDeclGuid Guid element value
@param protocolDeclFeatureFlag Reserved
**/
public void genSpdProtocolDeclarations(String protocolDeclEntryName, String protocolDeclCName,
String protocolDeclGuid, String protocolDeclFeatureFlag) {
if (getSpdProtocolDeclarations() == null) {
spdProtocolDeclarations = psaRoot.addNewProtocolDeclarations();
}
setSpdEntry(protocolDeclEntryName, protocolDeclCName, protocolDeclGuid, protocolDeclFeatureFlag,
spdProtocolDeclarations);
}
/**
Generate PPI declaration element using parameters passed in.
@param ppiDeclEntryName Name attribute of Entry element
@param ppiDeclCName CName element value
@param ppiDeclGuid Guid element value
@param ppiDeclFeatureFlag Reserved
**/
public void genSpdPpiDeclarations(String ppiDeclEntryName, String ppiDeclCName, String ppiDeclGuid,
String ppiDeclFeatureFlag) {
if (getSpdPpiDeclarations() == null) {
spdPpiDeclarations = psaRoot.addNewPpiDeclarations();
}
setSpdEntry(ppiDeclEntryName, ppiDeclCName, ppiDeclGuid, ppiDeclFeatureFlag, spdPpiDeclarations);
}
/**
Set Entry contents using parameters passed in
@param entryName Name attribute of Entry element
@param cName CName element value
@param guid Guid element value
@param featureFlag Reserved
@param parent The tag under which Entry element goes to
**/
public void setSpdEntry(String entryName, String cName, String guid, String featureFlag, XmlObject parent) {
if (parent instanceof GuidDeclarationsDocument.GuidDeclarations) {
GuidDeclarationsDocument.GuidDeclarations.Entry e = ((GuidDeclarations) parent).addNewEntry();
e.setName(entryName);
e.setCName(cName);
e.addNewGuid().setStringValue(guid);
return;
}
if (parent instanceof ProtocolDeclarationsDocument.ProtocolDeclarations) {
ProtocolDeclarationsDocument.ProtocolDeclarations.Entry pe = ((ProtocolDeclarationsDocument.ProtocolDeclarations) parent)
.addNewEntry();
pe.setName(entryName);
pe.setCName(cName);
pe.addNewGuid().setStringValue(guid);
}
if (parent instanceof PpiDeclarationsDocument.PpiDeclarations) {
PpiDeclarationsDocument.PpiDeclarations.Entry ppe = ((PpiDeclarationsDocument.PpiDeclarations) parent)
.addNewEntry();
ppe.setName(entryName);
ppe.setCName(cName);
ppe.addNewGuid().setStringValue(guid);
return;
}
return;
}
/**
Generate Pcd definition using parameters passed in
@param pcdItemTypes ItemType attribute of PcdEntry element
@param cName C_Name element value
@param token Token element value
@param dataType DatumType element value
@param skuEnable Reserved
@param sku Reserved
@param maxSku Reserved
@param hiiEnable Reserved
@param varGuid Reserved
@param varName Reserved
@param defaultString DefaultString element value
**/
public void genSpdPcdDefinitions(String pcdItemTypes, String cName, String token, String dataType,
String skuEnable, String sku, String maxSku, String hiiEnable, String varGuid,
String varName, String defaultString) {
if (getSpdPcdDefinitions() == null) {
spdPcdDefinitions = psaRoot.addNewPcdDefinitions();
}
setSpdPcdEntry(pcdItemTypes, cName, token, dataType, skuEnable, sku, maxSku, hiiEnable, varGuid, varName,
defaultString, spdPcdDefinitions);
}
/**
Set Pcd entry contents under parent tag
@param pcdItemTypes ItemType attribute of PcdEntry element
@param cName C_Name element value
@param token Token element value
@param dataType DatumType element value
@param skuEnable Reserved
@param sku Reserved
@param maxSku Reserved
@param hiiEnable Reserved
@param varGuid Reserved
@param varName Reserved
@param defaultString DefaultString element value
@param parent Tag under which PcdEntry goes to
**/
public void setSpdPcdEntry(String pcdItemTypes, String cName, String token, String dataType, String skuEnable,
String sku, String maxSku, String hiiEnable, String varGuid, String varName,
String defaultString, XmlObject parent) {
PcdDefinitionsDocument.PcdDefinitions.PcdEntry pe = ((PcdDefinitionsDocument.PcdDefinitions) parent)
.addNewPcdEntry();
pe.setItemType(PcdItemTypes.Enum.forString(pcdItemTypes));
pe.setCName(cName);
pe.setToken(token);
pe.setDatumType(PcdDataTypes.Enum.forString(dataType));
pe.setDefaultValue(defaultString);
}
/**
Get PpiDeclarations element
@return PpiDeclarationsDocument.PpiDeclarations
**/
public PpiDeclarationsDocument.PpiDeclarations getSpdPpiDeclarations() {
if (spdPpiDeclarations == null) {
spdPpiDeclarations = psaRoot.getPpiDeclarations();
}
return spdPpiDeclarations;
}
/**
Get ProtocolDeclarations element
@return ProtocolDeclarationsDocument.ProtocolDeclarations
**/
public ProtocolDeclarationsDocument.ProtocolDeclarations getSpdProtocolDeclarations() {
if (spdProtocolDeclarations == null) {
spdProtocolDeclarations = psaRoot.getProtocolDeclarations();
}
return spdProtocolDeclarations;
}
/**
Get GuidDeclarations element
@return GuidDeclarationsDocument.GuidDeclarations
**/
public GuidDeclarationsDocument.GuidDeclarations getSpdGuidDeclarations() {
if (spdGuidDeclarations == null) {
spdGuidDeclarations = psaRoot.getGuidDeclarations();
}
return spdGuidDeclarations;
}
/**
Get PcdDefinitions element
@return PcdDefinitionsDocument.PcdDefinitions
**/
public PcdDefinitionsDocument.PcdDefinitions getSpdPcdDefinitions() {
if (spdPcdDefinitions == null) {
spdPcdDefinitions = psaRoot.getPcdDefinitions();
}
return spdPcdDefinitions;
}
/**
Get PackageHeaders element
@return PackageHeadersDocument.PackageHeaders
**/
public PackageHeadersDocument.PackageHeaders getSpdModHdrs() {
if (spdModHdrs == null) {
spdModHdrs = psaRoot.getPackageHeaders();
}
return spdModHdrs;
}
/**
Get MsaFiles element
@return MsaFilesDocument.MsaFiles
**/
public MsaFilesDocument.MsaFiles getSpdMsaFiles() {
if (spdMsaFiles == null) {
spdMsaFiles = psaRoot.getMsaFiles();
}
return spdMsaFiles;
}
/**
Get LibraryClassDeclarations element
@return LibraryClassDeclarationsDocument.LibraryClassDeclarations
**/
public LibraryClassDeclarationsDocument.LibraryClassDeclarations getSpdLibClassDeclarations() {
if (spdLibClassDeclarations == null) {
spdLibClassDeclarations = psaRoot.getLibraryClassDeclarations();
}
return spdLibClassDeclarations;
}
/**
Get SpdHeader element
@return SpdHeaderDocument.SpdHeader
**/
public SpdHeaderDocument.SpdHeader getSpdHdr() {
if (spdHdr == null) {
spdHdr = psaRoot.getSpdHeader();
}
return spdHdr;
}
/**
Get Abstract element under tag SpdHeader
@return AbstractDocument.Abstract
**/
public AbstractDocument.Abstract getSpdHdrAbs() {
if (spdHdrAbs == null) {
spdHdrAbs = getSpdHdr().getAbstract();
}
return spdHdrAbs;
}
/**
Set value to Abstract element
@param abs The value set to Abstract element
**/
public void setSpdHdrAbs(String abs) {
if (getSpdHdrAbs() != null) {
getSpdHdrAbs().setStringValue(abs);
} else {
spdHdrAbs = getSpdHdr().addNewAbstract();
spdHdrAbs.setStringValue(abs);
}
}
/**
Set value to Copyright element
@param cpRit The value set to Copyright element
**/
public void setSpdHdrCpRit(String cpRit) {
getSpdHdr().setCopyright(cpRit);
}
/**
Set value to Created element
@param createDate The value set to Created element
**/
public void setSpdHdrCreateDate(String createDate) {
getSpdHdr().setCreated(createDate);
}
/**
Set value to Description element
@param des The value set to Description element
**/
public void setSpdHdrDes(String des) {
getSpdHdr().setDescription(des);
}
/**
Get Guid element under SpdHdr
@return GuidDocument.Guid
**/
public GuidDocument.Guid getSpdHdrGuid() {
if (spdHdrGuid == null) {
spdHdrGuid = getSpdHdr().getGuid();
}
return spdHdrGuid;
}
/**
Set value to Guid element
@param guid The value set to Guid element
**/
public void setSpdHdrGuid(String guid) {
if (getSpdHdrGuid() != null) {
getSpdHdrGuid().setStringValue(guid);
} else {
spdHdrGuid = getSpdHdr().addNewGuid();
spdHdrGuid.setStringValue(guid);
}
}
/**
Get Version element under SpdHdr
@return String
**/
public String getSpdHdrVer() {
if (spdHdr != null)
return spdHdr.getVersion() + "";
else
return null;
}
/**
Set value to Version element
@param ver The value set to Version element
**/
public void setSpdHdrVer(String ver) {
if (spdHdr != null) {
spdHdr.setVersion(new BigDecimal(ver.toCharArray()));
}
}
/**
Get License element under SpdHdr
@return LicenseDocument.License
**/
public LicenseDocument.License getSpdHdrLicense() {
if (spdHdrLicense == null) {
spdHdrLicense = getSpdHdr().getLicense();
}
return spdHdrLicense;
}
/**
Set value to License element
@param license The value set to License element
**/
public void setSpdHdrLicense(String license) {
if (getSpdHdrLicense() != null) {
getSpdHdrLicense().setStringValue(license);
} else {
spdHdrLicense = getSpdHdr().addNewLicense();
spdHdrLicense.setStringValue(license);
}
}
/**
Reserved method
@return
**/
public OutputDirectoryDocument.OutputDirectory getSpdHdrOutDir() {
return spdHdrOutDir;
}
/**
Reserved method
@param outdir
**/
public void setSpdHdrOutDir(String outdir) {
if (outdir == null) {
return;
}
if (getSpdHdrOutDir() != null) {
getSpdHdrOutDir().setStringValue(outdir);
} else {
spdHdrOutDir = getSpdHdr().addNewOutputDirectory();
spdHdrOutDir.setStringValue(outdir);
}
}
/**
Get PackageName element under SpdHdr
@return PackageNameDocument.PackageName
**/
public String getSpdHdrPkgName() {
if (spdHdrPkgName == null) {
spdHdrPkgName = getSpdHdr().getPackageName();
}
return spdHdrPkgName;
}
/**
Set value to PackageName element
@param pkgName The value set to PackageName element
**/
public void setSpdHdrPkgName(String pkgName) {
if (getSpdHdrPkgName() != null) {
getSpdHdr().setPackageName(pkgName);
} else {
getSpdHdr().setPackageName(pkgName);
}
}
/**
Reserved method
@return SpecificationDocument.Specification
**/
public SpecificationDocument.Specification getSpdHdrSpec() {
return spdHdrSpec;
}
/**
Reserved method
@param spec
**/
public void setSpdHdrSpec(String spec) {
if (spec == null) {
return;
}
if (getSpdHdrSpec() != null) {
getSpdHdrSpec().setStringValue(spec);
} else {
spdHdrSpec = getSpdHdr().addNewSpecification();
spdHdrSpec.setStringValue(spec);
}
}
/**
Set value to PackageType element
@param pkgType The value set to PackageType element
**/
public void setSpdHdrPkgType(String pkgType) {
getSpdHdr().setPackageType(PackageType.Enum.forString(pkgType));
}
/**
Set value to ReadOnly element
@param rdOnly The value set to ReadOnly element
**/
public void setSpdHdrRdOnly(String rdOnly) {
getSpdHdr().setReadOnly(new Boolean(rdOnly));
}
/**
Set value to RePackage element
@param rePkg The value set to RePackage element
**/
public void setSpdHdrRePkg(String rePkg) {
getSpdHdr().setRePackage(new Boolean(rePkg));
}
/**
Set value to Updated element
@param updateDate The value set to Updated element
**/
public void setSpdHdrUpdateDate(String updateDate) {
getSpdHdr().setUpdated(updateDate);
}
/**
Set value to URL element
@param url The value set to URL element
**/
public void setSpdHdrURL(String url) {
getSpdHdr().setURL(url);
}
/**
Get xml file
@return File
**/
public File getFile() {
return file;
}
/**
Set file
@param file File with xml format
**/
public void setFile(File file) {
this.file = file;
}
}
|