.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 >0, 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
.\" ========================================================================
.\"
.IX Title "Locale::RecodeData 3"
.TH Locale::RecodeData 3 2023-07-25 "perl v5.38.0" "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 \fBLocale::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 \fBLocale::_Conversions\fR\|(3), so that \fBLocale::Recode\fR\|(3) knows about
its presence.  If there are valid aliases for the codeset of your
converter, you will also have to edit \fBLocale::_Aliases\fR\|(3).
.PP
Finally, you have to implement the (protected) conversion routine
\&\fB_recode()\fR.  See below ("INTERFACE") for details.
.SH CONSTRUCTOR
.IX Header "CONSTRUCTOR"
.IP "\fBnew (from => FROM_CODESET, to => TO_CODESET)\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 => FROM_CODESET, to => TO_CODESET)\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 STRINGREF\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_getError()\fR returns
an informative error message.
.SH AUTHOR
.IX Header "AUTHOR"
Copyright (C) 2002\-2017 Guido Flohr <http://www.guido-flohr.net/>
(<mailto:guido.flohr@cantanea.com>), all rights reserved.  See the source
code for details!code for details!
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBLocale::Recode::_Aliases\fR\|(3pm), \fBLocale::Recode::_Conversions\fR\|(3pm),
\&\fBLocale::Recode\fR\|(3pm), \fBperl\fR\|(1)