Hash/RecordKeys.pm

   1 # $Id$
   2 # Hash tied to record all the accessed keys.
   3 # Copyright (C) 2005 Jan Kratochvil <project-www.jankratochvil.net@jankratochvil.net>
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; exactly version 2 of June 1991 is required
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License
  15 # along with this program; if not, write to the Free Software
  16 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17
  18
  19 package My::Hash::RecordKeys;
  20 our $VERSION=do { my @r=(q$Revision$=~/\d+/g); sprintf "%d.".("%03d"x$#r),@r; };
  21 our $CVS_ID=q$Id$;
  22 use strict;
  23 use warnings;
  24 use My::Web;    # for &Wrequire
  25 Wrequire 'My::Hash';
  26 our @ISA=qw(My::Hash);
  27 use Carp qw(cluck confess);
  28
  29
  30 sub TIEHASH($$)
  31 {
  32 my($class,$parent)=@_;
  33
  34         my $self=$class->SUPER::TIEHASH($parent);
  35         $self->{"keyshash"}={};
  36         return $self;
  37 }
  38
  39 # Call as: my @accessed=tied(%$ref)->accessed();
  40 sub accessed($)
  41 {
  42 my($self)=@_;
  43
  44         return keys(%{$self->{"keyshash"}})
  45 }
  46
  47 sub STORE($$$)
  48 {
  49 my($this,$key,$value)=@_;
  50
  51         $this->{"keyshash"}{$key}=1;
  52         return $this->pass("STORE",$key,$value);
  53 }
  54
  55 sub FETCH($$)
  56 {
  57 my($this,$key)=@_;
  58
  59         $this->{"keyshash"}{$key}=1;
  60         return $this->pass("FETCH",$key);
  61 }
  62
  63 sub FIRSTKEY($)
  64 {
  65 my($this)=@_;
  66
  67         my $a=keys(%{$this->{"parent"}});
  68         return $this->NEXTKEY($this,undef());
  69 }
  70
  71 sub NEXTKEY($$)
  72 {
  73 my($this,$lastkey)=@_;
  74
  75 cluck "TODO: Enumeration may not be expected.";
  76         for (;;) {
  77                 my $key=each(%{$this->{"parent"}});
  78                 return if !defined $key;
  79                 $this->{"keyshash"}{$key}=1;
  80                 return $key
  81                 }
  82 }
  83
  84 sub EXISTS($$)
  85 {
  86 my($this,$key)=@_;
  87
  88         $this->{"keyshash"}{$key}=1;
  89         return $this->pass("EXISTS",$key);
  90 }
  91
  92 sub DELETE($$)
  93 {
  94 my($this,$key)=@_;
  95
  96         $this->{"keyshash"}{$key}=1;
  97         return $this->pass("DELETE",$key);
  98 }
  99
 100 sub CLEAR($)
 101 {
 102 my($this)=@_;
 103
 104 confess "TODO: Not implementable.";
 105 }
 106
 107 sub SCALAR
 108 {
 109 my($this)=@_;
 110
 111 confess "TODO: Not yet implemented.";
 112 }
 113
 114 1;