Return a POSIX-standard (Unix-like) path from the input (Windows-style) path.
See the note below on how an input POSIX-style pathis handled.
The path nomalization by this procedure is specifically done by
- replacing all instances of the Windows-style path-separator (
\
) in the input path with the POSIX-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,
- if the input path contains a Hex value
\xhh
, then set ignore = \xhh
or
- if the is already (partially) POSIX-compliant such that
\
should be interprested verbatim then ignore can be set to \
.
- Parameters
-
[in,out] | path | : The input/output allocatable scalar character of default kind SK.
On input, it contains the Windows-style path to be converted to the POSIX-style.
On output, it is reallocated to contain the converted POSIX-style path.
On output, all instances of the backslash are replaced with forward-slash.
|
[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 ⛓
character(:, SK), allocatable :: path
Return a POSIX-standard (Unix-like) path from the input (Windows-style) path.
This module contains classes and procedures for manipulating system file/folder paths.
- Warning
- Any escape character
\
is interpreted as a Windows-style directory separator by the procedures of this generic interface and will be converted to POSIX-style directory separator character /
.
Therefore, passing an already POSIX-compliant path to the procedures of this generic interface is fine as long as,
- no POSIX special character is escaped via the POSIX escape character
\
in the input path
, and
- no backward slash
\
appears in the path
unless it serves as a directory separator or ignore =
"\"`.
-
The
pure
procedure(s) documented herein become impure
when the ParaMonte library is compiled with preprocessor macro CHECK_ENABLED=1
.
By default, these procedures are pure
in release
build and impure
in debug
and testing
builds. The impurity is caused by the dependency on setInserted.
-
Note that no trimming of the input
path
is performed by the procedure.
Consequently, any leading or trailing whitespace characters will be significant.
- Note
- The procedure setPathPosixEscaped can be called if any Bash environment special characters as specified in POSIX_RESERVED_STR need to be escaped in the output
path
via the escape character \
.
Otherwise, getPathVerbatimPosix can generate a path whose characters will be interpreted verbatim in POSIX shell environment.
- See also
- getPathPosix
getPathPosixEscaped
setPathPosixEscaped
Example usage ⛓
10 character(:),
allocatable :: path
12 type(display_type) :: disp
18 call disp%show(
"call setPathPosix(path)")
21 call disp%show( path , deliml
= """" )
27 call disp%show(
"call setPathPosix(path)")
30 call disp%show( path , deliml
= """" )
36 call disp%show(
"call setPathPosix(path)")
39 call disp%show( path , deliml
= """" )
45 call disp%show(
"call setPathPosix(path)")
48 call disp%show( path , deliml
= """" )
52 call disp%show(
"path = 'foo\/bar/\'")
54 call disp%show(
"call setPathPosix(path)")
57 call disp%show( path , deliml
= """" )
61 call disp%show(
"path = 'foo\/bar$/\'")
63 call disp%show(
"call setPathPosix(path)")
66 call disp%show( path , deliml
= """" )
70 call disp%show(
"path = 'd:\foo\/bar$\/\'")
71 path
= 'd:\foo\/bar$\/\'
72 call disp%show(
"call setPathPosix(path, ignore = '\/')")
75 call disp%show( path , deliml
= """" )
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.
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(....
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 ⛓
38path
= 'd:\foo\/bar$\/\'
- 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 Austin
Definition at line 1726 of file pm_sysPath.F90.