pm_sysPath::getPathVerbatimFish Interface Reference

Generate and return a path quoted with single quotation marks where all instances of backslashes within the path are replaced with double backslash and all single quotes \(\ms{'}\) are replaced with \(\ms{\'}\).
More...

Detailed Description

Generate and return a path quoted with single quotation marks where all instances of backslashes within the path are replaced with double backslash and all single quotes \(\ms{'}\) are replaced with \(\ms{\'}\).

This procedure exists to minimize security vulnerabilities associated with paths that may contain harmful system commands.
To ensure paths are interpreted as simple strings in Fish shell, they must be quoted with proper quotation marks on all platforms.
The path returned by this procedure is as close as one can get to a verbatim path in Fish shell on any platform.
If a path is be used in a call to a PowerShell runtime shell, it is recommended to pass it to this procedure to ensure the path is quoted and all instances of dangling quotation marks \(\ms{'}\)are gracefully escaped.

Optionally, if a set of wildcard characters are also specified, all instances of such characters identified within the specified path are properly excluded from the quotations, such that the resulting output path can be used as pattern for globing.

Parameters

[in]

path

: The input scalar character of kind any supported by the processor (e.g., SK, SKA, SKD , or SKU) containing the path to be enclosed with quotation marks.

Returns

pathVerbatim : The output allocatable scalar of type character of the same kind as path containing the modified input path enclosed with single quotation marks where all instances of single quotation marks and backslashes within the path are escaped.
Wildcard characters, if any are present, are not quoted via single quotation marks.

Possible calling interfaces ⛓

use pm_sysPath, only: getPathVerbatimFish
 
pathVerbatim = getPathVerbatimFish(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. The impurity is caused by the call to procedures whose purity depends on the library build configuration.

See also

getPathVerbatimPowerShell
getPathVerbatimPosix
getPathVerbatimFish
getPathVerbatimCMD
getPathVerbatim
getPathPosix
setPathPosix
getPathPosixEscaped
setPathPosixEscaped

Example usage ⛓

program example
 
    use pm_kind, only: LK
    use pm_kind, only: SK ! all processor types and kinds are supported.
    use pm_io, only: display_type
    use pm_sysPath, only: getPathVerbatimFish
 
    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 = getPathVerbatimFish(path)")
                    path = getPathVerbatimFish(path)
    call disp%show("path")
    call disp%show( path , deliml = """" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("path = '\'")
                    path = '\'
    call disp%show("path = getPathVerbatimFish(path)")
                    path = getPathVerbatimFish(path)
    call disp%show("path")
    call disp%show( path , deliml = """" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("path = '\''")
                    path = "\'"
    call disp%show("path = getPathVerbatimFish(path)")
                    path = getPathVerbatimFish(path)
    call disp%show("path")
    call disp%show( path , deliml = """" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("path = './""paramonte""/library'")
                    path = "./""paramonte""/library"
    call disp%show("path = getPathVerbatimFish(path)")
                    path = getPathVerbatimFish(path)
    call disp%show("path")
    call disp%show( path , deliml = """" )
    call disp%skip()
 
    call disp%skip()
    call disp%show('path = "./''paramonte''/library"')
                    path = './''paramonte''/library'
    call disp%show("path = getPathVerbatimFish(path)")
                    path = getPathVerbatimFish(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 = getPathVerbatimFish(path)
path
"''"
 
 
path = '\'
path = getPathVerbatimFish(path)
path
"'\\'"
 
 
path = '\''
path = getPathVerbatimFish(path)
path
"'\\\''"
 
 
path = './"paramonte"/library'
path = getPathVerbatimFish(path)
path
"'./"paramonte"/library'"
 
 
path = "./'paramonte'/library"
path = getPathVerbatimFish(path)
path
"'./\'paramonte\'/library'"
 
 

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.

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

---

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

• src/fortran/main/pm_sysPath.F90