.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.13)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.el \{\
. de IX
..
.\}
.\" ========================================================================
.\"
.IX Title "Test2::Util::Stash 3"
.TH Test2::Util::Stash 3 "2019-05-18" "perl v5.10.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Test2::Util::Stash \- Utilities for manipulating stashes and globs.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a collection of utilities for manipulating and inspecting package
stashes and globs.
.SH "EXPORTS"
.IX Header "EXPORTS"
.ie n .IP "$stash = get_stash($package)" 4
.el .IP "\f(CW$stash\fR = get_stash($package)" 4
.IX Item "$stash = get_stash($package)"
Gets the package stash. This is the same as \f(CW\*(C`$stash = \e%Package::Name::\*(C'\fR.
.ie n .IP "$sym_spec = parse_symbol($symbol)" 4
.el .IP "\f(CW$sym_spec\fR = parse_symbol($symbol)" 4
.IX Item "$sym_spec = parse_symbol($symbol)"
.PD 0
.ie n .IP "$sym_spec = parse_symbol($symbol, $package)" 4
.el .IP "\f(CW$sym_spec\fR = parse_symbol($symbol, \f(CW$package\fR)" 4
.IX Item "$sym_spec = parse_symbol($symbol, $package)"
.PD
Parse a symbol name, and return a hashref with info about the symbol.
.Sp
\&\f(CW$symbol\fR can be a simple name, or a fully qualified symbol name. The sigil is
optional, and \f(CW\*(C`&\*(C'\fR is assumed if none is provided. If \f(CW$symbol\fR is fully qualified,
and \f(CW$package\fR is also provided, then the package of the symbol must match the
\&\f(CW$package\fR.
.Sp
Returns a structure like this:
.Sp
.Vb 7
\& return {
\& name => \*(AqBAZ\*(Aq,
\& sigil => \*(Aq$\*(Aq,
\& type => \*(AqSCALAR\*(Aq,
\& symbol => \*(Aq&Foo::Bar::BAZ\*(Aq,
\& package => \*(AqFoo::Bar\*(Aq,
\& };
.Ve
.ie n .IP "$glob_ref = get_glob($symbol)" 4
.el .IP "\f(CW$glob_ref\fR = get_glob($symbol)" 4
.IX Item "$glob_ref = get_glob($symbol)"
.PD 0
.ie n .IP "$glob_ref = get_glob($symbol, $package)" 4
.el .IP "\f(CW$glob_ref\fR = get_glob($symbol, \f(CW$package\fR)" 4
.IX Item "$glob_ref = get_glob($symbol, $package)"
.PD
Get a glob ref. Arguments are the same as for \f(CW\*(C`parse_symbol\*(C'\fR.
.ie n .IP "$ref = get_symbol($symbol)" 4
.el .IP "\f(CW$ref\fR = get_symbol($symbol)" 4
.IX Item "$ref = get_symbol($symbol)"
.PD 0
.ie n .IP "$ref = get_symbol($symbol, $package)" 4
.el .IP "\f(CW$ref\fR = get_symbol($symbol, \f(CW$package\fR)" 4
.IX Item "$ref = get_symbol($symbol, $package)"
.PD
Get a reference to the symbol. Arguments are the same as for \f(CW\*(C`parse_symbol\*(C'\fR.
.ie n .IP "$ref = purge_symbol($symbol)" 4
.el .IP "\f(CW$ref\fR = purge_symbol($symbol)" 4
.IX Item "$ref = purge_symbol($symbol)"
.PD 0
.ie n .IP "$ref = purge_symbol($symbol, $package)" 4
.el .IP "\f(CW$ref\fR = purge_symbol($symbol, \f(CW$package\fR)" 4
.IX Item "$ref = purge_symbol($symbol, $package)"
.PD
Completely remove the symbol from the package symbol table. Arguments are the
same as for \f(CW\*(C`parse_symbol\*(C'\fR. A reference to the removed symbol is returned.
.ie n .IP "$sig = slot_to_sig($slot)" 4
.el .IP "\f(CW$sig\fR = slot_to_sig($slot)" 4
.IX Item "$sig = slot_to_sig($slot)"
Convert a slot (like '\s-1SCALAR\s0') to a sigil (like '$').
.ie n .IP "$slot = sig_to_slot($sig)" 4
.el .IP "\f(CW$slot\fR = sig_to_slot($sig)" 4
.IX Item "$slot = sig_to_slot($sig)"
Convert a sigil (like '$') to a slot (like '\s-1SCALAR\s0').
.SH "SOURCE"
.IX Header "SOURCE"
The source code repository for Test2\-Suite can be found at
\&\fIhttps://github.com/Test\-More/Test2\-Suite/\fR.
.SH "MAINTAINERS"
.IX Header "MAINTAINERS"
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.SH "AUTHORS"
.IX Header "AUTHORS"
.PD 0
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.PD
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2018 Chad Granum <exodist@cpan.org>.
.PP
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.PP
See \fIhttp://dev.perl.org/licenses/\fR
Copyright 2K16 - 2K18 Indonesian Hacker Rulez