Generate and return a path quoted with single quotation marks where all instances of single quotes \(\ms{'}\) within the path are replaced with \(\ms{''}\).
More...
Generate and return a path quoted with single quotation marks where all instances of single quotes \(\ms{'}\) within the path 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, they must be quoted with proper quotation marks on both Windows and Unix-like platforms.
The path returned by this procedure is as close as one can get to a verbatim path in Windows PowerShell or PowerShell Core on Unix platforms.
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.
- 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 within the path are escaped.
Possible calling interfaces ⛓
Generate and return a path quoted with single quotation marks where all instances of single quotes w...
This module contains classes and procedures for manipulating system file/folder paths.
- Warning
- Note that this procedure does not inspect the input path for the presence of other illegal Windows reserved characters on Windows platforms (e.g., WINDOWS_RESERVED_STR).
The presence of illegal characters in a Windows path can lead to runtime errors even if the path is quoted by the procedures of this generic interface.
-
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 ⛓
10 character(:),
allocatable :: path
12 type(display_type) :: disp
18 call disp%show(
"path = getPathVerbatimPowerShell(path)")
21 call disp%show( path , deliml
= """" )
25 call disp%show(
"path = './""paramonte""/library'")
26 path
= "./""paramonte""/library"
27 call disp%show(
"path = getPathVerbatimPowerShell(path)")
30 call disp%show( path , deliml
= """" )
34 call disp%show(
'path = "./''paramonte''/library"')
35 path
= './''paramonte''/library'
36 call disp%show(
"path = getPathVerbatimPowerShell(path)")
39 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 ⛓
8path
= './"paramonte"/library'
11"'./"paramonte
"/library'"
14path
= "./'paramonte'/library"
17"'./''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.
-
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 5077 of file pm_sysPath.F90.