.\" Automatically generated by Pod::Man 4.11 (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 "Hash::Case 3pm"
.TH Hash::Case 3pm "2020-02-08" "perl v5.30.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"
Hash::Case \- base class for hashes with key\-casing requirements
.SH "INHERITANCE"
.IX Header "INHERITANCE"
.Vb 2
\& Hash::Case
\&   is a Tie::StdHash
\&
\& Hash::Case is extended by
\&   Hash::Case::Lower
\&   Hash::Case::Preserve
\&   Hash::Case::Upper
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 4
\& use Hash::Case::Lower;
\& tie my(%lchash), \*(AqHash::Case::Lower\*(Aq;
\& $lchash{StraNGeKeY} = 3;
\& print keys %lchash;  # strangekey
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Hash::Case is the base class for various classes which tie special
treatment for the casing of keys.  Be aware of the differences in
implementation: \f(CW\*(C`Lower\*(C'\fR and \f(CW\*(C`Upper\*(C'\fR are tied native hashes:
these hashes have no need for hidden fields or other assisting
data structured.  A case \f(CW\*(C`Preserve\*(C'\fR hash will actually create
three hashes.
.PP
The following strategies are implemented:
.IP "\(bu" 4
Hash::Case::Lower (native hash)
.Sp
Keys are always considered lower case. The internals of this
module translate any incoming key to lower case before it is used.
.IP "\(bu" 4
Hash::Case::Upper (native hash)
.Sp
Like the ::Lower, but then all keys are always translated into
upper case.  This module can be of use for some databases, which
do translate everything to capitals as well.  To avoid confusion,
you may want to have you own internal Perl hash do this as well.
.IP "\(bu" 4
Hash::Case::Preserve
.Sp
The actual casing is ignored, but not forgotten.
.SH "METHODS"
.IX Header "METHODS"
.SS "Constructors"
.IX Subsection "Constructors"
.ie n .IP "$obj\->\fBaddHashData\fR(\s-1HASH\s0)" 4
.el .IP "\f(CW$obj\fR\->\fBaddHashData\fR(\s-1HASH\s0)" 4
.IX Item "$obj->addHashData(HASH)"
Add the data of a hash (passed as reference) to the created tied hash.  The
existing values in the hash remain, the keys are adapted to the needs of the
the casing.
.ie n .IP "$obj\->\fBaddPairs\fR(\s-1PAIRS\s0)" 4
.el .IP "\f(CW$obj\fR\->\fBaddPairs\fR(\s-1PAIRS\s0)" 4
.IX Item "$obj->addPairs(PAIRS)"
Specify an even length list of alternating key and value to be stored in
the hash.
.ie n .IP "$obj\->\fBsetHash\fR(\s-1HASH\s0)" 4
.el .IP "\f(CW$obj\fR\->\fBsetHash\fR(\s-1HASH\s0)" 4
.IX Item "$obj->setHash(HASH)"
The functionality differs for native and wrapper hashes.  For native
hashes, this is the same as first clearing the hash, and then a call
to \fBaddHashData()\fR.  Wrapper hashes will use the hash you specify here
to store the data, and re-create the mapping hash.
.IP "\fBtie\fR(\s-1HASH, TIE,\s0 [\s-1VALUES,\s0] \s-1OPTIONS\s0)" 4
.IX Item "tie(HASH, TIE, [VALUES,] OPTIONS)"
Tie the \s-1HASH\s0 with the \s-1TIE\s0 package which extends Hash::Case.  The \s-1OPTIONS\s0
differ per implementation: read the manual page for the package you actually
use.  The \s-1VALUES\s0 is a reference to an array containing key-value pairs,
or a reference to a hash: they fill the initial hash.
.Sp
example:
.Sp
.Vb 4
\& my %x;
\& tie %x, \*(AqHash::Case::Lower\*(Aq;
\& $x{Upper} = 3;
\& print keys %x;       # \*(Aqupper\*(Aq
\&
\& my @y = (ABC => 3, DeF => 4);
\& tie %x, \*(AqHash::Case::Lower\*(Aq, \e@y;
\& print keys %x;       # \*(Aqabc\*(Aq \*(Aqdef\*(Aq
\&
\& my %z = (ABC => 3, DeF => 4);
\& tie %x, \*(AqHash::Case::Lower\*(Aq, \e%z;
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This module is part of Hash-Case distribution version 1.05,
built on February 06, 2020. Website: \fIhttp://perl.overmeer.net/CPAN/\fR
.SH "LICENSE"
.IX Header "LICENSE"
Copyrights 2002\-2020 by [Mark Overmeer <markov@cpan.org>]. For other contributors see ChangeLog.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See \fIhttp://dev.perl.org/licenses/\fR