80486DX2-66/86Box-fork
1
0
Fork 0
Code Issues Pull Requests Activity

fdd: Add support for pcjs json floppy images

Browse Source
This commit is contained in:
cold-brewed
2024-05-20 11:07:55 -04:00
parent d07f018e6b
commit 117f604bf6
7 changed files with 4484 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/CMakeLists.txt
View File

@@ -21,7 +21,7 @@ endif()
add_executable(86Box 86box.c config.c log.c random.c timer.c io.c acpi.c apm.c
dma.c ddma.c nmi.c pic.c pit.c pit_fast.c port_6x.c port_92.c ppi.c pci.c
mca.c usb.c fifo.c fifo8.c device.c nvr.c nvr_at.c nvr_ps2.c
machine_status.c ini.c)
machine_status.c ini.c cJSON.c)
if(CMAKE_SYSTEM_NAME MATCHES "Linux")
add_compile_definitions(_FILE_OFFSET_BITS=64 _LARGEFILE_SOURCE=1 _LARGEFILE64_SOURCE=1)

3129
src/cJSON.c Normal file
View File

File diff suppressed because it is too large Load Diff

2
src/floppy/CMakeLists.txt
View File

@@ -14,5 +14,5 @@
#
add_library(fdd OBJECT fdd.c fdc.c fdc_magitronic.c fdc_monster.c fdc_pii15xb.c
fdi2raw.c fdd_common.c fdd_86f.c fdd_fdi.c fdd_imd.c fdd_img.c fdd_json.c
fdi2raw.c fdd_common.c fdd_86f.c fdd_fdi.c fdd_imd.c fdd_img.c fdd_pcjs.c
fdd_mfm.c fdd_td0.c)

6
src/floppy/fdd.c
View File

