pm_sysPath::isExtant Interface Reference

Generate and return .true. if the input path (whether a file or a directory) exists and .false. otherwise.
More...

Detailed Description

Generate and return .true. if the input path (whether a file or a directory) exists and .false. otherwise.

This generic functional interface is a simple convenience wrapper around the generic interfaces isFile() and isDir() and returns the short-circuited result of isFile() .or. isDir().
As such, its behavior is fully dictated by these generic interfaces.

Parameters

[in]	path	: The input scalar, or array of arbitrary rank, of type character of default kind SK representing the path whose existence is to be checked.
[out]	iostat	: The optional 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, 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. It can be present only if the iostat output argument is also present.)

Returns

extant : The output scalar, or array of same rank, shape, and size as the input array-like argument, of type logical of default kind LK.
It is .true. if and only if the input path (whether a file or a directory) exists.
Otherwise, it is .false..

Possible calling interfaces ⛓

use pm_kind, only: LK
use pm_sysPath, only: isExtant
integer(IK) :: iostat
logical(LK) :: extant
 
extant = isExtant(path)
extant = isExtant(path, iostat, iomsg = iomsg)

Remarks

The procedures under discussion are impure.

The procedures under discussion are elemental.

See also

isOpen
isDir
isFile
isExtant
isPreconnected

Example usage ⛓

program example
 
    use iso_fortran_env, only: output_unit, input_unit, error_unit
    use pm_kind, only: SK, IK, LK
    use pm_sysPath, only: isExtant
    use pm_io, only: display_type
 
    implicit none
 
    integer(IK) :: unit
    type(display_type) :: disp
 
    disp = display_type(file = "main.out.F90")
 
    call disp%skip
    call disp%show("isExtant('temp.tmp')")
    call disp%show( isExtant('temp.tmp') )
    call disp%skip
 
    call disp%skip
    call disp%show("open(newunit = unit, file = 'temp.tmp')")
                    open(newunit = unit, file = 'temp.tmp')
    call disp%show("isExtant('temp.tmp')")
    call disp%show( isExtant('temp.tmp') )
    call disp%show("close(unit)")
                    close(unit)
    call disp%show("isExtant('temp.tmp')")
    call disp%show( isExtant('temp.tmp') )
    call disp%skip
 
    call disp%skip
    call disp%show("isExtant('main.F90')")
    call disp%show( isExtant('main.F90') )
    call disp%skip
 
    call disp%skip
    call disp%show("isExtant('.') ! Current directory.")
    call disp%show( isExtant('.') )
    call disp%skip
 
    call disp%skip
    call disp%show("isExtant('./') ! Current directory.")
    call disp%show( isExtant('./') )
    call disp%skip
 
    call disp%skip
    call disp%show("isExtant('..') ! Parent directory.")
    call disp%show( isExtant('..') )
    call disp%skip
 
    call disp%skip
    call disp%show("isExtant('../') ! Parent directory.")
    call disp%show( isExtant('../') )
    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 ⛓

 
isExtant('temp.tmp')
T
 
 
open(newunit = unit, file = 'temp.tmp')
isExtant('temp.tmp')
T
close(unit)
isExtant('temp.tmp')
T
 
 
isExtant('main.F90')
T
 
 
isExtant('.') ! Current directory.
T
 
 
isExtant('./') ! Current directory.
T
 
 
isExtant('..') ! Parent directory.
T
 
 
isExtant('../') ! Parent directory.
T
 
 

Test:

test_pm_sysPath

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 4859 of file pm_sysPath.F90.

---

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

• src/fortran/main/pm_sysPath.F90