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