@@ -34,7 +34,7 @@
#include <86box/fdd_fdi.h>
#include <86box/fdd_imd.h>
#include <86box/fdd_img.h>
#include <86box/fdd_json.h>
#include <86box/fdd_pcjs.h>
#include <86box/fdd_mfm.h>
#include <86box/fdd_td0.h>
#include <86box/fdc.h>
@@ -131,7 +131,7 @@ static const struct
{ "IMA", img_load, img_close, -1},
{ "IMD", imd_load, imd_close, -1},
{ "IMG", img_load, img_close, -1},
{ "JSON", json_load, json_close, -1},
{ "JSON", pcjs_load, pcjs_close, -1},
{ "MFM", mfm_load, mfm_close, -1},
{ "TD0", td0_load, td0_close, -1},
{ "VFD", img_load, img_close, -1},
@@ -674,7 +674,7 @@ fdd_init(void)
d86f_init();
td0_init();
imd_init();
json_init();
pcjs_init();
for (i = 0; i < FDD_NUM; i++) {
fdd_load(i, floppyfns[i]);

795
src/floppy/fdd_pcjs.c Normal file
View File

@@ -0,0 +1,795 @@
/*
* 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
*/
#include <stdarg.h>
#include <stdint.h>
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <wchar.h>
#include <unistd.h>
#define HAVE_STDARG_H
#include <86box/86box.h>
#include <86box/timer.h>
#include <86box/plat.h>
#include <86box/fdd.h>
#include <86box/fdd_86f.h>
#include <86box/fdd_common.h>
#include <86box/fdd_pcjs.h>
#include <cJSON.h>
static pcjs_t *images[FDD_NUM];
static pcjs_error_t pcjs_error = E_SUCCESS;
struct pcjs_error_description {
int code;
const char *message;
} pcjs_error_description[] = {
{ E_SUCCESS, "No error" },
{ E_MISSING_KEY, "The requested key was missing" },
{ E_UNEXPECTED_VALUE, "The value was not of the expected type" },
{ E_INTEGRITY, "Integrity check failed" },
{ E_INVALID_OBJECT, "Object is missing or invalid" },
{ E_ALLOC, "Memory allocation failure" },
{ E_PARSE, "Parsing failure" },
{ -1, "Unknown error" },
};
#ifdef ENABLE_PCJS_LOG
int pcjs_do_log = ENABLE_PCJS_LOG;
static void
pcjs_log(const char *fmt, ...)
{
if (pcjs_do_log) {
va_list ap;
va_start(ap, fmt);
pclog_ex(fmt, ap);
va_end(ap);
}
}
#else
# define pcjs_log(fmt, ...)
#endif
void
pcjs_init(void)
{
memset(images, 0x00, sizeof(images));
}
const char* pcjs_errmsg(void)
{
int i = 0;
while (pcjs_error_description[i].code >= 0) {
if (pcjs_error_description[i].code == pcjs_error) {
return pcjs_error_description[i].message;
}
i++;
}
return "Unknown error";
}
int parse_image_info(pcjs_t *dev, const cJSON *parsed_json)
{
const cJSON *imageInfo = NULL;
if(dev == NULL || parsed_json == NULL) {
pcjs_log("Null values passed\n");
pcjs_error = E_INTEGRITY;
return 1;
}
imageInfo = cJSON_GetObjectItemCaseSensitive(parsed_json, "imageInfo");
if (imageInfo == NULL || !cJSON_IsObject(imageInfo)) {
pcjs_log("imageInfo object does not exist or is invalid\n");
pcjs_error = E_INVALID_OBJECT;
return 1;
}
/* Macros are used here to avoid repetition */
/* First get strings */
IMAGE_INFO_GET_STRING(type)
IMAGE_INFO_GET_STRING(name)
IMAGE_INFO_GET_STRING(format)
IMAGE_INFO_GET_STRING(hash)
IMAGE_INFO_GET_STRING(version)
IMAGE_INFO_GET_STRING(repository)
/* Then the numbers */
IMAGE_INFO_GET_NUMBER(cylinders)
IMAGE_INFO_GET_NUMBER(heads)
IMAGE_INFO_GET_NUMBER(trackDefault)
IMAGE_INFO_GET_NUMBER(sectorDefault)
IMAGE_INFO_GET_NUMBER(diskSize)
/* Special cases */
/* Convert bootSector to array if it exists */
/* For some reason the array itself is stored as a string
* which needs to be converted into an array before parsing. */
dev->image_info.boot_sector_array_size = 0;
const cJSON *array_string = cJSON_GetObjectItemCaseSensitive(imageInfo, "bootSector");
cJSON *bootSector = NULL;
if(cJSON_IsString(array_string) && array_string != NULL) {
bootSector = cJSON_Parse(array_string->valuestring);
}
if(cJSON_IsArray(bootSector)) {
const int array_size = cJSON_GetArraySize(bootSector);
dev->image_info.boot_sector_array_size = array_size;
const cJSON *array_item = NULL;
int array_index = 0;
cJSON_ArrayForEach(array_item, bootSector)
{
/* Make sure each item is a number */
if(!cJSON_IsNumber(array_item)) {
pcjs_log("Non-number item in bootSector array\n");
dev->image_info.boot_sector_array_size = 0;
/* Prevent the loop from continuing */
array_item = NULL;
break;
}
/* Make sure each number is in range */
const int value = array_item->valueint;
if (value < 0 || value > 255) {
pcjs_log("bootSector value %i out of range (0-255)\n", value);
dev->image_info.boot_sector_array_size = 0;
/* Prevent the loop from continuing */
array_item = NULL;
break;
}
/* Make sure we don't exceed the array length */
if (array_index + 1 > PCJS_IMAGE_INFO_ARRAY_LEN) {
pcjs_log("bootSector array length exceeded (max %i)\n", PCJS_IMAGE_INFO_ARRAY_LEN);
dev->image_info.boot_sector_array_size = 0;
/* Prevent the loop from continuing */
array_item = NULL;
break;
}
dev->image_info.boot_sector[array_index] = value;
array_index++;
}
}
/* checksum: Can't use the number macro like the others because it uses valueInt
* which is 32-bit signed and we need unsigned. Use the double value (valuedouble) instead. */
const cJSON *checksum_json = cJSON_GetObjectItemCaseSensitive(imageInfo, "checksum");
if (cJSON_IsNumber(checksum_json)) {
dev->image_info.checksum = checksum_json->valuedouble;
} else {
pcjs_log("Required number value for \"%s\" missing from imageInfo\n", "checksum");
pcjs_error = E_MISSING_KEY;
cJSON_Delete(bootSector);
return 1;
}
/* Use the metadata as the official source */
dev->total_tracks = dev->image_info.cylinders;
dev->total_sides = dev->image_info.heads;
dev->total_sectors = dev->image_info.trackDefault;
cJSON_Delete(bootSector);
return 0;
}
int parse_file_table(pcjs_t *dev, const cJSON *parsed_json)
{
const cJSON *fileTable = NULL;
if(dev == NULL || parsed_json == NULL) {
pcjs_log("Null values passed\n");
pcjs_error = E_INTEGRITY;
return 1;
}
fileTable = cJSON_GetObjectItemCaseSensitive(parsed_json, "fileTable");
if (fileTable == NULL || !cJSON_IsArray(fileTable)) {
pcjs_log("fileTable object does not exist or is invalid\n");
pcjs_error = E_INVALID_OBJECT;
return 1;
}
const cJSON *each_file_table = NULL;
dev->file_table.num_entries = cJSON_GetArraySize(fileTable);
uint16_t processed_entries = 0;
uint16_t current_entry = 0;
if (dev->file_table.num_entries == 0) {
pcjs_log("No fileTable entries to process\n");
return 0;
}
pcjs_log("Processing %i file table entries\n", dev->file_table.num_entries);
/* Allocate the entries */
dev->file_table.entries = (pcjs_file_table_entry_t *)calloc(dev->file_table.num_entries, sizeof(pcjs_file_table_entry_t));
if (dev->file_table.entries == NULL ) {
pcjs_log("Failed to allocate file table entries\n");
pcjs_error = E_ALLOC;
return 1;
}
cJSON_ArrayForEach(each_file_table, fileTable)
{
/* The -1 length of the temporary buffer brought to you by gcc's -Wstringop-truncation */
char hash[PCJS_FILE_TABLE_STRING_LEN-1] = {0};
char path[PCJS_FILE_TABLE_STRING_LEN-1] = {0};
char attr[PCJS_FILE_TABLE_STRING_LEN-1] = {0};
char date[PCJS_FILE_TABLE_STRING_LEN-1] = {0};
uint16_t f_size = 0;
JSON_GET_OBJECT_STRING_OPTIONAL(hash, each_file_table, PCJS_OBJECT_KEY_FT_HASH)
JSON_GET_OBJECT_STRING_OPTIONAL(path, each_file_table, PCJS_OBJECT_KEY_FT_PATH)
JSON_GET_OBJECT_STRING_REQUIRED(attr, each_file_table, PCJS_OBJECT_KEY_FT_ATTR)
JSON_GET_OBJECT_STRING_REQUIRED(date, each_file_table, PCJS_OBJECT_KEY_FT_DATE)
JSON_GET_OBJECT_NUMBER_OPTIONAL(f_size, each_file_table, PCJS_OBJECT_KEY_FT_SIZE)
strncpy(dev->file_table.entries[current_entry].hash, hash, sizeof(dev->file_table.entries[current_entry].hash) - 1);
strncpy(dev->file_table.entries[current_entry].path, path, sizeof(dev->file_table.entries[current_entry].path) - 1);
strncpy(dev->file_table.entries[current_entry].attr, attr, sizeof(dev->file_table.entries[current_entry].attr) - 1);
strncpy(dev->file_table.entries[current_entry].date, date, sizeof(dev->file_table.entries[current_entry].date) - 1);
dev->file_table.entries[current_entry].size = f_size;
processed_entries++;
current_entry++;
}
if(processed_entries != dev->file_table.num_entries) {
pcjs_log("fileTable entries processed (%i) inconsistent with number of entries in the table (%i)\n", processed_entries, dev->file_table.num_entries);
pcjs_error = E_INTEGRITY;
goto fail;
}
return 0;
fail:
/* Deallocate the array */
free(dev->file_table.entries);
return 1;
}
int json_parse(pcjs_t *dev)
{
const cJSON *diskData = NULL;
/* Determine the size of the file, reset back */
fseek(dev->fp, 0L, SEEK_END);
const long numbytes = ftell(dev->fp);
fseek(dev->fp, 0L, SEEK_SET);
/* Allocate memory for the contents */
char *buffer = calloc(numbytes + 1, sizeof(char));
if(buffer == NULL) {
pcjs_error = E_ALLOC;
return 1;
}
/* Read and null terminate */
fread(buffer, sizeof(char), numbytes, dev->fp);
buffer[numbytes] = '\0';
cJSON *parsed_json = cJSON_Parse(buffer);
if (parsed_json == NULL)
{
const char *error_ptr = cJSON_GetErrorPtr();
if (error_ptr != NULL) {
fprintf(stderr, "Error parsing json before: %s\n", error_ptr);
}
pcjs_error = E_PARSE;
goto fail;
}
if(parse_image_info(dev, parsed_json)) {
pcjs_log("Failed to parse imageInfo metadata\n");
goto fail;
}
/* File table metadata is optional */
if(parse_file_table(dev, parsed_json)) {
pcjs_log("File table metadata is not present or invalid\n");
}
diskData = cJSON_GetObjectItemCaseSensitive(parsed_json, "diskData");
const cJSON *each_track = NULL;
int total_c = 0;
int full_count = 0;
/* The diskData array is essentially [c][h][s] */
/* Start with the tracks in [c] */
cJSON_ArrayForEach(each_track, diskData)
{
int total_heads = 0;
const cJSON *each_head = NULL;
/* For each track, loop on each head */
/* Now in [c][h] */
cJSON_ArrayForEach(each_head, each_track)
{
int total_sectors = 0;
const cJSON *each_sector = NULL;
/* Now loop on the sectors in [c][h][s] */
/* Each sector item will have the information needed to fill in a pcjs_sector_t */
cJSON_ArrayForEach(each_sector, each_head)
{
const cJSON *data = NULL;
const cJSON *each_data = NULL;
int data_array_size = 0;
int total_d = 0;
int32_t current_track = 0;
int32_t current_head = 0;
int32_t current_sector = 0;
int32_t current_length = 0;
int32_t file_mapping = 0;
int32_t offset = 0;
pcjs_sector_t *sector = NULL;
/* Macros to keep things tidy */
JSON_GET_OBJECT_NUMBER_REQUIRED(current_track, each_sector, PCJS_OBJECT_KEY_TRACK)
JSON_GET_OBJECT_NUMBER_REQUIRED(current_head, each_sector, PCJS_OBJECT_KEY_HEAD)
JSON_GET_OBJECT_NUMBER_REQUIRED(current_sector, each_sector, PCJS_OBJECT_KEY_SECTOR)
JSON_GET_OBJECT_NUMBER_REQUIRED(current_length, each_sector, PCJS_OBJECT_KEY_LENGTH)
JSON_GET_OBJECT_NUMBER_OPTIONAL_DEFAULT(offset, each_sector, PCJS_OBJECT_KEY_OFFSET, -1)
JSON_GET_OBJECT_NUMBER_OPTIONAL_DEFAULT(file_mapping, each_sector, PCJS_OBJECT_KEY_FILE, -1)
/* NOTE: The sectors array is zero indexed, but the metadata for each sector shows its conventional sector number */
sector = &dev->sectors[current_track][current_head][current_sector-1];
if (sector->data == NULL ) {
/* We could verify the sector size against the metadata here */
sector->data = (uint8 *)calloc(1, current_length);
if (sector->data == NULL ) {
pcjs_log("Failed to allocate\n");
pcjs_error = E_ALLOC;
goto fail;
}
}
sector->track = current_track;
sector->side = current_head;
sector->sector = current_sector;
sector->size = current_length;
sector->encoded_size = fdd_sector_size_code(current_length);
sector->offset = offset;
sector->file = file_mapping;
sector->pattern_repeat = 0;
sector->last_entry = 0;
data = cJSON_GetObjectItemCaseSensitive(each_sector, PCJS_OBJECT_KEY_DATA);
if(data != NULL && cJSON_IsArray(data)) {
data_array_size = cJSON_GetArraySize(data);
cJSON_ArrayForEach(each_data, data)
{
/* total_d is our current position in the data array */
/* That number will be used to determine where to store the
* value in its destination (sector->data).
* Each value in the data array is a 32-bit integer, but the
* destination (sector->data) is a uint8_t array. Therefore
* we'll need to manually calculate offsets and place the bytes.
*/
const int dest_offset = total_d * 4;
if(total_d == data_array_size - 1) {
/* This is the last value in the data array. Check to see if we'll need it
* for the repeating pattern.
* We use current_length / 4 because each data element is 32 bits in size.
* For example, if current_length = 512
* then 512 / 4 = 128
* so anything less than that value will have padding */
if (total_d + 1 < current_length / 4) {
sector->last_entry = each_data->valueint;
/* total_d + 1 because it is zero indexed at this point */
sector->pattern_repeat = current_length / 4 - (total_d + 1);
}
}
const int value = each_data->valueint;
/* Take each value and shift in as necessary */
for (int i = 0; i < 4; i++) {
sector->data[dest_offset + i] = (value >> i * 8) & 0xff;
}
total_d++;
}
} else {
pcjs_log("Data array missing from [%d][%d][%d]", current_track, current_head, current_sector);
pcjs_error = E_MISSING_KEY;
goto fail;
}
/* Fill in the repeating pattern if needed */
/* total_d was already advanced at the end of the previous loop */
for (int i = 0; i < sector->pattern_repeat; i++ ) {
const int position = total_d + i;
const int dest_offset = position * 4;
if(position >= (sector->size / 4)) {
/* Something is wrong */
pcjs_log("Out of bounds write attempt to data array at %i", position);
pcjs_error = E_INTEGRITY;
goto fail;
}
for (int j = 0; j < 4; j++) {
sector->data[dest_offset + j] = (sector->last_entry >> j * 8) & 0xff;
}
}
total_sectors++;
full_count++;
dev->calc_total_sectors = total_sectors;
/* End sectors */
}
dev->spt[total_c][total_heads] = total_sectors;
total_heads++;
dev->calc_total_sides = total_heads;
/* End heads */
}
total_c++;
dev->calc_total_tracks = total_c;
/* End tracks */
}
pcjs_log("calculated totals: c/h/s %i/%i/%i\n", dev->calc_total_tracks, dev->calc_total_sides, dev->calc_total_sectors);
pcjs_log("metadata totals: c/h/s %i/%i/%i\n", dev->image_info.cylinders, dev->image_info.heads, dev->image_info.trackDefault);
free(buffer);
cJSON_Delete(parsed_json);
return 0;
fail:
free(buffer);
cJSON_Delete(parsed_json);
return pcjs_error;
}
/* Handlers */
static uint16_t
disk_flags(int drive)
{
const pcjs_t *dev = images[drive];
return dev->disk_flags;
}
static uint16_t
track_flags(int drive)
{
const pcjs_t *dev = images[drive];
return dev->track_flags;
}
static void
set_sector(int drive, int side, uint8_t c, uint8_t h, uint8_t r, uint8_t n)
{
pcjs_t *dev = images[drive];
dev->current_sector[side] = 0;
/* Make sure we are on the desired track. */
if (c != dev->current_track)
return;
/* Set the desired side. */
dev->current_side = side;
/* Sectors are stored zero indexed, but sector zero should not be requested */
if(r == 0) {
pcjs_log("set_sector: Sector 0 requested?\n");
} else {
dev->current_sector[side] = r - 1;
}
/* The ifdef is necessary because if ENABLE_PCJS_LOG is not defined gcc throws an unused variable warning */
#ifdef ENABLE_PCJS_LOG
const int file_index = dev->sectors[dev->current_track][side][dev->current_sector[side]].file;
pcjs_log("set sector: %i/%i/%i %s%s%s\n", c, h, r,
file_index == -1 ? "" : "(",
file_index == -1 ? "" : dev->file_table.entries[file_index].path,
file_index == -1 ? "" : ")");
#endif
}
static uint8_t
poll_read_data(int drive, int side, uint16_t pos)
{
const pcjs_t *dev = images[drive];
const uint8_t sec = dev->current_sector[side];
return (dev->sectors[dev->current_track][side][sec].data[pos]);
}
static void
pcjs_seek(int drive, int track)
{
uint8_t id[4] = { 0, 0, 0, 0 };
pcjs_t *dev = images[drive];
int rate;
int gap2;
int gap3;
int pos;
int ssize;
int rsec;
int asec;
if (dev->fp == NULL) {
pcjs_log("pcjs_seek: no file loaded\n");
return;
}
/* Allow for doublestepping tracks. */
if (!dev->track_width && fdd_doublestep_40(drive))
track /= 2;
/* Set the new track. */
dev->current_track = track;
d86f_set_cur_track(drive, track);
/* Reset the 86F state machine. */
d86f_reset_index_hole_pos(drive, 0);
d86f_destroy_linked_lists(drive, 0);
d86f_reset_index_hole_pos(drive, 1);
d86f_destroy_linked_lists(drive, 1);
if (track > dev->total_tracks) {
d86f_zero_track(drive);
return;
}
pcjs_log("seeking to track %i\n", track);
for (uint8_t side = 0; side < dev->total_sides; side++) {
/* Get transfer rate for this side. */
rate = dev->track_flags & 0x07;
if (!rate && (dev->track_flags & 0x20))
rate = 4;
/* Get correct GAP3 value for this side. */
gap3 = fdd_get_gap3_size(rate,
// dev->sectors[track][side][0].size,
dev->sectors[track][side][0].encoded_size,
dev->spt[track][side]);
/* Get correct GAP2 value for this side. */
gap2 = ((dev->track_flags & 0x07) >= 3) ? 41 : 22;
pos = d86f_prepare_pretrack(drive, side, 0);
for (uint8_t sector = 0; sector < dev->spt[track][side]; sector++) {
rsec = dev->sectors[track][side][sector].sector;
asec = sector;
id[0] = track;
id[1] = side;
id[2] = rsec;
if (dev->sectors[track][side][asec].encoded_size > 255)
perror("PCJS: pcjs_seek: sector size too big.");
id[3] = dev->sectors[track][side][asec].encoded_size & 0xff;
ssize = fdd_sector_code_size(dev->sectors[track][side][asec].encoded_size & 0xff);
pos = d86f_prepare_sector(
drive, side, pos, id,
dev->sectors[track][side][asec].data,
ssize, gap2, gap3,
0
);
if (sector == 0)
d86f_initialize_last_sector_id(drive, id[0], id[1], id[2], id[3]);
}
}
}
static int
pcjs_load_image(pcjs_t *dev)
{
if (dev->fp == NULL) {
pcjs_log("No file loaded!\n");
return 1;
}
/* Initialize. */
for (uint16_t i = 0; i < PCJS_MAX_TRACKS; i++) {
for (uint8_t j = 0; j < PCJS_MAX_SIDES; j++)
memset(dev->sectors[i][j], 0x00, sizeof(pcjs_sector_t));
}
dev->current_track = 0;
dev->current_side = 0;
return json_parse(dev);
}
void
pcjs_load(int drive, char *fn)
{
double bit_rate = 0;
int temp_rate;
const pcjs_sector_t *sector;
pcjs_t *dev;
d86f_unregister(drive);
/* Allocate a drive block */
dev = (pcjs_t *) malloc(sizeof(pcjs_t));
memset(dev, 0x00, sizeof(pcjs_t));
/* Open the image file, read-only */
dev->fp = plat_fopen(fn, "rb");
if (dev->fp == NULL) {
free(dev);
memset(fn, 0x00, sizeof(char));
return;
}
pcjs_log("Opening filename: %s\n", fn);
/* Always set the drive to write-protected mode */
writeprot[drive] = 1;
/* Place in the correct slot */
images[drive] = dev;
/* Parse and load the information from the json file */
if (pcjs_load_image(dev)) {
pcjs_log("Failed to initialize: %s\n", pcjs_errmsg());
(void) fclose(dev->fp);
free(dev);
images[drive] = NULL;
memset(fn, 0x00, sizeof(char));
return;
}
pcjs_log("Drive %d: %s (%i tracks, %i sides, %i sectors, sector size %i)\n",
drive, fn, dev->image_info.cylinders, dev->image_info.heads, dev->image_info.trackDefault, dev->image_info.sectorDefault);
/*
* If the image has more than 43 tracks, then
* the tracks are thin (96 tpi).
*/
dev->track_width = (dev->total_tracks > 43) ? 1 : 0;
/* If the image has 2 sides, mark it as such. */
dev->disk_flags = 0x00;
if (dev->total_sides == 2)
dev->disk_flags |= 0x08;
/* PCJS files are always assumed to be MFM-encoded. */
dev->track_flags = 0x08;
dev->interleave = 0;
temp_rate = 0xff;
sector = &dev->sectors[0][0][0];
for (uint8_t i = 0; i < 6; i++) {
if (dev->spt[0][0] > fdd_max_sectors[sector->encoded_size][i])
continue;
bit_rate = fdd_bit_rates_300[i];
temp_rate = fdd_rates[i];
dev->disk_flags |= (fdd_holes[i] << 1);
if ((bit_rate == 500.0) && (dev->spt[0][0] == 21) && (sector->encoded_size == 2) && (dev->total_tracks >= 80) && (dev->total_tracks <= 82) && (dev->total_sides == 2)) {
/*
* This is a DMF floppy, set the flag so
* we know to interleave the sectors.
*/
dev->dmf = 1;
} else {
if ((bit_rate == 500.0) && (dev->spt[0][0] == 22) && (sector->encoded_size == 2) && (dev->total_tracks >= 80) && (dev->total_tracks <= 82) && (dev->total_sides == 2)) {
/*
* This is marked specially because of the
* track flag (a RPM slow down is needed).
*/
dev->interleave = 2;
}
dev->dmf = 0;
}
break;
}
if (temp_rate == 0xff) {
pcjs_log("Invalid image (temp_rate=0xff)\n");
(void) fclose(dev->fp);
dev->fp = NULL;
free(dev);
images[drive] = NULL;
memset(fn, 0x00, sizeof(char));
return;
}
if (dev->interleave == 2) {
dev->interleave = 1;
dev->disk_flags |= 0x60;
}
dev->gap2_len = (temp_rate == 3) ? 41 : 22;
if (dev->dmf)
dev->gap3_len = 8;
else
dev->gap3_len = fdd_get_gap3_size(temp_rate, sector->encoded_size, dev->spt[0][0]);
if (!dev->gap3_len) {
pcjs_log("Image of unknown format was inserted into drive %c:\n",
'C' + drive);
(void) fclose(dev->fp);
dev->fp = NULL;
free(dev);
images[drive] = NULL;
memset(fn, 0x00, sizeof(char));
return;
}
dev->track_flags |= (temp_rate & 0x03); /* data rate */
if (temp_rate & 0x04)
dev->track_flags |= 0x20; /* RPM */
pcjs_log(" disk_flags: 0x%02x, track_flags: 0x%02x, GAP3 length: %i\n",
dev->disk_flags, dev->track_flags, dev->gap3_len);
pcjs_log(" bit rate 300: %.2f, temporary rate: %i, hole: %i, DMF: %i\n",
bit_rate, temp_rate, (dev->disk_flags >> 1), dev->dmf);
pcjs_log(" encoded_size: %i spt: %i\n", sector->encoded_size, dev->spt[0][0]);
/* Set up 86F handlers */
d86f_handler[drive].disk_flags = disk_flags;
d86f_handler[drive].side_flags = track_flags;
d86f_handler[drive].writeback = null_writeback;
d86f_handler[drive].set_sector = set_sector;
d86f_handler[drive].read_data = poll_read_data;
d86f_handler[drive].write_data = null_write_data;
d86f_handler[drive].format_conditions = null_format_conditions;
d86f_handler[drive].extra_bit_cells = null_extra_bit_cells;
d86f_handler[drive].encoded_data = common_encoded_data;
d86f_handler[drive].read_revolution = common_read_revolution;
d86f_handler[drive].index_hole_pos = null_index_hole_pos;
d86f_handler[drive].get_raw_size = common_get_raw_size;
d86f_handler[drive].check_crc = 1;
d86f_set_version(drive, 0x0063);
d86f_common_handlers(drive);
drives[drive].seek = pcjs_seek;
}
void
pcjs_close(int drive)
{
pcjs_t *dev = images[drive];
if (dev == NULL)
return;
/* Unlink image from the system. */
d86f_unregister(drive);
/* Release all the sector buffers. */
for (int c = 0; c < PCJS_MAX_TRACKS; c++) {
for (int h = 0; h < PCJS_MAX_SIDES; h++) {
for (uint16_t s = 0; s < PCJS_MAX_SECTORS; s++) {
if (dev->sectors[c][h][s].data != NULL)
free(dev->sectors[c][h][s].data);
dev->sectors[c][h][s].data = NULL;
}
}
}
/* Release file table entries */
if(dev->file_table.entries != NULL)
free(dev->file_table.entries);
dev->file_table.entries = NULL;
dev->file_table.num_entries = 0;
if (dev->fp != NULL)
(void) fclose(dev->fp);
/* Release the memory. */
free(dev);
images[drive] = NULL;
}

255
src/include/86box/fdd_pcjs.h Normal file
View 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
View 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