Merge pull request #251 from jacobwilliams/rfc6901

jacobwilliams · web-flow · commit ff13e4785766 · 2017-02-06T21:03:41.000-06:00
Add RFC 6901 support.
diff --git a/.travis.yml b/.travis.yml
@@ -1,7 +1,7 @@
 language: python
 
 python:
-  - 2.7
+  - 3.5
 
 sudo: false
 
@@ -57,6 +57,7 @@ install:
   - ln -fs /usr/bin/gfortran-4.9 "$HOME/.local/bin/gfortran" && gfortran --version
   - ls -l /usr/bin/gfortran-4.9
   - ln -fs /usr/bin/gcov-4.9 "$HOME/.local/bin/gcov" && gcov --version
+  - perl --version
   - |
     if ! which f90split; then
       wget http://people.sc.fsu.edu/~jburkardt/f_src/f90split/f90split.f90 && \
diff --git a/build.sh b/build.sh
@@ -68,6 +68,8 @@
 #    Jacob Williams : 12/27/2014
 #
 
+#set -x
+#set -v
 set -o errexit
 
 FORDMD='json-fortran.md'        # FORD options file for building documentation
@@ -314,13 +316,19 @@ if [[ $JF_SKIP_TESTS != [yY]* ]] ; then
     # run next commands in subshell to avoid `cd -`
     (cd "$BINDIR"
     GLOBIGNORE='*.*'
-    #
-    for TEST in jf_test_*; do
+    # from: http://stackoverflow.com/questions/7992689/bash-how-to-loop-all-files-in-sorted-order
+    ls jf_test_* | sed 's/^\([^0-9]*\)\([0-9]*\)/\1 \2/' | sort -k2,2n | tr -d ' ' |
+    while read TEST; do
         # It would be nice to run json output printed to stdout through jsonlint, however,
         # some tests output more than one json structure and these need to be split
+        echo ""
+        echo "======================================================"
+        echo ""
         echo "Running ${TEST}"
         "./${TEST}"
     done)
+    echo ""
+    echo "======================================================"
     GLOBIGNORE="$OLD_IGNORES"
     if [[ $CODE_COVERAGE = [yY]* ]] ; then
         for SRCFILE in json_string_utilities.F90 json_value_module.F90 json_file_module.F90 ; do
@@ -337,6 +345,23 @@ if [[ $JF_SKIP_TESTS != [yY]* ]] ; then
                 mv ${SRCFILE}.gcov ${SRCFILE}-no-unicode.gcov
             fi
             if [ -f ${SRCFILE}-unicode.gcov ] && [ -f ${SRCFILE}-no-unicode.gcov ]; then
+
+                ############## for debugging
+                #echo ""
+                #echo "-------------------"
+                #echo "no-unicode file"
+                #echo "-------------------"
+                #cat ${SRCFILE}-no-unicode.gcov
+                #echo ""
+                #echo "-------------------"
+                #echo "unicode file"
+                #echo "-------------------"
+                #cat ${SRCFILE}-unicode.gcov
+                #echo ""
+                #./pages/development-resources/gccr.pl -n -c ${SRCFILE}-no-unicode.gcov no-unicode \
+                #                  ${SRCFILE}-unicode.gcov unicode
+                ##############
+
                 # merge them
                 ./pages/development-resources/gccr.pl -n -c ${SRCFILE}-no-unicode.gcov no-unicode \
                                   ${SRCFILE}-unicode.gcov unicode > ${SRCFILE}.gcov
diff --git a/pages/development-resources/gccr.pl b/pages/development-resources/gccr.pl
@@ -248,7 +248,7 @@ ($$)
 			if($save_raw) {
 				$data{'line'}[$file_line_num]{'raw'} = $raw;
 			}
