json_get_by_path Subroutine

  1. json_module.F90
  2. json_module
  3. json_get_by_path

private subroutine json_get_by_path(me, path, p, found)

Arguments

Type IntentOptional AttributesName
type(json_value), intent(in), pointer:: me
character(kind=CK,len=*), intent(in) :: path
type(json_value), intent(out), pointer:: p
logical(kind=LK), intent(out), optional :: found

true if it was found

Description

Returns the json_value pointer given the path string.

Example

     type(json_value),pointer :: dat,p
     logical :: found
     !...
     call json_get(dat,'data(2).version',p,found)

Notes

The following special characters are used to denote paths:

  $         - root
  @         - this
  .         - child object member
  [] or ()  - child array element

Thus, if any of these characters are present in the name key, this routine cannot be used to get the value. In that case, the json_get_child routines would need to be used.

Calls

proc~~json_get_by_path~~CallsGraph proc~json_get_by_path json_get_by_path interface~json_get_child json_get_child proc~json_get_by_path->interface~json_get_child proc~json_clear_exceptions json_clear_exceptions proc~json_get_by_path->proc~json_clear_exceptions interface~throw_exception throw_exception proc~json_get_by_path->interface~throw_exception proc~string_to_integer string_to_integer proc~json_get_by_path->proc~string_to_integer proc~json_value_get_by_index json_value_get_by_index interface~json_get_child->proc~json_value_get_by_index proc~json_value_get_by_name_chars json_value_get_by_name_chars interface~json_get_child->proc~json_value_get_by_name_chars proc~json_throw_exception json_throw_exception interface~throw_exception->proc~json_throw_exception proc~string_to_integer->interface~throw_exception proc~json_value_get_by_index->interface~throw_exception proc~json_value_get_by_name_chars->interface~throw_exception proc~json_count json_count proc~json_value_get_by_name_chars->proc~json_count
Help

Called By

