number::recordlocator(3pm) [debian man page]

Number::RecordLocator(3pm)				User Contributed Perl Documentation				Number::RecordLocator(3pm)

NAME

       Number::RecordLocator - Encodes integers into a short and easy to read and pronounce "locator string"

SYNOPSIS

	   use Number::RecordLocator;

	   my $generator = Number::RecordLocator->new();
	   my $string = $generator->encode("123456");

	   # $string = "5RL2";

	   my $number = $generator->decode($string);

	   # $number = "123456";

DESCRIPTION

       "Number::RecordLocator" encodes integers into a 32 character "alphabet" designed to be short and easy to read and pronounce.  The encoding
       maps:

	   0 to O
	   1 to I
	   S to F
	   B to P

       With a 32 bit encoding, you can map 33.5 million unique ids into a 5 character code.

       This certainly isn't an exact science and I'm not yet 100% sure of the encoding.  Feedback is much appreciated.

   new
       Instantiate a new "Number::RecordLocator" object. Right now, we don't actually store any object-specific data, but in the future, we might.

   init
       Initializes our integer to character and character to integer mapping tables.

   encode INTEGER
       Takes an integer. Returns a Record Locator string.

   decode STRING
       Takes a record locator string and returns an integer. If you pass in a string containing an invalid character, it returns undef.

   canonicalize STRING
       To compare a Record Locator string with another you can do:

	 print "ALWAYS TRUE
" if $generator->decode("B0") == $generator->decode("PO");

       However, this method provides an alternative:

	 my $rl_string = $generator->encode(725);
	 print "ALWAYS TRUE
" if $generator->canonicalize("b0") eq $rl_string;
	 print "ALWAYS TRUE
" if $generator->canonicalize("BO") eq $rl_string;
	 print "ALWAYS TRUE
" if $generator->canonicalize("P0") eq $rl_string;
	 print "ALWAYS TRUE
" if $generator->canonicalize("po") eq $rl_string;

       This is primarily useful if you store the record locator rather than just the original integer and don't want to have to decode your
       strings to do comparisons.

       Takes a general Record Locator string and returns one with character mappings listed in "DESCRIPTION" applied to it. This allows string
       comparisons to work.  This returns "undef" if a non-alphanumeric character is found in the string.

BUGS AND LIMITATIONS

       No bugs have been reported.

       Please report any bugs or feature requests to "bug-number-recordlocator@rt.cpan.org", or through the web interface at <http://rt.cpan.org>.

AUTHOR

       Jesse Vincent  "<jesse@bestpractical.com>"

LICENCE AND COPYRIGHT

       Copyright (c) 2006, Best Practical Solutions, LLC.  All rights reserved.

       This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

perl v5.10.0							    2009-08-13						Number::RecordLocator(3pm)

MIME::QuotedPrint(3pm)					 Perl Programmers Reference Guide				    MIME::QuotedPrint(3pm)

NAME

       MIME::QuotedPrint - Encoding and decoding of quoted-printable strings

SYNOPSIS

	use MIME::QuotedPrint;

	$encoded = encode_qp($decoded);
	$decoded = decode_qp($encoded);

DESCRIPTION

       This module provides functions to encode and decode strings into and from the quoted-printable encoding specified in RFC 2045 - MIME
       (Multipurpose Internet Mail Extensions).  The quoted-printable encoding is intended to represent data that largely consists of bytes that
       correspond to printable characters in the ASCII character set.  Each non-printable character (as defined by English Americans) is
       represented by a triplet consisting of the character "=" followed by two hexadecimal digits.

       The following functions are provided:

       encode_qp( $str)
       encode_qp( $str, $eol)
       encode_qp( $str, $eol, $binmode )
	   This function returns an encoded version of the string ($str) given as argument.

	   The second argument ($eol) is the line-ending sequence to use.  It is optional and defaults to "
".  Every occurrence of "
" is
	   replaced with this string, and it is also used for additional "soft line breaks" to ensure that no line end up longer than 76
	   characters.	Pass it as "1512" to produce data suitable for external consumption.  The string "
" produces the same result on
	   many platforms, but not all.

	   The third argument ($binmode) will select binary mode if passed as a TRUE value.  In binary mode "
" will be encoded in the same way
	   as any other non-printable character.  This ensures that a decoder will end up with exactly the same string whatever line ending
	   sequence it uses.  In general it is preferable to use the base64 encoding for binary data; see MIME::Base64.

	   An $eol of "" (the empty string) is special.  In this case, no "soft line breaks" are introduced and binary mode is effectively enabled
	   so that any "
" in the original data is encoded as well.

       decode_qp( $str )
	   This function returns the plain text version of the string given as argument.  The lines of the result are "
" terminated, even if the
	   $str argument contains "
" terminated lines.

       If you prefer not to import these routines into your namespace, you can call them as:

	 use MIME::QuotedPrint ();
	 $encoded = MIME::QuotedPrint::encode($decoded);
	 $decoded = MIME::QuotedPrint::decode($encoded);

       Perl v5.8 and better allow extended Unicode characters in strings.  Such strings cannot be encoded directly, as the quoted-printable
       encoding is only defined for single-byte characters.  The solution is to use the Encode module to select the byte encoding you want.  For
       example:

	   use MIME::QuotedPrint qw(encode_qp);
	   use Encode qw(encode);

	   $encoded = encode_qp(encode("UTF-8", "x{FFFF}
"));
	   print $encoded;

COPYRIGHT

       Copyright 1995-1997,2002-2004 Gisle Aas.

       This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO

       MIME::Base64

perl v5.18.2							    2013-11-04						    MIME::QuotedPrint(3pm)