jstools.h File Reference

#include "stdbool.h"
#include "stdint.h"
#include "stdio.h"

Include dependency graph for jstools.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	JST_Array
	A JSON array. More...
struct	JST_Object
	A JSON object, a sorted set of named-value pairs. More...
union	JST_Value
	A JSON Value may be an object, an array, a boolean, a number or a string. More...
struct	JST_Element_
	An element is a typed value. More...
struct	JST_ArrayItem_
	An array item has a parent and a typed value. More...
struct	JST_Pair_
	A object attribute item has a parent and is a named-typed-value pair. More...
struct	JST_SyntaxError
	Information returned by JST_load() in case of error. More...

Typedefs
typedef struct JST_Element_	JST_Element
	An element is a typed value. More...
typedef struct JST_ArrayItem_	JST_ArrayItem
	An array item has a parent and a typed value. More...
typedef struct JST_Pair_	JST_Pair
	A object attribute item has a parent and is a named-typed-value pair. More...
typedef bool(*	JST_Visitor) (const char *name, unsigned index, bool pre, const JST_Element *element, void *user_context)
	Visitor in depth first with 'pre' set to true then backtrack with 'pre' set to false. More...

Enumerations
enum	JST_ValueType {   JST_OBJECT, JST_ARRAY, JST_BOOLEAN, JST_INTEGER,   JST_DOUBLE, JST_STRING, JST_NULL }
	The JSON Value types. More...
enum	JST_Error {   JST_ERR_NONE, JST_ERR_NULL_ARGUMENT, JST_ERR_NULL_TYPE, JST_ERR_ERRNO,   JST_ERR_STRING_NOT_ENDED, JST_ERR_STRING_BAD_ESCAPE_SEQUENCE, JST_ERR_STRING_CONTROL_CHAR_MUST_BE_ESCAPED, JST_ERR_SEPARATOR_EXPECTED_AFTER_TRUE,   JST_ERR_SEPARATOR_EXPECTED_AFTER_FALSE, JST_ERR_SEPARATOR_EXPECTED_AFTER_NULL, JST_ERR_TRUE_EXPECTED, JST_ERR_FALSE_EXPECTED,   JST_ERR_NULL_EXPECTED, JST_ERR_NUMBER_EXPECTED, JST_ERR_COLON_EXPECTED, JST_ERR_UNEXPECTED_TOKEN,   JST_ERR_PATH_SYNTAX, JST_ERR_NOT_FOUND, JST_ERR_ARRAY_INDEX_OUT_OF_RANGE, JST_ERR_INTERRUPTED }
	When things goes wrong, an error information is given. More...

Functions
JST_Error	JST_load_from_file (const char *filepath, JST_Element *root, JST_SyntaxError *error)
	Reads the input file, allocates the node of the corresponding tree, than frees the input buffer. More...
JST_Error	JST_load_from_stream (FILE *stream, JST_Element *root, JST_SyntaxError *error)
	Reads the input stream, allocates the node of the corresponding tree, than frees the input buffer. More...
JST_Error	JST_save_to_stream (FILE *stream, const JST_Element *root, unsigned indent)
	Save the JSON tree to a stream, pretty-printed. More...
JST_Error	JST_save_to_file (const char *filepath, const JST_Element *root, unsigned indent)
	Save the JSON tree to a file, pretty-printed. More...
JST_Error	JST_save_to_stream_compact (FILE *stream, const JST_Element *root)
	Save the JSON tree to a stream, as a single line of text, without whitespaces. More...
JST_Error	JST_save_to_file_compact (const char *filepath, const JST_Element *root)
	Save the JSON tree to a file, as a single line of text, without whitespaces. More...
JST_Error	JST_serialize (JST_Element *root, char **dest, unsigned indent)
	Serialize the JSON tree to a string, pretty-printed. More...
JST_Error	JST_serialize_compact (JST_Element *root, char **dest)
	Serialize the JSON tree to a string as a single line of text, without whitespaces. More...
JST_Error	JST_get (const char *jsonpath, JST_Element *root, JST_Element **dest)
	Search an element by its path. More...
