From 10593102a65c44aa48bb8fac655e587dbaae83a9 Mon Sep 17 00:00:00 2001 From: esbudylin Date: Sun, 10 Dec 2023 13:59:15 +0400 Subject: [PATCH 01/18] reading values from a config --- src/brogue/Config.c | 175 +++ src/brogue/Recordings.c | 1 - src/brogue/Rogue.h | 2 + src/cjson/cJSON.c | 3119 +++++++++++++++++++++++++++++++++++++++ src/cjson/cJSON.h | 300 ++++ src/platform/main.c | 7 +- 6 files changed, 3599 insertions(+), 5 deletions(-) create mode 100644 src/brogue/Config.c create mode 100644 src/cjson/cJSON.c create mode 100644 src/cjson/cJSON.h diff --git a/src/brogue/Config.c b/src/brogue/Config.c new file mode 100644 index 00000000..21be9d98 --- /dev/null +++ b/src/brogue/Config.c @@ -0,0 +1,175 @@ +#include "../cjson/cJSON.h" +#include "Rogue.h" +#include "GlobalsBase.h" + +const char* JSON_FILENAME = "brogue_config.json"; + +typedef struct configParams { + short playbackDelayPerTurn; + short gameVariant; + short graphicsMode; + boolean displayStealthRangeMode; + boolean trueColorMode; + boolean wizard; + boolean easyMode; +} configParams; + +typedef enum { + INT_TYPE, + BOOLEAN_TYPE, + GAME_VARIANT, + GRAPHICS_MODE, +} fieldType; + +typedef struct { + const char* fieldName; + void* fieldPointer; + fieldType fieldType; + const char** stringMapping; +} configEntry; + +const char* variantMappings[] = { + "brogue", + "rapid", + NULL +}; + +const char* graphicsModeMappings[] = { + "text", + "tiles", + "hybrid", + NULL +}; + +configParams createDefaultConfig() { + configParams config; + + config.playbackDelayPerTurn = DEFAULT_PLAYBACK_DELAY; + config.gameVariant = VARIANT_BROGUE; + config.graphicsMode = TEXT_GRAPHICS; + config.displayStealthRangeMode = false; + config.trueColorMode = false; + config.easyMode = false; + config.wizard = false; + + return config; +} + +char* loadConfigFile() { + FILE* jsonFile = fopen(JSON_FILENAME, "r"); + + if (!jsonFile) { + return NULL; + } + + fseek(jsonFile, 0, SEEK_END); + long fileSize = ftell(jsonFile); + fseek(jsonFile, 0, SEEK_SET); + + char* buffer = (char*)malloc(fileSize + 1); + + if (!buffer) { + fclose(jsonFile); + return NULL; + } + + fread(buffer, 1, fileSize, jsonFile); + fclose(jsonFile); + + buffer[fileSize] = '\0'; + + return buffer; +} + +configEntry* getFieldEntries(configParams* config) { + int numFields = 7; + + configEntry* entries = calloc(numFields + 1, sizeof(configEntry)); + + entries[0] = (configEntry){ "gameVariant", &(config->gameVariant), GAME_VARIANT, variantMappings }; + entries[1] = (configEntry){ "graphicsMode", &(config->graphicsMode), GRAPHICS_MODE, graphicsModeMappings }; + entries[2] = (configEntry){ "playbackDelayPerTurn", &(config->playbackDelayPerTurn), INT_TYPE }; + entries[3] = (configEntry){ "displayStealthRangeMode", &(config->displayStealthRangeMode), BOOLEAN_TYPE }; + entries[4] = (configEntry){ "trueColorMode", &(config->trueColorMode), BOOLEAN_TYPE }; + entries[5] = (configEntry){ "wizard", &(config->wizard), BOOLEAN_TYPE }; + entries[6] = (configEntry){ "easyMode", &(config->easyMode), BOOLEAN_TYPE }; + entries[numFields] = (configEntry){ NULL }; + + return entries; +} + +short mapStringToEnum(const char* inputString, const char** mappings) { + for (short i = 0; mappings[i]; i++) { + if (strcmp(inputString, mappings[i]) == 0) { + return i; + } + } + return -1; +} + +void parseConfigValues(const char* jsonString, configParams* config) { + if (!jsonString || !config) { + return; // Invalid input + } + + cJSON* root = cJSON_Parse(jsonString); + + if (!root) { + return; // JSON parsing error + } + + configEntry* entries = getFieldEntries(config); + + for (int i = 0; entries[i].fieldName; i++) { + cJSON* jsonField = cJSON_GetObjectItem(root, entries[i].fieldName); + + if (jsonField) { + switch (entries[i].fieldType) { + case INT_TYPE: + *((short*)entries[i].fieldPointer) = jsonField->valueint; + break; + + case BOOLEAN_TYPE: + *((boolean*)entries[i].fieldPointer) = jsonField->valueint; + break; + + case GAME_VARIANT: + case GRAPHICS_MODE: + { + const char* modeString = jsonField->valuestring; + short mode = mapStringToEnum(modeString, entries[i].stringMapping); + + if (mode != -1) { + *((short*)entries[i].fieldPointer) = mode; + } + break; + } + + default: + break; + } + } + } + + free(entries); + cJSON_Delete(root); +} + +void readFromConfig(playerCharacter* rogue, enum graphicsModes* initialGraphics) { + char* jsonString = loadConfigFile(); + + configParams config = createDefaultConfig(); + + parseConfigValues(jsonString, &config); + + rogue->wizard = config.wizard; + rogue->easyMode = config.easyMode; + rogue->displayStealthRangeMode = config.displayStealthRangeMode; + rogue->trueColorMode = config.trueColorMode; + rogue->playbackDelayPerTurn = config.playbackDelayPerTurn; + + gameVariant = config.gameVariant; + *initialGraphics = config.graphicsMode; + + free(jsonString); +} diff --git a/src/brogue/Recordings.c b/src/brogue/Recordings.c index 72005c8d..1272671b 100644 --- a/src/brogue/Recordings.c +++ b/src/brogue/Recordings.c @@ -494,7 +494,6 @@ void initRecording() { if (rogue.playbackMode) { lengthOfPlaybackFile = 100000; // so recall functions don't freak out - rogue.playbackDelayPerTurn = DEFAULT_PLAYBACK_DELAY; rogue.playbackDelayThisTurn = rogue.playbackDelayPerTurn; rogue.playbackPaused = false; diff --git a/src/brogue/Rogue.h b/src/brogue/Rogue.h index 132bd522..0ff78fad 100644 --- a/src/brogue/Rogue.h +++ b/src/brogue/Rogue.h @@ -3455,6 +3455,8 @@ extern "C" { void dijkstraScan(short **distanceMap, short **costMap, boolean useDiagonals); + void readFromConfig(playerCharacter* rogue, short* initialGraphics); + #if defined __cplusplus } #endif diff --git a/src/cjson/cJSON.c b/src/cjson/cJSON.c new file mode 100644 index 00000000..f6dd11c5 --- /dev/null +++ b/src/cjson/cJSON.c @@ -0,0 +1,3119 @@ +/* + 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. +*/ + +/* cJSON */ +/* JSON parser in C. */ + +/* disable warnings about old C89 functions in MSVC */ +#if !defined(_CRT_SECURE_NO_DEPRECATE) && defined(_MSC_VER) +#define _CRT_SECURE_NO_DEPRECATE +#endif + +#ifdef __GNUC__ +#pragma GCC visibility push(default) +#endif +#if defined(_MSC_VER) +#pragma warning (push) +/* disable warning about single line comments in system headers */ +#pragma warning (disable : 4001) +#endif + +#include +#include +#include +#include +#include +#include +#include + +#ifdef ENABLE_LOCALES +#include +#endif + +#if defined(_MSC_VER) +#pragma warning (pop) +#endif +#ifdef __GNUC__ +#pragma GCC visibility pop +#endif + +#include "cJSON.h" + +/* define our own boolean type */ +#ifdef true +#undef true +#endif +#define true ((cJSON_bool)1) + +#ifdef false +#undef false +#endif +#define false ((cJSON_bool)0) + +/* define isnan and isinf for ANSI C, if in C99 or above, isnan and isinf has been defined in math.h */ +#ifndef isinf +#define isinf(d) (isnan((d - d)) && !isnan(d)) +#endif +#ifndef isnan +#define isnan(d) (d != d) +#endif + +#ifndef NAN +#ifdef _WIN32 +#define NAN sqrt(-1.0) +#else +#define NAN 0.0/0.0 +#endif +#endif + +typedef struct { + const unsigned char *json; + size_t position; +} error; +static error global_error = { NULL, 0 }; + +CJSON_PUBLIC(const char *) cJSON_GetErrorPtr(void) +{ + return (const char*) (global_error.json + global_error.position); +} + +CJSON_PUBLIC(char *) cJSON_GetStringValue(const cJSON * const item) +{ + if (!cJSON_IsString(item)) + { + return NULL; + } + + return item->valuestring; +} + +CJSON_PUBLIC(double) cJSON_GetNumberValue(const cJSON * const item) +{ + if (!cJSON_IsNumber(item)) + { + return (double) NAN; + } + + return item->valuedouble; +} + +/* This is a safeguard to prevent copy-pasters from using incompatible C and header files */ +#if (CJSON_VERSION_MAJOR != 1) || (CJSON_VERSION_MINOR != 7) || (CJSON_VERSION_PATCH != 16) + #error cJSON.h and cJSON.c have different versions. Make sure that both have the same. +#endif + +CJSON_PUBLIC(const char*) cJSON_Version(void) +{ + static char version[15]; + sprintf(version, "%i.%i.%i", CJSON_VERSION_MAJOR, CJSON_VERSION_MINOR, CJSON_VERSION_PATCH); + + return version; +} + +/* Case insensitive string comparison, doesn't consider two NULL pointers equal though */ +static int case_insensitive_strcmp(const unsigned char *string1, const unsigned char *string2) +{ + if ((string1 == NULL) || (string2 == NULL)) + { + return 1; + } + + if (string1 == string2) + { + return 0; + } + + for(; tolower(*string1) == tolower(*string2); (void)string1++, string2++) + { + if (*string1 == '\0') + { + return 0; + } + } + + return tolower(*string1) - tolower(*string2); +} + +typedef struct internal_hooks +{ + void *(CJSON_CDECL *allocate)(size_t size); + void (CJSON_CDECL *deallocate)(void *pointer); + void *(CJSON_CDECL *reallocate)(void *pointer, size_t size); +} internal_hooks; + +#if defined(_MSC_VER) +/* work around MSVC error C2322: '...' address of dllimport '...' is not static */ +static void * CJSON_CDECL internal_malloc(size_t size) +{ + return malloc(size); +} +static void CJSON_CDECL internal_free(void *pointer) +{ + free(pointer); +} +static void * CJSON_CDECL internal_realloc(void *pointer, size_t size) +{ + return realloc(pointer, size); +} +#else +#define internal_malloc malloc +#define internal_free free +#define internal_realloc realloc +#endif + +/* strlen of character literals resolved at compile time */ +#define static_strlen(string_literal) (sizeof(string_literal) - sizeof("")) + +static internal_hooks global_hooks = { internal_malloc, internal_free, internal_realloc }; + +static unsigned char* cJSON_strdup(const unsigned char* string, const internal_hooks * const hooks) +{ + size_t length = 0; + unsigned char *copy = NULL; + + if (string == NULL) + { + return NULL; + } + + length = strlen((const char*)string) + sizeof(""); + copy = (unsigned char*)hooks->allocate(length); + if (copy == NULL) + { + return NULL; + } + memcpy(copy, string, length); + + return copy; +} + +CJSON_PUBLIC(void) cJSON_InitHooks(cJSON_Hooks* hooks) +{ + if (hooks == NULL) + { + /* Reset hooks */ + global_hooks.allocate = malloc; + global_hooks.deallocate = free; + global_hooks.reallocate = realloc; + return; + } + + global_hooks.allocate = malloc; + if (hooks->malloc_fn != NULL) + { + global_hooks.allocate = hooks->malloc_fn; + } + + global_hooks.deallocate = free; + if (hooks->free_fn != NULL) + { + global_hooks.deallocate = hooks->free_fn; + } + + /* use realloc only if both free and malloc are used */ + global_hooks.reallocate = NULL; + if ((global_hooks.allocate == malloc) && (global_hooks.deallocate == free)) + { + global_hooks.reallocate = realloc; + } +} + +/* Internal constructor. */ +static cJSON *cJSON_New_Item(const internal_hooks * const hooks) +{ + cJSON* node = (cJSON*)hooks->allocate(sizeof(cJSON)); + if (node) + { + memset(node, '\0', sizeof(cJSON)); + } + + return node; +} + +/* Delete a cJSON structure. */ +CJSON_PUBLIC(void) cJSON_Delete(cJSON *item) +{ + cJSON *next = NULL; + while (item != NULL) + { + next = item->next; + if (!(item->type & cJSON_IsReference) && (item->child != NULL)) + { + cJSON_Delete(item->child); + } + if (!(item->type & cJSON_IsReference) && (item->valuestring != NULL)) + { + global_hooks.deallocate(item->valuestring); + } + if (!(item->type & cJSON_StringIsConst) && (item->string != NULL)) + { + global_hooks.deallocate(item->string); + } + global_hooks.deallocate(item); + item = next; + } +} + +/* get the decimal point character of the current locale */ +static unsigned char get_decimal_point(void) +{ +#ifdef ENABLE_LOCALES + struct lconv *lconv = localeconv(); + return (unsigned char) lconv->decimal_point[0]; +#else + return '.'; +#endif +} + +typedef struct +{ + const unsigned char *content; + size_t length; + size_t offset; + size_t depth; /* How deeply nested (in arrays/objects) is the input at the current offset. */ + internal_hooks hooks; +} parse_buffer; + +/* check if the given size is left to read in a given parse buffer (starting with 1) */ +#define can_read(buffer, size) ((buffer != NULL) && (((buffer)->offset + size) <= (buffer)->length)) +/* check if the buffer can be accessed at the given index (starting with 0) */ +#define can_access_at_index(buffer, index) ((buffer != NULL) && (((buffer)->offset + index) < (buffer)->length)) +#define cannot_access_at_index(buffer, index) (!can_access_at_index(buffer, index)) +/* get a pointer to the buffer at the position */ +#define buffer_at_offset(buffer) ((buffer)->content + (buffer)->offset) + +/* Parse the input text to generate a number, and populate the result into item. */ +static cJSON_bool parse_number(cJSON * const item, parse_buffer * const input_buffer) +{ + double number = 0; + unsigned char *after_end = NULL; + unsigned char number_c_string[64]; + unsigned char decimal_point = get_decimal_point(); + size_t i = 0; + + if ((input_buffer == NULL) || (input_buffer->content == NULL)) + { + return false; + } + + /* copy the number into a temporary buffer and replace '.' with the decimal point + * of the current locale (for strtod) + * This also takes care of '\0' not necessarily being available for marking the end of the input */ + for (i = 0; (i < (sizeof(number_c_string) - 1)) && can_access_at_index(input_buffer, i); i++) + { + switch (buffer_at_offset(input_buffer)[i]) + { + case '0': + case '1': + case '2': + case '3': + case '4': + case '5': + case '6': + case '7': + case '8': + case '9': + case '+': + case '-': + case 'e': + case 'E': + number_c_string[i] = buffer_at_offset(input_buffer)[i]; + break; + + case '.': + number_c_string[i] = decimal_point; + break; + + default: + goto loop_end; + } + } +loop_end: + number_c_string[i] = '\0'; + + number = strtod((const char*)number_c_string, (char**)&after_end); + if (number_c_string == after_end) + { + return false; /* parse_error */ + } + + item->valuedouble = number; + + /* use saturation in case of overflow */ + if (number >= INT_MAX) + { + item->valueint = INT_MAX; + } + else if (number <= (double)INT_MIN) + { + item->valueint = INT_MIN; + } + else + { + item->valueint = (int)number; + } + + item->type = cJSON_Number; + + input_buffer->offset += (size_t)(after_end - number_c_string); + return true; +} + +/* don't ask me, but the original cJSON_SetNumberValue returns an integer or double */ +CJSON_PUBLIC(double) cJSON_SetNumberHelper(cJSON *object, double number) +{ + if (number >= INT_MAX) + { + object->valueint = INT_MAX; + } + else if (number <= (double)INT_MIN) + { + object->valueint = INT_MIN; + } + else + { + object->valueint = (int)number; + } + + return object->valuedouble = number; +} + +CJSON_PUBLIC(char*) cJSON_SetValuestring(cJSON *object, const char *valuestring) +{ + char *copy = NULL; + /* if object's type is not cJSON_String or is cJSON_IsReference, it should not set valuestring */ + if (!(object->type & cJSON_String) || (object->type & cJSON_IsReference)) + { + return NULL; + } + if (strlen(valuestring) <= strlen(object->valuestring)) + { + strcpy(object->valuestring, valuestring); + return object->valuestring; + } + copy = (char*) cJSON_strdup((const unsigned char*)valuestring, &global_hooks); + if (copy == NULL) + { + return NULL; + } + if (object->valuestring != NULL) + { + cJSON_free(object->valuestring); + } + object->valuestring = copy; + + return copy; +} + +typedef struct +{ + unsigned char *buffer; + size_t length; + size_t offset; + size_t depth; /* current nesting depth (for formatted printing) */ + cJSON_bool noalloc; + cJSON_bool format; /* is this print a formatted print */ + internal_hooks hooks; +} printbuffer; + +/* realloc printbuffer if necessary to have at least "needed" bytes more */ +static unsigned char* ensure(printbuffer * const p, size_t needed) +{ + unsigned char *newbuffer = NULL; + size_t newsize = 0; + + if ((p == NULL) || (p->buffer == NULL)) + { + return NULL; + } + + if ((p->length > 0) && (p->offset >= p->length)) + { + /* make sure that offset is valid */ + return NULL; + } + + if (needed > INT_MAX) + { + /* sizes bigger than INT_MAX are currently not supported */ + return NULL; + } + + needed += p->offset + 1; + if (needed <= p->length) + { + return p->buffer + p->offset; + } + + if (p->noalloc) { + return NULL; + } + + /* calculate new buffer size */ + if (needed > (INT_MAX / 2)) + { + /* overflow of int, use INT_MAX if possible */ + if (needed <= INT_MAX) + { + newsize = INT_MAX; + } + else + { + return NULL; + } + } + else + { + newsize = needed * 2; + } + + if (p->hooks.reallocate != NULL) + { + /* reallocate with realloc if available */ + newbuffer = (unsigned char*)p->hooks.reallocate(p->buffer, newsize); + if (newbuffer == NULL) + { + p->hooks.deallocate(p->buffer); + p->length = 0; + p->buffer = NULL; + + return NULL; + } + } + else + { + /* otherwise reallocate manually */ + newbuffer = (unsigned char*)p->hooks.allocate(newsize); + if (!newbuffer) + { + p->hooks.deallocate(p->buffer); + p->length = 0; + p->buffer = NULL; + + return NULL; + } + + memcpy(newbuffer, p->buffer, p->offset + 1); + p->hooks.deallocate(p->buffer); + } + p->length = newsize; + p->buffer = newbuffer; + + return newbuffer + p->offset; +} + +/* calculate the new length of the string in a printbuffer and update the offset */ +static void update_offset(printbuffer * const buffer) +{ + const unsigned char *buffer_pointer = NULL; + if ((buffer == NULL) || (buffer->buffer == NULL)) + { + return; + } + buffer_pointer = buffer->buffer + buffer->offset; + + buffer->offset += strlen((const char*)buffer_pointer); +} + +/* securely comparison of floating-point variables */ +static cJSON_bool compare_double(double a, double b) +{ + double maxVal = fabs(a) > fabs(b) ? fabs(a) : fabs(b); + return (fabs(a - b) <= maxVal * DBL_EPSILON); +} + +/* Render the number nicely from the given item into a string. */ +static cJSON_bool print_number(const cJSON * const item, printbuffer * const output_buffer) +{ + unsigned char *output_pointer = NULL; + double d = item->valuedouble; + int length = 0; + size_t i = 0; + unsigned char number_buffer[26] = {0}; /* temporary buffer to print the number into */ + unsigned char decimal_point = get_decimal_point(); + double test = 0.0; + + if (output_buffer == NULL) + { + return false; + } + + /* This checks for NaN and Infinity */ + if (isnan(d) || isinf(d)) + { + length = sprintf((char*)number_buffer, "null"); + } + else if(d == (double)item->valueint) + { + length = sprintf((char*)number_buffer, "%d", item->valueint); + } + else + { + /* Try 15 decimal places of precision to avoid nonsignificant nonzero digits */ + length = sprintf((char*)number_buffer, "%1.15g", d); + + /* Check whether the original double can be recovered */ + if ((sscanf((char*)number_buffer, "%lg", &test) != 1) || !compare_double((double)test, d)) + { + /* If not, print with 17 decimal places of precision */ + length = sprintf((char*)number_buffer, "%1.17g", d); + } + } + + /* sprintf failed or buffer overrun occurred */ + if ((length < 0) || (length > (int)(sizeof(number_buffer) - 1))) + { + return false; + } + + /* reserve appropriate space in the output */ + output_pointer = ensure(output_buffer, (size_t)length + sizeof("")); + if (output_pointer == NULL) + { + return false; + } + + /* copy the printed number to the output and replace locale + * dependent decimal point with '.' */ + for (i = 0; i < ((size_t)length); i++) + { + if (number_buffer[i] == decimal_point) + { + output_pointer[i] = '.'; + continue; + } + + output_pointer[i] = number_buffer[i]; + } + output_pointer[i] = '\0'; + + output_buffer->offset += (size_t)length; + + return true; +} + +/* parse 4 digit hexadecimal number */ +static unsigned parse_hex4(const unsigned char * const input) +{ + unsigned int h = 0; + size_t i = 0; + + for (i = 0; i < 4; i++) + { + /* parse digit */ + if ((input[i] >= '0') && (input[i] <= '9')) + { + h += (unsigned int) input[i] - '0'; + } + else if ((input[i] >= 'A') && (input[i] <= 'F')) + { + h += (unsigned int) 10 + input[i] - 'A'; + } + else if ((input[i] >= 'a') && (input[i] <= 'f')) + { + h += (unsigned int) 10 + input[i] - 'a'; + } + else /* invalid */ + { + return 0; + } + + if (i < 3) + { + /* shift left to make place for the next nibble */ + h = h << 4; + } + } + + return h; +} + +/* converts a UTF-16 literal to UTF-8 + * A literal can be one or two sequences of the form \uXXXX */ +static unsigned char utf16_literal_to_utf8(const unsigned char * const input_pointer, const unsigned char * const input_end, unsigned char **output_pointer) +{ + long unsigned int codepoint = 0; + unsigned int first_code = 0; + const unsigned char *first_sequence = input_pointer; + unsigned char utf8_length = 0; + unsigned char utf8_position = 0; + unsigned char sequence_length = 0; + unsigned char first_byte_mark = 0; + + if ((input_end - first_sequence) < 6) + { + /* input ends unexpectedly */ + goto fail; + } + + /* get the first utf16 sequence */ + first_code = parse_hex4(first_sequence + 2); + + /* check that the code is valid */ + if (((first_code >= 0xDC00) && (first_code <= 0xDFFF))) + { + goto fail; + } + + /* UTF16 surrogate pair */ + if ((first_code >= 0xD800) && (first_code <= 0xDBFF)) + { + const unsigned char *second_sequence = first_sequence + 6; + unsigned int second_code = 0; + sequence_length = 12; /* \uXXXX\uXXXX */ + + if ((input_end - second_sequence) < 6) + { + /* input ends unexpectedly */ + goto fail; + } + + if ((second_sequence[0] != '\\') || (second_sequence[1] != 'u')) + { + /* missing second half of the surrogate pair */ + goto fail; + } + + /* get the second utf16 sequence */ + second_code = parse_hex4(second_sequence + 2); + /* check that the code is valid */ + if ((second_code < 0xDC00) || (second_code > 0xDFFF)) + { + /* invalid second half of the surrogate pair */ + goto fail; + } + + + /* calculate the unicode codepoint from the surrogate pair */ + codepoint = 0x10000 + (((first_code & 0x3FF) << 10) | (second_code & 0x3FF)); + } + else + { + sequence_length = 6; /* \uXXXX */ + codepoint = first_code; + } + + /* encode as UTF-8 + * takes at maximum 4 bytes to encode: + * 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx */ + if (codepoint < 0x80) + { + /* normal ascii, encoding 0xxxxxxx */ + utf8_length = 1; + } + else if (codepoint < 0x800) + { + /* two bytes, encoding 110xxxxx 10xxxxxx */ + utf8_length = 2; + first_byte_mark = 0xC0; /* 11000000 */ + } + else if (codepoint < 0x10000) + { + /* three bytes, encoding 1110xxxx 10xxxxxx 10xxxxxx */ + utf8_length = 3; + first_byte_mark = 0xE0; /* 11100000 */ + } + else if (codepoint <= 0x10FFFF) + { + /* four bytes, encoding 1110xxxx 10xxxxxx 10xxxxxx 10xxxxxx */ + utf8_length = 4; + first_byte_mark = 0xF0; /* 11110000 */ + } + else + { + /* invalid unicode codepoint */ + goto fail; + } + + /* encode as utf8 */ + for (utf8_position = (unsigned char)(utf8_length - 1); utf8_position > 0; utf8_position--) + { + /* 10xxxxxx */ + (*output_pointer)[utf8_position] = (unsigned char)((codepoint | 0x80) & 0xBF); + codepoint >>= 6; + } + /* encode first byte */ + if (utf8_length > 1) + { + (*output_pointer)[0] = (unsigned char)((codepoint | first_byte_mark) & 0xFF); + } + else + { + (*output_pointer)[0] = (unsigned char)(codepoint & 0x7F); + } + + *output_pointer += utf8_length; + + return sequence_length; + +fail: + return 0; +} + +/* Parse the input text into an unescaped cinput, and populate item. */ +static cJSON_bool parse_string(cJSON * const item, parse_buffer * const input_buffer) +{ + const unsigned char *input_pointer = buffer_at_offset(input_buffer) + 1; + const unsigned char *input_end = buffer_at_offset(input_buffer) + 1; + unsigned char *output_pointer = NULL; + unsigned char *output = NULL; + + /* not a string */ + if (buffer_at_offset(input_buffer)[0] != '\"') + { + goto fail; + } + + { + /* calculate approximate size of the output (overestimate) */ + size_t allocation_length = 0; + size_t skipped_bytes = 0; + while (((size_t)(input_end - input_buffer->content) < input_buffer->length) && (*input_end != '\"')) + { + /* is escape sequence */ + if (input_end[0] == '\\') + { + if ((size_t)(input_end + 1 - input_buffer->content) >= input_buffer->length) + { + /* prevent buffer overflow when last input character is a backslash */ + goto fail; + } + skipped_bytes++; + input_end++; + } + input_end++; + } + if (((size_t)(input_end - input_buffer->content) >= input_buffer->length) || (*input_end != '\"')) + { + goto fail; /* string ended unexpectedly */ + } + + /* This is at most how much we need for the output */ + allocation_length = (size_t) (input_end - buffer_at_offset(input_buffer)) - skipped_bytes; + output = (unsigned char*)input_buffer->hooks.allocate(allocation_length + sizeof("")); + if (output == NULL) + { + goto fail; /* allocation failure */ + } + } + + output_pointer = output; + /* loop through the string literal */ + while (input_pointer < input_end) + { + if (*input_pointer != '\\') + { + *output_pointer++ = *input_pointer++; + } + /* escape sequence */ + else + { + unsigned char sequence_length = 2; + if ((input_end - input_pointer) < 1) + { + goto fail; + } + + switch (input_pointer[1]) + { + case 'b': + *output_pointer++ = '\b'; + break; + case 'f': + *output_pointer++ = '\f'; + break; + case 'n': + *output_pointer++ = '\n'; + break; + case 'r': + *output_pointer++ = '\r'; + break; + case 't': + *output_pointer++ = '\t'; + break; + case '\"': + case '\\': + case '/': + *output_pointer++ = input_pointer[1]; + break; + + /* UTF-16 literal */ + case 'u': + sequence_length = utf16_literal_to_utf8(input_pointer, input_end, &output_pointer); + if (sequence_length == 0) + { + /* failed to convert UTF16-literal to UTF-8 */ + goto fail; + } + break; + + default: + goto fail; + } + input_pointer += sequence_length; + } + } + + /* zero terminate the output */ + *output_pointer = '\0'; + + item->type = cJSON_String; + item->valuestring = (char*)output; + + input_buffer->offset = (size_t) (input_end - input_buffer->content); + input_buffer->offset++; + + return true; + +fail: + if (output != NULL) + { + input_buffer->hooks.deallocate(output); + } + + if (input_pointer != NULL) + { + input_buffer->offset = (size_t)(input_pointer - input_buffer->content); + } + + return false; +} + +/* Render the cstring provided to an escaped version that can be printed. */ +static cJSON_bool print_string_ptr(const unsigned char * const input, printbuffer * const output_buffer) +{ + const unsigned char *input_pointer = NULL; + unsigned char *output = NULL; + unsigned char *output_pointer = NULL; + size_t output_length = 0; + /* numbers of additional characters needed for escaping */ + size_t escape_characters = 0; + + if (output_buffer == NULL) + { + return false; + } + + /* empty string */ + if (input == NULL) + { + output = ensure(output_buffer, sizeof("\"\"")); + if (output == NULL) + { + return false; + } + strcpy((char*)output, "\"\""); + + return true; + } + + /* set "flag" to 1 if something needs to be escaped */ + for (input_pointer = input; *input_pointer; input_pointer++) + { + switch (*input_pointer) + { + case '\"': + case '\\': + case '\b': + case '\f': + case '\n': + case '\r': + case '\t': + /* one character escape sequence */ + escape_characters++; + break; + default: + if (*input_pointer < 32) + { + /* UTF-16 escape sequence uXXXX */ + escape_characters += 5; + } + break; + } + } + output_length = (size_t)(input_pointer - input) + escape_characters; + + output = ensure(output_buffer, output_length + sizeof("\"\"")); + if (output == NULL) + { + return false; + } + + /* no characters have to be escaped */ + if (escape_characters == 0) + { + output[0] = '\"'; + memcpy(output + 1, input, output_length); + output[output_length + 1] = '\"'; + output[output_length + 2] = '\0'; + + return true; + } + + output[0] = '\"'; + output_pointer = output + 1; + /* copy the string */ + for (input_pointer = input; *input_pointer != '\0'; (void)input_pointer++, output_pointer++) + { + if ((*input_pointer > 31) && (*input_pointer != '\"') && (*input_pointer != '\\')) + { + /* normal character, copy */ + *output_pointer = *input_pointer; + } + else + { + /* character needs to be escaped */ + *output_pointer++ = '\\'; + switch (*input_pointer) + { + case '\\': + *output_pointer = '\\'; + break; + case '\"': + *output_pointer = '\"'; + break; + case '\b': + *output_pointer = 'b'; + break; + case '\f': + *output_pointer = 'f'; + break; + case '\n': + *output_pointer = 'n'; + break; + case '\r': + *output_pointer = 'r'; + break; + case '\t': + *output_pointer = 't'; + break; + default: + /* escape and print as unicode codepoint */ + sprintf((char*)output_pointer, "u%04x", *input_pointer); + output_pointer += 4; + break; + } + } + } + output[output_length + 1] = '\"'; + output[output_length + 2] = '\0'; + + return true; +} + +/* Invoke print_string_ptr (which is useful) on an item. */ +static cJSON_bool print_string(const cJSON * const item, printbuffer * const p) +{ + return print_string_ptr((unsigned char*)item->valuestring, p); +} + +/* Predeclare these prototypes. */ +static cJSON_bool parse_value(cJSON * const item, parse_buffer * const input_buffer); +static cJSON_bool print_value(const cJSON * const item, printbuffer * const output_buffer); +static cJSON_bool parse_array(cJSON * const item, parse_buffer * const input_buffer); +static cJSON_bool print_array(const cJSON * const item, printbuffer * const output_buffer); +static cJSON_bool parse_object(cJSON * const item, parse_buffer * const input_buffer); +static cJSON_bool print_object(const cJSON * const item, printbuffer * const output_buffer); + +/* Utility to jump whitespace and cr/lf */ +static parse_buffer *buffer_skip_whitespace(parse_buffer * const buffer) +{ + if ((buffer == NULL) || (buffer->content == NULL)) + { + return NULL; + } + + if (cannot_access_at_index(buffer, 0)) + { + return buffer; + } + + while (can_access_at_index(buffer, 0) && (buffer_at_offset(buffer)[0] <= 32)) + { + buffer->offset++; + } + + if (buffer->offset == buffer->length) + { + buffer->offset--; + } + + return buffer; +} + +/* skip the UTF-8 BOM (byte order mark) if it is at the beginning of a buffer */ +static parse_buffer *skip_utf8_bom(parse_buffer * const buffer) +{ + if ((buffer == NULL) || (buffer->content == NULL) || (buffer->offset != 0)) + { + return NULL; + } + + if (can_access_at_index(buffer, 4) && (strncmp((const char*)buffer_at_offset(buffer), "\xEF\xBB\xBF", 3) == 0)) + { + buffer->offset += 3; + } + + return buffer; +} + +CJSON_PUBLIC(cJSON *) cJSON_ParseWithOpts(const char *value, const char **return_parse_end, cJSON_bool require_null_terminated) +{ + size_t buffer_length; + + if (NULL == value) + { + return NULL; + } + + /* Adding null character size due to require_null_terminated. */ + buffer_length = strlen(value) + sizeof(""); + + return cJSON_ParseWithLengthOpts(value, buffer_length, return_parse_end, require_null_terminated); +} + +/* Parse an object - create a new root, and populate. */ +CJSON_PUBLIC(cJSON *) cJSON_ParseWithLengthOpts(const char *value, size_t buffer_length, const char **return_parse_end, cJSON_bool require_null_terminated) +{ + parse_buffer buffer = { 0, 0, 0, 0, { 0, 0, 0 } }; + cJSON *item = NULL; + + /* reset error position */ + global_error.json = NULL; + global_error.position = 0; + + if (value == NULL || 0 == buffer_length) + { + goto fail; + } + + buffer.content = (const unsigned char*)value; + buffer.length = buffer_length; + buffer.offset = 0; + buffer.hooks = global_hooks; + + item = cJSON_New_Item(&global_hooks); + if (item == NULL) /* memory fail */ + { + goto fail; + } + + if (!parse_value(item, buffer_skip_whitespace(skip_utf8_bom(&buffer)))) + { + /* parse failure. ep is set. */ + goto fail; + } + + /* if we require null-terminated JSON without appended garbage, skip and then check for a null terminator */ + if (require_null_terminated) + { + buffer_skip_whitespace(&buffer); + if ((buffer.offset >= buffer.length) || buffer_at_offset(&buffer)[0] != '\0') + { + goto fail; + } + } + if (return_parse_end) + { + *return_parse_end = (const char*)buffer_at_offset(&buffer); + } + + return item; + +fail: + if (item != NULL) + { + cJSON_Delete(item); + } + + if (value != NULL) + { + error local_error; + local_error.json = (const unsigned char*)value; + local_error.position = 0; + + if (buffer.offset < buffer.length) + { + local_error.position = buffer.offset; + } + else if (buffer.length > 0) + { + local_error.position = buffer.length - 1; + } + + if (return_parse_end != NULL) + { + *return_parse_end = (const char*)local_error.json + local_error.position; + } + + global_error = local_error; + } + + return NULL; +} + +/* Default options for cJSON_Parse */ +CJSON_PUBLIC(cJSON *) cJSON_Parse(const char *value) +{ + return cJSON_ParseWithOpts(value, 0, 0); +} + +CJSON_PUBLIC(cJSON *) cJSON_ParseWithLength(const char *value, size_t buffer_length) +{ + return cJSON_ParseWithLengthOpts(value, buffer_length, 0, 0); +} + +#define cjson_min(a, b) (((a) < (b)) ? (a) : (b)) + +static unsigned char *print(const cJSON * const item, cJSON_bool format, const internal_hooks * const hooks) +{ + static const size_t default_buffer_size = 256; + printbuffer buffer[1]; + unsigned char *printed = NULL; + + memset(buffer, 0, sizeof(buffer)); + + /* create buffer */ + buffer->buffer = (unsigned char*) hooks->allocate(default_buffer_size); + buffer->length = default_buffer_size; + buffer->format = format; + buffer->hooks = *hooks; + if (buffer->buffer == NULL) + { + goto fail; + } + + /* print the value */ + if (!print_value(item, buffer)) + { + goto fail; + } + update_offset(buffer); + + /* check if reallocate is available */ + if (hooks->reallocate != NULL) + { + printed = (unsigned char*) hooks->reallocate(buffer->buffer, buffer->offset + 1); + if (printed == NULL) { + goto fail; + } + buffer->buffer = NULL; + } + else /* otherwise copy the JSON over to a new buffer */ + { + printed = (unsigned char*) hooks->allocate(buffer->offset + 1); + if (printed == NULL) + { + goto fail; + } + memcpy(printed, buffer->buffer, cjson_min(buffer->length, buffer->offset + 1)); + printed[buffer->offset] = '\0'; /* just to be sure */ + + /* free the buffer */ + hooks->deallocate(buffer->buffer); + } + + return printed; + +fail: + if (buffer->buffer != NULL) + { + hooks->deallocate(buffer->buffer); + } + + if (printed != NULL) + { + hooks->deallocate(printed); + } + + return NULL; +} + +/* Render a cJSON item/entity/structure to text. */ +CJSON_PUBLIC(char *) cJSON_Print(const cJSON *item) +{ + return (char*)print(item, true, &global_hooks); +} + +CJSON_PUBLIC(char *) cJSON_PrintUnformatted(const cJSON *item) +{ + return (char*)print(item, false, &global_hooks); +} + +CJSON_PUBLIC(char *) cJSON_PrintBuffered(const cJSON *item, int prebuffer, cJSON_bool fmt) +{ + printbuffer p = { 0, 0, 0, 0, 0, 0, { 0, 0, 0 } }; + + if (prebuffer < 0) + { + return NULL; + } + + p.buffer = (unsigned char*)global_hooks.allocate((size_t)prebuffer); + if (!p.buffer) + { + return NULL; + } + + p.length = (size_t)prebuffer; + p.offset = 0; + p.noalloc = false; + p.format = fmt; + p.hooks = global_hooks; + + if (!print_value(item, &p)) + { + global_hooks.deallocate(p.buffer); + return NULL; + } + + return (char*)p.buffer; +} + +CJSON_PUBLIC(cJSON_bool) cJSON_PrintPreallocated(cJSON *item, char *buffer, const int length, const cJSON_bool format) +{ + printbuffer p = { 0, 0, 0, 0, 0, 0, { 0, 0, 0 } }; + + if ((length < 0) || (buffer == NULL)) + { + return false; + } + + p.buffer = (unsigned char*)buffer; + p.length = (size_t)length; + p.offset = 0; + p.noalloc = true; + p.format = format; + p.hooks = global_hooks; + + return print_value(item, &p); +} + +/* Parser core - when encountering text, process appropriately. */ +static cJSON_bool parse_value(cJSON * const item, parse_buffer * const input_buffer) +{ + if ((input_buffer == NULL) || (input_buffer->content == NULL)) + { + return false; /* no input */ + } + + /* parse the different types of values */ + /* null */ + if (can_read(input_buffer, 4) && (strncmp((const char*)buffer_at_offset(input_buffer), "null", 4) == 0)) + { + item->type = cJSON_NULL; + input_buffer->offset += 4; + return true; + } + /* false */ + if (can_read(input_buffer, 5) && (strncmp((const char*)buffer_at_offset(input_buffer), "false", 5) == 0)) + { + item->type = cJSON_False; + input_buffer->offset += 5; + return true; + } + /* true */ + if (can_read(input_buffer, 4) && (strncmp((const char*)buffer_at_offset(input_buffer), "true", 4) == 0)) + { + item->type = cJSON_True; + item->valueint = 1; + input_buffer->offset += 4; + return true; + } + /* string */ + if (can_access_at_index(input_buffer, 0) && (buffer_at_offset(input_buffer)[0] == '\"')) + { + return parse_string(item, input_buffer); + } + /* number */ + if (can_access_at_index(input_buffer, 0) && ((buffer_at_offset(input_buffer)[0] == '-') || ((buffer_at_offset(input_buffer)[0] >= '0') && (buffer_at_offset(input_buffer)[0] <= '9')))) + { + return parse_number(item, input_buffer); + } + /* array */ + if (can_access_at_index(input_buffer, 0) && (buffer_at_offset(input_buffer)[0] == '[')) + { + return parse_array(item, input_buffer); + } + /* object */ + if (can_access_at_index(input_buffer, 0) && (buffer_at_offset(input_buffer)[0] == '{')) + { + return parse_object(item, input_buffer); + } + + return false; +} + +/* Render a value to text. */ +static cJSON_bool print_value(const cJSON * const item, printbuffer * const output_buffer) +{ + unsigned char *output = NULL; + + if ((item == NULL) || (output_buffer == NULL)) + { + return false; + } + + switch ((item->type) & 0xFF) + { + case cJSON_NULL: + output = ensure(output_buffer, 5); + if (output == NULL) + { + return false; + } + strcpy((char*)output, "null"); + return true; + + case cJSON_False: + output = ensure(output_buffer, 6); + if (output == NULL) + { + return false; + } + strcpy((char*)output, "false"); + return true; + + case cJSON_True: + output = ensure(output_buffer, 5); + if (output == NULL) + { + return false; + } + strcpy((char*)output, "true"); + return true; + + case cJSON_Number: + return print_number(item, output_buffer); + + case cJSON_Raw: + { + size_t raw_length = 0; + if (item->valuestring == NULL) + { + return false; + } + + raw_length = strlen(item->valuestring) + sizeof(""); + output = ensure(output_buffer, raw_length); + if (output == NULL) + { + return false; + } + memcpy(output, item->valuestring, raw_length); + return true; + } + + case cJSON_String: + return print_string(item, output_buffer); + + case cJSON_Array: + return print_array(item, output_buffer); + + case cJSON_Object: + return print_object(item, output_buffer); + + default: + return false; + } +} + +/* Build an array from input text. */ +static cJSON_bool parse_array(cJSON * const item, parse_buffer * const input_buffer) +{ + cJSON *head = NULL; /* head of the linked list */ + cJSON *current_item = NULL; + + if (input_buffer->depth >= CJSON_NESTING_LIMIT) + { + return false; /* to deeply nested */ + } + input_buffer->depth++; + + if (buffer_at_offset(input_buffer)[0] != '[') + { + /* not an array */ + goto fail; + } + + input_buffer->offset++; + buffer_skip_whitespace(input_buffer); + if (can_access_at_index(input_buffer, 0) && (buffer_at_offset(input_buffer)[0] == ']')) + { + /* empty array */ + goto success; + } + + /* check if we skipped to the end of the buffer */ + if (cannot_access_at_index(input_buffer, 0)) + { + input_buffer->offset--; + goto fail; + } + + /* step back to character in front of the first element */ + input_buffer->offset--; + /* loop through the comma separated array elements */ + do + { + /* allocate next item */ + cJSON *new_item = cJSON_New_Item(&(input_buffer->hooks)); + if (new_item == NULL) + { + goto fail; /* allocation failure */ + } + + /* attach next item to list */ + if (head == NULL) + { + /* start the linked list */ + current_item = head = new_item; + } + else + { + /* add to the end and advance */ + current_item->next = new_item; + new_item->prev = current_item; + current_item = new_item; + } + + /* parse next value */ + input_buffer->offset++; + buffer_skip_whitespace(input_buffer); + if (!parse_value(current_item, input_buffer)) + { + goto fail; /* failed to parse value */ + } + buffer_skip_whitespace(input_buffer); + } + while (can_access_at_index(input_buffer, 0) && (buffer_at_offset(input_buffer)[0] == ',')); + + if (cannot_access_at_index(input_buffer, 0) || buffer_at_offset(input_buffer)[0] != ']') + { + goto fail; /* expected end of array */ + } + +success: + input_buffer->depth--; + + if (head != NULL) { + head->prev = current_item; + } + + item->type = cJSON_Array; + item->child = head; + + input_buffer->offset++; + + return true; + +fail: + if (head != NULL) + { + cJSON_Delete(head); + } + + return false; +} + +/* Render an array to text */ +static cJSON_bool print_array(const cJSON * const item, printbuffer * const output_buffer) +{ + unsigned char *output_pointer = NULL; + size_t length = 0; + cJSON *current_element = item->child; + + if (output_buffer == NULL) + { + return false; + } + + /* Compose the output array. */ + /* opening square bracket */ + output_pointer = ensure(output_buffer, 1); + if (output_pointer == NULL) + { + return false; + } + + *output_pointer = '['; + output_buffer->offset++; + output_buffer->depth++; + + while (current_element != NULL) + { + if (!print_value(current_element, output_buffer)) + { + return false; + } + update_offset(output_buffer); + if (current_element->next) + { + length = (size_t) (output_buffer->format ? 2 : 1); + output_pointer = ensure(output_buffer, length + 1); + if (output_pointer == NULL) + { + return false; + } + *output_pointer++ = ','; + if(output_buffer->format) + { + *output_pointer++ = ' '; + } + *output_pointer = '\0'; + output_buffer->offset += length; + } + current_element = current_element->next; + } + + output_pointer = ensure(output_buffer, 2); + if (output_pointer == NULL) + { + return false; + } + *output_pointer++ = ']'; + *output_pointer = '\0'; + output_buffer->depth--; + + return true; +} + +/* Build an object from the text. */ +static cJSON_bool parse_object(cJSON * const item, parse_buffer * const input_buffer) +{ + cJSON *head = NULL; /* linked list head */ + cJSON *current_item = NULL; + + if (input_buffer->depth >= CJSON_NESTING_LIMIT) + { + return false; /* to deeply nested */ + } + input_buffer->depth++; + + if (cannot_access_at_index(input_buffer, 0) || (buffer_at_offset(input_buffer)[0] != '{')) + { + goto fail; /* not an object */ + } + + input_buffer->offset++; + buffer_skip_whitespace(input_buffer); + if (can_access_at_index(input_buffer, 0) && (buffer_at_offset(input_buffer)[0] == '}')) + { + goto success; /* empty object */ + } + + /* check if we skipped to the end of the buffer */ + if (cannot_access_at_index(input_buffer, 0)) + { + input_buffer->offset--; + goto fail; + } + + /* step back to character in front of the first element */ + input_buffer->offset--; + /* loop through the comma separated array elements */ + do + { + /* allocate next item */ + cJSON *new_item = cJSON_New_Item(&(input_buffer->hooks)); + if (new_item == NULL) + { + goto fail; /* allocation failure */ + } + + /* attach next item to list */ + if (head == NULL) + { + /* start the linked list */ + current_item = head = new_item; + } + else + { + /* add to the end and advance */ + current_item->next = new_item; + new_item->prev = current_item; + current_item = new_item; + } + + /* parse the name of the child */ + input_buffer->offset++; + buffer_skip_whitespace(input_buffer); + if (!parse_string(current_item, input_buffer)) + { + goto fail; /* failed to parse name */ + } + buffer_skip_whitespace(input_buffer); + + /* swap valuestring and string, because we parsed the name */ + current_item->string = current_item->valuestring; + current_item->valuestring = NULL; + + if (cannot_access_at_index(input_buffer, 0) || (buffer_at_offset(input_buffer)[0] != ':')) + { + goto fail; /* invalid object */ + } + + /* parse the value */ + input_buffer->offset++; + buffer_skip_whitespace(input_buffer); + if (!parse_value(current_item, input_buffer)) + { + goto fail; /* failed to parse value */ + } + buffer_skip_whitespace(input_buffer); + } + while (can_access_at_index(input_buffer, 0) && (buffer_at_offset(input_buffer)[0] == ',')); + + if (cannot_access_at_index(input_buffer, 0) || (buffer_at_offset(input_buffer)[0] != '}')) + { + goto fail; /* expected end of object */ + } + +success: + input_buffer->depth--; + + if (head != NULL) { + head->prev = current_item; + } + + item->type = cJSON_Object; + item->child = head; + + input_buffer->offset++; + return true; + +fail: + if (head != NULL) + { + cJSON_Delete(head); + } + + return false; +} + +/* Render an object to text. */ +static cJSON_bool print_object(const cJSON * const item, printbuffer * const output_buffer) +{ + unsigned char *output_pointer = NULL; + size_t length = 0; + cJSON *current_item = item->child; + + if (output_buffer == NULL) + { + return false; + } + + /* Compose the output: */ + length = (size_t) (output_buffer->format ? 2 : 1); /* fmt: {\n */ + output_pointer = ensure(output_buffer, length + 1); + if (output_pointer == NULL) + { + return false; + } + + *output_pointer++ = '{'; + output_buffer->depth++; + if (output_buffer->format) + { + *output_pointer++ = '\n'; + } + output_buffer->offset += length; + + while (current_item) + { + if (output_buffer->format) + { + size_t i; + output_pointer = ensure(output_buffer, output_buffer->depth); + if (output_pointer == NULL) + { + return false; + } + for (i = 0; i < output_buffer->depth; i++) + { + *output_pointer++ = '\t'; + } + output_buffer->offset += output_buffer->depth; + } + + /* print key */ + if (!print_string_ptr((unsigned char*)current_item->string, output_buffer)) + { + return false; + } + update_offset(output_buffer); + + length = (size_t) (output_buffer->format ? 2 : 1); + output_pointer = ensure(output_buffer, length); + if (output_pointer == NULL) + { + return false; + } + *output_pointer++ = ':'; + if (output_buffer->format) + { + *output_pointer++ = '\t'; + } + output_buffer->offset += length; + + /* print value */ + if (!print_value(current_item, output_buffer)) + { + return false; + } + update_offset(output_buffer); + + /* print comma if not last */ + length = ((size_t)(output_buffer->format ? 1 : 0) + (size_t)(current_item->next ? 1 : 0)); + output_pointer = ensure(output_buffer, length + 1); + if (output_pointer == NULL) + { + return false; + } + if (current_item->next) + { + *output_pointer++ = ','; + } + + if (output_buffer->format) + { + *output_pointer++ = '\n'; + } + *output_pointer = '\0'; + output_buffer->offset += length; + + current_item = current_item->next; + } + + output_pointer = ensure(output_buffer, output_buffer->format ? (output_buffer->depth + 1) : 2); + if (output_pointer == NULL) + { + return false; + } + if (output_buffer->format) + { + size_t i; + for (i = 0; i < (output_buffer->depth - 1); i++) + { + *output_pointer++ = '\t'; + } + } + *output_pointer++ = '}'; + *output_pointer = '\0'; + output_buffer->depth--; + + return true; +} + +/* Get Array size/item / object item. */ +CJSON_PUBLIC(int) cJSON_GetArraySize(const cJSON *array) +{ + cJSON *child = NULL; + size_t size = 0; + + if (array == NULL) + { + return 0; + } + + child = array->child; + + while(child != NULL) + { + size++; + child = child->next; + } + + /* FIXME: Can overflow here. Cannot be fixed without breaking the API */ + + return (int)size; +} + +static cJSON* get_array_item(const cJSON *array, size_t index) +{ + cJSON *current_child = NULL; + + if (array == NULL) + { + return NULL; + } + + current_child = array->child; + while ((current_child != NULL) && (index > 0)) + { + index--; + current_child = current_child->next; + } + + return current_child; +} + +CJSON_PUBLIC(cJSON *) cJSON_GetArrayItem(const cJSON *array, int index) +{ + if (index < 0) + { + return NULL; + } + + return get_array_item(array, (size_t)index); +} + +static cJSON *get_object_item(const cJSON * const object, const char * const name, const cJSON_bool case_sensitive) +{ + cJSON *current_element = NULL; + + if ((object == NULL) || (name == NULL)) + { + return NULL; + } + + current_element = object->child; + if (case_sensitive) + { + while ((current_element != NULL) && (current_element->string != NULL) && (strcmp(name, current_element->string) != 0)) + { + current_element = current_element->next; + } + } + else + { + while ((current_element != NULL) && (case_insensitive_strcmp((const unsigned char*)name, (const unsigned char*)(current_element->string)) != 0)) + { + current_element = current_element->next; + } + } + + if ((current_element == NULL) || (current_element->string == NULL)) { + return NULL; + } + + return current_element; +} + +CJSON_PUBLIC(cJSON *) cJSON_GetObjectItem(const cJSON * const object, const char * const string) +{ + return get_object_item(object, string, false); +} + +CJSON_PUBLIC(cJSON *) cJSON_GetObjectItemCaseSensitive(const cJSON * const object, const char * const string) +{ + return get_object_item(object, string, true); +} + +CJSON_PUBLIC(cJSON_bool) cJSON_HasObjectItem(const cJSON *object, const char *string) +{ + return cJSON_GetObjectItem(object, string) ? 1 : 0; +} + +/* Utility for array list handling. */ +static void suffix_object(cJSON *prev, cJSON *item) +{ + prev->next = item; + item->prev = prev; +} + +/* Utility for handling references. */ +static cJSON *create_reference(const cJSON *item, const internal_hooks * const hooks) +{ + cJSON *reference = NULL; + if (item == NULL) + { + return NULL; + } + + reference = cJSON_New_Item(hooks); + if (reference == NULL) + { + return NULL; + } + + memcpy(reference, item, sizeof(cJSON)); + reference->string = NULL; + reference->type |= cJSON_IsReference; + reference->next = reference->prev = NULL; + return reference; +} + +static cJSON_bool add_item_to_array(cJSON *array, cJSON *item) +{ + cJSON *child = NULL; + + if ((item == NULL) || (array == NULL) || (array == item)) + { + return false; + } + + child = array->child; + /* + * To find the last item in array quickly, we use prev in array + */ + if (child == NULL) + { + /* list is empty, start new one */ + array->child = item; + item->prev = item; + item->next = NULL; + } + else + { + /* append to the end */ + if (child->prev) + { + suffix_object(child->prev, item); + array->child->prev = item; + } + } + + return true; +} + +/* Add item to array/object. */ +CJSON_PUBLIC(cJSON_bool) cJSON_AddItemToArray(cJSON *array, cJSON *item) +{ + return add_item_to_array(array, item); +} + +#if defined(__clang__) || (defined(__GNUC__) && ((__GNUC__ > 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ > 5)))) + #pragma GCC diagnostic push +#endif +#ifdef __GNUC__ +#pragma GCC diagnostic ignored "-Wcast-qual" +#endif +/* helper function to cast away const */ +static void* cast_away_const(const void* string) +{ + return (void*)string; +} +#if defined(__clang__) || (defined(__GNUC__) && ((__GNUC__ > 4) || ((__GNUC__ == 4) && (__GNUC_MINOR__ > 5)))) + #pragma GCC diagnostic pop +#endif + + +static cJSON_bool add_item_to_object(cJSON * const object, const char * const string, cJSON * const item, const internal_hooks * const hooks, const cJSON_bool constant_key) +{ + char *new_key = NULL; + int new_type = cJSON_Invalid; + + if ((object == NULL) || (string == NULL) || (item == NULL) || (object == item)) + { + return false; + } + + if (constant_key) + { + new_key = (char*)cast_away_const(string); + new_type = item->type | cJSON_StringIsConst; + } + else + { + new_key = (char*)cJSON_strdup((const unsigned char*)string, hooks); + if (new_key == NULL) + { + return false; + } + + new_type = item->type & ~cJSON_StringIsConst; + } + + if (!(item->type & cJSON_StringIsConst) && (item->string != NULL)) + { + hooks->deallocate(item->string); + } + + item->string = new_key; + item->type = new_type; + + return add_item_to_array(object, item); +} + +CJSON_PUBLIC(cJSON_bool) cJSON_AddItemToObject(cJSON *object, const char *string, cJSON *item) +{ + return add_item_to_object(object, string, item, &global_hooks, false); +} + +/* Add an item to an object with constant string as key */ +CJSON_PUBLIC(cJSON_bool) cJSON_AddItemToObjectCS(cJSON *object, const char *string, cJSON *item) +{ + return add_item_to_object(object, string, item, &global_hooks, true); +} + +CJSON_PUBLIC(cJSON_bool) cJSON_AddItemReferenceToArray(cJSON *array, cJSON *item) +{ + if (array == NULL) + { + return false; + } + + return add_item_to_array(array, create_reference(item, &global_hooks)); +} + +CJSON_PUBLIC(cJSON_bool) cJSON_AddItemReferenceToObject(cJSON *object, const char *string, cJSON *item) +{ + if ((object == NULL) || (string == NULL)) + { + return false; + } + + return add_item_to_object(object, string, create_reference(item, &global_hooks), &global_hooks, false); +} + +CJSON_PUBLIC(cJSON*) cJSON_AddNullToObject(cJSON * const object, const char * const name) +{ + cJSON *null = cJSON_CreateNull(); + if (add_item_to_object(object, name, null, &global_hooks, false)) + { + return null; + } + + cJSON_Delete(null); + return NULL; +} + +CJSON_PUBLIC(cJSON*) cJSON_AddTrueToObject(cJSON * const object, const char * const name) +{ + cJSON *true_item = cJSON_CreateTrue(); + if (add_item_to_object(object, name, true_item, &global_hooks, false)) + { + return true_item; + } + + cJSON_Delete(true_item); + return NULL; +} + +CJSON_PUBLIC(cJSON*) cJSON_AddFalseToObject(cJSON * const object, const char * const name) +{ + cJSON *false_item = cJSON_CreateFalse(); + if (add_item_to_object(object, name, false_item, &global_hooks, false)) + { + return false_item; + } + + cJSON_Delete(false_item); + return NULL; +} + +CJSON_PUBLIC(cJSON*) cJSON_AddBoolToObject(cJSON * const object, const char * const name, const cJSON_bool boolean) +{ + cJSON *bool_item = cJSON_CreateBool(boolean); + if (add_item_to_object(object, name, bool_item, &global_hooks, false)) + { + return bool_item; + } + + cJSON_Delete(bool_item); + return NULL; +} + +CJSON_PUBLIC(cJSON*) cJSON_AddNumberToObject(cJSON * const object, const char * const name, const double number) +{ + cJSON *number_item = cJSON_CreateNumber(number); + if (add_item_to_object(object, name, number_item, &global_hooks, false)) + { + return number_item; + } + + cJSON_Delete(number_item); + return NULL; +} + +CJSON_PUBLIC(cJSON*) cJSON_AddStringToObject(cJSON * const object, const char * const name, const char * const string) +{ + cJSON *string_item = cJSON_CreateString(string); + if (add_item_to_object(object, name, string_item, &global_hooks, false)) + { + return string_item; + } + + cJSON_Delete(string_item); + return NULL; +} + +CJSON_PUBLIC(cJSON*) cJSON_AddRawToObject(cJSON * const object, const char * const name, const char * const raw) +{ + cJSON *raw_item = cJSON_CreateRaw(raw); + if (add_item_to_object(object, name, raw_item, &global_hooks, false)) + { + return raw_item; + } + + cJSON_Delete(raw_item); + return NULL; +} + +CJSON_PUBLIC(cJSON*) cJSON_AddObjectToObject(cJSON * const object, const char * const name) +{ + cJSON *object_item = cJSON_CreateObject(); + if (add_item_to_object(object, name, object_item, &global_hooks, false)) + { + return object_item; + } + + cJSON_Delete(object_item); + return NULL; +} + +CJSON_PUBLIC(cJSON*) cJSON_AddArrayToObject(cJSON * const object, const char * const name) +{ + cJSON *array = cJSON_CreateArray(); + if (add_item_to_object(object, name, array, &global_hooks, false)) + { + return array; + } + + cJSON_Delete(array); + return NULL; +} + +CJSON_PUBLIC(cJSON *) cJSON_DetachItemViaPointer(cJSON *parent, cJSON * const item) +{ + if ((parent == NULL) || (item == NULL)) + { + return NULL; + } + + if (item != parent->child) + { + /* not the first element */ + item->prev->next = item->next; + } + if (item->next != NULL) + { + /* not the last element */ + item->next->prev = item->prev; + } + + if (item == parent->child) + { + /* first element */ + parent->child = item->next; + } + else if (item->next == NULL) + { + /* last element */ + parent->child->prev = item->prev; + } + + /* make sure the detached item doesn't point anywhere anymore */ + item->prev = NULL; + item->next = NULL; + + return item; +} + +CJSON_PUBLIC(cJSON *) cJSON_DetachItemFromArray(cJSON *array, int which) +{ + if (which < 0) + { + return NULL; + } + + return cJSON_DetachItemViaPointer(array, get_array_item(array, (size_t)which)); +} + +CJSON_PUBLIC(void) cJSON_DeleteItemFromArray(cJSON *array, int which) +{ + cJSON_Delete(cJSON_DetachItemFromArray(array, which)); +} + +CJSON_PUBLIC(cJSON *) cJSON_DetachItemFromObject(cJSON *object, const char *string) +{ + cJSON *to_detach = cJSON_GetObjectItem(object, string); + + return cJSON_DetachItemViaPointer(object, to_detach); +} + +CJSON_PUBLIC(cJSON *) cJSON_DetachItemFromObjectCaseSensitive(cJSON *object, const char *string) +{ + cJSON *to_detach = cJSON_GetObjectItemCaseSensitive(object, string); + + return cJSON_DetachItemViaPointer(object, to_detach); +} + +CJSON_PUBLIC(void) cJSON_DeleteItemFromObject(cJSON *object, const char *string) +{ + cJSON_Delete(cJSON_DetachItemFromObject(object, string)); +} + +CJSON_PUBLIC(void) cJSON_DeleteItemFromObjectCaseSensitive(cJSON *object, const char *string) +{ + cJSON_Delete(cJSON_DetachItemFromObjectCaseSensitive(object, string)); +} + +/* Replace array/object items with new ones. */ +CJSON_PUBLIC(cJSON_bool) cJSON_InsertItemInArray(cJSON *array, int which, cJSON *newitem) +{ + cJSON *after_inserted = NULL; + + if (which < 0) + { + return false; + } + + after_inserted = get_array_item(array, (size_t)which); + if (after_inserted == NULL) + { + return add_item_to_array(array, newitem); + } + + newitem->next = after_inserted; + newitem->prev = after_inserted->prev; + after_inserted->prev = newitem; + if (after_inserted == array->child) + { + array->child = newitem; + } + else + { + newitem->prev->next = newitem; + } + return true; +} + +CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemViaPointer(cJSON * const parent, cJSON * const item, cJSON * replacement) +{ + if ((parent == NULL) || (parent->child == NULL) || (replacement == NULL) || (item == NULL)) + { + return false; + } + + if (replacement == item) + { + return true; + } + + replacement->next = item->next; + replacement->prev = item->prev; + + if (replacement->next != NULL) + { + replacement->next->prev = replacement; + } + if (parent->child == item) + { + if (parent->child->prev == parent->child) + { + replacement->prev = replacement; + } + parent->child = replacement; + } + else + { /* + * To find the last item in array quickly, we use prev in array. + * We can't modify the last item's next pointer where this item was the parent's child + */ + if (replacement->prev != NULL) + { + replacement->prev->next = replacement; + } + if (replacement->next == NULL) + { + parent->child->prev = replacement; + } + } + + item->next = NULL; + item->prev = NULL; + cJSON_Delete(item); + + return true; +} + +CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemInArray(cJSON *array, int which, cJSON *newitem) +{ + if (which < 0) + { + return false; + } + + return cJSON_ReplaceItemViaPointer(array, get_array_item(array, (size_t)which), newitem); +} + +static cJSON_bool replace_item_in_object(cJSON *object, const char *string, cJSON *replacement, cJSON_bool case_sensitive) +{ + if ((replacement == NULL) || (string == NULL)) + { + return false; + } + + /* replace the name in the replacement */ + if (!(replacement->type & cJSON_StringIsConst) && (replacement->string != NULL)) + { + cJSON_free(replacement->string); + } + replacement->string = (char*)cJSON_strdup((const unsigned char*)string, &global_hooks); + if (replacement->string == NULL) + { + return false; + } + + replacement->type &= ~cJSON_StringIsConst; + + return cJSON_ReplaceItemViaPointer(object, get_object_item(object, string, case_sensitive), replacement); +} + +CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemInObject(cJSON *object, const char *string, cJSON *newitem) +{ + return replace_item_in_object(object, string, newitem, false); +} + +CJSON_PUBLIC(cJSON_bool) cJSON_ReplaceItemInObjectCaseSensitive(cJSON *object, const char *string, cJSON *newitem) +{ + return replace_item_in_object(object, string, newitem, true); +} + +/* Create basic types: */ +CJSON_PUBLIC(cJSON *) cJSON_CreateNull(void) +{ + cJSON *item = cJSON_New_Item(&global_hooks); + if(item) + { + item->type = cJSON_NULL; + } + + return item; +} + +CJSON_PUBLIC(cJSON *) cJSON_CreateTrue(void) +{ + cJSON *item = cJSON_New_Item(&global_hooks); + if(item) + { + item->type = cJSON_True; + } + + return item; +} + +CJSON_PUBLIC(cJSON *) cJSON_CreateFalse(void) +{ + cJSON *item = cJSON_New_Item(&global_hooks); + if(item) + { + item->type = cJSON_False; + } + + return item; +} + +CJSON_PUBLIC(cJSON *) cJSON_CreateBool(cJSON_bool boolean) +{ + cJSON *item = cJSON_New_Item(&global_hooks); + if(item) + { + item->type = boolean ? cJSON_True : cJSON_False; + } + + return item; +} + +CJSON_PUBLIC(cJSON *) cJSON_CreateNumber(double num) +{ + cJSON *item = cJSON_New_Item(&global_hooks); + if(item) + { + item->type = cJSON_Number; + item->valuedouble = num; + + /* use saturation in case of overflow */ + if (num >= INT_MAX) + { + item->valueint = INT_MAX; + } + else if (num <= (double)INT_MIN) + { + item->valueint = INT_MIN; + } + else + { + item->valueint = (int)num; + } + } + + return item; +} + +CJSON_PUBLIC(cJSON *) cJSON_CreateString(const char *string) +{ + cJSON *item = cJSON_New_Item(&global_hooks); + if(item) + { + item->type = cJSON_String; + item->valuestring = (char*)cJSON_strdup((const unsigned char*)string, &global_hooks); + if(!item->valuestring) + { + cJSON_Delete(item); + return NULL; + } + } + + return item; +} + +CJSON_PUBLIC(cJSON *) cJSON_CreateStringReference(const char *string) +{ + cJSON *item = cJSON_New_Item(&global_hooks); + if (item != NULL) + { + item->type = cJSON_String | cJSON_IsReference; + item->valuestring = (char*)cast_away_const(string); + } + + return item; +} + +CJSON_PUBLIC(cJSON *) cJSON_CreateObjectReference(const cJSON *child) +{ + cJSON *item = cJSON_New_Item(&global_hooks); + if (item != NULL) { + item->type = cJSON_Object | cJSON_IsReference; + item->child = (cJSON*)cast_away_const(child); + } + + return item; +} + +CJSON_PUBLIC(cJSON *) cJSON_CreateArrayReference(const cJSON *child) { + cJSON *item = cJSON_New_Item(&global_hooks); + if (item != NULL) { + item->type = cJSON_Array | cJSON_IsReference; + item->child = (cJSON*)cast_away_const(child); + } + + return item; +} + +CJSON_PUBLIC(cJSON *) cJSON_CreateRaw(const char *raw) +{ + cJSON *item = cJSON_New_Item(&global_hooks); + if(item) + { + item->type = cJSON_Raw; + item->valuestring = (char*)cJSON_strdup((const unsigned char*)raw, &global_hooks); + if(!item->valuestring) + { + cJSON_Delete(item); + return NULL; + } + } + + return item; +} + +CJSON_PUBLIC(cJSON *) cJSON_CreateArray(void) +{ + cJSON *item = cJSON_New_Item(&global_hooks); + if(item) + { + item->type=cJSON_Array; + } + + return item; +} + +CJSON_PUBLIC(cJSON *) cJSON_CreateObject(void) +{ + cJSON *item = cJSON_New_Item(&global_hooks); + if (item) + { + item->type = cJSON_Object; + } + + return item; +} + +/* Create Arrays: */ +CJSON_PUBLIC(cJSON *) cJSON_CreateIntArray(const int *numbers, int count) +{ + size_t i = 0; + cJSON *n = NULL; + cJSON *p = NULL; + cJSON *a = NULL; + + if ((count < 0) || (numbers == NULL)) + { + return NULL; + } + + a = cJSON_CreateArray(); + + for(i = 0; a && (i < (size_t)count); i++) + { + n = cJSON_CreateNumber(numbers[i]); + if (!n) + { + cJSON_Delete(a); + return NULL; + } + if(!i) + { + a->child = n; + } + else + { + suffix_object(p, n); + } + p = n; + } + + if (a && a->child) { + a->child->prev = n; + } + + return a; +} + +CJSON_PUBLIC(cJSON *) cJSON_CreateFloatArray(const float *numbers, int count) +{ + size_t i = 0; + cJSON *n = NULL; + cJSON *p = NULL; + cJSON *a = NULL; + + if ((count < 0) || (numbers == NULL)) + { + return NULL; + } + + a = cJSON_CreateArray(); + + for(i = 0; a && (i < (size_t)count); i++) + { + n = cJSON_CreateNumber((double)numbers[i]); + if(!n) + { + cJSON_Delete(a); + return NULL; + } + if(!i) + { + a->child = n; + } + else + { + suffix_object(p, n); + } + p = n; + } + + if (a && a->child) { + a->child->prev = n; + } + + return a; +} + +CJSON_PUBLIC(cJSON *) cJSON_CreateDoubleArray(const double *numbers, int count) +{ + size_t i = 0; + cJSON *n = NULL; + cJSON *p = NULL; + cJSON *a = NULL; + + if ((count < 0) || (numbers == NULL)) + { + return NULL; + } + + a = cJSON_CreateArray(); + + for(i = 0; a && (i < (size_t)count); i++) + { + n = cJSON_CreateNumber(numbers[i]); + if(!n) + { + cJSON_Delete(a); + return NULL; + } + if(!i) + { + a->child = n; + } + else + { + suffix_object(p, n); + } + p = n; + } + + if (a && a->child) { + a->child->prev = n; + } + + return a; +} + +CJSON_PUBLIC(cJSON *) cJSON_CreateStringArray(const char *const *strings, int count) +{ + size_t i = 0; + cJSON *n = NULL; + cJSON *p = NULL; + cJSON *a = NULL; + + if ((count < 0) || (strings == NULL)) + { + return NULL; + } + + a = cJSON_CreateArray(); + + for (i = 0; a && (i < (size_t)count); i++) + { + n = cJSON_CreateString(strings[i]); + if(!n) + { + cJSON_Delete(a); + return NULL; + } + if(!i) + { + a->child = n; + } + else + { + suffix_object(p,n); + } + p = n; + } + + if (a && a->child) { + a->child->prev = n; + } + + return a; +} + +/* Duplication */ +CJSON_PUBLIC(cJSON *) cJSON_Duplicate(const cJSON *item, cJSON_bool recurse) +{ + cJSON *newitem = NULL; + cJSON *child = NULL; + cJSON *next = NULL; + cJSON *newchild = NULL; + + /* Bail on bad ptr */ + if (!item) + { + goto fail; + } + /* Create new item */ + newitem = cJSON_New_Item(&global_hooks); + if (!newitem) + { + goto fail; + } + /* Copy over all vars */ + newitem->type = item->type & (~cJSON_IsReference); + newitem->valueint = item->valueint; + newitem->valuedouble = item->valuedouble; + if (item->valuestring) + { + newitem->valuestring = (char*)cJSON_strdup((unsigned char*)item->valuestring, &global_hooks); + if (!newitem->valuestring) + { + goto fail; + } + } + if (item->string) + { + newitem->string = (item->type&cJSON_StringIsConst) ? item->string : (char*)cJSON_strdup((unsigned char*)item->string, &global_hooks); + if (!newitem->string) + { + goto fail; + } + } + /* If non-recursive, then we're done! */ + if (!recurse) + { + return newitem; + } + /* Walk the ->next chain for the child. */ + child = item->child; + while (child != NULL) + { + newchild = cJSON_Duplicate(child, true); /* Duplicate (with recurse) each item in the ->next chain */ + if (!newchild) + { + goto fail; + } + if (next != NULL) + { + /* If newitem->child already set, then crosswire ->prev and ->next and move on */ + next->next = newchild; + newchild->prev = next; + next = newchild; + } + else + { + /* Set newitem->child and move to it */ + newitem->child = newchild; + next = newchild; + } + child = child->next; + } + if (newitem && newitem->child) + { + newitem->child->prev = newchild; + } + + return newitem; + +fail: + if (newitem != NULL) + { + cJSON_Delete(newitem); + } + + return NULL; +} + +static void skip_oneline_comment(char **input) +{ + *input += static_strlen("//"); + + for (; (*input)[0] != '\0'; ++(*input)) + { + if ((*input)[0] == '\n') { + *input += static_strlen("\n"); + return; + } + } +} + +static void skip_multiline_comment(char **input) +{ + *input += static_strlen("/*"); + + for (; (*input)[0] != '\0'; ++(*input)) + { + if (((*input)[0] == '*') && ((*input)[1] == '/')) + { + *input += static_strlen("*/"); + return; + } + } +} + +static void minify_string(char **input, char **output) { + (*output)[0] = (*input)[0]; + *input += static_strlen("\""); + *output += static_strlen("\""); + + + for (; (*input)[0] != '\0'; (void)++(*input), ++(*output)) { + (*output)[0] = (*input)[0]; + + if ((*input)[0] == '\"') { + (*output)[0] = '\"'; + *input += static_strlen("\""); + *output += static_strlen("\""); + return; + } else if (((*input)[0] == '\\') && ((*input)[1] == '\"')) { + (*output)[1] = (*input)[1]; + *input += static_strlen("\""); + *output += static_strlen("\""); + } + } +} + +CJSON_PUBLIC(void) cJSON_Minify(char *json) +{ + char *into = json; + + if (json == NULL) + { + return; + } + + while (json[0] != '\0') + { + switch (json[0]) + { + case ' ': + case '\t': + case '\r': + case '\n': + json++; + break; + + case '/': + if (json[1] == '/') + { + skip_oneline_comment(&json); + } + else if (json[1] == '*') + { + skip_multiline_comment(&json); + } else { + json++; + } + break; + + case '\"': + minify_string(&json, (char**)&into); + break; + + default: + into[0] = json[0]; + json++; + into++; + } + } + + /* and null-terminate. */ + *into = '\0'; +} + +CJSON_PUBLIC(cJSON_bool) cJSON_IsInvalid(const cJSON * const item) +{ + if (item == NULL) + { + return false; + } + + return (item->type & 0xFF) == cJSON_Invalid; +} + +CJSON_PUBLIC(cJSON_bool) cJSON_IsFalse(const cJSON * const item) +{ + if (item == NULL) + { + return false; + } + + return (item->type & 0xFF) == cJSON_False; +} + +CJSON_PUBLIC(cJSON_bool) cJSON_IsTrue(const cJSON * const item) +{ + if (item == NULL) + { + return false; + } + + return (item->type & 0xff) == cJSON_True; +} + + +CJSON_PUBLIC(cJSON_bool) cJSON_IsBool(const cJSON * const item) +{ + if (item == NULL) + { + return false; + } + + return (item->type & (cJSON_True | cJSON_False)) != 0; +} +CJSON_PUBLIC(cJSON_bool) cJSON_IsNull(const cJSON * const item) +{ + if (item == NULL) + { + return false; + } + + return (item->type & 0xFF) == cJSON_NULL; +} + +CJSON_PUBLIC(cJSON_bool) cJSON_IsNumber(const cJSON * const item) +{ + if (item == NULL) + { + return false; + } + + return (item->type & 0xFF) == cJSON_Number; +} + +CJSON_PUBLIC(cJSON_bool) cJSON_IsString(const cJSON * const item) +{ + if (item == NULL) + { + return false; + } + + return (item->type & 0xFF) == cJSON_String; +} + +CJSON_PUBLIC(cJSON_bool) cJSON_IsArray(const cJSON * const item) +{ + if (item == NULL) + { + return false; + } + + return (item->type & 0xFF) == cJSON_Array; +} + +CJSON_PUBLIC(cJSON_bool) cJSON_IsObject(const cJSON * const item) +{ + if (item == NULL) + { + return false; + } + + return (item->type & 0xFF) == cJSON_Object; +} + +CJSON_PUBLIC(cJSON_bool) cJSON_IsRaw(const cJSON * const item) +{ + if (item == NULL) + { + return false; + } + + return (item->type & 0xFF) == cJSON_Raw; +} + +CJSON_PUBLIC(cJSON_bool) cJSON_Compare(const cJSON * const a, const cJSON * const b, const cJSON_bool case_sensitive) +{ + if ((a == NULL) || (b == NULL) || ((a->type & 0xFF) != (b->type & 0xFF))) + { + return false; + } + + /* check if type is valid */ + switch (a->type & 0xFF) + { + case cJSON_False: + case cJSON_True: + case cJSON_NULL: + case cJSON_Number: + case cJSON_String: + case cJSON_Raw: + case cJSON_Array: + case cJSON_Object: + break; + + default: + return false; + } + + /* identical objects are equal */ + if (a == b) + { + return true; + } + + switch (a->type & 0xFF) + { + /* in these cases and equal type is enough */ + case cJSON_False: + case cJSON_True: + case cJSON_NULL: + return true; + + case cJSON_Number: + if (compare_double(a->valuedouble, b->valuedouble)) + { + return true; + } + return false; + + case cJSON_String: + case cJSON_Raw: + if ((a->valuestring == NULL) || (b->valuestring == NULL)) + { + return false; + } + if (strcmp(a->valuestring, b->valuestring) == 0) + { + return true; + } + + return false; + + case cJSON_Array: + { + cJSON *a_element = a->child; + cJSON *b_element = b->child; + + for (; (a_element != NULL) && (b_element != NULL);) + { + if (!cJSON_Compare(a_element, b_element, case_sensitive)) + { + return false; + } + + a_element = a_element->next; + b_element = b_element->next; + } + + /* one of the arrays is longer than the other */ + if (a_element != b_element) { + return false; + } + + return true; + } + + case cJSON_Object: + { + cJSON *a_element = NULL; + cJSON *b_element = NULL; + cJSON_ArrayForEach(a_element, a) + { + /* TODO This has O(n^2) runtime, which is horrible! */ + b_element = get_object_item(b, a_element->string, case_sensitive); + if (b_element == NULL) + { + return false; + } + + if (!cJSON_Compare(a_element, b_element, case_sensitive)) + { + return false; + } + } + + /* doing this twice, once on a and b to prevent true comparison if a subset of b + * TODO: Do this the proper way, this is just a fix for now */ + cJSON_ArrayForEach(b_element, b) + { + a_element = get_object_item(a, b_element->string, case_sensitive); + if (a_element == NULL) + { + return false; + } + + if (!cJSON_Compare(b_element, a_element, case_sensitive)) + { + return false; + } + } + + return true; + } + + default: + return false; + } +} + +CJSON_PUBLIC(void *) cJSON_malloc(size_t size) +{ + return global_hooks.allocate(size); +} + +CJSON_PUBLIC(void) cJSON_free(void *object) +{ + global_hooks.deallocate(object); +} diff --git a/src/cjson/cJSON.h b/src/cjson/cJSON.h new file mode 100644 index 00000000..2628d763 --- /dev/null +++ b/src/cjson/cJSON.h @@ -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 16 + +#include + +/* 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 diff --git a/src/platform/main.c b/src/platform/main.c index 17407d85..66193141 100644 --- a/src/platform/main.c +++ b/src/platform/main.c @@ -102,12 +102,11 @@ int main(int argc, char *argv[]) rogue.nextGame = NG_NOTHING; rogue.nextGamePath[0] = '\0'; rogue.nextGameSeed = 0; - rogue.wizard = false; - rogue.displayStealthRangeMode = false; - rogue.trueColorMode = false; - enum graphicsModes initialGraphics = TEXT_GRAPHICS; + enum graphicsModes initialGraphics; + readFromConfig(&rogue, &initialGraphics); + int i; for (i = 1; i < argc; i++) { if (strcmp(argv[i], "--scores") == 0) { From 775644d7507fd42df4a8029ae1a3d16f0d8fd14c Mon Sep 17 00:00:00 2001 From: esbudylin Date: Mon, 11 Dec 2023 13:25:36 +0400 Subject: [PATCH 02/18] writing into config --- src/brogue/Config.c | 66 +++++++++++++++++++++++++++++++++++++++++++++ src/brogue/Rogue.h | 5 ++-- src/platform/main.c | 1 + 3 files changed, 70 insertions(+), 2 deletions(-) diff --git a/src/brogue/Config.c b/src/brogue/Config.c index 21be9d98..3278a2c1 100644 --- a/src/brogue/Config.c +++ b/src/brogue/Config.c @@ -155,6 +155,46 @@ void parseConfigValues(const char* jsonString, configParams* config) { cJSON_Delete(root); } +char* createJsonString(configParams* config) { + cJSON* root = cJSON_CreateObject(); + + configEntry* entries = getFieldEntries(config); + + for (int i = 0; entries[i].fieldName; i++) { + switch (entries[i].fieldType) { + case INT_TYPE: { + short short_value = *((short*)entries[i].fieldPointer); + cJSON_AddNumberToObject(root, entries[i].fieldName, short_value); + break; + } + case BOOLEAN_TYPE: { + boolean bool_value = *((boolean*)entries[i].fieldPointer); + cJSON_AddBoolToObject(root, entries[i].fieldName, bool_value); + break; + } + case GAME_VARIANT: + case GRAPHICS_MODE: + { + short enum_value = *((short*)entries[i].fieldPointer); + const char* string_value = entries[i].stringMapping[enum_value]; + cJSON_AddStringToObject(root, entries[i].fieldName, string_value); + break; + } + + default: + break; + } + + } + + char* jsonString = cJSON_Print(root); + + free(entries); + cJSON_Delete(root); + + return jsonString; +} + void readFromConfig(playerCharacter* rogue, enum graphicsModes* initialGraphics) { char* jsonString = loadConfigFile(); @@ -173,3 +213,29 @@ void readFromConfig(playerCharacter* rogue, enum graphicsModes* initialGraphics) free(jsonString); } + +void writeIntoConfig() { + configParams config; + + FILE* file = fopen(JSON_FILENAME, "w"); + + if (!file) { + return; + } + + config.wizard = rogue.wizard; + config.easyMode = rogue.easyMode; + config.displayStealthRangeMode = rogue.displayStealthRangeMode; + config.trueColorMode = rogue.trueColorMode; + config.playbackDelayPerTurn = rogue.playbackDelayPerTurn; + + config.gameVariant = gameVariant; + config.graphicsMode = graphicsMode; + + char* jsonString = createJsonString(&config); + + fprintf(file, "%s", jsonString); + + fclose(file); + free(jsonString); +} \ No newline at end of file diff --git a/src/brogue/Rogue.h b/src/brogue/Rogue.h index 0ff78fad..32aaefc7 100644 --- a/src/brogue/Rogue.h +++ b/src/brogue/Rogue.h @@ -3455,8 +3455,9 @@ extern "C" { void dijkstraScan(short **distanceMap, short **costMap, boolean useDiagonals); - void readFromConfig(playerCharacter* rogue, short* initialGraphics); - + void readFromConfig(playerCharacter* rogue, enum graphicsModes* initialGraphics); + void writeIntoConfig(); + #if defined __cplusplus } #endif diff --git a/src/platform/main.c b/src/platform/main.c index 66193141..e6228501 100644 --- a/src/platform/main.c +++ b/src/platform/main.c @@ -106,6 +106,7 @@ int main(int argc, char *argv[]) enum graphicsModes initialGraphics; readFromConfig(&rogue, &initialGraphics); + atexit(writeIntoConfig); int i; for (i = 1; i < argc; i++) { From 23106f41d53168300e6bd02ea998d2c7b4ff3c52 Mon Sep 17 00:00:00 2001 From: esbudylin Date: Mon, 11 Dec 2023 13:43:44 +0400 Subject: [PATCH 03/18] static declaration for local functions --- src/brogue/Config.c | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/brogue/Config.c b/src/brogue/Config.c index 3278a2c1..8b9cff6c 100644 --- a/src/brogue/Config.c +++ b/src/brogue/Config.c @@ -41,7 +41,7 @@ const char* graphicsModeMappings[] = { NULL }; -configParams createDefaultConfig() { +static configParams createDefaultConfig() { configParams config; config.playbackDelayPerTurn = DEFAULT_PLAYBACK_DELAY; @@ -55,7 +55,7 @@ configParams createDefaultConfig() { return config; } -char* loadConfigFile() { +static char* loadConfigFile() { FILE* jsonFile = fopen(JSON_FILENAME, "r"); if (!jsonFile) { @@ -81,7 +81,7 @@ char* loadConfigFile() { return buffer; } -configEntry* getFieldEntries(configParams* config) { +static configEntry* getFieldEntries(configParams* config) { int numFields = 7; configEntry* entries = calloc(numFields + 1, sizeof(configEntry)); @@ -98,7 +98,7 @@ configEntry* getFieldEntries(configParams* config) { return entries; } -short mapStringToEnum(const char* inputString, const char** mappings) { +static short mapStringToEnum(const char* inputString, const char** mappings) { for (short i = 0; mappings[i]; i++) { if (strcmp(inputString, mappings[i]) == 0) { return i; @@ -107,7 +107,7 @@ short mapStringToEnum(const char* inputString, const char** mappings) { return -1; } -void parseConfigValues(const char* jsonString, configParams* config) { +static void parseConfigValues(const char* jsonString, configParams* config) { if (!jsonString || !config) { return; // Invalid input } @@ -155,7 +155,7 @@ void parseConfigValues(const char* jsonString, configParams* config) { cJSON_Delete(root); } -char* createJsonString(configParams* config) { +static char* createJsonString(configParams* config) { cJSON* root = cJSON_CreateObject(); configEntry* entries = getFieldEntries(config); From 670ea64be55575e5460dc6c5e02d93a56dfdf303 Mon Sep 17 00:00:00 2001 From: esbudylin Date: Mon, 11 Dec 2023 14:02:27 +0400 Subject: [PATCH 04/18] makefile: cJSON added to sources --- Makefile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 59e786f2..e8c19ec7 100644 --- a/Makefile +++ b/Makefile @@ -1,12 +1,12 @@ include config.mk -cflags := -Isrc/brogue -Isrc/platform -Isrc/variants -std=c99 \ +cflags := -Isrc/brogue -Isrc/platform -Isrc/variants -Isrc/cjson -std=c99 \ -Wall -Wpedantic -Werror=implicit -Wno-parentheses -Wno-unused-result \ -Wformat -Werror=format-security -Wformat-overflow=0 -Wmissing-prototypes libs := -lm cppflags := -DDATADIR=$(DATADIR) -sources := $(wildcard src/brogue/*.c) $(wildcard src/variants/*.c) $(addprefix src/platform/,main.c platformdependent.c null-platform.c) +sources := $(wildcard src/brogue/*.c) $(wildcard src/cjson/*.c) $(wildcard src/variants/*.c) $(addprefix src/platform/,main.c platformdependent.c null-platform.c) objects := ifeq ($(SYSTEM),WINDOWS) From b5c9093f9fc44b41dab47d11005a71e5d24e53a0 Mon Sep 17 00:00:00 2001 From: esbudylin Date: Mon, 11 Dec 2023 14:06:42 +0400 Subject: [PATCH 05/18] no need to pass a global variable by a pointer --- src/brogue/Config.c | 12 ++++++------ src/brogue/Rogue.h | 2 +- src/platform/main.c | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/brogue/Config.c b/src/brogue/Config.c index 8b9cff6c..84156109 100644 --- a/src/brogue/Config.c +++ b/src/brogue/Config.c @@ -195,18 +195,18 @@ static char* createJsonString(configParams* config) { return jsonString; } -void readFromConfig(playerCharacter* rogue, enum graphicsModes* initialGraphics) { +void readFromConfig(enum graphicsModes* initialGraphics) { char* jsonString = loadConfigFile(); configParams config = createDefaultConfig(); parseConfigValues(jsonString, &config); - rogue->wizard = config.wizard; - rogue->easyMode = config.easyMode; - rogue->displayStealthRangeMode = config.displayStealthRangeMode; - rogue->trueColorMode = config.trueColorMode; - rogue->playbackDelayPerTurn = config.playbackDelayPerTurn; + rogue.wizard = config.wizard; + rogue.easyMode = config.easyMode; + rogue.displayStealthRangeMode = config.displayStealthRangeMode; + rogue.trueColorMode = config.trueColorMode; + rogue.playbackDelayPerTurn = config.playbackDelayPerTurn; gameVariant = config.gameVariant; *initialGraphics = config.graphicsMode; diff --git a/src/brogue/Rogue.h b/src/brogue/Rogue.h index 32aaefc7..9475f4cd 100644 --- a/src/brogue/Rogue.h +++ b/src/brogue/Rogue.h @@ -3455,7 +3455,7 @@ extern "C" { void dijkstraScan(short **distanceMap, short **costMap, boolean useDiagonals); - void readFromConfig(playerCharacter* rogue, enum graphicsModes* initialGraphics); + void readFromConfig(enum graphicsModes* initialGraphics); void writeIntoConfig(); #if defined __cplusplus diff --git a/src/platform/main.c b/src/platform/main.c index e6228501..e2af7f3d 100644 --- a/src/platform/main.c +++ b/src/platform/main.c @@ -105,7 +105,7 @@ int main(int argc, char *argv[]) enum graphicsModes initialGraphics; - readFromConfig(&rogue, &initialGraphics); + readFromConfig(&initialGraphics); atexit(writeIntoConfig); int i; From b405c98edbb11e083c9e0a213f4b02744773b463 Mon Sep 17 00:00:00 2001 From: esbudylin Date: Mon, 11 Dec 2023 14:18:33 +0400 Subject: [PATCH 06/18] correct function prototype --- src/brogue/Rogue.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/brogue/Rogue.h b/src/brogue/Rogue.h index 9475f4cd..4c9655e8 100644 --- a/src/brogue/Rogue.h +++ b/src/brogue/Rogue.h @@ -3456,7 +3456,7 @@ extern "C" { void dijkstraScan(short **distanceMap, short **costMap, boolean useDiagonals); void readFromConfig(enum graphicsModes* initialGraphics); - void writeIntoConfig(); + void writeIntoConfig(void); #if defined __cplusplus } From 3880110240c0392f57aa470af938bc0470aae58a Mon Sep 17 00:00:00 2001 From: esbudylin Date: Mon, 11 Dec 2023 17:11:40 +0400 Subject: [PATCH 07/18] checking for a type correctness of JSON input --- src/brogue/Config.c | 31 +++++++++++++++++++------------ 1 file changed, 19 insertions(+), 12 deletions(-) diff --git a/src/brogue/Config.c b/src/brogue/Config.c index 84156109..8136b160 100644 --- a/src/brogue/Config.c +++ b/src/brogue/Config.c @@ -126,24 +126,31 @@ static void parseConfigValues(const char* jsonString, configParams* config) { if (jsonField) { switch (entries[i].fieldType) { case INT_TYPE: - *((short*)entries[i].fieldPointer) = jsonField->valueint; - break; + if (cJSON_IsNumber(jsonField)) + { + *((short*)entries[i].fieldPointer) = jsonField->valueint; + break; + } case BOOLEAN_TYPE: - *((boolean*)entries[i].fieldPointer) = jsonField->valueint; - break; + if (cJSON_IsBool(jsonField)) + { + *((boolean*)entries[i].fieldPointer) = jsonField->valueint; + break; + } case GAME_VARIANT: case GRAPHICS_MODE: - { - const char* modeString = jsonField->valuestring; - short mode = mapStringToEnum(modeString, entries[i].stringMapping); - - if (mode != -1) { - *((short*)entries[i].fieldPointer) = mode; + if (cJSON_IsString(jsonField)) + { + const char* modeString = jsonField->valuestring; + short mode = mapStringToEnum(modeString, entries[i].stringMapping); + + if (mode != -1) { + *((short*)entries[i].fieldPointer) = mode; + } + break; } - break; - } default: break; From fa158d42dacdf9171f2e37171e7934b56b8589ed Mon Sep 17 00:00:00 2001 From: esbudylin Date: Tue, 12 Dec 2023 23:16:27 +0400 Subject: [PATCH 08/18] correct saving of a Playback Delay param In the previous version, the Playback Delay was being set to zero after the start of a game session --- src/brogue/Config.c | 13 +++++++++++-- src/brogue/GlobalsBase.h | 3 ++- src/brogue/Recordings.c | 1 + 3 files changed, 14 insertions(+), 3 deletions(-) diff --git a/src/brogue/Config.c b/src/brogue/Config.c index 8136b160..e9d52c71 100644 --- a/src/brogue/Config.c +++ b/src/brogue/Config.c @@ -2,6 +2,8 @@ #include "Rogue.h" #include "GlobalsBase.h" +short loadedPlaybackDelay; // base playback speed as loaded from the config file + const char* JSON_FILENAME = "brogue_config.json"; typedef struct configParams { @@ -213,7 +215,7 @@ void readFromConfig(enum graphicsModes* initialGraphics) { rogue.easyMode = config.easyMode; rogue.displayStealthRangeMode = config.displayStealthRangeMode; rogue.trueColorMode = config.trueColorMode; - rogue.playbackDelayPerTurn = config.playbackDelayPerTurn; + loadedPlaybackDelay = config.playbackDelayPerTurn; gameVariant = config.gameVariant; *initialGraphics = config.graphicsMode; @@ -234,7 +236,14 @@ void writeIntoConfig() { config.easyMode = rogue.easyMode; config.displayStealthRangeMode = rogue.displayStealthRangeMode; config.trueColorMode = rogue.trueColorMode; - config.playbackDelayPerTurn = rogue.playbackDelayPerTurn; + + if (rogue.playbackDelayPerTurn) + { + config.playbackDelayPerTurn = rogue.playbackDelayPerTurn; + } + else { + config.playbackDelayPerTurn = loadedPlaybackDelay; + } config.gameVariant = gameVariant; config.graphicsMode = graphicsMode; diff --git a/src/brogue/GlobalsBase.h b/src/brogue/GlobalsBase.h index aef1f8b0..cc25e639 100644 --- a/src/brogue/GlobalsBase.h +++ b/src/brogue/GlobalsBase.h @@ -66,6 +66,7 @@ extern item *floorItems; extern item *packItems; extern item *monsterItemsHopper; extern short numberOfWaypoints; +extern short loadedPlaybackDelay; extern char displayedMessage[MESSAGE_LINES][COLS*2]; extern short messagesUnconfirmed; @@ -132,4 +133,4 @@ extern const windowpos WINDOW_POSITION_DUNGEON_TOP_LEFT; #define CHARM_EFFECT_DURATION_INCREMENT_ARRAY_SIZE 50 extern const fixpt POW_0_CHARM_INCREMENT[]; extern const fixpt POW_120_CHARM_INCREMENT[]; -extern const fixpt POW_125_CHARM_INCREMENT[]; +extern const fixpt POW_125_CHARM_INCREMENT[]; \ No newline at end of file diff --git a/src/brogue/Recordings.c b/src/brogue/Recordings.c index 1272671b..b8e2dbdd 100644 --- a/src/brogue/Recordings.c +++ b/src/brogue/Recordings.c @@ -494,6 +494,7 @@ void initRecording() { if (rogue.playbackMode) { lengthOfPlaybackFile = 100000; // so recall functions don't freak out + rogue.playbackDelayPerTurn = loadedPlaybackDelay; rogue.playbackDelayThisTurn = rogue.playbackDelayPerTurn; rogue.playbackPaused = false; From d585aa11b63c9b169ac5ccae7c0e413576ba17b1 Mon Sep 17 00:00:00 2001 From: esbudylin Date: Wed, 20 Dec 2023 12:52:35 +0400 Subject: [PATCH 09/18] refactoring created a separate fieldType for json string that needs to be mapped to an Enum --- src/brogue/Config.c | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/src/brogue/Config.c b/src/brogue/Config.c index e9d52c71..d446f667 100644 --- a/src/brogue/Config.c +++ b/src/brogue/Config.c @@ -19,8 +19,7 @@ typedef struct configParams { typedef enum { INT_TYPE, BOOLEAN_TYPE, - GAME_VARIANT, - GRAPHICS_MODE, + ENUM_STRING // a json string that needs to be mapped to an Enum } fieldType; typedef struct { @@ -30,13 +29,13 @@ typedef struct { const char** stringMapping; } configEntry; -const char* variantMappings[] = { +const char* variantMappings[] = { // maps json strings to the gameVariant Enum "brogue", "rapid", NULL }; -const char* graphicsModeMappings[] = { +const char* graphicsModeMappings[] = { // maps json strings to the graphicsModes Enum "text", "tiles", "hybrid", @@ -88,8 +87,8 @@ static configEntry* getFieldEntries(configParams* config) { configEntry* entries = calloc(numFields + 1, sizeof(configEntry)); - entries[0] = (configEntry){ "gameVariant", &(config->gameVariant), GAME_VARIANT, variantMappings }; - entries[1] = (configEntry){ "graphicsMode", &(config->graphicsMode), GRAPHICS_MODE, graphicsModeMappings }; + entries[0] = (configEntry){ "gameVariant", &(config->gameVariant), ENUM_STRING, variantMappings }; + entries[1] = (configEntry){ "graphicsMode", &(config->graphicsMode), ENUM_STRING, graphicsModeMappings }; entries[2] = (configEntry){ "playbackDelayPerTurn", &(config->playbackDelayPerTurn), INT_TYPE }; entries[3] = (configEntry){ "displayStealthRangeMode", &(config->displayStealthRangeMode), BOOLEAN_TYPE }; entries[4] = (configEntry){ "trueColorMode", &(config->trueColorMode), BOOLEAN_TYPE }; @@ -141,8 +140,7 @@ static void parseConfigValues(const char* jsonString, configParams* config) { break; } - case GAME_VARIANT: - case GRAPHICS_MODE: + case ENUM_STRING: if (cJSON_IsString(jsonField)) { const char* modeString = jsonField->valuestring; @@ -181,8 +179,7 @@ static char* createJsonString(configParams* config) { cJSON_AddBoolToObject(root, entries[i].fieldName, bool_value); break; } - case GAME_VARIANT: - case GRAPHICS_MODE: + case ENUM_STRING: { short enum_value = *((short*)entries[i].fieldPointer); const char* string_value = entries[i].stringMapping[enum_value]; From d07763b43bc543c360bd52e4bb7b3e8a33f4e8d8 Mon Sep 17 00:00:00 2001 From: esbudylin Date: Sat, 23 Dec 2023 15:44:41 +0400 Subject: [PATCH 10/18] Update Config.c: formatting --- src/brogue/Config.c | 122 ++++++++++++++++++++------------------------ 1 file changed, 54 insertions(+), 68 deletions(-) diff --git a/src/brogue/Config.c b/src/brogue/Config.c index d446f667..3952e92f 100644 --- a/src/brogue/Config.c +++ b/src/brogue/Config.c @@ -29,18 +29,11 @@ typedef struct { const char** stringMapping; } configEntry; -const char* variantMappings[] = { // maps json strings to the gameVariant Enum - "brogue", - "rapid", - NULL -}; - -const char* graphicsModeMappings[] = { // maps json strings to the graphicsModes Enum - "text", - "tiles", - "hybrid", - NULL -}; +// maps json strings to the gameVariant Enum +const char* variantMappings[] = {"brogue", "rapid", NULL}; + +// maps json strings to the graphicsModes Enum +const char* graphicsModeMappings[] = {"text", "tiles", "hybrid", NULL}; static configParams createDefaultConfig() { configParams config; @@ -87,14 +80,14 @@ static configEntry* getFieldEntries(configParams* config) { configEntry* entries = calloc(numFields + 1, sizeof(configEntry)); - entries[0] = (configEntry){ "gameVariant", &(config->gameVariant), ENUM_STRING, variantMappings }; - entries[1] = (configEntry){ "graphicsMode", &(config->graphicsMode), ENUM_STRING, graphicsModeMappings }; - entries[2] = (configEntry){ "playbackDelayPerTurn", &(config->playbackDelayPerTurn), INT_TYPE }; - entries[3] = (configEntry){ "displayStealthRangeMode", &(config->displayStealthRangeMode), BOOLEAN_TYPE }; - entries[4] = (configEntry){ "trueColorMode", &(config->trueColorMode), BOOLEAN_TYPE }; - entries[5] = (configEntry){ "wizard", &(config->wizard), BOOLEAN_TYPE }; - entries[6] = (configEntry){ "easyMode", &(config->easyMode), BOOLEAN_TYPE }; - entries[numFields] = (configEntry){ NULL }; + entries[0] = (configEntry){"gameVariant", &(config->gameVariant), ENUM_STRING, variantMappings}; + entries[1] = (configEntry){"graphicsMode", &(config->graphicsMode), ENUM_STRING, graphicsModeMappings}; + entries[2] = (configEntry){"playbackDelayPerTurn", &(config->playbackDelayPerTurn), INT_TYPE}; + entries[3] = (configEntry){"displayStealthRangeMode", &(config->displayStealthRangeMode), BOOLEAN_TYPE}; + entries[4] = (configEntry){"trueColorMode", &(config->trueColorMode), BOOLEAN_TYPE}; + entries[5] = (configEntry){"wizard", &(config->wizard), BOOLEAN_TYPE}; + entries[6] = (configEntry){"easyMode", &(config->easyMode), BOOLEAN_TYPE}; + entries[numFields] = (configEntry){NULL}; return entries; } @@ -126,34 +119,31 @@ static void parseConfigValues(const char* jsonString, configParams* config) { if (jsonField) { switch (entries[i].fieldType) { - case INT_TYPE: - if (cJSON_IsNumber(jsonField)) - { - *((short*)entries[i].fieldPointer) = jsonField->valueint; - break; - } - - case BOOLEAN_TYPE: - if (cJSON_IsBool(jsonField)) - { - *((boolean*)entries[i].fieldPointer) = jsonField->valueint; - break; - } + case INT_TYPE: + if (cJSON_IsNumber(jsonField)) { + *((short*)entries[i].fieldPointer) = jsonField->valueint; + break; + } + + case BOOLEAN_TYPE: + if (cJSON_IsBool(jsonField)) { + *((boolean*)entries[i].fieldPointer) = jsonField->valueint; + break; + } - case ENUM_STRING: - if (cJSON_IsString(jsonField)) - { - const char* modeString = jsonField->valuestring; - short mode = mapStringToEnum(modeString, entries[i].stringMapping); + case ENUM_STRING: + if (cJSON_IsString(jsonField)) { + const char* modeString = jsonField->valuestring; + short mode = mapStringToEnum(modeString, entries[i].stringMapping); - if (mode != -1) { - *((short*)entries[i].fieldPointer) = mode; - } - break; + if (mode != -1) { + *((short*)entries[i].fieldPointer) = mode; } - - default: break; + } + + default: + break; } } } @@ -169,28 +159,26 @@ static char* createJsonString(configParams* config) { for (int i = 0; entries[i].fieldName; i++) { switch (entries[i].fieldType) { - case INT_TYPE: { - short short_value = *((short*)entries[i].fieldPointer); - cJSON_AddNumberToObject(root, entries[i].fieldName, short_value); - break; - } - case BOOLEAN_TYPE: { - boolean bool_value = *((boolean*)entries[i].fieldPointer); - cJSON_AddBoolToObject(root, entries[i].fieldName, bool_value); - break; - } - case ENUM_STRING: - { - short enum_value = *((short*)entries[i].fieldPointer); - const char* string_value = entries[i].stringMapping[enum_value]; - cJSON_AddStringToObject(root, entries[i].fieldName, string_value); - break; - } - - default: - break; + case INT_TYPE: { + short short_value = *((short*)entries[i].fieldPointer); + cJSON_AddNumberToObject(root, entries[i].fieldName, short_value); + break; + } + case BOOLEAN_TYPE: { + boolean bool_value = *((boolean*)entries[i].fieldPointer); + cJSON_AddBoolToObject(root, entries[i].fieldName, bool_value); + break; + } + case ENUM_STRING: { + short enum_value = *((short*)entries[i].fieldPointer); + const char* string_value = entries[i].stringMapping[enum_value]; + cJSON_AddStringToObject(root, entries[i].fieldName, string_value); + break; } + default: + break; + } } char* jsonString = cJSON_Print(root); @@ -234,11 +222,9 @@ void writeIntoConfig() { config.displayStealthRangeMode = rogue.displayStealthRangeMode; config.trueColorMode = rogue.trueColorMode; - if (rogue.playbackDelayPerTurn) - { + if (rogue.playbackDelayPerTurn) { config.playbackDelayPerTurn = rogue.playbackDelayPerTurn; - } - else { + } else { config.playbackDelayPerTurn = loadedPlaybackDelay; } From a5e84eff9792a0d5044d74df3de4214a216f9936 Mon Sep 17 00:00:00 2001 From: esbudylin Date: Sat, 23 Dec 2023 18:15:03 +0400 Subject: [PATCH 11/18] min and max values for playbackDelaySpeed are separated into constants --- src/brogue/Recordings.c | 4 ++-- src/brogue/Rogue.h | 4 ++++ 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/src/brogue/Recordings.c b/src/brogue/Recordings.c index b8e2dbdd..39924716 100644 --- a/src/brogue/Recordings.c +++ b/src/brogue/Recordings.c @@ -879,7 +879,7 @@ boolean executePlaybackInput(rogueEvent *recordingInput) { switch (key) { case UP_ARROW: case UP_KEY: - newDelay = max(1, min(rogue.playbackDelayPerTurn * 2/3, rogue.playbackDelayPerTurn - 1)); + newDelay = max(MIN_PLAYBACK_DELAY, min(rogue.playbackDelayPerTurn * 2/3, rogue.playbackDelayPerTurn - 1)); if (newDelay != rogue.playbackDelayPerTurn) { flashTemporaryAlert(" Faster ", 300); } @@ -888,7 +888,7 @@ boolean executePlaybackInput(rogueEvent *recordingInput) { return true; case DOWN_ARROW: case DOWN_KEY: - newDelay = min(3000, max(rogue.playbackDelayPerTurn * 3/2, rogue.playbackDelayPerTurn + 1)); + newDelay = min(MAX_PLAYBACK_DELAY, max(rogue.playbackDelayPerTurn * 3/2, rogue.playbackDelayPerTurn + 1)); if (newDelay != rogue.playbackDelayPerTurn) { flashTemporaryAlert(" Slower ", 300); } diff --git a/src/brogue/Rogue.h b/src/brogue/Rogue.h index 4c9655e8..e2268731 100644 --- a/src/brogue/Rogue.h +++ b/src/brogue/Rogue.h @@ -194,6 +194,10 @@ typedef struct windowpos { #define COLOR_ESCAPE 25 #define COLOR_VALUE_INTERCEPT 25 +#define MIN_PLAYBACK_DELAY 1 +#define MAX_PLAYBACK_DELAY 3000 + + // variants supported in this code base enum gameVariant { VARIANT_BROGUE, From 481401c224b49d03d7e8e20c9be042c478e1fd69 Mon Sep 17 00:00:00 2001 From: esbudylin Date: Sat, 23 Dec 2023 18:20:07 +0400 Subject: [PATCH 12/18] Config.c: validation for ints loaded from config Config loader now validates integers in the config to ensure they fall within specified min and max boundaries --- src/brogue/Config.c | 35 +++++++++++++++++++++++++++-------- 1 file changed, 27 insertions(+), 8 deletions(-) diff --git a/src/brogue/Config.c b/src/brogue/Config.c index 3952e92f..d0e02153 100644 --- a/src/brogue/Config.c +++ b/src/brogue/Config.c @@ -22,11 +22,21 @@ typedef enum { ENUM_STRING // a json string that needs to be mapped to an Enum } fieldType; +typedef struct { + int min; + int max; +} intRange; + +typedef union { + const char** stringMapping; + intRange intRange; +} fieldValidator; + typedef struct { const char* fieldName; void* fieldPointer; fieldType fieldType; - const char** stringMapping; + fieldValidator fieldValidator; } configEntry; // maps json strings to the gameVariant Enum @@ -35,6 +45,8 @@ const char* variantMappings[] = {"brogue", "rapid", NULL}; // maps json strings to the graphicsModes Enum const char* graphicsModeMappings[] = {"text", "tiles", "hybrid", NULL}; +intRange playbackDelayRange = {MIN_PLAYBACK_DELAY, MAX_PLAYBACK_DELAY}; + static configParams createDefaultConfig() { configParams config; @@ -80,9 +92,10 @@ static configEntry* getFieldEntries(configParams* config) { configEntry* entries = calloc(numFields + 1, sizeof(configEntry)); - entries[0] = (configEntry){"gameVariant", &(config->gameVariant), ENUM_STRING, variantMappings}; - entries[1] = (configEntry){"graphicsMode", &(config->graphicsMode), ENUM_STRING, graphicsModeMappings}; - entries[2] = (configEntry){"playbackDelayPerTurn", &(config->playbackDelayPerTurn), INT_TYPE}; + entries[0] = (configEntry){"gameVariant", &(config->gameVariant), ENUM_STRING, {variantMappings}}; + entries[1] = (configEntry){"graphicsMode", &(config->graphicsMode), ENUM_STRING, {graphicsModeMappings}}; + entries[2] = (configEntry){ + "playbackDelayPerTurn", &(config->playbackDelayPerTurn), INT_TYPE, {.intRange = playbackDelayRange}}; entries[3] = (configEntry){"displayStealthRangeMode", &(config->displayStealthRangeMode), BOOLEAN_TYPE}; entries[4] = (configEntry){"trueColorMode", &(config->trueColorMode), BOOLEAN_TYPE}; entries[5] = (configEntry){"wizard", &(config->wizard), BOOLEAN_TYPE}; @@ -121,10 +134,16 @@ static void parseConfigValues(const char* jsonString, configParams* config) { switch (entries[i].fieldType) { case INT_TYPE: if (cJSON_IsNumber(jsonField)) { - *((short*)entries[i].fieldPointer) = jsonField->valueint; + short value = jsonField->valueint; + intRange valueRange = entries[i].fieldValidator.intRange; + + if (value >= valueRange.min && value <= valueRange.max) { + *((short*)entries[i].fieldPointer) = value; + } + break; } - + case BOOLEAN_TYPE: if (cJSON_IsBool(jsonField)) { *((boolean*)entries[i].fieldPointer) = jsonField->valueint; @@ -134,7 +153,7 @@ static void parseConfigValues(const char* jsonString, configParams* config) { case ENUM_STRING: if (cJSON_IsString(jsonField)) { const char* modeString = jsonField->valuestring; - short mode = mapStringToEnum(modeString, entries[i].stringMapping); + short mode = mapStringToEnum(modeString, entries[i].fieldValidator.stringMapping); if (mode != -1) { *((short*)entries[i].fieldPointer) = mode; @@ -171,7 +190,7 @@ static char* createJsonString(configParams* config) { } case ENUM_STRING: { short enum_value = *((short*)entries[i].fieldPointer); - const char* string_value = entries[i].stringMapping[enum_value]; + const char* string_value = entries[i].fieldValidator.stringMapping[enum_value]; cJSON_AddStringToObject(root, entries[i].fieldName, string_value); break; } From 68ed92cc319e17dc183d5a7f5d0de56b1069174b Mon Sep 17 00:00:00 2001 From: esbudylin Date: Sat, 23 Dec 2023 19:14:40 +0400 Subject: [PATCH 13/18] Config.c: minor refactoring --- src/brogue/Config.c | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/src/brogue/Config.c b/src/brogue/Config.c index d0e02153..28faaa2a 100644 --- a/src/brogue/Config.c +++ b/src/brogue/Config.c @@ -28,7 +28,7 @@ typedef struct { } intRange; typedef union { - const char** stringMapping; + const char** enumMappings; intRange intRange; } fieldValidator; @@ -90,17 +90,21 @@ static char* loadConfigFile() { static configEntry* getFieldEntries(configParams* config) { int numFields = 7; + configEntry fieldDescriptors[] = { + {"gameVariant", &(config->gameVariant), ENUM_STRING, {.enumMappings = variantMappings}}, + {"graphicsMode", &(config->graphicsMode), ENUM_STRING, {.enumMappings = graphicsModeMappings}}, + {"playbackDelayPerTurn", &(config->playbackDelayPerTurn), INT_TYPE, {.intRange = playbackDelayRange}}, + {"displayStealthRangeMode", &(config->displayStealthRangeMode), BOOLEAN_TYPE}, + {"trueColorMode", &(config->trueColorMode), BOOLEAN_TYPE}, + {"wizard", &(config->wizard), BOOLEAN_TYPE}, + {"easyMode", &(config->easyMode), BOOLEAN_TYPE}, + {NULL}}; + configEntry* entries = calloc(numFields + 1, sizeof(configEntry)); - entries[0] = (configEntry){"gameVariant", &(config->gameVariant), ENUM_STRING, {variantMappings}}; - entries[1] = (configEntry){"graphicsMode", &(config->graphicsMode), ENUM_STRING, {graphicsModeMappings}}; - entries[2] = (configEntry){ - "playbackDelayPerTurn", &(config->playbackDelayPerTurn), INT_TYPE, {.intRange = playbackDelayRange}}; - entries[3] = (configEntry){"displayStealthRangeMode", &(config->displayStealthRangeMode), BOOLEAN_TYPE}; - entries[4] = (configEntry){"trueColorMode", &(config->trueColorMode), BOOLEAN_TYPE}; - entries[5] = (configEntry){"wizard", &(config->wizard), BOOLEAN_TYPE}; - entries[6] = (configEntry){"easyMode", &(config->easyMode), BOOLEAN_TYPE}; - entries[numFields] = (configEntry){NULL}; + for (int i = 0; i < numFields; i++) { + entries[i] = fieldDescriptors[i]; + } return entries; } @@ -153,7 +157,7 @@ static void parseConfigValues(const char* jsonString, configParams* config) { case ENUM_STRING: if (cJSON_IsString(jsonField)) { const char* modeString = jsonField->valuestring; - short mode = mapStringToEnum(modeString, entries[i].fieldValidator.stringMapping); + short mode = mapStringToEnum(modeString, entries[i].fieldValidator.enumMappings); if (mode != -1) { *((short*)entries[i].fieldPointer) = mode; @@ -190,7 +194,7 @@ static char* createJsonString(configParams* config) { } case ENUM_STRING: { short enum_value = *((short*)entries[i].fieldPointer); - const char* string_value = entries[i].fieldValidator.stringMapping[enum_value]; + const char* string_value = entries[i].fieldValidator.enumMappings[enum_value]; cJSON_AddStringToObject(root, entries[i].fieldName, string_value); break; } From 65ff74af13587159a02d5fd5af8bef2626481b57 Mon Sep 17 00:00:00 2001 From: esbudylin Date: Sat, 23 Dec 2023 19:30:22 +0400 Subject: [PATCH 14/18] Config.c: correct placement of break statements --- src/brogue/Config.c | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/src/brogue/Config.c b/src/brogue/Config.c index 28faaa2a..6f0b28b8 100644 --- a/src/brogue/Config.c +++ b/src/brogue/Config.c @@ -144,15 +144,14 @@ static void parseConfigValues(const char* jsonString, configParams* config) { if (value >= valueRange.min && value <= valueRange.max) { *((short*)entries[i].fieldPointer) = value; } - - break; } + break; case BOOLEAN_TYPE: if (cJSON_IsBool(jsonField)) { *((boolean*)entries[i].fieldPointer) = jsonField->valueint; - break; } + break; case ENUM_STRING: if (cJSON_IsString(jsonField)) { @@ -162,8 +161,8 @@ static void parseConfigValues(const char* jsonString, configParams* config) { if (mode != -1) { *((short*)entries[i].fieldPointer) = mode; } - break; } + break; default: break; From 2df2f4b1fe2d49220ea554f354a3291d1011ac75 Mon Sep 17 00:00:00 2001 From: esbudylin Date: Sat, 23 Dec 2023 21:11:46 +0400 Subject: [PATCH 15/18] Config.c: refactoring --- src/brogue/Config.c | 54 ++++++++++++++++++++++----------------------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/src/brogue/Config.c b/src/brogue/Config.c index 6f0b28b8..0895e7a0 100644 --- a/src/brogue/Config.c +++ b/src/brogue/Config.c @@ -33,11 +33,11 @@ typedef union { } fieldValidator; typedef struct { - const char* fieldName; - void* fieldPointer; - fieldType fieldType; - fieldValidator fieldValidator; -} configEntry; + const char* name; + void* paramPointer; // a pointer to a field of configParams struct + fieldType type; + fieldValidator validator; +} configField; // maps json strings to the gameVariant Enum const char* variantMappings[] = {"brogue", "rapid", NULL}; @@ -87,10 +87,10 @@ static char* loadConfigFile() { return buffer; } -static configEntry* getFieldEntries(configParams* config) { +static configField* getFieldEntries(configParams* config) { int numFields = 7; - configEntry fieldDescriptors[] = { + configField fieldDescriptors[] = { {"gameVariant", &(config->gameVariant), ENUM_STRING, {.enumMappings = variantMappings}}, {"graphicsMode", &(config->graphicsMode), ENUM_STRING, {.enumMappings = graphicsModeMappings}}, {"playbackDelayPerTurn", &(config->playbackDelayPerTurn), INT_TYPE, {.intRange = playbackDelayRange}}, @@ -100,7 +100,7 @@ static configEntry* getFieldEntries(configParams* config) { {"easyMode", &(config->easyMode), BOOLEAN_TYPE}, {NULL}}; - configEntry* entries = calloc(numFields + 1, sizeof(configEntry)); + configField* entries = calloc(numFields + 1, sizeof(configField)); for (int i = 0; i < numFields; i++) { entries[i] = fieldDescriptors[i]; @@ -129,37 +129,37 @@ static void parseConfigValues(const char* jsonString, configParams* config) { return; // JSON parsing error } - configEntry* entries = getFieldEntries(config); + configField* entries = getFieldEntries(config); - for (int i = 0; entries[i].fieldName; i++) { - cJSON* jsonField = cJSON_GetObjectItem(root, entries[i].fieldName); + for (int i = 0; entries[i].name; i++) { + cJSON* jsonField = cJSON_GetObjectItem(root, entries[i].name); if (jsonField) { - switch (entries[i].fieldType) { + switch (entries[i].type) { case INT_TYPE: if (cJSON_IsNumber(jsonField)) { short value = jsonField->valueint; - intRange valueRange = entries[i].fieldValidator.intRange; + intRange valueRange = entries[i].validator.intRange; if (value >= valueRange.min && value <= valueRange.max) { - *((short*)entries[i].fieldPointer) = value; + *((short*)entries[i].paramPointer) = value; } } break; case BOOLEAN_TYPE: if (cJSON_IsBool(jsonField)) { - *((boolean*)entries[i].fieldPointer) = jsonField->valueint; + *((boolean*)entries[i].paramPointer) = jsonField->valueint; } break; case ENUM_STRING: if (cJSON_IsString(jsonField)) { const char* modeString = jsonField->valuestring; - short mode = mapStringToEnum(modeString, entries[i].fieldValidator.enumMappings); + short mode = mapStringToEnum(modeString, entries[i].validator.enumMappings); if (mode != -1) { - *((short*)entries[i].fieldPointer) = mode; + *((short*)entries[i].paramPointer) = mode; } } break; @@ -177,24 +177,24 @@ static void parseConfigValues(const char* jsonString, configParams* config) { static char* createJsonString(configParams* config) { cJSON* root = cJSON_CreateObject(); - configEntry* entries = getFieldEntries(config); + configField* entries = getFieldEntries(config); - for (int i = 0; entries[i].fieldName; i++) { - switch (entries[i].fieldType) { + for (int i = 0; entries[i].name; i++) { + switch (entries[i].type) { case INT_TYPE: { - short short_value = *((short*)entries[i].fieldPointer); - cJSON_AddNumberToObject(root, entries[i].fieldName, short_value); + short short_value = *((short*)entries[i].paramPointer); + cJSON_AddNumberToObject(root, entries[i].name, short_value); break; } case BOOLEAN_TYPE: { - boolean bool_value = *((boolean*)entries[i].fieldPointer); - cJSON_AddBoolToObject(root, entries[i].fieldName, bool_value); + boolean bool_value = *((boolean*)entries[i].paramPointer); + cJSON_AddBoolToObject(root, entries[i].name, bool_value); break; } case ENUM_STRING: { - short enum_value = *((short*)entries[i].fieldPointer); - const char* string_value = entries[i].fieldValidator.enumMappings[enum_value]; - cJSON_AddStringToObject(root, entries[i].fieldName, string_value); + short enum_value = *((short*)entries[i].paramPointer); + const char* string_value = entries[i].validator.enumMappings[enum_value]; + cJSON_AddStringToObject(root, entries[i].name, string_value); break; } From 16b6bc7663f0f74da166bafd1607c58a2385db5e Mon Sep 17 00:00:00 2001 From: esbudylin Date: Sun, 24 Dec 2023 16:56:09 +0400 Subject: [PATCH 16/18] playbackDelayPerTurn handling changed The value of rogue.playbackDelayPerTurn is preserved from the purging of 'rogue' fields in the initializeRogue functions. That allows to store playbackDelayPerTurn value loaded from a config directly in 'rogue' global variable instead of creating a separate one. --- src/brogue/Config.c | 11 ++--------- src/brogue/GlobalsBase.h | 3 +-- src/brogue/Recordings.c | 1 - src/brogue/RogueMain.c | 4 +++- 4 files changed, 6 insertions(+), 13 deletions(-) diff --git a/src/brogue/Config.c b/src/brogue/Config.c index 0895e7a0..fbea20df 100644 --- a/src/brogue/Config.c +++ b/src/brogue/Config.c @@ -2,8 +2,6 @@ #include "Rogue.h" #include "GlobalsBase.h" -short loadedPlaybackDelay; // base playback speed as loaded from the config file - const char* JSON_FILENAME = "brogue_config.json"; typedef struct configParams { @@ -222,7 +220,7 @@ void readFromConfig(enum graphicsModes* initialGraphics) { rogue.easyMode = config.easyMode; rogue.displayStealthRangeMode = config.displayStealthRangeMode; rogue.trueColorMode = config.trueColorMode; - loadedPlaybackDelay = config.playbackDelayPerTurn; + rogue.playbackDelayPerTurn = config.playbackDelayPerTurn; gameVariant = config.gameVariant; *initialGraphics = config.graphicsMode; @@ -243,12 +241,7 @@ void writeIntoConfig() { config.easyMode = rogue.easyMode; config.displayStealthRangeMode = rogue.displayStealthRangeMode; config.trueColorMode = rogue.trueColorMode; - - if (rogue.playbackDelayPerTurn) { - config.playbackDelayPerTurn = rogue.playbackDelayPerTurn; - } else { - config.playbackDelayPerTurn = loadedPlaybackDelay; - } + config.playbackDelayPerTurn = rogue.playbackDelayPerTurn; config.gameVariant = gameVariant; config.graphicsMode = graphicsMode; diff --git a/src/brogue/GlobalsBase.h b/src/brogue/GlobalsBase.h index cc25e639..aef1f8b0 100644 --- a/src/brogue/GlobalsBase.h +++ b/src/brogue/GlobalsBase.h @@ -66,7 +66,6 @@ extern item *floorItems; extern item *packItems; extern item *monsterItemsHopper; extern short numberOfWaypoints; -extern short loadedPlaybackDelay; extern char displayedMessage[MESSAGE_LINES][COLS*2]; extern short messagesUnconfirmed; @@ -133,4 +132,4 @@ extern const windowpos WINDOW_POSITION_DUNGEON_TOP_LEFT; #define CHARM_EFFECT_DURATION_INCREMENT_ARRAY_SIZE 50 extern const fixpt POW_0_CHARM_INCREMENT[]; extern const fixpt POW_120_CHARM_INCREMENT[]; -extern const fixpt POW_125_CHARM_INCREMENT[]; \ No newline at end of file +extern const fixpt POW_125_CHARM_INCREMENT[]; diff --git a/src/brogue/Recordings.c b/src/brogue/Recordings.c index 39924716..7a6a1d7d 100644 --- a/src/brogue/Recordings.c +++ b/src/brogue/Recordings.c @@ -494,7 +494,6 @@ void initRecording() { if (rogue.playbackMode) { lengthOfPlaybackFile = 100000; // so recall functions don't freak out - rogue.playbackDelayPerTurn = loadedPlaybackDelay; rogue.playbackDelayThisTurn = rogue.playbackDelayPerTurn; rogue.playbackPaused = false; diff --git a/src/brogue/RogueMain.c b/src/brogue/RogueMain.c index b3fb9fda..f720ebba 100644 --- a/src/brogue/RogueMain.c +++ b/src/brogue/RogueMain.c @@ -187,7 +187,7 @@ void initializeRogue(uint64_t seed) { item *theItem; boolean playingback, playbackFF, playbackPaused, wizard, easy, displayStealthRangeMode; boolean trueColorMode; - short oldRNG; + short oldRNG, playbackDelay; char currentGamePath[BROGUE_FILENAME_MAX]; playingback = rogue.playbackMode; // the only animals that need to go on the ark @@ -197,6 +197,7 @@ void initializeRogue(uint64_t seed) { easy = rogue.easyMode; displayStealthRangeMode = rogue.displayStealthRangeMode; trueColorMode = rogue.trueColorMode; + playbackDelay = rogue.playbackDelayPerTurn; strcpy(currentGamePath, rogue.currentGamePath); @@ -212,6 +213,7 @@ void initializeRogue(uint64_t seed) { rogue.easyMode = easy; rogue.displayStealthRangeMode = displayStealthRangeMode; rogue.trueColorMode = trueColorMode; + rogue.playbackDelayPerTurn = playbackDelay; rogue.gameHasEnded = false; rogue.gameInProgress = true; From 09933fb972a403e33d9858a9310221ad8cd5f6cf Mon Sep 17 00:00:00 2001 From: esbudylin Date: Sun, 24 Dec 2023 17:16:37 +0400 Subject: [PATCH 17/18] static declarations for local variables --- src/brogue/Config.c | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/brogue/Config.c b/src/brogue/Config.c index fbea20df..d445c39c 100644 --- a/src/brogue/Config.c +++ b/src/brogue/Config.c @@ -2,8 +2,6 @@ #include "Rogue.h" #include "GlobalsBase.h" -const char* JSON_FILENAME = "brogue_config.json"; - typedef struct configParams { short playbackDelayPerTurn; short gameVariant; @@ -37,13 +35,15 @@ typedef struct { fieldValidator validator; } configField; +static const char* JSON_FILENAME = "brogue_config.json"; + // maps json strings to the gameVariant Enum -const char* variantMappings[] = {"brogue", "rapid", NULL}; +static const char* variantMappings[] = {"brogue", "rapid", NULL}; // maps json strings to the graphicsModes Enum -const char* graphicsModeMappings[] = {"text", "tiles", "hybrid", NULL}; +static const char* graphicsModeMappings[] = {"text", "tiles", "hybrid", NULL}; -intRange playbackDelayRange = {MIN_PLAYBACK_DELAY, MAX_PLAYBACK_DELAY}; +static intRange playbackDelayRange = {MIN_PLAYBACK_DELAY, MAX_PLAYBACK_DELAY}; static configParams createDefaultConfig() { configParams config; From 379e8067f1e2ae074f0acd7403c0f10f9c01d843 Mon Sep 17 00:00:00 2001 From: esbudylin Date: Sun, 24 Dec 2023 17:25:24 +0400 Subject: [PATCH 18/18] Create saved-settings.md description of changes --- changes/saved-settings.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 changes/saved-settings.md diff --git a/changes/saved-settings.md b/changes/saved-settings.md new file mode 100644 index 00000000..625d9113 --- /dev/null +++ b/changes/saved-settings.md @@ -0,0 +1 @@ +Game settings are saved to a configuration file, persisting between game launches. The saved settings include game variant (vanilla or rapid), graphical mode, replay speed, color effects, stealth range visibility, wizard mode, and easy mode. \ No newline at end of file