BaseTools: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / BaseTools / Source / C / Common / MemoryFile.h

/** @file\r
Header file for helper functions useful for accessing files.\r
\r
Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _EFI_MEMORY_FILE_H\r
#define _EFI_MEMORY_FILE_H\r
\r
#include <stdio.h>\r
#include <stdlib.h>\r
#include <Common/UefiBaseTypes.h>\r
\r
//\r
// Common data structures\r
//\r
typedef struct {\r
  CHAR8 *FileImage;\r
  CHAR8 *Eof;\r
  CHAR8 *CurrentFilePointer;\r
} MEMORY_FILE;\r
\r
\r
//\r
// Functions declarations\r
//\r
\r
EFI_STATUS\r
GetMemoryFile (\r
  IN CHAR8       *InputFileName,\r
  OUT EFI_HANDLE *OutputMemoryFile\r
  )\r
;\r
/**\r
\r
Routine Description:\r
\r
  This opens a file, reads it into memory and returns a memory file\r
  object.\r
\r
Arguments:\r
\r
  InputFile          Memory file image.\r
  OutputMemoryFile   Handle to memory file\r
\r
Returns:\r
\r
  EFI_STATUS\r
  OutputMemoryFile is valid if !EFI_ERROR\r
\r
**/\r
\r
\r
EFI_STATUS\r
FreeMemoryFile (\r
  IN EFI_HANDLE InputMemoryFile\r
  )\r
;\r
/**\r
\r
Routine Description:\r
\r
  Frees all memory associated with the input memory file.\r
\r
Arguments:\r
\r
  InputMemoryFile   Handle to memory file\r
\r
Returns:\r
\r
  EFI_STATUS\r
\r
**/\r
\r
\r
CHAR8 *\r
ReadMemoryFileLine (\r
  IN EFI_HANDLE     InputMemoryFile\r
  )\r
;\r
/**\r
\r
Routine Description:\r
\r
  This function reads a line from the memory file.  The newline characters\r
  are stripped and a null terminated string is returned.\r
\r
  If the string pointer returned is non-NULL, then the caller must free the\r
  memory associated with this string.\r
\r
Arguments:\r
\r
  InputMemoryFile   Handle to memory file\r
\r
Returns:\r
\r
  NULL if error or EOF\r
  NULL character termincated string otherwise (MUST BE FREED BY CALLER)\r
\r
**/\r
\r
\r
#endif\r