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