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 ⛓
logical(LK) :: pathIsFile
pathIsFile
= isFile(path, iostat,
iomsg = iomsg)
Generate and return .true. is the input path is a file (not a directory), otherwise return ....
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(....
This module contains classes and procedures for manipulating system file/folder paths.
- See also
- isOpen
isDir
isFile
isExtant
isPreconnected
getPathNew
getPathPosix
setPathPosix
getPathWindows
setPathWindows
getPathHostNameIndex
Example usage ⛓
9 type(display_type) :: disp
18 call disp%show(
"isFile(SK_'main.F90')")
23 call disp%show(
"isFile(SK_'main.out.F90')")
28 call disp%show(
"isFile(SK_'paramonte')")
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 classes and procedures for input/output (IO) or generic display operations on st...
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
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 ⛓
- 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.
-
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:09 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas at Austin
Definition at line 4672 of file pm_sysPath.F90.