json_file Interface

public interface json_file

Structure constructor to initialize a json_file object with an existing json_value object or a JSON string, and either the json_core settings or a json_core instance.

Example

 ...
 type(json_file) :: my_file
 type(json_value),pointer :: json_object
 type(json_core) :: json_core_object
 ...
 ! Construct a json_object:
 !could do this:
   my_file = json_file(json_object)
 !or:
   my_file = json_file(json_object,verbose=.true.)
 !or:
   my_file = json_file('{"x": [1]}',verbose=.true.)
 !or:
   my_file = json_file(json_object,json_core_object)
 !or:
   my_file = json_file('{"x": [1]}',json_core_object)

Calls

interface~~json_file~~CallsGraph interface~json_file json_file proc~initialize_json_file initialize_json_file interface~json_file->proc~initialize_json_file proc~initialize_json_file_from_string initialize_json_file_from_string interface~json_file->proc~initialize_json_file_from_string proc~initialize_json_file_from_string_v2 initialize_json_file_from_string_v2 interface~json_file->proc~initialize_json_file_from_string_v2 proc~initialize_json_file_v2 initialize_json_file_v2 interface~json_file->proc~initialize_json_file_v2 proc~wrap_initialize_json_file_from_string wrap_initialize_json_file_from_string interface~json_file->proc~wrap_initialize_json_file_from_string proc~wrap_initialize_json_file_from_string_v2 wrap_initialize_json_file_from_string_v2 interface~json_file->proc~wrap_initialize_json_file_from_string_v2 none~initialize json_file%initialize proc~initialize_json_file->none~initialize none~deserialize json_file%deserialize proc~initialize_json_file_from_string->none~deserialize proc~initialize_json_file_from_string->none~initialize proc~initialize_json_file_from_string_v2->none~deserialize proc~wrap_initialize_json_file_from_string->proc~initialize_json_file_from_string interface~to_unicode to_unicode proc~wrap_initialize_json_file_from_string->interface~to_unicode proc~wrap_initialize_json_file_from_string_v2->proc~initialize_json_file_from_string_v2 proc~wrap_initialize_json_file_from_string_v2->interface~to_unicode proc~to_uni to_uni interface~to_unicode->proc~to_uni proc~to_uni_vec to_uni_vec interface~to_unicode->proc~to_uni_vec proc~json_file_load_from_string json_file%json_file_load_from_string none~deserialize->proc~json_file_load_from_string proc~wrap_json_file_load_from_string json_file%wrap_json_file_load_from_string none~deserialize->proc~wrap_json_file_load_from_string proc~initialize_json_core_in_file json_file%initialize_json_core_in_file none~initialize->proc~initialize_json_core_in_file proc~set_json_core_in_file json_file%set_json_core_in_file none~initialize->proc~set_json_core_in_file proc~json_initialize json_core%json_initialize proc~initialize_json_core_in_file->proc~json_initialize none~deserialize~2 json_core%deserialize proc~json_file_load_from_string->none~deserialize~2 proc~json_file_destroy json_file%json_file_destroy proc~json_file_load_from_string->proc~json_file_destroy proc~wrap_json_file_load_from_string->interface~to_unicode proc~wrap_json_file_load_from_string->none~deserialize proc~json_parse_string json_core%json_parse_string none~deserialize~2->proc~json_parse_string proc~wrap_json_parse_string json_core%wrap_json_parse_string none~deserialize~2->proc~wrap_json_parse_string none~destroy~3 json_core%destroy proc~json_file_destroy->none~destroy~3 none~throw_exception json_core%throw_exception proc~json_initialize->none~throw_exception proc~integer_to_string integer_to_string proc~json_initialize->proc~integer_to_string proc~json_clear_exceptions json_core%json_clear_exceptions proc~json_initialize->proc~json_clear_exceptions proc~destroy_json_core json_core%destroy_json_core none~destroy~3->proc~destroy_json_core proc~json_value_destroy json_core%json_value_destroy none~destroy~3->proc~json_value_destroy proc~json_throw_exception json_core%json_throw_exception none~throw_exception->proc~json_throw_exception proc~wrap_json_throw_exception json_core%wrap_json_throw_exception none~throw_exception->proc~wrap_json_throw_exception proc~json_parse_string->proc~json_initialize proc~json_parse_string->none~throw_exception proc~annotate_invalid_json json_core%annotate_invalid_json proc~json_parse_string->proc~annotate_invalid_json proc~json_check_all_for_duplicate_keys json_core%json_check_all_for_duplicate_keys proc~json_parse_string->proc~json_check_all_for_duplicate_keys proc~json_parse_end json_core%json_parse_end proc~json_parse_string->proc~json_parse_end proc~json_prepare_parser json_core%json_prepare_parser proc~json_parse_string->proc~json_prepare_parser proc~json_value_create json_value_create proc~json_parse_string->proc~json_value_create proc~parse_value json_core%parse_value proc~json_parse_string->proc~parse_value proc~wrap_json_parse_string->interface~to_unicode proc~wrap_json_parse_string->none~deserialize~2 proc~annotate_invalid_json->proc~integer_to_string proc~get_current_line_from_file_sequential json_core%get_current_line_from_file_sequential proc~annotate_invalid_json->proc~get_current_line_from_file_sequential proc~get_current_line_from_file_stream json_core%get_current_line_from_file_stream proc~annotate_invalid_json->proc~get_current_line_from_file_stream proc~json_traverse json_core%json_traverse proc~json_check_all_for_duplicate_keys->proc~json_traverse proc~json_parse_end->none~throw_exception proc~pop_char json_core%pop_char proc~json_parse_end->proc~pop_char proc~json_value_destroy->none~destroy~3 proc~destroy_json_data destroy_json_data proc~json_value_destroy->proc~destroy_json_data proc~parse_value->none~throw_exception proc~parse_array json_core%parse_array proc~parse_value->proc~parse_array proc~parse_for_chars json_core%parse_for_chars proc~parse_value->proc~parse_for_chars proc~parse_number json_core%parse_number proc~parse_value->proc~parse_number proc~parse_object json_core%parse_object proc~parse_value->proc~parse_object proc~parse_string json_core%parse_string proc~parse_value->proc~parse_string proc~parse_value->proc~pop_char proc~push_char json_core%push_char proc~parse_value->proc~push_char proc~to_array json_core%to_array proc~parse_value->proc~to_array proc~to_logical json_core%to_logical proc~parse_value->proc~to_logical proc~to_null json_core%to_null proc~parse_value->proc~to_null proc~to_object json_core%to_object proc~parse_value->proc~to_object proc~to_string json_core%to_string proc~parse_value->proc~to_string proc~wrap_json_throw_exception->interface~to_unicode proc~wrap_json_throw_exception->none~throw_exception proc~json_traverse->none~throw_exception proc~parse_array->none~destroy~3 proc~parse_array->none~throw_exception proc~parse_array->proc~json_value_create proc~parse_array->proc~parse_value proc~parse_array->proc~pop_char none~add~4 json_core%add proc~parse_array->none~add~4 proc~parse_for_chars->none~throw_exception proc~parse_for_chars->proc~pop_char proc~parse_number->proc~json_clear_exceptions proc~parse_number->proc~pop_char proc~parse_number->proc~push_char proc~string_to_dble json_core%string_to_dble proc~parse_number->proc~string_to_dble proc~string_to_int json_core%string_to_int proc~parse_number->proc~string_to_int proc~to_integer json_core%to_integer proc~parse_number->proc~to_integer proc~to_real json_core%to_real proc~parse_number->proc~to_real proc~parse_object->none~destroy~3 proc~parse_object->none~throw_exception proc~parse_object->proc~json_value_create proc~parse_object->proc~parse_value proc~parse_object->proc~parse_object proc~parse_object->proc~parse_string proc~parse_object->proc~pop_char proc~parse_object->none~add~4 proc~parse_string->none~throw_exception proc~parse_string->proc~pop_char proc~unescape_string unescape_string proc~parse_string->proc~unescape_string proc~push_char->none~throw_exception proc~push_char->proc~integer_to_string proc~to_array->proc~destroy_json_data proc~to_logical->proc~destroy_json_data proc~to_null->proc~destroy_json_data proc~to_object->proc~destroy_json_data proc~to_string->proc~destroy_json_data proc~json_value_add_string_name_ascii json_core%json_value_add_string_name_ascii none~add~4->proc~json_value_add_string_name_ascii proc~json_value_add_string_val_ascii json_core%json_value_add_string_val_ascii none~add~4->proc~json_value_add_string_val_ascii proc~json_value_add_string_vec_name_ascii json_core%json_value_add_string_vec_name_ascii none~add~4->proc~json_value_add_string_vec_name_ascii proc~json_value_add_string_vec_val_ascii json_core%json_value_add_string_vec_val_ascii none~add~4->proc~json_value_add_string_vec_val_ascii proc~string_to_dble->none~throw_exception proc~string_to_real string_to_real proc~string_to_dble->proc~string_to_real proc~string_to_int->none~throw_exception proc~string_to_integer string_to_integer proc~string_to_int->proc~string_to_integer proc~to_integer->proc~destroy_json_data proc~to_real->proc~destroy_json_data proc~valid_json_hex valid_json_hex proc~unescape_string->proc~valid_json_hex proc~json_value_add_string_name_ascii->interface~to_unicode proc~json_value_add_string_name_ascii->none~add~4 proc~json_value_add_string_val_ascii->interface~to_unicode proc~json_value_add_string_val_ascii->none~add~4 proc~json_value_add_string_vec_name_ascii->interface~to_unicode proc~json_value_add_string_vec_name_ascii->none~add~4 proc~json_value_add_string_vec_val_ascii->interface~to_unicode proc~json_value_add_string_vec_val_ascii->none~add~4

