Merge pull request #317 from jacobwilliams/rename

added routines to rename a json variable by specifying the path.

Author: jacobwilliams

src/json_file_module.F90

@@ -92,6 +92,15 @@ module json_file_module
                                         json_file_print_1, &
                                         json_file_print_2
 
+
+        !>
+        !  Rename a variable, specifying it by path
+        generic,public :: rename => MAYBEWRAP(json_file_rename)
+#ifdef USE_UCS4
+        generic,public :: rename => json_file_rename_path_ascii, &
+                                    json_file_rename_name_ascii
+#endif
+
         !>
         !  Get a variable from a [[json_file(type)]], by specifying the path.
         generic,public :: get => MAYBEWRAP(json_file_get_object),      &
@@ -173,6 +182,13 @@ module json_file_module
         procedure :: MAYBEWRAP(json_file_variable_info)
         procedure :: MAYBEWRAP(json_file_variable_matrix_info)
 
+        !rename:
+        procedure :: MAYBEWRAP(json_file_rename)
+#ifdef USE_UCS4
+        procedure :: json_file_rename_path_ascii
+        procedure :: json_file_rename_name_ascii
+#endif
+
         !get:
         procedure :: MAYBEWRAP(json_file_get_object)
         procedure :: MAYBEWRAP(json_file_get_integer)
@@ -850,6 +866,82 @@ subroutine json_file_get_root(me,p)
     end subroutine json_file_get_root
 !*****************************************************************************************
 
+!*****************************************************************************************
+!> author: Jacob Williams
+!
+!  Rename a variable in a JSON file.
+
+    subroutine json_file_rename(me,path,name,found)
+
+    implicit none
+
+    class(json_file),intent(inout)      :: me
+    character(kind=CK,len=*),intent(in) :: path   !! the path to the variable
+    character(kind=CK,len=*),intent(in) :: name   !! the new name
+    logical(LK),intent(out),optional    :: found  !! if the variable was found
+
+    call me%core%rename(me%p, path, name, found)
+
+    end subroutine json_file_rename
+!*****************************************************************************************
+
+!*****************************************************************************************
+!> author: Jacob Williams
+!
+!  Alternate version of [[json_file_rename]], where "path" and "name" are kind=CDK.
+
+    subroutine wrap_json_file_rename(me,path,name,found)
+
+    implicit none
+
+    class(json_file),intent(inout)       :: me
+    character(kind=CDK,len=*),intent(in) :: path   !! the path to the variable
+    character(kind=CDK,len=*),intent(in) :: name   !! the new name
+    logical(LK),intent(out),optional     :: found  !! if the variable was found
+
+    call me%json_file_rename(to_unicode(path),to_unicode(name),found)
+
+    end subroutine wrap_json_file_rename
+!*****************************************************************************************
+
+!*****************************************************************************************
+!> author: Jacob Williams
+!
+!  Wrapper for [[json_file_rename]] where "path" is kind=CDK).
+
+    subroutine json_file_rename_path_ascii(me,path,name,found)
+
+    implicit none
+
+    class(json_file),intent(inout)       :: me
+    character(kind=CDK,len=*),intent(in) :: path   !! the path to the variable
+    character(kind=CK,len=*),intent(in)  :: name   !! the new name
+    logical(LK),intent(out),optional     :: found  !! if the variable was found
+
+    call me%json_file_rename(to_unicode(path),name,found)
+
+    end subroutine json_file_rename_path_ascii
+!*****************************************************************************************
+
+!*****************************************************************************************
+!> author: Jacob Williams
+!
+!  Wrapper for [[json_file_rename]] where "name" is kind=CDK).
+
+    subroutine json_file_rename_name_ascii(me,path,name,found)
+
+    implicit none
+
+    class(json_file),intent(inout)       :: me
+    character(kind=CK,len=*),intent(in)  :: path   !! the path to the variable
+    character(kind=CDK,len=*),intent(in) :: name   !! the new name
+    logical(LK),intent(out),optional     :: found  !! if the variable was found
+
+    call me%json_file_rename(path,to_unicode(name),found)
+
+    end subroutine json_file_rename_name_ascii
+!*****************************************************************************************
+
 !*****************************************************************************************
 !> author: Jacob Williams
 !  date: 2/3/2014

src/json_value_module.F90

@@ -278,21 +278,21 @@ module json_value_module
                                  json_value_add_string_vec_val_ascii
 #endif
 
