]>
Commit | Line | Data |
---|---|---|
1 | /** @file\r | |
2 | Token class.\r | |
3 | \r | |
4 | This module contains all classes releted to PCD token.\r | |
5 | \r | |
6 | Copyright (c) 2006, Intel Corporation\r | |
7 | All rights reserved. This program and the accompanying materials\r | |
8 | are licensed and made available under the terms and conditions of the BSD License\r | |
9 | which accompanies this distribution. The full text of the license may be found at\r | |
10 | http://opensource.org/licenses/bsd-license.php\r | |
11 | \r | |
12 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
13 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
14 | \r | |
15 | **/\r | |
16 | package org.tianocore.pcd.entity;\r | |
17 | \r | |
18 | import java.math.BigInteger;\r | |
19 | import java.util.ArrayList;\r | |
20 | import java.util.HashMap;\r | |
21 | import java.util.List;\r | |
22 | import java.util.Map;\r | |
23 | \r | |
24 | /**\r | |
25 | This class is to descript a PCD token object. The information of a token mainly\r | |
26 | comes from MSA, SPD and setting produced by platform developer.\r | |
27 | **/\r | |
28 | public class Token {\r | |
29 | ///\r | |
30 | /// Enumeration macro defintion for PCD type.\r | |
31 | ///\r | |
32 | public static enum PCD_TYPE {FEATURE_FLAG, FIXED_AT_BUILD, PATCHABLE_IN_MODULE, DYNAMIC,\r | |
33 | DYNAMIC_EX, UNKNOWN}\r | |
34 | \r | |
35 | ///\r | |
36 | /// Enumeration macro definition for datum type. All type mainly comes from ProcessBind.h.\r | |
37 | /// Wizard maybe expand this type as "int, unsigned int, short, unsigned short etc" in\r | |
38 | /// prompt dialog.\r | |
39 | ///\r | |
40 | public static enum DATUM_TYPE {UINT8, UINT16, UINT32, UINT64, BOOLEAN, POINTER, UNKNOWN}\r | |
41 | \r | |
42 | ///\r | |
43 | /// Enumeration macor defintion for usage of PCD\r | |
44 | ///\r | |
45 | public static enum PCD_USAGE {ALWAYS_PRODUCED, ALWAYS_CONSUMED, SOMETIMES_PRODUCED,\r | |
46 | SOMETIMES_CONSUMED, UNKNOWN}\r | |
47 | \r | |
48 | ///\r | |
49 | /// cName is to identify a PCD entry and will be used for generating autogen.h/autogen.c.\r | |
50 | /// cName will be defined in MSA, SPD and FPD, can be regarded as primary key with token space guid.\r | |
51 | ///\r | |
52 | public String cName;\r | |
53 | \r | |
54 | ///\r | |
55 | /// Token space name is the guid defined by token itself in package or module level. This\r | |
56 | /// name mainly for DynamicEx type. For other PCD type token, his token space name is the\r | |
57 | /// assignedtokenSpaceName as follows.\r | |
58 | /// tokenSpaceName is defined in MSA, SPD, FPD, can be regarded as primary key with cName.\r | |
59 | ///\r | |
60 | public String tokenSpaceName;\r | |
61 | \r | |
62 | ///\r | |
63 | /// tokenNumber is allocated by platform. tokenNumber indicate an index for this token in\r | |
64 | /// platform token space. For Dynamic, dynamicEx type, this number will be re-adjust by\r | |
65 | /// PCD run-time database autogen tools.\r | |
66 | ///\r | |
67 | public long tokenNumber;\r | |
68 | \r | |
69 | ///\r | |
70 | /// This token number is retrieved from FPD file for DynamicEx type.\r | |
71 | ///\r | |
72 | public long dynamicExTokenNumber;\r | |
73 | \r | |
74 | ///\r | |
75 | /// All supported PCD type, this value can be retrieved from SPD\r | |
76 | /// Currently, only record all PCD type for this token in FPD file.\r | |
77 | ///\r | |
78 | public List<PCD_TYPE> supportedPcdType;\r | |
79 | \r | |
80 | ///\r | |
81 | /// If the token's item type is Dynamic or DynamicEx type, isDynamicPCD\r | |
82 | /// is true.\r | |
83 | ///\r | |
84 | public boolean isDynamicPCD;\r | |
85 | \r | |
86 | ///\r | |
87 | /// datumSize is to descript the fix size or max size for this token.\r | |
88 | /// datumSize is defined in SPD.\r | |
89 | ///\r | |
90 | public int datumSize;\r | |
91 | \r | |
92 | ///\r | |
93 | /// datum type is to descript what type can be expressed by a PCD token.\r | |
94 | /// For same PCD used in different module, the datum type should be unique.\r | |
95 | /// So it belong memeber to Token class.\r | |
96 | ///\r | |
97 | public DATUM_TYPE datumType;\r | |
98 | \r | |
99 | ///\r | |
100 | /// skuData contains all value for SkuNumber of token.\r | |
101 | /// This field is for Dynamic or DynamicEx type PCD,\r | |
102 | ///\r | |
103 | public List<SkuInstance> skuData;\r | |
104 | \r | |
105 | ///\r | |
106 | /// consumers array record all module private information who consume this PCD token.\r | |
107 | ///\r | |
108 | public Map<String, UsageInstance> consumers;\r | |
109 | \r | |
110 | /**\r | |
111 | Constructure function for Token class\r | |
112 | \r | |
113 | @param cName The name of token\r | |
114 | @param tokenSpaceName The name of token space, it is a guid string\r | |
115 | **/\r | |
116 | public Token(String cName, String tokenSpaceName) {\r | |
117 | this.cName = cName;\r | |
118 | this.tokenSpaceName = tokenSpaceName;\r | |
119 | this.tokenNumber = 0;\r | |
120 | this.datumType = DATUM_TYPE.UNKNOWN;\r | |
121 | this.datumSize = -1;\r | |
122 | this.skuData = new ArrayList<SkuInstance>();\r | |
123 | \r | |
124 | this.consumers = new HashMap<String, UsageInstance>();\r | |
125 | this.supportedPcdType = new ArrayList<PCD_TYPE>();\r | |
126 | }\r | |
127 | \r | |
128 | /**\r | |
129 | updateSupportPcdType\r | |
130 | \r | |
131 | SupportPcdType should be gotten from SPD file actually, but now it just\r | |
132 | record all PCD type for this token in FPD file.\r | |
133 | \r | |
134 | @param pcdType new PCD type found in FPD file for this token.\r | |
135 | **/\r | |
136 | public void updateSupportPcdType(PCD_TYPE pcdType) {\r | |
137 | int size = supportedPcdType.size();\r | |
138 | for (int index = 0; index < size; index++) {\r | |
139 | if (supportedPcdType.get(index) == pcdType) {\r | |
140 | return;\r | |
141 | }\r | |
142 | }\r | |
143 | \r | |
144 | //\r | |
145 | // If not found, add the pcd type to member variable supportedPcdType\r | |
146 | //\r | |
147 | supportedPcdType.add(pcdType);\r | |
148 | }\r | |
149 | \r | |
150 | /**\r | |
151 | Judge whether pcdType is belong to dynamic type. Dynamic type includes\r | |
152 | DYNAMIC and DYNAMIC_EX.\r | |
153 | \r | |
154 | @param pcdType the judged pcd type\r | |
155 | \r | |
156 | @return boolean\r | |
157 | **/\r | |
158 | public static boolean isDynamic(PCD_TYPE pcdType) {\r | |
159 | if ((pcdType == PCD_TYPE.DYNAMIC ) ||\r | |
160 | (pcdType == PCD_TYPE.DYNAMIC_EX)) {\r | |
161 | return true;\r | |
162 | }\r | |
163 | \r | |
164 | return false;\r | |
165 | }\r | |
166 | \r | |
167 | /**\r | |
168 | The pcd type is DynamicEx?\r | |
169 | \r | |
170 | @retval true Is DynamicEx type\r | |
171 | @retval false not DynamicEx type\r | |
172 | **/\r | |
173 | public boolean isDynamicEx() {\r | |
174 | int size = supportedPcdType.size();\r | |
175 | for (int i = 0; i < size; i++) {\r | |
176 | if (supportedPcdType.get(i) == PCD_TYPE.DYNAMIC_EX) {\r | |
177 | return true;\r | |
178 | }\r | |
179 | }\r | |
180 | \r | |
181 | return false;\r | |
182 | }\r | |
183 | \r | |
184 | /**\r | |
185 | Use "TokencName + "-" + SpaceTokenName" as primary key when adding token into database\r | |
186 | \r | |
187 | @param cName Token name.\r | |
188 | @param tokenSpaceName The token space guid string defined in MSA or SPD\r | |
189 | \r | |
190 | @retval primary key for this token in token database.\r | |
191 | **/\r | |
192 | public static String getPrimaryKeyString(String cName, String tokenSpaceName) {\r | |
193 | if (tokenSpaceName == null) {\r | |
194 | return cName + "_nullTokenSpaceGuid";\r | |
195 | } else {\r | |
196 | return cName + "_" + tokenSpaceName.toString().replace('-', '_').toLowerCase();\r | |
197 | }\r | |
198 | }\r | |
199 | \r | |
200 | /**\r | |
201 | If skudata list contains more than one data, then Sku mechanism is enable.\r | |
202 | \r | |
203 | @retval boolean if the number of sku data exceed to 1\r | |
204 | **/\r | |
205 | public boolean isSkuEnable() {\r | |
206 | if (this.skuData.size() > 1) {\r | |
207 | return true;\r | |
208 | }\r | |
209 | return false;\r | |
210 | }\r | |
211 | \r | |
212 | /**\r | |
213 | If Hii type for value of token\r | |
214 | \r | |
215 | @return boolean\r | |
216 | **/\r | |
217 | public boolean isHiiEnable() {\r | |
218 | if (getDefaultSku().type == DynamicTokenValue.VALUE_TYPE.HII_TYPE) {\r | |
219 | return true;\r | |
220 | }\r | |
221 | return false;\r | |
222 | }\r | |
223 | \r | |
224 | /**\r | |
225 | If Vpd type for value of token\r | |
226 | \r | |
227 | @return boolean\r | |
228 | **/\r | |
229 | public boolean isVpdEnable() {\r | |
230 | if (getDefaultSku().type == DynamicTokenValue.VALUE_TYPE.VPD_TYPE) {\r | |
231 | return true;\r | |
232 | }\r | |
233 | return false;\r | |
234 | }\r | |
235 | \r | |
236 | /**\r | |
237 | Get the token primary key in token database.\r | |
238 | \r | |
239 | @return String\r | |
240 | **/\r | |
241 | public String getPrimaryKeyString () {\r | |
242 | return Token.getPrimaryKeyString(cName, tokenSpaceName);\r | |
243 | }\r | |
244 | \r | |
245 | /**\r | |
246 | Judge datumType is valid\r | |
247 | \r | |
248 | @param type The datumType want to be judged.\r | |
249 | \r | |
250 | @retval TRUE - The type is valid.\r | |
251 | @retval FALSE - The type is invalid.\r | |
252 | **/\r | |
253 | public static boolean isValiddatumType(DATUM_TYPE type) {\r | |
254 | if ((type.ordinal() < DATUM_TYPE.UINT8.ordinal() ) ||\r | |
255 | (type.ordinal() > DATUM_TYPE.POINTER.ordinal())) {\r | |
256 | return false;\r | |
257 | }\r | |
258 | return true;\r | |
259 | }\r | |
260 | \r | |
261 | /**\r | |
262 | Judge pcdType is valid\r | |
263 | \r | |
264 | @param type The PCdType want to be judged.\r | |
265 | \r | |
266 | @retval TRUE - The type is valid.\r | |
267 | @retval FALSE - The type is invalid.\r | |
268 | **/\r | |
269 | public static boolean isValidpcdType(PCD_TYPE type) {\r | |
270 | if ((type.ordinal() < PCD_TYPE.FEATURE_FLAG.ordinal() ) ||\r | |
271 | (type.ordinal() > PCD_TYPE.DYNAMIC_EX.ordinal())) {\r | |
272 | return false;\r | |
273 | }\r | |
274 | return true;\r | |
275 | }\r | |
276 | \r | |
277 | /**\r | |
278 | Add an usage instance for token\r | |
279 | \r | |
280 | @param usageInstance The usage instance\r | |
281 | \r | |
282 | @retval TRUE - Success to add usage instance.\r | |
283 | @retval FALSE - Fail to add usage instance\r | |
284 | **/\r | |
285 | public boolean addUsageInstance(UsageInstance usageInstance) {\r | |
286 | if (isUsageInstanceExist(usageInstance.usageId)) {\r | |
287 | return false;\r | |
288 | }\r | |
289 | \r | |
290 | //\r | |
291 | // Put usage instance into usage instance database of this PCD token.\r | |
292 | //\r | |
293 | consumers.put(usageInstance.getPrimaryKey(), usageInstance);\r | |
294 | \r | |
295 | return true;\r | |
296 | }\r | |
297 | \r | |
298 | /**\r | |
299 | Judge whether exist an usage instance for this token\r | |
300 | \r | |
301 | @param usageId The UsageInstance identification for usage instance\r | |
302 | \r | |
303 | @return boolean whether exist an usage instance for this token.\r | |
304 | **/\r | |
305 | public boolean isUsageInstanceExist(UsageIdentification usageId) {\r | |
306 | String keyStr = UsageInstance.getPrimaryKey(usageId);\r | |
307 | \r | |
308 | return (consumers.get(keyStr) != null);\r | |
309 | }\r | |
310 | \r | |
311 | /**\r | |
312 | Get the PCD_TYPE according to the string of PCD_TYPE\r | |
313 | \r | |
314 | @param pcdTypeStr The string of PCD_TYPE\r | |
315 | \r | |
316 | @return PCD_TYPE\r | |
317 | **/\r | |
318 | public static PCD_TYPE getPcdTypeFromString(String pcdTypeStr) {\r | |
319 | if (pcdTypeStr == null) {\r | |
320 | return PCD_TYPE.UNKNOWN;\r | |
321 | }\r | |
322 | \r | |
323 | if (pcdTypeStr.equalsIgnoreCase("FEATURE_FLAG")) {\r | |
324 | return PCD_TYPE.FEATURE_FLAG;\r | |
325 | } else if (pcdTypeStr.equalsIgnoreCase("FIXED_AT_BUILD")) {\r | |
326 | return PCD_TYPE.FIXED_AT_BUILD;\r | |
327 | } else if (pcdTypeStr.equalsIgnoreCase("PATCHABLE_IN_MODULE")) {\r | |
328 | return PCD_TYPE.PATCHABLE_IN_MODULE;\r | |
329 | } else if (pcdTypeStr.equalsIgnoreCase("DYNAMIC")) {\r | |
330 | return PCD_TYPE.DYNAMIC;\r | |
331 | } else if (pcdTypeStr.equalsIgnoreCase("DYNAMIC_EX")) {\r | |
332 | return PCD_TYPE.DYNAMIC_EX;\r | |
333 | } else {\r | |
334 | return PCD_TYPE.UNKNOWN;\r | |
335 | }\r | |
336 | }\r | |
337 | \r | |
338 | /**\r | |
339 | Get the string of given datumType. This string will be used for generating autogen files\r | |
340 | \r | |
341 | @param datumType Given datumType\r | |
342 | \r | |
343 | @return The string of datum type.\r | |
344 | **/\r | |
345 | public static String getStringOfdatumType(DATUM_TYPE datumType) {\r | |
346 | return datumType.toString();\r | |
347 | }\r | |
348 | \r | |
349 | /**\r | |
350 | Get the datumType according to a string.\r | |
351 | \r | |
352 | @param datumTypeStr The string of datumType\r | |
353 | \r | |
354 | @return DATUM_TYPE\r | |
355 | **/\r | |
356 | public static DATUM_TYPE getdatumTypeFromString(String datumTypeStr) {\r | |
357 | if (datumTypeStr.equalsIgnoreCase("UINT8")) {\r | |
358 | return DATUM_TYPE.UINT8;\r | |
359 | } else if (datumTypeStr.equalsIgnoreCase("UINT16")) {\r | |
360 | return DATUM_TYPE.UINT16;\r | |
361 | } else if (datumTypeStr.equalsIgnoreCase("UINT32")) {\r | |
362 | return DATUM_TYPE.UINT32;\r | |
363 | } else if (datumTypeStr.equalsIgnoreCase("UINT64")) {\r | |
364 | return DATUM_TYPE.UINT64;\r | |
365 | } else if (datumTypeStr.equalsIgnoreCase("VOID*")) {\r | |
366 | return DATUM_TYPE.POINTER;\r | |
367 | } else if (datumTypeStr.equalsIgnoreCase("BOOLEAN")) {\r | |
368 | return DATUM_TYPE.BOOLEAN;\r | |
369 | }\r | |
370 | return DATUM_TYPE.UNKNOWN;\r | |
371 | }\r | |
372 | \r | |
373 | /**\r | |
374 | Get string of given pcdType\r | |
375 | \r | |
376 | @param pcdType The given PcdType\r | |
377 | \r | |
378 | @return The string of PCD_TYPE.\r | |
379 | **/\r | |
380 | public static String getStringOfpcdType(PCD_TYPE pcdType) {\r | |
381 | return pcdType.toString();\r | |
382 | }\r | |
383 | \r | |
384 | /**\r | |
385 | Get the PCD_USAGE according to a string\r | |
386 | \r | |
387 | @param usageStr The string of PCD_USAGE\r | |
388 | \r | |
389 | @return The PCD_USAGE\r | |
390 | **/\r | |
391 | public static PCD_USAGE getUsageFromString(String usageStr) {\r | |
392 | if (usageStr == null) {\r | |
393 | return PCD_USAGE.UNKNOWN;\r | |
394 | }\r | |
395 | \r | |
396 | if (usageStr.equalsIgnoreCase("ALWAYS_PRODUCED")) {\r | |
397 | return PCD_USAGE.ALWAYS_PRODUCED;\r | |
398 | } else if (usageStr.equalsIgnoreCase("SOMETIMES_PRODUCED")) {\r | |
399 | return PCD_USAGE.SOMETIMES_PRODUCED;\r | |
400 | } else if (usageStr.equalsIgnoreCase("ALWAYS_CONSUMED")) {\r | |
401 | return PCD_USAGE.ALWAYS_CONSUMED;\r | |
402 | } else if (usageStr.equalsIgnoreCase("SOMETIMES_CONSUMED")) {\r | |
403 | return PCD_USAGE.SOMETIMES_CONSUMED;\r | |
404 | }\r | |
405 | \r | |
406 | return PCD_USAGE.UNKNOWN;\r | |
407 | }\r | |
408 | \r | |
409 | /**\r | |
410 | Get the string of given PCD_USAGE\r | |
411 | \r | |
412 | @param usage The given PCD_USAGE\r | |
413 | \r | |
414 | @return The string of PDC_USAGE.\r | |
415 | **/\r | |
416 | public static String getStringOfUsage(PCD_USAGE usage) {\r | |
417 | return usage.toString();\r | |
418 | }\r | |
419 | \r | |
420 | /**\r | |
421 | Get the Defined datumType string for autogen. The string is for generating some MACROs in Autogen.h\r | |
422 | \r | |
423 | @param datumType The given datumType\r | |
424 | \r | |
425 | @return string of datum type for autogen.\r | |
426 | **/\r | |
427 | public static String GetAutogenDefinedatumTypeString(DATUM_TYPE datumType) {\r | |
428 | switch (datumType) {\r | |
429 | \r | |
430 | case UINT8:\r | |
431 | return "8";\r | |
432 | case UINT16:\r | |
433 | return "16";\r | |
434 | case BOOLEAN:\r | |
435 | return "BOOL";\r | |
436 | case POINTER:\r | |
437 | return "PTR";\r | |
438 | case UINT32:\r | |
439 | return "32";\r | |
440 | case UINT64:\r | |
441 | return "64";\r | |
442 | default:\r | |
443 | return null;\r | |
444 | }\r | |
445 | }\r | |
446 | \r | |
447 | /**\r | |
448 | Get the datumType String for Autogen. This string will be used for generating defintions of PCD token in autogen\r | |
449 | \r | |
450 | @param datumType The given datumType\r | |
451 | \r | |
452 | @return string of datum type.\r | |
453 | **/\r | |
454 | \r | |
455 | public static String getAutogendatumTypeString(DATUM_TYPE datumType) {\r | |
456 | switch (datumType) {\r | |
457 | case UINT8:\r | |
458 | return "UINT8";\r | |
459 | case UINT16:\r | |
460 | return "UINT16";\r | |
461 | case UINT32:\r | |
462 | return "UINT32";\r | |
463 | case UINT64:\r | |
464 | return "UINT64";\r | |
465 | case POINTER:\r | |
466 | return "VOID*";\r | |
467 | case BOOLEAN:\r | |
468 | return "BOOLEAN";\r | |
469 | }\r | |
470 | return null;\r | |
471 | }\r | |
472 | \r | |
473 | /**\r | |
474 | Get the datumType string for generating some MACROs in autogen file of Library\r | |
475 | \r | |
476 | @param datumType The given datumType\r | |
477 | \r | |
478 | @return String of datum for genrating bit charater.\r | |
479 | **/\r | |
480 | public static String getAutogenLibrarydatumTypeString(DATUM_TYPE datumType) {\r | |
481 | switch (datumType) {\r | |
482 | case UINT8:\r | |
483 | return "8";\r | |
484 | case UINT16:\r | |
485 | return "16";\r | |
486 | case BOOLEAN:\r | |
487 | return "Bool";\r | |
488 | case POINTER:\r | |
489 | return "Ptr";\r | |
490 | case UINT32:\r | |
491 | return "32";\r | |
492 | case UINT64:\r | |
493 | return "64";\r | |
494 | default:\r | |
495 | return null;\r | |
496 | }\r | |
497 | }\r | |
498 | \r | |
499 | /**\r | |
500 | Get the sku data who id is 0.\r | |
501 | \r | |
502 | @retval DynamicTokenValue the value of this dyanmic token.\r | |
503 | **/\r | |
504 | public DynamicTokenValue getDefaultSku() {\r | |
505 | int index;\r | |
506 | int size = skuData.size();\r | |
507 | for (index = 0; index < size; index++) {\r | |
508 | if (skuData.get(index).id == 0) {\r | |
509 | return skuData.get(index).value;\r | |
510 | }\r | |
511 | }\r | |
512 | \r | |
513 | return null;\r | |
514 | }\r | |
515 | \r | |
516 | /**\r | |
517 | Get the number of Sku data for this token\r | |
518 | \r | |
519 | @retval int the number of sku data\r | |
520 | **/\r | |
521 | public int getSkuIdCount () {\r | |
522 | return this.skuData.size();\r | |
523 | }\r | |
524 | \r | |
525 | /**\r | |
526 | Get the size of PCD value, this PCD is POINTER type.\r | |
527 | \r | |
528 | @param str the string of the value\r | |
529 | @param al the array list for outer parameter.\r | |
530 | **/\r | |
531 | private void getCurrentSizeFromDefaultValue (String str, ArrayList<Integer> al) {\r | |
532 | if (isValidNullValue(str)) {\r | |
533 | al.add(new Integer(0));\r | |
534 | } else {\r | |
535 | //\r | |
536 | // isValidNullValue has already make sure that str here\r | |
537 | // always contain a valid default value of the following 3\r | |
538 | // cases:\r | |
539 | // 1) "Hello world" //Assci string\r | |
540 | // 2) L"Hello" //Unicode string\r | |
541 | // 3) {0x01, 0x02, 0x03} //Byte stream\r | |
542 | //\r | |
543 | if (str.startsWith("\"")) {\r | |
544 | al.add(new Integer(str.length() - 2));\r | |
545 | } else if (str.startsWith("L\"")){\r | |
546 | //\r | |
547 | // Unicode is 2 bytes each.\r | |
548 | //\r | |
549 | al.add(new Integer((str.length() - 3) * 2));\r | |
550 | } else if (str.startsWith("{")) {\r | |
551 | //\r | |
552 | // We count the number of "," in the string.\r | |
553 | // The number of byte is one plus the number of\r | |
554 | // comma.\r | |
555 | //\r | |
556 | String str2 = str;\r | |
557 | \r | |
558 | int cnt = 0;\r | |
559 | int pos = 0;\r | |
560 | pos = str2.indexOf(",", 0);\r | |
561 | while (pos != -1) {\r | |
562 | cnt++;\r | |
563 | pos++;\r | |
564 | pos = str2.indexOf(",", pos);\r | |
565 | }\r | |
566 | cnt++;\r | |
567 | al.add(new Integer(cnt));\r | |
568 | }\r | |
569 | }\r | |
570 | }\r | |
571 | \r | |
572 | /**\r | |
573 | This method can be used to get the MAX and current size\r | |
574 | for pointer type dynamic(ex) PCD entry\r | |
575 | **/\r | |
576 | public ArrayList<Integer> getPointerTypeSize () {\r | |
577 | ArrayList<Integer> al = new ArrayList<Integer>();\r | |
578 | \r | |
579 | //\r | |
580 | // For VPD_enabled and HII_enabled, we can only return the MAX size.\r | |
581 | // For the default DATA type dynamic PCD entry, we will return\r | |
582 | // the MAX size and current size for each SKU_ID.\r | |
583 | //\r | |
584 | al.add(new Integer(this.datumSize));\r | |
585 | \r | |
586 | if (!this.isVpdEnable()) {\r | |
587 | int idx;\r | |
588 | if (this.isHiiEnable()){\r | |
589 | for (idx = 0; idx < this.skuData.size(); idx++) {\r | |
590 | String str = this.skuData.get(idx).value.hiiDefaultValue;\r | |
591 | getCurrentSizeFromDefaultValue(str, al);\r | |
592 | }\r | |
593 | } else {\r | |
594 | for (idx = 0; idx < this.skuData.size(); idx++) {\r | |
595 | String str = this.skuData.get(idx).value.value;\r | |
596 | getCurrentSizeFromDefaultValue(str, al);\r | |
597 | }\r | |
598 | }\r | |
599 | }\r | |
600 | \r | |
601 | return al;\r | |
602 | }\r | |
603 | \r | |
604 | /**\r | |
605 | Get default value for a token, For HII type, HiiDefaultValue of default\r | |
606 | SKU 0 will be returned; For Default type, the defaultvalue of default SKU\r | |
607 | 0 will be returned.\r | |
608 | \r | |
609 | @return String get the default value for a DYNAMIC type PCD.\r | |
610 | **/\r | |
611 | public String getDynamicDefaultValue() {\r | |
612 | DynamicTokenValue dynamicData = getDefaultSku();\r | |
613 | if (hasDefaultValue()) {\r | |
614 | switch (dynamicData.type) {\r | |
615 | case DEFAULT_TYPE:\r | |
616 | return dynamicData.value;\r | |
617 | }\r | |
618 | }\r | |
619 | \r | |
620 | return null;\r | |
621 | }\r | |
622 | \r | |
623 | /**\r | |
624 | Judge whether a DYNAMIC PCD has default value.\r | |
625 | \r | |
626 | @return whether a DYNAMIC PCD has default value.\r | |
627 | **/\r | |
628 | public boolean hasDefaultValue () {\r | |
629 | DynamicTokenValue dynamicValue = null;\r | |
630 | \r | |
631 | if (isSkuEnable()) {\r | |
632 | return true;\r | |
633 | }\r | |
634 | \r | |
635 | if (this.isDynamicPCD) {\r | |
636 | dynamicValue = getDefaultSku();\r | |
637 | switch (dynamicValue.type) {\r | |
638 | case HII_TYPE:\r | |
639 | return true;\r | |
640 | case VPD_TYPE:\r | |
641 | return true;\r | |
642 | case DEFAULT_TYPE:\r | |
643 | return !isValidNullValue(dynamicValue.value);\r | |
644 | }\r | |
645 | }\r | |
646 | \r | |
647 | return false;\r | |
648 | }\r | |
649 | \r | |
650 | /**\r | |
651 | Judge the value is NULL value. NULL value means the value is uninitialized value\r | |
652 | \r | |
653 | @param judgedValue the want want to be judged\r | |
654 | \r | |
655 | @return boolean whether the value of PCD is NULL.\r | |
656 | **/\r | |
657 | public boolean isValidNullValue(String judgedValue) {\r | |
658 | String subStr;\r | |
659 | BigInteger bigIntValue;\r | |
660 | \r | |
661 | switch (datumType) {\r | |
662 | case UINT8:\r | |
663 | case UINT16:\r | |
664 | case UINT32:\r | |
665 | if (judgedValue.length() > 2) {\r | |
666 | if ((judgedValue.charAt(0) == '0') &&\r | |
667 | ((judgedValue.charAt(1) == 'x') || (judgedValue.charAt(1) == 'X'))){\r | |
668 | subStr = judgedValue.substring(2, judgedValue.length());\r | |
669 | bigIntValue = new BigInteger(subStr, 16);\r | |
670 | } else {\r | |
671 | bigIntValue = new BigInteger(judgedValue);\r | |
672 | }\r | |
673 | } else {\r | |
674 | bigIntValue = new BigInteger(judgedValue);\r | |
675 | }\r | |
676 | if (bigIntValue.bitCount() == 0) {\r | |
677 | return true;\r | |
678 | }\r | |
679 | break;\r | |
680 | case UINT64:\r | |
681 | if (judgedValue.length() > 2){\r | |
682 | if ((judgedValue.charAt(0) == '0') &&\r | |
683 | ((judgedValue.charAt(1) == 'x') ||\r | |
684 | (judgedValue.charAt(1) == 'X'))) {\r | |
685 | bigIntValue = new BigInteger(judgedValue.substring(2, judgedValue.length()), 16);\r | |
686 | if (bigIntValue.bitCount() == 0) {\r | |
687 | return true;\r | |
688 | }\r | |
689 | } else {\r | |
690 | bigIntValue = new BigInteger(judgedValue);\r | |
691 | if (bigIntValue.bitCount() == 0) {\r | |
692 | return true;\r | |
693 | }\r | |
694 | }\r | |
695 | } else {\r | |
696 | bigIntValue = new BigInteger(judgedValue);\r | |
697 | if (bigIntValue.bitCount() == 0) {\r | |
698 | return true;\r | |
699 | }\r | |
700 | }\r | |
701 | break;\r | |
702 | case BOOLEAN:\r | |
703 | if (judgedValue.equalsIgnoreCase("false")) {\r | |
704 | return true;\r | |
705 | }\r | |
706 | break;\r | |
707 | case POINTER:\r | |
708 | if (judgedValue.equalsIgnoreCase("\"\"") ||\r | |
709 | judgedValue.equalsIgnoreCase("L\"\"") ||\r | |
710 | (judgedValue.length() == 0)) {\r | |
711 | return true;\r | |
712 | } else if (judgedValue.trim().charAt(0) == '{') {\r | |
713 | int start = judgedValue.indexOf('{');\r | |
714 | int end = judgedValue.lastIndexOf('}');\r | |
715 | String[] strValueArray = judgedValue.substring(start + 1, end).split(",");\r | |
716 | if (strValueArray.length > 1) {\r | |
717 | return false;\r | |
718 | } else {\r | |
719 | if (strValueArray[0].matches("(0x)?(0X)?0*")) {\r | |
720 | return true;\r | |
721 | }\r | |
722 | }\r | |
723 | }\r | |
724 | }\r | |
725 | return false;\r | |
726 | }\r | |
727 | \r | |
728 | /**\r | |
729 | Is the string value in Unicode\r | |
730 | \r | |
731 | @return boolean the string value is UNICODE type string.\r | |
732 | **/\r | |
733 | public boolean isHiiDefaultValueUnicodeStringType() {\r | |
734 | DynamicTokenValue dynamicData = getDefaultSku();\r | |
735 | \r | |
736 | if (dynamicData == null)\r | |
737 | return false;\r | |
738 | \r | |
739 | return dynamicData.hiiDefaultValue.startsWith("L\"")\r | |
740 | && dynamicData.hiiDefaultValue.endsWith("\"");\r | |
741 | }\r | |
742 | \r | |
743 | /**\r | |
744 | Is the string value in ANSCI\r | |
745 | \r | |
746 | @return boolean whether the dfault value for HII case is string type.\r | |
747 | **/\r | |
748 | public boolean isHiiDefaultValueASCIIStringType() {\r | |
749 | DynamicTokenValue dynamicData = getDefaultSku();\r | |
750 | \r | |
751 | if (dynamicData == null)\r | |
752 | return false;\r | |
753 | \r | |
754 | return dynamicData.hiiDefaultValue.startsWith("\"")\r | |
755 | && dynamicData.hiiDefaultValue.endsWith("\"");\r | |
756 | }\r | |
757 | \r | |
758 | /**\r | |
759 | Judege whether current value is UNICODE string type.\r | |
760 | \r | |
761 | @return boolean whether the value is UNICODE string.\r | |
762 | **/\r | |
763 | public boolean isUnicodeStringType () {\r | |
764 | String str = getDynamicDefaultValue();\r | |
765 | \r | |
766 | if (str == null) {\r | |
767 | return false;\r | |
768 | }\r | |
769 | \r | |
770 | if (datumType == Token.DATUM_TYPE.POINTER &&\r | |
771 | str.startsWith("L\"") &&\r | |
772 | str.endsWith("\"")) {\r | |
773 | return true;\r | |
774 | }\r | |
775 | \r | |
776 | return false;\r | |
777 | }\r | |
778 | \r | |
779 | /**\r | |
780 | Judge whether the string type is ANSIC string.\r | |
781 | \r | |
782 | @return boolean whether the string type is ANSIC string\r | |
783 | **/\r | |
784 | public boolean isASCIIStringType () {\r | |
785 | String str = getDynamicDefaultValue();\r | |
786 | \r | |
787 | if (str == null) {\r | |
788 | return false;\r | |
789 | }\r | |
790 | \r | |
791 | if (datumType == Token.DATUM_TYPE.POINTER &&\r | |
792 | str.startsWith("\"") &&\r | |
793 | str.endsWith("\"")) {\r | |
794 | return true;\r | |
795 | }\r | |
796 | \r | |
797 | return false;\r | |
798 | }\r | |
799 | \r | |
800 | /**\r | |
801 | Judge whether the string value is byte array.\r | |
802 | \r | |
803 | @return boolean whether the string value is byte array.\r | |
804 | \r | |
805 | **/\r | |
806 | public boolean isByteStreamType () {\r | |
807 | String str = getDynamicDefaultValue();\r | |
808 | \r | |
809 | if (str == null) {\r | |
810 | return false;\r | |
811 | }\r | |
812 | \r | |
813 | if (datumType == Token.DATUM_TYPE.POINTER &&\r | |
814 | str.startsWith("{") &&\r | |
815 | str.endsWith("}")) {\r | |
816 | return true;\r | |
817 | }\r | |
818 | \r | |
819 | return false;\r | |
820 | \r | |
821 | }\r | |
822 | \r | |
823 | /**\r | |
824 | Get string value for ANSIC string type\r | |
825 | \r | |
826 | @return String the string value\r | |
827 | **/\r | |
828 | public String getStringTypeString () {\r | |
829 | return getDefaultSku().value.substring(2, getDefaultSku().value.length() - 1);\r | |
830 | }\r | |
831 | }\r | |
832 | \r | |
833 | \r | |
834 | \r | |
835 | \r |