lib/Variable/Magic.pm

   1 package Variable::Magic;
   2
   3 use 5.007003;
   4
   5 use strict;
   6 use warnings;
   7
   8 use Carp qw/croak/;
   9
  10 =head1 NAME
  11
  12 Variable::Magic - Associate user-defined magic to variables from Perl.
  13
  14 =head1 VERSION
  15
  16 Version 0.06
  17
  18 =cut
  19
  20 our $VERSION = '0.06';
  21
  22 =head1 SYNOPSIS
  23
  24     use Variable::Magic qw/wizard cast dispell/;
  25
  26     my $wiz = wizard set => sub { print STDERR "now set to ${$_[0]}!\n" };
  27     my $a = 1;
  28     cast $a, $wiz;
  29     $a = 2;          # "now set to 2!"
  30     dispell $a, $wiz;
  31     $a = 3           # (nothing)
  32
  33 =head1 DESCRIPTION
  34
  35 Magic is Perl way of enhancing objects. This mechanism let the user add extra data to any variable and overload syntaxical operations (such as access, assignation or destruction) that can be applied to it. With this module, you can add your own magic to any variable without the pain of the C API.
  36
  37 The operations that can be overloaded are :
  38
  39 =over 4
  40
  41 =item C<get>
  42
  43 This magic is invoked when the variable is evaluated (does not include array/hash subscripts and slices).
  44
  45 =item C<set>
  46
  47 This one is triggered each time the value of the variable changes (includes array/hash subscripts and slices).
  48
  49 =item C<len>
  50
  51 This magic is a little special : it is called when the 'size' or the 'length' of the variable has to be known by Perl. Typically, it's the magic involved when an array is evaluated in scalar context, but also on array assignation and loops (C<for>, C<map> or C<grep>). The callback has then to return the length as an integer.
  52
  53 =item C<clear>
  54
  55 This magic is invoked when the variable is reset, such as when an array is emptied. Please note that this is different from undefining the variable, even though the magic is called when the clearing is a result of the undefine (e.g. for an array, but actually a bug prevent it to work before perl 5.9.5 - see the L<history|/PERL MAGIC HISTORY>).
  56
  57 =item C<free>
  58
  59 This last one can be considered as an object destructor. It happens when the variable goes out of scope (with the exception of global scope), but not when it is undefined.
  60
  61 =back
  62
  63 To prevent any clash between different magics defined with this module, an unique numerical signature is attached to each kind of magic (i.e. each set of callbacks for magic operations).
  64
  65 =head1 PERL MAGIC HISTORY
  66
  67 The places where magic is invoked have changed a bit through perl history. Here's a little list of the most recent ones.
  68
  69 =head2 B<5.9.3>
  70
  71 =over 4
  72
  73 =item 'len' magic is no longer called when pushing an element into a magic array.
  74
  75 =back
  76
  77 =head2 B<5.9.5>
  78
  79 =over 4
  80
  81 =item 'clear' magic wasn't invoked when undefining an array. The bug is fixed as of this version.
  82
  83 =back
  84
  85 =head1 CONSTANTS
  86
  87 =head2 C<SIG_MIN>
  88
  89 The minimum integer used as a signature for user-defined magic.
  90
  91 =head2 C<SIG_MAX>
  92
  93 The maximum integer used as a signature for user-defined magic.
  94
  95 =head2 C<SIG_NBR>
  96
  97     SIG_NBR = SIG_MAX - SIG_MIN + 1
  98
  99 =head1 FUNCTIONS
 100
 101 =cut
 102
 103 use XSLoader;
 104
 105 XSLoader::load __PACKAGE__, $VERSION;
 106
 107 =head2 C<wizard>
 108
 109     wizard sig => .., data => ..., get => .., set => .., len => .., clear => .., free => ..
 110
 111 This function creates a 'wizard', an opaque type that holds the magic information. It takes a list of keys / values as argument, whose keys can be :
 112
 113 =over 4
 114
 115 =item C<'sig'>
 116
 117 The numerical signature. If not specified or undefined, a random signature is generated. If the signature matches an already defined magic, then the existant magic object is returned.
 118
 119 =item C<'data'>
 120
 121 A code reference to a private data constructor. It is called each time this magic is cast on a variable, and the scalar returned is used as private data storage for it. C<$_[0]> is a reference to the magic object and C<@_[1 .. @_-1]> are all extra arguments that were passed to L</cast>.
 122
 123 =item C<'get'>, C<'set'>, C<'len'>, C<'clear'> and C<'free'>
 124
 125 Code references to corresponding magic callbacks. You don't have to specify all of them : the magic associated with undefined entries simply won't be hooked. In those callbacks, C<$_[0]> is a reference to the magic object and C<$_[1]> is the private data (or C<undef> when no private data constructor was supplied). In the special case of C<len> magic and when the variable is an array, C<$_[2]> contains its normal length.
 126
 127 =back
 128
 129     # A simple scalar tracer
 130     my $wiz = wizard get  => sub { print STDERR "got ${$_[0]}\n" },
 131                      set  => sub { print STDERR "set to ${$_[0]}\n" },
 132                      free => sub { print STDERR "${$_[0]} was deleted\n" }
 133
 134 =cut
 135
 136 sub wizard {
 137  croak 'Wrong number of arguments for wizard()' if @_ % 2;
 138  my %opts = @_;
 139  return _wizard(map { $opts{$_} } qw/sig get set len clear free data/);
 140 }
 141
 142 =head2 C<gensig>
 143
 144 With this tool, you can manually generate random magic signature between SIG_MIN and SIG_MAX inclusive. That's the way L</wizard> creates them when no signature is supplied.
 145
 146     # Generate a signature
 147     my $sig = gensig;
 148
 149 =head2 C<getsig>
 150
 151     getsig $wiz
 152
 153 This accessor returns the magic signature of this wizard.
 154
 155     # Get $wiz signature
 156     my $sig = getsig $wiz;
 157
 158 =head2 C<cast>
 159
 160     cast [$@%&*]var, [$wiz|$sig], ...
 161
 162 This function associates C<$wiz> magic to the variable supplied, without overwriting any other kind of magic. You can also supply the numeric signature C<$sig> instead of C<$wiz>. It returns true on success or when C<$wiz> magic is already present, C<0> on error, and C<undef> when no magic corresponds to the given signature (in case C<$sig> was supplied). All extra arguments specified after C<$wiz> are passed to the private data constructor.
 163
 164     # Casts $wiz onto $x. If $wiz isn't a signature, undef can't be returned.
 165     my $x;
 166     die 'error' unless cast $x, $wiz;
 167
 168 =head2 C<getdata>
 169
 170     getdata [$@%&*]var, [$wiz|$sig]
 171
 172 This accessor fetches the private data associated with the magic C<$wiz> (or the signature C<$sig>) in the variable. C<undef> is returned when no such magic or data is found, or when C<$sig> does not represent a current valid magic object.
 173
 174     # Get the attached data.
 175     my $data = getdata $x, $wiz or die 'no such magic or magic has no data';
 176
 177 =head2 C<dispell>
 178
 179     dispell [$@%&*]variable, [$wiz|$sig]
 180
 181 The exact opposite of L</cast> : it dissociates C<$wiz> magic from the variable. You can also pass the magic signature C<$sig> as the second argument. True is returned on success, C<0> on error or when no magic represented by C<$wiz> could be found in the variable, and C<undef> when no magic corresponds to the given signature (in case C<$sig> was supplied).
 182
 183     # Dispell now. If $wiz isn't a signature, undef can't be returned.
 184     die 'no such magic or error' unless dispell $x, $wiz;
 185
 186 =head1 EXPORT
 187
 188 The functions L</wizard>, L</gensig>, L</getsig>, L</cast>, L</getdata> and L</dispell> are only exported on request. All of them are exported by the tags C<':funcs'> and C<':all'>.
 189
 190 The constants L</SIG_MIN>, L</SIG_MAX> and L</SIG_NBR> are also only exported on request. They are all exported by the tags C<':consts'> and C<':all'>.
 191
 192 =cut
 193
 194 use base qw/Exporter/;
 195
 196 our @EXPORT         = ();
 197 our %EXPORT_TAGS    = (
 198  'funcs' =>  [ qw/wizard gensig getsig cast getdata dispell/ ],
 199  'consts' => [ qw/SIG_MIN SIG_MAX SIG_NBR/ ]
 200 );
 201 our @EXPORT_OK      = map { @$_ } values %EXPORT_TAGS;
 202 $EXPORT_TAGS{'all'} = \@EXPORT_OK;
 203
 204 =head1 DEPENDENCIES
 205
 206 L<perl> 5.7.3.
 207
 208 L<Carp> (standard since perl 5), L<XSLoader> (standard since perl 5.006).
 209
 210 Glob tests need L<Symbol> (standard since perl 5.002).
 211
 212 =head1 SEE ALSO
 213
 214 L<perlguts> and L<perlapi> for internal information about magic.
 215
 216 =head1 AUTHOR
 217
 218 Vincent Pit, C<< <perl at profvince.com> >>
 219
 220 You can contact me by mail or on #perl @ FreeNode (Prof_Vince).
 221
 222 =head1 BUGS
 223
 224 Please report any bugs or feature requests to
 225 C<bug-variable-magic at rt.cpan.org>, or through the web interface at
 226 L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Variable-Magic>.
 227 I will be notified, and then you'll automatically be notified of progress on
 228 your bug as I make changes.
 229
 230 =head1 SUPPORT
 231
 232 You can find documentation for this module with the perldoc command.
 233
 234     perldoc Variable::Magic
 235
 236 =head1 COPYRIGHT & LICENSE
 237
 238 Copyright 2007 Vincent Pit, all rights reserved.
 239
 240 This program is free software; you can redistribute it and/or modify it
 241 under the same terms as Perl itself.
 242
 243 =cut
 244
 245 1; # End of Variable::Magic