json_util.h

Go to the documentation of this file.

/*
** Copyright 2014-2016 The Earlham Institute
** 
** Licensed under the Apache License, Version 2.0 (the "License");
** you may not use this file except in compliance with the License.
** You may obtain a copy of the License at
** 
**     http://www.apache.org/licenses/LICENSE-2.0
** 
** Unless required by applicable law or agreed to in writing, software
** distributed under the License is distributed on an "AS IS" BASIS,
** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
** See the License for the specific language governing permissions and
** limitations under the License.
*/
 
#ifndef JSON_UTIL_H
#define JSON_UTIL_H
 
 
#include <stdio.h>
 
#include "grassroots_util_library.h"
 
#include "jansson.h"
#include "linked_list.h"
#include "string_linked_list.h"
#include "schema_keys.h"
 
 
typedef struct JsonNode
{
  ListItem jn_node;
 
  json_t *jn_json_p;
} JsonNode;
 
 
typedef struct FieldNode
{
  StringListNode fn_base_node;
 
  json_type fn_type;
} FieldNode;
 
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
GRASSROOTS_UTIL_API int PrintJSON (FILE *out_f, const json_t * const json_p, const char * const prefix_s);
 
 
GRASSROOTS_UTIL_API const char *GetJSONString (const json_t *json_p, const char * const key_s);
 
 
 
GRASSROOTS_UTIL_API bool SetJSONString (json_t *json_p, const char * const key_s, const char * const value_s);
 
GRASSROOTS_UTIL_API bool SetJSONStringOrNull (json_t *json_p, const char * const key_s, const char * const value_s, const bool null_flag);
 
GRASSROOTS_UTIL_API char *GetCopiedJSONString (const json_t *json_p, const char * const key_s);
 
 
GRASSROOTS_UTIL_API bool GetJSONInteger (const json_t *json_p, const char * const key_s, json_int_t *value_p);
 
 
GRASSROOTS_UTIL_API bool SetJSONInteger (json_t *json_p, const char * const key_s, const json_int_t value);
 
GRASSROOTS_UTIL_API bool GetJSONLong (const json_t *json_p, const char * const key_s, long *value_p);
 
 
GRASSROOTS_UTIL_API bool GetJSONReal (const json_t *json_p, const char * const key_s, double *value_p);
 
 
GRASSROOTS_UTIL_API bool SetJSONReal ( json_t *json_p, const char * const key_s, const double value);
 
 
GRASSROOTS_UTIL_API bool GetJSONBoolean (const json_t *json_p, const char * const key_s, bool *value_p);
 
 
GRASSROOTS_UTIL_API bool SetJSONBoolean (json_t *json_p, const char * const key_s, const bool value);
 
 
GRASSROOTS_UTIL_API bool AddStringArrayToJSON (json_t *parent_p, const char ** const values_ss, const char * const child_key_s);
 
 
GRASSROOTS_UTIL_API char **GetStringArrayFromJSON (const json_t * const array_p, bool add_terminating_null_flag);
 
 
GRASSROOTS_UTIL_API bool AddStringListToJSON (json_t *parent_p, LinkedList *values_p, const char * const child_key_s);
 
 
GRASSROOTS_UTIL_API LinkedList *GetStringListFromJSON (const json_t * const array_p);
 
 
GRASSROOTS_UTIL_API JsonNode *AllocateJsonNode (json_t *json_p);
 
 
GRASSROOTS_UTIL_API void FreeJsonNode (ListItem *node_p);
 
 
GRASSROOTS_UTIL_API FieldNode *AllocateFieldNode (const char *name_s, const MEM_FLAG mf, json_type field_type);
 
