#--------------------------------------------------------------------- package Tie::CPHash; # # Copyright 1997-2008 Christopher J. Madsen # # Author: Christopher J. Madsen # Created: 08 Nov 1997 # $Id: CPHash.pm 1999 2008-04-27 01:35:25Z cjm $ # # This program is free software; you can redistribute it and/or modify # it under the same terms as Perl itself. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See either the # GNU General Public License or the Artistic License for more details. # # Case preserving but case insensitive hash #--------------------------------------------------------------------- require 5.000; use strict; #use warnings; # Wasn't core until 5.6.0 use vars qw($VERSION); #===================================================================== # Package Global Variables: $VERSION = '1.04'; #===================================================================== # Tied Methods: #--------------------------------------------------------------------- # TIEHASH classname # The method invoked by the command `tie %hash, classname'. # Associates a new hash instance with the specified class. sub TIEHASH { bless {}, $_[0]; } # end TIEHASH #--------------------------------------------------------------------- # STORE this, key, value # Store datum *value* into *key* for the tied hash *this*. sub STORE { $_[0]->{lc $_[1]} = [ $_[1], $_[2] ]; } # end STORE #--------------------------------------------------------------------- # FETCH this, key # Retrieve the datum in *key* for the tied hash *this*. sub FETCH { my $v = $_[0]->{lc $_[1]}; ($v ? $v->[1] : undef); } # end FETCH #--------------------------------------------------------------------- # FIRSTKEY this # Return the (key, value) pair for the first key in the hash. sub FIRSTKEY { my $a = scalar keys %{$_[0]}; &NEXTKEY; } # end FIRSTKEY #--------------------------------------------------------------------- # NEXTKEY this, lastkey # Return the next (key, value) pair for the hash. sub NEXTKEY { my $v = (each %{$_[0]})[1]; ($v ? $v->[0] : undef ); } # end NEXTKEY #--------------------------------------------------------------------- # SCALAR this # Return bucket usage information for the hash (0 if empty). sub SCALAR { scalar %{$_[0]}; } # end SCALAR #--------------------------------------------------------------------- # EXISTS this, key # Verify that *key* exists with the tied hash *this*. sub EXISTS { exists $_[0]->{lc $_[1]}; } # end EXISTS #--------------------------------------------------------------------- # DELETE this, key # Delete the key *key* from the tied hash *this*. # Returns the old value, or undef if it didn't exist. sub DELETE { my $v = delete $_[0]->{lc $_[1]}; ($v ? $v->[1] : undef); } # end DELETE #--------------------------------------------------------------------- # CLEAR this # Clear all values from the tied hash *this*. sub CLEAR { %{$_[0]} = (); } # end CLEAR #===================================================================== # Other Methods: #--------------------------------------------------------------------- # Return the case of KEY. sub key { my $v = $_[0]->{lc $_[1]}; ($v ? $v->[0] : undef); } #===================================================================== # Package Return Value: 1; __END__ =head1 NAME Tie::CPHash - Case preserving but case insensitive hash table =head1 VERSION This document describes version 1.04 of Tie::CPHash, released April 26, 2008. =head1 SYNOPSIS require Tie::CPHash; tie %cphash, 'Tie::CPHash'; $cphash{'Hello World'} = 'Hi there!'; printf("The key `%s' was used to store `%s'.\n", tied(%cphash)->key('HELLO WORLD'), $cphash{'HELLO world'}); =head1 DESCRIPTION The Tie::CPHash module provides a hash table that is case preserving but case insensitive. This means that $cphash{KEY} $cphash{key} $cphash{Key} $cphash{keY} all refer to the same entry. Also, the hash remembers which form of the key was last used to store the entry. The C and C functions will return the key that was used to set the value. An example should make this clear: tie %h, 'Tie::CPHash'; $h{Hello} = 'World'; print $h{HELLO}; # Prints 'World' print keys(%h); # Prints 'Hello' $h{HELLO} = 'WORLD'; print $h{hello}; # Prints 'WORLD' print keys(%h); # Prints 'HELLO' The additional C method lets you fetch the case of a specific key: # When run after the previous example, this prints 'HELLO': print tied(%h)->key('Hello'); (The C function returns the object that C<%h> is tied to.) If you need a case insensitive hash, but don't need to preserve case, just use C<$hash{lc $key}> instead of C<$hash{$key}>. This has a lot less overhead than Tie::CPHash. =head1 AUTHOR Christopher J. Madsen S<< C<< >> >> Please report any bugs or feature requests to S<< C<< >> >>, or through the web interface at L =head1 LICENSE AND COPYRIGHT Copyright 1997-2008 Christopher J. Madsen This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See L. =head1 DISCLAIMER OF WARRANTY BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. =cut