Module Procedures

private function initialize_json_file(p, verbose, compact_reals, print_signs, real_format, spaces_per_tab, strict_type_checking, trailing_spaces_significant, case_sensitive_keys, no_whitespace, unescape_strings, comment_char, path_mode, path_separator, compress_vectors, allow_duplicate_keys, escape_solidus, stop_on_error, null_to_real_mode, non_normal_mode, use_quiet_nan, strict_integer_type_checking, allow_trailing_comma, nullify_pointer) result(file_object)

Author
Izaak Beekman
Date
07/23/2015

Cast a json_value object as a json_file object. It also calls the initialize() method.

Read more…

Arguments

Type IntentOptional Attributes Name
type(json_value), optional, pointer :: p

json_value object to cast as a json_file object. This will be nullified.
logical(kind=LK), intent(in), optional :: verbose

mainly useful for debugging (default is false)
logical(kind=LK), intent(in), optional :: compact_reals

to compact the real number strings for output (default is true)
logical(kind=LK), intent(in), optional :: print_signs

always print numeric sign (default is false)
character(kind=CDK, len=*), intent(in), optional :: real_format

Real number format: ‘E’ [default], ‘*’, ‘G’, ‘EN’, or ‘ES’
integer(kind=IK), intent(in), optional :: spaces_per_tab

