Generate and return a full record (line) of arbitrary length as a string from the current position of the record-oriented and formatted file connected to the specified input unit.
More...
Generate and return a full record (line) of arbitrary length as a string from the current position of the record-oriented and formatted file connected to the specified input unit.
- Parameters
-
| [in] | unit | : The input scalar integer of default kind IK representing the unit of the connected file to read the line from.
|
| [out] | iostat | : The output scalar integer of default kind IK.
-
If present and no error occurs, it is set to
0 on output.
-
If present and an end-of-file condition occurs, it is set to
iostat_end from Fortran intrinsic module iso_fortran_env.
-
If present and an error occurs (e.g., if the input argument values are wrong or inconsistent), it is set to a positive non-zero value.
-
If missing and an error occurs (including end-of-file condition), then the program halts by calling
error stop followed by the relevant error message.
(optional.) |
| [in,out] | iomsg | : The input/output scalar character of default kind SK containing the error message, if any error occurs.
A length type parameter value of LEN_IOMSG is generally sufficient for iomsg to contain the output error messages.
(optional. Its presence is relevant only if iostat is also present.) |
| [in] | linefed | : The input scalar logical of default kind LK.
If .true., then the output record will end with the new line character(s) as specified by the Fortran intrinsic new_line("a").
If .false., then the output record will not end with the new line character(s).
In either case, only one record will be read from the specified unit, but will or will not end with a new line character if linefed is .true. or .false. respectively.
This behavior is extremely useful for,
-
reading records from a CSV file potentially containing new line characters in its fields.
-
consecutively reading a series of lines of a
unit into a single string by repeated calls to this generic interface while preserving the linefeed characters as record separators.
(optional, default = .false.) |
- Returns
record : The output allocatable scalar character of default kind SK that will contain the requested line in full.
If you suspect an end-of-file condition may occur, always specify and check the output value of iostat before using the contents of record.
Possible calling interfaces ⛓
character(:, SK), allocatable :: record
record
= getRecordFrom(unit,
iostat = iostat,
iomsg = iomsg, linefed
= linefed)
Generate and return a full record (line) of arbitrary length as a string from the current position of...
This module contains classes and procedures for input/output (IO) or generic display operations on st...
- Warning
- All warnings associated with setRecordFrom also apply to the procedures under this generic interface.
- See also
- setRecordFrom
getContentsFrom
setContentsFrom
isPreconnected
getFileUnit
Example usage ⛓
6 use iso_fortran_env,
only:
iostat_end
13 character(
255, SK) :: iomsg
14 character( :, SK),
allocatable :: record
16 type(display_type) :: disp
21 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
22 call disp%show(
"!Read the record-oriented (sequential access) `main.F90` file, line by line to the end.")
23 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
26 iomsg
= repeat(
" ",
len(iomsg))
28 call disp%show(
'open(newunit = unit, file = "main.F90", status = "old")')
29 open(newunit
= unit, file
= "main.F90", status
= "old")
32 call disp%show(
"record = getRecordFrom(unit, iostat = iostat)")
34 if (iostat
== 0_IK)
then
36 call disp%show( record , deliml
= SK_
"""" )
38 call disp%show(
"[iostat, iostat_end]")
39 call disp%show( [iostat,
iostat_end] )
This is a generic method of the derived type display_type with pass attribute.
This is a generic method of the derived type display_type with pass attribute.
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
integer, parameter LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
integer, parameter IK
The default integer kind in the ParaMonte library: int32 in Fortran, c_int32_t in C-Fortran Interoper...
integer, parameter SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in C-Fortran Intero...
Generate and return an object of type display_type.
Example Unix compile command via Intel ifort compiler ⛓
3ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
Example Windows Batch compile command via Intel ifort compiler ⛓
2set PATH=..\..\..\lib;%PATH%
3ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
Example Unix / MinGW compile command via GNU gfortran compiler ⛓
3gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
Example output ⛓
6open(newunit
= unit, file
= "main.F90", status
= "old")
20" use pm_kind, only: SK, IK, LK"
25" use pm_io, only: getRecordFrom"
30" use pm_io, only: display_type"
35" use iso_fortran_env, only: iostat_end"
65" integer(IK) :: iostat"
70" character(255, SK) :: iomsg"
75" character( :, SK), allocatable :: record"
85" type(display_type) :: disp"
95" disp = display_type(file = "main.out.F90
")"
135" iomsg = repeat(" ", len(iomsg))"
145" call disp%show('open(newunit = unit, file = "main.F90
", status = "old
")')"
150" open(newunit = unit, file = "main.F90
", status = "old
")"
165" call disp%show("record
= getRecordFrom(unit,
iostat = iostat)
")"
170" record = getRecordFrom(unit, iostat = iostat)"
175" if (iostat == 0_IK) then"
180" call disp%show("record
")"
185" call disp%show( record , deliml = SK_"""" )"
195" call disp%show("[iostat,
iostat_end]
")"
200" call disp%show( [iostat, iostat_end] )"
program main
This is main entry to the tests of the ParaMonte kernel library.
- Test:
- test_pm_io
Final Remarks ⛓
If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.
-
If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
-
If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.
This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.
- Copyright
- Computational Data Science Lab
- Author:
- Amir Shahmoradi, Tuesday March 7, 2017, 3:50 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas at Austin
Definition at line 1971 of file pm_io.F90.
1.9.3