.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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" ''
'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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" 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 "Hash::WithDefaults 3pm"
.TH Hash::WithDefaults 3pm "2012-05-26" "perl v5.14.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"
Hash::WithDefaults \- class for hashes with key\-casing requirements supporting defaults
.PP
version 0.05
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Hash::WithDefaults;
\&
\&  %main = ( ... );
\&  tie %h1, \*(AqHash::WithDefaults\*(Aq, {...};
\&  tied(%h1)\->AddDefault(\e%main);
\&  tie %h2, \*(AqHash::WithDefaults\*(Aq, [...];
\&  tied(%h2)\->AddDefault(\e%main);
\&
\&  # now if you use $h1{$key}, the value is looked up first
\&  # in %h1, then in %main.
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module implements hashes that support \*(L"defaults\*(R". That is you may specify
several more hashes in which the data will be looked up in case it is not found in
the current hash.
.SS "Object creation"
.IX Subsection "Object creation"
.Vb 3
\&        tie %hash, \*(AqHash::WithDefault\*(Aq, [$case_option], [\e%values];
\&        tie %hash, \*(AqHash::WithDefault\*(Aq, [$case_option], [\e@values];
\&        tie %hash, \*(AqHash::WithDefault\*(Aq, [$case_option], [%values];
.Ve
.PP
The optional \f(CW$case_option\fR may be one of these values:
.PP
.Vb 6
\&  Sensitive     \- the hash will be case sensitive
\&  Tolower       \- the hash will be case sensitive, all keys are made lowercase
\&  Toupper       \- the hash will be case sensitive, all keys are made uppercase
\&  Preserve      \- the hash will be case insensitive, the case is preserved
\&  Lower \- the hash will be case insensitive, all keys are made lowercase
\&  Upper \- the hash will be case insensitive, all keys are made uppercase
.Ve
.PP
If you pass a hash or array reference or an even list of keys and values to the \fItie()\fR function,
those keys and values will be \s-1COPIED\s0 to the resulting magical hash!
.PP
After you \fItie()\fR the hash, you use it just like any other hash.
.SS "Functions"
.IX Subsection "Functions"
\fIAddDefault\fR
.IX Subsection "AddDefault"
.PP
.Vb 1
\&        tied(%hash)\->AddDefault(\e%defaults);
.Ve
.PP
This instructs the object to include the \f(CW%defaults\fR in the search for values.
After this the value will be looked up first in \f(CW%hash\fR itself and then in \f(CW%defaults\fR.
.PP
You may keep modifying the \f(CW%defaults\fR and your changes \s-1WILL\s0 be visible through \f(CW%hash\fR!
.PP
You may add as many defaults to one Hash::WithDefaults object as you like, they will be searched
in the order you add them.
.PP
If you delete a key from the tied hash, it's only deleted from the list of specific keys, the defaults
are never modified through the tied hash. This means that you may get a default value for a key
after you deletethe key from the tied hash!
.PP
\fIGetDefaults\fR
.IX Subsection "GetDefaults"
.PP
.Vb 2
\&        $defaults = tied(%hash)\->GetDefaults();
\&        push @$defaults, \e%another_default;
.Ve
.PP
Returns a reference to the array that stores the defaults.
You may delete or insert hash references into the array, but make sure you
\&\s-1NEVER\s0 \s-1EVER\s0 insert anything else than a hash reference into the array!
.SS "Config::IniHash example"
.IX Subsection "Config::IniHash example"
.Vb 2
\&  use Config::IniHash;
\&  $config = ReadIni $inifile, withdefaults => 1, case => \*(Aqpreserve\*(Aq;
\&
\&  if (exists $config\->{\*(Aq:default\*(Aq}) {
\&    my $default = $config\->{\*(Aq:default\*(Aq};
\&    foreach my $section (keys %$config) {
\&      next if $section =~ /^:/;
\&          tied(%{$config\->{$section}})\->AddDefault($default)
\&    }
\&  }
.Ve
.PP
And now all normal sections will get the default values from [:default] section ;\-)
.SH "AUTHOR"
.IX Header "AUTHOR"
Jan Krynicky <Jenda@Krynicky.cz>
http://Jenda.Krynicky.cz
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2002\-2009 Jan Krynicky <Jenda@Krynicky.cz>. All rights reserved.
.PP
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.