C-escape - Revision history

Gray at 13:21, 16 October 2023

2023-10-16T13:21:15Z

Gray at 19:10, 5 September 2015

2015-09-05T19:10:36Z

Gray at 19:10, 5 September 2015

2015-09-05T19:10:17Z

Gray at 12:23, 26 October 2011

2011-10-26T12:23:04Z

Gray: Created page with "The ''C-escape'' filter replaces C escape sequences with the corresponding control character and vice versa. In encode mode, recognized control characters are replaced with..."

2011-03-23T08:10:01Z

Created page with "The ''C-escape'' filter replaces C escape sequences with the corresponding control character and vice versa. In encode mode, recognized control characters are replaced with..."

New page

The ''C-escape'' [[filter]] replaces C escape sequences with the corresponding control character and vice versa.

In encode mode, recognized control characters are replaced with their C escapes. For example, newline (ASCII 10) becomes ''\n'', horizontal tab (ASCII 9) becomes ''\t'', etc.

In decode mode, the reverse operation is performed, i.e. each C escape is replaced with the corresponding character. Unrecognized escape sequences are copied verbatim.

Only named escapes are supported, i.e.: ''\\'', ''\a'', ''\b'', ''\f'', ''\n'', ''\r'', ''\t'', ''\v''.

This filter does not take arguments.

The following object, declared in mailutils/filter.h describes the ''C-escape'' filter:

<source lang="C">
extern mu_filter_record_t mu_c_escape_filter;
</source>

The example below shows how to create an instance of this filter in decode mode for reading:

<source lang="C">
int rc; /* Return code */
mu_stream_t flt; /* Filter stream */
mu_stream_t input; /* Input stream */

initialize_input_stream (&stream);
rc = mu_filter_stream_create (&flt, input, "C-escape", MU_FILTER_DECODE, MU_STREAM_READ);
</source>

[[Category:Filters]]

← Older revision		Revision as of 12:23, 26 October 2011
Line 27:		Line 27:

	[[Category:Filters]]		[[Category:Filters]]
		+	[[Category:C API]]

@@ Line 11: / Line 11: @@
 The following object, declared in mailutils/filter.h describes the ''C-escape'' filter:
-<source lang="C">
+<syntaxhighlight lang="C">
 extern mu_filter_record_t mu_c_escape_filter;
-</source>
+</syntaxhighlight>
 The example below shows how to create an instance of this filter in decode mode for reading:
-<source lang="C">
+<syntaxhighlight lang="C">
    int rc;          /* Return code */
    mu_stream_t flt; /* Filter stream */
@@ Line 24: / Line 24: @@
    initialize_input_stream (&input);
    rc = mu_filter_create (&flt, input, "C-escape", MU_FILTER_DECODE, MU_STREAM_READ);
-</source>
+</syntaxhighlight>
 [[Category:Filters]]
 [[Category:C API]]