code.delx.au - refind/blob - refind/menu.c

   1 /*
   2  * refit/menu.c
   3  * Menu functions
   4  *
   5  * Copyright (c) 2006 Christoph Pfisterer
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions are
  10  * met:
  11  *
  12  *  * Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  *
  15  *  * Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the
  18  *    distribution.
  19  *
  20  *  * Neither the name of Christoph Pfisterer nor the names of the
  21  *    contributors may be used to endorse or promote products derived
  22  *    from this software without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  27  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  28  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  29  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  30  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  31  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  32  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  33  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  34  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  35  */
  36 /*
  37  * Modifications copyright (c) 2012 Roderick W. Smith
  38  *
  39  * Modifications distributed under the terms of the GNU General Public
  40  * License (GPL) version 3 (GPLv3), a copy of which must be distributed
  41  * with this source code or binaries made from it.
  42  *
  43  */
  44
  45 #include "global.h"
  46 #include "screen.h"
  47 #include "lib.h"
  48 #include "menu.h"
  49 #include "config.h"
  50 #include "libeg.h"
  51 #include "libegint.h"
  52 #include "../include/refit_call_wrapper.h"
  53
  54 #include "../include/egemb_back_selected_small.h"
  55 #include "../include/egemb_back_selected_big.h"
  56 #include "../include/egemb_arrow_left.h"
  57 #include "../include/egemb_arrow_right.h"
  58
  59 // other menu definitions
  60
  61 #define MENU_FUNCTION_INIT            (0)
  62 #define MENU_FUNCTION_CLEANUP         (1)
  63 #define MENU_FUNCTION_PAINT_ALL       (2)
  64 #define MENU_FUNCTION_PAINT_SELECTION (3)
  65 #define MENU_FUNCTION_PAINT_TIMEOUT   (4)
  66 #define MENU_FUNCTION_PAINT_HINTS     (5)
  67
  68 typedef VOID (*MENU_STYLE_FUNC)(IN REFIT_MENU_SCREEN *Screen, IN SCROLL_STATE *State, IN UINTN Function, IN CHAR16 *ParamText);
  69
  70 static CHAR16 ArrowUp[2] = { ARROW_UP, 0 };
  71 static CHAR16 ArrowDown[2] = { ARROW_DOWN, 0 };
  72 static UINTN TileSizes[2] = { 144, 64 };
  73
  74 // Text and icon spacing constants....
  75 #define TEXT_YMARGIN (2)
  76 #define TITLEICON_SPACING (16)
  77
  78 #define TILE_XSPACING (8)
  79 #define TILE_YSPACING (16)
  80
  81 // Alignment values for PaintIcon()
  82 #define ALIGN_RIGHT 1
  83 #define ALIGN_LEFT 0
  84
  85 static EG_IMAGE *SelectionImages[2] = { NULL, NULL };
  86 static EG_PIXEL SelectionBackgroundPixel = { 0xff, 0xff, 0xff, 0 };
  87
  88 //
  89 // Graphics helper functions
  90 //
  91
  92 static VOID InitSelection(VOID)
  93 {
  94     EG_IMAGE    *TempSmallImage = NULL, *TempBigImage = NULL;
  95     BOOLEAN     LoadedSmallImage = FALSE;
  96
  97     if (!AllowGraphicsMode)
  98         return;
  99     if (SelectionImages[0] != NULL)
 100         return;
 101
 102     // load small selection image
 103     if (GlobalConfig.SelectionSmallFileName != NULL) {
 104         TempSmallImage = egLoadImage(SelfDir, GlobalConfig.SelectionSmallFileName, TRUE);
 105     }
 106     if (TempSmallImage == NULL)
 107         TempSmallImage = egPrepareEmbeddedImage(&egemb_back_selected_small, TRUE);
 108     else
 109        LoadedSmallImage = TRUE;
 110     SelectionImages[1] = egScaleImage(TempSmallImage, TileSizes[1], TileSizes[1]);
 111
 112     // load big selection image
 113     if (GlobalConfig.SelectionBigFileName != NULL) {
 114         TempBigImage = egLoadImage(SelfDir, GlobalConfig.SelectionBigFileName, TRUE);
 115     }
 116     if (TempBigImage == NULL) {
 117         if (LoadedSmallImage) {
 118            // calculate big selection image from small one
 119            TempBigImage = egCopyImage(TempSmallImage);
 120         } else {
 121            TempBigImage = egPrepareEmbeddedImage(&egemb_back_selected_big, TRUE);
 122         }
 123     }
 124     SelectionImages[0] = egScaleImage(TempBigImage, TileSizes[0], TileSizes[0]);
 125
 126     if (TempSmallImage)
 127        egFreeImage(TempSmallImage);
 128     if (TempBigImage)
 129        egFreeImage(TempBigImage);
 130 } // VOID InitSelection()
 131
 132 //
 133 // Scrolling functions
 134 //
 135
 136 static VOID InitScroll(OUT SCROLL_STATE *State, IN UINTN ItemCount, IN UINTN VisibleSpace)
 137 {
 138     State->PreviousSelection = State->CurrentSelection = 0;
 139     State->MaxIndex = (INTN)ItemCount - 1;
 140     State->FirstVisible = 0;
 141     if (AllowGraphicsMode) {
 142        State->MaxVisible = UGAWidth / (TileSizes[0] + TILE_XSPACING) - 1;
 143     } else
 144        State->MaxVisible = ConHeight - 4;
 145     if ((VisibleSpace > 0) && (VisibleSpace < State->MaxVisible))
 146         State->MaxVisible = (INTN)VisibleSpace;
 147     State->PaintAll = TRUE;
 148     State->PaintSelection = FALSE;
 149
 150     State->LastVisible = State->FirstVisible + State->MaxVisible - 1;
 151 }
 152
 153 // Adjust variables relating to the scrolling of tags, for when a selected icon isn't
 154 // visible given the current scrolling condition....
 155 static VOID AdjustScrollState(IN SCROLL_STATE *State) {
 156    if (State->CurrentSelection > State->LastVisible) {
 157       State->LastVisible = State->CurrentSelection;
 158       State->FirstVisible = 1 + State->CurrentSelection - State->MaxVisible;
 159       if (State->FirstVisible < 0) // shouldn't happen, but just in case....
 160          State->FirstVisible = 0;
 161       State->PaintAll = TRUE;
 162    } // Scroll forward
 163    if (State->CurrentSelection < State->FirstVisible) {
 164       State->FirstVisible = State->CurrentSelection;
 165       State->LastVisible = State->CurrentSelection + State->MaxVisible - 1;
 166       State->PaintAll = TRUE;
 167    } // Scroll backward
 168 } // static VOID AdjustScrollState
 169
 170 static VOID UpdateScroll(IN OUT SCROLL_STATE *State, IN UINTN Movement)
 171 {
 172     State->PreviousSelection = State->CurrentSelection;
 173
 174     switch (Movement) {
 175         case SCROLL_LINE_LEFT:
 176             if (State->CurrentSelection > 0) {
 177                 State->CurrentSelection --;
 178             }
 179             break;
 180
 181         case SCROLL_LINE_RIGHT:
 182             if (State->CurrentSelection < State->MaxIndex) {
 183                 State->CurrentSelection ++;
 184             }
 185             break;
 186
 187         case SCROLL_LINE_UP:
 188             if (State->ScrollMode == SCROLL_MODE_ICONS) {
 189                if (State->CurrentSelection >= State->InitialRow1) {
 190                   if (State->MaxIndex > State->InitialRow1) { // avoid division by 0!
 191                      State->CurrentSelection = State->FirstVisible + (State->LastVisible - State->FirstVisible) *
 192                                                (State->CurrentSelection - State->InitialRow1) /
 193                                                (State->MaxIndex - State->InitialRow1);
 194                   } else {
 195                      State->CurrentSelection = State->FirstVisible;
 196                   } // if/else
 197                } // if in second row
 198             } else {
 199                if (State->CurrentSelection > 0)
 200                   State->CurrentSelection--;
 201             } // if/else
 202             break;
 203
 204         case SCROLL_LINE_DOWN:
 205            if (State->ScrollMode == SCROLL_MODE_ICONS) {
 206                if (State->CurrentSelection <= State->FinalRow0) {
 207                   if (State->LastVisible > State->FirstVisible) { // avoid division by 0!
 208                      State->CurrentSelection = State->InitialRow1 + (State->MaxIndex - State->InitialRow1) *
 209                                                (State->CurrentSelection - State->FirstVisible) /
 210                                                (State->LastVisible - State->FirstVisible);
 211                   } else {
 212                      State->CurrentSelection = State->InitialRow1;
 213                   } // if/else
 214                } // if in first row
 215             } else {
 216                if (State->CurrentSelection < State->MaxIndex)
 217                   State->CurrentSelection++;
 218             } // if/else
 219             break;
 220
 221         case SCROLL_PAGE_UP:
 222            if (State->CurrentSelection <= State->FinalRow0)
 223               State->CurrentSelection -= State->MaxVisible;
 224            else if (State->CurrentSelection == State->InitialRow1)
 225               State->CurrentSelection = State->FinalRow0;
 226            else
 227               State->CurrentSelection = State->InitialRow1;
 228            if (State->CurrentSelection < 0)
 229               State->CurrentSelection = 0;
 230            break;
 231
 232         case SCROLL_FIRST:
 233            if (State->CurrentSelection > 0) {
 234               State->PaintAll = TRUE;
 235               State->CurrentSelection = 0;
 236            }
 237            break;
 238
 239         case SCROLL_PAGE_DOWN:
 240            if (State->CurrentSelection < State->FinalRow0) {
 241               State->CurrentSelection += State->MaxVisible;
 242               if (State->CurrentSelection > State->FinalRow0)
 243                  State->CurrentSelection = State->FinalRow0;
 244            } else if (State->CurrentSelection == State->FinalRow0) {
 245               State->CurrentSelection++;
 246            } else {
 247               State->CurrentSelection = State->MaxIndex;
 248            }
 249            if (State->CurrentSelection > State->MaxIndex)
 250               State->CurrentSelection = State->MaxIndex;
 251            break;
 252
 253         case SCROLL_LAST:
 254            if (State->CurrentSelection < State->MaxIndex) {
 255               State->PaintAll = TRUE;
 256               State->CurrentSelection = State->MaxIndex;
 257            }
 258            break;
 259
 260         case SCROLL_NONE:
 261             break;
 262
 263     }
 264     if (State->ScrollMode == SCROLL_MODE_TEXT)
 265        AdjustScrollState(State);
 266
 267     if (!State->PaintAll && State->CurrentSelection != State->PreviousSelection)
 268         State->PaintSelection = TRUE;
 269     State->LastVisible = State->FirstVisible + State->MaxVisible - 1;
 270 } // static VOID UpdateScroll()
 271
 272 //
 273 // menu helper functions
 274 //
 275
 276 VOID AddMenuInfoLine(IN REFIT_MENU_SCREEN *Screen, IN CHAR16 *InfoLine)
 277 {
 278     AddListElement((VOID ***) &(Screen->InfoLines), &(Screen->InfoLineCount), InfoLine);
 279 }
 280
 281 VOID AddMenuEntry(IN REFIT_MENU_SCREEN *Screen, IN REFIT_MENU_ENTRY *Entry)
 282 {
 283     AddListElement((VOID ***) &(Screen->Entries), &(Screen->EntryCount), Entry);
 284 }
 285
 286
 287 static INTN FindMenuShortcutEntry(IN REFIT_MENU_SCREEN *Screen, IN CHAR16 *Defaults)
 288 {
 289     UINTN i, j = 0;
 290     CHAR16 *Shortcut;
 291
 292     while ((Shortcut = FindCommaDelimited(Defaults, j)) != NULL) {
 293        if (StrLen(Shortcut) == 1) {
 294          if (Shortcut[0] >= 'a' && Shortcut[0] <= 'z')
 295             Shortcut[0] -= ('a' - 'A');
 296          if (Shortcut[0]) {
 297             for (i = 0; i < Screen->EntryCount; i++) {
 298                   if (Screen->Entries[i]->ShortcutDigit == Shortcut[0] || Screen->Entries[i]->ShortcutLetter == Shortcut[0]) {
 299                      MyFreePool(Shortcut);
 300                      return i;
 301                   } // if
 302             } // for
 303          } // if
 304        } else if (StrLen(Shortcut) > 1) {
 305           for (i = 0; i < Screen->EntryCount; i++) {
 306              if (StriSubCmp(Shortcut, Screen->Entries[i]->Title)) {
 307                 MyFreePool(Shortcut);
 308                 return i;
 309              } // if
 310           } // for
 311        }
 312        MyFreePool(Shortcut);
 313        j++;
 314     } // while()
 315     return -1;
 316 }
 317
 318 // Identify the end of row 0 and the beginning of row 1; store the results in the
 319 // appropriate fields in State. Also reduce MaxVisible if that value is greater
 320 // than the total number of row-0 tags and if we're in an icon-based screen
 321 static VOID IdentifyRows(IN SCROLL_STATE *State, IN REFIT_MENU_SCREEN *Screen) {
 322    UINTN i;
 323
 324    State->FinalRow0 = 0;
 325    State->InitialRow1 = State->MaxIndex;
 326    for (i = 0; i <= State->MaxIndex; i++) {
 327       if (Screen->Entries[i]->Row == 0) {
 328          State->FinalRow0 = i;
 329       } else if ((Screen->Entries[i]->Row == 1) && (State->InitialRow1 > i)) {
 330          State->InitialRow1 = i;
 331       } // if/else
 332    } // for
 333    if ((State->ScrollMode == SCROLL_MODE_ICONS) && (State->MaxVisible > (State->FinalRow0 + 1)))
 334       State->MaxVisible = State->FinalRow0 + 1;
 335 } // static VOID IdentifyRows()
 336
 337 // Blank the screen, wait for a keypress, and restore banner/background.
 338 // Screen may still require redrawing of text and icons on return.
 339 // TODO: Support more sophisticated screen savers, such as power-saving
 340 // mode and dynamic images.
 341 static VOID SaveScreen(VOID) {
 342    UINTN index;
 343    EG_PIXEL Black = { 0x0, 0x0, 0x0, 0 };
 344
 345    egClearScreen(&Black);
 346    refit_call3_wrapper(BS->WaitForEvent, 1, &ST->ConIn->WaitForKey, &index);
 347    if (AllowGraphicsMode)
 348       SwitchToGraphicsAndClear();
 349    ReadAllKeyStrokes();
 350 } // VOID SaveScreen()
 351
 352 //
 353 // generic menu function
 354 //
 355 static UINTN RunGenericMenu(IN REFIT_MENU_SCREEN *Screen, IN MENU_STYLE_FUNC StyleFunc, IN OUT INTN *DefaultEntryIndex,
 356                             OUT REFIT_MENU_ENTRY **ChosenEntry)
 357 {
 358     SCROLL_STATE State;
 359     EFI_STATUS Status;
 360     EFI_INPUT_KEY key;
 361     UINTN index;
 362     INTN ShortcutEntry;
 363     BOOLEAN HaveTimeout = FALSE;
 364     UINTN TimeoutCountdown = 0;
 365     INTN PreviousTime = -1, CurrentTime, TimeSinceKeystroke = 0;
 366     CHAR16 TimeoutMessage[256];
 367     CHAR16 KeyAsString[2];
 368     UINTN MenuExit;
 369 //     EG_PIXEL Black = { 0x0, 0x0, 0x0, 0 };
 370
 371     if (Screen->TimeoutSeconds > 0) {
 372         HaveTimeout = TRUE;
 373         TimeoutCountdown = Screen->TimeoutSeconds * 10;
 374     }
 375     MenuExit = 0;
 376
 377     StyleFunc(Screen, &State, MENU_FUNCTION_INIT, NULL);
 378     IdentifyRows(&State, Screen);
 379     // override the starting selection with the default index, if any
 380     if (*DefaultEntryIndex >= 0 && *DefaultEntryIndex <= State.MaxIndex) {
 381         State.CurrentSelection = *DefaultEntryIndex;
 382         if (GlobalConfig.ScreensaverTime != -1)
 383            UpdateScroll(&State, SCROLL_NONE);
 384     }
 385     if (GlobalConfig.ScreensaverTime != -1)
 386         State.PaintAll = TRUE;
 387
 388     while (!MenuExit) {
 389         // update the screen
 390         if (State.PaintAll && (GlobalConfig.ScreensaverTime != -1)) {
 391             StyleFunc(Screen, &State, MENU_FUNCTION_PAINT_ALL, NULL);
 392             State.PaintAll = FALSE;
 393         } else if (State.PaintSelection) {
 394             StyleFunc(Screen, &State, MENU_FUNCTION_PAINT_SELECTION, NULL);
 395             State.PaintSelection = FALSE;
 396         }
 397
 398         if (HaveTimeout) {
 399             CurrentTime = (TimeoutCountdown + 5) / 10;
 400             if (CurrentTime != PreviousTime) {
 401                SPrint(TimeoutMessage, 255, L"%s in %d seconds", Screen->TimeoutText, CurrentTime);
 402                if (GlobalConfig.ScreensaverTime != -1)
 403                   StyleFunc(Screen, &State, MENU_FUNCTION_PAINT_TIMEOUT, TimeoutMessage);
 404                PreviousTime = CurrentTime;
 405             }
 406         }
 407
 408         // read key press (and wait for it if applicable)
 409         Status = refit_call2_wrapper(ST->ConIn->ReadKeyStroke, ST->ConIn, &key);
 410         if (Status != EFI_SUCCESS) {
 411             if (HaveTimeout && TimeoutCountdown == 0) {
 412                 // timeout expired
 413                 MenuExit = MENU_EXIT_TIMEOUT;
 414                 break;
 415             } else if (HaveTimeout) {
 416                 refit_call1_wrapper(BS->Stall, 100000); // Pause for 100 ms
 417                 TimeoutCountdown--;
 418                 TimeSinceKeystroke++;
 419             } else if (GlobalConfig.ScreensaverTime > 0) {
 420                 refit_call1_wrapper(BS->Stall, 100000); // Pause for 100 ms
 421                 TimeSinceKeystroke++;
 422                 if (TimeSinceKeystroke > (GlobalConfig.ScreensaverTime * 10)) {
 423                    SaveScreen();
 424                    State.PaintAll = TRUE;
 425                    TimeSinceKeystroke = 0;
 426                 } // if
 427             } else {
 428                 refit_call3_wrapper(BS->WaitForEvent, 1, &ST->ConIn->WaitForKey, &index);
 429             }
 430             continue;
 431         } else {
 432            TimeSinceKeystroke = 0;
 433         } // if/else !read keystroke
 434
 435         if (HaveTimeout) {
 436             // the user pressed a key, cancel the timeout
 437             StyleFunc(Screen, &State, MENU_FUNCTION_PAINT_TIMEOUT, L"");
 438             HaveTimeout = FALSE;
 439             if (GlobalConfig.ScreensaverTime == -1) { // cancel start-with-blank-screen coding
 440                GlobalConfig.ScreensaverTime = 0;
 441                if (!GlobalConfig.TextOnly)
 442                  BltClearScreen(TRUE);
 443             }
 444         }
 445
 446         // react to key press
 447         switch (key.ScanCode) {
 448             case SCAN_UP:
 449                 UpdateScroll(&State, SCROLL_LINE_UP);
 450                 break;
 451             case SCAN_LEFT:
 452                 UpdateScroll(&State, SCROLL_LINE_LEFT);
 453                 break;
 454             case SCAN_DOWN:
 455                 UpdateScroll(&State, SCROLL_LINE_DOWN);
 456                 break;
 457             case SCAN_RIGHT:
 458                 UpdateScroll(&State, SCROLL_LINE_RIGHT);
 459                 break;
 460             case SCAN_HOME:
 461                 UpdateScroll(&State, SCROLL_FIRST);
 462                 break;
 463             case SCAN_END:
 464                 UpdateScroll(&State, SCROLL_LAST);
 465                 break;
 466             case SCAN_PAGE_UP:
 467                 UpdateScroll(&State, SCROLL_PAGE_UP);
 468                 break;
 469             case SCAN_PAGE_DOWN:
 470                 UpdateScroll(&State, SCROLL_PAGE_DOWN);
 471                 break;
 472             case SCAN_ESC:
 473                 MenuExit = MENU_EXIT_ESCAPE;
 474                 break;
 475             case SCAN_INSERT:
 476             case SCAN_F2:
 477                 MenuExit = MENU_EXIT_DETAILS;
 478                 break;
 479             case SCAN_F10:
 480                 egScreenShot();
 481                 break;
 482             case 0x0016: // F12
 483                if (EjectMedia())
 484                   MenuExit = MENU_EXIT_ESCAPE;
 485                break;
 486         }
 487         switch (key.UnicodeChar) {
 488             case CHAR_LINEFEED:
 489             case CHAR_CARRIAGE_RETURN:
 490             case ' ':
 491                 MenuExit = MENU_EXIT_ENTER;
 492                 break;
 493             case '+':
 494                 MenuExit = MENU_EXIT_DETAILS;
 495                 break;
 496             default:
 497                 KeyAsString[0] = key.UnicodeChar;
 498                 KeyAsString[1] = 0;
 499                 ShortcutEntry = FindMenuShortcutEntry(Screen, KeyAsString);
 500                 if (ShortcutEntry >= 0) {
 501                     State.CurrentSelection = ShortcutEntry;
 502                     MenuExit = MENU_EXIT_ENTER;
 503                 }
 504                 break;
 505         }
 506     }
 507
 508     StyleFunc(Screen, &State, MENU_FUNCTION_CLEANUP, NULL);
 509
 510     if (ChosenEntry)
 511         *ChosenEntry = Screen->Entries[State.CurrentSelection];
 512     *DefaultEntryIndex = State.CurrentSelection;
 513     return MenuExit;
 514 } /* static UINTN RunGenericMenu() */
 515
 516 //
 517 // text-mode generic style
 518 //
 519
 520 // Show information lines in text mode.
 521 static VOID ShowTextInfoLines(IN REFIT_MENU_SCREEN *Screen) {
 522    INTN i;
 523
 524    BeginTextScreen(Screen->Title);
 525    if (Screen->InfoLineCount > 0) {
 526       refit_call2_wrapper(ST->ConOut->SetAttribute, ST->ConOut, ATTR_BASIC);
 527       for (i = 0; i < (INTN)Screen->InfoLineCount; i++) {
 528          refit_call3_wrapper(ST->ConOut->SetCursorPosition, ST->ConOut, 3, 4 + i);
 529          refit_call2_wrapper(ST->ConOut->OutputString, ST->ConOut, Screen->InfoLines[i]);
 530       }
 531    }
 532 } // VOID ShowTextInfoLines()
 533
 534 // Do most of the work for text-based menus....
 535 static VOID TextMenuStyle(IN REFIT_MENU_SCREEN *Screen, IN SCROLL_STATE *State, IN UINTN Function, IN CHAR16 *ParamText)
 536 {
 537     INTN i;
 538     UINTN MenuWidth, ItemWidth, MenuHeight;
 539     static UINTN MenuPosY;
 540     static CHAR16 **DisplayStrings;
 541     CHAR16 TimeoutMessage[256];
 542
 543     State->ScrollMode = SCROLL_MODE_TEXT;
 544     switch (Function) {
 545
 546         case MENU_FUNCTION_INIT:
 547             // vertical layout
 548             MenuPosY = 4;
 549             if (Screen->InfoLineCount > 0)
 550                 MenuPosY += Screen->InfoLineCount + 1;
 551             MenuHeight = ConHeight - MenuPosY - 3;
 552             if (Screen->TimeoutSeconds > 0)
 553                 MenuHeight -= 2;
 554             InitScroll(State, Screen->EntryCount, MenuHeight);
 555
 556             // determine width of the menu
 557             MenuWidth = 20;  // minimum
 558             for (i = 0; i <= State->MaxIndex; i++) {
 559                 ItemWidth = StrLen(Screen->Entries[i]->Title);
 560                 if (MenuWidth < ItemWidth)
 561                     MenuWidth = ItemWidth;
 562             }
 563             MenuWidth += 2;
 564             if (MenuWidth > ConWidth - 3)
 565                 MenuWidth = ConWidth - 3;
 566
 567             // prepare strings for display
 568             DisplayStrings = AllocatePool(sizeof(CHAR16 *) * Screen->EntryCount);
 569             for (i = 0; i <= State->MaxIndex; i++) {
 570                 // Note: Theoretically, SPrint() is a cleaner way to do this; but the
 571                 // description of the StrSize parameter to SPrint implies it's measured
 572                 // in characters, but in practice both TianoCore and GNU-EFI seem to
 573                 // use bytes instead, resulting in truncated displays. I could just
 574                 // double the size of the StrSize parameter, but that seems unsafe in
 575                 // case a future library change starts treating this as characters, so
 576                 // I'm doing it the hard way in this instance.
 577                 // TODO: Review the above and possibly change other uses of SPrint()
 578                 DisplayStrings[i] = AllocateZeroPool(2 * sizeof(CHAR16));
 579                 DisplayStrings[i][0] = L' ';
 580                 MergeStrings(&DisplayStrings[i], Screen->Entries[i]->Title, 0);
 581                 if (StrLen(DisplayStrings[i]) > MenuWidth)
 582                    DisplayStrings[i][MenuWidth - 1] = 0;
 583                 // TODO: use more elaborate techniques for shortening too long strings (ellipses in the middle)
 584                 // TODO: account for double-width characters
 585             } // for
 586
 587             break;
 588
 589         case MENU_FUNCTION_CLEANUP:
 590             // release temporary memory
 591             for (i = 0; i <= State->MaxIndex; i++)
 592                 MyFreePool(DisplayStrings[i]);
 593             MyFreePool(DisplayStrings);
 594             break;
 595
 596         case MENU_FUNCTION_PAINT_ALL:
 597             // paint the whole screen (initially and after scrolling)
 598
 599             ShowTextInfoLines(Screen);
 600             for (i = 0; i <= State->MaxIndex; i++) {
 601                 if (i >= State->FirstVisible && i <= State->LastVisible) {
 602                     refit_call3_wrapper(ST->ConOut->SetCursorPosition, ST->ConOut, 2, MenuPosY + (i - State->FirstVisible));
 603                     if (i == State->CurrentSelection)
 604                        refit_call2_wrapper(ST->ConOut->SetAttribute, ST->ConOut, ATTR_CHOICE_CURRENT);
 605                     else
 606                        refit_call2_wrapper(ST->ConOut->SetAttribute, ST->ConOut, ATTR_CHOICE_BASIC);
 607                     refit_call2_wrapper(ST->ConOut->OutputString, ST->ConOut, DisplayStrings[i]);
 608                 }
 609             }
 610             // scrolling indicators
 611             refit_call2_wrapper(ST->ConOut->SetAttribute, ST->ConOut, ATTR_SCROLLARROW);
 612             refit_call3_wrapper(ST->ConOut->SetCursorPosition, ST->ConOut, 0, MenuPosY);
 613             if (State->FirstVisible > 0)
 614                 refit_call2_wrapper(ST->ConOut->OutputString, ST->ConOut, ArrowUp);
 615             else
 616                refit_call2_wrapper(ST->ConOut->OutputString, ST->ConOut, L" ");
 617             refit_call3_wrapper(ST->ConOut->SetCursorPosition, ST->ConOut, 0, MenuPosY + State->MaxVisible);
 618             if (State->LastVisible < State->MaxIndex)
 619                refit_call2_wrapper(ST->ConOut->OutputString, ST->ConOut, ArrowDown);
 620             else
 621                refit_call2_wrapper(ST->ConOut->OutputString, ST->ConOut, L" ");
 622             if (!(GlobalConfig.HideUIFlags & HIDEUI_FLAG_HINTS)) {
 623                if (Screen->Hint1 != NULL) {
 624                   refit_call3_wrapper(ST->ConOut->SetCursorPosition, ST->ConOut, 0, ConHeight - 2);
 625                   refit_call2_wrapper(ST->ConOut->OutputString, ST->ConOut, Screen->Hint1);
 626                }
 627                if (Screen->Hint2 != NULL) {
 628                   refit_call3_wrapper(ST->ConOut->SetCursorPosition, ST->ConOut, 0, ConHeight - 1);
 629                   refit_call2_wrapper(ST->ConOut->OutputString, ST->ConOut, Screen->Hint2);
 630                }
 631             }
 632             break;
 633
 634         case MENU_FUNCTION_PAINT_SELECTION:
 635             // redraw selection cursor
 636             refit_call3_wrapper(ST->ConOut->SetCursorPosition, ST->ConOut, 2,
 637                                 MenuPosY + (State->PreviousSelection - State->FirstVisible));
 638             refit_call2_wrapper(ST->ConOut->SetAttribute, ST->ConOut, ATTR_CHOICE_BASIC);
 639             refit_call2_wrapper(ST->ConOut->OutputString, ST->ConOut, DisplayStrings[State->PreviousSelection]);
 640             refit_call3_wrapper(ST->ConOut->SetCursorPosition, ST->ConOut, 2,
 641                                 MenuPosY + (State->CurrentSelection - State->FirstVisible));
 642             refit_call2_wrapper(ST->ConOut->SetAttribute, ST->ConOut, ATTR_CHOICE_CURRENT);
 643             refit_call2_wrapper(ST->ConOut->OutputString, ST->ConOut, DisplayStrings[State->CurrentSelection]);
 644             break;
 645
 646         case MENU_FUNCTION_PAINT_TIMEOUT:
 647             if (ParamText[0] == 0) {
 648                 // clear message
 649                 refit_call2_wrapper(ST->ConOut->SetAttribute, ST->ConOut, ATTR_BASIC);
 650                 refit_call3_wrapper(ST->ConOut->SetCursorPosition, ST->ConOut, 0, ConHeight - 3);
 651                 refit_call2_wrapper(ST->ConOut->OutputString, ST->ConOut, BlankLine + 1);
 652             } else {
 653                 // paint or update message
 654                 refit_call2_wrapper(ST->ConOut->SetAttribute, ST->ConOut, ATTR_ERROR);
 655                 refit_call3_wrapper(ST->ConOut->SetCursorPosition, ST->ConOut, 3, ConHeight - 3);
 656                 SPrint(TimeoutMessage, 255, L"%s  ", ParamText);
 657                 refit_call2_wrapper(ST->ConOut->OutputString, ST->ConOut, TimeoutMessage);
 658             }
 659             break;
 660
 661     }
 662 }
 663
 664 //
 665 // graphical generic style
 666 //
 667
 668 inline static UINTN TextLineHeight(VOID) {
 669    return egGetFontHeight() + TEXT_YMARGIN * 2;
 670 } // UINTN TextLineHeight()
 671
 672 //
 673 // Display a submenu
 674 //
 675
 676 // Display text with a solid background (MenuBackgroundPixel or SelectionBackgroundPixel).
 677 // Indents text by one character and placed TEXT_YMARGIN pixels down from the
 678 // specified XPos and YPos locations.
 679 static VOID DrawText(IN CHAR16 *Text, IN BOOLEAN Selected, IN UINTN FieldWidth, IN UINTN XPos, IN UINTN YPos)
 680 {
 681    EG_IMAGE *TextBuffer;
 682    EG_PIXEL Bg;
 683
 684    TextBuffer = egCreateImage(FieldWidth, TextLineHeight(), FALSE);
 685
 686    egFillImage(TextBuffer, &MenuBackgroundPixel);
 687    Bg = MenuBackgroundPixel;
 688    if (Selected) {
 689        // draw selection bar background
 690        egFillImageArea(TextBuffer, 0, 0, FieldWidth, TextBuffer->Height, &SelectionBackgroundPixel);
 691        Bg = SelectionBackgroundPixel;
 692    }
 693
 694    // render the text
 695    egRenderText(Text, TextBuffer, egGetFontCellWidth(), TEXT_YMARGIN, (Bg.r + Bg.g + Bg.b) / 3);
 696    egDrawImageWithTransparency(TextBuffer, NULL, XPos, YPos, TextBuffer->Width, TextBuffer->Height);
 697 //    BltImage(TextBuffer, XPos, YPos);
 698 }
 699
 700 // Finds the average brightness of the input Image.
 701 // NOTE: Passing an Image that covers the whole screen can strain the
 702 // capacity of a UINTN on a 32-bit system with a very large display.
 703 // Using UINT64 instead is unworkable, since the code won't compile
 704 // on a 32-bit system. As the intended use for this function is to handle
 705 // a single text string's background, this shouldn't be a problem, but it
 706 // may need addressing if it's applied more broadly....
 707 static UINT8 AverageBrightness(EG_IMAGE *Image) {
 708    UINTN i;
 709    UINTN Sum = 0;
 710
 711    if (Image != NULL) {
 712       for (i = 0; i < (Image->Width * Image->Height); i++) {
 713          Sum += (Image->PixelData[i].r + Image->PixelData[i].g + Image->PixelData[i].b);
 714       }
 715    } // if
 716    return (UINT8) (Sum / (Image->Width * Image->Height * 3));
 717 } // UINT8 AverageBrightness()
 718
 719 // Display text against the screen's background image. Special case: If Text is NULL
 720 // or 0-length, clear the line. Does NOT indent the text or reposition it relative
 721 // to the specified XPos and YPos values.
 722 static VOID DrawTextWithTransparency(IN CHAR16 *Text, IN UINTN XPos, IN UINTN YPos)
 723 {
 724     UINTN TextWidth;
 725     EG_IMAGE *TextBuffer = NULL;
 726
 727     if (Text == NULL)
 728        Text = L"";
 729
 730     egMeasureText(Text, &TextWidth, NULL);
 731     if (TextWidth == 0) {
 732        TextWidth = UGAWidth;
 733        XPos = 0;
 734     }
 735
 736     TextBuffer = egCropImage(GlobalConfig.ScreenBackground, XPos, YPos, TextWidth, TextLineHeight());
 737     if (TextBuffer == NULL) {
 738        Print(L"Error: NULL TextBuffer in DrawTextWithTransparency()\n");
 739        return;
 740     }
 741
 742     // render the text
 743     egRenderText(Text, TextBuffer, 0, 0, AverageBrightness(TextBuffer));
 744     egDrawImageWithTransparency(TextBuffer, NULL, XPos, YPos, TextBuffer->Width, TextBuffer->Height);
 745     egFreeImage(TextBuffer);
 746 }
 747
 748 // Compute the size & position of the window that will hold a subscreen's information.
 749 static VOID ComputeSubScreenWindowSize(REFIT_MENU_SCREEN *Screen, IN SCROLL_STATE *State, UINTN *XPos, UINTN *YPos,
 750                                        UINTN *Width, UINTN *Height, UINTN *LineWidth) {
 751    UINTN i, ItemWidth, HintTop, BannerBottomEdge, TitleWidth;
 752    UINTN FontCellWidth = egGetFontCellWidth();
 753    UINTN FontCellHeight = egGetFontHeight();
 754
 755    *Width = 20;
 756    *Height = 5;
 757    TitleWidth = egComputeTextWidth(Screen->Title);
 758
 759    for (i = 0; i < Screen->InfoLineCount; i++) {
 760        ItemWidth = StrLen(Screen->InfoLines[i]);
 761        if (*Width < ItemWidth) {
 762            *Width = ItemWidth;
 763        }
 764        (*Height)++;
 765    }
 766    for (i = 0; i <= State->MaxIndex; i++) {
 767        ItemWidth = StrLen(Screen->Entries[i]->Title);
 768        if (*Width < ItemWidth) {
 769            *Width = ItemWidth;
 770        }
 771        (*Height)++;
 772    }
 773    *Width = (*Width + 2) * FontCellWidth;
 774    *LineWidth = *Width;
 775    if (Screen->TitleImage)
 776       *Width += (Screen->TitleImage->Width + TITLEICON_SPACING * 2 + FontCellWidth);
 777    else
 778       *Width += FontCellWidth;
 779
 780    if (*Width < TitleWidth)
 781       *Width = TitleWidth + 2 * FontCellWidth;
 782
 783    // Keep it within the bounds of the screen, or 2/3 of the screen's width
 784    // for screens over 800 pixels wide
 785    if (*Width > UGAWidth)
 786       *Width = UGAWidth;
 787
 788    *XPos = (UGAWidth - *Width) / 2;
 789
 790    HintTop = UGAHeight - (FontCellHeight * 3); // top of hint text
 791    *Height *= TextLineHeight();
 792    if (Screen->TitleImage && (*Height < (Screen->TitleImage->Height + TextLineHeight() * 4)))
 793       *Height = Screen->TitleImage->Height + TextLineHeight() * 4;
 794
 795    if (GlobalConfig.BannerBottomEdge >= HintTop) { // probably a full-screen image; treat it as an empty banner
 796       BannerBottomEdge = 0;
 797    } else {
 798       BannerBottomEdge = GlobalConfig.BannerBottomEdge;
 799    }
 800    if (*Height > (HintTop - BannerBottomEdge - FontCellHeight * 2)) {
 801       BannerBottomEdge = 0;
 802    }
 803    if (*Height > (HintTop - BannerBottomEdge - FontCellHeight * 2)) {
 804       // TODO: Implement scrolling in text screen.
 805       *Height = (HintTop - BannerBottomEdge - FontCellHeight * 2);
 806    }
 807
 808    *YPos = ((UGAHeight - *Height) / 2);
 809    if (*YPos < BannerBottomEdge)
 810       *YPos = BannerBottomEdge + FontCellHeight + (HintTop - BannerBottomEdge - *Height) / 2;
 811 } // VOID ComputeSubScreenWindowSize()
 812
 813 // Displays sub-menus
 814 static VOID GraphicsMenuStyle(IN REFIT_MENU_SCREEN *Screen, IN SCROLL_STATE *State, IN UINTN Function, IN CHAR16 *ParamText)
 815 {
 816     INTN i;
 817     UINTN ItemWidth;
 818     static UINTN LineWidth, MenuWidth, MenuHeight, EntriesPosX, TitlePosX, EntriesPosY, TimeoutPosY, CharWidth;
 819     EG_IMAGE *Window;
 820     EG_PIXEL *BackgroundPixel = &(GlobalConfig.ScreenBackground->PixelData[0]);
 821
 822     CharWidth = egGetFontCellWidth();
 823     State->ScrollMode = SCROLL_MODE_TEXT;
 824     switch (Function) {
 825
 826         case MENU_FUNCTION_INIT:
 827             InitScroll(State, Screen->EntryCount, 0);
 828             ComputeSubScreenWindowSize(Screen, State, &EntriesPosX, &EntriesPosY, &MenuWidth, &MenuHeight, &LineWidth);
 829             TimeoutPosY = EntriesPosY + (Screen->EntryCount + 1) * TextLineHeight();
 830
 831             // initial painting
 832             SwitchToGraphicsAndClear();
 833             Window = egCreateFilledImage(MenuWidth, MenuHeight, FALSE, BackgroundPixel);
 834             egDrawImage(Window, EntriesPosX, EntriesPosY);
 835             ItemWidth = egComputeTextWidth(Screen->Title);
 836             if (MenuWidth > ItemWidth) {
 837                TitlePosX = EntriesPosX + (MenuWidth - ItemWidth) / 2 - CharWidth;
 838             } else {
 839                TitlePosX = EntriesPosX;
 840                if (CharWidth > 0) {
 841                   i = MenuWidth / CharWidth - 2;
 842                   if (i > 0)
 843                      Screen->Title[i] = 0;
 844                } // if
 845             } // if/else
 846             break;
 847
 848         case MENU_FUNCTION_CLEANUP:
 849             // nothing to do
 850             break;
 851
 852         case MENU_FUNCTION_PAINT_ALL:
 853            ComputeSubScreenWindowSize(Screen, State, &EntriesPosX, &EntriesPosY, &MenuWidth, &MenuHeight, &LineWidth);
 854            DrawText(Screen->Title, FALSE, (StrLen(Screen->Title) + 2) * CharWidth, TitlePosX, EntriesPosY += TextLineHeight());
 855            if (Screen->TitleImage) {
 856               BltImageAlpha(Screen->TitleImage, EntriesPosX + TITLEICON_SPACING, EntriesPosY + TextLineHeight() * 2,
 857                             BackgroundPixel);
 858               EntriesPosX += (Screen->TitleImage->Width + TITLEICON_SPACING * 2);
 859            }
 860            EntriesPosY += (TextLineHeight() * 2);
 861            if (Screen->InfoLineCount > 0) {
 862                for (i = 0; i < (INTN)Screen->InfoLineCount; i++) {
 863                    DrawText(Screen->InfoLines[i], FALSE, LineWidth, EntriesPosX, EntriesPosY);
 864                    EntriesPosY += TextLineHeight();
 865                }
 866                EntriesPosY += TextLineHeight();  // also add a blank line
 867            }
 868
 869            for (i = 0; i <= State->MaxIndex; i++) {
 870               DrawText(Screen->Entries[i]->Title, (i == State->CurrentSelection), LineWidth, EntriesPosX,
 871                        EntriesPosY + i * TextLineHeight());
 872            }
 873            if (!(GlobalConfig.HideUIFlags & HIDEUI_FLAG_HINTS)) {
 874               if ((Screen->Hint1 != NULL) && (StrLen(Screen->Hint1) > 0))
 875                  DrawTextWithTransparency(Screen->Hint1, (UGAWidth - egComputeTextWidth(Screen->Hint1)) / 2,
 876                                           UGAHeight - (egGetFontHeight() * 3));
 877               if ((Screen->Hint2 != NULL) && (StrLen(Screen->Hint2) > 0))
 878                  DrawTextWithTransparency(Screen->Hint2, (UGAWidth - egComputeTextWidth(Screen->Hint2)) / 2,
 879                                            UGAHeight - (egGetFontHeight() * 2));
 880            } // if
 881            break;
 882
 883         case MENU_FUNCTION_PAINT_SELECTION:
 884             // redraw selection cursor
 885             DrawText(Screen->Entries[State->PreviousSelection]->Title, FALSE, LineWidth,
 886                      EntriesPosX, EntriesPosY + State->PreviousSelection * TextLineHeight());
 887             DrawText(Screen->Entries[State->CurrentSelection]->Title, TRUE, LineWidth,
 888                      EntriesPosX, EntriesPosY + State->CurrentSelection * TextLineHeight());
 889             break;
 890
 891         case MENU_FUNCTION_PAINT_TIMEOUT:
 892             DrawText(ParamText, FALSE, LineWidth, EntriesPosX, TimeoutPosY);
 893             break;
 894
 895     }
 896 } // static VOID GraphicsMenuStyle()
 897
 898 //
 899 // graphical main menu style
 900 //
 901
 902 static VOID DrawMainMenuEntry(REFIT_MENU_ENTRY *Entry, BOOLEAN selected, UINTN XPos, UINTN YPos)
 903 {
 904    EG_IMAGE *Background;
 905
 906    if (SelectionImages != NULL) {
 907       if (selected) {
 908          Background = egCropImage(GlobalConfig.ScreenBackground, XPos, YPos,
 909                                   SelectionImages[Entry->Row]->Width, SelectionImages[Entry->Row]->Height);
 910          egComposeImage(Background, SelectionImages[Entry->Row], 0, 0);
 911          BltImageCompositeBadge(Background, Entry->Image, Entry->BadgeImage, XPos, YPos);
 912       } else { // Image not selected; copy background
 913          egDrawImageWithTransparency(Entry->Image, Entry->BadgeImage, XPos, YPos,
 914                                      SelectionImages[Entry->Row]->Width, SelectionImages[Entry->Row]->Height);
 915       } // if/else
 916    } // if
 917 } // VOID DrawMainMenuEntry()
 918
 919 static VOID PaintAll(IN REFIT_MENU_SCREEN *Screen, IN SCROLL_STATE *State, UINTN *itemPosX,
 920                      UINTN row0PosY, UINTN row1PosY, UINTN textPosY) {
 921    INTN i;
 922
 923    if (Screen->Entries[State->CurrentSelection]->Row == 0)
 924       AdjustScrollState(State);
 925    for (i = State->FirstVisible; i <= State->MaxIndex; i++) {
 926       if (Screen->Entries[i]->Row == 0) {
 927          if (i <= State->LastVisible) {
 928             DrawMainMenuEntry(Screen->Entries[i], (i == State->CurrentSelection) ? TRUE : FALSE,
 929                               itemPosX[i - State->FirstVisible], row0PosY);
 930          } // if
 931       } else {
 932          DrawMainMenuEntry(Screen->Entries[i], (i == State->CurrentSelection) ? TRUE : FALSE, itemPosX[i], row1PosY);
 933       }
 934    }
 935    if (!(GlobalConfig.HideUIFlags & HIDEUI_FLAG_LABEL)) {
 936       DrawTextWithTransparency(L"", 0, textPosY);
 937       DrawTextWithTransparency(Screen->Entries[State->CurrentSelection]->Title,
 938                                (UGAWidth - egComputeTextWidth(Screen->Entries[State->CurrentSelection]->Title)) >> 1,
 939                                textPosY);
 940    }
 941
 942    if (!(GlobalConfig.HideUIFlags & HIDEUI_FLAG_HINTS)) {
 943       DrawTextWithTransparency(Screen->Hint1, (UGAWidth - egComputeTextWidth(Screen->Hint1)) / 2,
 944                                UGAHeight - (egGetFontHeight() * 3));
 945       DrawTextWithTransparency(Screen->Hint2, (UGAWidth - egComputeTextWidth(Screen->Hint2)) / 2,
 946                                UGAHeight - (egGetFontHeight() * 2));
 947    } // if
 948 } // static VOID PaintAll()
 949
 950 // Move the selection to State->CurrentSelection, adjusting icon row if necessary...
 951 static VOID PaintSelection(IN REFIT_MENU_SCREEN *Screen, IN SCROLL_STATE *State, UINTN *itemPosX,
 952                            UINTN row0PosY, UINTN row1PosY, UINTN textPosY) {
 953    UINTN XSelectPrev, XSelectCur, YPosPrev, YPosCur;
 954
 955    if (((State->CurrentSelection <= State->LastVisible) && (State->CurrentSelection >= State->FirstVisible)) ||
 956        (State->CurrentSelection >= State->InitialRow1) ) {
 957       if (Screen->Entries[State->PreviousSelection]->Row == 0) {
 958          XSelectPrev = State->PreviousSelection - State->FirstVisible;
 959          YPosPrev = row0PosY;
 960       } else {
 961          XSelectPrev = State->PreviousSelection;
 962          YPosPrev = row1PosY;
 963       } // if/else
 964       if (Screen->Entries[State->CurrentSelection]->Row == 0) {
 965          XSelectCur = State->CurrentSelection - State->FirstVisible;
 966          YPosCur = row0PosY;
 967       } else {
 968          XSelectCur = State->CurrentSelection;
 969          YPosCur = row1PosY;
 970       } // if/else
 971       DrawMainMenuEntry(Screen->Entries[State->PreviousSelection], FALSE, itemPosX[XSelectPrev], YPosPrev);
 972       DrawMainMenuEntry(Screen->Entries[State->CurrentSelection], TRUE, itemPosX[XSelectCur], YPosCur);
 973       if (!(GlobalConfig.HideUIFlags & HIDEUI_FLAG_LABEL)) {
 974          DrawTextWithTransparency(L"", 0, textPosY);
 975          DrawTextWithTransparency(Screen->Entries[State->CurrentSelection]->Title,
 976                                   (UGAWidth - egComputeTextWidth(Screen->Entries[State->CurrentSelection]->Title)) >> 1,
 977                                   textPosY);
 978       }
 979    } else { // Current selection not visible; must redraw the menu....
 980       MainMenuStyle(Screen, State, MENU_FUNCTION_PAINT_ALL, NULL);
 981    }
 982 } // static VOID MoveSelection(VOID)
 983
 984 // Display a 48x48 icon at the specified location. Uses the image specified by
 985 // ExternalFilename if it's available, or BuiltInImage if it's not. The
 986 // Y position is specified as the center value, and so is adjusted by half
 987 // the icon's height. The X position is set along the icon's left
 988 // edge if Alignment == ALIGN_LEFT, and along the right edge if
 989 // Alignment == ALIGN_RIGHT
 990 static VOID PaintIcon(IN EG_EMBEDDED_IMAGE *BuiltInIcon, IN CHAR16 *ExternalFilename, UINTN PosX, UINTN PosY, UINTN Alignment) {
 991    EG_IMAGE *Icon = NULL;
 992
 993    Icon = egFindIcon(ExternalFilename, GlobalConfig.IconSizes[ICON_SIZE_SMALL]);
 994    if (Icon == NULL)
 995       Icon = egPrepareEmbeddedImage(BuiltInIcon, TRUE);
 996    if (Icon != NULL) {
 997       if (Alignment == ALIGN_RIGHT)
 998          PosX -= Icon->Width;
 999       egDrawImageWithTransparency(Icon, NULL, PosX, PosY - (Icon->Height / 2), Icon->Width, Icon->Height);
1000    }
1001 } // static VOID ()
1002
1003 inline UINTN ComputeRow0PosY(VOID) {
1004    return ((UGAHeight / 2) - TileSizes[0] / 2);
1005 } // UINTN ComputeRow0PosY()
1006
1007 // Display (or erase) the arrow icons to the left and right of an icon's row,
1008 // as appropriate.
1009 static VOID PaintArrows(SCROLL_STATE *State, UINTN PosX, UINTN PosY, UINTN row0Loaders) {
1010    EG_IMAGE *TempImage;
1011    UINTN Width, Height, RightX, AdjPosY;
1012
1013    // NOTE: Assume that left and right arrows are of the same size....
1014    Width = egemb_arrow_left.Width;
1015    Height = egemb_arrow_left.Height;
1016    RightX = (UGAWidth + (TileSizes[0] + TILE_XSPACING) * State->MaxVisible) / 2 + TILE_XSPACING;
1017    AdjPosY = PosY - (Height / 2);
1018
1019    // For PaintIcon() calls, the starting Y position is moved to the midpoint
1020    // of the surrounding row; PaintIcon() adjusts this back up by half the
1021    // icon's height to properly center it.
1022    if ((State->FirstVisible > 0) && (!(GlobalConfig.HideUIFlags & HIDEUI_FLAG_ARROWS))) {
1023       PaintIcon(&egemb_arrow_left, L"arrow_left", PosX, PosY, ALIGN_RIGHT);
1024    } else {
1025       TempImage = egCropImage(GlobalConfig.ScreenBackground, PosX - Width, AdjPosY, Width, Height);
1026       BltImage(TempImage, PosX - Width, AdjPosY);
1027       egFreeImage(TempImage);
1028    } // if/else
1029
1030    if ((State->LastVisible < (row0Loaders - 1)) && (!(GlobalConfig.HideUIFlags & HIDEUI_FLAG_ARROWS))) {
1031       PaintIcon(&egemb_arrow_right, L"arrow_right", RightX, PosY, ALIGN_LEFT);
1032    } else {
1033       TempImage = egCropImage(GlobalConfig.ScreenBackground, RightX, AdjPosY, Width, Height);
1034       BltImage(TempImage, RightX, AdjPosY);
1035       egFreeImage(TempImage);
1036    } // if/else
1037 } // VOID PaintArrows()
1038
1039 // Display main menu in graphics mode
1040 VOID MainMenuStyle(IN REFIT_MENU_SCREEN *Screen, IN SCROLL_STATE *State, IN UINTN Function, IN CHAR16 *ParamText)
1041 {
1042     INTN i;
1043     static UINTN row0PosX, row0PosXRunning, row1PosY, row0Loaders;
1044     UINTN row0Count, row1Count, row1PosX, row1PosXRunning;
1045     static UINTN *itemPosX;
1046     static UINTN row0PosY, textPosY;
1047
1048     State->ScrollMode = SCROLL_MODE_ICONS;
1049     switch (Function) {
1050
1051         case MENU_FUNCTION_INIT:
1052             InitScroll(State, Screen->EntryCount, GlobalConfig.MaxTags);
1053
1054             // layout
1055             row0Count = 0;
1056             row1Count = 0;
1057             row0Loaders = 0;
1058             for (i = 0; i <= State->MaxIndex; i++) {
1059                if (Screen->Entries[i]->Row == 1) {
1060                   row1Count++;
1061                } else {
1062                   row0Loaders++;
1063                   if (row0Count < State->MaxVisible)
1064                      row0Count++;
1065                }
1066             }
1067             row0PosX = (UGAWidth + TILE_XSPACING - (TileSizes[0] + TILE_XSPACING) * row0Count) >> 1;
1068             row0PosY = ComputeRow0PosY();
1069             row1PosX = (UGAWidth + TILE_XSPACING - (TileSizes[1] + TILE_XSPACING) * row1Count) >> 1;
1070             row1PosY = row0PosY + TileSizes[0] + TILE_YSPACING;
1071             if (row1Count > 0)
1072                 textPosY = row1PosY + TileSizes[1] + TILE_YSPACING;
1073             else
1074                 textPosY = row1PosY;
1075
1076             itemPosX = AllocatePool(sizeof(UINTN) * Screen->EntryCount);
1077             row0PosXRunning = row0PosX;
1078             row1PosXRunning = row1PosX;
1079             for (i = 0; i <= State->MaxIndex; i++) {
1080                 if (Screen->Entries[i]->Row == 0) {
1081                     itemPosX[i] = row0PosXRunning;
1082                     row0PosXRunning += TileSizes[0] + TILE_XSPACING;
1083                 } else {
1084                     itemPosX[i] = row1PosXRunning;
1085                     row1PosXRunning += TileSizes[1] + TILE_XSPACING;
1086                 }
1087             }
1088             // initial painting
1089             InitSelection();
1090             SwitchToGraphicsAndClear();
1091             break;
1092
1093         case MENU_FUNCTION_CLEANUP:
1094             MyFreePool(itemPosX);
1095             break;
1096
1097         case MENU_FUNCTION_PAINT_ALL:
1098             PaintAll(Screen, State, itemPosX, row0PosY, row1PosY, textPosY);
1099             // For PaintArrows(), the starting Y position is moved to the midpoint
1100             // of the surrounding row; PaintIcon() adjusts this back up by half the
1101             // icon's height to properly center it.
1102             PaintArrows(State, row0PosX - TILE_XSPACING, row0PosY + (TileSizes[0] / 2), row0Loaders);
1103             break;
1104
1105         case MENU_FUNCTION_PAINT_SELECTION:
1106             PaintSelection(Screen, State, itemPosX, row0PosY, row1PosY, textPosY);
1107             break;
1108
1109         case MENU_FUNCTION_PAINT_TIMEOUT:
1110             if (!(GlobalConfig.HideUIFlags & HIDEUI_FLAG_LABEL)) {
1111                DrawTextWithTransparency(L"", 0, textPosY + TextLineHeight());
1112                DrawTextWithTransparency(ParamText, (UGAWidth - egComputeTextWidth(ParamText)) >> 1, textPosY + TextLineHeight());
1113             }
1114             break;
1115
1116     }
1117 } // VOID MainMenuStyle()
1118
1119 // Enable the user to edit boot loader options.
1120 // Returns TRUE if the user exited with edited options; FALSE if the user
1121 // pressed Esc to terminate the edit.
1122 static BOOLEAN EditOptions(LOADER_ENTRY *MenuEntry) {
1123    UINTN x_max, y_max;
1124    CHAR16 *EditedOptions;
1125    BOOLEAN retval = FALSE;
1126
1127    if (GlobalConfig.HideUIFlags & HIDEUI_FLAG_EDITOR) {
1128       return FALSE;
1129    }
1130
1131    refit_call4_wrapper(ST->ConOut->QueryMode, ST->ConOut, ST->ConOut->Mode->Mode, &x_max, &y_max);
1132
1133    if (!GlobalConfig.TextOnly)
1134       SwitchToText(TRUE);
1135
1136    if (line_edit(MenuEntry->LoadOptions, &EditedOptions, x_max)) {
1137       MyFreePool(MenuEntry->LoadOptions);
1138       MenuEntry->LoadOptions = EditedOptions;
1139       retval = TRUE;
1140    } // if
1141    if (!GlobalConfig.TextOnly)
1142       SwitchToGraphics();
1143    return retval;
1144 } // VOID EditOptions()
1145
1146 //
1147 // user-callable dispatcher functions
1148 //
1149
1150 UINTN RunMenu(IN REFIT_MENU_SCREEN *Screen, OUT REFIT_MENU_ENTRY **ChosenEntry)
1151 {
1152     INTN            DefaultEntry = -1;
1153     MENU_STYLE_FUNC Style = TextMenuStyle;
1154
1155     if (AllowGraphicsMode)
1156         Style = GraphicsMenuStyle;
1157
1158     return RunGenericMenu(Screen, Style, &DefaultEntry, ChosenEntry);
1159 }
1160
1161 UINTN RunMainMenu(IN REFIT_MENU_SCREEN *Screen, IN CHAR16* DefaultSelection, OUT REFIT_MENU_ENTRY **ChosenEntry)
1162 {
1163     MENU_STYLE_FUNC Style = TextMenuStyle;
1164     MENU_STYLE_FUNC MainStyle = TextMenuStyle;
1165     REFIT_MENU_ENTRY *TempChosenEntry;
1166     UINTN MenuExit = 0;
1167     INTN DefaultEntryIndex = -1;
1168     INTN DefaultSubmenuIndex = -1;
1169
1170     TileSizes[0] = (GlobalConfig.IconSizes[ICON_SIZE_BIG] * 9) / 8;
1171     TileSizes[1] = (GlobalConfig.IconSizes[ICON_SIZE_SMALL] * 4) / 3;
1172
1173     if (DefaultSelection != NULL) {
1174         // Find a menu entry that includes *DefaultSelection as a substring
1175         DefaultEntryIndex = FindMenuShortcutEntry(Screen, DefaultSelection);
1176     }
1177
1178     if (AllowGraphicsMode) {
1179         Style = GraphicsMenuStyle;
1180         MainStyle = MainMenuStyle;
1181     }
1182
1183     while (!MenuExit) {
1184         MenuExit = RunGenericMenu(Screen, MainStyle, &DefaultEntryIndex, &TempChosenEntry);
1185         Screen->TimeoutSeconds = 0;
1186
1187         if (MenuExit == MENU_EXIT_DETAILS) {
1188             if (TempChosenEntry->SubScreen != NULL) {
1189                MenuExit = RunGenericMenu(TempChosenEntry->SubScreen, Style, &DefaultSubmenuIndex, &TempChosenEntry);
1190                if (MenuExit == MENU_EXIT_ESCAPE || TempChosenEntry->Tag == TAG_RETURN)
1191                    MenuExit = 0;
1192                if (MenuExit == MENU_EXIT_DETAILS) {
1193                   if (!EditOptions((LOADER_ENTRY *) TempChosenEntry))
1194                      MenuExit = 0;
1195                } // if
1196             } else { // no sub-screen; ignore keypress
1197                MenuExit = 0;
1198             }
1199         } // Enter sub-screen
1200     }
1201
1202     if (ChosenEntry)
1203         *ChosenEntry = TempChosenEntry;
1204     return MenuExit;
1205 } /* UINTN RunMainMenu() */