GRASSROOTS_UTIL_API void FreeFieldNode (ListItem *node_p);
 
 
GRASSROOTS_UTIL_API json_t *LoadJSONFile (const char * const filename_s);
 
 
GRASSROOTS_UTIL_API json_t *ConvertTabularDataToJSON (char *data_s, const char column_delimiter, const char row_delimiter, LinkedList *headers_p);
 
 
GRASSROOTS_UTIL_API json_t *ConvertTabularDataWithHeadersToJSON (char *data_s, const char column_delimiter, const char row_delimiter, json_type (*get_type_fn) (const char *name_s, const void * const data_p), const void * const type_data_p);
 
 
GRASSROOTS_UTIL_API LinkedList *GetTabularHeaders (char **data_ss,  const char column_delimiter, const char row_delimiter, json_type (*get_type_fn) (const char *name_s, const void * const data_p), const void * const type_data_p);
 
 
GRASSROOTS_UTIL_LOCAL json_t *GetJSONFromString (const char *value_s, json_type field_type);
 
 
GRASSROOTS_UTIL_API json_t *ConvertRowToJSON (char *row_s, LinkedList *headers_p, const char delimiter);
 
 
GRASSROOTS_UTIL_API bool AddValidJSONString (json_t *parent_p, const char * const key_s, const char * const value_s);
 
 
GRASSROOTS_UTIL_API int PrintJSONToLog (const uint32 level, const char *filename_s, const int line_number, const json_t *json_p, const char *message_s, ...);
 
 
GRASSROOTS_UTIL_API int PrintJSONToErrors (const uint32 level, const char *filename_s, const int line_number, const json_t *json_p, const char *message_s, ...);
 
 
 
GRASSROOTS_UTIL_API bool IsJSONEmpty (const json_t *json_p);
 
 
 
GRASSROOTS_UTIL_API void PrintJSONRefCounts (const uint32 log_level, const char * const filename_s, const int line_number, const json_t * const value_p, const char *initial_s);
 
 
GRASSROOTS_UTIL_API bool SetBooleanFromJSON (const json_t *json_p, bool *value_p);
 
 
GRASSROOTS_UTIL_API bool SetRealFromJSON (const json_t *json_p, double *value_p);
 
 
GRASSROOTS_UTIL_API bool SetIntegerFromJSON (const json_t *json_p, json_int_t *value_p);
 
 
GRASSROOTS_UTIL_API bool SetLongFromJSON (const json_t *json_p, int64 *value_p);
 
 
GRASSROOTS_UTIL_API bool SetStringFromJSON (const json_t *json_p, char **value_ss);
 
 
 
GRASSROOTS_UTIL_API bool SetJSONNull (json_t *json_p, const char * const key_s);
 
 
GRASSROOTS_UTIL_API json_t *GetCompoundJSONObject (const json_t *input_p, const char * const compound_s);
 
 
GRASSROOTS_UTIL_API bool CopyJSONKeyStringValuePair (const json_t *src_p, json_t *dest_p, const char * const key_s, bool optional_flag);
 
 
 
 
GRASSROOTS_UTIL_API bool CopyJSONKeyIntegerValuePair (const json_t *src_p, json_t *dest_p, const char * const key_s, bool optional_flag);
 
 
 
GRASSROOTS_UTIL_API bool DeepCopyValidJSON (const json_t *src_p, json_t **dest_pp);
 
 
GRASSROOTS_UTIL_API bool AddOntologyContextTerm (json_t *root_p, const char *key_s, const char *term_s, const bool add_id_flag);
 
 
GRASSROOTS_UTIL_API json_t *SplitJSON (json_t *src_p, uint8 percentage_to_move);
 
 
 
 
GRASSROOTS_UTIL_API bool GetJSONStringAsInteger (const json_t *json_p, const char * const key_s, int *answer_p);
 
GRASSROOTS_UTIL_API bool GetJSONStringAsDouble (const json_t *json_p, const char * const key_s, double *answer_p);
 
 
GRASSROOTS_UTIL_API bool GetJSONUnsignedInteger (const json_t *json_p, const char * const key_s, uint32 *value_p);
 
 
GRASSROOTS_UTIL_API bool GetRealValueFromJSONString (const json_t *json_p, double64 *answer_p);
 
 
GRASSROOTS_UTIL_API json_t *ConvertStringArrayToJSON (char **values_ss, const size_t num_values);
 
GRASSROOTS_UTIL_API bool SetNonTrivialUnsignedInt (json_t *json_p, const char *key_s, const uint32 *value_p, const bool null_flag);
 
GRASSROOTS_UTIL_API bool SetNonTrivialString (json_t *value_p, const char *key_s, const char *value_s, const bool null_flag);
 
GRASSROOTS_UTIL_API bool SetNonTrivialDouble (json_t *json_p, const char *key_s, const double64 *value_p, const bool null_fla);
 
 
#ifdef __cplusplus
}
#endif
 
#endif    /* #ifndef JSON_UTIL_H */