ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
pm_io.F90 File Reference

Go to the source code of this file.

Data Types

type  pm_io::filext_type
 This is the derived type for generating objects containing the source file extensions used by different programming language environments. More...
 
type  pm_io::field_type
 The derived type that can be used for constructing containers of format or left and right delimiters for the (five) intrinsic Fortran field types. More...
 
type  pm_io::form_type
 This is an abstract derived type for constructing concrete derived types to distinguish various procedure signatures that require different file forms (e.g., csv, binary, ...).
More...
 
type  pm_io::unknown_type
 This is a concrete derived type whose instances are exclusively used to signify the unknown file form within an interface of a procedure of the ParaMonte library.
More...
 
type  pm_io::unformatted_type
 This is a concrete derived type whose instances are exclusively used to signify the unformatted (binary) file form within an interface of a procedure of the ParaMonte library.
More...
 
type  pm_io::formatted_type
 This is a concrete derived type whose instances are exclusively used to signify the formatted file form within an interface of a procedure of the ParaMonte library.
More...
 
type  pm_io::csv_type
 This is a concrete derived type whose instances are exclusively used to signify the CSV file form within an interface of a procedure of the ParaMonte library.
More...
 
type  pm_io::fld_type
 This is a concrete derived type whose instances are exclusively used to signify the Fortran-list-directed file form within an interface of a procedure of the ParaMonte library.
More...
 
interface  pm_io::openArg_type
 This is the openArg_type class containing arguments that can be passed to the open() intrinsic Fortran statement. More...
 
interface  pm_io::isOpen
 Generate and return .true. if the input file (or unit) is connected to a unit (or file), and .false. otherwise. More...
 
interface  pm_io::getAction
 Generate and return the action attribute of the input file or unit. More...
 
interface  pm_io::getCountRecord
 Generate and return the number of records in the entire record-oriented input file. More...
 
interface  pm_io::getContentsFrom
 Generate and return the entire contents of the input unconnected file or the (remaining) contents of an already-connected file associated with the input unit.
More...
 
interface  pm_io::setContentsFrom
 Return the entire contents of the input unconnected file or the (remaining) contents of an already-connected file associated with the input unit.
More...
 
interface  pm_io::setContentsTo
 Write the input string contents to the input unconnected file.
More...
 
interface  pm_io::setFileClosed
 Open the given input file, fetch the entire contents return it as a single allocatable string, and close the file. More...
 
interface  pm_io::getRecordFrom
 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...
 
interface  pm_io::setRecordFrom
 Read 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...
 
interface  pm_io::getCountRecordLeft
 Generate and return the number of records left (starting immediately after the last accessed record) in the record-oriented input file. More...
 
interface  pm_io::getErrTableRead
 Generate and return the iostat code resulting from reading the contents of the specified file or unit into an output table.
More...
 
interface  pm_io::getErrTableWrite
 Generate and return the iostat code resulting from writing the input table of rank 1 or 2 to the specified output.
More...
 
interface  pm_io::getFieldSep
 Generate and return the best-guess field separator of a (sequential-access) file stored in the input file. More...
 
type  pm_io::wrap_type
 This is the derived type for constructing objects that contain the specifications of the getStrWrapped dynamic method of objects of derived type wrap_type.
More...
 
interface  pm_io::wrap
 This is a generic method of the derived type display_type with pass attribute.
More...
 
type  pm_io::display_type
 Generate and return an object of type display_type. More...
 
interface  pm_io::skip
 This is a generic method of the derived type display_type with pass attribute.
More...
 
interface  pm_io::show
 This is a generic method of the derived type display_type with pass attribute.
More...
 
interface  pm_io::getFormat
 Generate and return a generic or type/kind-specific IO format with the requested specifications that can be use to read or write individual records in IO actions. More...
 

Modules

module  pm_io
 This module contains classes and procedures for input/output (IO) or generic display operations on standard displays or internal/external files.
 

Functions/Subroutines

pure logical(LK) function pm_io::isValidAccess (value)
 
pure logical(LK) function pm_io::isValidAction (value)
 
pure logical(LK) function pm_io::isValidAsynchronous (value)
 
pure logical(LK) function pm_io::isValidBlank (value)
 
pure logical(LK) function pm_io::isValidDecimal (value)
 
pure logical(LK) function pm_io::isValidDelim (value)
 
pure logical(LK) function pm_io::isValidEncoding (value)
 
pure logical(LK) function pm_io::isValidForm (value)
 
pure logical(LK) function pm_io::isValidPad (value)
 
pure logical(LK) function pm_io::isValidPosition (value)
 
pure logical(LK) function pm_io::isValidRecl (value)
 
pure logical(LK) function pm_io::isValidRound (value)
 
pure logical(LK) function pm_io::isValidSign (value)
 
pure logical(LK) function pm_io::isValidStatus (value)
 
