ShellPkg: Clean up source files

[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / HexEdit / Clipboard.c

/** @file\r
    Functions to deal with Clip Board\r
\r
  Copyright (c) 2005 - 2018, 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 "HexEditor.h"\r
\r
typedef struct {\r
  UINT8 *Buffer;\r
  UINTN Size;\r
} HEFI_EDITOR_CLIPBOARD;\r
\r
HEFI_EDITOR_CLIPBOARD HClipBoard;\r
\r
//\r
// for basic initialization of HClipBoard\r
//\r
HEFI_EDITOR_CLIPBOARD HClipBoardConst = {\r
  NULL,\r
  0\r
};\r
\r
/**\r
  Initialization function for HDiskImage.\r
\r
  @param[in] EFI_SUCCESS      The operation was successful.\r
  @param[in] EFI_LOAD_ERROR   A load error occured.\r
**/\r
EFI_STATUS\r
HClipBoardInit (\r
  VOID\r
  )\r
{\r
  //\r
  // basiclly initialize the HDiskImage\r
  //\r
  CopyMem (&HClipBoard, &HClipBoardConst, sizeof (HClipBoard));\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Initialization function for HDiskImage.\r
\r
  @param[in] EFI_SUCCESS      The operation was successful.\r
  @param[in] EFI_LOAD_ERROR   A load error occured.\r
**/\r
EFI_STATUS\r
HClipBoardCleanup (\r
  VOID\r
  )\r
{\r
\r
  SHELL_FREE_NON_NULL (HClipBoard.Buffer);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Set a buffer into the clipboard.\r
\r
  @param[in] Buffer   The buffer to add to the clipboard.\r
  @param[in] Size     The size of Buffer in bytes.\r
\r
  @retval EFI_SUCCESS   The operation was successful.\r
**/\r
EFI_STATUS\r
HClipBoardSet (\r
  IN UINT8 *Buffer,\r
  IN UINTN Size\r
  )\r
{\r
  //\r
  // free the old clipboard buffer\r
  // and set new clipboard buffer\r
  //\r
  SHELL_FREE_NON_NULL (HClipBoard.Buffer);\r
  HClipBoard.Buffer = Buffer;\r
\r
  HClipBoard.Size   = Size;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Get a buffer from the clipboard.\r
\r
  @param[out] Buffer   The pointer to the buffer to add to the clipboard.\r
\r
  @return the size of the buffer.\r
**/\r
UINTN\r
HClipBoardGet (\r
  OUT UINT8  **Buffer\r
  )\r
{\r
  //\r
  // return the clipboard buffer\r
  //\r
  *Buffer = HClipBoard.Buffer;\r
\r
  return HClipBoard.Size;\r
}\r