Changes

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