fdd: Add support for pcjs json floppy images
This commit is contained in:
255
src/include/86box/fdd_pcjs.h
Normal file
255
src/include/86box/fdd_pcjs.h
Normal file
@@ -0,0 +1,255 @@
|
||||
/*
|
||||
* 86Box A hypervisor and IBM PC system emulator that specializes in
|
||||
* running old operating systems and software designed for IBM
|
||||
* PC systems and compatibles from 1981 through fairly recent
|
||||
* system designs based on the PCI bus.
|
||||
*
|
||||
* This file is part of the 86Box distribution.
|
||||
*
|
||||
* Implementation of the pcjs v2 floppy image format (read-only)
|
||||
*
|
||||
* Authors: cold-brewed
|
||||
*
|
||||
* Copyright 2024 cold-brewed
|
||||
*
|
||||
* More info: https://www.pcjs.org/tools/diskimage/
|
||||
* pcjs disk module v2: https://github.com/jeffpar/pcjs/blob/master/machines/pcx86/modules/v2/disk.js
|
||||
*/
|
||||
|
||||
#ifndef EMU_FLOPPY_PCJS_H
|
||||
#define EMU_FLOPPY_PCJS_H
|
||||
|
||||
/* Currently targeting v2 of the spec */
|
||||
#define PCJS_DISK_SPEC_VERSION 2
|
||||
|
||||
#define PCJS_MAX_TRACKS 256
|
||||
#define PCJS_MAX_SIDES 2
|
||||
#define PCJS_MAX_SECTORS 256
|
||||
|
||||
/* The json keys as defined in each sector array item */
|
||||
#define PCJS_OBJECT_KEY_CYLINDER "c"
|
||||
#define PCJS_OBJECT_KEY_TRACK PCJS_OBJECT_KEY_CYLINDER
|
||||
#define PCJS_OBJECT_KEY_HEAD "h"
|
||||
#define PCJS_OBJECT_KEY_SECTOR "s"
|
||||
#define PCJS_OBJECT_KEY_LENGTH "l"
|
||||
#define PCJS_OBJECT_KEY_DATA "d"
|
||||
#define PCJS_OBJECT_KEY_FILE "f"
|
||||
#define PCJS_OBJECT_KEY_OFFSET "d"
|
||||
|
||||
/* The json keys as defined in the fileTable object */
|
||||
#define PCJS_OBJECT_KEY_FT_HASH "hash"
|
||||
#define PCJS_OBJECT_KEY_FT_PATH "path"
|
||||
#define PCJS_OBJECT_KEY_FT_ATTR "attr"
|
||||
#define PCJS_OBJECT_KEY_FT_DATE "date"
|
||||
#define PCJS_OBJECT_KEY_FT_SIZE "size"
|
||||
|
||||
/* String length defaults */
|
||||
#define PCJS_IMAGE_INFO_STRING_LEN 128
|
||||
#define PCJS_IMAGE_INFO_ARRAY_LEN 128
|
||||
#define PCJS_FILE_TABLE_STRING_LEN 128
|
||||
|
||||
/* Defaults for optional json values */
|
||||
#define JSON_OPTIONAL_NUMBER_DEFAULT 0
|
||||
#define JSON_OPTIONAL_STRING_DEFAULT ""
|
||||
|
||||
/* Structure for each sector */
|
||||
typedef struct pcjs_sector_t {
|
||||
/* Track number */
|
||||
uint8_t track;
|
||||
/* Side number */
|
||||
uint8_t side;
|
||||
/* Sector number */
|
||||
uint8_t sector;
|
||||
/* Size of the sector */
|
||||
uint16_t size;
|
||||
/* Encoded size of the sector */
|
||||
uint16_t encoded_size;
|
||||
/* Pointer the the allocated data for the sector */
|
||||
uint8_t *data;
|
||||
/* Number of times to repeat the pattern until end of sector */
|
||||
uint16_t pattern_repeat;
|
||||
/* Last pattern entry to repeat */
|
||||
int32_t last_entry;
|
||||
/* Maps back to a file entry. -1 if not set */
|
||||
int32_t file;
|
||||
/* The offset in the mapped file entry. -1 if not set */
|
||||
int32_t offset;
|
||||
} pcjs_sector_t;
|
||||
|
||||
/* Cases are mixed here (some camelCase) to match the pcjs values */
|
||||
typedef struct pcjs_image_info_t {
|
||||
char type[PCJS_IMAGE_INFO_STRING_LEN];
|
||||
char name[PCJS_IMAGE_INFO_STRING_LEN];
|
||||
char format[PCJS_IMAGE_INFO_STRING_LEN];
|
||||
char hash[PCJS_IMAGE_INFO_STRING_LEN];
|
||||
uint32_t checksum;
|
||||
uint8_t cylinders;
|
||||
uint8_t heads;
|
||||
uint8_t trackDefault;
|
||||
uint16_t sectorDefault;
|
||||
uint32_t diskSize;
|
||||
uint8_t boot_sector[PCJS_IMAGE_INFO_ARRAY_LEN];
|
||||
uint8_t boot_sector_array_size;
|
||||
char version[PCJS_IMAGE_INFO_STRING_LEN];
|
||||
char repository[PCJS_IMAGE_INFO_STRING_LEN];
|
||||
} pcjs_image_info_t;
|
||||
|
||||
typedef struct pcjs_file_table_entry_t {
|
||||
char hash[PCJS_FILE_TABLE_STRING_LEN];
|
||||
char path[PCJS_FILE_TABLE_STRING_LEN];
|
||||
char attr[PCJS_FILE_TABLE_STRING_LEN];
|
||||
char date[PCJS_FILE_TABLE_STRING_LEN];
|
||||
uint32_t size;
|
||||
} pcjs_file_table_entry_t ;
|
||||
|
||||
typedef struct pcjs_file_table_t {
|
||||
pcjs_file_table_entry_t *entries;
|
||||
uint16_t num_entries;
|
||||
} pcjs_file_table_t;
|
||||
|
||||
typedef struct pcjs_t {
|
||||
/* FILE pointer for the json file */
|
||||
FILE *fp;
|
||||
|
||||
/* These values are read in from the metadata */
|
||||
/* Total number of tracks */
|
||||
uint8_t total_tracks;
|
||||
/* Total number of sides */
|
||||
uint8_t total_sides;
|
||||
/* Total number of sectors per track */
|
||||
uint16_t total_sectors;
|
||||
|
||||
/* These values are calculated for validation */
|
||||
/* Calculated number of tracks */
|
||||
uint8_t calc_total_tracks;
|
||||
/* Calculated number of sides */
|
||||
uint8_t calc_total_sides;
|
||||
/* Calculated number of sectors per track */
|
||||
uint16_t calc_total_sectors;
|
||||
|
||||
/* Number of sectors per track */
|
||||
uint8_t spt[PCJS_MAX_TRACKS][PCJS_MAX_SIDES];
|
||||
|
||||
/* Current track */
|
||||
uint8_t current_track;
|
||||
/* Current side */
|
||||
uint8_t current_side;
|
||||
/* Current sector */
|
||||
uint8_t current_sector[PCJS_MAX_SIDES];
|
||||
|
||||
/* Disk is in dmf format? */
|
||||
uint8_t dmf;
|
||||
uint8_t interleave;
|
||||
uint8_t gap2_len;
|
||||
uint8_t gap3_len;
|
||||
int track_width;
|
||||
|
||||
/* Flags for the entire disk */
|
||||
uint16_t disk_flags;
|
||||
/* Flags for the current track */
|
||||
uint16_t track_flags;
|
||||
|
||||
uint8_t interleave_ordered[PCJS_MAX_TRACKS][PCJS_MAX_SIDES];
|
||||
|
||||
/* The main mapping of all the sectors back to each individual pcjs_sector_t item. */
|
||||
pcjs_sector_t sectors[PCJS_MAX_TRACKS][PCJS_MAX_SIDES][PCJS_MAX_SECTORS];
|
||||
|
||||
/* Disk metadata information contained in each image */
|
||||
pcjs_image_info_t image_info;
|
||||
/* Optional file table mapping for each sector */
|
||||
pcjs_file_table_t file_table;
|
||||
} pcjs_t;
|
||||
|
||||
/* Errors */
|
||||
enum pcjs_img_error {
|
||||
E_SUCCESS = 0,
|
||||
E_MISSING_KEY = 1,
|
||||
E_UNEXPECTED_VALUE = 2,
|
||||
E_INTEGRITY,
|
||||
E_INVALID_OBJECT,
|
||||
E_ALLOC,
|
||||
E_PARSE,
|
||||
};
|
||||
|
||||
typedef enum pcjs_img_error pcjs_error_t;
|
||||
|
||||
/* Macros */
|
||||
|
||||
/* Macro for getting image info metadata: strings */
|
||||
#define IMAGE_INFO_GET_STRING(type) \
|
||||
const cJSON * type##_json = cJSON_GetObjectItemCaseSensitive(imageInfo, #type); \
|
||||
if (cJSON_IsString( type##_json) && type##_json->valuestring != NULL) { \
|
||||
strncpy(dev->image_info.type, type##_json->valuestring, sizeof(dev->image_info. type) - 1); \
|
||||
} else { \
|
||||
pcjs_log("Required string value for \"%s\" missing from imageInfo\n", #type); \
|
||||
pcjs_error = E_INVALID_OBJECT; \
|
||||
return 1; \
|
||||
}
|
||||
/* Macro for getting image info metadata: ints */
|
||||
#define IMAGE_INFO_GET_NUMBER(type) \
|
||||
const cJSON * type##_json = cJSON_GetObjectItemCaseSensitive(imageInfo, #type); \
|
||||
if (cJSON_IsNumber( type##_json)) { \
|
||||
dev->image_info.type = type##_json->valueint; \
|
||||
} else { \
|
||||
pcjs_log("Required number value for \"%s\" missing from imageInfo\n", #type); \
|
||||
pcjs_error = E_INVALID_OBJECT; \
|
||||
return 1; \
|
||||
}
|
||||
|
||||
/* Macro for getting required object value: number */
|
||||
#define JSON_GET_OBJECT_NUMBER_REQUIRED(var, json, key) \
|
||||
const cJSON *var##_json = cJSON_GetObjectItemCaseSensitive(json, key); \
|
||||
if (!cJSON_IsNumber(var##_json)) { \
|
||||
pcjs_log("Required number value for \"%s\" missing or invalid\n", key); \
|
||||
pcjs_error = E_INVALID_OBJECT; \
|
||||
goto fail; \
|
||||
} else { \
|
||||
var = var##_json->valueint; \
|
||||
}
|
||||
|
||||
/* Macro for getting optional object value: number
|
||||
* Default value will be used if the number does not exist */
|
||||
#define JSON_GET_OBJECT_NUMBER_OPTIONAL(var, json, key) \
|
||||
const cJSON *var##_json = cJSON_GetObjectItemCaseSensitive(json, key); \
|
||||
if (!cJSON_IsNumber(var##_json)) { \
|
||||
var = JSON_OPTIONAL_NUMBER_DEFAULT; \
|
||||
} else { \
|
||||
var = var##_json->valueint; \
|
||||
}
|
||||
|
||||
/* Macro for getting optional object value: number
|
||||
* Provided default value will be used if the number does not exist */
|
||||
#define JSON_GET_OBJECT_NUMBER_OPTIONAL_DEFAULT(var, json, key, default) \
|
||||
const cJSON *var##_json = cJSON_GetObjectItemCaseSensitive(json, key); \
|
||||
if (!cJSON_IsNumber(var##_json)) { \
|
||||
var = default; \
|
||||
} else { \
|
||||
var = var##_json->valueint; \
|
||||
}
|
||||
|
||||
/* Macro for getting optional object value: string
|
||||
* Default value will be used if the string does not exist */
|
||||
#define JSON_GET_OBJECT_STRING_OPTIONAL(var, json, key) \
|
||||
const cJSON * var##_json = cJSON_GetObjectItemCaseSensitive(json, key); \
|
||||
if (cJSON_IsString( var##_json) && var##_json->valuestring != NULL) { \
|
||||
strncpy(var, var##_json->valuestring, sizeof(var) - 1); \
|
||||
} else { \
|
||||
strncpy(var, JSON_OPTIONAL_STRING_DEFAULT, sizeof(var) - 1); \
|
||||
}
|
||||
|
||||
/* Macro for getting required object value: string */
|
||||
#define JSON_GET_OBJECT_STRING_REQUIRED(var, json, key) \
|
||||
const cJSON * var##_json = cJSON_GetObjectItemCaseSensitive(json, key); \
|
||||
if (cJSON_IsString( var##_json) && var##_json->valuestring != NULL) { \
|
||||
strncpy(var, var##_json->valuestring, sizeof(var) - 1); \
|
||||
} else { \
|
||||
pcjs_error = E_INVALID_OBJECT; \
|
||||
goto fail; \
|
||||
}
|
||||
|
||||
extern void pcjs_init(void);
|
||||
extern void pcjs_load(int drive, char *fn);
|
||||
extern void pcjs_close(int drive);
|
||||
extern const char* pcjs_errmsg(void);
|
||||
|
||||
#endif
|
||||
300
src/include/cJSON.h
Normal file
300
src/include/cJSON.h
Normal file
@@ -0,0 +1,300 @@
|
||||
/*
|
||||
Copyright (c) 2009-2017 Dave Gamble and cJSON contributors
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
*/
|
||||
|
||||
#ifndef cJSON__h
|
||||
#define cJSON__h
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C"
|
||||
{
|
||||
#endif
|
||||
|
||||
#if !defined(__WINDOWS__) && (defined(WIN32) || defined(WIN64) || defined(_MSC_VER) || defined(_WIN32))
|
||||
#define __WINDOWS__
|
||||
#endif
|
||||
|
||||
#ifdef __WINDOWS__
|
||||
|
||||
/* When compiling for windows, we specify a specific calling convention to avoid issues where we are being called from a project with a different default calling convention. For windows you have 3 define options:
|
||||
|
||||
CJSON_HIDE_SYMBOLS - Define this in the case where you don't want to ever dllexport symbols
|
||||
CJSON_EXPORT_SYMBOLS - Define this on library build when you want to dllexport symbols (default)
|
||||
CJSON_IMPORT_SYMBOLS - Define this if you want to dllimport symbol
|
||||
|
||||
For *nix builds that support visibility attribute, you can define similar behavior by
|
||||
|
||||
setting default visibility to hidden by adding
|
||||
-fvisibility=hidden (for gcc)
|
||||
or
|
||||
-xldscope=hidden (for sun cc)
|
||||
to CFLAGS
|
||||
|
||||
then using the CJSON_API_VISIBILITY flag to "export" the same symbols the way CJSON_EXPORT_SYMBOLS does
|
||||
|
||||
*/
|
||||
|
||||
#define CJSON_CDECL __cdecl
|
||||
#define CJSON_STDCALL __stdcall
|
||||
|
||||
/* export symbols by default, this is necessary for copy pasting the C and header file */
|
||||
#if !defined(CJSON_HIDE_SYMBOLS) && !defined(CJSON_IMPORT_SYMBOLS) && !defined(CJSON_EXPORT_SYMBOLS)
|
||||
#define CJSON_EXPORT_SYMBOLS
|
||||
#endif
|
||||
|
||||
#if defined(CJSON_HIDE_SYMBOLS)
|
||||
#define CJSON_PUBLIC(type) type CJSON_STDCALL
|
||||
#elif defined(CJSON_EXPORT_SYMBOLS)
|
||||
#define CJSON_PUBLIC(type) __declspec(dllexport) type CJSON_STDCALL
|
||||
#elif defined(CJSON_IMPORT_SYMBOLS)
|
||||
#define CJSON_PUBLIC(type) __declspec(dllimport) type CJSON_STDCALL
|
||||
#endif
|
||||
#else /* !__WINDOWS__ */
|
||||
#define CJSON_CDECL
|
||||
#define CJSON_STDCALL
|
||||
|
||||
#if (defined(__GNUC__) || defined(__SUNPRO_CC) || defined (__SUNPRO_C)) && defined(CJSON_API_VISIBILITY)
|
||||
#define CJSON_PUBLIC(type) __attribute__((visibility("default"))) type
|
||||
#else
|
||||
#define CJSON_PUBLIC(type) type
|
||||
#endif
|
||||
#endif
|
||||
|
||||
/* project version */
|
||||
#define CJSON_VERSION_MAJOR 1
|
||||
#define CJSON_VERSION_MINOR 7
|
||||
#define CJSON_VERSION_PATCH 17
|
||||
|
||||
#include <stddef.h>
|
||||
|
||||
/* cJSON Types: */
|
||||
#define cJSON_Invalid (0)
|
||||
#define cJSON_False (1 << 0)
|
||||
#define cJSON_True (1 << 1)
|
||||
#define cJSON_NULL (1 << 2)
|
||||
#define cJSON_Number (1 << 3)
|
||||
#define cJSON_String (1 << 4)
|
||||
#define cJSON_Array (1 << 5)
|
||||
#define cJSON_Object (1 << 6)
|
||||
#define cJSON_Raw (1 << 7) /* raw json */
|
||||
|
||||
#define cJSON_IsReference 256
|
||||
#define cJSON_StringIsConst 512
|
||||
|
||||
/* The cJSON structure: */
|
||||
typedef struct cJSON
|
||||
{
|
||||
/* next/prev allow you to walk array/object chains. Alternatively, use GetArraySize/GetArrayItem/GetObjectItem */
|
||||
struct cJSON *next;
|
||||
struct cJSON *prev;
|
||||
/* An array or object item will have a child pointer pointing to a chain of the items in the array/object. */
|
||||
struct cJSON *child;
|
||||
|
||||
/* The type of the item, as above. */
|
||||
int type;
|
||||
|
||||
/* The item's string, if type==cJSON_String and type == cJSON_Raw */
|
||||
char *valuestring;
|
||||
/* writing to valueint is DEPRECATED, use cJSON_SetNumberValue instead */
|
||||
int valueint;
|
||||
/* The item's number, if type==cJSON_Number */
|
||||
double valuedouble;
|
||||
|
||||
/* The item's name string, if this item is the child of, or is in the list of subitems of an object. */
|
||||
char *string;
|
||||
} cJSON;
|
||||
|
||||
typedef struct cJSON_Hooks
|
||||
{
|
||||
/* malloc/free are CDECL on Windows regardless of the default calling convention of the compiler, so ensure the hooks allow passing those functions directly. */
|
||||
void *(CJSON_CDECL *malloc_fn)(size_t sz);
|
||||
void (CJSON_CDECL *free_fn)(void *ptr);
|
||||
} cJSON_Hooks;
|
||||
|
||||
typedef int cJSON_bool;
|
||||
|
||||
/* Limits how deeply nested arrays/objects can be before cJSON rejects to parse them.
|
||||
* This is to prevent stack overflows. */
|
||||
#ifndef CJSON_NESTING_LIMIT
|
||||
#define CJSON_NESTING_LIMIT 1000
|
||||
#endif
|
||||
|
||||
/* returns the version of cJSON as a string */
|
||||
CJSON_PUBLIC(const char*) cJSON_Version(void);
|
||||
|
||||
/* Supply malloc, realloc and free functions to cJSON */
|
||||
CJSON_PUBLIC(void) cJSON_InitHooks(cJSON_Hooks* hooks);
|
||||
|
||||
/* Memory Management: the caller is always responsible to free the results from all variants of cJSON_Parse (with cJSON_Delete) and cJSON_Print (with stdlib free, cJSON_Hooks.free_fn, or cJSON_free as appropriate). The exception is cJSON_PrintPreallocated, where the caller has full responsibility of the buffer. */
|
||||
/* Supply a block of JSON, and this returns a cJSON object you can interrogate. */
|
||||
CJSON_PUBLIC(cJSON *) cJSON_Parse(const char *value);
|
||||
CJSON_PUBLIC(cJSON *) cJSON_ParseWithLength(const char *value, size_t buffer_length);
|
||||
/* ParseWithOpts allows you to require (and check) that the JSON is null terminated, and to retrieve the pointer to the final byte parsed. */
|
||||
/* If you supply a ptr in return_parse_end and parsing fails, then return_parse_end will contain a pointer to the error so will match cJSON_GetErrorPtr(). */
|
||||
CJSON_PUBLIC(cJSON *) cJSON_ParseWithOpts(const char *value, const char **return_parse_end, cJSON_bool require_null_terminated);
|
||||
CJSON_PUBLIC(cJSON *) cJSON_ParseWithLengthOpts(const char *value, size_t buffer_length, const char **return_parse_end, cJSON_bool require_null_terminated);
|
||||
|
||||
/* Render a cJSON entity to text for transfer/storage. */
|
||||
CJSON_PUBLIC(char *) cJSON_Print(const cJSON *item);
|
||||
/* Render a cJSON entity to text for transfer/storage without any formatting. */
|
||||
CJSON_PUBLIC(char *) cJSON_PrintUnformatted(const cJSON *item);
|
||||
/* Render a cJSON entity to text using a buffered strategy. prebuffer is a guess at the final size. guessing well reduces reallocation. fmt=0 gives unformatted, =1 gives formatted */
|
||||
CJSON_PUBLIC(char *) cJSON_PrintBuffered(const cJSON *item, int prebuffer, cJSON_bool fmt);
|
||||
/* Render a cJSON entity to text using a buffer already allocated in memory with given length. Returns 1 on success and 0 on failure. */
|
||||
/* NOTE: cJSON is not always 100% accurate in estimating how much memory it will use, so to be safe allocate 5 bytes more than you actually need */
|
||||
CJSON_PUBLIC(cJSON_bool) cJSON_PrintPreallocated(cJSON *item, char *buffer, const int length, const cJSON_bool format);
|
||||
/* Delete a cJSON entity and all subentities. */
|
||||
CJSON_PUBLIC(void) cJSON_Delete(cJSON *item);
|
||||
|
||||
/* Returns the number of items in an array (or object). */
|
||||
CJSON_PUBLIC(int) cJSON_GetArraySize(const cJSON *array);
|
||||
/* Retrieve item number "index" from array "array". Returns NULL if unsuccessful. */
|
||||
CJSON_PUBLIC(cJSON *) cJSON_GetArrayItem(const cJSON *array, int index);
|
||||
/* Get item "string" from object. Case insensitive. */
|
||||
CJSON_PUBLIC(cJSON *) cJSON_GetObjectItem(const cJSON * const object, const char * const string);
|
||||
CJSON_PUBLIC(cJSON *) cJSON_GetObjectItemCaseSensitive(const cJSON * const object, const char * const string);
|
||||
CJSON_PUBLIC(cJSON_bool) cJSON_HasObjectItem(const cJSON *object, const char *string);
|
||||
/* For analysing failed parses. This returns a pointer to the parse error. You'll probably need to look a few chars back to make sense of it. Defined when cJSON_Parse() returns 0. 0 when cJSON_Parse() succeeds. */
|
||||
CJSON_PUBLIC(const char *) cJSON_GetErrorPtr(void);
|
||||
|
||||
/* Check item type and return its value */
|
||||
CJSON_PUBLIC(char *) cJSON_GetStringValue(const cJSON * const item);
|
||||
CJSON_PUBLIC(double) cJSON_GetNumberValue(const cJSON * const item);
|
||||
|
||||
/* These functions check the type of an item */
|
||||
CJSON_PUBLIC(cJSON_bool) cJSON_IsInvalid(const cJSON * const item);
|
||||
CJSON_PUBLIC(cJSON_bool) cJSON_IsFalse(const cJSON * const item);
|
||||
CJSON_PUBLIC(cJSON_bool) cJSON_IsTrue(const cJSON * const item);
|
||||
CJSON_PUBLIC(cJSON_bool) cJSON_IsBool(const cJSON * const item);
|
||||
CJSON_PUBLIC(cJSON_bool) cJSON_IsNull(const cJSON * const item);
|
||||
CJSON_PUBLIC(cJSON_bool) cJSON_IsNumber(const cJSON * const item);
|
||||
CJSON_PUBLIC(cJSON_bool) cJSON_IsString(const cJSON * const item);
|
||||
CJSON_PUBLIC(cJSON_bool) cJSON_IsArray(const cJSON * const item);
|
||||
CJSON_PUBLIC(cJSON_bool) cJSON_IsObject(const cJSON * const item);
|
||||
CJSON_PUBLIC(cJSON_bool) cJSON_IsRaw(const cJSON * const item);
|
||||
|
||||
/* These calls create a cJSON item of the appropriate type. */
|
||||
CJSON_PUBLIC(cJSON *) cJSON_CreateNull(void);
|
||||
CJSON_PUBLIC(cJSON *) cJSON_CreateTrue(void);
|
||||
CJSON_PUBLIC(cJSON *) cJSON_CreateFalse(void);
|
||||
CJSON_PUBLIC(cJSON *) cJSON_CreateBool(cJSON_bool boolean);
|
||||
CJSON_PUBLIC(cJSON *) cJSON_CreateNumber(double num);
|
||||
CJSON_PUBLIC(cJSON *) cJSON_CreateString(const char *string);
|
||||
/* raw json */
|
||||
CJSON_PUBLIC(cJSON *) cJSON_CreateRaw(const char *raw);
|
||||
CJSON_PUBLIC(cJSON *) cJSON_CreateArray(void);
|
||||
CJSON_PUBLIC(cJSON *) cJSON_CreateObject(void);
|
||||
|
||||
/* Create a string where valuestring references a string so
|
||||
* it will not be freed by cJSON_Delete */
|
||||
CJSON_PUBLIC(cJSON *) cJSON_CreateStringReference(const char *string);
|
||||
/* Create an object/array that only references it's elements so
|
||||
* they will not be freed by cJSON_Delete */
|
||||
CJSON_PUBLIC(cJSON *) cJSON_CreateObjectReference(const cJSON *child);
|
||||
CJSON_PUBLIC(cJSON *) cJSON_CreateArrayReference(const cJSON *child);
|
||||
|
||||
/* These utilities create an Array of count items.
|
||||
* The parameter count cannot be greater than the number of elements in the number array, otherwise array access will be out of bounds.*/
|
||||
CJSON_PUBLIC(cJSON *) cJSON_CreateIntArray(const int *numbers, int count);
|
||||
CJSON_PUBLIC(cJSON *) cJSON_CreateFloatArray(const float *numbers, int count);
|
||||
CJSON_PUBLIC(cJSON *) cJSON_CreateDoubleArray(const double *numbers, int count);
|
||||
CJSON_PUBLIC(cJSON *) cJSON_CreateStringArray(const char *const *strings, int count);
|
||||
|
||||
/* Append item to the specified array/object. */
|
||||
CJSON_PUBLIC(cJSON_bool) cJSON_AddItemToArray(cJSON *array, cJSON *item);
|
||||
CJSON_PUBLIC(cJSON_bool) cJSON_AddItemToObject(cJSON *object, const char *string, cJSON *item);
|
||||
/* Use this when string is definitely const (i.e. a literal, or as good as), and will definitely survive the cJSON object.
|
||||
* WARNING: When this function was used, make sure to always check that (item->type & cJSON_StringIsConst) is zero before
|
||||
* writing to `item->string` */
|
||||
CJSON_PUBLIC(cJSON_bool) cJSON_AddItemToObjectCS(cJSON *object, const char *string, cJSON *item);
|
||||
/* Append reference to item to the specified array/object. Use this when you want to add an existing cJSON to a new cJSON, but don't want to corrupt your existing cJSON. */
|
||||
CJSON_PUBLIC(cJSON_bool) cJSON_AddItemReferenceToArray(cJSON *array, cJSON *item);
|
||||
CJSON_PUBLIC(cJSON_bool) cJSON_AddItemReferenceToObject(cJSON *object, const char *string, cJSON *item);
|
||||
|
||||
/* Remove/Detach items from Arrays/Objects. */
|
||||
CJSON_PUBLIC(cJSON *) cJSON_DetachItemViaPointer(cJSON *parent, cJSON * const item);
|
||||
CJSON_PUBLIC(cJSON *) cJSON_DetachItemFromArray(cJSON *array, int which);
|
||||
CJSON_PUBLIC(void) cJSON_DeleteItemFromArray(cJSON *array, int which);
|
||||
CJSON_PUBLIC(cJSON *) cJSON_DetachItemFromObject(cJSON *object, const char *string);
|
||||
CJSON_PUBLIC(cJSON *) cJSON_DetachItemFromObjectCaseSensitive(cJSON *object, const char *string);
|
||||
CJSON_PUBLIC(void) cJSON_DeleteItemFromObject(cJSON *object, const char *string);
|
||||
CJSON_PUBLIC(void) cJSON_DeleteItemFromObjectCaseSensitive(cJSON *object, const char *string);
|
||||
|
||||
/* Update array items. */
|
||||
CJSON_PUBLIC(cJSON_bool) cJSON_InsertItemInArray(cJSON *array, int which, cJSON *newitem); /* Shifts pre-existing items to the right. */
|
||||
CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemViaPointer(cJSON * const parent, cJSON * const item, cJSON * replacement);
|
||||
CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemInArray(cJSON *array, int which, cJSON *newitem);
|
||||
CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemInObject(cJSON *object,const char *string,cJSON *newitem);
|
||||
CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemInObjectCaseSensitive(cJSON *object,const char *string,cJSON *newitem);
|
||||
|
||||
/* Duplicate a cJSON item */
|
||||
CJSON_PUBLIC(cJSON *) cJSON_Duplicate(const cJSON *item, cJSON_bool recurse);
|
||||
/* Duplicate will create a new, identical cJSON item to the one you pass, in new memory that will
|
||||
* need to be released. With recurse!=0, it will duplicate any children connected to the item.
|
||||
* The item->next and ->prev pointers are always zero on return from Duplicate. */
|
||||
/* Recursively compare two cJSON items for equality. If either a or b is NULL or invalid, they will be considered unequal.
|
||||
* case_sensitive determines if object keys are treated case sensitive (1) or case insensitive (0) */
|
||||
CJSON_PUBLIC(cJSON_bool) cJSON_Compare(const cJSON * const a, const cJSON * const b, const cJSON_bool case_sensitive);
|
||||
|
||||
/* Minify a strings, remove blank characters(such as ' ', '\t', '\r', '\n') from strings.
|
||||
* The input pointer json cannot point to a read-only address area, such as a string constant,
|
||||
* but should point to a readable and writable address area. */
|
||||
CJSON_PUBLIC(void) cJSON_Minify(char *json);
|
||||
|
||||
/* Helper functions for creating and adding items to an object at the same time.
|
||||
* They return the added item or NULL on failure. */
|
||||
CJSON_PUBLIC(cJSON*) cJSON_AddNullToObject(cJSON * const object, const char * const name);
|
||||
CJSON_PUBLIC(cJSON*) cJSON_AddTrueToObject(cJSON * const object, const char * const name);
|
||||
CJSON_PUBLIC(cJSON*) cJSON_AddFalseToObject(cJSON * const object, const char * const name);
|
||||
CJSON_PUBLIC(cJSON*) cJSON_AddBoolToObject(cJSON * const object, const char * const name, const cJSON_bool boolean);
|
||||
CJSON_PUBLIC(cJSON*) cJSON_AddNumberToObject(cJSON * const object, const char * const name, const double number);
|
||||
CJSON_PUBLIC(cJSON*) cJSON_AddStringToObject(cJSON * const object, const char * const name, const char * const string);
|
||||
CJSON_PUBLIC(cJSON*) cJSON_AddRawToObject(cJSON * const object, const char * const name, const char * const raw);
|
||||
CJSON_PUBLIC(cJSON*) cJSON_AddObjectToObject(cJSON * const object, const char * const name);
|
||||
CJSON_PUBLIC(cJSON*) cJSON_AddArrayToObject(cJSON * const object, const char * const name);
|
||||
|
||||
/* When assigning an integer value, it needs to be propagated to valuedouble too. */
|
||||
#define cJSON_SetIntValue(object, number) ((object) ? (object)->valueint = (object)->valuedouble = (number) : (number))
|
||||
/* helper for the cJSON_SetNumberValue macro */
|
||||
CJSON_PUBLIC(double) cJSON_SetNumberHelper(cJSON *object, double number);
|
||||
#define cJSON_SetNumberValue(object, number) ((object != NULL) ? cJSON_SetNumberHelper(object, (double)number) : (number))
|
||||
/* Change the valuestring of a cJSON_String object, only takes effect when type of object is cJSON_String */
|
||||
CJSON_PUBLIC(char*) cJSON_SetValuestring(cJSON *object, const char *valuestring);
|
||||
|
||||
/* If the object is not a boolean type this does nothing and returns cJSON_Invalid else it returns the new type*/
|
||||
#define cJSON_SetBoolValue(object, boolValue) ( \
|
||||
(object != NULL && ((object)->type & (cJSON_False|cJSON_True))) ? \
|
||||
(object)->type=((object)->type &(~(cJSON_False|cJSON_True)))|((boolValue)?cJSON_True:cJSON_False) : \
|
||||
cJSON_Invalid\
|
||||
)
|
||||
|
||||
/* Macro for iterating over an array or object */
|
||||
#define cJSON_ArrayForEach(element, array) for(element = (array != NULL) ? (array)->child : NULL; element != NULL; element = element->next)
|
||||
|
||||
/* malloc/free objects using the malloc/free functions that have been set with cJSON_InitHooks */
|
||||
CJSON_PUBLIC(void *) cJSON_malloc(size_t size);
|
||||
CJSON_PUBLIC(void) cJSON_free(void *object);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif
|
||||
Reference in New Issue
Block a user