MdeModulePkg/Universal/SetupBrowserDxe/InputHandler.c

   1 /** @file
   2 Implementation for handling user input from the User Interfaces.
   3
   4 Copyright (c) 2004 - 2009, Intel Corporation. All rights reserved.<BR>
   5 This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #include "Setup.h"
  16
  17
  18 /**
  19   Get string or password input from user.
  20
  21   @param  MenuOption        Pointer to the current input menu.
  22   @param  Prompt            The prompt string shown on popup window.
  23   @param  StringPtr         Destination for use input string.
  24
  25   @retval EFI_SUCCESS       If string input is read successfully
  26   @retval EFI_DEVICE_ERROR  If operation fails
  27
  28 **/
  29 EFI_STATUS
  30 ReadString (
  31   IN  UI_MENU_OPTION              *MenuOption,
  32   IN  CHAR16                      *Prompt,
  33   OUT CHAR16                      *StringPtr
  34   )
  35 {
  36   EFI_STATUS              Status;
  37   EFI_INPUT_KEY           Key;
  38   CHAR16                  NullCharacter;
  39   UINTN                   ScreenSize;
  40   CHAR16                  Space[2];
  41   CHAR16                  KeyPad[2];
  42   CHAR16                  *TempString;
  43   CHAR16                  *BufferedString;
  44   UINTN                   Index;
  45   UINTN                   Count;
  46   UINTN                   Start;
  47   UINTN                   Top;
  48   UINTN                   DimensionsWidth;
  49   UINTN                   DimensionsHeight;
  50   BOOLEAN                 CursorVisible;
  51   UINTN                   Minimum;
  52   UINTN                   Maximum;
  53   FORM_BROWSER_STATEMENT  *Question;
  54   BOOLEAN                 IsPassword;
  55
  56   DimensionsWidth  = gScreenDimensions.RightColumn - gScreenDimensions.LeftColumn;
  57   DimensionsHeight = gScreenDimensions.BottomRow - gScreenDimensions.TopRow;
  58
  59   NullCharacter    = CHAR_NULL;
  60   ScreenSize       = GetStringWidth (Prompt) / sizeof (CHAR16);
  61   Space[0]         = L' ';
  62   Space[1]         = CHAR_NULL;
  63
  64   Question         = MenuOption->ThisTag;
  65   Minimum          = (UINTN) Question->Minimum;
  66   Maximum          = (UINTN) Question->Maximum;
  67
  68   if (Question->Operand == EFI_IFR_PASSWORD_OP) {
  69     IsPassword = TRUE;
  70   } else {
  71     IsPassword = FALSE;
  72   }
  73
  74   TempString = AllocateZeroPool ((Maximum + 1)* sizeof (CHAR16));
  75   ASSERT (TempString);
  76
  77   if (ScreenSize < (Maximum + 1)) {
  78     ScreenSize = Maximum + 1;
  79   }
  80
  81   if ((ScreenSize + 2) > DimensionsWidth) {
  82     ScreenSize = DimensionsWidth - 2;
  83   }
  84
  85   BufferedString = AllocateZeroPool (ScreenSize * 2);
  86   ASSERT (BufferedString);
  87
  88   Start = (DimensionsWidth - ScreenSize - 2) / 2 + gScreenDimensions.LeftColumn + 1;
  89   Top   = ((DimensionsHeight - 6) / 2) + gScreenDimensions.TopRow - 1;
  90
  91   //
  92   // Display prompt for string
  93   //
  94   CreateMultiStringPopUp (ScreenSize, 4, &NullCharacter, Prompt, Space, &NullCharacter);
  95
  96   gST->ConOut->SetAttribute (gST->ConOut, EFI_TEXT_ATTR (EFI_BLACK, EFI_LIGHTGRAY));
  97
  98   CursorVisible = gST->ConOut->Mode->CursorVisible;
  99   gST->ConOut->EnableCursor (gST->ConOut, TRUE);
 100
 101   do {
 102     Status = WaitForKeyStroke (&Key);
 103     ASSERT_EFI_ERROR (Status);
 104
 105     gST->ConOut->SetAttribute (gST->ConOut, EFI_TEXT_ATTR (EFI_BLACK, EFI_LIGHTGRAY));
 106     switch (Key.UnicodeChar) {
 107     case CHAR_NULL:
 108       switch (Key.ScanCode) {
 109       case SCAN_LEFT:
 110         break;
 111
 112       case SCAN_RIGHT:
 113         break;
 114
 115       case SCAN_ESC:
 116         FreePool (TempString);
 117         FreePool (BufferedString);
 118         gST->ConOut->SetAttribute (gST->ConOut, EFI_TEXT_ATTR (EFI_LIGHTGRAY, EFI_BLACK));
 119         gST->ConOut->EnableCursor (gST->ConOut, CursorVisible);
 120         return EFI_DEVICE_ERROR;
 121
 122       default:
 123         break;
 124       }
 125
 126       break;
 127
 128     case CHAR_CARRIAGE_RETURN:
 129       if (GetStringWidth (StringPtr) >= ((Minimum + 1) * sizeof (CHAR16))) {
 130
 131         FreePool (TempString);
 132         FreePool (BufferedString);
 133         gST->ConOut->SetAttribute (gST->ConOut, EFI_TEXT_ATTR (EFI_LIGHTGRAY, EFI_BLACK));
 134         gST->ConOut->EnableCursor (gST->ConOut, CursorVisible);
 135         return EFI_SUCCESS;
 136       } else {
 137         //
 138         // Simply create a popup to tell the user that they had typed in too few characters.
 139         // To save code space, we can then treat this as an error and return back to the menu.
 140         //
 141         do {
 142           CreateDialog (4, TRUE, 0, NULL, &Key, &NullCharacter, gMiniString, gPressEnter, &NullCharacter);
 143         } while (Key.UnicodeChar != CHAR_CARRIAGE_RETURN);
 144
 145         FreePool (TempString);
 146         FreePool (BufferedString);
 147         gST->ConOut->SetAttribute (gST->ConOut, EFI_TEXT_ATTR (EFI_LIGHTGRAY, EFI_BLACK));
 148         gST->ConOut->EnableCursor (gST->ConOut, CursorVisible);
 149         return EFI_DEVICE_ERROR;
 150       }
 151
 152       break;
 153
 154     case CHAR_BACKSPACE:
 155       if (StringPtr[0] != CHAR_NULL) {
 156         for (Index = 0; StringPtr[Index] != CHAR_NULL; Index++) {
 157           TempString[Index] = StringPtr[Index];
 158         }
 159         //
 160         // Effectively truncate string by 1 character
 161         //
 162         TempString[Index - 1] = CHAR_NULL;
 163         StrCpy (StringPtr, TempString);
 164       }
 165
 166     default:
 167       //
 168       // If it is the beginning of the string, don't worry about checking maximum limits
 169       //
 170       if ((StringPtr[0] == CHAR_NULL) && (Key.UnicodeChar != CHAR_BACKSPACE)) {
 171         StrnCpy (StringPtr, &Key.UnicodeChar, 1);
 172         StrnCpy (TempString, &Key.UnicodeChar, 1);
 173       } else if ((GetStringWidth (StringPtr) < ((Maximum + 1) * sizeof (CHAR16))) && (Key.UnicodeChar != CHAR_BACKSPACE)) {
 174         KeyPad[0] = Key.UnicodeChar;
 175         KeyPad[1] = CHAR_NULL;
 176         StrCat (StringPtr, KeyPad);
 177         StrCat (TempString, KeyPad);
 178       }
 179
 180       //
 181       // If the width of the input string is now larger than the screen, we nee to
 182       // adjust the index to start printing portions of the string
 183       //
 184       SetUnicodeMem (BufferedString, ScreenSize - 1, L' ');
 185       PrintStringAt (Start + 1, Top + 3, BufferedString);
 186
 187       if ((GetStringWidth (StringPtr) / 2) > (DimensionsWidth - 2)) {
 188         Index = (GetStringWidth (StringPtr) / 2) - DimensionsWidth + 2;
 189       } else {
 190         Index = 0;
 191       }
 192
 193       if (IsPassword) {
 194         gST->ConOut->SetCursorPosition (gST->ConOut, Start + 1, Top + 3);
 195       }
 196
 197       for (Count = 0; Index + 1 < GetStringWidth (StringPtr) / 2; Index++, Count++) {
 198         BufferedString[Count] = StringPtr[Index];
 199
 200         if (IsPassword) {
 201           PrintChar (L'*');
 202         }
 203       }
 204
 205       if (!IsPassword) {
 206         PrintStringAt (Start + 1, Top + 3, BufferedString);
 207       }
 208       break;
 209     }
 210
 211     gST->ConOut->SetAttribute (gST->ConOut, EFI_TEXT_ATTR (EFI_LIGHTGRAY, EFI_BLACK));
 212     gST->ConOut->SetCursorPosition (gST->ConOut, Start + GetStringWidth (StringPtr) / 2, Top + 3);
 213   } while (TRUE);
 214
 215 }
 216
 217
 218 /**
 219   This routine reads a numeric value from the user input.
 220
 221   @param  Selection         Pointer to current selection.
 222   @param  MenuOption        Pointer to the current input menu.
 223
 224   @retval EFI_SUCCESS       If numerical input is read successfully
 225   @retval EFI_DEVICE_ERROR  If operation fails
 226
 227 **/
 228 EFI_STATUS
 229 GetNumericInput (
 230   IN  UI_MENU_SELECTION           *Selection,
 231   IN  UI_MENU_OPTION              *MenuOption
 232   )
 233 {
 234   EFI_STATUS              Status;
 235   UINTN                   Column;
 236   UINTN                   Row;
 237   CHAR16                  InputText[MAX_NUMERIC_INPUT_WIDTH];
 238   CHAR16                  FormattedNumber[MAX_NUMERIC_INPUT_WIDTH - 1];
 239   UINT64                  PreviousNumber[MAX_NUMERIC_INPUT_WIDTH - 3];
 240   UINTN                   Count;
 241   UINTN                   Loop;
 242   BOOLEAN                 ManualInput;
 243   BOOLEAN                 HexInput;
 244   BOOLEAN                 DateOrTime;
 245   UINTN                   InputWidth;
 246   UINT64                  EditValue;
 247   UINT64                  Step;
 248   UINT64                  Minimum;
 249   UINT64                  Maximum;
 250   UINTN                   EraseLen;
 251   UINT8                   Digital;
 252   EFI_INPUT_KEY           Key;
 253   EFI_HII_VALUE           *QuestionValue;
 254   FORM_BROWSER_FORM       *Form;
 255   FORM_BROWSER_FORMSET    *FormSet;
 256   FORM_BROWSER_STATEMENT  *Question;
 257
 258   Column            = MenuOption->OptCol;
 259   Row               = MenuOption->Row;
 260   PreviousNumber[0] = 0;
 261   Count             = 0;
 262   InputWidth        = 0;
 263   Digital           = 0;
 264
 265   FormSet       = Selection->FormSet;
 266   Form          = Selection->Form;
 267   Question      = MenuOption->ThisTag;
 268   QuestionValue = &Question->HiiValue;
 269   Step          = Question->Step;
 270   Minimum       = Question->Minimum;
 271   Maximum       = Question->Maximum;
 272
 273   if ((Question->Operand == EFI_IFR_DATE_OP) || (Question->Operand == EFI_IFR_TIME_OP)) {
 274     DateOrTime = TRUE;
 275   } else {
 276     DateOrTime = FALSE;
 277   }
 278
 279   //
 280   // Prepare Value to be edit
 281   //
 282   EraseLen = 0;
 283   EditValue = 0;
 284   if (Question->Operand == EFI_IFR_DATE_OP) {
 285     Step = 1;
 286     Minimum = 1;
 287
 288     switch (MenuOption->Sequence) {
 289     case 0:
 290       Maximum = 12;
 291       EraseLen = 4;
 292       EditValue = QuestionValue->Value.date.Month;
 293       break;
 294
 295     case 1:
 296       Maximum = 31;
 297       EraseLen = 3;
 298       EditValue = QuestionValue->Value.date.Day;
 299       break;
 300
 301     case 2:
 302       Maximum = 0xffff;
 303       EraseLen = 5;
 304       EditValue = QuestionValue->Value.date.Year;
 305       break;
 306
 307     default:
 308       break;
 309     }
 310   } else if (Question->Operand == EFI_IFR_TIME_OP) {
 311     Step = 1;
 312     Minimum = 0;
 313
 314     switch (MenuOption->Sequence) {
 315     case 0:
 316       Maximum = 23;
 317       EraseLen = 4;
 318       EditValue = QuestionValue->Value.time.Hour;
 319       break;
 320
 321     case 1:
 322       Maximum = 59;
 323       EraseLen = 3;
 324       EditValue = QuestionValue->Value.time.Minute;
 325       break;
 326
 327     case 2:
 328       Maximum = 59;
 329       EraseLen = 3;
 330       EditValue = QuestionValue->Value.time.Second;
 331       break;
 332
 333     default:
 334       break;
 335     }
 336   } else {
 337     //
 338     // Numeric
 339     //
 340     EraseLen = gOptionBlockWidth;
 341     EditValue = QuestionValue->Value.u64;
 342     if (Maximum == 0) {
 343       Maximum = (UINT64) -1;
 344     }
 345   }
 346
 347   if (Step == 0) {
 348     ManualInput = TRUE;
 349   } else {
 350     ManualInput = FALSE;
 351   }
 352
 353   if ((Question->Operand == EFI_IFR_NUMERIC_OP) &&
 354       ((Question->Flags & EFI_IFR_DISPLAY) == EFI_IFR_DISPLAY_UINT_HEX)) {
 355     HexInput = TRUE;
 356   } else {
 357     HexInput = FALSE;
 358   }
 359
 360   if (ManualInput) {
 361     if (HexInput) {
 362       InputWidth = Question->StorageWidth * 2;
 363     } else {
 364       switch (Question->StorageWidth) {
 365       case 1:
 366         InputWidth = 3;
 367         break;
 368
 369       case 2:
 370         InputWidth = 5;
 371         break;
 372
 373       case 4:
 374         InputWidth = 10;
 375         break;
 376
 377       case 8:
 378         InputWidth = 20;
 379         break;
 380
 381       default:
 382         InputWidth = 0;
 383         break;
 384       }
 385     }
 386
 387     InputText[0] = LEFT_NUMERIC_DELIMITER;
 388     SetUnicodeMem (InputText + 1, InputWidth, L' ');
 389     ASSERT (InputWidth + 2 < MAX_NUMERIC_INPUT_WIDTH);
 390     InputText[InputWidth + 1] = RIGHT_NUMERIC_DELIMITER;
 391     InputText[InputWidth + 2] = L'\0';
 392
 393     PrintAt (Column, Row, InputText);
 394     Column++;
 395   }
 396
 397   //
 398   // First time we enter this handler, we need to check to see if
 399   // we were passed an increment or decrement directive
 400   //
 401   do {
 402     Key.UnicodeChar = CHAR_NULL;
 403     if (gDirection != 0) {
 404       Key.ScanCode  = gDirection;
 405       gDirection    = 0;
 406       goto TheKey2;
 407     }
 408
 409     Status = WaitForKeyStroke (&Key);
 410
 411 TheKey2:
 412     switch (Key.UnicodeChar) {
 413
 414     case '+':
 415     case '-':
 416       if (Key.UnicodeChar == '+') {
 417         Key.ScanCode = SCAN_RIGHT;
 418       } else {
 419         Key.ScanCode = SCAN_LEFT;
 420       }
 421       Key.UnicodeChar = CHAR_NULL;
 422       goto TheKey2;
 423
 424     case CHAR_NULL:
 425       switch (Key.ScanCode) {
 426       case SCAN_LEFT:
 427       case SCAN_RIGHT:
 428         if (DateOrTime) {
 429           //
 430           // By setting this value, we will return back to the caller.
 431           // We need to do this since an auto-refresh will destroy the adjustment
 432           // based on what the real-time-clock is showing.  So we always commit
 433           // upon changing the value.
 434           //
 435           gDirection = SCAN_DOWN;
 436         }
 437
 438         if (!ManualInput) {
 439           if (Key.ScanCode == SCAN_LEFT) {
 440             if (EditValue > Step) {
 441               EditValue = EditValue - Step;
 442             } else {
 443               EditValue = Minimum;
 444             }
 445           } else if (Key.ScanCode == SCAN_RIGHT) {
 446             EditValue = EditValue + Step;
 447             if (EditValue > Maximum) {
 448               EditValue = Maximum;
 449             }
 450           }
 451
 452           ZeroMem (FormattedNumber, 21 * sizeof (CHAR16));
 453           if (Question->Operand == EFI_IFR_DATE_OP) {
 454             if (MenuOption->Sequence == 2) {
 455               //
 456               // Year
 457               //
 458               UnicodeSPrint (FormattedNumber, 21 * sizeof (CHAR16), L"%04d", (UINT16) EditValue);
 459             } else {
 460               //
 461               // Month/Day
 462               //
 463               UnicodeSPrint (FormattedNumber, 21 * sizeof (CHAR16), L"%02d", (UINT8) EditValue);
 464             }
 465
 466             if (MenuOption->Sequence == 0) {
 467               FormattedNumber[EraseLen - 2] = DATE_SEPARATOR;
 468             } else if (MenuOption->Sequence == 1) {
 469               FormattedNumber[EraseLen - 1] = DATE_SEPARATOR;
 470             }
 471           } else if (Question->Operand == EFI_IFR_TIME_OP) {
 472             UnicodeSPrint (FormattedNumber, 21 * sizeof (CHAR16), L"%02d", (UINT8) EditValue);
 473
 474             if (MenuOption->Sequence == 0) {
 475               FormattedNumber[EraseLen - 2] = TIME_SEPARATOR;
 476             } else if (MenuOption->Sequence == 1) {
 477               FormattedNumber[EraseLen - 1] = TIME_SEPARATOR;
 478             }
 479           } else {
 480             QuestionValue->Value.u64 = EditValue;
 481             PrintFormattedNumber (Question, FormattedNumber, 21 * sizeof (CHAR16));
 482           }
 483
 484           gST->ConOut->SetAttribute (gST->ConOut, FIELD_TEXT | FIELD_BACKGROUND);
 485           for (Loop = 0; Loop < EraseLen; Loop++) {
 486             PrintAt (MenuOption->OptCol + Loop, MenuOption->Row, L" ");
 487           }
 488           gST->ConOut->SetAttribute (gST->ConOut, FIELD_TEXT_HIGHLIGHT | FIELD_BACKGROUND_HIGHLIGHT);
 489
 490           if (MenuOption->Sequence == 0) {
 491             PrintCharAt (MenuOption->OptCol, Row, LEFT_NUMERIC_DELIMITER);
 492             Column = MenuOption->OptCol + 1;
 493           }
 494
 495           PrintStringAt (Column, Row, FormattedNumber);
 496
 497           if (!DateOrTime || MenuOption->Sequence == 2) {
 498             PrintChar (RIGHT_NUMERIC_DELIMITER);
 499           }
 500         }
 501
 502         goto EnterCarriageReturn;
 503         break;
 504
 505       case SCAN_UP:
 506       case SCAN_DOWN:
 507         goto EnterCarriageReturn;
 508
 509       case SCAN_ESC:
 510         return EFI_DEVICE_ERROR;
 511
 512       default:
 513         break;
 514       }
 515
 516       break;
 517
 518 EnterCarriageReturn:
 519
 520     case CHAR_CARRIAGE_RETURN:
 521       //
 522       // Store Edit value back to Question
 523       //
 524       if (Question->Operand == EFI_IFR_DATE_OP) {
 525         switch (MenuOption->Sequence) {
 526         case 0:
 527           QuestionValue->Value.date.Month = (UINT8) EditValue;
 528           break;
 529
 530         case 1:
 531           QuestionValue->Value.date.Day = (UINT8) EditValue;
 532           break;
 533
 534         case 2:
 535           QuestionValue->Value.date.Year = (UINT16) EditValue;
 536           break;
 537
 538         default:
 539           break;
 540         }
 541       } else if (Question->Operand == EFI_IFR_TIME_OP) {
 542         switch (MenuOption->Sequence) {
 543         case 0:
 544           QuestionValue->Value.time.Hour = (UINT8) EditValue;
 545           break;
 546
 547         case 1:
 548           QuestionValue->Value.time.Minute = (UINT8) EditValue;
 549           break;
 550
 551         case 2:
 552           QuestionValue->Value.time.Second = (UINT8) EditValue;
 553           break;
 554
 555         default:
 556           break;
 557         }
 558       } else {
 559         //
 560         // Numeric
 561         //
 562         QuestionValue->Value.u64 = EditValue;
 563       }
 564
 565       //
 566       // Check to see if the Value is something reasonable against consistency limitations.
 567       // If not, let's kick the error specified.
 568       //
 569       Status = ValidateQuestion (FormSet, Form, Question, EFI_HII_EXPRESSION_INCONSISTENT_IF);
 570       if (EFI_ERROR (Status)) {
 571         //
 572         // Input value is not valid, restore Question Value
 573         //
 574         GetQuestionValue (FormSet, Form, Question, TRUE);
 575       } else {
 576         SetQuestionValue (FormSet, Form, Question, TRUE);
 577         if (!DateOrTime || (Question->Storage != NULL)) {
 578           //
 579           // NV flag is unnecessary for RTC type of Date/Time
 580           //
 581           UpdateStatusBar (NV_UPDATE_REQUIRED, Question->QuestionFlags, TRUE);
 582         }
 583       }
 584
 585       return Status;
 586       break;
 587
 588     case CHAR_BACKSPACE:
 589       if (ManualInput) {
 590         if (Count == 0) {
 591           break;
 592         }
 593         //
 594         // Remove a character
 595         //
 596         EditValue = PreviousNumber[Count - 1];
 597         UpdateStatusBar (INPUT_ERROR, Question->QuestionFlags, FALSE);
 598         Count--;
 599         Column--;
 600         PrintAt (Column, Row, L" ");
 601       }
 602       break;
 603
 604     default:
 605       if (ManualInput) {
 606         if (HexInput) {
 607           if ((Key.UnicodeChar >= L'0') && (Key.UnicodeChar <= L'9')) {
 608             Digital = (UINT8) (Key.UnicodeChar - L'0');
 609           } else if ((Key.UnicodeChar >= L'A') && (Key.UnicodeChar <= L'F')) {
 610             Digital = (UINT8) (Key.UnicodeChar - L'A' + 0x0A);
 611           } else if ((Key.UnicodeChar >= L'a') && (Key.UnicodeChar <= L'f')) {
 612             Digital = (UINT8) (Key.UnicodeChar - L'a' + 0x0A);
 613           } else {
 614             UpdateStatusBar (INPUT_ERROR, Question->QuestionFlags, TRUE);
 615             break;
 616           }
 617         } else {
 618           if (Key.UnicodeChar > L'9' || Key.UnicodeChar < L'0') {
 619             UpdateStatusBar (INPUT_ERROR, Question->QuestionFlags, TRUE);
 620             break;
 621           }
 622         }
 623
 624         //
 625         // If Count exceed input width, there is no way more is valid
 626         //
 627         if (Count >= InputWidth) {
 628           break;
 629         }
 630         //
 631         // Someone typed something valid!
 632         //
 633         if (Count != 0) {
 634           if (HexInput) {
 635             EditValue = LShiftU64 (EditValue, 4) + Digital;
 636           } else {
 637             EditValue = MultU64x32 (EditValue, 10) + (Key.UnicodeChar - L'0');
 638           }
 639         } else {
 640           if (HexInput) {
 641             EditValue = Digital;
 642           } else {
 643             EditValue = Key.UnicodeChar - L'0';
 644           }
 645         }
 646
 647         if (EditValue > Maximum) {
 648           UpdateStatusBar (INPUT_ERROR, Question->QuestionFlags, TRUE);
 649           ASSERT (Count < sizeof (PreviousNumber) / sizeof (PreviousNumber[0]));
 650           EditValue = PreviousNumber[Count];
 651           break;
 652         } else {
 653           UpdateStatusBar (INPUT_ERROR, Question->QuestionFlags, FALSE);
 654         }
 655
 656         Count++;
 657         ASSERT (Count < (sizeof (PreviousNumber) / sizeof (PreviousNumber[0])));
 658         PreviousNumber[Count] = EditValue;
 659
 660         PrintCharAt (Column, Row, Key.UnicodeChar);
 661         Column++;
 662       }
 663       break;
 664     }
 665   } while (TRUE);
 666
 667 }
 668
 669
 670 /**
 671   Get selection for OneOf and OrderedList (Left/Right will be ignored).
 672
 673   @param  Selection         Pointer to current selection.
 674   @param  MenuOption        Pointer to the current input menu.
 675
 676   @retval EFI_SUCCESS       If Option input is processed successfully
 677   @retval EFI_DEVICE_ERROR  If operation fails
 678
 679 **/
 680 EFI_STATUS
 681 GetSelectionInputPopUp (
 682   IN  UI_MENU_SELECTION           *Selection,
 683   IN  UI_MENU_OPTION              *MenuOption
 684   )
 685 {
 686   EFI_STATUS              Status;
 687   EFI_INPUT_KEY           Key;
 688   UINTN                   Index;
 689   CHAR16                  *StringPtr;
 690   CHAR16                  *TempStringPtr;
 691   UINTN                   Index2;
 692   UINTN                   TopOptionIndex;
 693   UINTN                   HighlightOptionIndex;
 694   UINTN                   Start;
 695   UINTN                   End;
 696   UINTN                   Top;
 697   UINTN                   Bottom;
 698   UINTN                   PopUpMenuLines;
 699   UINTN                   MenuLinesInView;
 700   UINTN                   PopUpWidth;
 701   CHAR16                  Character;
 702   INT32                   SavedAttribute;
 703   BOOLEAN                 ShowDownArrow;
 704   BOOLEAN                 ShowUpArrow;
 705   UINTN                   DimensionsWidth;
 706   LIST_ENTRY              *Link;
 707   BOOLEAN                 OrderedList;
 708   UINT8                   *ValueArray;
 709   UINT8                   ValueType;
 710   EFI_HII_VALUE           HiiValue;
 711   EFI_HII_VALUE           *HiiValueArray;
 712   UINTN                   OptionCount;
 713   QUESTION_OPTION         *OneOfOption;
 714   QUESTION_OPTION         *CurrentOption;
 715   FORM_BROWSER_STATEMENT  *Question;
 716
 717   DimensionsWidth   = gScreenDimensions.RightColumn - gScreenDimensions.LeftColumn;
 718
 719   ValueArray        = NULL;
 720   ValueType         = 0;
 721   CurrentOption     = NULL;
 722   ShowDownArrow     = FALSE;
 723   ShowUpArrow       = FALSE;
 724
 725   StringPtr = AllocateZeroPool ((gOptionBlockWidth + 1) * 2);
 726   ASSERT (StringPtr);
 727
 728   Question = MenuOption->ThisTag;
 729   if (Question->Operand == EFI_IFR_ORDERED_LIST_OP) {
 730     ValueArray = Question->BufferValue;
 731     ValueType = Question->ValueType;
 732     OrderedList = TRUE;
 733   } else {
 734     OrderedList = FALSE;
 735   }
 736
 737   //
 738   // Calculate Option count
 739   //
 740   if (OrderedList) {
 741     for (Index = 0; Index < Question->MaxContainers; Index++) {
 742       if (GetArrayData (ValueArray, ValueType, Index) == 0) {
 743         break;
 744       }
 745     }
 746
 747     OptionCount = Index;
 748   } else {
 749     OptionCount = 0;
 750     Link = GetFirstNode (&Question->OptionListHead);
 751     while (!IsNull (&Question->OptionListHead, Link)) {
 752       OneOfOption = QUESTION_OPTION_FROM_LINK (Link);
 753
 754       OptionCount++;
 755
 756       Link = GetNextNode (&Question->OptionListHead, Link);
 757     }
 758   }
 759
 760   //
 761   // Prepare HiiValue array
 762   //
 763   HiiValueArray = AllocateZeroPool (OptionCount * sizeof (EFI_HII_VALUE));
 764   ASSERT (HiiValueArray != NULL);
 765   Link = GetFirstNode (&Question->OptionListHead);
 766   for (Index = 0; Index < OptionCount; Index++) {
 767     if (OrderedList) {
 768       HiiValueArray[Index].Type = ValueType;
 769       HiiValueArray[Index].Value.u64 = GetArrayData (ValueArray, ValueType, Index);
 770     } else {
 771       OneOfOption = QUESTION_OPTION_FROM_LINK (Link);
 772       CopyMem (&HiiValueArray[Index], &OneOfOption->Value, sizeof (EFI_HII_VALUE));
 773       Link = GetNextNode (&Question->OptionListHead, Link);
 774     }
 775   }
 776
 777   //
 778   // Move Suppressed Option to list tail
 779   //
 780   PopUpMenuLines = 0;
 781   for (Index = 0; Index < OptionCount; Index++) {
 782     OneOfOption = ValueToOption (Question, &HiiValueArray[OptionCount - Index - 1]);
 783     if (OneOfOption == NULL) {
 784       return EFI_NOT_FOUND;
 785     }
 786
 787     RemoveEntryList (&OneOfOption->Link);
 788
 789     if ((OneOfOption->SuppressExpression != NULL) &&
 790         (OneOfOption->SuppressExpression->Result.Value.b)) {
 791       //
 792       // This option is suppressed, insert to tail
 793       //
 794       InsertTailList (&Question->OptionListHead, &OneOfOption->Link);
 795     } else {
 796       //
 797       // Insert to head
 798       //
 799       InsertHeadList (&Question->OptionListHead, &OneOfOption->Link);
 800
 801       PopUpMenuLines++;
 802     }
 803   }
 804
 805   //
 806   // Get the number of one of options present and its size
 807   //
 808   PopUpWidth = 0;
 809   HighlightOptionIndex = 0;
 810   Link = GetFirstNode (&Question->OptionListHead);
 811   for (Index = 0; Index < PopUpMenuLines; Index++) {
 812     OneOfOption = QUESTION_OPTION_FROM_LINK (Link);
 813
 814     StringPtr = GetToken (OneOfOption->Text, MenuOption->Handle);
 815     if (StrLen (StringPtr) > PopUpWidth) {
 816       PopUpWidth = StrLen (StringPtr);
 817     }
 818     FreePool (StringPtr);
 819
 820     if (!OrderedList && CompareHiiValue (&Question->HiiValue, &OneOfOption->Value, NULL) == 0) {
 821       //
 822       // Find current selected Option for OneOf
 823       //
 824       HighlightOptionIndex = Index;
 825     }
 826
 827     Link = GetNextNode (&Question->OptionListHead, Link);
 828   }
 829
 830   //
 831   // Perform popup menu initialization.
 832   //
 833   PopUpWidth = PopUpWidth + POPUP_PAD_SPACE_COUNT;
 834
 835   SavedAttribute = gST->ConOut->Mode->Attribute;
 836   gST->ConOut->SetAttribute (gST->ConOut, POPUP_TEXT | POPUP_BACKGROUND);
 837
 838   if ((PopUpWidth + POPUP_FRAME_WIDTH) > DimensionsWidth) {
 839     PopUpWidth = DimensionsWidth - POPUP_FRAME_WIDTH;
 840   }
 841
 842   Start  = (DimensionsWidth - PopUpWidth - POPUP_FRAME_WIDTH) / 2 + gScreenDimensions.LeftColumn;
 843   End    = Start + PopUpWidth + POPUP_FRAME_WIDTH;
 844   Top    = gScreenDimensions.TopRow + NONE_FRONT_PAGE_HEADER_HEIGHT;
 845   Bottom = gScreenDimensions.BottomRow - STATUS_BAR_HEIGHT - FOOTER_HEIGHT - 1;
 846
 847   MenuLinesInView = Bottom - Top - 1;
 848   if (MenuLinesInView >= PopUpMenuLines) {
 849     Top     = Top + (MenuLinesInView - PopUpMenuLines) / 2;
 850     Bottom  = Top + PopUpMenuLines + 1;
 851   } else {
 852     ShowDownArrow = TRUE;
 853   }
 854
 855   if (HighlightOptionIndex > (MenuLinesInView - 1)) {
 856     TopOptionIndex = HighlightOptionIndex - MenuLinesInView + 1;
 857   } else {
 858     TopOptionIndex = 0;
 859   }
 860
 861   do {
 862     //
 863     // Clear that portion of the screen
 864     //
 865     ClearLines (Start, End, Top, Bottom, POPUP_TEXT | POPUP_BACKGROUND);
 866
 867     //
 868     // Draw "One of" pop-up menu
 869     //
 870     Character = BOXDRAW_DOWN_RIGHT;
 871     PrintCharAt (Start, Top, Character);
 872     for (Index = Start; Index + 2 < End; Index++) {
 873       if ((ShowUpArrow) && ((Index + 1) == (Start + End) / 2)) {
 874         Character = GEOMETRICSHAPE_UP_TRIANGLE;
 875       } else {
 876         Character = BOXDRAW_HORIZONTAL;
 877       }
 878
 879       PrintChar (Character);
 880     }
 881
 882     Character = BOXDRAW_DOWN_LEFT;
 883     PrintChar (Character);
 884     Character = BOXDRAW_VERTICAL;
 885     for (Index = Top + 1; Index < Bottom; Index++) {
 886       PrintCharAt (Start, Index, Character);
 887       PrintCharAt (End - 1, Index, Character);
 888     }
 889
 890     //
 891     // Move to top Option
 892     //
 893     Link = GetFirstNode (&Question->OptionListHead);
 894     for (Index = 0; Index < TopOptionIndex; Index++) {
 895       Link = GetNextNode (&Question->OptionListHead, Link);
 896     }
 897
 898     //
 899     // Display the One of options
 900     //
 901     Index2 = Top + 1;
 902     for (Index = TopOptionIndex; (Index < PopUpMenuLines) && (Index2 < Bottom); Index++) {
 903       OneOfOption = QUESTION_OPTION_FROM_LINK (Link);
 904       Link = GetNextNode (&Question->OptionListHead, Link);
 905
 906       StringPtr = GetToken (OneOfOption->Text, MenuOption->Handle);
 907       //
 908       // If the string occupies multiple lines, truncate it to fit in one line,
 909       // and append a "..." for indication.
 910       //
 911       if (StrLen (StringPtr) > (PopUpWidth - 1)) {
 912         TempStringPtr = AllocateZeroPool (sizeof (CHAR16) * (PopUpWidth - 1));
 913         ASSERT ( TempStringPtr != NULL );
 914         CopyMem (TempStringPtr, StringPtr, (sizeof (CHAR16) * (PopUpWidth - 5)));
 915         FreePool (StringPtr);
 916         StringPtr = TempStringPtr;
 917         StrCat (StringPtr, L"...");
 918       }
 919
 920       if (Index == HighlightOptionIndex) {
 921           //
 922           // Highlight the selected one
 923           //
 924           CurrentOption = OneOfOption;
 925
 926           gST->ConOut->SetAttribute (gST->ConOut, PICKLIST_HIGHLIGHT_TEXT | PICKLIST_HIGHLIGHT_BACKGROUND);
 927           PrintStringAt (Start + 2, Index2, StringPtr);
 928           gST->ConOut->SetAttribute (gST->ConOut, POPUP_TEXT | POPUP_BACKGROUND);
 929         } else {
 930           gST->ConOut->SetAttribute (gST->ConOut, POPUP_TEXT | POPUP_BACKGROUND);
 931           PrintStringAt (Start + 2, Index2, StringPtr);
 932         }
 933
 934       Index2++;
 935       FreePool (StringPtr);
 936     }
 937
 938     Character = BOXDRAW_UP_RIGHT;
 939     PrintCharAt (Start, Bottom, Character);
 940     for (Index = Start; Index + 2 < End; Index++) {
 941       if ((ShowDownArrow) && ((Index + 1) == (Start + End) / 2)) {
 942         Character = GEOMETRICSHAPE_DOWN_TRIANGLE;
 943       } else {
 944         Character = BOXDRAW_HORIZONTAL;
 945       }
 946
 947       PrintChar (Character);
 948     }
 949
 950     Character = BOXDRAW_UP_LEFT;
 951     PrintChar (Character);
 952
 953     //
 954     // Get User selection
 955     //
 956     Key.UnicodeChar = CHAR_NULL;
 957     if ((gDirection == SCAN_UP) || (gDirection == SCAN_DOWN)) {
 958       Key.ScanCode  = gDirection;
 959       gDirection    = 0;
 960       goto TheKey;
 961     }
 962
 963     Status = WaitForKeyStroke (&Key);
 964
 965 TheKey:
 966     switch (Key.UnicodeChar) {
 967     case '+':
 968       if (OrderedList) {
 969         if ((TopOptionIndex > 0) && (TopOptionIndex == HighlightOptionIndex)) {
 970           //
 971           // Highlight reaches the top of the popup window, scroll one menu item.
 972           //
 973           TopOptionIndex--;
 974           ShowDownArrow = TRUE;
 975         }
 976
 977         if (TopOptionIndex == 0) {
 978           ShowUpArrow = FALSE;
 979         }
 980
 981         if (HighlightOptionIndex > 0) {
 982           HighlightOptionIndex--;
 983
 984           ASSERT (CurrentOption != NULL);
 985           SwapListEntries (CurrentOption->Link.BackLink, &CurrentOption->Link);
 986         }
 987       }
 988       break;
 989
 990     case '-':
 991       //
 992       // If an ordered list op-code, we will allow for a popup of +/- keys
 993       // to create an ordered list of items
 994       //
 995       if (OrderedList) {
 996         if (((TopOptionIndex + MenuLinesInView) < PopUpMenuLines) &&
 997             (HighlightOptionIndex == (TopOptionIndex + MenuLinesInView - 1))) {
 998           //
 999           // Highlight reaches the bottom of the popup window, scroll one menu item.
1000           //
1001           TopOptionIndex++;
1002           ShowUpArrow = TRUE;
1003         }
1004
1005         if ((TopOptionIndex + MenuLinesInView) == PopUpMenuLines) {
1006           ShowDownArrow = FALSE;
1007         }
1008
1009         if (HighlightOptionIndex < (PopUpMenuLines - 1)) {
1010           HighlightOptionIndex++;
1011
1012           ASSERT (CurrentOption != NULL);
1013           SwapListEntries (&CurrentOption->Link, CurrentOption->Link.ForwardLink);
1014         }
1015       }
1016       break;
1017
1018     case CHAR_NULL:
1019       switch (Key.ScanCode) {
1020       case SCAN_UP:
1021       case SCAN_DOWN:
1022         if (Key.ScanCode == SCAN_UP) {
1023           if ((TopOptionIndex > 0) && (TopOptionIndex == HighlightOptionIndex)) {
1024             //
1025             // Highlight reaches the top of the popup window, scroll one menu item.
1026             //
1027             TopOptionIndex--;
1028             ShowDownArrow = TRUE;
1029           }
1030
1031           if (TopOptionIndex == 0) {
1032             ShowUpArrow = FALSE;
1033           }
1034
1035           if (HighlightOptionIndex > 0) {
1036             HighlightOptionIndex--;
1037           }
1038         } else {
1039           if (((TopOptionIndex + MenuLinesInView) < PopUpMenuLines) &&
1040               (HighlightOptionIndex == (TopOptionIndex + MenuLinesInView - 1))) {
1041             //
1042             // Highlight reaches the bottom of the popup window, scroll one menu item.
1043             //
1044             TopOptionIndex++;
1045             ShowUpArrow = TRUE;
1046           }
1047
1048           if ((TopOptionIndex + MenuLinesInView) == PopUpMenuLines) {
1049             ShowDownArrow = FALSE;
1050           }
1051
1052           if (HighlightOptionIndex < (PopUpMenuLines - 1)) {
1053             HighlightOptionIndex++;
1054           }
1055         }
1056         break;
1057
1058       case SCAN_ESC:
1059         gST->ConOut->SetAttribute (gST->ConOut, SavedAttribute);
1060
1061         //
1062         // Restore link list order for orderedlist
1063         //
1064         if (OrderedList) {
1065           HiiValue.Type = ValueType;
1066           HiiValue.Value.u64 = 0;
1067           for (Index = 0; Index < Question->MaxContainers; Index++) {
1068             HiiValue.Value.u64 = GetArrayData (ValueArray, ValueType, Index);
1069             if (HiiValue.Value.u64 == 0) {
1070               break;
1071             }
1072
1073             OneOfOption = ValueToOption (Question, &HiiValue);
1074             if (OneOfOption == NULL) {
1075               return EFI_NOT_FOUND;
1076             }
1077
1078             RemoveEntryList (&OneOfOption->Link);
1079             InsertTailList (&Question->OptionListHead, &OneOfOption->Link);
1080           }
1081         }
1082
1083         FreePool (HiiValueArray);
1084         return EFI_DEVICE_ERROR;
1085
1086       default:
1087         break;
1088       }
1089
1090       break;
1091
1092     case CHAR_CARRIAGE_RETURN:
1093       //
1094       // return the current selection
1095       //
1096       if (OrderedList) {
1097         Index = 0;
1098         Link = GetFirstNode (&Question->OptionListHead);
1099         while (!IsNull (&Question->OptionListHead, Link)) {
1100           OneOfOption = QUESTION_OPTION_FROM_LINK (Link);
1101
1102           SetArrayData (ValueArray, ValueType, Index, OneOfOption->Value.Value.u64);
1103
1104           Index++;
1105           if (Index > Question->MaxContainers) {
1106             break;
1107           }
1108
1109           Link = GetNextNode (&Question->OptionListHead, Link);
1110         }
1111       } else {
1112         ASSERT (CurrentOption != NULL);
1113         CopyMem (&Question->HiiValue, &CurrentOption->Value, sizeof (EFI_HII_VALUE));
1114       }
1115
1116       gST->ConOut->SetAttribute (gST->ConOut, SavedAttribute);
1117       FreePool (HiiValueArray);
1118
1119       Status = ValidateQuestion (Selection->FormSet, Selection->Form, Question, EFI_HII_EXPRESSION_INCONSISTENT_IF);
1120       if (EFI_ERROR (Status)) {
1121         //
1122         // Input value is not valid, restore Question Value
1123         //
1124         GetQuestionValue (Selection->FormSet, Selection->Form, Question, TRUE);
1125       } else {
1126         SetQuestionValue (Selection->FormSet, Selection->Form, Question, TRUE);
1127         UpdateStatusBar (NV_UPDATE_REQUIRED, Question->QuestionFlags, TRUE);
1128       }
1129
1130       return Status;
1131
1132     default:
1133       break;
1134     }
1135   } while (TRUE);
1136
1137 }
1138
1139 /**
1140   Wait for a key to be pressed by user.
1141
1142   @param Key         The key which is pressed by user.
1143
1144   @retval EFI_SUCCESS The function always completed successfully.
1145
1146 **/
1147 EFI_STATUS
1148 WaitForKeyStroke (
1149   OUT  EFI_INPUT_KEY           *Key
1150   )
1151 {
1152   EFI_STATUS  Status;
1153
1154   do {
1155     UiWaitForSingleEvent (gST->ConIn->WaitForKey, 0, 0);
1156     Status = gST->ConIn->ReadKeyStroke (gST->ConIn, Key);
1157   } while (EFI_ERROR(Status));
1158
1159   return Status;
1160 }