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

Return a POSIX-standard (Unix-like) path from the input (Windows-style) path.
More...

Detailed Description

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

  1. replacing all instances of the Windows-style path-separator (\) in the input path with the POSIX-style path-separator (/), and
  2. collapsing all redundant directory separators such that \A//B\/, ///A/B\\, \A//B\ all become /A/B.
  3. 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.
  4. 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 input path contains a Hex value \xhh, then set ignore = \xhh or
    2. 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 ⛓

use pm_sysPath, only: setPathPosix
character(:, SK), allocatable :: path
call setPathPosix(path)
call setPathPosix(path, ignore = ignore)
pm_sysPath::setPathPosix
Return a POSIX-standard (Unix-like) path from the input (Windows-style) path.
Definition: pm_sysPath.F90:1726
pm_sysPath
This module contains classes and procedures for manipulating system file/folder paths.
Definition: pm_sysPath.F90:274
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,
  1. no POSIX special character is escaped via the POSIX escape character \ in the input path, and
  2. 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.
Remarks
This procedure has the same functionality as its functional equivalent getPathPosix except for the fact it can be slightly faster than the functional procedure.
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 ⛓

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_sysPath, only: setPathPosix
7
8 implicit none
9
10 character(:), allocatable :: path
11
12 type(display_type) :: disp
13 disp = display_type(file = "main.out.F90")
14
15 call disp%skip()
16 call disp%show("path = ''")
17 path = ''
18 call disp%show("call setPathPosix(path)")
19 call setPathPosix(path)
20 call disp%show("path")
21 call disp%show( path , deliml = """" )
22 call disp%skip()
23
24 call disp%skip()
25 call disp%show("path = 'foo\bar'")
26 path = 'foo\bar'
27 call disp%show("call setPathPosix(path)")
28 call setPathPosix(path)
29 call disp%show("path")
30 call disp%show( path , deliml = """" )
31 call disp%skip()
32
33 call disp%skip()
34 call disp%show("path = 'foo\/bar'")
35 path = 'foo\/bar'
36 call disp%show("call setPathPosix(path)")
37 call setPathPosix(path)
38 call disp%show("path")
39 call disp%show( path , deliml = """" )
40 call disp%skip()
41
42 call disp%skip()
43 call disp%show("path = 'foo\/bar/'")
44 path = 'foo\/bar/'
45 call disp%show("call setPathPosix(path)")
46 call setPathPosix(path)
47 call disp%show("path")
48 call disp%show( path , deliml = """" )
49 call disp%skip()
50
51 call disp%skip()
52 call disp%show("path = 'foo\/bar/\'")
53 path = 'foo\/bar/\'
54 call disp%show("call setPathPosix(path)")
55 call setPathPosix(path)
56 call disp%show("path")
57 call disp%show( path , deliml = """" )
58 call disp%skip()
59
60 call disp%skip()
61 call disp%show("path = 'foo\/bar$/\'")
62 path = 'foo\/bar$/\'
63 call disp%show("call setPathPosix(path)")
64 call setPathPosix(path)
65 call disp%show("path")
66 call disp%show( path , deliml = """" )
67 call disp%skip()
68
69 call disp%skip()
70 call disp%show("path = 'd:\foo\/bar$\/\'")
71 path = 'd:\foo\/bar$\/\'
72 call disp%show("call setPathPosix(path, ignore = '\/')")
73 call setPathPosix(path, ignore = '\/')
74 call disp%show("path")
75 call disp%show( path , deliml = """" )
76 call disp%skip()
77
78end 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 setPathPosix(path)
4path
5""
6
7
8path = 'foo\bar'
9call setPathPosix(path)
10path
11"foo/bar"
12
13
14path = 'foo\/bar'
15call setPathPosix(path)
16path
17"foo/bar"
18
19
20path = 'foo\/bar/'
21call setPathPosix(path)
22path
23"foo/bar"
24
25
26path = 'foo\/bar/\'
27call setPathPosix(path)
28path
29"foo/bar"
30
31
32path = 'foo\/bar$/\'
33call setPathPosix(path)
34path
35"foo/bar$"
36
37
38path = 'd:\foo\/bar$\/\'
39call setPathPosix(path, ignore = '\/')
40path
41"d:/foo\/bar$\/"
42
43
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.

  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.

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 1726 of file pm_sysPath.F90.

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