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