-    procedure,private :: json_value_add_member
-    procedure,private :: MAYBEWRAP(json_value_add_integer)
-    procedure,private :: MAYBEWRAP(json_value_add_null)
-    procedure,private :: MAYBEWRAP(json_value_add_integer_vec)
-    procedure,private :: MAYBEWRAP(json_value_add_double)
-    procedure,private :: MAYBEWRAP(json_value_add_double_vec)
-    procedure,private :: MAYBEWRAP(json_value_add_logical)
-    procedure,private :: MAYBEWRAP(json_value_add_logical_vec)
-    procedure,private :: MAYBEWRAP(json_value_add_string)
-    procedure,private :: MAYBEWRAP(json_value_add_string_vec)
+        procedure,private :: json_value_add_member
+        procedure,private :: MAYBEWRAP(json_value_add_integer)
+        procedure,private :: MAYBEWRAP(json_value_add_null)
+        procedure,private :: MAYBEWRAP(json_value_add_integer_vec)
+        procedure,private :: MAYBEWRAP(json_value_add_double)
+        procedure,private :: MAYBEWRAP(json_value_add_double_vec)
+        procedure,private :: MAYBEWRAP(json_value_add_logical)
+        procedure,private :: MAYBEWRAP(json_value_add_logical_vec)
+        procedure,private :: MAYBEWRAP(json_value_add_string)
+        procedure,private :: MAYBEWRAP(json_value_add_string_vec)
 #ifdef USE_UCS4
-    procedure,private :: json_value_add_string_name_ascii
-    procedure,private :: json_value_add_string_val_ascii
-    procedure,private :: json_value_add_string_vec_name_ascii
-    procedure,private :: json_value_add_string_vec_val_ascii
+        procedure,private :: json_value_add_string_name_ascii
+        procedure,private :: json_value_add_string_val_ascii
+        procedure,private :: json_value_add_string_vec_name_ascii
+        procedure,private :: json_value_add_string_vec_val_ascii
 #endif
 
         !>
@@ -625,8 +625,16 @@ module json_value_module
 
         !>
         !  Rename a [[json_value]] variable.
-        generic,public :: rename => MAYBEWRAP(json_value_rename)
+        generic,public :: rename => MAYBEWRAP(json_value_rename),&
+                                    MAYBEWRAP(json_rename_by_path)
         procedure :: MAYBEWRAP(json_value_rename)
+        procedure :: MAYBEWRAP(json_rename_by_path)
+#ifdef USE_UCS4
+        generic,public :: rename => json_rename_by_path_name_ascii,&
+                                    json_rename_by_path_path_ascii
+        procedure :: json_rename_by_path_name_ascii
+        procedure :: json_rename_by_path_path_ascii
+#endif
 
         !>
         !  get info about a [[json_value]]
@@ -5678,6 +5686,107 @@ subroutine wrap_json_create_by_path(json,me,path,p,found,was_created)
     end subroutine wrap_json_create_by_path
 !*****************************************************************************************
 
