Debian Codegraph @

upstream/debian-unstable/man3/Test2::Manual::Tooling::Plugin::ToolCompletes.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 "Test2::Manual::Tooling::Plugin::ToolCompletes 3perl"
58 .TH Test2::Manual::Tooling::Plugin::ToolCompletes 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 Test2::Manual::Tooling::Plugin::ToolCompletes \- How to add behaviors that occur
65 when a tool completes work.
66 .SH DESCRIPTION
67 .IX Header "DESCRIPTION"
68 This tutorial helps you understand how to add behaviors that occur when a tool
69 is done with its work. All tools need to acquire and then release a context,
70 for this tutorial we make use of the release hooks that are called every time a
71 tool releases the context object.
72 .SH "COMPLETE CODE UP FRONT"
73 .IX Header "COMPLETE CODE UP FRONT"
74 .Vb 1
75 \& package Test2::Plugin::MyPlugin;
76 \&
77 \& use Test2::API qw{test2_add_callback_context_release};
78 \&
79 \& sub import {
80 \& my $class = shift;
81 \&
82 \& test2_add_callback_context_release(sub {
83 \& my $ctx_ref = shift;
84 \&
85 \& print "Context was released\en";
86 \& });
87 \& }
88 \&
89 \& 1;
90 .Ve
91 .SH "LINE BY LINE"
92 .IX Header "LINE BY LINE"
93 .IP "use Test2::API qw{test2_add_callback_context_release};" 4
94 .IX Item "use Test2::API qw{test2_add_callback_context_release};"
95 This imports the \f(CWtest2_add_callback_context_release()\fR callback.
96 .IP "test2_add_callback_context_release(sub { ... })" 4
97 .IX Item "test2_add_callback_context_release(sub { ... })"
98 .PD 0
99 .ie n .IP "my $ctx_ref = shift" 4
100 .el .IP "my \f(CW$ctx_ref\fR = shift" 4
101 .IX Item "my $ctx_ref = shift"
102 .PD
103 The coderefs for \fBtest2_add_callback_context_release()\fR will receive exactly 1
104 argument, the context being released.
105 .IP "print ""Context was released\en""" 4
106 .IX Item "print ""Context was releasedn"""
107 Print a notification whenever the context is released.
108 .SH "SEE ALSO"
109 .IX Header "SEE ALSO"
110 Test2::Manual \- Primary index of the manual.
111 .SH SOURCE
112 .IX Header "SOURCE"
113 The source code repository for Test2\-Manual can be found at
114 \&\fIhttps://github.com/Test\-More/Test2\-Suite/\fR.
115 .SH MAINTAINERS
116 .IX Header "MAINTAINERS"
117 .IP "Chad Granum <[email protected]>" 4
118 .IX Item "Chad Granum <[email protected]>"
119 .SH AUTHORS
120 .IX Header "AUTHORS"
121 .PD 0
122 .IP "Chad Granum <[email protected]>" 4
123 .IX Item "Chad Granum <[email protected]>"
124 .PD
125 .SH COPYRIGHT
126 .IX Header "COPYRIGHT"
127 Copyright 2018 Chad Granum <[email protected]>.
128 .PP
129 This program is free software; you can redistribute it and/or
130 modify it under the same terms as Perl itself.
131 .PP
132 See \fIhttp://dev.perl.org/licenses/\fR