pm_sysPath::getPathPosixEscaped Interface Reference

Generate and return a POSIX standard (Unix-like) version of the input POSIX-style-separated path where all the relevant POSIX reserved characters are properly escaped via (\).
More...

Detailed Description

Generate and return a POSIX standard (Unix-like) version of the input POSIX-style-separated path where all the relevant POSIX reserved characters are properly escaped via (\).

For more details on the implementation of the procedure, see the documentation of setPathPosixEscaped.

Parameters

[in]

path

: The input scalar character of default kind SK containing a POSIX-style-separated path whose relevant escape characters shall be escaped.

Returns

pathEscaped : The output allocatable scalar of type character of default kind SK containing the modified input path where the relevant escape characters are escaped properly.

Possible calling interfaces ⛓

use pm_sysPath, only: getPathPosixEscaped
character(:, SK), allocatable :: pathEscaped
 
pathEscaped = getPathPosixEscaped(path)

Warning

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.

See also

getPathNew
getPathPosix
setPathPosix
setPathPosixEscaped

Example usage ⛓

program example
 
    use pm_kind, only: SK ! all processor types and kinds are supported.
    use pm_io, only: display_type
    use pm_sysPath, only: getPathPosixEscaped
 
    implicit none
 
    character(:), allocatable :: path
 
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("path = ''")
                    path = ''
    call disp%show("path = getPathPosixEscaped(path)")
                    path = getPathPosixEscaped(path)
    call disp%show("path")
    call disp%show( path , deliml = """" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("path = 'foo\bar'")
                    path = 'foo\bar'
    call disp%show("path = getPathPosixEscaped(path)")
                    path = getPathPosixEscaped(path)
    call disp%show("path")
    call disp%show( path , deliml = """" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("path = 'foo\/bar'")
                    path = 'foo\/bar'
    call disp%show("path = getPathPosixEscaped(path)")
                    path = getPathPosixEscaped(path)
    call disp%show("path")
    call disp%show( path , deliml = """" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("path = 'foo\/bar/'")
                    path = 'foo\/bar/'
    call disp%show("path = getPathPosixEscaped(path)")
                    path = getPathPosixEscaped(path)
    call disp%show("path")
    call disp%show( path , deliml = """" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("path = 'foo\/bar/\'")
                    path = 'foo\/bar/\'
    call disp%show("path = getPathPosixEscaped(path)")
                    path = getPathPosixEscaped(path)
    call disp%show("path")
    call disp%show( path , deliml = """" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("path = 'foo\/bar$/\'")
                    path = 'foo\/bar$/\'
    call disp%show("path = getPathPosixEscaped(path)")
                    path = getPathPosixEscaped(path)
    call disp%show("path")
    call disp%show( path , deliml = """" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("path = 'd:\foo\/bar$/\'")
                    path = 'd:\foo\/bar$/\'
    call disp%show("path = getPathPosixEscaped(path)")
                    path = getPathPosixEscaped(path)
    call disp%show("path")
    call disp%show( path , deliml = """" )
    call disp%skip()
 
end program example

Example Unix compile command via Intel ifort compiler ⛓

#!/usr/bin/env sh
rm main.exe
ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example Windows Batch compile command via Intel ifort compiler ⛓

del main.exe
set PATH=..\..\..\lib;%PATH%
ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
main.exe

Example Unix / MinGW compile command via GNU gfortran compiler ⛓

#!/usr/bin/env sh
rm main.exe
gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example output ⛓

 
path = ''
path = getPathPosixEscaped(path)
path
""
 
 
path = 'foo\bar'
path = getPathPosixEscaped(path)
path
"foo\\bar"
 
 
path = 'foo\/bar'
path = getPathPosixEscaped(path)
path
"foo\\/bar"
 
 
path = 'foo\/bar/'
path = getPathPosixEscaped(path)
path
"foo\\/bar/"
 
 
path = 'foo\/bar/\'
path = getPathPosixEscaped(path)
path
"foo\\/bar/\\"
 
 
path = 'foo\/bar$/\'
path = getPathPosixEscaped(path)
path
"foo\\/bar\$/\\"
 
 
path = 'd:\foo\/bar$/\'
path = getPathPosixEscaped(path)
path
"d:\\foo\\/bar\$/\\"
 
 

Test:

test_pm_sysPath

Todo:

Normal Priority: The implementation of this procedure can be improved by replacing the call to the subroutine version with the actual code.

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 Austin

Definition at line 1340 of file pm_sysPath.F90.

---

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

• src/fortran/main/pm_sysPath.F90