JST_Error	JST_add_property (JST_Object *object, unsigned index, const char *name, const JST_Element *value)
	Add a named-value pair to an object. More...
JST_Error	JST_remove_property (JST_Object *object, const char *name)
JST_Error	JST_add_item (JST_Array *array, const JST_Element *value)
JST_Error	JST_remove_item (JST_Array *array, unsigned index)
JST_Error	JST_replace_item (JST_Array *array, unsigned index, const JST_Element *value)
JST_Error	JST_walk (const JST_Element *root, JST_Visitor visitor, void *user_context)
JST_Error	JST_delete_pair (JST_Pair *element)
JST_Error	JST_delete_object (JST_Object *object)
JST_Error	JST_delete_array_item (JST_ArrayItem *array)
JST_Error	JST_delete_array (JST_Array *array)
JST_Error	JST_delete_element (JST_Element *element)

Variables
const JST_Array	JST_Array_Zero
	Constant defined to initialize safely a variable of type JST_Array. More...
const JST_Object	JST_Object_Zero
	Constant defined to initialize safely a variable of type JST_Object. More...
const JST_Value	JST_Value_Zero
	Constant defined to initialize safely a variable of type JST_Value. More...
const JST_Element	JST_Element_Zero
	Constant defined to initialize safely a variable of type JST_Element. More...
const JST_ArrayItem	JST_ArrayItem_Zero
const JST_Pair	JST_Pair_Zero
	Constant defined to initialize safely a variable of type JST_Pair. More...
const JST_SyntaxError	JST_SyntaxError_Zero
	Constant defined to initialize safely a variable of type JST_SyntaxError. More...

Typedef Documentation

JST_ArrayItem

typedef struct JST_ArrayItem_ JST_ArrayItem

An array item has a parent and a typed value.

JST_Element

typedef struct JST_Element_ JST_Element

An element is a typed value.

JST_Pair

typedef struct JST_Pair_ JST_Pair

A object attribute item has a parent and is a named-typed-value pair.

JST_Visitor

typedef bool(* JST_Visitor) (const char *name, unsigned index, bool pre, const JST_Element *element, void *user_context)

Visitor in depth first with 'pre' set to true then backtrack with 'pre' set to false.

Definition at line 134 of file jstools.h.

Enumeration Type Documentation

JST_Error

enum JST_Error

When things goes wrong, an error information is given.

Enumerator
JST_ERR_NONE	All correct
JST_ERR_NULL_ARGUMENT	Function misused.
JST_ERR_NULL_TYPE	A type field has been set to JST_NONE.
JST_ERR_ERRNO	strerror() or perror() can be used to show the operating system layer error
JST_ERR_STRING_NOT_ENDED	ending quote has not been found
JST_ERR_STRING_BAD_ESCAPE_SEQUENCE	only ", \, /, b, f, n, r, t, u may be escaped
JST_ERR_STRING_CONTROL_CHAR_MUST_BE_ESCAPED	a control character has been found, it must be escaped
JST_ERR_SEPARATOR_EXPECTED_AFTER_TRUE	syntax error or 'true'
JST_ERR_SEPARATOR_EXPECTED_AFTER_FALSE	syntax error or 'false'
JST_ERR_SEPARATOR_EXPECTED_AFTER_NULL	syntax error or 'null'
JST_ERR_TRUE_EXPECTED	'true' token was expected
JST_ERR_FALSE_EXPECTED	'false' token was expected
JST_ERR_NULL_EXPECTED	'null' token was expected
JST_ERR_NUMBER_EXPECTED	token is not a number
JST_ERR_COLON_EXPECTED	token is not a colon
JST_ERR_UNEXPECTED_TOKEN	unexpected token
JST_ERR_PATH_SYNTAX	Path syntax is (<name>|[<integer>])(.<name>|[<integer>])*.
JST_ERR_NOT_FOUND	JST_get() has no result.
JST_ERR_ARRAY_INDEX_OUT_OF_RANGE	index is out of range
JST_ERR_INTERRUPTED	JST_Visitor has returned false to interrupt the tree's iteration.

