Info

codecov.yml

@@ -8,6 +8,8 @@ coverage:
   - doc
   status:
     patch:
-      default: {}
+      default:
+        target: 70%
     project:
-      default: {}
+      default:
+        target: 70%

src/json_file_module.F90

@@ -78,6 +78,7 @@ module json_file_module
         procedure,public :: destroy => json_file_destroy
         procedure,public :: move    => json_file_move_pointer
         generic,public   :: info    => MAYBEWRAP(json_file_variable_info)
+        generic,public   :: matrix_info => MAYBEWRAP(json_file_variable_matrix_info)
 
         !error checking:
         procedure,public :: failed => json_file_failed
@@ -125,8 +126,9 @@ module json_file_module
         procedure :: initialize_json_core_in_file
         procedure :: set_json_core_in_file
 
-        !git info:
+        !get info:
         procedure :: MAYBEWRAP(json_file_variable_info)
+        procedure :: MAYBEWRAP(json_file_variable_matrix_info)
 
         !get:
         procedure :: MAYBEWRAP(json_file_get_object)
@@ -648,61 +650,113 @@ end subroutine json_file_print_to_string
 !  date: 2/3/2014
 !
 !  Returns information about a variable in a [[json_file(type)]].
+!
+!@note If `found` is present, no exceptions will be thrown if an
+!      error occurs. Otherwise, an exception will be thrown if the
+!      variable is not found.
 
-    subroutine json_file_variable_info(me,path,found,var_type,n_children)
+    subroutine json_file_variable_info(me,path,found,var_type,n_children,name)
 
     implicit none
 
     class(json_file),intent(inout)      :: me
     character(kind=CK,len=*),intent(in) :: path       !! path to the variable
-    logical(LK),intent(out)             :: found      !! the variable exists in the structure
-    integer(IK),intent(out)             :: var_type   !! variable type
-    integer(IK),intent(out)             :: n_children !! number of children
+    logical(LK),intent(out),optional    :: found      !! the variable exists in the structure
+    integer(IK),intent(out),optional    :: var_type   !! variable type
+    integer(IK),intent(out),optional    :: n_children !! number of children
+    character(kind=CK,len=:),allocatable,intent(out),optional :: name !! variable name
 
-    type(json_value),pointer :: p
+    call me%core%info(me%p,path,found,var_type,n_children,name)
 
-    !initialize:
-    nullify(p)
+    end subroutine json_file_variable_info
+!*****************************************************************************************
 
-    !get a pointer to the variable (if it is there):
-    call me%get(path,p,found)
+!*****************************************************************************************
+!>
+!  Alternate version of [[json_file_variable_info]], where "path" is kind=CDK.
+!
+!@note If `found` is present, no exceptions will be thrown if an
+!      error occurs. Otherwise, an exception will be thrown if the
+!      variable is not found.
 
-    if (found) then
+    subroutine wrap_json_file_variable_info(me,path,found,var_type,n_children,name)
 
-        !get info:
-        call me%core%info(p,var_type,n_children)
+    implicit none
 
-    else
+    class(json_file),intent(inout)       :: me
+    character(kind=CDK,len=*),intent(in) :: path
+    logical(LK),intent(out),optional     :: found
+    integer(IK),intent(out),optional     :: var_type
+    integer(IK),intent(out),optional     :: n_children
+    character(kind=CK,len=:),allocatable,intent(out),optional :: name !! variable name
 
-        !set to dummy values:
-        var_type = json_unknown
-        n_children = 0
+    call me%info(to_unicode(path),found,var_type,n_children,name)
 
-    end if
+    end subroutine wrap_json_file_variable_info
+!*****************************************************************************************
 
-    !cleanup:
-    nullify(p)
+!*****************************************************************************************
+!> author: Jacob Williams
+!  date: 6/26/2016
+!
+!  Returns matrix information about a variable in a [[json_file(type)]].
+!
+!@note If `found` is present, no exceptions will be thrown if an
+!      error occurs. Otherwise, an exception will be thrown if the
+!      variable is not found.
 
-    end subroutine json_file_variable_info
+    subroutine json_file_variable_matrix_info(me,path,is_matrix,found,&
+                                        var_type,n_sets,set_size,name)
+
+    implicit none
+
+    class(json_file),intent(inout)      :: me
+    character(kind=CK,len=*),intent(in) :: path      !! path to the variable
+    logical(LK),intent(out)             :: is_matrix !! true if it is a valid matrix
+    logical(LK),intent(out),optional    :: found     !! true if it was found
+    integer(IK),intent(out),optional    :: var_type  !! variable type of data in
+                                                     !! the matrix (if all elements have
+                                                     !! the same type)
+    integer(IK),intent(out),optional    :: n_sets    !! number of data sets (i.e., matrix
+                                                     !! rows if using row-major order)
+    integer(IK),intent(out),optional    :: set_size  !! size of each data set (i.e., matrix
+                                                     !! cols if using row-major order)
+    character(kind=CK,len=:),allocatable,intent(out),optional :: name !! variable name
+
+    call me%core%matrix_info(me%p,path,is_matrix,found,var_type,n_sets,set_size,name)
+
+    end subroutine json_file_variable_matrix_info
 !*****************************************************************************************
 
 !*****************************************************************************************
 !>
-!  Alternate version of [[json_file_variable_info]], where "path" is kind=CDK.
+!  Alternate version of [[json_file_variable_matrix_info]], where "path" is kind=CDK.
+!
+!@note If `found` is present, no exceptions will be thrown if an
+!      error occurs. Otherwise, an exception will be thrown if the
+!      variable is not found.
 
-    subroutine wrap_json_file_variable_info(me,path,found,var_type,n_children)
+    subroutine wrap_json_file_variable_matrix_info(me,path,is_matrix,found,&
+                                                   var_type,n_sets,set_size,name)
 
     implicit none
 
     class(json_file),intent(inout)       :: me
-    character(kind=CDK,len=*),intent(in) :: path
-    logical(LK),intent(out)              :: found
-    integer(IK),intent(out)              :: var_type
-    integer(IK),intent(out)              :: n_children
-
-    call me%info(to_unicode(path),found,var_type,n_children)
-
-    end subroutine wrap_json_file_variable_info
+    character(kind=CDK,len=*),intent(in) :: path      !! path to the variable
+    logical(LK),intent(out)              :: is_matrix !! true if it is a valid matrix
+    logical(LK),intent(out),optional     :: found     !! true if it was found
+    integer(IK),intent(out),optional     :: var_type  !! variable type of data in
+                                                      !! the matrix (if all elements have
+                                                      !! the same type)
+    integer(IK),intent(out),optional     :: n_sets    !! number of data sets (i.e., matrix
+                                                      !! rows if using row-major order)
+    integer(IK),intent(out),optional     :: set_size  !! size of each data set (i.e., matrix
+                                                      !! cols if using row-major order)
+    character(kind=CK,len=:),allocatable,intent(out),optional :: name !! variable name
+
+    call me%matrix_info(to_unicode(path),is_matrix,found,var_type,n_sets,set_size,name)
+
+    end subroutine wrap_json_file_variable_matrix_info
 !*****************************************************************************************
 
 !*****************************************************************************************