pm_io::setContentsFrom Interface Reference

Return the entire contents of the input unconnected file or the (remaining) contents of an already-connected file associated with the input unit.
More...

Detailed Description

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.)
[out]	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. If iostat is present, always check the value of iostat before using contents.
[in]	del	: The input scalar logical of default kind LK. If .true., the file will be deleted upon return. This is guaranteed only if no runtime error occurs. If .false., the file will only be closed (without deletion) upon return. (optional, default = .false.)
[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 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, then the program halts by calling error stop followed by the relevant error message. (optional. It must be present if and only if the output argument iomsg is also present.)
[in,out]	iomsg	: The input/output scalar character of default kind SK of arbitrary length type parameter, containing the error message. A length type parameter value of LEN_IOMSG is generally sufficient for iomsg to contain the output error messages in full. (optional. It must be present if and only if the output argument iostat is also present.)

Possible calling interfaces ⛓

use pm_io, only: setContentsFrom
character(:, SK), allocatable :: contents
 
call setContentsFrom(unit, contents, del = del)
call setContentsFrom(file, contents, del = del)
call setContentsFrom(unit, contents, iostat, iomsg, del = del)
call setContentsFrom(file, contents, iostat, iomsg, del = del)

Warning

The condition isOpen(unit) must hold for the corresponding input arguments.
The condition .not. isOpen(file) must hold for the corresponding input arguments.
The condition 0 < index(getAction(unit), "READ") must hold for the corresponding input arguments.
These conditions are verified only if the library is built with the preprocessor macro CHECK_ENABLED=1.

Remarks

The procedures under discussion are impure.

See also

getFileUnit
isPreconnected
getContentsFrom

Example usage ⛓

program example
 
    use pm_kind, only: SK, IK, LK
    use pm_io, only: display_type
    use pm_io, only: setContentsFrom
    use pm_arrayCenter, only: getCentered
 
    implicit none
 
    integer(IK)                     :: iostat
    character(255, SK)              :: iomsg
    character(  :, SK), allocatable :: contents
 
    type(display_type) :: disp
 
    disp = display_type(file = "main.out.F90")
 
    call disp%skip
    call disp%show("call setContentsFrom('main.F90', contents, iostat = iostat, iomsg = iomsg)")
                    call setContentsFrom('main.F90', contents, iostat = iostat, iomsg = iomsg)
    call disp%show( getCentered(SK_" contents ", size = 132_IK, fill = SK_"_") )
    call disp%show( contents )
    call disp%show( getCentered(SK_" end of contents ", size = 132_IK, fill = SK_"_") )
    call disp%show("iostat")
    call disp%show( iostat )
    call disp%show("trim(iomsg)")
    call disp%show( trim(iomsg) , deliml = SK_"""" )
    call disp%skip
 
end program example

Example Unix compile command via Intel ifort compiler ⛓

#!/usr/bin/env sh
rm main.exe
ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example Windows Batch compile command via Intel ifort compiler ⛓

del main.exe
set PATH=..\..\..\lib;%PATH%
ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
main.exe

Example Unix / MinGW compile command via GNU gfortran compiler ⛓

#!/usr/bin/env sh
rm main.exe
gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example output ⛓

 
call setContentsFrom('main.F90', contents, iostat = iostat, iomsg = iomsg)
_____________________________________________________________ contents _____________________________________________________________
program example
 
    use pm_kind, only: SK, IK, LK
    use pm_io, only: display_type
    use pm_io, only: setContentsFrom
    use pm_arrayCenter, only: getCentered
 
    implicit none
 
    integer(IK)                     :: iostat
    character(255, SK)              :: iomsg
    character(  :, SK), allocatable :: contents
 
    type(display_type) :: disp
 
    disp = display_type(file = "main.out.F90")
 
    call disp%skip
    call disp%show("call setContentsFrom('main.F90', contents, iostat = iostat, iomsg = iomsg)")
                    call setContentsFrom('main.F90', contents, iostat = iostat, iomsg = iomsg)
    call disp%show( getCentered(SK_" contents ", size = 132_IK, fill = SK_"_") )
    call disp%show( contents )
    call disp%show( getCentered(SK_" end of contents ", size = 132_IK, fill = SK_"_") )
    call disp%show("iostat")
    call disp%show( iostat )
    call disp%show("trim(iomsg)")
    call disp%show( trim(iomsg) , deliml = SK_"""" )
    call disp%skip
 
end program example
_________________________________________________________ end of contents __________________________________________________________
iostat
+0
trim(iomsg)
" `3òOV  Àc3òOV      ␁       ␆   YES                                                                                                                                                                                                                            "
 
 

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.

1. 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.
   
2. 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 1678 of file pm_io.F90.

---

The documentation for this interface was generated from the following file:

• src/fortran/main/pm_io.F90