Definition at line 108 of file jstools.h.

             {
   JST_ERR_NONE,                                
   JST_ERR_NULL_ARGUMENT,                       
   JST_ERR_NULL_TYPE,                           
   JST_ERR_ERRNO,                               
   JST_ERR_STRING_NOT_ENDED,                    
   JST_ERR_STRING_BAD_ESCAPE_SEQUENCE,          
   JST_ERR_STRING_CONTROL_CHAR_MUST_BE_ESCAPED, 
   JST_ERR_SEPARATOR_EXPECTED_AFTER_TRUE,       
   JST_ERR_SEPARATOR_EXPECTED_AFTER_FALSE,      
   JST_ERR_SEPARATOR_EXPECTED_AFTER_NULL,       
   JST_ERR_TRUE_EXPECTED,                       
   JST_ERR_FALSE_EXPECTED,                      
   JST_ERR_NULL_EXPECTED,                       
   JST_ERR_NUMBER_EXPECTED,                     
   JST_ERR_COLON_EXPECTED,                      
   JST_ERR_UNEXPECTED_TOKEN,                    
   JST_ERR_PATH_SYNTAX,                         
   JST_ERR_NOT_FOUND,                           
   JST_ERR_ARRAY_INDEX_OUT_OF_RANGE,            
   JST_ERR_INTERRUPTED,                         
} JST_Error;

JST_ValueType

enum JST_ValueType

The JSON Value types.

Enumerator
JST_OBJECT
JST_ARRAY
JST_BOOLEAN
JST_INTEGER
JST_DOUBLE
JST_STRING
JST_NULL

Definition at line 57 of file jstools.h.

             {
   JST_OBJECT,
   JST_ARRAY,
   JST_BOOLEAN,
   JST_INTEGER,
   JST_DOUBLE,
   JST_STRING,
   JST_NULL,
} JST_ValueType;

Function Documentation

JST_add_item()

JST_Error JST_add_item	(	JST_Array *	array,
		const JST_Element *	value
	)

Definition at line 89 of file JST_update.c.

                                                                       {
   JST_ArrayItem * item = calloc( 1, sizeof( JST_ArrayItem ));
   if( ! item ) {
      return JST_ERR_ERRNO;
   }
   item->parent = array;
   JST_Error error = element_copy( &(item->element), value );
   if( error == JST_ERR_NONE ) {
      ++(array->count);
      array->items = realloc( array->items, array->count * sizeof( JST_ArrayItem * ));
      if( array->items == NULL ) {
         array->count = 0;
         error = JST_ERR_ERRNO;
      }
      else {
         array->items[array->count-1] = item;
      }
   }
   if( error != JST_ERR_NONE ) {
      JST_delete_element( &(item->element));
      free( item );
   }
   return error;
}

JST_add_property()

JST_Error JST_add_property	(	JST_Object *	object,
		unsigned	index,
		const char *	name,
		const JST_Element *	value
	)

Add a named-value pair to an object.

Parameters

object	the target object to modify
index	the property's rank, -1U to add at the end
name	the property's name
value	the property's value

Returns

JST_ERR_NONE on success, JST_ERR_NULL_TYPE or JST_ERR_ERRNO on failure.

Definition at line 60 of file JST_update.c.

                                                                                                                {
   (void)index;
   JST_Pair * item = calloc( 1, sizeof( JST_Pair ));
   if( ! item ) {
      return JST_ERR_ERRNO;
   }
   item->name   = strdup( name );
   item->parent = object;
   JST_Error error = element_copy( &(item->element), value );
   if( error == JST_ERR_NONE ) {
      ++(object->count);
      object->items = realloc( object->items, object->count * sizeof( JST_Pair * ));
      if( object->items == NULL ) {
         object->count = 0;
         error = JST_ERR_ERRNO;
      }
      else {
         object->items[object->count-1] = item;
         qsort( object->items, object->count, sizeof( JST_Pair *), JST_pairs_compare );
      }
   }
   if( error != JST_ERR_NONE ) {
      JST_delete_element( &(item->element));
      free( item->name );
      free( item );
   }
   return error;
}

JST_delete_array()

JST_Error JST_delete_array

(

JST_Array *

array

)