+!*****************************************************************************************
+!>
+!  Rename a [[json_value]], given the path.
+
+    subroutine json_rename_by_path(json, me, path, name, found)
+
+    implicit none
+
+    class(json_core),intent(inout)       :: json
+    type(json_value),pointer,intent(in)  :: me
+    character(kind=CK,len=*),intent(in)  :: path
+    character(kind=CK,len=*),intent(in)  :: name  !! the new name
+    logical(LK),intent(out),optional     :: found
+
+    type(json_value),pointer :: p
+
+    if ( json%exception_thrown ) then
+        if ( present(found) ) found = .false.
+        return
+    end if
+
+    nullify(p)
+    call json%get(me=me, path=path, p=p)
+
+    if (.not. associated(p)) then
+        call json%throw_exception('Error in json_rename_by_path:'//&
+                                  ' Unable to resolve path: '//trim(path))
+    else
+        call json%rename(p,name)
+        nullify(p)
+    end if
+
+    if (json%exception_thrown) then
+        if (present(found)) then
+            found = .false.
+            call json%clear_exceptions()
+        end if
+    else
+        if (present(found)) found = .true.
+    end if
+
+    end subroutine json_rename_by_path
+!*****************************************************************************************
+
+!*****************************************************************************************
+!>
+!  Alternate version of [[json_rename_by_path]], where "path" and "name" are kind=CDK
+
+    subroutine wrap_json_rename_by_path(json, me, path, name, found)
+
+    implicit none
+
+    class(json_core),intent(inout)        :: json
+    type(json_value),pointer,intent(in)   :: me
+    character(kind=CDK,len=*),intent(in)  :: path
+    character(kind=CDK,len=*),intent(in)  :: name
+    logical(LK),intent(out),optional      :: found
+
+    call json%rename(me,to_unicode(path),to_unicode(name),found)
+
+    end subroutine wrap_json_rename_by_path
+!*****************************************************************************************
+
+!*****************************************************************************************
+!>
+!  Alternate version of [[json_rename_by_path]], where "name" is kind=CDK
+
+    subroutine json_rename_by_path_name_ascii(json, me, path, name, found)
+
+    implicit none
+
+    class(json_core),intent(inout)        :: json
+    type(json_value),pointer,intent(in)   :: me
+    character(kind=CK,len=*),intent(in)   :: path
+    character(kind=CDK,len=*),intent(in)  :: name
+    logical(LK),intent(out),optional      :: found
+
+    call json%rename(me,path,to_unicode(name),found)
+
+    end subroutine json_rename_by_path_name_ascii
+!*****************************************************************************************
+
+!*****************************************************************************************
+!>
+!  Alternate version of [[json_rename_by_path]], where "path" is kind=CDK
+
+    subroutine json_rename_by_path_path_ascii(json, me, path, name, found)
+
+    implicit none
+
+    class(json_core),intent(inout)        :: json
+    type(json_value),pointer,intent(in)   :: me
+    character(kind=CDK,len=*),intent(in)  :: path
+    character(kind=CK,len=*),intent(in)   :: name
+    logical(LK),intent(out),optional      :: found
+
+    call json%rename(me,to_unicode(path),name,found)
+
+    end subroutine json_rename_by_path_path_ascii
+!*****************************************************************************************
+
 !*****************************************************************************************
 !>
 !  Returns the [[json_value]] pointer given the path string.

src/tests/jf_test_17.F90

@@ -7,7 +7,7 @@
 
 module jf_test_17_mod
 
-    use json_module, CK => json_CK
+    use json_module, CK => json_CK, CDK => json_CDK
     use, intrinsic :: iso_fortran_env , only: error_unit,output_unit
 
     implicit none
@@ -24,6 +24,11 @@ subroutine test_17(error_cnt)
 
     type(json_core) :: json
     type(json_value),pointer :: p,q
+    type(json_file) :: f
+
+    character(kind=CK,len=*),parameter :: json_string = &
+        '{"city": ["New York","Los Angeles","Chicago"], '//&
+        '"value": 1, "iflag": true, "struct":{"vec":[1,2,3]}}'
 
     write(error_unit,'(A)') ''
     write(error_unit,'(A)') '================================='
@@ -35,8 +40,7 @@ subroutine test_17(error_cnt)
 
     write(error_unit,'(A)') ''
     write(error_unit,'(A)') 'Original:'
-    call json%parse(p, '{"city": ["New York","Los Angeles","Chicago"], '//&
-                       '"value": 1, "iflag": true, "struct":{"vec":[1,2,3]}}')
+    call json%parse(p, json_string)
     if (json%failed()) then
         call json%print_error_message(error_unit)
         error_cnt = error_cnt + 1
@@ -46,13 +50,16 @@ subroutine test_17(error_cnt)
     write(error_unit,'(A)') ''
     write(error_unit,'(A)') 'Rename: "city" to "cities"'
     call json%get(p,'city',q)
-    call json%rename(q,'cities')
+    call json%rename(q,'cities')     ! also test the unicode ones
+    call json%rename(q,CK_'cities')
+    call json%rename(q,CDK_'cities')
     call json%print(p,output_unit)
     if (json%failed()) then
         call json%print_error_message(error_unit)
         error_cnt = error_cnt + 1
     end if
     nullify(q)
+
     !verify that it was renamed:
     call json%get(p,'cities',q)
     if (json%failed()) then
@@ -63,9 +70,52 @@ subroutine test_17(error_cnt)
     end if
     nullify(q)
 
+    ! rename by specifying the path:
+    write(error_unit,'(A)') ''
+    write(error_unit,'(A)') 'Rename: "iflag" to "flag"'
+    call json%rename(p,'iflag','flag')
+    call json%print(p,output_unit)
+    if (json%failed()) then
+        call json%print_error_message(error_unit)
+        error_cnt = error_cnt + 1
+    end if
+    call json%get(p,'flag',q)
+    if (json%failed()) then
+        call json%print_error_message(error_unit)
+        error_cnt = error_cnt + 1
+    else
+        write(error_unit,'(A)') 'Success!'
+    end if
+    nullify(q)
+
+    ! unicode wrappers:
+    call json%rename(p,CK_'flag',  CK_'iflag')
+    call json%rename(p,CK_'iflag', CDK_'flag')
+    call json%rename(p,CDK_'flag', CK_'iflag')
+    call json%rename(p,CDK_'iflag',CDK_'flag')
+    if (json%failed()) then
+        call json%print_error_message(error_unit)
+        error_cnt = error_cnt + 1
+    else
+        write(error_unit,'(A)') 'Success!'
+    end if
+
     !cleanup:
     call json%destroy(p)
 
+    ! test the corresponding json_file version:
+    call f%load_from_string(json_string)
+    call f%rename(CK_'iflag',  CK_'flag')
+    call f%rename(CK_'flag',   CDK_'iflag')
+    call f%rename(CDK_'iflag', CK_'flag')
+    call f%rename(CDK_'flag',  CDK_'iflag')
+    if (f%failed()) then
+        call f%print_error_message(error_unit)
+        error_cnt = error_cnt + 1
+    else
+        write(error_unit,'(A)') 'Success!'
+    end if
+
     end subroutine test_17
 
 end module jf_test_17_mod
@@ -85,4 +135,4 @@ program jf_test_17
 
 end program jf_test_17
 !*****************************************************************************************
-#endif
+#endif