-		}elsif($line =~ /^\s+(\d+):\s*(\d+):(.*)/) {
+		}elsif($line =~ /^\s*(\d+):\s*(\d+):(.*)/) {
 
 			# line was executed
 
diff --git a/src/json_file_module.F90 b/src/json_file_module.F90
@@ -30,7 +30,7 @@ module json_file_module
     !  The `json_file` is the main public class that is
     !  used to open a file and get data from it.
     !
-    !  A `json_file` contains only two items: an instance of a [[json_core]],
+    !  A `json_file` contains only two items: an instance of a [[json_core(type)]],
     !  which use used for all data manipulation, and a [[json_value]],
     !  which is used to construct the linked-list data structure.
     !  Note that most methods in the `json_file` class are simply wrappers
@@ -61,7 +61,7 @@ module json_file_module
 
         private
 
-        type(json_core) :: core !! The instance of the [[json_core]] factory used for this file.
+        type(json_core) :: core !! The instance of the [[json_core(type)]] factory used for this file.
         type(json_value),pointer :: p => null()  !! the JSON structure read from the file
 
     contains
@@ -165,8 +165,8 @@ module json_file_module
     !  date: 07/23/2015
     !
     !  Structure constructor to initialize a [[json_file(type)]] object
-    !  with an existing [[json_value]] object, and either the [[json_core]]
-    !  settings or a [[json_core]] instance.
+    !  with an existing [[json_value]] object, and either the [[json_core(type)]]
+    !  settings or a [[json_core(type)]] instance.
     !
     !# Example
     !
@@ -258,7 +258,7 @@ end subroutine json_file_print_error_message
 
 !*****************************************************************************************
 !>
-!  Initialize the [[json_core]] for this [[json_file]].
+!  Initialize the [[json_core(type)]] for this [[json_file]].
 !  This is just a wrapper for [[json_initialize]].
 !
 !@note: This does not destroy the data in the file.
@@ -274,35 +274,13 @@ subroutine initialize_json_core_in_file(me,verbose,compact_reals,&
                                             case_sensitive_keys,&
                                             no_whitespace,&
                                             unescape_strings,&
-                                            comment_char)
+                                            comment_char,&
+                                            use_rfc6901_paths)
 
     implicit none
 
     class(json_file),intent(inout) :: me
-    logical(LK),intent(in),optional :: verbose       !! mainly useful for debugging (default is false)
-    logical(LK),intent(in),optional :: compact_reals !! to compact the real number strings for output (default is true)
-    logical(LK),intent(in),optional :: print_signs   !! always print numeric sign (default is false)
-    character(kind=CDK,len=*),intent(in),optional :: real_format !! Real number format: 'E' [default], '*', 'G', 'EN', or 'ES'
-    integer(IK),intent(in),optional :: spaces_per_tab !! number of spaces per tab for indenting (default is 2)
-    logical(LK),intent(in),optional :: strict_type_checking !! if true, no integer, double, or logical type
-                                                            !! conversions are done for the `get` routines
-                                                            !! (default is false)
-    logical(LK),intent(in),optional :: trailing_spaces_significant  !! for name and path comparisons, is trailing
-                                                                    !! space to be considered significant.
-                                                                    !! (default is false)
-    logical(LK),intent(in),optional :: case_sensitive_keys  !! for name and path comparisons, are they
-                                                            !! case sensitive. (default is true)
-    logical(LK),intent(in),optional :: no_whitespace  !! if true, printing the JSON structure is
-                                                      !! done without adding any non-significant
-                                                      !! spaces or linebreaks (default is false)
-    logical(LK),intent(in),optional :: unescape_strings !! If false, then the raw escaped
-                                                        !! string is returned from [[json_get_string]]
-                                                        !! and similar routines. If true [default],
-                                                        !! then the string is returned unescaped.
-    character(kind=CK,len=1),intent(in),optional :: comment_char  !! If present, this character is used
-                                                                  !! to denote comments in the JSON file,
-                                                                  !! which will be ignored if present.
-                                                                  !! Example: `!` or `#`.
+#include "json_initialize_arguments.inc"
 
     call me%core%initialize(verbose,compact_reals,&
                             print_signs,real_format,spaces_per_tab,&
@@ -311,19 +289,20 @@ subroutine initialize_json_core_in_file(me,verbose,compact_reals,&
                             case_sensitive_keys,&
                             no_whitespace,&
                             unescape_strings,&
-                            comment_char)
+                            comment_char,&
+                            use_rfc6901_paths)
 
     end subroutine initialize_json_core_in_file
 !*****************************************************************************************
 
 !*****************************************************************************************
 !>
-!  Set the [[json_core]] for this [[json_file]].
+!  Set the [[json_core(type)]] for this [[json_file]].
 !
 !@note: This does not destroy the data in the file.
 !
 !@note: This one is used if you want to initialize the file with
