README

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