1 package Variable::Magic;
12 Variable::Magic - Associate user-defined magic to variables from Perl.
20 use vars qw/$VERSION/;
28 use Variable::Magic qw/wizard cast dispell/;
30 my $wiz = wizard set => sub { print STDERR "now set to ${$_[0]}!\n" };
33 $a = 2; # "now set to 2!"
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.
41 The operations that can be overloaded are :
47 This magic is invoked when the variable is evaluated (does not include array/hash subscripts and slices).
51 This one is triggered each time the value of the variable changes (includes array/hash subscripts and slices).
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.
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>).
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.
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).
69 =head1 PERL MAGIC HISTORY
71 The places where magic is invoked have changed a bit through perl history. Here's a little list of the most recent ones.
77 =item 'len' magic is no longer called when pushing an element into a magic array.
85 =item 'clear' magic wasn't invoked when undefining an array. The bug is fixed as of this version.
93 The minimum integer used as a signature for user-defined magic.
97 The maximum integer used as a signature for user-defined magic.
101 SIG_NBR = SIG_MAX - SIG_MIN + 1
105 True iff the 'copy' magic is available.
109 True iff the 'dup' magic is available.
113 True iff the 'local' magic is available.
122 XSLoader::load __PACKAGE__, $VERSION;
127 wizard sig => .., data => ..., get => .., set => .., len => .., clear => .., free => ..
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 :
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.
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>.
141 =item C<'get'>, C<'set'>, C<'len'>, C<'clear'> and C<'free'>
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.
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" }
155 croak 'Wrong number of arguments for wizard()' if @_ % 2;
157 my $sig = $opts{sig};
158 return _wizard($sig, map { $opts{$_} } qw/data get set len clear free copy dup local fetch store exists delete/);
163 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.
165 # Generate a signature
172 This accessor returns the magic signature of this wizard.
175 my $sig = getsig $wiz;
179 cast [$@%&*]var, [$wiz|$sig], ...
181 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.
183 # Casts $wiz onto $x. If $wiz isn't a signature, undef can't be returned.
185 die 'error' unless cast $x, $wiz;
189 getdata [$@%&*]var, [$wiz|$sig]
191 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.
193 # Get the attached data.
194 my $data = getdata $x, $wiz or die 'no such magic or magic has no data';
198 dispell [$@%&*]variable, [$wiz|$sig]
200 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).
202 # Dispell now. If $wiz isn't a signature, undef can't be returned.
203 die 'no such magic or error' unless dispell $x, $wiz;
207 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'>.
209 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'>.
213 use base qw/Exporter/;
217 'funcs' => [ qw/wizard gensig getsig cast getdata dispell/ ],
218 'consts' => [ qw/SIG_MIN SIG_MAX SIG_NBR MGf_COPY MGf_DUP MGf_LOCAL/ ]
220 our @EXPORT_OK = map { @$_ } values %EXPORT_TAGS;
221 $EXPORT_TAGS{'all'} = \@EXPORT_OK;
227 L<Carp> (standard since perl 5), L<XSLoader> (standard since perl 5.006).
229 Glob tests need L<Symbol> (standard since perl 5.002).
233 L<perlguts> and L<perlapi> for internal information about magic.
237 Vincent Pit, C<< <perl at profvince.com> >>
239 You can contact me by mail or on #perl @ FreeNode (Prof_Vince).
243 Please report any bugs or feature requests to
244 C<bug-variable-magic at rt.cpan.org>, or through the web interface at
245 L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Variable-Magic>.
246 I will be notified, and then you'll automatically be notified of progress on
247 your bug as I make changes.
251 You can find documentation for this module with the perldoc command.
253 perldoc Variable::Magic
255 =head1 COPYRIGHT & LICENSE
257 Copyright 2007 Vincent Pit, all rights reserved.
259 This program is free software; you can redistribute it and/or modify it
260 under the same terms as Perl itself.
264 1; # End of Variable::Magic