some refactoring and new options.

jacobwilliams · jacobwilliams · commit 3b15f03adebf · 2017-02-11T23:40:42.000-06:00
diff --git a/src/csv_kinds.f90 b/src/csv_kinds.f90
@@ -2,7 +2,7 @@
 !>
 !  Numeric kinds.
 
-    module kinds_module
+    module csv_kinds
 
     use iso_fortran_env, only: real64,int32
 
@@ -11,5 +11,5 @@ module kinds_module
     integer,parameter,public :: wp = real64  !! default real kind
     integer,parameter,public :: ip = int32   !! default integer kind
 
-    end module kinds_module
+    end module csv_kinds
 !*******************************************************************************
diff --git a/src/csv_module.f90 b/src/csv_module.f90
@@ -6,9 +6,10 @@
 
     module csv_module
 
-    use utilities_module
-    use kinds_module
-    use iso_fortran_env
+    use csv_utilities
+    use csv_kinds
+    use csv_parameters
+    use iso_fortran_env, only: error_unit
 
     implicit none
 
@@ -24,6 +25,9 @@ module csv_module
 
     type,public :: csv_string
         !! a cell from a CSV file.
+        !!
+        !! This use used to store the data internally
+        !! in the [[csv_file]] class.
         private
         character(len=:),allocatable :: str
     end type csv_string
@@ -38,7 +42,7 @@ module csv_module
 
         private
 
-        logical :: verbose = .true. !! to print error messages
+        logical :: verbose = .false. !! to print error messages
 
         character(len=1) :: quote     = '"'  !! quotation character
         character(len=1) :: delimiter = ','  !! delimiter character
@@ -128,17 +132,22 @@ subroutine initialize_csv_file(me,quote,delimiter,&
                                     enclose_all_in_quotes,&
                                     logical_true_string,&
                                     logical_false_string,&
+                                    chunk_size,&
                                     verbose)
 
     implicit none
 
     class(csv_file),intent(out) :: me
     character(len=1),intent(in),optional :: quote             !! note: can only be one character
+                                                              !! (Default is `"`)
     character(len=1),intent(in),optional :: delimiter         !! note: can only be one character
+                                                              !! (Default is `,`)
     logical,intent(in),optional :: enclose_strings_in_quotes  !! if true, all string cells
                                                               !! will be enclosed in quotes.
+                                                              !! (Default is True)
     logical,intent(in),optional :: enclose_all_in_quotes      !! if true, *all* cells will
                                                               !! be enclosed in quotes.
+                                                              !! (Default is False)
     character(len=1),intent(in),optional :: logical_true_string !! when writing a logical `true`
                                                                 !! value to a CSV file, this
                                                                 !! is the string to use