pure elemental logical(LK) function pm_io::isPreconnected (unit)
 Generate and return .true. if the input unit corresponds to one of the processor preconnected units: output_unit, input_unit, error_unit, otherwise return .false.. More...
 
impure elemental integer(IK) function pm_io::getFileUnit (file)
 Generate and return a random new unconnected file unit number that could be assigned to the unit specifier of the Fortran intrinsic open statement. Optionally, return the unit number of a file whose path is given by the input argument file. More...
 

Variables

character(*, SK), parameter pm_io::MODULE_NAME = "@pm_io"
 
type(filext_type), parameter pm_io::filext = filext_type()
 The scalar constant object of type filext_type containing file extensions used by different programming language environments. More...
 
character(*, SK), parameter pm_io::MFILL = SK_"%"
 The scalar character of default kind SK of len = 1 representing the default string that is used for filling the margins of the display or wrapped texts. More...
 
character(1, SK), parameter pm_io::TAB = achar(9, SK)
 The scalar character of default kind SK of len = 4 representing representing ASCII character: Horizontal Tab, which is frequently used in external files as column or field separators. More...
 
character(*, SK), parameter pm_io::TABEQV = repeat(SK_" ", 4)
 The scalar character of default kind SK of len = 4 representing the default string that is used in place of the tab character in the display. More...
 
character(*, SK), parameter pm_io::INDENT = TABEQV
 The scalar character of default kind SK of the same value as TABEQV representing the default indentation of text in the display, when indentation is needed. More...
 
character(*, SK), parameter pm_io::FORMAT_GENERIC_BLANK = SK_"(*(g0,:,' '))"
 The scalar character of default kind SK containing the generic IO whitespace-separated IO format. More...
 
character(*, SK), parameter pm_io::FORMAT_GENERIC_BLANK_TABBED = SK_"('"//INDENT//SK_"',*(g0,:,' '))"
 The scalar character of default kind SK containing the generic IO whitespace-separated IO format with in an initial INDENT. More...
 
character(*, SK), parameter pm_io::FORMAT_GENERIC_DISPLAY = SK_"(sp,*(g0,:,', '))"
 The scalar character of default kind SK containing the generic signed comma-space-separated format used as the default within objects of display_type. More...
 
character(*, SK), parameter pm_io::FORMAT_GENERIC_DISPLAY_COMPLEX_MATH = SK_"(sp,*(2g0,'i',:,', '))"
 The scalar character of default kind SK containing the generic signed comma-space-separated format that can be used as the math-style complex formatting when constructing objects of display_type. More...
 
character(*, SK), parameter pm_io::FORMAT_GENERIC_DISPLAY_COMPLEX_FORTRAN = SK_"(sp,*('(',g0,', ',g0,')',:,', '))"
 The scalar character of default kind SK containing the generic signed comma-space-separated format that can be used as the Fortran-style complex formatting when constructing objects of display_type. More...
 
character(1, SK), dimension(4), parameter pm_io::SPINNER = [ "|" , "/" , "-" , "\" ]
 The scalar character(1, SK) of default kind SK of size 4, containing the four characters used to display a spinning command line cursor. More...
 
integer(IK), parameter pm_io::LEN_IOMSG = 511_IK
 The scalar integer of default kind IK representing the maximum length of an IO error message returned by the Fortran intrinsic routines. Note that this an arbitrary length defined globally for consistency. More...
 
integer(IK), parameter pm_io::LEN_RECORD = 8191_IK
 The scalar integer of default kind IK representing the effective maximum length of a record in a record-oriented file. Note that this is an arbitrary length defined globally for consistency. More...
 
type(unknown_type), parameter pm_io::unknown = unknown_type()
 This is a scalar parameter object of type unknown_type that is exclusively used to signify the unknown file form within an interface of a procedure of the ParaMonte library.
More...
 
type(unformatted_type), parameter pm_io::unformatted = unformatted_type()
 This is a scalar parameter object of type unformatted_type that is exclusively used to signify the unformatted (binary) file form within an interface of a procedure of the ParaMonte library.
More...
 
type(formatted_type), parameter pm_io::formatted = formatted_type()
 This is a scalar parameter object of type formatted_type that is exclusively used to signify the formatted file form within an interface of a procedure of the ParaMonte library.
More...
 
type(csv_type), parameter pm_io::csv = csv_type()
 This is a scalar parameter object of type csv_type that is exclusively used to signify the CSV file form within an interface of a procedure of the ParaMonte library.
More...
 
type(fld_type), parameter pm_io::fld = fld_type()
 This is a scalar parameter object of type fld_type that is exclusively used to signify the Fortran-list-directed file form within an interface of a procedure of the ParaMonte library.
More...
 
type(display_type) pm_io::disp
 This is a scalar module variable an object of type display_type for general display.
More...