License header updated to match correct format.

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

/** @file\r
This contains some useful functions for accessing files.\r
\r
Copyright (c) 2004 - 2014, 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 <assert.h>\r
#include <string.h>\r
#include <ctype.h>\r
#include <stdlib.h>\r
#include "CommonLib.h"\r
#include "MemoryFile.h"\r
\r
\r
//\r
// Local (static) function prototypes\r
//\r
STATIC\r
VOID\r
CheckMemoryFileState (\r
  IN EFI_HANDLE InputMemoryFile\r
  );\r
\r
//\r
// Function implementations\r
//\r
\r
EFI_STATUS\r
GetMemoryFile (\r
  IN CHAR8       *InputFileName,\r
  OUT EFI_HANDLE *OutputMemoryFile\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
  EFI_STATUS  Status;\r
  CHAR8       *InputFileImage;\r
  UINT32      BytesRead;\r
  MEMORY_FILE *NewMemoryFile;\r
\r
  Status = GetFileImage (InputFileName, &InputFileImage, &BytesRead);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  NewMemoryFile = malloc (sizeof (*NewMemoryFile));\r
  if (NewMemoryFile == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  NewMemoryFile->FileImage           = InputFileImage;\r
  NewMemoryFile->CurrentFilePointer  = InputFileImage;\r
  NewMemoryFile->Eof                 = InputFileImage + BytesRead;\r
\r
  *OutputMemoryFile = (EFI_HANDLE)NewMemoryFile;\r
\r
  CheckMemoryFileState (*OutputMemoryFile);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
EFI_STATUS\r
FreeMemoryFile (\r
  IN EFI_HANDLE InputMemoryFile\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
  MEMORY_FILE *MemoryFile;\r
\r
  CheckMemoryFileState (InputMemoryFile);\r
\r
  MemoryFile = (MEMORY_FILE*)InputMemoryFile;\r
\r
  free (MemoryFile->FileImage);\r
\r
  //\r
  // Invalidate state of MEMORY_FILE structure to catch invalid usage.\r
  //\r
  memset (MemoryFile, 0xcc, sizeof (*MemoryFile));\r
  MemoryFile->Eof -= 1;\r
\r
  free (MemoryFile);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
CHAR8 *\r
ReadMemoryFileLine (\r
  IN EFI_HANDLE     InputMemoryFile\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
  CHAR8       *EndOfLine;\r
  UINTN       CharsToCopy;\r
  MEMORY_FILE *InputFile;\r
  UINTN       BytesToEof;\r
  CHAR8       *OutputString;\r
\r
  //\r
  // Verify input parameters are not null\r
  //\r
  CheckMemoryFileState (InputMemoryFile);\r
\r
  InputFile = (MEMORY_FILE*)InputMemoryFile;\r
\r
  //\r
  // Check for end of file condition\r
  //\r
  if (InputFile->CurrentFilePointer >= InputFile->Eof) {\r
    return NULL;\r
  }\r
\r
  //\r
  // Determine the number of bytes remaining until the EOF\r
  //\r
  BytesToEof = InputFile->Eof - InputFile->CurrentFilePointer;\r
\r
  //\r
  // Find the next newline char\r
  //\r
  EndOfLine = memchr (InputFile->CurrentFilePointer, '\n', BytesToEof);\r
\r
  //\r
  // Determine the number of characters to copy.\r
  //\r
  if (EndOfLine == 0) {\r
    //\r
    // If no newline found, copy to the end of the file.\r
    //\r
    CharsToCopy = InputFile->Eof - InputFile->CurrentFilePointer;\r
  } else {\r
    //\r
    // Newline found in the file.\r
    //\r
    CharsToCopy = EndOfLine - InputFile->CurrentFilePointer;\r
  }\r
\r
  OutputString = malloc (CharsToCopy);\r
  if (OutputString == NULL) {\r
    return NULL;\r
  }\r
\r
  //\r
  // Copy the line.\r
  //\r
  memcpy (OutputString, InputFile->CurrentFilePointer, CharsToCopy);\r
\r
  //\r
  // Add the null termination over the 0x0D\r
  //\r
  if (OutputString[CharsToCopy - 1] == '\r') {\r
\r
    OutputString[CharsToCopy - 1] = '\0';\r
\r
  } else {\r
\r
    OutputString[CharsToCopy] = '\0';\r
\r
  }\r
\r
  //\r
  // Increment the current file pointer (include the 0x0A)\r
  //\r
  InputFile->CurrentFilePointer += CharsToCopy + 1;\r
  CheckMemoryFileState (InputMemoryFile);\r
\r
  //\r
  // Return the string\r
  //\r
  return OutputString;\r
}\r
\r
\r
STATIC\r
VOID\r
CheckMemoryFileState (\r
  IN EFI_HANDLE InputMemoryFile\r
  )\r
{\r
  MEMORY_FILE *MemoryFile;\r
\r
  assert (InputMemoryFile != NULL);\r
\r
  MemoryFile = (MEMORY_FILE*)InputMemoryFile;\r
\r
  assert (MemoryFile->FileImage != NULL);\r
  assert (MemoryFile->CurrentFilePointer != NULL);\r
  assert (MemoryFile->Eof != NULL);\r
  assert (MemoryFile->Eof >= MemoryFile->FileImage);\r
  assert (MemoryFile->CurrentFilePointer >= MemoryFile->FileImage);\r
  assert (MemoryFile->CurrentFilePointer <= MemoryFile->Eof);\r
}\r
\r
\r