|
ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation. |
|
|
ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation. |
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...
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.
Escape sequences are used in the programming languages C and C++ whose conventions are also followed by many other languages.
An escape sequence is a sequence of characters that does not represent itself when used inside a character or string literal.
Instead, it is translated into another character or a sequence of characters that may be difficult or impossible to represent directly.
In C, all escape sequences consist of two or more characters, the first of which is the backslash, \ (called the escape character).
The remaining characters determine the interpretation of the escape sequence. For example, \n is an escape sequence that denotes a newline character.
The following escape sequences are defined in standard C which commonly (but not always) represent an ASCII (frequently nongraphical) character:
| Escape sequence | ASCII Octal | ASCII Decimal | ASCII Hex | ASCII Character Representation |
|---|---|---|---|---|
| \(\ms{\a}\) | 07 | 07 | 07 | Alert (Beep, Bell) (added in C89) |
| \(\ms{\b}\) | 10 | 08 | 08 | Backspace |
| \(\ms{\f}\) | 14 | 12 | 0C | Formfeed Page Break |
| \(\ms{\n}\) | 12 | 10 | 0A | Newline (Line Feed) |
| \(\ms{\r}\) | 15 | 13 | 0D | Carriage Return |
| \(\ms{\t}\) | 11 | 09 | 09 | Horizontal Tab |
| \(\ms{\v}\) | 13 | 11 | 0B | Vertical Tab |
| \(\ms{\\}\) | 134 | 92 | 5C | Backslash |
| \(\ms{\'}\) | 47 | 39 | 27 | Apostrophe or single quotation mark |
| \(\ms{\"}\) | 42 | 34 | 22 | Double quotation mark |
| \(\ms{\?}\) | 77 | 63 | 3F | Question mark (used to avoid trigraphs) |
| \(\ms{\nnn}\) | any | any | any | The byte whose numerical value is given by nnn interpreted as an octal number |
| \(\ms{\xhh…}\) | any | any | any | The byte whose numerical value is given by hh… interpreted as a hexadecimal number |
| \(\ms{\uhhhh}\) | none | none | none | Unicode code point below 10000 hexadecimal (added in C99) |
| \(\ms{\Uhhhhhhhh}\) | none | none | none | Unicode code point where h is a hexadecimal digit |
The following remarks are in order:
An octal escape sequence consists of \ followed by one, two, or three octal digits.
\11 is a single octal escape sequence denoting a byte with numerical value 9 (11 in octal), rather than the escape sequence \1 followed by the digit 1.\1111 is the octal escape sequence \111 followed by the digit 1.1, followed by the digit 1, one could use "\1""1", since C automatically concatenates adjacent string literals.\0 is a commonly used octal escape sequence, which denotes the null character, with value zero.A hex escape sequence must have at least one hex digit following \x, with no upper bound.
\xABCDEFG denotes the byte with the numerical value ABCDEF16, followed by the letter G, which is not a hex digit.8-bit character types, which limits a useful hex escape sequence to two hex digits.The C99 standard also supports escape sequences that denote Unicode code points in string literals.
Such escape sequences are called universal character names and have the form \uhhhh or \Uhhhhhhhh, where h stands for a hex digit.
\uhhhh denotes the code point hhhh, interpreted as a hexadecimal number.\Uhhhhhhhh denotes the code point hhhhhhhh, interpreted as a hexadecimal number.U+10000 or higher must be denoted with the \U syntax, whereas lower code points may use \u or \U.This functionality of this generic interface is highly useful for handling and maniulating C-style strings, for example, in processing the output of runtime shell commands, or processing user-specified strings that may or should contain nongraphical ASCII characters in a portable way.
| [in,out] | str | : The 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.
|
| [out] | ascii | : The output scalar of the same type and kind as the input str of length type parameter equal to or larger than the length of str, containing the input string where all instances of escape seuquences with an ASCII representation are replaced with their corresponding ASCII character.(optional. If missing, the output ASCII will be written to str.) |
| [out] | endloc | : The output scalar of type integer of default kind IK, containing the position of the last character of the resulting ASCII-converted string (in either str or ascii). |
Possible calling interfaces ⛓
pure procedure(s) documented herein become impure when the ParaMonte library is compiled with preprocessor macro CHECK_ENABLED=1.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.str should generally lead to faster runtime performance.
Example usage ⛓
ifort compiler ⛓ ifort compiler ⛓ gfortran compiler ⛓
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.
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.
Definition at line 4733 of file pm_strASCII.F90.
1.9.3