JsonLib.h

Go to the documentation of this file.

 
#ifndef JSON_LIB_H_
#define JSON_LIB_H_
 
typedef    VOID  *EDKII_JSON_VALUE;
typedef    VOID  *EDKII_JSON_ARRAY;
typedef    VOID  *EDKII_JSON_OBJECT;
 
typedef    INT64 EDKII_JSON_INT_T;   // #JSON_INTEGER_IS_LONG_LONG is set to 1
                                     // in jansson_Config.h
 
#define EDKII_JSON_MAX_INDENT  0x1F
#define EDKII_JSON_INDENT(n)  ((n) & EDKII_JSON_MAX_INDENT)
 
#define EDKII_JSON_COMPACT         0x20
#define EDKII_JSON_ENSURE_ASCII    0x40
#define EDKII_JSON_SORT_KEYS       0x80
#define EDKII_JSON_PRESERVE_ORDER  0x100
#define EDKII_JSON_ENCODE_ANY      0x200
#define EDKII_JSON_ESCAPE_SLASH    0x400
#define EDKII_JSON_REAL_PRECISION(n)  (((n) & 0x1F) << 11)
#define EDKII_JSON_EMBED  0x10000
 
#define EDKII_JSON_REJECT_DUPLICATES   0x1
#define EDKII_JSON_DISABLE_EOF_CHECK   0x2
#define EDKII_JSON_DECODE_ANY          0x4
#define EDKII_JSON_DECODE_INT_AS_REAL  0x8
#define EDKII_JSON_ALLOW_NUL           0x10
 
#define EDKII_JSON_ARRAY_FOREACH(Array, Index, Value) \
  for(Index = 0; \
    Index < JsonArrayCount(Array) && (Value = JsonArrayGetValue(Array, Index)); \
    Index++)
 
#define EDKII_JSON_OBJECT_FOREACH_SAFE(Object, N, Key, Value)           \
    for (Key = JsonObjectIteratorKey(JsonObjectIterator(Object)),                \
        N = JsonObjectIteratorNext(Object, JsonObjectKeyToIterator(Key));        \
        Key && (Value = JsonObjectIteratorValue(JsonObjectKeyToIterator(Key)));  \
        Key = JsonObjectIteratorKey(N),                                      \
        N = JsonObjectIteratorNext(Object, JsonObjectKeyToIterator(Key)))
 
#define EDKII_JSON_ERROR_TEXT_LENGTH    160
#define EDKII_JSON_ERROR_SOURCE_LENGTH  80
typedef struct {
  INTN     Line;
  INTN     Column;
  INTN     Position;
  CHAR8    Source[EDKII_JSON_ERROR_SOURCE_LENGTH];
  CHAR8    Text[EDKII_JSON_ERROR_TEXT_LENGTH];
} EDKII_JSON_ERROR;
 
typedef enum {
  EdkiiJsonTypeObject,
  EdkiiJsonTypeArray,
  EdkiiJsonTypeString,
  EdkiiJsonTypeInteger,
  EdkiiJsonTypeReal,
  EdkiiJsonTypeTrue,
  EdkiiJsonTypeFalse,
  EdkiiJsonTypeNull
} EDKII_JSON_TYPE;
 
EDKII_JSON_VALUE
EFIAPI
JsonValueInitArray (
  VOID
  );
 
EDKII_JSON_VALUE
EFIAPI
JsonValueInitObject (
  VOID
  );
 
EDKII_JSON_VALUE
EFIAPI
JsonValueInitAsciiString (
  IN    CONST CHAR8  *String
  );
 
EDKII_JSON_VALUE
EFIAPI
JsonValueInitUnicodeString (
  IN    CHAR16  *String
  );
 
EDKII_JSON_VALUE
EFIAPI
JsonValueInitInteger (
  IN    INT64  Value
  );
 
EDKII_JSON_VALUE
EFIAPI
JsonValueInitBoolean (
  IN    BOOLEAN  Value
  );
 
EDKII_JSON_VALUE
EFIAPI
JsonValueInitNull (
  VOID
  );
 
EDKII_JSON_VALUE
EFIAPI
JsonValueInitTrue (
  VOID
  );
 
EDKII_JSON_VALUE
EFIAPI
JsonValueInitFalse (
  VOID
  );
 
VOID
EFIAPI
JsonValueFree (
  IN    EDKII_JSON_VALUE  Json
  );
 
EDKII_JSON_VALUE
EFIAPI
JsonValueClone (
  IN    EDKII_JSON_VALUE  Json
  );
 
BOOLEAN
EFIAPI
JsonValueIsArray (
  IN    EDKII_JSON_VALUE  Json
  );
 
BOOLEAN
EFIAPI
JsonValueIsObject (
  IN    EDKII_JSON_VALUE  Json
  );
 
BOOLEAN
EFIAPI
JsonValueIsString (
  IN    EDKII_JSON_VALUE  Json
  );
 
BOOLEAN
EFIAPI
JsonValueIsInteger (
  IN    EDKII_JSON_VALUE  Json
  );
 
BOOLEAN
EFIAPI
JsonValueIsNumber (
  IN    EDKII_JSON_VALUE  Json
  );
 
