json_value_module Module

if true, any comments will be ignored when parsing a file. The comment tokens are defined by the comment_char character variable.

If False, then after parsing, if any duplicate keys are found, an error is thrown. A call to json_value_validate will also check for duplicates. If True [default] then no special checks are done

if name and path comparisons are case sensitive.

character position in the current line

a chunk read from a stream file when use_unformatted_stream=True

comment tokens when allow_comments is true. Examples: ‘!‘ or ‘#’. Default is CK_'/!#'.

to use the “compact” form of real numbers for output

If true, then arrays of integers, nulls, reals, & logicals are printed all on one line. [Note: no_whitespace will override this option if necessary]

the error message. if exception_thrown=False then this variable is not allocated.

If True then the solidus “/” is always escaped (“\/”) when serializing JSON. If False [default], then it is not escaped. Note that this option does not affect parsing (both escaped and unescaped versions are still valid in all cases).

The error flag. Will be set to true when an error is thrown in the class. Many of the methods will check this and return immediately if it is true.

the file size when when use_unformatted_stream=True

index in chunk for pop_char when use_unformatted_stream=True

for allocatable strings: next character to read

if true, all exceptions are immediately printed to console.

lines read counter

when printing a JSON string, don’t include non-significant spaces or line breaks. If true, the entire structure will be printed on one line.

How to serialize NaN, Infinity, and -Infinity real values:

if strict_type_checking=false:

How the path strings are interpreted in the get_by_path routines:

The path separator to use in the “default” mode for the paths in the various get_by_path routines. Note: if path_mode/=1 then this is ignored.

used when parsing lines in file

used when parsing lines in file

the format string to use for converting real numbers to strings. It can be set in json_initialize, and used in json_value_print If not set, then default_real_fmt is used instead.

number of spaces for indenting

if true, then the program is stopped immediately when an exception is raised.

if true, then no type conversions are done in the get routines if the actual variable type is different from the return type (for example, integer to real).

for name and path comparisons, if trailing space is to be considered significant.

If false, then the escaped string is returned from json_get_string and similar routines. If true [default], then the string is returned unescaped.

if true [default], null_to_real_mode=2 and string_to_real will use ieee_quiet_nan for NaN values. If false, ieee_signaling_nan will be used.

Function constructor for a json_core. This is just a wrapper for json_initialize.

Add objects to a linked list of json_values.

Add variables to a json_value linked list by specifying their paths.

Check a json_value object’s children for duplicate keys

Check entire JSON structure for duplicate keys (recursively)

check for error and get error message

clear exceptions

clone a JSON structure (deep copy)

count the number of children

Create a json_value linked list using the path to the variables. Optionally return a pointer to the variable.

Allocate a json_value pointer and make it an array variable. The pointer should not already be allocated.

This is equivalent to create_real, and is here only for backward compatibility.

Allocate a json_value pointer and make it an integer variable. The pointer should not already be allocated.

Allocate a json_value pointer and make it a logical variable. The pointer should not already be allocated.

Allocate a json_value pointer and make it a null variable. The pointer should not already be allocated.

Allocate a json_value pointer and make it an object variable. The pointer should not already be allocated.

Allocate a json_value pointer and make it a real variable. The pointer should not already be allocated.

Allocate a json_value pointer and make it a string variable. The pointer should not already be allocated.

Parse the JSON string and populate the json_value tree.

Destructor routine for a json_value pointer. This must be called explicitly if it is no longer needed, before it goes out of scope. Otherwise, a memory leak will result.

check for error

Get data from a json_value linked list.

Return a child of a json_value structure.

get pointer to json_value next

get pointer to json_value parent

get the path to a JSON variable in a structure:

get pointer to json_value previous

get pointer to json_value tail

get info about a json_value

to initialize some parsing parameters

insert a new element after an existing one, updating the JSON structure accordingly

Check if a json_value is a descendant of another.

Parse the JSON file and populate the json_value tree.