Definition at line 40 of file JST_delete.c.

                                                {
   if( array == NULL ) {
      return JST_ERR_NULL_ARGUMENT;
   }
   JST_Error error = JST_ERR_NONE;
   for( unsigned i = 0; ( error == JST_ERR_NONE )&&( i < array->count ); ++i ) {
      error = JST_delete_array_item( array->items[i] );
   }
   free( array->items );
   array->parent = NULL;
   array->count  = 0;
   array->items  = NULL;
   return error;
}

Here is the call graph for this function:

Here is the caller graph for this function:

JST_delete_array_item()

JST_Error JST_delete_array_item

(

JST_ArrayItem *

array

)

Definition at line 31 of file JST_delete.c.

                                                        {
   if( item == NULL ) {
      return JST_ERR_NULL_ARGUMENT;
   }
   JST_Error error = JST_delete_element( &(item->element));
   free( item );
   return error;
}

Here is the call graph for this function:

Here is the caller graph for this function:

JST_delete_element()

JST_Error JST_delete_element

(

JST_Element *

element

)

Definition at line 55 of file JST_delete.c.

                                                      {
   if( element == NULL ) {
      return JST_ERR_NULL_ARGUMENT;
   }
   switch( element->type ) {
   case JST_OBJECT: JST_delete_object( &(element->value.object)); break;
   case JST_ARRAY : JST_delete_array( &(element->value.array)); break;
   case JST_STRING: free( element->value.string ); break;
   default: break;
   }
   element->type         = JST_NULL;
   element->value.string = NULL;
   return JST_ERR_NONE;
}

Here is the call graph for this function:

Here is the caller graph for this function:

JST_delete_object()

JST_Error JST_delete_object

(

JST_Object *

object

)

Definition at line 15 of file JST_delete.c.

                                                   {
   if( object == NULL ) {
      return JST_ERR_NULL_ARGUMENT;
   }
   JST_Error error = JST_ERR_NONE;
   for( unsigned i = 0; ( error == JST_ERR_NONE )&&( i < object->count ); ++i ) {
      error = JST_delete_pair( object->items[i] );
   }
   free( object->items );
   object->parent = NULL;
   object->count  = 0;
   object->first  = NULL;
   object->items  = NULL;
   return error;
}

Here is the call graph for this function:

Here is the caller graph for this function:

JST_delete_pair()

JST_Error JST_delete_pair

(

JST_Pair *

element

)

Definition at line 5 of file JST_delete.c.

                                             {
   if( pair == NULL ) {
      return JST_ERR_NULL_ARGUMENT;
   }
   JST_Error error = JST_delete_element( &(pair->element));
   free( pair->name );
   free( pair );
   return error;
}

Here is the call graph for this function:

Here is the caller graph for this function:

JST_get()

JST_Error JST_get	(	const char *	jsonpath,
		JST_Element *	root,
		JST_Element **	dest
	)

Search an element by its path.

Parameters

jsonpath	syntax is (<name>|[<integer>])(.<name>|[<integer>])*
element	the root of the search
dest	an address of a pointer to the element found

Returns

an error status, JST_ERR_NOT_FOUND when jsonpath doesn't match.

Definition at line 10 of file JST_get.c.

                                                                                    {
   if(( root == NULL )||( jsonpath == NULL )||( dest == NULL )) {
      return JST_ERR_NULL_ARGUMENT;
   }
   char * tokenized = strdup( jsonpath );
   if( tokenized == NULL ) {
      return JST_ERR_ERRNO;
   }
   char * token = strtok( tokenized, STRTOK_PATH );
   if( token == NULL ) {
      free( tokenized );
      return JST_ERR_PATH_SYNTAX;
   }
   JST_Element * iter = root;
   while( iter && token ) {
      if( isdigit( *token )) {
         char * err;
         long unsigned index = strtoul( token, &err, 10 );
         if( err && *err ) {
            free( tokenized );
            return JST_ERR_PATH_SYNTAX;
         }
         if( iter->type !=  JST_ARRAY ) {
            free( tokenized );
            return JST_ERR_PATH_SYNTAX;
         }
         if( index >= iter->value.array.count ) {
            free( tokenized );
            return JST_ERR_NOT_FOUND;
         }
         JST_ArrayItem * item = iter->value.array.items[index];
         iter = &( item->element );
      }
      else {
         if( iter->type !=  JST_OBJECT ) {
            free( tokenized );
            return JST_ERR_PATH_SYNTAX;
         }
         JST_Pair key, *key_addr = &key;
         key.name = token;
         JST_Pair ** pair =
            bsearch( &key_addr, iter->value.object.items, iter->value.object.count, sizeof( JST_Pair * ), JST_pairs_compare );
         if( pair == NULL ) {
            free( tokenized );
            return JST_ERR_NOT_FOUND;
         }
         iter = &((*pair)->element);
      }
      token = strtok( NULL, STRTOK_PATH );
   }
   free( tokenized );
   *dest = iter;
   return JST_ERR_NONE;
}