BOOLEAN
EFIAPI
JsonValueIsBoolean (
  IN    EDKII_JSON_VALUE  Json
  );
 
BOOLEAN
EFIAPI
JsonValueIsTrue (
  IN    EDKII_JSON_VALUE  Json
  );
 
BOOLEAN
EFIAPI
JsonValueIsFalse (
  IN    EDKII_JSON_VALUE  Json
  );
 
BOOLEAN
EFIAPI
JsonValueIsNull (
  IN    EDKII_JSON_VALUE  Json
  );
 
EDKII_JSON_ARRAY
EFIAPI
JsonValueGetArray (
  IN    EDKII_JSON_VALUE  Json
  );
 
EDKII_JSON_OBJECT
EFIAPI
JsonValueGetObject (
  IN    EDKII_JSON_VALUE  Json
  );
 
CONST CHAR8 *
EFIAPI
JsonValueGetAsciiString (
  IN    EDKII_JSON_VALUE  Json
  );
 
CHAR16 *
EFIAPI
JsonValueGetUnicodeString (
  IN    EDKII_JSON_VALUE  Json
  );
 
INT64
EFIAPI
JsonValueGetInteger (
  IN    EDKII_JSON_VALUE  Json
  );
 
BOOLEAN
EFIAPI
JsonValueGetBoolean (
  IN    EDKII_JSON_VALUE  Json
  );
 
CONST CHAR8 *
EFIAPI
JsonValueGetString (
  IN    EDKII_JSON_VALUE  Json
  );
 
UINTN
EFIAPI
JsonObjectSize (
  IN    EDKII_JSON_OBJECT  JsonObject
  );
 
EFI_STATUS
EFIAPI
JsonObjectClear (
  IN    EDKII_JSON_OBJECT  JsonObject
  );
 
CHAR8 **
JsonObjectGetKeys (
  IN    EDKII_JSON_OBJECT  JsonObj,
  OUT   UINTN              *KeyCount
  );
 
EDKII_JSON_VALUE
EFIAPI
JsonObjectGetValue (
  IN    CONST EDKII_JSON_OBJECT  JsonObj,
  IN    CONST CHAR8              *Key
  );
 
EFI_STATUS
EFIAPI
JsonObjectSetValue (
  IN    EDKII_JSON_OBJECT  JsonObj,
  IN    CONST CHAR8        *Key,
  IN    EDKII_JSON_VALUE   Json
  );
 
EFI_STATUS
EFIAPI
JsonObjectDelete (
  IN    EDKII_JSON_OBJECT  JsonObj,
  IN    CONST CHAR8        *Key
  );
 
UINTN
EFIAPI
JsonArrayCount (
  IN    EDKII_JSON_ARRAY  JsonArray
  );
 
EDKII_JSON_VALUE
EFIAPI
JsonArrayGetValue (
  IN    EDKII_JSON_ARRAY  JsonArray,
  IN    UINTN             Index
  );
 
EFI_STATUS
EFIAPI
JsonArrayAppendValue (
  IN    EDKII_JSON_ARRAY  JsonArray,
  IN    EDKII_JSON_VALUE  Json
  );
 
EFI_STATUS
EFIAPI
JsonArrayRemoveValue (
  IN    EDKII_JSON_ARRAY  JsonArray,
  IN    UINTN             Index
  );
 
CHAR8 *
EFIAPI
JsonDumpString (
  IN    EDKII_JSON_VALUE  JsonValue,
  IN    UINTN             Flags
  );
 
EDKII_JSON_VALUE
EFIAPI
JsonLoadString (
  IN    CONST CHAR8       *String,
  IN    UINT64            Flags,
  IN    EDKII_JSON_ERROR  *Error
  );
 
EDKII_JSON_VALUE
EFIAPI
JsonLoadBuffer (
  IN    CONST CHAR8        *Buffer,
  IN    UINTN              BufferLen,
  IN    UINTN              Flags,
  IN OUT EDKII_JSON_ERROR  *Error
  );
 
VOID
EFIAPI
JsonDecreaseReference (
  IN EDKII_JSON_VALUE  JsonValue
  );
 
EDKII_JSON_VALUE
EFIAPI
JsonIncreaseReference (
  IN EDKII_JSON_VALUE  JsonValue
  );
 
VOID *
EFIAPI
JsonObjectIterator (
  IN EDKII_JSON_VALUE  JsonValue
  );
 
EDKII_JSON_VALUE
EFIAPI
JsonObjectIteratorValue (
  IN VOID  *Iterator
  );
 
VOID *
EFIAPI
JsonObjectIteratorNext (
  IN EDKII_JSON_VALUE  JsonValue,
  IN VOID              *Iterator
  );
 
CHAR8 *
EFIAPI
JsonObjectIteratorKey (
  IN VOID  *Iterator
  );
 
VOID *
EFIAPI
JsonObjectKeyToIterator (
  IN CHAR8  *Key
  );
 
EDKII_JSON_TYPE
EFIAPI
JsonGetType (
  IN EDKII_JSON_VALUE  JsonValue
  );
 
#endif