.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.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.  \*(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-
.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" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" 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 "Locale::RecodeData 3pm"
.TH Locale::RecodeData 3pm "2013-01-14" "perl v5.20.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Locale::RecodeData \- Abstract Base Class for Charset Converters
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 4
\&    # For compatibility with Perl 5.005 and earlier, you must
\&    # *use* the module before inheriting from it!
\&    use qw (Locale::RecodeData);
\&    use base qw (Locale::RecodeData);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The module \fBLocale::RecodeData\fR serves as an abstract base class to
all converters used by \fILocale::Recode\fR\|(3).
.PP
Adding new conversion modules is currently not straightforward, and 
you will have to edit the sources of some modules for that purpose.
.PP
First, you have to add your new converter class to the list found
in \fILocale::_Conversions\fR\|(3), so that \fILocale::Recode\fR\|(3) knows about
its presence.  If there are valid aliases for the codeset of your
converter, you will also have to edit \fILocale::_Aliases\fR\|(3).
.PP
Finally, you have to implement the (protected) conversion routine
\&\fI_recode()\fR.  See below (\*(L"\s-1INTERFACE\*(R"\s0) for details.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.IP "\fBnew (from => \s-1FROM_CODESET,\s0 to => \s-1TO_CODESET\s0)\fR" 4
.IX Item "new (from => FROM_CODESET, to => TO_CODESET)"
The constructor takes two (named) arguments:
.RS 4
.IP "\fBfrom\fR" 8
.IX Item "from"
The canonical name of the source codeset.  Aliases have already been
resolved and the name is converted to uppercase.
.IP "\fBto\fR" 8
.IX Item "to"
The canonical name of the destination codeset.  Aliases have already been
resolved and the name is converted to uppercase.
.RE
.RS 4
.Sp
You normally don't have to implement the constructor.  The default constructor
implemented here will store the source and destination codesets in the
protected members \f(CW\*(C`_from\*(C'\fR and \f(CW\*(C`_to\*(C'\fR.
.RE
.SH "METHODS"
.IX Header "METHODS"
The class implements one method:
.IP "\fB_getError\fR" 4
.IX Item "_getError"
Returns the (protected) member \f(CW\*(C`_error\*(C'\fR.
.SH "INTERFACE"
.IX Header "INTERFACE"
New conversion classes must provide the following interface:
.IP "\fBnew (from => \s-1FROM_CODESET,\s0 to => \s-1TO_CODESET\s0)\fR" 4
.IX Item "new (from => FROM_CODESET, to => TO_CODESET)"
The constructor takes two (named) arguments:
.RS 4
.IP "\fBfrom\fR" 8
.IX Item "from"
The canonical name of the source codeset.  Aliases have already been
resolved and the name is converted to uppercase.
.IP "\fBto\fR" 8
.IX Item "to"
The canonical name of the destination codeset.  Aliases have already been
resolved and the name is converted to uppercase.
.RE
.RS 4
.RE
.IP "\fB_getError\fR" 4
.IX Item "_getError"
Should return the last error (as a string) or false if there was no error.
.Sp
This method is implemented in the base class already.
.IP "\fB_recode \s-1STRINGREF\s0\fR" 4
.IX Item "_recode STRINGREF"
Should convert the argument \f(CW\*(C`STRINGREF\*(C'\fR in-place.  In case of failure,
return false, and make provisions that the method \f(CW\*(C`_getError()\*(C'\fR returns
an informative error message.
.SH "AUTHOR"
.IX Header "AUTHOR"
Copyright (C) 2002\-2013, Guido Flohr <guido@imperia.net>, all
rights reserved.  See the source code for details.
.PP
This software is contributed to the Perl community by Imperia 
(<http://www.imperia.net/>).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fILocale::Recode::_Aliases\fR\|(3pm), \fILocale::Recode::_Conversions\fR\|(3pm),
\&\fILocale::Recode\fR\|(3pm), \fIperl\fR\|(1)
.SH "POD ERRORS"
.IX Header "POD ERRORS"
Hey! \fBThe above document had some coding errors, which are explained below:\fR
.IP "Around line 178:" 4
.IX Item "Around line 178:"
=cut found outside a pod block.  Skipping to next block.