Merge branch 'master' of https://github.com/jacobwilliams/json-fortran into 564-nullify-option

Author: jacobwilliams

.github/workflows/CI.yml

@@ -10,8 +10,8 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-20.04]
-        gcc_v: [7,8,9,10] # Version of GFortran we want to use.
-        python-version: [3.9]
+        gcc_v: [7,8,9,10,11] # Version of GFortran we want to use.
+        python-version: [3.11]
     env:
       FC: gfortran-${{matrix.gcc_v}}
       GCC_V: ${{matrix.gcc_v}}
@@ -46,7 +46,7 @@ jobs:
       if: contains( matrix.os, 'ubuntu')
       run: |
         python -m pip install --upgrade pip
-        pip install ford FoBiS.py pygooglechart
+        pip install ford FoBiS.py pygooglechart fpm
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
 
     - name: Install GFortran Linux
@@ -60,14 +60,72 @@ jobs:
         --slave /usr/bin/gcov gcov /usr/bin/gcov-${GCC_V}
 
     - name: Compile_with_build
-      if: matrix.gcc_v != 7
+      if: matrix.gcc_v != 7 && matrix.gcc_v != 11
       run: |
         GFORTRAN=gfortran-${{matrix.gcc_v}}
         GCOV=gcov-${{matrix.gcc_v}}
         # build with build.sh, run unit tests
         ./build.sh --skip-documentation
         ./build.sh --skip-documentation --enable-unicode
 
+    - name: Compile_with_FPM
+      if: matrix.gcc_v == 11
+      run: |
+        GFORTRAN=gfortran-${{matrix.gcc_v}}
+        GCOV=gcov-${{matrix.gcc_v}}
+        sudo apt update && sudo apt install -y valgrind
+        fpm test jf_test_01 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_02 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_03 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_04 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_05 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_06 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_07 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_08 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_09 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_10 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_11 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_12 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_13 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_14 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_15 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_16 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_17 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_18 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_19 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_20 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_21 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_22 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_23 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_24 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_25 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_26 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_27 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_28 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_29 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_30 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_31 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_32 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_33 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_34 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_35 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_36 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_37 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_38 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_39 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_40 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_41 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_42 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_43 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_44 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_45 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_46 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_47 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_48 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_49 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_50 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+        fpm test jf_test_51 --runner "valgrind --leak-check=full --show-leak-kinds=all --error-exitcode=1"
+
     - name: Compile_with_cmake
       # CMake build with unit tests, no documentation, with coverage analysis
       # No unicode so that coverage combined with the build script will cover unicode

README.md

