Update to new SVN URL in readme.txt

[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / EditStatusBar.c

/** @file\r
  Implements statusbar interface functions.\r
\r
  Copyright (c) 2005 - 2011, Intel Corporation. All rights reserved. <BR>\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include "EditStatusBar.h"\r
#include "UefiShellDebug1CommandsLib.h"\r
\r
CHAR16  *StatusString;\r
BOOLEAN StatusBarNeedRefresh;\r
BOOLEAN StatusStringChanged;\r
\r
/**\r
  Initialization function for Status Bar.\r
\r
  @retval EFI_SUCCESS           The operation was successful.\r
  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.\r
  @sa StatusBarSetStatusString\r
**/\r
EFI_STATUS\r
EFIAPI\r
StatusBarInit (\r
  VOID\r
  )\r
{\r
  //\r
  // initialize the statusbar\r
  //\r
  StatusString         = NULL;\r
  StatusBarNeedRefresh = TRUE;\r
  StatusStringChanged  = FALSE;\r
\r
  //\r
  // status string set to ""\r
  //\r
  return (StatusBarSetStatusString (L""));\r
}\r
\r
/**\r
  Cleanup function for the status bar.\r
**/\r
VOID\r
EFIAPI\r
StatusBarCleanup (\r
  VOID\r
  )\r
{\r
  //\r
  // free the status string and backvar's status string\r
  //\r
  SHELL_FREE_NON_NULL (StatusString);\r
}\r
\r
typedef struct {\r
  UINT32  Foreground : 4;\r
  UINT32  Background : 4;\r
} STATUS_BAR_COLOR_ATTRIBUTES;\r
\r
typedef union {\r
  STATUS_BAR_COLOR_ATTRIBUTES  Colors;\r
  UINTN                       Data;\r
} STATUS_BAR_COLOR_UNION;\r
\r
/**\r
  Cause the status bar to refresh it's printing on the screen.\r
\r
  @param[in] EditorFirst      TRUE to indicate the first launch of the editor.  \r
                              FALSE otherwise.\r
  @param[in] LastRow          LastPrintable row.\r
  @param[in] LastCol          Last printable column.\r
  @param[in] FileRow          Row in the file.\r
  @param[in] FileCol          Column in the file.\r
  @param[in] InsertMode       TRUE to indicate InsertMode.  FALSE otherwise.\r
\r
  @retval EFI_SUCCESS         The operation was successful.\r
**/\r
EFI_STATUS\r
EFIAPI\r
StatusBarRefresh (\r
  IN BOOLEAN  EditorFirst,\r
  IN UINTN    LastRow,\r
  IN UINTN    LastCol,\r
  IN UINTN    FileRow,\r
  IN UINTN    FileCol,\r
  IN BOOLEAN  InsertMode\r
  )\r
{\r
  STATUS_BAR_COLOR_UNION  Orig;\r
  STATUS_BAR_COLOR_UNION  New;\r
\r
  if (!StatusStringChanged && StatusBarNeedRefresh) {\r
    StatusBarSetStatusString (L"\0");\r
  }\r
  //\r
  // when it's called first time after editor launch, so refresh is mandatory\r
  //\r
  if (!StatusBarNeedRefresh && !StatusStringChanged) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  //\r
  // back up the screen attributes\r
  //\r
  Orig.Data             = gST->ConOut->Mode->Attribute;\r
  New.Colors.Foreground = Orig.Colors.Background;\r
  New.Colors.Background = Orig.Colors.Foreground;\r
\r
  gST->ConOut->EnableCursor (gST->ConOut, FALSE);\r
  gST->ConOut->SetAttribute (gST->ConOut, New.Data);\r
\r
  //\r
  // clear status bar\r
  //\r
  EditorClearLine (LastRow, LastCol, LastRow);\r
\r
  //\r
  // print row, column fields\r
  //\r
  if (FileRow != (UINTN)(-1) && FileCol != (UINTN)(-1)) {\r
    ShellPrintEx (\r
      0,\r
      (INT32)(LastRow) - 1,\r
      L" %d,%d       %s",\r
      FileRow,\r
      FileCol,\r
      StatusString\r
      );\r
  } else {\r
    ShellPrintEx (\r
      0,\r
      (INT32)(LastRow) - 1,\r
      L"  %s",\r
      StatusString\r
      );\r
  }\r
\r
  //\r
  // print insert mode field\r
  //\r
  if (InsertMode) {\r
    ShellPrintEx ((INT32)(LastCol) - 21, (INT32)(LastRow) - 1, L"|%s|   Help: Ctrl-E", L"INS");\r
  } else {\r
    ShellPrintEx ((INT32)(LastCol) - 21, (INT32)(LastRow) - 1, L"|%s|   Help: Ctrl-E", L"OVR");\r
  }\r
  //\r
  // restore the old screen attributes\r
  //\r
  gST->ConOut->SetAttribute (gST->ConOut, Orig.Data);\r
\r
  //\r
  // restore position in edit area\r
  //\r
  gST->ConOut->EnableCursor (gST->ConOut, TRUE);\r
\r
  StatusBarNeedRefresh  = FALSE;\r
  StatusStringChanged   = FALSE;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Set the status string text part.\r
\r
  @param[in] Str                The string to use.\r
\r
  @retval EFI_SUCCESS           The operation was successful.\r
  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.\r
**/\r
EFI_STATUS\r
EFIAPI\r
StatusBarSetStatusString (\r
  IN CHAR16 *Str\r
  )\r
{\r
  StatusStringChanged = TRUE;\r
\r
  //\r
  // free the old status string\r
  //\r
  SHELL_FREE_NON_NULL (StatusString);\r
  StatusString = CatSPrint (NULL, L"%s", Str);\r
  if (StatusString == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Function to retrieve the current status string.\r
\r
  @return The string that is used.\r
**/\r
CONST CHAR16*\r
EFIAPI\r
StatusBarGetString (\r
  VOID\r
  )\r
{\r
  return (StatusString);\r
}\r
\r
/**\r
  Function to set the need refresh boolean to TRUE.\r
**/\r
VOID\r
EFIAPI\r
StatusBarSetRefresh(\r
  VOID\r
  )\r
{\r
  StatusBarNeedRefresh = TRUE;\r
}\r
\r
/**\r
  Function to get the need refresh boolean to TRUE.\r
\r
  @retval TRUE    The status bar needs to be refreshed.\r
**/\r
BOOLEAN\r
EFIAPI\r
StatusBarGetRefresh(\r
  VOID\r
  )\r
{\r
  return (StatusBarNeedRefresh);\r
}\r