OcFlexArrayLib.h

Go to the documentation of this file.

 
#ifndef OC_FLEX_ARRAY_LIB_H
#define OC_FLEX_ARRAY_LIB_H
 
#if !defined (OC_TRACE_FLEX)
#define OC_TRACE_FLEX  DEBUG_VERBOSE
#endif
 
#include <Uefi.h>
#include <Library/OcStringLib.h>
#include <Protocol/ApplePlatformInfoDatabase.h>
 
typedef struct OC_FLEX_ARRAY_ OC_FLEX_ARRAY;
 
typedef
VOID
(*OC_FLEX_ARRAY_FREE_ITEM) (
  IN  VOID  *Item
  );
 
VOID
OcFlexArrayFreePointerItem (
  IN  VOID  *Item
  );
 
OC_FLEX_ARRAY *
OcFlexArrayInit (
  IN     CONST UINTN                    ItemSize,
  IN     CONST OC_FLEX_ARRAY_FREE_ITEM  FreeItem   OPTIONAL
  );
 
VOID *
OcFlexArrayAddItem (
  IN OUT       OC_FLEX_ARRAY  *FlexArray
  );
 
VOID *
OcFlexArrayInsertItem (
  IN OUT  OC_FLEX_ARRAY  *FlexArray,
  IN      CONST UINTN    InsertIndex
  );
 
VOID *
OcFlexArrayItemAt (
  IN     CONST OC_FLEX_ARRAY  *FlexArray,
  IN     CONST UINTN          Index
  );
 
VOID
OcFlexArrayFree (
  IN OUT       OC_FLEX_ARRAY  **FlexArray
  );
 
VOID
OcFlexArrayDiscardItem (
  IN OUT  OC_FLEX_ARRAY  *FlexArray,
  IN      CONST BOOLEAN  FreeItem
  );
 
VOID
OcFlexArrayFreeContainer (
  IN OUT       OC_FLEX_ARRAY  **FlexArray,
  IN OUT       VOID           **Items,
  IN OUT       UINTN          *Count
  );
 
/*
  Flex array.
*/
struct OC_FLEX_ARRAY_ {
  //
  // Allocated array.
  //
  VOID                       *Items;
  //
  // Item size.
  //
  UINTN                      ItemSize;
  //
  // Current used count.
  //
  UINTN                      Count;
  //
  // Current allocated count.
  //
  UINTN                      AllocatedCount;
  //
  // Optional method to free memory pointed to from item.
  //
  OC_FLEX_ARRAY_FREE_ITEM    FreeItem;
};
 
/*
  Forward declaration of OC_ASCII_STRING_BUFFER structure.
*/
typedef struct OC_ASCII_STRING_BUFFER_ OC_ASCII_STRING_BUFFER;
 
OC_ASCII_STRING_BUFFER *
OcAsciiStringBufferInit (
  VOID
  );
 
EFI_STATUS
OcAsciiStringBufferAppend (
  IN OUT  OC_ASCII_STRING_BUFFER  *Buffer,
  IN      CONST CHAR8             *AppendString    OPTIONAL
  );
 
EFI_STATUS
OcAsciiStringBufferAppendN (
  IN OUT  OC_ASCII_STRING_BUFFER *Buffer,
  IN      CONST CHAR8 *AppendString, OPTIONAL
  IN      CONST UINTN         Length
  );
 
EFI_STATUS
EFIAPI
OcAsciiStringBufferSPrint (
  IN OUT  OC_ASCII_STRING_BUFFER  *Buffer,
  IN      CONST CHAR8             *FormatString,
  ...
  );
 
CHAR8 *
OcAsciiStringBufferFreeContainer (
  IN OUT  OC_ASCII_STRING_BUFFER  **StringBuffer
  );
 
VOID
OcAsciiStringBufferFree (
  IN OUT  OC_ASCII_STRING_BUFFER  **StringBuffer
  );
 
/*
  String buffer.
*/
struct OC_ASCII_STRING_BUFFER_ {
  CHAR8    *String;
  UINTN    StringLength;
  UINTN    BufferSize;
};
 
OC_FLEX_ARRAY *
OcStringSplit (
  IN  CONST VOID              *String,
  IN  CONST CHAR16            Delim,
  IN  CONST OC_STRING_FORMAT  StringFormat
  );
 
#endif // OC_FLEX_ARRAY_LIB_H