Added a rename function. Fixes #184

Author: jacobwilliams

src/json_value_module.F90

@@ -375,10 +375,6 @@ module json_value_module
         procedure :: json_value_destroy
         procedure :: destroy_json_core
 
-        !>
-        !  Remove a [[json_value]] from a linked-list structure.
-        procedure,public :: remove => json_value_remove
-
         !>
         !  If the child variable is present, then remove it.
         generic,public :: remove_if_present => MAYBEWRAP(json_value_remove_if_present)
@@ -491,23 +487,17 @@ module json_value_module
         procedure :: json_parse_file
         procedure :: MAYBEWRAP(json_parse_string)
 
-        !>
-        !  Swap two [[json_value]] pointers in a structure
-        !  (or two different structures).
-        generic,public :: swap => json_value_swap
-        procedure :: json_value_swap
-
-        !>
-        !  Check if a [[json_value]] is a child of another.
-        generic,public :: is_child_of => json_value_is_child_of
-        procedure :: json_value_is_child_of
-
         !>
         !  Throw an exception.
         generic,public :: throw_exception => MAYBEWRAP(json_throw_exception)
         procedure :: MAYBEWRAP(json_throw_exception)
 
-        !public routines:
+        !>
+        !  Rename a [[json_value]] variable.
+        generic,public :: rename => MAYBEWRAP(json_value_rename)
+        procedure :: MAYBEWRAP(json_value_rename)
+
+        procedure,public :: remove              => json_value_remove        !! Remove a [[json_value]] from a linked-list structure.
         procedure,public :: check_for_errors    => json_check_for_errors    !! check for error and get error message
         procedure,public :: clear_exceptions    => json_clear_exceptions    !! clear exceptions
         procedure,public :: count               => json_count               !! count the number of children
@@ -521,6 +511,9 @@ module json_value_module
         procedure,public :: initialize          => json_initialize          !! to initialize some parsing parameters
         procedure,public :: traverse            => json_traverse            !! to traverse all elements of a JSON structure
         procedure,public :: print_error_message => json_print_error_message !! simply routine to print error messages
+        procedure,public :: swap                => json_value_swap          !! Swap two [[json_value]] pointers
+                                                                            !! in a structure (or two different structures).
+        procedure,public :: is_child_of         => json_value_is_child_of   !! Check if a [[json_value]] is a child of another.
 
         !other private routines:
         procedure :: json_value_print
@@ -914,11 +907,55 @@ subroutine json_info(json,p,var_type,n_children,name)
 
     if (present(var_type))    var_type   = p%var_type
     if (present(n_children))  n_children = json%count(p)
-    if (present(name))        name       = p%name
+    if (present(name)) then
+        if (allocated(p%name)) then
+            name = p%name
+        else
+            name = ''
+        end if
+    end if
 
     end subroutine json_info
 !*****************************************************************************************
 
+!*****************************************************************************************
+!> author: Jacob Williams
+!  date: 4/29/2016
+!
+!  Rename a [[json_value]].
+
+    subroutine json_value_rename(json,p,name)
+
+    implicit none
+
+    class(json_core),intent(inout)      :: json
+    type(json_value),pointer,intent(in) :: p
+    character(kind=CK,len=*),intent(in) :: name !! new variable name
+
+    p%name = name
+
+    end subroutine json_value_rename
+!*****************************************************************************************
+
+!*****************************************************************************************
+!> author: Jacob Williams
+!  date: 4/29/2016
+!
+!  Alternate version of [[json_value_rename]], where `name` is kind=CDK.
+
+    subroutine wrap_json_value_rename(json,p,name)
+
+    implicit none
+
+    class(json_core),intent(inout)       :: json
+    type(json_value),pointer,intent(in)  :: p
+    character(kind=CDK,len=*),intent(in) :: name !! new variable name
+
+    call json%rename(p,to_unicode(name))
+
+    end subroutine wrap_json_value_rename
+!*****************************************************************************************
+
 !*****************************************************************************************
 !> author: Jacob Williams
 !  date: 12/4/2013

src/tests/jf_test_17.f90

@@ -0,0 +1,86 @@
+!*****************************************************************************************
+!> author: Jacob Williams
+!  date: 4/29/2017
+!
+! Module for the 17th unit test.
+! Test the `rename` function.
+
+module jf_test_17_mod
+
+    use json_module, CK => json_CK
+    use, intrinsic :: iso_fortran_env , only: error_unit,output_unit
+
+    implicit none
+
+contains
+
+    subroutine test_17(error_cnt)
+
+    !! Test the `rename` function.
+
+    implicit none
+
+    integer,intent(out) :: error_cnt !! report number of errors to caller
+
+    type(json_core) :: json
+    type(json_value),pointer :: p,q
+
+    write(error_unit,'(A)') ''
+    write(error_unit,'(A)') '================================='
+    write(error_unit,'(A)') '   TEST 17'
+    write(error_unit,'(A)') '================================='
+    write(error_unit,'(A)') ''
+
+    error_cnt = 0
+
+    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]}}')
+    if (json%failed()) then
+        call json%print_error_message(error_unit)
+        error_cnt = error_cnt + 1
+    end if
+    call json%print(p,error_unit)
+
+    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%print(p,output_unit)
+    if (json%failed()) then
+        call json%print_error_message(error_unit)
+        error_cnt = error_cnt + 1
+    end if
+    nullify(q)
+    !verifty that it was renamed:
+    call json%get(p,'cities',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)
+
+    !cleanup:
+    call json%destroy(p)
+
+    end subroutine test_17
+
+end module jf_test_17_mod
+!*****************************************************************************************
+
+!*****************************************************************************************
+program jf_test_17
+
+    !! 17th unit test.
+
+    use jf_test_17_mod, only: test_17
+    implicit none
+    integer :: n_errors
+    call test_17(n_errors)
+    if ( n_errors /= 0) stop 1
+
+end program jf_test_17
+!*****************************************************************************************