-!       an already-existing [[json_core]] (presumably, this was already
+!       an already-existing [[json_core(type)]] (presumably, this was already
 !       initialized by a call to [[initialize_json_core]] or similar).
 
     subroutine set_json_core_in_file(me,core)
@@ -340,7 +319,7 @@ end subroutine set_json_core_in_file
 
 !*****************************************************************************************
 !>
-!  Get a copy of the [[json_core]] in this [[json_file]].
+!  Get a copy of the [[json_core(type)]] in this [[json_file]].
 
     subroutine get_json_core_in_file(me,core)
 
@@ -372,37 +351,15 @@ function initialize_json_file(p,verbose,compact_reals,&
                                   case_sensitive_keys,&
                                   no_whitespace,&
                                   unescape_strings,&
-                                  comment_char) result(file_object)
+                                  comment_char,&
+                                  use_rfc6901_paths) result(file_object)
 
     implicit none
 
     type(json_file) :: file_object
     type(json_value),pointer,optional,intent(in) :: p  !! `json_value` object to cast
                                                        !! as a `json_file` object
-    logical(LK),intent(in),optional :: verbose       !! mainly useful for debugging (default is false)
-    logical(LK),intent(in),optional :: compact_reals !! to compact the real number strings for output (default is true)
-    logical(LK),intent(in),optional :: print_signs   !! always print numeric sign (default is false)
-    character(kind=CDK,len=*),intent(in),optional :: real_format !! Real number format: 'E' [default], '*', 'G', 'EN', or 'ES'
-    integer(IK),intent(in),optional :: spaces_per_tab !! number of spaces per tab for indenting (default is 2)
-    logical(LK),intent(in),optional :: strict_type_checking !! if true, no integer, double, or logical type
-                                                            !! conversions are done for the `get` routines
-                                                            !! (default is false)
-    logical(LK),intent(in),optional :: trailing_spaces_significant  !! for name and path comparisons, is trailing
-                                                                    !! space to be considered significant.
-                                                                    !! (default is false)
-    logical(LK),intent(in),optional :: case_sensitive_keys  !! for name and path comparisons, are they
-                                                            !! case sensitive. (default is true)
-    logical(LK),intent(in),optional :: no_whitespace  !! if true, printing the JSON structure is
-                                                      !! done without adding any non-significant
-                                                      !! spaces or linebreaks (default is false)
-    logical(LK),intent(in),optional :: unescape_strings !! If false, then the raw escaped
-                                                        !! string is returned from [[json_get_string]]
-                                                        !! and similar routines. If true [default],
-                                                        !! then the string is returned unescaped.
-    character(kind=CK,len=1),intent(in),optional :: comment_char  !! If present, this character is used
-                                                                  !! to denote comments in the JSON file,
-                                                                  !! which will be ignored if present.
-                                                                  !! Example: `!` or `#`.
+#include "json_initialize_arguments.inc"
 
     call file_object%initialize(verbose,compact_reals,&
                                 print_signs,real_format,spaces_per_tab,&
@@ -411,7 +368,8 @@ function initialize_json_file(p,verbose,compact_reals,&
                                 case_sensitive_keys,&
                                 no_whitespace,&
                                 unescape_strings,&
-                                comment_char)
+                                comment_char,&
+                                use_rfc6901_paths)
 
     if (present(p)) file_object%p => p
 
@@ -422,7 +380,7 @@ end function initialize_json_file
 !> author: Jacob Williams
 !  date: 4/26/2016
 !
-!  Cast a [[json_value]] pointer and a [[json_core]] object
+!  Cast a [[json_value]] pointer and a [[json_core(type)]] object
 !  as a [[json_file(type)]] object.
 
     function initialize_json_file_v2(json_value_object, json_core_object) &
@@ -448,8 +406,8 @@ end function initialize_json_file_v2
 !  or will be reused to open a different file.
 !  Otherwise a memory leak will occur.
 !
