Generate and return the absolute path corresponding to the input (potentially relative) path.
More...

Detailed Description

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,
1. 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.
2. If the above step fails or if the compiler is non-intel,
  1. 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 ⛓

: use pm_kind, only: SK

use pm_sysPath, only: getPathAbs

character(:, SK), allocatable :: pathAbs

pathAbs = getPathAbs(path)

pathAbs = getPathAbs(path, failed)

pathAbs = getPathAbs(path, failed, errmsg)

pm_sysPath::getPathAbs
Generate and return the absolute path corresponding to the input (potentially relative) path.
Definition: pm_sysPath.F90:2641

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

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_sysPath
This module contains classes and procedures for manipulating system file/folder paths.
Definition: pm_sysPath.F90:274

Remarks: The procedures of this generic interface do not make any attempts to resolve any soft links (symlinks) present in the input path.
Consequently, any instances of parent directory pattern (/../ or \..\) that may appear within the input path remain untouched because resolving such patterns can inadvertently modify symlinks if any are present.
In most applications, there is no need to resolve soft links or instances of parent directory; The procedures under discussion are impure.

See also: isPathAbsWindows
isPathAbsPosix
getPathNew
getPathPosix
setPathPosix
getPathWindows
setPathWindows
getPathHostNameIndex

Example usage ⛓

: 1program example

2

3 use pm_kind, only: LK

4 use pm_kind, only: SK ! all processor types and kinds are supported.

5 use pm_io, only: display_type

6 use pm_sysShell, only: isShellWindows

7 use pm_sysShell, only: isShellPosix

8 use pm_sysPath, only: getPathAbs

9

10 implicit none

11

12 character(:, SK), allocatable :: path

13 character(2047, SK) :: errmsg

14 logical(LK) :: failed

15

16 type(display_type) :: disp

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

18

19 call disp%skip()

20 call disp%show("isShellPosix()")

21 call disp%show( isShellPosix() )

22 call disp%show("isShellWindows()")

23 call disp%show( isShellWindows() )

24 call disp%skip()

25

26 call disp%skip()

27 call disp%show("path = ''")

28 path = ''

29 call disp%show("path = getPathAbs(path)")

30 path = getPathAbs(path)

31 call disp%show("path")

