pm_sysPath::isFile Interface Reference

Generate and return .true. is the input path is a file (not a directory), otherwise return .false..
More...

Detailed Description

Generate and return .true. is the input path is a file (not a directory), otherwise return .false..

The procedures under this generic interface utilize the Fortran intrinsic inquire() statement to infer the existence of the specified input path as a system file.

Parameters

[in]	path	: The input scalar character of kind any supported by the processor (e.g., SK, SKA, SKD , or SKU) containing a POSIX-style or Windows-style path.
[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

pathIsFile : The output scalar of type logical of default kind LK that is .true. if the input path is a file, otherwise .false..

Possible calling interfaces ⛓

use pm_kind, only: LK
use pm_sysPath, only: isFile
logical(LK) :: pathIsFile
 
pathIsFile = isFile(path)
pathIsFile = isFile(path, iostat, iomsg = iomsg)

Remarks

The procedures under discussion are impure.

See also

isOpen
isDir
isFile
isExtant
isPreconnected
getPathNew
getPathPosix
setPathPosix
getPathWindows
setPathWindows
getPathHostNameIndex

Example usage ⛓

program example
 
    use pm_kind, only: LK, IK, SK
    use pm_io, only: display_type
    use pm_sysPath, only: isFile
 
    implicit none
 
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("isFile(SK_'')")
    call disp%show( isFile(SK_'') )
    call disp%skip()
 
    call disp%skip()
    call disp%show("isFile(SK_'main.F90')")
    call disp%show( isFile(SK_'main.F90') )
    call disp%skip()
 
    call disp%skip()
    call disp%show("isFile(SK_'main.out.F90')")
    call disp%show( isFile(SK_'main.out.F90') )
    call disp%skip()
 
    call disp%skip()
    call disp%show("isFile(SK_'paramonte')")
    call disp%show( isFile(SK_'paramonte') )
    call disp%skip()
 
    call disp%skip()
    call disp%show("isFile(SK_'.')")
    call disp%show( isFile(SK_'.') )
    call disp%skip()
 
    call disp%skip()
    call disp%show("isFile(SK_'./')")
    call disp%show( isFile(SK_'./') )
    call disp%skip()
 
    call disp%skip()
    call disp%show("isFile(SK_'..')")
    call disp%show( isFile(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 ⛓

 
isFile(SK_'')
F
 
 
isFile(SK_'main.F90')
T
 
 
isFile(SK_'main.out.F90')
T
 
 
isFile(SK_'paramonte')
F
 
 
isFile(SK_'.')
F
 
 
isFile(SK_'./')
F
 
 
isFile(SK_'..')
F
 
 

Test:

test_pm_sysPath

Todo:

High Priority: The current Fortran standard 202x does not allow passing characters of non-default kind to the intrinsic Fortran statements and procedures.
As such, the implementation of this procedure for non-default character kinds leads to compile-time kind mismatch errors.
This procedure should be converted back to a generic interface in the future when non-default character kinds are also fully supported by the intrinsic functions.

Todo:

Critical Priority: This generic interface should be extended in the future to gracefully handle intrinsic inquire() exceptions.

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:09 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas at Austin

Definition at line 4672 of file pm_sysPath.F90.

---

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

• src/fortran/main/pm_sysPath.F90