proc~~json_get_by_path~~CalledByGraph proc~json_get_by_path json_get_by_path proc~json_file_get_object json_file_get_object proc~json_file_get_object->proc~json_get_by_path proc~json_get_string_with_path json_get_string_with_path proc~json_get_string_with_path->proc~json_get_by_path proc~json_get_logical_with_path json_get_logical_with_path proc~json_get_logical_with_path->proc~json_get_by_path proc~json_get_double_with_path json_get_double_with_path proc~json_get_double_with_path->proc~json_get_by_path proc~json_get_integer_with_path json_get_integer_with_path proc~json_get_integer_with_path->proc~json_get_by_path proc~json_get_array_with_path json_get_array_with_path proc~json_get_array_with_path->proc~json_get_by_path proc~wrap_json_get_by_path wrap_json_get_by_path proc~wrap_json_get_by_path->proc~json_get_by_path proc~wrap_json_file_get_object wrap_json_file_get_object proc~wrap_json_file_get_object->proc~json_file_get_object proc~wrap_json_get_string_with_path wrap_json_get_string_with_path proc~wrap_json_get_string_with_path->proc~json_get_string_with_path interface~json_get json_get interface~json_get->proc~json_get_by_path interface~json_get->proc~json_get_string_with_path interface~json_get->proc~json_get_logical_with_path interface~json_get->proc~json_get_double_with_path interface~json_get->proc~json_get_integer_with_path interface~json_get->proc~json_get_array_with_path proc~json_get_logical_vec_with_path json_get_logical_vec_with_path interface~json_get->proc~json_get_logical_vec_with_path proc~json_get_string_vec_with_path json_get_string_vec_with_path interface~json_get->proc~json_get_string_vec_with_path proc~json_get_logical_vec json_get_logical_vec interface~json_get->proc~json_get_logical_vec proc~json_get_integer_vec json_get_integer_vec interface~json_get->proc~json_get_integer_vec proc~json_get_integer_vec_with_path json_get_integer_vec_with_path interface~json_get->proc~json_get_integer_vec_with_path proc~json_get_double_vec_with_path json_get_double_vec_with_path interface~json_get->proc~json_get_double_vec_with_path proc~json_get_string_vec json_get_string_vec interface~json_get->proc~json_get_string_vec proc~json_get_double_vec json_get_double_vec interface~json_get->proc~json_get_double_vec proc~json_file_get_string json_file_get_string proc~json_file_get_string->interface~json_get proc~json_file_get_string_vec json_file_get_string_vec proc~json_file_get_string_vec->interface~json_get proc~json_get_logical_vec_with_path->interface~json_get proc~test_12 test_12 proc~test_12->interface~json_get interface~json_update json_update proc~test_12->interface~json_update proc~json_value_remove_if_present json_value_remove_if_present proc~json_value_remove_if_present->interface~json_get proc~json_get_string_vec_with_path->interface~json_get proc~json_file_get_integer json_file_get_integer proc~json_file_get_integer->interface~json_get proc~rename rename proc~rename->interface~json_get proc~rename->interface~json_update proc~json_get_logical_vec->interface~json_get proc~test_2 test_2 proc~test_2->interface~json_get proc~test_2->interface~json_update proc~test_7 test_7 proc~test_7->interface~json_get proc~json_file_get_integer_vec json_file_get_integer_vec proc~json_file_get_integer_vec->interface~json_get proc~json_file_get_double json_file_get_double proc~json_file_get_double->interface~json_get proc~json_update_logical json_update_logical proc~json_update_logical->interface~json_get proc~json_get_integer_vec->interface~json_get proc~json_file_get_double_vec json_file_get_double_vec proc~json_file_get_double_vec->interface~json_get proc~json_update_double json_update_double proc~json_update_double->interface~json_get proc~json_get_integer_vec_with_path->interface~json_get proc~json_update_integer json_update_integer proc~json_update_integer->interface~json_get proc~json_file_get_logical json_file_get_logical proc~json_file_get_logical->interface~json_get proc~json_get_double_vec_with_path->interface~json_get proc~json_update_string json_update_string proc~json_update_string->interface~json_get proc~json_get_string_vec->interface~json_get proc~json_get_double_vec->interface~json_get proc~json_file_get_logical_vec json_file_get_logical_vec proc~json_file_get_logical_vec->interface~json_get proc~test_10 test_10 proc~test_10->interface~json_get interface~json_remove_if_present json_remove_if_present proc~test_10->interface~json_remove_if_present proc~test_10->interface~json_update proc~wrap_json_file_get_string wrap_json_file_get_string proc~wrap_json_file_get_string->proc~json_file_get_string proc~wrap_json_file_get_string_vec wrap_json_file_get_string_vec proc~wrap_json_file_get_string_vec->proc~json_file_get_string_vec proc~wrap_json_get_logical_vec_with_path wrap_json_get_logical_vec_with_path proc~wrap_json_get_logical_vec_with_path->proc~json_get_logical_vec_with_path program~jf_test_12 jf_test_12 program~jf_test_12->proc~test_12 proc~wrap_json_value_remove_if_present wrap_json_value_remove_if_present proc~wrap_json_value_remove_if_present->proc~json_value_remove_if_present interface~json_remove_if_present->proc~json_value_remove_if_present proc~wrap_json_get_string_vec_with_path wrap_json_get_string_vec_with_path proc~wrap_json_get_string_vec_with_path->proc~json_get_string_vec_with_path proc~wrap_json_file_get_integer wrap_json_file_get_integer proc~wrap_json_file_get_integer->proc~json_file_get_integer program~jf_test_2 jf_test_2 program~jf_test_2->proc~test_2 program~jf_test_7 jf_test_7 program~jf_test_7->proc~test_7 proc~wrap_json_file_get_integer_vec wrap_json_file_get_integer_vec proc~wrap_json_file_get_integer_vec->proc~json_file_get_integer_vec proc~wrap_json_file_get_double wrap_json_file_get_double proc~wrap_json_file_get_double->proc~json_file_get_double proc~wrap_json_update_logical wrap_json_update_logical proc~wrap_json_update_logical->proc~json_update_logical interface~json_update->proc~json_update_logical interface~json_update->proc~json_update_double interface~json_update->proc~json_update_integer interface~json_update->proc~json_update_string proc~json_file_update_integer json_file_update_integer proc~json_file_update_integer->interface~json_update proc~json_file_update_string json_file_update_string proc~json_file_update_string->interface~json_update proc~test_1 test_1 proc~test_1->interface~json_update proc~json_file_update_real json_file_update_real proc~json_file_update_real->interface~json_update proc~json_file_update_logical json_file_update_logical proc~json_file_update_logical->interface~json_update proc~wrap_json_file_update_integer wrap_json_file_update_integer proc~wrap_json_file_update_integer->proc~json_file_update_integer proc~json_file_update_string_name_ascii json_file_update_string_name_ascii proc~json_file_update_string_name_ascii->proc~json_file_update_string proc~wrap_json_file_update_string wrap_json_file_update_string proc~wrap_json_file_update_string->proc~json_file_update_string proc~json_file_update_string_val_ascii json_file_update_string_val_ascii proc~json_file_update_string_val_ascii->proc~json_file_update_string program~jf_test_1 jf_test_1 program~jf_test_1->proc~test_1 proc~wrap_json_file_update_real wrap_json_file_update_real proc~wrap_json_file_update_real->proc~json_file_update_real proc~wrap_json_file_update_logical wrap_json_file_update_logical proc~wrap_json_file_update_logical->proc~json_file_update_logical proc~wrap_json_file_get_double_vec wrap_json_file_get_double_vec proc~wrap_json_file_get_double_vec->proc~json_file_get_double_vec proc~wrap_json_update_double wrap_json_update_double proc~wrap_json_update_double->proc~json_update_double proc~wrap_json_get_integer_vec_with_path wrap_json_get_integer_vec_with_path proc~wrap_json_get_integer_vec_with_path->proc~json_get_integer_vec_with_path proc~wrap_json_update_integer wrap_json_update_integer proc~wrap_json_update_integer->proc~json_update_integer proc~wrap_json_file_get_logical wrap_json_file_get_logical proc~wrap_json_file_get_logical->proc~json_file_get_logical proc~wrap_json_get_double_vec_with_path wrap_json_get_double_vec_with_path proc~wrap_json_get_double_vec_with_path->proc~json_get_double_vec_with_path proc~json_update_string_name_ascii json_update_string_name_ascii proc~json_update_string_name_ascii->proc~json_update_string proc~wrap_json_update_string wrap_json_update_string proc~wrap_json_update_string->proc~json_update_string proc~json_update_string_val_ascii json_update_string_val_ascii proc~json_update_string_val_ascii->proc~json_update_string proc~wrap_json_file_get_logical_vec wrap_json_file_get_logical_vec proc~wrap_json_file_get_logical_vec->proc~json_file_get_logical_vec program~jf_test_10 jf_test_10 program~jf_test_10->proc~test_10 proc~wrap_json_get_logical_with_path wrap_json_get_logical_with_path proc~wrap_json_get_logical_with_path->proc~json_get_logical_with_path proc~wrap_json_get_double_with_path wrap_json_get_double_with_path proc~wrap_json_get_double_with_path->proc~json_get_double_with_path proc~wrap_json_get_integer_with_path wrap_json_get_integer_with_path proc~wrap_json_get_integer_with_path->proc~json_get_integer_with_path proc~wrap_json_get_array_with_path wrap_json_get_array_with_path proc~wrap_json_get_array_with_path->proc~json_get_array_with_path
Help