32 call disp%show( path , deliml = SK_"""" )

33 call disp%skip()

34

35 call disp%skip()

36 call disp%show("path = 'foo\bar'")

37 path = 'foo\bar'

38 call disp%show("path = getPathAbs(path)")

39 path = getPathAbs(path)

40 call disp%show("path")

41 call disp%show( path , deliml = SK_"""" )

42 call disp%skip()

43

44 call disp%skip()

45 call disp%show("path = '\foo\bar'")

46 path = '\foo\bar'

47 call disp%show("path = getPathAbs(path)")

48 path = getPathAbs(path)

49 call disp%show("path")

50 call disp%show( path , deliml = SK_"""" )

51 call disp%skip()

52

53 call disp%skip()

54 call disp%show("path = '/foo\bar'")

55 path = '/foo\bar'

56 call disp%show("path = getPathAbs(path)")

57 path = getPathAbs(path)

58 call disp%show("path")

59 call disp%show( path , deliml = SK_"""" )

60 call disp%skip()

61

62 call disp%skip()

63 call disp%show("path = './foo\/bar'")

64 path = './foo\/bar'

65 call disp%show("path = getPathAbs(path)")

66 path = getPathAbs(path)

67 call disp%show("path")

68 call disp%show( path , deliml = SK_"""" )

69 call disp%skip()

70

71 call disp%skip()

72 call disp%show("path = '.\foo\/bar/'")

73 path = '.\foo\/bar/'

74 call disp%show("path = getPathAbs(path)")

75 path = getPathAbs(path)

76 call disp%show("path")

77 call disp%show( path , deliml = SK_"""" )

78 call disp%skip()

79

80 call disp%skip()

81 call disp%show("path = '../foo\/bar/..'")

82 path = '../foo\/bar/..'

83 call disp%show("path = getPathAbs(path)")

84 path = getPathAbs(path)

85 call disp%show("path")

86 call disp%show( path , deliml = SK_"""" )

87 call disp%skip()

88

89 call disp%skip()

90 call disp%show("path = 'foo\/bar/\'")

91 path = 'foo\/bar/\'

92 call disp%show("path = getPathAbs(path)")

93 path = getPathAbs(path)

94 call disp%show("path")

95 call disp%show( path , deliml = SK_"""" )

96 call disp%skip()

97

98 call disp%skip()

99 call disp%show("path = 'd:\foo\/bar$\/\'")

100 path = 'd:\foo\/bar$\/\'

101 call disp%show("path = getPathAbs(path)")

102 path = getPathAbs(path)

103 call disp%show("path")

104 call disp%show( path , deliml = SK_"""" )

105 call disp%skip()

106

107 call disp%skip()

108 call disp%show("path = '\\wsl$/Ubuntu-20.04' ! UNC path (recognized only by Windows OS).")

109 path = '\\wsl$/Ubuntu-20.04' ! UNC path (recognized only by Windows OS).

110 call disp%show("path = getPathAbs(path)")

111 path = getPathAbs(path)

112 call disp%show("path")

113 call disp%show( path , deliml = SK_"""" )

114 call disp%skip()

115

116 call disp%skip()

117 call disp%show("path = '//wsl$/Ubuntu-20.04' ! UNC path (recognized by both Windows and POSIX OS).")

118 path = '//wsl$/Ubuntu-20.04' ! UNC path (recognized by both Windows and POSIX OS).

119 call disp%show("path = getPathAbs(path)")

120 path = getPathAbs(path)

121 call disp%show("path")

122 call disp%show( path , deliml = SK_"""" )

123 call disp%skip()

124

125 call disp%skip()

126 call disp%show("path = getPathAbs(SK_"", failed, errmsg) ! handle potential runtime failures gracefully.")

127 path = getPathAbs(SK_"", failed, errmsg)

128 call disp%show("failed")

129 call disp%show( failed )

130 call disp%skip()

131

132end 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_sysShell::isShellPosix
Generate and return .true. if the runtime system shell is POSIX-compliant regardless of the Operating...
Definition: pm_sysShell.F90:773

pm_sysShell::isShellWindows
Generate and return .true. if the runtime system shell is Windows-based (e.g., CMD,...
Definition: pm_sysShell.F90:857

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

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::LK
integer, parameter LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
Definition: pm_kind.F90:541

pm_sysShell
This module contains procedures and generic interfaces for inferring the runtime system shell type an...
Definition: pm_sysShell.F90:38

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

2isShellPosix()

3T

4isShellWindows()

5F

6

7

8path = ''

9path = getPathAbs(path)

10path

11"/home/amir/git/paramonte/external/paramonted/doxygen/bld/linux/amd64/gnu/13.1.0/native/lib/mem/serial/fortran/checking/pkg/example/pm_sysPath/getPathAbs"

12

13

14path = 'foo\bar'

15path = getPathAbs(path)

16path

17"/home/amir/git/paramonte/external/paramonted/doxygen/bld/linux/amd64/gnu/13.1.0/native/lib/mem/serial/fortran/checking/pkg/example/pm_sysPath/getPathAbs/foo\bar"

18

19

20path = '\foo\bar'

21path = getPathAbs(path)

22path

23"/home/amir/git/paramonte/external/paramonted/doxygen/bld/linux/amd64/gnu/13.1.0/native/lib/mem/serial/fortran/checking/pkg/example/pm_sysPath/getPathAbs/\foo\bar"

24

25

26path = '/foo\bar'

27path = getPathAbs(path)

28path

29"/foo\bar"

30

31

32path = './foo\/bar'

33path = getPathAbs(path)

34path

35"/home/amir/git/paramonte/external/paramonted/doxygen/bld/linux/amd64/gnu/13.1.0/native/lib/mem/serial/fortran/checking/pkg/example/pm_sysPath/getPathAbs/./foo\/bar"

36

37

38path = '.\foo\/bar/'

39path = getPathAbs(path)

40path

41"/home/amir/git/paramonte/external/paramonted/doxygen/bld/linux/amd64/gnu/13.1.0/native/lib/mem/serial/fortran/checking/pkg/example/pm_sysPath/getPathAbs/.\foo\/bar/"

42

43

44path = '../foo\/bar/..'

45path = getPathAbs(path)

46path

47"/home/amir/git/paramonte/external/paramonted/doxygen/bld/linux/amd64/gnu/13.1.0/native/lib/mem/serial/fortran/checking/pkg/example/pm_sysPath/getPathAbs/../foo\/bar/.."

48

49

50path = 'foo\/bar/\'

51path = getPathAbs(path)

52path

53"/home/amir/git/paramonte/external/paramonted/doxygen/bld/linux/amd64/gnu/13.1.0/native/lib/mem/serial/fortran/checking/pkg/example/pm_sysPath/getPathAbs/foo\/bar/\"

54

55

56path = 'd:\foo\/bar$\/\'

57path = getPathAbs(path)

58path

59"/home/amir/git/paramonte/external/paramonted/doxygen/bld/linux/amd64/gnu/13.1.0/native/lib/mem/serial/fortran/checking/pkg/example/pm_sysPath/getPathAbs/d:\foo\/bar$\/\"

60

61

62path = '\\wsl$/Ubuntu-20.04' ! UNC path (recognized only by Windows OS).

63path = getPathAbs(path)

64path

65"/home/amir/git/paramonte/external/paramonted/doxygen/bld/linux/amd64/gnu/13.1.0/native/lib/mem/serial/fortran/checking/pkg/example/pm_sysPath/getPathAbs/\\wsl$/Ubuntu-20.04"

66

67

68path = '//wsl$/Ubuntu-20.04' ! UNC path (recognized by both Windows and POSIX OS).

69path = getPathAbs(path)

70path

71"//wsl$/Ubuntu-20.04"

72

73

74path = getPathAbs(SK_", failed, errmsg) ! handle potential runtime failures gracefully.

75failed

76F

77

78

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 at Austin

Definition at line 2641 of file pm_sysPath.F90.

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

src/fortran/main/pm_sysPath.F90