-!  Optionally, also destroy the [[json_core]] instance (this
-!  is not necessary to prevent memory leaks, since a [[json_core]]
+!  Optionally, also destroy the [[json_core(type)]] instance (this
+!  is not necessary to prevent memory leaks, since a [[json_core(type)]]
 !  does not use pointers).
 !
 !### History
@@ -461,7 +419,7 @@ subroutine json_file_destroy(me,destroy_core)
     implicit none
 
     class(json_file),intent(inout) :: me
-    logical,intent(in),optional :: destroy_core  !! to also destroy the [[json_core]].
+    logical,intent(in),optional :: destroy_core  !! to also destroy the [[json_core(type)]].
                                                  !! default is to leave it as is.
 
     if (associated(me%p)) call me%core%destroy(me%p)
diff --git a/src/json_initialize_arguments.inc b/src/json_initialize_arguments.inc
@@ -0,0 +1,28 @@
+    logical(LK),intent(in),optional :: verbose       !! mainly useful for debugging (default is false)
+    logical(LK),intent(in),optional :: compact_reals !! to compact the real number strings for output (default is true)
+    logical(LK),intent(in),optional :: print_signs   !! always print numeric sign (default is false)
+    character(kind=CDK,len=*),intent(in),optional :: real_format !! Real number format: 'E' [default], '*', 'G', 'EN', or 'ES'
+    integer(IK),intent(in),optional :: spaces_per_tab !! number of spaces per tab for indenting (default is 2)
+    logical(LK),intent(in),optional :: strict_type_checking !! if true, no integer, double, or logical type
+                                                            !! conversions are done for the `get` routines
+                                                            !! (default is false)
+    logical(LK),intent(in),optional :: trailing_spaces_significant  !! for name and path comparisons, is trailing
+                                                                    !! space to be considered significant.
+                                                                    !! (default is false)
+    logical(LK),intent(in),optional :: case_sensitive_keys  !! for name and path comparisons, are they
+                                                            !! case sensitive. (default is true)
+    logical(LK),intent(in),optional :: no_whitespace  !! if true, printing the JSON structure is
+                                                      !! done without adding any non-significant
+                                                      !! spaces or linebreaks (default is false)
+    logical(LK),intent(in),optional :: unescape_strings !! If false, then the raw escaped
+                                                        !! string is returned from [[json_get_string]]
+                                                        !! and similar routines. If true [default],
+                                                        !! then the string is returned unescaped.
+    character(kind=CK,len=1),intent(in),optional :: comment_char  !! If present, this character is used
+                                                                  !! to denote comments in the JSON file,
+                                                                  !! which will be ignored if present.
+                                                                  !! Example: `!` or `#`.
+    logical(LK),intent(in),optional :: use_rfc6901_paths  !! If true, then path values in the
+                                                          !! `get_by_path` routines are interpreted
+                                                          !! as RFC 6901 "JSON Pointer" paths.
+                                                          !! By default, this is False.
diff --git a/src/json_parameters.F90 b/src/json_parameters.F90
@@ -50,6 +50,7 @@ module json_parameters
     character(kind=CK,len=*),parameter :: root            = CK_'$'  !! for [[json_get_by_path]]
     character(kind=CK,len=*),parameter :: this            = CK_'@'  !! for [[json_get_by_path]]
     character(kind=CK,len=*),parameter :: child           = CK_'.'  !! for [[json_get_by_path]]
+    character(kind=CK,len=*),parameter :: tilde           = CK_'~'
     character(kind=CK,len=*),parameter :: bspace          = achar(8,  kind=CK)
     character(kind=CK,len=*),parameter :: horizontal_tab  = achar(9,  kind=CK)
     character(kind=CK,len=*),parameter :: newline         = achar(10, kind=CK)
@@ -120,7 +121,7 @@ module json_parameters
     integer(IK),parameter :: seq_chunk_size = 256_IK !! chunk size for reading sequential files
 
     integer(IK),parameter :: pushed_char_size = 10_IK !! size for `pushed_char`
-                                                      !! array in [[json_core]]
+                                                      !! array in [[json_core(type)]]
 
     end module json_parameters
 !*****************************************************************************************
diff --git a/src/json_string_utilities.F90 b/src/json_string_utilities.F90
diff --git a/src/json_value_module.F90 b/src/json_value_module.F90
diff --git a/src/tests/jf_test_23.f90 b/src/tests/jf_test_23.f90

Original file line number	Diff line number	Diff line change
`@@ -248,7 +248,7 @@ ($$)`
`248`	`248`	`if($save_raw) {`
`249`	`249`	`$data{'line'}[$file_line_num]{'raw'} = $raw;`
`250`	`250`	`}`
`251`		`- }elsif($line =~ /^\s+(\d+):\s(\d+):(.)/) {`
	`251`	`+ }elsif($line =~ /^\s(\d+):\s(\d+):(.*)/) {`
`252`	`252`
`253`	`253`	`# line was executed`
`254`	`254`