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