number of spaces per tab for indenting (default is 2)
logical(kind=LK), intent(in), optional :: strict_type_checking

if true, no integer, double, or logical type conversions are done for the get routines (default is false).
logical(kind=LK), intent(in), optional :: trailing_spaces_significant

for name and path comparisons, is trailing space to be considered significant. (default is false)
logical(kind=LK), intent(in), optional :: case_sensitive_keys

for name and path comparisons, are they case sensitive. (default is true)
logical(kind=LK), intent(in), optional :: no_whitespace

if true, printing the JSON structure is done without adding any non-significant spaces or linebreaks (default is false)
logical(kind=LK), intent(in), optional :: unescape_strings

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.
character(kind=CK, len=*), intent(in), optional :: comment_char

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 /!#).
integer(kind=IK), intent(in), optional :: path_mode

How the path strings are interpreted in the get_by_path routines:

Read more…
character(kind=CK, len=1), intent(in), optional :: path_separator

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.
logical(kind=LK), intent(in), optional :: compress_vectors

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).
logical(kind=LK), intent(in), optional :: allow_duplicate_keys Read more…
logical(kind=LK), intent(in), optional :: escape_solidus

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

Read more…
logical(kind=LK), intent(in), optional :: stop_on_error

If an exception is raised, then immediately quit. (Default is False).
integer(kind=IK), intent(in), optional :: null_to_real_mode

