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.
- Parameters
-
| [in] | unit | : The input scalar integer of default kind IK containing the unit of an already-connected (opened) file whose (partial) contents will be returned.
(optional. It must be present if and only if the input argument file is missing.) |
| [in] | file | : The input scalar character of default kind SK containing the path of an unconnected (unopened) file whose entire contents will be returned.
(optional. It must be present if and only if the input argument unit is missing.) |
| [in] | del | : See the documentation for the corresponding argument of setContentsFrom().
(optional. The default behavior is set by setContentsFrom()) |
- Returns
contents : The output allocatable scalar character of default kind SK that will contain the file contents.
The allocation status of contents or its value remain undefined if an error occurs.
Possible calling interfaces ⛓
character(:, SK), allocatable :: contents
Generate and return the entire contents of the input unconnected file or the (remaining) contents of ...
This module contains classes and procedures for input/output (IO) or generic display operations on st...
- Warning
- All warnings associated with setContentsFrom also apply to the procedures under this generic interface.
-
If the procedure fails to fetch the contents of the file, the program may stop by signaling the occurrence of an error.
Use setContentsFrom for graceful error handling.
- See also
- getFileUnit
isPreconnected
setContentsFrom
Example usage ⛓
11 character(:, SK),
allocatable :: contents
13 type(display_type) :: disp
17 call disp%show(
"contents = getContentsFrom('main.F90')")
26#if !__INTEL_COMPILER || !_WIN32
28 call disp%show(
"open(newunit = unit, file = 'main.F90')")
29 open(newunit
= unit, file
= 'main.F90')
30 call disp%show(
"contents = getContentsFrom(unit)")
Generate and return a resized and centered copy of the input array within the newly allocated arrayCe...
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.
This module contains procedures and generic interfaces for resizing an input array and centering the ...
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 ⛓
3_____________________________________________________________ contents _____________________________________________________________
14 character(:, SK),
allocatable :: contents
16 type(display_type) :: disp
20 call disp%show(
"contents = getContentsFrom('main.F90')")
29#if !__INTEL_COMPILER || !_WIN32
31 call disp%show(
"open(newunit = unit, file = 'main.F90')")
32 open(newunit
= unit, file
= 'main.F90')
33 call disp%show(
"contents = getContentsFrom(unit)")
42_________________________________________________________
end of contents __________________________________________________________
45open(newunit
= unit, file
= 'main.F90')
47_____________________________________________________________ contents _____________________________________________________________
58 character(:, SK),
allocatable :: contents
60 type(display_type) :: disp
64 call disp%show(
"contents = getContentsFrom('main.F90')")
73#if !__INTEL_COMPILER || !_WIN32
75 call disp%show(
"open(newunit = unit, file = 'main.F90')")
76 open(newunit
= unit, file
= 'main.F90')
77 call disp%show(
"contents = getContentsFrom(unit)")
86_________________________________________________________
end of contents __________________________________________________________
- 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 Austin
Definition at line 1586 of file pm_io.F90.
1.9.3