]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Universal/DisplayEngineDxe/FormDisplay.c
MdeModulePkg:Support delete key
[mirror_edk2.git] / MdeModulePkg / Universal / DisplayEngineDxe / FormDisplay.c
CommitLineData
7c6c064c
ED
1/** @file\r
2Entry and initialization module for the browser.\r
3\r
23c7d425 4Copyright (c) 2007 - 2015, Intel Corporation. All rights reserved.<BR>\r
c4866c77 5Copyright (c) 2014, Hewlett-Packard Development Company, L.P.<BR>\r
7c6c064c
ED
6This program and the accompanying materials\r
7are licensed and made available under the terms and conditions of the BSD License\r
8which accompanies this distribution. The full text of the license may be found at\r
9http://opensource.org/licenses/bsd-license.php\r
10\r
11THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13\r
14**/\r
15\r
16#include "FormDisplay.h"\r
17\r
18//\r
19// Search table for UiDisplayMenu()\r
20//\r
21SCAN_CODE_TO_SCREEN_OPERATION gScanCodeToOperation[] = {\r
22 {\r
23 SCAN_UP,\r
24 UiUp,\r
25 },\r
26 {\r
27 SCAN_DOWN,\r
28 UiDown,\r
29 },\r
30 {\r
31 SCAN_PAGE_UP,\r
32 UiPageUp,\r
33 },\r
34 {\r
35 SCAN_PAGE_DOWN,\r
36 UiPageDown,\r
37 },\r
38 {\r
39 SCAN_ESC,\r
40 UiReset,\r
41 },\r
42 {\r
43 SCAN_LEFT,\r
44 UiLeft,\r
45 },\r
46 {\r
47 SCAN_RIGHT,\r
48 UiRight,\r
49 }\r
50};\r
51\r
52UINTN mScanCodeNumber = sizeof (gScanCodeToOperation) / sizeof (gScanCodeToOperation[0]);\r
53\r
54SCREEN_OPERATION_T0_CONTROL_FLAG gScreenOperationToControlFlag[] = {\r
55 {\r
56 UiNoOperation,\r
57 CfUiNoOperation,\r
58 },\r
59 {\r
60 UiSelect,\r
61 CfUiSelect,\r
62 },\r
63 {\r
64 UiUp,\r
65 CfUiUp,\r
66 },\r
67 {\r
68 UiDown,\r
69 CfUiDown,\r
70 },\r
71 {\r
72 UiLeft,\r
73 CfUiLeft,\r
74 },\r
75 {\r
76 UiRight,\r
77 CfUiRight,\r
78 },\r
79 {\r
80 UiReset,\r
81 CfUiReset,\r
82 },\r
83 {\r
84 UiPageUp,\r
85 CfUiPageUp,\r
86 },\r
87 {\r
88 UiPageDown,\r
89 CfUiPageDown\r
90 }, \r
91 {\r
92 UiHotKey,\r
93 CfUiHotKey\r
94 }\r
95};\r
96\r
97EFI_GUID gDisplayEngineGuid = {\r
98 0xE38C1029, 0xE38F, 0x45b9, {0x8F, 0x0D, 0xE2, 0xE6, 0x0B, 0xC9, 0xB2, 0x62}\r
99};\r
100\r
42645c3d 101BOOLEAN gMisMatch;\r
7c6c064c 102EFI_SCREEN_DESCRIPTOR gStatementDimensions;\r
7c6c064c
ED
103BOOLEAN mStatementLayoutIsChanged = TRUE;\r
104USER_INPUT *gUserInput;\r
105FORM_DISPLAY_ENGINE_FORM *gFormData;\r
106EFI_HII_HANDLE gHiiHandle;\r
107UINT16 gDirection;\r
108LIST_ENTRY gMenuOption;\r
109DISPLAY_HIGHLIGHT_MENU_INFO gHighligthMenuInfo = {0};\r
5a9f73bf
ED
110BOOLEAN mIsFirstForm = TRUE;\r
111FORM_ENTRY_INFO gOldFormEntry = {0};\r
7c6c064c
ED
112\r
113//\r
114// Browser Global Strings\r
115//\r
116CHAR16 *gFormNotFound;\r
117CHAR16 *gNoSubmitIf;\r
118CHAR16 *gBrwoserError;\r
119CHAR16 *gSaveFailed;\r
4d4deaac
ED
120CHAR16 *gNoSubmitIfFailed;\r
121CHAR16 *gSaveProcess;\r
122CHAR16 *gSaveNoSubmitProcess;\r
123CHAR16 *gDiscardChange;\r
124CHAR16 *gJumpToFormSet;\r
125CHAR16 *gCheckError;\r
7c6c064c
ED
126CHAR16 *gPromptForData;\r
127CHAR16 *gPromptForPassword;\r
128CHAR16 *gPromptForNewPassword;\r
129CHAR16 *gConfirmPassword;\r
130CHAR16 *gConfirmError;\r
131CHAR16 *gPassowordInvalid;\r
132CHAR16 *gPressEnter;\r
133CHAR16 *gEmptyString;\r
134CHAR16 *gMiniString;\r
135CHAR16 *gOptionMismatch;\r
136CHAR16 *gFormSuppress;\r
137CHAR16 *gProtocolNotFound;\r
23c7d425
ED
138CHAR16 *gConfirmDefaultMsg;\r
139CHAR16 *gConfirmSubmitMsg;\r
140CHAR16 *gConfirmDiscardMsg;\r
141CHAR16 *gConfirmResetMsg;\r
142CHAR16 *gConfirmExitMsg;\r
143CHAR16 *gConfirmSubmitMsg2nd;\r
144CHAR16 *gConfirmDefaultMsg2nd;\r
145CHAR16 *gConfirmResetMsg2nd;\r
146CHAR16 *gConfirmExitMsg2nd;\r
147CHAR16 *gConfirmOpt;\r
148CHAR16 *gConfirmOptYes;\r
149CHAR16 *gConfirmOptNo;\r
150CHAR16 *gConfirmMsgConnect;\r
151CHAR16 *gConfirmMsgEnd;\r
af047db7 152CHAR16 gModalSkipColumn;\r
7c6c064c
ED
153CHAR16 gPromptBlockWidth;\r
154CHAR16 gOptionBlockWidth;\r
155CHAR16 gHelpBlockWidth;\r
156CHAR16 *mUnknownString;\r
157\r
158FORM_DISPLAY_DRIVER_PRIVATE_DATA mPrivateData = {\r
159 FORM_DISPLAY_DRIVER_SIGNATURE,\r
160 NULL,\r
161 {\r
162 FormDisplay,\r
5a9f73bf 163 DriverClearDisplayPage,\r
7c6c064c
ED
164 ConfirmDataChange\r
165 }\r
166};\r
167\r
168\r
169/**\r
170 Get the string based on the StringId and HII Package List Handle.\r
171\r
172 @param Token The String's ID.\r
173 @param HiiHandle The package list in the HII database to search for\r
174 the specified string.\r
175\r
176 @return The output string.\r
177\r
178**/\r
179CHAR16 *\r
180GetToken (\r
181 IN EFI_STRING_ID Token,\r
182 IN EFI_HII_HANDLE HiiHandle\r
183 )\r
184{\r
185 EFI_STRING String;\r
186\r
187 String = HiiGetString (HiiHandle, Token, NULL);\r
188 if (String == NULL) {\r
189 String = AllocateCopyPool (StrSize (mUnknownString), mUnknownString);\r
190 ASSERT (String != NULL);\r
191 }\r
192\r
193 return (CHAR16 *) String;\r
194}\r
195\r
196\r
197/**\r
198 Initialize the HII String Token to the correct values.\r
199\r
200**/\r
201VOID\r
202InitializeDisplayStrings (\r
203 VOID\r
204 )\r
205{\r
206 mUnknownString = GetToken (STRING_TOKEN (UNKNOWN_STRING), gHiiHandle);\r
207 gSaveFailed = GetToken (STRING_TOKEN (SAVE_FAILED), gHiiHandle);\r
4d4deaac
ED
208 gNoSubmitIfFailed = GetToken (STRING_TOKEN (NO_SUBMIT_IF_CHECK_FAILED), gHiiHandle);\r
209 gSaveProcess = GetToken (STRING_TOKEN (DISCARD_OR_JUMP), gHiiHandle);\r
210 gSaveNoSubmitProcess = GetToken (STRING_TOKEN (DISCARD_OR_CHECK), gHiiHandle);\r
211 gDiscardChange = GetToken (STRING_TOKEN (DISCARD_OR_JUMP_DISCARD), gHiiHandle);\r
212 gJumpToFormSet = GetToken (STRING_TOKEN (DISCARD_OR_JUMP_JUMP), gHiiHandle);\r
213 gCheckError = GetToken (STRING_TOKEN (DISCARD_OR_CHECK_CHECK), gHiiHandle);\r
7c6c064c
ED
214 gPromptForData = GetToken (STRING_TOKEN (PROMPT_FOR_DATA), gHiiHandle);\r
215 gPromptForPassword = GetToken (STRING_TOKEN (PROMPT_FOR_PASSWORD), gHiiHandle);\r
216 gPromptForNewPassword = GetToken (STRING_TOKEN (PROMPT_FOR_NEW_PASSWORD), gHiiHandle);\r
217 gConfirmPassword = GetToken (STRING_TOKEN (CONFIRM_PASSWORD), gHiiHandle);\r
218 gConfirmError = GetToken (STRING_TOKEN (CONFIRM_ERROR), gHiiHandle);\r
219 gPassowordInvalid = GetToken (STRING_TOKEN (PASSWORD_INVALID), gHiiHandle);\r
220 gPressEnter = GetToken (STRING_TOKEN (PRESS_ENTER), gHiiHandle);\r
221 gEmptyString = GetToken (STRING_TOKEN (EMPTY_STRING), gHiiHandle);\r
222 gMiniString = GetToken (STRING_TOKEN (MINI_STRING), gHiiHandle);\r
223 gOptionMismatch = GetToken (STRING_TOKEN (OPTION_MISMATCH), gHiiHandle);\r
224 gFormSuppress = GetToken (STRING_TOKEN (FORM_SUPPRESSED), gHiiHandle);\r
225 gProtocolNotFound = GetToken (STRING_TOKEN (PROTOCOL_NOT_FOUND), gHiiHandle);\r
226 gFormNotFound = GetToken (STRING_TOKEN (STATUS_BROWSER_FORM_NOT_FOUND), gHiiHandle);\r
227 gNoSubmitIf = GetToken (STRING_TOKEN (STATUS_BROWSER_NO_SUBMIT_IF), gHiiHandle);\r
228 gBrwoserError = GetToken (STRING_TOKEN (STATUS_BROWSER_ERROR), gHiiHandle);\r
23c7d425
ED
229 gConfirmDefaultMsg = GetToken (STRING_TOKEN (CONFIRM_DEFAULT_MESSAGE), gHiiHandle);\r
230 gConfirmDiscardMsg = GetToken (STRING_TOKEN (CONFIRM_DISCARD_MESSAGE), gHiiHandle);\r
231 gConfirmSubmitMsg = GetToken (STRING_TOKEN (CONFIRM_SUBMIT_MESSAGE), gHiiHandle);\r
232 gConfirmResetMsg = GetToken (STRING_TOKEN (CONFIRM_RESET_MESSAGE), gHiiHandle);\r
233 gConfirmExitMsg = GetToken (STRING_TOKEN (CONFIRM_EXIT_MESSAGE), gHiiHandle);\r
234 gConfirmDefaultMsg2nd = GetToken (STRING_TOKEN (CONFIRM_DEFAULT_MESSAGE_2ND), gHiiHandle);\r
235 gConfirmSubmitMsg2nd = GetToken (STRING_TOKEN (CONFIRM_SUBMIT_MESSAGE_2ND), gHiiHandle);\r
236 gConfirmResetMsg2nd = GetToken (STRING_TOKEN (CONFIRM_RESET_MESSAGE_2ND), gHiiHandle);\r
237 gConfirmExitMsg2nd = GetToken (STRING_TOKEN (CONFIRM_EXIT_MESSAGE_2ND), gHiiHandle);\r
238 gConfirmOpt = GetToken (STRING_TOKEN (CONFIRM_OPTION), gHiiHandle);\r
239 gConfirmOptYes = GetToken (STRING_TOKEN (CONFIRM_OPTION_YES), gHiiHandle);\r
240 gConfirmOptNo = GetToken (STRING_TOKEN (CONFIRM_OPTION_NO), gHiiHandle);\r
241 gConfirmMsgConnect = GetToken (STRING_TOKEN (CONFIRM_OPTION_CONNECT), gHiiHandle);\r
242 gConfirmMsgEnd = GetToken (STRING_TOKEN (CONFIRM_OPTION_END), gHiiHandle);\r
7c6c064c
ED
243}\r
244\r
245/**\r
246 Free up the resource allocated for all strings required\r
247 by Setup Browser.\r
248\r
249**/\r
250VOID\r
251FreeDisplayStrings (\r
252 VOID\r
253 )\r
254{\r
255 FreePool (mUnknownString);\r
256 FreePool (gEmptyString);\r
257 FreePool (gSaveFailed);\r
4d4deaac
ED
258 FreePool (gNoSubmitIfFailed);\r
259 FreePool (gSaveProcess);\r
260 FreePool (gSaveNoSubmitProcess);\r
261 FreePool (gDiscardChange);\r
262 FreePool (gJumpToFormSet);\r
263 FreePool (gCheckError);\r
7c6c064c
ED
264 FreePool (gPromptForData);\r
265 FreePool (gPromptForPassword);\r
266 FreePool (gPromptForNewPassword);\r
267 FreePool (gConfirmPassword);\r
268 FreePool (gConfirmError);\r
269 FreePool (gPassowordInvalid);\r
270 FreePool (gPressEnter);\r
271 FreePool (gMiniString);\r
272 FreePool (gOptionMismatch);\r
273 FreePool (gFormSuppress);\r
274 FreePool (gProtocolNotFound);\r
275 FreePool (gBrwoserError);\r
276 FreePool (gNoSubmitIf);\r
277 FreePool (gFormNotFound);\r
23c7d425
ED
278 FreePool (gConfirmDefaultMsg);\r
279 FreePool (gConfirmSubmitMsg);\r
280 FreePool (gConfirmDiscardMsg);\r
281 FreePool (gConfirmResetMsg);\r
282 FreePool (gConfirmExitMsg);\r
283 FreePool (gConfirmDefaultMsg2nd);\r
284 FreePool (gConfirmSubmitMsg2nd);\r
285 FreePool (gConfirmResetMsg2nd);\r
286 FreePool (gConfirmExitMsg2nd);\r
287 FreePool (gConfirmOpt);\r
288 FreePool (gConfirmOptYes);\r
289 FreePool (gConfirmOptNo);\r
290 FreePool (gConfirmMsgConnect);\r
291 FreePool (gConfirmMsgEnd);\r
7c6c064c
ED
292}\r
293\r
294/**\r
295 Get prompt string id from the opcode data buffer.\r
296\r
297 @param OpCode The input opcode buffer.\r
298\r
299 @return The prompt string id.\r
300\r
301**/\r
302EFI_STRING_ID\r
303GetPrompt (\r
304 IN EFI_IFR_OP_HEADER *OpCode\r
305 )\r
306{\r
307 EFI_IFR_STATEMENT_HEADER *Header;\r
308\r
309 if (OpCode->Length <= sizeof (EFI_IFR_OP_HEADER)) {\r
310 return 0;\r
311 }\r
312\r
313 Header = (EFI_IFR_STATEMENT_HEADER *) (OpCode + 1);\r
314\r
315 return Header->Prompt;\r
316}\r
317\r
318/**\r
319 Get the supported width for a particular op-code\r
320\r
6f05c023 321 @param MenuOption The menu option.\r
af047db7 322 @param AdjustWidth The width which is saved for the space.\r
7c6c064c
ED
323\r
324 @return Returns the number of CHAR16 characters that is support.\r
325\r
326**/\r
327UINT16\r
328GetWidth (\r
6f05c023
ED
329 IN UI_MENU_OPTION *MenuOption,\r
330 OUT UINT16 *AdjustWidth\r
7c6c064c
ED
331 )\r
332{\r
6f05c023
ED
333 CHAR16 *String;\r
334 UINTN Size;\r
335 EFI_IFR_TEXT *TestOp;\r
336 UINT16 ReturnWidth;\r
337 FORM_DISPLAY_ENGINE_STATEMENT *Statement;\r
338\r
339 Statement = MenuOption->ThisTag;\r
7c6c064c 340\r
af047db7
ED
341 //\r
342 // For modal form, clean the entire row.\r
343 //\r
344 if ((gFormData->Attribute & HII_DISPLAY_MODAL) != 0) {\r
ae4f5746
ED
345 if (AdjustWidth != NULL) {\r
346 *AdjustWidth = LEFT_SKIPPED_COLUMNS;\r
347 }\r
348 return (UINT16)(gStatementDimensions.RightColumn - gStatementDimensions.LeftColumn - 2 * (gModalSkipColumn + LEFT_SKIPPED_COLUMNS));\r
af047db7
ED
349 }\r
350\r
7c6c064c
ED
351 Size = 0;\r
352\r
353 //\r
354 // See if the second text parameter is really NULL\r
355 //\r
356 if (Statement->OpCode->OpCode == EFI_IFR_TEXT_OP) {\r
357 TestOp = (EFI_IFR_TEXT *) Statement->OpCode;\r
358 if (TestOp->TextTwo != 0) {\r
359 String = GetToken (TestOp->TextTwo, gFormData->HiiHandle);\r
360 Size = StrLen (String);\r
361 FreePool (String);\r
362 }\r
363 }\r
364\r
365 if ((Statement->OpCode->OpCode == EFI_IFR_SUBTITLE_OP) ||\r
366 (Statement->OpCode->OpCode == EFI_IFR_REF_OP) ||\r
367 (Statement->OpCode->OpCode == EFI_IFR_PASSWORD_OP) ||\r
368 (Statement->OpCode->OpCode == EFI_IFR_ACTION_OP) ||\r
369 (Statement->OpCode->OpCode == EFI_IFR_RESET_BUTTON_OP) ||\r
370 //\r
371 // Allow a wide display if text op-code and no secondary text op-code\r
372 //\r
373 ((Statement->OpCode->OpCode == EFI_IFR_TEXT_OP) && (Size == 0))\r
374 ) {\r
af047db7
ED
375 \r
376 //\r
377 // Return the space width.\r
378 // \r
379 if (AdjustWidth != NULL) {\r
380 *AdjustWidth = 2;\r
381 }\r
382 //\r
383 // Keep consistent with current behavior.\r
384 //\r
6f05c023
ED
385 ReturnWidth = (UINT16) (gPromptBlockWidth + gOptionBlockWidth - 2);\r
386 } else {\r
387 if (AdjustWidth != NULL) {\r
388 *AdjustWidth = 1;\r
389 }\r
390\r
391 ReturnWidth = (UINT16) (gPromptBlockWidth - 1);\r
7c6c064c
ED
392 }\r
393\r
6f05c023
ED
394 //\r
395 // For nest in statement, should the subtitle indent.\r
396 //\r
397 if (MenuOption->NestInStatement) {\r
398 ReturnWidth -= SUBTITLE_INDENT;\r
af047db7 399 }\r
6f05c023
ED
400\r
401 return ReturnWidth;\r
7c6c064c
ED
402}\r
403\r
404/**\r
405 Will copy LineWidth amount of a string in the OutputString buffer and return the\r
406 number of CHAR16 characters that were copied into the OutputString buffer.\r
407 The output string format is:\r
408 Glyph Info + String info + '\0'.\r
409\r
410 In the code, it deals \r,\n,\r\n same as \n\r, also it not process the \r or \g.\r
411\r
412 @param InputString String description for this option.\r
413 @param LineWidth Width of the desired string to extract in CHAR16\r
414 characters\r
415 @param GlyphWidth The glyph width of the begin of the char in the string.\r
416 @param Index Where in InputString to start the copy process\r
417 @param OutputString Buffer to copy the string into\r
418\r
419 @return Returns the number of CHAR16 characters that were copied into the OutputString \r
420 buffer, include extra glyph info and '\0' info.\r
421\r
422**/\r
423UINT16\r
424GetLineByWidth (\r
425 IN CHAR16 *InputString,\r
426 IN UINT16 LineWidth,\r
427 IN OUT UINT16 *GlyphWidth,\r
428 IN OUT UINTN *Index,\r
429 OUT CHAR16 **OutputString\r
430 )\r
431{\r
432 UINT16 StrOffset;\r
433 UINT16 GlyphOffset;\r
434 UINT16 OriginalGlyphWidth;\r
435 BOOLEAN ReturnFlag;\r
436 UINT16 LastSpaceOffset;\r
437 UINT16 LastGlyphWidth;\r
438\r
439 if (InputString == NULL || Index == NULL || OutputString == NULL) {\r
440 return 0;\r
441 }\r
442\r
443 if (LineWidth == 0 || *GlyphWidth == 0) {\r
444 return 0;\r
445 }\r
446\r
447 //\r
448 // Save original glyph width.\r
449 //\r
450 OriginalGlyphWidth = *GlyphWidth;\r
451 LastGlyphWidth = OriginalGlyphWidth;\r
452 ReturnFlag = FALSE;\r
453 LastSpaceOffset = 0;\r
454\r
455 //\r
456 // NARROW_CHAR can not be printed in screen, so if a line only contain the two CHARs: 'NARROW_CHAR + CHAR_CARRIAGE_RETURN' , it is a empty line in Screen.\r
457 // To avoid displaying this empty line in screen, just skip the two CHARs here.\r
458 //\r
459 if ((InputString[*Index] == NARROW_CHAR) && (InputString[*Index + 1] == CHAR_CARRIAGE_RETURN)) {\r
460 *Index = *Index + 2;\r
461 }\r
462\r
463 //\r
464 // Fast-forward the string and see if there is a carriage-return in the string\r
465 //\r
466 for (StrOffset = 0, GlyphOffset = 0; GlyphOffset <= LineWidth; StrOffset++) {\r
467 switch (InputString[*Index + StrOffset]) {\r
468 case NARROW_CHAR:\r
469 *GlyphWidth = 1;\r
470 break;\r
471\r
472 case WIDE_CHAR:\r
473 *GlyphWidth = 2;\r
474 break;\r
475\r
476 case CHAR_CARRIAGE_RETURN:\r
477 case CHAR_LINEFEED:\r
478 case CHAR_NULL:\r
479 ReturnFlag = TRUE;\r
480 break;\r
481\r
482 default:\r
483 GlyphOffset = GlyphOffset + *GlyphWidth;\r
484\r
485 //\r
486 // Record the last space info in this line. Will be used in rewind.\r
487 //\r
488 if ((InputString[*Index + StrOffset] == CHAR_SPACE) && (GlyphOffset <= LineWidth)) {\r
489 LastSpaceOffset = StrOffset;\r
490 LastGlyphWidth = *GlyphWidth;\r
491 }\r
492 break;\r
493 }\r
494\r
495 if (ReturnFlag) {\r
496 break;\r
497 }\r
498 } \r
499\r
500 //\r
501 // Rewind the string from the maximum size until we see a space to break the line\r
502 //\r
503 if (GlyphOffset > LineWidth) {\r
504 //\r
505 // Rewind the string to last space char in this line.\r
506 //\r
507 if (LastSpaceOffset != 0) {\r
508 StrOffset = LastSpaceOffset;\r
509 *GlyphWidth = LastGlyphWidth;\r
510 } else {\r
511 //\r
512 // Roll back to last char in the line width.\r
513 //\r
514 StrOffset--;\r
515 }\r
516 }\r
517\r
518 //\r
519 // The CHAR_NULL has process last time, this time just return 0 to stand for the end.\r
520 //\r
521 if (StrOffset == 0 && (InputString[*Index + StrOffset] == CHAR_NULL)) {\r
522 return 0;\r
523 }\r
524\r
525 //\r
526 // Need extra glyph info and '\0' info, so +2.\r
527 //\r
528 *OutputString = AllocateZeroPool (((UINTN) (StrOffset + 2) * sizeof(CHAR16)));\r
529 if (*OutputString == NULL) {\r
530 return 0;\r
531 }\r
532\r
533 //\r
534 // Save the glyph info at the begin of the string, will used by Print function.\r
535 //\r
536 if (OriginalGlyphWidth == 1) {\r
537 *(*OutputString) = NARROW_CHAR;\r
538 } else {\r
539 *(*OutputString) = WIDE_CHAR;\r
540 }\r
541\r
542 CopyMem ((*OutputString) + 1, &InputString[*Index], StrOffset * sizeof(CHAR16));\r
543\r
544 if (InputString[*Index + StrOffset] == CHAR_SPACE) {\r
545 //\r
546 // Skip the space info at the begin of next line.\r
547 // \r
548 *Index = (UINT16) (*Index + StrOffset + 1);\r
549 } else if (InputString[*Index + StrOffset] == CHAR_LINEFEED) {\r
550 //\r
551 // Skip the /n or /n/r info.\r
552 //\r
553 if (InputString[*Index + StrOffset + 1] == CHAR_CARRIAGE_RETURN) {\r
554 *Index = (UINT16) (*Index + StrOffset + 2);\r
555 } else {\r
556 *Index = (UINT16) (*Index + StrOffset + 1);\r
557 }\r
558 } else if (InputString[*Index + StrOffset] == CHAR_CARRIAGE_RETURN) {\r
559 //\r
560 // Skip the /r or /r/n info.\r
561 // \r
562 if (InputString[*Index + StrOffset + 1] == CHAR_LINEFEED) {\r
563 *Index = (UINT16) (*Index + StrOffset + 2);\r
564 } else {\r
565 *Index = (UINT16) (*Index + StrOffset + 1);\r
566 }\r
567 } else {\r
568 *Index = (UINT16) (*Index + StrOffset);\r
569 }\r
570\r
571 //\r
572 // Include extra glyph info and '\0' info, so +2.\r
573 //\r
574 return StrOffset + 2;\r
575}\r
576\r
577/**\r
578 Add one menu option by specified description and context.\r
579\r
580 @param Statement Statement of this Menu Option.\r
581 @param MenuItemCount The index for this Option in the Menu.\r
582 @param NestIn Whether this statement is nest in another statement.\r
583\r
584**/\r
585VOID\r
586UiAddMenuOption (\r
587 IN FORM_DISPLAY_ENGINE_STATEMENT *Statement,\r
588 IN UINT16 *MenuItemCount,\r
589 IN BOOLEAN NestIn\r
590 )\r
591{\r
592 UI_MENU_OPTION *MenuOption;\r
593 UINTN Index;\r
594 UINTN Count;\r
595 CHAR16 *String;\r
596 UINT16 NumberOfLines;\r
597 UINT16 GlyphWidth;\r
598 UINT16 Width;\r
599 UINTN ArrayEntry;\r
600 CHAR16 *OutputString;\r
601 EFI_STRING_ID PromptId;\r
602\r
603 NumberOfLines = 1;\r
604 ArrayEntry = 0;\r
605 GlyphWidth = 1;\r
606 Count = 1;\r
607 MenuOption = NULL;\r
608\r
609 PromptId = GetPrompt (Statement->OpCode);\r
610 ASSERT (PromptId != 0);\r
611\r
612 String = GetToken (PromptId, gFormData->HiiHandle);\r
613 ASSERT (String != NULL);\r
614\r
7c6c064c 615 if (Statement->OpCode->OpCode == EFI_IFR_DATE_OP || Statement->OpCode->OpCode == EFI_IFR_TIME_OP) {\r
7c6c064c
ED
616 Count = 3;\r
617 }\r
618\r
619 for (Index = 0; Index < Count; Index++) {\r
620 MenuOption = AllocateZeroPool (sizeof (UI_MENU_OPTION));\r
621 ASSERT (MenuOption);\r
622\r
623 MenuOption->Signature = UI_MENU_OPTION_SIGNATURE;\r
624 MenuOption->Description = String;\r
625 MenuOption->Handle = gFormData->HiiHandle;\r
626 MenuOption->ThisTag = Statement;\r
627 MenuOption->NestInStatement = NestIn;\r
628 MenuOption->EntryNumber = *MenuItemCount;\r
629\r
7c6c064c
ED
630 MenuOption->Sequence = Index;\r
631\r
632 if ((Statement->Attribute & HII_DISPLAY_GRAYOUT) != 0) {\r
633 MenuOption->GrayOut = TRUE;\r
634 } else {\r
635 MenuOption->GrayOut = FALSE;\r
636 }\r
637\r
638 if ((Statement->Attribute & HII_DISPLAY_LOCK) != 0 || (gFormData->Attribute & HII_DISPLAY_LOCK) != 0) {\r
639 MenuOption->GrayOut = TRUE;\r
640 }\r
641\r
642 //\r
643 // If the form or the question has the lock attribute, deal same as grayout.\r
644 //\r
645 if ((gFormData->Attribute & HII_DISPLAY_LOCK) != 0 || (Statement->Attribute & HII_DISPLAY_LOCK) != 0) {\r
646 MenuOption->GrayOut = TRUE;\r
647 }\r
648\r
649 switch (Statement->OpCode->OpCode) {\r
650 case EFI_IFR_ORDERED_LIST_OP:\r
651 case EFI_IFR_ONE_OF_OP:\r
652 case EFI_IFR_NUMERIC_OP:\r
653 case EFI_IFR_TIME_OP:\r
654 case EFI_IFR_DATE_OP:\r
655 case EFI_IFR_CHECKBOX_OP:\r
656 case EFI_IFR_PASSWORD_OP:\r
657 case EFI_IFR_STRING_OP:\r
658 //\r
659 // User could change the value of these items\r
660 //\r
661 MenuOption->IsQuestion = TRUE;\r
662 break;\r
663 case EFI_IFR_TEXT_OP:\r
664 if (FeaturePcdGet (PcdBrowserGrayOutTextStatement)) {\r
665 //\r
666 // Initializing GrayOut option as TRUE for Text setup options \r
667 // so that those options will be Gray in colour and un selectable.\r
668 //\r
669 MenuOption->GrayOut = TRUE;\r
670 }\r
671 break;\r
672 default:\r
673 MenuOption->IsQuestion = FALSE;\r
674 break;\r
675 }\r
676\r
677 if ((Statement->Attribute & HII_DISPLAY_READONLY) != 0) {\r
678 MenuOption->ReadOnly = TRUE;\r
679 if (FeaturePcdGet (PcdBrowerGrayOutReadOnlyMenu)) {\r
680 MenuOption->GrayOut = TRUE;\r
681 }\r
682 }\r
683\r
6f05c023
ED
684 if (Index == 0 && \r
685 (Statement->OpCode->OpCode != EFI_IFR_DATE_OP) && \r
686 (Statement->OpCode->OpCode != EFI_IFR_TIME_OP)) {\r
687 Width = GetWidth (MenuOption, NULL);\r
688 for (; GetLineByWidth (String, Width, &GlyphWidth,&ArrayEntry, &OutputString) != 0x0000;) {\r
689 //\r
690 // If there is more string to process print on the next row and increment the Skip value\r
691 //\r
692 if (StrLen (&String[ArrayEntry]) != 0) {\r
693 NumberOfLines++;\r
694 }\r
695 FreePool (OutputString);\r
696 }\r
697 } else {\r
698 //\r
699 // Add three MenuOptions for Date/Time\r
700 // Data format : [01/02/2004] [11:22:33]\r
701 // Line number : 0 0 1 0 0 1\r
702 // \r
703 NumberOfLines = 0;\r
704 }\r
705\r
706 if (Index == 2) {\r
707 //\r
708 // Override LineNumber for the MenuOption in Date/Time sequence\r
709 //\r
710 MenuOption->Skip = 1;\r
711 } else {\r
712 MenuOption->Skip = NumberOfLines;\r
713 }\r
714\r
7c6c064c
ED
715 InsertTailList (&gMenuOption, &MenuOption->Link);\r
716 }\r
717\r
718 (*MenuItemCount)++;\r
719}\r
720\r
721/**\r
722 Create the menu list base on the form data info.\r
723\r
724**/\r
725VOID\r
726ConvertStatementToMenu (\r
727 VOID\r
728 )\r
729{\r
730 UINT16 MenuItemCount;\r
731 LIST_ENTRY *Link;\r
732 LIST_ENTRY *NestLink;\r
733 FORM_DISPLAY_ENGINE_STATEMENT *Statement;\r
734 FORM_DISPLAY_ENGINE_STATEMENT *NestStatement;\r
735\r
736 MenuItemCount = 0;\r
737 InitializeListHead (&gMenuOption);\r
738\r
739 Link = GetFirstNode (&gFormData->StatementListHead);\r
740 while (!IsNull (&gFormData->StatementListHead, Link)) {\r
741 Statement = FORM_DISPLAY_ENGINE_STATEMENT_FROM_LINK (Link);\r
742 Link = GetNextNode (&gFormData->StatementListHead, Link);\r
743\r
744 //\r
745 // Skip the opcode not recognized by Display core.\r
746 //\r
747 if (Statement->OpCode->OpCode == EFI_IFR_GUID_OP) {\r
748 continue;\r
749 }\r
750\r
751 UiAddMenuOption (Statement, &MenuItemCount, FALSE);\r
752\r
753 //\r
754 // Check the statement nest in this host statement.\r
755 //\r
756 NestLink = GetFirstNode (&Statement->NestStatementList);\r
757 while (!IsNull (&Statement->NestStatementList, NestLink)) {\r
758 NestStatement = FORM_DISPLAY_ENGINE_STATEMENT_FROM_LINK (NestLink);\r
759 NestLink = GetNextNode (&Statement->NestStatementList, NestLink);\r
760\r
077c7aee
ED
761 //\r
762 // Skip the opcode not recognized by Display core.\r
763 //\r
764 if (NestStatement->OpCode->OpCode == EFI_IFR_GUID_OP) {\r
765 continue;\r
766 }\r
767\r
7c6c064c
ED
768 UiAddMenuOption (NestStatement, &MenuItemCount, TRUE);\r
769 }\r
770 }\r
771}\r
772\r
773/**\r
774 Count the storage space of a Unicode string.\r
775\r
776 This function handles the Unicode string with NARROW_CHAR\r
777 and WIDE_CHAR control characters. NARROW_HCAR and WIDE_CHAR\r
778 does not count in the resultant output. If a WIDE_CHAR is\r
779 hit, then 2 Unicode character will consume an output storage\r
780 space with size of CHAR16 till a NARROW_CHAR is hit.\r
781\r
782 If String is NULL, then ASSERT ().\r
783\r
784 @param String The input string to be counted.\r
785\r
786 @return Storage space for the input string.\r
787\r
788**/\r
789UINTN\r
790GetStringWidth (\r
791 IN CHAR16 *String\r
792 )\r
793{\r
794 UINTN Index;\r
795 UINTN Count;\r
796 UINTN IncrementValue;\r
797\r
798 ASSERT (String != NULL);\r
799 if (String == NULL) {\r
800 return 0;\r
801 }\r
802\r
803 Index = 0;\r
804 Count = 0;\r
805 IncrementValue = 1;\r
806\r
807 do {\r
808 //\r
809 // Advance to the null-terminator or to the first width directive\r
810 //\r
811 for (;\r
812 (String[Index] != NARROW_CHAR) && (String[Index] != WIDE_CHAR) && (String[Index] != 0);\r
813 Index++, Count = Count + IncrementValue\r
814 )\r
815 ;\r
816\r
817 //\r
818 // We hit the null-terminator, we now have a count\r
819 //\r
820 if (String[Index] == 0) {\r
821 break;\r
822 }\r
823 //\r
824 // We encountered a narrow directive - strip it from the size calculation since it doesn't get printed\r
825 // and also set the flag that determines what we increment by.(if narrow, increment by 1, if wide increment by 2)\r
826 //\r
827 if (String[Index] == NARROW_CHAR) {\r
828 //\r
829 // Skip to the next character\r
830 //\r
831 Index++;\r
832 IncrementValue = 1;\r
833 } else {\r
834 //\r
835 // Skip to the next character\r
836 //\r
837 Index++;\r
838 IncrementValue = 2;\r
839 }\r
840 } while (String[Index] != 0);\r
841\r
842 //\r
843 // Increment by one to include the null-terminator in the size\r
844 //\r
845 Count++;\r
846\r
847 return Count * sizeof (CHAR16);\r
848}\r
849\r
850/**\r
851 Base on the input option string to update the skip value for a menu option.\r
852\r
853 @param MenuOption The MenuOption to be checked.\r
854 @param OptionString The input option string.\r
855\r
856**/\r
857VOID\r
858UpdateSkipInfoForMenu (\r
859 IN UI_MENU_OPTION *MenuOption,\r
860 IN CHAR16 *OptionString\r
861 )\r
862{\r
863 UINTN Index;\r
864 UINT16 Width;\r
865 UINTN Row;\r
866 CHAR16 *OutputString;\r
867 UINT16 GlyphWidth;\r
868\r
869 Width = (UINT16) gOptionBlockWidth;\r
870 GlyphWidth = 1;\r
871 Row = 1;\r
872\r
873 for (Index = 0; GetLineByWidth (OptionString, Width, &GlyphWidth, &Index, &OutputString) != 0x0000;) {\r
874 if (StrLen (&OptionString[Index]) != 0) {\r
875 Row++;\r
876 }\r
877\r
878 FreePool (OutputString);\r
879 }\r
880\r
881 if ((Row > MenuOption->Skip) && \r
882 (MenuOption->ThisTag->OpCode->OpCode != EFI_IFR_DATE_OP) && \r
883 (MenuOption->ThisTag->OpCode->OpCode != EFI_IFR_TIME_OP)) {\r
884 MenuOption->Skip = Row;\r
885 }\r
886}\r
887\r
888/**\r
889 Update display lines for a Menu Option.\r
890\r
891 @param MenuOption The MenuOption to be checked.\r
892\r
893**/\r
894VOID\r
895UpdateOptionSkipLines (\r
896 IN UI_MENU_OPTION *MenuOption\r
897 )\r
898{\r
899 CHAR16 *OptionString;\r
900\r
901 OptionString = NULL;\r
902\r
903 ProcessOptions (MenuOption, FALSE, &OptionString, TRUE);\r
904 if (OptionString != NULL) {\r
905 UpdateSkipInfoForMenu (MenuOption, OptionString);\r
906\r
907 FreePool (OptionString);\r
908 }\r
909\r
910 if ((MenuOption->ThisTag->OpCode->OpCode == EFI_IFR_TEXT_OP) && (((EFI_IFR_TEXT*)MenuOption->ThisTag->OpCode)->TextTwo != 0)) {\r
911 OptionString = GetToken (((EFI_IFR_TEXT*)MenuOption->ThisTag->OpCode)->TextTwo, gFormData->HiiHandle);\r
912\r
913 if (OptionString != NULL) {\r
914 UpdateSkipInfoForMenu (MenuOption, OptionString);\r
915\r
916 FreePool (OptionString);\r
917 }\r
918 }\r
919}\r
920\r
ab369468
ED
921/**\r
922 Check whether this Menu Option could be print.\r
923\r
924 Check Prompt string, option string or text two string not NULL.\r
925\r
926 This is an internal function.\r
927\r
928 @param MenuOption The MenuOption to be checked.\r
929\r
930 @retval TRUE This Menu Option is printable.\r
931 @retval FALSE This Menu Option could not be printable.\r
932\r
933**/\r
934BOOLEAN\r
935PrintableMenu (\r
936 UI_MENU_OPTION *MenuOption\r
937 )\r
938{\r
939 EFI_STATUS Status;\r
940 EFI_STRING OptionString;\r
941\r
942 OptionString = NULL;\r
943\r
944 if (MenuOption->Description[0] != '\0') {\r
945 return TRUE;\r
946 }\r
947\r
948 Status = ProcessOptions (MenuOption, FALSE, &OptionString, FALSE);\r
949 if (EFI_ERROR (Status)) {\r
950 return FALSE;\r
951 }\r
952 if (OptionString != NULL && OptionString[0] != '\0') {\r
953 FreePool (OptionString);\r
954 return TRUE;\r
955 }\r
956\r
957 if ((MenuOption->ThisTag->OpCode->OpCode == EFI_IFR_TEXT_OP) && (((EFI_IFR_TEXT*)MenuOption->ThisTag->OpCode)->TextTwo != 0)) {\r
958 OptionString = GetToken (((EFI_IFR_TEXT*)MenuOption->ThisTag->OpCode)->TextTwo, gFormData->HiiHandle);\r
959 ASSERT (OptionString != NULL);\r
960 if (OptionString[0] != '\0'){\r
961 FreePool (OptionString);\r
962 return TRUE;\r
963 }\r
964 }\r
965\r
966 return FALSE;\r
967}\r
968\r
7c6c064c
ED
969/**\r
970 Check whether this Menu Option could be highlighted.\r
971\r
972 This is an internal function.\r
973\r
974 @param MenuOption The MenuOption to be checked.\r
975\r
976 @retval TRUE This Menu Option is selectable.\r
977 @retval FALSE This Menu Option could not be selected.\r
978\r
979**/\r
980BOOLEAN\r
981IsSelectable (\r
982 UI_MENU_OPTION *MenuOption\r
983 )\r
984{\r
985 if ((MenuOption->ThisTag->OpCode->OpCode == EFI_IFR_SUBTITLE_OP) ||\r
ab369468 986 MenuOption->GrayOut || MenuOption->ReadOnly || !PrintableMenu (MenuOption)) {\r
7c6c064c
ED
987 return FALSE;\r
988 } else {\r
989 return TRUE;\r
990 }\r
991}\r
992\r
993/**\r
994 Move to next selectable statement.\r
995\r
996 This is an internal function.\r
997\r
998 @param GoUp The navigation direction. TRUE: up, FALSE: down.\r
999 @param CurrentPosition Current position.\r
1000 @param GapToTop Gap position to top or bottom.\r
ab369468 1001 @param FindInForm Whether find menu in current form or beyond.\r
7c6c064c
ED
1002\r
1003 @return The row distance from current MenuOption to next selectable MenuOption.\r
1004\r
1005 @retval -1 Reach the begin of the menu, still can't find the selectable menu.\r
ab369468
ED
1006 @retval Value Find the selectable menu, maybe the truly selectable, maybe the \r
1007 first menu showing beyond current form or last menu showing in \r
1008 current form.\r
1009 The value is the line number between the new selected menu and the\r
1010 current select menu, not include the new selected menu.\r
7c6c064c
ED
1011\r
1012**/\r
1013INTN\r
1014MoveToNextStatement (\r
1015 IN BOOLEAN GoUp,\r
1016 IN OUT LIST_ENTRY **CurrentPosition,\r
ab369468
ED
1017 IN UINTN GapToTop,\r
1018 IN BOOLEAN FindInForm\r
7c6c064c
ED
1019 )\r
1020{\r
1021 INTN Distance;\r
1022 LIST_ENTRY *Pos;\r
1023 UI_MENU_OPTION *NextMenuOption;\r
1024 UI_MENU_OPTION *PreMenuOption;\r
1025\r
1026 Distance = 0;\r
1027 Pos = *CurrentPosition;\r
ab369468
ED
1028\r
1029 if (Pos == &gMenuOption) {\r
1030 return -1;\r
1031 }\r
1032\r
7c6c064c
ED
1033 PreMenuOption = MENU_OPTION_FROM_LINK (Pos);\r
1034\r
1035 while (TRUE) {\r
1036 NextMenuOption = MENU_OPTION_FROM_LINK (Pos);\r
1037 //\r
1038 // NextMenuOption->Row == 0 means this menu has not calculate\r
1039 // the NextMenuOption->Skip value yet, just calculate here.\r
1040 //\r
1041 if (NextMenuOption->Row == 0) {\r
1042 UpdateOptionSkipLines (NextMenuOption);\r
1043 }\r
7c6c064c 1044\r
ab369468
ED
1045 if (IsSelectable (NextMenuOption)) {\r
1046 break;\r
7c6c064c
ED
1047 }\r
1048\r
ab369468
ED
1049 //\r
1050 // In this case, still can't find the selectable menu,\r
1051 // return the first one beyond the showing form.\r
1052 //\r
1053 if ((UINTN) Distance + NextMenuOption->Skip > GapToTop) {\r
1054 if (FindInForm) {\r
1055 NextMenuOption = PreMenuOption;\r
1056 }\r
7c6c064c
ED
1057 break;\r
1058 }\r
1059\r
ab369468
ED
1060 Distance += NextMenuOption->Skip;\r
1061\r
7c6c064c
ED
1062 //\r
1063 // Arrive at begin of the menu list.\r
1064 //\r
1065 if ((GoUp ? Pos->BackLink : Pos->ForwardLink) == &gMenuOption) {\r
1066 Distance = -1;\r
1067 break;\r
1068 }\r
1069\r
7c6c064c 1070 Pos = (GoUp ? Pos->BackLink : Pos->ForwardLink);\r
ab369468 1071 PreMenuOption = NextMenuOption;\r
7c6c064c
ED
1072 }\r
1073\r
1074 *CurrentPosition = &NextMenuOption->Link;\r
1075 return Distance;\r
1076}\r
1077\r
1078\r
1079/**\r
1080 Process option string for date/time opcode.\r
1081\r
1082 @param MenuOption Menu option point to date/time.\r
1083 @param OptionString Option string input for process.\r
1084 @param AddOptCol Whether need to update MenuOption->OptCol. \r
1085\r
1086**/\r
1087VOID \r
1088ProcessStringForDateTime (\r
1089 UI_MENU_OPTION *MenuOption,\r
1090 CHAR16 *OptionString,\r
1091 BOOLEAN AddOptCol\r
1092 )\r
1093{\r
1094 UINTN Index;\r
1095 UINTN Count;\r
1096 FORM_DISPLAY_ENGINE_STATEMENT *Statement;\r
1097 EFI_IFR_DATE *Date;\r
1098 EFI_IFR_TIME *Time;\r
1099\r
1100 ASSERT (MenuOption != NULL && OptionString != NULL);\r
1101 \r
1102 Statement = MenuOption->ThisTag;\r
1103 Date = NULL;\r
1104 Time = NULL;\r
1105 if (Statement->OpCode->OpCode == EFI_IFR_DATE_OP) {\r
1106 Date = (EFI_IFR_DATE *) Statement->OpCode;\r
1107 } else if (Statement->OpCode->OpCode == EFI_IFR_TIME_OP) {\r
1108 Time = (EFI_IFR_TIME *) Statement->OpCode;\r
1109 }\r
1110 \r
1111 //\r
1112 // If leading spaces on OptionString - remove the spaces\r
1113 //\r
1114 for (Index = 0; OptionString[Index] == L' '; Index++) {\r
1115 //\r
1116 // Base on the blockspace to get the option column info.\r
1117 //\r
1118 if (AddOptCol) {\r
1119 MenuOption->OptCol++;\r
1120 }\r
1121 }\r
1122 \r
1123 for (Count = 0; OptionString[Index] != CHAR_NULL; Index++) {\r
1124 OptionString[Count] = OptionString[Index];\r
1125 Count++;\r
1126 }\r
1127 OptionString[Count] = CHAR_NULL;\r
1128 \r
1129 //\r
1130 // Enable to suppress field in the opcode base on the flag.\r
1131 //\r
1132 if (Statement->OpCode->OpCode == EFI_IFR_DATE_OP) {\r
1133 //\r
1134 // OptionString format is: <**: **: ****>\r
1135 // |month|day|year|\r
1136 // 4 3 5\r
1137 //\r
1138 if ((Date->Flags & EFI_QF_DATE_MONTH_SUPPRESS) && (MenuOption->Sequence == 0)) {\r
1139 //\r
1140 // At this point, only "<**:" in the optionstring. \r
1141 // Clean the day's ** field, after clean, the format is "< :"\r
1142 //\r
1143 SetUnicodeMem (&OptionString[1], 2, L' ');\r
1144 } else if ((Date->Flags & EFI_QF_DATE_DAY_SUPPRESS) && (MenuOption->Sequence == 1)) {\r
1145 //\r
1146 // At this point, only "**:" in the optionstring. \r
1147 // Clean the month's "**" field, after clean, the format is " :"\r
1148 // \r
1149 SetUnicodeMem (&OptionString[0], 2, L' ');\r
1150 } else if ((Date->Flags & EFI_QF_DATE_YEAR_SUPPRESS) && (MenuOption->Sequence == 2)) {\r
1151 //\r
1152 // At this point, only "****>" in the optionstring. \r
1153 // Clean the year's "****" field, after clean, the format is " >"\r
1154 // \r
1155 SetUnicodeMem (&OptionString[0], 4, L' ');\r
1156 }\r
1157 } else if (Statement->OpCode->OpCode == EFI_IFR_TIME_OP) {\r
1158 //\r
1159 // OptionString format is: <**: **: **>\r
1160 // |hour|minute|second|\r
1161 // 4 3 3\r
1162 //\r
1163 if ((Time->Flags & QF_TIME_HOUR_SUPPRESS) && (MenuOption->Sequence == 0)) {\r
1164 //\r
1165 // At this point, only "<**:" in the optionstring. \r
1166 // Clean the hour's ** field, after clean, the format is "< :"\r
1167 //\r
1168 SetUnicodeMem (&OptionString[1], 2, L' ');\r
1169 } else if ((Time->Flags & QF_TIME_MINUTE_SUPPRESS) && (MenuOption->Sequence == 1)) {\r
1170 //\r
1171 // At this point, only "**:" in the optionstring. \r
1172 // Clean the minute's "**" field, after clean, the format is " :"\r
1173 // \r
1174 SetUnicodeMem (&OptionString[0], 2, L' ');\r
1175 } else if ((Time->Flags & QF_TIME_SECOND_SUPPRESS) && (MenuOption->Sequence == 2)) {\r
1176 //\r
1177 // At this point, only "**>" in the optionstring. \r
1178 // Clean the second's "**" field, after clean, the format is " >"\r
1179 // \r
1180 SetUnicodeMem (&OptionString[0], 2, L' ');\r
1181 }\r
1182 }\r
1183}\r
1184\r
1185\r
1186/**\r
1187 Adjust Data and Time position accordingly.\r
1188 Data format : [01/02/2004] [11:22:33]\r
1189 Line number : 0 0 1 0 0 1\r
1190\r
1191 This is an internal function.\r
1192\r
1193 @param DirectionUp the up or down direction. False is down. True is\r
1194 up.\r
1195 @param CurrentPosition Current position. On return: Point to the last\r
1196 Option (Year or Second) if up; Point to the first\r
1197 Option (Month or Hour) if down.\r
1198\r
1199 @return Return line number to pad. It is possible that we stand on a zero-advance\r
1200 @return data or time opcode, so pad one line when we judge if we are going to scroll outside.\r
1201\r
1202**/\r
1203UINTN\r
1204AdjustDateAndTimePosition (\r
1205 IN BOOLEAN DirectionUp,\r
1206 IN OUT LIST_ENTRY **CurrentPosition\r
1207 )\r
1208{\r
1209 UINTN Count;\r
1210 LIST_ENTRY *NewPosition;\r
1211 UI_MENU_OPTION *MenuOption;\r
1212 UINTN PadLineNumber;\r
1213\r
1214 PadLineNumber = 0;\r
1215 NewPosition = *CurrentPosition;\r
1216 MenuOption = MENU_OPTION_FROM_LINK (NewPosition);\r
1217\r
1218 if ((MenuOption->ThisTag->OpCode->OpCode == EFI_IFR_DATE_OP) ||\r
1219 (MenuOption->ThisTag->OpCode->OpCode == EFI_IFR_TIME_OP)) {\r
1220 //\r
1221 // Calculate the distance from current position to the last Date/Time MenuOption\r
1222 //\r
1223 Count = 0;\r
1224 while (MenuOption->Skip == 0) {\r
1225 Count++;\r
1226 NewPosition = NewPosition->ForwardLink;\r
1227 MenuOption = MENU_OPTION_FROM_LINK (NewPosition);\r
1228 PadLineNumber = 1;\r
1229 }\r
1230\r
1231 NewPosition = *CurrentPosition;\r
1232 if (DirectionUp) {\r
1233 //\r
1234 // Since the behavior of hitting the up arrow on a Date/Time MenuOption is intended\r
1235 // to be one that back to the previous set of MenuOptions, we need to advance to the first\r
1236 // Date/Time MenuOption and leave the remaining logic in CfUiUp intact so the appropriate\r
1237 // checking can be done.\r
1238 //\r
1239 while (Count++ < 2) {\r
1240 NewPosition = NewPosition->BackLink;\r
1241 }\r
1242 } else {\r
1243 //\r
1244 // Since the behavior of hitting the down arrow on a Date/Time MenuOption is intended\r
1245 // to be one that progresses to the next set of MenuOptions, we need to advance to the last\r
1246 // Date/Time MenuOption and leave the remaining logic in CfUiDown intact so the appropriate\r
1247 // checking can be done.\r
1248 //\r
1249 while (Count-- > 0) {\r
1250 NewPosition = NewPosition->ForwardLink;\r
1251 }\r
1252 }\r
1253\r
1254 *CurrentPosition = NewPosition;\r
1255 }\r
1256\r
1257 return PadLineNumber;\r
1258}\r
1259\r
1260/**\r
1261 Get step info from numeric opcode.\r
1262 \r
1263 @param[in] OpCode The input numeric op code.\r
1264\r
1265 @return step info for this opcode.\r
1266**/\r
1267UINT64\r
1268GetFieldFromNum (\r
1269 IN EFI_IFR_OP_HEADER *OpCode\r
1270 )\r
1271{\r
1272 EFI_IFR_NUMERIC *NumericOp;\r
1273 UINT64 Step;\r
1274\r
1275 NumericOp = (EFI_IFR_NUMERIC *) OpCode;\r
1276 \r
1277 switch (NumericOp->Flags & EFI_IFR_NUMERIC_SIZE) {\r
1278 case EFI_IFR_NUMERIC_SIZE_1:\r
1279 Step = NumericOp->data.u8.Step;\r
1280 break;\r
1281 \r
1282 case EFI_IFR_NUMERIC_SIZE_2:\r
1283 Step = NumericOp->data.u16.Step;\r
1284 break;\r
1285 \r
1286 case EFI_IFR_NUMERIC_SIZE_4:\r
1287 Step = NumericOp->data.u32.Step;\r
1288 break;\r
1289 \r
1290 case EFI_IFR_NUMERIC_SIZE_8:\r
1291 Step = NumericOp->data.u64.Step;\r
1292 break;\r
1293 \r
1294 default:\r
1295 Step = 0;\r
1296 break;\r
1297 }\r
1298\r
1299 return Step;\r
1300}\r
1301\r
1302/**\r
1303 Find the registered HotKey based on KeyData.\r
1304 \r
1305 @param[in] KeyData A pointer to a buffer that describes the keystroke\r
1306 information for the hot key.\r
1307\r
1308 @return The registered HotKey context. If no found, NULL will return.\r
1309**/\r
1310BROWSER_HOT_KEY *\r
1311GetHotKeyFromRegisterList (\r
1312 IN EFI_INPUT_KEY *KeyData\r
1313 )\r
1314{\r
1315 LIST_ENTRY *Link;\r
1316 BROWSER_HOT_KEY *HotKey;\r
1317\r
1318 Link = GetFirstNode (&gFormData->HotKeyListHead);\r
1319 while (!IsNull (&gFormData->HotKeyListHead, Link)) {\r
1320 HotKey = BROWSER_HOT_KEY_FROM_LINK (Link);\r
1321 \r
1322 if (HotKey->KeyData->ScanCode == KeyData->ScanCode) {\r
1323 return HotKey;\r
1324 }\r
1325\r
1326 Link = GetNextNode (&gFormData->HotKeyListHead, Link);\r
1327 }\r
1328 \r
1329 return NULL;\r
1330}\r
1331\r
1332\r
1333/**\r
1334 Determine if the menu is the last menu that can be selected.\r
1335\r
1336 This is an internal function.\r
1337\r
1338 @param Direction The scroll direction. False is down. True is up.\r
1339 @param CurrentPos The current focus.\r
1340\r
1341 @return FALSE -- the menu isn't the last menu that can be selected.\r
1342 @return TRUE -- the menu is the last menu that can be selected.\r
1343\r
1344**/\r
1345BOOLEAN\r
1346ValueIsScroll (\r
1347 IN BOOLEAN Direction,\r
1348 IN LIST_ENTRY *CurrentPos\r
1349 )\r
1350{\r
1351 LIST_ENTRY *Temp;\r
1352\r
1353 Temp = Direction ? CurrentPos->BackLink : CurrentPos->ForwardLink;\r
1354\r
1355 if (Temp == &gMenuOption) {\r
1356 return TRUE;\r
1357 }\r
1358\r
1359 return FALSE;\r
1360}\r
1361\r
1362/**\r
1363 Wait for a given event to fire, or for an optional timeout to expire.\r
1364\r
1365 @param Event The event to wait for\r
1366\r
1367 @retval UI_EVENT_TYPE The type of the event which is trigged.\r
1368\r
1369**/\r
1370UI_EVENT_TYPE\r
1371UiWaitForEvent (\r
1372 IN EFI_EVENT Event\r
1373 )\r
1374{\r
1375 EFI_STATUS Status;\r
1376 UINTN Index;\r
1377 UINTN EventNum;\r
1378 UINT64 Timeout;\r
1379 EFI_EVENT TimerEvent;\r
1380 EFI_EVENT WaitList[3];\r
1381 UI_EVENT_TYPE EventType;\r
1382\r
1383 TimerEvent = NULL;\r
1384 Timeout = FormExitTimeout(gFormData);\r
1385\r
1386 if (Timeout != 0) {\r
1387 Status = gBS->CreateEvent (EVT_TIMER, 0, NULL, NULL, &TimerEvent);\r
1388\r
1389 //\r
1390 // Set the timer event\r
1391 //\r
1392 gBS->SetTimer (\r
1393 TimerEvent,\r
1394 TimerRelative,\r
1395 Timeout\r
1396 );\r
1397 }\r
1398 \r
1399 WaitList[0] = Event;\r
1400 EventNum = 1;\r
1401 if (gFormData->FormRefreshEvent != NULL) {\r
1402 WaitList[EventNum] = gFormData->FormRefreshEvent;\r
1403 EventNum ++;\r
1404 } \r
1405\r
1406 if (Timeout != 0) {\r
1407 WaitList[EventNum] = TimerEvent;\r
1408 EventNum ++;\r
1409 }\r
1410\r
1411 Status = gBS->WaitForEvent (EventNum, WaitList, &Index);\r
1412 ASSERT_EFI_ERROR (Status);\r
1413\r
1414 switch (Index) {\r
1415 case 0:\r
1416 EventType = UIEventKey;\r
1417 break;\r
1418\r
1419 case 1:\r
1420 if (gFormData->FormRefreshEvent != NULL) {\r
1421 EventType = UIEventDriver;\r
1422 } else {\r
1423 ASSERT (Timeout != 0 && EventNum == 2);\r
1424 EventType = UIEventTimeOut;\r
1425 }\r
1426 break;\r
1427\r
1428 default:\r
1429 ASSERT (Index == 2 && EventNum == 3);\r
1430 EventType = UIEventTimeOut;\r
1431 break;\r
1432 }\r
1433\r
1434 if (Timeout != 0) {\r
1435 gBS->CloseEvent (TimerEvent);\r
1436 }\r
1437 \r
1438 return EventType;\r
1439}\r
1440\r
1441/**\r
1442 Get question id info from the input opcode header.\r
1443\r
1444 @param OpCode The input opcode header pointer.\r
1445\r
1446 @retval The question id for this opcode.\r
1447\r
1448**/\r
1449EFI_QUESTION_ID\r
1450GetQuestionIdInfo (\r
1451 IN EFI_IFR_OP_HEADER *OpCode\r
1452 )\r
1453{\r
1454 EFI_IFR_QUESTION_HEADER *QuestionHeader;\r
1455\r
1456 if (OpCode->Length < sizeof (EFI_IFR_OP_HEADER) + sizeof (EFI_IFR_QUESTION_HEADER)) {\r
1457 return 0;\r
1458 }\r
1459\r
1460 QuestionHeader = (EFI_IFR_QUESTION_HEADER *)((UINT8 *) OpCode + sizeof(EFI_IFR_OP_HEADER));\r
1461\r
1462 return QuestionHeader->QuestionId;\r
1463}\r
1464\r
ab369468
ED
1465\r
1466/**\r
1467 Find the top of screen menu base on the current menu.\r
1468\r
1469 @param CurPos Current input menu.\r
1470 @param Rows Totol screen rows.\r
1471 @param SkipValue SkipValue for this new form.\r
1472\r
1473 @retval TopOfScreen Top of screen menu for the new form.\r
1474\r
1475**/\r
1476LIST_ENTRY *\r
1477FindTopOfScreenMenu (\r
1478 IN LIST_ENTRY *CurPos,\r
1479 IN UINTN Rows,\r
1480 OUT UINTN *SkipValue\r
1481 )\r
1482{\r
1483 LIST_ENTRY *Link;\r
1484 LIST_ENTRY *TopOfScreen;\r
1485 UI_MENU_OPTION *PreviousMenuOption;\r
1486\r
1487 Link = CurPos;\r
1488 PreviousMenuOption = NULL;\r
1489\r
1490 while (Link->BackLink != &gMenuOption) {\r
1491 Link = Link->BackLink;\r
1492 PreviousMenuOption = MENU_OPTION_FROM_LINK (Link);\r
1493 if (PreviousMenuOption->Row == 0) {\r
1494 UpdateOptionSkipLines (PreviousMenuOption);\r
1495 }\r
1496 if (Rows <= PreviousMenuOption->Skip) {\r
1497 break;\r
1498 }\r
1499 Rows = Rows - PreviousMenuOption->Skip;\r
1500 }\r
1501\r
1502 if (Link->BackLink == &gMenuOption) {\r
1503 TopOfScreen = gMenuOption.ForwardLink;\r
1504 if (PreviousMenuOption != NULL && Rows < PreviousMenuOption->Skip) {\r
1505 *SkipValue = PreviousMenuOption->Skip - Rows;\r
1506 } else {\r
1507 *SkipValue = 0;\r
1508 }\r
1509 } else {\r
1510 TopOfScreen = Link;\r
1511 *SkipValue = PreviousMenuOption->Skip - Rows;\r
1512 }\r
1513\r
1514 return TopOfScreen;\r
1515}\r
1516\r
42645c3d
ED
1517/**\r
1518 Get the index info for this opcode.\r
1519\r
1520 @param OpCode The input opcode for the statement.\r
1521\r
1522 @retval The index of this statement.\r
1523\r
1524**/\r
1525UINTN\r
1526GetIndexInfoForOpcode (\r
1527 IN EFI_IFR_OP_HEADER *OpCode\r
1528 )\r
1529{\r
1530 LIST_ENTRY *NewPos;\r
1531 UI_MENU_OPTION *MenuOption;\r
1532 UINTN Index;\r
1533\r
1534 NewPos = gMenuOption.ForwardLink;\r
1535 Index = 0;\r
1536\r
1537 for (NewPos = gMenuOption.ForwardLink; NewPos != &gMenuOption; NewPos = NewPos->ForwardLink){\r
1538 MenuOption = MENU_OPTION_FROM_LINK (NewPos);\r
1539\r
1540 if (CompareMem (MenuOption->ThisTag->OpCode, OpCode, OpCode->Length) == 0) {\r
1541 if (MenuOption->ThisTag->OpCode == OpCode) {\r
1542 return Index;\r
1543 }\r
1544\r
1545 Index ++;\r
1546 }\r
1547 }\r
1548\r
1549 return Index;\r
1550}\r
1551\r
1552/**\r
1553 Is this the saved highlight statement.\r
1554\r
1555 @param HighLightedStatement The input highlight statement.\r
1556\r
1557 @retval TRUE This is the highlight statement.\r
1558 @retval FALSE This is not the highlight statement.\r
1559\r
1560**/\r
1561BOOLEAN \r
1562IsSavedHighlightStatement (\r
1563 IN FORM_DISPLAY_ENGINE_STATEMENT *HighLightedStatement\r
1564 )\r
1565{\r
1566 if ((gFormData->HiiHandle == gHighligthMenuInfo.HiiHandle) &&\r
1567 (gFormData->FormId == gHighligthMenuInfo.FormId)) {\r
1568 if (gHighligthMenuInfo.HLTQuestionId != 0) {\r
2e097165 1569 return (BOOLEAN) (gHighligthMenuInfo.HLTQuestionId == GetQuestionIdInfo (HighLightedStatement->OpCode));\r
42645c3d
ED
1570 } else {\r
1571 if (CompareMem (gHighligthMenuInfo.HLTOpCode, HighLightedStatement->OpCode, gHighligthMenuInfo.HLTOpCode->Length) == 0) {\r
1572 if (gHighligthMenuInfo.HLTIndex == 0 || gHighligthMenuInfo.HLTIndex == GetIndexInfoForOpcode(HighLightedStatement->OpCode)) {\r
1573 return TRUE;\r
1574 } else {\r
1575 return FALSE;\r
1576 }\r
1577 }\r
1578 }\r
1579 }\r
1580\r
1581 return FALSE;\r
1582}\r
1583\r
1584/**\r
1585 Is this the highlight menu.\r
1586\r
1587 @param MenuOption The input Menu option.\r
1588\r
1589 @retval TRUE This is the highlight menu option.\r
1590 @retval FALSE This is not the highlight menu option.\r
1591\r
1592**/\r
1593BOOLEAN\r
1594IsHighLightMenuOption (\r
1595 IN UI_MENU_OPTION *MenuOption\r
1596 )\r
1597{\r
1598 if (gHighligthMenuInfo.HLTQuestionId != 0) {\r
1599 if (GetQuestionIdInfo(MenuOption->ThisTag->OpCode) == gHighligthMenuInfo.HLTQuestionId) {\r
2e097165 1600 return (BOOLEAN) (MenuOption->Sequence == gHighligthMenuInfo.HLTSequence);\r
42645c3d
ED
1601 }\r
1602 } else {\r
1603 if(CompareMem (gHighligthMenuInfo.HLTOpCode, MenuOption->ThisTag->OpCode, gHighligthMenuInfo.HLTOpCode->Length) == 0) {\r
1604 if (gHighligthMenuInfo.HLTIndex == 0 || gHighligthMenuInfo.HLTIndex == GetIndexInfoForOpcode(MenuOption->ThisTag->OpCode)) {\r
2e097165 1605 return (BOOLEAN) (MenuOption->Sequence == gHighligthMenuInfo.HLTSequence);\r
42645c3d
ED
1606 } else {\r
1607 return FALSE;\r
1608 }\r
1609 }\r
1610 }\r
1611\r
1612 return FALSE;\r
1613}\r
1614\r
1615/**\r
1616 Find the highlight menu.\r
1617\r
1618 If the input is NULL, base on the record highlight info in\r
1619 gHighligthMenuInfo to find the last highlight menu.\r
1620\r
1621 @param HighLightedStatement The input highlight statement.\r
1622\r
1623 @retval The highlight menu index.\r
1624\r
1625**/\r
1626LIST_ENTRY *\r
1627FindHighLightMenuOption (\r
1628 IN FORM_DISPLAY_ENGINE_STATEMENT *HighLightedStatement\r
1629 )\r
1630{\r
1631 LIST_ENTRY *NewPos;\r
1632 UI_MENU_OPTION *MenuOption;\r
1633\r
1634 NewPos = gMenuOption.ForwardLink;\r
1635 MenuOption = MENU_OPTION_FROM_LINK (NewPos);\r
1636\r
1637 if (HighLightedStatement != NULL) {\r
1638 while (MenuOption->ThisTag != HighLightedStatement) {\r
1639 NewPos = NewPos->ForwardLink;\r
1640 if (NewPos == &gMenuOption) {\r
1641 //\r
1642 // Not Found it, break\r
1643 //\r
1644 break;\r
1645 }\r
1646 MenuOption = MENU_OPTION_FROM_LINK (NewPos);\r
1647 }\r
1648\r
1649 //\r
1650 // Must find the highlight statement.\r
1651 //\r
1652 ASSERT (NewPos != &gMenuOption);\r
1653\r
1654 } else {\r
1655 while (!IsHighLightMenuOption (MenuOption)) {\r
1656 NewPos = NewPos->ForwardLink;\r
1657 if (NewPos == &gMenuOption) {\r
1658 //\r
1659 // Not Found it, break\r
1660 //\r
1661 break;\r
1662 }\r
1663 MenuOption = MENU_OPTION_FROM_LINK (NewPos);\r
1664 }\r
1665\r
1666 //\r
1667 // Highlight statement has disappear (suppressed/disableed)\r
1668 //\r
1669 if (NewPos == &gMenuOption) {\r
1670 NewPos = NULL;\r
1671 }\r
1672 }\r
1673\r
1674 return NewPos;\r
1675}\r
1676\r
1677/**\r
1678 Is this the Top of screen menu.\r
1679\r
1680 @param MenuOption The input Menu option.\r
1681\r
1682 @retval TRUE This is the Top of screen menu option.\r
1683 @retval FALSE This is not the Top of screen menu option.\r
1684\r
1685**/\r
1686BOOLEAN\r
1687IsTopOfScreeMenuOption (\r
1688 IN UI_MENU_OPTION *MenuOption\r
1689 )\r
1690{\r
1691 if (gHighligthMenuInfo.TOSQuestionId != 0) {\r
2e097165 1692 return (BOOLEAN) (GetQuestionIdInfo(MenuOption->ThisTag->OpCode) == gHighligthMenuInfo.TOSQuestionId);\r
42645c3d
ED
1693 } \r
1694\r
1695 if(CompareMem (gHighligthMenuInfo.TOSOpCode, MenuOption->ThisTag->OpCode, gHighligthMenuInfo.TOSOpCode->Length) == 0) {\r
1696 if (gHighligthMenuInfo.TOSIndex == 0 || gHighligthMenuInfo.TOSIndex == GetIndexInfoForOpcode(MenuOption->ThisTag->OpCode)) {\r
1697 return TRUE;\r
1698 } else {\r
1699 return FALSE;\r
1700 }\r
1701 }\r
1702\r
1703 return FALSE;\r
1704}\r
1705\r
1706/**\r
1707 Find the Top of screen menu.\r
1708\r
1709 If the input is NULL, base on the record highlight info in\r
1710 gHighligthMenuInfo to find the last highlight menu.\r
1711\r
1712 @param HighLightedStatement The input highlight statement.\r
1713\r
1714 @retval The highlight menu index.\r
1715\r
1716**/\r
1717LIST_ENTRY *\r
1718FindTopOfScreenMenuOption (\r
1719 VOID\r
1720 )\r
1721{\r
1722 LIST_ENTRY *NewPos;\r
1723 UI_MENU_OPTION *MenuOption;\r
1724\r
1725 NewPos = gMenuOption.ForwardLink;\r
1726 MenuOption = MENU_OPTION_FROM_LINK (NewPos);\r
1727\r
1728 while (!IsTopOfScreeMenuOption(MenuOption)) {\r
1729 NewPos = NewPos->ForwardLink;\r
1730 if (NewPos == &gMenuOption) {\r
1731 //\r
1732 // Not Found it, break\r
1733 //\r
1734 break;\r
1735 }\r
1736 MenuOption = MENU_OPTION_FROM_LINK (NewPos);\r
1737 }\r
1738\r
1739 //\r
1740 // Last time top of screen menu has disappeared.\r
1741 //\r
1742 if (NewPos == &gMenuOption) {\r
1743 NewPos = NULL;\r
1744 }\r
1745\r
1746 return NewPos;\r
1747}\r
1748\r
7c6c064c
ED
1749/**\r
1750 Find the first menu which will be show at the top.\r
1751\r
1752 @param FormData The data info for this form.\r
1753 @param TopOfScreen The link_entry pointer to top menu.\r
1754 @param HighlightMenu The menu which will be highlight.\r
1755 @param SkipValue The skip value for the top menu.\r
1756\r
1757**/\r
1758VOID\r
1759FindTopMenu (\r
1760 IN FORM_DISPLAY_ENGINE_FORM *FormData,\r
1761 OUT LIST_ENTRY **TopOfScreen,\r
1762 OUT LIST_ENTRY **HighlightMenu,\r
ab369468 1763 OUT UINTN *SkipValue\r
7c6c064c
ED
1764 )\r
1765{\r
7c6c064c
ED
1766 UINTN TopRow;\r
1767 UINTN BottomRow;\r
42645c3d 1768 UI_MENU_OPTION *MenuOption;\r
ab369468 1769 UINTN TmpValue;\r
7c6c064c
ED
1770\r
1771 TopRow = gStatementDimensions.TopRow + SCROLL_ARROW_HEIGHT;\r
1772 BottomRow = gStatementDimensions.BottomRow - SCROLL_ARROW_HEIGHT;\r
1773\r
42645c3d
ED
1774 if (gMisMatch) {\r
1775 //\r
1776 // Reenter caused by option mismatch or auto exit caused by refresh form(refresh interval/guid), \r
1777 // base on the record highlight info to find the highlight menu.\r
1778 //\r
1779 ASSERT (gFormData->HiiHandle == gHighligthMenuInfo.HiiHandle &&\r
1780 gFormData->FormId == gHighligthMenuInfo.FormId);\r
7c6c064c 1781\r
42645c3d
ED
1782 *HighlightMenu = FindHighLightMenuOption(NULL);\r
1783 if (*HighlightMenu != NULL) {\r
7c6c064c 1784 //\r
42645c3d 1785 // Update skip info for this highlight menu.\r
7c6c064c 1786 //\r
42645c3d
ED
1787 MenuOption = MENU_OPTION_FROM_LINK (*HighlightMenu);\r
1788 UpdateOptionSkipLines (MenuOption);\r
7c6c064c 1789\r
42645c3d
ED
1790 //\r
1791 // Found the last time highlight menu.\r
1792 //\r
1793 *TopOfScreen = FindTopOfScreenMenuOption();\r
1794 if (*TopOfScreen != NULL) {\r
1795 //\r
1796 // Found the last time selectable top of screen menu.\r
1797 //\r
1798 AdjustDateAndTimePosition(TRUE, TopOfScreen);\r
1799 MenuOption = MENU_OPTION_FROM_LINK (*TopOfScreen);\r
1800 UpdateOptionSkipLines (MenuOption);\r
7c6c064c 1801\r
42645c3d
ED
1802 *SkipValue = gHighligthMenuInfo.SkipValue;\r
1803 } else {\r
336c8e11 1804 //\r
42645c3d
ED
1805 // Not found last time top of screen menu, so base on current highlight menu\r
1806 // to find the new top of screen menu.\r
1807 // Make the current highlight menu at the bottom of the form to calculate the\r
1808 // top of screen menu.\r
336c8e11 1809 //\r
42645c3d
ED
1810 if (MenuOption->Skip >= BottomRow - TopRow) {\r
1811 *TopOfScreen = *HighlightMenu;\r
1812 TmpValue = 0;\r
1813 } else {\r
1814 *TopOfScreen = FindTopOfScreenMenu(*HighlightMenu, BottomRow - TopRow - MenuOption->Skip, &TmpValue);\r
1815 }\r
1816\r
1817 *SkipValue = TmpValue;\r
336c8e11 1818 }\r
42645c3d
ED
1819 } else {\r
1820 //\r
1821 // Last time highlight menu has disappear, find the first highlightable menu as the defalut one.\r
1822 //\r
1823 *HighlightMenu = gMenuOption.ForwardLink;\r
1824 if (!IsListEmpty (&gMenuOption)) {\r
1825 MoveToNextStatement (FALSE, HighlightMenu, BottomRow - TopRow, TRUE);\r
1826 }\r
1827 *TopOfScreen = gMenuOption.ForwardLink;\r
1828 *SkipValue = 0;\r
1829 }\r
1830\r
1831 gMisMatch = FALSE;\r
1832 } else if (FormData->HighLightedStatement != NULL) {\r
1833 if (IsSavedHighlightStatement (FormData->HighLightedStatement)) {\r
1834 //\r
1835 // Input highlight menu is same as last time highlight menu.\r
1836 // Base on last time highlight menu to set the top of screen menu and highlight menu.\r
1837 //\r
1838 *HighlightMenu = FindHighLightMenuOption(NULL);\r
1839 ASSERT (*HighlightMenu != NULL);\r
1840\r
1841 //\r
1842 // Update skip info for this highlight menu.\r
1843 //\r
1844 MenuOption = MENU_OPTION_FROM_LINK (*HighlightMenu);\r
1845 UpdateOptionSkipLines (MenuOption);\r
1846 \r
1847 *TopOfScreen = FindTopOfScreenMenuOption();\r
1848 if (*TopOfScreen == NULL) {\r
336c8e11 1849 //\r
42645c3d
ED
1850 // Not found last time top of screen menu, so base on current highlight menu\r
1851 // to find the new top of screen menu.\r
1852 // Make the current highlight menu at the bottom of the form to calculate the\r
1853 // top of screen menu.\r
336c8e11 1854 //\r
42645c3d
ED
1855 if (MenuOption->Skip >= BottomRow - TopRow) {\r
1856 *TopOfScreen = *HighlightMenu;\r
1857 TmpValue = 0;\r
1858 } else {\r
1859 *TopOfScreen = FindTopOfScreenMenu(*HighlightMenu, BottomRow - TopRow - MenuOption->Skip, &TmpValue);\r
1860 }\r
1861\r
1862 *SkipValue = TmpValue;\r
1863 } else {\r
1864 AdjustDateAndTimePosition(TRUE, TopOfScreen);\r
1865 MenuOption = MENU_OPTION_FROM_LINK (*TopOfScreen);\r
1866 UpdateOptionSkipLines (MenuOption);\r
1867\r
1868 *SkipValue = gHighligthMenuInfo.SkipValue;\r
336c8e11 1869 }\r
42645c3d
ED
1870 AdjustDateAndTimePosition(TRUE, TopOfScreen);\r
1871 } else {\r
1872 //\r
1873 // Input highlight menu is not save as last time highlight menu.\r
1874 //\r
1875 *HighlightMenu = FindHighLightMenuOption(FormData->HighLightedStatement);\r
1876 MenuOption = MENU_OPTION_FROM_LINK (*HighlightMenu);\r
1877 UpdateOptionSkipLines (MenuOption);\r
7c6c064c 1878\r
42645c3d
ED
1879 //\r
1880 // Make the current highlight menu at the bottom of the form to calculate the\r
1881 // top of screen menu.\r
1882 //\r
1883 if (MenuOption->Skip >= BottomRow - TopRow) {\r
1884 *TopOfScreen = *HighlightMenu;\r
1885 TmpValue = 0;\r
1886 } else {\r
1887 *TopOfScreen = FindTopOfScreenMenu(*HighlightMenu, BottomRow - TopRow - MenuOption->Skip, &TmpValue);\r
1888 }\r
1889\r
1890 *SkipValue = TmpValue;\r
1891 }\r
1892 AdjustDateAndTimePosition(TRUE, TopOfScreen);\r
7c6c064c 1893 } else {\r
42645c3d
ED
1894 //\r
1895 // If not has input highlight statement, just return the first one in this form.\r
1896 //\r
1897 *TopOfScreen = gMenuOption.ForwardLink;\r
1898 *HighlightMenu = gMenuOption.ForwardLink;\r
1899 if (!IsListEmpty (&gMenuOption)) {\r
1900 MoveToNextStatement (FALSE, HighlightMenu, BottomRow - TopRow, TRUE);\r
1901 }\r
1902 *SkipValue = 0;\r
7c6c064c 1903 }\r
ab2cf8ea
ED
1904\r
1905 //\r
1906 // First enter to show the menu, update highlight info.\r
1907 //\r
1908 UpdateHighlightMenuInfo (*HighlightMenu, *TopOfScreen, *SkipValue);\r
7c6c064c
ED
1909}\r
1910\r
af047db7 1911/**\r
42645c3d 1912 Record the highlight menu and top of screen menu info.\r
af047db7 1913\r
42645c3d
ED
1914 @param Highlight The menu opton which is highlight.\r
1915 @param TopOfScreen The menu opton which is at the top of the form.\r
1916 @param SkipValue The skip line info for the top of screen menu.\r
af047db7
ED
1917\r
1918**/\r
1919VOID\r
1920UpdateHighlightMenuInfo (\r
42645c3d
ED
1921 IN LIST_ENTRY *Highlight,\r
1922 IN LIST_ENTRY *TopOfScreen,\r
1923 IN UINTN SkipValue\r
af047db7
ED
1924 )\r
1925{\r
42645c3d 1926 UI_MENU_OPTION *MenuOption;\r
af047db7
ED
1927 FORM_DISPLAY_ENGINE_STATEMENT *Statement;\r
1928\r
42645c3d
ED
1929 gHighligthMenuInfo.HiiHandle = gFormData->HiiHandle;\r
1930 gHighligthMenuInfo.FormId = gFormData->FormId;\r
1931 gHighligthMenuInfo.SkipValue = (UINT16)SkipValue;\r
af047db7 1932\r
42645c3d
ED
1933 if (!IsListEmpty (&gMenuOption)) {\r
1934 MenuOption = MENU_OPTION_FROM_LINK (Highlight);\r
1935 Statement = MenuOption->ThisTag;\r
af047db7 1936\r
42645c3d 1937 gUserInput->SelectedStatement = Statement;\r
336c8e11 1938\r
42645c3d
ED
1939 gHighligthMenuInfo.HLTSequence = MenuOption->Sequence;\r
1940 gHighligthMenuInfo.HLTQuestionId = GetQuestionIdInfo(Statement->OpCode);\r
1941 if (gHighligthMenuInfo.HLTQuestionId == 0) {\r
1942 //\r
1943 // if question id == 0, save the opcode buffer..\r
1944 //\r
1945 if (gHighligthMenuInfo.HLTOpCode != NULL) {\r
1946 FreePool (gHighligthMenuInfo.HLTOpCode);\r
336c8e11 1947 }\r
42645c3d
ED
1948 gHighligthMenuInfo.HLTOpCode = AllocateCopyPool (Statement->OpCode->Length, Statement->OpCode);\r
1949 ASSERT (gHighligthMenuInfo.HLTOpCode != NULL);\r
1950\r
1951 gHighligthMenuInfo.HLTIndex = GetIndexInfoForOpcode(Statement->OpCode);\r
1952 }\r
1953\r
1954 MenuOption = MENU_OPTION_FROM_LINK (TopOfScreen);\r
1955 Statement = MenuOption->ThisTag;\r
1956\r
1957 gHighligthMenuInfo.TOSQuestionId = GetQuestionIdInfo(Statement->OpCode);\r
1958 if (gHighligthMenuInfo.TOSQuestionId == 0) {\r
1959 //\r
1960 // if question id == 0, save the opcode buffer..\r
1961 //\r
1962 if (gHighligthMenuInfo.TOSOpCode != NULL) {\r
1963 FreePool (gHighligthMenuInfo.TOSOpCode);\r
1964 }\r
1965 gHighligthMenuInfo.TOSOpCode = AllocateCopyPool (Statement->OpCode->Length, Statement->OpCode);\r
1966 ASSERT (gHighligthMenuInfo.TOSOpCode != NULL);\r
1967\r
1968 gHighligthMenuInfo.TOSIndex = GetIndexInfoForOpcode(Statement->OpCode);\r
336c8e11 1969 }\r
af047db7 1970 } else {\r
42645c3d
ED
1971 gUserInput->SelectedStatement = NULL;\r
1972\r
1973 gHighligthMenuInfo.HLTSequence = 0;\r
1974 gHighligthMenuInfo.HLTQuestionId = 0;\r
1975 if (gHighligthMenuInfo.HLTOpCode != NULL) {\r
1976 FreePool (gHighligthMenuInfo.HLTOpCode);\r
336c8e11 1977 }\r
42645c3d
ED
1978 gHighligthMenuInfo.HLTOpCode = NULL;\r
1979 gHighligthMenuInfo.HLTIndex = 0;\r
af047db7 1980\r
42645c3d
ED
1981 gHighligthMenuInfo.TOSQuestionId = 0;\r
1982 if (gHighligthMenuInfo.TOSOpCode != NULL) {\r
1983 FreePool (gHighligthMenuInfo.TOSOpCode);\r
1984 }\r
1985 gHighligthMenuInfo.TOSOpCode = NULL;\r
1986 gHighligthMenuInfo.TOSIndex = 0;\r
1987 }\r
af047db7
ED
1988}\r
1989\r
1990/**\r
1991 Update attribut for this menu.\r
1992\r
1993 @param MenuOption The menu opton which this attribut used to.\r
1994 @param Highlight Whether this menu will be highlight.\r
1995\r
1996**/\r
1997VOID\r
1998SetDisplayAttribute (\r
1999 IN UI_MENU_OPTION *MenuOption,\r
2000 IN BOOLEAN Highlight\r
2001 )\r
2002{\r
2003 FORM_DISPLAY_ENGINE_STATEMENT *Statement;\r
2004 \r
2005 Statement = MenuOption->ThisTag;\r
2006\r
2007 if (Highlight) {\r
2008 gST->ConOut->SetAttribute (gST->ConOut, GetHighlightTextColor ());\r
2009 return;\r
2010 }\r
2011\r
2012 if (MenuOption->GrayOut) {\r
2013 gST->ConOut->SetAttribute (gST->ConOut, GetGrayedTextColor ());\r
2014 } else {\r
2015 if (Statement->OpCode->OpCode == EFI_IFR_SUBTITLE_OP) {\r
2016 gST->ConOut->SetAttribute (gST->ConOut, GetSubTitleTextColor ());\r
2017 } else {\r
2018 gST->ConOut->SetAttribute (gST->ConOut, GetFieldTextColor ());\r
2019 }\r
2020 }\r
2021}\r
2022\r
2023/**\r
2024 Print string for this menu option.\r
2025\r
2026 @param MenuOption The menu opton which this attribut used to.\r
2027 @param Col The column that this string will be print at.\r
2028 @param Row The row that this string will be print at.\r
2029 @param String The string which need to print.\r
2030 @param Width The width need to print, if string is less than the\r
2031 width, the block space will be used.\r
2032 @param Highlight Whether this menu will be highlight.\r
2033\r
2034**/\r
2035VOID\r
2036DisplayMenuString (\r
2037 IN UI_MENU_OPTION *MenuOption,\r
2038 IN UINTN Col,\r
2039 IN UINTN Row,\r
2040 IN CHAR16 *String,\r
2041 IN UINTN Width,\r
2042 IN BOOLEAN Highlight\r
2043 )\r
2044{\r
2045 UINTN Length;\r
2046\r
2047 //\r
2048 // Print string with normal color.\r
2049 //\r
2050 if (!Highlight) {\r
2051 PrintStringAtWithWidth (Col, Row, String, Width);\r
2052 return;\r
2053 }\r
2054 \r
2055 //\r
2056 // Print the highlight menu string.\r
2057 // First print the highlight string.\r
2058 // \r
2059 SetDisplayAttribute(MenuOption, TRUE);\r
2060 Length = PrintStringAt (Col, Row, String);\r
2061\r
2062 //\r
2063 // Second, clean the empty after the string.\r
2064 //\r
2065 SetDisplayAttribute(MenuOption, FALSE);\r
2066 PrintStringAtWithWidth (Col + Length, Row, L"", Width - Length);\r
2067}\r
2068\r
28401a65
ED
2069/**\r
2070 Check whether this menu can has option string.\r
2071\r
2072 @param MenuOption The menu opton which this attribut used to.\r
2073\r
2074 @retval TRUE This menu option can have option string.\r
2075 @retval FALSE This menu option can't have option string.\r
2076\r
2077**/\r
2078BOOLEAN \r
2079HasOptionString (\r
2080 IN UI_MENU_OPTION *MenuOption\r
2081 )\r
2082{\r
2083 FORM_DISPLAY_ENGINE_STATEMENT *Statement;\r
2084 CHAR16 *String;\r
2085 UINTN Size;\r
2086 EFI_IFR_TEXT *TestOp;\r
2087\r
2088 Size = 0;\r
2089 Statement = MenuOption->ThisTag;\r
2090\r
2091 //\r
2092 // See if the second text parameter is really NULL\r
2093 //\r
2094 if (Statement->OpCode->OpCode == EFI_IFR_TEXT_OP) {\r
2095 TestOp = (EFI_IFR_TEXT *) Statement->OpCode;\r
2096 if (TestOp->TextTwo != 0) {\r
2097 String = GetToken (TestOp->TextTwo, gFormData->HiiHandle);\r
2098 Size = StrLen (String);\r
2099 FreePool (String);\r
2100 }\r
2101 }\r
2102\r
2103 if ((Statement->OpCode->OpCode == EFI_IFR_SUBTITLE_OP) ||\r
2104 (Statement->OpCode->OpCode == EFI_IFR_REF_OP) ||\r
2105 (Statement->OpCode->OpCode == EFI_IFR_PASSWORD_OP) ||\r
2106 (Statement->OpCode->OpCode == EFI_IFR_ACTION_OP) ||\r
2107 (Statement->OpCode->OpCode == EFI_IFR_RESET_BUTTON_OP) ||\r
2108 //\r
2109 // Allow a wide display if text op-code and no secondary text op-code\r
2110 //\r
2111 ((Statement->OpCode->OpCode == EFI_IFR_TEXT_OP) && (Size == 0))\r
2112 ) {\r
2113\r
2114 return FALSE;\r
2115 }\r
2116\r
2117 return TRUE;\r
2118}\r
2119\r
23c7d425
ED
2120/**\r
2121 Double confirm with user about the action.\r
2122\r
2123 @param Action The user input action.\r
2124\r
2125 @retval TRUE User confirm with the input or not need user confirm.\r
2126 @retval FALSE User want ignore this input.\r
2127\r
2128**/\r
2129BOOLEAN\r
2130FxConfirmPopup (\r
2131 IN UINT32 Action\r
2132 )\r
2133{\r
2134 EFI_INPUT_KEY Key;\r
2135 CHAR16 *CfmStr;\r
2136 UINTN CfmStrLen;\r
2137 UINT32 CheckFlags;\r
2138 BOOLEAN RetVal;\r
2139 UINTN CatLen;\r
2140\r
2141 CfmStrLen = 0;\r
2142 CatLen = StrLen (gConfirmMsgConnect);\r
2143\r
2144 //\r
2145 // Below action need extra popup dialog to confirm.\r
2146 // \r
2147 CheckFlags = BROWSER_ACTION_DISCARD | \r
2148 BROWSER_ACTION_DEFAULT |\r
2149 BROWSER_ACTION_SUBMIT |\r
2150 BROWSER_ACTION_RESET |\r
2151 BROWSER_ACTION_EXIT;\r
2152\r
2153 //\r
2154 // Not need to confirm with user, just return TRUE.\r
2155 //\r
2156 if ((Action & CheckFlags) == 0) {\r
2157 return TRUE;\r
2158 }\r
2159\r
2160 if ((Action & BROWSER_ACTION_DISCARD) == BROWSER_ACTION_DISCARD) {\r
2161 CfmStrLen += StrLen (gConfirmDiscardMsg);\r
2162 } \r
2163\r
2164 if ((Action & BROWSER_ACTION_DEFAULT) == BROWSER_ACTION_DEFAULT) {\r
2165 if (CfmStrLen != 0) {\r
2166 CfmStrLen += CatLen;\r
2167 } \r
2168\r
2169 CfmStrLen += StrLen (gConfirmDefaultMsg);\r
2170 }\r
2171\r
2172 if ((Action & BROWSER_ACTION_SUBMIT) == BROWSER_ACTION_SUBMIT) {\r
2173 if (CfmStrLen != 0) {\r
2174 CfmStrLen += CatLen;\r
2175 } \r
2176\r
2177 CfmStrLen += StrLen (gConfirmSubmitMsg);\r
2178 }\r
2179\r
2180 if ((Action & BROWSER_ACTION_RESET) == BROWSER_ACTION_RESET) {\r
2181 if (CfmStrLen != 0) {\r
2182 CfmStrLen += CatLen;\r
2183 } \r
2184\r
2185 CfmStrLen += StrLen (gConfirmResetMsg);\r
2186 }\r
2187\r
2188 if ((Action & BROWSER_ACTION_EXIT) == BROWSER_ACTION_EXIT) {\r
2189 if (CfmStrLen != 0) {\r
2190 CfmStrLen += CatLen;\r
2191 } \r
2192\r
2193 CfmStrLen += StrLen (gConfirmExitMsg);\r
2194 }\r
2195\r
2196 //\r
2197 // Allocate buffer to save the string.\r
2198 // String + "?" + "\0"\r
2199 //\r
2200 CfmStr = AllocateZeroPool ((CfmStrLen + 1 + 1) * sizeof (CHAR16));\r
2201 ASSERT (CfmStr != NULL);\r
2202\r
2203 if ((Action & BROWSER_ACTION_DISCARD) == BROWSER_ACTION_DISCARD) {\r
2204 StrCpy (CfmStr, gConfirmDiscardMsg);\r
2205 }\r
2206\r
2207 if ((Action & BROWSER_ACTION_DEFAULT) == BROWSER_ACTION_DEFAULT) {\r
2208 if (CfmStr[0] != 0) {\r
2209 StrCat (CfmStr, gConfirmMsgConnect);\r
2210 StrCat (CfmStr, gConfirmDefaultMsg2nd);\r
2211 } else {\r
2212 StrCpy (CfmStr, gConfirmDefaultMsg);\r
2213 }\r
2214 }\r
2215\r
2216 if ((Action & BROWSER_ACTION_SUBMIT) == BROWSER_ACTION_SUBMIT) {\r
2217 if (CfmStr[0] != 0) {\r
2218 StrCat (CfmStr, gConfirmMsgConnect);\r
2219 StrCat (CfmStr, gConfirmSubmitMsg2nd);\r
2220 } else {\r
2221 StrCpy (CfmStr, gConfirmSubmitMsg);\r
2222 }\r
2223 }\r
2224\r
2225 if ((Action & BROWSER_ACTION_RESET) == BROWSER_ACTION_RESET) {\r
2226 if (CfmStr[0] != 0) {\r
2227 StrCat (CfmStr, gConfirmMsgConnect);\r
2228 StrCat (CfmStr, gConfirmResetMsg2nd);\r
2229 } else {\r
2230 StrCpy (CfmStr, gConfirmResetMsg);\r
2231 }\r
2232 }\r
2233\r
2234 if ((Action & BROWSER_ACTION_EXIT) == BROWSER_ACTION_EXIT) {\r
2235 if (CfmStr[0] != 0) {\r
2236 StrCat (CfmStr, gConfirmMsgConnect);\r
2237 StrCat (CfmStr, gConfirmExitMsg2nd);\r
2238 } else {\r
2239 StrCpy (CfmStr, gConfirmExitMsg);\r
2240 }\r
2241 }\r
2242\r
2243 StrCat (CfmStr, gConfirmMsgEnd);\r
2244\r
2245 do {\r
2246 CreateDialog (&Key, gEmptyString, CfmStr, gConfirmOpt, gEmptyString, NULL);\r
2247 } while (((Key.UnicodeChar | UPPER_LOWER_CASE_OFFSET) != (gConfirmOptYes[0] | UPPER_LOWER_CASE_OFFSET)) &&\r
2248 ((Key.UnicodeChar | UPPER_LOWER_CASE_OFFSET) != (gConfirmOptNo[0] | UPPER_LOWER_CASE_OFFSET)));\r
2249\r
2250 if ((Key.UnicodeChar | UPPER_LOWER_CASE_OFFSET) == (gConfirmOptYes[0] | UPPER_LOWER_CASE_OFFSET)) {\r
2251 RetVal = TRUE;\r
2252 } else {\r
2253 RetVal = FALSE;\r
2254 }\r
2255\r
2256 FreePool (CfmStr);\r
2257\r
2258 return RetVal;\r
2259}\r
28401a65 2260\r
af047db7
ED
2261/**\r
2262 Print string for this menu option.\r
2263\r
2264 @param MenuOption The menu opton which this attribut used to.\r
2265 @param SkipWidth The skip width between the left to the start of the prompt.\r
2266 @param BeginCol The begin column for one menu.\r
2267 @param SkipLine The skip line for this menu. \r
2268 @param BottomRow The bottom row for this form.\r
2269 @param Highlight Whether this menu will be highlight.\r
f0c5095b 2270 @param UpdateCol Whether need to update the column info for Date/Time.\r
af047db7
ED
2271\r
2272 @retval EFI_SUCESSS Process the user selection success.\r
2273\r
2274**/\r
2275EFI_STATUS\r
2276DisplayOneMenu (\r
2277 IN UI_MENU_OPTION *MenuOption,\r
2278 IN UINTN SkipWidth,\r
2279 IN UINTN BeginCol,\r
2280 IN UINTN SkipLine,\r
2281 IN UINTN BottomRow,\r
f0c5095b
ED
2282 IN BOOLEAN Highlight,\r
2283 IN BOOLEAN UpdateCol\r
af047db7
ED
2284 )\r
2285{\r
2286 FORM_DISPLAY_ENGINE_STATEMENT *Statement;\r
2287 UINTN Index;\r
2288 UINT16 Width;\r
2289 UINT16 PromptWidth;\r
2290 CHAR16 *StringPtr;\r
2291 CHAR16 *OptionString;\r
2292 CHAR16 *OutputString;\r
af047db7
ED
2293 UINT16 GlyphWidth;\r
2294 UINTN Temp;\r
2295 UINTN Temp2;\r
2296 UINTN Temp3;\r
2297 EFI_STATUS Status;\r
2298 UINTN Row;\r
8c9c60b6 2299 BOOLEAN IsProcessingFirstRow;\r
af047db7
ED
2300 UINTN Col;\r
2301 UINTN PromptLineNum;\r
28401a65 2302 UINTN OptionLineNum;\r
af047db7 2303 CHAR16 AdjustValue;\r
28401a65 2304 UINTN MaxRow;\r
af047db7
ED
2305\r
2306 Statement = MenuOption->ThisTag;\r
af047db7
ED
2307 Temp = SkipLine;\r
2308 Temp2 = SkipLine;\r
2309 Temp3 = SkipLine;\r
28401a65
ED
2310 AdjustValue = 0;\r
2311 PromptLineNum = 0;\r
2312 OptionLineNum = 0;\r
2313 MaxRow = 0;\r
8c9c60b6 2314 IsProcessingFirstRow = TRUE;\r
af047db7
ED
2315\r
2316 //\r
2317 // Set default color.\r
2318 //\r
2319 SetDisplayAttribute (MenuOption, FALSE);\r
2320\r
2321 //\r
2322 // 1. Paint the option string.\r
2323 //\r
2324 Status = ProcessOptions (MenuOption, FALSE, &OptionString, FALSE);\r
2325 if (EFI_ERROR (Status)) {\r
2326 return Status;\r
2327 }\r
2328\r
2329 if (OptionString != NULL) {\r
2330 if (Statement->OpCode->OpCode == EFI_IFR_DATE_OP || Statement->OpCode->OpCode == EFI_IFR_TIME_OP) {\r
2331 //\r
2332 // Adjust option string for date/time opcode.\r
2333 //\r
f0c5095b 2334 ProcessStringForDateTime(MenuOption, OptionString, UpdateCol);\r
af047db7
ED
2335 }\r
2336 \r
2337 Width = (UINT16) gOptionBlockWidth - 1;\r
28401a65 2338 Row = MenuOption->Row;\r
af047db7 2339 GlyphWidth = 1;\r
28401a65 2340 OptionLineNum = 0;\r
af047db7
ED
2341 \r
2342 for (Index = 0; GetLineByWidth (OptionString, Width, &GlyphWidth, &Index, &OutputString) != 0x0000;) {\r
2343 if (((Temp2 == 0)) && (Row <= BottomRow)) {\r
2344 if (Statement->OpCode->OpCode == EFI_IFR_DATE_OP || Statement->OpCode->OpCode == EFI_IFR_TIME_OP) {\r
2345 //\r
2346 // For date/time question, it has three menu options for this qustion.\r
2347 // The first/second menu options with the skip value is 0. the last one\r
2348 // with skip value is 1.\r
2349 //\r
2350 if (MenuOption->Skip != 0) {\r
2351 //\r
2352 // For date/ time, print the last past (year for date and second for time)\r
2353 // - 7 means skip [##/##/ for date and [##:##: for time.\r
2354 //\r
2355 DisplayMenuString (MenuOption,MenuOption->OptCol, Row, OutputString, Width + 1 - 7, Highlight);\r
2356 } else {\r
2357 //\r
2358 // For date/ time, print the first and second past (year for date and second for time)\r
f0c5095b
ED
2359 // The OutputString has a NARROW_CHAR or WIDE_CHAR at the begin of the string, \r
2360 // so need to - 1 to remove it, otherwise, it will clean 1 extr char follow it.\r
2361 DisplayMenuString (MenuOption, MenuOption->OptCol, Row, OutputString, StrLen (OutputString) - 1, Highlight);\r
af047db7
ED
2362 }\r
2363 } else {\r
2364 DisplayMenuString (MenuOption, MenuOption->OptCol, Row, OutputString, Width + 1, Highlight);\r
2365 }\r
28401a65 2366 OptionLineNum++;\r
af047db7
ED
2367 }\r
2368 \r
2369 //\r
2370 // If there is more string to process print on the next row and increment the Skip value\r
2371 //\r
2372 if (StrLen (&OptionString[Index]) != 0) {\r
2373 if (Temp2 == 0) {\r
2374 Row++;\r
2375 //\r
2376 // Since the Number of lines for this menu entry may or may not be reflected accurately\r
2377 // since the prompt might be 1 lines and option might be many, and vice versa, we need to do\r
2378 // some testing to ensure we are keeping this in-sync.\r
2379 //\r
2380 // If the difference in rows is greater than or equal to the skip value, increase the skip value\r
2381 //\r
28401a65 2382 if ((Row - MenuOption->Row) >= MenuOption->Skip) {\r
af047db7
ED
2383 MenuOption->Skip++;\r
2384 }\r
2385 }\r
2386 }\r
2387 \r
2388 FreePool (OutputString);\r
2389 if (Temp2 != 0) {\r
2390 Temp2--;\r
2391 }\r
2392 }\r
2393 \r
af047db7
ED
2394 Highlight = FALSE;\r
2395\r
2396 FreePool (OptionString);\r
2397 }\r
af047db7
ED
2398\r
2399 //\r
28401a65 2400 // 2. Paint the description.\r
af047db7 2401 //\r
6f05c023 2402 PromptWidth = GetWidth (MenuOption, &AdjustValue);\r
28401a65 2403 Row = MenuOption->Row;\r
af047db7
ED
2404 GlyphWidth = 1;\r
2405 PromptLineNum = 0;\r
2406\r
2407 if (MenuOption->Description == NULL || MenuOption->Description[0] == '\0') {\r
28401a65
ED
2408 PrintStringAtWithWidth (BeginCol, Row, L"", PromptWidth + AdjustValue + SkipWidth);\r
2409 PromptLineNum++;\r
af047db7
ED
2410 } else {\r
2411 for (Index = 0; GetLineByWidth (MenuOption->Description, PromptWidth, &GlyphWidth, &Index, &OutputString) != 0x0000;) { \r
2412 if ((Temp == 0) && (Row <= BottomRow)) { \r
2413 //\r
2414 // 1.Clean the start LEFT_SKIPPED_COLUMNS \r
2415 //\r
2416 PrintStringAtWithWidth (BeginCol, Row, L"", SkipWidth);\r
2417 \r
8c9c60b6 2418 if (Statement->OpCode->OpCode == EFI_IFR_REF_OP && MenuOption->Col >= 2 && IsProcessingFirstRow) {\r
af047db7
ED
2419 //\r
2420 // Print Arrow for Goto button.\r
2421 //\r
2422 PrintCharAt (\r
2423 MenuOption->Col - 2,\r
2424 Row,\r
2425 GEOMETRICSHAPE_RIGHT_TRIANGLE\r
2426 );\r
8c9c60b6 2427 IsProcessingFirstRow = FALSE;\r
af047db7
ED
2428 }\r
2429 DisplayMenuString (MenuOption, MenuOption->Col, Row, OutputString, PromptWidth + AdjustValue, Highlight);\r
2430 PromptLineNum ++;\r
2431 }\r
2432 //\r
2433 // If there is more string to process print on the next row and increment the Skip value\r
2434 //\r
2435 if (StrLen (&MenuOption->Description[Index]) != 0) {\r
2436 if (Temp == 0) {\r
2437 Row++;\r
2438 }\r
2439 }\r
2440\r
2441 FreePool (OutputString);\r
2442 if (Temp != 0) {\r
2443 Temp--;\r
2444 }\r
2445 }\r
2446\r
2447 Highlight = FALSE;\r
af047db7 2448 }\r
af047db7
ED
2449\r
2450\r
2451 //\r
28401a65 2452 // 3. If this is a text op with secondary text information\r
af047db7
ED
2453 //\r
2454 if ((Statement->OpCode->OpCode == EFI_IFR_TEXT_OP) && (((EFI_IFR_TEXT*)Statement->OpCode)->TextTwo != 0)) {\r
2455 StringPtr = GetToken (((EFI_IFR_TEXT*)Statement->OpCode)->TextTwo, gFormData->HiiHandle);\r
2456 \r
2457 Width = (UINT16) gOptionBlockWidth - 1;\r
28401a65 2458 Row = MenuOption->Row;\r
af047db7 2459 GlyphWidth = 1;\r
28401a65 2460 OptionLineNum = 0;\r
af047db7
ED
2461\r
2462 for (Index = 0; GetLineByWidth (StringPtr, Width, &GlyphWidth, &Index, &OutputString) != 0x0000;) { \r
2463 if ((Temp3 == 0) && (Row <= BottomRow)) {\r
2464 DisplayMenuString (MenuOption, MenuOption->OptCol, Row, OutputString, Width + 1, Highlight);\r
28401a65 2465 OptionLineNum++;\r
af047db7
ED
2466 }\r
2467 //\r
2468 // If there is more string to process print on the next row and increment the Skip value\r
2469 //\r
2470 if (StrLen (&StringPtr[Index]) != 0) {\r
2471 if (Temp3 == 0) {\r
2472 Row++;\r
a6a2a956
ED
2473 //\r
2474 // If the rows for text two is greater than or equal to the skip value, increase the skip value\r
2475 //\r
2476 if ((Row - MenuOption->Row) >= MenuOption->Skip) {\r
2477 MenuOption->Skip++;\r
2478 }\r
af047db7
ED
2479 }\r
2480 }\r
2481 \r
2482 FreePool (OutputString);\r
2483 if (Temp3 != 0) {\r
2484 Temp3--;\r
2485 }\r
2486 }\r
28401a65 2487\r
af047db7
ED
2488 FreePool (StringPtr);\r
2489 }\r
2490\r
28401a65
ED
2491 //\r
2492 // 4.Line number for Option string and prompt string are not equal.\r
2493 // Clean the column whose line number is less.\r
2494 //\r
2495 if (HasOptionString(MenuOption) && (OptionLineNum != PromptLineNum)) {\r
2496 Col = OptionLineNum < PromptLineNum ? MenuOption->OptCol : BeginCol;\r
2497 Row = (OptionLineNum < PromptLineNum ? OptionLineNum : PromptLineNum) + MenuOption->Row;\r
2498 Width = (UINT16) (OptionLineNum < PromptLineNum ? gOptionBlockWidth : PromptWidth + AdjustValue + SkipWidth);\r
2499 MaxRow = (OptionLineNum < PromptLineNum ? PromptLineNum : OptionLineNum) + MenuOption->Row - 1;\r
2500 \r
2501 while (Row <= MaxRow) {\r
2502 DisplayMenuString (MenuOption, Col, Row++, L"", Width, FALSE);\r
2503 }\r
2504 }\r
2505\r
af047db7
ED
2506 return EFI_SUCCESS;\r
2507}\r
2508\r
7c6c064c
ED
2509/**\r
2510 Display menu and wait for user to select one menu option, then return it.\r
2511 If AutoBoot is enabled, then if user doesn't select any option,\r
2512 after period of time, it will automatically return the first menu option.\r
2513\r
2514 @param FormData The current form data info.\r
2515\r
2516 @retval EFI_SUCESSS Process the user selection success.\r
2517 @retval EFI_NOT_FOUND Process option string for orderedlist/Oneof fail.\r
2518\r
2519**/\r
2520EFI_STATUS\r
2521UiDisplayMenu (\r
2522 IN FORM_DISPLAY_ENGINE_FORM *FormData\r
2523 )\r
2524{\r
ab369468 2525 UINTN SkipValue;\r
7c6c064c
ED
2526 INTN Difference;\r
2527 UINTN DistanceValue;\r
2528 UINTN Row;\r
2529 UINTN Col;\r
7c6c064c
ED
2530 UINTN Temp;\r
2531 UINTN Temp2;\r
7c6c064c
ED
2532 UINTN TopRow;\r
2533 UINTN BottomRow;\r
7c6c064c 2534 UINTN Index;\r
7c6c064c
ED
2535 CHAR16 *StringPtr;\r
2536 CHAR16 *OptionString;\r
7c6c064c
ED
2537 CHAR16 *HelpString;\r
2538 CHAR16 *HelpHeaderString;\r
2539 CHAR16 *HelpBottomString;\r
2540 BOOLEAN NewLine;\r
2541 BOOLEAN Repaint;\r
2542 BOOLEAN UpArrow;\r
2543 BOOLEAN DownArrow;\r
2544 EFI_STATUS Status;\r
2545 EFI_INPUT_KEY Key;\r
2546 LIST_ENTRY *Link;\r
2547 LIST_ENTRY *NewPos;\r
2548 LIST_ENTRY *TopOfScreen;\r
2549 LIST_ENTRY *SavedListEntry;\r
2550 UI_MENU_OPTION *MenuOption;\r
2551 UI_MENU_OPTION *NextMenuOption;\r
2552 UI_MENU_OPTION *SavedMenuOption;\r
7c6c064c
ED
2553 UI_CONTROL_FLAG ControlFlag;\r
2554 UI_SCREEN_OPERATION ScreenOperation;\r
7c6c064c 2555 FORM_DISPLAY_ENGINE_STATEMENT *Statement;\r
7c6c064c
ED
2556 BROWSER_HOT_KEY *HotKey;\r
2557 UINTN HelpPageIndex;\r
2558 UINTN HelpPageCount;\r
2559 UINTN RowCount;\r
2560 UINTN HelpLine;\r
2561 UINTN HelpHeaderLine;\r
2562 UINTN HelpBottomLine;\r
2563 BOOLEAN MultiHelpPage;\r
7c6c064c
ED
2564 UINT16 EachLineWidth;\r
2565 UINT16 HeaderLineWidth;\r
2566 UINT16 BottomLineWidth;\r
2567 EFI_STRING_ID HelpInfo;\r
2568 UI_EVENT_TYPE EventType;\r
af047db7 2569 BOOLEAN SkipHighLight;\r
7c6c064c
ED
2570\r
2571 EventType = UIEventNone;\r
2572 Status = EFI_SUCCESS;\r
2573 HelpString = NULL;\r
2574 HelpHeaderString = NULL;\r
2575 HelpBottomString = NULL;\r
2576 OptionString = NULL;\r
2577 ScreenOperation = UiNoOperation;\r
2578 NewLine = TRUE;\r
7c6c064c
ED
2579 HelpPageCount = 0;\r
2580 HelpLine = 0;\r
2581 RowCount = 0;\r
2582 HelpBottomLine = 0;\r
2583 HelpHeaderLine = 0;\r
2584 HelpPageIndex = 0;\r
2585 MultiHelpPage = FALSE;\r
2586 EachLineWidth = 0;\r
2587 HeaderLineWidth = 0;\r
2588 BottomLineWidth = 0;\r
7c6c064c
ED
2589 UpArrow = FALSE;\r
2590 DownArrow = FALSE;\r
2591 SkipValue = 0;\r
af047db7 2592 SkipHighLight = FALSE;\r
7c6c064c
ED
2593\r
2594 NextMenuOption = NULL;\r
7c6c064c
ED
2595 SavedMenuOption = NULL;\r
2596 HotKey = NULL;\r
2597 Repaint = TRUE;\r
2598 MenuOption = NULL;\r
af047db7 2599 gModalSkipColumn = (CHAR16) (gStatementDimensions.RightColumn - gStatementDimensions.LeftColumn) / 6;\r
7c6c064c
ED
2600\r
2601 ZeroMem (&Key, sizeof (EFI_INPUT_KEY));\r
2602\r
7c6c064c
ED
2603 TopRow = gStatementDimensions.TopRow + SCROLL_ARROW_HEIGHT;\r
2604 BottomRow = gStatementDimensions.BottomRow - SCROLL_ARROW_HEIGHT - 1;\r
2605\r
2606 Row = TopRow;\r
2607 if ((FormData->Attribute & HII_DISPLAY_MODAL) != 0) {\r
af047db7 2608 Col = gStatementDimensions.LeftColumn + LEFT_SKIPPED_COLUMNS + gModalSkipColumn;\r
7c6c064c
ED
2609 } else {\r
2610 Col = gStatementDimensions.LeftColumn + LEFT_SKIPPED_COLUMNS;\r
2611 }\r
2612\r
2613 FindTopMenu(FormData, &TopOfScreen, &NewPos, &SkipValue);\r
42645c3d
ED
2614 if (!IsListEmpty (&gMenuOption)) {\r
2615 NextMenuOption = MENU_OPTION_FROM_LINK (NewPos);\r
2616 gUserInput->SelectedStatement = NextMenuOption->ThisTag;\r
2617 }\r
7c6c064c
ED
2618\r
2619 gST->ConOut->EnableCursor (gST->ConOut, FALSE);\r
2620\r
2621 ControlFlag = CfInitialization;\r
2622 while (TRUE) {\r
2623 switch (ControlFlag) {\r
2624 case CfInitialization:\r
af047db7
ED
2625 if ((gOldFormEntry.HiiHandle != FormData->HiiHandle) || \r
2626 (!CompareGuid (&gOldFormEntry.FormSetGuid, &FormData->FormSetGuid))) {\r
2627 //\r
2628 // Clear Statement range if different formset is painted.\r
2629 //\r
2630 ClearLines (\r
2631 gStatementDimensions.LeftColumn,\r
2632 gStatementDimensions.RightColumn,\r
2633 TopRow - SCROLL_ARROW_HEIGHT,\r
2634 BottomRow + SCROLL_ARROW_HEIGHT,\r
2635 GetFieldTextColor ()\r
2636 );\r
7c6c064c 2637\r
7c6c064c 2638 }\r
af047db7 2639 ControlFlag = CfRepaint;\r
7c6c064c
ED
2640 break;\r
2641\r
2642 case CfRepaint:\r
2643 ControlFlag = CfRefreshHighLight;\r
2644\r
2645 if (Repaint) {\r
2646 //\r
2647 // Display menu\r
2648 //\r
2649 DownArrow = FALSE;\r
2650 UpArrow = FALSE;\r
2651 Row = TopRow;\r
2652\r
af047db7
ED
2653 gST->ConOut->SetAttribute (gST->ConOut, GetFieldTextColor ());\r
2654 \r
7c6c064c 2655 //\r
af047db7 2656 // 1. Check whether need to print the arrow up.\r
7c6c064c 2657 //\r
af047db7
ED
2658 if (!ValueIsScroll (TRUE, TopOfScreen)) {\r
2659 UpArrow = TRUE;\r
2660 }\r
af047db7 2661\r
ae4f5746
ED
2662 if ((FormData->Attribute & HII_DISPLAY_MODAL) != 0) {\r
2663 PrintStringAtWithWidth(gStatementDimensions.LeftColumn + gModalSkipColumn, TopRow - 1, L"", gStatementDimensions.RightColumn - gStatementDimensions.LeftColumn - 2 * gModalSkipColumn);\r
2664 } else {\r
2665 PrintStringAtWithWidth(gStatementDimensions.LeftColumn, TopRow - 1, L"", gStatementDimensions.RightColumn - gStatementDimensions.LeftColumn);\r
2666 }\r
af047db7
ED
2667 if (UpArrow) {\r
2668 gST->ConOut->SetAttribute (gST->ConOut, GetArrowColor ());\r
2669 PrintCharAt (\r
2670 gStatementDimensions.LeftColumn + gPromptBlockWidth + gOptionBlockWidth + 1,\r
7c6c064c 2671 TopRow - SCROLL_ARROW_HEIGHT,\r
af047db7 2672 ARROW_UP\r
7c6c064c 2673 );\r
af047db7 2674 gST->ConOut->SetAttribute (gST->ConOut, GetFieldTextColor ());\r
7c6c064c
ED
2675 }\r
2676\r
2677 //\r
2678 // 2.Paint the menu.\r
2679 //\r
2680 for (Link = TopOfScreen; Link != &gMenuOption; Link = Link->ForwardLink) {\r
2681 MenuOption = MENU_OPTION_FROM_LINK (Link);\r
2682 MenuOption->Row = Row;\r
2683 MenuOption->Col = Col;\r
2684 if ((FormData->Attribute & HII_DISPLAY_MODAL) != 0) {\r
af047db7 2685 MenuOption->OptCol = gStatementDimensions.LeftColumn + LEFT_SKIPPED_COLUMNS + gPromptBlockWidth + gModalSkipColumn;\r
7c6c064c 2686 } else {\r
af047db7 2687 MenuOption->OptCol = gStatementDimensions.LeftColumn + LEFT_SKIPPED_COLUMNS + gPromptBlockWidth;\r
7c6c064c
ED
2688 }\r
2689\r
7c6c064c
ED
2690 if (MenuOption->NestInStatement) {\r
2691 MenuOption->Col += SUBTITLE_INDENT;\r
2692 }\r
2693\r
7c6c064c 2694 //\r
af047db7 2695 // Save the highlight menu, will be used in CfRefreshHighLight case.\r
7c6c064c 2696 //\r
af047db7
ED
2697 if (Link == NewPos) {\r
2698 SavedMenuOption = MenuOption;\r
2699 SkipHighLight = TRUE;\r
7c6c064c 2700 }\r
ae4f5746
ED
2701\r
2702 if ((FormData->Attribute & HII_DISPLAY_MODAL) != 0) {\r
72f2eca2 2703 Status = DisplayOneMenu (MenuOption, \r
6f05c023 2704 MenuOption->Col - gStatementDimensions.LeftColumn,\r
ae4f5746
ED
2705 gStatementDimensions.LeftColumn + gModalSkipColumn, \r
2706 Link == TopOfScreen ? SkipValue : 0, \r
2707 BottomRow,\r
f0c5095b
ED
2708 (BOOLEAN) ((Link == NewPos) && IsSelectable(MenuOption)),\r
2709 TRUE\r
ae4f5746
ED
2710 );\r
2711 } else {\r
72f2eca2 2712 Status = DisplayOneMenu (MenuOption, \r
6f05c023 2713 MenuOption->Col - gStatementDimensions.LeftColumn,\r
ae4f5746
ED
2714 gStatementDimensions.LeftColumn, \r
2715 Link == TopOfScreen ? SkipValue : 0, \r
2716 BottomRow,\r
f0c5095b
ED
2717 (BOOLEAN) ((Link == NewPos) && IsSelectable(MenuOption)),\r
2718 TRUE\r
2719 );\r
ae4f5746 2720 }\r
7c6c064c 2721\r
72f2eca2 2722 if (EFI_ERROR (Status)) {\r
42645c3d
ED
2723 if (gMisMatch) {\r
2724 return EFI_SUCCESS;\r
2725 } else {\r
2726 return Status;\r
2727 }\r
72f2eca2 2728 }\r
7c6c064c
ED
2729 //\r
2730 // 3. Update the row info which will be used by next menu.\r
2731 //\r
2732 if (Link == TopOfScreen) {\r
2733 Row += MenuOption->Skip - SkipValue;\r
2734 } else {\r
2735 Row += MenuOption->Skip;\r
2736 }\r
2737\r
2738 if (Row > BottomRow) {\r
2739 if (!ValueIsScroll (FALSE, Link)) {\r
2740 DownArrow = TRUE;\r
2741 }\r
2742\r
2743 Row = BottomRow + 1;\r
2744 break;\r
2745 }\r
2746 }\r
2747\r
af047db7
ED
2748 //\r
2749 // 3. Menus in this form may not cover all form, clean the remain field.\r
2750 //\r
2751 while (Row <= BottomRow) {\r
2752 if ((FormData->Attribute & HII_DISPLAY_MODAL) != 0) {\r
ae4f5746 2753 PrintStringAtWithWidth(gStatementDimensions.LeftColumn + gModalSkipColumn, Row++, L"", gStatementDimensions.RightColumn - gStatementDimensions.LeftColumn - 2 * gModalSkipColumn);\r
af047db7
ED
2754 } else {\r
2755 PrintStringAtWithWidth(gStatementDimensions.LeftColumn, Row++, L"", gStatementDimensions.RightColumn - gHelpBlockWidth - gStatementDimensions.LeftColumn);\r
2756 }\r
7c6c064c
ED
2757 }\r
2758\r
af047db7
ED
2759 //\r
2760 // 4. Print the down arrow row.\r
2761 //\r
ae4f5746
ED
2762 if ((FormData->Attribute & HII_DISPLAY_MODAL) != 0) {\r
2763 PrintStringAtWithWidth(gStatementDimensions.LeftColumn + gModalSkipColumn, BottomRow + 1, L"", gStatementDimensions.RightColumn - gStatementDimensions.LeftColumn - 2 * + gModalSkipColumn);\r
2764 } else {\r
2765 PrintStringAtWithWidth(gStatementDimensions.LeftColumn, BottomRow + 1, L"", gStatementDimensions.RightColumn - gStatementDimensions.LeftColumn);\r
2766 }\r
7c6c064c
ED
2767 if (DownArrow) {\r
2768 gST->ConOut->SetAttribute (gST->ConOut, GetArrowColor ());\r
2769 PrintCharAt (\r
2770 gStatementDimensions.LeftColumn + gPromptBlockWidth + gOptionBlockWidth + 1,\r
2771 BottomRow + SCROLL_ARROW_HEIGHT,\r
2772 ARROW_DOWN\r
2773 );\r
2774 gST->ConOut->SetAttribute (gST->ConOut, GetFieldTextColor ());\r
2775 }\r
2776\r
2777 MenuOption = NULL;\r
2778 }\r
2779 break;\r
2780\r
2781 case CfRefreshHighLight:\r
2782\r
2783 //\r
2784 // MenuOption: Last menu option that need to remove hilight\r
2785 // MenuOption is set to NULL in Repaint\r
2786 // NewPos: Current menu option that need to hilight\r
2787 //\r
2788 ControlFlag = CfUpdateHelpString;\r
2789\r
42645c3d
ED
2790 UpdateHighlightMenuInfo(NewPos, TopOfScreen, SkipValue);\r
2791\r
af047db7 2792 if (SkipHighLight) {\r
af047db7 2793 SkipHighLight = FALSE;\r
42645c3d
ED
2794 MenuOption = SavedMenuOption;\r
2795 RefreshKeyHelp(gFormData, SavedMenuOption->ThisTag, FALSE);\r
af047db7
ED
2796 break;\r
2797 }\r
2798\r
8924aecd
ED
2799 if (IsListEmpty (&gMenuOption)) {\r
2800 //\r
2801 // No menu option, just update the hotkey filed.\r
2802 //\r
2803 RefreshKeyHelp(gFormData, NULL, FALSE);\r
2804 break;\r
2805 }\r
2806\r
7c6c064c
ED
2807 if (MenuOption != NULL && TopOfScreen == &MenuOption->Link) {\r
2808 Temp = SkipValue;\r
2809 } else {\r
2810 Temp = 0;\r
2811 }\r
2812 if (NewPos == TopOfScreen) {\r
2813 Temp2 = SkipValue;\r
2814 } else {\r
2815 Temp2 = 0;\r
2816 }\r
2817\r
2818 if (NewPos != NULL && (MenuOption == NULL || NewPos != &MenuOption->Link)) {\r
2819 if (MenuOption != NULL) {\r
2820 //\r
ab369468 2821 // Remove the old highlight menu.\r
7c6c064c 2822 //\r
ab369468
ED
2823 Status = DisplayOneMenu (MenuOption, \r
2824 MenuOption->Col - gStatementDimensions.LeftColumn,\r
2825 gStatementDimensions.LeftColumn, \r
2826 Temp, \r
2827 BottomRow,\r
f0c5095b 2828 FALSE,\r
ab369468
ED
2829 FALSE\r
2830 );\r
7c6c064c
ED
2831 }\r
2832\r
2833 //\r
2834 // This is the current selected statement\r
2835 //\r
2836 MenuOption = MENU_OPTION_FROM_LINK (NewPos);\r
42645c3d 2837 RefreshKeyHelp(gFormData, MenuOption->ThisTag, FALSE);\r
7c6c064c
ED
2838\r
2839 if (!IsSelectable (MenuOption)) {\r
7c6c064c
ED
2840 break;\r
2841 }\r
2842\r
ab369468
ED
2843 Status = DisplayOneMenu (MenuOption, \r
2844 MenuOption->Col - gStatementDimensions.LeftColumn,\r
2845 gStatementDimensions.LeftColumn, \r
2846 Temp2, \r
2847 BottomRow,\r
f0c5095b
ED
2848 TRUE,\r
2849 FALSE\r
ab369468 2850 );\r
7c6c064c
ED
2851 }\r
2852 break;\r
2853\r
2854 case CfUpdateHelpString:\r
2855 ControlFlag = CfPrepareToReadKey;\r
2856 if ((FormData->Attribute & HII_DISPLAY_MODAL) != 0) {\r
2857 break;\r
2858 }\r
2859\r
ab369468
ED
2860 //\r
2861 // NewLine means only update highlight menu (remove old highlight and highlith\r
2862 // the new one), not need to full repain the form.\r
2863 //\r
7c6c064c 2864 if (Repaint || NewLine) {\r
8924aecd
ED
2865 if (IsListEmpty (&gMenuOption)) {\r
2866 //\r
2867 // Don't print anything if no mwnu option.\r
2868 //\r
7c6c064c
ED
2869 StringPtr = GetToken (STRING_TOKEN (EMPTY_STRING), gHiiHandle);\r
2870 } else {\r
8924aecd
ED
2871 //\r
2872 // Don't print anything if it is a NULL help token\r
2873 //\r
2874 ASSERT(MenuOption != NULL);\r
2875 HelpInfo = ((EFI_IFR_STATEMENT_HEADER *) ((CHAR8 *)MenuOption->ThisTag->OpCode + sizeof (EFI_IFR_OP_HEADER)))->Help;\r
2876 if (HelpInfo == 0 || !IsSelectable (MenuOption)) {\r
2877 StringPtr = GetToken (STRING_TOKEN (EMPTY_STRING), gHiiHandle);\r
2878 } else {\r
2879 StringPtr = GetToken (HelpInfo, gFormData->HiiHandle);\r
2880 }\r
7c6c064c
ED
2881 }\r
2882\r
2883 RowCount = BottomRow - TopRow + 1;\r
2884 HelpPageIndex = 0;\r
2885 //\r
2886 // 1.Calculate how many line the help string need to print.\r
2887 //\r
2888 if (HelpString != NULL) {\r
2889 FreePool (HelpString);\r
2890 HelpString = NULL;\r
2891 }\r
2892 HelpLine = ProcessHelpString (StringPtr, &HelpString, &EachLineWidth, RowCount);\r
2893 FreePool (StringPtr);\r
2894\r
2895 if (HelpLine > RowCount) {\r
2896 MultiHelpPage = TRUE;\r
2897 StringPtr = GetToken (STRING_TOKEN(ADJUST_HELP_PAGE_UP), gHiiHandle);\r
2898 if (HelpHeaderString != NULL) {\r
2899 FreePool (HelpHeaderString);\r
2900 HelpHeaderString = NULL;\r
2901 }\r
2902 HelpHeaderLine = ProcessHelpString (StringPtr, &HelpHeaderString, &HeaderLineWidth, 0);\r
2903 FreePool (StringPtr);\r
2904 StringPtr = GetToken (STRING_TOKEN(ADJUST_HELP_PAGE_DOWN), gHiiHandle);\r
2905 if (HelpBottomString != NULL) {\r
2906 FreePool (HelpBottomString);\r
2907 HelpBottomString = NULL;\r
2908 }\r
2909 HelpBottomLine = ProcessHelpString (StringPtr, &HelpBottomString, &BottomLineWidth, 0);\r
2910 FreePool (StringPtr);\r
2911 //\r
2912 // Calculate the help page count.\r
2913 //\r
2914 if (HelpLine > 2 * RowCount - 2) {\r
2915 HelpPageCount = (HelpLine - RowCount + 1) / (RowCount - 2) + 1;\r
2916 if ((HelpLine - RowCount + 1) % (RowCount - 2) > 1) {\r
2917 HelpPageCount += 1;\r
2918 }\r
2919 } else {\r
2920 HelpPageCount = 2;\r
2921 }\r
2922 } else {\r
2923 MultiHelpPage = FALSE;\r
2924 }\r
2925 }\r
2926\r
2927 //\r
2928 // Check whether need to show the 'More(U/u)' at the begin.\r
2929 // Base on current direct info, here shows aligned to the right side of the column.\r
2930 // If the direction is multi line and aligned to right side may have problem, so \r
2931 // add ASSERT code here.\r
2932 //\r
2933 if (HelpPageIndex > 0) {\r
2934 gST->ConOut->SetAttribute (gST->ConOut, GetInfoTextColor ());\r
2935 for (Index = 0; Index < HelpHeaderLine; Index++) {\r
2936 ASSERT (HelpHeaderLine == 1);\r
2937 ASSERT (GetStringWidth (HelpHeaderString) / 2 < (UINTN) (gHelpBlockWidth - 1));\r
2938 PrintStringAtWithWidth (\r
2939 gStatementDimensions.RightColumn - gHelpBlockWidth,\r
2940 Index + TopRow,\r
2941 gEmptyString,\r
2942 gHelpBlockWidth\r
2943 );\r
2944 PrintStringAt (\r
2945 gStatementDimensions.RightColumn - GetStringWidth (HelpHeaderString) / 2 - 1,\r
2946 Index + TopRow,\r
2947 &HelpHeaderString[Index * HeaderLineWidth]\r
2948 );\r
2949 }\r
2950 }\r
2951\r
2952 gST->ConOut->SetAttribute (gST->ConOut, GetHelpTextColor ());\r
2953 //\r
2954 // Print the help string info.\r
2955 //\r
2956 if (!MultiHelpPage) {\r
2957 for (Index = 0; Index < HelpLine; Index++) {\r
2958 PrintStringAtWithWidth (\r
2959 gStatementDimensions.RightColumn - gHelpBlockWidth,\r
2960 Index + TopRow,\r
2961 &HelpString[Index * EachLineWidth],\r
2962 gHelpBlockWidth\r
2963 );\r
2964 }\r
2965 for (; Index < RowCount; Index ++) {\r
2966 PrintStringAtWithWidth (\r
2967 gStatementDimensions.RightColumn - gHelpBlockWidth,\r
2968 Index + TopRow,\r
2969 gEmptyString,\r
2970 gHelpBlockWidth\r
2971 );\r
2972 }\r
2973 gST->ConOut->SetCursorPosition(gST->ConOut, gStatementDimensions.RightColumn-1, BottomRow);\r
2974 } else {\r
2975 if (HelpPageIndex == 0) {\r
2976 for (Index = 0; Index < RowCount - HelpBottomLine; Index++) {\r
2977 PrintStringAtWithWidth (\r
2978 gStatementDimensions.RightColumn - gHelpBlockWidth,\r
2979 Index + TopRow,\r
2980 &HelpString[Index * EachLineWidth],\r
2981 gHelpBlockWidth\r
2982 );\r
2983 }\r
2984 } else {\r
2985 for (Index = 0; (Index < RowCount - HelpBottomLine - HelpHeaderLine) && \r
2986 (Index + HelpPageIndex * (RowCount - 2) + 1 < HelpLine); Index++) {\r
2987 PrintStringAtWithWidth (\r
2988 gStatementDimensions.RightColumn - gHelpBlockWidth,\r
2989 Index + TopRow + HelpHeaderLine,\r
2990 &HelpString[(Index + HelpPageIndex * (RowCount - 2) + 1)* EachLineWidth],\r
2991 gHelpBlockWidth\r
2992 );\r
2993 }\r
2994 if (HelpPageIndex == HelpPageCount - 1) {\r
2995 for (; Index < RowCount - HelpHeaderLine; Index ++) {\r
2996 PrintStringAtWithWidth (\r
2997 gStatementDimensions.RightColumn - gHelpBlockWidth,\r
2998 Index + TopRow + HelpHeaderLine,\r
2999 gEmptyString,\r
3000 gHelpBlockWidth\r
3001 );\r
3002 }\r
3003 gST->ConOut->SetCursorPosition(gST->ConOut, gStatementDimensions.RightColumn-1, BottomRow);\r
3004 }\r
3005 } \r
3006 }\r
3007\r
3008 //\r
3009 // Check whether need to print the 'More(D/d)' at the bottom.\r
3010 // Base on current direct info, here shows aligned to the right side of the column.\r
3011 // If the direction is multi line and aligned to right side may have problem, so \r
3012 // add ASSERT code here.\r
3013 //\r
3014 if (HelpPageIndex < HelpPageCount - 1 && MultiHelpPage) {\r
3015 gST->ConOut->SetAttribute (gST->ConOut, GetInfoTextColor ());\r
3016 for (Index = 0; Index < HelpBottomLine; Index++) {\r
3017 ASSERT (HelpBottomLine == 1);\r
3018 ASSERT (GetStringWidth (HelpBottomString) / 2 < (UINTN) (gHelpBlockWidth - 1)); \r
3019 PrintStringAtWithWidth (\r
3020 gStatementDimensions.RightColumn - gHelpBlockWidth,\r
3021 BottomRow + Index - HelpBottomLine + 1,\r
3022 gEmptyString,\r
3023 gHelpBlockWidth\r
3024 );\r
3025 PrintStringAt (\r
3026 gStatementDimensions.RightColumn - GetStringWidth (HelpBottomString) / 2 - 1,\r
3027 BottomRow + Index - HelpBottomLine + 1,\r
3028 &HelpBottomString[Index * BottomLineWidth]\r
3029 );\r
3030 }\r
3031 }\r
3032 //\r
3033 // Reset this flag every time we finish using it.\r
3034 //\r
3035 Repaint = FALSE;\r
3036 NewLine = FALSE;\r
3037 break;\r
3038\r
3039 case CfPrepareToReadKey:\r
3040 ControlFlag = CfReadKey;\r
3041 ScreenOperation = UiNoOperation;\r
3042 break;\r
3043\r
3044 case CfReadKey:\r
3045 ControlFlag = CfScreenOperation;\r
3046\r
3047 //\r
3048 // Wait for user's selection\r
3049 //\r
3050 while (TRUE) {\r
3051 Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r
3052 if (!EFI_ERROR (Status)) {\r
3053 EventType = UIEventKey;\r
3054 break;\r
3055 }\r
3056\r
3057 //\r
3058 // If we encounter error, continue to read another key in.\r
3059 //\r
3060 if (Status != EFI_NOT_READY) {\r
3061 continue;\r
3062 }\r
3063 \r
3064 EventType = UiWaitForEvent(gST->ConIn->WaitForKey);\r
3065 if (EventType == UIEventKey) {\r
3066 gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r
3067 }\r
3068 break;\r
3069 }\r
3070\r
3071 if (EventType == UIEventDriver) {\r
42645c3d 3072 gMisMatch = TRUE;\r
7c6c064c
ED
3073 gUserInput->Action = BROWSER_ACTION_NONE;\r
3074 ControlFlag = CfExit;\r
3075 break;\r
3076 }\r
3077 \r
3078 if (EventType == UIEventTimeOut) {\r
3079 gUserInput->Action = BROWSER_ACTION_FORM_EXIT;\r
3080 ControlFlag = CfExit;\r
3081 break;\r
3082 }\r
3083\r
3084 switch (Key.UnicodeChar) {\r
3085 case CHAR_CARRIAGE_RETURN:\r
3086 if(MenuOption == NULL || MenuOption->GrayOut || MenuOption->ReadOnly) {\r
3087 ControlFlag = CfReadKey;\r
3088 break;\r
3089 }\r
3090\r
3091 ScreenOperation = UiSelect;\r
3092 gDirection = 0;\r
3093 break;\r
3094\r
3095 //\r
3096 // We will push the adjustment of these numeric values directly to the input handler\r
3097 // NOTE: we won't handle manual input numeric\r
3098 //\r
3099 case '+':\r
3100 case '-':\r
3101 //\r
3102 // If the screen has no menu items, and the user didn't select UiReset\r
3103 // ignore the selection and go back to reading keys.\r
3104 //\r
05de47ef 3105 ASSERT(MenuOption != NULL);\r
7c6c064c
ED
3106 if(IsListEmpty (&gMenuOption) || MenuOption->GrayOut || MenuOption->ReadOnly) {\r
3107 ControlFlag = CfReadKey;\r
3108 break;\r
3109 }\r
3110\r
7c6c064c
ED
3111 Statement = MenuOption->ThisTag;\r
3112 if ((Statement->OpCode->OpCode == EFI_IFR_DATE_OP)\r
3113 || (Statement->OpCode->OpCode == EFI_IFR_TIME_OP)\r
3114 || ((Statement->OpCode->OpCode == EFI_IFR_NUMERIC_OP) && (GetFieldFromNum(Statement->OpCode) != 0))\r
3115 ){\r
3116 if (Key.UnicodeChar == '+') {\r
3117 gDirection = SCAN_RIGHT;\r
3118 } else {\r
3119 gDirection = SCAN_LEFT;\r
3120 }\r
3121 \r
3122 Status = ProcessOptions (MenuOption, TRUE, &OptionString, TRUE);\r
3123 if (OptionString != NULL) {\r
3124 FreePool (OptionString);\r
3125 }\r
3126 if (EFI_ERROR (Status)) {\r
3127 //\r
3128 // Repaint to clear possible error prompt pop-up\r
3129 //\r
3130 Repaint = TRUE;\r
3131 NewLine = TRUE;\r
3132 } else {\r
3133 ControlFlag = CfExit;\r
3134 }\r
3135 }\r
3136 break;\r
3137\r
3138 case '^':\r
3139 ScreenOperation = UiUp;\r
3140 break;\r
3141\r
3142 case 'V':\r
3143 case 'v':\r
3144 ScreenOperation = UiDown;\r
3145 break;\r
3146\r
3147 case ' ':\r
3148 if(IsListEmpty (&gMenuOption)) {\r
3149 ControlFlag = CfReadKey;\r
3150 break;\r
3151 }\r
3152 \r
3153 ASSERT(MenuOption != NULL);\r
3154 if (MenuOption->ThisTag->OpCode->OpCode == EFI_IFR_CHECKBOX_OP && !MenuOption->GrayOut && !MenuOption->ReadOnly) {\r
3155 ScreenOperation = UiSelect;\r
3156 }\r
3157 break;\r
3158\r
3159 case 'D':\r
3160 case 'd':\r
3161 if (!MultiHelpPage) {\r
3162 ControlFlag = CfReadKey;\r
3163 break;\r
3164 }\r
3165 ControlFlag = CfUpdateHelpString;\r
3166 HelpPageIndex = HelpPageIndex < HelpPageCount - 1 ? HelpPageIndex + 1 : HelpPageCount - 1;\r
3167 break;\r
3168\r
3169 case 'U':\r
3170 case 'u':\r
3171 if (!MultiHelpPage) {\r
3172 ControlFlag = CfReadKey;\r
3173 break;\r
3174 }\r
3175 ControlFlag = CfUpdateHelpString;\r
3176 HelpPageIndex = HelpPageIndex > 0 ? HelpPageIndex - 1 : 0;\r
3177 break;\r
3178\r
3179 case CHAR_NULL:\r
3180 for (Index = 0; Index < mScanCodeNumber; Index++) {\r
3181 if (Key.ScanCode == gScanCodeToOperation[Index].ScanCode) {\r
3182 ScreenOperation = gScanCodeToOperation[Index].ScreenOperation;\r
3183 break;\r
3184 }\r
3185 }\r
3186 \r
3187 if (((FormData->Attribute & HII_DISPLAY_MODAL) != 0) && (Key.ScanCode == SCAN_ESC || Index == mScanCodeNumber)) {\r
3188 //\r
3189 // ModalForm has no ESC key and Hot Key.\r
3190 //\r
3191 ControlFlag = CfReadKey;\r
3192 } else if (Index == mScanCodeNumber) {\r
3193 //\r
3194 // Check whether Key matches the registered hot key.\r
3195 //\r
3196 HotKey = NULL;\r
3197 HotKey = GetHotKeyFromRegisterList (&Key);\r
3198 if (HotKey != NULL) {\r
3199 ScreenOperation = UiHotKey;\r
3200 }\r
3201 }\r
3202 break;\r
3203 }\r
3204 break;\r
3205\r
3206 case CfScreenOperation:\r
8924aecd 3207 if ((ScreenOperation != UiReset) && (ScreenOperation != UiHotKey)) {\r
7c6c064c 3208 //\r
8924aecd 3209 // If the screen has no menu items, and the user didn't select UiReset or UiHotKey\r
7c6c064c
ED
3210 // ignore the selection and go back to reading keys.\r
3211 //\r
3212 if (IsListEmpty (&gMenuOption)) {\r
3213 ControlFlag = CfReadKey;\r
3214 break;\r
3215 }\r
3216 }\r
3217\r
3218 for (Index = 0;\r
3219 Index < sizeof (gScreenOperationToControlFlag) / sizeof (gScreenOperationToControlFlag[0]);\r
3220 Index++\r
3221 ) {\r
3222 if (ScreenOperation == gScreenOperationToControlFlag[Index].ScreenOperation) {\r
3223 ControlFlag = gScreenOperationToControlFlag[Index].ControlFlag;\r
3224 break;\r
3225 }\r
3226 }\r
3227 break;\r
3228\r
3229 case CfUiSelect:\r
3230 ControlFlag = CfRepaint;\r
3231\r
3232 ASSERT(MenuOption != NULL);\r
3233 Statement = MenuOption->ThisTag;\r
3234 if (Statement->OpCode->OpCode == EFI_IFR_TEXT_OP) {\r
3235 break;\r
3236 }\r
3237\r
3238 switch (Statement->OpCode->OpCode) {\r
3239 case EFI_IFR_REF_OP:\r
3240 case EFI_IFR_ACTION_OP:\r
3241 case EFI_IFR_RESET_BUTTON_OP:\r
3242 ControlFlag = CfExit;\r
3243 break;\r
3244\r
3245 default:\r
3246 //\r
3247 // Editable Questions: oneof, ordered list, checkbox, numeric, string, password\r
3248 //\r
3249 RefreshKeyHelp (gFormData, Statement, TRUE);\r
3250 Status = ProcessOptions (MenuOption, TRUE, &OptionString, TRUE);\r
3251 \r
3252 if (OptionString != NULL) {\r
3253 FreePool (OptionString);\r
3254 }\r
3255 \r
3256 if (EFI_ERROR (Status)) {\r
3257 Repaint = TRUE;\r
3258 NewLine = TRUE;\r
3259 RefreshKeyHelp (gFormData, Statement, FALSE);\r
3260 break;\r
3261 } else {\r
3262 ControlFlag = CfExit;\r
3263 break;\r
3264 }\r
3265 }\r
3266 break;\r
3267\r
3268 case CfUiReset:\r
3269 //\r
3270 // We come here when someone press ESC\r
3271 // If the policy is not exit front page when user press ESC, process here.\r
3272 //\r
3273 if (!FormExitPolicy()) {\r
3274 Repaint = TRUE;\r
3275 NewLine = TRUE;\r
3276 ControlFlag = CfRepaint;\r
3277 break;\r
3278 }\r
3279\r
7c6c064c
ED
3280 gUserInput->Action = BROWSER_ACTION_FORM_EXIT;\r
3281 ControlFlag = CfExit;\r
3282 break;\r
3283\r
3284 case CfUiHotKey:\r
3285 ControlFlag = CfRepaint;\r
05de47ef
ED
3286\r
3287 ASSERT (HotKey != NULL);\r
23c7d425
ED
3288\r
3289 if (FxConfirmPopup(HotKey->Action)) {\r
3290 gUserInput->Action = HotKey->Action;\r
a687a1d2
ED
3291 if ((HotKey->Action & BROWSER_ACTION_DEFAULT) == BROWSER_ACTION_DEFAULT) {\r
3292 gUserInput->DefaultId = HotKey->DefaultId;\r
3293 }\r
23c7d425
ED
3294 ControlFlag = CfExit;\r
3295 } else {\r
3296 Repaint = TRUE;\r
3297 NewLine = TRUE;\r
3298 ControlFlag = CfRepaint;\r
3299 }\r
3300\r
7c6c064c
ED
3301 break;\r
3302\r
3303 case CfUiLeft:\r
3304 ControlFlag = CfRepaint;\r
3305 ASSERT(MenuOption != NULL);\r
3306 if ((MenuOption->ThisTag->OpCode->OpCode == EFI_IFR_DATE_OP) || (MenuOption->ThisTag->OpCode->OpCode == EFI_IFR_TIME_OP)) {\r
3307 if (MenuOption->Sequence != 0) {\r
3308 //\r
3309 // In the middle or tail of the Date/Time op-code set, go left.\r
3310 //\r
3311 ASSERT(NewPos != NULL);\r
3312 NewPos = NewPos->BackLink;\r
3313 }\r
3314 }\r
3315 break;\r
3316\r
3317 case CfUiRight:\r
3318 ControlFlag = CfRepaint;\r
3319 ASSERT(MenuOption != NULL);\r
3320 if ((MenuOption->ThisTag->OpCode->OpCode == EFI_IFR_DATE_OP) || (MenuOption->ThisTag->OpCode->OpCode == EFI_IFR_TIME_OP)) {\r
3321 if (MenuOption->Sequence != 2) {\r
3322 //\r
3323 // In the middle or tail of the Date/Time op-code set, go left.\r
3324 //\r
3325 ASSERT(NewPos != NULL);\r
3326 NewPos = NewPos->ForwardLink;\r
3327 }\r
3328 }\r
3329 break;\r
3330\r
3331 case CfUiUp:\r
3332 ControlFlag = CfRepaint;\r
ab369468 3333 NewLine = TRUE;\r
7c6c064c
ED
3334\r
3335 SavedListEntry = NewPos;\r
7c6c064c 3336 ASSERT(NewPos != NULL);\r
f0c5095b
ED
3337\r
3338 MenuOption = MENU_OPTION_FROM_LINK (NewPos);\r
3339 ASSERT (MenuOption != NULL);\r
3340\r
7c6c064c
ED
3341 //\r
3342 // Adjust Date/Time position before we advance forward.\r
3343 //\r
3344 AdjustDateAndTimePosition (TRUE, &NewPos);\r
7c6c064c 3345\r
ab369468
ED
3346 NewPos = NewPos->BackLink;\r
3347 //\r
3348 // Find next selectable menu or the first menu beyond current form.\r
3349 //\r
3350 Difference = MoveToNextStatement (TRUE, &NewPos, MenuOption->Row - TopRow, FALSE);\r
3351 if (Difference < 0) {\r
3352 //\r
3353 // We hit the begining MenuOption that can be focused\r
3354 // so we simply scroll to the top.\r
3355 //\r
3356 Repaint = TRUE;\r
3357 if (TopOfScreen != gMenuOption.ForwardLink || SkipValue != 0) {\r
3358 TopOfScreen = gMenuOption.ForwardLink;\r
3359 NewPos = SavedListEntry;\r
3360 SkipValue = 0;\r
3361 } else {\r
7c6c064c 3362 //\r
ab369468 3363 // Scroll up to the last page when we have arrived at top page.\r
7c6c064c 3364 //\r
ab369468
ED
3365 TopOfScreen = FindTopOfScreenMenu (gMenuOption.BackLink, BottomRow - TopRow, &SkipValue);\r
3366 NewPos = gMenuOption.BackLink;\r
3367 MoveToNextStatement (TRUE, &NewPos, BottomRow - TopRow, TRUE);\r
3368 }\r
3369 } else {\r
3370 NextMenuOption = MENU_OPTION_FROM_LINK (NewPos);\r
3371\r
3372 if (MenuOption->Row < TopRow + Difference + NextMenuOption->Skip) {\r
7c6c064c
ED
3373 //\r
3374 // Previous focus MenuOption is above the TopOfScreen, so we need to scroll\r
3375 //\r
3376 TopOfScreen = NewPos;\r
3377 Repaint = TRUE;\r
ab369468 3378 SkipValue = 0;\r
7c6c064c
ED
3379 }\r
3380\r
3381 //\r
ab369468 3382 // Check whether new highlight menu is selectable, if not, keep highlight on the old one.\r
7c6c064c 3383 //\r
ab369468
ED
3384 // BottomRow - TopRow + 1 means the total rows current forms supported.\r
3385 // Difference + NextMenuOption->Skip + 1 means the distance between last highlight menu \r
3386 // and new top menu. New top menu will all shows in next form, but last highlight menu \r
3387 // may only shows 1 line. + 1 at right part means at least need to keep 1 line for the \r
3388 // last highlight menu.\r
3389 // \r
3390 if (!IsSelectable(NextMenuOption) && IsSelectable(MenuOption) && \r
3391 (BottomRow - TopRow + 1 >= Difference + NextMenuOption->Skip + 1)) {\r
3392 NewPos = SavedListEntry;\r
6f05c023 3393 }\r
7c6c064c 3394 }\r
7c6c064c 3395\r
ab369468 3396 UpdateStatusBar (INPUT_ERROR, FALSE);\r
7c6c064c 3397\r
7c6c064c 3398 //\r
ab369468 3399 // If we encounter a Date/Time op-code set, rewind to the first op-code of the set.\r
7c6c064c 3400 //\r
ab369468
ED
3401 AdjustDateAndTimePosition (TRUE, &TopOfScreen);\r
3402 AdjustDateAndTimePosition (TRUE, &NewPos);\r
42645c3d
ED
3403\r
3404 UpdateHighlightMenuInfo(NewPos, TopOfScreen, SkipValue);\r
ab369468 3405 break;\r
7c6c064c 3406\r
ab369468 3407 case CfUiPageUp:\r
7c6c064c 3408 //\r
ab369468 3409 // SkipValue means lines is skipped when show the top menu option.\r
7c6c064c 3410 //\r
ab369468
ED
3411 ControlFlag = CfRepaint;\r
3412 NewLine = TRUE;\r
3413 Repaint = TRUE;\r
7c6c064c
ED
3414\r
3415 Link = TopOfScreen;\r
3416 //\r
3417 // First minus the menu of the top screen, it's value is SkipValue.\r
3418 //\r
2e7183ba 3419 if (SkipValue >= BottomRow - TopRow + 1) {\r
7c6c064c 3420 //\r
ab369468
ED
3421 // SkipValue > (BottomRow - TopRow + 1) means current menu has more than one\r
3422 // form of options to be show, so just update the SkipValue to show the next\r
3423 // parts of options.\r
7c6c064c 3424 //\r
ab369468
ED
3425 SkipValue -= BottomRow - TopRow + 1;\r
3426 NewPos = TopOfScreen;\r
3427 break;\r
3428 } else {\r
3429 Index = (BottomRow + 1) - SkipValue - TopRow;\r
7c6c064c 3430 }\r
ab369468
ED
3431 \r
3432 TopOfScreen = FindTopOfScreenMenu(TopOfScreen, Index, &SkipValue);\r
3433 NewPos = TopOfScreen;\r
3434 MoveToNextStatement (FALSE, &NewPos, BottomRow - TopRow, FALSE);\r
3435 \r
3436 UpdateStatusBar (INPUT_ERROR, FALSE);\r
7c6c064c
ED
3437\r
3438 //\r
3439 // If we encounter a Date/Time op-code set, rewind to the first op-code of the set.\r
3440 // Don't do this when we are already in the first page.\r
3441 //\r
3442 AdjustDateAndTimePosition (TRUE, &TopOfScreen);\r
3443 AdjustDateAndTimePosition (TRUE, &NewPos);\r
42645c3d
ED
3444\r
3445 UpdateHighlightMenuInfo(NewPos, TopOfScreen, SkipValue);\r
7c6c064c
ED
3446 break;\r
3447\r
3448 case CfUiPageDown:\r
3449 //\r
3450 // SkipValue means lines is skipped when show the top menu option.\r
3451 //\r
ab369468
ED
3452 ControlFlag = CfRepaint;\r
3453 NewLine = TRUE;\r
3454 Repaint = TRUE;\r
7c6c064c 3455\r
7c6c064c
ED
3456 Link = TopOfScreen;\r
3457 NextMenuOption = MENU_OPTION_FROM_LINK (Link);\r
3458 Index = TopRow + NextMenuOption->Skip - SkipValue;\r
3459 //\r
3460 // Count to the menu option which will show at the top of the next form.\r
3461 //\r
3462 while ((Index <= BottomRow + 1) && (Link->ForwardLink != &gMenuOption)) {\r
3463 Link = Link->ForwardLink;\r
3464 NextMenuOption = MENU_OPTION_FROM_LINK (Link);\r
3465 Index = Index + NextMenuOption->Skip;\r
3466 }\r
3467\r
3468 if ((Link->ForwardLink == &gMenuOption) && (Index <= BottomRow + 1)) {\r
3469 //\r
ab369468 3470 // Highlight on the last menu which can be highlight.\r
7c6c064c
ED
3471 //\r
3472 Repaint = FALSE;\r
ab369468 3473 MoveToNextStatement (TRUE, &Link, Index - TopRow, TRUE);\r
7c6c064c
ED
3474 } else {\r
3475 //\r
3476 // Calculate the skip line for top of screen menu.\r
3477 //\r
3478 if (Link == TopOfScreen) {\r
3479 //\r
3480 // The top of screen menu option occupies the entire form.\r
3481 //\r
3482 SkipValue += BottomRow - TopRow + 1;\r
3483 } else {\r
3484 SkipValue = NextMenuOption->Skip - (Index - (BottomRow + 1));\r
3485 }\r
7c6c064c
ED
3486 TopOfScreen = Link;\r
3487 MenuOption = NULL;\r
3488 //\r
3489 // Move to the Next selectable menu.\r
3490 //\r
ab369468 3491 MoveToNextStatement (FALSE, &Link, BottomRow - TopRow, TRUE);\r
7c6c064c
ED
3492 }\r
3493\r
3494 //\r
3495 // Save the menu as the next highlight menu.\r
3496 //\r
3497 NewPos = Link;\r
3498\r
ab369468
ED
3499 UpdateStatusBar (INPUT_ERROR, FALSE);\r
3500\r
7c6c064c
ED
3501 //\r
3502 // If we encounter a Date/Time op-code set, rewind to the first op-code of the set.\r
3503 // Don't do this when we are already in the last page.\r
3504 //\r
3505 AdjustDateAndTimePosition (TRUE, &TopOfScreen);\r
3506 AdjustDateAndTimePosition (TRUE, &NewPos);\r
42645c3d
ED
3507\r
3508 UpdateHighlightMenuInfo(NewPos, TopOfScreen, SkipValue);\r
7c6c064c
ED
3509 break;\r
3510\r
3511 case CfUiDown:\r
3512 //\r
3513 // SkipValue means lines is skipped when show the top menu option.\r
3514 // NewPos points to the menu which is highlighted now.\r
3515 //\r
3516 ControlFlag = CfRepaint;\r
ab369468 3517 NewLine = TRUE;\r
7c6c064c 3518\r
ab369468
ED
3519 if (NewPos == TopOfScreen) {\r
3520 Temp2 = SkipValue;\r
3521 } else {\r
3522 Temp2 = 0;\r
3523 }\r
3524\r
3525 SavedListEntry = NewPos;\r
7c6c064c
ED
3526 //\r
3527 // Since the behavior of hitting the down arrow on a Date/Time op-code is intended\r
3528 // to be one that progresses to the next set of op-codes, we need to advance to the last\r
3529 // Date/Time op-code and leave the remaining logic in UiDown intact so the appropriate\r
3530 // checking can be done. The only other logic we need to introduce is that if a Date/Time\r
3531 // op-code is the last entry in the menu, we need to rewind back to the first op-code of\r
3532 // the Date/Time op-code.\r
3533 //\r
7c6c064c
ED
3534 AdjustDateAndTimePosition (FALSE, &NewPos);\r
3535\r
ab369468
ED
3536 MenuOption = MENU_OPTION_FROM_LINK (NewPos);\r
3537 NewPos = NewPos->ForwardLink;\r
3538 //\r
3539 // Find the next selectable menu.\r
3540 //\r
3541 if (MenuOption->Row + MenuOption->Skip - Temp2 > BottomRow + 1) {\r
3542 if (gMenuOption.ForwardLink == NewPos || &gMenuOption == NewPos) {\r
3543 Difference = -1;\r
3544 } else {\r
3545 Difference = 0;\r
3546 }\r
3547 } else {\r
3548 Difference = MoveToNextStatement (FALSE, &NewPos, BottomRow + 1 - (MenuOption->Row + MenuOption->Skip - Temp2), FALSE);\r
3549 }\r
3550 if (Difference < 0) {\r
3551 //\r
3552 // Scroll to the first page.\r
3553 //\r
3554 if (TopOfScreen != gMenuOption.ForwardLink || SkipValue != 0) { \r
3555 TopOfScreen = gMenuOption.ForwardLink;\r
3556 Repaint = TRUE;\r
3557 MenuOption = NULL;\r
6f05c023 3558 } else {\r
ab369468 3559 MenuOption = MENU_OPTION_FROM_LINK (SavedListEntry);\r
6f05c023 3560 }\r
ab369468
ED
3561 NewPos = gMenuOption.ForwardLink;\r
3562 MoveToNextStatement (FALSE, &NewPos, BottomRow - TopRow, TRUE);\r
6f05c023 3563\r
ab369468
ED
3564 SkipValue = 0;\r
3565 //\r
3566 // If we are at the end of the list and sitting on a Date/Time op, rewind to the head.\r
3567 //\r
3568 AdjustDateAndTimePosition (TRUE, &TopOfScreen);\r
3569 AdjustDateAndTimePosition (TRUE, &NewPos);\r
42645c3d
ED
3570\r
3571 UpdateHighlightMenuInfo(NewPos, TopOfScreen, SkipValue);\r
ab369468
ED
3572 break;\r
3573 } \r
7c6c064c 3574\r
ab369468
ED
3575 //\r
3576 // Get next selected menu info.\r
3577 //\r
3578 AdjustDateAndTimePosition (FALSE, &NewPos);\r
3579 NextMenuOption = MENU_OPTION_FROM_LINK (NewPos);\r
3580 if (NextMenuOption->Row == 0) {\r
3581 UpdateOptionSkipLines (NextMenuOption);\r
3582 }\r
3583\r
3584 //\r
3585 // Calculate new highlight menu end row.\r
3586 //\r
3587 Temp = (MenuOption->Row + MenuOption->Skip - Temp2) + Difference + NextMenuOption->Skip - 1;\r
3588 if (Temp > BottomRow) {\r
7c6c064c 3589 //\r
ab369468 3590 // Get the top screen menu info.\r
7c6c064c 3591 //\r
ab369468
ED
3592 AdjustDateAndTimePosition (FALSE, &TopOfScreen);\r
3593 SavedMenuOption = MENU_OPTION_FROM_LINK (TopOfScreen);\r
3594\r
3595 //\r
3596 // Current Top screen menu occupy (SavedMenuOption->Skip - SkipValue) rows.\r
3597 // Full shows the new selected menu need to skip (Temp - BottomRow - 1) rows.\r
3598 //\r
3599 if ((Temp - BottomRow) >= (SavedMenuOption->Skip - SkipValue)) {\r
7c6c064c 3600 //\r
ab369468 3601 // Skip the top op-code\r
7c6c064c 3602 //\r
ab369468
ED
3603 TopOfScreen = TopOfScreen->ForwardLink;\r
3604 DistanceValue = (Temp - BottomRow) - (SavedMenuOption->Skip - SkipValue);\r
7c6c064c 3605\r
ab369468 3606 SavedMenuOption = MENU_OPTION_FROM_LINK (TopOfScreen);\r
7c6c064c 3607\r
ab369468
ED
3608 //\r
3609 // If we have a remainder, skip that many more op-codes until we drain the remainder\r
3610 // Special case is the selected highlight menu has more than one form of menus.\r
3611 //\r
3612 while (DistanceValue >= SavedMenuOption->Skip && TopOfScreen != NewPos) {\r
7c6c064c 3613 //\r
ab369468 3614 // Since the Difference is greater than or equal to this op-code's skip value, skip it\r
7c6c064c 3615 //\r
ab369468
ED
3616 DistanceValue = DistanceValue - (INTN) SavedMenuOption->Skip;\r
3617 TopOfScreen = TopOfScreen->ForwardLink;\r
7c6c064c 3618 SavedMenuOption = MENU_OPTION_FROM_LINK (TopOfScreen);\r
ab369468 3619 }\r
7c6c064c 3620 //\r
ab369468
ED
3621 // Since we will act on this op-code in the next routine, and increment the\r
3622 // SkipValue, set the skips to one less than what is required.\r
7c6c064c 3623 //\r
ab369468
ED
3624 if (TopOfScreen != NewPos) {\r
3625 SkipValue = DistanceValue;\r
3626 } else {\r
3627 SkipValue = 0;\r
3628 }\r
7c6c064c
ED
3629 } else {\r
3630 //\r
ab369468
ED
3631 // Since we will act on this op-code in the next routine, and increment the\r
3632 // SkipValue, set the skips to one less than what is required.\r
7c6c064c 3633 //\r
ab369468 3634 SkipValue += Temp - BottomRow;\r
7c6c064c 3635 }\r
ab369468
ED
3636 Repaint = TRUE;\r
3637 } else if (!IsSelectable (NextMenuOption)) {\r
7c6c064c 3638 //\r
ab369468 3639 // Continue to go down until scroll to next page or the selectable option is found.\r
7c6c064c 3640 //\r
ab369468
ED
3641 ScreenOperation = UiDown;\r
3642 ControlFlag = CfScreenOperation;\r
3643 break;\r
3644 }\r
3645\r
3646 MenuOption = MENU_OPTION_FROM_LINK (SavedListEntry);\r
3647\r
3648 //\r
3649 // Check whether new highlight menu is selectable, if not, keep highlight on the old one.\r
3650 //\r
3651 // BottomRow - TopRow + 1 means the total rows current forms supported.\r
3652 // Difference + NextMenuOption->Skip + 1 means the distance between last highlight menu \r
3653 // and new top menu. New top menu will all shows in next form, but last highlight menu \r
3654 // may only shows 1 line. + 1 at right part means at least need to keep 1 line for the \r
3655 // last highlight menu.\r
3656 // \r
3657 if (!IsSelectable (NextMenuOption) && IsSelectable (MenuOption) && \r
3658 (BottomRow - TopRow + 1 >= Difference + NextMenuOption->Skip + 1)) {\r
3659 NewPos = SavedListEntry;\r
7c6c064c
ED
3660 }\r
3661\r
ab369468
ED
3662 UpdateStatusBar (INPUT_ERROR, FALSE);\r
3663\r
7c6c064c
ED
3664 //\r
3665 // If we are at the end of the list and sitting on a Date/Time op, rewind to the head.\r
3666 //\r
3667 AdjustDateAndTimePosition (TRUE, &TopOfScreen);\r
3668 AdjustDateAndTimePosition (TRUE, &NewPos);\r
42645c3d
ED
3669\r
3670 UpdateHighlightMenuInfo(NewPos, TopOfScreen, SkipValue);\r
7c6c064c
ED
3671 break;\r
3672\r
3673 case CfUiNoOperation:\r
3674 ControlFlag = CfRepaint;\r
3675 break;\r
3676\r
3677 case CfExit:\r
5a9f73bf 3678 gST->ConOut->SetAttribute (gST->ConOut, EFI_TEXT_ATTR (EFI_LIGHTGRAY, EFI_BLACK));\r
7c6c064c
ED
3679 if (HelpString != NULL) {\r
3680 FreePool (HelpString);\r
3681 }\r
3682 if (HelpHeaderString != NULL) {\r
3683 FreePool (HelpHeaderString);\r
3684 }\r
3685 if (HelpBottomString != NULL) {\r
3686 FreePool (HelpBottomString);\r
3687 }\r
3688 return EFI_SUCCESS;\r
3689\r
3690 default:\r
3691 break;\r
3692 }\r
3693 }\r
3694}\r
3695\r
3696/**\r
3697\r
3698 Base on the browser status info to show an pop up message.\r
3699\r
3700**/\r
3701VOID\r
3702BrowserStatusProcess (\r
3703 VOID\r
3704 )\r
3705{\r
bfae1330
ED
3706 CHAR16 *ErrorInfo;\r
3707 EFI_INPUT_KEY Key;\r
3708 EFI_EVENT WaitList[2];\r
3709 EFI_EVENT RefreshIntervalEvent;\r
3710 EFI_EVENT TimeOutEvent;\r
3711 UINT8 TimeOut;\r
3712 EFI_STATUS Status;\r
3713 UINTN Index;\r
3714 WARNING_IF_CONTEXT EventContext;\r
3715 EFI_IFR_OP_HEADER *OpCodeBuf;\r
3716 EFI_STRING_ID StringToken;\r
4d4deaac
ED
3717 CHAR16 DiscardChange;\r
3718 CHAR16 JumpToFormSet;\r
3719 CHAR16 *PrintString;\r
7c6c064c
ED
3720\r
3721 if (gFormData->BrowserStatus == BROWSER_SUCCESS) {\r
3722 return;\r
3723 }\r
3724\r
bfae1330
ED
3725 StringToken = 0;\r
3726 TimeOutEvent = NULL;\r
3727 RefreshIntervalEvent = NULL;\r
3728 OpCodeBuf = NULL;\r
3729 if (gFormData->HighLightedStatement != NULL) {\r
3730 OpCodeBuf = gFormData->HighLightedStatement->OpCode;\r
3731 }\r
3732\r
3733 if (gFormData->BrowserStatus == (BROWSER_WARNING_IF)) {\r
3734 ASSERT (OpCodeBuf != NULL && OpCodeBuf->OpCode == EFI_IFR_WARNING_IF_OP);\r
3735\r
3736 TimeOut = ((EFI_IFR_WARNING_IF *) OpCodeBuf)->TimeOut;\r
3737 StringToken = ((EFI_IFR_WARNING_IF *) OpCodeBuf)->Warning;\r
3738 } else {\r
3739 TimeOut = 0;\r
3740 if ((gFormData->BrowserStatus == (BROWSER_NO_SUBMIT_IF)) &&\r
3741 (OpCodeBuf != NULL && OpCodeBuf->OpCode == EFI_IFR_NO_SUBMIT_IF_OP)) {\r
3742 StringToken = ((EFI_IFR_NO_SUBMIT_IF *) OpCodeBuf)->Error;\r
3743 } else if ((gFormData->BrowserStatus == (BROWSER_INCONSISTENT_IF)) &&\r
3744 (OpCodeBuf != NULL && OpCodeBuf->OpCode == EFI_IFR_INCONSISTENT_IF_OP)) {\r
3745 StringToken = ((EFI_IFR_INCONSISTENT_IF *) OpCodeBuf)->Error;\r
3746 }\r
3747 }\r
3748\r
3749 if (StringToken != 0) {\r
3750 ErrorInfo = GetToken (StringToken, gFormData->HiiHandle);\r
3751 } else if (gFormData->ErrorString != NULL) {\r
3752 //\r
3753 // Only used to compatible with old setup browser.\r
3754 // Not use this field in new browser core.\r
3755 //\r
7c6c064c
ED
3756 ErrorInfo = gFormData->ErrorString;\r
3757 } else {\r
3758 switch (gFormData->BrowserStatus) {\r
3759 case BROWSER_SUBMIT_FAIL:\r
3760 ErrorInfo = gSaveFailed;\r
3761 break;\r
3762\r
7c6c064c
ED
3763 case BROWSER_FORM_NOT_FOUND:\r
3764 ErrorInfo = gFormNotFound;\r
3765 break;\r
3766\r
3767 case BROWSER_FORM_SUPPRESS:\r
3768 ErrorInfo = gFormSuppress;\r
3769 break;\r
3770\r
3771 case BROWSER_PROTOCOL_NOT_FOUND:\r
3772 ErrorInfo = gProtocolNotFound;\r
3773 break;\r
3774\r
4d4deaac
ED
3775 case BROWSER_SUBMIT_FAIL_NO_SUBMIT_IF:\r
3776 ErrorInfo = gNoSubmitIfFailed;\r
3777 break;\r
3778\r
7c6c064c
ED
3779 default:\r
3780 ErrorInfo = gBrwoserError;\r
3781 break;\r
3782 }\r
3783 }\r
3784\r
4d4deaac
ED
3785 switch (gFormData->BrowserStatus) {\r
3786 case BROWSER_SUBMIT_FAIL:\r
3787 case BROWSER_SUBMIT_FAIL_NO_SUBMIT_IF:\r
3788 ASSERT (gUserInput != NULL);\r
3789 if (gFormData->BrowserStatus == (BROWSER_SUBMIT_FAIL)) {\r
3790 PrintString = gSaveProcess;\r
3791 JumpToFormSet = gJumpToFormSet[0];\r
3792 } else {\r
3793 PrintString = gSaveNoSubmitProcess;\r
3794 JumpToFormSet = gCheckError[0];\r
3795 }\r
3796 DiscardChange = gDiscardChange[0];\r
3797\r
bfae1330 3798 do {\r
4d4deaac
ED
3799 CreateDialog (&Key, gEmptyString, ErrorInfo, PrintString, gEmptyString, NULL);\r
3800 } while (((Key.UnicodeChar | UPPER_LOWER_CASE_OFFSET) != (DiscardChange | UPPER_LOWER_CASE_OFFSET)) &&\r
3801 ((Key.UnicodeChar | UPPER_LOWER_CASE_OFFSET) != (JumpToFormSet | UPPER_LOWER_CASE_OFFSET)));\r
bfae1330 3802\r
4d4deaac
ED
3803 if ((Key.UnicodeChar | UPPER_LOWER_CASE_OFFSET) == (DiscardChange | UPPER_LOWER_CASE_OFFSET)) {\r
3804 gUserInput->Action = BROWSER_ACTION_DISCARD;\r
3805 } else {\r
3806 gUserInput->Action = BROWSER_ACTION_GOTO;\r
3807 }\r
3808 break;\r
bfae1330 3809\r
4d4deaac
ED
3810 default:\r
3811 if (TimeOut == 0) {\r
3812 do {\r
3813 CreateDialog (&Key, gEmptyString, ErrorInfo, gPressEnter, gEmptyString, NULL);\r
3814 } while (Key.UnicodeChar != CHAR_CARRIAGE_RETURN);\r
3815 } else {\r
3816 Status = gBS->CreateEvent (EVT_NOTIFY_WAIT, TPL_CALLBACK, EmptyEventProcess, NULL, &TimeOutEvent);\r
3817 ASSERT_EFI_ERROR (Status);\r
bfae1330 3818\r
4d4deaac
ED
3819 EventContext.SyncEvent = TimeOutEvent;\r
3820 EventContext.TimeOut = &TimeOut;\r
3821 EventContext.ErrorInfo = ErrorInfo;\r
bfae1330 3822\r
4d4deaac
ED
3823 Status = gBS->CreateEvent (EVT_TIMER | EVT_NOTIFY_SIGNAL, TPL_CALLBACK, RefreshTimeOutProcess, &EventContext, &RefreshIntervalEvent);\r
3824 ASSERT_EFI_ERROR (Status);\r
bfae1330 3825\r
4d4deaac
ED
3826 //\r
3827 // Show the dialog first to avoid long time not reaction.\r
3828 //\r
3829 gBS->SignalEvent (RefreshIntervalEvent);\r
3830 \r
3831 Status = gBS->SetTimer (RefreshIntervalEvent, TimerPeriodic, ONE_SECOND);\r
3832 ASSERT_EFI_ERROR (Status);\r
bfae1330 3833\r
4d4deaac
ED
3834 while (TRUE) {\r
3835 Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r
3836 if (!EFI_ERROR (Status) && Key.UnicodeChar == CHAR_CARRIAGE_RETURN) {\r
3837 break;\r
3838 }\r
bfae1330 3839\r
4d4deaac
ED
3840 if (Status != EFI_NOT_READY) {\r
3841 continue;\r
3842 }\r
bfae1330 3843\r
4d4deaac
ED
3844 WaitList[0] = TimeOutEvent;\r
3845 WaitList[1] = gST->ConIn->WaitForKey;\r
bfae1330 3846\r
4d4deaac
ED
3847 Status = gBS->WaitForEvent (2, WaitList, &Index);\r
3848 ASSERT_EFI_ERROR (Status);\r
3849\r
3850 if (Index == 0) {\r
3851 //\r
3852 // Timeout occur, close the hoot time out event.\r
3853 //\r
3854 break;\r
3855 }\r
bfae1330 3856 }\r
4d4deaac
ED
3857\r
3858 gBS->CloseEvent (TimeOutEvent);\r
3859 gBS->CloseEvent (RefreshIntervalEvent);\r
bfae1330 3860 }\r
4d4deaac 3861 break;\r
bfae1330
ED
3862 }\r
3863\r
bfae1330
ED
3864 if (StringToken != 0) {\r
3865 FreePool (ErrorInfo);\r
3866 }\r
7c6c064c
ED
3867}\r
3868\r
3869/**\r
3870 Display one form, and return user input.\r
3871 \r
3872 @param FormData Form Data to be shown.\r
3873 @param UserInputData User input data.\r
3874 \r
3875 @retval EFI_SUCCESS 1.Form Data is shown, and user input is got.\r
3876 2.Error info has show and return.\r
3877 @retval EFI_INVALID_PARAMETER The input screen dimension is not valid\r
3878 @retval EFI_NOT_FOUND New form data has some error.\r
3879**/\r
3880EFI_STATUS\r
3881EFIAPI \r
3882FormDisplay (\r
3883 IN FORM_DISPLAY_ENGINE_FORM *FormData,\r
3884 OUT USER_INPUT *UserInputData\r
3885 )\r
3886{\r
3887 EFI_STATUS Status;\r
3888\r
3889 ASSERT (FormData != NULL);\r
3890 if (FormData == NULL) {\r
3891 return EFI_INVALID_PARAMETER;\r
3892 }\r
3893\r
3894 gUserInput = UserInputData;\r
3895 gFormData = FormData;\r
3896\r
3897 //\r
3898 // Process the status info first.\r
3899 //\r
3900 BrowserStatusProcess();\r
4d4deaac 3901 if (gFormData->BrowserStatus != BROWSER_SUCCESS) {\r
7c6c064c 3902 //\r
4d4deaac 3903 // gFormData->BrowserStatus != BROWSER_SUCCESS, means only need to print the error info, return here.\r
7c6c064c
ED
3904 //\r
3905 return EFI_SUCCESS;\r
3906 }\r
3907\r
7c6c064c
ED
3908 Status = DisplayPageFrame (FormData, &gStatementDimensions);\r
3909 if (EFI_ERROR (Status)) {\r
3910 return Status;\r
3911 }\r
3912\r
c4866c77
SEHM
3913 //\r
3914 // Global Widths should be initialized before any MenuOption creation\r
3915 // or the GetWidth() used in UiAddMenuOption() will return incorrect value.\r
3916 //\r
3917 //\r
3918 // Left right\r
3919 // |<-.->|<-.........->|<- .........->|<-...........->|\r
3920 // Skip Prompt Option Help \r
3921 //\r
3922 gOptionBlockWidth = (CHAR16) ((gStatementDimensions.RightColumn - gStatementDimensions.LeftColumn) / 3) + 1;\r
3923 gHelpBlockWidth = (CHAR16) (gOptionBlockWidth - 1 - LEFT_SKIPPED_COLUMNS);\r
3924 gPromptBlockWidth = (CHAR16) (gStatementDimensions.RightColumn - gStatementDimensions.LeftColumn - 2 * (gOptionBlockWidth - 1) - 1);\r
3925\r
3926 ConvertStatementToMenu();\r
3927\r
5a9f73bf
ED
3928 //\r
3929 // Check whether layout is changed.\r
3930 //\r
3931 if (mIsFirstForm \r
3932 || (gOldFormEntry.HiiHandle != FormData->HiiHandle)\r
3933 || (!CompareGuid (&gOldFormEntry.FormSetGuid, &FormData->FormSetGuid))\r
3934 || (gOldFormEntry.FormId != FormData->FormId)) {\r
7c6c064c 3935 mStatementLayoutIsChanged = TRUE;\r
5a9f73bf
ED
3936 } else {\r
3937 mStatementLayoutIsChanged = FALSE;\r
7c6c064c
ED
3938 }\r
3939\r
3940 Status = UiDisplayMenu(FormData);\r
5a9f73bf
ED
3941 \r
3942 //\r
3943 // Backup last form info.\r
3944 //\r
3945 mIsFirstForm = FALSE;\r
3946 gOldFormEntry.HiiHandle = FormData->HiiHandle;\r
3947 CopyGuid (&gOldFormEntry.FormSetGuid, &FormData->FormSetGuid);\r
3948 gOldFormEntry.FormId = FormData->FormId;\r
7c6c064c
ED
3949\r
3950 return Status;\r
3951}\r
3952\r
5a9f73bf
ED
3953/**\r
3954 Clear Screen to the initial state.\r
3955**/\r
3956VOID\r
3957EFIAPI \r
3958DriverClearDisplayPage (\r
3959 VOID\r
3960 )\r
3961{\r
3962 ClearDisplayPage ();\r
3963 mIsFirstForm = TRUE;\r
3964}\r
3965\r
3966/**\r
3967 Set Buffer to Value for Size bytes.\r
3968\r
3969 @param Buffer Memory to set.\r
3970 @param Size Number of bytes to set\r
3971 @param Value Value of the set operation.\r
3972\r
3973**/\r
3974VOID\r
3975SetUnicodeMem (\r
3976 IN VOID *Buffer,\r
3977 IN UINTN Size,\r
3978 IN CHAR16 Value\r
3979 )\r
3980{\r
3981 CHAR16 *Ptr;\r
3982\r
3983 Ptr = Buffer;\r
3984 while ((Size--) != 0) {\r
3985 *(Ptr++) = Value;\r
3986 }\r
3987}\r
3988\r
7c6c064c
ED
3989/**\r
3990 Initialize Setup Browser driver.\r
3991\r
3992 @param ImageHandle The image handle.\r
3993 @param SystemTable The system table.\r
3994\r
3995 @retval EFI_SUCCESS The Setup Browser module is initialized correctly..\r
3996 @return Other value if failed to initialize the Setup Browser module.\r
3997\r
3998**/\r
3999EFI_STATUS\r
4000EFIAPI\r
4001InitializeDisplayEngine (\r
4002 IN EFI_HANDLE ImageHandle,\r
4003 IN EFI_SYSTEM_TABLE *SystemTable\r
4004 )\r
4005{\r
4006 EFI_STATUS Status;\r
4007 EFI_INPUT_KEY HotKey;\r
4008 EFI_STRING NewString;\r
4009 EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL *FormBrowserEx2;\r
4010\r
4011 //\r
4012 // Publish our HII data\r
4013 //\r
4014 gHiiHandle = HiiAddPackages (\r
4015 &gDisplayEngineGuid,\r
4016 ImageHandle,\r
4017 DisplayEngineStrings,\r
4018 NULL\r
4019 );\r
4020 ASSERT (gHiiHandle != NULL);\r
4021\r
4022 //\r
4023 // Install Form Display protocol\r
4024 //\r
4025 Status = gBS->InstallProtocolInterface (\r
4026 &mPrivateData.Handle,\r
4027 &gEdkiiFormDisplayEngineProtocolGuid,\r
4028 EFI_NATIVE_INTERFACE,\r
4029 &mPrivateData.FromDisplayProt\r
4030 );\r
4031 ASSERT_EFI_ERROR (Status);\r
4032\r
4033 InitializeDisplayStrings();\r
5a9f73bf
ED
4034 \r
4035 ZeroMem (&gHighligthMenuInfo, sizeof (gHighligthMenuInfo));\r
4036 ZeroMem (&gOldFormEntry, sizeof (gOldFormEntry));\r
7c6c064c
ED
4037\r
4038 //\r
4039 // Use BrowserEx2 protocol to register HotKey.\r
4040 // \r
4041 Status = gBS->LocateProtocol (&gEdkiiFormBrowserEx2ProtocolGuid, NULL, (VOID **) &FormBrowserEx2);\r
4042 if (!EFI_ERROR (Status)) {\r
4043 //\r
4044 // Register the default HotKey F9 and F10 again.\r
4045 //\r
4046 HotKey.UnicodeChar = CHAR_NULL;\r
4047 HotKey.ScanCode = SCAN_F10;\r
4048 NewString = HiiGetString (gHiiHandle, STRING_TOKEN (FUNCTION_TEN_STRING), NULL);\r
4049 ASSERT (NewString != NULL);\r
4050 FormBrowserEx2->RegisterHotKey (&HotKey, BROWSER_ACTION_SUBMIT, 0, NewString);\r
4051\r
4052 HotKey.ScanCode = SCAN_F9;\r
4053 NewString = HiiGetString (gHiiHandle, STRING_TOKEN (FUNCTION_NINE_STRING), NULL);\r
4054 ASSERT (NewString != NULL);\r
4055 FormBrowserEx2->RegisterHotKey (&HotKey, BROWSER_ACTION_DEFAULT, EFI_HII_DEFAULT_CLASS_STANDARD, NewString);\r
4056 }\r
4057\r
4058 return EFI_SUCCESS;\r
4059}\r
4060\r
4061/**\r
4062 This is the default unload handle for display core drivers.\r
4063\r
4064 @param[in] ImageHandle The drivers' driver image.\r
4065\r
4066 @retval EFI_SUCCESS The image is unloaded.\r
4067 @retval Others Failed to unload the image.\r
4068\r
4069**/\r
4070EFI_STATUS\r
4071EFIAPI\r
4072UnloadDisplayEngine (\r
4073 IN EFI_HANDLE ImageHandle\r
4074 )\r
4075{\r
4076 HiiRemovePackages(gHiiHandle);\r
4077\r
4078 FreeDisplayStrings ();\r
4079\r
42645c3d
ED
4080 if (gHighligthMenuInfo.HLTOpCode != NULL) {\r
4081 FreePool (gHighligthMenuInfo.HLTOpCode);\r
4082 }\r
4083\r
4084 if (gHighligthMenuInfo.TOSOpCode != NULL) {\r
4085 FreePool (gHighligthMenuInfo.TOSOpCode);\r
336c8e11
ED
4086 }\r
4087\r
7c6c064c
ED
4088 return EFI_SUCCESS;\r
4089}\r