if strict_type_checking=false:

Read more…
integer(kind=IK), intent(in), optional :: non_normal_mode

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

Read more…
logical(kind=LK), intent(in), optional :: use_quiet_nan Read more…
logical(kind=LK), intent(in), optional :: strict_integer_type_checking

(default is true)

Read more…
logical(kind=LK), intent(in), optional :: allow_trailing_comma

Allow a single trailing comma in arrays and objects. (default is true)
logical(kind=LK), intent(in), optional :: nullify_pointer

if True, then p will be nullified if present. (default is True). Normally, this should be done, because the json_file will destroy the pointer when the class goes out of scope (causing p to be a dangling pointer). However, if the intent is to use p in a json_file and then call nullify and continue to use p, then this should be set to False.

Return Value type(json_file)

private function initialize_json_file_v2(json_value_object, json_core_object) result(file_object)

Author
Jacob Williams
Date
4/26/2016

Cast a json_value pointer and a json_core object as a json_file object.

Arguments

Type IntentOptional Attributes Name
type(json_value), intent(in), pointer :: json_value_object
type(json_core), intent(in) :: json_core_object

Return Value type(json_file)

private function initialize_json_file_from_string(str, verbose, compact_reals, print_signs, real_format, spaces_per_tab, strict_type_checking, trailing_spaces_significant, case_sensitive_keys, no_whitespace, unescape_strings, comment_char, path_mode, path_separator, compress_vectors, allow_duplicate_keys, escape_solidus, stop_on_error, null_to_real_mode, non_normal_mode, use_quiet_nan, strict_integer_type_checking, allow_trailing_comma) result(file_object)

Author
Jacob Williams
Date
01/19/2019

Cast a JSON string as a json_file object. It also calls the initialize() method.

Read more…

Arguments

Type IntentOptional Attributes Name
character(kind=CK, len=*), intent(in) :: str

string to load JSON data from
logical(kind=LK), intent(in), optional :: verbose

mainly useful for debugging (default is false)
logical(kind=LK), intent(in), optional :: compact_reals

to compact the real number strings for output (default is true)
logical(kind=LK), intent(in), optional :: print_signs

always print numeric sign (default is false)
character(kind=CDK, len=*), intent(in), optional :: real_format

Real number format: ‘E’ [default], ‘*’, ‘G’, ‘EN’, or ‘ES’
integer(kind=IK), intent(in), optional :: spaces_per_tab

number of spaces per tab for indenting (default is 2)
logical(kind=LK), intent(in), optional :: strict_type_checking

if true, no integer, double, or logical type conversions are done for the get routines (default is false).
logical(kind=LK), intent(in), optional :: trailing_spaces_significant

for name and path comparisons, is trailing space to be considered significant. (default is false)
logical(kind=LK), intent(in), optional :: case_sensitive_keys

for name and path comparisons, are they case sensitive. (default is true)
logical(kind=LK), intent(in), optional :: no_whitespace

if true, printing the JSON structure is done without adding any non-significant spaces or linebreaks (default is false)
logical(kind=LK), intent(in), optional :: unescape_strings

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.
character(kind=CK, len=*), intent(in), optional :: comment_char

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 /!#).
integer(kind=IK), intent(in), optional :: path_mode

How the path strings are interpreted in the get_by_path routines:

Read more…
character(kind=CK, len=1), intent(in), optional :: path_separator

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.
logical(kind=LK), intent(in), optional :: compress_vectors

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).
logical(kind=LK), intent(in), optional :: allow_duplicate_keys Read more…
logical(kind=LK), intent(in), optional :: escape_solidus

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

Read more…
logical(kind=LK), intent(in), optional :: stop_on_error

If an exception is raised, then immediately quit. (Default is False).
integer(kind=IK), intent(in), optional :: null_to_real_mode

if strict_type_checking=false:

Read more…
integer(kind=IK), intent(in), optional :: non_normal_mode

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

