Open the given input file, fetch the entire contents return it as a single allocatable string, and close the file. More...

Detailed Description

Open the given input file, fetch the entire contents return it as a single allocatable string, and close the file.

Parameters

[out]	unit	: The input scalar `integer` of default kind IK containing the file unit number to close.
[in]	del	: The input scalar `logical` of default kind LK. If `.true.`, the file will be deleted upon return. 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.)
[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 the `iostat` output argument is also present.)

Possible calling interfaces ⛓

: use pm_io, only: setFileClosed

call setFileClosed(unit, del = del, iostat = iostat, iomsg = iomsg)

pm_io::setFileClosed
Open the given input file, fetch the entire contents return it as a single allocatable string,...
Definition: pm_io.F90:1889

pm_io
This module contains classes and procedures for input/output (IO) or generic display operations on st...
Definition: pm_io.F90:252

Note

As per the Fortran standard rules,

if the specified file unit a non-existing or unconnected unit, then the close() statement acts as a do nothing statement (no error occurs).
If the file connected to the unit has scratch status, then it will be automartically deleted regardless of the specified value for del.

See also: getFileUnit
isPreconnected

Example usage ⛓

: 1program example

2

3 use pm_kind, only: SK, IK, LK

4 use pm_io, only: display_type

5 use pm_io, only: setFileClosed

6

7 implicit none

8

9 integer(IK) :: iostat

10 character(132,SK) :: iomsg

11

12 type(display_type) :: disp

13 disp = display_type(file = "main.out.F90")

14

15 call disp%skip

16 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")

17 call disp%show("!Control runtime IO error with optional error status code and message.")

18 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")

19 call disp%skip

20

21 iomsg = repeat(" ", len(iomsg))

22

23 call disp%skip

24 call disp%show("call setFileClosed(unit = 43, iostat = iostat, iomsg = iomsg)")

25 call setFileClosed(unit = 43, iostat = iostat, iomsg = iomsg)

26 call disp%show("iostat")

27 call disp%show( iostat )

28 call disp%show("trim(iomsg)")

29 call disp%show( trim(iomsg) , deliml = """")

30 call disp%skip

31

32 iomsg = repeat(" ", len(iomsg))

33

34 call disp%skip

35 call disp%show("call setFileClosed(unit = 43, del = .true._LK, iostat = iostat, iomsg = iomsg)")

36 call setFileClosed(unit = 43, del = .true._LK, iostat = iostat, iomsg = iomsg)

37 call disp%show("iostat")

38 call disp%show( iostat )

39 call disp%show("trim(iomsg)")

40 call disp%show( trim(iomsg) , deliml = """")

41 call disp%skip

42

43 iomsg = repeat(" ", len(iomsg))

44

45 call disp%skip

46 call disp%show("open(unit = 34, status = 'scratch')")

47 open(unit = 34, status = 'scratch')

48 call disp%show("call setFileClosed(unit = 34, del = .true._LK, iostat = iostat, iomsg = iomsg)")

49 call setFileClosed(unit = 34, del = .true._LK, iostat = iostat, iomsg = iomsg)

50 call disp%show("iostat")

51 call disp%show( iostat )

52 call disp%show("trim(iomsg)")

53 call disp%show( trim(iomsg) , deliml = """")

54 call disp%skip

55

56 iomsg = repeat(" ", len(iomsg))

57

58 call disp%skip

59 call disp%show("call setFileClosed(unit = -34, iostat = iostat)")

60 call setFileClosed(unit = -34, iostat = iostat)

61 call disp%show("iostat")

62 call disp%show( iostat )

63 call disp%show("trim(iomsg)")

64 call disp%show( trim(iomsg) , deliml = SK_"""" )

65 call disp%skip

66

67end program example

pm_io::show
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11726

pm_io::skip
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11508

pm_io::disp
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
Definition: pm_io.F90:11393

pm_kind
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
Definition: pm_kind.F90:268

pm_kind::LK
integer, parameter LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
Definition: pm_kind.F90:541

pm_kind::IK
integer, parameter IK
The default integer kind in the ParaMonte library: int32 in Fortran, c_int32_t in C-Fortran Interoper...
Definition: pm_kind.F90:540

pm_kind::SK
integer, parameter SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in C-Fortran Intero...
Definition: pm_kind.F90:539

pm_io::display_type
Generate and return an object of type display_type.
Definition: pm_io.F90:10282

Example Unix compile command via Intel ifort compiler ⛓
1#!/usr/bin/env sh

2rm main.exe

3ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe

4./main.exe

Example Windows Batch compile command via Intel ifort compiler ⛓
1del main.exe

2set PATH=..\..\..\lib;%PATH%

3ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe

4main.exe

Example Unix / MinGW compile command via GNU gfortran compiler ⛓
1#!/usr/bin/env sh

2rm main.exe

3gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe

4./main.exe

Example output ⛓
1

2!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

3!Control runtime IO error with optional error status code and message.

4!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

5

6

7call setFileClosed(unit = 43, iostat = iostat, iomsg = iomsg)

8iostat

9+0

10trim(iomsg)

11" "

12

13

14call setFileClosed(unit = 43, del = .true._LK, iostat = iostat, iomsg = iomsg)

15iostat

16+0

17trim(iomsg)

18""

19

20

21open(unit = 34, status = 'scratch')

22call setFileClosed(unit = 34, del = .true._LK, iostat = iostat, iomsg = iomsg)

23iostat

24+0

25trim(iomsg)

26""

27

28

29call setFileClosed(unit = -34, iostat = iostat)

30iostat

31+0

32trim(iomsg)

33""

34

35

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 1889 of file pm_io.F90.

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

src/fortran/main/pm_io.F90