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

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...

Detailed Description

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

POSIX-style paths can contain almost any character including single or double quotation marks.
To simplify the task and minimize the risks, this procedure quotes all input POSIX style paths with single quotation marks.
Enclosing the path with single quotation marks requires escaping any existing instances of single quotes within the path.
This is done by replacing all instances of \(\ms{'}\) within the path are replaced with \(\ms{'\''}\).

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 within the path are escaped.
Wildcard characters, if any are present, are not quoted via single quotation marks.


Possible calling interfaces

pathVerbatim = getPathVerbatimPosix(path)
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.
Definition: pm_sysPath.F90:274
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

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
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("path = getPathVerbatimPosix(path)")
19 path = getPathVerbatimPosix(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 = './""paramonte""/library'")
26 path = "./""paramonte""/library"
27 call disp%show("path = getPathVerbatimPosix(path)")
28 path = getPathVerbatimPosix(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 = "./''paramonte''/library"')
35 path = './''paramonte''/library'
36 call disp%show("path = getPathVerbatimPosix(path)")
37 path = getPathVerbatimPosix(path)
38 call disp%show("path")
39 call disp%show( path , deliml = """" )
40 call disp%skip()
41
42end 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
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 = ''
3path = getPathVerbatimPosix(path)
4path
5"''"
6
7
8path = './"paramonte"/library'
9path = getPathVerbatimPosix(path)
10path
11"'./"paramonte"/library'"
12
13
14path = "./'paramonte'/library"
15path = getPathVerbatimPosix(path)
16path
17"'./'\''paramonte'\''/library'"
18
19
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.

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


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