json.h

Go to the documentation of this file.

// The latest version of this library is available on GitHub;
//   https://github.com/sheredom/json.h

// This is free and unencumbered software released into the public domain.
//
// Anyone is free to copy, modify, publish, use, compile, sell, or
// distribute this software, either in source code form or as a compiled
// binary, for any purpose, commercial or non-commercial, and by any
// means.
//
// In jurisdictions that recognize copyright laws, the author or authors
// of this software dedicate any and all copyright interest in the
// software to the public domain. We make this dedication for the benefit
// of the public at large and to the detriment of our heirs and
// successors. We intend this dedication to be an overt act of
// relinquishment in perpetuity of all present and future rights to this
// software under copyright law.
//
// 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 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.
//
// For more information, please refer to <http://unlicense.org/>

/* das2 developer modification note:  
 * 
 * Neil Hennings's JSON library is quite good and I can imagine many others 
 * would pick it up (I know I adopted it instead of json-c), so I've changed
 * the names of all the visible objects.  Structure names have been changed to
 * blend in with the rest of the libdas2 and functions have had their prefixes
 * changed from "json_" to "das_j".   If I could be sure that libdas2 users
 * would never need to access raw json objects, this change would not be
 * necessary.  However preventing access to the raw objects limits libdas2's
 * usefulness, hence this trivial token transformation.  Original "json.h"
 * logic has not been altered in any way, though some new functions have been
 * added at the end of the C file.
 * 
 * Thanks to Neil, for helping out space physics research.
 *   -cwp 2018-10-14
 */

#ifndef _das_json_h_
#define _das_json_h_

#if defined(_MSC_VER)
#pragma warning(push)

// disable 'bytes padding added after construct' warning
#pragma warning(disable : 4820)
#endif

#include <stddef.h>

#ifdef __cplusplus
extern "C" {
#endif
   
   
enum das_json_type_e {
  das_json_type_str,
  das_json_type_num,
  das_json_type_dict,
  das_json_type_ary,
  das_json_type_true,
  das_json_type_false,
  das_json_type_null
};

typedef struct das_json_str_s {
  const char *string;
  size_t string_size;
} das_json_str;

typedef struct das_json_str_ex_s {
  struct das_json_str_s string;

  size_t offset;

  size_t line_no;

  size_t row_no;
} das_json_str_ex;

typedef struct das_json_num_s {
  const char *number;
  size_t number_size;
} das_json_num;

typedef struct das_json_dict_el_s {
  struct das_json_str_s *name;
  struct das_json_obj_s *value;
  struct das_json_dict_el_s *next;
} das_json_dict_el;

typedef struct das_json_dict_s {
  struct das_json_dict_el_s *start;
  size_t length;
} das_json_dict;

typedef struct das_json_ary_el_s {
  struct das_json_obj_s *value;
  struct das_json_ary_el_s *next;
} das_json_ary_el;

typedef struct das_json_ary_s {
  struct das_json_ary_el_s *start;
  size_t length;
} das_json_ary;


   
typedef struct das_json_obj_s {
  void* value;
  
  size_t type;
  
} DasJdo;

typedef struct das_json_val_ex_s {
  DasJdo value;

  size_t offset;

  size_t line_no;

  size_t row_no;
} das_json_val_ex;

   

enum das_json_parse_flags_e {
  das_jparse_flags_default = 0,

  das_jparse_flags_allow_trailing_comma = 0x1,

  das_jparse_flags_allow_unquoted_keys = 0x2,

  das_jparse_flags_allow_global_object = 0x4,

  das_jparse_flags_allow_equals_in_object = 0x8,

  das_jparse_flags_allow_no_commas = 0x10,

  das_jparse_flags_allow_c_style_comments = 0x20,

  // deprecated flag, unused
  das_jparse_flags_deprecated = 0x40,

  das_jparse_flags_allow_location_information = 0x80,

  das_jparse_flags_allow_single_quoted_strings = 0x100,

  das_jparse_flags_allow_hexadecimal_numbers = 0x200,

  das_jparse_flags_allow_leading_plus_sign = 0x400,

  das_jparse_flags_allow_leading_or_trailing_decimal_point = 0x800,

  das_jparse_flags_allow_inf_and_nan = 0x1000,

  das_jparse_flags_allow_multi_line_strings = 0x2000,

  das_jparse_flags_allow_simplified_json =
      (das_jparse_flags_allow_trailing_comma |
       das_jparse_flags_allow_unquoted_keys |
       das_jparse_flags_allow_global_object |
       das_jparse_flags_allow_equals_in_object |
       das_jparse_flags_allow_no_commas),

  das_jparse_flags_allow_json5 =
      (das_jparse_flags_allow_trailing_comma |
       das_jparse_flags_allow_unquoted_keys |
       das_jparse_flags_allow_c_style_comments |
       das_jparse_flags_allow_single_quoted_strings |
       das_jparse_flags_allow_hexadecimal_numbers |
       das_jparse_flags_allow_leading_plus_sign |
       das_jparse_flags_allow_leading_or_trailing_decimal_point |
       das_jparse_flags_allow_inf_and_nan |
       das_jparse_flags_allow_multi_line_strings)
};

enum das_jparse_error_e {
  das_jparse_error_none = 0,

  das_jparse_error_expected_comma_or_closing_bracket,

  das_jparse_error_expected_colon,

  das_jparse_error_expected_opening_quote,

  das_jparse_error_invalid_string_escape_sequence,

  das_jparse_error_invalid_number_format,

  das_jparse_error_invalid_value,

  das_jparse_error_premature_end_of_buffer,

  das_jparse_error_invalid_string,

  das_jparse_error_allocator_failed,

  das_jparse_error_unexpected_trailing_characters,

  das_jparse_error_unknown
};

struct das_json_parse_result_s {
  size_t error;

  size_t error_offset;

  size_t error_line_no;

  size_t error_row_no;
};

const char* json_parse_error_info(
   const struct das_json_parse_result_s* pRes, char* sTmp, size_t uLen
);


DasJdo* das_json_parse_ex(
   const void *src, size_t src_size, size_t flags_bitset,
   void *(*alloc_func_ptr)(void *, size_t), void *user_data,
   struct das_json_parse_result_s *result
);


DasJdo* das_json_parse(const void *src, size_t src_size);


const DasJdo* DasJdo_get(const DasJdo* pThis, const char* sRelPath);

const das_json_dict_el* DasJdo_dictFirst(const DasJdo* pThis);

const das_json_ary_el* DasJdo_aryFirst(const DasJdo* pThis);



const char* DasJdo_string(const DasJdo* pThis);


const das_json_dict* DasJdo_dict(const DasJdo* pThis);



void* DasJdo_writeMinified(const DasJdo* pThis, size_t *out_size);


void* DasJdo_writePretty(const DasJdo* pThis, const char *indent,
                        const char *newline, size_t *out_size);


#ifdef __cplusplus
} // extern "C"
#endif

#if defined(_MSC_VER)
#pragma warning(pop)
#endif

#endif // _das_json_h_