2 Implementation for handling the User Interface option processing.
5 Copyright (c) 2004 - 2011, 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.
20 Process Question Config.
22 @param Selection The UI menu selection.
23 @param Question The Question to be peocessed.
25 @retval EFI_SUCCESS Question Config process success.
26 @retval Other Question Config process fail.
30 ProcessQuestionConfig (
31 IN UI_MENU_SELECTION
*Selection
,
32 IN FORM_BROWSER_STATEMENT
*Question
38 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
40 if (Question
->QuestionConfig
== 0) {
47 ConfigResp
= GetToken (Question
->QuestionConfig
, Selection
->FormSet
->HiiHandle
);
48 if (ConfigResp
== NULL
) {
53 // Send config to Configuration Driver
55 ConfigAccess
= Selection
->FormSet
->ConfigAccess
;
56 if (ConfigAccess
== NULL
) {
57 return EFI_UNSUPPORTED
;
59 Status
= ConfigAccess
->RouteConfig (
70 Search an Option of a Question by its value.
72 @param Question The Question
73 @param OptionValue Value for Option to be searched.
75 @retval Pointer Pointer to the found Option.
76 @retval NULL Option not found.
81 IN FORM_BROWSER_STATEMENT
*Question
,
82 IN EFI_HII_VALUE
*OptionValue
86 QUESTION_OPTION
*Option
;
88 Link
= GetFirstNode (&Question
->OptionListHead
);
89 while (!IsNull (&Question
->OptionListHead
, Link
)) {
90 Option
= QUESTION_OPTION_FROM_LINK (Link
);
92 if (CompareHiiValue (&Option
->Value
, OptionValue
, NULL
) == 0) {
96 Link
= GetNextNode (&Question
->OptionListHead
, Link
);
104 Return data element in an Array by its Index.
106 @param Array The data array.
107 @param Type Type of the data in this array.
108 @param Index Zero based index for data in this array.
110 @retval Value The data to be returned
122 ASSERT (Array
!= NULL
);
126 case EFI_IFR_TYPE_NUM_SIZE_8
:
127 Data
= (UINT64
) *(((UINT8
*) Array
) + Index
);
130 case EFI_IFR_TYPE_NUM_SIZE_16
:
131 Data
= (UINT64
) *(((UINT16
*) Array
) + Index
);
134 case EFI_IFR_TYPE_NUM_SIZE_32
:
135 Data
= (UINT64
) *(((UINT32
*) Array
) + Index
);
138 case EFI_IFR_TYPE_NUM_SIZE_64
:
139 Data
= (UINT64
) *(((UINT64
*) Array
) + Index
);
151 Set value of a data element in an Array by its Index.
153 @param Array The data array.
154 @param Type Type of the data in this array.
155 @param Index Zero based index for data in this array.
156 @param Value The value to be set.
168 ASSERT (Array
!= NULL
);
171 case EFI_IFR_TYPE_NUM_SIZE_8
:
172 *(((UINT8
*) Array
) + Index
) = (UINT8
) Value
;
175 case EFI_IFR_TYPE_NUM_SIZE_16
:
176 *(((UINT16
*) Array
) + Index
) = (UINT16
) Value
;
179 case EFI_IFR_TYPE_NUM_SIZE_32
:
180 *(((UINT32
*) Array
) + Index
) = (UINT32
) Value
;
183 case EFI_IFR_TYPE_NUM_SIZE_64
:
184 *(((UINT64
*) Array
) + Index
) = (UINT64
) Value
;
194 Print Question Value according to it's storage width and display attributes.
196 @param Question The Question to be printed.
197 @param FormattedNumber Buffer for output string.
198 @param BufferSize The FormattedNumber buffer size in bytes.
200 @retval EFI_SUCCESS Print success.
201 @retval EFI_BUFFER_TOO_SMALL Buffer size is not enough for formatted number.
205 PrintFormattedNumber (
206 IN FORM_BROWSER_STATEMENT
*Question
,
207 IN OUT CHAR16
*FormattedNumber
,
213 EFI_HII_VALUE
*QuestionValue
;
215 if (BufferSize
< (21 * sizeof (CHAR16
))) {
216 return EFI_BUFFER_TOO_SMALL
;
219 QuestionValue
= &Question
->HiiValue
;
221 Value
= (INT64
) QuestionValue
->Value
.u64
;
222 switch (Question
->Flags
& EFI_IFR_DISPLAY
) {
223 case EFI_IFR_DISPLAY_INT_DEC
:
224 switch (QuestionValue
->Type
) {
225 case EFI_IFR_NUMERIC_SIZE_1
:
226 Value
= (INT64
) ((INT8
) QuestionValue
->Value
.u8
);
229 case EFI_IFR_NUMERIC_SIZE_2
:
230 Value
= (INT64
) ((INT16
) QuestionValue
->Value
.u16
);
233 case EFI_IFR_NUMERIC_SIZE_4
:
234 Value
= (INT64
) ((INT32
) QuestionValue
->Value
.u32
);
237 case EFI_IFR_NUMERIC_SIZE_8
:
250 case EFI_IFR_DISPLAY_UINT_DEC
:
254 case EFI_IFR_DISPLAY_UINT_HEX
:
259 return EFI_UNSUPPORTED
;
263 UnicodeSPrint (FormattedNumber
, BufferSize
, Format
, Value
);
270 Password may be stored as encrypted by Configuration Driver. When change a
271 password, user will be challenged with old password. To validate user input old
272 password, we will send the clear text to Configuration Driver via Callback().
273 Configuration driver is responsible to check the passed in password and return
274 the validation result. If validation pass, state machine in password Callback()
275 will transit from BROWSER_STATE_VALIDATE_PASSWORD to BROWSER_STATE_SET_PASSWORD.
276 After user type in new password twice, Callback() will be invoked to send the
277 new password to Configuration Driver.
279 @param Selection Pointer to UI_MENU_SELECTION.
280 @param MenuOption The MenuOption for this password Question.
281 @param String The clear text of password.
283 @retval EFI_NOT_AVAILABLE_YET Callback() request to terminate password input.
284 @return In state of BROWSER_STATE_VALIDATE_PASSWORD:
285 @retval EFI_SUCCESS Password correct, Browser will prompt for new
287 @retval EFI_NOT_READY Password incorrect, Browser will show error
289 @retval Other Browser will do nothing.
290 @return In state of BROWSER_STATE_SET_PASSWORD:
291 @retval EFI_SUCCESS Set password success.
292 @retval Other Set password failed.
297 IN UI_MENU_SELECTION
*Selection
,
298 IN UI_MENU_OPTION
*MenuOption
,
303 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
304 EFI_BROWSER_ACTION_REQUEST ActionRequest
;
305 EFI_IFR_TYPE_VALUE IfrTypeValue
;
307 ConfigAccess
= Selection
->FormSet
->ConfigAccess
;
308 if (ConfigAccess
== NULL
) {
309 return EFI_UNSUPPORTED
;
313 // Prepare password string in HII database
315 if (String
!= NULL
) {
316 IfrTypeValue
.string
= NewString (String
, Selection
->FormSet
->HiiHandle
);
318 IfrTypeValue
.string
= 0;
322 // Send password to Configuration Driver for validation
324 Status
= ConfigAccess
->Callback (
326 EFI_BROWSER_ACTION_CHANGING
,
327 MenuOption
->ThisTag
->QuestionId
,
328 MenuOption
->ThisTag
->HiiValue
.Type
,
334 // Remove password string from HII database
336 if (String
!= NULL
) {
337 DeleteString (IfrTypeValue
.string
, Selection
->FormSet
->HiiHandle
);
345 Display error message for invalid password.
356 // Invalid password, prompt error message
359 CreateDialog (4, TRUE
, 0, NULL
, &Key
, gEmptyString
, gPassowordInvalid
, gPressEnter
, gEmptyString
);
360 } while (Key
.UnicodeChar
!= CHAR_CARRIAGE_RETURN
);
365 Process a Question's Option (whether selected or un-selected).
367 @param Selection Pointer to UI_MENU_SELECTION.
368 @param MenuOption The MenuOption for this Question.
369 @param Selected TRUE: if Question is selected.
370 @param OptionString Pointer of the Option String to be displayed.
372 @retval EFI_SUCCESS Question Option process success.
373 @retval Other Question Option process fail.
378 IN UI_MENU_SELECTION
*Selection
,
379 IN UI_MENU_OPTION
*MenuOption
,
381 OUT CHAR16
**OptionString
388 FORM_BROWSER_STATEMENT
*Question
;
389 CHAR16 FormattedNumber
[21];
394 QUESTION_OPTION
*OneOfOption
;
396 EFI_HII_VALUE HiiValue
;
397 EFI_HII_VALUE
*QuestionValue
;
400 QUESTION_OPTION
*Option
;
404 EFI_STRING_ID StringId
;
406 Status
= EFI_SUCCESS
;
409 Character
[1] = L
'\0';
410 *OptionString
= NULL
;
413 ZeroMem (FormattedNumber
, 21 * sizeof (CHAR16
));
414 BufferSize
= (gOptionBlockWidth
+ 1) * 2 * gScreenDimensions
.BottomRow
;
416 Question
= MenuOption
->ThisTag
;
417 QuestionValue
= &Question
->HiiValue
;
418 Maximum
= (UINT16
) Question
->Maximum
;
420 ValueArray
= Question
->BufferValue
;
421 ValueType
= Question
->ValueType
;
423 switch (Question
->Operand
) {
424 case EFI_IFR_ORDERED_LIST_OP
:
426 // Check whether there are Options of this OrderedList
428 if (IsListEmpty (&Question
->OptionListHead
)) {
432 // Initialize Option value array
434 if (GetArrayData (ValueArray
, ValueType
, 0) == 0) {
435 GetQuestionDefault (Selection
->FormSet
, Selection
->Form
, Question
, 0);
442 Status
= GetSelectionInputPopUp (Selection
, MenuOption
);
445 // We now know how many strings we will have, so we can allocate the
446 // space required for the array or strings.
448 *OptionString
= AllocateZeroPool (Question
->MaxContainers
* BufferSize
);
449 ASSERT (*OptionString
);
451 HiiValue
.Type
= ValueType
;
452 HiiValue
.Value
.u64
= 0;
453 for (Index
= 0; Index
< Question
->MaxContainers
; Index
++) {
454 HiiValue
.Value
.u64
= GetArrayData (ValueArray
, ValueType
, Index
);
455 if (HiiValue
.Value
.u64
== 0) {
457 // Values for the options in ordered lists should never be a 0
462 OneOfOption
= ValueToOption (Question
, &HiiValue
);
463 if (OneOfOption
== NULL
) {
465 // Show error message
468 CreateDialog (4, TRUE
, 0, NULL
, &Key
, gEmptyString
, gOptionMismatch
, gPressEnter
, gEmptyString
);
469 } while (Key
.UnicodeChar
!= CHAR_CARRIAGE_RETURN
);
472 // The initial value of the orderedlist is invalid, force to be valid value
474 Link
= GetFirstNode (&Question
->OptionListHead
);
476 while (!IsNull (&Question
->OptionListHead
, Link
) && Index2
< Question
->MaxContainers
) {
477 Option
= QUESTION_OPTION_FROM_LINK (Link
);
478 SetArrayData (ValueArray
, ValueType
, Index2
, Option
->Value
.Value
.u64
);
480 Link
= GetNextNode (&Question
->OptionListHead
, Link
);
482 SetArrayData (ValueArray
, ValueType
, Index2
, 0);
484 Status
= SetQuestionValue (Selection
->FormSet
, Selection
->Form
, Question
, TRUE
);
485 UpdateStatusBar (Selection
, NV_UPDATE_REQUIRED
, Question
->QuestionFlags
, TRUE
);
487 FreePool (*OptionString
);
488 *OptionString
= NULL
;
489 return EFI_NOT_FOUND
;
493 if ((OneOfOption
->SuppressExpression
!= NULL
) &&
494 (OneOfOption
->SuppressExpression
->Result
.Value
.b
)) {
496 // This option is suppressed
502 Character
[0] = LEFT_ONEOF_DELIMITER
;
503 NewStrCat (OptionString
[0], Character
);
504 StringPtr
= GetToken (OneOfOption
->Text
, Selection
->Handle
);
505 NewStrCat (OptionString
[0], StringPtr
);
506 Character
[0] = RIGHT_ONEOF_DELIMITER
;
507 NewStrCat (OptionString
[0], Character
);
508 Character
[0] = CHAR_CARRIAGE_RETURN
;
509 NewStrCat (OptionString
[0], Character
);
511 FreePool (StringPtr
);
517 case EFI_IFR_ONE_OF_OP
:
519 // Check whether there are Options of this OneOf
521 if (IsListEmpty (&Question
->OptionListHead
)) {
528 Status
= GetSelectionInputPopUp (Selection
, MenuOption
);
530 *OptionString
= AllocateZeroPool (BufferSize
);
531 ASSERT (*OptionString
);
533 OneOfOption
= ValueToOption (Question
, QuestionValue
);
534 if (OneOfOption
== NULL
) {
536 // Show error message
539 CreateDialog (4, TRUE
, 0, NULL
, &Key
, gEmptyString
, gOptionMismatch
, gPressEnter
, gEmptyString
);
540 } while (Key
.UnicodeChar
!= CHAR_CARRIAGE_RETURN
);
543 // Force the Question value to be valid
545 Link
= GetFirstNode (&Question
->OptionListHead
);
546 while (!IsNull (&Question
->OptionListHead
, Link
)) {
547 Option
= QUESTION_OPTION_FROM_LINK (Link
);
549 if ((Option
->SuppressExpression
== NULL
) ||
550 !Option
->SuppressExpression
->Result
.Value
.b
) {
551 CopyMem (QuestionValue
, &Option
->Value
, sizeof (EFI_HII_VALUE
));
552 SetQuestionValue (Selection
->FormSet
, Selection
->Form
, Question
, TRUE
);
553 UpdateStatusBar (Selection
, NV_UPDATE_REQUIRED
, Question
->QuestionFlags
, TRUE
);
557 Link
= GetNextNode (&Question
->OptionListHead
, Link
);
560 FreePool (*OptionString
);
561 *OptionString
= NULL
;
562 return EFI_NOT_FOUND
;
565 if ((OneOfOption
->SuppressExpression
!= NULL
) &&
566 (OneOfOption
->SuppressExpression
->Result
.Value
.b
)) {
568 // This option is suppressed
577 // Current selected option happen to be suppressed,
578 // enforce to select on a non-suppressed option
580 Link
= GetFirstNode (&Question
->OptionListHead
);
581 while (!IsNull (&Question
->OptionListHead
, Link
)) {
582 OneOfOption
= QUESTION_OPTION_FROM_LINK (Link
);
584 if ((OneOfOption
->SuppressExpression
== NULL
) ||
585 !OneOfOption
->SuppressExpression
->Result
.Value
.b
) {
587 CopyMem (QuestionValue
, &OneOfOption
->Value
, sizeof (EFI_HII_VALUE
));
588 SetQuestionValue (Selection
->FormSet
, Selection
->Form
, Question
, TRUE
);
589 UpdateStatusBar (Selection
, NV_UPDATE_REQUIRED
, Question
->QuestionFlags
, TRUE
);
590 gST
->ConOut
->SetAttribute (gST
->ConOut
, PcdGet8 (PcdBrowserFieldTextColor
) | FIELD_BACKGROUND
);
594 Link
= GetNextNode (&Question
->OptionListHead
, Link
);
599 Character
[0] = LEFT_ONEOF_DELIMITER
;
600 NewStrCat (OptionString
[0], Character
);
601 StringPtr
= GetToken (OneOfOption
->Text
, Selection
->Handle
);
602 NewStrCat (OptionString
[0], StringPtr
);
603 Character
[0] = RIGHT_ONEOF_DELIMITER
;
604 NewStrCat (OptionString
[0], Character
);
606 FreePool (StringPtr
);
611 case EFI_IFR_CHECKBOX_OP
:
612 *OptionString
= AllocateZeroPool (BufferSize
);
613 ASSERT (*OptionString
);
615 *OptionString
[0] = LEFT_CHECKBOX_DELIMITER
;
619 // Since this is a BOOLEAN operation, flip it upon selection
621 QuestionValue
->Value
.b
= (BOOLEAN
) (QuestionValue
->Value
.b
? FALSE
: TRUE
);
624 // Perform inconsistent check
626 Status
= ValidateQuestion (Selection
->FormSet
, Selection
->Form
, Question
, EFI_HII_EXPRESSION_INCONSISTENT_IF
);
627 if (EFI_ERROR (Status
)) {
629 // Inconsistent check fail, restore Question Value
631 QuestionValue
->Value
.b
= (BOOLEAN
) (QuestionValue
->Value
.b
? FALSE
: TRUE
);
632 FreePool (*OptionString
);
633 *OptionString
= NULL
;
638 // Save Question value
640 Status
= SetQuestionValue (Selection
->FormSet
, Selection
->Form
, Question
, TRUE
);
641 UpdateStatusBar (Selection
, NV_UPDATE_REQUIRED
, Question
->QuestionFlags
, TRUE
);
644 if (QuestionValue
->Value
.b
) {
645 *(OptionString
[0] + 1) = CHECK_ON
;
647 *(OptionString
[0] + 1) = CHECK_OFF
;
649 *(OptionString
[0] + 2) = RIGHT_CHECKBOX_DELIMITER
;
652 case EFI_IFR_NUMERIC_OP
:
657 Status
= GetNumericInput (Selection
, MenuOption
);
659 *OptionString
= AllocateZeroPool (BufferSize
);
660 ASSERT (*OptionString
);
662 *OptionString
[0] = LEFT_NUMERIC_DELIMITER
;
667 PrintFormattedNumber (Question
, FormattedNumber
, 21 * sizeof (CHAR16
));
668 Number
= (UINT16
) GetStringWidth (FormattedNumber
);
669 CopyMem (OptionString
[0] + 1, FormattedNumber
, Number
);
671 *(OptionString
[0] + Number
/ 2) = RIGHT_NUMERIC_DELIMITER
;
675 case EFI_IFR_DATE_OP
:
678 // This is similar to numerics
680 Status
= GetNumericInput (Selection
, MenuOption
);
682 *OptionString
= AllocateZeroPool (BufferSize
);
683 ASSERT (*OptionString
);
685 switch (MenuOption
->Sequence
) {
687 *OptionString
[0] = LEFT_NUMERIC_DELIMITER
;
688 UnicodeSPrint (OptionString
[0] + 1, 21 * sizeof (CHAR16
), L
"%02d", QuestionValue
->Value
.date
.Month
);
689 *(OptionString
[0] + 3) = DATE_SEPARATOR
;
693 SetUnicodeMem (OptionString
[0], 4, L
' ');
694 UnicodeSPrint (OptionString
[0] + 4, 21 * sizeof (CHAR16
), L
"%02d", QuestionValue
->Value
.date
.Day
);
695 *(OptionString
[0] + 6) = DATE_SEPARATOR
;
699 SetUnicodeMem (OptionString
[0], 7, L
' ');
700 UnicodeSPrint (OptionString
[0] + 7, 21 * sizeof (CHAR16
), L
"%4d", QuestionValue
->Value
.date
.Year
);
701 *(OptionString
[0] + 11) = RIGHT_NUMERIC_DELIMITER
;
707 case EFI_IFR_TIME_OP
:
710 // This is similar to numerics
712 Status
= GetNumericInput (Selection
, MenuOption
);
714 *OptionString
= AllocateZeroPool (BufferSize
);
715 ASSERT (*OptionString
);
717 switch (MenuOption
->Sequence
) {
719 *OptionString
[0] = LEFT_NUMERIC_DELIMITER
;
720 UnicodeSPrint (OptionString
[0] + 1, 21 * sizeof (CHAR16
), L
"%02d", QuestionValue
->Value
.time
.Hour
);
721 *(OptionString
[0] + 3) = TIME_SEPARATOR
;
725 SetUnicodeMem (OptionString
[0], 4, L
' ');
726 UnicodeSPrint (OptionString
[0] + 4, 21 * sizeof (CHAR16
), L
"%02d", QuestionValue
->Value
.time
.Minute
);
727 *(OptionString
[0] + 6) = TIME_SEPARATOR
;
731 SetUnicodeMem (OptionString
[0], 7, L
' ');
732 UnicodeSPrint (OptionString
[0] + 7, 21 * sizeof (CHAR16
), L
"%02d", QuestionValue
->Value
.time
.Second
);
733 *(OptionString
[0] + 9) = RIGHT_NUMERIC_DELIMITER
;
739 case EFI_IFR_STRING_OP
:
741 StringPtr
= AllocateZeroPool ((Maximum
+ 1) * sizeof (CHAR16
));
744 Status
= ReadString (MenuOption
, gPromptForData
, StringPtr
);
745 if (!EFI_ERROR (Status
)) {
746 HiiSetString(Selection
->FormSet
->HiiHandle
, Question
->HiiValue
.Value
.string
, StringPtr
, NULL
);
747 Status
= ValidateQuestion(Selection
->FormSet
, Selection
->Form
, Question
, EFI_HII_EXPRESSION_INCONSISTENT_IF
);
748 if (EFI_ERROR (Status
)) {
749 HiiSetString(Selection
->FormSet
->HiiHandle
, Question
->HiiValue
.Value
.string
, (CHAR16
*)Question
->BufferValue
, NULL
);
751 CopyMem (Question
->BufferValue
, StringPtr
, Maximum
* sizeof (CHAR16
));
752 SetQuestionValue (Selection
->FormSet
, Selection
->Form
, Question
, TRUE
);
754 UpdateStatusBar (Selection
, NV_UPDATE_REQUIRED
, Question
->QuestionFlags
, TRUE
);
758 FreePool (StringPtr
);
760 *OptionString
= AllocateZeroPool (BufferSize
);
761 ASSERT (*OptionString
);
763 if (((CHAR16
*) Question
->BufferValue
)[0] == 0x0000) {
764 *(OptionString
[0]) = '_';
766 if ((Maximum
* sizeof (CHAR16
)) < BufferSize
) {
767 BufferSize
= Maximum
* sizeof (CHAR16
);
769 CopyMem (OptionString
[0], (CHAR16
*) Question
->BufferValue
, BufferSize
);
774 case EFI_IFR_PASSWORD_OP
:
776 StringPtr
= AllocateZeroPool ((Maximum
+ 1) * sizeof (CHAR16
));
780 // For interactive passwords, old password is validated by callback
782 if ((Question
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
) != 0) {
784 // Use a NULL password to test whether old password is required
787 Status
= PasswordCallback (Selection
, MenuOption
, StringPtr
);
788 if (Status
== EFI_NOT_AVAILABLE_YET
|| Status
== EFI_UNSUPPORTED
) {
790 // Callback is not supported, or
791 // Callback request to terminate password input
793 FreePool (StringPtr
);
797 if (EFI_ERROR (Status
)) {
799 // Old password exist, ask user for the old password
801 Status
= ReadString (MenuOption
, gPromptForPassword
, StringPtr
);
802 if (EFI_ERROR (Status
)) {
803 FreePool (StringPtr
);
808 // Check user input old password
810 Status
= PasswordCallback (Selection
, MenuOption
, StringPtr
);
811 if (EFI_ERROR (Status
)) {
812 if (Status
== EFI_NOT_READY
) {
814 // Typed in old password incorrect
818 Status
= EFI_SUCCESS
;
821 FreePool (StringPtr
);
827 // For non-interactive password, validate old password in local
829 if (*((CHAR16
*) Question
->BufferValue
) != 0) {
831 // There is something there! Prompt for password
833 Status
= ReadString (MenuOption
, gPromptForPassword
, StringPtr
);
834 if (EFI_ERROR (Status
)) {
835 FreePool (StringPtr
);
839 TempString
= AllocateCopyPool ((Maximum
+ 1) * sizeof (CHAR16
), Question
->BufferValue
);
840 ASSERT (TempString
!= NULL
);
842 TempString
[Maximum
] = L
'\0';
844 if (StrCmp (StringPtr
, TempString
) != 0) {
846 // Typed in old password incorrect
850 FreePool (StringPtr
);
851 FreePool (TempString
);
855 FreePool (TempString
);
860 // Ask for new password
862 ZeroMem (StringPtr
, (Maximum
+ 1) * sizeof (CHAR16
));
863 Status
= ReadString (MenuOption
, gPromptForNewPassword
, StringPtr
);
864 if (EFI_ERROR (Status
)) {
866 // Reset state machine for interactive password
868 if ((Question
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
) != 0) {
869 PasswordCallback (Selection
, MenuOption
, NULL
);
872 FreePool (StringPtr
);
877 // Confirm new password
879 TempString
= AllocateZeroPool ((Maximum
+ 1) * sizeof (CHAR16
));
881 Status
= ReadString (MenuOption
, gConfirmPassword
, TempString
);
882 if (EFI_ERROR (Status
)) {
884 // Reset state machine for interactive password
886 if ((Question
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
) != 0) {
887 PasswordCallback (Selection
, MenuOption
, NULL
);
890 FreePool (StringPtr
);
891 FreePool (TempString
);
896 // Compare two typed-in new passwords
898 if (StrCmp (StringPtr
, TempString
) == 0) {
900 // Prepare the Question->HiiValue.Value.string for ValidateQuestion use.
902 if((Question
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
) != 0) {
903 StringId
= Question
->HiiValue
.Value
.string
;
904 Question
->HiiValue
.Value
.string
= NewString (StringPtr
, Selection
->FormSet
->HiiHandle
);
906 HiiSetString(Selection
->FormSet
->HiiHandle
, Question
->HiiValue
.Value
.string
, StringPtr
, NULL
);
909 Status
= ValidateQuestion(Selection
->FormSet
, Selection
->Form
, Question
, EFI_HII_EXPRESSION_INCONSISTENT_IF
);
912 // Researve the Question->HiiValue.Value.string.
914 if((Question
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
) != 0) {
915 DeleteString(Question
->HiiValue
.Value
.string
, Selection
->FormSet
->HiiHandle
);
916 Question
->HiiValue
.Value
.string
= StringId
;
919 if (EFI_ERROR (Status
)) {
921 // Reset state machine for interactive password
923 if ((Question
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
) != 0) {
924 PasswordCallback (Selection
, MenuOption
, NULL
);
927 // Researve the Question->HiiValue.Value.string.
929 HiiSetString(Selection
->FormSet
->HiiHandle
, Question
->HiiValue
.Value
.string
, (CHAR16
*)Question
->BufferValue
, NULL
);
933 // Two password match, send it to Configuration Driver
935 if ((Question
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
) != 0) {
936 PasswordCallback (Selection
, MenuOption
, StringPtr
);
938 CopyMem (Question
->BufferValue
, StringPtr
, Maximum
* sizeof (CHAR16
));
939 SetQuestionValue (Selection
->FormSet
, Selection
->Form
, Question
, FALSE
);
944 // Reset state machine for interactive password
946 if ((Question
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
) != 0) {
947 PasswordCallback (Selection
, MenuOption
, NULL
);
951 // Two password mismatch, prompt error message
954 CreateDialog (4, TRUE
, 0, NULL
, &Key
, gEmptyString
, gConfirmError
, gPressEnter
, gEmptyString
);
955 } while (Key
.UnicodeChar
!= CHAR_CARRIAGE_RETURN
);
958 FreePool (TempString
);
959 FreePool (StringPtr
);
972 Process the help string: Split StringPtr to several lines of strings stored in
973 FormattedString and the glyph width of each line cannot exceed gHelpBlockWidth.
975 @param StringPtr The entire help string.
976 @param FormattedString The oupput formatted string.
977 @param RowCount TRUE: if Question is selected.
982 IN CHAR16
*StringPtr
,
983 OUT CHAR16
**FormattedString
,
990 // [PrevCurrIndex, CurrIndex) forms a range of a screen-line
995 UINTN VirtualLineCount
;
997 // GlyphOffset stores glyph width of current screen-line
1001 // GlyphWidth equals to 2 if we meet width directive
1005 // during scanning, we remember the position of last space character
1006 // in case that if next word cannot put in current line, we could restore back to the position
1007 // of last space character
1008 // while we should also remmeber the glyph width of the last space character for restoring
1010 UINTN LastSpaceIndex
;
1011 UINTN LastSpaceGlyphWidth
;
1013 // every time we begin to form a new screen-line, we should remember glyph width of single character
1016 UINTN LineStartGlyphWidth
;
1018 UINTN
*OldIndexArray
;
1020 BlockWidth
= (UINTN
) gHelpBlockWidth
- 1;
1023 // every three elements of IndexArray form a screen-line of string:[ IndexArray[i*3], IndexArray[i*3+1] )
1024 // IndexArray[i*3+2] stores the initial glyph width of single character. to save this is because we want
1025 // to bring the width directive of the last line to current screen-line.
1026 // e.g.: "\wideabcde ... fghi", if "fghi" also has width directive but is splitted to the next screen-line
1027 // different from that of "\wideabcde", we should remember the width directive.
1029 AllocateSize
= 0x20;
1030 IndexArray
= AllocatePool (AllocateSize
* sizeof (UINTN
) * 3);
1031 ASSERT (IndexArray
!= NULL
);
1033 if (*FormattedString
!= NULL
) {
1034 FreePool (*FormattedString
);
1035 *FormattedString
= NULL
;
1038 for (PrevCurrIndex
= 0, CurrIndex
= 0, LineCount
= 0, LastSpaceIndex
= 0,
1039 IndexArray
[0] = 0, GlyphWidth
= 1, GlyphOffset
= 0, LastSpaceGlyphWidth
= 1, LineStartGlyphWidth
= 1;
1040 (StringPtr
[CurrIndex
] != CHAR_NULL
);
1043 if (LineCount
== AllocateSize
) {
1044 AllocateSize
+= 0x10;
1045 OldIndexArray
= IndexArray
;
1046 IndexArray
= AllocatePool (AllocateSize
* sizeof (UINTN
) * 3);
1047 ASSERT (IndexArray
!= NULL
);
1049 CopyMem (IndexArray
, OldIndexArray
, LineCount
* sizeof (UINTN
) * 3);
1050 FreePool (OldIndexArray
);
1052 switch (StringPtr
[CurrIndex
]) {
1056 GlyphWidth
= ((StringPtr
[CurrIndex
] == WIDE_CHAR
) ? 2 : 1);
1057 if (CurrIndex
== 0) {
1058 LineStartGlyphWidth
= GlyphWidth
;
1064 // "\r\n" isn't handled here, handled by case CHAR_CARRIAGE_RETURN
1068 // Store a range of string as a line
1070 IndexArray
[LineCount
*3] = PrevCurrIndex
;
1071 IndexArray
[LineCount
*3+1] = CurrIndex
;
1072 IndexArray
[LineCount
*3+2] = LineStartGlyphWidth
;
1075 // Reset offset and save begin position of line
1078 LineStartGlyphWidth
= GlyphWidth
;
1079 PrevCurrIndex
= CurrIndex
+ 1;
1084 // "\r\n" and "\r" both are handled here
1086 case CHAR_CARRIAGE_RETURN
:
1087 if (StringPtr
[CurrIndex
+ 1] == CHAR_LINEFEED
) {
1089 // next char is '\n'
1091 IndexArray
[LineCount
*3] = PrevCurrIndex
;
1092 IndexArray
[LineCount
*3+1] = CurrIndex
;
1093 IndexArray
[LineCount
*3+2] = LineStartGlyphWidth
;
1098 LineStartGlyphWidth
= GlyphWidth
;
1099 PrevCurrIndex
= CurrIndex
+ 1;
1103 // char is space or other char
1106 GlyphOffset
+= GlyphWidth
;
1107 if (GlyphOffset
>= BlockWidth
) {
1108 if (LastSpaceIndex
> PrevCurrIndex
) {
1110 // LastSpaceIndex points to space inside current screen-line,
1111 // restore to LastSpaceIndex
1112 // (Otherwise the word is too long to fit one screen-line, just cut it)
1114 CurrIndex
= LastSpaceIndex
;
1115 GlyphWidth
= LastSpaceGlyphWidth
;
1116 } else if (GlyphOffset
> BlockWidth
) {
1118 // the word is too long to fit one screen-line and we don't get the chance
1119 // of GlyphOffset == BlockWidth because GlyphWidth = 2
1124 IndexArray
[LineCount
*3] = PrevCurrIndex
;
1125 IndexArray
[LineCount
*3+1] = CurrIndex
+ 1;
1126 IndexArray
[LineCount
*3+2] = LineStartGlyphWidth
;
1127 LineStartGlyphWidth
= GlyphWidth
;
1130 // Reset offset and save begin position of line
1133 PrevCurrIndex
= CurrIndex
+ 1;
1137 // LastSpaceIndex: remember position of last space
1139 if (StringPtr
[CurrIndex
] == CHAR_SPACE
) {
1140 LastSpaceIndex
= CurrIndex
;
1141 LastSpaceGlyphWidth
= GlyphWidth
;
1147 if (GlyphOffset
> 0) {
1148 IndexArray
[LineCount
*3] = PrevCurrIndex
;
1149 IndexArray
[LineCount
*3+1] = CurrIndex
;
1150 IndexArray
[LineCount
*3+2] = GlyphWidth
;
1154 if (LineCount
== 0) {
1156 // in case we meet null string
1161 // we assume null string's glyph width is 1
1167 VirtualLineCount
= RowCount
* (LineCount
/ RowCount
+ (LineCount
% RowCount
> 0));
1168 *FormattedString
= AllocateZeroPool (VirtualLineCount
* (BlockWidth
+ 1) * sizeof (CHAR16
) * 2);
1169 ASSERT (*FormattedString
!= NULL
);
1171 for (CurrIndex
= 0; CurrIndex
< LineCount
; CurrIndex
++) {
1172 *(*FormattedString
+ CurrIndex
* 2 * (BlockWidth
+ 1)) = (CHAR16
) ((IndexArray
[CurrIndex
*3+2] == 2) ? WIDE_CHAR
: NARROW_CHAR
);
1174 *FormattedString
+ CurrIndex
* 2 * (BlockWidth
+ 1) + 1,
1175 StringPtr
+ IndexArray
[CurrIndex
*3],
1176 IndexArray
[CurrIndex
*3+1]-IndexArray
[CurrIndex
*3]
1180 FreePool (IndexArray
);