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