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