json_parse_file Subroutine

private subroutine json_parse_file(json, file, p, unit)

Parse the JSON file and populate the json_value tree.

Inputs

The inputs can be:

  • file & unit : the specified unit is used to read JSON from file. [note if unit is already open, then the filename is ignored]
  • file : JSON is read from file using internal unit number

Example

    type(json_core) :: json
    type(json_value),pointer :: p
    call json%load(file='myfile.json', p=p)

History

  • Jacob Williams : 01/13/2015 : added read from string option.
  • Izaak Beekman : 03/08/2015 : moved read from string to separate subroutine, and error annotation to separate subroutine.

Note

When calling this routine, any exceptions thrown from previous calls will automatically be cleared.

Type Bound

json_core

Arguments

Type IntentOptional Attributes Name
class(json_core), intent(inout) :: json
character(kind=CDK, len=*), intent(in) :: file

JSON file name
type(json_value), pointer :: p

output structure
integer(kind=IK), intent(in), optional :: unit

file unit number (/= 0)

Calls

proc~~json_parse_file~~CallsGraph proc~json_parse_file json_core%json_parse_file none~throw_exception json_core%throw_exception proc~json_parse_file->none~throw_exception proc~annotate_invalid_json json_core%annotate_invalid_json proc~json_parse_file->proc~annotate_invalid_json proc~json_check_all_for_duplicate_keys json_core%json_check_all_for_duplicate_keys proc~json_parse_file->proc~json_check_all_for_duplicate_keys proc~json_initialize json_core%json_initialize proc~json_parse_file->proc~json_initialize proc~json_parse_end json_core%json_parse_end proc~json_parse_file->proc~json_parse_end proc~json_prepare_parser json_core%json_prepare_parser proc~json_parse_file->proc~json_prepare_parser proc~json_value_create json_value_create proc~json_parse_file->proc~json_value_create proc~parse_value json_core%parse_value proc~json_parse_file->proc~parse_value proc~json_throw_exception json_core%json_throw_exception none~throw_exception->proc~json_throw_exception 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~integer_to_string integer_to_string proc~annotate_invalid_json->proc~integer_to_string proc~json_traverse json_core%json_traverse proc~json_check_all_for_duplicate_keys->proc~json_traverse proc~json_initialize->none~throw_exception proc~json_initialize->proc~integer_to_string proc~json_clear_exceptions json_core%json_clear_exceptions proc~json_initialize->proc~json_clear_exceptions proc~json_parse_end->none~throw_exception proc~pop_char json_core%pop_char proc~json_parse_end->proc~pop_char 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~json_traverse->none~throw_exception 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 json_core%add proc~parse_array->none~add none~destroy json_core%destroy proc~parse_array->none~destroy 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~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 proc~parse_object->none~destroy 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~destroy_json_data destroy_json_data 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_integer json_core%json_value_add_integer none~add->proc~json_value_add_integer proc~json_value_add_integer_vec json_core%json_value_add_integer_vec none~add->proc~json_value_add_integer_vec proc~json_value_add_logical json_core%json_value_add_logical none~add->proc~json_value_add_logical proc~json_value_add_logical_vec json_core%json_value_add_logical_vec none~add->proc~json_value_add_logical_vec proc~json_value_add_member json_core%json_value_add_member none~add->proc~json_value_add_member proc~json_value_add_null json_core%json_value_add_null none~add->proc~json_value_add_null proc~json_value_add_real json_core%json_value_add_real none~add->proc~json_value_add_real proc~json_value_add_real32 json_core%json_value_add_real32 none~add->proc~json_value_add_real32 proc~json_value_add_real32_vec json_core%json_value_add_real32_vec none~add->proc~json_value_add_real32_vec proc~json_value_add_real_vec json_core%json_value_add_real_vec none~add->proc~json_value_add_real_vec proc~json_value_add_string json_core%json_value_add_string none~add->proc~json_value_add_string proc~json_value_add_string_vec json_core%json_value_add_string_vec none~add->proc~json_value_add_string_vec proc~destroy_json_core json_core%destroy_json_core none~destroy->proc~destroy_json_core proc~json_value_destroy json_core%json_value_destroy none~destroy->proc~json_value_destroy 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_integer->none~add none~create_integer json_core%create_integer proc~json_value_add_integer->none~create_integer proc~json_value_add_integer_vec->none~add none~create_array json_core%create_array proc~json_value_add_integer_vec->none~create_array proc~json_value_add_logical->none~add none~create_logical json_core%create_logical proc~json_value_add_logical->none~create_logical proc~json_value_add_logical_vec->none~add proc~json_value_add_logical_vec->none~create_array proc~json_value_add_member->none~throw_exception none~info json_core%info proc~json_value_add_member->none~info proc~json_value_add_null->none~add none~create_null json_core%create_null proc~json_value_add_null->none~create_null proc~json_value_add_real->none~add none~create_real~2 json_core%create_real proc~json_value_add_real->none~create_real~2 proc~json_value_add_real32->none~add proc~json_value_add_real32_vec->none~add proc~json_value_add_real_vec->none~add proc~json_value_add_real_vec->none~create_array proc~json_value_add_string->none~add none~create_string json_core%create_string proc~json_value_add_string->none~create_string proc~json_value_add_string_vec->none~add proc~json_value_add_string_vec->none~create_array proc~json_value_destroy->none~destroy proc~json_value_destroy->proc~destroy_json_data proc~json_value_create_array json_core%json_value_create_array none~create_array->proc~json_value_create_array proc~json_value_create_integer json_core%json_value_create_integer none~create_integer->proc~json_value_create_integer proc~json_value_create_logical json_core%json_value_create_logical none~create_logical->proc~json_value_create_logical proc~json_value_create_null json_core%json_value_create_null none~create_null->proc~json_value_create_null proc~json_value_create_real32 json_core%json_value_create_real32 none~create_real~2->proc~json_value_create_real32 proc~json_value_create_string json_core%json_value_create_string none~create_string->proc~json_value_create_string proc~json_info json_core%json_info none~info->proc~json_info proc~json_info_by_path json_core%json_info_by_path none~info->proc~json_info_by_path proc~json_info->none~throw_exception proc~json_info_by_path->none~info none~get json_core%get proc~json_info_by_path->none~get proc~json_value_create_array->proc~json_value_create proc~json_value_create_array->proc~to_array proc~json_value_create_integer->proc~json_value_create proc~json_value_create_integer->proc~to_integer proc~json_value_create_logical->proc~json_value_create proc~json_value_create_logical->proc~to_logical proc~json_value_create_null->proc~json_value_create proc~json_value_create_null->proc~to_null proc~json_value_create_real32->none~create_real~2 proc~json_value_create_string->proc~json_value_create proc~json_value_create_string->proc~to_string proc~json_get_alloc_string_vec json_core%json_get_alloc_string_vec none~get->proc~json_get_alloc_string_vec proc~json_get_alloc_string_vec_by_path json_core%json_get_alloc_string_vec_by_path none~get->proc~json_get_alloc_string_vec_by_path proc~json_get_array json_core%json_get_array none~get->proc~json_get_array proc~json_get_array_by_path json_core%json_get_array_by_path none~get->proc~json_get_array_by_path proc~json_get_by_path json_core%json_get_by_path none~get->proc~json_get_by_path proc~json_get_integer json_core%json_get_integer none~get->proc~json_get_integer proc~json_get_integer_by_path json_core%json_get_integer_by_path none~get->proc~json_get_integer_by_path proc~json_get_integer_vec json_core%json_get_integer_vec none~get->proc~json_get_integer_vec proc~json_get_integer_vec_by_path json_core%json_get_integer_vec_by_path none~get->proc~json_get_integer_vec_by_path proc~json_get_logical json_core%json_get_logical none~get->proc~json_get_logical proc~json_get_logical_by_path json_core%json_get_logical_by_path none~get->proc~json_get_logical_by_path proc~json_get_logical_vec json_core%json_get_logical_vec none~get->proc~json_get_logical_vec proc~json_get_logical_vec_by_path json_core%json_get_logical_vec_by_path none~get->proc~json_get_logical_vec_by_path proc~json_get_real json_core%json_get_real none~get->proc~json_get_real proc~json_get_real32 json_core%json_get_real32 none~get->proc~json_get_real32 proc~json_get_real32_by_path json_core%json_get_real32_by_path none~get->proc~json_get_real32_by_path proc~json_get_real32_vec json_core%json_get_real32_vec none~get->proc~json_get_real32_vec proc~json_get_real32_vec_by_path json_core%json_get_real32_vec_by_path none~get->proc~json_get_real32_vec_by_path proc~json_get_real_by_path json_core%json_get_real_by_path none~get->proc~json_get_real_by_path proc~json_get_real_vec json_core%json_get_real_vec none~get->proc~json_get_real_vec proc~json_get_real_vec_by_path json_core%json_get_real_vec_by_path none~get->proc~json_get_real_vec_by_path proc~json_get_string json_core%json_get_string none~get->proc~json_get_string proc~json_get_string_by_path json_core%json_get_string_by_path none~get->proc~json_get_string_by_path proc~json_get_string_vec json_core%json_get_string_vec none~get->proc~json_get_string_vec proc~json_get_string_vec_by_path json_core%json_get_string_vec_by_path none~get->proc~json_get_string_vec_by_path proc~json_get_alloc_string_vec->none~get none~string_info json_core%string_info proc~json_get_alloc_string_vec->none~string_info proc~json_get_alloc_string_vec_by_path->none~throw_exception proc~json_get_alloc_string_vec_by_path->proc~json_clear_exceptions proc~json_get_alloc_string_vec_by_path->none~get proc~flag_not_found flag_not_found proc~json_get_alloc_string_vec_by_path->proc~flag_not_found proc~json_get_array->none~throw_exception proc~json_get_array_by_path->none~throw_exception proc~json_get_array_by_path->proc~json_clear_exceptions proc~json_get_array_by_path->none~get proc~json_get_by_path->none~throw_exception proc~json_get_by_path->proc~integer_to_string proc~json_get_by_path->proc~json_clear_exceptions proc~json_get_by_path_default json_core%json_get_by_path_default proc~json_get_by_path->proc~json_get_by_path_default proc~json_get_by_path_jsonpath_bracket json_core%json_get_by_path_jsonpath_bracket proc~json_get_by_path->proc~json_get_by_path_jsonpath_bracket proc~json_get_by_path_rfc6901 json_core%json_get_by_path_rfc6901 proc~json_get_by_path->proc~json_get_by_path_rfc6901 proc~json_get_integer->none~throw_exception proc~json_get_integer->proc~string_to_integer proc~json_get_integer_by_path->none~throw_exception proc~json_get_integer_by_path->proc~json_clear_exceptions proc~json_get_integer_by_path->none~get proc~json_get_integer_by_path->proc~flag_not_found proc~json_get_integer_vec->none~get proc~json_get_integer_vec_by_path->none~throw_exception proc~json_get_integer_vec_by_path->proc~json_clear_exceptions proc~json_get_integer_vec_by_path->none~get proc~json_get_integer_vec_by_path->proc~flag_not_found proc~json_get_logical->none~throw_exception proc~json_get_logical_by_path->none~throw_exception proc~json_get_logical_by_path->proc~json_clear_exceptions proc~json_get_logical_by_path->none~get proc~json_get_logical_by_path->proc~flag_not_found proc~json_get_logical_vec->none~get proc~json_get_logical_vec_by_path->none~throw_exception proc~json_get_logical_vec_by_path->proc~json_clear_exceptions proc~json_get_logical_vec_by_path->none~get proc~json_get_logical_vec_by_path->proc~flag_not_found proc~json_get_real->none~throw_exception proc~json_get_real->proc~string_to_real proc~json_get_real32->none~get proc~json_get_real32_by_path->none~get proc~json_get_real32_vec->none~get proc~json_get_real32_vec_by_path->none~get proc~json_get_real_by_path->none~throw_exception proc~json_get_real_by_path->proc~json_clear_exceptions proc~json_get_real_by_path->none~get proc~json_get_real_by_path->proc~flag_not_found proc~json_get_real_vec->none~get proc~json_get_real_vec_by_path->none~throw_exception proc~json_get_real_vec_by_path->proc~json_clear_exceptions proc~json_get_real_vec_by_path->none~get proc~json_get_real_vec_by_path->proc~flag_not_found proc~json_get_string->none~throw_exception proc~json_get_string->proc~integer_to_string proc~escape_string escape_string proc~json_get_string->proc~escape_string proc~real_to_string real_to_string proc~json_get_string->proc~real_to_string proc~json_get_string_by_path->none~throw_exception proc~json_get_string_by_path->proc~json_clear_exceptions proc~json_get_string_by_path->none~get proc~json_get_string_by_path->proc~flag_not_found proc~json_get_string_vec->none~get proc~json_get_string_vec_by_path->none~throw_exception proc~json_get_string_vec_by_path->proc~json_clear_exceptions proc~json_get_string_vec_by_path->none~get proc~json_get_string_vec_by_path->proc~flag_not_found proc~json_string_info json_core%json_string_info none~string_info->proc~json_string_info proc~escape_string->proc~valid_json_hex proc~json_get_by_path_default->none~throw_exception proc~json_get_by_path_default->proc~json_value_create proc~json_get_by_path_default->proc~json_clear_exceptions proc~json_get_by_path_default->proc~to_array proc~json_get_by_path_default->proc~to_null proc~json_get_by_path_default->proc~to_object proc~json_get_by_path_default->none~add proc~json_get_by_path_default->proc~string_to_integer none~get_child json_core%get_child proc~json_get_by_path_default->none~get_child proc~json_get_by_path_jsonpath_bracket->none~throw_exception proc~json_get_by_path_jsonpath_bracket->proc~json_value_create proc~json_get_by_path_jsonpath_bracket->proc~json_clear_exceptions proc~json_get_by_path_jsonpath_bracket->proc~to_null proc~json_get_by_path_jsonpath_bracket->none~add proc~json_get_by_path_jsonpath_bracket->proc~string_to_integer proc~json_get_by_path_jsonpath_bracket->none~get_child proc~convert json_core%convert proc~json_get_by_path_jsonpath_bracket->proc~convert proc~json_get_by_path_rfc6901->none~throw_exception proc~json_get_by_path_rfc6901->proc~json_clear_exceptions proc~json_get_by_path_rfc6901->proc~string_to_integer proc~json_get_by_path_rfc6901->none~get_child proc~decode_rfc6901 decode_rfc6901 proc~json_get_by_path_rfc6901->proc~decode_rfc6901 proc~compact_real_string compact_real_string proc~real_to_string->proc~compact_real_string proc~json_value_get_child json_core%json_value_get_child none~get_child->proc~json_value_get_child proc~json_value_get_child_by_index json_core%json_value_get_child_by_index none~get_child->proc~json_value_get_child_by_index proc~json_value_get_child_by_name json_core%json_value_get_child_by_name none~get_child->proc~json_value_get_child_by_name proc~convert->none~throw_exception proc~convert->none~create_array proc~convert->none~create_null proc~convert->none~info none~create_object json_core%create_object proc~convert->none~create_object proc~json_value_replace json_core%json_value_replace proc~convert->proc~json_value_replace proc~replace_string replace_string proc~decode_rfc6901->proc~replace_string proc~json_string_info->none~throw_exception proc~json_string_info->proc~json_clear_exceptions proc~json_string_info->none~info proc~json_string_info->none~get proc~json_value_create_object json_core%json_value_create_object none~create_object->proc~json_value_create_object proc~json_value_get_child->none~throw_exception proc~json_value_get_child_by_index->none~throw_exception proc~json_value_get_child_by_index->proc~json_clear_exceptions proc~json_value_get_child_by_name->none~throw_exception proc~json_value_get_child_by_name->proc~json_clear_exceptions proc~name_equal json_core%name_equal proc~json_value_get_child_by_name->proc~name_equal none~insert_after json_core%insert_after proc~json_value_replace->none~insert_after proc~json_value_remove json_core%json_value_remove proc~json_value_replace->proc~json_value_remove proc~json_value_insert_after json_core%json_value_insert_after none~insert_after->proc~json_value_insert_after proc~json_value_insert_after_child_by_index json_core%json_value_insert_after_child_by_index none~insert_after->proc~json_value_insert_after_child_by_index proc~json_value_create_object->proc~json_value_create proc~json_value_create_object->proc~to_object proc~json_value_remove->none~destroy proc~name_strings_equal json_core%name_strings_equal proc~name_equal->proc~name_strings_equal proc~json_value_insert_after_child_by_index->none~get_child proc~json_value_insert_after_child_by_index->none~insert_after proc~lowercase_string lowercase_string proc~name_strings_equal->proc~lowercase_string

