Debian Codegraph @

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