diff options
Diffstat (limited to 'dump.c')
| -rw-r--r-- | dump.c | 46 |
1 files changed, 23 insertions, 23 deletions
@@ -94,43 +94,43 @@ S_append_flags(pTHX_ SV *sv, U32 flags, const struct flag_to_name *start, /* =for apidoc pv_escape -Escapes at most the first "count" chars of pv and puts the results into -dsv such that the size of the escaped string will not exceed "max" chars +Escapes at most the first C<count> chars of C<pv> and puts the results into +C<dsv> such that the size of the escaped string will not exceed C<max> chars and will not contain any incomplete escape sequences. The number of bytes -escaped will be returned in the STRLEN *escaped parameter if it is not null. -When the dsv parameter is null no escaping actually occurs, but the number +escaped will be returned in the C<STRLEN *escaped> parameter if it is not null. +When the C<dsv> parameter is null no escaping actually occurs, but the number of bytes that would be escaped were it not null will be calculated. -If flags contains PERL_PV_ESCAPE_QUOTE then any double quotes in the string +If flags contains C<PERL_PV_ESCAPE_QUOTE> then any double quotes in the string will also be escaped. Normally the SV will be cleared before the escaped string is prepared, -but when PERL_PV_ESCAPE_NOCLEAR is set this will not occur. +but when C<PERL_PV_ESCAPE_NOCLEAR> is set this will not occur. -If PERL_PV_ESCAPE_UNI is set then the input string is treated as UTF-8 -if PERL_PV_ESCAPE_UNI_DETECT is set then the input string is scanned +If C<PERL_PV_ESCAPE_UNI> is set then the input string is treated as UTF-8 +if C<PERL_PV_ESCAPE_UNI_DETECT> is set then the input string is scanned using C<is_utf8_string()> to determine if it is UTF-8. -If PERL_PV_ESCAPE_ALL is set then all input chars will be output -using C<\x01F1> style escapes, otherwise if PERL_PV_ESCAPE_NONASCII is set, only +If C<PERL_PV_ESCAPE_ALL> is set then all input chars will be output +using C<\x01F1> style escapes, otherwise if C<PERL_PV_ESCAPE_NONASCII> is set, only non-ASCII chars will be escaped using this style; otherwise, only chars above 255 will be so escaped; other non printable chars will use octal or common escaped patterns like C<\n>. -Otherwise, if PERL_PV_ESCAPE_NOBACKSLASH +Otherwise, if C<PERL_PV_ESCAPE_NOBACKSLASH> then all chars below 255 will be treated as printable and will be output as literals. -If PERL_PV_ESCAPE_FIRSTCHAR is set then only the first char of the +If C<PERL_PV_ESCAPE_FIRSTCHAR> is set then only the first char of the string will be escaped, regardless of max. If the output is to be in hex, then it will be returned as a plain hex sequence. Thus the output will either be a single char, an octal escape sequence, a special escape like C<\n> or a hex value. -If PERL_PV_ESCAPE_RE is set then the escape char used will be a '%' and -not a '\\'. This is because regexes very often contain backslashed -sequences, whereas '%' is not a particularly common character in patterns. +If C<PERL_PV_ESCAPE_RE> is set then the escape char used will be a C<"%"> and +not a C<"\\">. This is because regexes very often contain backslashed +sequences, whereas C<"%"> is not a particularly common character in patterns. -Returns a pointer to the escaped text as held by dsv. +Returns a pointer to the escaped text as held by C<dsv>. =cut */ @@ -249,23 +249,23 @@ Perl_pv_escape( pTHX_ SV *dsv, char const * const str, =for apidoc pv_pretty Converts a string into something presentable, handling escaping via -pv_escape() and supporting quoting and ellipses. +C<pv_escape()> and supporting quoting and ellipses. -If the PERL_PV_PRETTY_QUOTE flag is set then the result will be +If the C<PERL_PV_PRETTY_QUOTE> flag is set then the result will be double quoted with any double quotes in the string escaped. Otherwise -if the PERL_PV_PRETTY_LTGT flag is set then the result be wrapped in +if the C<PERL_PV_PRETTY_LTGT> flag is set then the result be wrapped in angle brackets. -If the PERL_PV_PRETTY_ELLIPSES flag is set and not all characters in +If the C<PERL_PV_PRETTY_ELLIPSES> flag is set and not all characters in string were output then an ellipsis C<...> will be appended to the string. Note that this happens AFTER it has been quoted. -If start_color is non-null then it will be inserted after the opening -quote (if there is one) but before the escaped text. If end_color +If C<start_color> is non-null then it will be inserted after the opening +quote (if there is one) but before the escaped text. If C<end_color> is non-null then it will be inserted after the escaped text but before any quotes or ellipses. -Returns a pointer to the prettified text as held by dsv. +Returns a pointer to the prettified text as held by C<dsv>. =cut */ |