2 Implementation for handling the User Interface option processing.
5 Copyright (c) 2004 - 2009, Intel Corporation
6 All rights reserved. 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_HII_VALUE
*QuestionValue
;
307 QuestionValue
= &MenuOption
->ThisTag
->HiiValue
;
308 ConfigAccess
= Selection
->FormSet
->ConfigAccess
;
309 if (ConfigAccess
== NULL
) {
310 return EFI_UNSUPPORTED
;
314 // Prepare password string in HII database
316 if (String
!= NULL
) {
317 QuestionValue
->Value
.string
= NewString (String
, Selection
->FormSet
->HiiHandle
);
319 QuestionValue
->Value
.string
= 0;
323 // Send password to Configuration Driver for validation
325 Status
= ConfigAccess
->Callback (
327 EFI_BROWSER_ACTION_CHANGING
,
328 MenuOption
->ThisTag
->QuestionId
,
330 &QuestionValue
->Value
,
335 // Remove password string from HII database
337 if (String
!= NULL
) {
338 DeleteString (QuestionValue
->Value
.string
, Selection
->FormSet
->HiiHandle
);
346 Display error message for invalid password.
357 // Invalid password, prompt error message
360 CreateDialog (4, TRUE
, 0, NULL
, &Key
, gEmptyString
, gPassowordInvalid
, gPressEnter
, gEmptyString
);
361 } while (Key
.UnicodeChar
!= CHAR_CARRIAGE_RETURN
);
366 Process a Question's Option (whether selected or un-selected).
368 @param Selection Pointer to UI_MENU_SELECTION.
369 @param MenuOption The MenuOption for this Question.
370 @param Selected TRUE: if Question is selected.
371 @param OptionString Pointer of the Option String to be displayed.
373 @retval EFI_SUCCESS Question Option process success.
374 @retval Other Question Option process fail.
379 IN UI_MENU_SELECTION
*Selection
,
380 IN UI_MENU_OPTION
*MenuOption
,
382 OUT CHAR16
**OptionString
389 FORM_BROWSER_STATEMENT
*Question
;
390 CHAR16 FormattedNumber
[21];
395 QUESTION_OPTION
*OneOfOption
;
397 EFI_HII_VALUE HiiValue
;
398 EFI_HII_VALUE
*QuestionValue
;
401 QUESTION_OPTION
*Option
;
406 Status
= EFI_SUCCESS
;
409 Character
[1] = L
'\0';
410 *OptionString
= NULL
;
412 ZeroMem (FormattedNumber
, 21 * sizeof (CHAR16
));
413 BufferSize
= (gOptionBlockWidth
+ 1) * 2 * gScreenDimensions
.BottomRow
;
415 Question
= MenuOption
->ThisTag
;
416 QuestionValue
= &Question
->HiiValue
;
417 Maximum
= (UINT16
) Question
->Maximum
;
419 ValueArray
= Question
->BufferValue
;
420 ValueType
= Question
->ValueType
;
422 switch (Question
->Operand
) {
423 case EFI_IFR_ORDERED_LIST_OP
:
425 // Initialize Option value array
427 if (GetArrayData (ValueArray
, ValueType
, 0) == 0) {
428 GetQuestionDefault (Selection
->FormSet
, Selection
->Form
, Question
, 0);
435 Status
= GetSelectionInputPopUp (Selection
, MenuOption
);
438 // We now know how many strings we will have, so we can allocate the
439 // space required for the array or strings.
441 *OptionString
= AllocateZeroPool (Question
->MaxContainers
* BufferSize
);
442 ASSERT (*OptionString
);
444 HiiValue
.Type
= ValueType
;
445 HiiValue
.Value
.u64
= 0;
446 for (Index
= 0; Index
< Question
->MaxContainers
; Index
++) {
447 HiiValue
.Value
.u64
= GetArrayData (ValueArray
, ValueType
, Index
);
448 if (HiiValue
.Value
.u64
== 0) {
450 // Values for the options in ordered lists should never be a 0
455 OneOfOption
= ValueToOption (Question
, &HiiValue
);
456 if (OneOfOption
== NULL
) {
458 // Show error message
461 CreateDialog (4, TRUE
, 0, NULL
, &Key
, gEmptyString
, gOptionMismatch
, gPressEnter
, gEmptyString
);
462 } while (Key
.UnicodeChar
!= CHAR_CARRIAGE_RETURN
);
465 // The initial value of the orderedlist is invalid, force to be valid value
467 Link
= GetFirstNode (&Question
->OptionListHead
);
469 while (!IsNull (&Question
->OptionListHead
, Link
) && Index2
< Question
->MaxContainers
) {
470 Option
= QUESTION_OPTION_FROM_LINK (Link
);
471 SetArrayData (ValueArray
, ValueType
, Index2
, Option
->Value
.Value
.u64
);
473 Link
= GetNextNode (&Question
->OptionListHead
, Link
);
475 SetArrayData (ValueArray
, ValueType
, Index2
, 0);
477 Status
= SetQuestionValue (Selection
->FormSet
, Selection
->Form
, Question
, TRUE
);
478 UpdateStatusBar (NV_UPDATE_REQUIRED
, Question
->QuestionFlags
, TRUE
);
480 FreePool (*OptionString
);
481 *OptionString
= NULL
;
482 return EFI_NOT_FOUND
;
486 if ((OneOfOption
->SuppressExpression
!= NULL
) &&
487 (OneOfOption
->SuppressExpression
->Result
.Value
.b
)) {
489 // This option is suppressed
495 Character
[0] = LEFT_ONEOF_DELIMITER
;
496 NewStrCat (OptionString
[0], Character
);
497 StringPtr
= GetToken (OneOfOption
->Text
, Selection
->Handle
);
498 NewStrCat (OptionString
[0], StringPtr
);
499 Character
[0] = RIGHT_ONEOF_DELIMITER
;
500 NewStrCat (OptionString
[0], Character
);
501 Character
[0] = CHAR_CARRIAGE_RETURN
;
502 NewStrCat (OptionString
[0], Character
);
504 FreePool (StringPtr
);
510 case EFI_IFR_ONE_OF_OP
:
515 Status
= GetSelectionInputPopUp (Selection
, MenuOption
);
517 *OptionString
= AllocateZeroPool (BufferSize
);
518 ASSERT (*OptionString
);
520 OneOfOption
= ValueToOption (Question
, QuestionValue
);
521 if (OneOfOption
== NULL
) {
523 // Show error message
526 CreateDialog (4, TRUE
, 0, NULL
, &Key
, gEmptyString
, gOptionMismatch
, gPressEnter
, gEmptyString
);
527 } while (Key
.UnicodeChar
!= CHAR_CARRIAGE_RETURN
);
530 // Force the Question value to be valid
532 Link
= GetFirstNode (&Question
->OptionListHead
);
533 while (!IsNull (&Question
->OptionListHead
, Link
)) {
534 Option
= QUESTION_OPTION_FROM_LINK (Link
);
536 if ((Option
->SuppressExpression
== NULL
) ||
537 !Option
->SuppressExpression
->Result
.Value
.b
) {
538 CopyMem (QuestionValue
, &Option
->Value
, sizeof (EFI_HII_VALUE
));
539 SetQuestionValue (Selection
->FormSet
, Selection
->Form
, Question
, TRUE
);
540 UpdateStatusBar (NV_UPDATE_REQUIRED
, Question
->QuestionFlags
, TRUE
);
544 Link
= GetNextNode (&Question
->OptionListHead
, Link
);
547 FreePool (*OptionString
);
548 *OptionString
= NULL
;
549 return EFI_NOT_FOUND
;
552 if ((OneOfOption
->SuppressExpression
!= NULL
) &&
553 (OneOfOption
->SuppressExpression
->Result
.Value
.b
)) {
555 // This option is suppressed
564 // Current selected option happen to be suppressed,
565 // enforce to select on a non-suppressed option
567 Link
= GetFirstNode (&Question
->OptionListHead
);
568 while (!IsNull (&Question
->OptionListHead
, Link
)) {
569 OneOfOption
= QUESTION_OPTION_FROM_LINK (Link
);
571 if ((OneOfOption
->SuppressExpression
== NULL
) ||
572 !OneOfOption
->SuppressExpression
->Result
.Value
.b
) {
574 CopyMem (QuestionValue
, &OneOfOption
->Value
, sizeof (EFI_HII_VALUE
));
575 SetQuestionValue (Selection
->FormSet
, Selection
->Form
, Question
, TRUE
);
576 UpdateStatusBar (NV_UPDATE_REQUIRED
, Question
->QuestionFlags
, TRUE
);
577 gST
->ConOut
->SetAttribute (gST
->ConOut
, FIELD_TEXT
| FIELD_BACKGROUND
);
581 Link
= GetNextNode (&Question
->OptionListHead
, Link
);
586 Character
[0] = LEFT_ONEOF_DELIMITER
;
587 NewStrCat (OptionString
[0], Character
);
588 StringPtr
= GetToken (OneOfOption
->Text
, Selection
->Handle
);
589 NewStrCat (OptionString
[0], StringPtr
);
590 Character
[0] = RIGHT_ONEOF_DELIMITER
;
591 NewStrCat (OptionString
[0], Character
);
593 FreePool (StringPtr
);
598 case EFI_IFR_CHECKBOX_OP
:
599 *OptionString
= AllocateZeroPool (BufferSize
);
600 ASSERT (*OptionString
);
602 *OptionString
[0] = LEFT_CHECKBOX_DELIMITER
;
606 // Since this is a BOOLEAN operation, flip it upon selection
608 QuestionValue
->Value
.b
= (BOOLEAN
) (QuestionValue
->Value
.b
? FALSE
: TRUE
);
611 // Perform inconsistent check
613 Status
= ValidateQuestion (Selection
->FormSet
, Selection
->Form
, Question
, EFI_HII_EXPRESSION_INCONSISTENT_IF
);
614 if (EFI_ERROR (Status
)) {
616 // Inconsistent check fail, restore Question Value
618 QuestionValue
->Value
.b
= (BOOLEAN
) (QuestionValue
->Value
.b
? FALSE
: TRUE
);
619 FreePool (*OptionString
);
620 *OptionString
= NULL
;
625 // Save Question value
627 Status
= SetQuestionValue (Selection
->FormSet
, Selection
->Form
, Question
, TRUE
);
628 UpdateStatusBar (NV_UPDATE_REQUIRED
, Question
->QuestionFlags
, TRUE
);
631 if (QuestionValue
->Value
.b
) {
632 *(OptionString
[0] + 1) = CHECK_ON
;
634 *(OptionString
[0] + 1) = CHECK_OFF
;
636 *(OptionString
[0] + 2) = RIGHT_CHECKBOX_DELIMITER
;
639 case EFI_IFR_NUMERIC_OP
:
644 Status
= GetNumericInput (Selection
, MenuOption
);
646 *OptionString
= AllocateZeroPool (BufferSize
);
647 ASSERT (*OptionString
);
649 *OptionString
[0] = LEFT_NUMERIC_DELIMITER
;
654 PrintFormattedNumber (Question
, FormattedNumber
, 21 * sizeof (CHAR16
));
655 Number
= (UINT16
) GetStringWidth (FormattedNumber
);
656 CopyMem (OptionString
[0] + 1, FormattedNumber
, Number
);
658 *(OptionString
[0] + Number
/ 2) = RIGHT_NUMERIC_DELIMITER
;
662 case EFI_IFR_DATE_OP
:
665 // This is similar to numerics
667 Status
= GetNumericInput (Selection
, MenuOption
);
669 *OptionString
= AllocateZeroPool (BufferSize
);
670 ASSERT (*OptionString
);
672 switch (MenuOption
->Sequence
) {
674 *OptionString
[0] = LEFT_NUMERIC_DELIMITER
;
675 UnicodeSPrint (OptionString
[0] + 1, 21 * sizeof (CHAR16
), L
"%02d", QuestionValue
->Value
.date
.Month
);
676 *(OptionString
[0] + 3) = DATE_SEPARATOR
;
680 SetUnicodeMem (OptionString
[0], 4, L
' ');
681 UnicodeSPrint (OptionString
[0] + 4, 21 * sizeof (CHAR16
), L
"%02d", QuestionValue
->Value
.date
.Day
);
682 *(OptionString
[0] + 6) = DATE_SEPARATOR
;
686 SetUnicodeMem (OptionString
[0], 7, L
' ');
687 UnicodeSPrint (OptionString
[0] + 7, 21 * sizeof (CHAR16
), L
"%4d", QuestionValue
->Value
.date
.Year
);
688 *(OptionString
[0] + 11) = RIGHT_NUMERIC_DELIMITER
;
694 case EFI_IFR_TIME_OP
:
697 // This is similar to numerics
699 Status
= GetNumericInput (Selection
, MenuOption
);
701 *OptionString
= AllocateZeroPool (BufferSize
);
702 ASSERT (*OptionString
);
704 switch (MenuOption
->Sequence
) {
706 *OptionString
[0] = LEFT_NUMERIC_DELIMITER
;
707 UnicodeSPrint (OptionString
[0] + 1, 21 * sizeof (CHAR16
), L
"%02d", QuestionValue
->Value
.time
.Hour
);
708 *(OptionString
[0] + 3) = TIME_SEPARATOR
;
712 SetUnicodeMem (OptionString
[0], 4, L
' ');
713 UnicodeSPrint (OptionString
[0] + 4, 21 * sizeof (CHAR16
), L
"%02d", QuestionValue
->Value
.time
.Minute
);
714 *(OptionString
[0] + 6) = TIME_SEPARATOR
;
718 SetUnicodeMem (OptionString
[0], 7, L
' ');
719 UnicodeSPrint (OptionString
[0] + 7, 21 * sizeof (CHAR16
), L
"%02d", QuestionValue
->Value
.time
.Second
);
720 *(OptionString
[0] + 9) = RIGHT_NUMERIC_DELIMITER
;
726 case EFI_IFR_STRING_OP
:
728 StringPtr
= AllocateZeroPool ((Maximum
+ 1) * sizeof (CHAR16
));
731 Status
= ReadString (MenuOption
, gPromptForData
, StringPtr
);
732 if (!EFI_ERROR (Status
)) {
733 CopyMem (Question
->BufferValue
, StringPtr
, Maximum
* sizeof (CHAR16
));
734 SetQuestionValue (Selection
->FormSet
, Selection
->Form
, Question
, TRUE
);
736 UpdateStatusBar (NV_UPDATE_REQUIRED
, Question
->QuestionFlags
, TRUE
);
739 FreePool (StringPtr
);
741 *OptionString
= AllocateZeroPool (BufferSize
);
742 ASSERT (*OptionString
);
744 if (((CHAR16
*) Question
->BufferValue
)[0] == 0x0000) {
745 *(OptionString
[0]) = '_';
747 if ((Maximum
* sizeof (CHAR16
)) < BufferSize
) {
748 BufferSize
= Maximum
* sizeof (CHAR16
);
750 CopyMem (OptionString
[0], (CHAR16
*) Question
->BufferValue
, BufferSize
);
755 case EFI_IFR_PASSWORD_OP
:
757 StringPtr
= AllocateZeroPool ((Maximum
+ 1) * sizeof (CHAR16
));
761 // For interactive passwords, old password is validated by callback
763 if ((Question
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
) != 0) {
765 // Use a NULL password to test whether old password is required
768 Status
= PasswordCallback (Selection
, MenuOption
, StringPtr
);
769 if (Status
== EFI_NOT_AVAILABLE_YET
) {
771 // Callback request to terminate password input
773 FreePool (StringPtr
);
777 if (EFI_ERROR (Status
)) {
779 // Old password exist, ask user for the old password
781 Status
= ReadString (MenuOption
, gPromptForPassword
, StringPtr
);
782 if (EFI_ERROR (Status
)) {
783 FreePool (StringPtr
);
788 // Check user input old password
790 Status
= PasswordCallback (Selection
, MenuOption
, StringPtr
);
791 if (EFI_ERROR (Status
)) {
792 if (Status
== EFI_NOT_READY
) {
794 // Typed in old password incorrect
798 Status
= EFI_SUCCESS
;
801 FreePool (StringPtr
);
807 // For non-interactive password, validate old password in local
809 if (*((CHAR16
*) Question
->BufferValue
) != 0) {
811 // There is something there! Prompt for password
813 Status
= ReadString (MenuOption
, gPromptForPassword
, StringPtr
);
814 if (EFI_ERROR (Status
)) {
815 FreePool (StringPtr
);
819 TempString
= AllocateCopyPool ((Maximum
+ 1) * sizeof (CHAR16
), Question
->BufferValue
);
820 ASSERT (TempString
!= NULL
);
822 TempString
[Maximum
] = L
'\0';
824 if (StrCmp (StringPtr
, TempString
) != 0) {
826 // Typed in old password incorrect
830 FreePool (StringPtr
);
831 FreePool (TempString
);
835 FreePool (TempString
);
840 // Ask for new password
842 ZeroMem (StringPtr
, (Maximum
+ 1) * sizeof (CHAR16
));
843 Status
= ReadString (MenuOption
, gPromptForNewPassword
, StringPtr
);
844 if (EFI_ERROR (Status
)) {
846 // Reset state machine for interactive password
848 if ((Question
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
) != 0) {
849 PasswordCallback (Selection
, MenuOption
, NULL
);
852 FreePool (StringPtr
);
857 // Confirm new password
859 TempString
= AllocateZeroPool ((Maximum
+ 1) * sizeof (CHAR16
));
861 Status
= ReadString (MenuOption
, gConfirmPassword
, TempString
);
862 if (EFI_ERROR (Status
)) {
864 // Reset state machine for interactive password
866 if ((Question
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
) != 0) {
867 PasswordCallback (Selection
, MenuOption
, NULL
);
870 FreePool (StringPtr
);
871 FreePool (TempString
);
876 // Compare two typed-in new passwords
878 if (StrCmp (StringPtr
, TempString
) == 0) {
880 // Two password match, send it to Configuration Driver
882 if ((Question
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
) != 0) {
883 PasswordCallback (Selection
, MenuOption
, StringPtr
);
885 CopyMem (Question
->BufferValue
, StringPtr
, Maximum
* sizeof (CHAR16
));
886 SetQuestionValue (Selection
->FormSet
, Selection
->Form
, Question
, FALSE
);
890 // Reset state machine for interactive password
892 if ((Question
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
) != 0) {
893 PasswordCallback (Selection
, MenuOption
, NULL
);
897 // Two password mismatch, prompt error message
900 CreateDialog (4, TRUE
, 0, NULL
, &Key
, gEmptyString
, gConfirmError
, gPressEnter
, gEmptyString
);
901 } while (Key
.UnicodeChar
!= CHAR_CARRIAGE_RETURN
);
904 FreePool (TempString
);
905 FreePool (StringPtr
);
918 Process the help string: Split StringPtr to several lines of strings stored in
919 FormattedString and the glyph width of each line cannot exceed gHelpBlockWidth.
921 @param StringPtr The entire help string.
922 @param FormattedString The oupput formatted string.
923 @param RowCount TRUE: if Question is selected.
928 IN CHAR16
*StringPtr
,
929 OUT CHAR16
**FormattedString
,
936 // [PrevCurrIndex, CurrIndex) forms a range of a screen-line
941 UINTN VirtualLineCount
;
943 // GlyphOffset stores glyph width of current screen-line
947 // GlyphWidth equals to 2 if we meet width directive
951 // during scanning, we remember the position of last space character
952 // in case that if next word cannot put in current line, we could restore back to the position
953 // of last space character
954 // while we should also remmeber the glyph width of the last space character for restoring
956 UINTN LastSpaceIndex
;
957 UINTN LastSpaceGlyphWidth
;
959 // every time we begin to form a new screen-line, we should remember glyph width of single character
962 UINTN LineStartGlyphWidth
;
964 UINTN
*OldIndexArray
;
966 BlockWidth
= (UINTN
) gHelpBlockWidth
- 1;
969 // every three elements of IndexArray form a screen-line of string:[ IndexArray[i*3], IndexArray[i*3+1] )
970 // IndexArray[i*3+2] stores the initial glyph width of single character. to save this is because we want
971 // to bring the width directive of the last line to current screen-line.
972 // e.g.: "\wideabcde ... fghi", if "fghi" also has width directive but is splitted to the next screen-line
973 // different from that of "\wideabcde", we should remember the width directive.
976 IndexArray
= AllocatePool (AllocateSize
* sizeof (UINTN
) * 3);
977 ASSERT (IndexArray
!= NULL
);
979 if (*FormattedString
!= NULL
) {
980 FreePool (*FormattedString
);
981 *FormattedString
= NULL
;
984 for (PrevCurrIndex
= 0, CurrIndex
= 0, LineCount
= 0, LastSpaceIndex
= 0,
985 IndexArray
[0] = 0, GlyphWidth
= 1, GlyphOffset
= 0, LastSpaceGlyphWidth
= 1, LineStartGlyphWidth
= 1;
986 (StringPtr
[CurrIndex
] != CHAR_NULL
);
989 if (LineCount
== AllocateSize
) {
990 AllocateSize
+= 0x10;
991 OldIndexArray
= IndexArray
;
992 IndexArray
= AllocatePool (AllocateSize
* sizeof (UINTN
) * 3);
993 ASSERT (IndexArray
!= NULL
);
995 CopyMem (IndexArray
, OldIndexArray
, LineCount
* sizeof (UINTN
) * 3);
996 FreePool (OldIndexArray
);
998 switch (StringPtr
[CurrIndex
]) {
1002 GlyphWidth
= ((StringPtr
[CurrIndex
] == WIDE_CHAR
) ? 2 : 1);
1003 if (CurrIndex
== 0) {
1004 LineStartGlyphWidth
= GlyphWidth
;
1010 // "\r\n" isn't handled here, handled by case CHAR_CARRIAGE_RETURN
1014 // Store a range of string as a line
1016 IndexArray
[LineCount
*3] = PrevCurrIndex
;
1017 IndexArray
[LineCount
*3+1] = CurrIndex
;
1018 IndexArray
[LineCount
*3+2] = LineStartGlyphWidth
;
1021 // Reset offset and save begin position of line
1024 LineStartGlyphWidth
= GlyphWidth
;
1025 PrevCurrIndex
= CurrIndex
+ 1;
1030 // "\r\n" and "\r" both are handled here
1032 case CHAR_CARRIAGE_RETURN
:
1033 if (StringPtr
[CurrIndex
+ 1] == CHAR_LINEFEED
) {
1035 // next char is '\n'
1037 IndexArray
[LineCount
*3] = PrevCurrIndex
;
1038 IndexArray
[LineCount
*3+1] = CurrIndex
;
1039 IndexArray
[LineCount
*3+2] = LineStartGlyphWidth
;
1044 LineStartGlyphWidth
= GlyphWidth
;
1045 PrevCurrIndex
= CurrIndex
+ 1;
1049 // char is space or other char
1052 GlyphOffset
+= GlyphWidth
;
1053 if (GlyphOffset
>= BlockWidth
) {
1054 if (LastSpaceIndex
> PrevCurrIndex
) {
1056 // LastSpaceIndex points to space inside current screen-line,
1057 // restore to LastSpaceIndex
1058 // (Otherwise the word is too long to fit one screen-line, just cut it)
1060 CurrIndex
= LastSpaceIndex
;
1061 GlyphWidth
= LastSpaceGlyphWidth
;
1062 } else if (GlyphOffset
> BlockWidth
) {
1064 // the word is too long to fit one screen-line and we don't get the chance
1065 // of GlyphOffset == BlockWidth because GlyphWidth = 2
1070 IndexArray
[LineCount
*3] = PrevCurrIndex
;
1071 IndexArray
[LineCount
*3+1] = CurrIndex
+ 1;
1072 IndexArray
[LineCount
*3+2] = LineStartGlyphWidth
;
1073 LineStartGlyphWidth
= GlyphWidth
;
1076 // Reset offset and save begin position of line
1079 PrevCurrIndex
= CurrIndex
+ 1;
1083 // LastSpaceIndex: remember position of last space
1085 if (StringPtr
[CurrIndex
] == CHAR_SPACE
) {
1086 LastSpaceIndex
= CurrIndex
;
1087 LastSpaceGlyphWidth
= GlyphWidth
;
1093 if (GlyphOffset
> 0) {
1094 IndexArray
[LineCount
*3] = PrevCurrIndex
;
1095 IndexArray
[LineCount
*3+1] = CurrIndex
;
1096 IndexArray
[LineCount
*3+2] = GlyphWidth
;
1100 if (LineCount
== 0) {
1102 // in case we meet null string
1107 // we assume null string's glyph width is 1
1113 VirtualLineCount
= RowCount
* (LineCount
/ RowCount
+ (LineCount
% RowCount
> 0));
1114 *FormattedString
= AllocateZeroPool (VirtualLineCount
* (BlockWidth
+ 1) * sizeof (CHAR16
) * 2);
1115 ASSERT (*FormattedString
!= NULL
);
1117 for (CurrIndex
= 0; CurrIndex
< LineCount
; CurrIndex
++) {
1118 *(*FormattedString
+ CurrIndex
* 2 * (BlockWidth
+ 1)) = (CHAR16
) ((IndexArray
[CurrIndex
*3+2] == 2) ? WIDE_CHAR
: NARROW_CHAR
);
1120 *FormattedString
+ CurrIndex
* 2 * (BlockWidth
+ 1) + 1,
1121 StringPtr
+ IndexArray
[CurrIndex
*3],
1122 IndexArray
[CurrIndex
*3+1]-IndexArray
[CurrIndex
*3]
1126 FreePool (IndexArray
);