]> git.proxmox.com Git - mirror_edk2.git/blobdiff - RedfishPkg/Include/Library/JsonLib.h
RedfishPkg: Apply uncrustify changes
[mirror_edk2.git] / RedfishPkg / Include / Library / JsonLib.h
index 83959dd52a04d1b57e592ca72aca3d1e41f80a35..f98f4e779ede204ff0ea1c53f2269b23b909185c 100644 (file)
@@ -7,17 +7,18 @@
     SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
+\r
 #ifndef JSON_LIB_H_\r
 #define JSON_LIB_H_\r
 \r
-typedef    VOID*    EDKII_JSON_VALUE;\r
-typedef    VOID*    EDKII_JSON_ARRAY;\r
-typedef    VOID*    EDKII_JSON_OBJECT;\r
+typedef    VOID  *EDKII_JSON_VALUE;\r
+typedef    VOID  *EDKII_JSON_ARRAY;\r
+typedef    VOID  *EDKII_JSON_OBJECT;\r
 \r
 ///\r
 /// Map to json_int_t in jansson.h\r
 ///\r
-typedef    INT64   EDKII_JSON_INT_T; // #JSON_INTEGER_IS_LONG_LONG is set to 1\r
+typedef    INT64 EDKII_JSON_INT_T;   // #JSON_INTEGER_IS_LONG_LONG is set to 1\r
                                      // in jansson_Config.h\r
 \r
 ///\r
@@ -25,28 +26,28 @@ typedef    INT64   EDKII_JSON_INT_T; // #JSON_INTEGER_IS_LONG_LONG is set to 1
 /// See below URI for the JSON encoding flags reference.\r
 /// https://jansson.readthedocs.io/en/2.13/apiref.html#encoding\r
 ///\r
-#define EDKII_JSON_MAX_INDENT        0x1F\r
-#define EDKII_JSON_INDENT(n)         ((n) & EDKII_JSON_MAX_INDENT)\r
-\r
-#define EDKII_JSON_COMPACT           0x20\r
-#define EDKII_JSON_ENSURE_ASCII      0x40\r
-#define EDKII_JSON_SORT_KEYS         0x80\r
-#define EDKII_JSON_PRESERVE_ORDER    0x100\r
-#define EDKII_JSON_ENCODE_ANY        0x200\r
-#define EDKII_JSON_ESCAPE_SLASH      0x400\r
-#define EDKII_JSON_REAL_PRECISION(n) (((n) & 0x1F) << 11)\r
-#define EDKII_JSON_EMBED             0x10000\r
+#define EDKII_JSON_MAX_INDENT  0x1F\r
+#define EDKII_JSON_INDENT(n)  ((n) & EDKII_JSON_MAX_INDENT)\r
+\r
+#define EDKII_JSON_COMPACT         0x20\r
+#define EDKII_JSON_ENSURE_ASCII    0x40\r
+#define EDKII_JSON_SORT_KEYS       0x80\r
+#define EDKII_JSON_PRESERVE_ORDER  0x100\r
+#define EDKII_JSON_ENCODE_ANY      0x200\r
+#define EDKII_JSON_ESCAPE_SLASH    0x400\r
+#define EDKII_JSON_REAL_PRECISION(n)  (((n) & 0x1F) << 11)\r
+#define EDKII_JSON_EMBED  0x10000\r
 \r
 ///\r
 /// Map to the definitions in jansson.h\r
 /// See below URI for the JSON decoding flags reference.\r
 /// https://jansson.readthedocs.io/en/2.13/apiref.html?highlight=json_loadb#decoding\r
 ///\r