Called by

proc~~json_parse_file~~CalledByGraph proc~json_parse_file json_core%json_parse_file none~load json_core%load none~load->proc~json_parse_file proc~json_file_load json_file%json_file_load proc~json_file_load->none~load

Source Code

    subroutine json_parse_file(json, file, p, unit)

    implicit none

    class(json_core),intent(inout)       :: json
    character(kind=CDK,len=*),intent(in) :: file  !! JSON file name
    type(json_value),pointer             :: p     !! output structure
    integer(IK),intent(in),optional      :: unit  !! file unit number (/= 0)

    integer(IK) :: iunit   !! file unit actually used
    integer(IK) :: istat   !! iostat flag
    logical(LK) :: is_open !! if the file is already open
    logical(LK) :: has_duplicate  !! if checking for duplicate keys
    character(kind=CK,len=:),allocatable :: path !! path to any duplicate key

    ! clear any exceptions and initialize:
    call json%initialize()
    call json%prepare_parser()

    if ( present(unit) ) then

        if (unit==0) then
            call json%throw_exception('Error in json_parse_file: unit number must not be 0.')
            return
        end if

        iunit = unit

        ! check to see if the file is already open
        ! if it is, then use it, otherwise open the file with the name given.
        inquire(unit=iunit, opened=is_open, iostat=istat)
        if (istat==0 .and. .not. is_open) then
           ! open the file
            open (  unit        = iunit, &
                    file        = file, &
                    status      = 'OLD', &
                    action      = 'READ', &
                    form        = form_spec, &
                    access      = access_spec, &
                    iostat      = istat &
                    FILE_ENCODING )
        else
            ! if the file is already open, then we need to make sure
            ! that it is open with the correct form/access/etc...
        end if

    else

        ! open the file with a new unit number:
        open (  newunit     = iunit, &
                file        = file, &
                status      = 'OLD', &
                action      = 'READ', &
                form        = form_spec, &
                access      = access_spec, &
                iostat      = istat &
                FILE_ENCODING )

    end if

    if (istat==0) then

        if (use_unformatted_stream) then
            ! save the file size to be read:
            inquire(unit=iunit, size=json%filesize, iostat=istat)
        end if

        ! create the value and associate the pointer
        call json_value_create(p)

        ! Note: the name of the root json_value doesn't really matter,
        !  but we'll allocate something here just in case.
        p%name = trim(file)  !use the file name

        ! parse as a value
        call json%parse_value(unit=iunit, str=CK_'', value=p)
        call json%parse_end(unit=iunit, str=CK_'')

        ! check for errors:
        if (json%exception_thrown) then
            call json%annotate_invalid_json(iunit,CK_'')
        else
            if (.not. json%allow_duplicate_keys) then
                call json%check_for_duplicate_keys(p,has_duplicate,path=path)
                if (.not. json%exception_thrown) then
                    if (has_duplicate) then
                        call json%throw_exception('Error in json_parse_file: '//&
                                                  'Duplicate key found: '//path)
                    end if
                end if
            end if
        end if

        ! close the file:
        close(unit=iunit, iostat=istat)

    else

        call json%throw_exception('Error in json_parse_file: Error opening file: '//trim(file))
        nullify(p)

    end if

    end subroutine json_parse_file