.\" 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::Code 3pm"
.TH MARC::Charset::Code 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::Code \- represents a MARC\-8/UTF\-8 mapping
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Each mapping from a \s-1MARC\-8\s0 value to a \s-1UTF\-8\s0 value is represented by 
a MARC::Charset::Code object in a MARC::Charset::Table.
.SH "METHODS"
.IX Header "METHODS"
.SS "\fBnew()\fP"
.IX Subsection "new()"
The constructor.
.SS "\fBname()\fP"
.IX Subsection "name()"
A descriptive name for the code point.
.SS "\fBmarc()\fP"
.IX Subsection "marc()"
A string representing the \s-1MARC\-8\s0 bytes codes.
.SS "\fBucs()\fP"
.IX Subsection "ucs()"
A string representing the \s-1UCS\s0 code point in hex.
.SS "\fBcharset_code()\fP"
.IX Subsection "charset_code()"
The \s-1MARC\-8\s0 character set code.
.SS "\fBis_combining()\fP"
.IX Subsection "is_combining()"
Returns true/false to tell if the character is a combining character.
.SS "\fBmarc_left_half()\fP"
.IX Subsection "marc_left_half()"
If the character is the right half of a \*(L"double diacritic\*(R", returns
a hex string representing the \s-1MARC\-8\s0 value of the left half.
.SS "\fBmarc_right_half()\fP"
.IX Subsection "marc_right_half()"
If the character is the left half of a \*(L"double diacritic\*(R", returns
a hex string representing the \s-1MARC\-8\s0 value of the right half.
.SS "\fBto_string()\fP"
.IX Subsection "to_string()"
A stringified version of the object suitable for pretty printing.
.SS "\fBchar_value()\fP"
.IX Subsection "char_value()"
Returns the unicode character. Essentially just a helper around
\&\fBucs()\fR.
.SS "\fBg0_marc_value()\fP"
.IX Subsection "g0_marc_value()"
The string representing the \s-1MARC\-8\s0 encoding
for lookup.
.SS "\fBmarc_value()\fP"
.IX Subsection "marc_value()"
The string representing the \s-1MARC\-8\s0 encodingA
for output.
.SS "\fBcharset_name()\fP"
.IX Subsection "charset_name()"
Returns the name of the character set, instead of the code.
.SS "\fBto_string()\fP"
.IX Subsection "to_string()"
Returns a stringified version of the object.
.SS "\fBmarc8_hash_code()\fP"
.IX Subsection "marc8_hash_code()"
Returns a hash code for this Code object for looking up the object using
\&\s-1MARC8.\s0 First portion is the character set code and the second is the 
\&\s-1MARC\-8\s0 value.
.SS "\fButf8_hash_code()\fP"
.IX Subsection "utf8_hash_code()"
Returns a hash code for uniquely identifying a Code by it's \s-1UCS\s0 value.
.SS "default_charset_group"
.IX Subsection "default_charset_group"
Returns 'G0' or 'G1' indicating where the character is typicalling used 
in the \s-1MARC\-8\s0 environment.
.SS "get_marc8_escape"
.IX Subsection "get_marc8_escape"
Returns an escape sequence to move to the Code from another marc\-8 character
set.
.SS "charset_value"
.IX Subsection "charset_value"
Returns the charset value, not the hex sequence.