JST_load_from_file()

JST_Error JST_load_from_file	(	const char *	filepath,
		JST_Element *	root,
		JST_SyntaxError *	error
	)

Reads the input file, allocates the node of the corresponding tree, than frees the input buffer.

Parameters

filepath	the file path
root	the root of the JSON tree
line	the last line number read, available in case of error
context	few characters before the error, available in case of error
ditsance	the offset of the error, in context

Returns

an error status.

Definition at line 573 of file JST_load.c.

                                                                                                      {
   if(( path == NULL )) {
      return JST_ERR_NULL_ARGUMENT;
   }
   FILE * stream = fopen( path, "rt" );
   if( stream == NULL ) {
      return JST_ERR_ERRNO;
   }
   JST_Error error = JST_load_from_stream( stream, root, syntax_error );
   int myerrno = errno;
   fclose( stream );
   errno = myerrno;
   return error;
}

Here is the call graph for this function:

JST_load_from_stream()

JST_Error JST_load_from_stream	(	FILE *	stream,
		JST_Element *	root,
		JST_SyntaxError *	error
	)

Reads the input stream, allocates the node of the corresponding tree, than frees the input buffer.

Parameters

stream	the character stream to read
root	the root of the JSON tree
line	the last line number read, available in case of error
context	few characters before the error, available in case of error
ditsance	the offset of the error, in context

Returns

an error status.

Definition at line 533 of file JST_load.c.

                                                                                                    {
   if( syntax_error ) {
      *syntax_error = JST_SyntaxError_Zero;
   }
   if(( stream == NULL )||( root == NULL )) {
      return JST_ERR_NULL_ARGUMENT;
   }
   *root = JST_Element_Zero;
   Context context = Context_Zero;
   Token   token   = Token_Zero;
   context.stream = stream;
   bool    ok      = true
      && get_next_token( &context, &token )
      && set_value( &context, root, NULL, &token )
      && remaining_chars_are_only_whitespaces( &context );
   if( ! ok ) {
      if( syntax_error ) {
         syntax_error->line = (unsigned)( 1 + context.line );
         size_t pos = (( context.pos < context.limit )||(context.limit == 0 )) ? context.pos : ( context.limit - 1 );
         while(( pos > 0 )
            && (( context.pos - pos ) < ( sizeof( syntax_error->context ) / 2 ))
            && ( context.buffer[pos] != '\r' )
            && ( context.buffer[pos] != '\n' ))
         {
            --pos;
         }
         if(( context.buffer[pos] == '\r' )||( context.buffer[pos] == '\n' )) {
            ++pos;
         }
         strncpy( syntax_error->context, context.buffer + pos, sizeof( syntax_error->context ) - 1 );
         syntax_error->context[sizeof( syntax_error->context )-1] = '\0';
         syntax_error->pos  = (unsigned)( context.pos - pos );
         if( syntax_error->pos > 0 ) {
            --(syntax_error->pos);
         }
      }
   }
   return context.error;
}

Here is the caller graph for this function:

JST_remove_item()

JST_Error JST_remove_item	(	JST_Array *	array,
		unsigned	index
	)

