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.07_01
  17
  18 =cut
  19
  20 use vars qw/$VERSION/;
  21
  22 BEGIN {
  23  $VERSION = '0.07_01';
  24 }
  25
  26 =head1 SYNOPSIS
  27
  28     use Variable::Magic qw/wizard cast dispell/;
  29
  30     my $wiz = wizard set => sub { print STDERR "now set to ${$_[0]}!\n" };
  31     my $a = 1;
  32     cast $a, $wiz;
  33     $a = 2;          # "now set to 2!"
  34     dispell $a, $wiz;
  35     $a = 3           # (nothing)
  36
  37 =head1 DESCRIPTION
  38
  39 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.
  40
  41 The operations that can be overloaded are :
  42
  43 =over 4
  44
  45 =item C<get>
  46
  47 This magic is invoked when the variable is evaluated (does not include array/hash subscripts and slices).
  48
  49 =item C<set>
  50
  51 This one is triggered each time the value of the variable changes (includes array/hash subscripts and slices).
  52
  53 =item C<len>
  54
  55 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.
  56
  57 =item C<clear>
  58
  59 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>).
  60
  61 =item C<free>
  62
  63 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.
  64
  65 =back
  66
  67 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).
  68
  69 =head1 PERL MAGIC HISTORY
  70
  71 The places where magic is invoked have changed a bit through perl history. Here's a little list of the most recent ones.
  72
  73 =head2 B<5.9.3>
  74
  75 =over 4
  76
  77 =item 'len' magic is no longer called when pushing an element into a magic array.
  78
  79 =back
  80
  81 =head2 B<5.9.5>
  82
  83 =over 4
  84
  85 =item 'clear' magic wasn't invoked when undefining an array. The bug is fixed as of this version.
  86
  87 =back
  88
  89 =head1 CONSTANTS
  90
  91 =head2 C<SIG_MIN>
  92
  93 The minimum integer used as a signature for user-defined magic.
  94
  95 =head2 C<SIG_MAX>
  96
  97 The maximum integer used as a signature for user-defined magic.
  98
  99 =head2 C<SIG_NBR>
 100
 101     SIG_NBR = SIG_MAX - SIG_MIN + 1
 102
 103 =head2 C<MGf_COPY>
 104
 105 True iff the 'copy' magic is available.
 106
 107 =head2 C<MGf_DUP>
 108
 109 True iff the 'dup' magic is available.
 110
 111 =head2 C<MGf_LOCAL>
 112
 113 True iff the 'local' magic is available.
 114
 115 =head1 FUNCTIONS
 116
 117 =cut
 118
 119 use XSLoader;
 120
 121 BEGIN {
 122  XSLoader::load __PACKAGE__, $VERSION;
 123 }
 124
 125 =head2 C<wizard>
 126
 127     wizard sig => .., data => ..., get => .., set => .., len => .., clear => .., free => ..
 128
 129 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 :
 130
 131 =over 4
 132
 133 =item C<'sig'>
 134
 135 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.
 136
 137 =item C<'data'>
 138
 139 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>.
 140
 141 =item C<'get'>, C<'set'>, C<'len'>, C<'clear'> and C<'free'>
 142
 143 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.
 144
 145 =back
 146
 147     # A simple scalar tracer
 148     my $wiz = wizard get  => sub { print STDERR "got ${$_[0]}\n" },
 149                      set  => sub { print STDERR "set to ${$_[0]}\n" },
 150                      free => sub { print STDERR "${$_[0]} was deleted\n" }
 151
 152 =cut
 153
 154 sub wizard {
 155  croak 'Wrong number of arguments for wizard()' if @_ % 2;
 156  my %opts = @_;
 157  my $sig = $opts{sig};
 158  my @types = qw/data get set len clear free/;
 159  push @types, 'copy'  if MGf_COPY;
 160  push @types, 'dup'   if MGf_DUP;
 161  delete $opts{dup}; # don't use it for now
 162  push @types, 'local' if MGf_LOCAL;
 163  return _wizard($sig, map { $opts{$_} } @types);
 164 }
 165
 166 =head2 C<gensig>
 167
 168 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.
 169
 170     # Generate a signature
 171     my $sig = gensig;
 172
 173 =head2 C<getsig>
 174
 175     getsig $wiz
 176
 177 This accessor returns the magic signature of this wizard.
 178
 179     # Get $wiz signature
 180     my $sig = getsig $wiz;
 181
 182 =head2 C<cast>
 183
 184     cast [$@%&*]var, [$wiz|$sig], ...
 185
 186 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.
 187
 188     # Casts $wiz onto $x. If $wiz isn't a signature, undef can't be returned.
 189     my $x;
 190     die 'error' unless cast $x, $wiz;
 191
 192 =head2 C<getdata>
 193
 194     getdata [$@%&*]var, [$wiz|$sig]
 195
 196 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.
 197
 198     # Get the attached data.
 199     my $data = getdata $x, $wiz or die 'no such magic or magic has no data';
 200
 201 =head2 C<dispell>
 202
 203     dispell [$@%&*]variable, [$wiz|$sig]
 204
 205 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).
 206
 207     # Dispell now. If $wiz isn't a signature, undef can't be returned.
 208     die 'no such magic or error' unless dispell $x, $wiz;
 209
 210 =head1 EXPORT
 211
 212 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'>.
 213
 214 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'>.
 215
 216 =cut
 217
 218 use base qw/Exporter/;
 219
 220 our @EXPORT         = ();
 221 our %EXPORT_TAGS    = (
 222  'funcs' =>  [ qw/wizard gensig getsig cast getdata dispell/ ],
 223  'consts' => [ qw/SIG_MIN SIG_MAX SIG_NBR MGf_COPY MGf_DUP MGf_LOCAL/ ]
 224 );
 225 our @EXPORT_OK      = map { @$_ } values %EXPORT_TAGS;
 226 $EXPORT_TAGS{'all'} = \@EXPORT_OK;
 227
 228 =head1 DEPENDENCIES
 229
 230 L<perl> 5.7.3.
 231
 232 L<Carp> (standard since perl 5), L<XSLoader> (standard since perl 5.006).
 233
 234 Glob tests need L<Symbol> (standard since perl 5.002).
 235
 236 =head1 SEE ALSO
 237
 238 L<perlguts> and L<perlapi> for internal information about magic.
 239
 240 =head1 AUTHOR
 241
 242 Vincent Pit, C<< <perl at profvince.com> >>
 243
 244 You can contact me by mail or on #perl @ FreeNode (Prof_Vince).
 245
 246 =head1 BUGS
 247
 248 Please report any bugs or feature requests to
 249 C<bug-variable-magic at rt.cpan.org>, or through the web interface at
 250 L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Variable-Magic>.
 251 I will be notified, and then you'll automatically be notified of progress on
 252 your bug as I make changes.
 253
 254 =head1 SUPPORT
 255
 256 You can find documentation for this module with the perldoc command.
 257
 258     perldoc Variable::Magic
 259
 260 =head1 COPYRIGHT & LICENSE
 261
 262 Copyright 2007 Vincent Pit, all rights reserved.
 263
 264 This program is free software; you can redistribute it and/or modify it
 265 under the same terms as Perl itself.
 266
 267 =cut
 268
 269 1; # End of Variable::Magic