@@ -78,7 +78,7 @@ the [json-fortran package](https://anaconda.org/conda-forge/json-fortran)
 can be installed.
 
 ```bash
-conda install json-fortran
+conda install --channel conda-forge json-fortran
 ```
 
 _Note:_ Packages on conda-forge are build with GCC 9.4 which is upwards

fpm.toml

@@ -261,4 +261,9 @@ main       = "jf_test_49.F90"
 [[test]]
 name       = "jf_test_50"
 source-dir = "src/tests"
-main       = "jf_test_50.F90"
+main       = "jf_test_50.F90"
+
+[[test]]
+name       = "jf_test_51"
+source-dir = "src/tests"
+main       = "jf_test_51.F90"

src/json_initialize_arguments.inc

@@ -111,4 +111,7 @@ logical(LK),intent(in),optional :: strict_integer_type_checking
   !! * If true, an exception will be raised if the integer
   !!   value cannot be read.
   !!
+  !! (default is true)
+logical(LK),intent(in),optional :: allow_trailing_comma
+  !! Allow a single trailing comma in arrays and objects.
   !! (default is true)

src/json_initialize_dummy_arguments.inc

@@ -22,4 +22,5 @@ stop_on_error,&
 null_to_real_mode,&
 non_normal_mode,&
 use_quiet_nan, &
-strict_integer_type_checking &
+strict_integer_type_checking, &
+allow_trailing_comma &

src/json_value_module.F90

@@ -287,6 +287,9 @@ module json_value_module
                             !! * If true [default], an exception will be raised if an integer
                             !!   value cannot be read when parsing JSON.
 
+        logical(LK) :: allow_trailing_comma = .true.
+                            !! Allow a single trailing comma in arrays and objects.
+
         integer :: ichunk = 0 !! index in `chunk` for [[pop_char]]
                               !! when `use_unformatted_stream=True`
         integer :: filesize = 0 !! the file size when when `use_unformatted_stream=True`
@@ -1140,6 +1143,10 @@ subroutine json_initialize(me,&
         me%strict_integer_type_checking = strict_integer_type_checking
     end if
 
+    if (present(allow_trailing_comma)) then
+        me%allow_trailing_comma = allow_trailing_comma
+    end if
+
     !Set the format for real numbers:
     ! [if not changing it, then it remains the same]
 
@@ -10154,7 +10161,7 @@ recursive subroutine parse_value(json, unit, str, value)
 
                 ! start object
                 call json%to_object(value)    !allocate class
-                call json%parse_object(unit, str, value)
+                call json%parse_object(unit, str, value, expecting_next_element=.false.)
 
             case (start_array)
 
@@ -10879,14 +10886,17 @@ end subroutine to_array
 !>
 !  Core parsing routine.
 
-    recursive subroutine parse_object(json, unit, str, parent)
+    recursive subroutine parse_object(json, unit, str, parent, expecting_next_element)
 
     implicit none
 
     class(json_core),intent(inout)      :: json
     integer(IK),intent(in)              :: unit    !! file unit number (if parsing from a file)
     character(kind=CK,len=*),intent(in) :: str     !! JSON string (if parsing from a string)
     type(json_value),pointer            :: parent  !! the parsed object will be added as a child of this
+    logical(LK),intent(in) :: expecting_next_element !! if true, this object is preceeded by a comma, so
+                                                     !! we expect a valid object to exist. used to check
+                                                     !! for trailing delimiters.
 
     type(json_value),pointer :: pair  !! temp variable
     logical(LK)              :: eof   !! end of file flag
@@ -10907,13 +10917,18 @@ recursive subroutine parse_object(json, unit, str, parent)
 
         ! pair name
         call json%pop_char(unit, str=str, eof=eof, skip_ws=.true., &
-                            skip_comments=json%allow_comments, popped=c)
+                           skip_comments=json%allow_comments, popped=c)
         if (eof) then
             call json%throw_exception('Error in parse_object:'//&
                                       ' Unexpected end of file while parsing start of object.')
             return
         else if (end_object == c) then
             ! end of an empty object
+            if (expecting_next_element .and. .not. json%allow_trailing_comma) then
+                ! this is a dangling comma.
+                call json%throw_exception('Error in parse_object: '//&
+                                          'Dangling comma when parsing an object.')
+            end if
             return
         else if (quotation_mark == c) then
             call json_value_create(pair)
@@ -10935,7 +10950,7 @@ recursive subroutine parse_object(json, unit, str, parent)
 
         ! pair value
         call json%pop_char(unit, str=str, eof=eof, skip_ws=.true., &
-                            skip_comments=json%allow_comments, popped=c)
+                           skip_comments=json%allow_comments, popped=c)
         if (eof) then
             call json%destroy(pair)
             call json%throw_exception('Error in parse_object:'//&
@@ -10959,14 +10974,15 @@ recursive subroutine parse_object(json, unit, str, parent)
 
         ! another possible pair
         call json%pop_char(unit, str=str, eof=eof, skip_ws=.true., &
-                            skip_comments=json%allow_comments, popped=c)
+                           skip_comments=json%allow_comments, popped=c)
         if (eof) then
             call json%throw_exception('Error in parse_object: '//&
                                       'End of file encountered when parsing an object')
             return
         else if (delimiter == c) then
             ! read the next member
-            call json%parse_object(unit = unit, str=str, parent = parent)
+            call json%parse_object(unit = unit, str=str, parent = parent, &
+                                   expecting_next_element=.true.)
         else if (end_object == c) then
             ! end of object
             return
@@ -10996,6 +11012,9 @@ recursive subroutine parse_array(json, unit, str, array)
     type(json_value),pointer :: element !! temp variable for array element
     logical(LK)              :: eof     !! end of file flag
     character(kind=CK,len=1) :: c       !! character returned by [[pop_char]]
+    logical(LK) :: expecting_next_element !! to check for trailing delimiters
+
+    expecting_next_element = .false.
 
     do
 
@@ -11011,7 +11030,10 @@ recursive subroutine parse_array(json, unit, str, array)
         end if
 
         ! parse value will deallocate an empty array value
