Normalize the input POSIX-style or Windows-style path to a Windows-style path, such that it conforms to the path conventions of the Windows Command Prompt (CMD).
More...

Detailed Description

Normalize the input POSIX-style or Windows-style path to a Windows-style path, such that it conforms to the path conventions of the Windows Command Prompt (CMD).

The nomalization done by this procedure is only part of the Windows system-level path normalization that is detailed in the documentation of pm_sysPath.
Here it is specifically done by

replacing all instances of the POSIX-style path-separator (/) in the input path with the Windows-style path-separator (\), and
collapsing all redundant directory separators such that \A//B\/, ///A/B\\, \A//B\ all become /A/B.
If the path begins with two directory separators, it is interpreted as a UNC path and the initial hostname portion of the path remains untouched.
Additionally, if ignore is present, then all instances of the pattern ignore will be copied to the output path as is.
For example,
1. if the forward slashes / should be kept as is, then set ignore = "/".

Parameters

[in,out]	path	: The input `allocatable` scalar `character` of kind any supported by the processor (e.g., SK, SKA, SKD , or SKU) containing the POSIX-style path to be converted to the Windows-style. On output, it contains the modified input path such that it conforms to the Windows-Command-Prompt style.
[in]	ignore	: The input scalar `character` of the same kind as `path` of arbitrary length type parameter. If present, any pattern matching the value of `ignore` from left to right will be interpreted verbatim and copied to the output path as is. (optional, default = `""`)

Possible calling interfaces ⛓

: use pm_sysPath, only: setPathWindows

call setPathWindows(path, ignore = ignore)

pm_sysPath::setPathWindows
Normalize the input POSIX-style or Windows-style path to a Windows-style path, such that it conforms ...
Definition: pm_sysPath.F90:1999

pm_sysPath
This module contains classes and procedures for manipulating system file/folder paths.
Definition: pm_sysPath.F90:274

Warning: The procedures under this generic interface assume that the input path is valid in both Unix and Windows environments.
Specifically, the procedures do not make any attempts to remove or modify the appearance of any Windows reserved characters (WINDOWS_RESERVED_STR) or device names (WINDOWS_RESERVED_DEVICE_NAME).; Although the procedures under this generic interface can properly handle input paths with trailing whitespace character, you should never create a directory or filename with a trailing space. Trailing spaces can make it difficult or impossible to access a directory, and applications commonly fail when attempting to handle directories or files whose names include trailing spaces.; Note that no trimming of the input path is performed by the procedure.
Consequently, any leading or trailing whitespace characters will be significant.
Similarly, single and double quotation marks that appear anywhere in path are significant and kept.

Remarks: The procedures under discussion are pure.

See also: getPathNew
getPathPosix
setPathPosix
getPathWindows
setPathWindows
getPathHostNameIndex

Example usage ⛓

: 1program example

2

3 use pm_kind, only: SK, LK

4 use pm_io, only: display_type

5 use pm_sysPath, only: setPathWindows

6

7 implicit none

8

9 character(:), allocatable :: path

10

11 type(display_type) :: disp

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

13

14 call disp%skip()

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

16 path = ''

17 call disp%show("call setPathWindows(path)")

18 call setPathWindows(path)

19 call disp%show("path")