@@ -147,7 +156,10 @@ subroutine initialize_csv_file(me,quote,delimiter,&
                                                                  !! value to a CSV file, this
                                                                  !! is the string to use
                                                                  !! (default is `F`)
-    logical,intent(in),optional :: verbose
+    integer,intent(in),optional :: chunk_size  !! factor for expanding vectors
+                                               !! (default is 100)
+    logical,intent(in),optional :: verbose  !! print error messages to the
+                                            !! console (default is False)
 
     if (present(quote)) me%quote = quote
     if (present(delimiter)) me%delimiter = delimiter
@@ -160,6 +172,10 @@ subroutine initialize_csv_file(me,quote,delimiter,&
     if (present(logical_false_string)) &
         me%logical_false_string = logical_false_string
     if (present(verbose)) me%verbose = verbose
+    if (present(chunk_size)) me%chunk_size = chunk_size
+
+    ! override:
+    if (me%enclose_all_in_quotes) me%enclose_strings_in_quotes = .true.
 
     end subroutine initialize_csv_file
 !*****************************************************************************************
@@ -299,21 +315,17 @@ end subroutine read_csv_file
 
 !*****************************************************************************************
 !>
-!  Open a CSV file for writing
+!  Open a CSV file for writing.
+!
+!  Use `initialize` to set options for the CSV file.
 
-    subroutine open_csv_file(me,filename,&
-                                n_cols,&
-                                enclose_strings_in_quotes,&
-                                enclose_all_in_quotes,&
-                                status_ok)
+    subroutine open_csv_file(me,filename,n_cols,status_ok)
 
     implicit none
 
     class(csv_file),intent(inout) :: me
     character(len=*),intent(in) :: filename  !! the CSV file to open
     integer,intent(in) :: n_cols  !! number of columns in the file
-    logical,intent(in),optional :: enclose_strings_in_quotes  !! default is true
-    logical,intent(in),optional :: enclose_all_in_quotes !! default is false
     logical,intent(out) :: status_ok  !! status flag
 
     integer :: istat  !! open `iostat` flag
@@ -322,18 +334,6 @@ subroutine open_csv_file(me,filename,&
 
     me%n_cols = n_cols
 
-    if (present(enclose_strings_in_quotes)) then
-        me%enclose_strings_in_quotes = enclose_strings_in_quotes
-    else
-        me%enclose_strings_in_quotes = .true.
-    end if
-    if (present(enclose_all_in_quotes)) then
-        me%enclose_all_in_quotes = enclose_all_in_quotes
-    else
-        me%enclose_all_in_quotes = .false.
-    end if
-    if (me%enclose_all_in_quotes) me%enclose_strings_in_quotes = .true. ! override
-
     open(newunit=me%iunit,file=filename,status='REPLACE',iostat=istat)
     if (istat==0) then
         status_ok = .true.
@@ -367,25 +367,27 @@ end subroutine close_csv_file
 !*****************************************************************************************
 !>
 !  Add a cell to a CSV file.
+!
+!@todo Need to check the `istat` values for errors.
 
     subroutine add_cell(me,val,int_fmt,real_fmt,trim_str)
 
     implicit none
 
     class(csv_file),intent(inout) :: me
     class(*),intent(in) :: val  !! the value to add
-    character(len=*),intent(in),optional :: int_fmt !! format string for integers
-    character(len=*),intent(in),optional :: real_fmt !! format string for reals
-    logical,intent(in),optional :: trim_str !! to trim the string
+    character(len=*),intent(in),optional :: int_fmt  !! if `val` is an integer, use
+                                                     !! this format string.
+    character(len=*),intent(in),optional :: real_fmt !! if `val` is a real, use
+                                                     !! this format string.
+    logical,intent(in),optional :: trim_str !! if `val` is a string, then trim it.
 
     integer :: istat !! write `iostat` flag
     character(len=:),allocatable :: ifmt !! actual format string to use for integers
     character(len=:),allocatable :: rfmt !! actual format string to use for reals
     logical :: trimstr !! if the strings are to be trimmed
-    character(len=max_real_str_len) :: real_val
-    character(len=max_integer_str_len) :: int_val
-
-    !TODO need to check the istat values for errors
+    character(len=max_real_str_len) :: real_val  !! for writing a real value
+    character(len=max_integer_str_len) :: int_val !! for writing an integer value
 
     ! make sure the row isn't already finished
     if (me%icol<me%n_cols) then
@@ -479,9 +481,11 @@ subroutine add_vector(me,val,int_fmt,real_fmt,trim_str)
 
     class(csv_file),intent(inout) :: me
     class(*),dimension(:),intent(in) :: val  !! the values to add
-    character(len=*),intent(in),optional :: int_fmt !! format string for integers
-    character(len=*),intent(in),optional :: real_fmt !! format string for reals
-    logical,intent(in),optional :: trim_str !! to trim the string
+    character(len=*),intent(in),optional :: int_fmt  !! if `val` is an integer, use
+                                                     !! this format string.
+    character(len=*),intent(in),optional :: real_fmt !! if `val` is a real, use
+                                                     !! this format string.
+    logical,intent(in),optional :: trim_str !! if `val` is a string, then trim it.
 
     integer :: i !! counter
 
@@ -504,9 +508,11 @@ subroutine add_matrix(me,val,int_fmt,real_fmt,trim_str)
 
     class(csv_file),intent(inout) :: me
     class(*),dimension(:,:),intent(in) :: val  !! the values to add
-    character(len=*),intent(in),optional :: int_fmt !! format string for integers
-    character(len=*),intent(in),optional :: real_fmt !! format string for reals
-    logical,intent(in),optional :: trim_str !! to trim the string
+    character(len=*),intent(in),optional :: int_fmt  !! if `val` is an integer, use
+                                                     !! this format string.
+    character(len=*),intent(in),optional :: real_fmt !! if `val` is a real, use
+                                                     !! this format string.
+    logical,intent(in),optional :: trim_str !! if `val` is a string, then trim it.
 
     integer :: i !! counter
 
diff --git a/src/csv_parameters.f90 b/src/csv_parameters.f90
@@ -0,0 +1,20 @@
+!*******************************************************************************
+!>
+!  Various parameters.
+
+    module csv_parameters
+
+    use csv_kinds
+
+    private
+
+    integer(ip),parameter,public :: max_real_str_len = 27 !! maximum string length of a real number
+    character(len=*),parameter,public :: default_real_fmt = '(E27.17E4)'
+        !! default real number format statement (for writing real values to strings and files).
+
+    integer(ip),parameter,public :: max_integer_str_len = 256 !! maximum string length of an integer.
+    character(len=*),parameter,public :: default_int_fmt  = '(I256)'
+        !! default integer number format statement (for writing real values to strings and files).
+
+    end module csv_parameters
+!*******************************************************************************
diff --git a/src/csv_utilities.f90 b/src/csv_utilities.f90
@@ -3,34 +3,15 @@
 !
 !  Utility routines.
 
-    module utilities_module
+    module csv_utilities
 
-    use kinds_module
+    use csv_kinds
+    use csv_parameters
 
     private
 
     integer,parameter :: max_size_for_insertion_sort = 20 !! max size for using insertion sort.
 
-    character(len=*),parameter,public :: default_real_fmt = '(E27.17E4)'
-        !! default real number format statement (for writing real values to strings and files).
-    character(len=*),parameter,public :: default_int_fmt  = '(I256)'
-        !! minimum width format for integers
-    integer(ip),parameter :: rp_safety_factor = 1_ip
-    integer(ip),parameter :: rp_addl_safety = 2_ip
-    integer(ip),parameter :: real_precision = rp_safety_factor*precision(1.0_wp) + &
-                                              rp_addl_safety
-    integer(ip),parameter :: maxexp = maxexponent(1.0_wp)
-    integer(ip),parameter :: minexp = minexponent(1.0_wp)
-    integer(ip),parameter :: real_exponent_digits = floor( 1 + log10( &
-                                  real(max(maxexp,abs(maxexp)),&
-                                  kind=wp) ) )
-    integer(ip),parameter,public :: max_real_str_len = real_precision + real_exponent_digits + 6
-        !! maximum string length of a real number
-        !! `6 = sign + leading 0 + decimal + 'E' + exponent sign + 1 extra`
-    integer(ip),parameter,public :: max_integer_str_len = 256 !! maximum string length of an integer.
-                                                              !! This is totally arbitrary (any way
-                                                              !! to get the compiler to tell us this?)
-
     character(len=*),parameter :: upper = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ' !! uppercase characters
     character(len=*),parameter :: lower = 'abcdefghijklmnopqrstuvwxyz' !! lowercase characters
 
@@ -277,5 +258,5 @@ end function lowercase_string
 !*******************************************************************************
 
 !*******************************************************************************
-    end module utilities_module
+    end module csv_utilities
 !*******************************************************************************
diff --git a/src/tests/csv_test.f90 b/src/tests/csv_test.f90
@@ -7,7 +7,7 @@
     program csv_test
 
     use csv_module
-    use kinds_module
+    use iso_fortran_env, only: wp => real64
 
     implicit none
 
@@ -16,12 +16,9 @@ program csv_test
     integer :: i !! counter
     character(len=30),dimension(:),allocatable :: header  !! the header
     character(len=30),dimension(:,:),allocatable :: csv_data  !! the data from the file as strings
-
-    real(wp),dimension(:),allocatable :: x
-    !real(wp),dimension(:),allocatable :: y
-    !real(wp),dimension(:),allocatable :: z
-    logical :: status_ok
-    integer,dimension(:),allocatable :: itypes
+    real(wp),dimension(:),allocatable :: x  !! for getting a real vector from a csv file
+    logical :: status_ok  !! error flag
+    integer,dimension(:),allocatable :: itypes  !! array of variable types in the file
 
     ! read the file:
     call f%read('../files/test.csv',header_row=1,status_ok=status_ok)
@@ -49,21 +46,24 @@ program csv_test
     write(*,*) ''
     write(*,*) 'age:'
     call f%get(3,x,status_ok)
-    write(*,'(F27.16,1x)',advance='NO') x
+    write(*,'(F6.3,1x)',advance='NO') x
     write(*,*) ''
 
     ! now test creating a CSV:
+    call f2%initialize(enclose_strings_in_quotes=.false.,verbose=.true.)
     call f2%open('test2.csv',n_cols=4,status_ok=status_ok)
-    call f2%add(['x','y','z','t'])    ! add header as vector
-    call f2%next_row()
-    call f2%add(1.0_wp)  ! add as scalars
-    call f2%add(2.0_wp)
-    call f2%add(3.0_wp)
-    call f2%add(.true.)
-    call f2%next_row()
-    call f2%add([4.0_wp,5.0_wp,6.0_wp]) ! add as vectors
-    call f2%add(.false.)
-    call f2%next_row()
+    if (status_ok) then
+        call f2%add(['x','y','z','t'])    ! add header as vector
+        call f2%next_row()
+        call f2%add(1.0_wp)  ! add as scalars
+        call f2%add(2.0_wp)
+        call f2%add(3.0_wp)
+        call f2%add(.true.)
+        call f2%next_row()
+        call f2%add([4.0_wp,5.0_wp,6.0_wp]) ! add as vectors
+        call f2%add(.false.)
+        call f2%next_row()
+    end if
     call f2%close(status_ok)
 
     end program csv_test
