underscore

Author: perazz

doc/specs/stdlib_io.md

@@ -205,7 +205,7 @@ Provides a npy file called `filename` that contains the rank-2 `array`.
 {!example/io/example_savenpy.f90!}
 ```
 
-## `getline`
+## `get_line`
 
 ### Status
 
@@ -217,9 +217,9 @@ Read a whole line from a formatted unit into a string variable
 
 ### Syntax
 
-`call ` [[stdlib_io(module):getline(interface)]] ` (unit, line[, iostat][, iomsg])`
+`call ` [[stdlib_io(module):get_line(interface)]] ` (unit, line[, iostat][, iomsg])`
 
-`call ` [[stdlib_io(module):getline(interface)]] ` (line[, iostat][, iomsg])`
+`call ` [[stdlib_io(module):get_line(interface)]] ` (line[, iostat][, iomsg])`
 
 ### Arguments
 
@@ -241,7 +241,7 @@ Read a whole line from a formatted unit into a string variable
 ### Example
 
 ```fortran
-{!example/io/example_getline.f90!}
+{!example/io/example_get_line.f90!}
 ```
 
 ## Formatting constants
@@ -261,7 +261,7 @@ Provides formats for all kinds as defined in the `stdlib_kinds` module.
 {!example/io/example_fmt_constants.f90!}
 ```
 
-## `getfile` - Read a whole ASCII file into a `character` or a `string` variable
+## `get_file` - Read a whole ASCII file into a `character` or a `string` variable
 
 ### Status
 
@@ -274,7 +274,7 @@ The function provides an optional error-handling mechanism via the `state_type`
 
 ### Syntax
 
-`call [[stdlib_io(module):getfile(subroutine)]] (filename, file [, err] [, delete=.false.])`
+`call [[stdlib_io(module):get_file(subroutine)]] (filename, file [, err] [, delete=.false.])`
 
 ### Class
 Function
@@ -299,5 +299,5 @@ Exceptions trigger an `error stop` unless the optional `err` argument is provide
 ### Example
 
 ```fortran
-{!example/io/example_getfile.f90!}
+{!example/io/example_get_file.f90!}
 ```

example/io/CMakeLists.txt

@@ -1,6 +1,6 @@
 ADD_EXAMPLE(fmt_constants)
-#ADD_EXAMPLE(getline)
-ADD_EXAMPLE(getfile)
+#ADD_EXAMPLE(get_line)
+ADD_EXAMPLE(get_file)
 ADD_EXAMPLE(loadnpy)
 ADD_EXAMPLE(loadtxt)
 ADD_EXAMPLE(open)

example/io/example_getfile.f90 renamed to example/io/example_get_file.f90

@@ -1,6 +1,6 @@
-! Demonstrate usage of `getfile`
-program example_getfile
-  use stdlib_io, only: getfile
+! Demonstrate usage of `get_file`
+program example_get_file
+  use stdlib_io, only: get_file
   use stdlib_string_type, only: string_type
   use stdlib_error, only: state_type
   implicit none
@@ -10,11 +10,11 @@ program example_getfile
   type(state_type) :: err
 
   ! Read a file into a string
-  call getfile(filename, filecontent, err=err)
+  call get_file(filename, filecontent, err=err)
 
   if (err%error()) then
     print *, err%print()
   else
     print *, "Success! File "//filename//" imported."
   end if
-end program example_getfile
+end program example_get_file

example/io/example_getline.f90 renamed to example/io/example_get_line.f90

@@ -1,13 +1,13 @@
 program example_getline
   use, intrinsic :: iso_fortran_env, only: input_unit, output_unit
-  use stdlib_io, only: getline
+  use stdlib_io, only: get_line
   implicit none
   character(len=:), allocatable :: line
   integer :: stat
 
-  call getline(input_unit, line, stat)
+  call get_line(input_unit, line, stat)
   do while (stat == 0)
     write (output_unit, '(a)') line
-    call getline(input_unit, line, stat)
+    call get_line(input_unit, line, stat)
   end do
 end program example_getline

src/stdlib_io.fypp

@@ -16,12 +16,12 @@ module stdlib_io
   implicit none
   private
   ! Public API