Definition at line 140 of file JST_update.c.

                                                               {
   if( array == NULL ) {
      return JST_ERR_NULL_ARGUMENT;
   }
   if( index >= array->count ) {
      return JST_ERR_ARRAY_INDEX_OUT_OF_RANGE;
   }
   JST_ArrayItem * item = array->items[index];
   memmove( array->items+index, array->items+index+1, sizeof( JST_ArrayItem * )*( array->count - index - 1 ));
   --(array->count);
   JST_delete_array_item( item );
   return JST_ERR_NONE;
}

Here is the call graph for this function:

JST_remove_property()

JST_Error JST_remove_property	(	JST_Object *	object,
		const char *	name
	)

Definition at line 124 of file JST_update.c.

                                                                        {
   if(( object == NULL )||( name == NULL )) {
      return JST_ERR_NULL_ARGUMENT;
   }
   for( unsigned i = 0; i < object->count; ++i ) {
      JST_Pair * pair = object->items[i];
      if( 0 == strcmp( pair->name, name )) {
         memmove( object->items+i, object->items+i+1, sizeof( JST_Pair * )*( object->count - i - 1 ));
         --(object->count);
         JST_delete_pair( pair );
         return JST_ERR_NONE;
      }
   }
   return JST_ERR_NOT_FOUND;
}

Here is the call graph for this function:

JST_replace_item()

JST_Error JST_replace_item	(	JST_Array *	array,
		unsigned	index,
		const JST_Element *	value
	)

Definition at line 114 of file JST_update.c.

                                                                                         {
   if(( array == NULL )||( src == NULL )) {
      return JST_ERR_NULL_ARGUMENT;
   }
   if( index > array->count ) {
      return JST_ERR_ARRAY_INDEX_OUT_OF_RANGE;
   }
   return element_copy( &(array->items[index]->element), src );
}

JST_save_to_file()

JST_Error JST_save_to_file	(	const char *	filepath,
		const JST_Element *	root,
		unsigned	indent
	)

Save the JSON tree to a file, pretty-printed.

Parameters

filepath	the path of the target file
root	the root of the tree to save
indent	the amout of space to pretty print the tree.

Definition at line 56 of file JST_save.c.

                                                                                           {
   if(( path == NULL )||( root == NULL )) {
      return JST_ERR_NULL_ARGUMENT;
   }
   FILE * stream = fopen( path, "wt" );
   if( stream == NULL ) {
      return JST_ERR_ERRNO;
   }
   return JST_save_to_stream( stream, root, indent );
}

Here is the call graph for this function:

JST_save_to_file_compact()

JST_Error JST_save_to_file_compact	(	const char *	filepath,
		const JST_Element *	root
	)

Save the JSON tree to a file, as a single line of text, without whitespaces.

Parameters

filepath	the path of the target file
root	the root of the tree to save

Definition at line 120 of file JST_save.c.

                                                                                  {
   if(( path == NULL )||( root == NULL )) {
      return JST_ERR_NULL_ARGUMENT;
   }
   FILE * stream = fopen( path, "wt" );
   if( stream == NULL ) {
      return JST_ERR_ERRNO;
   }
   return JST_save_to_stream_compact( stream, root );
}

Here is the call graph for this function:

JST_save_to_stream()

JST_Error JST_save_to_stream	(	FILE *	stream,
		const JST_Element *	root,
		unsigned	indent
	)

Save the JSON tree to a stream, pretty-printed.

Parameters

stream	the target stream.
root	the root of the tree to save.
indent	the amout of space to pretty print the tree.

Definition at line 47 of file JST_save.c.

                                                                                         {
   if(( stream == NULL )||( root == NULL )) {
      return JST_ERR_NULL_ARGUMENT;
   }
   save_element( root, stream, 0, indent );
   fprintf( stream, "\n" );
   return fclose( stream ) ? JST_ERR_ERRNO : JST_ERR_NONE;
}

Here is the caller graph for this function:

JST_save_to_stream_compact()

JST_Error JST_save_to_stream_compact	(	FILE *	stream,
		const JST_Element *	root
	)

Save the JSON tree to a stream, as a single line of text, without whitespaces.

Parameters

filepath	the path of the target file
root	the root of the tree to save

