2 Implementation for handling the User Interface option processing.
5 Copyright (c) 2004 - 2015, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #include "FormDisplay.h"
18 #define MAX_TIME_OUT_LEN 0x10
21 Concatenate a narrow string to another string.
23 @param Destination The destination string.
24 @param Source The source string. The string to be concatenated.
25 to the end of Destination.
30 IN OUT CHAR16
*Destination
,
37 for (Length
= 0; Destination
[Length
] != 0; Length
++)
41 // We now have the length of the original string
42 // We can safely assume for now that we are concatenating a narrow value to this string.
43 // For instance, the string is "XYZ" and cat'ing ">"
44 // If this assumption changes, we need to make this routine a bit more complex
46 Destination
[Length
] = NARROW_CHAR
;
49 StrCpyS (Destination
+ Length
, DestMax
- Length
, Source
);
53 Get UINT64 type value.
55 @param Value Input Hii value.
57 @retval UINT64 Return the UINT64 type value.
62 IN EFI_HII_VALUE
*Value
69 switch (Value
->Type
) {
70 case EFI_IFR_TYPE_NUM_SIZE_8
:
71 RetVal
= Value
->Value
.u8
;
74 case EFI_IFR_TYPE_NUM_SIZE_16
:
75 RetVal
= Value
->Value
.u16
;
78 case EFI_IFR_TYPE_NUM_SIZE_32
:
79 RetVal
= Value
->Value
.u32
;
82 case EFI_IFR_TYPE_BOOLEAN
:
83 RetVal
= Value
->Value
.b
;
86 case EFI_IFR_TYPE_DATE
:
87 RetVal
= *(UINT64
*) &Value
->Value
.date
;
90 case EFI_IFR_TYPE_TIME
:
91 RetVal
= (*(UINT64
*) &Value
->Value
.time
) & 0xffffff;
95 RetVal
= Value
->Value
.u64
;
103 Check whether this value type can be transfer to EFI_IFR_TYPE_BUFFER type.
105 EFI_IFR_TYPE_REF, EFI_IFR_TYPE_DATE and EFI_IFR_TYPE_TIME are converted to
106 EFI_IFR_TYPE_BUFFER when do the value compare.
108 @param Value Expression value to compare on.
110 @retval TRUE This value type can be transter to EFI_IFR_TYPE_BUFFER type.
111 @retval FALSE This value type can't be transter to EFI_IFR_TYPE_BUFFER type.
116 IN EFI_HII_VALUE
*Value
119 switch (Value
->Type
) {
120 case EFI_IFR_TYPE_BUFFER
:
121 case EFI_IFR_TYPE_DATE
:
122 case EFI_IFR_TYPE_TIME
:
123 case EFI_IFR_TYPE_REF
:
132 Check whether this value type can be transfer to EFI_IFR_TYPE_UINT64
134 @param Value Expression value to compare on.
136 @retval TRUE This value type can be transter to EFI_IFR_TYPE_BUFFER type.
137 @retval FALSE This value type can't be transter to EFI_IFR_TYPE_BUFFER type.
142 IN EFI_HII_VALUE
*Value
145 switch (Value
->Type
) {
146 case EFI_IFR_TYPE_NUM_SIZE_8
:
147 case EFI_IFR_TYPE_NUM_SIZE_16
:
148 case EFI_IFR_TYPE_NUM_SIZE_32
:
149 case EFI_IFR_TYPE_NUM_SIZE_64
:
150 case EFI_IFR_TYPE_BOOLEAN
:
159 Return the buffer length and buffer pointer for this value.
161 EFI_IFR_TYPE_REF, EFI_IFR_TYPE_DATE and EFI_IFR_TYPE_TIME are converted to
162 EFI_IFR_TYPE_BUFFER when do the value compare.
164 @param Value Expression value to compare on.
165 @param Buf Return the buffer pointer.
166 @param BufLen Return the buffer length.
170 GetBufAndLenForValue (
171 IN EFI_HII_VALUE
*Value
,
176 switch (Value
->Type
) {
177 case EFI_IFR_TYPE_BUFFER
:
178 *Buf
= Value
->Buffer
;
179 *BufLen
= Value
->BufferLen
;
182 case EFI_IFR_TYPE_DATE
:
183 *Buf
= (UINT8
*) (&Value
->Value
.date
);
184 *BufLen
= (UINT16
) sizeof (EFI_HII_DATE
);
187 case EFI_IFR_TYPE_TIME
:
188 *Buf
= (UINT8
*) (&Value
->Value
.time
);
189 *BufLen
= (UINT16
) sizeof (EFI_HII_TIME
);
192 case EFI_IFR_TYPE_REF
:
193 *Buf
= (UINT8
*) (&Value
->Value
.ref
);
194 *BufLen
= (UINT16
) sizeof (EFI_HII_REF
);
204 Compare two Hii value.
206 @param Value1 Expression value to compare on left-hand.
207 @param Value2 Expression value to compare on right-hand.
208 @param Result Return value after compare.
209 retval 0 Two operators equal.
210 return Positive value if Value1 is greater than Value2.
211 retval Negative value if Value1 is less than Value2.
212 @param HiiHandle Only required for string compare.
214 @retval other Could not perform compare on two values.
215 @retval EFI_SUCCESS Compare the value success.
220 IN EFI_HII_VALUE
*Value1
,
221 IN EFI_HII_VALUE
*Value2
,
223 IN EFI_HII_HANDLE HiiHandle OPTIONAL
235 if (Value1
->Type
== EFI_IFR_TYPE_STRING
&& Value2
->Type
== EFI_IFR_TYPE_STRING
) {
236 if (Value1
->Value
.string
== 0 || Value2
->Value
.string
== 0) {
238 // StringId 0 is reserved
240 return EFI_INVALID_PARAMETER
;
243 if (Value1
->Value
.string
== Value2
->Value
.string
) {
248 Str1
= GetToken (Value1
->Value
.string
, HiiHandle
);
253 return EFI_NOT_FOUND
;
256 Str2
= GetToken (Value2
->Value
.string
, HiiHandle
);
259 return EFI_NOT_FOUND
;
262 *Result
= StrCmp (Str1
, Str2
);
271 // Take types(date, time, ref, buffer) as buffer
273 if (IsTypeInBuffer(Value1
) && IsTypeInBuffer(Value2
)) {
274 GetBufAndLenForValue(Value1
, &Buf1
, &Buf1Len
);
275 GetBufAndLenForValue(Value2
, &Buf2
, &Buf2Len
);
277 Len
= Buf1Len
> Buf2Len
? Buf2Len
: Buf1Len
;
278 *Result
= CompareMem (Buf1
, Buf2
, Len
);
279 if ((*Result
== 0) && (Buf1Len
!= Buf2Len
)) {
281 // In this case, means base on samll number buffer, the data is same
282 // So which value has more data, which value is bigger.
284 *Result
= Buf1Len
> Buf2Len
? 1 : -1;
290 // Take remain types(integer, boolean, date/time) as integer
292 if (IsTypeInUINT64(Value1
) && IsTypeInUINT64(Value2
)) {
293 Temp64
= HiiValueToUINT64(Value1
) - HiiValueToUINT64(Value2
);
296 } else if (Temp64
< 0) {
304 return EFI_UNSUPPORTED
;
308 Search an Option of a Question by its value.
310 @param Question The Question
311 @param OptionValue Value for Option to be searched.
313 @retval Pointer Pointer to the found Option.
314 @retval NULL Option not found.
317 DISPLAY_QUESTION_OPTION
*
319 IN FORM_DISPLAY_ENGINE_STATEMENT
*Question
,
320 IN EFI_HII_VALUE
*OptionValue
324 DISPLAY_QUESTION_OPTION
*Option
;
328 Link
= GetFirstNode (&Question
->OptionListHead
);
329 while (!IsNull (&Question
->OptionListHead
, Link
)) {
330 Option
= DISPLAY_QUESTION_OPTION_FROM_LINK (Link
);
332 ZeroMem (&Value
, sizeof (EFI_HII_VALUE
));
333 Value
.Type
= Option
->OptionOpCode
->Type
;
334 CopyMem (&Value
.Value
, &Option
->OptionOpCode
->Value
, Option
->OptionOpCode
->Header
.Length
- OFFSET_OF (EFI_IFR_ONE_OF_OPTION
, Value
));
336 if ((CompareHiiValue (&Value
, OptionValue
, &Result
, NULL
) == EFI_SUCCESS
) && (Result
== 0)) {
340 Link
= GetNextNode (&Question
->OptionListHead
, Link
);
348 Return data element in an Array by its Index.
350 @param Array The data array.
351 @param Type Type of the data in this array.
352 @param Index Zero based index for data in this array.
354 @retval Value The data to be returned
366 ASSERT (Array
!= NULL
);
370 case EFI_IFR_TYPE_NUM_SIZE_8
:
371 Data
= (UINT64
) *(((UINT8
*) Array
) + Index
);
374 case EFI_IFR_TYPE_NUM_SIZE_16
:
375 Data
= (UINT64
) *(((UINT16
*) Array
) + Index
);
378 case EFI_IFR_TYPE_NUM_SIZE_32
:
379 Data
= (UINT64
) *(((UINT32
*) Array
) + Index
);
382 case EFI_IFR_TYPE_NUM_SIZE_64
:
383 Data
= (UINT64
) *(((UINT64
*) Array
) + Index
);
395 Set value of a data element in an Array by its Index.
397 @param Array The data array.
398 @param Type Type of the data in this array.
399 @param Index Zero based index for data in this array.
400 @param Value The value to be set.
412 ASSERT (Array
!= NULL
);
415 case EFI_IFR_TYPE_NUM_SIZE_8
:
416 *(((UINT8
*) Array
) + Index
) = (UINT8
) Value
;
419 case EFI_IFR_TYPE_NUM_SIZE_16
:
420 *(((UINT16
*) Array
) + Index
) = (UINT16
) Value
;
423 case EFI_IFR_TYPE_NUM_SIZE_32
:
424 *(((UINT32
*) Array
) + Index
) = (UINT32
) Value
;
427 case EFI_IFR_TYPE_NUM_SIZE_64
:
428 *(((UINT64
*) Array
) + Index
) = (UINT64
) Value
;
437 Check whether this value already in the array, if yes, return the index.
439 @param Array The data array.
440 @param Type Type of the data in this array.
441 @param Value The value to be find.
442 @param Index The index in the array which has same value with Value.
444 @retval TRUE Found the value in the array.
445 @retval FALSE Not found the value.
453 OUT UINTN
*Index OPTIONAL
460 ASSERT (Array
!= NULL
);
466 case EFI_IFR_TYPE_NUM_SIZE_8
:
467 ValueComp
= (UINT8
) Value
;
470 case EFI_IFR_TYPE_NUM_SIZE_16
:
471 ValueComp
= (UINT16
) Value
;
474 case EFI_IFR_TYPE_NUM_SIZE_32
:
475 ValueComp
= (UINT32
) Value
;
478 case EFI_IFR_TYPE_NUM_SIZE_64
:
479 ValueComp
= (UINT64
) Value
;
487 while ((TmpValue
= GetArrayData (Array
, Type
, Count
)) != 0) {
488 if (ValueComp
== TmpValue
) {
502 Print Question Value according to it's storage width and display attributes.
504 @param Question The Question to be printed.
505 @param FormattedNumber Buffer for output string.
506 @param BufferSize The FormattedNumber buffer size in bytes.
508 @retval EFI_SUCCESS Print success.
509 @retval EFI_BUFFER_TOO_SMALL Buffer size is not enough for formatted number.
513 PrintFormattedNumber (
514 IN FORM_DISPLAY_ENGINE_STATEMENT
*Question
,
515 IN OUT CHAR16
*FormattedNumber
,
521 EFI_HII_VALUE
*QuestionValue
;
522 EFI_IFR_NUMERIC
*NumericOp
;
524 if (BufferSize
< (21 * sizeof (CHAR16
))) {
525 return EFI_BUFFER_TOO_SMALL
;
528 QuestionValue
= &Question
->CurrentValue
;
529 NumericOp
= (EFI_IFR_NUMERIC
*) Question
->OpCode
;
531 Value
= (INT64
) QuestionValue
->Value
.u64
;
532 switch (NumericOp
->Flags
& EFI_IFR_DISPLAY
) {
533 case EFI_IFR_DISPLAY_INT_DEC
:
534 switch (QuestionValue
->Type
) {
535 case EFI_IFR_NUMERIC_SIZE_1
:
536 Value
= (INT64
) ((INT8
) QuestionValue
->Value
.u8
);
539 case EFI_IFR_NUMERIC_SIZE_2
:
540 Value
= (INT64
) ((INT16
) QuestionValue
->Value
.u16
);
543 case EFI_IFR_NUMERIC_SIZE_4
:
544 Value
= (INT64
) ((INT32
) QuestionValue
->Value
.u32
);
547 case EFI_IFR_NUMERIC_SIZE_8
:
560 case EFI_IFR_DISPLAY_UINT_DEC
:
564 case EFI_IFR_DISPLAY_UINT_HEX
:
569 return EFI_UNSUPPORTED
;
573 UnicodeSPrint (FormattedNumber
, BufferSize
, Format
, Value
);
580 Draw a pop up windows based on the dimension, number of lines and
583 @param RequestedWidth The width of the pop-up.
584 @param NumberOfLines The number of lines.
585 @param Marker The variable argument list for the list of string to be printed.
590 IN UINTN RequestedWidth
,
591 IN UINTN NumberOfLines
,
603 UINTN DimensionsWidth
;
604 UINTN DimensionsHeight
;
606 DimensionsWidth
= gStatementDimensions
.RightColumn
- gStatementDimensions
.LeftColumn
;
607 DimensionsHeight
= gStatementDimensions
.BottomRow
- gStatementDimensions
.TopRow
;
609 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetPopupColor ());
611 if ((RequestedWidth
+ 2) > DimensionsWidth
) {
612 RequestedWidth
= DimensionsWidth
- 2;
616 // Subtract the PopUp width from total Columns, allow for one space extra on
617 // each end plus a border.
619 Start
= (DimensionsWidth
- RequestedWidth
- 2) / 2 + gStatementDimensions
.LeftColumn
+ 1;
620 End
= Start
+ RequestedWidth
+ 1;
622 Top
= ((DimensionsHeight
- NumberOfLines
- 2) / 2) + gStatementDimensions
.TopRow
- 1;
623 Bottom
= Top
+ NumberOfLines
+ 2;
625 Character
= BOXDRAW_DOWN_RIGHT
;
626 PrintCharAt (Start
, Top
, Character
);
627 Character
= BOXDRAW_HORIZONTAL
;
628 for (Index
= Start
; Index
+ 2 < End
; Index
++) {
629 PrintCharAt ((UINTN
)-1, (UINTN
)-1, Character
);
632 Character
= BOXDRAW_DOWN_LEFT
;
633 PrintCharAt ((UINTN
)-1, (UINTN
)-1, Character
);
634 Character
= BOXDRAW_VERTICAL
;
637 for (Index
= Top
; Index
+ 2 < Bottom
; Index
++, Count
++) {
638 String
= VA_ARG (Marker
, CHAR16
*);
641 // This will clear the background of the line - we never know who might have been
642 // here before us. This differs from the next clear in that it used the non-reverse
643 // video for normal printing.
645 if (GetStringWidth (String
) / 2 > 1) {
646 ClearLines (Start
, End
, Index
+ 1, Index
+ 1, GetPopupColor ());
650 // Passing in a space results in the assumption that this is where typing will occur
652 if (String
[0] == L
' ') {
653 ClearLines (Start
+ 1, End
- 1, Index
+ 1, Index
+ 1, GetPopupInverseColor ());
657 // Passing in a NULL results in a blank space
659 if (String
[0] == CHAR_NULL
) {
660 ClearLines (Start
, End
, Index
+ 1, Index
+ 1, GetPopupColor ());
664 ((DimensionsWidth
- GetStringWidth (String
) / 2) / 2) + gStatementDimensions
.LeftColumn
+ 1,
668 gST
->ConOut
->SetAttribute (gST
->ConOut
, GetPopupColor ());
669 PrintCharAt (Start
, Index
+ 1, Character
);
670 PrintCharAt (End
- 1, Index
+ 1, Character
);
673 Character
= BOXDRAW_UP_RIGHT
;
674 PrintCharAt (Start
, Bottom
- 1, Character
);
675 Character
= BOXDRAW_HORIZONTAL
;
676 for (Index
= Start
; Index
+ 2 < End
; Index
++) {
677 PrintCharAt ((UINTN
)-1, (UINTN
)-1, Character
);
680 Character
= BOXDRAW_UP_LEFT
;
681 PrintCharAt ((UINTN
)-1, (UINTN
)-1, Character
);
685 Draw a pop up windows based on the dimension, number of lines and
688 @param RequestedWidth The width of the pop-up.
689 @param NumberOfLines The number of lines.
690 @param ... A series of text strings that displayed in the pop-up.
695 CreateMultiStringPopUp (
696 IN UINTN RequestedWidth
,
697 IN UINTN NumberOfLines
,
703 VA_START (Marker
, NumberOfLines
);
705 CreateSharedPopUp (RequestedWidth
, NumberOfLines
, Marker
);
713 @param Event The Event need to be process
714 @param Context The context of the event.
727 Process for the refresh interval statement.
729 @param Event The Event need to be process
730 @param Context The context of the event.
735 RefreshTimeOutProcess (
740 WARNING_IF_CONTEXT
*EventInfo
;
741 CHAR16 TimeOutString
[MAX_TIME_OUT_LEN
];
743 EventInfo
= (WARNING_IF_CONTEXT
*) Context
;
745 if (*(EventInfo
->TimeOut
) == 0) {
746 gBS
->CloseEvent (Event
);
748 gBS
->SignalEvent (EventInfo
->SyncEvent
);
752 UnicodeSPrint(TimeOutString
, MAX_TIME_OUT_LEN
, L
"%d", *(EventInfo
->TimeOut
));
754 CreateDialog (NULL
, gEmptyString
, EventInfo
->ErrorInfo
, gPressEnter
, gEmptyString
, TimeOutString
, NULL
);
756 *(EventInfo
->TimeOut
) -= 1;
760 Display error message for invalid password.
771 // Invalid password, prompt error message
774 CreateDialog (&Key
, gEmptyString
, gPassowordInvalid
, gPressEnter
, gEmptyString
, NULL
);
775 } while (Key
.UnicodeChar
!= CHAR_CARRIAGE_RETURN
);
779 Process password op code.
781 @param MenuOption The menu for current password op code.
783 @retval EFI_SUCCESS Question Option process success.
784 @retval Other Question Option process fail.
789 IN UI_MENU_OPTION
*MenuOption
796 EFI_IFR_PASSWORD
*PasswordInfo
;
797 FORM_DISPLAY_ENGINE_STATEMENT
*Question
;
800 Question
= MenuOption
->ThisTag
;
801 PasswordInfo
= (EFI_IFR_PASSWORD
*) Question
->OpCode
;
802 Maximum
= PasswordInfo
->MaxSize
;
803 Status
= EFI_SUCCESS
;
805 StringPtr
= AllocateZeroPool ((Maximum
+ 1) * sizeof (CHAR16
));
809 // Use a NULL password to test whether old password is required
812 Status
= Question
->PasswordCheck (gFormData
, Question
, StringPtr
);
813 if (Status
== EFI_NOT_AVAILABLE_YET
|| Status
== EFI_UNSUPPORTED
) {
815 // Password can't be set now.
817 FreePool (StringPtr
);
821 if (EFI_ERROR (Status
)) {
823 // Old password exist, ask user for the old password
825 Status
= ReadString (MenuOption
, gPromptForPassword
, StringPtr
);
826 if (EFI_ERROR (Status
)) {
827 FreePool (StringPtr
);
832 // Check user input old password
834 Status
= Question
->PasswordCheck (gFormData
, Question
, StringPtr
);
835 if (EFI_ERROR (Status
)) {
836 if (Status
== EFI_NOT_READY
) {
838 // Typed in old password incorrect
842 Status
= EFI_SUCCESS
;
845 FreePool (StringPtr
);
851 // Ask for new password
853 ZeroMem (StringPtr
, (Maximum
+ 1) * sizeof (CHAR16
));
854 Status
= ReadString (MenuOption
, gPromptForNewPassword
, StringPtr
);
855 if (EFI_ERROR (Status
)) {
857 // Reset state machine for password
859 Question
->PasswordCheck (gFormData
, Question
, NULL
);
860 FreePool (StringPtr
);
865 // Confirm new password
867 TempString
= AllocateZeroPool ((Maximum
+ 1) * sizeof (CHAR16
));
869 Status
= ReadString (MenuOption
, gConfirmPassword
, TempString
);
870 if (EFI_ERROR (Status
)) {
872 // Reset state machine for password
874 Question
->PasswordCheck (gFormData
, Question
, NULL
);
875 FreePool (StringPtr
);
876 FreePool (TempString
);
881 // Compare two typed-in new passwords
883 if (StrCmp (StringPtr
, TempString
) == 0) {
884 gUserInput
->InputValue
.Buffer
= AllocateCopyPool (Question
->CurrentValue
.BufferLen
, StringPtr
);
885 gUserInput
->InputValue
.BufferLen
= Question
->CurrentValue
.BufferLen
;
886 gUserInput
->InputValue
.Type
= Question
->CurrentValue
.Type
;
887 gUserInput
->InputValue
.Value
.string
= HiiSetString(gFormData
->HiiHandle
, gUserInput
->InputValue
.Value
.string
, StringPtr
, NULL
);
888 FreePool (StringPtr
);
890 Status
= EFI_SUCCESS
;
892 if (EFI_ERROR (Status
)) {
894 // Reset state machine for password
896 Question
->PasswordCheck (gFormData
, Question
, NULL
);
902 // Reset state machine for password
904 Question
->PasswordCheck (gFormData
, Question
, NULL
);
907 // Two password mismatch, prompt error message
910 CreateDialog (&Key
, gEmptyString
, gConfirmError
, gPressEnter
, gEmptyString
, NULL
);
911 } while (Key
.UnicodeChar
!= CHAR_CARRIAGE_RETURN
);
913 Status
= EFI_INVALID_PARAMETER
;
916 FreePool (TempString
);
917 FreePool (StringPtr
);
923 Process a Question's Option (whether selected or un-selected).
925 @param MenuOption The MenuOption for this Question.
926 @param Selected TRUE: if Question is selected.
927 @param OptionString Pointer of the Option String to be displayed.
928 @param SkipErrorValue Whether need to return when value without option for it.
930 @retval EFI_SUCCESS Question Option process success.
931 @retval Other Question Option process fail.
936 IN UI_MENU_OPTION
*MenuOption
,
938 OUT CHAR16
**OptionString
,
939 IN BOOLEAN SkipErrorValue
945 FORM_DISPLAY_ENGINE_STATEMENT
*Question
;
946 CHAR16 FormattedNumber
[21];
951 DISPLAY_QUESTION_OPTION
*OneOfOption
;
953 EFI_HII_VALUE HiiValue
;
954 EFI_HII_VALUE
*QuestionValue
;
955 DISPLAY_QUESTION_OPTION
*Option
;
959 EFI_IFR_ORDERED_LIST
*OrderList
;
960 BOOLEAN ValueInvalid
;
963 Status
= EFI_SUCCESS
;
966 Character
[1] = L
'\0';
967 *OptionString
= NULL
;
968 ValueInvalid
= FALSE
;
970 ZeroMem (FormattedNumber
, 21 * sizeof (CHAR16
));
971 BufferSize
= (gOptionBlockWidth
+ 1) * 2 * gStatementDimensions
.BottomRow
;
973 Question
= MenuOption
->ThisTag
;
974 QuestionValue
= &Question
->CurrentValue
;
976 switch (Question
->OpCode
->OpCode
) {
977 case EFI_IFR_ORDERED_LIST_OP
:
980 // Check whether there are Options of this OrderedList
982 if (IsListEmpty (&Question
->OptionListHead
)) {
986 OrderList
= (EFI_IFR_ORDERED_LIST
*) Question
->OpCode
;
988 Link
= GetFirstNode (&Question
->OptionListHead
);
989 OneOfOption
= DISPLAY_QUESTION_OPTION_FROM_LINK (Link
);
991 ValueType
= OneOfOption
->OptionOpCode
->Type
;
992 ValueArray
= Question
->CurrentValue
.Buffer
;
998 Status
= GetSelectionInputPopUp (MenuOption
);
1001 // We now know how many strings we will have, so we can allocate the
1002 // space required for the array or strings.
1004 MaxLen
= OrderList
->MaxContainers
* BufferSize
/ sizeof (CHAR16
);
1005 *OptionString
= AllocateZeroPool (MaxLen
* sizeof (CHAR16
));
1006 ASSERT (*OptionString
);
1008 HiiValue
.Type
= ValueType
;
1009 HiiValue
.Value
.u64
= 0;
1010 for (Index
= 0; Index
< OrderList
->MaxContainers
; Index
++) {
1011 HiiValue
.Value
.u64
= GetArrayData (ValueArray
, ValueType
, Index
);
1012 if (HiiValue
.Value
.u64
== 0) {
1014 // Values for the options in ordered lists should never be a 0
1019 OneOfOption
= ValueToOption (Question
, &HiiValue
);
1020 if (OneOfOption
== NULL
) {
1021 if (SkipErrorValue
) {
1023 // Just try to get the option string, skip the value which not has option.
1029 // Show error message
1032 CreateDialog (&Key
, gEmptyString
, gOptionMismatch
, gPressEnter
, gEmptyString
, NULL
);
1033 } while (Key
.UnicodeChar
!= CHAR_CARRIAGE_RETURN
);
1036 // The initial value of the orderedlist is invalid, force to be valid value
1037 // Exit current DisplayForm with new value.
1039 gUserInput
->SelectedStatement
= Question
;
1041 ValueArray
= AllocateZeroPool (Question
->CurrentValue
.BufferLen
);
1042 ASSERT (ValueArray
!= NULL
);
1043 gUserInput
->InputValue
.Buffer
= ValueArray
;
1044 gUserInput
->InputValue
.BufferLen
= Question
->CurrentValue
.BufferLen
;
1045 gUserInput
->InputValue
.Type
= Question
->CurrentValue
.Type
;
1047 Link
= GetFirstNode (&Question
->OptionListHead
);
1049 while (!IsNull (&Question
->OptionListHead
, Link
) && Index2
< OrderList
->MaxContainers
) {
1050 Option
= DISPLAY_QUESTION_OPTION_FROM_LINK (Link
);
1051 Link
= GetNextNode (&Question
->OptionListHead
, Link
);
1052 SetArrayData (ValueArray
, ValueType
, Index2
, Option
->OptionOpCode
->Value
.u64
);
1055 SetArrayData (ValueArray
, ValueType
, Index2
, 0);
1057 FreePool (*OptionString
);
1058 *OptionString
= NULL
;
1059 return EFI_NOT_FOUND
;
1062 Character
[0] = LEFT_ONEOF_DELIMITER
;
1063 NewStrCat (OptionString
[0], MaxLen
, Character
);
1064 StringPtr
= GetToken (OneOfOption
->OptionOpCode
->Option
, gFormData
->HiiHandle
);
1065 ASSERT (StringPtr
!= NULL
);
1066 NewStrCat (OptionString
[0], MaxLen
, StringPtr
);
1067 Character
[0] = RIGHT_ONEOF_DELIMITER
;
1068 NewStrCat (OptionString
[0], MaxLen
, Character
);
1069 Character
[0] = CHAR_CARRIAGE_RETURN
;
1070 NewStrCat (OptionString
[0], MaxLen
, Character
);
1071 FreePool (StringPtr
);
1075 // If valid option more than the max container, skip these options.
1077 if (Index
>= OrderList
->MaxContainers
) {
1082 // Search the other options, try to find the one not in the container.
1084 Link
= GetFirstNode (&Question
->OptionListHead
);
1085 while (!IsNull (&Question
->OptionListHead
, Link
)) {
1086 OneOfOption
= DISPLAY_QUESTION_OPTION_FROM_LINK (Link
);
1087 Link
= GetNextNode (&Question
->OptionListHead
, Link
);
1089 if (FindArrayData (ValueArray
, ValueType
, OneOfOption
->OptionOpCode
->Value
.u64
, NULL
)) {
1093 if (SkipErrorValue
) {
1095 // Not report error, just get the correct option string info.
1097 Character
[0] = LEFT_ONEOF_DELIMITER
;
1098 NewStrCat (OptionString
[0], MaxLen
, Character
);
1099 StringPtr
= GetToken (OneOfOption
->OptionOpCode
->Option
, gFormData
->HiiHandle
);
1100 ASSERT (StringPtr
!= NULL
);
1101 NewStrCat (OptionString
[0], MaxLen
, StringPtr
);
1102 Character
[0] = RIGHT_ONEOF_DELIMITER
;
1103 NewStrCat (OptionString
[0], MaxLen
, Character
);
1104 Character
[0] = CHAR_CARRIAGE_RETURN
;
1105 NewStrCat (OptionString
[0], MaxLen
, Character
);
1106 FreePool (StringPtr
);
1111 if (!ValueInvalid
) {
1112 ValueInvalid
= TRUE
;
1114 // Show error message
1117 CreateDialog (&Key
, gEmptyString
, gOptionMismatch
, gPressEnter
, gEmptyString
, NULL
);
1118 } while (Key
.UnicodeChar
!= CHAR_CARRIAGE_RETURN
);
1121 // The initial value of the orderedlist is invalid, force to be valid value
1122 // Exit current DisplayForm with new value.
1124 gUserInput
->SelectedStatement
= Question
;
1126 ValueArray
= AllocateCopyPool (Question
->CurrentValue
.BufferLen
, Question
->CurrentValue
.Buffer
);
1127 ASSERT (ValueArray
!= NULL
);
1128 gUserInput
->InputValue
.Buffer
= ValueArray
;
1129 gUserInput
->InputValue
.BufferLen
= Question
->CurrentValue
.BufferLen
;
1130 gUserInput
->InputValue
.Type
= Question
->CurrentValue
.Type
;
1133 SetArrayData (ValueArray
, ValueType
, Index
++, OneOfOption
->OptionOpCode
->Value
.u64
);
1137 FreePool (*OptionString
);
1138 *OptionString
= NULL
;
1139 return EFI_NOT_FOUND
;
1144 case EFI_IFR_ONE_OF_OP
:
1146 // Check whether there are Options of this OneOf
1148 if (IsListEmpty (&Question
->OptionListHead
)) {
1155 Status
= GetSelectionInputPopUp (MenuOption
);
1157 MaxLen
= BufferSize
/ sizeof(CHAR16
);
1158 *OptionString
= AllocateZeroPool (BufferSize
);
1159 ASSERT (*OptionString
);
1161 OneOfOption
= ValueToOption (Question
, QuestionValue
);
1162 if (OneOfOption
== NULL
) {
1163 if (SkipErrorValue
) {
1165 // Not report error, just get the correct option string info.
1167 Link
= GetFirstNode (&Question
->OptionListHead
);
1168 OneOfOption
= DISPLAY_QUESTION_OPTION_FROM_LINK (Link
);
1171 // Show error message
1174 CreateDialog (&Key
, gEmptyString
, gOptionMismatch
, gPressEnter
, gEmptyString
, NULL
);
1175 } while (Key
.UnicodeChar
!= CHAR_CARRIAGE_RETURN
);
1178 // Force the Question value to be valid
1179 // Exit current DisplayForm with new value.
1181 Link
= GetFirstNode (&Question
->OptionListHead
);
1182 Option
= DISPLAY_QUESTION_OPTION_FROM_LINK (Link
);
1184 gUserInput
->InputValue
.Type
= Option
->OptionOpCode
->Type
;
1185 switch (gUserInput
->InputValue
.Type
) {
1186 case EFI_IFR_TYPE_NUM_SIZE_8
:
1187 gUserInput
->InputValue
.Value
.u8
= Option
->OptionOpCode
->Value
.u8
;
1189 case EFI_IFR_TYPE_NUM_SIZE_16
:
1190 CopyMem (&gUserInput
->InputValue
.Value
.u16
, &Option
->OptionOpCode
->Value
.u16
, sizeof (UINT16
));
1192 case EFI_IFR_TYPE_NUM_SIZE_32
:
1193 CopyMem (&gUserInput
->InputValue
.Value
.u32
, &Option
->OptionOpCode
->Value
.u32
, sizeof (UINT32
));
1195 case EFI_IFR_TYPE_NUM_SIZE_64
:
1196 CopyMem (&gUserInput
->InputValue
.Value
.u64
, &Option
->OptionOpCode
->Value
.u64
, sizeof (UINT64
));
1202 gUserInput
->SelectedStatement
= Question
;
1204 FreePool (*OptionString
);
1205 *OptionString
= NULL
;
1206 return EFI_NOT_FOUND
;
1210 Character
[0] = LEFT_ONEOF_DELIMITER
;
1211 NewStrCat (OptionString
[0], MaxLen
, Character
);
1212 StringPtr
= GetToken (OneOfOption
->OptionOpCode
->Option
, gFormData
->HiiHandle
);
1213 ASSERT (StringPtr
!= NULL
);
1214 NewStrCat (OptionString
[0], MaxLen
, StringPtr
);
1215 Character
[0] = RIGHT_ONEOF_DELIMITER
;
1216 NewStrCat (OptionString
[0], MaxLen
, Character
);
1218 FreePool (StringPtr
);
1222 case EFI_IFR_CHECKBOX_OP
:
1225 // Since this is a BOOLEAN operation, flip it upon selection
1227 gUserInput
->InputValue
.Type
= QuestionValue
->Type
;
1228 gUserInput
->InputValue
.Value
.b
= (BOOLEAN
) (QuestionValue
->Value
.b
? FALSE
: TRUE
);
1231 // Perform inconsistent check
1235 *OptionString
= AllocateZeroPool (BufferSize
);
1236 ASSERT (*OptionString
);
1238 *OptionString
[0] = LEFT_CHECKBOX_DELIMITER
;
1240 if (QuestionValue
->Value
.b
) {
1241 *(OptionString
[0] + 1) = CHECK_ON
;
1243 *(OptionString
[0] + 1) = CHECK_OFF
;
1245 *(OptionString
[0] + 2) = RIGHT_CHECKBOX_DELIMITER
;
1249 case EFI_IFR_NUMERIC_OP
:
1254 Status
= GetNumericInput (MenuOption
);
1256 *OptionString
= AllocateZeroPool (BufferSize
);
1257 ASSERT (*OptionString
);
1259 *OptionString
[0] = LEFT_NUMERIC_DELIMITER
;
1264 PrintFormattedNumber (Question
, FormattedNumber
, 21 * sizeof (CHAR16
));
1265 Number
= (UINT16
) GetStringWidth (FormattedNumber
);
1266 CopyMem (OptionString
[0] + 1, FormattedNumber
, Number
);
1268 *(OptionString
[0] + Number
/ 2) = RIGHT_NUMERIC_DELIMITER
;
1272 case EFI_IFR_DATE_OP
:
1275 // This is similar to numerics
1277 Status
= GetNumericInput (MenuOption
);
1279 *OptionString
= AllocateZeroPool (BufferSize
);
1280 ASSERT (*OptionString
);
1282 switch (MenuOption
->Sequence
) {
1284 *OptionString
[0] = LEFT_NUMERIC_DELIMITER
;
1285 if (QuestionValue
->Value
.date
.Month
== 0xff){
1286 UnicodeSPrint (OptionString
[0] + 1, 21 * sizeof (CHAR16
), L
"??");
1288 UnicodeSPrint (OptionString
[0] + 1, 21 * sizeof (CHAR16
), L
"%02d", QuestionValue
->Value
.date
.Month
);
1290 *(OptionString
[0] + 3) = DATE_SEPARATOR
;
1294 SetUnicodeMem (OptionString
[0], 4, L
' ');
1295 if (QuestionValue
->Value
.date
.Day
== 0xff){
1296 UnicodeSPrint (OptionString
[0] + 4, 21 * sizeof (CHAR16
), L
"??");
1298 UnicodeSPrint (OptionString
[0] + 4, 21 * sizeof (CHAR16
), L
"%02d", QuestionValue
->Value
.date
.Day
);
1300 *(OptionString
[0] + 6) = DATE_SEPARATOR
;
1304 SetUnicodeMem (OptionString
[0], 7, L
' ');
1305 if (QuestionValue
->Value
.date
.Year
== 0xff){
1306 UnicodeSPrint (OptionString
[0] + 7, 21 * sizeof (CHAR16
), L
"????");
1308 UnicodeSPrint (OptionString
[0] + 7, 21 * sizeof (CHAR16
), L
"%04d", QuestionValue
->Value
.date
.Year
);
1310 *(OptionString
[0] + 11) = RIGHT_NUMERIC_DELIMITER
;
1316 case EFI_IFR_TIME_OP
:
1319 // This is similar to numerics
1321 Status
= GetNumericInput (MenuOption
);
1323 *OptionString
= AllocateZeroPool (BufferSize
);
1324 ASSERT (*OptionString
);
1326 switch (MenuOption
->Sequence
) {
1328 *OptionString
[0] = LEFT_NUMERIC_DELIMITER
;
1329 if (QuestionValue
->Value
.time
.Hour
== 0xff){
1330 UnicodeSPrint (OptionString
[0] + 1, 21 * sizeof (CHAR16
), L
"??");
1332 UnicodeSPrint (OptionString
[0] + 1, 21 * sizeof (CHAR16
), L
"%02d", QuestionValue
->Value
.time
.Hour
);
1334 *(OptionString
[0] + 3) = TIME_SEPARATOR
;
1338 SetUnicodeMem (OptionString
[0], 4, L
' ');
1339 if (QuestionValue
->Value
.time
.Minute
== 0xff){
1340 UnicodeSPrint (OptionString
[0] + 4, 21 * sizeof (CHAR16
), L
"??");
1342 UnicodeSPrint (OptionString
[0] + 4, 21 * sizeof (CHAR16
), L
"%02d", QuestionValue
->Value
.time
.Minute
);
1344 *(OptionString
[0] + 6) = TIME_SEPARATOR
;
1348 SetUnicodeMem (OptionString
[0], 7, L
' ');
1349 if (QuestionValue
->Value
.time
.Second
== 0xff){
1350 UnicodeSPrint (OptionString
[0] + 7, 21 * sizeof (CHAR16
), L
"??");
1352 UnicodeSPrint (OptionString
[0] + 7, 21 * sizeof (CHAR16
), L
"%02d", QuestionValue
->Value
.time
.Second
);
1354 *(OptionString
[0] + 9) = RIGHT_NUMERIC_DELIMITER
;
1360 case EFI_IFR_STRING_OP
:
1362 StringPtr
= AllocateZeroPool (Question
->CurrentValue
.BufferLen
+ sizeof (CHAR16
));
1364 CopyMem(StringPtr
, Question
->CurrentValue
.Buffer
, Question
->CurrentValue
.BufferLen
);
1366 Status
= ReadString (MenuOption
, gPromptForData
, StringPtr
);
1367 if (EFI_ERROR (Status
)) {
1368 FreePool (StringPtr
);
1372 gUserInput
->InputValue
.Buffer
= AllocateCopyPool (Question
->CurrentValue
.BufferLen
, StringPtr
);
1373 gUserInput
->InputValue
.BufferLen
= Question
->CurrentValue
.BufferLen
;
1374 gUserInput
->InputValue
.Type
= Question
->CurrentValue
.Type
;
1375 gUserInput
->InputValue
.Value
.string
= HiiSetString(gFormData
->HiiHandle
, gUserInput
->InputValue
.Value
.string
, StringPtr
, NULL
);
1376 FreePool (StringPtr
);
1379 *OptionString
= AllocateZeroPool (BufferSize
);
1380 ASSERT (*OptionString
);
1382 if (((CHAR16
*) Question
->CurrentValue
.Buffer
)[0] == 0x0000) {
1383 *(OptionString
[0]) = '_';
1385 if (Question
->CurrentValue
.BufferLen
< BufferSize
) {
1386 BufferSize
= Question
->CurrentValue
.BufferLen
;
1388 CopyMem (OptionString
[0], (CHAR16
*) Question
->CurrentValue
.Buffer
, BufferSize
);
1393 case EFI_IFR_PASSWORD_OP
:
1395 Status
= PasswordProcess (MenuOption
);
1408 Process the help string: Split StringPtr to several lines of strings stored in
1409 FormattedString and the glyph width of each line cannot exceed gHelpBlockWidth.
1411 @param StringPtr The entire help string.
1412 @param FormattedString The oupput formatted string.
1413 @param EachLineWidth The max string length of each line in the formatted string.
1414 @param RowCount TRUE: if Question is selected.
1419 IN CHAR16
*StringPtr
,
1420 OUT CHAR16
**FormattedString
,
1421 OUT UINT16
*EachLineWidth
,
1426 CHAR16
*OutputString
;
1431 UINT16 MaxStringLen
;
1442 // Set default help string width.
1444 LineWidth
= (UINT16
) (gHelpBlockWidth
- 1);
1447 // Get row number of the String.
1449 while ((StringLen
= GetLineByWidth (StringPtr
, LineWidth
, &GlyphWidth
, &Index
, &OutputString
)) != 0) {
1450 if (StringLen
> MaxStringLen
) {
1451 MaxStringLen
= StringLen
;
1455 FreePool (OutputString
);
1457 *EachLineWidth
= MaxStringLen
;
1459 *FormattedString
= AllocateZeroPool (TotalRowNum
* MaxStringLen
* sizeof (CHAR16
));
1460 ASSERT (*FormattedString
!= NULL
);
1463 // Generate formatted help string array.
1467 while((StringLen
= GetLineByWidth (StringPtr
, LineWidth
, &GlyphWidth
, &Index
, &OutputString
)) != 0) {
1468 CopyMem (*FormattedString
+ CheckedNum
* MaxStringLen
, OutputString
, StringLen
* sizeof (CHAR16
));
1470 FreePool (OutputString
);