Merge pull request #332 from jacobwilliams/devel

Various updates

Author: jacobwilliams

.travis.yml

@@ -68,8 +68,7 @@ install:
   - pip install --upgrade pygooglechart
   - pip install --upgrade graphviz
   - (pip install --upgrade FoBiS.py==2.2.8 && FoBiS.py --version)
-  - (pip install --upgrade ford==5.0.6 && ford --version)
-  - (pip install --upgrade markdown==2.6.9)
+  - (pip install --upgrade ford==6.0.0 && ford --version)
   - (pip install --upgrade git+https://github.com/dmeranda/demjson.git && jsonlint --version)
 
 before_script:

json-fortran.md

@@ -57,7 +57,7 @@ Official Releases
 
 The **current stable release** is **{!.VERSION!}** and can be [downloaded
 on GitHub](https://github.com/jacobwilliams/json-fortran/releases/latest)
-or installed with [Homebrew](http://brew.sh) on Mac OSX. The
+or installed with [Homebrew](http://brew.sh) on MacOS. The
 documentation for the current version, **{!.VERSION!}**, can be
 found [here](http://jacobwilliams.github.io/json-fortran/{!.VERSION!}/index.html)[^1], and a
 list of changes from the previous version are
@@ -74,6 +74,7 @@ Miscellaneous
 
 *[API]: Application Programming Interface: a set of routines, protocols, and tools for building software applications
 *[JSON]: JavaScript Object Notation: A human friendly syntax for storing and exchanging data
+*[variable type]: json_unknown, json_null, json_object, json_array, json_logical, json_integer, json_double, json_string
 *[current stable release]: {!.VERSION!}
 *[latest stable release]: {!.VERSION!}
 

src/json_file_module.F90

@@ -353,7 +353,7 @@ end subroutine json_file_print_error_message
 !  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.
+!@note This does not destroy the data in the file.
 !
 !@note [[initialize_json_core]], [[json_initialize]],
 !      [[initialize_json_core_in_file]], and [[initialize_json_file]]
@@ -401,9 +401,9 @@ end subroutine initialize_json_core_in_file
 !>
 !  Set the [[json_core(type)]] for this [[json_file]].
 !
-!@note: This does not destroy the data in the file.
+!@note This does not destroy the data in the file.
 !
-!@note: This one is used if you want to initialize the file with
+!@note This one is used if you want to initialize the file with
 !       an already-existing [[json_core(type)]] (presumably, this was already
 !       initialized by a call to [[initialize_json_core]] or similar).
 

src/json_module.F90

@@ -22,12 +22,12 @@
 #pragma pop_macro("USE_UCS4")
 #endif
 !
-!## License
+!### License
 !  * JSON-Fortran is released under a BSD-style license.
 !    See the [LICENSE](https://github.com/jacobwilliams/json-fortran/blob/master/LICENSE)
 !    file for details.
 !
-!## History
+!### History
 !  * Joseph A. Levin : March 2012 : Original [FSON](https://github.com/josephalevin/fson)
 !    code [retrieved on 12/2/2013].
 !  * Jacob Williams : 2/8/2014 : Extensive modifications to the original FSON code.
@@ -39,7 +39,7 @@
 !    (e.g., allocatable strings, newunit, generic, class, and abstract interface).
 !  * Development continues at: [Github](http://github.com/jacobwilliams/json-fortran)
 !
-!## See also
+!### See also
 !  * [json-fortran development site](http://github.com/jacobwilliams/json-fortran)
 !  * [json-fortran online documentation](http://jacobwilliams.github.io/json-fortran)
 !  * [JSON website](http://www.json.org/)

src/json_parameters.F90

@@ -5,7 +5,7 @@
 !  Other parameters used by JSON-Fortran.
 !  This is a low-level module not meant to be used by a JSON-Fortran user.
 !
-!## License
+!### License
 !  * JSON-Fortran is released under a BSD-style license.
 !    See the [LICENSE](https://github.com/jacobwilliams/json-fortran/blob/master/LICENSE)
 !    file for details.
@@ -38,29 +38,29 @@ module json_parameters
     integer(IK),parameter :: json_string    = 7  !! String JSON data type
 
     !special JSON characters
-    character(kind=CK,len=*),parameter :: space           = CK_' '
-    character(kind=CK,len=*),parameter :: start_object    = CK_'{'
-    character(kind=CK,len=*),parameter :: end_object      = CK_'}'
-    character(kind=CK,len=*),parameter :: start_array     = CK_'['
-    character(kind=CK,len=*),parameter :: end_array       = CK_']'
-    character(kind=CK,len=*),parameter :: delimiter       = CK_','
-    character(kind=CK,len=*),parameter :: colon_char      = CK_':'
-    character(kind=CK,len=*),parameter :: start_array_alt = CK_'('  !! for [[json_get_by_path]]
-    character(kind=CK,len=*),parameter :: end_array_alt   = CK_')'  !! for [[json_get_by_path]]
-    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 :: dot             = CK_'.'  !! for [[json_get_by_path]]
+    character(kind=CK,len=*),parameter :: space           = CK_' '  !! space character
+    character(kind=CK,len=*),parameter :: start_object    = CK_'{'  !! start of a JSON object
+    character(kind=CK,len=*),parameter :: end_object      = CK_'}'  !! end of a JSON object
+    character(kind=CK,len=*),parameter :: start_array     = CK_'['  !! start of a JSON array
+    character(kind=CK,len=*),parameter :: end_array       = CK_']'  !! end of a JSON array
+    character(kind=CK,len=*),parameter :: delimiter       = CK_','  !! delimiter for JSON
+    character(kind=CK,len=*),parameter :: colon_char      = CK_':'  !! colon character for JSON
+    character(kind=CK,len=*),parameter :: start_array_alt = CK_'('  !! alternate start of JSON array for [[json_get_by_path_default]]
+    character(kind=CK,len=*),parameter :: end_array_alt   = CK_')'  !! alternate end of JSON array for [[json_get_by_path_default]]
+    character(kind=CK,len=*),parameter :: root            = CK_'$'  !! root for [[json_get_by_path_default]]
+    character(kind=CK,len=*),parameter :: this            = CK_'@'  !! 'this' for [[json_get_by_path_default]]
+    character(kind=CK,len=*),parameter :: dot             = CK_'.'  !! path separator for [[json_get_by_path_default]]
     character(kind=CK,len=*),parameter :: tilde           = CK_'~'  !! RFC 6901 escape character
     character(kind=CK,len=*),parameter :: percent         = CK_'%'  !! Fortran path separator
     character(kind=CK,len=*),parameter :: single_quote    = CK_"'"  !! for JSONPath bracket-notation
-    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)
-    character(kind=CK,len=*),parameter :: formfeed        = achar(12, kind=CK)
-    character(kind=CK,len=*),parameter :: carriage_return = achar(13, kind=CK)
-    character(kind=CK,len=*),parameter :: quotation_mark  = achar(34, kind=CK)
-    character(kind=CK,len=*),parameter :: slash           = achar(47, kind=CK)
-    character(kind=CK,len=*),parameter :: backslash       = achar(92, kind=CK)
+    character(kind=CK,len=*),parameter :: bspace          = achar(8,  kind=CK) !! JSON special character
+    character(kind=CK,len=*),parameter :: horizontal_tab  = achar(9,  kind=CK) !! JSON special character
+    character(kind=CK,len=*),parameter :: newline         = achar(10, kind=CK) !! JSON special character
+    character(kind=CK,len=*),parameter :: formfeed        = achar(12, kind=CK) !! JSON special character
+    character(kind=CK,len=*),parameter :: carriage_return = achar(13, kind=CK) !! JSON special character
+    character(kind=CK,len=*),parameter :: quotation_mark  = achar(34, kind=CK) !! JSON special character
+    character(kind=CK,len=*),parameter :: slash           = achar(47, kind=CK) !! JSON special character
+    character(kind=CK,len=*),parameter :: backslash       = achar(92, kind=CK) !! JSON special character
 
     character(kind=CDK,len=*),parameter :: default_real_fmt = '(ss,E27.17E4)'
         !! default real number format statement (for writing real values to strings and files).
@@ -103,11 +103,11 @@ module json_parameters
     !Get the number of possible digits in the exponent when using decimal number system
     integer(IK),parameter :: maxexp = maxexponent(1.0_RK)
     integer(IK),parameter :: minexp = minexponent(1.0_RK)
-    integer(IK),parameter :: real_exponent_digits = floor( 1 + log10( &
+    integer(IK),parameter :: real_exponent_digits = floor( 1_IK + log10( &
                                   real(max(maxexp,abs(maxexp)),&
                                   kind=RK) ) )
 
-    integer(IK),parameter :: max_numeric_str_len = real_precision + real_exponent_digits + 6
+    integer(IK),parameter :: max_numeric_str_len = real_precision + real_exponent_digits + 6_IK
         !! 6 = sign + leading 0 + decimal + 'E' + exponent sign + 1 extra
     character(kind=CDK,len=*),parameter :: int_fmt  = '(ss,I0)' !! minimum width format for integers
 

src/json_string_utilities.F90

@@ -4,7 +4,7 @@
 !
 !  JSON-Fortran support module for string manipulation.
 !
-!## License
+!### License
 !  * JSON-Fortran is released under a BSD-style license.
 !    See the [LICENSE](https://github.com/jacobwilliams/json-fortran/blob/master/LICENSE)
 !    file for details.
@@ -116,7 +116,7 @@ subroutine string_to_integer(str,ival,status_ok)
 
     implicit none
 
-    character(kind=CK,len=*),intent(in) :: str        !! the string to conver to an integer
+    character(kind=CK,len=*),intent(in) :: str        !! the string to convert to an integer
     integer(IK),intent(out)             :: ival       !! the integer value
     logical(LK),intent(out)             :: status_ok  !! true if there were no errors
 
@@ -193,8 +193,8 @@ subroutine string_to_real(str,rval,status_ok)
 
     implicit none
 
-    character(kind=CK,len=*),intent(in) :: str
-    real(RK),intent(out)                :: rval
+    character(kind=CK,len=*),intent(in) :: str        !! the string to convert to a real
+    real(RK),intent(out)                :: rval       !! `str` converted to a real value
     logical(LK),intent(out)             :: status_ok  !! true if there were no errors
 
     integer(IK) :: ierr  !! read iostat error code
@@ -322,7 +322,6 @@ subroutine escape_string(str_in, str_out, escape_solidus)
 
     character(kind=CK,len=*),parameter :: specials = specials_no_slash//slash
 
-
     !Do a quick scan for the special characters,
     ! if any are present, then process the string,
     ! otherwise, return the string as is.