get matrix info about a json_value

Same as load and deserialize but only here for backward compatibility.

Print the json_value to an output unit or file.

simply routine to print error messages

The same as serialize, but only here for backward compatibility

Remove a json_value from a linked-list structure.

If the child variable is present, then remove it.

Rename a json_value variable.

Replace a json_value in a linked-list structure.

Reverse the order of the children of an array of object.

Print the json_value structure to an allocatable string

get string info about a json_value

Swap two json_value pointers in a structure (or two different structures).

Throw an exception.

to traverse all elements of a JSON structure

These are like the add methods, except if a variable with the same path is already present, then its value is simply updated. Note that currently, these only work for scalar variables. These routines can also change the variable’s type (but an error will be thrown if the existing variable is not a scalar).

verify if a path is valid (i.e., a variable with this path exists in the file).

Check that a json_value linked list is valid (i.e., is properly constructed). This may be useful if it has been constructed externally.

first child item of this

real data for this variable

integer data for this variable

logical data for this variable

number of children

variable name (unescaped)

next item in the list

parent item of this

previous item in the list

string data for this variable (unescaped)

last child item of this

variable type

mainly useful for debugging (default is false)

to compact the real number strings for output (default is true)

always print numeric sign (default is false)

Real number format: ‘E’ [default], ‘*’, ‘G’, ‘EN’, or ‘ES’

number of spaces per tab for indenting (default is 2)

if true, no integer, double, or logical type conversions are done for the get routines (default is false).

for name and path comparisons, is trailing space to be considered significant. (default is false)

for name and path comparisons, are they case sensitive. (default is true)

if true, printing the JSON structure is done without adding any non-significant spaces or linebreaks (default is false)

If false, then the raw escaped string is returned from json_get_string and similar routines. If true [default], then the string is returned unescaped.

If present, these characters are used to denote comments in the JSON file, which will be ignored if present. Example: !, #, or /!#. Setting this to a blank string disables the ignoring of comments. (Default is /!#).

How the path strings are interpreted in the get_by_path routines:

• 1 : Default mode (see json_get_by_path_default)
• 2 : as RFC 6901 “JSON Pointer” paths (see json_get_by_path_rfc6901)
• 3 : JSONPath “bracket-notation” see json_get_by_path_jsonpath_bracket)

The path separator to use in the “default” mode for the paths in the various get_by_path routines. Example: . [default] or %. Note: if path_mode/=1 then this is ignored.

If true, then arrays of integers, nulls, doubles, and logicals are printed all on one line. [Note: no_whitespace will override this option if necessary]. (Default is False).

• If True then the solidus “/” is always escaped “\/” when serializing JSON
• If False [default], then it is not escaped.

Note that this option does not affect parsing (both escaped and unescaped are still valid in all cases).

If an exception is raised, then immediately quit. (Default is False).

if strict_type_checking=false:

• 1 : an exception will be raised if try to retrieve a null as a real.
• 2 : a null retrieved as a real will return a NaN. [default]
• 3 : a null retrieved as a real will return 0.0.

How to serialize NaN, Infinity, and -Infinity real values:

• 1 : as strings (e.g., “NaN”, “Infinity”, “-Infinity”) [default]
• 2 : as JSON null values

• If false, when parsing JSON, if an integer numeric value cannot be converted to an integer (integer(IK)), then an attempt is then make to convert it to a real (real(RK)).
• If true, an exception will be raised if the integer value cannot be read.

(default is true)

this should normally be a json_object or a json_array. For any other variable type this will return 0.

a JSON linked list

path to the variable

the json object

the name to check for

the name to check

the name to check

a string

a string

a JSON linked list

path to the variable

file unit number

string with JSON data

the variable to convert

the variable type to convert p to

file unit number

current line

file unit number

current line

the JSON structure

the path to the variable

the value to add

if the variable was found

if the variable had to be created

the JSON structure

the path to the variable