-  public :: loadtxt, savetxt, open, getline, getfile
+  public :: loadtxt, savetxt, open, get_line, get_file
 
   !! version: experimental 
   !!
   !! Reads a whole ASCII file and loads its contents into a string variable. 
-  !! ([Specification](../page/specs/stdlib_io.html#getfile-read-a-whole-ascii-file-into-a-character-or-a-string-variable))
+  !! ([Specification](../page/specs/stdlib_io.html#get-file-read-a-whole-ascii-file-into-a-character-or-a-string-variable))
   !! 
   !!### Summary 
   !! Subroutine interface for reading the content of a file into a string.
@@ -35,10 +35,10 @@ module stdlib_io
   !!@note Handles errors using the library's `state_type` error-handling class. If not provided, 
   !! exceptions will trigger an `error stop`. 
   !!         
-  interface getfile
-    module procedure :: getfile_char
-    module procedure :: getfile_string
-  end interface getfile
+  interface get_file
+    module procedure :: get_file_char
+    module procedure :: get_file_string
+  end interface get_file
 
   ! Private API that is exposed so that we can test it in tests
   public :: parse_mode
@@ -73,12 +73,12 @@ module stdlib_io
   !> Version: experimental
   !>
   !> Read a whole line from a formatted unit into a string variable
-  interface getline
-    module procedure :: getline_char
-    module procedure :: getline_string
-    module procedure :: getline_input_char
-    module procedure :: getline_input_string
-  end interface getline
+  interface get_line
+    module procedure :: get_line_char
+    module procedure :: get_line_string
+    module procedure :: get_line_input_char
+    module procedure :: get_line_input_string
+  end interface get_line
 
   interface loadtxt
     !! version: experimental
@@ -287,7 +287,7 @@ contains
     number_of_columns = 0
 
     ! Read first non-skipped line as a whole
-    call getline(s, line, ios)
+    call get_line(s, line, ios)
     if (ios/=0 .or. .not.allocated(line)) return
 
     lastblank = .true.
@@ -459,7 +459,7 @@ contains
   !> Version: experimental
   !>
   !> Read a whole line from a formatted unit into a deferred length character variable
-  subroutine getline_char(unit, line, iostat, iomsg)
+  subroutine get_line_char(unit, line, iostat, iomsg)
     !> Formatted IO unit
     integer, intent(in) :: unit
     !> Line to read
@@ -501,12 +501,12 @@ contains
     else if (stat /= 0) then
       call error_stop(trim(msg))
     end if
-  end subroutine getline_char
+  end subroutine get_line_char
 
   !> Version: experimental
   !>
   !> Read a whole line from a formatted unit into a string variable
-  subroutine getline_string(unit, line, iostat, iomsg)
+  subroutine get_line_string(unit, line, iostat, iomsg)
     !> Formatted IO unit
     integer, intent(in) :: unit
     !> Line to read
@@ -518,43 +518,43 @@ contains
 
     character(len=:), allocatable :: buffer
 
-    call getline(unit, buffer, iostat, iomsg)
+    call get_line(unit, buffer, iostat, iomsg)
     line = string_type(buffer)
-  end subroutine getline_string
+  end subroutine get_line_string
 
   !> Version: experimental
   !>
   !> Read a whole line from the standard input into a deferred length character variable
-  subroutine getline_input_char(line, iostat, iomsg)
+  subroutine get_line_input_char(line, iostat, iomsg)
     !> Line to read
     character(len=:), allocatable, intent(out) :: line
     !> Status of operation
     integer, intent(out), optional :: iostat
     !> Error message
     character(len=:), allocatable, optional :: iomsg
 
-    call getline(input_unit, line, iostat, iomsg)
-  end subroutine getline_input_char
+    call get_line(input_unit, line, iostat, iomsg)
+  end subroutine get_line_input_char
 
   !> Version: experimental
   !>
   !> Read a whole line from the standard input into a string variable
-  subroutine getline_input_string(line, iostat, iomsg)
+  subroutine get_line_input_string(line, iostat, iomsg)
     !> Line to read
     type(string_type), intent(out) :: line
     !> Status of operation
     integer, intent(out), optional :: iostat
     !> Error message
     character(len=:), allocatable, optional :: iomsg
 
-    call getline(input_unit, line, iostat, iomsg)
-  end subroutine getline_input_string
+    call get_line(input_unit, line, iostat, iomsg)
+  end subroutine get_line_input_string
 
   !> Version: experimental
   !> 
   !> Reads a whole ASCII file and loads its contents into a string variable.
   !> The function handles error states and optionally deletes the file after reading.
-  subroutine getfile_string(filename,file,err,delete) 
+  subroutine get_file_string(filename,file,err,delete) 
       !> Input file name
       character(*), intent(in) :: filename
       !> Output string variable
@@ -568,16 +568,16 @@ contains
       character(len=:), allocatable :: filestring
 
       ! Process output
-      call getfile_char(filename,filestring,err,delete)
+      call get_file_char(filename,filestring,err,delete)
       call move(from=fileString,to=file)
 
-  end subroutine getfile_string
+  end subroutine get_file_string
 
   !> Version: experimental
   !> 
   !> Reads a whole ASCII file and loads its contents into an allocatable `character` variable.
   !> The function handles error states and optionally deletes the file after reading.
-  subroutine getfile_char(filename,file,err,delete) 
+  subroutine get_file_char(filename,file,err,delete) 
       !> Input file name
       character(*), intent(in) :: filename
       !> Output string variable
@@ -605,7 +605,7 @@ contains
       inquire(file=filename, exist=is_present)
       if (.not.is_present) then
          allocate(character(len=0) :: file)
-         err0 = state_type('getfile',STDLIB_IO_ERROR,'File not present:',filename)
+         err0 = state_type('get_file',STDLIB_IO_ERROR,'File not present:',filename)
          call err0%handle(err)
          return
       end if
@@ -616,7 +616,7 @@ contains
       invalid_size: if (file_size<0) then 
 
           allocate(character(len=0) :: file)
-          err0 = state_type('getfile',STDLIB_IO_ERROR,filename,'has invalid size=',file_size)
+          err0 = state_type('get_file',STDLIB_IO_ERROR,filename,'has invalid size=',file_size)
           call err0%handle(err)
           return            
 
@@ -629,7 +629,7 @@ contains
 
       if (iostat/=0) then 
          allocate(character(len=0) :: file)
-         err0 = state_type('getfile',STDLIB_IO_ERROR,'Cannot open',filename,'for read:',iomsg)
+         err0 = state_type('get_file',STDLIB_IO_ERROR,'Cannot open',filename,'for read:',iomsg)
          call err0%handle(err)
          return
       end if     
@@ -644,7 +644,7 @@ contains
           if (iostat/=0) then 
 
               inquire(unit=lun,pos=errpos)                    
-              err0 = state_type('getfile',STDLIB_IO_ERROR,iomsg,'(',filename,'at byte',errpos,')')
+              err0 = state_type('get_file',STDLIB_IO_ERROR,iomsg,'(',filename,'at byte',errpos,')')
               call err0%handle(err)
               return
 
@@ -654,15 +654,15 @@ contains
 
       if (want_deleted) then 
          close(lun,iostat=iostat,status='delete')
-         if (iostat/=0) err0 = state_type('getfile',STDLIB_IO_ERROR,'Cannot delete',filename,'after reading')
+         if (iostat/=0) err0 = state_type('get_file',STDLIB_IO_ERROR,'Cannot delete',filename,'after reading')
       else
          close(lun,iostat=iostat)
-         if (iostat/=0) err0 = state_type('getfile',STDLIB_IO_ERROR,'Cannot close',filename,'after reading')
+         if (iostat/=0) err0 = state_type('get_file',STDLIB_IO_ERROR,'Cannot close',filename,'after reading')
       endif 
 
       ! Process output
       call err0%handle(err)
 
-  end subroutine getfile_char
+  end subroutine get_file_char
 
 end module stdlib_io

test/io/CMakeLists.txt

@@ -13,7 +13,7 @@ ADDTEST(savetxt_qp)
 set_tests_properties(loadtxt_qp PROPERTIES LABELS quadruple_precision)
 set_tests_properties(savetxt_qp PROPERTIES LABELS quadruple_precision)
 
-ADDTEST(getline)
+ADDTEST(get_line)
 ADDTEST(npy)
 ADDTEST(open)
 ADDTEST(parse_mode)