Bump copyright year

Add a CONTRIBUTING guidelines file

Upper.xs - in 5.37.6 cop_warnings became a char * (RCVP)

It is actually a RCPV (RefCounted PV), so we can use RCPV_LEN() to
find its length.

Unfortunately there is not currently a way to "mortalize" a RCPV,
an oversight that I will correct in a future release of Perl. But
for now this should do.

t/ - Given is deprecated in 5.37.10, do not test it

This silences vast numbers of warnings, and will prevent the module
from breaking in 5.42.

This is 0.33

Update Test::Leaner to f53f8d6

Update META spec to 2.0

See you, Kent.

This fixes [RT #114816].

Bump copyright year

Make the expected() utility more closely match context_info()

context_info() returns $warnings::Bits{all} when the warnings for
a context is pWARN_ALL, while caller() returns WARN_ALLstring.

The test tried to avoid loading any modules that registered
warning categories to avoid this making a difference, but
DynaLoader is needed to load Scope::Upper, and DynaLoader uses
vars.pm which registers a warnings category.

This wasn't a problem when the default warning mask wasn't used up to a
byte boundary, but adding the experimental category in Perl 5 commit
3b54923c did align the warning mask on a byte boundary, leading to this
test failing.

Specifically, handle case where warnings mask contains only "\x55"
bytes.  Return $warnings::Bits{all} in that case.  As suggested by Tony
Cook in: https://rt.cpan.org/Ticket/Display.html?id=139823

BBC ticket: https://github.com/Perl/perl5/issues/19212

Most of commit message suggested by Tony Cook in:
https://github.com/jkeenan/p5-Scope-Upper/pull/1#issuecomment-968375955

This is 0.32

Bump copyright year

Update Test::Leaner to 0080661

Update VPIT::TestHelpers to 0bb3aa5

Update contact info

Fix breakage caused by core change f14cf363

This fixes [RT #129539].

This is 0.31

Bump copyright year

Always apply localizations at the glob level

"localize '$x', $var" used to dereference $var and apply the localization
to $x directly. This did not set the IMPORTED flag on *x when necessary.
In order to fix this, we now follow the opposite logic : $var is now
referenced when the localization target is a scalar, and that reference is
assigned to *x so that localize now really behaves like "local *x = $var".

This fixes [RT #125931].

This is 0.30

Update VPIT::XSHelpers to 18554226

Protect against d_cplusplus perls

It's only a matter of time before someone uses this in the wild.

Bump copyright year

Update VPIT::TestHelpers to 15e8aee3

This is 0.29

Thanks, Dave

Bump copyright year

Minor stylistic nits

No functional changes.

Rename su_debug_log() into xsh_debug_log()

As it should have been in the big refactor change.

Merge perl 5.24 fixes from davem

ud_ is not unused in su_yield()

Avoid partially braced if/else

Hide aTHX in macros

Only define su_cxt_enter_count when XSH_DEBUG is set

Remove a couple of unused variable

Prevent a future possible declaration-after-code error

Right now SU_HAS_NEW_CXT implies defined(gv_fetchsv), but better
make this more obvious.

Actually restore old_cop in su_localize()

Fix the build on perl 5.8.0

PERL_DEB() was not defined at that time.

Always define SU_HAS_NEW_CXT

Minor whitespace changes

fixup t/13-reap-ctl.t for 5.23.8

One test in this script failed under 5.23.8 due to a change in the way
the die while leaving an eval scope is now handled.

Consider the following code, where leaving an eval scope triggers a call
to STORE to unlocalise a tied scalar, and where STORE raises an exception:

    sub TIESCALAR { bless [] }
    sub FETCH { 1;  }
    sub STORE { die "died in store\n" if $_[1]  }

    tie $s, 'main';
    eval {
        local $s;
    };
    warn "caught: [$@]\n";

5.23.7 and earlier die, while 5.23.8 output:

    caught: [died in store
    ]

Similarly, one would expect the behaviour of "reap HERE" to change
in 5.23.8, with an exception raised in the reap handler to now be caught
be the innermost eval.

So fix up the test to reflect this new reality.

eliminate CX_ARGARRAY() and CX_ARGARRAY_set()

I added these earlier as a way of compiling the code under both 5.23.7 and
5.23.8, since the latter no longer has the argarray field in the context
struct. I didn't know at the time whether they were logically correct
under 5.23.8 - I just wanted the code to compile.

Having now properly fixed uplevel() to work on 5.23.8, and since uplevel
under 5.23.8 uses an entirely separate code path, only 5.23.7 and earlier
make use of CX_ARGARRAY() and _set(), so eliminate these macros and
revert back to the original usage (i.e. cx->blk_sub.argarray).

fix uplevel() under 5.23.8+

The old method of creating a new curstackinfo containing the faked-up
new context stack no longer works. This is because leave_scope() is now
called just prior to each context stack entry popping, and so a destructor
which restores the old context array leaves a dangling pointer.

E.g. pp_leavesub() on 5.23.8 onwards looks something like:

    cx = CX_CUR();
    ....
    CX_LEAVE_SCOPE(cx);

    /* at this point the destructor has been called and the old context
     * stack back been restored; cx now points at freed garbage
    */
    cx_popsub(cx); /* SEGV */

Conversely, now that it's guaranteed that the save stack is always
processed prior to each context pop - regardless of whether its a normal
scope exit or an exception - it allows us to use a simpler method to fake
things up for uplevel(): just temporarily change the types of all the
higher contexts to CXt_NULL so that they won't be seen by caller() etc. On
scope exit the savestack destructor restores the old types, which are then
processed and popped as normal.

As well as setting each entry to CXt_NULL we set a flag,
CXp_SU_UPLEVEL_NULLED (whose bit is currently unused by the perl core)
to indicate that this is a temporarily ignored context.

We then introduce a distinction between logical and physical context stack
indices: functions like UP return a logical index which ignore all the
nulled-out contexts; when such a logical value is passed as an arg to a
function such as localize(), it is first converted back to a real index.

The other main change is how uplevel() doctors the sub's arg list as seen
by caller(): previously this was done by modifying the argarray field of
the context entry for the just-called sub. Since 5.23.8 onwards doesn't
have an argarray field, we instead modify the pad[0] of the running sub
(which is what caller() examines now). Since there's no longer a
possibility of getting argarray and pad[0] out of sync, the special fixups
formerly required in the presence of goto are no longer required.

Rather than rolling our own OP_ENTERSUB op, we just use call_sv()
instead, with a PL_runops pointing to a temporary hook that allows the
args to be fixed up on return from pp_entersub. After that, a normal
runops loop is called.

Since uplevel is so different under 5.23.8, I've split the original
functions into

    su_uplevel_old/su_uplevel_new
    su_uplevel_restore_old/su_uplevel_restore_new

with #defines compiling only one set.

su_uplevel: populate lower stack frames properly

When creating a temporary new argument stack, su_uplevel() copies most of
the old stack to a new one. This isn't really needed, as the new stack
will be abandoned before it ever pops back to that level.  But it *is*
needed when debugging code prints out the stack, as in for example,
'perl -Dstv'.

However, the code didn't actually copy the old stack: it copied garbage
instead, since it was using PL_curstack rather than AvARRAY(PL_curstack)
as the address of of the old stack. Which was causing 'perl -Dstv' to
SEGV.

This commit fixes that.

fix unwind()

Perl 5.23.4 debugging builds added asserts to POPMARK etc that nothing
was underflowing etc. At this point 52-unwind-context.t started failing
with

    Perl_pp_return: Assertion `((my_perl->Imarkstack_ptr) >
    (my_perl->Imarkstack)) || !"MARK underflow"' failed.

Properly pushing a new mark for pp_return to pop rather than doing it
manually seems to fix this.

get su_init/su_pop working under 5.23.8

In 5.23.8 there are two big differences to the way perl's context system
manipulates the savestack. Firstly, pushing a scope no longer does one or
two ENTER's instead the old value of PL_savestack_ix is stored as
cx->blk_oldsaveix. This means that the boundaries of savestack frames are
now not only specified as scopestack entries, but also as blk_oldsaveix
entries.

Secondly, most values that need restoring are saved in new fields in the
CX structure rather than being pushed on the savestack; this means that it
is quite likely that two nested scopes can share the same savestack index.

This commit gets all the test scripts working that mainly test the
savestack manipulation code (su_init and su_pop).

It does this by:

*) allowing the offset by which a savestack frame boundary is adjusted to
be variable (rather than always SU_SAVE_DESTRUCTOR_SIZE), and by turning
the origin array into an array of structs, one field of which is the
offset for that depth. This allows multiple empty savestack frames
to all trigger, by ensuring that each adjusted boundary is higher than the
previous.

*) padding the savestack using SAVEt_ALLOC, which allows a variable-sized
chunk of savestack to be reserved, with minimal overhead during scope exit.

In addition,

*) the various SU_SAVE_AELEM_SIZE type macros have been rationalised and
better commented;
*) debugging output for su_init and su_pop has been improved
*) the names of context types (for debugging) have been updated for 5.23.8
and some errors fixes for older perl versions

Some basic 5.23.8 fixes

The context system has changed a lot in 5.23.8. This commit
just gets the code compiling again; it doesn';t attempt to fix any
breakage.

Temporarily rename xsh_debug_log to su_debug_log

In a previous commit that function was renamed, but none of its callers
were renamed. For now, revert the function back to its old name

Fix off-by-one error in su_uplevel_ud->si initialization

si->si_cxmax is the last available context slot, hence should be -1 if we
don't allocate any.

The Big Boilerplate Factorization

This is 0.28

Don't hardcode the length of NEGATIVE_INDICES_VAR

Only dump debug info when $Scope::Upper::DEBUG is true

Factor a part of the debugging logic into an helper function

Add braces around a condition block

Add a comment in the initializing loop in su_init()

Document the new warnings and caveats

Add some comments to the mysterious su_init()/su_pop()

Remove one level of indirection in the UID internal structure

On top of the memory savings, this seems to make the UID stress test about
7% faster, even with a threaded build.

Port t/79-uid-threads.t to the new threads interface

For some reason it was still calling threads->create(). This commit also
makes sure that the test is resilient to stray exits.

Harden t/69-uplevel-threads.t against stray exits

Harden t/59-yield-threads.t against stray exits

Harden t/54-unwind-threads.t against stray exits

Harden t/09-load-tests.t against stray exits

Update VPIT::TestHelpers to ba865c42

Also warn when SUB() and EVAL() cannot find an appropriate target

Warn when the words target a context outside of the current stack

Note that the check is done when the target context is defined and not
when the helpers use it.

This fixes RT #104751.

Stop copying the reap-ed coderef

Remove some extraneous SU_UD_ORIGIN(ud) initializations

Revamp the different su_ud_* subtypes

For reap(), su_call() now only gets the SV cb and not the whole su_ud_reap
structure. This lets us free the ud in su_pop(), and likewise for
su_localize(). As for the uid feature, it gets its own su_ud_uid structure
instead of hijacking su_ud_reap, so that su_uid_bump() is no longer needed.

Replace the su_handler[] dispatch table by a switch

This lets us inline the handlers in su_pop(), which is somewhat clearer.

Remove the code coverage link

It's outdated and now covered by cpancover.

Refactor the su_ud_common structure

The handler member is replaced by a small integer index into a static array.
The pad member is shrank so that it can be packed together with the type.
In the remaining space, we fit a private member that can be used to remove
the type member of su_ud_localize.

Greatly simplify the depth computation in su_init()

In order to count how many scopes we will have to pop, it is enough to take
the difference between the current scope (PL_scopestack_ix) and the one
just below the target context (cxstack[cxix].blk_oldscopesp).

Give a proper definition of SU_CXNAME() for non DEBUGGING builds

Rewrite the origin initialization loop in su_init()

It used to iterate downward, and then the indices used were of the form
a - i and b - i.

Silence a 'shadowing' warning

Update t/09-load-threads.t

It now also exercises cloning.

Update VPIT::TestHelpers to 2a6ac0f1

Update t/09-load-threads.t

It now has better diagnostics in case of failure, and it tests asymetrical
thread termination.

Add a missing volatile qualifier

Improve scheduling for the parallel loading test

This is 0.27

Document that we can no longer die from uplevel in the debugger

Also preserve PL_scopestack[cx->blk_oldscopesp - 1] in formats

Correctly use $TEST_VERBOSE in the testdeb target

Preserve PL_scopestack[cx->blk_oldscopesp - 1] in su_pop()

Starting from perl 5.19.4 commit 2537512, pp_leavesub does a second
leave_scope(PL_scopestack[cx->blk_oldscopesp - 1]) just after the usual
LEAVE call. However, this index in the scope stack may be overwritten
by our own "flush" leave_scope() call in su_pop(). More precisely, this
seems to happen in sv_clear() (called from sv_free2() called from
sv_unref_flags() called from sv_force_normal_flags() called from
leave_scope()) and only when the debugger is enabled.

Add POSIX to build requires

Update the ActivePerl/gcc-3.4 hack for EUMM 7.04

Starting from this version, PERL_ARCHIVE is quoted so we can no longer set
it to the empty string. Instead, we remove all occurrences of PERL_ARCHIVE
in the linking step section of the Makefile, which is OK since we specify
the perl DLL in other variables. This new technique is still valid for
older versions of EUMM.

Don't compile su_uplevel_storage_delete() before perl 5.13.7

As it is unused on these older perls.

Protect t/09-load-threads.t against old relocated perls

Update VPIT::TestHelpers to 4eeb5afc

Also test that the module can be loaded in the main body

In t/09-load-threads.t, handle spawn() failures gracefully

Thoroughly test module loading in threads

Update VPIT::TestHelpers to 6ca15279

Update VPIT::TestHelpers to 6cd68168

And port threads tests to its new interface. The new 'force threads test'
environment variable is PERL_FORCE_TEST_THREADS.

Release UID global memory at global teardown time

Revamp the setup boot logic

Silence an "unused label" compiler warning

Replace STATIC by static