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

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 (\).

The POSIX reserved characters that handled by this procedure are specified in POSIX_RESERVED_STR.
This includes escaping any single or double quotation marks that might be present in the input path.

Parameters

[out]	pathEscaped	: The output scalar `allocatable` `character` of default kind SK containing the input `path` that is reallocated to contain the input `path` where all instances of POSIX Shell escape character sets (POSIX_RESERVED_STR or POSIX_RESERVED_DQUOTE_STR) are properly escaped via `\`.
[in]	path	: The input scalar `character` of default kind SK containing a POSIX-style string whose characters shall be escaped.

Possible calling interfaces ⛓

: use pm_sysPath, only: setPathPosixEscaped

character(:, SK), allocatable :: pathEscaped, path

call setPathPosixEscaped(pathEscaped, path)

pm_sysPath::setPathPosixEscaped
Return a POSIX standard (Unix-like) version of the input POSIX-style-separated path where all the rel...
Definition: pm_sysPath.F90:1454

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

See also: getPathNew
getPathPosix
setPathPosix
getPathPosixEscaped

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

6 use pm_sysPath, only: setPathPosixEscaped

7

8 implicit none

9

10 character(:), allocatable :: path, pathEscaped

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("call setPathPosixEscaped(pathEscaped, path)")

19 call setPathPosixEscaped(pathEscaped, path)

20 call disp%show("pathEscaped")

21 call disp%show( pathEscaped , deliml = """" )

22 call disp%skip()

23

24 call disp%skip()

25 call disp%show("path = 'foo\bar'")

26 path = 'foo\bar'

27 call disp%show("call setPathPosixEscaped(pathEscaped, path)")

28 call setPathPosixEscaped(pathEscaped, path)

29 call disp%show("pathEscaped")

30 call disp%show( pathEscaped , deliml = """" )

31 call disp%skip()

32

33 call disp%skip()

34 call disp%show("path = 'foo\/bar'")

35 path = 'foo\/bar'

36 call disp%show("call setPathPosixEscaped(pathEscaped, path)")

37 call setPathPosixEscaped(pathEscaped, path)

38 call disp%show("pathEscaped")

39 call disp%show( pathEscaped , deliml = """" )

40 call disp%skip()

41

42 call disp%skip()

43 call disp%show("path = 'foo\/bar/'")

44 path = 'foo\/bar/'

45 call disp%show("call setPathPosixEscaped(pathEscaped, path)")

46 call setPathPosixEscaped(pathEscaped, path)

47 call disp%show("pathEscaped")

48 call disp%show( pathEscaped , deliml = """" )

49 call disp%skip()

50

51 call disp%skip()

52 call disp%show("path = 'foo\/bar/\'")

53 path = 'foo\/bar/\'

54 call disp%show("call setPathPosixEscaped(pathEscaped, path)")

55 call setPathPosixEscaped(pathEscaped, path)

56 call disp%show("pathEscaped")

57 call disp%show( pathEscaped , deliml = """" )

58 call disp%skip()

59

60 call disp%skip()

61 call disp%show("path = 'foo\/bar$/\'")

62 path = 'foo\/bar$/\'

63 call disp%show("call setPathPosixEscaped(pathEscaped, path)")

64 call setPathPosixEscaped(pathEscaped, path)

65 call disp%show("pathEscaped")

66 call disp%show( pathEscaped , deliml = """" )

67 call disp%skip()

68

69 call disp%skip()

70 call disp%show("path = 'd:\foo\/bar$/\'")

71 path = 'd:\foo\/bar$/\'

72 call disp%show("call setPathPosixEscaped(pathEscaped, path)")

73 call setPathPosixEscaped(pathEscaped, path)

74 call disp%show("pathEscaped")

75 call disp%show( pathEscaped , deliml = """" )

76 call disp%skip()

77

78end program example

pm_io::show
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11726

pm_io::skip
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11508

pm_io
This module contains classes and procedures for input/output (IO) or generic display operations on st...
Definition: pm_io.F90:252

pm_io::disp
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
Definition: pm_io.F90:11393

pm_kind
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
Definition: pm_kind.F90:268

pm_kind::LK
integer, parameter LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
Definition: pm_kind.F90:541

pm_kind::SK
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

pm_io::display_type
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 = ''

3call setPathPosixEscaped(pathEscaped, path)

4pathEscaped

5""

6

7

8path = 'foo\bar'

9call setPathPosixEscaped(pathEscaped, path)

10pathEscaped

11"foo\\bar"

12

13

14path = 'foo\/bar'

15call setPathPosixEscaped(pathEscaped, path)

16pathEscaped

17"foo\\/bar"

18

19

20path = 'foo\/bar/'

21call setPathPosixEscaped(pathEscaped, path)

22pathEscaped

23"foo\\/bar/"

24

25

26path = 'foo\/bar/\'

27call setPathPosixEscaped(pathEscaped, path)

28pathEscaped

29"foo\\/bar/\\"

30

31

32path = 'foo\/bar$/\'

33call setPathPosixEscaped(pathEscaped, path)

34pathEscaped

35"foo\\/bar\$/\\"

36

37

38path = 'd:\foo\/bar$/\'

39call setPathPosixEscaped(pathEscaped, path)

40pathEscaped

41"d:\\foo\\/bar\$/\\"

42

43

Test:: test_pm_sysPath

Todo:: Low Priority: This procedure can be converted to a generic interface with an input intent(inout), allocatable :: path interface for further convenience.

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

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

src/fortran/main/pm_sysPath.F90