NAME

String::Escape - Backslash escapes, quoted phrase, word elision, etc.

SYNOPSIS

This module provides a flexible calling interface to some frequently-performed string conversion functions, including applying and removing backslash escapes like \n and \t, wrapping and removing double-quotes, and truncating to fit within a desired length.

use String::Escape qw( printable unprintable );
# Convert control, high-bit chars to \n or \xxx escapes
$output = printable($value);
# Convert escape sequences back to original chars
$value = unprintable($input);

use String::Escape qw( elide );
# Shorten strings to fit, if necessary
foreach (@_) { print elide( $_, 79 ) . "\n"; } 

use String::Escape qw( string2list list2string );
# Pack and unpack simple lists by quoting each item
$list = list2string( @list );
@list = string2list( $list );

use String::Escape qw( escape );
# Defer selection of escaping routines until runtime
$escape_name = $use_quotes ? 'qprintable' : 'printable';
@escaped = escape($escape_name, @values);

VERSION

This is version 2010.001.

SUBROUTINES

You can either import the specific functions you want, or import only the escape() function and pass it the names of the functions to invoke.

import / EXPORT

All of the public functions described below are available as optional exports.

Quoting

Each of these functions takes a single simple scalar argument and returns its escaped (or unescaped) equivalent.

quote($value) : $escaped: Add double quote characters to each end of the string.
unquote($value) : $escaped: If the string both begins and ends with double quote characters, they are removed, otherwise the string is returned unchanged.
quote_non_words($value) : $escaped: As above, but only quotes empty, punctuated, and multiword values; simple values consisting of alphanumerics without special characters are not quoted.
singlequote($value) : $escaped: Add single quote characters to each end of the string.
unsinglequote($value) : $escaped: If the string both begins and ends with single quote characters, they are removed, otherwise the string is returned unchanged.

Backslash Escaping Functions

Each of these functions takes a single simple scalar argument and returns its escaped (or unescaped) equivalent.

evalable($value) : $escaped: Converts return, newline, tab, backslash, dollar, at sign and unprintable characters to their backslash-escaped equivalents.
unevalable($value) : $escaped: Converts backslash escape sequences in a string back to their original value.
qevalable($value) : $escaped: Converts special characters to their backslash-escaped equivalents and then wraps the results with double quotes.
unqevalable($value) : $escaped: Strips surrounding double quotes then converts backslash escape sequences back to their original value.

In addition to the four functions listed above, there is a corresponding set which use a slightly different set of escape sequences.

printable($value) : $escaped

Converts return, newline, tab, backslash and unprintable characters to their backslash-escaped equivalents.

unprintable($value) : $escaped

Converts backslash escape sequences in a string back to their original value.

qprintable($value) : $escaped

Converts special characters to their backslash-escaped equivalents and then wraps the results with double quotes.

(Note that this is not MIME quoted-printable encoding.)

unqprintable($value) : $escaped

Strips surrounding double quotes then converts backslash escape sequences back to their original value.

In addition to the functions listed above, there is also one function that mirrors the behavior of Perl's built-in quotemeta() function.

unquotemeta($value) : $escaped: Strips out backslashes before any character.

Here are a few examples:

print printable( "\tNow is the time\nfor all good folks\n" );

\tNow is the time\nfor all good folks\n

print unprintable( '\\tNow is the time\\nfor all good folks\\n' );

	Now is the time
	for all good folks

Elision Function

This function extracts the leading portion of a provided string and appends ellipsis if it's longer than the desired maximum excerpt length.

elide($string) : $elided_string

elide($string, $length) : $elided_string

elide($string, $length, $word_boundary_strictness) : $elided_string

Return a single-quoted, shortened version of the string, with ellipsis.

If the original string is shorter than $length, it is returned unchanged. At most $length characters are returned; if called with a single argument, $length defaults to $DefaultLength.

Up to $word_boundary_strictness additional characters may be ommited in order to make the elided portion end on a word boundary; you can pass 0 to ignore word boundaries. If not provided, $word_boundary_strictness defaults to $DefaultStrictness.

$Elipses

The string of characters used to indicate the end of the excerpt. Initialized to '...'.

$DefaultLength

The default target excerpt length, used when the elide function is called with a single argument. Initialized to 60.

$DefaultStrictness

The default word-boundary flexibility, used when the elide function is called without the third argument. Initialized to 10.

Here are a few examples:

$string = 'foo bar baz this that the other';

print elide( $string, 100 );
```
foo bar baz this that the other
```
print elide( $string, 12 );
```
foo bar...
```
print elide( $string, 12, 0 );
```
foo bar b...
```

escape()

These functions provide for the registration of string-escape specification names and corresponding functions, and then allow the invocation of one or several of these functions on one or several source string values.

escape($escapes, $value) : $escaped_value

escape($escapes, @values) : @escaped_values

Returns an altered copy of the provided values by looking up the escapes string in a registry of string-modification functions.

If called in a scalar context, operates on the single value passed in; if called in a list contact, operates identically on each of the provided values.

Space-separated compound specifications like 'quoted uppercase' are expanded to a list of functions to be applied in order.

Valid escape specifications are:

one of the keys defined in %Escapes: The coresponding specification will be looked up and used.
a sequence of names separated by whitespace,: Each name will be looked up, and each of the associated functions will be applied successively, from left to right.
a reference to a function: The provided function will be called on with each value in turn.
a reference to an array: Each item in the array will be expanded as provided above.

