Generate and return the absolute path corresponding to the input (potentially relative) path.
The procedures of this generic interface take the following steps to generate the absolute path corresponding to the input path
,
-
If the input
path
is empty, the absolute path to the current directory will be returned.
-
If the input
path
is an absolute path determined via isPathAbsPosix or isPathAbsWindows, the input path
is returned as the output absolute path.
-
If the input
path
is relative, then,
-
If the library is compiled with Intel compilers, the absolute path is determined by a call to
FullPathQQ()
procedure of ifport
module of the Intel ifort
compiler.
-
If the above step fails or if the compiler is non-intel,
-
The absolute path is directly inferred by a system call to the relevant Microsoft or Windows PowerShell command if the shell is available on the platform.
-
If all of the above approaches fail or do not apply (particularly the case with POSIX-compliant runtime shells), the absolute path is constructed by appending the current working directory to the partially qualified input
path
.
See the warnings and remarks below.
- Parameters
-
[in] | path | : The input scalar character of kind SK containing the relative path to be resolved to the corresponding absolute path.
|
[out] | failed | : The output scalar logical of default kind LK.
It is .true. if and only if an error occurs while resolving path .
(optional. If missing and a runtime error occurs, the program will halt by calling error stop .) |
[in,out] | errmsg | : The input/output scalar character of default kind SK of arbitrary length type parameter.
If present and an error occurs, it is assigned an explanatory message describing the nature of the error that has occurred.
A length of 2047 characters for errmsg is likely enough to capture most error messages in full.
(optional. It can be present only if failed is also present.) |
- Returns
pathAbs
: The output allocatable
scalar character
of default kind SK containing the absolute path corresponding to the input (potentially relative) path
.
-
If the input
path
is relative but the path resolution succeeds, the program sets pathAbs
to the resolved path and failed = .false.
upon return.
-
If the input
path
is relative but the path resolution fails, the program sets pathAbs = path
and failed = .true.
upon return.
-
If the input
path
is absolute already, the program sets pathAbs = path
and failed = .false.
upon return.
Possible calling interfaces ⛓
character(:, SK), allocatable :: pathAbs
Generate and return the absolute path corresponding to the input (potentially relative) path.
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
integer, parameter SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in C-Fortran Intero...
This module contains classes and procedures for manipulating system file/folder paths.
- See also
- isPathAbsWindows
isPathAbsPosix
getPathNew
getPathPosix
setPathPosix
getPathWindows
setPathWindows
getPathHostNameIndex
Example usage ⛓
12 character(:, SK),
allocatable :: path
13 character(
2047, SK) :: errmsg
16 type(display_type) :: disp
29 call disp%show(
"path = getPathAbs(path)")
32 call disp%show( path , deliml
= SK_
"""" )
38 call disp%show(
"path = getPathAbs(path)")
41 call disp%show( path , deliml
= SK_
"""" )
47 call disp%show(
"path = getPathAbs(path)")
50 call disp%show( path , deliml
= SK_
"""" )
56 call disp%show(
"path = getPathAbs(path)")
59 call disp%show( path , deliml
= SK_
"""" )
63 call disp%show(
"path = './foo\/bar'")
65 call disp%show(
"path = getPathAbs(path)")
68 call disp%show( path , deliml
= SK_
"""" )
72 call disp%show(
"path = '.\foo\/bar/'")
74 call disp%show(
"path = getPathAbs(path)")
77 call disp%show( path , deliml
= SK_
"""" )
81 call disp%show(
"path = '../foo\/bar/..'")
82 path
= '../foo\/bar/..'
83 call disp%show(
"path = getPathAbs(path)")
86 call disp%show( path , deliml
= SK_
"""" )
90 call disp%show(
"path = 'foo\/bar/\'")
92 call disp%show(
"path = getPathAbs(path)")
95 call disp%show( path , deliml
= SK_
"""" )
99 call disp%show(
"path = 'd:\foo\/bar$\/\'")
100 path
= 'd:\foo\/bar$\/\'
101 call disp%show(
"path = getPathAbs(path)")
104 call disp%show( path , deliml
= SK_
"""" )
108 call disp%show(
"path = '\\wsl$/Ubuntu-20.04' ! UNC path (recognized only by Windows OS).")
109 path
= '\\wsl$/Ubuntu-20.04'
110 call disp%show(
"path = getPathAbs(path)")
113 call disp%show( path , deliml
= SK_
"""" )
117 call disp%show(
"path = '//wsl$/Ubuntu-20.04' ! UNC path (recognized by both Windows and POSIX OS).")
118 path
= '//wsl$/Ubuntu-20.04'
119 call disp%show(
"path = getPathAbs(path)")
122 call disp%show( path , deliml
= SK_
"""" )
126 call disp%show(
"path = getPathAbs(SK_"", failed, errmsg) ! handle potential runtime failures gracefully.")
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.
Generate and return .true. if the runtime system shell is POSIX-compliant regardless of the Operating...
Generate and return .true. if the runtime system shell is Windows-based (e.g., CMD,...
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 LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
This module contains procedures and generic interfaces for inferring the runtime system shell type an...
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 ⛓
11"/home/amir/git/paramonte/external/paramonted/doxygen/bld/linux/amd64/csid/csvs/native/lib/mem/serial/fortran/checking/pkg/example/pm_sysPath/getPathAbs"
17"/home/amir/git/paramonte/external/paramonted/doxygen/bld/linux/amd64/csid/csvs/native/lib/mem/serial/fortran/checking/pkg/example/pm_sysPath/getPathAbs/foo\bar"
23"/home/amir/git/paramonte/external/paramonted/doxygen/bld/linux/amd64/csid/csvs/native/lib/mem/serial/fortran/checking/pkg/example/pm_sysPath/getPathAbs/\foo\bar"
35"/home/amir/git/paramonte/external/paramonted/doxygen/bld/linux/amd64/csid/csvs/native/lib/mem/serial/fortran/checking/pkg/example/pm_sysPath/getPathAbs/./foo\/bar"
41"/home/amir/git/paramonte/external/paramonted/doxygen/bld/linux/amd64/csid/csvs/native/lib/mem/serial/fortran/checking/pkg/example/pm_sysPath/getPathAbs/.\foo\/bar/"
44path
= '../foo\/bar/..'
47"/home/amir/git/paramonte/external/paramonted/doxygen/bld/linux/amd64/csid/csvs/native/lib/mem/serial/fortran/checking/pkg/example/pm_sysPath/getPathAbs/../foo\/bar/.."
53"/home/amir/git/paramonte/external/paramonted/doxygen/bld/linux/amd64/csid/csvs/native/lib/mem/serial/fortran/checking/pkg/example/pm_sysPath/getPathAbs/foo\/bar/\"
56path
= 'd:\foo\/bar$\/\'
59"/home/amir/git/paramonte/external/paramonted/doxygen/bld/linux/amd64/csid/csvs/native/lib/mem/serial/fortran/checking/pkg/example/pm_sysPath/getPathAbs/d:\foo\/bar$\/\"
62path
= '\\wsl$/Ubuntu-20.04'
65"/home/amir/git/paramonte/external/paramonted/doxygen/bld/linux/amd64/csid/csvs/native/lib/mem/serial/fortran/checking/pkg/example/pm_sysPath/getPathAbs/\\wsl$/Ubuntu-20.04"
68path
= '//wsl$/Ubuntu-20.04'
74path
= getPathAbs(SK_
", failed, errmsg) ! handle potential runtime failures gracefully.
- Test:
- test_pm_sysPath
- Todo:
- Very Low Priority: A subroutine version of this functional interface could be implemented in the future to avoid allocations.
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 Austin
Definition at line 2641 of file pm_sysPath.F90.