-#define EDKII_JSON_REJECT_DUPLICATES  0x1\r
-#define EDKII_JSON_DISABLE_EOF_CHECK  0x2\r
-#define EDKII_JSON_DECODE_ANY         0x4\r
-#define EDKII_JSON_DECODE_INT_AS_REAL 0x8\r
-#define EDKII_JSON_ALLOW_NUL          0x10\r
+#define EDKII_JSON_REJECT_DUPLICATES   0x1\r
+#define EDKII_JSON_DISABLE_EOF_CHECK   0x2\r
+#define EDKII_JSON_DECODE_ANY          0x4\r
+#define EDKII_JSON_DECODE_INT_AS_REAL  0x8\r
+#define EDKII_JSON_ALLOW_NUL           0x10\r
 \r
 #define EDKII_JSON_ARRAY_FOREACH(Array, Index, Value) \\r
   for(Index = 0; \\r
@@ -63,28 +64,28 @@ typedef    INT64   EDKII_JSON_INT_T; // #JSON_INTEGER_IS_LONG_LONG is set to 1
 ///\r
 ///  Map to the json_error_t in jansson.h\r
 ///\r
-#define EDKII_JSON_ERROR_TEXT_LENGTH   160\r
-#define EDKII_JSON_ERROR_SOURCE_LENGTH 80\r
+#define EDKII_JSON_ERROR_TEXT_LENGTH    160\r
+#define EDKII_JSON_ERROR_SOURCE_LENGTH  80\r
 typedef struct {\r
-    INTN    Line;\r
-    INTN    Column;\r
-    INTN    Position;\r
-    CHAR8   Source [EDKII_JSON_ERROR_SOURCE_LENGTH];\r
-    CHAR8   Text [EDKII_JSON_ERROR_TEXT_LENGTH];\r
+  INTN     Line;\r
+  INTN     Column;\r
+  INTN     Position;\r
+  CHAR8    Source[EDKII_JSON_ERROR_SOURCE_LENGTH];\r
+  CHAR8    Text[EDKII_JSON_ERROR_TEXT_LENGTH];\r
 } EDKII_JSON_ERROR;\r
 \r
 ///\r
 ///  Map to the json_type in jansson.h\r
 ///\r
 typedef enum {\r
-    EdkiiJsonTypeObject,\r
-    EdkiiJsonTypeArray,\r
-    EdkiiJsonTypeString,\r
-    EdkiiJsonTypeInteger,\r
-    EdkiiJsonTypeReal,\r
-    EdkiiJsonTypeTrue,\r
-    EdkiiJsonTypeFalse,\r
-    EdkiiJsonTypeNull\r
+  EdkiiJsonTypeObject,\r
+  EdkiiJsonTypeArray,\r
+  EdkiiJsonTypeString,\r
+  EdkiiJsonTypeInteger,\r
+  EdkiiJsonTypeReal,\r
+  EdkiiJsonTypeTrue,\r
+  EdkiiJsonTypeFalse,\r
+  EdkiiJsonTypeNull\r
 } EDKII_JSON_TYPE;\r
 \r
 /**\r
@@ -147,7 +148,7 @@ JsonValueInitObject (
 EDKII_JSON_VALUE\r
 EFIAPI\r
 JsonValueInitAsciiString (\r
-  IN    CONST CHAR8    *String\r
+  IN    CONST CHAR8  *String\r
   );\r
 \r
 /**\r
@@ -170,7 +171,7 @@ JsonValueInitAsciiString (
 EDKII_JSON_VALUE\r
 EFIAPI\r
 JsonValueInitUnicodeString (\r
-  IN    CHAR16    *String\r
+  IN    CHAR16  *String\r
   );\r
 \r
 /**\r
@@ -190,7 +191,7 @@ JsonValueInitUnicodeString (
 EDKII_JSON_VALUE\r
 EFIAPI\r
 JsonValueInitInteger (\r
-  IN    INT64    Value\r
+  IN    INT64  Value\r
   );\r
 \r
 /**\r
@@ -207,7 +208,7 @@ JsonValueInitInteger (
 EDKII_JSON_VALUE\r
 EFIAPI\r
 JsonValueInitBoolean (\r
-  IN    BOOLEAN    Value\r
+  IN    BOOLEAN  Value\r
   );\r
 \r
 /**\r
@@ -278,7 +279,7 @@ JsonValueInitFalse (
 VOID\r
 EFIAPI\r
 JsonValueFree (\r
-  IN    EDKII_JSON_VALUE    Json\r
+  IN    EDKII_JSON_VALUE  Json\r
   );\r
 \r
 /**\r
@@ -301,7 +302,7 @@ JsonValueFree (
 EDKII_JSON_VALUE\r
 EFIAPI\r
 JsonValueClone (\r
-  IN    EDKII_JSON_VALUE    Json\r
+  IN    EDKII_JSON_VALUE  Json\r
   );\r
 \r
 /**\r
@@ -316,7 +317,7 @@ JsonValueClone (
 BOOLEAN\r
 EFIAPI\r
 JsonValueIsArray (\r
-  IN    EDKII_JSON_VALUE    Json\r
+  IN    EDKII_JSON_VALUE  Json\r
   );\r
 \r
 /**\r
@@ -331,7 +332,7 @@ JsonValueIsArray (
 BOOLEAN\r
 EFIAPI\r
 JsonValueIsObject (\r
-  IN    EDKII_JSON_VALUE    Json\r
+  IN    EDKII_JSON_VALUE  Json\r
   );\r
 \r
 /**\r
@@ -347,7 +348,7 @@ JsonValueIsObject (
 BOOLEAN\r
 EFIAPI\r
 JsonValueIsString (\r
-  IN    EDKII_JSON_VALUE    Json\r
+  IN    EDKII_JSON_VALUE  Json\r
   );\r
 \r
 /**\r
@@ -362,7 +363,7 @@ JsonValueIsString (
 BOOLEAN\r
 EFIAPI\r
 JsonValueIsInteger (\r
-  IN    EDKII_JSON_VALUE    Json\r
+  IN    EDKII_JSON_VALUE  Json\r
   );\r
 \r
 /**\r
@@ -377,7 +378,7 @@ JsonValueIsInteger (
 BOOLEAN\r
 EFIAPI\r
 JsonValueIsNumber (\r
-  IN    EDKII_JSON_VALUE    Json\r
+  IN    EDKII_JSON_VALUE  Json\r
   );\r
 \r
 /**\r
@@ -392,7 +393,7 @@ JsonValueIsNumber (
 BOOLEAN\r
 EFIAPI\r
 JsonValueIsBoolean (\r
-  IN    EDKII_JSON_VALUE    Json\r
+  IN    EDKII_JSON_VALUE  Json\r
   );\r
 \r
 /**\r
@@ -407,7 +408,7 @@ JsonValueIsBoolean (
 BOOLEAN\r
 EFIAPI\r
 JsonValueIsTrue (\r
-  IN    EDKII_JSON_VALUE    Json\r
+  IN    EDKII_JSON_VALUE  Json\r
   );\r
 \r
 /**\r
@@ -422,7 +423,7 @@ JsonValueIsTrue (
 BOOLEAN\r
 EFIAPI\r
 JsonValueIsFalse (\r
-  IN    EDKII_JSON_VALUE    Json\r
+  IN    EDKII_JSON_VALUE  Json\r
   );\r
 \r
 /**\r
@@ -437,7 +438,7 @@ JsonValueIsFalse (
 BOOLEAN\r
 EFIAPI\r
 JsonValueIsNull (\r
-  IN    EDKII_JSON_VALUE    Json\r
+  IN    EDKII_JSON_VALUE  Json\r
   );\r
 \r
 /**\r
@@ -453,7 +454,7 @@ JsonValueIsNull (
 EDKII_JSON_ARRAY\r
 EFIAPI\r
 JsonValueGetArray (\r
-  IN    EDKII_JSON_VALUE    Json\r
+  IN    EDKII_JSON_VALUE  Json\r
   );\r
 \r
 /**\r
@@ -469,7 +470,7 @@ JsonValueGetArray (
 EDKII_JSON_OBJECT\r
 EFIAPI\r
 JsonValueGetObject (\r
-  IN    EDKII_JSON_VALUE    Json\r
+  IN    EDKII_JSON_VALUE  Json\r
   );\r
 \r
 /**\r
@@ -485,7 +486,7 @@ JsonValueGetObject (
 CONST CHAR8 *\r
 EFIAPI\r
 JsonValueGetAsciiString (\r
-  IN    EDKII_JSON_VALUE    Json\r
+  IN    EDKII_JSON_VALUE  Json\r
   );\r
 \r
 /**\r
@@ -499,10 +500,10 @@ JsonValueGetAsciiString (
   @retval      Return the associated Unicode string in JSON value or NULL.\r
 \r
 **/\r
-CHAR16*\r
+CHAR16 *\r
 EFIAPI\r
 JsonValueGetUnicodeString (\r
-  IN    EDKII_JSON_VALUE    Json\r
+  IN    EDKII_JSON_VALUE  Json\r
   );\r
 \r
 /**\r
@@ -519,7 +520,7 @@ JsonValueGetUnicodeString (
 INT64\r
 EFIAPI\r
 JsonValueGetInteger (\r
-  IN    EDKII_JSON_VALUE    Json\r
+  IN    EDKII_JSON_VALUE  Json\r
   );\r
 \r
 /**\r
@@ -536,7 +537,7 @@ JsonValueGetInteger (
 BOOLEAN\r
 EFIAPI\r
 JsonValueGetBoolean (\r
-  IN    EDKII_JSON_VALUE    Json\r
+  IN    EDKII_JSON_VALUE  Json\r
   );\r
 \r
 /**\r
@@ -549,10 +550,10 @@ JsonValueGetBoolean (
   @retval      Return the associated Ascii string in JSON value or NULL on errors.\r
 \r
 **/\r
-CONST CHAR8*\r
+CONST CHAR8 *\r
 EFIAPI\r
 JsonValueGetString (\r
-  IN    EDKII_JSON_VALUE    Json\r
+  IN    EDKII_JSON_VALUE  Json\r
   );\r
 \r
 /**\r
@@ -567,7 +568,7 @@ JsonValueGetString (
 UINTN\r
 EFIAPI\r
 JsonObjectSize (\r
-  IN    EDKII_JSON_OBJECT    JsonObject\r
+  IN    EDKII_JSON_OBJECT  JsonObject\r
   );\r
 \r
 /**\r
@@ -583,10 +584,10 @@ JsonObjectSize (
                JsonObj is not an JSON object, key count is zero or on other errors.\r
 \r
 **/\r
-CHAR8**\r
+CHAR8 **\r
 JsonObjectGetKeys (\r
-  IN    EDKII_JSON_OBJECT    JsonObj,\r
-  OUT   UINTN                *KeyCount\r
+  IN    EDKII_JSON_OBJECT  JsonObj,\r
+  OUT   UINTN              *KeyCount\r
   );\r
 \r
 /**\r
@@ -608,8 +609,8 @@ JsonObjectGetKeys (
 EDKII_JSON_VALUE\r
 EFIAPI\r
 JsonObjectGetValue (\r
-  IN    CONST EDKII_JSON_OBJECT    JsonObj,\r
-  IN    CONST CHAR8                *Key\r
+  IN    CONST EDKII_JSON_OBJECT  JsonObj,\r
+  IN    CONST CHAR8              *Key\r
   );\r
 \r
 /**\r
@@ -633,9 +634,9 @@ JsonObjectGetValue (
 EFI_STATUS\r
 EFIAPI\r
 JsonObjectSetValue (\r
-  IN    EDKII_JSON_OBJECT    JsonObj,\r
-  IN    CONST CHAR8          *Key,\r
-  IN    EDKII_JSON_VALUE     Json\r
+  IN    EDKII_JSON_OBJECT  JsonObj,\r
+  IN    CONST CHAR8        *Key,\r
+  IN    EDKII_JSON_VALUE   Json\r
   );\r
 \r
 /**\r
@@ -650,7 +651,7 @@ JsonObjectSetValue (
 UINTN\r
 EFIAPI\r
 JsonArrayCount (\r
-  IN    EDKII_JSON_ARRAY    JsonArray\r
+  IN    EDKII_JSON_ARRAY  JsonArray\r
   );\r
 \r
 /**\r
@@ -672,8 +673,8 @@ JsonArrayCount (
 EDKII_JSON_VALUE\r
 EFIAPI\r
 JsonArrayGetValue (\r
-  IN    EDKII_JSON_ARRAY    JsonArray,\r
-  IN    UINTN               Index\r
+  IN    EDKII_JSON_ARRAY  JsonArray,\r
+  IN    UINTN             Index\r
   );\r
 \r
 /**\r
@@ -692,8 +693,8 @@ JsonArrayGetValue (
 EFI_STATUS\r
 EFIAPI\r
 JsonArrayAppendValue (\r
-  IN    EDKII_JSON_ARRAY    JsonArray,\r
-  IN    EDKII_JSON_VALUE    Json\r
+  IN    EDKII_JSON_ARRAY  JsonArray,\r
+  IN    EDKII_JSON_VALUE  Json\r
   );\r
 \r
 /**\r
@@ -713,8 +714,8 @@ JsonArrayAppendValue (
 EFI_STATUS\r
 EFIAPI\r
 JsonArrayRemoveValue (\r
-  IN    EDKII_JSON_ARRAY    JsonArray,\r
-  IN    UINTN               Index\r
+  IN    EDKII_JSON_ARRAY  JsonArray,\r
+  IN    UINTN             Index\r
   );\r
 \r
 /**\r
@@ -742,8 +743,8 @@ JsonArrayRemoveValue (
 CHAR8 *\r
 EFIAPI\r
 JsonDumpString (\r
-  IN    EDKII_JSON_VALUE    JsonValue,\r
-  IN    UINTN               Flags\r
+  IN    EDKII_JSON_VALUE  JsonValue,\r
+  IN    UINTN             Flags\r
   );\r
 \r
 /**\r
@@ -766,9 +767,9 @@ JsonDumpString (
 EDKII_JSON_VALUE\r
 EFIAPI\r
 JsonLoadString (\r
-  IN    CONST CHAR8*     String,\r
-  IN    UINT64           Flags,\r
-  IN    EDKII_JSON_ERROR *Error\r
+  IN    CONST CHAR8       *String,\r
+  IN    UINT64            Flags,\r
+  IN    EDKII_JSON_ERROR  *Error\r
   );\r
 \r
 /**\r
@@ -793,7 +794,7 @@ JsonLoadString (
 EDKII_JSON_VALUE\r
 EFIAPI\r
 JsonLoadBuffer (\r
-  IN    CONST CHAR8       *Buffer,\r
+  IN    CONST CHAR8        *Buffer,\r
   IN    UINTN              BufferLen,\r
   IN    UINTN              Flags,\r
   IN OUT EDKII_JSON_ERROR  *Error\r
@@ -815,7 +816,7 @@ JsonLoadBuffer (
 VOID\r
 EFIAPI\r
 JsonDecreaseReference (\r
-  IN EDKII_JSON_VALUE JsonValue\r
+  IN EDKII_JSON_VALUE  JsonValue\r
   );\r
 \r
 /**\r
@@ -833,8 +834,9 @@ JsonDecreaseReference (
 EDKII_JSON_VALUE\r
 EFIAPI\r
 JsonIncreaseReference (\r
-  IN EDKII_JSON_VALUE JsonValue\r
+  IN EDKII_JSON_VALUE  JsonValue\r
   );\r
+\r
 /**\r
   Returns an opaque iterator which can be used to iterate over all key-value pairs\r
   in object, or NULL if object is empty\r
@@ -844,7 +846,7 @@ JsonIncreaseReference (
 VOID *\r
 EFIAPI\r
 JsonObjectIterator (\r
-  IN EDKII_JSON_VALUE JsonValue\r
+  IN EDKII_JSON_VALUE  JsonValue\r
   );\r
 \r
 /**\r
@@ -855,7 +857,7 @@ JsonObjectIterator (
 EDKII_JSON_VALUE\r
 EFIAPI\r
 JsonObjectIteratorValue (\r
-  IN VOID *Iterator\r
+  IN VOID  *Iterator\r
   );\r
 \r
 /**\r
@@ -869,8 +871,8 @@ JsonObjectIteratorValue (
 VOID *\r
 EFIAPI\r
 JsonObjectIteratorNext (\r
-  IN EDKII_JSON_VALUE JsonValue,\r
-  IN VOID             *Iterator\r
+  IN EDKII_JSON_VALUE  JsonValue,\r
+  IN VOID              *Iterator\r
   );\r
 \r
 /**\r
@@ -882,8 +884,8 @@ JsonObjectIteratorNext (
 CHAR8 *\r
 EFIAPI\r
 JsonObjectIteratorKey (\r
-  IN VOID *Iterator\r
-);\r
+  IN VOID  *Iterator\r
+  );\r
 \r
 /**\r
   Returns the pointer of iterator by key.\r
@@ -894,8 +896,8 @@ JsonObjectIteratorKey (
 VOID *\r
 EFIAPI\r
 JsonObjectKeyToIterator (\r
-  IN CHAR8 *Key\r
-);\r
+  IN CHAR8  *Key\r
+  );\r
 \r
 /**\r
   Returns the json type of this json value\r
@@ -905,7 +907,8 @@ JsonObjectKeyToIterator (
 **/\r
 EDKII_JSON_TYPE\r
 EFIAPI\r
-JsonGetType(\r
-  IN EDKII_JSON_VALUE JsonValue\r
+JsonGetType (\r
+  IN EDKII_JSON_VALUE  JsonValue\r
   );\r
+\r
 #endif\r