Changes

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