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