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

Generate and return a path quoted with single or double quotation marks whose metacharacters are also properly escaped depending on the runtime system shell.
More...

Detailed Description

Generate and return a path quoted with single or double quotation marks whose metacharacters are also properly escaped depending on the runtime system shell.

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 procedures under this generic interface call one of the following generic interfaces, depending on the specified or determined runtime system shell,

  1. getPathVerbatimPowerShell in Windows or Unix PowerShell environments.
  2. getPathVerbatimPosix in POSIX-compliant shell environments.
  3. getPathVerbatimCMD in Windows CMD shell environments.
Parameters
[in]path: The input scalar character of default kind SK containing the path to be enclosed with quotation marks.
[out]failed: The output scalar logical of default kind LK that is .true. if and only if an error occurs while inferring the runtime system shell.
(optional. If missing and a runtime error occurs, the program will halt by calling error stop.)
[in,out]errmsg: The input/output scalar character of default kind SK of arbitrary length type parameter.
If an error occurs, errmsg will be set to a descriptive message about the nature of the runtime error.
A length of LEN_IOMSG characters is likely sufficient to capture most error messages in full.
(optional. If missing, no error message will be output. Its presence is relevant only if failed is also present.)
Returns
pathVerbatim : The output allocatable scalar of type character of the same kind as path containing the modified input path enclosed with single or double quotation marks such that it can be treated as a verbatim path in the specified or the runtime shell.


Possible calling interfaces

character(255, SK) :: errmsg
logical(LK) :: failed
pathVerbatim = getPathVerbatim(path, failed = failed, errmsg = errmsg)
Generate and return a path quoted with single or double quotation marks whose metacharacters are also...
This module contains classes and procedures for manipulating system file/folder paths.
Definition: pm_sysPath.F90:274
Remarks
The procedures under discussion are impure.
See also
getPathVerbatimPowerShell
getPathVerbatimPosix
getPathVerbatimCMD
getPathVerbatim
getPathPosix
setPathPosix
getPathPosixEscaped
setPathPosixEscaped


Example usage

1program example
2
3 use pm_kind, only: SK, LK
4 use pm_io, only: display_type
6 use pm_sysShell, only: shell_type
7
8 implicit none
9
10 type(shell_type) :: Shell
11 character(:, SK), allocatable :: path
12
13 type(display_type) :: disp
14 disp = display_type(file = "main.out.F90")
15
16 call disp%skip()
17 call disp%show('shell = shell_type()')
18 shell = shell_type()
19 call disp%show("shell%name")
20 call disp%show( shell%name , deliml = SK_"""" )
21 call disp%skip()
22
23 call disp%skip()
24 call disp%show("path = SK_''")
25 path = SK_''
26 call disp%show("path = getPathVerbatim(path)")
27 path = getPathVerbatim(path)
28 call disp%show("path")
29 call disp%show( path , deliml = SK_"""" )
30 call disp%skip()
31
32 call disp%skip()
33 call disp%show("path = './""paramonte""/library'")
34 path = "./""paramonte""/library"
35 call disp%show("path = getPathVerbatim(path)")
36 path = getPathVerbatim(path)
37 call disp%show("path")
38 call disp%show( path , deliml = SK_'''' )
39 call disp%skip()
40
41 call disp%skip()
42 call disp%show('path = "./''paramonte''/library"')
43 path = './''paramonte''/library'
44 call disp%show("path = getPathVerbatim(path)")
45 path = getPathVerbatim(path)
46 call disp%show("path")
47 call disp%show( path , deliml = SK_"""" )
48 call disp%skip()
49
50 call disp%skip()
51 call disp%show('path = "./''paramonte''/library"')
52 path = './''paramonte''/library'
53 call disp%show("path = getPathVerbatim(path)")
54 path = getPathVerbatim(path)
55 call disp%show("path")
56 call disp%show( path , deliml = SK_"""" )
57 call disp%skip()
58
59end program example
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11726
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11508
This module contains classes and procedures for input/output (IO) or generic display operations on st...
Definition: pm_io.F90:252
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
Definition: pm_io.F90:11393
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
Definition: pm_kind.F90:268
integer, parameter LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
Definition: pm_kind.F90:541
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
This module contains procedures and generic interfaces for inferring the runtime system shell type an...
Definition: pm_sysShell.F90:38
Generate and return an object of type display_type.
Definition: pm_io.F90:10282
This is the shell_type class for generating objects to determine the runtime shell type of the operat...

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
2shell = shell_type()
3shell%name
4"dash"
5
6
7path = SK_''
8path = getPathVerbatim(path)
9path
10"''"
11
12
13path = './"paramonte"/library'
14path = getPathVerbatim(path)
15path
16''./"paramonte"/library''
17
18
19path = "./'paramonte'/library"
20path = getPathVerbatim(path)
21path
22"'./'\''paramonte'\''/library'"
23
24
25path = "./'paramonte'/library"
26path = getPathVerbatim(path)
27path
28"'./'\''paramonte'\''/library'"
29
30
Test:
test_pm_sysPath
Todo:
High Priority: The current Fortran standard 202x does not allow passing characters of non-default kind to the intrinsic Fortran statements and procedures.
As such, the implementation of this procedure for non-default character kinds leads to compile-time kind mismatch errors.
This procedure should be converted back to a generic interface in the future when non-default character kinds are also fully supported by the intrinsic functions.


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.

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


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