Read more…
logical(kind=LK), intent(in), optional :: use_quiet_nan Read more…
logical(kind=LK), intent(in), optional :: strict_integer_type_checking

(default is true)

Read more…
logical(kind=LK), intent(in), optional :: allow_trailing_comma

Allow a single trailing comma in arrays and objects. (default is true)

Return Value type(json_file)

private function wrap_initialize_json_file_from_string(str, verbose, compact_reals, print_signs, real_format, spaces_per_tab, strict_type_checking, trailing_spaces_significant, case_sensitive_keys, no_whitespace, unescape_strings, comment_char, path_mode, path_separator, compress_vectors, allow_duplicate_keys, escape_solidus, stop_on_error, null_to_real_mode, non_normal_mode, use_quiet_nan, strict_integer_type_checking, allow_trailing_comma) result(file_object)

Alternate version of initialize_json_file_from_string, where “str” is kind=CDK.

Arguments

Type IntentOptional Attributes Name
character(kind=CDK, len=*), intent(in) :: str

string to load JSON data from
logical(kind=LK), intent(in), optional :: verbose

mainly useful for debugging (default is false)
logical(kind=LK), intent(in), optional :: compact_reals

to compact the real number strings for output (default is true)
logical(kind=LK), intent(in), optional :: print_signs

always print numeric sign (default is false)
character(kind=CDK, len=*), intent(in), optional :: real_format

Real number format: ‘E’ [default], ‘*’, ‘G’, ‘EN’, or ‘ES’
integer(kind=IK), intent(in), optional :: spaces_per_tab

number of spaces per tab for indenting (default is 2)
logical(kind=LK), intent(in), optional :: strict_type_checking

if true, no integer, double, or logical type conversions are done for the get routines (default is false).
logical(kind=LK), intent(in), optional :: trailing_spaces_significant

for name and path comparisons, is trailing space to be considered significant. (default is false)
logical(kind=LK), intent(in), optional :: case_sensitive_keys

for name and path comparisons, are they case sensitive. (default is true)
logical(kind=LK), intent(in), optional :: no_whitespace

if true, printing the JSON structure is done without adding any non-significant spaces or linebreaks (default is false)
logical(kind=LK), intent(in), optional :: unescape_strings

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.
character(kind=CK, len=*), intent(in), optional :: comment_char

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 /!#).
integer(kind=IK), intent(in), optional :: path_mode

How the path strings are interpreted in the get_by_path routines:

Read more…
character(kind=CK, len=1), intent(in), optional :: path_separator

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.
logical(kind=LK), intent(in), optional :: compress_vectors

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).
logical(kind=LK), intent(in), optional :: allow_duplicate_keys Read more…
logical(kind=LK), intent(in), optional :: escape_solidus

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

Read more…
logical(kind=LK), intent(in), optional :: stop_on_error

If an exception is raised, then immediately quit. (Default is False).
integer(kind=IK), intent(in), optional :: null_to_real_mode

if strict_type_checking=false:

Read more…
integer(kind=IK), intent(in), optional :: non_normal_mode

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

Read more…
logical(kind=LK), intent(in), optional :: use_quiet_nan Read more…
logical(kind=LK), intent(in), optional :: strict_integer_type_checking

(default is true)

Read more…
logical(kind=LK), intent(in), optional :: allow_trailing_comma

Allow a single trailing comma in arrays and objects. (default is true)

Return Value type(json_file)

private function initialize_json_file_from_string_v2(str, json_core_object) result(file_object)

Author
Jacob Williams
Date
1/19/2019

Cast a JSON string and a json_core object as a json_file object.

Arguments

Type IntentOptional Attributes Name
character(kind=CK, len=*), intent(in) :: str

string to load JSON data from
type(json_core), intent(in) :: json_core_object

Return Value type(json_file)

private function wrap_initialize_json_file_from_string_v2(str, json_core_object) result(file_object)

Alternate version of initialize_json_file_from_string_v2, where “str” is kind=CDK.

Arguments

Type IntentOptional Attributes Name
character(kind=CDK, len=*), intent(in) :: str

string to load JSON data from
type(json_core), intent(in) :: json_core_object

Return Value type(json_file)