Debian Codegraph @

upstream/mageia-cauldron/man3pm/autodie::Scope::GuardStack.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "autodie::Scope::GuardStack 3pm"
61 .TH autodie::Scope::GuardStack 3pm 2023-12-30 "perl v5.42.0" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 autodie::Scope::GuardStack \- Hook stack for managing scopes via %^H
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 3
71 \& use autodie::Scope::GuardStack;
72 \& my $stack = autodie::Scope::GuardStack\->new
73 \& $^H{\*(Aqmy\-key\*(Aq} = $stack;
74 \&
75 \& $stack\->push_hook(sub {});
76 .Ve
77 .SH DESCRIPTION
78 .IX Header "DESCRIPTION"
79 This class is a stack of hooks to be called in the right order as
80 scopes go away. The stack is only useful when inserted into \f(CW\*(C`%^H\*(C'\fR
81 and will pop hooks as their "scope" is popped. This is useful for
82 uninstalling or reinstalling subs in a namespace as a pragma goes
83 out of scope.
84 .PP
85 Due to how \f(CW\*(C`%^H\*(C'\fR works, this class is only useful during the
86 compilation phase of a perl module and relies on the internals of how
87 perl handles references in \f(CW\*(C`%^H\*(C'\fR. This module is not a part of
88 autodie\*(Aqs public API.
89 .SS Methods
90 .IX Subsection "Methods"
91 \fInew\fR
92 .IX Subsection "new"
93 .PP
94 .Vb 1
95 \& my $stack = autodie::Scope::GuardStack\->new;
96 .Ve
97 .PP
98 Creates a new \f(CW\*(C`autodie::Scope::GuardStack\*(C'\fR. The stack is initially
99 empty and must be inserted into \f(CW\*(C`%^H\*(C'\fR by the creator.
100 .PP
101 \fIpush_hook\fR
102 .IX Subsection "push_hook"
103 .PP
104 .Vb 1
105 \& $stack\->push_hook(sub {});
106 .Ve
107 .PP
108 Add a sub to the stack. The sub will be called once the current
109 compile\-time "scope" is left. Multiple hooks can be added per scope
110 .SH AUTHOR
111 .IX Header "AUTHOR"
112 Copyright 2013, Niels Thykier <[email protected]>
113 .SH LICENSE
114 .IX Header "LICENSE"
115 This module is free software. You may distribute it under the
116 same terms as Perl itself.