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