-        if (associated(element)) call json%add(array, element)
+        if (associated(element)) then
+            expecting_next_element = .false.
+            call json%add(array, element)
+        end if
 
         ! popped the next character
         call json%pop_char(unit, str=str, eof=eof, skip_ws=.true., &
@@ -11024,9 +11046,15 @@ recursive subroutine parse_array(json, unit, str, array)
             exit
         else if (delimiter == c) then
             ! parse the next element
+            expecting_next_element = .true.
             cycle
         else if (end_array == c) then
             ! end of array
+            if (expecting_next_element .and. .not. json%allow_trailing_comma) then
+                ! this is a dangling comma.
+                call json%throw_exception('Error in parse_array: '//&
+                                          'Dangling comma when parsing an array.')
+            end if
             exit
         else
             call json%throw_exception('Error in parse_array: '//&

src/tests/jf_test_12.F90

@@ -150,7 +150,10 @@ subroutine test_12(error_cnt)
     call json%get(me=root,path='array data.data',array_callback=get_3D_from_array)
     call check_errors(all(abs(fetched_array - reshape(raw_array,[size(raw_array)])) <= TOL))
 
-    my_file = json_file(root,verbose=.true.,real_format='G')
+    !my_file = json_file(root,verbose=.true.,real_format='G')  ! valgrind says this cases a memory leak
+    call my_file%initialize(verbose=.true.,real_format='G')    ! this doesn't have a memmory leak
+    call my_file%add(root)
+    nullify(root)
 
     call my_file%update('array data.description',CK_'vector data',found=existed)
     call check_file_errors(existed)

src/tests/jf_test_15.F90

@@ -216,7 +216,9 @@ subroutine test_15(error_cnt)
 
         !****************************************
 
-        file1 = json_file(p2,json)  !constructor
+        !file1 = json_file(p2,json)  ! memory leak with gfortran?
+        call file1%initialize(json)
+        call file1%add(p2); nullify(p2)
         call file1%destroy(destroy_core=.true.)
 
         !****************************************

src/tests/jf_test_25.F90

@@ -108,7 +108,9 @@ subroutine test_25(error_cnt)
 #endif
 
     ! test json_file interface
-    f = json_file(p)
+    !f = json_file(p) ! memory leak in gfortran?
+    call f%initialize()
+    call f%add(p)
     nullify(p) ! data is now in f
     call f%get('str_array', vec, ilen, found)
     if (.not. found) then

src/tests/jf_test_27.F90

@@ -60,7 +60,9 @@ subroutine test_27(error_cnt)
     call json%print(p,int(output_unit,IK))
 
     ! test json_file interface
-    f = json_file(p)
+    !f = json_file(p) ! memory leak in gfortran?
+    call f%initialize()
+    call f%add(p)
     nullify(p) ! data is now in f
     call f%initialize(compress_vectors=.true.)
     call f%print()

src/tests/jf_test_37.F90

@@ -39,26 +39,34 @@ subroutine test_37(error_cnt)
     call json%initialize(no_whitespace=.true.)
 
     call json%deserialize(p, CK_'{"a": ["1", "2", "3"]}')
-    f = json_file(p,no_whitespace=.true.)
+    !f = json_file(p,no_whitespace=.true.) ! memory leak in gfortran?
+    call f%initialize(no_whitespace=.true.)
+    call f%add(p)
     call f%print(int(error_unit,IK))
     write(error_unit,'(A)') ''
     call check_for_error()
     call f%destroy()
 
     call json%deserialize(p, CK_'{"b": ["4", "5", "6"]}')
-    f = json_file(p,json)
+    !f = json_file(p,json) ! memory leak in gfortran?
+    call f%initialize(json)
+    call f%add(p)
     call f%print(int(error_unit,IK))
     write(error_unit,'(A)') ''
     call check_for_error()
     call f%destroy()
 
-    f = json_file(CK_'{"x": [1,2,3]}',no_whitespace=.true.)
+    !f = json_file(CK_'{"x": [1,2,3]}',no_whitespace=.true.) ! memory leak in gfortran?
+    call f%initialize(no_whitespace=.true.)
+    call f%deserialize(CK_'{"x": [1,2,3]}')
     call f%print(int(error_unit,IK))
     write(error_unit,'(A)') ''
     call check_for_error()
     call f%destroy()
 
-    f = json_file(CK_'{"y": [4,5,6]}',json)
+    !f = json_file(CK_'{"y": [4,5,6]}',json) ! memory leak in gfortran?
+    call f%initialize(json)
+    call f%deserialize(CK_'{"y": [4,5,6]}')
     call f%print(int(error_unit,IK))
     write(error_unit,'(A)') ''
     call check_for_error()
@@ -69,26 +77,34 @@ subroutine test_37(error_cnt)
     ! also test default character kind when unicode is enabled:
 
     call json%deserialize(p, CDK_'{"a": ["1", "2", "3"]}')
-    f = json_file(p,no_whitespace=.true.)
+    !f = json_file(p,no_whitespace=.true.) ! memory leak in gfortran?
+    call f%initialize(no_whitespace=.true.)
+    call f%add(p)
     call f%print(int(error_unit,IK))
     write(error_unit,'(A)') ''
     call check_for_error()
     call f%destroy()
 
     call json%deserialize(p, CDK_'{"b": ["4", "5", "6"]}')
-    f = json_file(p,json)
+    !f = json_file(p,json) ! memory leak in gfortran?
+    call f%initialize(json)
+    call f%add(p)
     call f%print(int(error_unit,IK))
     write(error_unit,'(A)') ''
     call check_for_error()
     call f%destroy()
 
-    f = json_file(CDK_'{"x": [1,2,3]}',no_whitespace=.true.)
+    !f = json_file(CDK_'{"x": [1,2,3]}',no_whitespace=.true.) ! memory leak in gfortran?
+    call f%initialize(no_whitespace=.true.)
+    call f%deserialize(CDK_'{"x": [1,2,3]}')
     call f%print(int(error_unit,IK))
     write(error_unit,'(A)') ''
     call check_for_error()
     call f%destroy()
 
-    f = json_file(CDK_'{"y": [4,5,6]}',json)
+    !f = json_file(CDK_'{"y": [4,5,6]}',json) ! memory leak in gfortran?
+    call f%initialize(json)
+    call f%deserialize(CDK_'{"y": [4,5,6]}')
     call f%print(int(error_unit,IK))
     write(error_unit,'(A)') ''
     call check_for_error()