ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
pm_sysPath::getPathWindows Interface Reference

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

Detailed Description

Generate and return a normalized Windows-style path from the input POSIX-style or Windows-style path, such that it conforms to the path conventions of the Windows Command Prompt (CMD).

This procedure calls setPathWindows to generate the Windows-style normalized path.
See the documentation of setPathWindows for details of the path normalization.

Parameters
[in]path: The input 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.
[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 = "")
Returns
pathWindows : The output allocatable scalar of type character of the same kind as the input path containing the modified input path such that it conforms to the Windows Command Prompt style.


Possible calling interfaces

pathWindows = getPathWindows(path)
Generate and return a normalized Windows-style path from the input POSIX-style or Windows-style path,...
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
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("path = getPathWindows(path)")
18 path = getPathWindows(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("path = getPathWindows(path)")
27 path = getPathWindows(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("path = getPathWindows(path)")
36 path = getPathWindows(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 = '\\\./\'")
43 path = '\\\./\'
44 call disp%show("path = getPathWindows(path)")
45 path = getPathWindows(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("path = getPathWindows(path)")
54 path = getPathWindows(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("path = getPathWindows(path)")
63 path = getPathWindows(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 = './Para Monte/'")
70 path = './Para Monte/'
71 call disp%show("path = getPathWindows(path)")
72 path = getPathWindows(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 = 'foo\$bar'")
79 path = 'foo\$bar'
80 call disp%show("path = getPathWindows(path)")
81 path = getPathWindows(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 = 'foo\\$bar'")
88 path = 'foo\\$bar'
89 call disp%show("path = getPathWindows(path)")
90 path = getPathWindows(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 = 'foo/\$bar'")
97 path = 'foo/\$bar'
98 call disp%show("path = getPathWindows(path)")
99 path = getPathWindows(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 = 'foo/\$bar '")
106 path = 'foo/\$bar '
107 call disp%show("path = getPathWindows(path)")
108 path = getPathWindows(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 = 'foo\{/bar/'")
115 path = 'foo\{/bar/'
116 call disp%show("path = getPathWindows(path)")
117 path = getPathWindows(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 = 'foo\/bar$/\'")
124 path = 'foo\/bar$/\'
125 call disp%show("path = getPathWindows(path)")
126 path = getPathWindows(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 = 'd:/\foo\/bar$/\'")
133 path = 'd:/\foo\/bar$/\'
134 call disp%show("path = getPathWindows(path)")
135 path = getPathWindows(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 = 'd:\\foo\/bar$/\'")
142 path = 'd:\\foo\/bar$/\'
143 call disp%show("path = getPathWindows(path)")
144 path = getPathWindows(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 = './paramonte library'")
151 path = './paramonte library'
152 call disp%show("path = getPathWindows(path)")
153 path = getPathWindows(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 = '\\wsl$\Ubuntu-20.04\'")
160 path = '\\wsl$\Ubuntu-20.04\'
161 call disp%show("path = getPathWindows(path)")
162 path = getPathWindows(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 = '//wsl$/Ubuntu-20.04//'")
169 path = '//wsl$/Ubuntu-20.04//'
170 call disp%show("path = getPathWindows(path)")
171 path = getPathWindows(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 = '""./paramonte library""'")
178 path = '"./paramonte library"'
179 call disp%show("path = getPathWindows(path)")
180 path = getPathWindows(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 = 'd:/foo\/bar$\//'")
187 path = 'd:/foo\/bar$\//'
188 call disp%show("path = getPathWindows(path, ignore = '\/')")
189 path = getPathWindows(path, ignore = '\/')
190 call disp%show("path")
191 call disp%show( path , deliml = SK_'''' )
192 call disp%skip()
193
194end program example
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11726
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11508
This module contains classes and procedures for input/output (IO) or generic display operations on st...
Definition: pm_io.F90:252
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
Definition: pm_io.F90:11393
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
Definition: pm_kind.F90:268
integer, parameter LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
Definition: pm_kind.F90:541
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
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 = ''
3path = getPathWindows(path)
4path
5''
6
7
8path = '\ '
9path = getPathWindows(path)
10path
11'\ '
12
13
14path = '\\\'
15path = getPathWindows(path)
16path
17'\'
18
19
20path = '\\\./\'
21path = getPathWindows(path)
22path
23'\.'
24
25
26path = '/ '
27path = getPathWindows(path)
28path
29'\ '
30
31
32path = '/ /'
33path = getPathWindows(path)
34path
35'\ '
36
37
38path = './Para Monte/'
39path = getPathWindows(path)
40path
41'.\Para Monte'
42
43
44path = 'foo\$bar'
45path = getPathWindows(path)
46path
47'foo\$bar'
48
49
50path = 'foo\\$bar'
51path = getPathWindows(path)
52path
53'foo\$bar'
54
55
56path = 'foo/\$bar'
57path = getPathWindows(path)
58path
59'foo\$bar'
60
61
62path = 'foo/\$bar '
63path = getPathWindows(path)
64path
65'foo\$bar '
66
67
68path = 'foo\{/bar/'
69path = getPathWindows(path)
70path
71'foo\{\bar'
72
73
74path = 'foo\/bar$/\'
75path = getPathWindows(path)
76path
77'foo\bar$'
78
79
80path = 'd:/\foo\/bar$/\'
81path = getPathWindows(path)
82path
83'd:\foo\bar$'
84
85
86path = 'd:\\foo\/bar$/\'
87path = getPathWindows(path)
88path
89'd:\foo\bar$'
90
91
92path = './paramonte library'
93path = getPathWindows(path)
94path
95'.\paramonte library'
96
97
98path = '\\wsl$\Ubuntu-20.04\'
99path = getPathWindows(path)
100path
101'\\wsl$\Ubuntu-20.04'
102
103
104path = '//wsl$/Ubuntu-20.04//'
105path = getPathWindows(path)
106path
107'\\wsl$\Ubuntu-20.04'
108
109
110path = '"./paramonte library"'
111path = getPathWindows(path)
112path
113'".\paramonte library"'
114
115
116path = 'd:/foo\/bar$\//'
117path = getPathWindows(path, ignore = '\/')
118path
119'd:\foo\/bar$\/'
120
121
Test:
test_pm_sysPath


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.

Author:
Amir Shahmoradi, Tuesday March 7, 2017, 3:50 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin

Definition at line 1857 of file pm_sysPath.F90.


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