20 call disp%show( path , deliml = SK_'''' )

21 call disp%skip()

22

23 call disp%skip()

24 call disp%show("path = '\ '")

25 path = '\ '

26 call disp%show("call setPathWindows(path)")

27 call setPathWindows(path)

28 call disp%show("path")

29 call disp%show( path , deliml = SK_'''' )

30 call disp%skip()

31

32 call disp%skip()

33 call disp%show("path = '\.'")

34 path = '\.'

35 call disp%show("call setPathWindows(path)")

36 call setPathWindows(path)

37 call disp%show("path")

38 call disp%show( path , deliml = SK_'''' )

39 call disp%skip()

40

41 call disp%skip()

42 call disp%show("path = '\\.' ! UNC path remains untouched.")

43 path = '\\.'

44 call disp%show("call setPathWindows(path)")

45 call setPathWindows(path)

46 call disp%show("path")

47 call disp%show( path , deliml = SK_'''' )

48 call disp%skip()

49

50 call disp%skip()

51 call disp%show("path = '\\\.'")

52 path = '\\\.'

53 call disp%show("call setPathWindows(path)")

54 call setPathWindows(path)

55 call disp%show("path")

56 call disp%show( path , deliml = SK_'''' )

57 call disp%skip()

58

59 call disp%skip()

60 call disp%show("path = '///./.'")

61 path = '///./.'

62 call disp%show("call setPathWindows(path)")

63 call setPathWindows(path)

64 call disp%show("path")

65 call disp%show( path , deliml = SK_'''' )

66 call disp%skip()

67

68 call disp%skip()

69 call disp%show("path = '.'")

70 path = '.'

71 call disp%show("call setPathWindows(path)")

72 call setPathWindows(path)

73 call disp%show("path")

74 call disp%show( path , deliml = SK_'''' )

75 call disp%skip()

76

77 call disp%skip()

78 call disp%show("path = './'")

79 path = './'

80 call disp%show("call setPathWindows(path)")

81 call setPathWindows(path)

82 call disp%show("path")

83 call disp%show( path , deliml = SK_'''' )

84 call disp%skip()

85

86 call disp%skip()

87 call disp%show("path = './/'")

88 path = './/'

89 call disp%show("call setPathWindows(path)")

90 call setPathWindows(path)

91 call disp%show("path")

92 call disp%show( path , deliml = SK_'''' )

93 call disp%skip()

94

95 call disp%skip()

96 call disp%show("path = './.'")

97 path = './.'

98 call disp%show("call setPathWindows(path)")

99 call setPathWindows(path)

100 call disp%show("path")

101 call disp%show( path , deliml = SK_'''' )

102 call disp%skip()

103

104 call disp%skip()

105 call disp%show("path = '/ '")

106 path = '/ '

107 call disp%show("call setPathWindows(path)")

108 call setPathWindows(path)

109 call disp%show("path")

110 call disp%show( path , deliml = SK_'''' )

111 call disp%skip()

112

113 call disp%skip()

114 call disp%show("path = '\\\'")

115 path = '\\\'

116 call disp%show("call setPathWindows(path)")

117 call setPathWindows(path)

118 call disp%show("path")

119 call disp%show( path , deliml = SK_'''' )

120 call disp%skip()

121

122 call disp%skip()

123 call disp%show("path = '\\\./\'")

124 path = '\\\./\'

125 call disp%show("call setPathWindows(path)")

126 call setPathWindows(path)

127 call disp%show("path")

128 call disp%show( path , deliml = SK_'''' )

129 call disp%skip()

130

131 call disp%skip()

132 call disp%show("path = '/ /'")

133 path = '/ /'

134 call disp%show("call setPathWindows(path)")

135 call setPathWindows(path)

136 call disp%show("path")

137 call disp%show( path , deliml = SK_'''' )

138 call disp%skip()

139

140 call disp%skip()

141 call disp%show("path = './Para Monte/./.'")

142 path = './Para Monte/./.'

143 call disp%show("call setPathWindows(path)")

144 call setPathWindows(path)

145 call disp%show("path")

146 call disp%show( path , deliml = SK_'''' )

147 call disp%skip()

148

149 call disp%skip()

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

151 path = 'foo\$bar'

152 call disp%show("call setPathWindows(path)")

153 call setPathWindows(path)

154 call disp%show("path")

155 call disp%show( path , deliml = SK_'''' )

156 call disp%skip()

157

158 call disp%skip()

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

160 path = 'foo\\$bar'

161 call disp%show("call setPathWindows(path)")

162 call setPathWindows(path)

163 call disp%show("path")

164 call disp%show( path , deliml = SK_'''' )

165 call disp%skip()

166

167 call disp%skip()

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

169 path = 'foo/\$bar'

170 call disp%show("call setPathWindows(path)")

171 call setPathWindows(path)

172 call disp%show("path")

173 call disp%show( path , deliml = SK_'''' )

174 call disp%skip()

175

176 call disp%skip()

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

178 path = 'foo/\$bar '

179 call disp%show("call setPathWindows(path)")

180 call setPathWindows(path)

181 call disp%show("path")

182 call disp%show( path , deliml = SK_'''' )

183 call disp%skip()

184

185 call disp%skip()

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

187 path = 'foo\{/bar/'

188 call disp%show("call setPathWindows(path)")

189 call setPathWindows(path)

190 call disp%show("path")

191 call disp%show( path , deliml = SK_'''' )

192 call disp%skip()

193

194 call disp%skip()

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

196 path = 'foo\/bar$/\'

197 call disp%show("call setPathWindows(path)")

198 call setPathWindows(path)

199 call disp%show("path")

200 call disp%show( path , deliml = SK_'''' )

201 call disp%skip()

202

203 call disp%skip()

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

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

206 call disp%show("call setPathWindows(path)")

207 call setPathWindows(path)

208 call disp%show("path")

209 call disp%show( path , deliml = SK_'''' )

210 call disp%skip()

211

212 call disp%skip()

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

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

215 call disp%show("call setPathWindows(path)")

216 call setPathWindows(path)

217 call disp%show("path")

218 call disp%show( path , deliml = SK_'''' )

219 call disp%skip()

220

221 call disp%skip()

222 call disp%show("path = '\\wsl$\Ubuntu-20.04\'")

223 path = '\\wsl$\Ubuntu-20.04\'

224 call disp%show("call setPathWindows(path)")

225 call setPathWindows(path)

226 call disp%show("path")

227 call disp%show( path , deliml = SK_'''' )

228 call disp%skip()

229

230 call disp%skip()

231 call disp%show("path = '//wsl$/Ubuntu-20.04//'")

232 path = '//wsl$/Ubuntu-20.04//'

233 call disp%show("call setPathWindows(path)")

234 call setPathWindows(path)

235 call disp%show("path")

236 call disp%show( path , deliml = SK_'''' )

237 call disp%skip()

238

239 call disp%skip()

240 call disp%show("path = '//wsl$./.\Ubuntu-20.04//'")

241 path = '//wsl$./.\Ubuntu-20.04//'

242 call disp%show("call setPathWindows(path)")

243 call setPathWindows(path)

244 call disp%show("path")

245 call disp%show( path , deliml = SK_'''' )

246 call disp%skip()

247

248 call disp%skip()

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

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

251 call disp%show("call setPathWindows(path, ignore = '\/')")

252 call setPathWindows(path, ignore = '\/')

253 call disp%show("path")

254 call disp%show( path , deliml = SK_'''' )

255 call disp%skip()

256

257 call disp%skip()

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

259 path = 'd:./foo\/bar$\//'

260 call disp%show("call setPathWindows(path, ignore = '\/')")

261 call setPathWindows(path, ignore = '\/')

262 call disp%show("path")

263 call disp%show( path , deliml = SK_'''' )

264 call disp%skip()

265

266end 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_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
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
Definition: pm_kind.F90:268

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_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_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

2path = ''

3call setPathWindows(path)

4path

5''

6

7

8path = '\ '

9call setPathWindows(path)

10path

11'\ '

12

13

14path = '\.'

15call setPathWindows(path)

16path

17'\.'

18

19

20path = '\\.' ! UNC path remains untouched.

21call setPathWindows(path)

22path

23'\\.'

24

25

26path = '\\\.'

27call setPathWindows(path)

28path

29'\.'

30

31

32path = '///./.'

33call setPathWindows(path)

34path

35'\.\.'

36

37

38path = '.'

39call setPathWindows(path)

40path

41'.'

42

43

44path = './'

45call setPathWindows(path)

46path

47'.'

48

49

50path = './/'

51call setPathWindows(path)

52path

53'.'

54

55

56path = './.'

57call setPathWindows(path)

58path

59'.\.'

60

61

62path = '/ '

63call setPathWindows(path)

64path

65'\ '

66

67

68path = '\\\'

69call setPathWindows(path)

70path

71'\'

72

73

74path = '\\\./\'

75call setPathWindows(path)

76path

77'\.'

78

79

80path = '/ /'

81call setPathWindows(path)

82path

83'\ '

84

85

86path = './Para Monte/./.'

87call setPathWindows(path)

88path

89'.\Para Monte\.\.'

90

91

92path = 'foo\$bar'

93call setPathWindows(path)

94path

95'foo\$bar'

96

97

98path = 'foo\\$bar'

99call setPathWindows(path)

100path

101'foo\$bar'

102

103

104path = 'foo/\$bar'

105call setPathWindows(path)

106path

107'foo\$bar'

108

109

110path = 'foo/\$bar '

111call setPathWindows(path)

112path

113'foo\$bar '

114

115

116path = 'foo\{/bar/'

117call setPathWindows(path)

118path

119'foo\{\bar'

120

121

122path = 'foo\/bar$/\'

123call setPathWindows(path)

124path

125'foo\bar$'

126

127

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

129call setPathWindows(path)

130path

131'd:\foo\bar$'

132

133

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

135call setPathWindows(path)

136path

137'd:\foo\bar$'

138

139

140path = '\\wsl$\Ubuntu-20.04\'

141call setPathWindows(path)

142path

143'\\wsl$\Ubuntu-20.04'

144

145

146path = '//wsl$/Ubuntu-20.04//'

147call setPathWindows(path)

148path

149'\\wsl$\Ubuntu-20.04'

150

151

152path = '//wsl$./.\Ubuntu-20.04//'

153call setPathWindows(path)

154path

155'\\wsl$.\.\Ubuntu-20.04'

156

157

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

159call setPathWindows(path, ignore = '\/')

160path

161'd:\foo\/bar$\/'

162

163

164path = 'd:./foo\/bar$\//'

165call setPathWindows(path, ignore = '\/')

166path

167'd:.\foo\/bar$\/'

168

169

Test:: test_pm_sysPath

Todo:: High Priority: An optional argument external procedure iseq() should be added to the procedures of this generic interface to bring flexibility to searching for ignore patterns.

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

Definition at line 1999 of file pm_sysPath.F90.

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

src/fortran/main/pm_sysPath.F90