the vector to add

if the variable was found

if the variable had to be created

the JSON structure

the path to the variable

the value to add

if the variable was found

if the variable had to be created

the JSON structure

the path to the variable

the vector to add

if the variable was found

if the variable had to be created

the JSON structure

the path to the variable

the value to add

if the variable was found

if the variable had to be created

the JSON structure

the path to the variable

the value to add

if the variable was found

if the variable had to be created

the JSON structure

the path to the variable

the vector to add

if the variable was found

if the variable had to be created

the JSON structure

the path to the variable

the value to add

if the variable was found

if the variable had to be created

the JSON structure

the path to the variable

the vector to add

if the variable was found

if the variable had to be created

the JSON structure

the path to the variable

the value to add

if the variable was found

if the variable had to be created

if TRIM() should be called for each element

if ADJUSTL() should be called for each element

the JSON structure

the path to the variable

the value to add

if the variable was found

if the variable had to be created

if TRIM() should be called for each element

if ADJUSTL() should be called for each element

the JSON structure

the path to the variable

the value to add

if the variable was found

if the variable had to be created

if TRIM() should be called for each element

if ADJUSTL() should be called for each element

the JSON structure

the path to the variable

the vector to add

if the variable was found

if the variable had to be created

the string lengths of each element in value. If not present, the full len(value) string is added for each element.

if TRIM() should be called for each element

if ADJUSTL() should be called for each element

the JSON structure

the path to the variable

the vector to add

if the variable was found

if the variable had to be created

the string lengths of each element in value. If not present, the full len(value) string is added for each element.

if TRIM() should be called for each element

if ADJUSTL() should be called for each element

the JSON structure

the path to the variable

the vector to add

if the variable was found

if the variable had to be created

the string lengths of each element in value. If not present, the full len(value) string is added for each element.

if TRIM() should be called for each element

if ADJUSTL() should be called for each element

the object to search. If p is not a json_object, then has_duplicate will be false.

true if there is at least one duplicate name key anywhere in the structure.

the duplicate name (unallocated if no duplicates were found)

the full path to the duplicate name (unallocated if no duplicate was found)

the object to search. If p is not a json_object, then has_duplicate will be false.

true if there is at least two children have duplicate name values.

the duplicate name (unallocated if no duplicate was found)

the full path to the duplicate name (unallocated if no duplicate was found)

true if there were no errors

the error message. (not allocated if there were no errors)

this is the structure to clone

the clone is put here (it must not already be associated)

a JSON linked list

path to the variable

pointer to the variable specify by path

true if there were no errors (variable found or created)

true if it was actually created (as opposed to already being there)

the actual length of each character string in the array

the actual length of each character string in the array

the actual length of default

a JSON linked list

path to the variable

pointer to the variable specified by path

true if it was found

a JSON linked list

path to the variable

pointer to the variable specify by path

true if it was found

if a variable is not present in the path, then it is created. the leaf node is returned as a null json type and can be changed by the caller.

if create_it is true, this will be true if the variable was actually created. Otherwise it will be false.

a JSON linked list

path to the variable (using JSONPath “bracket-notation”)

pointer to the variable specify by path

true if it was found

if a variable is not present in the path, then it is created. the leaf node is returned as a null json type and can be changed by the caller.

if create_it is true, this will be true if the variable was actually created. Otherwise it will be false.

a JSON linked list

path to the variable (an RFC 6901 “JSON Pointer”)

pointer to the variable specify by path

true if it was found

the integer value

default value if not found

default value if not found

default value if not found

JSON object

pointer to next

JSON object

pointer to parent

a JSON linked list object

path to the variable

true if there were no problems

if true, then ‘()’ are used for array elements otherwise, ‘[]’ are used [default] (only used if path_mode=1)

character to use for path separator (otherwise use json%path_separator) (only used if path_mode=1)

JSON object

pointer to previous

default value if not found

default value if not found

default value if not found