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