Definition at line 112 of file JST_save.c.

                                                                                {
   if(( stream == NULL )||( root == NULL )) {
      return JST_ERR_NULL_ARGUMENT;
   }
   save_element_compact( root, stream );
   return fclose( stream ) ? JST_ERR_ERRNO : JST_ERR_NONE;
}

Here is the caller graph for this function:

JST_serialize()

JST_Error JST_serialize	(	JST_Element *	root,
		char **	dest,
		unsigned	indent
	)

Serialize the JSON tree to a string, pretty-printed.

Parameters

filepath	the path of the target file
root	the root of the tree to save
dest	a pointer to the char buffer allocated by this function, must be freed by the user
indent	the amout of space to pretty print the tree. When indent is negative, it means the JSON tree is printed with all the nodes on a single line.

Definition at line 112 of file JST_serialize.c.

                                                                             {
   if(( root == NULL )||( dest == NULL )) {
      return JST_ERR_NULL_ARGUMENT;
   }
   JST_String string = JST_String_Zero;
   if(( serialize_element( root, &string, 0, indent ) == JST_ERR_NONE )&& JST_String_append_char( &string, '\n' )) {
      string.buffer[string.length] = '\0';
      *dest = realloc( string.buffer, string.length + 1 ); // truncate, if necessary
      if( *dest == NULL ) {
         JST_String_delete( &string );
         return JST_ERR_ERRNO;
      }
      string.buffer = NULL;
   }
   JST_String_delete( &string );
   return JST_ERR_NONE;
}

JST_serialize_compact()

JST_Error JST_serialize_compact	(	JST_Element *	root,
		char **	dest
	)

Serialize the JSON tree to a string as a single line of text, without whitespaces.

Parameters

filepath	the path of the target file
root	the root of the tree to save
dest	a pointer to the char buffer allocated by this function, must be freed by the user negative, it means the JSON tree is printed with all the nodes on a single line.

Definition at line 227 of file JST_serialize.c.

                                                                    {
   if(( root == NULL )||( dest == NULL )) {
      return JST_ERR_NULL_ARGUMENT;
   }
   JST_String string = JST_String_Zero;
   if(( serialize_element_compact( root, &string ) == JST_ERR_NONE )) {
      string.buffer[string.length] = '\0';
      *dest = realloc( string.buffer, string.length + 1 ); // truncate, if necessary
      if( *dest == NULL ) {
         JST_String_delete( &string );
         return JST_ERR_ERRNO;
      }
      string.buffer = NULL;
   }
   JST_String_delete( &string );
   return JST_ERR_NONE;
}

JST_walk()

JST_Error JST_walk	(	const JST_Element *	root,
		JST_Visitor	visitor,
		void *	user_context
	)

Definition at line 45 of file JST_walk.c.

                                                                                    {
   if(( root == NULL )||( visitor == NULL )) {
      return JST_ERR_NULL_ARGUMENT;
   }
   return visit_element( NULL, -1U, root, visitor, context ) ?  JST_ERR_NONE : JST_ERR_INTERRUPTED;
}

Variable Documentation

JST_Array_Zero

const JST_Array JST_Array_Zero

Constant defined to initialize safely a variable of type JST_Array.

Definition at line 16 of file JST_load.c.

JST_ArrayItem_Zero

const JST_ArrayItem JST_ArrayItem_Zero

Definition at line 20 of file JST_load.c.

JST_Element_Zero

const JST_Element JST_Element_Zero

Constant defined to initialize safely a variable of type JST_Element.

Definition at line 19 of file JST_load.c.

JST_Object_Zero

const JST_Object JST_Object_Zero

Constant defined to initialize safely a variable of type JST_Object.

Definition at line 17 of file JST_load.c.

JST_Pair_Zero

const JST_Pair JST_Pair_Zero

Constant defined to initialize safely a variable of type JST_Pair.

Definition at line 21 of file JST_load.c.

JST_SyntaxError_Zero

const JST_SyntaxError JST_SyntaxError_Zero

Constant defined to initialize safely a variable of type JST_SyntaxError.

Definition at line 22 of file JST_load.c.

JST_Value_Zero

const JST_Value JST_Value_Zero

Constant defined to initialize safely a variable of type JST_Value.

Definition at line 18 of file JST_load.c.