This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perlretut: use a numbered list to format a numbered list
[perl5.git] / gv.c
CommitLineData
a0d0e21e 1/* gv.c
79072805 2 *
1129b882 3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
67fbe0e1 4 * 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall and others
79072805
LW
5 *
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
8 *
a0d0e21e
LW
9 */
10
11/*
12 * 'Mercy!' cried Gandalf. 'If the giving of information is to be the cure
4ac71550 13 * of your inquisitiveness, I shall spend all the rest of my days in answering
a0d0e21e
LW
14 * you. What more do you want to know?'
15 * 'The names of all the stars, and of all living things, and the whole
16 * history of Middle-earth and Over-heaven and of the Sundering Seas,'
17 * laughed Pippin.
4ac71550 18 *
cdad3b53 19 * [p.599 of _The Lord of the Rings_, III/xi: "The Palantír"]
79072805
LW
20 */
21
ccfc67b7 22/*
f3d866f2 23=head1 GV Handling and Stashes
166f8a29
DM
24A GV is a structure which corresponds to to a Perl typeglob, ie *foo.
25It is a structure that holds a pointer to a scalar, an array, a hash etc,
26corresponding to $foo, @foo, %foo.
27
28GVs are usually found as values in stashes (symbol table hashes) where
29Perl stores its global variables.
30
f3d866f2
KW
31A B<stash> is a hash that contains all variables that are defined
32within a package. See L<perlguts/Stashes and Globs>
33
fa2b244a
KW
34=for apidoc Ayh||GV
35
166f8a29 36=cut
ccfc67b7
JH
37*/
38
79072805 39#include "EXTERN.h"
864dbfa3 40#define PERL_IN_GV_C
79072805 41#include "perl.h"
6ffcffbd 42#include "overload.inc"
4aaa4757 43#include "keywords.h"
2846acbf 44#include "feature.h"
79072805 45
f54cb97a 46static const char S_autoload[] = "AUTOLOAD";
3c81f0b3 47#define S_autolen (sizeof("AUTOLOAD")-1)
5c7983e5 48
c8a452ed
KW
49/*
50=for apidoc gv_add_by_type
51
52Make sure there is a slot of type C<type> in the GV C<gv>.
53
54=cut
55*/
56
13c59d41
MH
57GV *
58Perl_gv_add_by_type(pTHX_ GV *gv, svtype type)
c69033f2 59{
d5713896 60 SV **where;
7918f24d 61
13c59d41
MH
62 if (
63 !gv
64 || (
65 SvTYPE((const SV *)gv) != SVt_PVGV
13be902c 66 && SvTYPE((const SV *)gv) != SVt_PVLV
13c59d41 67 )
13be902c 68 ) {
1604cfb0
MS
69 const char *what;
70 if (type == SVt_PVIO) {
71 /*
72 * if it walks like a dirhandle, then let's assume that
73 * this is a dirhandle.
74 */
75 what = OP_IS_DIRHOP(PL_op->op_type) ?
76 "dirhandle" : "filehandle";
77 } else if (type == SVt_PVHV) {
78 what = "hash";
79 } else {
80 what = type == SVt_PVAV ? "array" : "scalar";
81 }
1604cfb0 82 Perl_croak(aTHX_ "Bad symbol for %s", what);
bb85b28a 83 }
d5713896 84
13c59d41 85 if (type == SVt_PVHV) {
1604cfb0 86 where = (SV **)&GvHV(gv);
13c59d41 87 } else if (type == SVt_PVAV) {
1604cfb0 88 where = (SV **)&GvAV(gv);
13c59d41 89 } else if (type == SVt_PVIO) {
1604cfb0 90 where = (SV **)&GvIOp(gv);
13c59d41 91 } else {
1604cfb0 92 where = &GvSV(gv);
13c59d41 93 }
7918f24d 94
13c59d41
MH
95 if (!*where)
96 {
1604cfb0 97 *where = newSV_type(type);
76d5f637
KW
98 if ( type == SVt_PVAV
99 && memEQs(GvNAME(gv), GvNAMELEN(gv), "ISA"))
100 {
1604cfb0 101 sv_magic(*where, (SV *)gv, PERL_MAGIC_isa, NULL, 0);
76d5f637 102 }
e17aed30 103 }
13c59d41 104 return gv;
79072805
LW
105}
106
b1decff3
KW
107/*
108=for apidoc gv_fetchfile
109=for apidoc_item gv_fetchfile_flags
110
111These return the debugger glob for the file (compiled by Perl) whose name is
112given by the C<name> parameter.
113
114There are currently exactly two differences between these functions.
115
116The C<name> parameter to C<gv_fetchfile> is a C string, meaning it is
117C<NUL>-terminated; whereas the C<name> parameter to C<gv_fetchfile_flags> is a
118Perl string, whose length (in bytes) is passed in via the C<namelen> parameter
119This means the name may contain embedded C<NUL> characters.
120C<namelen> doesn't exist in plain C<gv_fetchfile>).
121
122The other difference is that C<gv_fetchfile_flags> has an extra C<flags>
123parameter, which is currently completely ignored, but allows for possible
124future extensions.
125
126=cut
127*/
79072805 128GV *
864dbfa3 129Perl_gv_fetchfile(pTHX_ const char *name)
79072805 130{
7918f24d 131 PERL_ARGS_ASSERT_GV_FETCHFILE;
d9095cec
NC
132 return gv_fetchfile_flags(name, strlen(name), 0);
133}
134
135GV *
136Perl_gv_fetchfile_flags(pTHX_ const char *const name, const STRLEN namelen,
1604cfb0 137 const U32 flags)
d9095cec 138{
4116122e 139 char smallbuf[128];
53d95988 140 char *tmpbuf;
d9095cec 141 const STRLEN tmplen = namelen + 2;
79072805
LW
142 GV *gv;
143
7918f24d 144 PERL_ARGS_ASSERT_GV_FETCHFILE_FLAGS;
d9095cec
NC
145 PERL_UNUSED_ARG(flags);
146
1d7c1841 147 if (!PL_defstash)
1604cfb0 148 return NULL;
1d7c1841 149
d9095cec 150 if (tmplen <= sizeof smallbuf)
1604cfb0 151 tmpbuf = smallbuf;
53d95988 152 else
1604cfb0 153 Newx(tmpbuf, tmplen, char);
0ac0412a 154 /* This is where the debugger's %{"::_<$filename"} hash is created */
53d95988
CS
155 tmpbuf[0] = '_';
156 tmpbuf[1] = '<';
d9095cec 157 memcpy(tmpbuf + 2, name, namelen);
9c913148
TC
158 GV **gvp = (GV**)hv_fetch(PL_defstash, tmpbuf, tmplen, (flags & GVF_NOADD) ? FALSE : TRUE);
159 if (gvp) {
160 gv = *gvp;
161 if (!isGV(gv)) {
162 gv_init(gv, PL_defstash, tmpbuf, tmplen, FALSE);
c69033f2 163#ifdef PERL_DONT_CREATE_GVSV
9c913148 164 GvSV(gv) = newSVpvn(name, namelen);
c69033f2 165#else
9c913148 166 sv_setpvn(GvSV(gv), name, namelen);
c69033f2 167#endif
9c913148
TC
168 }
169 if (PERLDB_LINE_OR_SAVESRC && !GvAV(gv))
1604cfb0 170 hv_magic(GvHVn(gv), GvAVn(gv), PERL_MAGIC_dbfile);
9c913148
TC
171 }
172 else {
173 gv = NULL;
174 }
53d95988 175 if (tmpbuf != smallbuf)
1604cfb0 176 Safefree(tmpbuf);
79072805
LW
177 return gv;
178}
179
62d55b22
NC
180/*
181=for apidoc gv_const_sv
182
183If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
184inlining, or C<gv> is a placeholder reference that would be promoted to such
185a typeglob, then returns the value returned by the sub. Otherwise, returns
796b6530 186C<NULL>.
62d55b22
NC
187
188=cut
189*/
190
191SV *
192Perl_gv_const_sv(pTHX_ GV *gv)
193{
7918f24d 194 PERL_ARGS_ASSERT_GV_CONST_SV;
23491f1d 195 PERL_UNUSED_CONTEXT;
7918f24d 196
62d55b22 197 if (SvTYPE(gv) == SVt_PVGV)
1604cfb0 198 return cv_const_sv(GvCVu(gv));
16a6e5a4 199 return SvROK(gv) && SvTYPE(SvRV(gv)) != SVt_PVAV && SvTYPE(SvRV(gv)) != SVt_PVCV ? SvRV(gv) : NULL;
62d55b22
NC
200}
201
12816592
NC
202GP *
203Perl_newGP(pTHX_ GV *const gv)
204{
205 GP *gp;
19bad673 206 U32 hash;
19bad673
NC
207 const char *file;
208 STRLEN len;
209
7918f24d 210 PERL_ARGS_ASSERT_NEWGP;
2639089b
DD
211 Newxz(gp, 1, GP);
212 gp->gp_egv = gv; /* allow compiler to reuse gv after this */
213#ifndef PERL_DONT_CREATE_GVSV
8fcb2425 214 gp->gp_sv = newSV_type(SVt_NULL);
2639089b 215#endif
7918f24d 216
c947bc1d 217 /* PL_curcop may be null here. E.g.,
1604cfb0 218 INIT { bless {} and exit }
c947bc1d
FC
219 frees INIT before looking up DESTROY (and creating *DESTROY)
220 */
2639089b 221 if (PL_curcop) {
6760f691 222 char *tmp= CopFILE(PL_curcop);
1604cfb0 223 gp->gp_line = CopLINE(PL_curcop); /* 0 otherwise Newxz */
6760f691
YO
224
225 if (tmp) {
226 file = tmp;
227 len = CopFILE_LEN(PL_curcop);
1604cfb0 228 }
1604cfb0 229 else goto no_file;
cb0d3385
FC
230 }
231 else {
1604cfb0
MS
232 no_file:
233 file = "";
234 len = 0;
19bad673 235 }
f4890806
NC
236
237 PERL_HASH(hash, file, len);
f4890806 238 gp->gp_file_hek = share_hek(file, len, hash);
12816592
NC
239 gp->gp_refcnt = 1;
240
241 return gp;
242}
243
803f2748
DM
244/* Assign CvGV(cv) = gv, handling weak references.
245 * See also S_anonymise_cv_maybe */
246
247void
248Perl_cvgv_set(pTHX_ CV* cv, GV* gv)
249{
ae77754a 250 GV * const oldgv = CvNAMED(cv) ? NULL : SvANY(cv)->xcv_gv_u.xcv_gv;
b290562e 251 HEK *hek;
803f2748
DM
252 PERL_ARGS_ASSERT_CVGV_SET;
253
254 if (oldgv == gv)
1604cfb0 255 return;
803f2748
DM
256
257 if (oldgv) {
1604cfb0
MS
258 if (CvCVGV_RC(cv)) {
259 SvREFCNT_dec_NN(oldgv);
260 CvCVGV_RC_off(cv);
261 }
262 else {
263 sv_del_backref(MUTABLE_SV(oldgv), MUTABLE_SV(cv));
264 }
803f2748 265 }
db5cc3ee 266 else if ((hek = CvNAME_HEK(cv))) {
1604cfb0
MS
267 unshare_hek(hek);
268 CvLEXICAL_off(cv);
db5cc3ee 269 }
803f2748 270
5988f306 271 CvNAMED_off(cv);
b290562e 272 SvANY(cv)->xcv_gv_u.xcv_gv = gv;
c794ca97 273 assert(!CvCVGV_RC(cv));
803f2748
DM
274
275 if (!gv)
1604cfb0 276 return;
803f2748 277
c794ca97 278 if (isGV_with_GP(gv) && GvGP(gv) && (GvCV(gv) == cv || GvFORM(gv) == cv))
1604cfb0 279 Perl_sv_add_backref(aTHX_ MUTABLE_SV(gv), MUTABLE_SV(cv));
c794ca97 280 else {
1604cfb0
MS
281 CvCVGV_RC_on(cv);
282 SvREFCNT_inc_simple_void_NN(gv);
803f2748 283 }
803f2748
DM
284}
285
ae77754a
FC
286/* Convert CvSTASH + CvNAME_HEK into a GV. Conceptually, all subs have a
287 GV, but for efficiency that GV may not in fact exist. This function,
288 called by CvGV, reifies it. */
289
290GV *
291Perl_cvgv_from_hek(pTHX_ CV *cv)
292{
293 GV *gv;
2eaf799e 294 SV **svp;
ae77754a
FC
295 PERL_ARGS_ASSERT_CVGV_FROM_HEK;
296 assert(SvTYPE(cv) == SVt_PVCV);
297 if (!CvSTASH(cv)) return NULL;
298 ASSUME(CvNAME_HEK(cv));
2eaf799e 299 svp = hv_fetchhek(CvSTASH(cv), CvNAME_HEK(cv), 0);
8fcb2425 300 gv = MUTABLE_GV(svp && *svp ? *svp : newSV_type(SVt_NULL));
2eaf799e 301 if (!isGV(gv))
1604cfb0
MS
302 gv_init_pvn(gv, CvSTASH(cv), HEK_KEY(CvNAME_HEK(cv)),
303 HEK_LEN(CvNAME_HEK(cv)),
82943faa 304 SVf_UTF8 * cBOOL(HEK_UTF8(CvNAME_HEK(cv))));
2eaf799e 305 if (!CvNAMED(cv)) { /* gv_init took care of it */
1604cfb0
MS
306 assert (SvANY(cv)->xcv_gv_u.xcv_gv == gv);
307 return gv;
2eaf799e 308 }
ae77754a
FC
309 unshare_hek(CvNAME_HEK(cv));
310 CvNAMED_off(cv);
311 SvANY(cv)->xcv_gv_u.xcv_gv = gv;
2eaf799e 312 if (svp && *svp) SvREFCNT_inc_simple_void_NN(gv);
ae77754a
FC
313 CvCVGV_RC_on(cv);
314 return gv;
315}
316
c68d9564
Z
317/* Assign CvSTASH(cv) = st, handling weak references. */
318
319void
320Perl_cvstash_set(pTHX_ CV *cv, HV *st)
321{
322 HV *oldst = CvSTASH(cv);
323 PERL_ARGS_ASSERT_CVSTASH_SET;
324 if (oldst == st)
1604cfb0 325 return;
c68d9564 326 if (oldst)
1604cfb0 327 sv_del_backref(MUTABLE_SV(oldst), MUTABLE_SV(cv));
c68d9564
Z
328 SvANY(cv)->xcv_stash = st;
329 if (st)
1604cfb0 330 Perl_sv_add_backref(aTHX_ MUTABLE_SV(st), MUTABLE_SV(cv));
c68d9564 331}
803f2748 332
e1104062
FC
333/*
334=for apidoc gv_init_pvn
335
336Converts a scalar into a typeglob. This is an incoercible typeglob;
337assigning a reference to it will assign to one of its slots, instead of
796b6530
KW
338overwriting it as happens with typeglobs created by C<SvSetSV>. Converting
339any scalar that is C<SvOK()> may produce unpredictable results and is reserved
e1104062
FC
340for perl's internal use.
341
342C<gv> is the scalar to be converted.
343
344C<stash> is the parent stash/package, if any.
345
04ec7e59
FC
346C<name> and C<len> give the name. The name must be unqualified;
347that is, it must not include the package name. If C<gv> is a
e1104062
FC
348stash element, it is the caller's responsibility to ensure that the name
349passed to this function matches the name of the element. If it does not
350match, perl's internal bookkeeping will get out of sync.
351
4a4088c4 352C<flags> can be set to C<SVf_UTF8> if C<name> is a UTF-8 string, or
04ec7e59 353the return value of SvUTF8(sv). It can also take the
796b6530 354C<GV_ADDMULTI> flag, which means to pretend that the GV has been
e1104062
FC
355seen before (i.e., suppress "Used once" warnings).
356
5af38e47
KW
357=for apidoc Amnh||GV_ADDMULTI
358
e1104062
FC
359=for apidoc gv_init
360
4a4088c4 361The old form of C<gv_init_pvn()>. It does not work with UTF-8 strings, as it
04ec7e59 362has no flags parameter. If the C<multi> parameter is set, the
796b6530 363C<GV_ADDMULTI> flag will be passed to C<gv_init_pvn()>.
e1104062
FC
364
365=for apidoc gv_init_pv
366
796b6530 367Same as C<gv_init_pvn()>, but takes a nul-terminated string for the name
e1104062
FC
368instead of separate char * and length parameters.
369
370=for apidoc gv_init_sv
371
796b6530 372Same as C<gv_init_pvn()>, but takes an SV * for the name instead of separate
e1104062
FC
373char * and length parameters. C<flags> is currently unused.
374
375=cut
376*/
377
463ee0b2 378void
04ec7e59 379Perl_gv_init_sv(pTHX_ GV *gv, HV *stash, SV* namesv, U32 flags)
e6066781
BF
380{
381 char *namepv;
382 STRLEN namelen;
383 PERL_ARGS_ASSERT_GV_INIT_SV;
384 namepv = SvPV(namesv, namelen);
385 if (SvUTF8(namesv))
386 flags |= SVf_UTF8;
04ec7e59 387 gv_init_pvn(gv, stash, namepv, namelen, flags);
e6066781
BF
388}
389
390void
04ec7e59 391Perl_gv_init_pv(pTHX_ GV *gv, HV *stash, const char *name, U32 flags)
e6066781
BF
392{
393 PERL_ARGS_ASSERT_GV_INIT_PV;
04ec7e59 394 gv_init_pvn(gv, stash, name, strlen(name), flags);
e6066781
BF
395}
396
d538caf6
NC
397/* Packages in the symbol table are "stashes" - hashes where the keys are symbol
398 names and the values are typeglobs. The value $foo::bar is actually found
399 by looking up the typeglob *foo::{bar} and then reading its SCALAR slot.
400
401 At least, that's what you see in Perl space if you use typeglob syntax.
402 Usually it's also what's actually stored in the stash, but for some cases
403 different values are stored (as a space optimisation) and converted to full
404 typeglobs "on demand" - if a typeglob syntax is used to read a value. It's
405 the job of this function, Perl_gv_init_pvn(), to undo any trickery and
406 replace the SV stored in the stash with the regular PVGV structure that it is
407 a shorthand for. This has to be done "in-place" by upgrading the actual SV
408 that is already stored in the stash to a PVGV.
409
410 As the public documentation above says:
411 Converting any scalar that is C<SvOK()> may produce unpredictable
412 results and is reserved for perl's internal use.
413
414 Values that can be stored:
415
416 * plain scalar - a subroutine declaration
417 The scalar's string value is the subroutine prototype; the integer -1 is
418 "no prototype". ie shorthand for sub foo ($$); or sub bar;
419 * reference to a scalar - a constant. ie shorthand for sub PI() { 4; }
420 * reference to a sub - a subroutine (avoids allocating a PVGV)
421
422 The earliest optimisation was subroutine declarations, implemented in 1998
423 by commit 8472ac73d6d80294:
424 "Sub declaration cost reduced from ~500 to ~100 bytes"
425
426 This space optimisation needs to be invisible to regular Perl code. For this
427 code:
428
429 sub foo ($$);
430 *foo = [];
431
432 When the first line is compiled, the optimisation is used, and $::{foo} is
433 assigned the scalar '$$'. No PVGV or PVCV is created.
434
435 When the second line encountered, the typeglob lookup on foo needs to
436 "upgrade" the symbol table entry to a PVGV, and then create a PVCV in the
437 {CODE} slot with the prototype $$ and no body. The typeglob is then available
438 so that [] can be assigned to the {ARRAY} slot. For the code above the
439 upgrade happens at compile time, the assignment at runtime.
440
441 Analogous code unwinds the other optimisations.
442*/
e6066781 443void
04ec7e59 444Perl_gv_init_pvn(pTHX_ GV *gv, HV *stash, const char *name, STRLEN len, U32 flags)
463ee0b2 445{
3b6733bf
NC
446 const U32 old_type = SvTYPE(gv);
447 const bool doproto = old_type > SVt_NULL;
f9509170 448 char * const proto = (doproto && SvPOK(gv))
1604cfb0
MS
449 ? ((void)(SvIsCOW(gv) && (sv_force_normal((SV *)gv), 0)), SvPVX(gv))
450 : NULL;
49a54bbe 451 const STRLEN protolen = proto ? SvCUR(gv) : 0;
e0260a5b 452 const U32 proto_utf8 = proto ? SvUTF8(gv) : 0;
756cb477 453 SV *const has_constant = doproto && SvROK(gv) ? SvRV(gv) : NULL;
1ccdb730 454 const U32 exported_constant = has_constant ? SvPCS_IMPORTED(gv) : 0;
6881372e 455 const bool really_sub =
1604cfb0 456 has_constant && SvTYPE(has_constant) == SVt_PVCV;
6881372e 457 COP * const old = PL_curcop;
756cb477 458
e6066781 459 PERL_ARGS_ASSERT_GV_INIT_PVN;
756cb477
NC
460 assert (!(proto && has_constant));
461
462 if (has_constant) {
1604cfb0
MS
463 /* The constant has to be a scalar, array or subroutine. */
464 switch (SvTYPE(has_constant)) {
465 case SVt_PVHV:
466 case SVt_PVFM:
467 case SVt_PVIO:
5c1f4d79 468 Perl_croak(aTHX_ "Cannot convert a reference to %s to typeglob",
1604cfb0 469 sv_reftype(has_constant, 0));
c9a0dcdc 470 NOT_REACHED; /* NOTREACHED */
4bbde2f7 471 break;
81d52ecd 472
1604cfb0
MS
473 default: NOOP;
474 }
475 SvRV_set(gv, NULL);
476 SvROK_off(gv);
756cb477 477 }
463ee0b2 478
3b6733bf
NC
479
480 if (old_type < SVt_PVGV) {
1604cfb0
MS
481 if (old_type >= SVt_PV)
482 SvCUR_set(gv, 0);
483 sv_upgrade(MUTABLE_SV(gv), SVt_PVGV);
3b6733bf 484 }
55d729e4 485 if (SvLEN(gv)) {
1604cfb0 486 if (proto) {
d538caf6
NC
487 /* For this case, we are "stealing" the buffer from the SvPV and
488 re-attaching to an SV below with the call to sv_usepvn_flags().
489 Hence we don't free it. */
1604cfb0 490 SvPV_set(gv, NULL);
d538caf6
NC
491 }
492 else {
493 /* There is no valid prototype. (SvPOK() must be true for a valid
494 prototype.) Hence we free the memory. */
1604cfb0 495 Safefree(SvPVX_mutable(gv));
d538caf6
NC
496 }
497 SvLEN_set(gv, 0);
498 SvPOK_off(gv);
55d729e4 499 }
2e5b91de
NC
500 SvIOK_off(gv);
501 isGV_with_GP_on(gv);
12816592 502
6881372e
FC
503 if (really_sub && !CvISXSUB(has_constant) && CvSTART(has_constant)
504 && ( CvSTART(has_constant)->op_type == OP_NEXTSTATE
1604cfb0
MS
505 || CvSTART(has_constant)->op_type == OP_DBSTATE))
506 PL_curcop = (COP *)CvSTART(has_constant);
c43ae56f 507 GvGP_set(gv, Perl_newGP(aTHX_ gv));
6881372e 508 PL_curcop = old;
e15faf7d
NC
509 GvSTASH(gv) = stash;
510 if (stash)
1604cfb0 511 Perl_sv_add_backref(aTHX_ MUTABLE_SV(stash), MUTABLE_SV(gv));
04f3bf56 512 gv_name_set(gv, name, len, GV_ADD | ( flags & SVf_UTF8 ? SVf_UTF8 : 0 ));
04ec7e59 513 if (flags & GV_ADDMULTI || doproto) /* doproto means it */
1604cfb0 514 GvMULTI_on(gv); /* _was_ mentioned */
6881372e 515 if (really_sub) {
1604cfb0
MS
516 /* Not actually a constant. Just a regular sub. */
517 CV * const cv = (CV *)has_constant;
518 GvCV_set(gv,cv);
519 if (CvNAMED(cv) && CvSTASH(cv) == stash && (
520 CvNAME_HEK(cv) == GvNAME_HEK(gv)
521 || ( HEK_LEN(CvNAME_HEK(cv)) == HEK_LEN(GvNAME_HEK(gv))
522 && HEK_FLAGS(CvNAME_HEK(cv)) != HEK_FLAGS(GvNAME_HEK(gv))
523 && HEK_UTF8(CvNAME_HEK(cv)) == HEK_UTF8(GvNAME_HEK(gv))
524 && memEQ(HEK_KEY(CvNAME_HEK(cv)), GvNAME(gv), GvNAMELEN(gv))
525 )
526 ))
527 CvGV_set(cv,gv);
2eaf799e
FC
528 }
529 else if (doproto) {
1604cfb0
MS
530 CV *cv;
531 if (has_constant) {
532 /* newCONSTSUB takes ownership of the reference from us. */
533 cv = newCONSTSUB_flags(stash, name, len, flags, has_constant);
534 /* In case op.c:S_process_special_blocks stole it: */
535 if (!GvCV(gv))
536 GvCV_set(gv, (CV *)SvREFCNT_inc_simple_NN(cv));
537 assert(GvCV(gv) == cv); /* newCONSTSUB should have set this */
538 /* If this reference was a copy of another, then the subroutine
539 must have been "imported", by a Perl space assignment to a GV
540 from a reference to CV. */
541 if (exported_constant)
542 GvIMPORTED_CV_on(gv);
543 CvSTASH_set(cv, PL_curstash); /* XXX Why is this needed? */
544 } else {
545 cv = newSTUB(gv,1);
546 }
547 if (proto) {
548 sv_usepvn_flags(MUTABLE_SV(cv), proto, protolen,
549 SV_HAS_TRAILING_NUL);
e0260a5b 550 if ( proto_utf8 ) SvUTF8_on(MUTABLE_SV(cv));
1604cfb0 551 }
55d729e4 552 }
463ee0b2
LW
553}
554
76e3520e 555STATIC void
e6066781 556S_gv_init_svtype(pTHX_ GV *gv, const svtype sv_type)
a0d0e21e 557{
13c59d41
MH
558 PERL_ARGS_ASSERT_GV_INIT_SVTYPE;
559
560 switch (sv_type) {
561 case SVt_PVIO:
1604cfb0
MS
562 (void)GvIOn(gv);
563 break;
13c59d41 564 case SVt_PVAV:
1604cfb0
MS
565 (void)GvAVn(gv);
566 break;
13c59d41 567 case SVt_PVHV:
1604cfb0
MS
568 (void)GvHVn(gv);
569 break;
c69033f2 570#ifdef PERL_DONT_CREATE_GVSV
13c59d41
MH
571 case SVt_NULL:
572 case SVt_PVCV:
573 case SVt_PVFM:
574 case SVt_PVGV:
1604cfb0 575 break;
13c59d41 576 default:
1604cfb0
MS
577 if(GvSVn(gv)) {
578 /* Work round what appears to be a bug in Sun C++ 5.8 2005/10/13
579 If we just cast GvSVn(gv) to void, it ignores evaluating it for
580 its side effect */
581 }
c69033f2 582#endif
a0d0e21e
LW
583 }
584}
585
0f8d4b5e
FC
586static void core_xsub(pTHX_ CV* cv);
587
588static GV *
589S_maybe_add_coresub(pTHX_ HV * const stash, GV *gv,
87566176 590 const char * const name, const STRLEN len)
0f8d4b5e
FC
591{
592 const int code = keyword(name, len, 1);
593 static const char file[] = __FILE__;
97021f77 594 CV *cv, *oldcompcv = NULL;
0f8d4b5e 595 int opnum = 0;
0f8d4b5e 596 bool ampable = TRUE; /* &{}-able */
97021f77
FC
597 COP *oldcurcop = NULL;
598 yy_parser *oldparser = NULL;
599 I32 oldsavestack_ix = 0;
0f8d4b5e
FC
600
601 assert(gv || stash);
602 assert(name);
0f8d4b5e 603
88b892d8
FC
604 if (!code) return NULL; /* Not a keyword */
605 switch (code < 0 ? -code : code) {
0f8d4b5e 606 /* no support for \&CORE::infix;
d885f758 607 no support for funcs that do not parse like funcs */
99b497aa
PE
608 case KEY___DATA__: case KEY___END__ :
609 case KEY_ADJUST : case KEY_AUTOLOAD: case KEY_BEGIN : case KEY_CHECK :
610 case KEY_DESTROY : case KEY_END : case KEY_INIT : case KEY_UNITCHECK:
611 case KEY_and : case KEY_catch : case KEY_class :
612 case KEY_cmp : case KEY_default: case KEY_defer :
88b892d8 613 case KEY_do : case KEY_dump : case KEY_else : case KEY_elsif :
99b497aa
PE
614 case KEY_eq : case KEY_eval : case KEY_field :
615 case KEY_finally:
88b892d8 616 case KEY_for : case KEY_foreach: case KEY_format: case KEY_ge :
813e85a0 617 case KEY_given : case KEY_goto : case KEY_grep : case KEY_gt :
99b497aa
PE
618 case KEY_if : case KEY_isa :
619 case KEY_last :
813e85a0 620 case KEY_le : case KEY_local : case KEY_lt : case KEY_m :
99b497aa 621 case KEY_map : case KEY_method : case KEY_my :
88b892d8 622 case KEY_ne : case KEY_next : case KEY_no: case KEY_or: case KEY_our:
1efec5ed 623 case KEY_package: case KEY_print: case KEY_printf:
919ad5f7 624 case KEY_q : case KEY_qq : case KEY_qr : case KEY_qw :
88b892d8 625 case KEY_qx : case KEY_redo : case KEY_require: case KEY_return:
d33bb3da 626 case KEY_s : case KEY_say : case KEY_sort :
d80ed303 627 case KEY_state: case KEY_sub :
99b497aa
PE
628 case KEY_tr : case KEY_try :
629 case KEY_unless:
7896dde7 630 case KEY_until: case KEY_use : case KEY_when : case KEY_while :
88b892d8 631 case KEY_x : case KEY_xor : case KEY_y :
1604cfb0 632 return NULL;
0f8d4b5e 633 case KEY_chdir:
eb31eb35 634 case KEY_chomp: case KEY_chop: case KEY_defined: case KEY_delete:
73665bc4 635 case KEY_eof : case KEY_exec: case KEY_exists :
0f8d4b5e 636 case KEY_lstat:
bea284c8 637 case KEY_split:
0f8d4b5e
FC
638 case KEY_stat:
639 case KEY_system:
640 case KEY_truncate: case KEY_unlink:
1604cfb0 641 ampable = FALSE;
0f8d4b5e
FC
642 }
643 if (!gv) {
8fcb2425 644 gv = (GV *)newSV_type(SVt_NULL);
1604cfb0 645 gv_init(gv, stash, name, len, TRUE);
0f8d4b5e 646 }
7e68c38b 647 GvMULTI_on(gv);
0f8d4b5e 648 if (ampable) {
1604cfb0
MS
649 ENTER;
650 oldcurcop = PL_curcop;
651 oldparser = PL_parser;
652 lex_start(NULL, NULL, 0);
653 oldcompcv = PL_compcv;
654 PL_compcv = NULL; /* Prevent start_subparse from setting
655 CvOUTSIDE. */
656 oldsavestack_ix = start_subparse(FALSE,0);
657 cv = PL_compcv;
0f8d4b5e
FC
658 }
659 else {
1604cfb0
MS
660 /* Avoid calling newXS, as it calls us, and things start to
661 get hairy. */
662 cv = MUTABLE_CV(newSV_type(SVt_PVCV));
663 GvCV_set(gv,cv);
664 GvCVGEN(gv) = 0;
665 CvISXSUB_on(cv);
666 CvXSUB(cv) = core_xsub;
667 PoisonPADLIST(cv);
0f8d4b5e
FC
668 }
669 CvGV_set(cv, gv); /* This stops new ATTRSUB from setting CvFILE
670 from PL_curcop. */
9b669ea1
DD
671 /* XSUBs can't be perl lang/perl5db.pl debugged
672 if (PERLDB_LINE_OR_SAVESRC)
673 (void)gv_fetchfile(file); */
0f8d4b5e
FC
674 CvFILE(cv) = (char *)file;
675 /* XXX This is inefficient, as doing things this order causes
676 a prototype check in newATTRSUB. But we have to do
677 it this order as we need an op number before calling
678 new ATTRSUB. */
679 (void)core_prototype((SV *)cv, name, code, &opnum);
87566176 680 if (stash)
1604cfb0 681 (void)hv_store(stash,name,len,(SV *)gv,0);
0f8d4b5e 682 if (ampable) {
4428fb0e
TC
683#ifdef DEBUGGING
684 CV *orig_cv = cv;
685#endif
1604cfb0 686 CvLVALUE_on(cv);
4428fb0e
TC
687 /* newATTRSUB will free the CV and return NULL if we're still
688 compiling after a syntax error */
1604cfb0
MS
689 if ((cv = newATTRSUB_x(
690 oldsavestack_ix, (OP *)gv,
691 NULL,NULL,
692 coresub_op(
693 opnum
694 ? newSVuv((UV)opnum)
695 : newSVpvn(name,len),
696 code, opnum
697 ),
698 TRUE
4428fb0e
TC
699 )) != NULL) {
700 assert(GvCV(gv) == orig_cv);
701 if (opnum != OP_VEC && opnum != OP_SUBSTR && opnum != OP_POS
cd642408 702 && opnum != OP_UNDEF && opnum != OP_KEYS)
4428fb0e
TC
703 CvLVALUE_off(cv); /* Now *that* was a neat trick. */
704 }
1604cfb0
MS
705 LEAVE;
706 PL_parser = oldparser;
707 PL_curcop = oldcurcop;
708 PL_compcv = oldcompcv;
0f8d4b5e 709 }
4428fb0e 710 if (cv) {
1604cfb0
MS
711 SV *opnumsv = newSViv(
712 (opnum == OP_ENTEREVAL && len == 9 && memEQ(name, "evalbytes", 9)) ?
713 (OP_ENTEREVAL | (1<<16))
714 : opnum ? opnum : (((I32)name[2]) << 16));
a83b92fa 715 cv_set_call_checker_flags(cv, Perl_ck_entersub_args_core, opnumsv, 0);
1604cfb0 716 SvREFCNT_dec_NN(opnumsv);
4428fb0e
TC
717 }
718
0f8d4b5e
FC
719 return gv;
720}
721
954c1994 722/*
a1f822c2
KW
723=for apidoc gv_fetchmeth
724=for apidoc_item gv_fetchmeth_pv
725=for apidoc_item gv_fetchmeth_pvn
726=for apidoc_item gv_fetchmeth_sv
6c53d59b 727
a1f822c2
KW
728These each look for a glob with name C<name>, containing a defined subroutine,
729returning the GV of that glob if found, or C<NULL> if not.
6c53d59b 730
a1f822c2 731C<stash> is always searched (first), unless it is C<NULL>.
e6919483 732
a1f822c2
KW
733If C<stash> is NULL, or was searched but nothing was found in it, and the
734C<GV_SUPER> bit is set in C<flags>, stashes accessible via C<@ISA> are searched
735next. Searching is conducted according to L<C<MRO> order|perlmroapi>.
736
737Finally, if no matches were found so far, and the C<GV_NOUNIVERSAL> flag in
738C<flags> is not set, C<UNIVERSAL::> is searched.
739
740The argument C<level> should be either 0 or -1. If -1, the function will
741return without any side effects or caching. If 0, the function makes sure
742there is a glob named C<name> in C<stash>, creating one if necessary.
743The subroutine slot in the glob will be set to any subroutine found in the
744C<stash> and C<SUPER::> search, hence caching any C<SUPER::> result. Note that
745subroutines found in C<UNIVERSAL::> are not cached.
746
747The GV returned from these may be a method cache entry, which is not visible to
748Perl code. So when calling C<call_sv>, you should not use the GV directly;
749instead, you should use the method's CV, which can be obtained from the GV with
750the C<GvCV> macro.
751
752The only other significant value for C<flags> is C<SVf_UTF8>, indicating that
753C<name> is to be treated as being encoded in UTF-8.
754
755Plain C<gv_fetchmeth> lacks a C<flags> parameter, hence always searches in
756C<stash>, then C<UNIVERSAL::>, and C<name> is never UTF-8. Otherwise it is
757exactly like C<gv_fetchmeth_pvn>.
758
759The other forms do have a C<flags> parameter, and differ only in how the glob
760name is specified.
761
762In C<gv_fetchmeth_pv>, C<name> is a C language NUL-terminated string.
763
764In C<gv_fetchmeth_pvn>, C<name> points to the first byte of the name, and an
765additional parameter, C<len>, specifies its length in bytes. Hence, the name
766may contain embedded-NUL characters.
767
768In C<gv_fetchmeth_sv>, C<*name> is an SV, and the name is the PV extracted from
769that, using L</C<SvPV>>. If the SV is marked as being in UTF-8, the extracted
770PV will also be.
771
772=for apidoc Amnh||GV_SUPER
e6919483
BF
773
774=cut
775*/
776
777GV *
778Perl_gv_fetchmeth_sv(pTHX_ HV *stash, SV *namesv, I32 level, U32 flags)
779{
c290e187 780 char *namepv;
781 STRLEN namelen;
782 PERL_ARGS_ASSERT_GV_FETCHMETH_SV;
783 if (LIKELY(SvPOK_nog(namesv))) /* common case */
14062320
FC
784 return gv_fetchmeth_internal(stash, namesv, NULL, 0, level,
785 flags | SvUTF8(namesv));
c290e187 786 namepv = SvPV(namesv, namelen);
787 if (SvUTF8(namesv)) flags |= SVf_UTF8;
788 return gv_fetchmeth_pvn(stash, namepv, namelen, level, flags);
e6919483
BF
789}
790
e6919483
BF
791
792GV *
793Perl_gv_fetchmeth_pv(pTHX_ HV *stash, const char *name, I32 level, U32 flags)
794{
795 PERL_ARGS_ASSERT_GV_FETCHMETH_PV;
c6afe666 796 return gv_fetchmeth_internal(stash, NULL, name, strlen(name), level, flags);
e6919483
BF
797}
798
e1a479c5
BB
799/* NOTE: No support for tied ISA */
800
c6afe666 801PERL_STATIC_INLINE GV*
802S_gv_fetchmeth_internal(pTHX_ HV* stash, SV* meth, const char* name, STRLEN len, I32 level, U32 flags)
79072805 803{
463ee0b2 804 GV** gvp;
c6afe666 805 HE* he;
e1a479c5
BB
806 AV* linear_av;
807 SV** linear_svp;
808 SV* linear_sv;
aae43805 809 HV* cstash, *cachestash;
e1a479c5
BB
810 GV* candidate = NULL;
811 CV* cand_cv = NULL;
e1a479c5 812 GV* topgv = NULL;
bfcb3514 813 const char *hvname;
448aac91 814 STRLEN hvnamelen;
c6afe666 815 I32 create = (level >= 0) ? HV_FETCH_LVALUE : 0;
e1a479c5 816 I32 items;
e1a479c5 817 U32 topgen_cmp;
04f3bf56 818 U32 is_utf8 = flags & SVf_UTF8;
a0d0e21e 819
af09ea45
IK
820 /* UNIVERSAL methods should be callable without a stash */
821 if (!stash) {
1604cfb0
MS
822 create = 0; /* probably appropriate */
823 if(!(stash = gv_stashpvs("UNIVERSAL", 0)))
824 return 0;
af09ea45
IK
825 }
826
e1a479c5
BB
827 assert(stash);
828
bfcb3514 829 hvname = HvNAME_get(stash);
448aac91 830 hvnamelen = HvNAMELEN_get(stash);
bfcb3514 831 if (!hvname)
e1a479c5 832 Perl_croak(aTHX_ "Can't use anonymous symbol table for method lookup");
e27ad1f2 833
e1a479c5 834 assert(hvname);
55df6700 835 assert(name || meth);
463ee0b2 836
aae43805 837 DEBUG_o( Perl_deb(aTHX_ "Looking for %smethod %s in package %s\n",
1604cfb0
MS
838 flags & GV_SUPER ? "SUPER " : "",
839 name ? name : SvPV_nolen(meth), hvname) );
44a8e56a 840
dd69841b 841 topgen_cmp = HvMROMETA(stash)->cache_gen + PL_sub_generation;
e1a479c5 842
aae43805 843 if (flags & GV_SUPER) {
1604cfb0
MS
844 if (!HvAUX(stash)->xhv_mro_meta->super)
845 HvAUX(stash)->xhv_mro_meta->super = newHV();
846 cachestash = HvAUX(stash)->xhv_mro_meta->super;
aae43805
FC
847 }
848 else cachestash = stash;
849
e1a479c5 850 /* check locally for a real method or a cache entry */
c6afe666 851 he = (HE*)hv_common(
1cde3371 852 cachestash, meth, name, len, is_utf8 ? HVhek_UTF8 : 0, create, NULL, 0
c6afe666 853 );
854 if (he) gvp = (GV**)&HeVAL(he);
855 else gvp = NULL;
856
e1a479c5
BB
857 if(gvp) {
858 topgv = *gvp;
0f8d4b5e 859 have_gv:
e1a479c5
BB
860 assert(topgv);
861 if (SvTYPE(topgv) != SVt_PVGV)
55df6700
FC
862 {
863 if (!name)
864 name = SvPV_nomg(meth, len);
04ec7e59 865 gv_init_pvn(topgv, stash, name, len, GV_ADDMULTI|is_utf8);
55df6700 866 }
e1a479c5
BB
867 if ((cand_cv = GvCV(topgv))) {
868 /* If genuine method or valid cache entry, use it */
869 if (!GvCVGEN(topgv) || GvCVGEN(topgv) == topgen_cmp) {
870 return topgv;
871 }
872 else {
873 /* stale cache entry, junk it and move on */
1604cfb0
MS
874 SvREFCNT_dec_NN(cand_cv);
875 GvCV_set(topgv, NULL);
876 cand_cv = NULL;
877 GvCVGEN(topgv) = 0;
e1a479c5
BB
878 }
879 }
880 else if (GvCVGEN(topgv) == topgen_cmp) {
881 /* cache indicates no such method definitively */
882 return 0;
883 }
1604cfb0
MS
884 else if (stash == cachestash
885 && len > 1 /* shortest is uc */
b59bf0b2 886 && memEQs(hvname, HvNAMELEN_get(stash), "CORE")
87566176 887 && S_maybe_add_coresub(aTHX_ NULL,topgv,name,len))
1604cfb0 888 goto have_gv;
463ee0b2 889 }
79072805 890
aae43805 891 linear_av = mro_get_linear_isa(stash); /* has ourselves at the top of the list */
e1a479c5
BB
892 linear_svp = AvARRAY(linear_av) + 1; /* skip over self */
893 items = AvFILLp(linear_av); /* no +1, to skip over self */
894 while (items--) {
895 linear_sv = *linear_svp++;
896 assert(linear_sv);
897 cstash = gv_stashsv(linear_sv, 0);
898
dd69841b 899 if (!cstash) {
448aac91
MM
900 if ( ckWARN(WARN_SYNTAX)) {
901 if( /* these are loaded from Perl_Gv_AMupdate() one way or another */
902 ( len && name[0] == '(' ) /* overload.pm related, in particular "()" */
903 || ( memEQs( name, len, "DESTROY") )
904 ) {
905 Perl_ck_warner(aTHX_ packWARN(WARN_SYNTAX),
906 "Can't locate package %" SVf " for @%" HEKf "::ISA",
907 SVfARG(linear_sv),
908 HEKfARG(HvNAME_HEK(stash)));
909
910 } else if( memEQs( name, len, "AUTOLOAD") ) {
911 /* gobble this warning */
912 } else {
913 Perl_ck_warner(aTHX_ packWARN(WARN_SYNTAX),
914 "While trying to resolve method call %.*s->%.*s()"
39629dcf
YO
915 " can not locate package %" SVf_QUOTEDPREFIX " yet it is mentioned in @%.*s::ISA"
916 " (perhaps you forgot to load %" SVf_QUOTEDPREFIX "?)",
29a3370f
N
917 (int) hvnamelen, hvname,
918 (int) len, name,
448aac91 919 SVfARG(linear_sv),
29a3370f 920 (int) hvnamelen, hvname,
448aac91
MM
921 SVfARG(linear_sv));
922 }
923 }
e1a479c5
BB
924 continue;
925 }
9607fc9c 926
e1a479c5
BB
927 assert(cstash);
928
202cd98a
SA
929 gvp = (GV**)hv_common(
930 cstash, meth, name, len, is_utf8 ? HVhek_UTF8 : 0, HV_FETCH_JUST_SV, NULL, 0
931 );
0f8d4b5e
FC
932 if (!gvp) {
933 if (len > 1 && HvNAMELEN_get(cstash) == 4) {
934 const char *hvname = HvNAME(cstash); assert(hvname);
c8b388b0 935 if (strBEGINs(hvname, "CORE")
0f8d4b5e 936 && (candidate =
87566176 937 S_maybe_add_coresub(aTHX_ cstash,NULL,name,len)
0f8d4b5e
FC
938 ))
939 goto have_candidate;
940 }
941 continue;
942 }
943 else candidate = *gvp;
944 have_candidate:
e1a479c5 945 assert(candidate);
04f3bf56 946 if (SvTYPE(candidate) != SVt_PVGV)
04ec7e59 947 gv_init_pvn(candidate, cstash, name, len, GV_ADDMULTI|is_utf8);
e1a479c5
BB
948 if (SvTYPE(candidate) == SVt_PVGV && (cand_cv = GvCV(candidate)) && !GvCVGEN(candidate)) {
949 /*
950 * Found real method, cache method in topgv if:
951 * 1. topgv has no synonyms (else inheritance crosses wires)
952 * 2. method isn't a stub (else AUTOLOAD fails spectacularly)
953 */
954 if (topgv && (GvREFCNT(topgv) == 1) && (CvROOT(cand_cv) || CvXSUB(cand_cv))) {
9bfbb681
VP
955 CV *old_cv = GvCV(topgv);
956 SvREFCNT_dec(old_cv);
e1a479c5 957 SvREFCNT_inc_simple_void_NN(cand_cv);
c43ae56f 958 GvCV_set(topgv, cand_cv);
e1a479c5
BB
959 GvCVGEN(topgv) = topgen_cmp;
960 }
1604cfb0 961 return candidate;
e1a479c5
BB
962 }
963 }
9607fc9c 964
e1a479c5 965 /* Check UNIVERSAL without caching */
5f65868c 966 if((level == 0 || level == -1) && !(flags & GV_NOUNIVERSAL)) {
55df6700
FC
967 candidate = gv_fetchmeth_internal(NULL, meth, name, len, 1,
968 flags &~GV_SUPER);
e1a479c5
BB
969 if(candidate) {
970 cand_cv = GvCV(candidate);
971 if (topgv && (GvREFCNT(topgv) == 1) && (CvROOT(cand_cv) || CvXSUB(cand_cv))) {
9bfbb681
VP
972 CV *old_cv = GvCV(topgv);
973 SvREFCNT_dec(old_cv);
e1a479c5 974 SvREFCNT_inc_simple_void_NN(cand_cv);
c43ae56f 975 GvCV_set(topgv, cand_cv);
e1a479c5
BB
976 GvCVGEN(topgv) = topgen_cmp;
977 }
978 return candidate;
979 }
980 }
981
64d11743 982 if (topgv && GvREFCNT(topgv) == 1 && !(flags & GV_NOUNIVERSAL)) {
e1a479c5
BB
983 /* cache the fact that the method is not defined */
984 GvCVGEN(topgv) = topgen_cmp;
a0d0e21e
LW
985 }
986
79072805
LW
987 return 0;
988}
989
c6afe666 990GV *
991Perl_gv_fetchmeth_pvn(pTHX_ HV *stash, const char *name, STRLEN len, I32 level, U32 flags)
992{
993 PERL_ARGS_ASSERT_GV_FETCHMETH_PVN;
994 return gv_fetchmeth_internal(stash, NULL, name, len, level, flags);
995}
996
954c1994 997/*
460e5730
FC
998=for apidoc gv_fetchmeth_autoload
999
1000This is the old form of L</gv_fetchmeth_pvn_autoload>, which has no flags
1001parameter.
1002
d21989ed 1003=for apidoc gv_fetchmeth_sv_autoload
611c1e95 1004
d21989ed
BF
1005Exactly like L</gv_fetchmeth_pvn_autoload>, but takes the name string in the form
1006of an SV instead of a string/length pair.
1007
1008=cut
1009*/
1010
1011GV *
1012Perl_gv_fetchmeth_sv_autoload(pTHX_ HV *stash, SV *namesv, I32 level, U32 flags)
1013{
1014 char *namepv;
1015 STRLEN namelen;
1016 PERL_ARGS_ASSERT_GV_FETCHMETH_SV_AUTOLOAD;
1017 namepv = SvPV(namesv, namelen);
1018 if (SvUTF8(namesv))
1019 flags |= SVf_UTF8;
1020 return gv_fetchmeth_pvn_autoload(stash, namepv, namelen, level, flags);
1021}
1022
1023/*
1024=for apidoc gv_fetchmeth_pv_autoload
1025
1026Exactly like L</gv_fetchmeth_pvn_autoload>, but takes a nul-terminated string
1027instead of a string/length pair.
1028
1029=cut
1030*/
1031
1032GV *
1033Perl_gv_fetchmeth_pv_autoload(pTHX_ HV *stash, const char *name, I32 level, U32 flags)
1034{
1035 PERL_ARGS_ASSERT_GV_FETCHMETH_PV_AUTOLOAD;
1036 return gv_fetchmeth_pvn_autoload(stash, name, strlen(name), level, flags);
1037}
1038
1039/*
1040=for apidoc gv_fetchmeth_pvn_autoload
1041
796b6530 1042Same as C<gv_fetchmeth_pvn()>, but looks for autoloaded subroutines too.
611c1e95
IZ
1043Returns a glob for the subroutine.
1044
1045For an autoloaded subroutine without a GV, will create a GV even
796b6530 1046if C<level < 0>. For an autoloaded subroutine without a stub, C<GvCV()>
611c1e95
IZ
1047of the result may be zero.
1048
796b6530 1049Currently, the only significant value for C<flags> is C<SVf_UTF8>.
d21989ed 1050
611c1e95
IZ
1051=cut
1052*/
1053
1054GV *
d21989ed 1055Perl_gv_fetchmeth_pvn_autoload(pTHX_ HV *stash, const char *name, STRLEN len, I32 level, U32 flags)
611c1e95 1056{
499321d3 1057 GV *gv = gv_fetchmeth_pvn(stash, name, len, level, flags);
611c1e95 1058
d21989ed 1059 PERL_ARGS_ASSERT_GV_FETCHMETH_PVN_AUTOLOAD;
7918f24d 1060
611c1e95 1061 if (!gv) {
1604cfb0
MS
1062 CV *cv;
1063 GV **gvp;
1064
1065 if (!stash)
1066 return NULL; /* UNIVERSAL::AUTOLOAD could cause trouble */
1067 if (len == S_autolen && memEQ(name, S_autoload, S_autolen))
1068 return NULL;
1069 if (!(gv = gv_fetchmeth_pvn(stash, S_autoload, S_autolen, FALSE, flags)))
1070 return NULL;
1071 cv = GvCV(gv);
1072 if (!(CvROOT(cv) || CvXSUB(cv)))
1073 return NULL;
1074 /* Have an autoload */
1075 if (level < 0) /* Cannot do without a stub */
1076 gv_fetchmeth_pvn(stash, name, len, 0, flags);
1077 gvp = (GV**)hv_fetch(stash, name,
c60dbbc3 1078 (flags & SVf_UTF8) ? -(I32)len : (I32)len, (level >= 0));
1604cfb0
MS
1079 if (!gvp)
1080 return NULL;
1081 return *gvp;
611c1e95
IZ
1082 }
1083 return gv;
1084}
1085
1086/*
954c1994
GS
1087=for apidoc gv_fetchmethod_autoload
1088
1089Returns the glob which contains the subroutine to call to invoke the method
1090on the C<stash>. In fact in the presence of autoloading this may be the
796b6530 1091glob for "AUTOLOAD". In this case the corresponding variable C<$AUTOLOAD> is
b267980d 1092already setup.
954c1994
GS
1093
1094The third parameter of C<gv_fetchmethod_autoload> determines whether
1095AUTOLOAD lookup is performed if the given method is not present: non-zero
b267980d 1096means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
954c1994 1097Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
b267980d 1098with a non-zero C<autoload> parameter.
954c1994 1099
cec2d7b1
FC
1100These functions grant C<"SUPER"> token
1101as a prefix of the method name. Note
954c1994
GS
1102that if you want to keep the returned glob for a long time, you need to
1103check for it being "AUTOLOAD", since at the later time the call may load a
796b6530 1104different subroutine due to C<$AUTOLOAD> changing its value. Use the glob
cec2d7b1 1105created as a side effect to do this.
954c1994 1106
cec2d7b1
FC
1107These functions have the same side-effects as C<gv_fetchmeth> with
1108C<level==0>. The warning against passing the GV returned by
1109C<gv_fetchmeth> to C<call_sv> applies equally to these functions.
954c1994
GS
1110
1111=cut
1112*/
1113
dc848c6f 1114GV *
864dbfa3 1115Perl_gv_fetchmethod_autoload(pTHX_ HV *stash, const char *name, I32 autoload)
dc848c6f 1116{
547bb267
NC
1117 PERL_ARGS_ASSERT_GV_FETCHMETHOD_AUTOLOAD;
1118
256d1bb2
NC
1119 return gv_fetchmethod_flags(stash, name, autoload ? GV_AUTOLOAD : 0);
1120}
1121
44130a26
BF
1122GV *
1123Perl_gv_fetchmethod_sv_flags(pTHX_ HV *stash, SV *namesv, U32 flags)
1124{
1125 char *namepv;
1126 STRLEN namelen;
1127 PERL_ARGS_ASSERT_GV_FETCHMETHOD_SV_FLAGS;
1128 namepv = SvPV(namesv, namelen);
1129 if (SvUTF8(namesv))
1130 flags |= SVf_UTF8;
1131 return gv_fetchmethod_pvn_flags(stash, namepv, namelen, flags);
1132}
1133
1134GV *
1135Perl_gv_fetchmethod_pv_flags(pTHX_ HV *stash, const char *name, U32 flags)
1136{
1137 PERL_ARGS_ASSERT_GV_FETCHMETHOD_PV_FLAGS;
1138 return gv_fetchmethod_pvn_flags(stash, name, strlen(name), flags);
1139}
1140
256d1bb2 1141GV *
44130a26 1142Perl_gv_fetchmethod_pvn_flags(pTHX_ HV *stash, const char *name, const STRLEN len, U32 flags)
256d1bb2 1143{
65308f87
YO
1144 const char * const origname = name;
1145 const char * const name_end = name + len;
e2cace1e 1146 const char *last_separator = NULL;
a0d0e21e 1147 GV* gv;
0dae17bd 1148 HV* ostash = stash;
ad64d0ec 1149 SV *const error_report = MUTABLE_SV(stash);
256d1bb2
NC
1150 const U32 autoload = flags & GV_AUTOLOAD;
1151 const U32 do_croak = flags & GV_CROAK;
14d1dfbd 1152 const U32 is_utf8 = flags & SVf_UTF8;
0dae17bd 1153
44130a26 1154 PERL_ARGS_ASSERT_GV_FETCHMETHOD_PVN_FLAGS;
7918f24d 1155
eff494dd 1156 if (SvTYPE(stash) < SVt_PVHV)
1604cfb0 1157 stash = NULL;
c9bf4021 1158 else {
1604cfb0
MS
1159 /* The only way stash can become NULL later on is if last_separator is set,
1160 which in turn means that there is no need for a SVt_PVHV case
1161 the error reporting code. */
c9bf4021 1162 }
b267980d 1163
cfb73676
YO
1164 {
1165 /* check if the method name is fully qualified or
1166 * not, and separate the package name from the actual
1167 * method name.
1168 *
1169 * leaves last_separator pointing to the beginning of the
1170 * last package separator (either ' or ::) or 0
1171 * if none was found.
1172 *
1173 * leaves name pointing at the beginning of the
1174 * method name.
1175 */
1176 const char *name_cursor = name;
1177 const char * const name_em1 = name_end - 1; /* name_end minus 1 */
1178 for (name_cursor = name; name_cursor < name_end ; name_cursor++) {
1179 if (*name_cursor == '\'') {
1180 last_separator = name_cursor;
1181 name = name_cursor + 1;
1182 }
1183 else if (name_cursor < name_em1 && *name_cursor == ':' && name_cursor[1] == ':') {
1184 last_separator = name_cursor++;
1185 name = name_cursor + 1;
1186 }
1187 }
a0d0e21e 1188 }
cfb73676
YO
1189
1190 /* did we find a separator? */
e2cace1e 1191 if (last_separator) {
9b7f107c
YO
1192 STRLEN sep_len= last_separator - origname;
1193 if ( memEQs(origname, sep_len, "SUPER")) {
1604cfb0
MS
1194 /* ->SUPER::method should really be looked up in original stash */
1195 stash = CopSTASH(PL_curcop);
1196 flags |= GV_SUPER;
1197 DEBUG_o( Perl_deb(aTHX_ "Treating %s as %s::%s\n",
1198 origname, HvENAME_get(stash), name) );
1199 }
47324b4e 1200 else if ( sep_len >= 7 &&
1604cfb0 1201 strBEGINs(last_separator - 7, "::SUPER")) {
0c6362ad 1202 /* don't autovivify if ->NoSuchStash::SUPER::method */
9b7f107c 1203 stash = gv_stashpvn(origname, sep_len - 7, is_utf8);
1604cfb0
MS
1204 if (stash) flags |= GV_SUPER;
1205 }
1206 else {
0c6362ad 1207 /* don't autovivify if ->NoSuchStash::method */
9b7f107c 1208 stash = gv_stashpvn(origname, sep_len, is_utf8);
1604cfb0
MS
1209 }
1210 ostash = stash;
4633a7c4
LW
1211 }
1212
65308f87 1213 gv = gv_fetchmeth_pvn(stash, name, name_end - name, 0, flags);
a0d0e21e 1214 if (!gv) {
1604cfb0
MS
1215 /* This is the special case that exempts Foo->import and
1216 Foo->unimport from being an error even if there's no
1217 import/unimport subroutine */
1218 if (strEQ(name,"import") || strEQ(name,"unimport")) {
1219 gv = (GV*)sv_2mortal((SV*)newCONSTSUB_flags(NULL,
1220 NULL, 0, 0, NULL));
1221 } else if (autoload)
1222 gv = gv_autoload_pvn(
1223 ostash, name, name_end - name, GV_AUTOLOAD_ISMETHOD|flags
1224 );
1225 if (!gv && do_croak) {
1226 /* Right now this is exclusively for the benefit of S_method_common
1227 in pp_hot.c */
1228 if (stash) {
1229 /* If we can't find an IO::File method, it might be a call on
1230 * a filehandle. If IO:File has not been loaded, try to
1231 * require it first instead of croaking */
1232 const char *stash_name = HvNAME_get(stash);
1233 if (stash_name && memEQs(stash_name, HvNAMELEN_get(stash), "IO::File")
1234 && !Perl_hv_common(aTHX_ GvHVn(PL_incgv), NULL,
1235 STR_WITH_LEN("IO/File.pm"), 0,
1236 HV_FETCH_ISEXISTS, NULL, 0)
1237 ) {
1238 require_pv("IO/File.pm");
1239 gv = gv_fetchmeth_pvn(stash, name, name_end - name, 0, flags);
1240 if (gv)
1241 return gv;
1242 }
1243 Perl_croak(aTHX_
33ef5d2c
YO
1244 "Can't locate object method %" UTF8f_QUOTEDPREFIX ""
1245 " via package %" HEKf_QUOTEDPREFIX,
1604cfb0 1246 UTF8fARG(is_utf8, name_end - name, name),
d0c0e7dd 1247 HEKfARG(HvNAME_HEK(stash)));
1604cfb0
MS
1248 }
1249 else {
ecad31f0 1250 SV* packnamesv;
256d1bb2 1251
1604cfb0
MS
1252 if (last_separator) {
1253 packnamesv = newSVpvn_flags(origname, last_separator - origname,
ecad31f0 1254 SVs_TEMP | is_utf8);
1604cfb0
MS
1255 } else {
1256 packnamesv = error_report;
1257 }
1258
1259 Perl_croak(aTHX_
33ef5d2c
YO
1260 "Can't locate object method %" UTF8f_QUOTEDPREFIX ""
1261 " via package %" SVf_QUOTEDPREFIX ""
1262 " (perhaps you forgot to load %" SVf_QUOTEDPREFIX "?)",
1604cfb0 1263 UTF8fARG(is_utf8, name_end - name, name),
ecad31f0 1264 SVfARG(packnamesv), SVfARG(packnamesv));
1604cfb0
MS
1265 }
1266 }
463ee0b2 1267 }
dc848c6f 1268 else if (autoload) {
1604cfb0
MS
1269 CV* const cv = GvCV(gv);
1270 if (!CvROOT(cv) && !CvXSUB(cv)) {
1271 GV* stubgv;
1272 GV* autogv;
1273
1274 if (CvANON(cv) || CvLEXICAL(cv))
1275 stubgv = gv;
1276 else {
1277 stubgv = CvGV(cv);
1278 if (GvCV(stubgv) != cv) /* orphaned import */
1279 stubgv = gv;
1280 }
c8416c26
BF
1281 autogv = gv_autoload_pvn(GvSTASH(stubgv),
1282 GvNAME(stubgv), GvNAMELEN(stubgv),
1283 GV_AUTOLOAD_ISMETHOD
1284 | (GvNAMEUTF8(stubgv) ? SVf_UTF8 : 0));
1604cfb0
MS
1285 if (autogv)
1286 gv = autogv;
1287 }
dc848c6f 1288 }
44a8e56a 1289
1290 return gv;
1291}
1292
df91ed1f
KW
1293
1294/*
1295=for apidoc gv_autoload_pv
1296=for apidoc_item gv_autoload_pvn
1297=for apidoc_item gv_autoload_sv
1298
1299These each search for an C<AUTOLOAD> method, returning NULL if not found, or
1300else returning a pointer to its GV, while setting the package
1301L<C<$AUTOLOAD>|perlobj/AUTOLOAD> variable to C<name> (fully qualified). Also,
1302if found and the GV's CV is an XSUB, the CV's PV will be set to C<name>, and
1303its stash will be set to the stash of the GV.
1304
1305Searching is done in L<C<MRO> order|perlmroapi>, as specified in
1306L</C<gv_fetchmeth>>, beginning with C<stash> if it isn't NULL.
1307
1308The forms differ only in how C<name> is specified.
1309
1310In C<gv_autoload_pv>, C<namepv> is a C language NUL-terminated string.
1311
1312In C<gv_autoload_pvn>, C<name> points to the first byte of the name, and an
1313additional parameter, C<len>, specifies its length in bytes. Hence, C<*name>
1314may contain embedded-NUL characters.
1315
1316In C<gv_autoload_sv>, C<*namesv> is an SV, and the name is the PV extracted
1317from that using L</C<SvPV>>. If the SV is marked as being in UTF-8, the
1318extracted PV will also be.
1319
1320=cut
1321*/
1322
44a8e56a 1323GV*
0eeb01b9 1324Perl_gv_autoload_sv(pTHX_ HV *stash, SV* namesv, U32 flags)
5fba3c91
BF
1325{
1326 char *namepv;
1327 STRLEN namelen;
0fe84f7c 1328 PERL_ARGS_ASSERT_GV_AUTOLOAD_SV;
5fba3c91
BF
1329 namepv = SvPV(namesv, namelen);
1330 if (SvUTF8(namesv))
1331 flags |= SVf_UTF8;
0eeb01b9 1332 return gv_autoload_pvn(stash, namepv, namelen, flags);
5fba3c91
BF
1333}
1334
1335GV*
0eeb01b9 1336Perl_gv_autoload_pv(pTHX_ HV *stash, const char *namepv, U32 flags)
5fba3c91 1337{
0fe84f7c 1338 PERL_ARGS_ASSERT_GV_AUTOLOAD_PV;
0eeb01b9 1339 return gv_autoload_pvn(stash, namepv, strlen(namepv), flags);
5fba3c91
BF
1340}
1341
1342GV*
0eeb01b9 1343Perl_gv_autoload_pvn(pTHX_ HV *stash, const char *name, STRLEN len, U32 flags)
44a8e56a 1344{
44a8e56a 1345 GV* gv;
1346 CV* cv;
1347 HV* varstash;
1348 GV* vargv;
1349 SV* varsv;
c8416c26
BF
1350 SV *packname = NULL;
1351 U32 is_utf8 = flags & SVf_UTF8 ? SVf_UTF8 : 0;
44a8e56a 1352
0fe84f7c 1353 PERL_ARGS_ASSERT_GV_AUTOLOAD_PVN;
7918f24d 1354
7edbdc6b 1355 if (len == S_autolen && memEQ(name, S_autoload, S_autolen))
1604cfb0 1356 return NULL;
0dae17bd 1357 if (stash) {
1604cfb0 1358 if (SvTYPE(stash) < SVt_PVHV) {
c8416c26
BF
1359 STRLEN packname_len = 0;
1360 const char * const packname_ptr = SvPV_const(MUTABLE_SV(stash), packname_len);
1361 packname = newSVpvn_flags(packname_ptr, packname_len,
1362 SVs_TEMP | SvUTF8(stash));
1604cfb0
MS
1363 stash = NULL;
1364 }
1365 else
518db96a 1366 packname = newSVhek_mortal(HvNAME_HEK(stash));
1604cfb0 1367 if (flags & GV_SUPER) sv_catpvs(packname, "::SUPER");
0dae17bd 1368 }
257dc59d 1369 if (!(gv = gv_fetchmeth_pvn(stash, S_autoload, S_autolen, FALSE,
1604cfb0
MS
1370 is_utf8 | (flags & GV_SUPER))))
1371 return NULL;
dc848c6f 1372 cv = GvCV(gv);
1373
adb5a9ae 1374 if (!(CvROOT(cv) || CvXSUB(cv)))
1604cfb0 1375 return NULL;
ed850460 1376
dc848c6f 1377 /*
64278e8c 1378 * Inheriting AUTOLOAD for non-methods no longer works
dc848c6f 1379 */
0eeb01b9
FC
1380 if (
1381 !(flags & GV_AUTOLOAD_ISMETHOD)
1382 && (GvCVGEN(gv) || GvSTASH(gv) != stash)
041457d9 1383 )
64278e8c
A
1384 Perl_croak(aTHX_ "Use of inherited AUTOLOAD for non-method %" SVf
1385 "::%" UTF8f "() is no longer allowed",
1604cfb0 1386 SVfARG(packname),
b17a0679 1387 UTF8fARG(is_utf8, len, name));
44a8e56a 1388
aed2304a 1389 if (CvISXSUB(cv)) {
51254cb2 1390 /* Instead of forcing the XSUB to do another lookup for $AUTOLOAD
bb619f37
FC
1391 * and split that value on the last '::', pass along the same data
1392 * via the SvPVX field in the CV, and the stash in CvSTASH.
8fa6a409
FC
1393 *
1394 * Due to an unfortunate accident of history, the SvPVX field
51254cb2
KW
1395 * serves two purposes. It is also used for the subroutine's
1396 * prototype. Since SvPVX has been documented as returning the sub
1397 * name for a long time, but not as returning the prototype, we have to
1398 * preserve the SvPVX AUTOLOAD behaviour and put the prototype
8fa6a409
FC
1399 * elsewhere.
1400 *
1401 * We put the prototype in the same allocated buffer, but after
1402 * the sub name. The SvPOK flag indicates the presence of a proto-
1403 * type. The CvAUTOLOAD flag indicates the presence of a sub name.
1404 * If both flags are on, then SvLEN is used to indicate the end of
1405 * the prototype (artificially lower than what is actually allo-
1406 * cated), at the risk of having to reallocate a few bytes unneces-
1407 * sarily--but that should happen very rarely, if ever.
1408 *
1409 * We use SvUTF8 for both prototypes and sub names, so if one is
1410 * UTF8, the other must be upgraded.
adb5a9ae 1411 */
1604cfb0
MS
1412 CvSTASH_set(cv, stash);
1413 if (SvPOK(cv)) { /* Ouch! */
1414 SV * const tmpsv = newSVpvn_flags(name, len, is_utf8);
1415 STRLEN ulen;
1416 const char *proto = CvPROTO(cv);
1417 assert(proto);
1418 if (SvUTF8(cv))
1419 sv_utf8_upgrade_flags_grow(tmpsv, 0, CvPROTOLEN(cv) + 2);
1420 ulen = SvCUR(tmpsv);
1421 SvCUR_set(tmpsv, SvCUR(tmpsv) + 1); /* include null in string */
1422 sv_catpvn_flags(
1423 tmpsv, proto, CvPROTOLEN(cv), SV_CATBYTES*!SvUTF8(cv)
1424 );
1425 SvTEMP_on(tmpsv); /* Allow theft */
1426 sv_setsv_nomg((SV *)cv, tmpsv);
1427 SvTEMP_off(tmpsv);
1428 SvREFCNT_dec_NN(tmpsv);
1429 SvLEN_set(cv, SvCUR(cv) + 1);
1430 SvCUR_set(cv, ulen);
1431 }
1432 else {
1433 sv_setpvn((SV *)cv, name, len);
1434 SvPOK_off(cv);
1435 if (is_utf8)
c8416c26 1436 SvUTF8_on(cv);
1604cfb0
MS
1437 else SvUTF8_off(cv);
1438 }
1439 CvAUTOLOAD_on(cv);
adb5a9ae 1440 }
adb5a9ae 1441
44a8e56a 1442 /*
1443 * Given &FOO::AUTOLOAD, set $FOO::AUTOLOAD to desired function name.
1444 * The subroutine's original name may not be "AUTOLOAD", so we don't
1445 * use that, but for lack of anything better we will use the sub's
1446 * original package to look up $AUTOLOAD.
1447 */
18691622 1448 varstash = CvNAMED(cv) ? CvSTASH(cv) : GvSTASH(CvGV(cv));
5c7983e5 1449 vargv = *(GV**)hv_fetch(varstash, S_autoload, S_autolen, TRUE);
3d35f11b
GS
1450 ENTER;
1451
c69033f2 1452 if (!isGV(vargv)) {
1604cfb0 1453 gv_init_pvn(vargv, varstash, S_autoload, S_autolen, 0);
c69033f2 1454#ifdef PERL_DONT_CREATE_GVSV
8fcb2425 1455 GvSV(vargv) = newSV_type(SVt_NULL);
c69033f2
NC
1456#endif
1457 }
3d35f11b 1458 LEAVE;
e203899d 1459 varsv = GvSVn(vargv);
4bac9ae4
CS
1460 SvTAINTED_off(varsv); /* previous $AUTOLOAD taint is obsolete */
1461 /* XXX: this process is not careful to avoid extra magic gets and sets; tied $AUTOLOAD will get noise */
c8416c26 1462 sv_setsv(varsv, packname);
396482e1 1463 sv_catpvs(varsv, "::");
d40bf27b
NC
1464 /* Ensure SvSETMAGIC() is called if necessary. In particular, to clear
1465 tainting if $FOO::AUTOLOAD was previously tainted, but is not now. */
61a9130e 1466 sv_catpvn_flags(
1604cfb0
MS
1467 varsv, name, len,
1468 SV_SMAGIC|(is_utf8 ? SV_CATUTF8 : SV_CATBYTES)
61a9130e 1469 );
c8416c26
BF
1470 if (is_utf8)
1471 SvUTF8_on(varsv);
a0d0e21e
LW
1472 return gv;
1473}
1474
44a2ac75
YO
1475
1476/* require_tie_mod() internal routine for requiring a module
486ec47a 1477 * that implements the logic of automatic ties like %! and %-
e94ea821
FC
1478 * It loads the module and then calls the _tie_it subroutine
1479 * with the passed gv as an argument.
44a2ac75
YO
1480 *
1481 * The "gv" parameter should be the glob.
ee33cc1a 1482 * "varname" holds the 1-char name of the var, used for error messages.
45cbc99a 1483 * "namesv" holds the module name. Its refcount will be decremented.
45cbc99a 1484 * "flags": if flag & 1 then save the scalar before loading.
44a2ac75
YO
1485 * For the protection of $! to work (it is set by this routine)
1486 * the sv slot must already be magicalized.
d2c93421 1487 */
e94ea821 1488STATIC void
ee33cc1a 1489S_require_tie_mod(pTHX_ GV *gv, const char varname, const char * name,
a1683482 1490 STRLEN len, const U32 flags)
d2c93421 1491{
e94ea821 1492 const SV * const target = varname == '[' ? GvSV(gv) : (SV *)GvHV(gv);
45cbc99a 1493
7918f24d
NC
1494 PERL_ARGS_ASSERT_REQUIRE_TIE_MOD;
1495
e94ea821
FC
1496 /* If it is not tied */
1497 if (!target || !SvRMAGICAL(target)
1498 || !mg_find(target,
1499 varname == '[' ? PERL_MAGIC_tiedscalar : PERL_MAGIC_tied))
1500 {
1501 HV *stash;
1502 GV **gvp;
1503 dSP;
1504
655f5b26 1505 PUSHSTACKi(PERLSI_MAGIC);
e94ea821 1506 ENTER;
e94ea821 1507
6881372e
FC
1508#define GET_HV_FETCH_TIE_FUNC \
1509 ( (gvp = (GV **)hv_fetchs(stash, "_tie_it", 0)) \
1510 && *gvp \
1511 && ( (isGV(*gvp) && GvCV(*gvp)) \
1512 || (SvROK(*gvp) && SvTYPE(SvRV(*gvp)) == SVt_PVCV) ) \
1513 )
e94ea821
FC
1514
1515 /* Load the module if it is not loaded. */
360cebfd 1516 if (!(stash = gv_stashpvn(name, len, 0))
6881372e 1517 || ! GET_HV_FETCH_TIE_FUNC)
e94ea821 1518 {
1604cfb0
MS
1519 SV * const module = newSVpvn(name, len);
1520 const char type = varname == '[' ? '$' : '%';
1521 if ( flags & 1 )
1522 save_scalar(gv);
1523 Perl_load_module(aTHX_ PERL_LOADMOD_NOIMPORT, module, NULL);
1524 assert(sp == PL_stack_sp);
1525 stash = gv_stashpvn(name, len, 0);
1526 if (!stash)
1527 Perl_croak(aTHX_ "panic: Can't use %c%c because %s is not available",
1528 type, varname, name);
1529 else if (! GET_HV_FETCH_TIE_FUNC)
1530 Perl_croak(aTHX_ "panic: Can't use %c%c because %s does not define _tie_it",
1531 type, varname, name);
e94ea821
FC
1532 }
1533 /* Now call the tie function. It should be in *gvp. */
6881372e 1534 assert(gvp); assert(*gvp);
e94ea821
FC
1535 PUSHMARK(SP);
1536 XPUSHs((SV *)gv);
1537 PUTBACK;
1538 call_sv((SV *)*gvp, G_VOID|G_DISCARD);
1539 LEAVE;
655f5b26 1540 POPSTACK;
d2c93421
RH
1541 }
1542}
1543
7c719134
YO
1544/* add a require_tie_mod_s - the _s suffix is similar to pvs type suffixes,
1545 * IOW it means we do STR_WITH_LEN() ourselves and the user should pass in
1546 * a true string WITHOUT a len.
1547 */
1548#define require_tie_mod_s(gv, varname, name, flags) \
1549 S_require_tie_mod(aTHX_ gv, varname, STR_WITH_LEN(name), flags)
1550
954c1994
GS
1551/*
1552=for apidoc gv_stashpv
1553
da51bb9b 1554Returns a pointer to the stash for a specified package. Uses C<strlen> to
75c442e4 1555determine the length of C<name>, then calls C<gv_stashpvn()>.
954c1994
GS
1556
1557=cut
1558*/
1559
a0d0e21e 1560HV*
864dbfa3 1561Perl_gv_stashpv(pTHX_ const char *name, I32 create)
a0d0e21e 1562{
7918f24d 1563 PERL_ARGS_ASSERT_GV_STASHPV;
dc437b57 1564 return gv_stashpvn(name, strlen(name), create);
1565}
1566
bc96cb06
SH
1567/*
1568=for apidoc gv_stashpvn
1569
da51bb9b
NC
1570Returns a pointer to the stash for a specified package. The C<namelen>
1571parameter indicates the length of the C<name>, in bytes. C<flags> is passed
1572to C<gv_fetchpvn_flags()>, so if set to C<GV_ADD> then the package will be
1573created if it does not already exist. If the package does not exist and
796b6530 1574C<flags> is 0 (or any other setting that does not create packages) then C<NULL>
da51bb9b
NC
1575is returned.
1576
566a4718
YO
1577Flags may be one of:
1578
52e47e22
KW
1579 GV_ADD Create and initialize the package if doesn't
1580 already exist
1581 GV_NOADD_NOINIT Don't create the package,
1582 GV_ADDMG GV_ADD iff the GV is magical
1583 GV_NOINIT GV_ADD, but don't initialize
1584 GV_NOEXPAND Don't expand SvOK() entries to PVGV
1585 SVf_UTF8 The name is in UTF-8
566a4718 1586
796b6530 1587The most important of which are probably C<GV_ADD> and C<SVf_UTF8>.
bc96cb06 1588
808724c8 1589Note, use of C<gv_stashsv> instead of C<gv_stashpvn> where possible is strongly
1590recommended for performance reasons.
1591
4f8d487a 1592=for apidoc Amnh||GV_ADD
5af38e47
KW
1593=for apidoc Amnh||GV_NOADD_NOINIT
1594=for apidoc Amnh||GV_NOINIT
1595=for apidoc Amnh||GV_NOEXPAND
1596=for apidoc Amnh||GV_ADDMG
1597=for apidoc Amnh||SVf_UTF8
4f8d487a 1598
bc96cb06
SH
1599=cut
1600*/
1601
0eadbdad
YO
1602/*
1603gv_stashpvn_internal
1604
1605Perform the internal bits of gv_stashsvpvn_cached. You could think of this
1606as being one half of the logic. Not to be called except from gv_stashsvpvn_cached().
1607
1608*/
1609
4e7ebec5 1610PERL_STATIC_INLINE HV*
0eadbdad 1611S_gv_stashpvn_internal(pTHX_ const char *name, U32 namelen, I32 flags)
dc437b57 1612{
0cea0058 1613 char smallbuf[128];
46fc3d4c 1614 char *tmpbuf;
a0d0e21e
LW
1615 HV *stash;
1616 GV *tmpgv;
add0ecde 1617 U32 tmplen = namelen + 2;
dc437b57 1618
0eadbdad 1619 PERL_ARGS_ASSERT_GV_STASHPVN_INTERNAL;
7918f24d 1620
add0ecde 1621 if (tmplen <= sizeof smallbuf)
1604cfb0 1622 tmpbuf = smallbuf;
46fc3d4c 1623 else
1604cfb0 1624 Newx(tmpbuf, tmplen, char);
add0ecde
VP
1625 Copy(name, tmpbuf, namelen, char);
1626 tmpbuf[namelen] = ':';
1627 tmpbuf[namelen+1] = ':';
1628 tmpgv = gv_fetchpvn_flags(tmpbuf, tmplen, flags, SVt_PVHV);
46fc3d4c 1629 if (tmpbuf != smallbuf)
1604cfb0 1630 Safefree(tmpbuf);
d2fcb1d6 1631 if (!tmpgv || !isGV_with_GP(tmpgv))
1604cfb0 1632 return NULL;
a0d0e21e 1633 stash = GvHV(tmpgv);
1f656fcf 1634 if (!(flags & ~GV_NOADD_MASK) && !stash) return NULL;
9efb5c72 1635 assert(stash);
2e4090b8 1636 if (!HvHasNAME(stash)) {
1604cfb0 1637 hv_name_set(stash, name, namelen, flags & SVf_UTF8 ? SVf_UTF8 : 0 );
9c913148 1638
1604cfb0
MS
1639 /* FIXME: This is a repeat of logic in gv_fetchpvn_flags */
1640 /* If the containing stash has multiple effective
1641 names, see that this one gets them, too. */
1642 if (HvAUX(GvSTASH(tmpgv))->xhv_name_count)
1643 mro_package_moved(stash, NULL, tmpgv, 1);
1f656fcf 1644 }
a0d0e21e 1645 return stash;
463ee0b2
LW
1646}
1647
808724c8 1648/*
85bf2e91 1649=for apidoc gv_stashsvpvn_cached
808724c8 1650
1651Returns a pointer to the stash for a specified package, possibly
85bf2e91
KW
1652cached. Implements both L<perlapi/C<gv_stashpvn>> and
1653L<perlapi/C<gv_stashsv>>.
808724c8 1654
b8c7ef84 1655Requires one of either C<namesv> or C<namepv> to be non-null.
808724c8 1656
85bf2e91
KW
1657If the flag C<GV_CACHE_ONLY> is set, return the stash only if found in the
1658cache; see L<perlapi/C<gv_stashpvn>> for details on the other C<flags>.
808724c8 1659
85bf2e91
KW
1660Note it is strongly preferred for C<namesv> to be non-null, for performance
1661reasons.
808724c8 1662
85bf2e91
KW
1663=for apidoc Emnh||GV_CACHE_ONLY
1664
1665=cut
808724c8 1666*/
1667
1668#define PERL_ARGS_ASSERT_GV_STASHSVPVN_CACHED \
1669 assert(namesv || name)
1670
c4b6b96d
SA
1671HV*
1672Perl_gv_stashsvpvn_cached(pTHX_ SV *namesv, const char *name, U32 namelen, I32 flags)
4e7ebec5 1673{
1674 HV* stash;
808724c8 1675 HE* he;
1676
1677 PERL_ARGS_ASSERT_GV_STASHSVPVN_CACHED;
1678
1679 he = (HE *)hv_common(
1680 PL_stashcache, namesv, name, namelen,
4e7ebec5 1681 (flags & SVf_UTF8) ? HVhek_UTF8 : 0, 0, NULL, 0
1682 );
808724c8 1683
78e4f28f
DM
1684 if (he) {
1685 SV *sv = HeVAL(he);
1686 HV *hv;
1687 assert(SvIOK(sv));
1688 hv = INT2PTR(HV*, SvIVX(sv));
1689 assert(SvTYPE(hv) == SVt_PVHV);
1690 return hv;
1691 }
d283e876 1692 else if (flags & GV_CACHE_ONLY) return NULL;
4e7ebec5 1693
808724c8 1694 if (namesv) {
1695 if (SvOK(namesv)) { /* prevent double uninit warning */
1696 STRLEN len;
1697 name = SvPV_const(namesv, len);
1698 namelen = len;
1699 flags |= SvUTF8(namesv);
1700 } else {
1701 name = ""; namelen = 0;
1702 }
1703 }
0eadbdad
YO
1704 stash = gv_stashpvn_internal(name, namelen, flags);
1705
4e7ebec5 1706 if (stash && namelen) {
1707 SV* const ref = newSViv(PTR2IV(stash));
0eadbdad 1708 (void)hv_store(PL_stashcache, name,
4e7ebec5 1709 (flags & SVf_UTF8) ? -(I32)namelen : (I32)namelen, ref, 0);
1710 }
808724c8 1711
4e7ebec5 1712 return stash;
1713}
1714
808724c8 1715HV*
1716Perl_gv_stashpvn(pTHX_ const char *name, U32 namelen, I32 flags)
1717{
1718 PERL_ARGS_ASSERT_GV_STASHPVN;
1719 return gv_stashsvpvn_cached(NULL, name, namelen, flags);
1720}
1721
954c1994
GS
1722/*
1723=for apidoc gv_stashsv
1724
fbe13c60
KW
1725Returns a pointer to the stash for a specified package. See
1726C<L</gv_stashpvn>>.
954c1994 1727
fbe13c60
KW
1728Note this interface is strongly preferred over C<gv_stashpvn> for performance
1729reasons.
808724c8 1730
954c1994
GS
1731=cut
1732*/
1733
a0d0e21e 1734HV*
da51bb9b 1735Perl_gv_stashsv(pTHX_ SV *sv, I32 flags)
a0d0e21e 1736{
7918f24d 1737 PERL_ARGS_ASSERT_GV_STASHSV;
808724c8 1738 return gv_stashsvpvn_cached(sv, NULL, 0, flags);
a0d0e21e 1739}
463ee0b2 1740GV *
3752a9fe 1741Perl_gv_fetchpv(pTHX_ const char *nambeg, I32 flags, const svtype sv_type) {
7918f24d 1742 PERL_ARGS_ASSERT_GV_FETCHPV;
3752a9fe 1743 return gv_fetchpvn_flags(nambeg, strlen(nambeg), flags, sv_type);
7a5fd60d
NC
1744}
1745
1746GV *
fe9845cc 1747Perl_gv_fetchsv(pTHX_ SV *name, I32 flags, const svtype sv_type) {
7a5fd60d 1748 STRLEN len;
77cb3b01
FC
1749 const char * const nambeg =
1750 SvPV_flags_const(name, len, flags & GV_NO_SVGMAGIC ? 0 : SV_GMAGIC);
7918f24d 1751 PERL_ARGS_ASSERT_GV_FETCHSV;
7a5fd60d
NC
1752 return gv_fetchpvn_flags(nambeg, len, flags | SvUTF8(name), sv_type);
1753}
1754
90aeefb4 1755PERL_STATIC_INLINE void
290a1700 1756S_gv_magicalize_isa(pTHX_ GV *gv)
ad7cce9f
FR
1757{
1758 AV* av;
1759
1760 PERL_ARGS_ASSERT_GV_MAGICALIZE_ISA;
1761
1762 av = GvAVn(gv);
1763 GvMULTI_on(gv);
1764 sv_magic(MUTABLE_SV(av), MUTABLE_SV(gv), PERL_MAGIC_isa,
1604cfb0 1765 NULL, 0);
e51627af
PE
1766
1767 if(HvSTASH_IS_CLASS(GvSTASH(gv))) {
1768 /* Don't permit modification of @ISA outside of the class management
1769 * code. This is temporarily undone by class.c when fiddling with the
1770 * array, so it knows it can be done safely.
1771 */
1772 SvREADONLY_on((SV *)av);
1773 }
ad7cce9f
FR
1774}
1775
90aeefb4
BF
1776/* This function grabs name and tries to split a stash and glob
1777 * from its contents. TODO better description, comments
9c913148 1778 *
90aeefb4
BF
1779 * If the function returns TRUE and 'name == name_end', then
1780 * 'gv' can be directly returned to the caller of gv_fetchpvn_flags
1781 */
1782PERL_STATIC_INLINE bool
1783S_parse_gv_stash_name(pTHX_ HV **stash, GV **gv, const char **name,
1784 STRLEN *len, const char *nambeg, STRLEN full_len,
1785 const U32 is_utf8, const I32 add)
1786{
8c573bee 1787 char *tmpfullbuf = NULL; /* only malloc one big chunk of memory when the smallbuff is not large enough */
90aeefb4
BF
1788 const char *name_cursor;
1789 const char *const name_end = nambeg + full_len;
1790 const char *const name_em1 = name_end - 1;
8c573bee 1791 char smallbuf[64]; /* small buffer to avoid a malloc when possible */
90aeefb4
BF
1792
1793 PERL_ARGS_ASSERT_PARSE_GV_STASH_NAME;
9c913148 1794
7a207065
KW
1795 if ( full_len > 2
1796 && **name == '*'
1797 && isIDFIRST_lazy_if_safe(*name + 1, name_end, is_utf8))
1798 {
90aeefb4
BF
1799 /* accidental stringify on a GV? */
1800 (*name)++;
1801 }
1802
1803 for (name_cursor = *name; name_cursor < name_end; name_cursor++) {
1804 if (name_cursor < name_em1 &&
1805 ((*name_cursor == ':' && name_cursor[1] == ':')
1806 || *name_cursor == '\''))
1807 {
1808 if (!*stash)
1809 *stash = PL_defstash;
1810 if (!*stash || !SvREFCNT(*stash)) /* symbol table under destruction */
657ed7c1 1811 goto notok;
90aeefb4
BF
1812
1813 *len = name_cursor - *name;
1814 if (name_cursor > nambeg) { /* Skip for initial :: or ' */
1815 const char *key;
1816 GV**gvp;
1817 if (*name_cursor == ':') {
1818 key = *name;
1819 *len += 2;
1820 }
f8ac814f 1821 else { /* using ' for package separator */
8c573bee
N
1822 /* use our pre-allocated buffer when possible to save a malloc */
1823 char *tmpbuf;
1824 if ( *len+2 <= sizeof smallbuf)
1825 tmpbuf = smallbuf;
1826 else {
1827 /* only malloc once if needed */
1828 if (tmpfullbuf == NULL) /* only malloc&free once, a little more than needed */
1829 Newx(tmpfullbuf, full_len+2, char);
1830 tmpbuf = tmpfullbuf;
1831 }
90aeefb4
BF
1832 Copy(*name, tmpbuf, *len, char);
1833 tmpbuf[(*len)++] = ':';
1834 tmpbuf[(*len)++] = ':';
1835 key = tmpbuf;
1836 }
c161da64 1837 gvp = (GV**)hv_fetch(*stash, key, is_utf8 ? -((I32)*len) : (I32)*len, add);
90aeefb4 1838 *gv = gvp ? *gvp : NULL;
f8ac814f 1839 if (!*gv || *gv == (const GV *)&PL_sv_undef) {
657ed7c1 1840 goto notok;
f8ac814f
N
1841 }
1842 /* here we know that *gv && *gv != &PL_sv_undef */
1843 if (SvTYPE(*gv) != SVt_PVGV)
1844 gv_init_pvn(*gv, *stash, key, *len, (add & GV_ADDMULTI)|is_utf8);
1845 else
1846 GvMULTI_on(*gv);
90aeefb4
BF
1847
1848 if (!(*stash = GvHV(*gv))) {
1849 *stash = GvHV(*gv) = newHV();
2e4090b8 1850 if (!HvHasNAME(*stash)) {
90aeefb4 1851 if (GvSTASH(*gv) == PL_defstash && *len == 6
c8b388b0 1852 && strBEGINs(*name, "CORE"))
4c4f3c46 1853 hv_name_sets(*stash, "CORE", 0);
90aeefb4
BF
1854 else
1855 hv_name_set(
1856 *stash, nambeg, name_cursor-nambeg, is_utf8
1857 );
1858 /* If the containing stash has multiple effective
1859 names, see that this one gets them, too. */
1860 if (HvAUX(GvSTASH(*gv))->xhv_name_count)
1861 mro_package_moved(*stash, NULL, *gv, 1);
1862 }
1863 }
2e4090b8 1864 else if (!HvHasNAME(*stash))
90aeefb4
BF
1865 hv_name_set(*stash, nambeg, name_cursor - nambeg, is_utf8);
1866 }
1867
1868 if (*name_cursor == ':')
1869 name_cursor++;
1870 *name = name_cursor+1;
1871 if (*name == name_end) {
120921ac 1872 if (!*gv) {
1604cfb0
MS
1873 *gv = MUTABLE_GV(*hv_fetchs(PL_defstash, "main::", TRUE));
1874 if (SvTYPE(*gv) != SVt_PVGV) {
1875 gv_init_pvn(*gv, PL_defstash, "main::", 6,
1876 GV_ADDMULTI);
1877 GvHV(*gv) =
1878 MUTABLE_HV(SvREFCNT_inc_simple(PL_defstash));
1879 }
1880 }
657ed7c1 1881 goto ok;
90aeefb4
BF
1882 }
1883 }
1884 }
1885 *len = name_cursor - *name;
657ed7c1
DM
1886 ok:
1887 Safefree(tmpfullbuf); /* free our tmpfullbuf if it was used */
90aeefb4 1888 return TRUE;
657ed7c1
DM
1889 notok:
1890 Safefree(tmpfullbuf); /* free our tmpfullbuf if it was used */
1891 return FALSE;
90aeefb4
BF
1892}
1893
657ed7c1 1894
536d1a88 1895/* Checks if an unqualified name is in the main stash */
90aeefb4 1896PERL_STATIC_INLINE bool
536d1a88 1897S_gv_is_in_main(pTHX_ const char *name, STRLEN len, const U32 is_utf8)
90aeefb4 1898{
536d1a88 1899 PERL_ARGS_ASSERT_GV_IS_IN_MAIN;
9c913148 1900
90aeefb4 1901 /* If it's an alphanumeric variable */
7a207065 1902 if ( len && isIDFIRST_lazy_if_safe(name, name + len, is_utf8) ) {
90aeefb4
BF
1903 /* Some "normal" variables are always in main::,
1904 * like INC or STDOUT.
1905 */
1906 switch (len) {
1907 case 1:
1908 if (*name == '_')
536d1a88 1909 return TRUE;
90aeefb4
BF
1910 break;
1911 case 3:
1912 if ((name[0] == 'I' && name[1] == 'N' && name[2] == 'C')
1913 || (name[0] == 'E' && name[1] == 'N' && name[2] == 'V')
1914 || (name[0] == 'S' && name[1] == 'I' && name[2] == 'G'))
536d1a88 1915 return TRUE;
90aeefb4
BF
1916 break;
1917 case 4:
1918 if (name[0] == 'A' && name[1] == 'R' && name[2] == 'G'
1919 && name[3] == 'V')
536d1a88 1920 return TRUE;
90aeefb4
BF
1921 break;
1922 case 5:
1923 if (name[0] == 'S' && name[1] == 'T' && name[2] == 'D'
1924 && name[3] == 'I' && name[4] == 'N')
536d1a88 1925 return TRUE;
90aeefb4
BF
1926 break;
1927 case 6:
1928 if ((name[0] == 'S' && name[1] == 'T' && name[2] == 'D')
1929 &&((name[3] == 'O' && name[4] == 'U' && name[5] == 'T')
1930 ||(name[3] == 'E' && name[4] == 'R' && name[5] == 'R')))
536d1a88 1931 return TRUE;
90aeefb4
BF
1932 break;
1933 case 7:
1934 if (name[0] == 'A' && name[1] == 'R' && name[2] == 'G'
1935 && name[3] == 'V' && name[4] == 'O' && name[5] == 'U'
1936 && name[6] == 'T')
536d1a88 1937 return TRUE;
90aeefb4
BF
1938 break;
1939 }
536d1a88
BF
1940 }
1941 /* *{""}, or a special variable like $@ */
1942 else
1943 return TRUE;
9c913148 1944
536d1a88
BF
1945 return FALSE;
1946}
1947
1948
1949/* This function is called if parse_gv_stash_name() failed to
1950 * find a stash, or if GV_NOTQUAL or an empty name was passed
1951 * to gv_fetchpvn_flags.
9c913148 1952 *
536d1a88
BF
1953 * It returns FALSE if the default stash can't be found nor created,
1954 * which might happen during global destruction.
1955 */
1956PERL_STATIC_INLINE bool
1957S_find_default_stash(pTHX_ HV **stash, const char *name, STRLEN len,
1958 const U32 is_utf8, const I32 add,
1959 const svtype sv_type)
1960{
1961 PERL_ARGS_ASSERT_FIND_DEFAULT_STASH;
9c913148 1962
536d1a88 1963 /* No stash in name, so see how we can default */
90aeefb4 1964
536d1a88
BF
1965 if ( gv_is_in_main(name, len, is_utf8) ) {
1966 *stash = PL_defstash;
1967 }
1968 else {
1969 if (IN_PERL_COMPILETIME) {
90aeefb4
BF
1970 *stash = PL_curstash;
1971 if (add && (PL_hints & HINT_STRICT_VARS) &&
1972 sv_type != SVt_PVCV &&
1973 sv_type != SVt_PVGV &&
1974 sv_type != SVt_PVFM &&
1975 sv_type != SVt_PVIO &&
1976 !(len == 1 && sv_type == SVt_PV &&
1977 (*name == 'a' || *name == 'b')) )
1978 {
c161da64 1979 GV**gvp = (GV**)hv_fetch(*stash,name,is_utf8 ? -(I32)len : (I32)len,0);
90aeefb4
BF
1980 if (!gvp || *gvp == (const GV *)&PL_sv_undef ||
1981 SvTYPE(*gvp) != SVt_PVGV)
1982 {
1983 *stash = NULL;
1984 }
1985 else if ((sv_type == SVt_PV && !GvIMPORTED_SV(*gvp)) ||
1986 (sv_type == SVt_PVAV && !GvIMPORTED_AV(*gvp)) ||
1987 (sv_type == SVt_PVHV && !GvIMPORTED_HV(*gvp)) )
1988 {
1989 /* diag_listed_as: Variable "%s" is not imported%s */
1990 Perl_ck_warner_d(
1991 aTHX_ packWARN(WARN_MISC),
147e3846 1992 "Variable \"%c%" UTF8f "\" is not imported",
90aeefb4
BF
1993 sv_type == SVt_PVAV ? '@' :
1994 sv_type == SVt_PVHV ? '%' : '$',
1995 UTF8fARG(is_utf8, len, name));
1996 if (GvCVu(*gvp))
1997 Perl_ck_warner_d(
1998 aTHX_ packWARN(WARN_MISC),
147e3846 1999 "\t(Did you mean &%" UTF8f " instead?)\n",
90aeefb4
BF
2000 UTF8fARG(is_utf8, len, name)
2001 );
2002 *stash = NULL;
2003 }
2004 }
2005 }
2006 else {
2007 /* Use the current op's stash */
2008 *stash = CopSTASH(PL_curcop);
2009 }
2010 }
90aeefb4
BF
2011
2012 if (!*stash) {
2013 if (add && !PL_in_clean_all) {
10860bf4
FC
2014 GV *gv;
2015 qerror(Perl_mess(aTHX_
147e3846 2016 "Global symbol \"%s%" UTF8f
d8c6310a 2017 "\" requires explicit package name (did you forget to "
147e3846 2018 "declare \"my %s%" UTF8f "\"?)",
d8c6310a
FC
2019 (sv_type == SVt_PV ? "$"
2020 : sv_type == SVt_PVAV ? "@"
2021 : sv_type == SVt_PVHV ? "%"
2022 : ""), UTF8fARG(is_utf8, len, name),
90aeefb4
BF
2023 (sv_type == SVt_PV ? "$"
2024 : sv_type == SVt_PVAV ? "@"
2025 : sv_type == SVt_PVHV ? "%"
10860bf4 2026 : ""), UTF8fARG(is_utf8, len, name)));
cd164bf8
BF
2027 /* To maintain the output of errors after the strict exception
2028 * above, and to keep compat with older releases, rather than
2029 * placing the variables in the pad, we place
2030 * them in the <none>:: stash.
2031 */
90aeefb4
BF
2032 gv = gv_fetchpvs("<none>::", GV_ADDMULTI, SVt_PVHV);
2033 if (!gv) {
2034 /* symbol table under destruction */
2035 return FALSE;
2036 }
2037 *stash = GvHV(gv);
2038 }
2039 else
2040 return FALSE;
2041 }
2042
2043 if (!SvREFCNT(*stash)) /* symbol table under destruction */
2044 return FALSE;
2045
2046 return TRUE;
2047}
2048
8c995aba
FC
2049/* gv_magicalize only turns on the SVf_READONLY flag, not SVf_PROTECT. So
2050 redefine SvREADONLY_on for that purpose. We don’t use it later on in
2051 this file. */
2052#undef SvREADONLY_on
2053#define SvREADONLY_on(sv) (SvFLAGS(sv) |= SVf_READONLY)
2054
930867a8
BF
2055/* gv_magicalize() is called by gv_fetchpvn_flags when creating
2056 * a new GV.
2057 * Note that it does not insert the GV into the stash prior to
2058 * magicalization, which some variables require need in order
c22e17d0 2059 * to work (like %+, %-, %!), so callers must take care of
1321bbe3 2060 * that.
9c913148 2061 *
1321bbe3
FC
2062 * It returns true if the gv did turn out to be magical one; i.e.,
2063 * if gv_magicalize actually did something.
930867a8
BF
2064 */
2065PERL_STATIC_INLINE bool
2066S_gv_magicalize(pTHX_ GV *gv, HV *stash, const char *name, STRLEN len,
1321bbe3 2067 const svtype sv_type)
79072805 2068{
960b831f 2069 SSize_t paren;
79072805 2070
930867a8 2071 PERL_ARGS_ASSERT_GV_MAGICALIZE;
9c913148 2072
44428a46 2073 if (stash != PL_defstash) { /* not the main stash */
1604cfb0
MS
2074 /* We only have to check for a few names here: a, b, EXPORT, ISA
2075 and VERSION. All the others apply only to the main stash or to
2076 CORE (which is checked right after this). */
2077 if (len) {
2078 switch (*name) {
2079 case 'E':
3092ee0c
YO
2080 if (
2081 len >= 6 && name[1] == 'X' &&
2082 (memEQs(name, len, "EXPORT")
eafd371c
YO
2083 ||memEQs(name, len, "EXPORT_OK")
2084 ||memEQs(name, len, "EXPORT_FAIL")
3092ee0c 2085 ||memEQs(name, len, "EXPORT_TAGS"))
eafd371c 2086 )
1604cfb0
MS
2087 GvMULTI_on(gv);
2088 break;
2089 case 'I':
eafd371c 2090 if (memEQs(name, len, "ISA"))
1604cfb0
MS
2091 gv_magicalize_isa(gv);
2092 break;
2093 case 'V':
eafd371c 2094 if (memEQs(name, len, "VERSION"))
1604cfb0
MS
2095 GvMULTI_on(gv);
2096 break;
2097 case 'a':
eafd371c 2098 if (stash == PL_debstash && memEQs(name, len, "args")) {
1604cfb0
MS
2099 GvMULTI_on(gv_AVadd(gv));
2100 break;
eafd371c
YO
2101 }
2102 /* FALLTHROUGH */
1604cfb0
MS
2103 case 'b':
2104 if (len == 1 && sv_type == SVt_PV)
2105 GvMULTI_on(gv);
2106 /* FALLTHROUGH */
2107 default:
2108 goto try_core;
2109 }
2110 goto ret;
2111 }
4aaa4757 2112 try_core:
1604cfb0
MS
2113 if (len > 1 /* shortest is uc */ && HvNAMELEN_get(stash) == 4) {
2114 /* Avoid null warning: */
2115 const char * const stashname = HvNAME(stash); assert(stashname);
2116 if (strBEGINs(stashname, "CORE"))
2117 S_maybe_add_coresub(aTHX_ 0, gv, name, len);
2118 }
44428a46
FC
2119 }
2120 else if (len > 1) {
2121#ifndef EBCDIC
1604cfb0
MS
2122 if (*name > 'V' ) {
2123 NOOP;
2124 /* Nothing else to do.
2125 The compiler will probably turn the switch statement into a
2126 branch table. Make sure we avoid even that small overhead for
2ae25f5c
KW
2127 the common case of lower case variable names. (On EBCDIC
2128 platforms, we can't just do:
2129 if (NATIVE_TO_ASCII(*name) > NATIVE_TO_ASCII('V') ) {
2130 because cases like '\027' in the switch statement below are
2131 C1 (non-ASCII) controls on those platforms, so the remapping
2132 would make them larger than 'V')
2133 */
1604cfb0 2134 } else
44428a46 2135#endif
1604cfb0
MS
2136 {
2137 switch (*name) {
2138 case 'A':
eafd371c 2139 if (memEQs(name, len, "ARGV")) {
1604cfb0
MS
2140 IoFLAGS(GvIOn(gv)) |= IOf_ARGV|IOf_START;
2141 }
eafd371c 2142 else if (memEQs(name, len, "ARGVOUT")) {
1604cfb0
MS
2143 GvMULTI_on(gv);
2144 }
2145 break;
2146 case 'E':
3092ee0c
YO
2147 if (
2148 len >= 6 && name[1] == 'X' &&
2149 (memEQs(name, len, "EXPORT")
055ae706
YO
2150 ||memEQs(name, len, "EXPORT_OK")
2151 ||memEQs(name, len, "EXPORT_FAIL")
3092ee0c 2152 ||memEQs(name, len, "EXPORT_TAGS"))
055ae706 2153 )
1604cfb0
MS
2154 GvMULTI_on(gv);
2155 break;
2156 case 'I':
eafd371c 2157 if (memEQs(name, len, "ISA")) {
1604cfb0
MS
2158 gv_magicalize_isa(gv);
2159 }
2160 break;
2161 case 'S':
eafd371c 2162 if (memEQs(name, len, "SIG")) {
1604cfb0
MS
2163 HV *hv;
2164 I32 i;
2165 if (!PL_psig_name) {
2166 Newxz(PL_psig_name, 2 * SIG_SIZE, SV*);
2167 Newxz(PL_psig_pend, SIG_SIZE, int);
2168 PL_psig_ptr = PL_psig_name + SIG_SIZE;
2169 } else {
2170 /* I think that the only way to get here is to re-use an
2171 embedded perl interpreter, where the previous
2172 use didn't clean up fully because
2173 PL_perl_destruct_level was 0. I'm not sure that we
2174 "support" that, in that I suspect in that scenario
2175 there are sufficient other garbage values left in the
2176 interpreter structure that something else will crash
2177 before we get here. I suspect that this is one of
2178 those "doctor, it hurts when I do this" bugs. */
2179 Zero(PL_psig_name, 2 * SIG_SIZE, SV*);
2180 Zero(PL_psig_pend, SIG_SIZE, int);
2181 }
2182 GvMULTI_on(gv);
2183 hv = GvHVn(gv);
2184 hv_magic(hv, NULL, PERL_MAGIC_sig);
2185 for (i = 1; i < SIG_SIZE; i++) {
2186 SV * const * const init = hv_fetch(hv, PL_sig_name[i], strlen(PL_sig_name[i]), 1);
2187 if (init)
2188 sv_setsv(*init, &PL_sv_undef);
2189 }
2190 }
2191 break;
2192 case 'V':
eafd371c 2193 if (memEQs(name, len, "VERSION"))
1604cfb0
MS
2194 GvMULTI_on(gv);
2195 break;
e5218da5 2196 case '\003': /* $^CHILD_ERROR_NATIVE */
eafd371c 2197 if (memEQs(name, len, "\003HILD_ERROR_NATIVE"))
1604cfb0 2198 goto magicalize;
27deb0cf
YO
2199 /* @{^CAPTURE} %{^CAPTURE} */
2200 if (memEQs(name, len, "\003APTURE")) {
2201 AV* const av = GvAVn(gv);
fa531f32 2202 const Size_t n = *name;
27deb0cf 2203
fa531f32 2204 sv_magic(MUTABLE_SV(av), (SV*)n, PERL_MAGIC_regdata, NULL, 0);
27deb0cf
YO
2205 SvREADONLY_on(av);
2206
d8422270 2207 require_tie_mod_s(gv, '+', "Tie::Hash::NamedCapture",0);
27deb0cf
YO
2208
2209 } else /* %{^CAPTURE_ALL} */
2210 if (memEQs(name, len, "\003APTURE_ALL")) {
d8422270 2211 require_tie_mod_s(gv, '-', "Tie::Hash::NamedCapture",0);
27deb0cf 2212 }
1604cfb0 2213 break;
6c12e0ee 2214 case '\005': /* ${^ENCODING} */
eafd371c 2215 if (memEQs(name, len, "\005NCODING"))
1604cfb0
MS
2216 goto magicalize;
2217 break;
6c12e0ee 2218 case '\007': /* ${^GLOBAL_PHASE} */
eafd371c 2219 if (memEQs(name, len, "\007LOBAL_PHASE"))
1604cfb0
MS
2220 goto ro_magicalize;
2221 break;
93f6f965
YO
2222 case '\010': /* %{^HOOK} */
2223 if (memEQs(name, len, "\010OOK")) {
2224 GvMULTI_on(gv);
2225 HV *hv = GvHVn(gv);
2226 hv_magic(hv, NULL, PERL_MAGIC_hook);
2227 }
2228 break;
d80a076d
YO
2229 case '\014':
2230 if ( memEQs(name, len, "\014AST_FH") || /* ${^LAST_FH} */
2231 memEQs(name, len, "\014AST_SUCCESSFUL_PATTERN")) /* ${^LAST_SUCCESSFUL_PATTERN} */
1604cfb0
MS
2232 goto ro_magicalize;
2233 break;
6c12e0ee 2234 case '\015': /* ${^MATCH} */
eafd371c 2235 if (memEQs(name, len, "\015ATCH")) {
960b831f
NC
2236 paren = RX_BUFF_IDX_CARET_FULLMATCH;
2237 goto storeparen;
2238 }
66230c86 2239 break;
6c12e0ee 2240 case '\017': /* ${^OPEN} */
eafd371c 2241 if (memEQs(name, len, "\017PEN"))
1604cfb0
MS
2242 goto magicalize;
2243 break;
6c12e0ee 2244 case '\020': /* ${^PREMATCH} ${^POSTMATCH} */
eafd371c 2245 if (memEQs(name, len, "\020REMATCH")) {
960b831f
NC
2246 paren = RX_BUFF_IDX_CARET_PREMATCH;
2247 goto storeparen;
2248 }
eafd371c 2249 if (memEQs(name, len, "\020OSTMATCH")) {
960b831f
NC
2250 paren = RX_BUFF_IDX_CARET_POSTMATCH;
2251 goto storeparen;
2252 }
1604cfb0 2253 break;
f512d242
KW
2254 case '\023':
2255 if (memEQs(name, len, "\023AFE_LOCALES"))
1604cfb0
MS
2256 goto ro_magicalize;
2257 break;
2258 case '\024': /* ${^TAINT} */
eafd371c 2259 if (memEQs(name, len, "\024AINT"))
1604cfb0
MS
2260 goto ro_magicalize;
2261 break;
2262 case '\025': /* ${^UNICODE}, ${^UTF8LOCALE} */
eafd371c 2263 if (memEQs(name, len, "\025NICODE"))
1604cfb0 2264 goto ro_magicalize;
eafd371c 2265 if (memEQs(name, len, "\025TF8LOCALE"))
1604cfb0 2266 goto ro_magicalize;
eafd371c 2267 if (memEQs(name, len, "\025TF8CACHE"))
1604cfb0
MS
2268 goto magicalize;
2269 break;
2270 case '\027': /* $^WARNING_BITS */
eafd371c 2271 if (memEQs(name, len, "\027ARNING_BITS"))
1604cfb0 2272 goto magicalize;
8ca2a5d6 2273#ifdef WIN32
eafd371c 2274 else if (memEQs(name, len, "\027IN32_SLOPPY_STAT"))
1604cfb0 2275 goto magicalize;
8ca2a5d6 2276#endif
1604cfb0
MS
2277 break;
2278 case '1':
2279 case '2':
2280 case '3':
2281 case '4':
2282 case '5':
2283 case '6':
2284 case '7':
2285 case '8':
2286 case '9':
2287 {
2288 /* Ensures that we have an all-digit variable, ${"1foo"} fails
2289 this test */
22ff3130
HS
2290 UV uv;
2291 if (!grok_atoUV(name, &uv, NULL) || uv > I32_MAX)
1321bbe3 2292 goto ret;
22ff3130
HS
2293 /* XXX why are we using a SSize_t? */
2294 paren = (SSize_t)(I32)uv;
960b831f 2295 goto storeparen;
1604cfb0
MS
2296 }
2297 }
2298 }
392db708 2299 } else {
1604cfb0
MS
2300 /* Names of length 1. (Or 0. But name is NUL terminated, so that will
2301 be case '\0' in this switch statement (ie a default case) */
2302 switch (*name) {
2303 case '&': /* $& */
960b831f
NC
2304 paren = RX_BUFF_IDX_FULLMATCH;
2305 goto sawampersand;
1604cfb0 2306 case '`': /* $` */
960b831f
NC
2307 paren = RX_BUFF_IDX_PREMATCH;
2308 goto sawampersand;
1604cfb0 2309 case '\'': /* $' */
960b831f
NC
2310 paren = RX_BUFF_IDX_POSTMATCH;
2311 sawampersand:
1a904fc8 2312#ifdef PERL_SAWAMPERSAND
1604cfb0
MS
2313 if (!(
2314 sv_type == SVt_PVAV ||
2315 sv_type == SVt_PVHV ||
2316 sv_type == SVt_PVCV ||
2317 sv_type == SVt_PVFM ||
2318 sv_type == SVt_PVIO
2319 )) { PL_sawampersand |=
d3b97530
DM
2320 (*name == '`')
2321 ? SAWAMPERSAND_LEFT
2322 : (*name == '&')
2323 ? SAWAMPERSAND_MIDDLE
2324 : SAWAMPERSAND_RIGHT;
2325 }
1a904fc8 2326#endif
960b831f 2327 goto storeparen;
e91d8259
NC
2328 case '1': /* $1 */
2329 case '2': /* $2 */
2330 case '3': /* $3 */
2331 case '4': /* $4 */
2332 case '5': /* $5 */
2333 case '6': /* $6 */
2334 case '7': /* $7 */
2335 case '8': /* $8 */
2336 case '9': /* $9 */
960b831f
NC
2337 paren = *name - '0';
2338
2339 storeparen:
e91d8259
NC
2340 /* Flag the capture variables with a NULL mg_ptr
2341 Use mg_len for the array index to lookup. */
960b831f 2342 sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, NULL, paren);
e91d8259 2343 break;
cc4c2da6 2344
1604cfb0
MS
2345 case ':': /* $: */
2346 sv_setpv(GvSVn(gv),PL_chopset);
2347 goto magicalize;
cc4c2da6 2348
1604cfb0 2349 case '?': /* $? */
ff0cee69 2350#ifdef COMPLEX_STATUS
1604cfb0 2351 SvUPGRADE(GvSVn(gv), SVt_PVLV);
ff0cee69 2352#endif
1604cfb0 2353 goto magicalize;
ff0cee69 2354
1604cfb0
MS
2355 case '!': /* $! */
2356 GvMULTI_on(gv);
2357 /* If %! has been used, automatically load Errno.pm. */
d2c93421 2358
1604cfb0 2359 sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
d2c93421 2360
7c719134 2361 /* magicalization must be done before require_tie_mod_s is called */
1604cfb0 2362 if (sv_type == SVt_PVHV || sv_type == SVt_PVGV)
7c719134 2363 require_tie_mod_s(gv, '!', "Errno", 1);
d2c93421 2364
1604cfb0
MS
2365 break;
2366 case '-': /* $-, %-, @- */
2367 case '+': /* $+, %+, @+ */
27deb0cf
YO
2368 GvMULTI_on(gv); /* no used once warnings here */
2369 { /* $- $+ */
2370 sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
2371 if (*name == '+')
2372 SvREADONLY_on(GvSVn(gv));
2373 }
2374 { /* %- %+ */
2375 if (sv_type == SVt_PVHV || sv_type == SVt_PVGV)
2376 require_tie_mod_s(gv, *name, "Tie::Hash::NamedCapture",0);
2377 }
2378 { /* @- @+ */
2379 AV* const av = GvAVn(gv);
fa531f32 2380 const Size_t n = *name;
67261566 2381
fa531f32 2382 sv_magic(MUTABLE_SV(av), (SV*)n, PERL_MAGIC_regdata, NULL, 0);
27deb0cf
YO
2383 SvREADONLY_on(av);
2384 }
80305961 2385 break;
1604cfb0
MS
2386 case '*': /* $* */
2387 case '#': /* $# */
dcb414ac
JK
2388 if (sv_type == SVt_PV)
2389 /* diag_listed_as: $* is no longer supported as of Perl 5.30 */
2390 Perl_croak(aTHX_ "$%c is no longer supported as of Perl 5.30", *name);
2391 break;
1604cfb0
MS
2392 case '\010': /* $^H */
2393 {
2394 HV *const hv = GvHVn(gv);
2395 hv_magic(hv, NULL, PERL_MAGIC_hints);
2396 }
2397 goto magicalize;
2398 case '\023': /* $^S */
2399 ro_magicalize:
2400 SvREADONLY_on(GvSVn(gv));
2401 /* FALLTHROUGH */
2402 case '0': /* $0 */
2403 case '^': /* $^ */
2404 case '~': /* $~ */
2405 case '=': /* $= */
2406 case '%': /* $% */
2407 case '.': /* $. */
2408 case '(': /* $( */
2409 case ')': /* $) */
2410 case '<': /* $< */
2411 case '>': /* $> */
2412 case '\\': /* $\ */
2413 case '/': /* $/ */
2414 case '|': /* $| */
2415 case '$': /* $$ */
2416 case '[': /* $[ */
2417 case '\001': /* $^A */
2418 case '\003': /* $^C */
2419 case '\004': /* $^D */
2420 case '\005': /* $^E */
2421 case '\006': /* $^F */
2422 case '\011': /* $^I, NOT \t in EBCDIC */
2423 case '\016': /* $^N */
2424 case '\017': /* $^O */
2425 case '\020': /* $^P */
2426 case '\024': /* $^T */
2427 case '\027': /* $^W */
2428 magicalize:
2429 sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
2430 break;
2431
2432 case '\014': /* $^L */
2433 sv_setpvs(GvSVn(gv),"\f");
2434 break;
2435 case ';': /* $; */
2436 sv_setpvs(GvSVn(gv),"\034");
2437 break;
2438 case ']': /* $] */
2439 {
2440 SV * const sv = GvSV(gv);
2441 if (!sv_derived_from(PL_patchlevel, "version"))
2442 upg_version(PL_patchlevel, TRUE);
2443 GvSV(gv) = vnumify(PL_patchlevel);
2444 SvREADONLY_on(GvSV(gv));
2445 SvREFCNT_dec(sv);
2446 }
2447 break;
2448 case '\026': /* $^V */
2449 {
2450 SV * const sv = GvSV(gv);
2451 GvSV(gv) = new_version(PL_patchlevel);
2452 SvREADONLY_on(GvSV(gv));
2453 SvREFCNT_dec(sv);
2454 }
2455 break;
2456 case 'a':
2457 case 'b':
2458 if (sv_type == SVt_PV)
2459 GvMULTI_on(gv);
2460 }
79072805 2461 }
930867a8 2462
1321bbe3
FC
2463 ret:
2464 /* Return true if we actually did something. */
2465 return GvAV(gv) || GvHV(gv) || GvIO(gv) || GvCV(gv)
2466 || ( GvSV(gv) && (
2467 SvOK(GvSV(gv)) || SvMAGICAL(GvSV(gv))
2468 )
2469 );
71c35c05
BF
2470}
2471
8c995aba
FC
2472/* If we do ever start using this later on in the file, we need to make
2473 sure we don’t accidentally use the wrong definition. */
2474#undef SvREADONLY_on
2475
070dc475
BF
2476/* This function is called when the stash already holds the GV of the magic
2477 * variable we're looking for, but we need to check that it has the correct
2478 * kind of magic. For example, if someone first uses $! and then %!, the
2479 * latter would end up here, and we add the Errno tie to the HASH slot of
2480 * the *! glob.
2481 */
2482PERL_STATIC_INLINE void
2483S_maybe_multimagic_gv(pTHX_ GV *gv, const char *name, const svtype sv_type)
2484{
2485 PERL_ARGS_ASSERT_MAYBE_MULTIMAGIC_GV;
2486
2487 if (sv_type == SVt_PVHV || sv_type == SVt_PVGV) {
2488 if (*name == '!')
7c719134 2489 require_tie_mod_s(gv, '!', "Errno", 1);
070dc475 2490 else if (*name == '-' || *name == '+')
7c719134 2491 require_tie_mod_s(gv, *name, "Tie::Hash::NamedCapture", 0);
a678626e
A
2492 } else if (sv_type == SVt_PV) {
2493 if (*name == '*' || *name == '#') {
dcb414ac
JK
2494 /* diag_listed_as: $* is no longer supported as of Perl 5.30 */
2495 Perl_croak(aTHX_ "$%c is no longer supported as of Perl 5.30", *name);
a678626e 2496 }
070dc475
BF
2497 }
2498 if (sv_type==SVt_PV || sv_type==SVt_PVGV) {
2499 switch (*name) {
070dc475
BF
2500#ifdef PERL_SAWAMPERSAND
2501 case '`':
2502 PL_sawampersand |= SAWAMPERSAND_LEFT;
2503 (void)GvSVn(gv);
2504 break;
2505 case '&':
2506 PL_sawampersand |= SAWAMPERSAND_MIDDLE;
2507 (void)GvSVn(gv);
2508 break;
2509 case '\'':
2510 PL_sawampersand |= SAWAMPERSAND_RIGHT;
2511 (void)GvSVn(gv);
2512 break;
2513#endif
2514 }
2515 }
2516}
2517
84ca0d82
KW
2518/*
2519=for apidoc gv_fetchpv
2520=for apidoc_item |GV *|gv_fetchpvn|const char * nambeg|STRLEN full_len|I32 flags|const svtype sv_type
2521=for apidoc_item ||gv_fetchpvn_flags
2522=for apidoc_item |GV *|gv_fetchpvs|"name"|I32 flags|const svtype sv_type
2523=for apidoc_item ||gv_fetchsv
2524=for apidoc_item |GV *|gv_fetchsv_nomg|SV *name|I32 flags|const svtype sv_type
2525
2526These all return the GV of type C<sv_type> whose name is given by the inputs,
2527or NULL if no GV of that name and type could be found. See L<perlguts/Stashes
2528and Globs>.
2529
2530The only differences are how the input name is specified, and if 'get' magic is
2531normally used in getting that name.
2532
2533Don't be fooled by the fact that only one form has C<flags> in its name. They
2534all have a C<flags> parameter in fact, and all the flag bits have the same
2535meanings for all
2536
2537If any of the flags C<GV_ADD>, C<GV_ADDMG>, C<GV_ADDWARN>, C<GV_ADDMULTI>, or
2538C<GV_NOINIT> is set, a GV is created if none already exists for the input name
2539and type. However, C<GV_ADDMG> will only do the creation for magical GV's.
2540For all of these flags except C<GV_NOINIT>, C<L</gv_init_pvn>> is called after
2541the addition. C<GV_ADDWARN> is used when the caller expects that adding won't
2542be necessary because the symbol should already exist; but if not, add it
2543anyway, with a warning that it was unexpectedly absent. The C<GV_ADDMULTI>
2544flag means to pretend that the GV has been seen before (I<i.e.>, suppress "Used
2545once" warnings).
2546
2547The flag C<GV_NOADD_NOINIT> causes C<L</gv_init_pvn>> not be to called if the
2548GV existed but isn't PVGV.
2549
2550If the C<SVf_UTF8> bit is set, the name is treated as being encoded in UTF-8;
2551otherwise the name won't be considered to be UTF-8 in the C<pv>-named forms,
2552and the UTF-8ness of the underlying SVs will be used in the C<sv> forms.
2553
2554If the flag C<GV_NOTQUAL> is set, the caller warrants that the input name is a
2555plain symbol name, not qualified with a package, otherwise the name is checked
2556for being a qualified one.
2557
2558In C<gv_fetchpv>, C<nambeg> is a C string, NUL-terminated with no intermediate
2559NULs.
2560
2561In C<gv_fetchpvs>, C<name> is a literal C string, hence is enclosed in
2562double quotes.
2563
2564C<gv_fetchpvn> and C<gv_fetchpvn_flags> are identical. In these, <nambeg> is
2565a Perl string whose byte length is given by C<full_len>, and may contain
2566embedded NULs.
2567
2568In C<gv_fetchsv> and C<gv_fetchsv_nomg>, the name is extracted from the PV of
2569the input C<name> SV. The only difference between these two forms is that
2570'get' magic is normally done on C<name> in C<gv_fetchsv>, and always skipped
2571with C<gv_fetchsv_nomg>. Including C<GV_NO_SVGMAGIC> in the C<flags> parameter
2572to C<gv_fetchsv> makes it behave identically to C<gv_fetchsv_nomg>.
2573
2574=for apidoc Amnh||GV_ADD
2575=for apidoc Amnh||GV_ADDMG
2576=for apidoc Amnh||GV_ADDMULTI
2577=for apidoc Amnh||GV_ADDWARN
84ca0d82 2578=for apidoc Amnh||GV_NOINIT
1607e393 2579=for apidoc Amnh||GV_NOADD_NOINIT
84ca0d82
KW
2580=for apidoc Amnh||GV_NOTQUAL
2581=for apidoc Amnh||GV_NO_SVGMAGIC
2582=for apidoc Amnh||SVf_UTF8
2583
2584=cut
2585*/
2586
71c35c05
BF
2587GV *
2588Perl_gv_fetchpvn_flags(pTHX_ const char *nambeg, STRLEN full_len, I32 flags,
1604cfb0 2589 const svtype sv_type)
71c35c05 2590{
71c35c05
BF
2591 const char *name = nambeg;
2592 GV *gv = NULL;
2593 GV**gvp;
2594 STRLEN len;
2595 HV *stash = NULL;
2596 const I32 no_init = flags & (GV_NOADD_NOINIT | GV_NOINIT);
2597 const I32 no_expand = flags & GV_NOEXPAND;
2598 const I32 add = flags & ~GV_NOADD_MASK;
2599 const U32 is_utf8 = flags & SVf_UTF8;
930867a8 2600 bool addmg = cBOOL(flags & GV_ADDMG);
71c35c05
BF
2601 const char *const name_end = nambeg + full_len;
2602 U32 faking_it;
2603
2604 PERL_ARGS_ASSERT_GV_FETCHPVN_FLAGS;
2605
2606 /* If we have GV_NOTQUAL, the caller promised that
2607 * there is no stash, so we can skip the check.
2608 * Similarly if full_len is 0, since then we're
2609 * dealing with something like *{""} or ""->foo()
2610 */
2611 if ((flags & GV_NOTQUAL) || !full_len) {
2612 len = full_len;
2613 }
2614 else if (parse_gv_stash_name(&stash, &gv, &name, &len, nambeg, full_len, is_utf8, add)) {
2615 if (name == name_end) return gv;
2616 }
2617 else {
2618 return NULL;
2619 }
2620
2621 if (!stash && !find_default_stash(&stash, name, len, is_utf8, add, sv_type)) {
2622 return NULL;
2623 }
9c913148 2624
71c35c05 2625 /* By this point we should have a stash and a name */
c161da64 2626 gvp = (GV**)hv_fetch(stash,name,is_utf8 ? -(I32)len : (I32)len,add);
71c35c05 2627 if (!gvp || *gvp == (const GV *)&PL_sv_undef) {
8fcb2425 2628 if (addmg) gv = (GV *)newSV_type(SVt_NULL); /* tentatively */
1604cfb0 2629 else return NULL;
71c35c05
BF
2630 }
2631 else gv = *gvp, addmg = 0;
2632 /* From this point on, addmg means gv has not been inserted in the
2633 symtab yet. */
2634
2635 if (SvTYPE(gv) == SVt_PVGV) {
c002ae9a
BF
2636 /* The GV already exists, so return it, but check if we need to do
2637 * anything else with it before that.
2638 */
1604cfb0 2639 if (add) {
c002ae9a
BF
2640 /* This is the heuristic that handles if a variable triggers the
2641 * 'used only once' warning. If there's already a GV in the stash
2642 * with this name, then we assume that the variable has been used
2643 * before and turn its MULTI flag on.
2644 * It's a heuristic because it can easily be "tricked", like with
2645 * BEGIN { $a = 1; $::{foo} = *a }; () = $foo
2646 * not warning about $main::foo being used just once
2647 */
1604cfb0
MS
2648 GvMULTI_on(gv);
2649 gv_init_svtype(gv, sv_type);
71c35c05
BF
2650 /* You reach this path once the typeglob has already been created,
2651 either by the same or a different sigil. If this path didn't
2652 exist, then (say) referencing $! first, and %! second would
2653 mean that %! was not handled correctly. */
1604cfb0 2654 if (len == 1 && stash == PL_defstash) {
070dc475 2655 maybe_multimagic_gv(gv, name, sv_type);
1604cfb0 2656 }
b59bf0b2 2657 else if (sv_type == SVt_PVAV
1604cfb0
MS
2658 && memEQs(name, len, "ISA")
2659 && (!GvAV(gv) || !SvSMAGICAL(GvAV(gv))))
2660 gv_magicalize_isa(gv);
2661 }
2662 return gv;
71c35c05 2663 } else if (no_init) {
1604cfb0
MS
2664 assert(!addmg);
2665 return gv;
c002ae9a
BF
2666 }
2667 /* If GV_NOEXPAND is true and what we got off the stash is a ref,
2668 * don't expand it to a glob. This is an optimization so that things
2669 * copying constants over, like Exporter, don't have to be rewritten
2670 * to take into account that you can store more than just globs in
2671 * stashes.
2672 */
2673 else if (no_expand && SvROK(gv)) {
1604cfb0
MS
2674 assert(!addmg);
2675 return gv;
71c35c05
BF
2676 }
2677
2678 /* Adding a new symbol.
2679 Unless of course there was already something non-GV here, in which case
2680 we want to behave as if there was always a GV here, containing some sort
2681 of subroutine.
2682 Otherwise we run the risk of creating things like GvIO, which can cause
2683 subtle bugs. eg the one that tripped up SQL::Translator */
2684
2685 faking_it = SvOK(gv);
2686
2687 if (add & GV_ADDWARN)
1604cfb0
MS
2688 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
2689 "Had to create %" UTF8f " unexpectedly",
2690 UTF8fARG(is_utf8, name_end-nambeg, nambeg));
71c35c05
BF
2691 gv_init_pvn(gv, stash, name, len, (add & GV_ADDMULTI)|is_utf8);
2692
7a207065
KW
2693 if ( full_len != 0
2694 && isIDFIRST_lazy_if_safe(name, name + full_len, is_utf8)
2695 && !ckWARN(WARN_ONCE) )
2696 {
71c35c05 2697 GvMULTI_on(gv) ;
7a207065 2698 }
71c35c05
BF
2699
2700 /* set up magic where warranted */
1321bbe3 2701 if ( gv_magicalize(gv, stash, name, len, sv_type) ) {
930867a8 2702 /* See 23496c6 */
1321bbe3
FC
2703 if (addmg) {
2704 /* gv_magicalize magicalised this gv, so we want it
930867a8 2705 * stored in the symtab.
9c913148 2706 * Effectively the caller is asking, ‘Does this gv exist?’
1321bbe3 2707 * And we respond, ‘Er, *now* it does!’
930867a8
BF
2708 */
2709 (void)hv_store(stash,name,len,(SV *)gv,0);
1321bbe3
FC
2710 }
2711 }
2712 else if (addmg) {
2713 /* The temporary GV created above */
930867a8
BF
2714 SvREFCNT_dec_NN(gv);
2715 gv = NULL;
930867a8 2716 }
9c913148 2717
e6066781 2718 if (gv) gv_init_svtype(gv, faking_it ? SVt_PVCV : sv_type);
93a17b20 2719 return gv;
79072805
LW
2720}
2721
a5dd70c5 2722/*
1607e393 2723=for apidoc gv_efullname3
a5dd70c5 2724=for apidoc_item gv_efullname4
1607e393
KW
2725=for apidoc_item gv_fullname3
2726=for apidoc_item gv_fullname4
a5dd70c5
KW
2727
2728Place the full package name of C<gv> into C<sv>. The C<gv_e*> forms return
2729instead the effective package name (see L</HvENAME>).
2730
2731If C<prefix> is non-NULL, it is considered to be a C language NUL-terminated
2732string, and the stored name will be prefaced with it.
2733
2734The other difference between the functions is that the C<*4> forms have an
2735extra parameter, C<keepmain>. If C<true> an initial C<main::> in the name is
2736kept; if C<false> it is stripped. With the C<*3> forms, it is always kept.
2737
2738=cut
2739*/
2740
79072805 2741void
35a4481c 2742Perl_gv_fullname4(pTHX_ SV *sv, const GV *gv, const char *prefix, bool keepmain)
43693395 2743{
ed60a868 2744 const char *name;
35a4481c 2745 const HV * const hv = GvSTASH(gv);
7918f24d
NC
2746
2747 PERL_ARGS_ASSERT_GV_FULLNAME4;
2748
666ea192 2749 sv_setpv(sv, prefix ? prefix : "");
a0288114 2750
52a6327b 2751 if (hv && (name = HvNAME(hv))) {
ed60a868 2752 const STRLEN len = HvNAMELEN(hv);
61e2287f 2753 if (keepmain || ! memBEGINs(name, len, "main")) {
1604cfb0
MS
2754 sv_catpvn_flags(sv,name,len,HvNAMEUTF8(hv)?SV_CATUTF8:SV_CATBYTES);
2755 sv_catpvs(sv,"::");
ed60a868 2756 }
43693395 2757 }
ed60a868 2758 else sv_catpvs(sv,"__ANON__::");
518db96a 2759 sv_catsv(sv,newSVhek_mortal(GvNAME_HEK(gv)));
43693395
GS
2760}
2761
2762void
35a4481c 2763Perl_gv_efullname4(pTHX_ SV *sv, const GV *gv, const char *prefix, bool keepmain)
43693395 2764{
099be4f1 2765 const GV * const egv = GvEGVx(gv);
7918f24d
NC
2766
2767 PERL_ARGS_ASSERT_GV_EFULLNAME4;
2768
46c461b5 2769 gv_fullname4(sv, egv ? egv : gv, prefix, keepmain);
43693395
GS
2770}
2771
39a65960
DM
2772
2773/* recursively scan a stash and any nested stashes looking for entries
2774 * that need the "only used once" warning raised
2775 */
2776
79072805 2777void
51da40ed 2778Perl_gv_check(pTHX_ HV *stash)
79072805 2779{
eb578fdb 2780 I32 i;
463ee0b2 2781
7918f24d
NC
2782 PERL_ARGS_ASSERT_GV_CHECK;
2783
53083cad 2784 if (!HvHasAUX(stash))
1604cfb0 2785 return;
90754377 2786
9e5cda6b 2787 assert(HvARRAY(stash));
90754377 2788
0cdaae3e
NC
2789 /* mark stash is being scanned, to avoid recursing */
2790 HvAUX(stash)->xhv_aux_flags |= HvAUXf_SCAN_STASH;
a0d0e21e 2791 for (i = 0; i <= (I32) HvMAX(stash); i++) {
e1ec3a88 2792 const HE *entry;
1604cfb0 2793 for (entry = HvARRAY(stash)[i]; entry; entry = HeNEXT(entry)) {
eb578fdb 2794 GV *gv;
b7787f18 2795 HV *hv;
1604cfb0 2796 STRLEN keylen = HeKLEN(entry);
e7acdfe9
DM
2797 const char * const key = HeKEY(entry);
2798
1604cfb0
MS
2799 if (keylen >= 2 && key[keylen-2] == ':' && key[keylen-1] == ':' &&
2800 (gv = MUTABLE_GV(HeVAL(entry))) && isGV(gv) && (hv = GvHV(gv)))
2801 {
2802 if (hv != PL_defstash && hv != stash
53083cad 2803 && !(HvHasAUX(hv)
90754377
DM
2804 && (HvAUX(hv)->xhv_aux_flags & HvAUXf_SCAN_STASH))
2805 )
1604cfb0
MS
2806 gv_check(hv); /* nested package */
2807 }
7a207065
KW
2808 else if ( HeKLEN(entry) != 0
2809 && *HeKEY(entry) != '_'
2810 && isIDFIRST_lazy_if_safe(HeKEY(entry),
2811 HeKEY(entry) + HeKLEN(entry),
2812 HeUTF8(entry)) )
2813 {
e1ec3a88 2814 const char *file;
1604cfb0
MS
2815 gv = MUTABLE_GV(HeVAL(entry));
2816 if (SvTYPE(gv) != SVt_PVGV || GvMULTI(gv))
2817 continue;
2818 file = GvFILE(gv);
6760f691 2819 assert(PL_curcop == &PL_compiling);
1604cfb0 2820 CopLINE_set(PL_curcop, GvLINE(gv));
1dc74fdb 2821#ifdef USE_ITHREADS
6760f691
YO
2822 SAVECOPFILE_FREE(PL_curcop);
2823 CopFILE_set(PL_curcop, (char *)file); /* set for warning */
1dc74fdb 2824#else
1604cfb0
MS
2825 CopFILEGV(PL_curcop)
2826 = gv_fetchfile_flags(file, HEK_LEN(GvFILE_HEK(gv)), 0);
1dc74fdb 2827#endif
1604cfb0
MS
2828 Perl_warner(aTHX_ packWARN(WARN_ONCE),
2829 "Name \"%" HEKf "::%" HEKf
2830 "\" used only once: possible typo",
d0c0e7dd
FC
2831 HEKfARG(HvNAME_HEK(stash)),
2832 HEKfARG(GvNAME_HEK(gv)));
1604cfb0
MS
2833 }
2834 }
79072805 2835 }
0cdaae3e 2836 HvAUX(stash)->xhv_aux_flags &= ~HvAUXf_SCAN_STASH;
79072805
LW
2837}
2838
875e4924
KW
2839/*
2840=for apidoc newGVgen
2841=for apidoc_item newGVgen_flags
2842
2843Create a new, guaranteed to be unique, GV in the package given by the
2844NUL-terminated C language string C<pack>, and return a pointer to it.
2845
2846For C<newGVgen> or if C<flags> in C<newGVgen_flags> is 0, C<pack> is to be
2847considered to be encoded in Latin-1. The only other legal C<flags> value is
2848C<SVf_UTF8>, which indicates C<pack> is to be considered to be encoded in
2849UTF-8.
2850
2851=cut
2852*/
2853
79072805 2854GV *
9cc50d5b 2855Perl_newGVgen_flags(pTHX_ const char *pack, U32 flags)
79072805 2856{
9cc50d5b 2857 PERL_ARGS_ASSERT_NEWGVGEN_FLAGS;
b17a0679 2858 assert(!(flags & ~SVf_UTF8));
7918f24d 2859
147e3846 2860 return gv_fetchpv(Perl_form(aTHX_ "%" UTF8f "::_GEN_%ld",
b17a0679 2861 UTF8fARG(flags, strlen(pack), pack),
9cc50d5b
BF
2862 (long)PL_gensym++),
2863 GV_ADD, SVt_PVGV);
79072805
LW
2864}
2865
2866/* hopefully this is only called on local symbol table entries */
2867
2868GP*
864dbfa3 2869Perl_gp_ref(pTHX_ GP *gp)
79072805 2870{
1d7c1841 2871 if (!gp)
1604cfb0 2872 return NULL;
79072805 2873 gp->gp_refcnt++;
44a8e56a 2874 if (gp->gp_cv) {
1604cfb0
MS
2875 if (gp->gp_cvgen) {
2876 /* If the GP they asked for a reference to contains
e1a479c5
BB
2877 a method cache entry, clear it first, so that we
2878 don't infect them with our cached entry */
1604cfb0
MS
2879 SvREFCNT_dec_NN(gp->gp_cv);
2880 gp->gp_cv = NULL;
2881 gp->gp_cvgen = 0;
2882 }
44a8e56a 2883 }
79072805 2884 return gp;
79072805
LW
2885}
2886
2887void
864dbfa3 2888Perl_gp_free(pTHX_ GV *gv)
79072805 2889{
79072805 2890 GP* gp;
b0d55c99 2891 int attempts = 100;
2c205b54 2892 bool in_global_destruction = PL_phase == PERL_PHASE_DESTRUCT;
79072805 2893
f7877b28 2894 if (!gv || !isGV_with_GP(gv) || !(gp = GvGP(gv)))
1604cfb0 2895 return;
f248d071 2896 if (gp->gp_refcnt == 0) {
1604cfb0
MS
2897 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
2898 "Attempt to free unreferenced glob pointers"
2899 pTHX__FORMAT pTHX__VALUE);
79072805
LW
2900 return;
2901 }
4571f4a7 2902 if (gp->gp_refcnt > 1) {
bc81b34d 2903 borrowed:
1604cfb0
MS
2904 if (gp->gp_egv == gv)
2905 gp->gp_egv = 0;
2906 gp->gp_refcnt--;
2907 GvGP_set(gv, NULL);
79072805 2908 return;
748a9306 2909 }
79072805 2910
b0d55c99
FC
2911 while (1) {
2912 /* Copy and null out all the glob slots, so destructors do not see
2913 freed SVs. */
2914 HEK * const file_hek = gp->gp_file_hek;
2c205b54
NC
2915 SV * sv = gp->gp_sv;
2916 AV * av = gp->gp_av;
2917 HV * hv = gp->gp_hv;
2918 IO * io = gp->gp_io;
2919 CV * cv = gp->gp_cv;
2920 CV * form = gp->gp_form;
2921
2922 int need = 0;
b0d55c99
FC
2923
2924 gp->gp_file_hek = NULL;
2925 gp->gp_sv = NULL;
2926 gp->gp_av = NULL;
2927 gp->gp_hv = NULL;
2928 gp->gp_io = NULL;
2929 gp->gp_cv = NULL;
2930 gp->gp_form = NULL;
2931
2932 if (file_hek)
1604cfb0 2933 unshare_hek(file_hek);
b0d55c99 2934
2c205b54
NC
2935 /* Storing the SV on the temps stack (instead of freeing it immediately)
2936 is an admitted bodge that attempt to compensate for the lack of
2937 reference counting on the stack. The motivation is that typeglob syntax
2938 is extremely short hence programs such as '$a += (*a = 2)' are often
2939 found randomly by researchers running fuzzers. Previously these
2940 programs would trigger errors, that the researchers would
2941 (legitimately) report, and then we would spend time figuring out that
2942 the cause was "stack not reference counted" and so not a dangerous
2943 security hole. This consumed a lot of researcher time, our time, and
2944 prevents "interesting" security holes being uncovered.
2945
2946 Typeglob assignment is rarely used in performance critical production
2947 code, so we aren't causing much slowdown by doing extra work here.
2948
2949 In turn, the need to check for SvOBJECT (and references to objects) is
2950 because we have regression tests that rely on timely destruction that
2951 happens *within this while loop* to demonstrate behaviour, and
2952 potentially there is also *working* code in the wild that relies on
2953 such behaviour.
2954
2955 And we need to avoid doing this in global destruction else we can end
2956 up with "Attempt to free temp prematurely ... Unbalanced string table
2957 refcount".
2958
2959 Hence the whole thing is a heuristic intended to mitigate against
2960 simple problems likely found by fuzzers but never written by humans,
2961 whilst leaving working code unchanged. */
2962 if (sv) {
0c6362ad 2963 SV *referent;
2c205b54
NC
2964 if (SvREFCNT(sv) > 1 || SvOBJECT(sv) || UNLIKELY(in_global_destruction)) {
2965 SvREFCNT_dec_NN(sv);
2966 sv = NULL;
0c6362ad
JK
2967 } else if (SvROK(sv) && (referent = SvRV(sv))
2968 && (SvREFCNT(referent) > 1 || SvOBJECT(referent))) {
2c205b54
NC
2969 SvREFCNT_dec_NN(sv);
2970 sv = NULL;
2971 } else {
2972 ++need;
2973 }
2974 }
2975 if (av) {
2976 if (SvREFCNT(av) > 1 || SvOBJECT(av) || UNLIKELY(in_global_destruction)) {
2977 SvREFCNT_dec_NN(av);
2978 av = NULL;
2979 } else {
2980 ++need;
2981 }
2982 }
b0d55c99
FC
2983 /* FIXME - another reference loop GV -> symtab -> GV ?
2984 Somehow gp->gp_hv can end up pointing at freed garbage. */
2985 if (hv && SvTYPE(hv) == SVt_PVHV) {
c2242065 2986 const HEK *hvname_hek = HvNAME_HEK(hv);
923ed580
FC
2987 if (PL_stashcache && hvname_hek) {
2988 DEBUG_o(Perl_deb(aTHX_
147e3846 2989 "gp_free clearing PL_stashcache for '%" HEKf "'\n",
923ed580 2990 HEKfARG(hvname_hek)));
0ca9877d 2991 (void)hv_deletehek(PL_stashcache, hvname_hek, G_DISCARD);
923ed580 2992 }
2c205b54
NC
2993 if (SvREFCNT(hv) > 1 || SvOBJECT(hv) || UNLIKELY(in_global_destruction)) {
2994 SvREFCNT_dec_NN(hv);
2995 hv = NULL;
2996 } else {
2997 ++need;
2998 }
b0d55c99 2999 }
96d7c888 3000 if (io && SvREFCNT(io) == 1 && IoIFP(io)
1604cfb0
MS
3001 && (IoTYPE(io) == IoTYPE_WRONLY ||
3002 IoTYPE(io) == IoTYPE_RDWR ||
3003 IoTYPE(io) == IoTYPE_APPEND)
3004 && ckWARN_d(WARN_IO)
3005 && IoIFP(io) != PerlIO_stdin()
3006 && IoIFP(io) != PerlIO_stdout()
3007 && IoIFP(io) != PerlIO_stderr()
3008 && !(IoFLAGS(io) & IOf_FAKE_DIRP))
3009 io_close(io, gv, FALSE, TRUE);
2c205b54
NC
3010 if (io) {
3011 if (SvREFCNT(io) > 1 || SvOBJECT(io) || UNLIKELY(in_global_destruction)) {
3012 SvREFCNT_dec_NN(io);
3013 io = NULL;
3014 } else {
3015 ++need;
3016 }
3017 }
3018 if (cv) {
3019 if (SvREFCNT(cv) > 1 || SvOBJECT(cv) || UNLIKELY(in_global_destruction)) {
3020 SvREFCNT_dec_NN(cv);
3021 cv = NULL;
3022 } else {
3023 ++need;
3024 }
3025 }
3026 if (form) {
3027 if (SvREFCNT(form) > 1 || SvOBJECT(form) || UNLIKELY(in_global_destruction)) {
3028 SvREFCNT_dec_NN(form);
3029 form = NULL;
3030 } else {
3031 ++need;
3032 }
3033 }
3034
3035 if (need) {
3036 /* We don't strictly need to defer all this to the end, but it's
3037 easiest to do so. The subtle problems we have are
3038 1) any of the actions triggered by the various SvREFCNT_dec()s in
3039 any of the intermediate blocks can cause more items to be added
3040 to the temps stack. So we can't "cache" its state locally
3041 2) We'd have to re-check the "extend by 1?" for each time.
3042 Whereas if we don't NULL out the values that we want to put onto
3043 the save stack until here, we can do it in one go, with one
3044 one size check. */
3045
3046 SSize_t max_ix = PL_tmps_ix + need;
3047
3048 if (max_ix >= PL_tmps_max) {
3049 tmps_grow_p(max_ix);
3050 }
3051
3052 if (sv) {
3053 PL_tmps_stack[++PL_tmps_ix] = sv;
3054 }
3055 if (av) {
3056 PL_tmps_stack[++PL_tmps_ix] = (SV *) av;
3057 }
3058 if (hv) {
3059 PL_tmps_stack[++PL_tmps_ix] = (SV *) hv;
3060 }
3061 if (io) {
3062 PL_tmps_stack[++PL_tmps_ix] = (SV *) io;
3063 }
3064 if (cv) {
3065 PL_tmps_stack[++PL_tmps_ix] = (SV *) cv;
3066 }
3067 if (form) {
3068 PL_tmps_stack[++PL_tmps_ix] = (SV *) form;
3069 }
3070 }
b0d55c99 3071
bc81b34d
FC
3072 /* Possibly reallocated by a destructor */
3073 gp = GvGP(gv);
3074
b0d55c99
FC
3075 if (!gp->gp_file_hek
3076 && !gp->gp_sv
3077 && !gp->gp_av
3078 && !gp->gp_hv
3079 && !gp->gp_io
3080 && !gp->gp_cv
3081 && !gp->gp_form) break;
3082
3083 if (--attempts == 0) {
1604cfb0
MS
3084 Perl_die(aTHX_
3085 "panic: gp_free failed to free glob pointer - "
3086 "something is repeatedly re-creating entries"
3087 );
b0d55c99 3088 }
13207a71 3089 }
748a9306 3090
bc81b34d
FC
3091 /* Possibly incremented by a destructor doing glob assignment */
3092 if (gp->gp_refcnt > 1) goto borrowed;
79072805 3093 Safefree(gp);
c43ae56f 3094 GvGP_set(gv, NULL);
79072805
LW
3095}
3096
d460ef45
NIS
3097int
3098Perl_magic_freeovrld(pTHX_ SV *sv, MAGIC *mg)
3099{
53c1dcc0
AL
3100 AMT * const amtp = (AMT*)mg->mg_ptr;
3101 PERL_UNUSED_ARG(sv);
dd374669 3102
7918f24d
NC
3103 PERL_ARGS_ASSERT_MAGIC_FREEOVRLD;
3104
d460ef45 3105 if (amtp && AMT_AMAGIC(amtp)) {
1604cfb0
MS
3106 int i;
3107 for (i = 1; i < NofAMmeth; i++) {
3108 CV * const cv = amtp->table[i];
3109 if (cv) {
3110 SvREFCNT_dec_NN(MUTABLE_SV(cv));
3111 amtp->table[i] = NULL;
3112 }
3113 }
d460ef45
NIS
3114 }
3115 return 0;
3116}
3117
30062c3a
KW
3118/*
3119=for apidoc Gv_AMupdate
3120
3121Recalculates overload magic in the package given by C<stash>.
3122
3123Returns:
3124
3125=over
3126
3127=item 1 on success and there is some overload
3128
3129=item 0 if there is no overload
3130
3131=item -1 if some error occurred and it couldn't croak (because C<destructing>
3132is true).
3133
3134=back
3135
3136=cut
3137*/
a0d0e21e 3138
c3a9a790 3139int
242f8760 3140Perl_Gv_AMupdate(pTHX_ HV *stash, bool destructing)
a0d0e21e 3141{
ad64d0ec 3142 MAGIC* const mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
a6006777 3143 AMT amt;
9b439311 3144 const struct mro_meta* stash_meta = HvMROMETA(stash);
e1a479c5 3145 U32 newgen;
a0d0e21e 3146
7918f24d
NC
3147 PERL_ARGS_ASSERT_GV_AMUPDATE;
3148
9b439311 3149 newgen = PL_sub_generation + stash_meta->pkg_gen + stash_meta->cache_gen;
14899595
NC
3150 if (mg) {
3151 const AMT * const amtp = (AMT*)mg->mg_ptr;
66978156 3152 if (amtp->was_ok_sub == newgen) {
1604cfb0 3153 return AMT_AMAGIC(amtp) ? 1 : 0;
14899595 3154 }
ad64d0ec 3155 sv_unmagic(MUTABLE_SV(stash), PERL_MAGIC_overload_table);
14899595 3156 }
a0d0e21e 3157
0c6362ad 3158 DEBUG_o( Perl_deb(aTHX_ "Recalculating overload magic in package %s\n",HvNAME_get(stash)) );
a0d0e21e 3159
d460ef45 3160 Zero(&amt,1,AMT);
e1a479c5 3161 amt.was_ok_sub = newgen;
a6006777 3162 amt.fallback = AMGfallNO;
3163 amt.flags = 0;
3164
a6006777 3165 {
8c34e50d
FC
3166 int filled = 0;
3167 int i;
3d147ac2
DM
3168 bool deref_seen = 0;
3169
a6006777 3170
3866ea3b 3171 /* Work with "fallback" key, which we assume to be first in PL_AMG_names */
a6006777 3172
89ffc314 3173 /* Try to find via inheritance. */
e6919483 3174 GV *gv = gv_fetchmeth_pvn(stash, PL_AMG_names[0], 2, -1, 0);
3866ea3b 3175 SV * const sv = gv ? GvSV(gv) : NULL;
53c1dcc0 3176 CV* cv;
89ffc314
IZ
3177
3178 if (!gv)
3866ea3b
FC
3179 {
3180 if (!gv_fetchmeth_pvn(stash, "((", 2, -1, 0))
1604cfb0 3181 goto no_table;
3866ea3b
FC
3182 }
3183#ifdef PERL_DONT_CREATE_GVSV
3184 else if (!sv) {
1604cfb0 3185 NOOP; /* Equivalent to !SvTRUE and !SvOK */
3866ea3b
FC
3186 }
3187#endif
79c9643d
JL
3188 else if (SvTRUE(sv))
3189 /* don't need to set overloading here because fallback => 1
3190 * is the default setting for classes without overloading */
1604cfb0 3191 amt.fallback=AMGfallYES;
79c9643d 3192 else if (SvOK(sv)) {
1604cfb0 3193 amt.fallback=AMGfallNEVER;
386a5489 3194 filled = 1;
386a5489 3195 }
79c9643d 3196 else {
386a5489 3197 filled = 1;
386a5489 3198 }
a6006777 3199
53083cad 3200 assert(HvHasAUX(stash));
3d147ac2 3201 /* initially assume the worst */
339441ef 3202 HvAUX(stash)->xhv_aux_flags &= ~HvAUXf_NO_DEREF;
3d147ac2 3203
8c34e50d 3204 for (i = 1; i < NofAMmeth; i++) {
1604cfb0
MS
3205 const char * const cooky = PL_AMG_names[i];
3206 /* Human-readable form, for debugging: */
3207 const char * const cp = AMG_id2name(i);
3208 const STRLEN l = PL_AMG_namelens[i];
3209
3210 DEBUG_o( Perl_deb(aTHX_ "Checking overloading of \"%s\" in package \"%.256s\"\n",
3211 cp, HvNAME_get(stash)) );
3212 /* don't fill the cache while looking up!
3213 Creation of inheritance stubs in intermediate packages may
3214 conflict with the logic of runtime method substitution.
3215 Indeed, for inheritance A -> B -> C, if C overloads "+0",
3216 then we could have created stubs for "(+0" in A and C too.
3217 But if B overloads "bool", we may want to use it for
3218 numifying instead of C's "+0". */
3219 gv = Perl_gv_fetchmeth_pvn(aTHX_ stash, cooky, l, -1, 0);
46fc3d4c 3220 cv = 0;
c3ad4e54 3221 if (gv && (cv = GvCV(gv)) && CvHASGV(cv)) {
79656330 3222 const HEK * const gvhek = CvGvNAME_HEK(cv);
c3ad4e54
FC
3223 const HEK * const stashek =
3224 HvNAME_HEK(CvNAMED(cv) ? CvSTASH(cv) : GvSTASH(CvGV(cv)));
b59bf0b2
KW
3225 if (memEQs(HEK_KEY(gvhek), HEK_LEN(gvhek), "nil")
3226 && stashek
3227 && memEQs(HEK_KEY(stashek), HEK_LEN(stashek), "overload")) {
1604cfb0
MS
3228 /* This is a hack to support autoloading..., while
3229 knowing *which* methods were declared as overloaded. */
3230 /* GvSV contains the name of the method. */
3231 GV *ngv = NULL;
3232 SV *gvsv = GvSV(gv);
3233
3234 DEBUG_o( Perl_deb(aTHX_ "Resolving method \"%" SVf256\
3235 "\" for overloaded \"%s\" in package \"%.256s\"\n",
3236 (void*)GvSV(gv), cp, HvNAME(stash)) );
3237 if (!gvsv || !SvPOK(gvsv)
3238 || !(ngv = gv_fetchmethod_sv_flags(stash, gvsv, 0)))
3239 {
3240 /* Can be an import stub (created by "can"). */
3241 if (destructing) {
3242 return -1;
3243 }
3244 else {
3245 const SV * const name = (gvsv && SvPOK(gvsv))
d66cca07
BF
3246 ? gvsv
3247 : newSVpvs_flags("???", SVs_TEMP);
1604cfb0
MS
3248 /* diag_listed_as: Can't resolve method "%s" overloading "%s" in package "%s" */
3249 Perl_croak(aTHX_ "%s method \"%" SVf256
3250 "\" overloading \"%s\" "\
3251 "in package \"%" HEKf256 "\"",
3252 (GvCVGEN(gv) ? "Stub found while resolving"
3253 : "Can't resolve"),
3254 SVfARG(name), cp,
d0c0e7dd 3255 HEKfARG(
1604cfb0
MS
3256 HvNAME_HEK(stash)
3257 ));
3258 }
3259 }
3260 cv = GvCV(gv = ngv);
3261 }
3262 DEBUG_o( Perl_deb(aTHX_ "Overloading \"%s\" in package \"%.256s\" via \"%.256s::%.256s\"\n",
3263 cp, HvNAME_get(stash), HvNAME_get(GvSTASH(CvGV(cv))),
3264 GvNAME(CvGV(cv))) );
3265 filled = 1;
3266 } else if (gv) { /* Autoloaded... */
3267 cv = MUTABLE_CV(gv);
3268 filled = 1;
3269 }
3270 amt.table[i]=MUTABLE_CV(SvREFCNT_inc_simple(cv));
3d147ac2
DM
3271
3272 if (gv) {
3273 switch (i) {
3274 case to_sv_amg:
3275 case to_av_amg:
3276 case to_hv_amg:
3277 case to_gv_amg:
3278 case to_cv_amg:
3279 case nomethod_amg:
3280 deref_seen = 1;
3281 break;
3282 }
3283 }
a0d0e21e 3284 }
3d147ac2 3285 if (!deref_seen)
45479970
DM
3286 /* none of @{} etc overloaded; we can do $obj->[N] quicker.
3287 * NB - aux var invalid here, HvARRAY() could have been
3288 * reallocated since it was assigned to */
3289 HvAUX(stash)->xhv_aux_flags |= HvAUXf_NO_DEREF;
3d147ac2 3290
a0d0e21e 3291 if (filled) {
a6006777 3292 AMT_AMAGIC_on(&amt);
ad64d0ec 3293 sv_magic(MUTABLE_SV(stash), 0, PERL_MAGIC_overload_table,
1604cfb0 3294 (char*)&amt, sizeof(AMT));
8c34e50d 3295 return TRUE;
a0d0e21e
LW
3296 }
3297 }
a6006777 3298 /* Here we have no table: */
8c34e50d 3299 no_table:
a6006777 3300 AMT_AMAGIC_off(&amt);
ad64d0ec 3301 sv_magic(MUTABLE_SV(stash), 0, PERL_MAGIC_overload_table,
1604cfb0 3302 (char*)&amt, sizeof(AMTS));
c3a9a790 3303 return 0;
a0d0e21e
LW
3304}
3305
7f3d1102
KW
3306/*
3307=for apidoc gv_handler
3308
3309Implements C<StashHANDLER>, which you should use instead
3310
3311=cut
3312*/
32251b26
IZ
3313
3314CV*
3315Perl_gv_handler(pTHX_ HV *stash, I32 id)
3316{
3f8f4626 3317 MAGIC *mg;
32251b26 3318 AMT *amtp;
e1a479c5 3319 U32 newgen;
9b439311 3320 struct mro_meta* stash_meta;
32251b26 3321
2e4090b8 3322 if (!stash || !HvHasNAME(stash))
601f1833 3323 return NULL;
e1a479c5 3324
9b439311
BB
3325 stash_meta = HvMROMETA(stash);
3326 newgen = PL_sub_generation + stash_meta->pkg_gen + stash_meta->cache_gen;
e1a479c5 3327
ad64d0ec 3328 mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
32251b26
IZ
3329 if (!mg) {
3330 do_update:
1604cfb0
MS
3331 if (Gv_AMupdate(stash, 0) == -1)
3332 return NULL;
3333 mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
32251b26 3334 }
a9fd4e40 3335 assert(mg);
32251b26 3336 amtp = (AMT*)mg->mg_ptr;
66978156 3337 if ( amtp->was_ok_sub != newgen )
1604cfb0 3338 goto do_update;
3ad83ce7 3339 if (AMT_AMAGIC(amtp)) {
1604cfb0
MS
3340 CV * const ret = amtp->table[id];
3341 if (ret && isGV(ret)) { /* Autoloading stab */
3342 /* Passing it through may have resulted in a warning
3343 "Inherited AUTOLOAD for a non-method deprecated", since
3344 our caller is going through a function call, not a method call.
3345 So return the CV for AUTOLOAD, setting $AUTOLOAD. */
3346 GV * const gv = gv_fetchmethod(stash, PL_AMG_names[id]);
3347
3348 if (gv && GvCV(gv))
3349 return GvCV(gv);
3350 }
3351 return ret;
3ad83ce7 3352 }
a0288114 3353
601f1833 3354 return NULL;
32251b26
IZ
3355}
3356
3357
6f1401dc
DM
3358/* Implement tryAMAGICun_MG macro.
3359 Do get magic, then see if the stack arg is overloaded and if so call it.
3360 Flags:
1604cfb0 3361 AMGf_numeric apply sv_2num to the stack arg.
6f1401dc
DM
3362*/
3363
3364bool
3365Perl_try_amagic_un(pTHX_ int method, int flags) {
6f1401dc
DM
3366 dSP;
3367 SV* tmpsv;
3368 SV* const arg = TOPs;
3369
3370 SvGETMAGIC(arg);
3371
9f8bf298 3372 if (SvAMAGIC(arg) && (tmpsv = amagic_call(arg, &PL_sv_undef, method,
1604cfb0
MS
3373 AMGf_noright | AMGf_unary
3374 | (flags & AMGf_numarg))))
636ac8fc 3375 {
13874762
DM
3376 /* where the op is of the form:
3377 * $lex = $x op $y (where the assign is optimised away)
3378 * then assign the returned value to targ and return that;
3379 * otherwise return the value directly
3380 */
3381 if ( (PL_opargs[PL_op->op_type] & OA_TARGLEX)
3382 && (PL_op->op_private & OPpTARGET_MY))
3383 {
3384 dTARGET;
3385 sv_setsv(TARG, tmpsv);
3386 SETTARG;
3387 }
3388 else
3389 SETs(tmpsv);
3390
1604cfb0
MS
3391 PUTBACK;
3392 return TRUE;
6f1401dc
DM
3393 }
3394
3395 if ((flags & AMGf_numeric) && SvROK(arg))
1604cfb0 3396 *sp = sv_2num(arg);
6f1401dc
DM
3397 return FALSE;
3398}
3399
3400
bab261c9 3401/*
8da47909 3402=for apidoc amagic_applies
bab261c9 3403
8da47909
YO
3404Check C<sv> to see if the overloaded (active magic) operation C<method>
3405applies to it. If the sv is not SvROK or it is not an object then returns
3406false, otherwise checks if the object is blessed into a class supporting
3407overloaded operations, and returns true if a call to amagic_call() with
3408this SV and the given method would trigger an amagic operation, including
3409via the overload fallback rules or via nomethod. Thus a call like:
bab261c9 3410
8da47909
YO
3411 amagic_applies(sv, string_amg, AMG_unary)
3412
3413would return true for an object with overloading set up in any of the
3414following ways:
3415
3416 use overload q("") => sub { ... };
3417 use overload q(0+) => sub { ... }, fallback => 1;
3418
3419and could be used to tell if a given object would stringify to something
3420other than the normal default ref stringification.
bab261c9 3421
8da47909
YO
3422Note that the fact that this function returns TRUE does not mean you
3423can succesfully perform the operation with amagic_call(), for instance
3424any overloaded method might throw a fatal exception, however if this
3425function returns FALSE you can be confident that it will NOT perform
3426the given overload operation.
3427
3428C<method> is an integer enum, one of the values found in F<overload.h>,
3429for instance C<string_amg>.
3430
3431C<flags> should be set to AMG_unary for unary operations.
bab261c9
EH
3432
3433=cut
3434*/
8da47909
YO
3435bool
3436Perl_amagic_applies(pTHX_ SV *sv, int method, int flags)
bab261c9 3437{
8da47909 3438 PERL_ARGS_ASSERT_AMAGIC_APPLIES;
bab261c9
EH
3439 PERL_UNUSED_VAR(flags);
3440
3441 assert(method >= 0 && method < NofAMmeth);
3442
3443 if (!SvAMAGIC(sv))
8da47909 3444 return FALSE;
bab261c9
EH
3445
3446 HV *stash = SvSTASH(SvRV(sv));
3447 if (!Gv_AMG(stash))
8da47909 3448 return FALSE;
bab261c9
EH
3449
3450 MAGIC *mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
3451 if (!mg)
8da47909 3452 return FALSE;
bab261c9
EH
3453
3454 CV **cvp = NULL;
8da47909
YO
3455 AMT *amtp = NULL;
3456 if (AMT_AMAGIC((AMT *)mg->mg_ptr)) {
3457 amtp = (AMT *)mg->mg_ptr;
3458 cvp = amtp->table;
3459 }
bab261c9 3460 if (!cvp)
8da47909
YO
3461 return FALSE;
3462
3463 if (cvp[method])
3464 return TRUE;
3465
3466 /* Note this logic should be kept in sync with amagic_call() */
3467 if (amtp->fallback > AMGfallNEVER && flags & AMGf_unary) {
3468 CV *cv; /* This makes it easier to kee ... */
3469 int off,off1; /* ... in sync with amagic_call() */
bab261c9 3470
8da47909
YO
3471 /* look for substituted methods */
3472 /* In all the covered cases we should be called with assign==0. */
3473 switch (method) {
3474 case inc_amg:
3475 if ((cv = cvp[off=add_ass_amg]) || ((cv = cvp[off = add_amg])))
3476 return TRUE;
3477 break;
3478 case dec_amg:
3479 if((cv = cvp[off = subtr_ass_amg]) || ((cv = cvp[off = subtr_amg])))
3480 return TRUE;
3481 break;
3482 case bool__amg:
3483 if ((cv = cvp[off=numer_amg]) || (cv = cvp[off=string_amg]))
3484 return TRUE;
3485 break;
3486 case numer_amg:
3487 if((cv = cvp[off=string_amg]) || (cv = cvp[off=bool__amg]))
3488 return TRUE;
3489 break;
3490 case string_amg:
3491 if((cv = cvp[off=numer_amg]) || (cv = cvp[off=bool__amg]))
3492 return TRUE;
3493 break;
3494 case not_amg:
3495 if((cv = cvp[off=bool__amg])
3496 || (cv = cvp[off=numer_amg])
3497 || (cv = cvp[off=string_amg]))
3498 return TRUE;
3499 break;
3500 case abs_amg:
3501 if((cvp[off1=lt_amg] || cvp[off1=ncmp_amg])
3502 && ((cv = cvp[off=neg_amg]) || (cv = cvp[off=subtr_amg])))
3503 return TRUE;
3504 break;
3505 case neg_amg:
3506 if ((cv = cvp[off=subtr_amg]))
3507 return TRUE;
3508 break;
3509 }
3510 } else if (((cvp && amtp->fallback > AMGfallNEVER))
3511 && !(flags & AMGf_unary)) {
3512 /* We look for substitution for
3513 * comparison operations and
3514 * concatenation */
3515 if (method==concat_amg || method==concat_ass_amg
3516 || method==repeat_amg || method==repeat_ass_amg) {
3517 return FALSE; /* Delegate operation to string conversion */
3518 }
3519 switch (method) {
3520 case lt_amg:
3521 case le_amg:
3522 case gt_amg:
3523 case ge_amg:
3524 case eq_amg:
3525 case ne_amg:
3526 if (cvp[ncmp_amg])
3527 return TRUE;
3528 break;
3529 case slt_amg:
3530 case sle_amg:
3531 case sgt_amg:
3532 case sge_amg:
3533 case seq_amg:
3534 case sne_amg:
3535 if (cvp[scmp_amg])
3536 return TRUE;
3537 break;
3538 }
3539 }
3540
3541 if (cvp[nomethod_amg])
3542 return TRUE;
3543
3544 return FALSE;
bab261c9
EH
3545}
3546
3547
6f1401dc
DM
3548/* Implement tryAMAGICbin_MG macro.
3549 Do get magic, then see if the two stack args are overloaded and if so
3550 call it.
3551 Flags:
1604cfb0
MS
3552 AMGf_assign op may be called as mutator (eg +=)
3553 AMGf_numeric apply sv_2num to the stack arg.
6f1401dc
DM
3554*/
3555
3556bool
3557Perl_try_amagic_bin(pTHX_ int method, int flags) {
6f1401dc
DM
3558 dSP;
3559 SV* const left = TOPm1s;
3560 SV* const right = TOPs;
3561
3562 SvGETMAGIC(left);
3563 if (left != right)
1604cfb0 3564 SvGETMAGIC(right);
6f1401dc
DM
3565
3566 if (SvAMAGIC(left) || SvAMAGIC(right)) {
1604cfb0 3567 SV * tmpsv;
72876cce
DM
3568 /* STACKED implies mutator variant, e.g. $x += 1 */
3569 bool mutator = (flags & AMGf_assign) && (PL_op->op_flags & OPf_STACKED);
3570
1604cfb0
MS
3571 tmpsv = amagic_call(left, right, method,
3572 (mutator ? AMGf_assign: 0)
3573 | (flags & AMGf_numarg));
3574 if (tmpsv) {
13874762
DM
3575 (void)POPs;
3576 /* where the op is one of the two forms:
3577 * $x op= $y
3578 * $lex = $x op $y (where the assign is optimised away)
3579 * then assign the returned value to targ and return that;
3580 * otherwise return the value directly
3581 */
3582 if ( mutator
3583 || ( (PL_opargs[PL_op->op_type] & OA_TARGLEX)
3584 && (PL_op->op_private & OPpTARGET_MY)))
3585 {
3586 dTARG;
3587 TARG = mutator ? *SP : PAD_SV(PL_op->op_targ);
3588 sv_setsv(TARG, tmpsv);
3589 SETTARG;
3590 }
3591 else
3592 SETs(tmpsv);
3593
1604cfb0
MS
3594 PUTBACK;
3595 return TRUE;
3596 }
6f1401dc 3597 }
13874762 3598
75ea7a12 3599 if(left==right && SvGMAGICAL(left)) {
1604cfb0
MS
3600 SV * const left = sv_newmortal();
3601 *(sp-1) = left;
3602 /* Print the uninitialized warning now, so it includes the vari-
3603 able name. */
3604 if (!SvOK(right)) {
3605 if (ckWARN(WARN_UNINITIALIZED)) report_uninit(right);
1d0d673f 3606 sv_setbool(left, FALSE);
1604cfb0
MS
3607 }
3608 else sv_setsv_flags(left, right, 0);
3609 SvGETMAGIC(right);
75ea7a12 3610 }
6f1401dc 3611 if (flags & AMGf_numeric) {
1604cfb0
MS
3612 if (SvROK(TOPm1s))
3613 *(sp-1) = sv_2num(TOPm1s);
3614 if (SvROK(right))
3615 *sp = sv_2num(right);
6f1401dc
DM
3616 }
3617 return FALSE;
3618}
3619
0797ed67
KW
3620/*
3621=for apidoc amagic_deref_call
3622
3623Perform C<method> overloading dereferencing on C<ref>, returning the
3624dereferenced result. C<method> must be one of the dereference operations given
3625in F<overload.h>.
3626
3627If overloading is inactive on C<ref>, returns C<ref> itself.
3628
3629=cut
3630*/
3631
25a9ffce
NC
3632SV *
3633Perl_amagic_deref_call(pTHX_ SV *ref, int method) {
3634 SV *tmpsv = NULL;
3d147ac2 3635 HV *stash;
25a9ffce
NC
3636
3637 PERL_ARGS_ASSERT_AMAGIC_DEREF_CALL;
3638
3d147ac2
DM
3639 if (!SvAMAGIC(ref))
3640 return ref;
3641 /* return quickly if none of the deref ops are overloaded */
3642 stash = SvSTASH(SvRV(ref));
53083cad 3643 assert(HvHasAUX(stash));
3d147ac2
DM
3644 if (HvAUX(stash)->xhv_aux_flags & HvAUXf_NO_DEREF)
3645 return ref;
3646
3647 while ((tmpsv = amagic_call(ref, &PL_sv_undef, method,
9c913148 3648 AMGf_noright | AMGf_unary))) {
1604cfb0
MS
3649 if (!SvROK(tmpsv))
3650 Perl_croak(aTHX_ "Overloaded dereference did not return a reference");
3651 if (tmpsv == ref || SvRV(tmpsv) == SvRV(ref)) {
3652 /* Bail out if it returns us the same reference. */
3653 return tmpsv;
3654 }
3655 ref = tmpsv;
3d147ac2
DM
3656 if (!SvAMAGIC(ref))
3657 break;
25a9ffce
NC
3658 }
3659 return tmpsv ? tmpsv : ref;
3660}
6f1401dc 3661
8d569291
FC
3662bool
3663Perl_amagic_is_enabled(pTHX_ int method)
3664{
3665 SV *lex_mask = cop_hints_fetch_pvs(PL_curcop, "overloading", 0);
3666
3667 assert(PL_curcop->cop_hints & HINT_NO_AMAGIC);
3668
3669 if ( !lex_mask || !SvOK(lex_mask) )
1604cfb0
MS
3670 /* overloading lexically disabled */
3671 return FALSE;
8d569291 3672 else if ( lex_mask && SvPOK(lex_mask) ) {
1604cfb0
MS
3673 /* we have an entry in the hints hash, check if method has been
3674 * masked by overloading.pm */
3675 STRLEN len;
3676 const int offset = method / 8;
3677 const int bit = method % 8;
3678 char *pv = SvPV(lex_mask, len);
3679
3680 /* Bit set, so this overloading operator is disabled */
3681 if ( (STRLEN)offset < len && pv[offset] & ( 1 << bit ) )
3682 return FALSE;
8d569291
FC
3683 }
3684 return TRUE;
3685}
3686
0797ed67 3687/*
d487610d 3688=for apidoc amagic_call
0797ed67
KW
3689
3690Perform the overloaded (active magic) operation given by C<method>.
3691C<method> is one of the values found in F<overload.h>.
3692
3693C<flags> affects how the operation is performed, as follows:
3694
3695=over
3696
3697=item C<AMGf_noleft>
3698
3699C<left> is not to be used in this operation.
3700
3701=item C<AMGf_noright>
3702