1 package Variable::Magic;
10 Variable::Magic - Associate user-defined magic to variables from Perl.
25 use Variable::Magic qw<wizard cast VMG_OP_INFO_NAME>;
28 my $wiz = wizard set => sub { print "now set to ${$_[0]}!\n" },
29 free => sub { print "destroyed!\n" };
33 $a = 2; # "now set to 2!"
36 { # A hash with a default value
37 my $wiz = wizard data => sub { $_[1] },
38 fetch => sub { $_[2] = $_[1] unless exists $_[0]->{$_[2]}; () },
39 store => sub { print "key $_[2] stored in $_[-1]\n" },
41 op_info => VMG_OP_INFO_NAME;
43 my %h = (_default => 0, apple => 2);
44 cast %h, $wiz, '_default';
45 print $h{banana}, "\n"; # "0", because the 'banana' key doesn't exist in %h
46 $h{pear} = 1; # "key pear stored in helem"
51 Magic is Perl's way of enhancing variables.
52 This mechanism lets the user add extra data to any variable and hook syntactical operations (such as access, assignment or destruction) that can be applied to it.
53 With this module, you can add your own magic to any variable without having to write a single line of XS.
55 You'll realize that these magic variables look a lot like tied variables.
56 It's not surprising, as tied variables are implemented as a special kind of magic, just like any 'irregular' Perl variable : scalars like C<$!>, C<$(> or C<$^W>, the C<%ENV> and C<%SIG> hashes, the C<@ISA> array, C<vec()> and C<substr()> lvalues, L<threads::shared> variables...
57 They all share the same underlying C API, and this module gives you direct access to it.
59 Still, the magic made available by this module differs from tieing and overloading in several ways :
65 It isn't copied on assignment.
67 You attach it to variables, not values (as for blessed references).
71 It doesn't replace the original semantics.
73 Magic callbacks usually get triggered before the original action takes place, and can't prevent it from happening.
74 This also makes catching individual events easier than with C<tie>, where you have to provide fallbacks methods for all actions by usually inheriting from the correct C<Tie::Std*> class and overriding individual methods in your own class.
80 The same magic can be applied on scalars, arrays, hashes, subs or globs.
81 But the same hook (see below for a list) may trigger differently depending on the the type of the variable.
85 It's mostly invisible at the Perl level.
87 Magical and non-magical variables cannot be distinguished with C<ref>, C<tied> or another trick.
93 Mainly because perl's way of handling magic is lighter by nature, and because there's no need for any method resolution.
94 Also, since you don't have to reimplement all the variable semantics, you only pay for what you actually use.
98 The operations that can be overloaded are :
106 This magic is invoked when the variable is evaluated.
107 It is never called for arrays and hashes.
113 This one is triggered each time the value of the variable changes.
114 It is called for array subscripts and slices, but never for hashes.
120 This magic is a little special : it is called when the 'size' or the 'length' of the variable has to be known by Perl.
121 Typically, it's the magic involved when an array is evaluated in scalar context, but also on array assignment and loops (C<for>, C<map> or C<grep>).
122 The callback has then to return the length as an integer.
128 This magic is invoked when the variable is reset, such as when an array is emptied.
129 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>).
135 This one can be considered as an object destructor.
136 It happens when the variable goes out of scope, but not when it is undefined.
142 This magic only applies to tied arrays and hashes.
143 It fires when you try to access or change their elements.
144 It is available on your perl iff C<MGf_COPY> is true.
150 Invoked when the variable is cloned across threads.
151 Currently not available.
157 When this magic is set on a variable, all subsequent localizations of the variable will trigger the callback.
158 It is available on your perl iff C<MGf_LOCAL> is true.
162 The following actions only apply to hashes and are available iff L</VMG_UVAR> is true.
163 They are referred to as C<uvar> magics.
171 This magic happens each time an element is fetched from the hash.
177 This one is called when an element is stored into the hash.
183 This magic fires when a key is tested for existence in the hash.
189 This last one triggers when a key is deleted in the hash, regardless of whether the key actually exists in it.
193 You can refer to the tests to have more insight of where the different magics are invoked.
195 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).
196 At the C level, magic tokens owned by magic created by this module have their C<< mg->mg_private >> field set to C<0x3891> or C<0x3892>, so please don't use these magic (sic) numbers in other extensions.
204 XSLoader::load(__PACKAGE__, $VERSION);
209 wizard data => sub { ... },
210 get => sub { my ($ref, $data [, $op]) = @_; ... },
211 set => sub { my ($ref, $data [, $op]) = @_; ... },
212 len => sub { my ($ref, $data, $len [, $op]) = @_; ... ; return $newlen; },
213 clear => sub { my ($ref, $data [, $op]) = @_; ... },
214 free => sub { my ($ref, $data [, $op]) = @_, ... },
215 copy => sub { my ($ref, $data, $key, $elt [, $op]) = @_; ... },
216 local => sub { my ($ref, $data [, $op]) = @_; ... },
217 fetch => sub { my ($ref, $data, $key [, $op]) = @_; ... },
218 store => sub { my ($ref, $data, $key [, $op]) = @_; ... },
219 exists => sub { my ($ref, $data, $key [, $op]) = @_; ... },
220 delete => sub { my ($ref, $data, $key [, $op]) = @_; ... },
222 op_info => [ 0 | VMG_OP_INFO_NAME | VMG_OP_INFO_OBJECT ]
224 This function creates a 'wizard', an opaque type that holds the magic information.
225 It takes a list of keys / values as argument, whose keys can be :
233 A code (or string) reference to a private data constructor.
234 It is called each time this magic is cast on a variable, and the scalar returned is used as private data storage for it.
235 C<$_[0]> is a reference to the magic object and C<@_[1 .. @_-1]> are all extra arguments that were passed to L</cast>.
239 C<get>, C<set>, C<len>, C<clear>, C<free>, C<copy>, C<local>, C<fetch>, C<store>, C<exists> and C<delete>
241 Code (or string) references to the corresponding magic callbacks.
242 You don't have to specify all of them : the magic associated with undefined entries simply won't be hooked.
243 In those callbacks, C<$_[0]> is always a reference to the magic object and C<$_[1]> is always the private data (or C<undef> when no private data constructor was supplied).
245 Moreover, when you pass C<< op_info => $num >> to C<wizard>, the last element of C<@_> will be the current op name if C<$num == VMG_OP_INFO_NAME> and a C<B::OP> object representing the current op if C<$num == VMG_OP_INFO_OBJECT>.
246 Both have a performance hit, but just getting the name is lighter than getting the op object.
248 Other arguments are specific to the magic hooked :
256 When the variable is an array or a scalar, C<$_[2]> contains the non-magical length.
257 The callback can return the new scalar or array length to use, or C<undef> to default to the normal length.
263 C<$_[2]> is a either a copy or an alias of the current key, which means that it is useless to try to change or cast magic on it.
264 C<$_[3]> is an alias to the current element (i.e. the value).
268 C<fetch>, C<store>, C<exists> and C<delete>
270 C<$_[2]> is an alias to the current key.
271 Nothing prevents you from changing it, but be aware that there lurk dangerous side effects.
272 For example, it may rightfully be readonly if the key was a bareword.
273 You can get a copy instead by passing C<< copy_key => 1 >> to L</wizard>, which allows you to safely assign to C<$_[2]> in order to e.g. redirect the action to another key.
274 This however has a little performance drawback because of the copy.
278 All the callbacks are expected to return an integer, which is passed straight to the perl magic API.
279 However, only the return value of the C<len> callback currently holds a meaning.
283 Each callback can be specified as a code or a string reference, in which case the function denoted by the string will be used as the callback.
285 Note that C<free> callbacks are I<never> called during global destruction, as there's no way to ensure that the wizard and the C<free> callback weren't destroyed before the variable.
287 Here's a simple usage example :
289 # A simple scalar tracer
290 my $wiz = wizard get => sub { print STDERR "got ${$_[0]}\n" },
291 set => sub { print STDERR "set to ${$_[0]}\n" },
292 free => sub { print STDERR "${$_[0]} was deleted\n" }
299 Carp::croak('Wrong number of arguments for wizard()');
304 my @keys = qw<data op_info get set len clear free>;
305 push @keys, 'copy' if MGf_COPY;
306 push @keys, 'dup' if MGf_DUP;
307 push @keys, 'local' if MGf_LOCAL;
308 push @keys, qw<fetch store exists delete copy_key> if VMG_UVAR;
313 $wiz = eval { _wizard(map $opts{$_}, @keys) };
317 $err =~ s/\sat\s+.*?\n//;
327 cast [$@%&*]var, $wiz, ...
329 This function associates C<$wiz> magic to the variable supplied, without overwriting any other kind of magic.
330 It returns true on success or when C<$wiz> magic is already present, and croaks on error.
331 All extra arguments specified after C<$wiz> are passed to the private data constructor in C<@_[1 .. @_-1]>.
332 If the variable isn't a hash, any C<uvar> callback of the wizard is safely ignored.
334 # Casts $wiz onto $x, and pass '1' to the data constructor.
338 The C<var> argument can be an array or hash value.
339 Magic for those behaves like for any other scalar, except that it is dispelled when the entry is deleted from the container.
340 For example, if you want to call C<POSIX::tzset> each time the C<'TZ'> environment variable is changed in C<%ENV>, you can use :
343 cast $ENV{TZ}, wizard set => sub { POSIX::tzset(); () };
345 If you want to overcome the possible deletion of the C<'TZ'> entry, you have no choice but to rely on C<store> uvar magic.
349 getdata [$@%&*]var, $wiz
351 This accessor fetches the private data associated with the magic C<$wiz> in the variable.
352 It croaks when C<$wiz> do not represent a valid magic object, and returns an empty list if no such magic is attached to the variable or when the wizard has no data constructor.
354 # Get the attached data, or undef if the wizard does not attach any.
355 my $data = getdata $x, $wiz;
359 dispell [$@%&*]variable, $wiz
361 The exact opposite of L</cast> : it dissociates C<$wiz> magic from the variable.
362 This function returns true on success, C<0> when no magic represented by C<$wiz> could be found in the variable, and croaks if the supplied wizard is invalid.
365 die 'no such magic in $x' unless dispell $x, $wiz;
371 Evaluates to true iff the 'copy' magic is available.
375 Evaluates to true iff the 'dup' magic is available.
379 Evaluates to true iff the 'local' magic is available.
383 When this constant is true, you can use the C<fetch,store,exists,delete> callbacks on hashes.
384 Initial VMG_UVAR capability was introduced in perl 5.9.5, with a fully functional implementation
385 shipped with perl 5.10.0.
387 =head2 C<VMG_COMPAT_ARRAY_PUSH_NOLEN>
389 True for perls that don't call 'len' magic when you push an element in a magical array.
390 Starting from perl 5.11.0, this only refers to pushes in non-void context and hence is false.
392 =head2 C<VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID>
394 True for perls that don't call 'len' magic when you push in void context an element in a magical array.
396 =head2 C<VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID>
398 True for perls that don't call 'len' magic when you unshift in void context an element in a magical array.
400 =head2 C<VMG_COMPAT_ARRAY_UNDEF_CLEAR>
402 True for perls that call 'clear' magic when undefining magical arrays.
404 =head2 C<VMG_COMPAT_SCALAR_LENGTH_NOLEN>
406 True for perls that don't call 'len' magic when taking the C<length> of a magical scalar.
408 =head2 C<VMG_COMPAT_GLOB_GET>
410 True for perls that call 'get' magic for operations on globs.
412 =head2 C<VMG_PERL_PATCHLEVEL>
414 The perl patchlevel this module was built with, or C<0> for non-debugging perls.
416 =head2 C<VMG_THREADSAFE>
418 True iff this module could have been built with thread-safety features enabled.
420 =head2 C<VMG_FORKSAFE>
422 True iff this module could have been built with fork-safety features enabled.
423 This will always be true except on Windows where it's false for perl 5.10.0 and below .
425 =head2 C<VMG_OP_INFO_NAME>
427 Value to pass with C<op_info> to get the current op name in the magic callbacks.
429 =head2 C<VMG_OP_INFO_OBJECT>
431 Value to pass with C<op_info> to get a C<B::OP> object representing the current op in the magic callbacks.
435 =head2 Associate an object to any perl variable
437 This technique can be useful for passing user data through limited APIs.
438 It is similar to using inside-out objects, but without the drawback of having to implement a complex destructor.
441 package Magical::UserData;
443 use Variable::Magic qw<wizard cast getdata>;
445 my $wiz = wizard data => sub { \$_[1] };
447 sub ud (\[$@%*&]) : lvalue {
449 my $data = &getdata($var, $wiz);
450 unless (defined $data) {
452 &cast($var, $wiz, $slot)
453 or die "Couldn't cast UserData magic onto the variable";
460 BEGIN { *ud = \&Magical::UserData::ud }
463 $cb = sub { print 'Hello, ', ud(&$cb), "!\n" };
466 $cb->(); # Hello, world!
469 =head2 Recursively cast magic on datastructures
471 C<cast> can be called from any magical callback, and in particular from C<data>.
472 This allows you to recursively cast magic on datastructures :
475 $wiz = wizard data => sub {
476 my ($var, $depth) = @_;
480 &cast((ref() ? $_ : \$_), $wiz, $depth + 1) for @$var;
481 } elsif ($r eq 'HASH') {
482 &cast((ref() ? $_ : \$_), $wiz, $depth + 1) for values %$var;
487 my ($var, $depth) = @_;
489 print "free $r at depth $depth\n";
501 When C<%h> goes out of scope, this will print something among the lines of :
505 free SCALAR at depth 2
506 free ARRAY at depth 1
507 free SCALAR at depth 3
508 free SCALAR at depth 3
510 Of course, this example does nothing with the values that are added after the C<cast>.
512 =head1 PERL MAGIC HISTORY
514 The places where magic is invoked have changed a bit through perl history.
515 Here's a little list of the most recent ones.
523 I<p14416> : 'copy' and 'dup' magic.
529 I<p28160> : Integration of I<p25854> (see below).
531 I<p32542> : Integration of I<p31473> (see below).
537 I<p25854> : 'len' magic is no longer called when pushing an element into a magic array.
539 I<p26569> : 'local' magic.
545 I<p31064> : Meaningful 'uvar' magic.
547 I<p31473> : 'clear' magic wasn't invoked when undefining an array.
548 The bug is fixed as of this version.
554 Since C<PERL_MAGIC_uvar> is uppercased, C<hv_magic_check()> triggers 'copy' magic on hash stores for (non-tied) hashes that also have 'uvar' magic.
560 I<p32969> : 'len' magic is no longer invoked when calling C<length> with a magical scalar.
562 I<p34908> : 'len' magic is no longer called when pushing / unshifting an element into a magical array in void context.
563 The C<push> part was already covered by I<p25854>.
565 I<g9cdcb38b> : 'len' magic is called again when pushing into a magical array in non-void context.
571 The functions L</wizard>, L</cast>, L</getdata> and L</dispell> are only exported on request.
572 All of them are exported by the tags C<':funcs'> and C<':all'>.
574 All the constants are also only exported on request, either individually or by the tags C<':consts'> and C<':all'>.
578 use base qw<Exporter>;
582 'funcs' => [ qw<wizard cast getdata dispell> ],
584 MGf_COPY MGf_DUP MGf_LOCAL VMG_UVAR
585 VMG_COMPAT_ARRAY_PUSH_NOLEN VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID
586 VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID
587 VMG_COMPAT_ARRAY_UNDEF_CLEAR
588 VMG_COMPAT_SCALAR_LENGTH_NOLEN
591 VMG_THREADSAFE VMG_FORKSAFE
592 VMG_OP_INFO_NAME VMG_OP_INFO_OBJECT
595 our @EXPORT_OK = map { @$_ } values %EXPORT_TAGS;
596 $EXPORT_TAGS{'all'} = [ @EXPORT_OK ];
600 If you store a magic object in the private data slot, the magic won't be accessible by L</getdata> since it's not copied by assignment.
601 The only way to address this would be to return a reference.
603 If you define a wizard with a C<free> callback and cast it on itself, this destructor won't be called because the wizard will be destroyed first.
605 In order to define magic on hash members, you need at least L<perl> 5.10.0 (see L</VMG_UVAR>)
612 This module may happen to build with a C++ compiler as well, but don't rely on it, as no guarantee is made in this regard.
614 L<Carp> (standard since perl 5), L<XSLoader> (standard since perl 5.006).
616 Copy tests need L<Tie::Array> (standard since perl 5.005) and L<Tie::Hash> (since 5.002).
618 Some uvar tests need L<Hash::Util::FieldHash> (standard since perl 5.009004).
620 Glob tests need L<Symbol> (standard since perl 5.002).
622 Threads tests need L<threads> and L<threads::shared>.
626 L<perlguts> and L<perlapi> for internal information about magic.
628 L<perltie> and L<overload> for other ways of enhancing objects.
632 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
634 You can contact me by mail or on C<irc.perl.org> (vincent).
638 Please report any bugs or feature requests to C<bug-variable-magic at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Variable-Magic>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
642 You can find documentation for this module with the perldoc command.
644 perldoc Variable::Magic
646 Tests code coverage report is available at L<http://www.profvince.com/perl/cover/Variable-Magic>.
648 =head1 COPYRIGHT & LICENSE
650 Copyright 2007,2008,2009,2010,2011 Vincent Pit, all rights reserved.
652 This program is free software; you can redistribute it and/or modify it
653 under the same terms as Perl itself.
657 1; # End of Variable::Magic