2 Utility functions for expression evaluation.
4 Copyright (c) 2007 - 2015, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 // Global stack used to evaluate boolean expresions
20 EFI_HII_VALUE
*mOpCodeScopeStack
= NULL
;
21 EFI_HII_VALUE
*mOpCodeScopeStackEnd
= NULL
;
22 EFI_HII_VALUE
*mOpCodeScopeStackPointer
= NULL
;
24 EFI_HII_VALUE
*mExpressionEvaluationStack
= NULL
;
25 EFI_HII_VALUE
*mExpressionEvaluationStackEnd
= NULL
;
26 EFI_HII_VALUE
*mExpressionEvaluationStackPointer
= NULL
;
27 UINTN mExpressionEvaluationStackOffset
= 0;
29 EFI_HII_VALUE
*mCurrentExpressionStack
= NULL
;
30 EFI_HII_VALUE
*mCurrentExpressionEnd
= NULL
;
31 EFI_HII_VALUE
*mCurrentExpressionPointer
= NULL
;
33 EFI_HII_VALUE
*mMapExpressionListStack
= NULL
;
34 EFI_HII_VALUE
*mMapExpressionListEnd
= NULL
;
35 EFI_HII_VALUE
*mMapExpressionListPointer
= NULL
;
37 FORM_EXPRESSION
**mFormExpressionStack
= NULL
;
38 FORM_EXPRESSION
**mFormExpressionEnd
= NULL
;
39 FORM_EXPRESSION
**mFormExpressionPointer
= NULL
;
41 FORM_EXPRESSION
**mStatementExpressionStack
= NULL
;
42 FORM_EXPRESSION
**mStatementExpressionEnd
= NULL
;
43 FORM_EXPRESSION
**mStatementExpressionPointer
= NULL
;
45 FORM_EXPRESSION
**mOptionExpressionStack
= NULL
;
46 FORM_EXPRESSION
**mOptionExpressionEnd
= NULL
;
47 FORM_EXPRESSION
**mOptionExpressionPointer
= NULL
;
51 // Unicode collation protocol interface
53 EFI_UNICODE_COLLATION_PROTOCOL
*mUnicodeCollation
= NULL
;
54 EFI_USER_MANAGER_PROTOCOL
*mUserManager
= NULL
;
57 Grow size of the stack.
59 This is an internal function.
61 @param Stack On input: old stack; On output: new stack
62 @param StackPtr On input: old stack pointer; On output: new stack
64 @param StackEnd On input: old stack end; On output: new stack end
66 @retval EFI_SUCCESS Grow stack success.
67 @retval EFI_OUT_OF_RESOURCES No enough memory for stack space.
72 IN OUT EFI_HII_VALUE
**Stack
,
73 IN OUT EFI_HII_VALUE
**StackPtr
,
74 IN OUT EFI_HII_VALUE
**StackEnd
78 EFI_HII_VALUE
*NewStack
;
80 Size
= EXPRESSION_STACK_SIZE_INCREMENT
;
81 if (*StackPtr
!= NULL
) {
82 Size
= Size
+ (*StackEnd
- *Stack
);
85 NewStack
= AllocatePool (Size
* sizeof (EFI_HII_VALUE
));
86 if (NewStack
== NULL
) {
87 return EFI_OUT_OF_RESOURCES
;
90 if (*StackPtr
!= NULL
) {
92 // Copy from Old Stack to the New Stack
97 (*StackEnd
- *Stack
) * sizeof (EFI_HII_VALUE
)
101 // Free The Old Stack
107 // Make the Stack pointer point to the old data in the new stack
109 *StackPtr
= NewStack
+ (*StackPtr
- *Stack
);
111 *StackEnd
= NewStack
+ Size
;
118 Push an element onto the Boolean Stack.
120 @param Stack On input: old stack; On output: new stack
121 @param StackPtr On input: old stack pointer; On output: new stack
123 @param StackEnd On input: old stack end; On output: new stack end
124 @param Data Data to push.
126 @retval EFI_SUCCESS Push stack success.
131 IN OUT EFI_HII_VALUE
**Stack
,
132 IN OUT EFI_HII_VALUE
**StackPtr
,
133 IN OUT EFI_HII_VALUE
**StackEnd
,
134 IN EFI_HII_VALUE
*Data
140 // Check for a stack overflow condition
142 if (*StackPtr
>= *StackEnd
) {
146 Status
= GrowStack (Stack
, StackPtr
, StackEnd
);
147 if (EFI_ERROR (Status
)) {
153 // Push the item onto the stack
155 CopyMem (*StackPtr
, Data
, sizeof (EFI_HII_VALUE
));
156 if (Data
->Type
== EFI_IFR_TYPE_BUFFER
) {
157 (*StackPtr
)->Buffer
= AllocateCopyPool(Data
->BufferLen
, Data
->Buffer
);
158 ASSERT ((*StackPtr
)->Buffer
!= NULL
);
161 *StackPtr
= *StackPtr
+ 1;
168 Pop an element from the stack.
170 @param Stack On input: old stack
171 @param StackPtr On input: old stack pointer; On output: new stack pointer
172 @param Data Data to pop.
174 @retval EFI_SUCCESS The value was popped onto the stack.
175 @retval EFI_ACCESS_DENIED The pop operation underflowed the stack
180 IN EFI_HII_VALUE
*Stack
,
181 IN OUT EFI_HII_VALUE
**StackPtr
,
182 OUT EFI_HII_VALUE
*Data
186 // Check for a stack underflow condition
188 if (*StackPtr
== Stack
) {
189 return EFI_ACCESS_DENIED
;
193 // Pop the item off the stack
195 *StackPtr
= *StackPtr
- 1;
196 CopyMem (Data
, *StackPtr
, sizeof (EFI_HII_VALUE
));
202 Reset stack pointer to begin of the stack.
206 ResetCurrentExpressionStack (
210 mCurrentExpressionPointer
= mCurrentExpressionStack
;
211 mFormExpressionPointer
= mFormExpressionStack
;
212 mStatementExpressionPointer
= mStatementExpressionStack
;
213 mOptionExpressionPointer
= mOptionExpressionStack
;
218 Push current expression onto the Stack
220 @param Pointer Pointer to current expression.
222 @retval EFI_SUCCESS The value was pushed onto the stack.
223 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the stack.
227 PushCurrentExpression (
233 Data
.Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
234 Data
.Value
.u64
= (UINT64
) (UINTN
) Pointer
;
237 &mCurrentExpressionStack
,
238 &mCurrentExpressionPointer
,
239 &mCurrentExpressionEnd
,
246 Pop current expression from the Stack
248 @param Pointer Pointer to current expression to be pop.
250 @retval EFI_SUCCESS The value was pushed onto the stack.
251 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the stack.
255 PopCurrentExpression (
263 mCurrentExpressionStack
,
264 &mCurrentExpressionPointer
,
268 *Pointer
= (VOID
*) (UINTN
) Data
.Value
.u64
;
274 Reset stack pointer to begin of the stack.
278 ResetMapExpressionListStack (
282 mMapExpressionListPointer
= mMapExpressionListStack
;
287 Grow size of the stack.
289 This is an internal function.
291 @param Stack On input: old stack; On output: new stack
292 @param StackPtr On input: old stack pointer; On output: new stack
294 @param StackEnd On input: old stack end; On output: new stack end
295 @param MemberSize The stack member size.
297 @retval EFI_SUCCESS Grow stack success.
298 @retval EFI_OUT_OF_RESOURCES No enough memory for stack space.
302 GrowConditionalStack (
303 IN OUT FORM_EXPRESSION
***Stack
,
304 IN OUT FORM_EXPRESSION
***StackPtr
,
305 IN OUT FORM_EXPRESSION
***StackEnd
,
310 FORM_EXPRESSION
**NewStack
;
312 Size
= EXPRESSION_STACK_SIZE_INCREMENT
;
313 if (*StackPtr
!= NULL
) {
314 Size
= Size
+ (*StackEnd
- *Stack
);
317 NewStack
= AllocatePool (Size
* MemberSize
);
318 if (NewStack
== NULL
) {
319 return EFI_OUT_OF_RESOURCES
;
322 if (*StackPtr
!= NULL
) {
324 // Copy from Old Stack to the New Stack
329 (*StackEnd
- *Stack
) * MemberSize
333 // Free The Old Stack
339 // Make the Stack pointer point to the old data in the new stack
341 *StackPtr
= NewStack
+ (*StackPtr
- *Stack
);
343 *StackEnd
= NewStack
+ Size
;
349 Push an element onto the Stack.
351 @param Stack On input: old stack; On output: new stack
352 @param StackPtr On input: old stack pointer; On output: new stack
354 @param StackEnd On input: old stack end; On output: new stack end
355 @param Data Data to push.
357 @retval EFI_SUCCESS Push stack success.
361 PushConditionalStack (
362 IN OUT FORM_EXPRESSION
***Stack
,
363 IN OUT FORM_EXPRESSION
***StackPtr
,
364 IN OUT FORM_EXPRESSION
***StackEnd
,
365 IN FORM_EXPRESSION
**Data
371 // Check for a stack overflow condition
373 if (*StackPtr
>= *StackEnd
) {
377 Status
= GrowConditionalStack (Stack
, StackPtr
, StackEnd
, sizeof (FORM_EXPRESSION
*));
378 if (EFI_ERROR (Status
)) {
384 // Push the item onto the stack
386 CopyMem (*StackPtr
, Data
, sizeof (FORM_EXPRESSION
*));
387 *StackPtr
= *StackPtr
+ 1;
394 Pop an element from the stack.
396 @param Stack On input: old stack
397 @param StackPtr On input: old stack pointer; On output: new stack pointer
398 @param Data Data to pop.
400 @retval EFI_SUCCESS The value was popped onto the stack.
401 @retval EFI_ACCESS_DENIED The pop operation underflowed the stack
405 PopConditionalStack (
406 IN FORM_EXPRESSION
**Stack
,
407 IN OUT FORM_EXPRESSION
***StackPtr
,
408 OUT FORM_EXPRESSION
**Data
412 // Check for a stack underflow condition
414 if (*StackPtr
== Stack
) {
415 return EFI_ACCESS_DENIED
;
419 // Pop the item off the stack
421 *StackPtr
= *StackPtr
- 1;
422 CopyMem (Data
, *StackPtr
, sizeof (FORM_EXPRESSION
*));
428 Get the expression list count.
430 @param Level Which type this expression belong to. Form,
433 @retval >=0 The expression count
434 @retval -1 Input parameter error.
438 GetConditionalExpressionCount (
439 IN EXPRESS_LEVEL Level
444 return mFormExpressionPointer
- mFormExpressionStack
;
445 case ExpressStatement
:
446 return mStatementExpressionPointer
- mStatementExpressionStack
;
448 return mOptionExpressionPointer
- mOptionExpressionStack
;
456 Get the expression Buffer pointer.
458 @param Level Which type this expression belong to. Form,
461 @retval The start pointer of the expression buffer or NULL.
465 GetConditionalExpressionList (
466 IN EXPRESS_LEVEL Level
471 return mFormExpressionStack
;
472 case ExpressStatement
:
473 return mStatementExpressionStack
;
475 return mOptionExpressionStack
;
484 Push the expression options onto the Stack.
486 @param Pointer Pointer to the current expression.
487 @param Level Which type this expression belong to. Form,
490 @retval EFI_SUCCESS The value was pushed onto the stack.
491 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the stack.
495 PushConditionalExpression (
496 IN FORM_EXPRESSION
*Pointer
,
497 IN EXPRESS_LEVEL Level
502 return PushConditionalStack (
503 &mFormExpressionStack
,
504 &mFormExpressionPointer
,
508 case ExpressStatement
:
509 return PushConditionalStack (
510 &mStatementExpressionStack
,
511 &mStatementExpressionPointer
,
512 &mStatementExpressionEnd
,
516 return PushConditionalStack (
517 &mOptionExpressionStack
,
518 &mOptionExpressionPointer
,
519 &mOptionExpressionEnd
,
524 return EFI_INVALID_PARAMETER
;
529 Pop the expression options from the Stack
531 @param Level Which type this expression belong to. Form,
534 @retval EFI_SUCCESS The value was pushed onto the stack.
535 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the stack.
539 PopConditionalExpression (
540 IN EXPRESS_LEVEL Level
543 FORM_EXPRESSION
*Pointer
;
547 return PopConditionalStack (
548 mFormExpressionStack
,
549 &mFormExpressionPointer
,
553 case ExpressStatement
:
554 return PopConditionalStack (
555 mStatementExpressionStack
,
556 &mStatementExpressionPointer
,
561 return PopConditionalStack (
562 mOptionExpressionStack
,
563 &mOptionExpressionPointer
,
569 return EFI_INVALID_PARAMETER
;
575 Push the list of map expression onto the Stack
577 @param Pointer Pointer to the list of map expression to be pushed.
579 @retval EFI_SUCCESS The value was pushed onto the stack.
580 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the stack.
584 PushMapExpressionList (
590 Data
.Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
591 Data
.Value
.u64
= (UINT64
) (UINTN
) Pointer
;
594 &mMapExpressionListStack
,
595 &mMapExpressionListPointer
,
596 &mMapExpressionListEnd
,
603 Pop the list of map expression from the Stack
605 @param Pointer Pointer to the list of map expression to be pop.
607 @retval EFI_SUCCESS The value was pushed onto the stack.
608 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the stack.
612 PopMapExpressionList (
620 mMapExpressionListStack
,
621 &mMapExpressionListPointer
,
625 *Pointer
= (VOID
*) (UINTN
) Data
.Value
.u64
;
631 Reset stack pointer to begin of the stack.
639 mOpCodeScopeStackPointer
= mOpCodeScopeStack
;
644 Push an Operand onto the Stack
646 @param Operand Operand to push.
648 @retval EFI_SUCCESS The value was pushed onto the stack.
649 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the
660 Data
.Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
661 Data
.Value
.u8
= Operand
;
665 &mOpCodeScopeStackPointer
,
666 &mOpCodeScopeStackEnd
,
673 Pop an Operand from the Stack
675 @param Operand Operand to pop.
677 @retval EFI_SUCCESS The value was pushed onto the stack.
678 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the
692 &mOpCodeScopeStackPointer
,
696 *Operand
= Data
.Value
.u8
;
703 Push an Expression value onto the Stack
705 @param Value Expression value to push.
707 @retval EFI_SUCCESS The value was pushed onto the stack.
708 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the
714 IN EFI_HII_VALUE
*Value
718 &mExpressionEvaluationStack
,
719 &mExpressionEvaluationStackPointer
,
720 &mExpressionEvaluationStackEnd
,
727 Pop an Expression value from the stack.
729 @param Value Expression value to pop.
731 @retval EFI_SUCCESS The value was popped onto the stack.
732 @retval EFI_ACCESS_DENIED The pop operation underflowed the stack
737 OUT EFI_HII_VALUE
*Value
741 mExpressionEvaluationStack
+ mExpressionEvaluationStackOffset
,
742 &mExpressionEvaluationStackPointer
,
748 Get current stack offset from stack start.
750 @return Stack offset to stack start.
753 SaveExpressionEvaluationStackOffset (
756 UINTN TempStackOffset
;
757 TempStackOffset
= mExpressionEvaluationStackOffset
;
758 mExpressionEvaluationStackOffset
= mExpressionEvaluationStackPointer
- mExpressionEvaluationStack
;
759 return TempStackOffset
;
763 Restore stack offset based on input stack offset
765 @param StackOffset Offset to stack start.
769 RestoreExpressionEvaluationStackOffset (
773 mExpressionEvaluationStackOffset
= StackOffset
;
777 Get Form given its FormId.
779 @param FormSet The formset which contains this form.
780 @param FormId Id of this form.
782 @retval Pointer The form.
783 @retval NULL Specified Form is not found in the formset.
788 IN FORM_BROWSER_FORMSET
*FormSet
,
793 FORM_BROWSER_FORM
*Form
;
795 Link
= GetFirstNode (&FormSet
->FormListHead
);
796 while (!IsNull (&FormSet
->FormListHead
, Link
)) {
797 Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
799 if (Form
->FormId
== FormId
) {
803 Link
= GetNextNode (&FormSet
->FormListHead
, Link
);
811 Search a Question in Form scope using its QuestionId.
813 @param Form The form which contains this Question.
814 @param QuestionId Id of this Question.
816 @retval Pointer The Question.
817 @retval NULL Specified Question not found in the form.
820 FORM_BROWSER_STATEMENT
*
822 IN FORM_BROWSER_FORM
*Form
,
827 FORM_BROWSER_STATEMENT
*Question
;
829 if (QuestionId
== 0 || Form
== NULL
) {
831 // The value of zero is reserved
836 Link
= GetFirstNode (&Form
->StatementListHead
);
837 while (!IsNull (&Form
->StatementListHead
, Link
)) {
838 Question
= FORM_BROWSER_STATEMENT_FROM_LINK (Link
);
840 if (Question
->QuestionId
== QuestionId
) {
844 Link
= GetNextNode (&Form
->StatementListHead
, Link
);
852 Search a Question in Formset scope using its QuestionId.
854 @param FormSet The formset which contains this form.
855 @param Form The form which contains this Question.
856 @param QuestionId Id of this Question.
858 @retval Pointer The Question.
859 @retval NULL Specified Question not found in the form.
862 FORM_BROWSER_STATEMENT
*
864 IN FORM_BROWSER_FORMSET
*FormSet
,
865 IN FORM_BROWSER_FORM
*Form
,
870 FORM_BROWSER_STATEMENT
*Question
;
873 // Search in the form scope first
875 Question
= IdToQuestion2 (Form
, QuestionId
);
876 if (Question
!= NULL
) {
881 // Search in the formset scope
883 Link
= GetFirstNode (&FormSet
->FormListHead
);
884 while (!IsNull (&FormSet
->FormListHead
, Link
)) {
885 Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
887 Question
= IdToQuestion2 (Form
, QuestionId
);
888 if (Question
!= NULL
) {
890 // EFI variable storage may be updated by Callback() asynchronous,
891 // to keep synchronous, always reload the Question Value.
893 if (Question
->Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE
) {
894 GetQuestionValue (FormSet
, Form
, Question
, GetSetValueWithHiiDriver
);
900 Link
= GetNextNode (&FormSet
->FormListHead
, Link
);
908 Get Expression given its RuleId.
910 @param Form The form which contains this Expression.
911 @param RuleId Id of this Expression.
913 @retval Pointer The Expression.
914 @retval NULL Specified Expression not found in the form.
919 IN FORM_BROWSER_FORM
*Form
,
924 FORM_EXPRESSION
*Expression
;
926 Link
= GetFirstNode (&Form
->ExpressionListHead
);
927 while (!IsNull (&Form
->ExpressionListHead
, Link
)) {
928 Expression
= FORM_EXPRESSION_FROM_LINK (Link
);
930 if (Expression
->Type
== EFI_HII_EXPRESSION_RULE
&& Expression
->RuleId
== RuleId
) {
934 Link
= GetNextNode (&Form
->ExpressionListHead
, Link
);
942 Locate the Unicode Collation Protocol interface for later use.
944 @retval EFI_SUCCESS Protocol interface initialize success.
945 @retval Other Protocol interface initialize failed.
949 InitializeUnicodeCollationProtocol (
955 if (mUnicodeCollation
!= NULL
) {
960 // BUGBUG: Proper impelmentation is to locate all Unicode Collation Protocol
961 // instances first and then select one which support English language.
962 // Current implementation just pick the first instance.
964 Status
= gBS
->LocateProtocol (
965 &gEfiUnicodeCollation2ProtocolGuid
,
967 (VOID
**) &mUnicodeCollation
973 Convert the input Unicode character to upper.
975 @param String Th Unicode character to be converted.
983 while (*String
!= 0) {
984 if ((*String
>= 'a') && (*String
<= 'z')) {
985 *String
= (UINT16
) ((*String
) & ((UINT16
) ~0x20));
992 Check whether this value type can be transfer to EFI_IFR_TYPE_BUFFER type.
994 EFI_IFR_TYPE_REF, EFI_IFR_TYPE_DATE and EFI_IFR_TYPE_TIME are converted to
995 EFI_IFR_TYPE_BUFFER when do the value compare.
997 @param Value Expression value to compare on.
999 @retval TRUE This value type can be transter to EFI_IFR_TYPE_BUFFER type.
1000 @retval FALSE This value type can't be transter to EFI_IFR_TYPE_BUFFER type.
1005 IN EFI_HII_VALUE
*Value
1008 switch (Value
->Type
) {
1009 case EFI_IFR_TYPE_BUFFER
:
1010 case EFI_IFR_TYPE_DATE
:
1011 case EFI_IFR_TYPE_TIME
:
1012 case EFI_IFR_TYPE_REF
:
1021 Check whether this value type can be transfer to EFI_IFR_TYPE_UINT64
1023 @param Value Expression value to compare on.
1025 @retval TRUE This value type can be transter to EFI_IFR_TYPE_BUFFER type.
1026 @retval FALSE This value type can't be transter to EFI_IFR_TYPE_BUFFER type.
1031 IN EFI_HII_VALUE
*Value
1034 switch (Value
->Type
) {
1035 case EFI_IFR_TYPE_NUM_SIZE_8
:
1036 case EFI_IFR_TYPE_NUM_SIZE_16
:
1037 case EFI_IFR_TYPE_NUM_SIZE_32
:
1038 case EFI_IFR_TYPE_NUM_SIZE_64
:
1039 case EFI_IFR_TYPE_BOOLEAN
:
1048 Return the buffer length for this value.
1050 EFI_IFR_TYPE_REF, EFI_IFR_TYPE_DATE and EFI_IFR_TYPE_TIME are converted to
1051 EFI_IFR_TYPE_BUFFER when do the value compare.
1053 @param Value Expression value to compare on.
1055 @retval BufLen Return the buffer length.
1060 IN EFI_HII_VALUE
*Value
1063 switch (Value
->Type
) {
1064 case EFI_IFR_TYPE_BUFFER
:
1065 return Value
->BufferLen
;
1067 case EFI_IFR_TYPE_DATE
:
1068 return (UINT16
) sizeof (EFI_HII_DATE
);
1070 case EFI_IFR_TYPE_TIME
:
1071 return (UINT16
) sizeof (EFI_HII_TIME
);
1073 case EFI_IFR_TYPE_REF
:
1074 return (UINT16
) sizeof (EFI_HII_REF
);
1082 Return the buffer pointer for this value.
1084 EFI_IFR_TYPE_REF, EFI_IFR_TYPE_DATE and EFI_IFR_TYPE_TIME are converted to
1085 EFI_IFR_TYPE_BUFFER when do the value compare.
1087 @param Value Expression value to compare on.
1089 @retval Buf Return the buffer pointer.
1094 IN EFI_HII_VALUE
*Value
1097 switch (Value
->Type
) {
1098 case EFI_IFR_TYPE_BUFFER
:
1099 return Value
->Buffer
;
1101 case EFI_IFR_TYPE_DATE
:
1102 return (UINT8
*) (&Value
->Value
.date
);
1104 case EFI_IFR_TYPE_TIME
:
1105 return (UINT8
*) (&Value
->Value
.time
);
1107 case EFI_IFR_TYPE_REF
:
1108 return (UINT8
*) (&Value
->Value
.ref
);
1116 Evaluate opcode EFI_IFR_TO_STRING.
1118 @param FormSet Formset which contains this opcode.
1119 @param Format String format in EFI_IFR_TO_STRING.
1120 @param Result Evaluation result for this opcode.
1122 @retval EFI_SUCCESS Opcode evaluation success.
1123 @retval Other Opcode evaluation failed.
1128 IN FORM_BROWSER_FORMSET
*FormSet
,
1130 OUT EFI_HII_VALUE
*Result
1134 EFI_HII_VALUE Value
;
1136 CHAR16
*PrintFormat
;
1137 CHAR16 Buffer
[MAXIMUM_VALUE_CHARACTERS
];
1143 Status
= PopExpression (&Value
);
1144 if (EFI_ERROR (Status
)) {
1148 switch (Value
.Type
) {
1149 case EFI_IFR_TYPE_NUM_SIZE_8
:
1150 case EFI_IFR_TYPE_NUM_SIZE_16
:
1151 case EFI_IFR_TYPE_NUM_SIZE_32
:
1152 case EFI_IFR_TYPE_NUM_SIZE_64
:
1153 BufferSize
= MAXIMUM_VALUE_CHARACTERS
* sizeof (CHAR16
);
1155 case EFI_IFR_STRING_UNSIGNED_DEC
:
1156 case EFI_IFR_STRING_SIGNED_DEC
:
1157 PrintFormat
= L
"%ld";
1160 case EFI_IFR_STRING_LOWERCASE_HEX
:
1161 PrintFormat
= L
"%lx";
1164 case EFI_IFR_STRING_UPPERCASE_HEX
:
1165 PrintFormat
= L
"%lX";
1169 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1172 UnicodeSPrint (Buffer
, BufferSize
, PrintFormat
, Value
.Value
.u64
);
1176 case EFI_IFR_TYPE_STRING
:
1177 CopyMem (Result
, &Value
, sizeof (EFI_HII_VALUE
));
1180 case EFI_IFR_TYPE_BOOLEAN
:
1181 String
= (Value
.Value
.b
) ? L
"True" : L
"False";
1184 case EFI_IFR_TYPE_BUFFER
:
1185 case EFI_IFR_TYPE_DATE
:
1186 case EFI_IFR_TYPE_TIME
:
1187 case EFI_IFR_TYPE_REF
:
1189 // + 3 is base on the unicode format, the length may be odd number,
1190 // so need 1 byte to align, also need 2 bytes for L'\0'.
1192 if (Value
.Type
== EFI_IFR_TYPE_BUFFER
) {
1193 SrcLen
= Value
.BufferLen
;
1194 SrcBuf
= Value
.Buffer
;
1196 SrcBuf
= GetBufferForValue(&Value
);
1197 SrcLen
= GetLengthForValue(&Value
);
1200 TmpBuf
= AllocateZeroPool (SrcLen
+ 3);
1201 ASSERT (TmpBuf
!= NULL
);
1202 if (Format
== EFI_IFR_STRING_ASCII
) {
1203 CopyMem (TmpBuf
, SrcBuf
, SrcLen
);
1204 PrintFormat
= L
"%a";
1206 // Format == EFI_IFR_STRING_UNICODE
1207 CopyMem (TmpBuf
, SrcBuf
, SrcLen
* sizeof (CHAR16
));
1208 PrintFormat
= L
"%s";
1210 UnicodeSPrint (Buffer
, sizeof (Buffer
), PrintFormat
, TmpBuf
);
1213 if (Value
.Type
== EFI_IFR_TYPE_BUFFER
) {
1214 FreePool (Value
.Buffer
);
1219 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1223 Result
->Type
= EFI_IFR_TYPE_STRING
;
1224 Result
->Value
.string
= NewString (String
, FormSet
->HiiHandle
);
1230 Evaluate opcode EFI_IFR_TO_UINT.
1232 @param FormSet Formset which contains this opcode.
1233 @param Result Evaluation result for this opcode.
1235 @retval EFI_SUCCESS Opcode evaluation success.
1236 @retval Other Opcode evaluation failed.
1241 IN FORM_BROWSER_FORMSET
*FormSet
,
1242 OUT EFI_HII_VALUE
*Result
1246 EFI_HII_VALUE Value
;
1250 Status
= PopExpression (&Value
);
1251 if (EFI_ERROR (Status
)) {
1255 if (Value
.Type
>= EFI_IFR_TYPE_OTHER
&& !IsTypeInBuffer(&Value
)) {
1256 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1260 Status
= EFI_SUCCESS
;
1261 if (Value
.Type
== EFI_IFR_TYPE_STRING
) {
1262 String
= GetToken (Value
.Value
.string
, FormSet
->HiiHandle
);
1263 if (String
== NULL
) {
1264 return EFI_NOT_FOUND
;
1267 IfrStrToUpper (String
);
1268 StringPtr
= StrStr (String
, L
"0X");
1269 if (StringPtr
!= NULL
) {
1273 Result
->Value
.u64
= StrHexToUint64 (String
);
1278 Result
->Value
.u64
= StrDecimalToUint64 (String
);
1281 } else if (IsTypeInBuffer(&Value
)) {
1282 if (GetLengthForValue (&Value
) > 8) {
1283 if (Value
.Type
== EFI_IFR_TYPE_BUFFER
) {
1284 FreePool (Value
.Buffer
);
1286 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1289 Result
->Value
.u64
= *(UINT64
*) GetBufferForValue (&Value
);
1290 if (Value
.Type
== EFI_IFR_TYPE_BUFFER
) {
1291 FreePool (Value
.Buffer
);
1294 CopyMem (Result
, &Value
, sizeof (EFI_HII_VALUE
));
1297 Result
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
1303 Evaluate opcode EFI_IFR_CATENATE.
1305 @param FormSet Formset which contains this opcode.
1306 @param Result Evaluation result for this opcode.
1308 @retval EFI_SUCCESS Opcode evaluation success.
1309 @retval Other Opcode evaluation failed.
1314 IN FORM_BROWSER_FORMSET
*FormSet
,
1315 OUT EFI_HII_VALUE
*Result
1319 EFI_HII_VALUE Value
[2];
1329 // String[0] - The second string
1330 // String[1] - The first string
1335 Status
= EFI_SUCCESS
;
1336 ZeroMem (Value
, sizeof (Value
));
1338 Status
= PopExpression (&Value
[0]);
1339 if (EFI_ERROR (Status
)) {
1343 Status
= PopExpression (&Value
[1]);
1344 if (EFI_ERROR (Status
)) {
1348 for (Index
= 0; Index
< 2; Index
++) {
1349 if (Value
[Index
].Type
!= EFI_IFR_TYPE_STRING
&& !IsTypeInBuffer(&Value
[Index
])) {
1350 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1351 Status
= EFI_SUCCESS
;
1355 if (Value
[Index
].Type
== EFI_IFR_TYPE_STRING
) {
1356 String
[Index
] = GetToken (Value
[Index
].Value
.string
, FormSet
->HiiHandle
);
1357 if (String
[Index
] == NULL
) {
1358 Status
= EFI_NOT_FOUND
;
1364 if (Value
[0].Type
== EFI_IFR_TYPE_STRING
) {
1365 Size
= StrSize (String
[0]);
1366 StringPtr
= AllocatePool (StrSize (String
[1]) + Size
);
1367 ASSERT (StringPtr
!= NULL
);
1368 StrCpy (StringPtr
, String
[1]);
1369 StrCat (StringPtr
, String
[0]);
1371 Result
->Type
= EFI_IFR_TYPE_STRING
;
1372 Result
->Value
.string
= NewString (StringPtr
, FormSet
->HiiHandle
);
1374 Result
->Type
= EFI_IFR_TYPE_BUFFER
;
1375 Length0
= GetLengthForValue(&Value
[0]);
1376 Length1
= GetLengthForValue(&Value
[1]);
1377 Result
->BufferLen
= (UINT16
) (Length0
+ Length1
);
1379 Result
->Buffer
= AllocateZeroPool (Result
->BufferLen
);
1380 ASSERT (Result
->Buffer
!= NULL
);
1382 TmpBuf
= GetBufferForValue(&Value
[0]);
1383 ASSERT (TmpBuf
!= NULL
);
1384 CopyMem (Result
->Buffer
, TmpBuf
, Length0
);
1385 TmpBuf
= GetBufferForValue(&Value
[1]);
1386 ASSERT (TmpBuf
!= NULL
);
1387 CopyMem (&Result
->Buffer
[Length0
], TmpBuf
, Length1
);
1390 if (Value
[0].Buffer
!= NULL
) {
1391 FreePool (Value
[0].Buffer
);
1393 if (Value
[1].Buffer
!= NULL
) {
1394 FreePool (Value
[1].Buffer
);
1396 if (String
[0] != NULL
) {
1397 FreePool (String
[0]);
1399 if (String
[1] != NULL
) {
1400 FreePool (String
[1]);
1402 if (StringPtr
!= NULL
) {
1403 FreePool (StringPtr
);
1411 Evaluate opcode EFI_IFR_MATCH.
1413 @param FormSet Formset which contains this opcode.
1414 @param Result Evaluation result for this opcode.
1416 @retval EFI_SUCCESS Opcode evaluation success.
1417 @retval Other Opcode evaluation failed.
1422 IN FORM_BROWSER_FORMSET
*FormSet
,
1423 OUT EFI_HII_VALUE
*Result
1427 EFI_HII_VALUE Value
[2];
1432 // String[0] - The string to search
1433 // String[1] - pattern
1437 Status
= EFI_SUCCESS
;
1438 ZeroMem (Value
, sizeof (Value
));
1440 Status
= PopExpression (&Value
[0]);
1441 if (EFI_ERROR (Status
)) {
1445 Status
= PopExpression (&Value
[1]);
1446 if (EFI_ERROR (Status
)) {
1450 for (Index
= 0; Index
< 2; Index
++) {
1451 if (Value
[Index
].Type
!= EFI_IFR_TYPE_STRING
) {
1452 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1453 Status
= EFI_SUCCESS
;
1457 String
[Index
] = GetToken (Value
[Index
].Value
.string
, FormSet
->HiiHandle
);
1458 if (String
[Index
] == NULL
) {
1459 Status
= EFI_NOT_FOUND
;
1464 Result
->Type
= EFI_IFR_TYPE_BOOLEAN
;
1465 Result
->Value
.b
= mUnicodeCollation
->MetaiMatch (mUnicodeCollation
, String
[0], String
[1]);
1468 if (String
[0] != NULL
) {
1469 FreePool (String
[0]);
1471 if (String
[1] != NULL
) {
1472 FreePool (String
[1]);
1479 Evaluate opcode EFI_IFR_MATCH2.
1481 @param FormSet Formset which contains this opcode.
1482 @param SyntaxType Syntax type for match2.
1483 @param Result Evaluation result for this opcode.
1485 @retval EFI_SUCCESS Opcode evaluation success.
1486 @retval Other Opcode evaluation failed.
1491 IN FORM_BROWSER_FORMSET
*FormSet
,
1492 IN EFI_GUID
*SyntaxType
,
1493 OUT EFI_HII_VALUE
*Result
1497 EFI_HII_VALUE Value
[2];
1501 EFI_HANDLE
*HandleBuffer
;
1503 EFI_REGULAR_EXPRESSION_PROTOCOL
*RegularExpressionProtocol
;
1504 UINTN RegExSyntaxTypeListSize
;
1505 EFI_REGEX_SYNTAX_TYPE
*RegExSyntaxTypeList
;
1506 UINTN CapturesCount
;
1509 // String[0] - The string to search
1510 // String[1] - pattern
1514 HandleBuffer
= NULL
;
1515 RegExSyntaxTypeList
= NULL
;
1516 Status
= EFI_SUCCESS
;
1517 ZeroMem (Value
, sizeof (Value
));
1519 Status
= PopExpression (&Value
[0]);
1520 if (EFI_ERROR (Status
)) {
1524 Status
= PopExpression (&Value
[1]);
1525 if (EFI_ERROR (Status
)) {
1529 for (Index
= 0; Index
< 2; Index
++) {
1530 if (Value
[Index
].Type
!= EFI_IFR_TYPE_STRING
) {
1531 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1532 Status
= EFI_SUCCESS
;
1536 String
[Index
] = GetToken (Value
[Index
].Value
.string
, FormSet
->HiiHandle
);
1537 if (String
[Index
] == NULL
) {
1538 Status
= EFI_NOT_FOUND
;
1544 HandleBuffer
= NULL
;
1545 Status
= gBS
->LocateHandle(
1547 &gEfiRegularExpressionProtocolGuid
,
1551 if (Status
== EFI_BUFFER_TOO_SMALL
) {
1552 HandleBuffer
= AllocateZeroPool(BufferSize
);
1553 if (HandleBuffer
== NULL
) {
1554 Status
= EFI_OUT_OF_RESOURCES
;
1557 Status
= gBS
->LocateHandle(
1559 &gEfiRegularExpressionProtocolGuid
,
1566 if (EFI_ERROR (Status
)) {
1567 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1568 Status
= EFI_SUCCESS
;
1572 ASSERT (HandleBuffer
!= NULL
);
1573 for ( Index
= 0; Index
< BufferSize
/ sizeof(EFI_HANDLE
); Index
++) {
1574 Status
= gBS
->HandleProtocol (
1575 HandleBuffer
[Index
],
1576 &gEfiRegularExpressionProtocolGuid
,
1577 (VOID
**)&RegularExpressionProtocol
1579 if (EFI_ERROR (Status
)) {
1583 RegExSyntaxTypeListSize
= 0;
1584 RegExSyntaxTypeList
= NULL
;
1586 Status
= RegularExpressionProtocol
->GetInfo (
1587 RegularExpressionProtocol
,
1588 &RegExSyntaxTypeListSize
,
1591 if (Status
== EFI_BUFFER_TOO_SMALL
) {
1592 RegExSyntaxTypeList
= AllocateZeroPool(RegExSyntaxTypeListSize
);
1593 if (RegExSyntaxTypeList
== NULL
) {
1594 Status
= EFI_OUT_OF_RESOURCES
;
1597 Status
= RegularExpressionProtocol
->GetInfo (
1598 RegularExpressionProtocol
,
1599 &RegExSyntaxTypeListSize
,
1602 } else if (EFI_ERROR (Status
)) {
1606 for (GuidIndex
= 0; GuidIndex
< RegExSyntaxTypeListSize
/ sizeof(EFI_GUID
); GuidIndex
++) {
1607 if (CompareGuid (&RegExSyntaxTypeList
[GuidIndex
], SyntaxType
)) {
1609 // Find the match type, return the value.
1611 Result
->Type
= EFI_IFR_TYPE_BOOLEAN
;
1612 Status
= RegularExpressionProtocol
->MatchString (
1613 RegularExpressionProtocol
,
1625 if (RegExSyntaxTypeList
!= NULL
) {
1626 FreePool (RegExSyntaxTypeList
);
1631 // Type specified by SyntaxType is not supported
1632 // in any of the EFI_REGULAR_EXPRESSION_PROTOCOL instances.
1634 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1635 Status
= EFI_SUCCESS
;
1638 if (String
[0] != NULL
) {
1639 FreePool (String
[0]);
1641 if (String
[1] != NULL
) {
1642 FreePool (String
[1]);
1644 if (RegExSyntaxTypeList
!= NULL
) {
1645 FreePool (RegExSyntaxTypeList
);
1647 if (HandleBuffer
!= NULL
) {
1648 FreePool (HandleBuffer
);
1654 Evaluate opcode EFI_IFR_FIND.
1656 @param FormSet Formset which contains this opcode.
1657 @param Format Case sensitive or insensitive.
1658 @param Result Evaluation result for this opcode.
1660 @retval EFI_SUCCESS Opcode evaluation success.
1661 @retval Other Opcode evaluation failed.
1666 IN FORM_BROWSER_FORMSET
*FormSet
,
1668 OUT EFI_HII_VALUE
*Result
1672 EFI_HII_VALUE Value
[3];
1678 ZeroMem (Value
, sizeof (Value
));
1680 if (Format
> EFI_IFR_FF_CASE_INSENSITIVE
) {
1681 return EFI_INVALID_PARAMETER
;
1684 Status
= PopExpression (&Value
[0]);
1685 if (EFI_ERROR (Status
)) {
1689 Status
= PopExpression (&Value
[1]);
1690 if (EFI_ERROR (Status
)) {
1694 Status
= PopExpression (&Value
[2]);
1695 if (EFI_ERROR (Status
)) {
1699 if (Value
[0].Type
> EFI_IFR_TYPE_NUM_SIZE_64
) {
1700 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1703 Base
= (UINTN
) Value
[0].Value
.u64
;
1706 // String[0] - sub-string
1707 // String[1] - The string to search
1711 for (Index
= 0; Index
< 2; Index
++) {
1712 if (Value
[Index
+ 1].Type
!= EFI_IFR_TYPE_STRING
) {
1713 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1714 Status
= EFI_SUCCESS
;
1718 String
[Index
] = GetToken (Value
[Index
+ 1].Value
.string
, FormSet
->HiiHandle
);
1719 if (String
[Index
] == NULL
) {
1720 Status
= EFI_NOT_FOUND
;
1724 if (Format
== EFI_IFR_FF_CASE_INSENSITIVE
) {
1726 // Case insensitive, convert both string to upper case
1728 IfrStrToUpper (String
[Index
]);
1732 Result
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
1733 if (Base
>= StrLen (String
[1])) {
1734 Result
->Value
.u64
= 0xFFFFFFFFFFFFFFFFULL
;
1736 StringPtr
= StrStr (String
[1] + Base
, String
[0]);
1737 Result
->Value
.u64
= (StringPtr
== NULL
) ? 0xFFFFFFFFFFFFFFFFULL
: (StringPtr
- String
[1]);
1741 if (String
[0] != NULL
) {
1742 FreePool (String
[0]);
1744 if (String
[1] != NULL
) {
1745 FreePool (String
[1]);
1753 Evaluate opcode EFI_IFR_MID.
1755 @param FormSet Formset which contains this opcode.
1756 @param Result Evaluation result for this opcode.
1758 @retval EFI_SUCCESS Opcode evaluation success.
1759 @retval Other Opcode evaluation failed.
1764 IN FORM_BROWSER_FORMSET
*FormSet
,
1765 OUT EFI_HII_VALUE
*Result
1769 EFI_HII_VALUE Value
[3];
1777 ZeroMem (Value
, sizeof (Value
));
1779 Status
= PopExpression (&Value
[0]);
1780 if (EFI_ERROR (Status
)) {
1784 Status
= PopExpression (&Value
[1]);
1785 if (EFI_ERROR (Status
)) {
1789 Status
= PopExpression (&Value
[2]);
1790 if (EFI_ERROR (Status
)) {
1794 if (Value
[0].Type
> EFI_IFR_TYPE_NUM_SIZE_64
) {
1795 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1798 Length
= (UINTN
) Value
[0].Value
.u64
;
1800 if (Value
[1].Type
> EFI_IFR_TYPE_NUM_SIZE_64
) {
1801 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1804 Base
= (UINTN
) Value
[1].Value
.u64
;
1806 if (Value
[2].Type
!= EFI_IFR_TYPE_STRING
&& !IsTypeInBuffer(&Value
[2])) {
1807 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1810 if (Value
[2].Type
== EFI_IFR_TYPE_STRING
) {
1811 String
= GetToken (Value
[2].Value
.string
, FormSet
->HiiHandle
);
1812 if (String
== NULL
) {
1813 return EFI_NOT_FOUND
;
1816 if (Length
== 0 || Base
>= StrLen (String
)) {
1817 SubString
= gEmptyString
;
1819 SubString
= String
+ Base
;
1820 if ((Base
+ Length
) < StrLen (String
)) {
1821 SubString
[Length
] = L
'\0';
1825 Result
->Type
= EFI_IFR_TYPE_STRING
;
1826 Result
->Value
.string
= NewString (SubString
, FormSet
->HiiHandle
);
1830 BufferLen
= GetLengthForValue (&Value
[2]);
1831 Buffer
= GetBufferForValue (&Value
[2]);
1833 Result
->Type
= EFI_IFR_TYPE_BUFFER
;
1834 if (Length
== 0 || Base
>= BufferLen
) {
1835 Result
->BufferLen
= 0;
1836 Result
->Buffer
= NULL
;
1838 Result
->BufferLen
= (UINT16
)((BufferLen
- Base
) < Length
? (BufferLen
- Base
) : Length
);
1839 Result
->Buffer
= AllocateZeroPool (Result
->BufferLen
);
1840 ASSERT (Result
->Buffer
!= NULL
);
1841 CopyMem (Result
->Buffer
, &Buffer
[Base
], Result
->BufferLen
);
1844 if (Value
[2].Type
== EFI_IFR_TYPE_BUFFER
) {
1845 FreePool (Value
[2].Buffer
);
1854 Evaluate opcode EFI_IFR_TOKEN.
1856 @param FormSet Formset which contains this opcode.
1857 @param Result Evaluation result for this opcode.
1859 @retval EFI_SUCCESS Opcode evaluation success.
1860 @retval Other Opcode evaluation failed.
1865 IN FORM_BROWSER_FORMSET
*FormSet
,
1866 OUT EFI_HII_VALUE
*Result
1870 EFI_HII_VALUE Value
[3];
1878 ZeroMem (Value
, sizeof (Value
));
1880 Status
= PopExpression (&Value
[0]);
1881 if (EFI_ERROR (Status
)) {
1885 Status
= PopExpression (&Value
[1]);
1886 if (EFI_ERROR (Status
)) {
1890 Status
= PopExpression (&Value
[2]);
1891 if (EFI_ERROR (Status
)) {
1895 if (Value
[0].Type
> EFI_IFR_TYPE_NUM_SIZE_64
) {
1896 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1899 Count
= (UINTN
) Value
[0].Value
.u64
;
1902 // String[0] - Delimiter
1903 // String[1] - The string to search
1907 for (Index
= 0; Index
< 2; Index
++) {
1908 if (Value
[Index
+ 1].Type
!= EFI_IFR_TYPE_STRING
) {
1909 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
1910 Status
= EFI_SUCCESS
;
1914 String
[Index
] = GetToken (Value
[Index
+ 1].Value
.string
, FormSet
->HiiHandle
);
1915 if (String
[Index
] == NULL
) {
1916 Status
= EFI_NOT_FOUND
;
1921 Delimiter
= String
[0];
1922 SubString
= String
[1];
1924 SubString
= StrStr (SubString
, Delimiter
);
1925 if (SubString
!= NULL
) {
1927 // Skip over the delimiter
1929 SubString
= SubString
+ StrLen (Delimiter
);
1936 if (SubString
== NULL
) {
1938 // nth delimited sub-string not found, push an empty string
1940 SubString
= gEmptyString
;
1943 // Put a NULL terminator for nth delimited sub-string
1945 StringPtr
= StrStr (SubString
, Delimiter
);
1946 if (StringPtr
!= NULL
) {
1951 Result
->Type
= EFI_IFR_TYPE_STRING
;
1952 Result
->Value
.string
= NewString (SubString
, FormSet
->HiiHandle
);
1955 if (String
[0] != NULL
) {
1956 FreePool (String
[0]);
1958 if (String
[1] != NULL
) {
1959 FreePool (String
[1]);
1967 Evaluate opcode EFI_IFR_SPAN.
1969 @param FormSet Formset which contains this opcode.
1970 @param Flags FIRST_MATCHING or FIRST_NON_MATCHING.
1971 @param Result Evaluation result for this opcode.
1973 @retval EFI_SUCCESS Opcode evaluation success.
1974 @retval Other Opcode evaluation failed.
1979 IN FORM_BROWSER_FORMSET
*FormSet
,
1981 OUT EFI_HII_VALUE
*Result
1985 EFI_HII_VALUE Value
[3];
1993 ZeroMem (Value
, sizeof (Value
));
1995 Status
= PopExpression (&Value
[0]);
1996 if (EFI_ERROR (Status
)) {
2000 Status
= PopExpression (&Value
[1]);
2001 if (EFI_ERROR (Status
)) {
2005 Status
= PopExpression (&Value
[2]);
2006 if (EFI_ERROR (Status
)) {
2010 if (Value
[0].Type
> EFI_IFR_TYPE_NUM_SIZE_64
) {
2011 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2014 Base
= (UINTN
) Value
[0].Value
.u64
;
2017 // String[0] - Charset
2018 // String[1] - The string to search
2022 for (Index
= 0; Index
< 2; Index
++) {
2023 if (Value
[Index
+ 1].Type
!= EFI_IFR_TYPE_STRING
) {
2024 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2025 Status
= EFI_SUCCESS
;
2029 String
[Index
] = GetToken (Value
[Index
+ 1].Value
.string
, FormSet
->HiiHandle
);
2030 if (String
[Index
] == NULL
) {
2031 Status
= EFI_NOT_FOUND
;
2036 if (Base
>= StrLen (String
[1])) {
2037 Result
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2038 Status
= EFI_SUCCESS
;
2043 StringPtr
= String
[1] + Base
;
2044 Charset
= String
[0];
2045 while (*StringPtr
!= 0 && !Found
) {
2047 while (Charset
[Index
] != 0) {
2048 if (*StringPtr
>= Charset
[Index
] && *StringPtr
<= Charset
[Index
+ 1]) {
2049 if (Flags
== EFI_IFR_FLAGS_FIRST_MATCHING
) {
2054 if (Flags
== EFI_IFR_FLAGS_FIRST_NON_MATCHING
) {
2060 // Skip characters pair representing low-end of a range and high-end of a range
2070 Result
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
2071 Result
->Value
.u64
= StringPtr
- String
[1];
2074 if (String
[0] != NULL
) {
2075 FreePool (String
[0]);
2077 if (String
[1] != NULL
) {
2078 FreePool (String
[1]);
2086 Zero extend integer/boolean/date/time to UINT64 for comparing.
2088 @param Value HII Value to be converted.
2093 IN EFI_HII_VALUE
*Value
2099 switch (Value
->Type
) {
2100 case EFI_IFR_TYPE_NUM_SIZE_8
:
2101 Temp
= Value
->Value
.u8
;
2104 case EFI_IFR_TYPE_NUM_SIZE_16
:
2105 Temp
= Value
->Value
.u16
;
2108 case EFI_IFR_TYPE_NUM_SIZE_32
:
2109 Temp
= Value
->Value
.u32
;
2112 case EFI_IFR_TYPE_BOOLEAN
:
2113 Temp
= Value
->Value
.b
;
2116 case EFI_IFR_TYPE_TIME
:
2117 Temp
= Value
->Value
.u32
& 0xffffff;
2120 case EFI_IFR_TYPE_DATE
:
2121 Temp
= Value
->Value
.u32
;
2128 Value
->Value
.u64
= Temp
;
2132 Get UINT64 type value.
2134 @param Value Input Hii value.
2136 @retval UINT64 Return the UINT64 type value.
2141 IN EFI_HII_VALUE
*Value
2148 switch (Value
->Type
) {
2149 case EFI_IFR_TYPE_NUM_SIZE_8
:
2150 RetVal
= Value
->Value
.u8
;
2153 case EFI_IFR_TYPE_NUM_SIZE_16
:
2154 RetVal
= Value
->Value
.u16
;
2157 case EFI_IFR_TYPE_NUM_SIZE_32
:
2158 RetVal
= Value
->Value
.u32
;
2161 case EFI_IFR_TYPE_BOOLEAN
:
2162 RetVal
= Value
->Value
.b
;
2165 case EFI_IFR_TYPE_DATE
:
2166 RetVal
= *(UINT64
*) &Value
->Value
.date
;
2169 case EFI_IFR_TYPE_TIME
:
2170 RetVal
= (*(UINT64
*) &Value
->Value
.time
) & 0xffffff;
2174 RetVal
= Value
->Value
.u64
;
2182 Compare two Hii value.
2184 @param Value1 Expression value to compare on left-hand.
2185 @param Value2 Expression value to compare on right-hand.
2186 @param Result Return value after compare.
2187 retval 0 Two operators equal.
2188 return Positive value if Value1 is greater than Value2.
2189 retval Negative value if Value1 is less than Value2.
2190 @param HiiHandle Only required for string compare.
2192 @retval other Could not perform compare on two values.
2193 @retval EFI_SUCCESS Compare the value success.
2198 IN EFI_HII_VALUE
*Value1
,
2199 IN EFI_HII_VALUE
*Value2
,
2201 IN EFI_HII_HANDLE HiiHandle OPTIONAL
2213 if (Value1
->Type
== EFI_IFR_TYPE_STRING
&& Value2
->Type
== EFI_IFR_TYPE_STRING
) {
2214 if (Value1
->Value
.string
== 0 || Value2
->Value
.string
== 0) {
2216 // StringId 0 is reserved
2218 return EFI_INVALID_PARAMETER
;
2221 if (Value1
->Value
.string
== Value2
->Value
.string
) {
2226 Str1
= GetToken (Value1
->Value
.string
, HiiHandle
);
2231 return EFI_NOT_FOUND
;
2234 Str2
= GetToken (Value2
->Value
.string
, HiiHandle
);
2237 return EFI_NOT_FOUND
;
2240 *Result
= StrCmp (Str1
, Str2
);
2249 // Take types(date, time, ref, buffer) as buffer
2251 if (IsTypeInBuffer(Value1
) && IsTypeInBuffer(Value2
)) {
2252 Buf1
= GetBufferForValue(Value1
);
2253 Buf1Len
= GetLengthForValue(Value1
);
2254 Buf2
= GetBufferForValue(Value2
);
2255 Buf2Len
= GetLengthForValue(Value2
);
2257 Len
= Buf1Len
> Buf2Len
? Buf2Len
: Buf1Len
;
2258 *Result
= CompareMem (Buf1
, Buf2
, Len
);
2259 if ((*Result
== 0) && (Buf1Len
!= Buf2Len
)) {
2261 // In this case, means base on samll number buffer, the data is same
2262 // So which value has more data, which value is bigger.
2264 *Result
= Buf1Len
> Buf2Len
? 1 : -1;
2270 // Take types(integer, boolean) as integer
2272 if (IsTypeInUINT64(Value1
) && IsTypeInUINT64(Value2
)) {
2273 Temp64
= HiiValueToUINT64(Value1
) - HiiValueToUINT64(Value2
);
2276 } else if (Temp64
< 0) {
2285 return EFI_UNSUPPORTED
;
2289 Check if current user has the privilege specified by the permissions GUID.
2291 @param[in] Guid A GUID specifying setup access permissions.
2293 @retval TRUE Current user has the privilege.
2294 @retval FALSE Current user does not have the privilege.
2297 CheckUserPrivilege (
2302 EFI_USER_PROFILE_HANDLE UserProfileHandle
;
2303 EFI_USER_INFO_HANDLE UserInfoHandle
;
2304 EFI_USER_INFO
*UserInfo
;
2305 EFI_GUID
*UserPermissionsGuid
;
2307 UINTN AccessControlDataSize
;
2308 EFI_USER_INFO_ACCESS_CONTROL
*AccessControl
;
2311 if (mUserManager
== NULL
) {
2312 Status
= gBS
->LocateProtocol (
2313 &gEfiUserManagerProtocolGuid
,
2315 (VOID
**) &mUserManager
2317 if (EFI_ERROR (Status
)) {
2319 /// If the system does not support user management, then it is assumed that
2320 /// all users have admin privilege and evaluation of each EFI_IFR_SECURITY
2321 /// op-code is always TRUE.
2327 Status
= mUserManager
->Current (mUserManager
, &UserProfileHandle
);
2328 ASSERT_EFI_ERROR (Status
);
2331 /// Enumerate all user information of the current user profile
2332 /// to look for any EFI_USER_INFO_ACCESS_SETUP record.
2335 for (UserInfoHandle
= NULL
;;) {
2336 Status
= mUserManager
->GetNextInfo (mUserManager
, UserProfileHandle
, &UserInfoHandle
);
2337 if (EFI_ERROR (Status
)) {
2342 Status
= mUserManager
->GetInfo (mUserManager
, UserProfileHandle
, UserInfoHandle
, NULL
, &UserInfoSize
);
2343 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
2347 UserInfo
= (EFI_USER_INFO
*) AllocatePool (UserInfoSize
);
2348 if (UserInfo
== NULL
) {
2352 Status
= mUserManager
->GetInfo (mUserManager
, UserProfileHandle
, UserInfoHandle
, UserInfo
, &UserInfoSize
);
2353 if (EFI_ERROR (Status
) ||
2354 UserInfo
->InfoType
!= EFI_USER_INFO_ACCESS_POLICY_RECORD
||
2355 UserInfo
->InfoSize
<= sizeof (EFI_USER_INFO
)) {
2356 FreePool (UserInfo
);
2360 RemainSize
= UserInfo
->InfoSize
- sizeof (EFI_USER_INFO
);
2361 AccessControl
= (EFI_USER_INFO_ACCESS_CONTROL
*)(UserInfo
+ 1);
2362 while (RemainSize
>= sizeof (EFI_USER_INFO_ACCESS_CONTROL
)) {
2363 if (RemainSize
< AccessControl
->Size
|| AccessControl
->Size
< sizeof (EFI_USER_INFO_ACCESS_CONTROL
)) {
2366 if (AccessControl
->Type
== EFI_USER_INFO_ACCESS_SETUP
) {
2368 /// Check if current user has the privilege specified by the permissions GUID.
2371 UserPermissionsGuid
= (EFI_GUID
*)(AccessControl
+ 1);
2372 AccessControlDataSize
= AccessControl
->Size
- sizeof (EFI_USER_INFO_ACCESS_CONTROL
);
2373 while (AccessControlDataSize
>= sizeof (EFI_GUID
)) {
2374 if (CompareGuid (Guid
, UserPermissionsGuid
)) {
2375 FreePool (UserInfo
);
2378 UserPermissionsGuid
++;
2379 AccessControlDataSize
-= sizeof (EFI_GUID
);
2382 RemainSize
-= AccessControl
->Size
;
2383 AccessControl
= (EFI_USER_INFO_ACCESS_CONTROL
*)((UINT8
*)AccessControl
+ AccessControl
->Size
);
2386 FreePool (UserInfo
);
2392 Get question value from the predefined formset.
2394 @param DevicePath The driver's device path which produece the formset data.
2395 @param InputHiiHandle The hii handle associate with the formset data.
2396 @param FormSetGuid The formset guid which include the question.
2397 @param QuestionId The question id which need to get value from.
2398 @param Value The return data about question's value.
2400 @retval TRUE Get the question value success.
2401 @retval FALSE Get the question value failed.
2404 GetQuestionValueFromForm (
2405 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
2406 IN EFI_HII_HANDLE InputHiiHandle
,
2407 IN EFI_GUID
*FormSetGuid
,
2408 IN EFI_QUESTION_ID QuestionId
,
2409 OUT EFI_HII_VALUE
*Value
2413 EFI_HII_HANDLE HiiHandle
;
2414 FORM_BROWSER_STATEMENT
*Question
;
2415 FORM_BROWSER_FORMSET
*FormSet
;
2416 FORM_BROWSER_FORM
*Form
;
2421 // The input parameter DevicePath or InputHiiHandle must have one valid input.
2423 ASSERT ((DevicePath
!= NULL
&& InputHiiHandle
== NULL
) ||
2424 (DevicePath
== NULL
&& InputHiiHandle
!= NULL
) );
2434 if (DevicePath
!= NULL
) {
2435 HiiHandle
= DevicePathToHiiHandle (DevicePath
, FormSetGuid
);
2436 if (HiiHandle
== NULL
) {
2440 HiiHandle
= InputHiiHandle
;
2442 ASSERT (HiiHandle
!= NULL
);
2445 // Get the formset data include this question.
2447 FormSet
= AllocateZeroPool (sizeof (FORM_BROWSER_FORMSET
));
2448 ASSERT (FormSet
!= NULL
);
2449 Status
= InitializeFormSet(HiiHandle
, FormSetGuid
, FormSet
);
2450 if (EFI_ERROR (Status
)) {
2456 // Base on the Question Id to get the question info.
2458 Question
= IdToQuestion(FormSet
, NULL
, QuestionId
);
2459 if (Question
== NULL
) {
2465 // Search form in the formset scope
2467 Link
= GetFirstNode (&FormSet
->FormListHead
);
2468 while (!IsNull (&FormSet
->FormListHead
, Link
)) {
2469 Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
2471 Question
= IdToQuestion2 (Form
, QuestionId
);
2472 if (Question
!= NULL
) {
2476 Link
= GetNextNode (&FormSet
->FormListHead
, Link
);
2479 ASSERT (Form
!= NULL
);
2482 // Get the question value.
2484 Status
= GetQuestionValue(FormSet
, Form
, Question
, GetSetValueWithHiiDriver
);
2485 if (EFI_ERROR (Status
)) {
2490 CopyMem (Value
, &Question
->HiiValue
, sizeof (EFI_HII_VALUE
));
2494 // Clean the formset structure and restore the global parameter.
2496 if (FormSet
!= NULL
) {
2497 DestroyFormSet (FormSet
);
2504 Evaluate the result of a HII expression.
2506 If Expression is NULL, then ASSERT.
2508 @param FormSet FormSet associated with this expression.
2509 @param Form Form associated with this expression.
2510 @param Expression Expression to be evaluated.
2512 @retval EFI_SUCCESS The expression evaluated successfuly
2513 @retval EFI_NOT_FOUND The Question which referenced by a QuestionId
2515 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the
2517 @retval EFI_ACCESS_DENIED The pop operation underflowed the stack
2518 @retval EFI_INVALID_PARAMETER Syntax error with the Expression
2522 EvaluateExpression (
2523 IN FORM_BROWSER_FORMSET
*FormSet
,
2524 IN FORM_BROWSER_FORM
*Form
,
2525 IN OUT FORM_EXPRESSION
*Expression
2530 EXPRESSION_OPCODE
*OpCode
;
2531 FORM_BROWSER_STATEMENT
*Question
;
2532 FORM_BROWSER_STATEMENT
*Question2
;
2534 EFI_HII_VALUE Data1
;
2535 EFI_HII_VALUE Data2
;
2536 EFI_HII_VALUE Data3
;
2537 FORM_EXPRESSION
*RuleExpression
;
2538 EFI_HII_VALUE
*Value
;
2543 LIST_ENTRY
*SubExpressionLink
;
2544 FORM_EXPRESSION
*SubExpression
;
2551 EFI_HII_VALUE QuestionVal
;
2552 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
2557 // Save current stack offset.
2559 StackOffset
= SaveExpressionEvaluationStackOffset ();
2561 ASSERT (Expression
!= NULL
);
2562 Expression
->Result
.Type
= EFI_IFR_TYPE_OTHER
;
2564 Link
= GetFirstNode (&Expression
->OpCodeListHead
);
2565 while (!IsNull (&Expression
->OpCodeListHead
, Link
)) {
2566 OpCode
= EXPRESSION_OPCODE_FROM_LINK (Link
);
2568 Link
= GetNextNode (&Expression
->OpCodeListHead
, Link
);
2570 ZeroMem (&Data1
, sizeof (EFI_HII_VALUE
));
2571 ZeroMem (&Data2
, sizeof (EFI_HII_VALUE
));
2572 ZeroMem (&Data3
, sizeof (EFI_HII_VALUE
));
2575 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
2576 Status
= EFI_SUCCESS
;
2578 switch (OpCode
->Operand
) {
2580 // Built-in functions
2582 case EFI_IFR_EQ_ID_VAL_OP
:
2583 Question
= IdToQuestion (FormSet
, Form
, OpCode
->QuestionId
);
2584 if (Question
== NULL
) {
2585 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2589 Status
= CompareHiiValue (&Question
->HiiValue
, &OpCode
->Value
, &Result
, NULL
);
2590 if (Status
== EFI_UNSUPPORTED
) {
2591 Status
= EFI_SUCCESS
;
2592 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2596 if (EFI_ERROR (Status
)) {
2599 Value
->Value
.b
= (BOOLEAN
) ((Result
== 0) ? TRUE
: FALSE
);
2602 case EFI_IFR_EQ_ID_ID_OP
:
2603 Question
= IdToQuestion (FormSet
, Form
, OpCode
->QuestionId
);
2604 if (Question
== NULL
) {
2605 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2609 Question2
= IdToQuestion (FormSet
, Form
, OpCode
->QuestionId2
);
2610 if (Question2
== NULL
) {
2611 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2615 Status
= CompareHiiValue (&Question
->HiiValue
, &Question2
->HiiValue
, &Result
, FormSet
->HiiHandle
);
2616 if (Status
== EFI_UNSUPPORTED
) {
2617 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2618 Status
= EFI_SUCCESS
;
2621 if (EFI_ERROR (Status
)) {
2624 Value
->Value
.b
= (BOOLEAN
) ((Result
== 0) ? TRUE
: FALSE
);
2627 case EFI_IFR_EQ_ID_VAL_LIST_OP
:
2628 Question
= IdToQuestion (FormSet
, Form
, OpCode
->QuestionId
);
2629 if (Question
== NULL
) {
2630 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2634 Value
->Value
.b
= FALSE
;
2635 for (Index
=0; Index
< OpCode
->ListLength
; Index
++) {
2636 if (Question
->HiiValue
.Value
.u16
== OpCode
->ValueList
[Index
]) {
2637 Value
->Value
.b
= TRUE
;
2643 case EFI_IFR_DUP_OP
:
2644 Status
= PopExpression (Value
);
2645 if (EFI_ERROR (Status
)) {
2649 Status
= PushExpression (Value
);
2652 case EFI_IFR_QUESTION_REF1_OP
:
2653 case EFI_IFR_THIS_OP
:
2654 Question
= IdToQuestion (FormSet
, Form
, OpCode
->QuestionId
);
2655 if (Question
== NULL
) {
2656 Status
= EFI_NOT_FOUND
;
2660 Value
= &Question
->HiiValue
;
2663 case EFI_IFR_SECURITY_OP
:
2664 Value
->Value
.b
= CheckUserPrivilege (&OpCode
->Guid
);
2667 case EFI_IFR_GET_OP
:
2669 // Get Value from VarStore buffer, EFI VarStore, Name/Value VarStore.
2671 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2672 Value
->Value
.u8
= 0;
2673 if (OpCode
->VarStorage
!= NULL
) {
2674 switch (OpCode
->VarStorage
->Type
) {
2675 case EFI_HII_VARSTORE_BUFFER
:
2676 case EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
:
2678 // Get value from Edit Buffer
2680 Value
->Type
= OpCode
->ValueType
;
2681 CopyMem (&Value
->Value
, OpCode
->VarStorage
->EditBuffer
+ OpCode
->VarStoreInfo
.VarOffset
, OpCode
->ValueWidth
);
2683 case EFI_HII_VARSTORE_NAME_VALUE
:
2684 if (OpCode
->ValueType
!= EFI_IFR_TYPE_STRING
) {
2686 // Get value from string except for STRING value.
2688 Status
= GetValueByName (OpCode
->VarStorage
, OpCode
->ValueName
, &StrPtr
, GetSetValueWithEditBuffer
);
2689 if (!EFI_ERROR (Status
)) {
2690 ASSERT (StrPtr
!= NULL
);
2691 TempLength
= StrLen (StrPtr
);
2692 if (OpCode
->ValueWidth
>= ((TempLength
+ 1) / 2)) {
2693 Value
->Type
= OpCode
->ValueType
;
2694 TempBuffer
= (UINT8
*) &Value
->Value
;
2695 ZeroMem (TempStr
, sizeof (TempStr
));
2696 for (Index
= 0; Index
< TempLength
; Index
++) {
2697 TempStr
[0] = StrPtr
[TempLength
- Index
- 1];
2698 DigitUint8
= (UINT8
) StrHexToUint64 (TempStr
);
2699 if ((Index
& 1) == 0) {
2700 TempBuffer
[Index
/2] = DigitUint8
;
2702 TempBuffer
[Index
/2] = (UINT8
) ((DigitUint8
<< 4) + TempBuffer
[Index
/2]);
2709 case EFI_HII_VARSTORE_EFI_VARIABLE
:
2711 // Get value from variable.
2713 TempLength
= OpCode
->ValueWidth
;
2714 Value
->Type
= OpCode
->ValueType
;
2715 Status
= gRT
->GetVariable (
2717 &OpCode
->VarStorage
->Guid
,
2722 if (EFI_ERROR (Status
)) {
2723 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2724 Value
->Value
.u8
= 0;
2729 // Not recognize storage.
2731 Status
= EFI_UNSUPPORTED
;
2736 // For Time/Date Data
2738 if (OpCode
->ValueType
!= EFI_IFR_TYPE_DATE
&& OpCode
->ValueType
!= EFI_IFR_TYPE_TIME
) {
2740 // Only support Data/Time data when storage doesn't exist.
2742 Status
= EFI_UNSUPPORTED
;
2745 Status
= gRT
->GetTime (&EfiTime
, NULL
);
2746 if (!EFI_ERROR (Status
)) {
2747 if (OpCode
->ValueType
== EFI_IFR_TYPE_DATE
) {
2748 switch (OpCode
->VarStoreInfo
.VarOffset
) {
2750 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_16
;
2751 Value
->Value
.u16
= EfiTime
.Year
;
2754 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
2755 Value
->Value
.u8
= EfiTime
.Month
;
2758 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
2759 Value
->Value
.u8
= EfiTime
.Day
;
2763 // Invalid Date field.
2765 Status
= EFI_INVALID_PARAMETER
;
2769 switch (OpCode
->VarStoreInfo
.VarOffset
) {
2771 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
2772 Value
->Value
.u8
= EfiTime
.Hour
;
2775 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
2776 Value
->Value
.u8
= EfiTime
.Minute
;
2779 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_8
;
2780 Value
->Value
.u8
= EfiTime
.Second
;
2784 // Invalid Time field.
2786 Status
= EFI_INVALID_PARAMETER
;
2795 case EFI_IFR_QUESTION_REF3_OP
:
2797 // EFI_IFR_QUESTION_REF3
2798 // Pop an expression from the expression stack
2800 Status
= PopExpression (Value
);
2801 if (EFI_ERROR (Status
)) {
2806 // Validate the expression value
2808 if ((Value
->Type
> EFI_IFR_TYPE_NUM_SIZE_64
) || (Value
->Value
.u64
> 0xffff)) {
2809 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2813 if (OpCode
->DevicePath
!= 0) {
2814 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2816 StrPtr
= GetToken (OpCode
->DevicePath
, FormSet
->HiiHandle
);
2817 if (StrPtr
!= NULL
&& mPathFromText
!= NULL
) {
2818 DevicePath
= mPathFromText
->ConvertTextToDevicePath(StrPtr
);
2819 if (DevicePath
!= NULL
&& GetQuestionValueFromForm(DevicePath
, NULL
, &OpCode
->Guid
, Value
->Value
.u16
, &QuestionVal
)) {
2820 Value
= &QuestionVal
;
2822 if (DevicePath
!= NULL
) {
2823 FreePool (DevicePath
);
2827 if (StrPtr
!= NULL
) {
2830 } else if (CompareGuid (&OpCode
->Guid
, &gZeroGuid
) != 0) {
2831 if (!GetQuestionValueFromForm(NULL
, FormSet
->HiiHandle
, &OpCode
->Guid
, Value
->Value
.u16
, &QuestionVal
)){
2832 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2835 Value
= &QuestionVal
;
2837 Question
= IdToQuestion (FormSet
, Form
, Value
->Value
.u16
);
2838 if (Question
== NULL
) {
2839 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2844 // push the questions' value on to the expression stack
2846 Value
= &Question
->HiiValue
;
2850 case EFI_IFR_RULE_REF_OP
:
2852 // Find expression for this rule
2854 RuleExpression
= RuleIdToExpression (Form
, OpCode
->RuleId
);
2855 if (RuleExpression
== NULL
) {
2856 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2861 // Evaluate this rule expression
2863 Status
= EvaluateExpression (FormSet
, Form
, RuleExpression
);
2864 if (EFI_ERROR (Status
) || RuleExpression
->Result
.Type
== EFI_IFR_TYPE_UNDEFINED
) {
2865 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2869 Value
= &RuleExpression
->Result
;
2872 case EFI_IFR_STRING_REF1_OP
:
2873 Value
->Type
= EFI_IFR_TYPE_STRING
;
2874 Value
->Value
.string
= OpCode
->Value
.Value
.string
;
2880 case EFI_IFR_TRUE_OP
:
2881 case EFI_IFR_FALSE_OP
:
2882 case EFI_IFR_ONE_OP
:
2883 case EFI_IFR_ONES_OP
:
2884 case EFI_IFR_UINT8_OP
:
2885 case EFI_IFR_UINT16_OP
:
2886 case EFI_IFR_UINT32_OP
:
2887 case EFI_IFR_UINT64_OP
:
2888 case EFI_IFR_UNDEFINED_OP
:
2889 case EFI_IFR_VERSION_OP
:
2890 case EFI_IFR_ZERO_OP
:
2891 Value
= &OpCode
->Value
;
2897 case EFI_IFR_LENGTH_OP
:
2898 Status
= PopExpression (Value
);
2899 if (EFI_ERROR (Status
)) {
2902 if (Value
->Type
!= EFI_IFR_TYPE_STRING
&& !IsTypeInBuffer (Value
)) {
2903 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2907 if (Value
->Type
== EFI_IFR_TYPE_STRING
) {
2908 StrPtr
= GetToken (Value
->Value
.string
, FormSet
->HiiHandle
);
2909 if (StrPtr
== NULL
) {
2910 Status
= EFI_INVALID_PARAMETER
;
2914 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
2915 Value
->Value
.u64
= StrLen (StrPtr
);
2918 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
2919 Value
->Value
.u64
= GetLengthForValue(Value
);
2920 FreePool (Value
->Buffer
);
2924 case EFI_IFR_NOT_OP
:
2925 Status
= PopExpression (Value
);
2926 if (EFI_ERROR (Status
)) {
2929 if (Value
->Type
!= EFI_IFR_TYPE_BOOLEAN
) {
2930 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2933 Value
->Value
.b
= (BOOLEAN
) (!Value
->Value
.b
);
2936 case EFI_IFR_QUESTION_REF2_OP
:
2938 // Pop an expression from the expression stack
2940 Status
= PopExpression (Value
);
2941 if (EFI_ERROR (Status
)) {
2946 // Validate the expression value
2948 if ((Value
->Type
> EFI_IFR_TYPE_NUM_SIZE_64
) || (Value
->Value
.u64
> 0xffff)) {
2949 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2953 Question
= IdToQuestion (FormSet
, Form
, Value
->Value
.u16
);
2954 if (Question
== NULL
) {
2955 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2959 Value
= &Question
->HiiValue
;
2962 case EFI_IFR_STRING_REF2_OP
:
2964 // Pop an expression from the expression stack
2966 Status
= PopExpression (Value
);
2967 if (EFI_ERROR (Status
)) {
2972 // Validate the expression value
2974 if ((Value
->Type
> EFI_IFR_TYPE_NUM_SIZE_64
) || (Value
->Value
.u64
> 0xffff)) {
2975 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
2979 Value
->Type
= EFI_IFR_TYPE_STRING
;
2980 StrPtr
= GetToken (Value
->Value
.u16
, FormSet
->HiiHandle
);
2981 if (StrPtr
== NULL
) {
2983 // If String not exit, push an empty string
2985 Value
->Value
.string
= NewString (gEmptyString
, FormSet
->HiiHandle
);
2987 Index
= (UINT16
) Value
->Value
.u64
;
2988 Value
->Value
.string
= Index
;
2993 case EFI_IFR_TO_BOOLEAN_OP
:
2995 // Pop an expression from the expression stack
2997 Status
= PopExpression (Value
);
2998 if (EFI_ERROR (Status
)) {
3003 // Convert an expression to a Boolean
3005 if (Value
->Type
<= EFI_IFR_TYPE_DATE
) {
3007 // When converting from an unsigned integer, zero will be converted to
3008 // FALSE and any other value will be converted to TRUE.
3010 Value
->Value
.b
= (BOOLEAN
) (HiiValueToUINT64(Value
) != 0);
3012 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
3013 } else if (Value
->Type
== EFI_IFR_TYPE_STRING
) {
3015 // When converting from a string, if case-insensitive compare
3016 // with "true" is True, then push True. If a case-insensitive compare
3017 // with "false" is True, then push False. Otherwise, push Undefined.
3019 StrPtr
= GetToken (Value
->Value
.string
, FormSet
->HiiHandle
);
3020 if (StrPtr
== NULL
) {
3021 Status
= EFI_INVALID_PARAMETER
;
3025 IfrStrToUpper (StrPtr
);
3026 if (StrCmp (StrPtr
, L
"TRUE") == 0){
3027 Value
->Value
.b
= TRUE
;
3028 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
3029 } else if (StrCmp (StrPtr
, L
"FALSE") == 0) {
3030 Value
->Value
.b
= FALSE
;
3031 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
3033 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3036 } else if (Value
->Type
== EFI_IFR_TYPE_BUFFER
) {
3038 // When converting from a buffer, if the buffer is all zeroes,
3039 // then push False. Otherwise push True.
3041 for (Index
=0; Index
< Value
->BufferLen
; Index
++) {
3042 if (Value
->Buffer
[Index
] != 0) {
3047 if (Index
>= Value
->BufferLen
) {
3048 Value
->Value
.b
= FALSE
;
3050 Value
->Value
.b
= TRUE
;
3052 Value
->Type
= EFI_IFR_TYPE_BOOLEAN
;
3053 FreePool (Value
->Buffer
);
3057 case EFI_IFR_TO_STRING_OP
:
3058 Status
= IfrToString (FormSet
, OpCode
->Format
, Value
);
3061 case EFI_IFR_TO_UINT_OP
:
3062 Status
= IfrToUint (FormSet
, Value
);
3065 case EFI_IFR_TO_LOWER_OP
:
3066 case EFI_IFR_TO_UPPER_OP
:
3067 Status
= InitializeUnicodeCollationProtocol ();
3068 if (EFI_ERROR (Status
)) {
3072 Status
= PopExpression (Value
);
3073 if (EFI_ERROR (Status
)) {
3077 if (Value
->Type
!= EFI_IFR_TYPE_STRING
) {
3078 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3082 StrPtr
= GetToken (Value
->Value
.string
, FormSet
->HiiHandle
);
3083 if (StrPtr
== NULL
) {
3084 Status
= EFI_NOT_FOUND
;
3088 if (OpCode
->Operand
== EFI_IFR_TO_LOWER_OP
) {
3089 mUnicodeCollation
->StrLwr (mUnicodeCollation
, StrPtr
);
3091 mUnicodeCollation
->StrUpr (mUnicodeCollation
, StrPtr
);
3093 Value
->Value
.string
= NewString (StrPtr
, FormSet
->HiiHandle
);
3097 case EFI_IFR_BITWISE_NOT_OP
:
3099 // Pop an expression from the expression stack
3101 Status
= PopExpression (Value
);
3102 if (EFI_ERROR (Status
)) {
3105 if (Value
->Type
> EFI_IFR_TYPE_DATE
) {
3106 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3110 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
3111 Value
->Value
.u64
= ~ HiiValueToUINT64(Value
);
3114 case EFI_IFR_SET_OP
:
3116 // Pop an expression from the expression stack
3118 Status
= PopExpression (Value
);
3119 if (EFI_ERROR (Status
)) {
3122 Data1
.Type
= EFI_IFR_TYPE_BOOLEAN
;
3123 Data1
.Value
.b
= FALSE
;
3125 // Set value to var storage buffer
3127 if (OpCode
->VarStorage
!= NULL
) {
3128 switch (OpCode
->VarStorage
->Type
) {
3129 case EFI_HII_VARSTORE_BUFFER
:
3130 case EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
:
3131 CopyMem (OpCode
->VarStorage
->EditBuffer
+ OpCode
->VarStoreInfo
.VarOffset
, &Value
->Value
, OpCode
->ValueWidth
);
3132 Data1
.Value
.b
= TRUE
;
3134 case EFI_HII_VARSTORE_NAME_VALUE
:
3135 if (OpCode
->ValueType
!= EFI_IFR_TYPE_STRING
) {
3136 NameValue
= AllocateZeroPool ((OpCode
->ValueWidth
* 2 + 1) * sizeof (CHAR16
));
3137 ASSERT (Value
!= NULL
);
3139 // Convert Buffer to Hex String
3141 TempBuffer
= (UINT8
*) &Value
->Value
+ OpCode
->ValueWidth
- 1;
3143 for (Index
= 0; Index
< OpCode
->ValueWidth
; Index
++, TempBuffer
--) {
3144 StrPtr
+= UnicodeValueToString (StrPtr
, PREFIX_ZERO
| RADIX_HEX
, *TempBuffer
, 2);
3146 Status
= SetValueByName (OpCode
->VarStorage
, OpCode
->ValueName
, NameValue
, GetSetValueWithEditBuffer
, NULL
);
3147 FreePool (NameValue
);
3148 if (!EFI_ERROR (Status
)) {
3149 Data1
.Value
.b
= TRUE
;
3153 case EFI_HII_VARSTORE_EFI_VARIABLE
:
3154 Status
= gRT
->SetVariable (
3156 &OpCode
->VarStorage
->Guid
,
3157 OpCode
->VarStorage
->Attributes
,
3161 if (!EFI_ERROR (Status
)) {
3162 Data1
.Value
.b
= TRUE
;
3167 // Not recognize storage.
3169 Status
= EFI_UNSUPPORTED
;
3175 // For Time/Date Data
3177 if (OpCode
->ValueType
!= EFI_IFR_TYPE_DATE
&& OpCode
->ValueType
!= EFI_IFR_TYPE_TIME
) {
3179 // Only support Data/Time data when storage doesn't exist.
3181 Status
= EFI_UNSUPPORTED
;
3184 Status
= gRT
->GetTime (&EfiTime
, NULL
);
3185 if (!EFI_ERROR (Status
)) {
3186 if (OpCode
->ValueType
== EFI_IFR_TYPE_DATE
) {
3187 switch (OpCode
->VarStoreInfo
.VarOffset
) {
3189 EfiTime
.Year
= Value
->Value
.u16
;
3192 EfiTime
.Month
= Value
->Value
.u8
;
3195 EfiTime
.Day
= Value
->Value
.u8
;
3199 // Invalid Date field.
3201 Status
= EFI_INVALID_PARAMETER
;
3205 switch (OpCode
->VarStoreInfo
.VarOffset
) {
3207 EfiTime
.Hour
= Value
->Value
.u8
;
3210 EfiTime
.Minute
= Value
->Value
.u8
;
3213 EfiTime
.Second
= Value
->Value
.u8
;
3217 // Invalid Time field.
3219 Status
= EFI_INVALID_PARAMETER
;
3223 Status
= gRT
->SetTime (&EfiTime
);
3224 if (!EFI_ERROR (Status
)) {
3225 Data1
.Value
.b
= TRUE
;
3235 case EFI_IFR_ADD_OP
:
3236 case EFI_IFR_SUBTRACT_OP
:
3237 case EFI_IFR_MULTIPLY_OP
:
3238 case EFI_IFR_DIVIDE_OP
:
3239 case EFI_IFR_MODULO_OP
:
3240 case EFI_IFR_BITWISE_AND_OP
:
3241 case EFI_IFR_BITWISE_OR_OP
:
3242 case EFI_IFR_SHIFT_LEFT_OP
:
3243 case EFI_IFR_SHIFT_RIGHT_OP
:
3245 // Pop an expression from the expression stack
3247 Status
= PopExpression (&Data2
);
3248 if (EFI_ERROR (Status
)) {
3253 // Pop another expression from the expression stack
3255 Status
= PopExpression (&Data1
);
3256 if (EFI_ERROR (Status
)) {
3260 if (Data2
.Type
> EFI_IFR_TYPE_DATE
) {
3261 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3266 if (Data1
.Type
> EFI_IFR_TYPE_DATE
) {
3267 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3271 Value
->Type
= EFI_IFR_TYPE_NUM_SIZE_64
;
3273 switch (OpCode
->Operand
) {
3274 case EFI_IFR_ADD_OP
:
3275 Value
->Value
.u64
= HiiValueToUINT64(&Data1
) + HiiValueToUINT64(&Data2
);
3278 case EFI_IFR_SUBTRACT_OP
:
3279 Value
->Value
.u64
= HiiValueToUINT64(&Data1
) - HiiValueToUINT64(&Data2
);
3282 case EFI_IFR_MULTIPLY_OP
:
3283 Value
->Value
.u64
= MultU64x32 (HiiValueToUINT64(&Data1
), (UINT32
) HiiValueToUINT64(&Data2
));
3286 case EFI_IFR_DIVIDE_OP
:
3287 Value
->Value
.u64
= DivU64x32 (HiiValueToUINT64(&Data1
), (UINT32
) HiiValueToUINT64(&Data2
));
3290 case EFI_IFR_MODULO_OP
:
3291 DivU64x32Remainder (HiiValueToUINT64(&Data1
), (UINT32
) HiiValueToUINT64(&Data2
), &TempValue
);
3292 Value
->Value
.u64
= TempValue
;
3295 case EFI_IFR_BITWISE_AND_OP
:
3296 Value
->Value
.u64
= HiiValueToUINT64(&Data1
) & HiiValueToUINT64(&Data2
);
3299 case EFI_IFR_BITWISE_OR_OP
:
3300 Value
->Value
.u64
= HiiValueToUINT64(&Data1
) | HiiValueToUINT64(&Data2
);
3303 case EFI_IFR_SHIFT_LEFT_OP
:
3304 Value
->Value
.u64
= LShiftU64 (HiiValueToUINT64(&Data1
), (UINTN
) HiiValueToUINT64(&Data2
));
3307 case EFI_IFR_SHIFT_RIGHT_OP
:
3308 Value
->Value
.u64
= RShiftU64 (HiiValueToUINT64(&Data1
), (UINTN
) HiiValueToUINT64(&Data2
));
3316 case EFI_IFR_AND_OP
:
3319 // Two Boolean operator
3321 Status
= PopExpression (&Data2
);
3322 if (EFI_ERROR (Status
)) {
3327 // Pop another expression from the expression stack
3329 Status
= PopExpression (&Data1
);
3330 if (EFI_ERROR (Status
)) {
3334 if (Data2
.Type
!= EFI_IFR_TYPE_BOOLEAN
) {
3335 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3339 if (Data1
.Type
!= EFI_IFR_TYPE_BOOLEAN
) {
3340 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3344 if (OpCode
->Operand
== EFI_IFR_AND_OP
) {
3345 Value
->Value
.b
= (BOOLEAN
) (Data1
.Value
.b
&& Data2
.Value
.b
);
3347 Value
->Value
.b
= (BOOLEAN
) (Data1
.Value
.b
|| Data2
.Value
.b
);
3351 case EFI_IFR_EQUAL_OP
:
3352 case EFI_IFR_NOT_EQUAL_OP
:
3353 case EFI_IFR_GREATER_EQUAL_OP
:
3354 case EFI_IFR_GREATER_THAN_OP
:
3355 case EFI_IFR_LESS_EQUAL_OP
:
3356 case EFI_IFR_LESS_THAN_OP
:
3358 // Compare two integer, string, boolean or date/time
3360 Status
= PopExpression (&Data2
);
3361 if (EFI_ERROR (Status
)) {
3366 // Pop another expression from the expression stack
3368 Status
= PopExpression (&Data1
);
3369 if (EFI_ERROR (Status
)) {
3373 if (Data2
.Type
> EFI_IFR_TYPE_BOOLEAN
&&
3374 Data2
.Type
!= EFI_IFR_TYPE_STRING
&&
3375 !IsTypeInBuffer(&Data2
)) {
3376 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3380 if (Data1
.Type
> EFI_IFR_TYPE_BOOLEAN
&&
3381 Data1
.Type
!= EFI_IFR_TYPE_STRING
&&
3382 !IsTypeInBuffer(&Data1
)) {
3383 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3387 Status
= CompareHiiValue (&Data1
, &Data2
, &Result
, FormSet
->HiiHandle
);
3388 if (Data1
.Type
== EFI_IFR_TYPE_BUFFER
) {
3389 FreePool (Data1
.Buffer
);
3391 if (Data2
.Type
== EFI_IFR_TYPE_BUFFER
) {
3392 FreePool (Data2
.Buffer
);
3395 if (Status
== EFI_UNSUPPORTED
) {
3396 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3397 Status
= EFI_SUCCESS
;
3401 if (EFI_ERROR (Status
)) {
3405 switch (OpCode
->Operand
) {
3406 case EFI_IFR_EQUAL_OP
:
3407 Value
->Value
.b
= (BOOLEAN
) ((Result
== 0) ? TRUE
: FALSE
);
3410 case EFI_IFR_NOT_EQUAL_OP
:
3411 Value
->Value
.b
= (BOOLEAN
) ((Result
!= 0) ? TRUE
: FALSE
);
3414 case EFI_IFR_GREATER_EQUAL_OP
:
3415 Value
->Value
.b
= (BOOLEAN
) ((Result
>= 0) ? TRUE
: FALSE
);
3418 case EFI_IFR_GREATER_THAN_OP
:
3419 Value
->Value
.b
= (BOOLEAN
) ((Result
> 0) ? TRUE
: FALSE
);
3422 case EFI_IFR_LESS_EQUAL_OP
:
3423 Value
->Value
.b
= (BOOLEAN
) ((Result
<= 0) ? TRUE
: FALSE
);
3426 case EFI_IFR_LESS_THAN_OP
:
3427 Value
->Value
.b
= (BOOLEAN
) ((Result
< 0) ? TRUE
: FALSE
);
3435 case EFI_IFR_MATCH_OP
:
3436 Status
= InitializeUnicodeCollationProtocol ();
3437 if (EFI_ERROR (Status
)) {
3441 Status
= IfrMatch (FormSet
, Value
);
3444 case EFI_IFR_MATCH2_OP
:
3445 Status
= IfrMatch2 (FormSet
, &OpCode
->Guid
, Value
);
3448 case EFI_IFR_CATENATE_OP
:
3449 Status
= IfrCatenate (FormSet
, Value
);
3455 case EFI_IFR_CONDITIONAL_OP
:
3457 // Pop third expression from the expression stack
3459 Status
= PopExpression (&Data3
);
3460 if (EFI_ERROR (Status
)) {
3465 // Pop second expression from the expression stack
3467 Status
= PopExpression (&Data2
);
3468 if (EFI_ERROR (Status
)) {
3473 // Pop first expression from the expression stack
3475 Status
= PopExpression (&Data1
);
3476 if (EFI_ERROR (Status
)) {
3479 if (Data1
.Type
!= EFI_IFR_TYPE_BOOLEAN
) {
3480 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3484 if (Data1
.Value
.b
) {
3491 case EFI_IFR_FIND_OP
:
3492 Status
= IfrFind (FormSet
, OpCode
->Format
, Value
);
3495 case EFI_IFR_MID_OP
:
3496 Status
= IfrMid (FormSet
, Value
);
3499 case EFI_IFR_TOKEN_OP
:
3500 Status
= IfrToken (FormSet
, Value
);
3503 case EFI_IFR_SPAN_OP
:
3504 Status
= IfrSpan (FormSet
, OpCode
->Flags
, Value
);
3507 case EFI_IFR_MAP_OP
:
3509 // Pop the check value
3511 Status
= PopExpression (&Data1
);
3512 if (EFI_ERROR (Status
)) {
3516 // Check MapExpression list is valid.
3518 if (OpCode
->MapExpressionList
.ForwardLink
== NULL
) {
3519 Status
= EFI_INVALID_PARAMETER
;
3523 // Go through map expression list.
3525 SubExpressionLink
= GetFirstNode(&OpCode
->MapExpressionList
);
3526 while (!IsNull (&OpCode
->MapExpressionList
, SubExpressionLink
)) {
3527 SubExpression
= FORM_EXPRESSION_FROM_LINK (SubExpressionLink
);
3529 // Evaluate the first expression in this pair.
3531 Status
= EvaluateExpression (FormSet
, Form
, SubExpression
);
3532 if (EFI_ERROR (Status
)) {
3536 // Compare the expression value with current value
3538 if ((CompareHiiValue (&Data1
, &SubExpression
->Result
, &Result
, NULL
) == EFI_SUCCESS
) && (Result
== 0)) {
3540 // Try get the map value.
3542 SubExpressionLink
= GetNextNode (&OpCode
->MapExpressionList
, SubExpressionLink
);
3543 if (IsNull (&OpCode
->MapExpressionList
, SubExpressionLink
)) {
3544 Status
= EFI_INVALID_PARAMETER
;
3547 SubExpression
= FORM_EXPRESSION_FROM_LINK (SubExpressionLink
);
3548 Status
= EvaluateExpression (FormSet
, Form
, SubExpression
);
3549 if (EFI_ERROR (Status
)) {
3552 Value
= &SubExpression
->Result
;
3556 // Skip the second expression on this pair.
3558 SubExpressionLink
= GetNextNode (&OpCode
->MapExpressionList
, SubExpressionLink
);
3559 if (IsNull (&OpCode
->MapExpressionList
, SubExpressionLink
)) {
3560 Status
= EFI_INVALID_PARAMETER
;
3564 // Goto the first expression on next pair.
3566 SubExpressionLink
= GetNextNode (&OpCode
->MapExpressionList
, SubExpressionLink
);
3570 // No map value is found.
3572 if (IsNull (&OpCode
->MapExpressionList
, SubExpressionLink
)) {
3573 Value
->Type
= EFI_IFR_TYPE_UNDEFINED
;
3574 Value
->Value
.u8
= 0;
3581 if (EFI_ERROR (Status
) || Value
->Type
== EFI_IFR_TYPE_UNDEFINED
) {
3585 Status
= PushExpression (Value
);
3586 if (EFI_ERROR (Status
)) {
3592 // Pop the final result from expression stack
3595 Status
= PopExpression (Value
);
3596 if (EFI_ERROR (Status
)) {
3601 // After evaluating an expression, there should be only one value left on the expression stack
3603 if (PopExpression (Value
) != EFI_ACCESS_DENIED
) {
3604 Status
= EFI_INVALID_PARAMETER
;
3608 RestoreExpressionEvaluationStackOffset (StackOffset
);
3609 if (!EFI_ERROR (Status
)) {
3610 CopyMem (&Expression
->Result
, Value
, sizeof (EFI_HII_VALUE
));
3617 Check whether the result is TRUE or FALSE.
3619 For the EFI_HII_VALUE value type is numeric, return TRUE if the
3622 @param Result Input the result data.
3624 @retval TRUE The result is TRUE.
3625 @retval FALSE The result is FALSE.
3630 IN EFI_HII_VALUE
*Result
3633 switch (Result
->Type
) {
3634 case EFI_IFR_TYPE_BOOLEAN
:
3635 return Result
->Value
.b
;
3637 case EFI_IFR_TYPE_NUM_SIZE_8
:
3638 return (BOOLEAN
)(Result
->Value
.u8
!= 0);
3640 case EFI_IFR_TYPE_NUM_SIZE_16
:
3641 return (BOOLEAN
)(Result
->Value
.u16
!= 0);
3643 case EFI_IFR_TYPE_NUM_SIZE_32
:
3644 return (BOOLEAN
)(Result
->Value
.u32
!= 0);
3646 case EFI_IFR_TYPE_NUM_SIZE_64
:
3647 return (BOOLEAN
)(Result
->Value
.u64
!= 0);
3655 Return the result of the expression list. Check the expression list and
3656 return the highest priority express result.
3657 Priority: DisableIf > SuppressIf > GrayOutIf > FALSE
3659 @param ExpList The input expression list.
3660 @param Evaluate Whether need to evaluate the expression first.
3661 @param FormSet FormSet associated with this expression.
3662 @param Form Form associated with this expression.
3664 @retval EXPRESS_RESULT Return the higher priority express result.
3665 DisableIf > SuppressIf > GrayOutIf > FALSE
3669 EvaluateExpressionList (
3670 IN FORM_EXPRESSION_LIST
*ExpList
,
3671 IN BOOLEAN Evaluate
,
3672 IN FORM_BROWSER_FORMSET
*FormSet
, OPTIONAL
3673 IN FORM_BROWSER_FORM
*Form OPTIONAL
3677 EXPRESS_RESULT ReturnVal
;
3678 EXPRESS_RESULT CompareOne
;
3681 if (ExpList
== NULL
) {
3682 return ExpressFalse
;
3685 ASSERT(ExpList
->Signature
== FORM_EXPRESSION_LIST_SIGNATURE
);
3689 // Check whether need to evaluate the expression first.
3692 while (ExpList
->Count
> Index
) {
3693 Status
= EvaluateExpression (FormSet
, Form
, ExpList
->Expression
[Index
++]);
3694 if (EFI_ERROR (Status
)) {
3695 return ExpressFalse
;
3701 // Run the list of expressions.
3703 ReturnVal
= ExpressFalse
;
3704 for (Index
= 0; Index
< ExpList
->Count
; Index
++) {
3705 if (IsTrue (&ExpList
->Expression
[Index
]->Result
)) {
3706 switch (ExpList
->Expression
[Index
]->Type
) {
3707 case EFI_HII_EXPRESSION_SUPPRESS_IF
:
3708 CompareOne
= ExpressSuppress
;
3711 case EFI_HII_EXPRESSION_GRAY_OUT_IF
:
3712 CompareOne
= ExpressGrayOut
;
3715 case EFI_HII_EXPRESSION_DISABLE_IF
:
3716 CompareOne
= ExpressDisable
;
3720 return ExpressFalse
;
3723 ReturnVal
= ReturnVal
< CompareOne
? CompareOne
: ReturnVal
;