logical strings can now be user-specified for writing.

Author: jacobwilliams

src/csv_module.f90

@@ -51,11 +51,19 @@ module csv_module
 
         !for writing a csv file:
         integer :: icol = 0    !! last column written in current row
-        integer :: iunit = 0  !! file unit for writing
+        integer :: iunit = 0   !! file unit for writing
         logical :: enclose_strings_in_quotes = .true.  !! if true, all string cells
                                                        !! will be enclosed in quotes.
-        logical :: enclose_all_in_quotes = .false. !! if true, *all* cells will
-                                                   !! be enclosed in quotes.
+        logical :: enclose_all_in_quotes = .false.     !! if true, *all* cells will
+                                                       !! be enclosed in quotes.
+        character(len=1) :: logical_true_string = 'T'  !! when writing a logical `true`
+                                                       !! value to a CSV file, this
+                                                       !! is the string to use
+                                                       !! (default is `T`)
+        character(len=1) :: logical_false_string = 'F' !! when writing a logical `false`
+                                                       !! value to a CSV file, this
+                                                       !! is the string to use
+                                                       !! (default is `F`)
 
     contains
 
@@ -118,6 +126,8 @@ module csv_module
     subroutine initialize_csv_file(me,quote,delimiter,&
                                     enclose_strings_in_quotes,&
                                     enclose_all_in_quotes,&
+                                    logical_true_string,&
+                                    logical_false_string,&
                                     verbose)
 
     implicit none
@@ -129,6 +139,14 @@ subroutine initialize_csv_file(me,quote,delimiter,&
                                                               !! will be enclosed in quotes.
     logical,intent(in),optional :: enclose_all_in_quotes      !! if true, *all* cells will
                                                               !! be enclosed in quotes.
+    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
+                                                                !! (default is `T`)
+    character(len=1),intent(in),optional :: logical_false_string !! when writing a logical `false`
+                                                                 !! value to a CSV file, this
+                                                                 !! is the string to use
+                                                                 !! (default is `F`)
     logical,intent(in),optional :: verbose
 
     if (present(quote)) me%quote = quote
@@ -137,6 +155,10 @@ subroutine initialize_csv_file(me,quote,delimiter,&
         me%enclose_strings_in_quotes = enclose_strings_in_quotes
     if (present(enclose_all_in_quotes)) &
         me%enclose_all_in_quotes = enclose_all_in_quotes
+    if (present(logical_true_string))  &
+        me%logical_true_string = logical_true_string
+    if (present(logical_false_string)) &
+        me%logical_false_string = logical_false_string
     if (present(verbose)) me%verbose = verbose
 
     end subroutine initialize_csv_file
@@ -176,6 +198,9 @@ subroutine read_csv_file(me,filename,header_row,skip_rows,status_ok)
     integer,intent(in),optional :: header_row  !! the header row
     integer,dimension(:),intent(in),optional :: skip_rows  !! rows to skip
 
+    type(csv_string),dimension(:),allocatable :: row_data  !! a tokenized row
+    integer,dimension(:),allocatable :: rows_to_skip  !! the actual rows to skip
+    character(len=:),allocatable :: line  !! a line from the file
     integer :: i                !! counter
     integer :: j                !! counter
     integer :: irow             !! row counter
@@ -184,11 +209,10 @@ subroutine read_csv_file(me,filename,header_row,skip_rows,status_ok)
     integer :: n_cols           !! number of columns in the file (and output data matrix)
     integer :: istat            !! open status flag
     integer :: iunit            !! open file unit
-    integer,dimension(:),allocatable :: rows_to_skip  !! the actual rows to skip
-    logical :: arrays_allocated  !! if the arrays in the class have been allocated
-    type(csv_string),dimension(:),allocatable :: row_data  !! a tokenized row
-    character(len=:),allocatable :: line  !! a line from the file
-    integer :: iheader  !! row number of header row (0 if no header specified)
+    logical :: arrays_allocated !! if the arrays in the
+                                !! class have been allocated
+    integer :: iheader          !! row number of header row
+                                !! (0 if no header specified)
 
     call me%destroy()
     arrays_allocated = .false.
@@ -264,7 +288,8 @@ subroutine read_csv_file(me,filename,header_row,skip_rows,status_ok)
         status_ok = .true.
 
     else
-        if (me%verbose) write(error_unit,'(A)') 'Error opening file: '//trim(filename)
+        if (me%verbose) write(error_unit,'(A)') &
+                'Error opening file: '//trim(filename)
         status_ok = .false.
     end if
 
@@ -354,7 +379,7 @@ subroutine add_cell(me,val,int_fmt,real_fmt,trim_str)
 
     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
+    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
@@ -389,9 +414,9 @@ subroutine add_cell(me,val,int_fmt,real_fmt,trim_str)
             write(me%iunit,fmt='(A)',advance='NO',iostat=istat) trim(adjustl(real_val))
         type is (logical)
             if (val) then
-                write(me%iunit,fmt='(A)',advance='NO',iostat=istat) 'T'   !TODO make these user-defined strings
+                write(me%iunit,fmt='(A)',advance='NO',iostat=istat) me%logical_true_string
             else
-                write(me%iunit,fmt='(A)',advance='NO',iostat=istat) 'F'
+                write(me%iunit,fmt='(A)',advance='NO',iostat=istat) me%logical_false_string
             end if
         type is (character(len=*))
             if (me%enclose_strings_in_quotes .and. .not. me%enclose_all_in_quotes) &
@@ -709,7 +734,7 @@ pure elemental subroutine to_logical(str,val,status_ok)
     if ( any(tmp==true_str) ) then
         val = .true.
         status_ok = .true.
-    elseif ( any(tmp==false_str) ) then
+    else if ( any(tmp==false_str) ) then
         val = .false.
         status_ok = .true.
     else
@@ -1121,7 +1146,7 @@ subroutine read_line_from_file(me,iunit,line)
             ! add the last block of text before the end of record
             if (nread>0) line = line//buffer(1:nread)
             exit
-        elseif (istat==0) then ! all the characters were read
+        else if (istat==0) then ! all the characters were read
             line = line//buffer  ! add this block of text to the string
         else  ! some kind of error
             error stop 'Read error.'

src/tests/csv_test.f90

@@ -18,8 +18,8 @@ program csv_test
     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
+    !real(wp),dimension(:),allocatable :: y
+    !real(wp),dimension(:),allocatable :: z
     logical :: status_ok
     integer,dimension(:),allocatable :: itypes
 

src/utilities_module.f90

@@ -170,7 +170,7 @@ recursive subroutine quicksort(ilow,ihigh)
                 end do
             end do
 
-        elseif ( ihigh-ilow>max_size_for_insertion_sort ) then
+        else if ( ihigh-ilow>max_size_for_insertion_sort ) then
 
             ! do the normal quicksort:
             call partition(ilow,ihigh,ipivot)