summaryrefslogtreecommitdiffstats
path: root/upstream/archlinux/man3/Internals.3perl
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
commitfc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch)
treece1e3bce06471410239a6f41282e328770aa404a /upstream/archlinux/man3/Internals.3perl
parentInitial commit. (diff)
downloadmanpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz
manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/archlinux/man3/Internals.3perl')
-rw-r--r--upstream/archlinux/man3/Internals.3perl130
1 files changed, 130 insertions, 0 deletions
diff --git a/upstream/archlinux/man3/Internals.3perl b/upstream/archlinux/man3/Internals.3perl
new file mode 100644
index 00000000..7e350842
--- /dev/null
+++ b/upstream/archlinux/man3/Internals.3perl
@@ -0,0 +1,130 @@
+.\" -*- mode: troff; coding: utf-8 -*-
+.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
+.\"
+.\" 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
+..
+.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
+.ie n \{\
+. ds C` ""
+. ds C' ""
+'br\}
+.el\{\
+. ds C`
+. ds C'
+'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 >0, 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.
+.\"
+.\" Avoid warning from groff about undefined register 'F'.
+.de IX
+..
+.nr rF 0
+.if \n(.g .if rF .nr rF 1
+.if (\n(rF:(\n(.g==0)) \{\
+. if \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. if !\nF==2 \{\
+. nr % 0
+. nr F 2
+. \}
+. \}
+.\}
+.rr rF
+.\" ========================================================================
+.\"
+.IX Title "Internals 3perl"
+.TH Internals 3perl 2024-02-11 "perl v5.38.2" "Perl Programmers Reference Guide"
+.\" 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
+Internals \- Reserved special namespace for internals related functions
+.SH SYNOPSIS
+.IX Header "SYNOPSIS"
+.Vb 3
+\& $is_ro= Internals::SvREADONLY($x)
+\& $refcnt= Internals::SvREFCNT($x)
+\& hv_clear_placeholders(%hash);
+.Ve
+.SH DESCRIPTION
+.IX Header "DESCRIPTION"
+The Internals namespace is used by the core Perl development team to
+expose certain low level internals routines for testing and other purposes.
+.PP
+In theory these routines were not and are not intended to be used outside
+of the perl core, and are subject to change and removal at any time.
+.PP
+In practice people have come to depend on these over the years, despite
+being historically undocumented, so we will provide some level of
+forward compatibility for some time. Nevertheless you can assume that any
+routine documented here is experimental or deprecated and you should find
+alternatives to their use.
+.SS FUNCTIONS
+.IX Subsection "FUNCTIONS"
+.ie n .IP "SvREFCNT(THING [, $value])" 4
+.el .IP "SvREFCNT(THING [, \f(CW$value\fR])" 4
+.IX Item "SvREFCNT(THING [, $value])"
+Historically Perl has been a refcounted language. This means that each
+variable tracks how many things reference it, and when the variable is no
+longer referenced it will automatically free itself. In theory Perl code
+should not have to care about this, and in a future version Perl might
+change to some other strategy, although in practice this is unlikely.
+.Sp
+This function allows one to violate the abstraction of variables and get
+or set the refcount of a variable, and in generally is really only useful
+in code that is testing refcount behavior.
+.Sp
+*NOTE* You are strongly discouraged from using this function in non-test
+code and especially discouraged from using the set form of this function.
+The results of doing so may result in segmentation faults or other undefined
+behavior.
+.ie n .IP "SvREADONLY(THING, [, $value])" 4
+.el .IP "SvREADONLY(THING, [, \f(CW$value\fR])" 4
+.IX Item "SvREADONLY(THING, [, $value])"
+Set or get whether a variable is readonly or not. Exactly what the
+readonly flag means depend on the type of the variable affected and the
+version of perl used.
+.Sp
+You are strongly discouraged from using this function directly. It is used
+by various core modules, like \f(CW\*(C`Hash::Util\*(C'\fR, and the \f(CW\*(C`constant\*(C'\fR pragma
+to implement higher-level behavior which should be used instead.
+.Sp
+See the core implementation for the exact meaning of the readonly flag for
+each internal variable type.
+.IP hv_clear_placeholders(%hash) 4
+.IX Item "hv_clear_placeholders(%hash)"
+Clear any placeholders from a locked hash. Should not be used directly.
+You should use the wrapper functions provided by Hash::Util instead.
+As of 5.25 also available as \f(CW Hash::Util::_clear_placeholders(%hash) \fR
+.SH AUTHOR
+.IX Header "AUTHOR"
+Perl core development team.
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+perlguts
+Hash::Util
+constant
+universal.c