.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" 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 >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 "MARC::Charset::Table 3pm"
.TH MARC::Charset::Table 3pm "2019-03-17" "perl v5.28.1" "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"
MARC::Charset::Table \- character mapping db
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    use MARC::Charset::Table;
\&    use MARC::Charset::Constants qw(:all);
\&
\&    # create the table object
\&    my $table = MARC::Charset::Table\->new();
\&   
\&    # get a code using the marc8 character set code and the character
\&    my $code = $table\->lookup_by_marc8(CYRILLIC_BASIC, \*(AqK\*(Aq);
\&
\&    # get a code using the utf8 value
\&    $code = $table\->lookup_by_utf8(chr(0x043A));
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
MARC::Charset::Table is a wrapper around the character mapping database, 
which is implemented as a tied hash on disk. This database gets generated 
by Makefile.PL on installation of MARC::Charset using 
MARC::Charset::Compiler.
.PP
The database is essentially a key/value mapping where a key is a 
\&\s-1MARC\-8\s0 character set code + a \s-1MARC\-8\s0 character, or an integer representing the
\&\s-1UCS\s0 code point. These keys map to a serialized MARC::Charset::Code object.
.SS "\fBnew()\fP"
.IX Subsection "new()"
The consturctor.
.SS "\fBadd_code()\fP"
.IX Subsection "add_code()"
Add a MARC::Charset::Code to the table.
.SS "\fBget_code()\fP"
.IX Subsection "get_code()"
Retrieve a code using a hash key.
.SS "\fBlookup_by_marc8()\fP"
.IX Subsection "lookup_by_marc8()"
Looks up MARC::Charset::Code entry using a character set code and a \s-1MARC\-8\s0 
value.
.PP
.Vb 2
\&    use MARC::Charset::Constants qw(HEBREW);
\&    $code = $table\->lookup_by_marc8(HEBREW, chr(0x60));
.Ve
.SS "\fBlookup_by_utf8()\fP"
.IX Subsection "lookup_by_utf8()"
Looks up a MARC::Charset::Code object using a utf8 value.
.SS "\fBdb()\fP"
.IX Subsection "db()"
Returns a reference to a tied character database. MARC::Charset::Table
wraps access to the db, but you can get at it if you want.
.SS "\fBdb_path()\fP"
.IX Subsection "db_path()"
Returns the path to the character encoding database. Can be called 
statically too:
.PP
.Vb 1
\&    print MARC::Charset::Table\->db_path();
.Ve
.SS "\fBbrand_new()\fP"
.IX Subsection "brand_new()"
An alternate constructor which removes the existing database and starts
afresh. Be careful with this one, it's really only used on MARC::Charset
installation.