pm_strASCII::getAsciiFromEscaped Interface Reference

Generate and return the input C-style escaped string where all instances of C-style escape sequences are converted to the corresponding ASCII characters or left intact if they are not convertible.
More...

Detailed Description

Generate and return the input C-style escaped string where all instances of C-style escape sequences are converted to the corresponding ASCII characters or left intact if they are not convertible.

See the documentation of setAsciiFromEscaped for further details.

Parameters

[in]

str

: The input scalar character of kind any supported by the processor (e.g., SK, SKA, SKD , or SKU) containing the C-style escaped string to be converted to ASCII.

Returns

ascii : The output allocatable scalar of the same type and kind as the input str containing the input string where all instances of escape seuquences with an ASCII representation are replaced with their corresponding ASCII character (, otherwise, left as is).

Possible calling interfaces ⛓

use pm_strASCII, only: getAsciiFromEscaped
character(:,kind(str)), allocatable :: ascii
 
ascii = getAsciiFromEscaped(str)

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 of the procedures is caused by the dependence on other conditionally impure procedure.

See also

setAsciiFromEscaped
isFailedList

Example usage ⛓

program example
 
    use pm_kind, only: SK, IK
    use pm_io, only: display_type
    use pm_strASCII, only: getAsciiFromEscaped
 
    implicit none
 
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("getAsciiFromEscaped('')")
    call disp%show( getAsciiFromEscaped('') , deliml = """" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getAsciiFromEscaped('A')")
    call disp%show( getAsciiFromEscaped('A') , deliml = """" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getAsciiFromEscaped('\paramonte')")
    call disp%show( getAsciiFromEscaped('\paramonte') , deliml = """" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getAsciiFromEscaped('\\nn\004\t')")
    call disp%show( getAsciiFromEscaped('\\nn\004\t') , deliml = """" )
    call disp%show("'\nn'//achar(4)//achar(9) == getAsciiFromEscaped('\\nn\004\t')")
    call disp%show( '\nn'//achar(4)//achar(9) == getAsciiFromEscaped('\\nn\004\t') )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getAsciiFromEscaped('\nn\fn\04\? \r\b\\a\47\41\x009f\xZFa\u002C\U0000007E\U+2661')")
    call disp%show( getAsciiFromEscaped('\nn\fn\04\? \r\b\\a\47\41\x009f\xZFa\u002C\U0000007E\U+2661') , deliml = """" )
    call disp%show("achar(10)//'n'//achar(12)//'n'//achar(4)//'? '//achar(13)//achar(8)//'\a'//achar(39)//achar(33)//achar(9)//'f\xZFa'//char(44)//char(126)//'A\UFBDA' == getAsciiFromEscaped('\nn\fn\04\? \r\b\\a\47\41\x009f\xZFa\u002C\U0000007EA\UFBDA')")
    call disp%show( achar(10)//'n'//achar(12)//'n'//achar(4)//'? '//achar(13)//achar(8)//'\a'//achar(39)//achar(33)//achar(9)//'f\xZFa'//char(44)//char(126)//'A\UFBDA' == getAsciiFromEscaped('\nn\fn\04\? \r\b\\a\47\41\x009f\xZFa\u002C\U0000007EA\UFBDA') )
    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 ⛓

 
getAsciiFromEscaped('')
""
 
 
getAsciiFromEscaped('A')
"A"
 
 
getAsciiFromEscaped('\paramonte')
"\paramonte"
 
 
getAsciiFromEscaped('\\nn\004\t')
"\nn␄   "
'\nn'//achar(4)//achar(9) == getAsciiFromEscaped('\\nn\004\t')
T
 
 
getAsciiFromEscaped('\nn\fn\04\? \r\b\\a\47\41\x009f\xZFa\u002C\U0000007E\U+2661')
"
n␌n␄? 
␈\a'!   f\xZFa,~\U+2661"
achar(10)//'n'//achar(12)//'n'//achar(4)//'? '//achar(13)//achar(8)//'\a'//achar(39)//achar(33)//achar(9)//'f\xZFa'//char(44)//char(126)//'A\UFBDA' == getAsciiFromEscaped('\nn\fn\04\? \r\b\\a\47\41\x009f\xZFa\u002C\U0000007EA\UFBDA')
T
 
 

Test:

test_pm_strASCII

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, September 1, 2017, 11:02 PM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin

Definition at line 4534 of file pm_strASCII.F90.

---

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

• src/fortran/main/pm_strASCII.F90