]>
Commit | Line | Data |
---|---|---|
7936fb6a | 1 | /** @file\r |
2 | Utility functions for UI presentation.\r | |
3 | \r | |
31585af4 | 4 | Copyright (c) 2004 - 2012, Intel Corporation. All rights reserved.<BR>\r |
e5eed7d3 | 5 | This program and the accompanying materials\r |
7936fb6a | 6 | are licensed and made available under the terms and conditions of the BSD License\r |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT 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 |
17 | BOOLEAN mHiiPackageListUpdated;\r | |
18 | UI_MENU_SELECTION *gCurrentSelection;\r | |
13ad1def LG |
19 | EFI_HII_HANDLE mCurrentHiiHandle = NULL;\r |
20 | EFI_GUID mCurrentFormSetGuid = {0, 0, 0, {0, 0, 0, 0, 0, 0, 0, 0}};\r | |
21 | UINT16 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 | |
33 | VOID\r | |
34 | ClearLines (\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 | |
82 | VOID\r | |
83 | NewStrCat (\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 | |
121 | UINTN\r | |
122 | GetStringWidth (\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 | |
b00964a9 ED |
185 | @param Selection Selection contains the information about \r |
186 | the Selection, form and formset to be displayed.\r | |
187 | Selection action may be updated in retrieve callback.\r | |
7936fb6a | 188 | **/\r |
189 | VOID\r | |
190 | DisplayPageFrame (\r | |
b00964a9 | 191 | IN UI_MENU_SELECTION *Selection\r |
7936fb6a | 192 | )\r |
193 | {\r | |
194 | UINTN Index;\r | |
195 | UINT8 Line;\r | |
196 | UINT8 Alignment;\r | |
197 | CHAR16 Character;\r | |
198 | CHAR16 *Buffer;\r | |
199 | CHAR16 *StrFrontPageBanner;\r | |
200 | UINTN Row;\r | |
201 | EFI_SCREEN_DESCRIPTOR LocalScreen;\r | |
db0bd81c | 202 | UINT8 RowIdx;\r |
203 | UINT8 ColumnIdx;\r | |
7936fb6a | 204 | \r |
205 | ZeroMem (&LocalScreen, sizeof (EFI_SCREEN_DESCRIPTOR));\r | |
206 | gST->ConOut->QueryMode (gST->ConOut, gST->ConOut->Mode->Mode, &LocalScreen.RightColumn, &LocalScreen.BottomRow);\r | |
207 | ClearLines (0, LocalScreen.RightColumn, 0, LocalScreen.BottomRow, KEYHELP_BACKGROUND);\r | |
208 | \r | |
b00964a9 ED |
209 | if (Selection->Form->ModalForm) {\r |
210 | return;\r | |
211 | }\r | |
212 | \r | |
7936fb6a | 213 | CopyMem (&LocalScreen, &gScreenDimensions, sizeof (EFI_SCREEN_DESCRIPTOR));\r |
214 | \r | |
215 | //\r | |
216 | // For now, allocate an arbitrarily long buffer\r | |
217 | //\r | |
218 | Buffer = AllocateZeroPool (0x10000);\r | |
219 | ASSERT (Buffer != NULL);\r | |
220 | \r | |
221 | Character = BOXDRAW_HORIZONTAL;\r | |
222 | \r | |
223 | for (Index = 0; Index + 2 < (LocalScreen.RightColumn - LocalScreen.LeftColumn); Index++) {\r | |
224 | Buffer[Index] = Character;\r | |
225 | }\r | |
226 | \r | |
40245175 | 227 | if ((gClassOfVfr & FORMSET_CLASS_FRONT_PAGE) == FORMSET_CLASS_FRONT_PAGE) {\r |
7936fb6a | 228 | //\r |
229 | // ClearLines(0, LocalScreen.RightColumn, 0, BANNER_HEIGHT-1, BANNER_TEXT | BANNER_BACKGROUND);\r | |
230 | //\r | |
231 | ClearLines (\r | |
232 | LocalScreen.LeftColumn,\r | |
233 | LocalScreen.RightColumn,\r | |
234 | LocalScreen.TopRow,\r | |
235 | FRONT_PAGE_HEADER_HEIGHT - 1 + LocalScreen.TopRow,\r | |
236 | BANNER_TEXT | BANNER_BACKGROUND\r | |
237 | );\r | |
238 | //\r | |
239 | // for (Line = 0; Line < BANNER_HEIGHT; Line++) {\r | |
240 | //\r | |
241 | for (Line = (UINT8) LocalScreen.TopRow; Line < BANNER_HEIGHT + (UINT8) LocalScreen.TopRow; Line++) {\r | |
242 | //\r | |
243 | // for (Alignment = 0; Alignment < BANNER_COLUMNS; Alignment++) {\r | |
244 | //\r | |
245 | for (Alignment = (UINT8) LocalScreen.LeftColumn;\r | |
246 | Alignment < BANNER_COLUMNS + (UINT8) LocalScreen.LeftColumn;\r | |
247 | Alignment++\r | |
248 | ) {\r | |
89c18a1e | 249 | RowIdx = (UINT8) (Line - (UINT8) LocalScreen.TopRow);\r |
250 | ColumnIdx = (UINT8) (Alignment - (UINT8) LocalScreen.LeftColumn);\r | |
40a06b0c | 251 | \r |
252 | ASSERT (RowIdx < BANNER_HEIGHT);\r | |
253 | ASSERT (ColumnIdx < BANNER_COLUMNS);\r | |
d66e6c16 | 254 | \r |
0a1147ed | 255 | if (gBannerData->Banner[RowIdx][ColumnIdx] != 0x0000) {\r |
7936fb6a | 256 | StrFrontPageBanner = GetToken (\r |
0a1147ed LG |
257 | gBannerData->Banner[RowIdx][ColumnIdx],\r |
258 | gFrontPageHandle\r | |
7936fb6a | 259 | );\r |
260 | } else {\r | |
261 | continue;\r | |
262 | }\r | |
263 | \r | |
264 | switch (Alignment - LocalScreen.LeftColumn) {\r | |
265 | case 0:\r | |
266 | //\r | |
267 | // Handle left column\r | |
268 | //\r | |
c3161b25 | 269 | PrintStringAt (LocalScreen.LeftColumn + BANNER_LEFT_COLUMN_INDENT, Line, StrFrontPageBanner);\r |
7936fb6a | 270 | break;\r |
271 | \r | |
272 | case 1:\r | |
273 | //\r | |
274 | // Handle center column\r | |
275 | //\r | |
276 | PrintStringAt (\r | |
277 | LocalScreen.LeftColumn + (LocalScreen.RightColumn - LocalScreen.LeftColumn) / 3,\r | |
278 | Line,\r | |
279 | StrFrontPageBanner\r | |
280 | );\r | |
281 | break;\r | |
282 | \r | |
283 | case 2:\r | |
284 | //\r | |
285 | // Handle right column\r | |
286 | //\r | |
287 | PrintStringAt (\r | |
288 | LocalScreen.LeftColumn + (LocalScreen.RightColumn - LocalScreen.LeftColumn) * 2 / 3,\r | |
289 | Line,\r | |
290 | StrFrontPageBanner\r | |
291 | );\r | |
292 | break;\r | |
293 | }\r | |
294 | \r | |
f4113e1f | 295 | FreePool (StrFrontPageBanner);\r |
7936fb6a | 296 | }\r |
297 | }\r | |
298 | }\r | |
299 | \r | |
300 | ClearLines (\r | |
301 | LocalScreen.LeftColumn,\r | |
302 | LocalScreen.RightColumn,\r | |
48a9d5f7 | 303 | LocalScreen.BottomRow - STATUS_BAR_HEIGHT - gFooterHeight,\r |
7936fb6a | 304 | LocalScreen.BottomRow - STATUS_BAR_HEIGHT - 1,\r |
305 | KEYHELP_TEXT | KEYHELP_BACKGROUND\r | |
306 | );\r | |
307 | \r | |
40245175 | 308 | if ((gClassOfVfr & FORMSET_CLASS_FRONT_PAGE) != FORMSET_CLASS_FRONT_PAGE) {\r |
7936fb6a | 309 | ClearLines (\r |
310 | LocalScreen.LeftColumn,\r | |
311 | LocalScreen.RightColumn,\r | |
312 | LocalScreen.TopRow,\r | |
313 | LocalScreen.TopRow + NONE_FRONT_PAGE_HEADER_HEIGHT - 1,\r | |
314 | TITLE_TEXT | TITLE_BACKGROUND\r | |
315 | );\r | |
316 | //\r | |
317 | // Print Top border line\r | |
318 | // +------------------------------------------------------------------------------+\r | |
319 | // ? ?\r | |
320 | // +------------------------------------------------------------------------------+\r | |
321 | //\r | |
322 | Character = BOXDRAW_DOWN_RIGHT;\r | |
323 | \r | |
324 | PrintChar (Character);\r | |
325 | PrintString (Buffer);\r | |
326 | \r | |
327 | Character = BOXDRAW_DOWN_LEFT;\r | |
328 | PrintChar (Character);\r | |
329 | \r | |
330 | Character = BOXDRAW_VERTICAL;\r | |
331 | for (Row = LocalScreen.TopRow + 1; Row <= LocalScreen.TopRow + NONE_FRONT_PAGE_HEADER_HEIGHT - 2; Row++) {\r | |
332 | PrintCharAt (LocalScreen.LeftColumn, Row, Character);\r | |
333 | PrintCharAt (LocalScreen.RightColumn - 1, Row, Character);\r | |
334 | }\r | |
335 | \r | |
336 | Character = BOXDRAW_UP_RIGHT;\r | |
337 | PrintCharAt (LocalScreen.LeftColumn, LocalScreen.TopRow + NONE_FRONT_PAGE_HEADER_HEIGHT - 1, Character);\r | |
338 | PrintString (Buffer);\r | |
339 | \r | |
340 | Character = BOXDRAW_UP_LEFT;\r | |
341 | PrintChar (Character);\r | |
342 | \r | |
40245175 | 343 | if ((gClassOfVfr & FORMSET_CLASS_PLATFORM_SETUP) == FORMSET_CLASS_PLATFORM_SETUP) {\r |
7936fb6a | 344 | //\r |
345 | // Print Bottom border line\r | |
346 | // +------------------------------------------------------------------------------+\r | |
347 | // ? ?\r | |
348 | // +------------------------------------------------------------------------------+\r | |
349 | //\r | |
350 | Character = BOXDRAW_DOWN_RIGHT;\r | |
48a9d5f7 | 351 | PrintCharAt (LocalScreen.LeftColumn, LocalScreen.BottomRow - STATUS_BAR_HEIGHT - gFooterHeight, Character);\r |
7936fb6a | 352 | \r |
353 | PrintString (Buffer);\r | |
354 | \r | |
355 | Character = BOXDRAW_DOWN_LEFT;\r | |
356 | PrintChar (Character);\r | |
357 | Character = BOXDRAW_VERTICAL;\r | |
48a9d5f7 | 358 | for (Row = LocalScreen.BottomRow - STATUS_BAR_HEIGHT - gFooterHeight + 1;\r |
7936fb6a | 359 | Row <= LocalScreen.BottomRow - STATUS_BAR_HEIGHT - 2;\r |
360 | Row++\r | |
361 | ) {\r | |
362 | PrintCharAt (LocalScreen.LeftColumn, Row, Character);\r | |
363 | PrintCharAt (LocalScreen.RightColumn - 1, Row, Character);\r | |
364 | }\r | |
365 | \r | |
366 | Character = BOXDRAW_UP_RIGHT;\r | |
367 | PrintCharAt (LocalScreen.LeftColumn, LocalScreen.BottomRow - STATUS_BAR_HEIGHT - 1, Character);\r | |
368 | \r | |
369 | PrintString (Buffer);\r | |
370 | \r | |
371 | Character = BOXDRAW_UP_LEFT;\r | |
372 | PrintChar (Character);\r | |
373 | }\r | |
374 | }\r | |
375 | \r | |
f4113e1f | 376 | FreePool (Buffer);\r |
7936fb6a | 377 | \r |
378 | }\r | |
379 | \r | |
380 | \r | |
381 | /**\r | |
382 | Evaluate all expressions in a Form.\r | |
383 | \r | |
384 | @param FormSet FormSet this Form belongs to.\r | |
385 | @param Form The Form.\r | |
386 | \r | |
387 | @retval EFI_SUCCESS The expression evaluated successfuly\r | |
388 | \r | |
389 | **/\r | |
390 | EFI_STATUS\r | |
391 | EvaluateFormExpressions (\r | |
392 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
393 | IN FORM_BROWSER_FORM *Form\r | |
394 | )\r | |
395 | {\r | |
396 | EFI_STATUS Status;\r | |
397 | LIST_ENTRY *Link;\r | |
398 | FORM_EXPRESSION *Expression;\r | |
399 | \r | |
400 | Link = GetFirstNode (&Form->ExpressionListHead);\r | |
401 | while (!IsNull (&Form->ExpressionListHead, Link)) {\r | |
402 | Expression = FORM_EXPRESSION_FROM_LINK (Link);\r | |
403 | Link = GetNextNode (&Form->ExpressionListHead, Link);\r | |
404 | \r | |
405 | if (Expression->Type == EFI_HII_EXPRESSION_INCONSISTENT_IF ||\r | |
2573712e LG |
406 | Expression->Type == EFI_HII_EXPRESSION_NO_SUBMIT_IF ||\r |
407 | Expression->Type == EFI_HII_EXPRESSION_WRITE ||\r | |
408 | (Expression->Type == EFI_HII_EXPRESSION_READ && Form->FormType != STANDARD_MAP_FORM_TYPE)) {\r | |
7936fb6a | 409 | //\r |
2573712e | 410 | // Postpone Form validation to Question editing or Form submitting or Question Write or Question Read for nonstandard form.\r |
7936fb6a | 411 | //\r |
412 | continue;\r | |
413 | }\r | |
414 | \r | |
415 | Status = EvaluateExpression (FormSet, Form, Expression);\r | |
416 | if (EFI_ERROR (Status)) {\r | |
417 | return Status;\r | |
418 | }\r | |
419 | }\r | |
420 | \r | |
421 | return EFI_SUCCESS;\r | |
422 | }\r | |
423 | \r | |
424 | /*\r | |
425 | +------------------------------------------------------------------------------+\r | |
d66e6c16 | 426 | ? Setup Page ?\r |
7936fb6a | 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 | \r | |
440 | \r | |
441 | \r | |
442 | \r | |
443 | \r | |
444 | \r | |
445 | +------------------------------------------------------------------------------+\r | |
446 | ?F1=Scroll Help F9=Reset to Defaults F10=Save and Exit ?\r | |
447 | | ^"=Move Highlight <Spacebar> Toggles Checkbox Esc=Discard Changes |\r | |
448 | +------------------------------------------------------------------------------+\r | |
449 | */\r | |
450 | \r | |
451 | /**\r | |
452 | \r | |
d66e6c16 | 453 | \r |
7936fb6a | 454 | Display form and wait for user to select one menu option, then return it.\r |
d66e6c16 | 455 | \r |
7936fb6a | 456 | @param Selection On input, Selection tell setup browser the information\r |
457 | about the Selection, form and formset to be displayed.\r | |
458 | On output, Selection return the screen item that is selected\r | |
459 | by user.\r | |
460 | @retval EFI_SUCESSS This function always return successfully for now.\r | |
461 | \r | |
462 | **/\r | |
463 | EFI_STATUS\r | |
464 | DisplayForm (\r | |
465 | IN OUT UI_MENU_SELECTION *Selection\r | |
466 | )\r | |
467 | {\r | |
468 | CHAR16 *StringPtr;\r | |
469 | UINT16 MenuItemCount;\r | |
470 | EFI_HII_HANDLE Handle;\r | |
7936fb6a | 471 | EFI_SCREEN_DESCRIPTOR LocalScreen;\r |
472 | UINT16 Width;\r | |
473 | UINTN ArrayEntry;\r | |
474 | CHAR16 *OutputString;\r | |
475 | LIST_ENTRY *Link;\r | |
476 | FORM_BROWSER_STATEMENT *Statement;\r | |
477 | UINT16 NumberOfLines;\r | |
478 | EFI_STATUS Status;\r | |
8b0fc5c1 | 479 | UI_MENU_OPTION *MenuOption;\r |
6c310dfb | 480 | UINT16 GlyphWidth;\r |
7936fb6a | 481 | \r |
482 | Handle = Selection->Handle;\r | |
483 | MenuItemCount = 0;\r | |
484 | ArrayEntry = 0;\r | |
485 | OutputString = NULL;\r | |
486 | \r | |
487 | UiInitMenu ();\r | |
488 | \r | |
489 | CopyMem (&LocalScreen, &gScreenDimensions, sizeof (EFI_SCREEN_DESCRIPTOR));\r | |
490 | \r | |
e8e36190 | 491 | StringPtr = GetToken (Selection->Form->FormTitle, Handle);\r |
7936fb6a | 492 | \r |
40245175 | 493 | if ((gClassOfVfr & FORMSET_CLASS_FRONT_PAGE) != FORMSET_CLASS_FRONT_PAGE) {\r |
b00964a9 ED |
494 | if (Selection->Form->ModalForm) {\r |
495 | gST->ConOut->SetAttribute (gST->ConOut, TITLE_TEXT | EFI_BACKGROUND_BLACK);\r | |
496 | } else {\r | |
497 | gST->ConOut->SetAttribute (gST->ConOut, TITLE_TEXT | TITLE_BACKGROUND);\r | |
498 | }\r | |
7936fb6a | 499 | PrintStringAt (\r |
500 | (LocalScreen.RightColumn + LocalScreen.LeftColumn - GetStringWidth (StringPtr) / 2) / 2,\r | |
501 | LocalScreen.TopRow + 1,\r | |
502 | StringPtr\r | |
503 | );\r | |
504 | }\r | |
505 | \r | |
7936fb6a | 506 | //\r |
507 | // Remove Buffer allocated for StringPtr after it has been used.\r | |
508 | //\r | |
f4113e1f | 509 | FreePool (StringPtr);\r |
7936fb6a | 510 | \r |
511 | //\r | |
512 | // Evaluate all the Expressions in this Form\r | |
513 | //\r | |
514 | Status = EvaluateFormExpressions (Selection->FormSet, Selection->Form);\r | |
515 | if (EFI_ERROR (Status)) {\r | |
516 | return Status;\r | |
517 | }\r | |
518 | \r | |
8b0fc5c1 | 519 | Selection->FormEditable = FALSE;\r |
7936fb6a | 520 | Link = GetFirstNode (&Selection->Form->StatementListHead);\r |
521 | while (!IsNull (&Selection->Form->StatementListHead, Link)) {\r | |
522 | Statement = FORM_BROWSER_STATEMENT_FROM_LINK (Link);\r | |
523 | \r | |
31585af4 | 524 | if (EvaluateExpressionList(Statement->Expression, FALSE, NULL, NULL) <= ExpressGrayOut) {\r |
7936fb6a | 525 | StringPtr = GetToken (Statement->Prompt, Handle);\r |
04eb20aa | 526 | ASSERT (StringPtr != NULL);\r |
7936fb6a | 527 | \r |
528 | Width = GetWidth (Statement, Handle);\r | |
529 | \r | |
530 | NumberOfLines = 1;\r | |
531 | ArrayEntry = 0;\r | |
6c310dfb ED |
532 | GlyphWidth = 1;\r |
533 | for (; GetLineByWidth (StringPtr, Width, &GlyphWidth,&ArrayEntry, &OutputString) != 0x0000;) {\r | |
7936fb6a | 534 | //\r |
535 | // If there is more string to process print on the next row and increment the Skip value\r | |
536 | //\r | |
d1a54e2c | 537 | if (StrLen (&StringPtr[ArrayEntry]) != 0) {\r |
7936fb6a | 538 | NumberOfLines++;\r |
539 | }\r | |
540 | \r | |
f4113e1f | 541 | FreePool (OutputString);\r |
7936fb6a | 542 | }\r |
543 | \r | |
544 | //\r | |
545 | // We are NOT!! removing this StringPtr buffer via FreePool since it is being used in the menuoptions, we will do\r | |
546 | // it in UiFreeMenu.\r | |
547 | //\r | |
f67c4382 | 548 | MenuOption = UiAddMenuOption (StringPtr, Selection->Handle, Selection->Form, Statement, NumberOfLines, MenuItemCount);\r |
7936fb6a | 549 | MenuItemCount++;\r |
8b0fc5c1 | 550 | \r |
551 | if (MenuOption->IsQuestion && !MenuOption->ReadOnly) {\r | |
552 | //\r | |
553 | // At least one item is not readonly, this Form is considered as editable\r | |
554 | //\r | |
555 | Selection->FormEditable = TRUE;\r | |
556 | }\r | |
7936fb6a | 557 | }\r |
558 | \r | |
559 | Link = GetNextNode (&Selection->Form->StatementListHead, Link);\r | |
560 | }\r | |
561 | \r | |
562 | Status = UiDisplayMenu (Selection);\r | |
563 | \r | |
564 | UiFreeMenu ();\r | |
565 | \r | |
566 | return Status;\r | |
567 | }\r | |
568 | \r | |
569 | /**\r | |
570 | Initialize the HII String Token to the correct values.\r | |
571 | \r | |
572 | **/\r | |
573 | VOID\r | |
574 | InitializeBrowserStrings (\r | |
575 | VOID\r | |
576 | )\r | |
577 | {\r | |
7936fb6a | 578 | gEnterString = GetToken (STRING_TOKEN (ENTER_STRING), gHiiHandle);\r |
579 | gEnterCommitString = GetToken (STRING_TOKEN (ENTER_COMMIT_STRING), gHiiHandle);\r | |
8d00a0f1 | 580 | gEnterEscapeString = GetToken (STRING_TOKEN (ENTER_ESCAPE_STRING), gHiiHandle);\r |
7936fb6a | 581 | gEscapeString = GetToken (STRING_TOKEN (ESCAPE_STRING), gHiiHandle);\r |
7936fb6a | 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 | |
613 | VOID\r | |
614 | FreeBrowserStrings (\r | |
615 | VOID\r | |
616 | )\r | |
617 | {\r | |
676df92c | 618 | FreePool (gEnterString);\r |
619 | FreePool (gEnterCommitString);\r | |
8d00a0f1 | 620 | FreePool (gEnterEscapeString);\r |
676df92c | 621 | FreePool (gEscapeString);\r |
622 | FreePool (gMoveHighlight);\r | |
623 | FreePool (gMakeSelection);\r | |
624 | FreePool (gDecNumericInput);\r | |
625 | FreePool (gHexNumericInput);\r | |
626 | FreePool (gToggleCheckBox);\r | |
627 | FreePool (gPromptForData);\r | |
628 | FreePool (gPromptForPassword);\r | |
629 | FreePool (gPromptForNewPassword);\r | |
630 | FreePool (gConfirmPassword);\r | |
631 | FreePool (gPassowordInvalid);\r | |
632 | FreePool (gConfirmError);\r | |
633 | FreePool (gPressEnter);\r | |
634 | FreePool (gEmptyString);\r | |
635 | FreePool (gAreYouSure);\r | |
636 | FreePool (gYesResponse);\r | |
637 | FreePool (gNoResponse);\r | |
638 | FreePool (gMiniString);\r | |
639 | FreePool (gPlusString);\r | |
640 | FreePool (gMinusString);\r | |
641 | FreePool (gAdjustNumber);\r | |
642 | FreePool (gSaveChanges);\r | |
8d00a0f1 | 643 | FreePool (gOptionMismatch);\r |
0c66bc76 | 644 | FreePool (gFormSuppress);\r |
7936fb6a | 645 | return ;\r |
646 | }\r | |
647 | \r | |
48a9d5f7 LG |
648 | /**\r |
649 | Show all registered HotKey help strings on bottom Rows.\r | |
650 | \r | |
651 | **/\r | |
652 | VOID\r | |
653 | PrintHotKeyHelpString (\r | |
654 | VOID\r | |
655 | )\r | |
656 | {\r | |
657 | UINTN CurrentCol;\r | |
658 | UINTN CurrentRow;\r | |
659 | UINTN BottomRowOfHotKeyHelp;\r | |
660 | UINTN ColumnWidth;\r | |
661 | UINTN Index;\r | |
662 | EFI_SCREEN_DESCRIPTOR LocalScreen;\r | |
663 | LIST_ENTRY *Link;\r | |
664 | BROWSER_HOT_KEY *HotKey;\r | |
665 | \r | |
666 | CopyMem (&LocalScreen, &gScreenDimensions, sizeof (EFI_SCREEN_DESCRIPTOR));\r | |
667 | ColumnWidth = (LocalScreen.RightColumn - LocalScreen.LeftColumn) / 3;\r | |
668 | BottomRowOfHotKeyHelp = LocalScreen.BottomRow - STATUS_BAR_HEIGHT - 3;\r | |
669 | \r | |
670 | //\r | |
671 | // Calculate total number of Register HotKeys. \r | |
672 | //\r | |
673 | Index = 0;\r | |
674 | Link = GetFirstNode (&gBrowserHotKeyList);\r | |
675 | while (!IsNull (&gBrowserHotKeyList, Link)) {\r | |
676 | HotKey = BROWSER_HOT_KEY_FROM_LINK (Link);\r | |
677 | //\r | |
678 | // Help string can't exceed ColumnWidth. One Row will show three Help information. \r | |
679 | //\r | |
680 | if (StrLen (HotKey->HelpString) > ColumnWidth) {\r | |
681 | HotKey->HelpString[ColumnWidth] = L'\0';\r | |
682 | }\r | |
683 | //\r | |
684 | // Calculate help information Column and Row.\r | |
685 | //\r | |
686 | if ((Index % 3) != 2) {\r | |
687 | CurrentCol = LocalScreen.LeftColumn + (2 - Index % 3) * ColumnWidth;\r | |
688 | } else {\r | |
689 | CurrentCol = LocalScreen.LeftColumn + 2;\r | |
690 | }\r | |
691 | CurrentRow = BottomRowOfHotKeyHelp - Index / 3;\r | |
692 | //\r | |
693 | // Print HotKey help string on bottom Row.\r | |
694 | //\r | |
695 | PrintStringAt (CurrentCol, CurrentRow, HotKey->HelpString);\r | |
696 | \r | |
697 | //\r | |
698 | // Get Next Hot Key.\r | |
699 | //\r | |
700 | Link = GetNextNode (&gBrowserHotKeyList, Link);\r | |
701 | Index ++;\r | |
702 | }\r | |
703 | \r | |
704 | return;\r | |
705 | }\r | |
7936fb6a | 706 | \r |
707 | /**\r | |
708 | Update key's help imformation.\r | |
709 | \r | |
8b0fc5c1 | 710 | @param Selection Tell setup browser the information about the Selection\r |
7936fb6a | 711 | @param MenuOption The Menu option\r |
712 | @param Selected Whether or not a tag be selected\r | |
713 | \r | |
714 | **/\r | |
715 | VOID\r | |
716 | UpdateKeyHelp (\r | |
8b0fc5c1 | 717 | IN UI_MENU_SELECTION *Selection,\r |
7936fb6a | 718 | IN UI_MENU_OPTION *MenuOption,\r |
719 | IN BOOLEAN Selected\r | |
720 | )\r | |
721 | {\r | |
722 | UINTN SecCol;\r | |
723 | UINTN ThdCol;\r | |
724 | UINTN LeftColumnOfHelp;\r | |
725 | UINTN RightColumnOfHelp;\r | |
726 | UINTN TopRowOfHelp;\r | |
727 | UINTN BottomRowOfHelp;\r | |
728 | UINTN StartColumnOfHelp;\r | |
729 | EFI_SCREEN_DESCRIPTOR LocalScreen;\r | |
730 | FORM_BROWSER_STATEMENT *Statement;\r | |
731 | \r | |
b00964a9 ED |
732 | gST->ConOut->SetAttribute (gST->ConOut, KEYHELP_TEXT | KEYHELP_BACKGROUND);\r |
733 | \r | |
734 | if (Selection->Form->ModalForm) {\r | |
735 | return;\r | |
736 | }\r | |
737 | \r | |
7936fb6a | 738 | CopyMem (&LocalScreen, &gScreenDimensions, sizeof (EFI_SCREEN_DESCRIPTOR));\r |
739 | \r | |
740 | SecCol = LocalScreen.LeftColumn + (LocalScreen.RightColumn - LocalScreen.LeftColumn) / 3;\r | |
48a9d5f7 | 741 | ThdCol = LocalScreen.LeftColumn + (LocalScreen.RightColumn - LocalScreen.LeftColumn) / 3 * 2;\r |
7936fb6a | 742 | \r |
743 | StartColumnOfHelp = LocalScreen.LeftColumn + 2;\r | |
744 | LeftColumnOfHelp = LocalScreen.LeftColumn + 1;\r | |
745 | RightColumnOfHelp = LocalScreen.RightColumn - 2;\r | |
48a9d5f7 LG |
746 | TopRowOfHelp = LocalScreen.BottomRow - STATUS_BAR_HEIGHT - gFooterHeight + 1;\r |
747 | BottomRowOfHelp = LocalScreen.BottomRow - STATUS_BAR_HEIGHT - 2;\r | |
7936fb6a | 748 | \r |
7936fb6a | 749 | Statement = MenuOption->ThisTag;\r |
750 | switch (Statement->Operand) {\r | |
751 | case EFI_IFR_ORDERED_LIST_OP:\r | |
752 | case EFI_IFR_ONE_OF_OP:\r | |
753 | case EFI_IFR_NUMERIC_OP:\r | |
754 | case EFI_IFR_TIME_OP:\r | |
755 | case EFI_IFR_DATE_OP:\r | |
756 | ClearLines (LeftColumnOfHelp, RightColumnOfHelp, TopRowOfHelp, BottomRowOfHelp, KEYHELP_TEXT | KEYHELP_BACKGROUND);\r | |
757 | \r | |
758 | if (!Selected) {\r | |
48a9d5f7 LG |
759 | //\r |
760 | // On system setting, HotKey will show on every form.\r | |
761 | //\r | |
762 | if (gBrowserSettingScope == SystemLevel ||\r | |
763 | (Selection->FormEditable && gFunctionKeySetting != NONE_FUNCTION_KEY_SETTING)) {\r | |
764 | PrintHotKeyHelpString ();\r | |
765 | }\r | |
766 | \r | |
40245175 | 767 | if ((gClassOfVfr & FORMSET_CLASS_PLATFORM_SETUP) == FORMSET_CLASS_PLATFORM_SETUP) {\r |
7936fb6a | 768 | PrintStringAt (ThdCol, BottomRowOfHelp, gEscapeString);\r |
769 | }\r | |
770 | \r | |
771 | if ((Statement->Operand == EFI_IFR_DATE_OP) ||\r | |
8d00a0f1 | 772 | (Statement->Operand == EFI_IFR_TIME_OP)) {\r |
7936fb6a | 773 | PrintAt (\r |
774 | StartColumnOfHelp,\r | |
775 | BottomRowOfHelp,\r | |
776 | L"%c%c%c%c%s",\r | |
777 | ARROW_UP,\r | |
778 | ARROW_DOWN,\r | |
779 | ARROW_RIGHT,\r | |
780 | ARROW_LEFT,\r | |
781 | gMoveHighlight\r | |
782 | );\r | |
e24adb18 ED |
783 | PrintStringAt (SecCol, BottomRowOfHelp, gEnterString);\r |
784 | PrintStringAt (StartColumnOfHelp, TopRowOfHelp, gAdjustNumber);\r | |
7936fb6a | 785 | } else {\r |
786 | PrintAt (StartColumnOfHelp, BottomRowOfHelp, L"%c%c%s", ARROW_UP, ARROW_DOWN, gMoveHighlight);\r | |
8d00a0f1 | 787 | if (Statement->Operand == EFI_IFR_NUMERIC_OP && Statement->Step != 0) {\r |
e24adb18 ED |
788 | PrintStringAt (StartColumnOfHelp, TopRowOfHelp, gAdjustNumber);\r |
789 | } \r | |
790 | PrintStringAt (SecCol, BottomRowOfHelp, gEnterString);\r | |
7936fb6a | 791 | }\r |
792 | } else {\r | |
793 | PrintStringAt (SecCol, BottomRowOfHelp, gEnterCommitString);\r | |
794 | \r | |
795 | //\r | |
796 | // If it is a selected numeric with manual input, display different message\r | |
797 | //\r | |
e24adb18 ED |
798 | if ((Statement->Operand == EFI_IFR_NUMERIC_OP) || \r |
799 | (Statement->Operand == EFI_IFR_DATE_OP) ||\r | |
800 | (Statement->Operand == EFI_IFR_TIME_OP)) {\r | |
7936fb6a | 801 | PrintStringAt (\r |
802 | SecCol,\r | |
803 | TopRowOfHelp,\r | |
804 | ((Statement->Flags & EFI_IFR_DISPLAY_UINT_HEX) == EFI_IFR_DISPLAY_UINT_HEX) ? gHexNumericInput : gDecNumericInput\r | |
805 | );\r | |
806 | } else if (Statement->Operand != EFI_IFR_ORDERED_LIST_OP) {\r | |
807 | PrintAt (StartColumnOfHelp, BottomRowOfHelp, L"%c%c%s", ARROW_UP, ARROW_DOWN, gMoveHighlight);\r | |
808 | }\r | |
809 | \r | |
810 | if (Statement->Operand == EFI_IFR_ORDERED_LIST_OP) {\r | |
811 | PrintStringAt (StartColumnOfHelp, TopRowOfHelp, gPlusString);\r | |
812 | PrintStringAt (ThdCol, TopRowOfHelp, gMinusString);\r | |
813 | }\r | |
814 | \r | |
8d00a0f1 | 815 | PrintStringAt (ThdCol, BottomRowOfHelp, gEnterEscapeString);\r |
7936fb6a | 816 | }\r |
817 | break;\r | |
818 | \r | |
819 | case EFI_IFR_CHECKBOX_OP:\r | |
820 | ClearLines (LeftColumnOfHelp, RightColumnOfHelp, TopRowOfHelp, BottomRowOfHelp, KEYHELP_TEXT | KEYHELP_BACKGROUND);\r | |
821 | \r | |
48a9d5f7 LG |
822 | //\r |
823 | // On system setting, HotKey will show on every form.\r | |
824 | //\r | |
825 | if (gBrowserSettingScope == SystemLevel ||\r | |
826 | (Selection->FormEditable && gFunctionKeySetting != NONE_FUNCTION_KEY_SETTING)) {\r | |
827 | PrintHotKeyHelpString ();\r | |
828 | }\r | |
40245175 | 829 | if ((gClassOfVfr & FORMSET_CLASS_PLATFORM_SETUP) == FORMSET_CLASS_PLATFORM_SETUP) {\r |
7936fb6a | 830 | PrintStringAt (ThdCol, BottomRowOfHelp, gEscapeString);\r |
831 | }\r | |
832 | \r | |
833 | PrintAt (StartColumnOfHelp, BottomRowOfHelp, L"%c%c%s", ARROW_UP, ARROW_DOWN, gMoveHighlight);\r | |
834 | PrintStringAt (SecCol, BottomRowOfHelp, gToggleCheckBox);\r | |
835 | break;\r | |
836 | \r | |
837 | case EFI_IFR_REF_OP:\r | |
838 | case EFI_IFR_PASSWORD_OP:\r | |
839 | case EFI_IFR_STRING_OP:\r | |
840 | case EFI_IFR_TEXT_OP:\r | |
841 | case EFI_IFR_ACTION_OP:\r | |
842 | case EFI_IFR_RESET_BUTTON_OP:\r | |
11232773 | 843 | case EFI_IFR_SUBTITLE_OP:\r |
7936fb6a | 844 | ClearLines (LeftColumnOfHelp, RightColumnOfHelp, TopRowOfHelp, BottomRowOfHelp, KEYHELP_TEXT | KEYHELP_BACKGROUND);\r |
845 | \r | |
846 | if (!Selected) {\r | |
48a9d5f7 LG |
847 | //\r |
848 | // On system setting, HotKey will show on every form.\r | |
849 | //\r | |
850 | if (gBrowserSettingScope == SystemLevel ||\r | |
851 | (Selection->FormEditable && gFunctionKeySetting != NONE_FUNCTION_KEY_SETTING)) {\r | |
852 | PrintHotKeyHelpString ();\r | |
853 | }\r | |
40245175 | 854 | if ((gClassOfVfr & FORMSET_CLASS_PLATFORM_SETUP) == FORMSET_CLASS_PLATFORM_SETUP) {\r |
7936fb6a | 855 | PrintStringAt (ThdCol, BottomRowOfHelp, gEscapeString);\r |
856 | }\r | |
857 | \r | |
858 | PrintAt (StartColumnOfHelp, BottomRowOfHelp, L"%c%c%s", ARROW_UP, ARROW_DOWN, gMoveHighlight);\r | |
11232773 | 859 | if (Statement->Operand != EFI_IFR_TEXT_OP && Statement->Operand != EFI_IFR_SUBTITLE_OP) {\r |
7936fb6a | 860 | PrintStringAt (SecCol, BottomRowOfHelp, gEnterString);\r |
861 | }\r | |
862 | } else {\r | |
863 | if (Statement->Operand != EFI_IFR_REF_OP) {\r | |
864 | PrintStringAt (\r | |
865 | (LocalScreen.RightColumn - GetStringWidth (gEnterCommitString) / 2) / 2,\r | |
866 | BottomRowOfHelp,\r | |
867 | gEnterCommitString\r | |
868 | );\r | |
8d00a0f1 | 869 | PrintStringAt (ThdCol, BottomRowOfHelp, gEnterEscapeString);\r |
7936fb6a | 870 | }\r |
871 | }\r | |
872 | break;\r | |
873 | \r | |
874 | default:\r | |
875 | break;\r | |
876 | }\r | |
877 | }\r | |
878 | \r | |
879 | /**\r | |
880 | Functions which are registered to receive notification of\r | |
881 | database events have this prototype. The actual event is encoded\r | |
882 | in NotifyType. The following table describes how PackageType,\r | |
883 | PackageGuid, Handle, and Package are used for each of the\r | |
884 | notification types.\r | |
885 | \r | |
886 | @param PackageType Package type of the notification.\r | |
887 | \r | |
888 | @param PackageGuid If PackageType is\r | |
889 | EFI_HII_PACKAGE_TYPE_GUID, then this is\r | |
890 | the pointer to the GUID from the Guid\r | |
891 | field of EFI_HII_PACKAGE_GUID_HEADER.\r | |
892 | Otherwise, it must be NULL.\r | |
893 | \r | |
894 | @param Package Points to the package referred to by the\r | |
895 | notification Handle The handle of the package\r | |
896 | list which contains the specified package.\r | |
897 | \r | |
898 | @param Handle The HII handle.\r | |
899 | \r | |
900 | @param NotifyType The type of change concerning the\r | |
901 | database. See\r | |
902 | EFI_HII_DATABASE_NOTIFY_TYPE.\r | |
903 | \r | |
904 | **/\r | |
905 | EFI_STATUS\r | |
6d3ea23f | 906 | EFIAPI\r |
7936fb6a | 907 | FormUpdateNotify (\r |
908 | IN UINT8 PackageType,\r | |
909 | IN CONST EFI_GUID *PackageGuid,\r | |
910 | IN CONST EFI_HII_PACKAGE_HEADER *Package,\r | |
911 | IN EFI_HII_HANDLE Handle,\r | |
912 | IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType\r | |
913 | )\r | |
914 | {\r | |
915 | mHiiPackageListUpdated = TRUE;\r | |
916 | \r | |
917 | return EFI_SUCCESS;\r | |
918 | }\r | |
919 | \r | |
b18e7050 ED |
920 | /**\r |
921 | check whether the formset need to update the NV.\r | |
922 | \r | |
923 | @param FormSet FormSet data structure.\r | |
924 | \r | |
925 | @retval TRUE Need to update the NV.\r | |
926 | @retval FALSE No need to update the NV.\r | |
927 | **/\r | |
928 | BOOLEAN \r | |
929 | IsNvUpdateRequired (\r | |
930 | IN FORM_BROWSER_FORMSET *FormSet\r | |
931 | )\r | |
932 | {\r | |
933 | LIST_ENTRY *Link;\r | |
934 | FORM_BROWSER_FORM *Form;\r | |
935 | \r | |
936 | Link = GetFirstNode (&FormSet->FormListHead);\r | |
937 | while (!IsNull (&FormSet->FormListHead, Link)) {\r | |
938 | Form = FORM_BROWSER_FORM_FROM_LINK (Link);\r | |
939 | \r | |
940 | if (Form->NvUpdateRequired ) {\r | |
941 | return TRUE;\r | |
942 | }\r | |
943 | \r | |
944 | Link = GetNextNode (&FormSet->FormListHead, Link);\r | |
945 | }\r | |
946 | \r | |
947 | return FALSE;\r | |
948 | }\r | |
949 | \r | |
950 | /**\r | |
951 | check whether the formset need to update the NV.\r | |
952 | \r | |
953 | @param FormSet FormSet data structure.\r | |
954 | @param SetValue Whether set new value or clear old value.\r | |
955 | \r | |
956 | **/\r | |
957 | VOID\r | |
958 | UpdateNvInfoInForm (\r | |
959 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
960 | IN BOOLEAN SetValue\r | |
961 | )\r | |
962 | {\r | |
963 | LIST_ENTRY *Link;\r | |
964 | FORM_BROWSER_FORM *Form;\r | |
965 | \r | |
966 | Link = GetFirstNode (&FormSet->FormListHead);\r | |
967 | while (!IsNull (&FormSet->FormListHead, Link)) {\r | |
968 | Form = FORM_BROWSER_FORM_FROM_LINK (Link);\r | |
969 | \r | |
970 | Form->NvUpdateRequired = SetValue;\r | |
971 | \r | |
972 | Link = GetNextNode (&FormSet->FormListHead, Link);\r | |
973 | }\r | |
974 | }\r | |
975 | /**\r | |
976 | Find menu which will show next time.\r | |
977 | \r | |
978 | @param Selection On input, Selection tell setup browser the information\r | |
979 | about the Selection, form and formset to be displayed.\r | |
980 | On output, Selection return the screen item that is selected\r | |
981 | by user.\r | |
982 | @param Repaint Whether need to repaint the menu.\r | |
983 | @param NewLine Whether need to show at new line.\r | |
984 | \r | |
985 | @retval TRUE Need return.\r | |
986 | @retval FALSE No need to return.\r | |
987 | **/\r | |
988 | BOOLEAN\r | |
989 | FindNextMenu (\r | |
990 | IN OUT UI_MENU_SELECTION *Selection,\r | |
991 | IN BOOLEAN *Repaint, \r | |
992 | IN BOOLEAN *NewLine \r | |
993 | )\r | |
994 | {\r | |
995 | UI_MENU_LIST *CurrentMenu;\r | |
996 | CHAR16 YesResponse;\r | |
997 | CHAR16 NoResponse;\r | |
998 | EFI_INPUT_KEY Key;\r | |
b2e444aa | 999 | BROWSER_SETTING_SCOPE Scope;\r |
b18e7050 ED |
1000 | \r |
1001 | CurrentMenu = Selection->CurrentMenu;\r | |
1002 | \r | |
1003 | if (CurrentMenu != NULL && CurrentMenu->Parent != NULL) {\r | |
b2e444aa ED |
1004 | //\r |
1005 | // we have a parent, so go to the parent menu\r | |
1006 | //\r | |
1007 | if (CompareGuid (&CurrentMenu->FormSetGuid, &CurrentMenu->Parent->FormSetGuid)) {\r | |
1008 | //\r | |
1009 | // The parent menu and current menu are in the same formset\r | |
1010 | //\r | |
1011 | Selection->Action = UI_ACTION_REFRESH_FORM;\r | |
1012 | Scope = FormLevel;\r | |
1013 | } else {\r | |
1014 | Selection->Action = UI_ACTION_REFRESH_FORMSET;\r | |
1015 | CopyMem (&Selection->FormSetGuid, &CurrentMenu->Parent->FormSetGuid, sizeof (EFI_GUID));\r | |
1016 | Selection->Handle = CurrentMenu->Parent->HiiHandle;\r | |
1017 | Scope = FormSetLevel;\r | |
1018 | }\r | |
1019 | \r | |
48a9d5f7 LG |
1020 | //\r |
1021 | // Form Level Check whether the data is changed.\r | |
1022 | //\r | |
b2e444aa ED |
1023 | if ((gBrowserSettingScope == FormLevel && Selection->Form->NvUpdateRequired) ||\r |
1024 | (gBrowserSettingScope == FormSetLevel && IsNvUpdateRequired(Selection->FormSet) && Scope == FormSetLevel)) {\r | |
7538d536 | 1025 | gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r |
48a9d5f7 LG |
1026 | \r |
1027 | YesResponse = gYesResponse[0];\r | |
1028 | NoResponse = gNoResponse[0];\r | |
1029 | \r | |
1030 | //\r | |
1031 | // If NV flag is up, prompt user\r | |
1032 | //\r | |
1033 | do {\r | |
1034 | CreateDialog (4, TRUE, 0, NULL, &Key, gEmptyString, gSaveChanges, gAreYouSure, gEmptyString);\r | |
1035 | } while\r | |
1036 | (\r | |
1037 | (Key.ScanCode != SCAN_ESC) &&\r | |
1038 | ((Key.UnicodeChar | UPPER_LOWER_CASE_OFFSET) != (NoResponse | UPPER_LOWER_CASE_OFFSET)) &&\r | |
1039 | ((Key.UnicodeChar | UPPER_LOWER_CASE_OFFSET) != (YesResponse | UPPER_LOWER_CASE_OFFSET))\r | |
1040 | );\r | |
1041 | \r | |
1042 | if (Key.ScanCode == SCAN_ESC) {\r | |
1043 | //\r | |
1044 | // User hits the ESC key, Ingore. \r | |
1045 | //\r | |
1046 | if (Repaint != NULL) {\r | |
1047 | *Repaint = TRUE;\r | |
1048 | }\r | |
1049 | if (NewLine != NULL) {\r | |
1050 | *NewLine = TRUE;\r | |
1051 | }\r | |
1052 | \r | |
1053 | Selection->Action = UI_ACTION_NONE;\r | |
1054 | return FALSE;\r | |
1055 | }\r | |
1056 | \r | |
1057 | if ((Key.UnicodeChar | UPPER_LOWER_CASE_OFFSET) == (YesResponse | UPPER_LOWER_CASE_OFFSET)) {\r | |
1058 | //\r | |
1059 | // If the user hits the YesResponse key\r | |
1060 | //\r | |
7538d536 | 1061 | SubmitForm (Selection->FormSet, Selection->Form, Scope);\r |
48a9d5f7 LG |
1062 | } else {\r |
1063 | //\r | |
1064 | // If the user hits the NoResponse key\r | |
1065 | //\r | |
7538d536 | 1066 | DiscardForm (Selection->FormSet, Selection->Form, Scope);\r |
48a9d5f7 LG |
1067 | }\r |
1068 | }\r | |
1069 | \r | |
b18e7050 ED |
1070 | Selection->Statement = NULL;\r |
1071 | \r | |
1072 | Selection->FormId = CurrentMenu->Parent->FormId;\r | |
1073 | Selection->QuestionId = CurrentMenu->Parent->QuestionId;\r | |
1074 | \r | |
1075 | //\r | |
1076 | // Clear highlight record for this menu\r | |
1077 | //\r | |
1078 | CurrentMenu->QuestionId = 0;\r | |
1079 | return FALSE;\r | |
1080 | }\r | |
1081 | \r | |
1082 | if ((gClassOfVfr & FORMSET_CLASS_FRONT_PAGE) == FORMSET_CLASS_FRONT_PAGE) {\r | |
1083 | //\r | |
1084 | // We never exit FrontPage, so skip the ESC\r | |
1085 | //\r | |
1086 | Selection->Action = UI_ACTION_NONE;\r | |
1087 | return FALSE;\r | |
1088 | }\r | |
1089 | \r | |
1090 | //\r | |
1091 | // We are going to leave current FormSet, so check uncommited data in this FormSet\r | |
1092 | //\r | |
48a9d5f7 | 1093 | if (gBrowserSettingScope != SystemLevel && IsNvUpdateRequired(Selection->FormSet)) {\r |
7538d536 | 1094 | gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r |
b18e7050 ED |
1095 | \r |
1096 | YesResponse = gYesResponse[0];\r | |
1097 | NoResponse = gNoResponse[0];\r | |
1098 | \r | |
1099 | //\r | |
1100 | // If NV flag is up, prompt user\r | |
1101 | //\r | |
1102 | do {\r | |
1103 | CreateDialog (4, TRUE, 0, NULL, &Key, gEmptyString, gSaveChanges, gAreYouSure, gEmptyString);\r | |
1104 | } while\r | |
1105 | (\r | |
1106 | (Key.ScanCode != SCAN_ESC) &&\r | |
1107 | ((Key.UnicodeChar | UPPER_LOWER_CASE_OFFSET) != (NoResponse | UPPER_LOWER_CASE_OFFSET)) &&\r | |
1108 | ((Key.UnicodeChar | UPPER_LOWER_CASE_OFFSET) != (YesResponse | UPPER_LOWER_CASE_OFFSET))\r | |
1109 | );\r | |
1110 | \r | |
1111 | if (Key.ScanCode == SCAN_ESC) {\r | |
1112 | //\r | |
1113 | // User hits the ESC key\r | |
1114 | //\r | |
1115 | if (Repaint != NULL) {\r | |
1116 | *Repaint = TRUE;\r | |
1117 | }\r | |
1118 | \r | |
1119 | if (NewLine != NULL) {\r | |
1120 | *NewLine = TRUE;\r | |
1121 | }\r | |
1122 | \r | |
1123 | Selection->Action = UI_ACTION_NONE;\r | |
1124 | return FALSE;\r | |
1125 | }\r | |
1126 | \r | |
b18e7050 | 1127 | if ((Key.UnicodeChar | UPPER_LOWER_CASE_OFFSET) == (YesResponse | UPPER_LOWER_CASE_OFFSET)) {\r |
48a9d5f7 LG |
1128 | //\r |
1129 | // If the user hits the YesResponse key\r | |
1130 | //\r | |
7538d536 | 1131 | SubmitForm (Selection->FormSet, Selection->Form, FormSetLevel);\r |
48a9d5f7 LG |
1132 | } else {\r |
1133 | //\r | |
1134 | // If the user hits the NoResponse key\r | |
1135 | //\r | |
7538d536 | 1136 | DiscardForm (Selection->FormSet, Selection->Form, FormSetLevel);\r |
b18e7050 ED |
1137 | }\r |
1138 | }\r | |
1139 | \r | |
1140 | Selection->Statement = NULL;\r | |
0194d26c ED |
1141 | if (CurrentMenu != NULL) {\r |
1142 | CurrentMenu->QuestionId = 0;\r | |
1143 | }\r | |
b18e7050 ED |
1144 | \r |
1145 | Selection->Action = UI_ACTION_EXIT;\r | |
1146 | return TRUE;\r | |
1147 | }\r | |
1148 | \r | |
1149 | /**\r | |
1150 | Call the call back function for the question and process the return action.\r | |
1151 | \r | |
1152 | @param Selection On input, Selection tell setup browser the information\r | |
1153 | about the Selection, form and formset to be displayed.\r | |
1154 | On output, Selection return the screen item that is selected\r | |
1155 | by user.\r | |
1156 | @param Question The Question which need to call.\r | |
1157 | @param Action The action request.\r | |
1158 | @param SkipSaveOrDiscard Whether skip save or discard action.\r | |
1159 | \r | |
1160 | @retval EFI_SUCCESS The call back function excutes successfully.\r | |
1161 | @return Other value if the call back function failed to excute. \r | |
1162 | **/\r | |
1163 | EFI_STATUS \r | |
1164 | ProcessCallBackFunction (\r | |
1165 | IN OUT UI_MENU_SELECTION *Selection,\r | |
1166 | IN FORM_BROWSER_STATEMENT *Question,\r | |
1167 | IN EFI_BROWSER_ACTION Action,\r | |
1168 | IN BOOLEAN SkipSaveOrDiscard\r | |
1169 | )\r | |
1170 | {\r | |
1171 | EFI_STATUS Status;\r | |
1172 | EFI_BROWSER_ACTION_REQUEST ActionRequest;\r | |
1173 | EFI_HII_CONFIG_ACCESS_PROTOCOL *ConfigAccess;\r | |
1174 | EFI_HII_VALUE *HiiValue;\r | |
1175 | EFI_IFR_TYPE_VALUE *TypeValue;\r | |
1176 | FORM_BROWSER_STATEMENT *Statement;\r | |
1177 | BOOLEAN SubmitFormIsRequired;\r | |
b18e7050 ED |
1178 | BOOLEAN DiscardFormIsRequired;\r |
1179 | BOOLEAN NeedExit;\r | |
1180 | LIST_ENTRY *Link;\r | |
48a9d5f7 | 1181 | BROWSER_SETTING_SCOPE SettingLevel;\r |
b18e7050 ED |
1182 | \r |
1183 | ConfigAccess = Selection->FormSet->ConfigAccess;\r | |
1184 | SubmitFormIsRequired = FALSE;\r | |
48a9d5f7 | 1185 | SettingLevel = FormSetLevel;\r |
b18e7050 ED |
1186 | DiscardFormIsRequired = FALSE;\r |
1187 | NeedExit = FALSE;\r | |
1188 | Status = EFI_SUCCESS;\r | |
1189 | ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;\r | |
1190 | \r | |
1191 | if (ConfigAccess == NULL) {\r | |
1192 | return EFI_SUCCESS;\r | |
1193 | }\r | |
1194 | \r | |
1195 | Link = GetFirstNode (&Selection->Form->StatementListHead);\r | |
1196 | while (!IsNull (&Selection->Form->StatementListHead, Link)) {\r | |
1197 | Statement = FORM_BROWSER_STATEMENT_FROM_LINK (Link);\r | |
1198 | Link = GetNextNode (&Selection->Form->StatementListHead, Link);\r | |
1199 | \r | |
1200 | //\r | |
1201 | // if Question != NULL, only process the question. Else, process all question in this form.\r | |
1202 | //\r | |
1203 | if ((Question != NULL) && (Statement != Question)) {\r | |
1204 | continue;\r | |
1205 | }\r | |
1206 | \r | |
1207 | if ((Statement->QuestionFlags & EFI_IFR_FLAG_CALLBACK) != EFI_IFR_FLAG_CALLBACK) {\r | |
1208 | continue;\r | |
1209 | }\r | |
1210 | \r | |
1211 | //\r | |
1212 | // Check whether Statement is disabled.\r | |
1213 | //\r | |
31585af4 ED |
1214 | if (Statement->Expression != NULL) {\r |
1215 | if (EvaluateExpressionList(Statement->Expression, TRUE, Selection->FormSet, Selection->Form) == ExpressDisable) {\r | |
b18e7050 ED |
1216 | continue;\r |
1217 | }\r | |
1218 | }\r | |
1219 | \r | |
1220 | HiiValue = &Statement->HiiValue;\r | |
1221 | TypeValue = &HiiValue->Value;\r | |
1222 | if (HiiValue->Type == EFI_IFR_TYPE_BUFFER) {\r | |
1223 | //\r | |
1224 | // For OrderedList, passing in the value buffer to Callback()\r | |
1225 | //\r | |
1226 | TypeValue = (EFI_IFR_TYPE_VALUE *) Statement->BufferValue;\r | |
1227 | }\r | |
1228 | \r | |
1229 | ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;\r | |
1230 | Status = ConfigAccess->Callback (\r | |
1231 | ConfigAccess,\r | |
1232 | Action,\r | |
1233 | Statement->QuestionId,\r | |
1234 | HiiValue->Type,\r | |
1235 | TypeValue,\r | |
1236 | &ActionRequest\r | |
1237 | );\r | |
1238 | if (!EFI_ERROR (Status)) {\r | |
3a4e7a3e ED |
1239 | //\r |
1240 | // Only for EFI_BROWSER_ACTION_CHANGED need to handle this ActionRequest.\r | |
1241 | //\r | |
1242 | if (Action == EFI_BROWSER_ACTION_CHANGED) {\r | |
1243 | switch (ActionRequest) {\r | |
1244 | case EFI_BROWSER_ACTION_REQUEST_RESET:\r | |
1245 | gResetRequired = TRUE;\r | |
1246 | Selection->Action = UI_ACTION_EXIT;\r | |
1247 | break;\r | |
b18e7050 | 1248 | \r |
3a4e7a3e ED |
1249 | case EFI_BROWSER_ACTION_REQUEST_SUBMIT:\r |
1250 | SubmitFormIsRequired = TRUE;\r | |
1251 | Selection->Action = UI_ACTION_EXIT;\r | |
1252 | break;\r | |
b18e7050 | 1253 | \r |
3a4e7a3e ED |
1254 | case EFI_BROWSER_ACTION_REQUEST_EXIT:\r |
1255 | Selection->Action = UI_ACTION_EXIT;\r | |
1256 | break;\r | |
b18e7050 | 1257 | \r |
3a4e7a3e ED |
1258 | case EFI_BROWSER_ACTION_REQUEST_FORM_SUBMIT_EXIT:\r |
1259 | SubmitFormIsRequired = TRUE;\r | |
1260 | SettingLevel = FormLevel;\r | |
1261 | NeedExit = TRUE;\r | |
1262 | break;\r | |
b18e7050 | 1263 | \r |
3a4e7a3e ED |
1264 | case EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD_EXIT:\r |
1265 | DiscardFormIsRequired = TRUE;\r | |
1266 | SettingLevel = FormLevel; \r | |
1267 | NeedExit = TRUE;\r | |
1268 | break;\r | |
b18e7050 | 1269 | \r |
3a4e7a3e ED |
1270 | case EFI_BROWSER_ACTION_REQUEST_FORM_APPLY:\r |
1271 | SubmitFormIsRequired = TRUE;\r | |
1272 | SettingLevel = FormLevel;\r | |
1273 | break;\r | |
b18e7050 | 1274 | \r |
3a4e7a3e ED |
1275 | case EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD:\r |
1276 | DiscardFormIsRequired = TRUE;\r | |
1277 | SettingLevel = FormLevel;\r | |
1278 | break;\r | |
b18e7050 | 1279 | \r |
3a4e7a3e ED |
1280 | default:\r |
1281 | break;\r | |
1282 | }\r | |
b18e7050 | 1283 | }\r |
8ca6180f ED |
1284 | \r |
1285 | //\r | |
1286 | // According the spec, return value from call back of "changing" and \r | |
1287 | // "retrieve" should update to the question's temp buffer.\r | |
1288 | //\r | |
1289 | if (Action == EFI_BROWSER_ACTION_CHANGING || Action == EFI_BROWSER_ACTION_RETRIEVE) {\r | |
816a7110 | 1290 | SetQuestionValue(Selection->FormSet, Selection->Form, Statement, GetSetValueWithEditBuffer);\r |
8ca6180f | 1291 | }\r |
c4042207 | 1292 | } else {\r |
b18e7050 | 1293 | //\r |
c4042207 ED |
1294 | // According the spec, return fail from call back of "changing" and \r |
1295 | // "retrieve", should restore the question's value.\r | |
b18e7050 | 1296 | //\r |
c4042207 | 1297 | if (Action == EFI_BROWSER_ACTION_CHANGING || Action == EFI_BROWSER_ACTION_RETRIEVE) {\r |
816a7110 | 1298 | GetQuestionValue(Selection->FormSet, Selection->Form, Statement, GetSetValueWithEditBuffer);\r |
c4042207 ED |
1299 | }\r |
1300 | \r | |
1301 | if (Status == EFI_UNSUPPORTED) {\r | |
1302 | //\r | |
1303 | // If return EFI_UNSUPPORTED, also consider Hii driver suceess deal with it.\r | |
1304 | //\r | |
1305 | Status = EFI_SUCCESS;\r | |
1306 | }\r | |
b18e7050 ED |
1307 | }\r |
1308 | }\r | |
1309 | \r | |
1310 | if (SubmitFormIsRequired && !SkipSaveOrDiscard) {\r | |
48a9d5f7 | 1311 | SubmitForm (Selection->FormSet, Selection->Form, SettingLevel);\r |
b18e7050 ED |
1312 | }\r |
1313 | \r | |
1314 | if (DiscardFormIsRequired && !SkipSaveOrDiscard) {\r | |
48a9d5f7 | 1315 | DiscardForm (Selection->FormSet, Selection->Form, SettingLevel);\r |
b18e7050 ED |
1316 | }\r |
1317 | \r | |
1318 | if (NeedExit) {\r | |
1319 | FindNextMenu (Selection, NULL, NULL);\r | |
1320 | }\r | |
1321 | \r | |
1322 | return Status;\r | |
1323 | }\r | |
1324 | \r | |
9776099f ED |
1325 | /**\r |
1326 | Call the retrieve type call back function for one question to get the initialize data.\r | |
1327 | \r | |
1328 | This function only used when in the initialize stage, because in this stage, the \r | |
1329 | Selection->Form is not ready. For other case, use the ProcessCallBackFunction instead.\r | |
1330 | \r | |
1331 | @param ConfigAccess The config access protocol produced by the hii driver.\r | |
1332 | @param Statement The Question which need to call.\r | |
1333 | \r | |
1334 | @retval EFI_SUCCESS The call back function excutes successfully.\r | |
1335 | @return Other value if the call back function failed to excute. \r | |
1336 | **/\r | |
1337 | EFI_STATUS \r | |
1338 | ProcessRetrieveForQuestion (\r | |
1339 | IN EFI_HII_CONFIG_ACCESS_PROTOCOL *ConfigAccess,\r | |
1340 | IN FORM_BROWSER_STATEMENT *Statement\r | |
1341 | )\r | |
1342 | {\r | |
1343 | EFI_STATUS Status;\r | |
1344 | EFI_BROWSER_ACTION_REQUEST ActionRequest;\r | |
1345 | EFI_HII_VALUE *HiiValue;\r | |
1346 | EFI_IFR_TYPE_VALUE *TypeValue;\r | |
1347 | \r | |
1348 | Status = EFI_SUCCESS;\r | |
1349 | ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;\r | |
1350 | \r | |
1351 | if ((Statement->QuestionFlags & EFI_IFR_FLAG_CALLBACK) != EFI_IFR_FLAG_CALLBACK) {\r | |
1352 | return EFI_UNSUPPORTED;\r | |
1353 | }\r | |
1354 | \r | |
1355 | HiiValue = &Statement->HiiValue;\r | |
1356 | TypeValue = &HiiValue->Value;\r | |
1357 | if (HiiValue->Type == EFI_IFR_TYPE_BUFFER) {\r | |
1358 | //\r | |
1359 | // For OrderedList, passing in the value buffer to Callback()\r | |
1360 | //\r | |
1361 | TypeValue = (EFI_IFR_TYPE_VALUE *) Statement->BufferValue;\r | |
1362 | }\r | |
1363 | \r | |
1364 | ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;\r | |
1365 | Status = ConfigAccess->Callback (\r | |
1366 | ConfigAccess,\r | |
1367 | EFI_BROWSER_ACTION_RETRIEVE,\r | |
1368 | Statement->QuestionId,\r | |
1369 | HiiValue->Type,\r | |
1370 | TypeValue,\r | |
1371 | &ActionRequest\r | |
1372 | );\r | |
1373 | return Status;\r | |
1374 | }\r | |
1375 | \r | |
7936fb6a | 1376 | /**\r |
1377 | The worker function that send the displays to the screen. On output,\r | |
1378 | the selection made by user is returned.\r | |
1379 | \r | |
1380 | @param Selection On input, Selection tell setup browser the information\r | |
1381 | about the Selection, form and formset to be displayed.\r | |
1382 | On output, Selection return the screen item that is selected\r | |
1383 | by user.\r | |
1384 | \r | |
1385 | @retval EFI_SUCCESS The page is displayed successfully.\r | |
1386 | @return Other value if the page failed to be diplayed.\r | |
1387 | \r | |
1388 | **/\r | |
1389 | EFI_STATUS\r | |
1390 | SetupBrowser (\r | |
1391 | IN OUT UI_MENU_SELECTION *Selection\r | |
1392 | )\r | |
1393 | {\r | |
1394 | EFI_STATUS Status;\r | |
1395 | LIST_ENTRY *Link;\r | |
7936fb6a | 1396 | EFI_HANDLE NotifyHandle;\r |
7936fb6a | 1397 | FORM_BROWSER_STATEMENT *Statement;\r |
1398 | EFI_HII_CONFIG_ACCESS_PROTOCOL *ConfigAccess;\r | |
0c66bc76 | 1399 | EFI_INPUT_KEY Key;\r |
7936fb6a | 1400 | \r |
1401 | gMenuRefreshHead = NULL;\r | |
5adb8db7 | 1402 | ConfigAccess = Selection->FormSet->ConfigAccess;\r |
7936fb6a | 1403 | \r |
1404 | //\r | |
1405 | // Register notify for Form package update\r | |
1406 | //\r | |
1407 | Status = mHiiDatabase->RegisterPackageNotify (\r | |
1408 | mHiiDatabase,\r | |
8d00a0f1 | 1409 | EFI_HII_PACKAGE_FORMS,\r |
7936fb6a | 1410 | NULL,\r |
1411 | FormUpdateNotify,\r | |
1412 | EFI_HII_DATABASE_NOTIFY_REMOVE_PACK,\r | |
1413 | &NotifyHandle\r | |
1414 | );\r | |
1415 | if (EFI_ERROR (Status)) {\r | |
1416 | return Status;\r | |
1417 | }\r | |
1418 | \r | |
d66e6c16 | 1419 | //\r |
1420 | // Initialize current settings of Questions in this FormSet\r | |
1421 | //\r | |
1422 | Status = InitializeCurrentSetting (Selection->FormSet);\r | |
1423 | if (EFI_ERROR (Status)) {\r | |
d66e6c16 | 1424 | goto Done;\r |
1425 | }\r | |
1426 | \r | |
48a9d5f7 LG |
1427 | //\r |
1428 | // Update gOldFormSet on maintain back up FormSet list.\r | |
1429 | // And, make gOldFormSet point to current FormSet. \r | |
1430 | //\r | |
1431 | if (gOldFormSet != NULL) {\r | |
1432 | RemoveEntryList (&gOldFormSet->Link);\r | |
1433 | DestroyFormSet (gOldFormSet);\r | |
1434 | }\r | |
1435 | gOldFormSet = Selection->FormSet;\r | |
1436 | InsertTailList (&gBrowserFormSetList, &gOldFormSet->Link);\r | |
1437 | \r | |
7936fb6a | 1438 | do {\r |
54f8fc6d ED |
1439 | //\r |
1440 | // IFR is updated, force to reparse the IFR binary\r | |
1441 | //\r | |
1442 | if (mHiiPackageListUpdated) {\r | |
1443 | Selection->Action = UI_ACTION_REFRESH_FORMSET;\r | |
1444 | mHiiPackageListUpdated = FALSE;\r | |
1445 | break;\r | |
1446 | }\r | |
1447 | \r | |
7936fb6a | 1448 | //\r |
1449 | // Initialize Selection->Form\r | |
1450 | //\r | |
1451 | if (Selection->FormId == 0) {\r | |
1452 | //\r | |
1453 | // Zero FormId indicates display the first Form in a FormSet\r | |
1454 | //\r | |
1455 | Link = GetFirstNode (&Selection->FormSet->FormListHead);\r | |
1456 | \r | |
1457 | Selection->Form = FORM_BROWSER_FORM_FROM_LINK (Link);\r | |
1458 | Selection->FormId = Selection->Form->FormId;\r | |
1459 | } else {\r | |
1460 | Selection->Form = IdToForm (Selection->FormSet, Selection->FormId);\r | |
1461 | }\r | |
1462 | \r | |
0a1147ed LG |
1463 | if (Selection->Form == NULL) {\r |
1464 | //\r | |
1465 | // No Form to display\r | |
1466 | //\r | |
13ad1def LG |
1467 | Status = EFI_NOT_FOUND;\r |
1468 | goto Done;\r | |
0a1147ed LG |
1469 | }\r |
1470 | \r | |
0c66bc76 LG |
1471 | //\r |
1472 | // Check Form is suppressed.\r | |
1473 | //\r | |
1474 | if (Selection->Form->SuppressExpression != NULL) {\r | |
31585af4 | 1475 | if (EvaluateExpressionList(Selection->Form->SuppressExpression, TRUE, Selection->FormSet, Selection->Form) == ExpressSuppress) {\r |
0c66bc76 LG |
1476 | //\r |
1477 | // Form is suppressed. \r | |
1478 | //\r | |
1479 | do {\r | |
1480 | CreateDialog (4, TRUE, 0, NULL, &Key, gEmptyString, gFormSuppress, gPressEnter, gEmptyString);\r | |
1481 | } while (Key.UnicodeChar != CHAR_CARRIAGE_RETURN);\r | |
1482 | \r | |
13ad1def LG |
1483 | Status = EFI_NOT_FOUND;\r |
1484 | goto Done;\r | |
0c66bc76 LG |
1485 | }\r |
1486 | }\r | |
5adb8db7 | 1487 | \r |
5adb8db7 LG |
1488 | //\r |
1489 | // Before display new form, invoke ConfigAccess.Callback() with EFI_BROWSER_ACTION_FORM_OPEN\r | |
1490 | // for each question with callback flag.\r | |
1491 | // New form may be the first form, or the different form after another form close.\r | |
1492 | //\r | |
13ad1def LG |
1493 | if ((ConfigAccess != NULL) &&\r |
1494 | ((Selection->Handle != mCurrentHiiHandle) ||\r | |
1495 | (!CompareGuid (&Selection->FormSetGuid, &mCurrentFormSetGuid)) ||\r | |
1496 | (Selection->FormId != mCurrentFormId))) {\r | |
1497 | \r | |
1498 | //\r | |
1499 | // Keep current form information\r | |
1500 | //\r | |
1501 | mCurrentHiiHandle = Selection->Handle;\r | |
1502 | CopyGuid (&mCurrentFormSetGuid, &Selection->FormSetGuid);\r | |
1503 | mCurrentFormId = Selection->FormId;\r | |
1504 | \r | |
b18e7050 ED |
1505 | Status = ProcessCallBackFunction (Selection, NULL, EFI_BROWSER_ACTION_FORM_OPEN, FALSE);\r |
1506 | if (EFI_ERROR (Status)) {\r | |
1507 | goto Done;\r | |
5adb8db7 | 1508 | }\r |
b18e7050 | 1509 | \r |
5adb8db7 LG |
1510 | //\r |
1511 | // EXIT requests to close form.\r | |
1512 | //\r | |
1513 | if (Selection->Action == UI_ACTION_EXIT) {\r | |
1514 | goto Done;\r | |
1515 | }\r | |
1516 | //\r | |
1517 | // IFR is updated during callback of open form, force to reparse the IFR binary\r | |
1518 | //\r | |
1519 | if (mHiiPackageListUpdated) {\r | |
1520 | Selection->Action = UI_ACTION_REFRESH_FORMSET;\r | |
1521 | mHiiPackageListUpdated = FALSE;\r | |
6a05469c | 1522 | break;\r |
5adb8db7 LG |
1523 | }\r |
1524 | }\r | |
1525 | \r | |
7936fb6a | 1526 | //\r |
1527 | // Load Questions' Value for display\r | |
1528 | //\r | |
eccfeab1 | 1529 | Status = LoadFormSetConfig (Selection, Selection->FormSet);\r |
7936fb6a | 1530 | if (EFI_ERROR (Status)) {\r |
13ad1def | 1531 | goto Done;\r |
7936fb6a | 1532 | }\r |
1533 | \r | |
5adb8db7 LG |
1534 | //\r |
1535 | // EXIT requests to close form.\r | |
1536 | //\r | |
1537 | if (Selection->Action == UI_ACTION_EXIT) {\r | |
1538 | goto Done;\r | |
1539 | }\r | |
eccfeab1 LG |
1540 | //\r |
1541 | // IFR is updated during callback of read value, force to reparse the IFR binary\r | |
1542 | //\r | |
1543 | if (mHiiPackageListUpdated) {\r | |
1544 | Selection->Action = UI_ACTION_REFRESH_FORMSET;\r | |
1545 | mHiiPackageListUpdated = FALSE;\r | |
6a05469c | 1546 | break;\r |
eccfeab1 LG |
1547 | }\r |
1548 | \r | |
d02847d3 | 1549 | //\r |
1550 | // Displays the Header and Footer borders\r | |
1551 | //\r | |
b00964a9 | 1552 | DisplayPageFrame (Selection);\r |
d02847d3 | 1553 | \r |
7936fb6a | 1554 | //\r |
1555 | // Display form\r | |
1556 | //\r | |
1557 | Status = DisplayForm (Selection);\r | |
1558 | if (EFI_ERROR (Status)) {\r | |
13ad1def | 1559 | goto Done;\r |
7936fb6a | 1560 | }\r |
1561 | \r | |
1562 | //\r | |
1563 | // Check Selected Statement (if press ESC, Selection->Statement will be NULL)\r | |
1564 | //\r | |
1565 | Statement = Selection->Statement;\r | |
1566 | if (Statement != NULL) {\r | |
1567 | if ((Statement->QuestionFlags & EFI_IFR_FLAG_RESET_REQUIRED) == EFI_IFR_FLAG_RESET_REQUIRED) {\r | |
1568 | gResetRequired = TRUE;\r | |
1569 | }\r | |
1570 | \r | |
13ad1def LG |
1571 | if ((ConfigAccess != NULL) && \r |
1572 | ((Statement->QuestionFlags & EFI_IFR_FLAG_CALLBACK) == EFI_IFR_FLAG_CALLBACK) && \r | |
1573 | (Statement->Operand != EFI_IFR_PASSWORD_OP)) {\r | |
b18e7050 | 1574 | Status = ProcessCallBackFunction(Selection, Statement, EFI_BROWSER_ACTION_CHANGING, FALSE); \r |
8ca6180f ED |
1575 | if (Statement->Operand == EFI_IFR_REF_OP && Selection->Action != UI_ACTION_EXIT) {\r |
1576 | //\r | |
1577 | // Process dynamic update ref opcode.\r | |
1578 | //\r | |
1579 | if (!EFI_ERROR (Status)) {\r | |
1580 | Status = ProcessGotoOpCode(Statement, Selection, NULL, NULL);\r | |
1581 | }\r | |
1582 | \r | |
3dde743f | 1583 | //\r |
8ca6180f | 1584 | // Callback return error status or status return from process goto opcode.\r |
3dde743f | 1585 | //\r |
8ca6180f | 1586 | if (EFI_ERROR (Status)) {\r |
3dde743f | 1587 | //\r |
1588 | // Cross reference will not be taken\r | |
1589 | //\r | |
1590 | Selection->FormId = Selection->Form->FormId;\r | |
1591 | Selection->QuestionId = 0;\r | |
1592 | }\r | |
7936fb6a | 1593 | }\r |
b7891584 | 1594 | \r |
3a4e7a3e | 1595 | if (!EFI_ERROR (Status) && Statement->Operand != EFI_IFR_REF_OP) {\r |
b7891584 ED |
1596 | ProcessCallBackFunction(Selection, Statement, EFI_BROWSER_ACTION_CHANGED, FALSE);\r |
1597 | }\r | |
7936fb6a | 1598 | }\r |
7936fb6a | 1599 | }\r |
7936fb6a | 1600 | \r |
5adb8db7 LG |
1601 | //\r |
1602 | // Before exit the form, invoke ConfigAccess.Callback() with EFI_BROWSER_ACTION_FORM_CLOSE\r | |
1603 | // for each question with callback flag.\r | |
1604 | //\r | |
5adb8db7 LG |
1605 | if ((ConfigAccess != NULL) && \r |
1606 | ((Selection->Action == UI_ACTION_EXIT) || \r | |
13ad1def LG |
1607 | (Selection->Handle != mCurrentHiiHandle) ||\r |
1608 | (!CompareGuid (&Selection->FormSetGuid, &mCurrentFormSetGuid)) ||\r | |
1609 | (Selection->FormId != mCurrentFormId))) {\r | |
f4a2af1f | 1610 | \r |
b18e7050 ED |
1611 | Status = ProcessCallBackFunction (Selection, NULL, EFI_BROWSER_ACTION_FORM_CLOSE, FALSE);\r |
1612 | if (EFI_ERROR (Status)) {\r | |
1613 | goto Done;\r | |
f4a2af1f | 1614 | }\r |
1615 | }\r | |
5adb8db7 | 1616 | } while (Selection->Action == UI_ACTION_REFRESH_FORM);\r |
f4a2af1f | 1617 | \r |
d66e6c16 | 1618 | Done:\r |
13ad1def LG |
1619 | //\r |
1620 | // Reset current form information to the initial setting when error happens or form exit.\r | |
1621 | //\r | |
1622 | if (EFI_ERROR (Status) || Selection->Action == UI_ACTION_EXIT) {\r | |
1623 | mCurrentHiiHandle = NULL;\r | |
1624 | CopyGuid (&mCurrentFormSetGuid, &gZeroGuid);\r | |
1625 | mCurrentFormId = 0;\r | |
1626 | }\r | |
1627 | \r | |
7936fb6a | 1628 | //\r |
1629 | // Unregister notify for Form package update\r | |
1630 | //\r | |
13ad1def LG |
1631 | mHiiDatabase->UnregisterPackageNotify (\r |
1632 | mHiiDatabase,\r | |
1633 | NotifyHandle\r | |
1634 | );\r | |
7936fb6a | 1635 | return Status;\r |
1636 | }\r |