Debian Codegraph @

upstream/debian-unstable/man3/Test2::Util::Stash.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::Util::Stash 3perl"
58 .TH Test2::Util::Stash 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::Util::Stash \- Utilities for manipulating stashes and globs.
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 This is a collection of utilities for manipulating and inspecting package
68 stashes and globs.
69 .SH EXPORTS
70 .IX Header "EXPORTS"
71 .ie n .IP "$stash = get_stash($package)" 4
72 .el .IP "\f(CW$stash\fR = get_stash($package)" 4
73 .IX Item "$stash = get_stash($package)"
74 Gets the package stash. This is the same as \f(CW\*(C`$stash = \e%Package::Name::\*(C'\fR.
75 .ie n .IP "$sym_spec = parse_symbol($symbol)" 4
76 .el .IP "\f(CW$sym_spec\fR = parse_symbol($symbol)" 4
77 .IX Item "$sym_spec = parse_symbol($symbol)"
78 .PD 0
79 .ie n .IP "$sym_spec = parse_symbol($symbol, $package)" 4
80 .el .IP "\f(CW$sym_spec\fR = parse_symbol($symbol, \f(CW$package\fR)" 4
81 .IX Item "$sym_spec = parse_symbol($symbol, $package)"
82 .PD
83 Parse a symbol name, and return a hashref with info about the symbol.
84 .Sp
85 \&\f(CW$symbol\fR can be a simple name, or a fully qualified symbol name. The sigil is
86 optional, and \f(CW\*(C`&\*(C'\fR is assumed if none is provided. If \f(CW$symbol\fR is fully qualified,
87 and \f(CW$package\fR is also provided, then the package of the symbol must match the
88 \&\f(CW$package\fR.
89 .Sp
90 Returns a structure like this:
91 .Sp
92 .Vb 7
93 \& return {
94 \& name => \*(AqBAZ\*(Aq,
95 \& sigil => \*(Aq$\*(Aq,
96 \& type => \*(AqSCALAR\*(Aq,
97 \& symbol => \*(Aq&Foo::Bar::BAZ\*(Aq,
98 \& package => \*(AqFoo::Bar\*(Aq,
99 \& };
100 .Ve
101 .ie n .IP "$glob_ref = get_glob($symbol)" 4
102 .el .IP "\f(CW$glob_ref\fR = get_glob($symbol)" 4
103 .IX Item "$glob_ref = get_glob($symbol)"
104 .PD 0
105 .ie n .IP "$glob_ref = get_glob($symbol, $package)" 4
106 .el .IP "\f(CW$glob_ref\fR = get_glob($symbol, \f(CW$package\fR)" 4
107 .IX Item "$glob_ref = get_glob($symbol, $package)"
108 .PD
109 Get a glob ref. Arguments are the same as for \f(CW\*(C`parse_symbol\*(C'\fR.
110 .ie n .IP "$ref = get_symbol($symbol)" 4
111 .el .IP "\f(CW$ref\fR = get_symbol($symbol)" 4
112 .IX Item "$ref = get_symbol($symbol)"
113 .PD 0
114 .ie n .IP "$ref = get_symbol($symbol, $package)" 4
115 .el .IP "\f(CW$ref\fR = get_symbol($symbol, \f(CW$package\fR)" 4
116 .IX Item "$ref = get_symbol($symbol, $package)"
117 .PD
118 Get a reference to the symbol. Arguments are the same as for \f(CW\*(C`parse_symbol\*(C'\fR.
119 .ie n .IP "$ref = purge_symbol($symbol)" 4
120 .el .IP "\f(CW$ref\fR = purge_symbol($symbol)" 4
121 .IX Item "$ref = purge_symbol($symbol)"
122 .PD 0
123 .ie n .IP "$ref = purge_symbol($symbol, $package)" 4
124 .el .IP "\f(CW$ref\fR = purge_symbol($symbol, \f(CW$package\fR)" 4
125 .IX Item "$ref = purge_symbol($symbol, $package)"
126 .PD
127 Completely remove the symbol from the package symbol table. Arguments are the
128 same as for \f(CW\*(C`parse_symbol\*(C'\fR. A reference to the removed symbol is returned.
129 .ie n .IP "$sig = slot_to_sig($slot)" 4
130 .el .IP "\f(CW$sig\fR = slot_to_sig($slot)" 4
131 .IX Item "$sig = slot_to_sig($slot)"
132 Convert a slot (like 'SCALAR') to a sigil (like '$').
133 .ie n .IP "$slot = sig_to_slot($sig)" 4
134 .el .IP "\f(CW$slot\fR = sig_to_slot($sig)" 4
135 .IX Item "$slot = sig_to_slot($sig)"
136 Convert a sigil (like '$') to a slot (like 'SCALAR').
137 .SH SOURCE
138 .IX Header "SOURCE"
139 The source code repository for Test2\-Suite can be found at
140 \&\fIhttps://github.com/Test\-More/Test2\-Suite/\fR.
141 .SH MAINTAINERS
142 .IX Header "MAINTAINERS"
143 .IP "Chad Granum <[email protected]>" 4
144 .IX Item "Chad Granum <[email protected]>"
145 .SH AUTHORS
146 .IX Header "AUTHORS"
147 .PD 0
148 .IP "Chad Granum <[email protected]>" 4
149 .IX Item "Chad Granum <[email protected]>"
150 .PD
151 .SH COPYRIGHT
152 .IX Header "COPYRIGHT"
153 Copyright 2018 Chad Granum <[email protected]>.
154 .PP
155 This program is free software; you can redistribute it and/or
156 modify it under the same terms as Perl itself.
157 .PP
158 See \fIhttp://dev.perl.org/licenses/\fR