Debian Codegraph @

upstream/debian-unstable/man3/autodie::Scope::GuardStack.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "autodie::Scope::GuardStack 3perl"
58 .TH autodie::Scope::GuardStack 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 autodie::Scope::GuardStack \- Hook stack for managing scopes via %^H
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 3
68 \& use autodie::Scope::GuardStack;
69 \& my $stack = autodie::Scope::GuardStack\->new
70 \& $^H{\*(Aqmy\-key\*(Aq} = $stack;
71 \&
72 \& $stack\->push_hook(sub {});
73 .Ve
74 .SH DESCRIPTION
75 .IX Header "DESCRIPTION"
76 This class is a stack of hooks to be called in the right order as
77 scopes go away. The stack is only useful when inserted into \f(CW\*(C`%^H\*(C'\fR
78 and will pop hooks as their "scope" is popped. This is useful for
79 uninstalling or reinstalling subs in a namespace as a pragma goes
80 out of scope.
81 .PP
82 Due to how \f(CW\*(C`%^H\*(C'\fR works, this class is only useful during the
83 compilation phase of a perl module and relies on the internals of how
84 perl handles references in \f(CW\*(C`%^H\*(C'\fR. This module is not a part of
85 autodie's public API.
86 .SS Methods
87 .IX Subsection "Methods"
88 \fInew\fR
89 .IX Subsection "new"
90 .PP
91 .Vb 1
92 \& my $stack = autodie::Scope::GuardStack\->new;
93 .Ve
94 .PP
95 Creates a new \f(CW\*(C`autodie::Scope::GuardStack\*(C'\fR. The stack is initially
96 empty and must be inserted into \f(CW\*(C`%^H\*(C'\fR by the creator.
97 .PP
98 \fIpush_hook\fR
99 .IX Subsection "push_hook"
100 .PP
101 .Vb 1
102 \& $stack\->push_hook(sub {});
103 .Ve
104 .PP
105 Add a sub to the stack. The sub will be called once the current
106 compile-time "scope" is left. Multiple hooks can be added per scope
107 .SH AUTHOR
108 .IX Header "AUTHOR"
109 Copyright 2013, Niels Thykier <[email protected]>
110 .SH LICENSE
111 .IX Header "LICENSE"
112 This module is free software. You may distribute it under the
113 same terms as Perl itself.