A fatal error will be generated if you pass an unsupported escape specification, or if the function is called with multiple values in a scalar context.

String::Escape::names() : @defined_escapes

Returns a list of defined escape specification strings.

String::Escape::add( $escape_name, \&escape_function );

Add a new escape specification and corresponding function.

By default, all of the public functions described below are available as named escape commands, as well as the following built-in functions:

none: Return the string unchanged.
uppercase: Calls the built-in uc function.
lowercase: Calls the built-in lc function.
initialcase: Calls the built-in lc and ucfirst functions.

Here are a few examples:

print escape('qprintable', "\tNow is the time\nfor all good folks\n" );
```
"\tNow is the time\nfor all good folks\n"
```
print escape('uppercase qprintable', "\tNow is the time\nfor all good folks\n" );
```
"\tNOW IS THE TIME\nFOR ALL GOOD FOLKS\n"
```
print join '--', escape('printable', "\tNow is the time\n", "for all good folks\n" );
```
\tNow is the time\n--for all good folks\n
```
You can add more escaping functions to the supported set by calling add().

String::Escape::add( 'html', \&HTML::Entities::encode_entities );

print escape('html', "AT&T" );
```
AT&amp;T
```

Space-separated Lists and Hashes

@words = string2list( $space_separated_phrases );: Converts a space separated string of words and quoted phrases to an array;
$space_sparated_string = list2string( @words );: Joins an array of strings into a space separated string of words and quoted phrases;
%hash = string2hash( $string );: Converts a space separated string of equal-sign-associated key=value pairs into a simple hash.
$string = hash2string( %hash );: Converts a simple hash into a space separated string of equal-sign-associated key=value pairs.
%hash = list2hash( @words );: Converts an array of equal-sign-associated key=value strings into a simple hash.
@words = hash2list( %hash );: Converts a hash to an array of equal-sign-associated key=value strings.

Here are a few examples:

print list2string('hello', 'I move next march');
```
hello "I move next march"
```
@list = string2list('one "second item" 3 "four\nlines\nof\ntext"');

print $list[1];
```
second item
```
print hash2string( 'foo' => 'Animal Cities', 'bar' => 'Cheap' );
```
foo="Animal Cities" bar=Cheap
```
%hash = string2hash('key=value "undefined key" words="the cat in the hat"');

print $hash{'words'};
```
the cat in the hat
```
print exists $hash{'undefined_key'} and ! defined $hash{'undefined_key'};
```
1
```

PREREQUISITES AND INSTALLATION

This package should run on any standard Perl 5 installation.

To install this package, download the distribution from a CPAN mirror, unpack the archive file, and execute the standard "perl Makefile.PL", "make test", "make install" sequence or your local equivalent.

AUTHOR

Matthew Simon Cavalletto, <simonm at cavalletto.org>

BUGS

Please report any bugs or feature requests to bug-string-escape at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=String-Escape. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

The following changes are in progress or under consideration:

Clarify documentation regarding printable / evalable functions.

Rename evalable functions.

Clarify the language being used in the documentation.
```
http://perldoc.perl.org/perlop.html#Quote-and-Quote-like-Operators

http://rt.cpan.org/Public/Bug/Display.html?id=19765
```
Does this problem with the \r character only show up on Windows?
```
http://rt.cpan.org/Public/Bug/Display.html?id=19766
```
I would like to suggest another the inclusion of the '|' character into the escapable list. I know that the '|' has no special function while printing but it could be useful when using regexp matching. In fact, an extra function for escaping regexp reserved characters could be quite handy.

-- Filipe Garrett
Use \b word-boundary test in elide's regular expression rather than \s|\Z.
Check for possible problems in the use of printable escaping functions and list2hash. For example, are the encoded strings for hashes with high-bit characters in their keys properly unquoted and unescaped?
In string2list, quotes embedded in a word (eg: a@"!a) shouldn't cause phrase breaks.
Allow escape specifications to contain = signs and optional arguments, so that users can request certain string lengths with escape("lowercase elide=20 quoted", @_.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc String::Escape

You can also look for information at:

RT: CPAN's request tracker

http://rt.cpan.org/NoAuth/Bugs.html?Dist=String-Escape
AnnoCPAN: Annotated CPAN documentation

http://annocpan.org/dist/String-Escape
CPAN Ratings

http://cpanratings.perl.org/d/String-Escape
Search CPAN

http://search.cpan.org/dist/String-Escape/

ACKNOWLEDGEMENTS

Initial versions developed at Evolution Online Systems with Eleanor J. Evans and Jeremy G. Bishop.

LICENSE AND COPYRIGHT

You may use, modify, and distribute this software under the same terms as Perl.

See http://dev.perl.org/licenses/ for more information.

To install String::Escape, copy and paste the appropriate command in to your terminal.

cpanm

cpanm String::Escape

CPAN shell

perl -MCPAN -e shell
install String::Escape

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

SYNOPSIS

VERSION

SUBROUTINES

import / EXPORT

Quoting

Backslash Escaping Functions

Elision Function

escape()

Space-separated Lists and Hashes

PREREQUISITES AND INSTALLATION

SEE ALSO

AUTHOR

BUGS

SUPPORT

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Module Install Instructions