Initial commit of OpenSPARC T2 design and verification files.

[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man3 / Encode::Encoder.3

.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Encode::Encoder 3"
.TH Encode::Encoder 3 "2002-06-01" "perl v5.8.0" "Perl Programmers Reference Guide"
.SH "NAME"
Encode::Encoder \-\- Object Oriented Encoder
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 14
\&  use Encode::Encoder;
\&  # Encode::encode("ISO-8859-1", $data); 
\&  Encode::Encoder->new($data)->iso_8859_1; # OOP way
\&  # shortcut
\&  use Encode::Encoder qw(encoder);
\&  encoder($data)->iso_8859_1;
\&  # you can stack them!
\&  encoder($data)->iso_8859_1->base64;  # provided base64() is defined
\&  # you can use it as a decoder as well
\&  encoder($base64)->bytes('base64')->latin1;
\&  # stringified
\&  print encoder($data)->utf8->latin1;  # prints the string in latin1
\&  # numified
\&  encoder("\ex{abcd}\ex{ef}g")->utf8 == 6; # true. bytes::length($data)
.Ve
.SH "ABSTRACT"
.IX Header "ABSTRACT"
\&\fBEncode::Encoder\fR allows you to use Encode in an object-oriented
style.  This is not only more intuitive than a functional approach,
but also handier when you want to stack encodings.  Suppose you want
your \s-1UTF\-8\s0 string converted to Latin1 then Base64: you can simply say
.PP
.Vb 1
\&  my $base64 = encoder($utf8)->latin1->base64;
.Ve
.PP
instead of
.PP
.Vb 2
\&  my $latin1 = encode("latin1", $utf8);
\&  my $base64 = encode_base64($utf8);
.Ve
.PP
or the lazier and more convoluted
.PP
.Vb 1
\&  my $base64 = encode_base64(encode("latin1", $utf8));
.Ve
.SH "Description"
.IX Header "Description"
Here is how to use this module.
.IP "\(bu" 4
There are at least two instance variables stored in a hash reference,
{data} and {encoding}.
.IP "\(bu" 4
When there is no method, it takes the method name as the name of the
encoding and encodes the instance \fIdata\fR with \fIencoding\fR.  If successful,
the instance \fIencoding\fR is set accordingly.
.IP "\(bu" 4
You can retrieve the result via \->data but usually you don't have to 
because the stringify operator ("") is overridden to do exactly that.
.Sh "Predefined Methods"
.IX Subsection "Predefined Methods"
This module predefines the methods below:
.ie n .IP "$e = Encode::Encoder\->new([$data, $encoding]);" 4
.el .IP "$e = Encode::Encoder\->new([$data, \f(CW$encoding\fR]);" 4
.IX Item "$e = Encode::Encoder->new([$data, $encoding]);"
returns an encoder object.  Its data is initialized with \f(CW$data\fR if
present, and its encoding is set to \f(CW$encoding\fR if present.
.Sp
When \f(CW$encoding\fR is omitted, it defaults to utf8 if \f(CW$data\fR is already in
utf8 or "" (empty string) otherwise.
.IP "\fIencoder()\fR" 4
.IX Item "encoder()"
is an alias of Encode::Encoder\->\fInew()\fR.  This one is exported on demand.
.IP "$e\->data([$data])" 4
.IX Item "$e->data([$data])"
When \f(CW$data\fR is present, sets the instance data to \f(CW$data\fR and returns the
object itself.  Otherwise, the current instance data is returned.
.IP "$e\->encoding([$encoding])" 4
.IX Item "$e->encoding([$encoding])"
When \f(CW$encoding\fR is present, sets the instance encoding to \f(CW$encoding\fR and
returns the object itself.  Otherwise, the current instance encoding is
returned.
.IP "$e\->bytes([$encoding])" 4
.IX Item "$e->bytes([$encoding])"
decodes instance data from \f(CW$encoding\fR, or the instance encoding if
omitted.  If the conversion is successful, the instance encoding
will be set to "".
.Sp
The name \fIbytes\fR was deliberately picked to avoid namespace tainting
\&\*(-- this module may be used as a base class so method names that appear
in Encode::Encoding are avoided.
.Sh "Example: base64 transcoder"
.IX Subsection "Example: base64 transcoder"
This module is designed to work with Encode::Encoding.
To make the Base64 transcoder example above really work, you could
write a module like this:
.PP
.Vb 14
\&  package Encode::Base64;
\&  use base 'Encode::Encoding';
\&  __PACKAGE__->Define('base64');
\&  use MIME::Base64;
\&  sub encode{ 
\&      my ($obj, $data) = @_; 
\&      return encode_base64($data);
\&  }
\&  sub decode{
\&      my ($obj, $data) = @_; 
\&      return decode_base64($data);
\&  }
\&  1;
\&  __END__
.Ve
.PP
And your caller module would be something like this:
.PP
.Vb 2
\&  use Encode::Encoder;
\&  use Encode::Base64;
.Ve
.PP
.Vb 1
\&  # now you can really do the following
.Ve
.PP
.Vb 2
\&  encoder($data)->iso_8859_1->base64;
\&  encoder($base64)->bytes('base64')->latin1;
.Ve
.Sh "Operator Overloading"
.IX Subsection "Operator Overloading"
This module overloads two operators, stringify ("") and numify (0+).
.PP
Stringify dumps the data inside the object.
.PP
Numify returns the number of bytes in the instance data.
.PP
They come in handy when you want to print or find the size of data.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Encode,
Encode::Encoding