/usr/local/lp/sonarperl/man/man3/ Current File: //usr/local/lp/sonarperl/man/man3/autodie::Scope::GuardStack.3
.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "autodie::Scope::GuardStack 3"
.TH autodie::Scope::GuardStack 3 2023-05-26 "perl v5.38.0" "Perl Programmers Reference Guide"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
autodie::Scope::GuardStack \-  Hook stack for managing scopes via %^H
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\&    use autodie::Scope::GuardStack;
\&    my $stack = autodie::Scope::GuardStack\->new
\&    $^H{\*(Aqmy\-key\*(Aq} = $stack;
\&
\&    $stack\->push_hook(sub {});
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This class is a stack of hooks to be called in the right order as
scopes go away.  The stack is only useful when inserted into \f(CW\*(C`%^H\*(C'\fR
and will pop hooks as their "scope" is popped.  This is useful for
uninstalling or reinstalling subs in a namespace as a pragma goes
out of scope.
.PP
Due to how \f(CW\*(C`%^H\*(C'\fR works, this class is only useful during the
compilation phase of a perl module and relies on the internals of how
perl handles references in \f(CW\*(C`%^H\*(C'\fR.  This module is not a part of
autodie's public API.
.SS Methods
.IX Subsection "Methods"
\fInew\fR
.IX Subsection "new"
.PP
.Vb 1
\&  my $stack = autodie::Scope::GuardStack\->new;
.Ve
.PP
Creates a new \f(CW\*(C`autodie::Scope::GuardStack\*(C'\fR.  The stack is initially
empty and must be inserted into \f(CW\*(C`%^H\*(C'\fR by the creator.
.PP
\fIpush_hook\fR
.IX Subsection "push_hook"
.PP
.Vb 1
\&  $stack\->push_hook(sub {});
.Ve
.PP
Add a sub to the stack.  The sub will be called once the current
compile-time "scope" is left.  Multiple hooks can be added per scope
.SH AUTHOR
.IX Header "AUTHOR"
Copyright 2013, Niels Thykier <niels@thykier.net>
.SH LICENSE
.IX Header "LICENSE"
This module is free software.  You may distribute it under the
same terms as Perl itself.