1 Revision history for Variable-Magic
3 0.51 2012-08-18 15:00 UTC
4 + Fix : It is now safe to call dispell() from inside 'free', 'copy' and
5 'uvar' callbacks to dispell the magic currently in use.
6 Thanks Clinton Gormley for reporting.
7 + Fix : Exceptions thrown from inside a 'free' callback are now always
8 consistently propagated outside of the callback. They used to
9 be lost when the 'free' callback was invoked at the end of an
11 + Fix : The 'reset RMG flag' workaroundn used to allow wizards with
12 both 'uvar' and 'clear' magics to be cast onto a hash, has been
15 0.50 2012-06-24 23:00 UTC
16 + Fix : Less memory is leaked when a wizard is freed during global
17 destruction, or when an exception is thrown from a 'free'
19 + Fix : [RT #77991] : t/17-ctl.t fails on perl 5.14 and 5.16.
20 This was actually an issue with ActivePerl, and this test
21 has learned to cope with it.
22 Thanks Gisle Aas for reporting.
23 + Tst : t/35-stash.t has been taught about perl 5.17.1.
24 + Doc : Many clarifications.
26 0.49 2012-06-05 21:40 UTC
27 This is a maintenance release. The code contains no functional change.
28 Satisfied users of version 0.48 can skip this update.
29 + Fix : [RT #77644] : t/17_ctl.t fails in test 44 since 5.17.0.
30 This test has been taught about perl 5.17.0.
31 Thanks Reini Urban for reporting.
32 + Tst : t/99-kwalitee.t will be skipped when only problematic versions
33 of its dependencies are available.
35 0.48 2012-02-17 23:40 UTC
36 + Add : You can now pass a reference to undef as the magic callback in
37 order to install a no-op callback.
38 Thanks Florian Ragwitz for the suggestion.
40 0.47 2011-10-27 16:55 UTC
41 + Add : The new constant VMG_COMPAT_HASH_DELETE_NOUVAR_VOID evaluates
42 to true when "delete $hash{key}" does not call 'delete' uvar
43 magic in void context.
44 + Chg : The MAGIC tokens created by this module no longer use the
45 mg_private member for storing a "magical" signature.
46 + Fix : Triggering magic in a thread on a variable cloned from the main
47 interpreter, and when the wizard already went out of scope,
48 will not segfault anymore.
49 + Opt : The pointer table is no longer needed to ensure thread safety.
50 The size of the object code is about 8% smaller for threaded
52 + Tst : Threads tests will not fail anymore if resources constraints
53 prevent the system from creating all the required threads.
55 0.46 2011-01-23 16:45 UTC
56 + Fix : [RT #64866] : Assertion failure with perl 5.13.9.
57 The real problem was that dispell() wasn't properly resetting
58 the magical sv flags, which became visible in the test suite
59 only with perl 5.13.9.
60 Thanks Joshua ben Jore for reporting.
62 0.45 2010-11-21 23:15 UTC
63 This is a maintenance release. The code contains no functional change.
64 Users of 0.44 can skip this update.
65 + Doc : C++ compilers are officially NOT supported.
66 + Doc : The minimum perl 5.10.0 requirement for uvar magic has been
68 Thanks Peter Rabbitson for pointing this out and contributing a
70 + Tst : Tune for perl 5.13.7.
71 + Tst : Capture::Tiny will be used in t/17-ctl.t if and only if it can
74 0.44 2010-09-24 19:10 UTC
75 + Fix : Broken linkage on Windows with gcc 3.4, which appears in
76 particular when using ActivePerl's default compiler suite.
77 For those setups, the Variable::Magic shared library will now
78 be linked against the perl dll directly (instead of the import
79 library). This (should) fix RT #51483.
80 Thanks Christian Walde for helping to reproduce this failure
82 + Rem : Support for development perls from the 5.11 branch but older
83 than the 5.11.0 release was removed. This could cause more
84 recent setups to fail.
85 + Tst : Threads tests are now only run on perl 5.13.4 and higher.
86 They could segfault randomly because of what seems to be an
87 internal bug of Perl, which has been addressed in 5.13.4.
88 There is also an environment variable that allows you to
89 forcefully run those tests, but it should be set only for
90 author testing and not for end users.
92 0.43 2010-06-25 23:35 UTC
93 + Add : The new constant VMG_COMPAT_GLOB_GET tells you whether get magic
94 is called for globs. It's true starting perl 5.13.2.
95 + Chg : All callbacks are now called within an eval-like context.
96 Only free callbacks used to be called that way.
97 + Fix : Some exceptions thrown from a free callback could be lost.
98 + Fix : Croak messages could sometimes be repeated several times.
99 + Fix : t/41-clone.t segfaulting with perl 5.13.2.
101 0.42 2010-05-19 00:15 UTC
102 This is a maintenance release. The code contains no functional change.
103 Users of 0.41 can skip this update.
104 + Fix : Test failures with perl 5.13.
105 + Tst : Improve coverage.
107 0.41 2010-03-15 17:35 UTC
108 + Doc : Tweaks and fixups.
110 + Fix : Compatibility with the soon-to-be-released perl 5.12.0.
111 + Fix : Correctly propagate the errors thrown when variable destruction
112 happens at compile-time and not from inside eval STRING.
113 Thanks Florian Ragwitz and Ash Berlin for reporting.
115 0.40 2010-01-06 23:20 UTC
116 + Fix : Possible memory miswrites when passing data arguments to cast().
117 + Fix : Minor C portability tweaks.
119 0.39 2009-12-01 00:05 UTC
120 + Add : You can use a function name as a callback by passing a string
121 reference to wizard() instead of a code reference.
122 + Fix : Compatiblity with perl 5.11.1 and 5.11.2.
123 + Fix : Scalars stored into the data slot no longer leak.
124 + Fix : Thread destruction should not segfault anymore.
125 + Opt : As a result of removing the deprecated features, less memory is
126 used for both threaded (a pointer table is used instead of a
127 hash) and non-threaded (no global structure is needed anymore)
129 + Rem : As advertised in the precendent version, all the signature
130 related features were removed. This includes the 'sig' option
131 to wizard(), the getsig() and gensig() functions, and the SIG_*
134 0.38 2009-10-04 16:10 UTC
135 + Dep : All the signature-related features are DEPRECATED and will be
136 removed in december 2009. This includes the 'sig' option to
137 wizard(), the getsig() and gensig() functions, and the SIG_*
139 Afaik those features were never used in real life, and they make
140 the XS code slow and brittle. If you want your wizards to be
141 globally available, you'll have to handle that yourself by
142 storing them in a hash.
143 + Doc : More examples in a new COOKBOOK section.
144 + Fix : Compatiblity with the 5.11.0 release. The new compatibility
145 constant VMG_COMPAT_ARRAY_PUSH_NOLEN_VOID was added to cover
147 + Fix : Work around Kwalitee test misfailures.
149 0.37 2009-08-25 15:25 UTC
150 + Add : The new constant VMG_FORKSAFE can be tested to know whether the
151 module will behave nicely when fork()ing. It's currently always
152 true except on Windows where you need perl 5.10.1 for it to be
154 + Doc : Nits and clarifications.
156 0.36 2009-07-05 16:30 UTC
157 + Chg : getdata() now returns an empty list when no magic is present.
158 It used to return undef but did not croak as stated in the doc.
159 Thanks Matt S. Trout for pointing this out.
160 + Fix : Building and tests with ActiveState Perl 5.8 build >= 822.
162 0.35 2009-05-15 20:50 UTC
163 This is a maintenance release. Users of 0.34 can skip this update.
164 + Chg : uvar magic used to be enabled for 5.9.5. It now requires 5.10 or
166 + Fix : Silence compilation warnings for cxinc().
167 + Rem : The workaround introduced in 0.31 for the "Unknown errors" issue
168 was removed, as regression tests show that 0.34 provides a
170 + Tst : Skip t/40-threads.t on 5.8.x with old versions of threads and
173 0.34 2009-04-19 16:55 UTC
174 + Fix : Destruction of wizards in require.
175 + Fix : "panic: restartop" in 5.10 when dieing at compile time triggers
178 0.33 2009-03-26 00:00 UTC
179 + Chg : cast() and getsig() now croak too when an invalid signature is
181 + Fix : It was possible to generate with gensig() the same signature
182 twice before actually defining the wizards.
183 + Tst : More stash tests.
184 + Tst : Test when the magic takes place in some cases.
185 + Tst : Improved coverage for the op object feature.
187 0.32 2009-03-01 13:45 UTC
188 + Chg : dispell() and getdata() now croak when an invalid signature is
190 + Doc : More examples and a brand new synopsis.
191 + Fix : The signature is no longer stored in the mg_private member of
192 the MAGIC struct. This fixes possible clashes with magics from
194 + Fix : op info objects weren't blessed into the right class.
195 + Fix : Races when initializing the op names cache under threads.
197 0.31 2009-02-19 23:50 UTC
198 + Doc : A somewhat better introduction. The FUNCTION section was moved
199 before CONSTANTS and HISTORY since it's more important. And
200 'assignation' is really 'assignment', says Ricardo. :)
201 + Fix : The op_info features are now thread safe.
202 + Fix : Segfaults that occured when trying to get the op name during
204 + Fix : Segfaults and wrong "Unknown error" exceptions that happened
205 when dieing in require caused a free callback to fire.
206 Thanks Florian Ragwitz for reporting.
208 0.30 2009-02-12 17:05 UTC
209 + Add : You can now get in all the callbacks either the name or a B::OP
210 object representing the current op if you pass the new 'op_info'
211 option to wizard() with respective values VMG_OP_INFO_NAME and
213 + Doc : Document magic on array/hashes values.
214 + Fix : Completely skip free callbacks during global destruction.
215 + Tst : Tests now pass again on 5.8.3 and lower (they were broken since
217 + Tst : Test magic on symbol table and on array/hash values.
219 0.29 2009-02-08 11:10 UTC
220 + Add : Set $_[2] to the default length for len magic on scalars.
221 + Chg : Perl 5.8 is required.
222 + Chg : The CLONE method will no longer be defined for non-threaded
225 + Fix : The logic for turning off the GMAGICAL flag on hashes when no
226 uvar magic is involved could do nasty things on tied hashes.
227 + Upd : More resources in META.yml.
229 0.28 2009-01-24 17:05 UTC
230 + Add : The 'copy_key' option to wizard(), that enables the safe edition
231 of $_[2] in uvar callbacks to redirect actions to another key.
232 + Fix : Exception objects thrown from callbacks at compile time were not
234 + Fix : free callbacks triggered during global destruction could lead to
235 segfaults because the wizard was already freed.
236 + Fix : Refcount of scalars with free callback.
237 + Fix : Segfaults when using get or uvar magic simultaneously with clear
239 + Doc : The documentation about what the callbacks take and should
240 return is now somewhat clearer.
242 0.27 2009-01-18 23:40 UTC
243 + Fix : Offset of 1 with len magic on scalars.
244 + Fix : Segfaults that seem to happen when one croak in a callback at
245 compile time (thanks Ash Berlin for the testcase).
246 + Upd : Resources in META.yml (Florian Ragwitz)
247 + Tst : Large cleanup resulting in a wider set of tested behaviours.
249 0.26 2008-11-29 22:05 UTC
250 + Fix : Leaks of cloned coderefs that access lexicals.
251 + Fix : Building with maint-5.8 and blead (thanks Andreas Koenig).
253 0.25 2008-11-12 19:40 UTC
254 + Fix : Compatibility with 5.8.9.
255 + Fix : Old Pod::Coverage don't ignore CLONE.
256 + Upd : META.yml spec updated to 1.4.
258 0.24 2008-10-12 14:55 UTC
259 + Fix : Really fix it.
261 0.23 2008-10-11 17:25 UTC
262 + Fix : Building on perls with multiplicity but not ithreads.
264 0.22 2008-09-29 19:40 UTC
265 + Doc : Explain how magic differs from overloading.
266 + Fix : Disable thread safety for perl 5.8 on Windows. If you want it
267 enabled, reliable feedback is welcome.
269 0.21_02 2008-09-28 23:10 UTC
270 + Fix : Hide previously deleted magic tokens in vmg_svt_free (Yuval
273 0.21_01 2008-09-22 13:25 UTC
274 + Chg : Shrink the context data.
275 + Fix : Enable thread safety features for perls that just lack
277 + Tst : Output threads and threads::shared versions in threads tests.
279 0.20 2008-09-20 23:35 UTC
280 + Fix : The module is now thread safe. You can test if it had been
281 built with thread safety features enabled through the
282 VMG_THREADSAFE constant.
283 + Fix : Correct backtrace when wizard() croaks.
284 + Fix : 'cast $a, undef' should throw an 'invalid wizard' error instead
285 of an 'invalid signature'.
287 0.19 2008-07-05 15:05 UTC
288 + Add : The patchlevel with which the module has been built is now
289 exported with the VMG_PERL_PATCHLEVEL constant.
290 + Chg : Version checking macros overhaul.
291 + Fix : 'uvar' magic should only be enabled in maint-5.10 and higher
292 since it's never going to be backported to 5.8.
293 + Fix : Likewise, the copy callback API change should only be enabled in
295 + Fix : Instead of those ackward fake refcount increments in the wizard
296 destructor, flag the wizard with SVf_BREAK and force temps
297 cleanup. This should fix the wizard destruction for all perls,
298 and solves the leak introduced by the previous solution.
300 0.18 2008-07-04 12:20 UTC
301 + Fix : Enable uvar magic when patchlevel >= 28419.
302 + Fix : Set VMG_COMPAT_ARRAY_PUSH_NOLEN for Windows ActiveState Perl
305 0.17 2008-05-11 09:05 UTC
306 + Fix : 5.8.4 and lower don't have mPUSHi. Gah. Yeah, I know, I should
309 0.16 2008-05-10 22:05 UTC
310 + Add : The samples/copy.pl script.
311 + Chg : The sv_magical() + vmg_mg_magical() combo was simplified into
313 + Tst : t/33-code.t was testing scalars, not code.
314 + Tst : is() and like() are better than ok().
315 + Tst : 100% coverage reached.
317 0.15 2008-04-11 18:25 UTC
318 + Chg : Factor vmg_cb_call{1,2,3}() into one function.
319 + Fix : len magic is no longer called when taking the length() of a
320 magical scalar since p32969. The VMG_COMPAT_SCALAR_LENGTH_NOLEN
321 constant was added to cover this.
322 + Tst : More tests for t/22-len.t.
324 0.14 2008-03-24 12:35 UTC
325 + Fix : t/16-huf.t failures on Solaris and FreeBSD caused by not
326 updating mg->mg_ptr after Renew-ing it on dispell.
327 + Fix : Undefining MGf_DUP caused the wizard's magic to be wrongly
328 initialized. MGf_DUP now appears as true from the user point of
329 view, but the dup callback isn't actually set.
330 + Fix : Warnings with blead due to copy callbacks now taking an I32 (API
332 + Fix : vmg_svt_val() and vmg_uvar_del() aren't required if no uvar
334 + Tst : Tests now output the version of optional modules loaded.
336 0.13 2008-03-19 14:35 UTC
337 + Doc : Link to coverage report.
338 + Fix : Correct dependencies listing in META.yml.
339 + Tst : Improved test coverage.
340 + Tst : Print the patchlevel as a comment.
341 + Tst : Use is() where it's relevant.
342 + Tst : t/16-huf.t now really tests interaction with H::U::FH.
344 0.12 2008-02-07 18:15 UTC
345 + Fix : POD error. Thanks to Chris Williams (BinGOs) for the quick
348 0.11 2008-02-07 17:55 UTC
349 + Add : Copy callbacks now receive the current key/index in $_[2].
350 The current value/element is now in $_[3].
351 + Chg : The trigger of copy magic on list assignment with perls greater
352 than 5.10.0 was caused by uvar magic. Hence,
353 VMG_COMPAT_HASH_LISTASSIGN_COPY was removed. Use VMG_UVAR
355 + Fix : Build failures on patched perls.
356 + Tst : Added missing exported symbols to 01-import.t.
358 0.10 2008-02-04 11:30 UTC
359 + Add : New script : samples/vm_vs_tie.pl, that benchmarks our uvar
360 magic versus tied hashes.
361 + Add : The VMG_COMPAT_* constants can be used from userspace to check
362 perl magic abilities.
363 + Fix : Callbacks that returned undef made us croak, breaking the
364 variable behaviour (regression test in 14-callbacks.t).
365 + Fix : uvar callbacks weren't tested for non-NULL-ity before being
366 called (regression test in 28-uvar.t).
367 + Tst : Fix typo in 25-copy.t that prevented Tie::Hash tests to be ran.
369 0.09 2008-02-02 11:30 UTC
370 + Doc : Explicitely say that uvar callbacks are safely ignored for
372 + Doc : Document caveats and fix the usual set of typos.
373 + Fix : vmg_dispell() didn't check if the ext magic were ours when
374 counting wizards that have uvar callbacks, resulting in a
375 possible memory misread.
376 + Fix : getdata() now returns directly the data object, and no longer a
377 copy. This caused a leak.
378 + Tst : Prefix author tests by 9*-.
379 + Tst : New optional author test : 95-portability-files.t, that uses
380 Test::Portability::Files when it's present.
381 + Tst : New test : 14-self.t, that tests application of magic on the
383 + Tst : Move Hash::Util::FieldHash tests out of 11-multiple.t to
386 0.08 2008-02-01 16:55 UTC
387 + Add : copy magic for tied arrays/hashes.
389 + Add : uvar magics : fetch, store, exists, delete for hashes.
392 Internal development versions.
394 0.06 2007-11-20 10:10 UTC
395 + Chg : 5.7.3 is now officially required.
396 + Fix : "data" test failures on 5.8.{0,2}.
397 + Fix : Drand01() vs rand().
399 0.05 2007-11-19 09:10 UTC
400 + Fix : 5.10.0_RC1 compatibility fix.
402 0.04 2007-08-28 12:25 UTC
403 + Chg : s/require (XSLoader)/use $1/.
404 + Fix : Tests are now strict.
405 + Fix : Complete dependencies.
407 0.03 2007-08-01 17:20 UTC
408 + Add : Passing the signature of an already defined magic to wizard()
409 now returns the corresponding magic object.
410 + Add : You can pass the numeric signature as the wizard argument of
411 cast(), dispell() and getdata().
412 + Add : Any argument specified after the wizard (or the signature) in a
413 call to cast() is now passed to the private data constructor in
415 + Chg : $_[0] is now always a reference to the magic variable in all
416 callbacks. The reason for changing from the previous behaviour
417 is that one may want to apply the same magic to a plain scalar
418 and to a scalar reference, and needs a way to distinguish
419 between them in the callback (say, ref()).
420 + Fix : Wizard object destruction used not to free the signature.
422 0.02 2007-07-27 13:50 UTC
423 + Fix : In response to test report 548152 :
424 Newx() and SvMAGIC_set() not present on older perls.
425 + Fix : In response to test report 548275 :
426 Since perl 5.9.5, 'clear' magic is invoked when an array is
427 undefined (bug #43357). Moreover, 'len' magic is no longer
428 called by pushing an element since perl 5.9.3.
429 + Fix : Missing glob test in MANIFEST.
431 0.01 2007-07-25 16:15 UTC
432 First version, released on an unsuspecting world.