]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Universal/SetupBrowserDxe/Presentation.c
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Clean up DEC files:
[mirror_edk2.git] / MdeModulePkg / Universal / SetupBrowserDxe / Presentation.c
1 /** @file
2 Utility functions for UI presentation.
3
4 Copyright (c) 2004 - 2011, 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
9
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.
12
13 **/
14
15 #include "Setup.h"
16
17 BOOLEAN mHiiPackageListUpdated;
18 UI_MENU_SELECTION *gCurrentSelection;
19 EFI_HII_HANDLE mCurrentHiiHandle = NULL;
20 EFI_GUID mCurrentFormSetGuid = {0, 0, 0, {0, 0, 0, 0, 0, 0, 0, 0}};
21 UINT16 mCurrentFormId = 0;
22
23 /**
24 Clear retangle with specified text attribute.
25
26 @param LeftColumn Left column of retangle.
27 @param RightColumn Right column of retangle.
28 @param TopRow Start row of retangle.
29 @param BottomRow End row of retangle.
30 @param TextAttribute The character foreground and background.
31
32 **/
33 VOID
34 ClearLines (
35 IN UINTN LeftColumn,
36 IN UINTN RightColumn,
37 IN UINTN TopRow,
38 IN UINTN BottomRow,
39 IN UINTN TextAttribute
40 )
41 {
42 CHAR16 *Buffer;
43 UINTN Row;
44
45 //
46 // For now, allocate an arbitrarily long buffer
47 //
48 Buffer = AllocateZeroPool (0x10000);
49 ASSERT (Buffer != NULL);
50
51 //
52 // Set foreground and background as defined
53 //
54 gST->ConOut->SetAttribute (gST->ConOut, TextAttribute);
55
56 //
57 // Much faster to buffer the long string instead of print it a character at a time
58 //
59 SetUnicodeMem (Buffer, RightColumn - LeftColumn, L' ');
60
61 //
62 // Clear the desired area with the appropriate foreground/background
63 //
64 for (Row = TopRow; Row <= BottomRow; Row++) {
65 PrintStringAt (LeftColumn, Row, Buffer);
66 }
67
68 gST->ConOut->SetCursorPosition (gST->ConOut, LeftColumn, TopRow);
69
70 FreePool (Buffer);
71 return ;
72 }
73
74 /**
75 Concatenate a narrow string to another string.
76
77 @param Destination The destination string.
78 @param Source The source string. The string to be concatenated.
79 to the end of Destination.
80
81 **/
82 VOID
83 NewStrCat (
84 IN OUT CHAR16 *Destination,
85 IN CHAR16 *Source
86 )
87 {
88 UINTN Length;
89
90 for (Length = 0; Destination[Length] != 0; Length++)
91 ;
92
93 //
94 // We now have the length of the original string
95 // We can safely assume for now that we are concatenating a narrow value to this string.
96 // For instance, the string is "XYZ" and cat'ing ">"
97 // If this assumption changes, we need to make this routine a bit more complex
98 //
99 Destination[Length] = NARROW_CHAR;
100 Length++;
101
102 StrCpy (Destination + Length, Source);
103 }
104
105 /**
106 Count the storage space of a Unicode string.
107
108 This function handles the Unicode string with NARROW_CHAR
109 and WIDE_CHAR control characters. NARROW_HCAR and WIDE_CHAR
110 does not count in the resultant output. If a WIDE_CHAR is
111 hit, then 2 Unicode character will consume an output storage
112 space with size of CHAR16 till a NARROW_CHAR is hit.
113
114 If String is NULL, then ASSERT ().
115
116 @param String The input string to be counted.
117
118 @return Storage space for the input string.
119
120 **/
121 UINTN
122 GetStringWidth (
123 IN CHAR16 *String
124 )
125 {
126 UINTN Index;
127 UINTN Count;
128 UINTN IncrementValue;
129
130 ASSERT (String != NULL);
131 if (String == NULL) {
132 return 0;
133 }
134
135 Index = 0;
136 Count = 0;
137 IncrementValue = 1;
138
139 do {
140 //
141 // Advance to the null-terminator or to the first width directive
142 //
143 for (;
144 (String[Index] != NARROW_CHAR) && (String[Index] != WIDE_CHAR) && (String[Index] != 0);
145 Index++, Count = Count + IncrementValue
146 )
147 ;
148
149 //
150 // We hit the null-terminator, we now have a count
151 //
152 if (String[Index] == 0) {
153 break;
154 }
155 //
156 // We encountered a narrow directive - strip it from the size calculation since it doesn't get printed
157 // and also set the flag that determines what we increment by.(if narrow, increment by 1, if wide increment by 2)
158 //
159 if (String[Index] == NARROW_CHAR) {
160 //
161 // Skip to the next character
162 //
163 Index++;
164 IncrementValue = 1;
165 } else {
166 //
167 // Skip to the next character
168 //
169 Index++;
170 IncrementValue = 2;
171 }
172 } while (String[Index] != 0);
173
174 //
175 // Increment by one to include the null-terminator in the size
176 //
177 Count++;
178
179 return Count * sizeof (CHAR16);
180 }
181
182 /**
183 This function displays the page frame.
184
185 **/
186 VOID
187 DisplayPageFrame (
188 VOID
189 )
190 {
191 UINTN Index;
192 UINT8 Line;
193 UINT8 Alignment;
194 CHAR16 Character;
195 CHAR16 *Buffer;
196 CHAR16 *StrFrontPageBanner;
197 UINTN Row;
198 EFI_SCREEN_DESCRIPTOR LocalScreen;
199 UINT8 RowIdx;
200 UINT8 ColumnIdx;
201
202 ZeroMem (&LocalScreen, sizeof (EFI_SCREEN_DESCRIPTOR));
203 gST->ConOut->QueryMode (gST->ConOut, gST->ConOut->Mode->Mode, &LocalScreen.RightColumn, &LocalScreen.BottomRow);
204 ClearLines (0, LocalScreen.RightColumn, 0, LocalScreen.BottomRow, KEYHELP_BACKGROUND);
205
206 CopyMem (&LocalScreen, &gScreenDimensions, sizeof (EFI_SCREEN_DESCRIPTOR));
207
208 //
209 // For now, allocate an arbitrarily long buffer
210 //
211 Buffer = AllocateZeroPool (0x10000);
212 ASSERT (Buffer != NULL);
213
214 Character = BOXDRAW_HORIZONTAL;
215
216 for (Index = 0; Index + 2 < (LocalScreen.RightColumn - LocalScreen.LeftColumn); Index++) {
217 Buffer[Index] = Character;
218 }
219
220 if ((gClassOfVfr & FORMSET_CLASS_FRONT_PAGE) == FORMSET_CLASS_FRONT_PAGE) {
221 //
222 // ClearLines(0, LocalScreen.RightColumn, 0, BANNER_HEIGHT-1, BANNER_TEXT | BANNER_BACKGROUND);
223 //
224 ClearLines (
225 LocalScreen.LeftColumn,
226 LocalScreen.RightColumn,
227 LocalScreen.TopRow,
228 FRONT_PAGE_HEADER_HEIGHT - 1 + LocalScreen.TopRow,
229 BANNER_TEXT | BANNER_BACKGROUND
230 );
231 //
232 // for (Line = 0; Line < BANNER_HEIGHT; Line++) {
233 //
234 for (Line = (UINT8) LocalScreen.TopRow; Line < BANNER_HEIGHT + (UINT8) LocalScreen.TopRow; Line++) {
235 //
236 // for (Alignment = 0; Alignment < BANNER_COLUMNS; Alignment++) {
237 //
238 for (Alignment = (UINT8) LocalScreen.LeftColumn;
239 Alignment < BANNER_COLUMNS + (UINT8) LocalScreen.LeftColumn;
240 Alignment++
241 ) {
242 RowIdx = (UINT8) (Line - (UINT8) LocalScreen.TopRow);
243 ColumnIdx = (UINT8) (Alignment - (UINT8) LocalScreen.LeftColumn);
244
245 ASSERT (RowIdx < BANNER_HEIGHT);
246 ASSERT (ColumnIdx < BANNER_COLUMNS);
247
248 if (gBannerData->Banner[RowIdx][ColumnIdx] != 0x0000) {
249 StrFrontPageBanner = GetToken (
250 gBannerData->Banner[RowIdx][ColumnIdx],
251 gFrontPageHandle
252 );
253 } else {
254 continue;
255 }
256
257 switch (Alignment - LocalScreen.LeftColumn) {
258 case 0:
259 //
260 // Handle left column
261 //
262 PrintStringAt (LocalScreen.LeftColumn + BANNER_LEFT_COLUMN_INDENT, Line, StrFrontPageBanner);
263 break;
264
265 case 1:
266 //
267 // Handle center column
268 //
269 PrintStringAt (
270 LocalScreen.LeftColumn + (LocalScreen.RightColumn - LocalScreen.LeftColumn) / 3,
271 Line,
272 StrFrontPageBanner
273 );
274 break;
275
276 case 2:
277 //
278 // Handle right column
279 //
280 PrintStringAt (
281 LocalScreen.LeftColumn + (LocalScreen.RightColumn - LocalScreen.LeftColumn) * 2 / 3,
282 Line,
283 StrFrontPageBanner
284 );
285 break;
286 }
287
288 FreePool (StrFrontPageBanner);
289 }
290 }
291 }
292
293 ClearLines (
294 LocalScreen.LeftColumn,
295 LocalScreen.RightColumn,
296 LocalScreen.BottomRow - STATUS_BAR_HEIGHT - FOOTER_HEIGHT,
297 LocalScreen.BottomRow - STATUS_BAR_HEIGHT - 1,
298 KEYHELP_TEXT | KEYHELP_BACKGROUND
299 );
300
301 if ((gClassOfVfr & FORMSET_CLASS_FRONT_PAGE) != FORMSET_CLASS_FRONT_PAGE) {
302 ClearLines (
303 LocalScreen.LeftColumn,
304 LocalScreen.RightColumn,
305 LocalScreen.TopRow,
306 LocalScreen.TopRow + NONE_FRONT_PAGE_HEADER_HEIGHT - 1,
307 TITLE_TEXT | TITLE_BACKGROUND
308 );
309 //
310 // Print Top border line
311 // +------------------------------------------------------------------------------+
312 // ? ?
313 // +------------------------------------------------------------------------------+
314 //
315 Character = BOXDRAW_DOWN_RIGHT;
316
317 PrintChar (Character);
318 PrintString (Buffer);
319
320 Character = BOXDRAW_DOWN_LEFT;
321 PrintChar (Character);
322
323 Character = BOXDRAW_VERTICAL;
324 for (Row = LocalScreen.TopRow + 1; Row <= LocalScreen.TopRow + NONE_FRONT_PAGE_HEADER_HEIGHT - 2; Row++) {
325 PrintCharAt (LocalScreen.LeftColumn, Row, Character);
326 PrintCharAt (LocalScreen.RightColumn - 1, Row, Character);
327 }
328
329 Character = BOXDRAW_UP_RIGHT;
330 PrintCharAt (LocalScreen.LeftColumn, LocalScreen.TopRow + NONE_FRONT_PAGE_HEADER_HEIGHT - 1, Character);
331 PrintString (Buffer);
332
333 Character = BOXDRAW_UP_LEFT;
334 PrintChar (Character);
335
336 if ((gClassOfVfr & FORMSET_CLASS_PLATFORM_SETUP) == FORMSET_CLASS_PLATFORM_SETUP) {
337 //
338 // Print Bottom border line
339 // +------------------------------------------------------------------------------+
340 // ? ?
341 // +------------------------------------------------------------------------------+
342 //
343 Character = BOXDRAW_DOWN_RIGHT;
344 PrintCharAt (LocalScreen.LeftColumn, LocalScreen.BottomRow - STATUS_BAR_HEIGHT - FOOTER_HEIGHT, Character);
345
346 PrintString (Buffer);
347
348 Character = BOXDRAW_DOWN_LEFT;
349 PrintChar (Character);
350 Character = BOXDRAW_VERTICAL;
351 for (Row = LocalScreen.BottomRow - STATUS_BAR_HEIGHT - FOOTER_HEIGHT + 1;
352 Row <= LocalScreen.BottomRow - STATUS_BAR_HEIGHT - 2;
353 Row++
354 ) {
355 PrintCharAt (LocalScreen.LeftColumn, Row, Character);
356 PrintCharAt (LocalScreen.RightColumn - 1, Row, Character);
357 }
358
359 Character = BOXDRAW_UP_RIGHT;
360 PrintCharAt (LocalScreen.LeftColumn, LocalScreen.BottomRow - STATUS_BAR_HEIGHT - 1, Character);
361
362 PrintString (Buffer);
363
364 Character = BOXDRAW_UP_LEFT;
365 PrintChar (Character);
366 }
367 }
368
369 FreePool (Buffer);
370
371 }
372
373
374 /**
375 Evaluate all expressions in a Form.
376
377 @param FormSet FormSet this Form belongs to.
378 @param Form The Form.
379
380 @retval EFI_SUCCESS The expression evaluated successfuly
381
382 **/
383 EFI_STATUS
384 EvaluateFormExpressions (
385 IN FORM_BROWSER_FORMSET *FormSet,
386 IN FORM_BROWSER_FORM *Form
387 )
388 {
389 EFI_STATUS Status;
390 LIST_ENTRY *Link;
391 FORM_EXPRESSION *Expression;
392
393 Link = GetFirstNode (&Form->ExpressionListHead);
394 while (!IsNull (&Form->ExpressionListHead, Link)) {
395 Expression = FORM_EXPRESSION_FROM_LINK (Link);
396 Link = GetNextNode (&Form->ExpressionListHead, Link);
397
398 if (Expression->Type == EFI_HII_EXPRESSION_INCONSISTENT_IF ||
399 Expression->Type == EFI_HII_EXPRESSION_NO_SUBMIT_IF ||
400 Expression->Type == EFI_HII_EXPRESSION_WRITE ||
401 (Expression->Type == EFI_HII_EXPRESSION_READ && Form->FormType != STANDARD_MAP_FORM_TYPE)) {
402 //
403 // Postpone Form validation to Question editing or Form submitting or Question Write or Question Read for nonstandard form.
404 //
405 continue;
406 }
407
408 Status = EvaluateExpression (FormSet, Form, Expression);
409 if (EFI_ERROR (Status)) {
410 return Status;
411 }
412 }
413
414 return EFI_SUCCESS;
415 }
416
417 /*
418 +------------------------------------------------------------------------------+
419 ? Setup Page ?
420 +------------------------------------------------------------------------------+
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438 +------------------------------------------------------------------------------+
439 ?F1=Scroll Help F9=Reset to Defaults F10=Save and Exit ?
440 | ^"=Move Highlight <Spacebar> Toggles Checkbox Esc=Discard Changes |
441 +------------------------------------------------------------------------------+
442 */
443
444 /**
445
446
447 Display form and wait for user to select one menu option, then return it.
448
449 @param Selection On input, Selection tell setup browser the information
450 about the Selection, form and formset to be displayed.
451 On output, Selection return the screen item that is selected
452 by user.
453 @retval EFI_SUCESSS This function always return successfully for now.
454
455 **/
456 EFI_STATUS
457 DisplayForm (
458 IN OUT UI_MENU_SELECTION *Selection
459 )
460 {
461 CHAR16 *StringPtr;
462 UINT16 MenuItemCount;
463 EFI_HII_HANDLE Handle;
464 BOOLEAN Suppress;
465 EFI_SCREEN_DESCRIPTOR LocalScreen;
466 UINT16 Width;
467 UINTN ArrayEntry;
468 CHAR16 *OutputString;
469 LIST_ENTRY *Link;
470 FORM_BROWSER_STATEMENT *Statement;
471 UINT16 NumberOfLines;
472 EFI_STATUS Status;
473 UI_MENU_OPTION *MenuOption;
474
475 Handle = Selection->Handle;
476 MenuItemCount = 0;
477 ArrayEntry = 0;
478 OutputString = NULL;
479
480 UiInitMenu ();
481
482 CopyMem (&LocalScreen, &gScreenDimensions, sizeof (EFI_SCREEN_DESCRIPTOR));
483
484 StringPtr = GetToken (Selection->Form->FormTitle, Handle);
485
486 if ((gClassOfVfr & FORMSET_CLASS_FRONT_PAGE) != FORMSET_CLASS_FRONT_PAGE) {
487 gST->ConOut->SetAttribute (gST->ConOut, TITLE_TEXT | TITLE_BACKGROUND);
488 PrintStringAt (
489 (LocalScreen.RightColumn + LocalScreen.LeftColumn - GetStringWidth (StringPtr) / 2) / 2,
490 LocalScreen.TopRow + 1,
491 StringPtr
492 );
493 }
494
495 //
496 // Remove Buffer allocated for StringPtr after it has been used.
497 //
498 FreePool (StringPtr);
499
500 //
501 // Evaluate all the Expressions in this Form
502 //
503 Status = EvaluateFormExpressions (Selection->FormSet, Selection->Form);
504 if (EFI_ERROR (Status)) {
505 return Status;
506 }
507
508 Selection->FormEditable = FALSE;
509 Link = GetFirstNode (&Selection->Form->StatementListHead);
510 while (!IsNull (&Selection->Form->StatementListHead, Link)) {
511 Statement = FORM_BROWSER_STATEMENT_FROM_LINK (Link);
512
513 if (Statement->SuppressExpression != NULL) {
514 Suppress = Statement->SuppressExpression->Result.Value.b;
515 } else {
516 Suppress = FALSE;
517 }
518
519 if (Statement->DisableExpression != NULL) {
520 Suppress = (BOOLEAN) (Suppress || Statement->DisableExpression->Result.Value.b);
521 }
522
523 if (!Suppress) {
524 StringPtr = GetToken (Statement->Prompt, Handle);
525
526 Width = GetWidth (Statement, Handle);
527
528 NumberOfLines = 1;
529 ArrayEntry = 0;
530 for (; GetLineByWidth (StringPtr, Width, &ArrayEntry, &OutputString) != 0x0000;) {
531 //
532 // If there is more string to process print on the next row and increment the Skip value
533 //
534 if (StrLen (&StringPtr[ArrayEntry]) != 0) {
535 NumberOfLines++;
536 }
537
538 FreePool (OutputString);
539 }
540
541 //
542 // We are NOT!! removing this StringPtr buffer via FreePool since it is being used in the menuoptions, we will do
543 // it in UiFreeMenu.
544 //
545 MenuOption = UiAddMenuOption (StringPtr, Selection->Handle, Statement, NumberOfLines, MenuItemCount);
546 MenuItemCount++;
547
548 if (MenuOption->IsQuestion && !MenuOption->ReadOnly) {
549 //
550 // At least one item is not readonly, this Form is considered as editable
551 //
552 Selection->FormEditable = TRUE;
553 }
554 }
555
556 Link = GetNextNode (&Selection->Form->StatementListHead, Link);
557 }
558
559 Status = UiDisplayMenu (Selection);
560
561 UiFreeMenu ();
562
563 return Status;
564 }
565
566 /**
567 Initialize the HII String Token to the correct values.
568
569 **/
570 VOID
571 InitializeBrowserStrings (
572 VOID
573 )
574 {
575 gFunctionNineString = GetToken (STRING_TOKEN (FUNCTION_NINE_STRING), gHiiHandle);
576 gFunctionTenString = GetToken (STRING_TOKEN (FUNCTION_TEN_STRING), gHiiHandle);
577 gEnterString = GetToken (STRING_TOKEN (ENTER_STRING), gHiiHandle);
578 gEnterCommitString = GetToken (STRING_TOKEN (ENTER_COMMIT_STRING), gHiiHandle);
579 gEnterEscapeString = GetToken (STRING_TOKEN (ENTER_ESCAPE_STRING), gHiiHandle);
580 gEscapeString = GetToken (STRING_TOKEN (ESCAPE_STRING), gHiiHandle);
581 gSaveFailed = GetToken (STRING_TOKEN (SAVE_FAILED), gHiiHandle);
582 gMoveHighlight = GetToken (STRING_TOKEN (MOVE_HIGHLIGHT), gHiiHandle);
583 gMakeSelection = GetToken (STRING_TOKEN (MAKE_SELECTION), gHiiHandle);
584 gDecNumericInput = GetToken (STRING_TOKEN (DEC_NUMERIC_INPUT), gHiiHandle);
585 gHexNumericInput = GetToken (STRING_TOKEN (HEX_NUMERIC_INPUT), gHiiHandle);
586 gToggleCheckBox = GetToken (STRING_TOKEN (TOGGLE_CHECK_BOX), gHiiHandle);
587 gPromptForData = GetToken (STRING_TOKEN (PROMPT_FOR_DATA), gHiiHandle);
588 gPromptForPassword = GetToken (STRING_TOKEN (PROMPT_FOR_PASSWORD), gHiiHandle);
589 gPromptForNewPassword = GetToken (STRING_TOKEN (PROMPT_FOR_NEW_PASSWORD), gHiiHandle);
590 gConfirmPassword = GetToken (STRING_TOKEN (CONFIRM_PASSWORD), gHiiHandle);
591 gConfirmError = GetToken (STRING_TOKEN (CONFIRM_ERROR), gHiiHandle);
592 gPassowordInvalid = GetToken (STRING_TOKEN (PASSWORD_INVALID), gHiiHandle);
593 gPressEnter = GetToken (STRING_TOKEN (PRESS_ENTER), gHiiHandle);
594 gEmptyString = GetToken (STRING_TOKEN (EMPTY_STRING), gHiiHandle);
595 gAreYouSure = GetToken (STRING_TOKEN (ARE_YOU_SURE), gHiiHandle);
596 gYesResponse = GetToken (STRING_TOKEN (ARE_YOU_SURE_YES), gHiiHandle);
597 gNoResponse = GetToken (STRING_TOKEN (ARE_YOU_SURE_NO), gHiiHandle);
598 gMiniString = GetToken (STRING_TOKEN (MINI_STRING), gHiiHandle);
599 gPlusString = GetToken (STRING_TOKEN (PLUS_STRING), gHiiHandle);
600 gMinusString = GetToken (STRING_TOKEN (MINUS_STRING), gHiiHandle);
601 gAdjustNumber = GetToken (STRING_TOKEN (ADJUST_NUMBER), gHiiHandle);
602 gSaveChanges = GetToken (STRING_TOKEN (SAVE_CHANGES), gHiiHandle);
603 gOptionMismatch = GetToken (STRING_TOKEN (OPTION_MISMATCH), gHiiHandle);
604 gFormSuppress = GetToken (STRING_TOKEN (FORM_SUPPRESSED), gHiiHandle);
605 return ;
606 }
607
608 /**
609 Free up the resource allocated for all strings required
610 by Setup Browser.
611
612 **/
613 VOID
614 FreeBrowserStrings (
615 VOID
616 )
617 {
618 FreePool (gFunctionNineString);
619 FreePool (gFunctionTenString);
620 FreePool (gEnterString);
621 FreePool (gEnterCommitString);
622 FreePool (gEnterEscapeString);
623 FreePool (gEscapeString);
624 FreePool (gMoveHighlight);
625 FreePool (gMakeSelection);
626 FreePool (gDecNumericInput);
627 FreePool (gHexNumericInput);
628 FreePool (gToggleCheckBox);
629 FreePool (gPromptForData);
630 FreePool (gPromptForPassword);
631 FreePool (gPromptForNewPassword);
632 FreePool (gConfirmPassword);
633 FreePool (gPassowordInvalid);
634 FreePool (gConfirmError);
635 FreePool (gPressEnter);
636 FreePool (gEmptyString);
637 FreePool (gAreYouSure);
638 FreePool (gYesResponse);
639 FreePool (gNoResponse);
640 FreePool (gMiniString);
641 FreePool (gPlusString);
642 FreePool (gMinusString);
643 FreePool (gAdjustNumber);
644 FreePool (gSaveChanges);
645 FreePool (gOptionMismatch);
646 FreePool (gFormSuppress);
647 return ;
648 }
649
650
651 /**
652 Update key's help imformation.
653
654 @param Selection Tell setup browser the information about the Selection
655 @param MenuOption The Menu option
656 @param Selected Whether or not a tag be selected
657
658 **/
659 VOID
660 UpdateKeyHelp (
661 IN UI_MENU_SELECTION *Selection,
662 IN UI_MENU_OPTION *MenuOption,
663 IN BOOLEAN Selected
664 )
665 {
666 UINTN SecCol;
667 UINTN ThdCol;
668 UINTN LeftColumnOfHelp;
669 UINTN RightColumnOfHelp;
670 UINTN TopRowOfHelp;
671 UINTN BottomRowOfHelp;
672 UINTN StartColumnOfHelp;
673 EFI_SCREEN_DESCRIPTOR LocalScreen;
674 FORM_BROWSER_STATEMENT *Statement;
675
676 CopyMem (&LocalScreen, &gScreenDimensions, sizeof (EFI_SCREEN_DESCRIPTOR));
677
678 SecCol = LocalScreen.LeftColumn + (LocalScreen.RightColumn - LocalScreen.LeftColumn) / 3;
679 ThdCol = LocalScreen.LeftColumn + (LocalScreen.RightColumn - LocalScreen.LeftColumn) * 2 / 3;
680
681 StartColumnOfHelp = LocalScreen.LeftColumn + 2;
682 LeftColumnOfHelp = LocalScreen.LeftColumn + 1;
683 RightColumnOfHelp = LocalScreen.RightColumn - 2;
684 TopRowOfHelp = LocalScreen.BottomRow - 4;
685 BottomRowOfHelp = LocalScreen.BottomRow - 3;
686
687 gST->ConOut->SetAttribute (gST->ConOut, KEYHELP_TEXT | KEYHELP_BACKGROUND);
688
689 Statement = MenuOption->ThisTag;
690 switch (Statement->Operand) {
691 case EFI_IFR_ORDERED_LIST_OP:
692 case EFI_IFR_ONE_OF_OP:
693 case EFI_IFR_NUMERIC_OP:
694 case EFI_IFR_TIME_OP:
695 case EFI_IFR_DATE_OP:
696 ClearLines (LeftColumnOfHelp, RightColumnOfHelp, TopRowOfHelp, BottomRowOfHelp, KEYHELP_TEXT | KEYHELP_BACKGROUND);
697
698 if (!Selected) {
699 if ((gClassOfVfr & FORMSET_CLASS_PLATFORM_SETUP) == FORMSET_CLASS_PLATFORM_SETUP) {
700 if (Selection->FormEditable) {
701 PrintStringAt (SecCol, TopRowOfHelp, gFunctionNineString);
702 PrintStringAt (ThdCol, TopRowOfHelp, gFunctionTenString);
703 }
704 PrintStringAt (ThdCol, BottomRowOfHelp, gEscapeString);
705 }
706
707 if ((Statement->Operand == EFI_IFR_DATE_OP) ||
708 (Statement->Operand == EFI_IFR_TIME_OP)) {
709 PrintAt (
710 StartColumnOfHelp,
711 BottomRowOfHelp,
712 L"%c%c%c%c%s",
713 ARROW_UP,
714 ARROW_DOWN,
715 ARROW_RIGHT,
716 ARROW_LEFT,
717 gMoveHighlight
718 );
719 PrintStringAt (SecCol, BottomRowOfHelp, gEnterString);
720 PrintStringAt (StartColumnOfHelp, TopRowOfHelp, gAdjustNumber);
721 } else {
722 PrintAt (StartColumnOfHelp, BottomRowOfHelp, L"%c%c%s", ARROW_UP, ARROW_DOWN, gMoveHighlight);
723 if (Statement->Operand == EFI_IFR_NUMERIC_OP && Statement->Step != 0) {
724 PrintStringAt (StartColumnOfHelp, TopRowOfHelp, gAdjustNumber);
725 }
726 PrintStringAt (SecCol, BottomRowOfHelp, gEnterString);
727 }
728 } else {
729 PrintStringAt (SecCol, BottomRowOfHelp, gEnterCommitString);
730
731 //
732 // If it is a selected numeric with manual input, display different message
733 //
734 if ((Statement->Operand == EFI_IFR_NUMERIC_OP) ||
735 (Statement->Operand == EFI_IFR_DATE_OP) ||
736 (Statement->Operand == EFI_IFR_TIME_OP)) {
737 PrintStringAt (
738 SecCol,
739 TopRowOfHelp,
740 ((Statement->Flags & EFI_IFR_DISPLAY_UINT_HEX) == EFI_IFR_DISPLAY_UINT_HEX) ? gHexNumericInput : gDecNumericInput
741 );
742 } else if (Statement->Operand != EFI_IFR_ORDERED_LIST_OP) {
743 PrintAt (StartColumnOfHelp, BottomRowOfHelp, L"%c%c%s", ARROW_UP, ARROW_DOWN, gMoveHighlight);
744 }
745
746 if (Statement->Operand == EFI_IFR_ORDERED_LIST_OP) {
747 PrintStringAt (StartColumnOfHelp, TopRowOfHelp, gPlusString);
748 PrintStringAt (ThdCol, TopRowOfHelp, gMinusString);
749 }
750
751 PrintStringAt (ThdCol, BottomRowOfHelp, gEnterEscapeString);
752 }
753 break;
754
755 case EFI_IFR_CHECKBOX_OP:
756 ClearLines (LeftColumnOfHelp, RightColumnOfHelp, TopRowOfHelp, BottomRowOfHelp, KEYHELP_TEXT | KEYHELP_BACKGROUND);
757
758 if ((gClassOfVfr & FORMSET_CLASS_PLATFORM_SETUP) == FORMSET_CLASS_PLATFORM_SETUP) {
759 if (Selection->FormEditable) {
760 PrintStringAt (SecCol, TopRowOfHelp, gFunctionNineString);
761 PrintStringAt (ThdCol, TopRowOfHelp, gFunctionTenString);
762 }
763 PrintStringAt (ThdCol, BottomRowOfHelp, gEscapeString);
764 }
765
766 PrintAt (StartColumnOfHelp, BottomRowOfHelp, L"%c%c%s", ARROW_UP, ARROW_DOWN, gMoveHighlight);
767 PrintStringAt (SecCol, BottomRowOfHelp, gToggleCheckBox);
768 break;
769
770 case EFI_IFR_REF_OP:
771 case EFI_IFR_PASSWORD_OP:
772 case EFI_IFR_STRING_OP:
773 case EFI_IFR_TEXT_OP:
774 case EFI_IFR_ACTION_OP:
775 case EFI_IFR_RESET_BUTTON_OP:
776 case EFI_IFR_SUBTITLE_OP:
777 ClearLines (LeftColumnOfHelp, RightColumnOfHelp, TopRowOfHelp, BottomRowOfHelp, KEYHELP_TEXT | KEYHELP_BACKGROUND);
778
779 if (!Selected) {
780 if ((gClassOfVfr & FORMSET_CLASS_PLATFORM_SETUP) == FORMSET_CLASS_PLATFORM_SETUP) {
781 if (Selection->FormEditable) {
782 PrintStringAt (SecCol, TopRowOfHelp, gFunctionNineString);
783 PrintStringAt (ThdCol, TopRowOfHelp, gFunctionTenString);
784 }
785 PrintStringAt (ThdCol, BottomRowOfHelp, gEscapeString);
786 }
787
788 PrintAt (StartColumnOfHelp, BottomRowOfHelp, L"%c%c%s", ARROW_UP, ARROW_DOWN, gMoveHighlight);
789 if (Statement->Operand != EFI_IFR_TEXT_OP && Statement->Operand != EFI_IFR_SUBTITLE_OP) {
790 PrintStringAt (SecCol, BottomRowOfHelp, gEnterString);
791 }
792 } else {
793 if (Statement->Operand != EFI_IFR_REF_OP) {
794 PrintStringAt (
795 (LocalScreen.RightColumn - GetStringWidth (gEnterCommitString) / 2) / 2,
796 BottomRowOfHelp,
797 gEnterCommitString
798 );
799 PrintStringAt (ThdCol, BottomRowOfHelp, gEnterEscapeString);
800 }
801 }
802 break;
803
804 default:
805 break;
806 }
807 }
808
809 /**
810 Functions which are registered to receive notification of
811 database events have this prototype. The actual event is encoded
812 in NotifyType. The following table describes how PackageType,
813 PackageGuid, Handle, and Package are used for each of the
814 notification types.
815
816 @param PackageType Package type of the notification.
817
818 @param PackageGuid If PackageType is
819 EFI_HII_PACKAGE_TYPE_GUID, then this is
820 the pointer to the GUID from the Guid
821 field of EFI_HII_PACKAGE_GUID_HEADER.
822 Otherwise, it must be NULL.
823
824 @param Package Points to the package referred to by the
825 notification Handle The handle of the package
826 list which contains the specified package.
827
828 @param Handle The HII handle.
829
830 @param NotifyType The type of change concerning the
831 database. See
832 EFI_HII_DATABASE_NOTIFY_TYPE.
833
834 **/
835 EFI_STATUS
836 EFIAPI
837 FormUpdateNotify (
838 IN UINT8 PackageType,
839 IN CONST EFI_GUID *PackageGuid,
840 IN CONST EFI_HII_PACKAGE_HEADER *Package,
841 IN EFI_HII_HANDLE Handle,
842 IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType
843 )
844 {
845 mHiiPackageListUpdated = TRUE;
846
847 return EFI_SUCCESS;
848 }
849
850 /**
851 The worker function that send the displays to the screen. On output,
852 the selection made by user is returned.
853
854 @param Selection On input, Selection tell setup browser the information
855 about the Selection, form and formset to be displayed.
856 On output, Selection return the screen item that is selected
857 by user.
858
859 @retval EFI_SUCCESS The page is displayed successfully.
860 @return Other value if the page failed to be diplayed.
861
862 **/
863 EFI_STATUS
864 SetupBrowser (
865 IN OUT UI_MENU_SELECTION *Selection
866 )
867 {
868 EFI_STATUS Status;
869 LIST_ENTRY *Link;
870 EFI_BROWSER_ACTION_REQUEST ActionRequest;
871 EFI_HANDLE NotifyHandle;
872 EFI_HII_VALUE *HiiValue;
873 EFI_IFR_TYPE_VALUE *TypeValue;
874 FORM_BROWSER_STATEMENT *Statement;
875 EFI_HII_CONFIG_ACCESS_PROTOCOL *ConfigAccess;
876 FORM_BROWSER_FORMSET *FormSet;
877 EFI_INPUT_KEY Key;
878 BOOLEAN SubmitFormIsRequired;
879
880 gMenuRefreshHead = NULL;
881 gResetRequired = FALSE;
882 FormSet = Selection->FormSet;
883 ConfigAccess = Selection->FormSet->ConfigAccess;
884
885 //
886 // Register notify for Form package update
887 //
888 Status = mHiiDatabase->RegisterPackageNotify (
889 mHiiDatabase,
890 EFI_HII_PACKAGE_FORMS,
891 NULL,
892 FormUpdateNotify,
893 EFI_HII_DATABASE_NOTIFY_REMOVE_PACK,
894 &NotifyHandle
895 );
896 if (EFI_ERROR (Status)) {
897 return Status;
898 }
899
900 //
901 // Initialize current settings of Questions in this FormSet
902 //
903 Status = InitializeCurrentSetting (Selection->FormSet);
904 if (EFI_ERROR (Status)) {
905 goto Done;
906 }
907
908 do {
909 //
910 // Initialize Selection->Form
911 //
912 if (Selection->FormId == 0) {
913 //
914 // Zero FormId indicates display the first Form in a FormSet
915 //
916 Link = GetFirstNode (&Selection->FormSet->FormListHead);
917
918 Selection->Form = FORM_BROWSER_FORM_FROM_LINK (Link);
919 Selection->FormId = Selection->Form->FormId;
920 } else {
921 Selection->Form = IdToForm (Selection->FormSet, Selection->FormId);
922 }
923
924 if (Selection->Form == NULL) {
925 //
926 // No Form to display
927 //
928 Status = EFI_NOT_FOUND;
929 goto Done;
930 }
931
932 //
933 // Check Form is suppressed.
934 //
935 if (Selection->Form->SuppressExpression != NULL) {
936 Status = EvaluateExpression (Selection->FormSet, Selection->Form, Selection->Form->SuppressExpression);
937 if (EFI_ERROR (Status) || (Selection->Form->SuppressExpression->Result.Type != EFI_IFR_TYPE_BOOLEAN)) {
938 Status = EFI_INVALID_PARAMETER;
939 goto Done;
940 }
941
942 if (Selection->Form->SuppressExpression->Result.Value.b) {
943 //
944 // Form is suppressed.
945 //
946 do {
947 CreateDialog (4, TRUE, 0, NULL, &Key, gEmptyString, gFormSuppress, gPressEnter, gEmptyString);
948 } while (Key.UnicodeChar != CHAR_CARRIAGE_RETURN);
949
950 Status = EFI_NOT_FOUND;
951 goto Done;
952 }
953 }
954
955 //
956 // Reset FormPackage update flag
957 //
958 mHiiPackageListUpdated = FALSE;
959
960 //
961 // Before display new form, invoke ConfigAccess.Callback() with EFI_BROWSER_ACTION_FORM_OPEN
962 // for each question with callback flag.
963 // New form may be the first form, or the different form after another form close.
964 //
965 if ((ConfigAccess != NULL) &&
966 ((Selection->Handle != mCurrentHiiHandle) ||
967 (!CompareGuid (&Selection->FormSetGuid, &mCurrentFormSetGuid)) ||
968 (Selection->FormId != mCurrentFormId))) {
969
970 //
971 // Keep current form information
972 //
973 mCurrentHiiHandle = Selection->Handle;
974 CopyGuid (&mCurrentFormSetGuid, &Selection->FormSetGuid);
975 mCurrentFormId = Selection->FormId;
976
977 //
978 // Go through each statement in this form
979 //
980 SubmitFormIsRequired = FALSE;
981 Link = GetFirstNode (&Selection->Form->StatementListHead);
982 while (!IsNull (&Selection->Form->StatementListHead, Link)) {
983 Statement = FORM_BROWSER_STATEMENT_FROM_LINK (Link);
984 Link = GetNextNode (&Selection->Form->StatementListHead, Link);
985
986 if ((Statement->QuestionFlags & EFI_IFR_FLAG_CALLBACK) != EFI_IFR_FLAG_CALLBACK) {
987 continue;
988 }
989
990 //
991 // Check whether Statement is disabled.
992 //
993 if (Statement->DisableExpression != NULL) {
994 Status = EvaluateExpression (Selection->FormSet, Selection->Form, Statement->DisableExpression);
995 if (!EFI_ERROR (Status) &&
996 (Statement->DisableExpression->Result.Type == EFI_IFR_TYPE_BOOLEAN) &&
997 (Statement->DisableExpression->Result.Value.b)) {
998 continue;
999 }
1000 }
1001
1002 ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;
1003 Status = ConfigAccess->Callback (
1004 ConfigAccess,
1005 EFI_BROWSER_ACTION_FORM_OPEN,
1006 Statement->QuestionId,
1007 EFI_IFR_TYPE_UNDEFINED,
1008 NULL,
1009 &ActionRequest
1010 );
1011
1012 if (!EFI_ERROR (Status)) {
1013 switch (ActionRequest) {
1014 case EFI_BROWSER_ACTION_REQUEST_RESET:
1015 gResetRequired = TRUE;
1016 break;
1017
1018 case EFI_BROWSER_ACTION_REQUEST_SUBMIT:
1019 SubmitFormIsRequired = TRUE;
1020 break;
1021
1022 case EFI_BROWSER_ACTION_REQUEST_EXIT:
1023 Selection->Action = UI_ACTION_EXIT;
1024 gNvUpdateRequired = FALSE;
1025 break;
1026
1027 default:
1028 break;
1029 }
1030 }
1031 }
1032 if (SubmitFormIsRequired) {
1033 SubmitForm (Selection->FormSet, Selection->Form);
1034 }
1035 //
1036 // EXIT requests to close form.
1037 //
1038 if (Selection->Action == UI_ACTION_EXIT) {
1039 goto Done;
1040 }
1041 //
1042 // IFR is updated during callback of open form, force to reparse the IFR binary
1043 //
1044 if (mHiiPackageListUpdated) {
1045 Selection->Action = UI_ACTION_REFRESH_FORMSET;
1046 mHiiPackageListUpdated = FALSE;
1047 goto Done;
1048 }
1049 }
1050
1051 //
1052 // Load Questions' Value for display
1053 //
1054 Status = LoadFormSetConfig (Selection, Selection->FormSet);
1055 if (EFI_ERROR (Status)) {
1056 goto Done;
1057 }
1058
1059 //
1060 // EXIT requests to close form.
1061 //
1062 if (Selection->Action == UI_ACTION_EXIT) {
1063 goto Done;
1064 }
1065 //
1066 // IFR is updated during callback of read value, force to reparse the IFR binary
1067 //
1068 if (mHiiPackageListUpdated) {
1069 Selection->Action = UI_ACTION_REFRESH_FORMSET;
1070 mHiiPackageListUpdated = FALSE;
1071 goto Done;
1072 }
1073
1074 //
1075 // Displays the Header and Footer borders
1076 //
1077 DisplayPageFrame ();
1078
1079 //
1080 // Display form
1081 //
1082 Status = DisplayForm (Selection);
1083 if (EFI_ERROR (Status)) {
1084 goto Done;
1085 }
1086
1087 //
1088 // Check Selected Statement (if press ESC, Selection->Statement will be NULL)
1089 //
1090 Statement = Selection->Statement;
1091 if (Statement != NULL) {
1092 if ((Statement->QuestionFlags & EFI_IFR_FLAG_RESET_REQUIRED) == EFI_IFR_FLAG_RESET_REQUIRED) {
1093 gResetRequired = TRUE;
1094 }
1095
1096 //
1097 // Reset FormPackage update flag
1098 //
1099 mHiiPackageListUpdated = FALSE;
1100
1101 if ((ConfigAccess != NULL) &&
1102 ((Statement->QuestionFlags & EFI_IFR_FLAG_CALLBACK) == EFI_IFR_FLAG_CALLBACK) &&
1103 (Statement->Operand != EFI_IFR_PASSWORD_OP)) {
1104
1105 ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;
1106
1107 HiiValue = &Statement->HiiValue;
1108 TypeValue = &HiiValue->Value;
1109 if (HiiValue->Type == EFI_IFR_TYPE_BUFFER) {
1110 //
1111 // For OrderedList, passing in the value buffer to Callback()
1112 //
1113 TypeValue = (EFI_IFR_TYPE_VALUE *) Statement->BufferValue;
1114 }
1115
1116 Status = ConfigAccess->Callback (
1117 ConfigAccess,
1118 EFI_BROWSER_ACTION_CHANGING,
1119 Statement->QuestionId,
1120 HiiValue->Type,
1121 TypeValue,
1122 &ActionRequest
1123 );
1124
1125 if (!EFI_ERROR (Status)) {
1126 switch (ActionRequest) {
1127 case EFI_BROWSER_ACTION_REQUEST_RESET:
1128 gResetRequired = TRUE;
1129 break;
1130
1131 case EFI_BROWSER_ACTION_REQUEST_SUBMIT:
1132 SubmitForm (Selection->FormSet, Selection->Form);
1133 break;
1134
1135 case EFI_BROWSER_ACTION_REQUEST_EXIT:
1136 Selection->Action = UI_ACTION_EXIT;
1137 gNvUpdateRequired = FALSE;
1138 break;
1139
1140 default:
1141 break;
1142 }
1143 } else if (Status != EFI_UNSUPPORTED) {
1144 //
1145 // Callback return error status other than EFI_UNSUPPORTED
1146 //
1147 if (Statement->Operand == EFI_IFR_REF_OP) {
1148 //
1149 // Cross reference will not be taken
1150 //
1151 Selection->FormId = Selection->Form->FormId;
1152 Selection->QuestionId = 0;
1153 }
1154 }
1155 }
1156
1157 //
1158 // Check whether Form Package has been updated during Callback
1159 //
1160 if (mHiiPackageListUpdated && (Selection->Action == UI_ACTION_REFRESH_FORM)) {
1161 //
1162 // Force to reparse IFR binary of target Formset
1163 //
1164 mHiiPackageListUpdated = FALSE;
1165 Selection->Action = UI_ACTION_REFRESH_FORMSET;
1166 }
1167 }
1168
1169 //
1170 // Before exit the form, invoke ConfigAccess.Callback() with EFI_BROWSER_ACTION_FORM_CLOSE
1171 // for each question with callback flag.
1172 //
1173 if ((ConfigAccess != NULL) &&
1174 ((Selection->Action == UI_ACTION_EXIT) ||
1175 (Selection->Handle != mCurrentHiiHandle) ||
1176 (!CompareGuid (&Selection->FormSetGuid, &mCurrentFormSetGuid)) ||
1177 (Selection->FormId != mCurrentFormId))) {
1178 //
1179 // Go through each statement in this form
1180 //
1181 SubmitFormIsRequired = FALSE;
1182 Link = GetFirstNode (&Selection->Form->StatementListHead);
1183 while (!IsNull (&Selection->Form->StatementListHead, Link)) {
1184 Statement = FORM_BROWSER_STATEMENT_FROM_LINK (Link);
1185 Link = GetNextNode (&Selection->Form->StatementListHead, Link);
1186
1187 if ((Statement->QuestionFlags & EFI_IFR_FLAG_CALLBACK) != EFI_IFR_FLAG_CALLBACK) {
1188 continue;
1189 }
1190
1191 ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;
1192 Status = ConfigAccess->Callback (
1193 ConfigAccess,
1194 EFI_BROWSER_ACTION_FORM_CLOSE,
1195 Statement->QuestionId,
1196 EFI_IFR_TYPE_UNDEFINED,
1197 NULL,
1198 &ActionRequest
1199 );
1200
1201 if (!EFI_ERROR (Status)) {
1202 switch (ActionRequest) {
1203 case EFI_BROWSER_ACTION_REQUEST_RESET:
1204 gResetRequired = TRUE;
1205 break;
1206
1207 case EFI_BROWSER_ACTION_REQUEST_SUBMIT:
1208 SubmitFormIsRequired = TRUE;
1209 break;
1210
1211 case EFI_BROWSER_ACTION_REQUEST_EXIT:
1212 Selection->Action = UI_ACTION_EXIT;
1213 gNvUpdateRequired = FALSE;
1214 break;
1215
1216 default:
1217 break;
1218 }
1219 }
1220 }
1221 if (SubmitFormIsRequired) {
1222 SubmitForm (Selection->FormSet, Selection->Form);
1223 }
1224 }
1225 } while (Selection->Action == UI_ACTION_REFRESH_FORM);
1226
1227 //
1228 // Record the old formset
1229 //
1230 if (gOldFormSet != NULL) {
1231 DestroyFormSet (gOldFormSet);
1232 }
1233 gOldFormSet = FormSet;
1234
1235 Done:
1236 //
1237 // Reset current form information to the initial setting when error happens or form exit.
1238 //
1239 if (EFI_ERROR (Status) || Selection->Action == UI_ACTION_EXIT) {
1240 mCurrentHiiHandle = NULL;
1241 CopyGuid (&mCurrentFormSetGuid, &gZeroGuid);
1242 mCurrentFormId = 0;
1243 }
1244
1245 //
1246 // Unregister notify for Form package update
1247 //
1248 mHiiDatabase->UnregisterPackageNotify (
1249 mHiiDatabase,
1250 NotifyHandle
1251 );
1252 return Status;
1253 }
EFI Development Kit II mirror for PVE