Variables

TypeVisibility AttributesNameInitial
character(kind=CK,len=1), public, parameter:: start_array_alt ='('
character(kind=CK,len=1), public, parameter:: end_array_alt =')'
character(kind=CK,len=1), public, parameter:: root ='$'
character(kind=CK,len=1), public, parameter:: this ='@'
character(kind=CK,len=1), public, parameter:: child ='.'
integer(kind=IK), public :: i
integer(kind=IK), public :: length
integer(kind=IK), public :: child_i
character(kind=CK,len=1), public :: c
logical(kind=LK), public :: array
type(json_value), public, pointer:: tmp

Source Code

    subroutine json_get_by_path(me, path, p, found)

    implicit none

    type(json_value),pointer,intent(in)  :: me
    character(kind=CK,len=*),intent(in)  :: path
    type(json_value),pointer,intent(out) :: p
    logical(LK),intent(out),optional     :: found  !! true if it was found

    character(kind=CK,len=1),parameter :: start_array_alt = '('
    character(kind=CK,len=1),parameter :: end_array_alt   = ')'
    character(kind=CK,len=1),parameter :: root            = '$'
    character(kind=CK,len=1),parameter :: this            = '@'
    character(kind=CK,len=1),parameter :: child           = '.'

    integer(IK)              :: i,length,child_i
    character(kind=CK,len=1) :: c
    logical(LK)              :: array
    type(json_value),pointer :: tmp

    if (.not. exception_thrown) then

        nullify(p)

        ! default to assuming relative to this
        p => me

        child_i = 1

        array = .false.

        length = len_trim(path)

        do i=1, length

            c = path(i:i)

            select case (c)
            case (root)

                ! root
                do while (associated (p%parent))
                    p => p%parent
                end do
                child_i = i + 1

            case (this)

                ! this
                p => me
                child_i = i + 1

            case (child)

                ! get child member from p
                if (child_i < i) then
                    nullify(tmp)
                    call json_get_child(p, path(child_i:i-1), tmp)
                    p => tmp
                    nullify(tmp)
                else
                    child_i = i + 1
                    cycle
                end if

                if (.not. associated(p)) then
                    call throw_exception('Error in json_get_by_path:'//&
                                         ' Error getting child member.')
                    exit
                end if

                child_i = i+1

            case (start_array,start_array_alt)

                !....Modified to allow for 'var[3]' style syntax
                !Note: jmozmoz/fson has a slightly different version of this...

                ! start looking for the array element index
                array = .true.

                ! get child member from p
                if (child_i < i) then
                    nullify(tmp)
                    call json_get_child(p, path(child_i:i-1), tmp)
                    p => tmp
                    nullify(tmp)
                else
                    child_i = i + 1
                    cycle
                end if
                if (.not. associated(p)) then
                    call throw_exception('Error in json_get_by_path:'//&
                                         ' Error getting array element')
                    exit
                end if
                child_i = i + 1

            case (end_array,end_array_alt)

                if (.not.array) then
                    call throw_exception('Error in json_get_by_path: Unexpected ]')
                    exit
                end if
                array = .false.
                child_i = string_to_integer(path(child_i:i-1))

                nullify(tmp)
                call json_get_child(p, child_i, tmp)
                p => tmp
                nullify(tmp)

                child_i= i + 1

            end select

        end do

        if (exception_thrown) then

            if (present(found)) then
                found = .false.
                call json_clear_exceptions()
            end if

        else

            ! grab the last child if present in the path
            if (child_i <= length) then
                nullify(tmp)
                call json_get_child(p, path(child_i:i-1), tmp)
                p => tmp
                nullify(tmp)
            end if
            if (associated(p)) then
                if (present(found)) found = .true.    !everything seems to be ok
            else
                call throw_exception('Error in json_get_by_path:'//&
                                     ' variable not found: '//trim(path))
                if (present(found)) then
                    found = .false.
                    call json_clear_exceptions()
                end if
            end if

        end if

    else
        if (present(found)) found = .false.
    end if

    end subroutine json_get_by_path