3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 * 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall and others
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.
12 * 'Mercy!' cried Gandalf. 'If the giving of information is to be the cure
13 * of your inquisitiveness, I shall spend all the rest of my days in answering
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,'
19 * [p.599 of _The Lord of the Rings_, III/xi: "The PalantÃr"]
25 A GV is a structure which corresponds to to a Perl typeglob, ie *foo.
26 It is a structure that holds a pointer to a scalar, an array, a hash etc,
27 corresponding to $foo, @foo, %foo.
29 GVs are usually found as values in stashes (symbol table hashes) where
30 Perl stores its global variables.
42 static const char S_autoload[] = "AUTOLOAD";
43 static const STRLEN S_autolen = sizeof(S_autoload)-1;
46 Perl_gv_add_by_type(pTHX_ GV *gv, svtype type)
53 SvTYPE((const SV *)gv) != SVt_PVGV
54 && SvTYPE((const SV *)gv) != SVt_PVLV
58 if (type == SVt_PVIO) {
60 * if it walks like a dirhandle, then let's assume that
61 * this is a dirhandle.
63 what = OP_IS_DIRHOP(PL_op->op_type) ?
64 "dirhandle" : "filehandle";
65 } else if (type == SVt_PVHV) {
68 what = type == SVt_PVAV ? "array" : "scalar";
70 /* diag_listed_as: Bad symbol for filehandle */
71 Perl_croak(aTHX_ "Bad symbol for %s", what);
74 if (type == SVt_PVHV) {
75 where = (SV **)&GvHV(gv);
76 } else if (type == SVt_PVAV) {
77 where = (SV **)&GvAV(gv);
78 } else if (type == SVt_PVIO) {
79 where = (SV **)&GvIOp(gv);
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);
93 Perl_gv_fetchfile(pTHX_ const char *name)
95 PERL_ARGS_ASSERT_GV_FETCHFILE;
96 return gv_fetchfile_flags(name, strlen(name), 0);
100 Perl_gv_fetchfile_flags(pTHX_ const char *const name, const STRLEN namelen,
106 const STRLEN tmplen = namelen + 2;
109 PERL_ARGS_ASSERT_GV_FETCHFILE_FLAGS;
110 PERL_UNUSED_ARG(flags);
115 if (tmplen <= sizeof smallbuf)
118 Newx(tmpbuf, tmplen, char);
119 /* This is where the debugger's %{"::_<$filename"} hash is created */
122 memcpy(tmpbuf + 2, name, namelen);
123 gv = *(GV**)hv_fetch(PL_defstash, tmpbuf, tmplen, TRUE);
125 gv_init(gv, PL_defstash, tmpbuf, tmplen, FALSE);
126 #ifdef PERL_DONT_CREATE_GVSV
127 GvSV(gv) = newSVpvn(name, namelen);
129 sv_setpvn(GvSV(gv), name, namelen);
132 if ((PERLDB_LINE || PERLDB_SAVESRC) && !GvAV(gv))
133 hv_magic(GvHVn(gv_AVadd(gv)), NULL, PERL_MAGIC_dbfile);
134 if (tmpbuf != smallbuf)
140 =for apidoc gv_const_sv
142 If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
143 inlining, or C<gv> is a placeholder reference that would be promoted to such
144 a typeglob, then returns the value returned by the sub. Otherwise, returns
151 Perl_gv_const_sv(pTHX_ GV *gv)
153 PERL_ARGS_ASSERT_GV_CONST_SV;
155 if (SvTYPE(gv) == SVt_PVGV)
156 return cv_const_sv(GvCVu(gv));
157 return SvROK(gv) ? SvRV(gv) : NULL;
161 Perl_newGP(pTHX_ GV *const gv)
172 PERL_ARGS_ASSERT_NEWGP;
174 gp->gp_egv = gv; /* allow compiler to reuse gv after this */
175 #ifndef PERL_DONT_CREATE_GVSV
176 gp->gp_sv = newSV(0);
181 gp->gp_line = CopLINE(PL_curcop); /* 0 otherwise Newxz */
182 if (CopFILE(PL_curcop)) {
183 file = CopFILE(PL_curcop);
195 gp->gp_line = CopLINE(PL_curcop); /* 0 otherwise Newxz */
196 temp_sv = CopFILESV(PL_curcop);
198 file = SvPVX(temp_sv);
199 len = SvCUR(temp_sv);
206 PERL_HASH(hash, file, len);
207 gp->gp_file_hek = share_hek(file, len, hash);
213 /* Assign CvGV(cv) = gv, handling weak references.
214 * See also S_anonymise_cv_maybe */
217 Perl_cvgv_set(pTHX_ CV* cv, GV* gv)
219 GV * const oldgv = CvGV(cv);
221 PERL_ARGS_ASSERT_CVGV_SET;
228 SvREFCNT_dec_NN(oldgv);
232 sv_del_backref(MUTABLE_SV(oldgv), MUTABLE_SV(cv));
235 else if ((hek = CvNAME_HEK(cv))) unshare_hek(hek);
237 SvANY(cv)->xcv_gv_u.xcv_gv = gv;
238 assert(!CvCVGV_RC(cv));
243 if (isGV_with_GP(gv) && GvGP(gv) && (GvCV(gv) == cv || GvFORM(gv) == cv))
244 Perl_sv_add_backref(aTHX_ MUTABLE_SV(gv), MUTABLE_SV(cv));
247 SvREFCNT_inc_simple_void_NN(gv);
251 /* Assign CvSTASH(cv) = st, handling weak references. */
254 Perl_cvstash_set(pTHX_ CV *cv, HV *st)
256 HV *oldst = CvSTASH(cv);
257 PERL_ARGS_ASSERT_CVSTASH_SET;
261 sv_del_backref(MUTABLE_SV(oldst), MUTABLE_SV(cv));
262 SvANY(cv)->xcv_stash = st;
264 Perl_sv_add_backref(aTHX_ MUTABLE_SV(st), MUTABLE_SV(cv));
268 =for apidoc gv_init_pvn
270 Converts a scalar into a typeglob. This is an incoercible typeglob;
271 assigning a reference to it will assign to one of its slots, instead of
272 overwriting it as happens with typeglobs created by SvSetSV. Converting
273 any scalar that is SvOK() may produce unpredictable results and is reserved
274 for perl's internal use.
276 C<gv> is the scalar to be converted.
278 C<stash> is the parent stash/package, if any.
280 C<name> and C<len> give the name. The name must be unqualified;
281 that is, it must not include the package name. If C<gv> is a
282 stash element, it is the caller's responsibility to ensure that the name
283 passed to this function matches the name of the element. If it does not
284 match, perl's internal bookkeeping will get out of sync.
286 C<flags> can be set to SVf_UTF8 if C<name> is a UTF8 string, or
287 the return value of SvUTF8(sv). It can also take the
288 GV_ADDMULTI flag, which means to pretend that the GV has been
289 seen before (i.e., suppress "Used once" warnings).
293 The old form of gv_init_pvn(). It does not work with UTF8 strings, as it
294 has no flags parameter. If the C<multi> parameter is set, the
295 GV_ADDMULTI flag will be passed to gv_init_pvn().
297 =for apidoc gv_init_pv
299 Same as gv_init_pvn(), but takes a nul-terminated string for the name
300 instead of separate char * and length parameters.
302 =for apidoc gv_init_sv
304 Same as gv_init_pvn(), but takes an SV * for the name instead of separate
305 char * and length parameters. C<flags> is currently unused.
311 Perl_gv_init_sv(pTHX_ GV *gv, HV *stash, SV* namesv, U32 flags)
315 PERL_ARGS_ASSERT_GV_INIT_SV;
316 namepv = SvPV(namesv, namelen);
319 gv_init_pvn(gv, stash, namepv, namelen, flags);
323 Perl_gv_init_pv(pTHX_ GV *gv, HV *stash, const char *name, U32 flags)
325 PERL_ARGS_ASSERT_GV_INIT_PV;
326 gv_init_pvn(gv, stash, name, strlen(name), flags);
330 Perl_gv_init_pvn(pTHX_ GV *gv, HV *stash, const char *name, STRLEN len, U32 flags)
333 const U32 old_type = SvTYPE(gv);
334 const bool doproto = old_type > SVt_NULL;
335 char * const proto = (doproto && SvPOK(gv))
336 ? ((void)(SvIsCOW(gv) && (sv_force_normal((SV *)gv), 0)), SvPVX(gv))
338 const STRLEN protolen = proto ? SvCUR(gv) : 0;
339 const U32 proto_utf8 = proto ? SvUTF8(gv) : 0;
340 SV *const has_constant = doproto && SvROK(gv) ? SvRV(gv) : NULL;
341 const U32 exported_constant = has_constant ? SvPCS_IMPORTED(gv) : 0;
343 PERL_ARGS_ASSERT_GV_INIT_PVN;
344 assert (!(proto && has_constant));
347 /* The constant has to be a simple scalar type. */
348 switch (SvTYPE(has_constant)) {
354 Perl_croak(aTHX_ "Cannot convert a reference to %s to typeglob",
355 sv_reftype(has_constant, 0));
363 if (old_type < SVt_PVGV) {
364 if (old_type >= SVt_PV)
366 sv_upgrade(MUTABLE_SV(gv), SVt_PVGV);
374 Safefree(SvPVX_mutable(gv));
379 GvGP_set(gv, Perl_newGP(aTHX_ gv));
382 Perl_sv_add_backref(aTHX_ MUTABLE_SV(stash), MUTABLE_SV(gv));
383 gv_name_set(gv, name, len, GV_ADD | ( flags & SVf_UTF8 ? SVf_UTF8 : 0 ));
384 if (flags & GV_ADDMULTI || doproto) /* doproto means it */
385 GvMULTI_on(gv); /* _was_ mentioned */
389 /* newCONSTSUB takes ownership of the reference from us. */
390 cv = newCONSTSUB_flags(stash, name, len, flags, has_constant);
391 /* In case op.c:S_process_special_blocks stole it: */
393 GvCV_set(gv, (CV *)SvREFCNT_inc_simple_NN(cv));
394 assert(GvCV(gv) == cv); /* newCONSTSUB should have set this */
395 /* If this reference was a copy of another, then the subroutine
396 must have been "imported", by a Perl space assignment to a GV
397 from a reference to CV. */
398 if (exported_constant)
399 GvIMPORTED_CV_on(gv);
400 CvSTASH_set(cv, PL_curstash); /* XXX Why is this needed? */
405 sv_usepvn_flags(MUTABLE_SV(cv), proto, protolen,
406 SV_HAS_TRAILING_NUL);
407 if ( proto_utf8 ) SvUTF8_on(MUTABLE_SV(cv));
413 S_gv_init_svtype(pTHX_ GV *gv, const svtype sv_type)
415 PERL_ARGS_ASSERT_GV_INIT_SVTYPE;
427 #ifdef PERL_DONT_CREATE_GVSV
435 /* Work round what appears to be a bug in Sun C++ 5.8 2005/10/13
436 If we just cast GvSVn(gv) to void, it ignores evaluating it for
443 static void core_xsub(pTHX_ CV* cv);
446 S_maybe_add_coresub(pTHX_ HV * const stash, GV *gv,
447 const char * const name, const STRLEN len)
449 const int code = keyword(name, len, 1);
450 static const char file[] = __FILE__;
451 CV *cv, *oldcompcv = NULL;
454 bool ampable = TRUE; /* &{}-able */
455 COP *oldcurcop = NULL;
456 yy_parser *oldparser = NULL;
457 I32 oldsavestack_ix = 0;
462 if (!code) return NULL; /* Not a keyword */
463 switch (code < 0 ? -code : code) {
464 /* no support for \&CORE::infix;
465 no support for funcs that do not parse like funcs */
466 case KEY___DATA__: case KEY___END__: case KEY_and: case KEY_AUTOLOAD:
467 case KEY_BEGIN : case KEY_CHECK : case KEY_cmp: case KEY_CORE :
468 case KEY_default : case KEY_DESTROY:
469 case KEY_do : case KEY_dump : case KEY_else : case KEY_elsif :
470 case KEY_END : case KEY_eq : case KEY_eval :
471 case KEY_for : case KEY_foreach: case KEY_format: case KEY_ge :
472 case KEY_given : case KEY_goto : case KEY_grep :
473 case KEY_gt : case KEY_if: case KEY_INIT: case KEY_last: case KEY_le:
474 case KEY_local: case KEY_lt: case KEY_m : case KEY_map : case KEY_my:
475 case KEY_ne : case KEY_next : case KEY_no: case KEY_or: case KEY_our:
476 case KEY_package: case KEY_print: case KEY_printf:
477 case KEY_q : case KEY_qq : case KEY_qr : case KEY_qw :
478 case KEY_qx : case KEY_redo : case KEY_require: case KEY_return:
479 case KEY_s : case KEY_say : case KEY_sort :
480 case KEY_state: case KEY_sub :
481 case KEY_tr : case KEY_UNITCHECK: case KEY_unless:
482 case KEY_until: case KEY_use : case KEY_when : case KEY_while :
483 case KEY_x : case KEY_xor : case KEY_y :
486 case KEY_chomp: case KEY_chop: case KEY_defined: case KEY_delete:
487 case KEY_each : case KEY_eof : case KEY_exec : case KEY_exists:
493 case KEY_splice: case KEY_split:
496 case KEY_truncate: case KEY_unlink:
503 gv_init(gv, stash, name, len, TRUE);
508 oldcurcop = PL_curcop;
509 oldparser = PL_parser;
510 lex_start(NULL, NULL, 0);
511 oldcompcv = PL_compcv;
512 PL_compcv = NULL; /* Prevent start_subparse from setting
514 oldsavestack_ix = start_subparse(FALSE,0);
518 /* Avoid calling newXS, as it calls us, and things start to
520 cv = MUTABLE_CV(newSV_type(SVt_PVCV));
523 mro_method_changed_in(GvSTASH(gv));
525 CvXSUB(cv) = core_xsub;
527 CvGV_set(cv, gv); /* This stops new ATTRSUB from setting CvFILE
529 (void)gv_fetchfile(file);
530 CvFILE(cv) = (char *)file;
531 /* XXX This is inefficient, as doing things this order causes
532 a prototype check in newATTRSUB. But we have to do
533 it this order as we need an op number before calling
535 (void)core_prototype((SV *)cv, name, code, &opnum);
537 (void)hv_store(stash,name,len,(SV *)gv,0);
541 oldsavestack_ix, (OP *)gv,
546 : newSVpvn(name,len),
551 assert(GvCV(gv) == cv);
552 if (opnum != OP_VEC && opnum != OP_SUBSTR && opnum != OP_POS
553 && opnum != OP_UNDEF)
554 CvLVALUE_off(cv); /* Now *that* was a neat trick. */
556 PL_parser = oldparser;
557 PL_curcop = oldcurcop;
558 PL_compcv = oldcompcv;
560 opnumsv = opnum ? newSVuv((UV)opnum) : (SV *)NULL;
562 cv, Perl_ck_entersub_args_core, opnumsv ? opnumsv : (SV *)cv
564 SvREFCNT_dec(opnumsv);
569 =for apidoc gv_fetchmeth
571 Like L</gv_fetchmeth_pvn>, but lacks a flags parameter.
573 =for apidoc gv_fetchmeth_sv
575 Exactly like L</gv_fetchmeth_pvn>, but takes the name string in the form
576 of an SV instead of a string/length pair.
582 Perl_gv_fetchmeth_sv(pTHX_ HV *stash, SV *namesv, I32 level, U32 flags)
586 PERL_ARGS_ASSERT_GV_FETCHMETH_SV;
587 namepv = SvPV(namesv, namelen);
590 return gv_fetchmeth_pvn(stash, namepv, namelen, level, flags);
594 =for apidoc gv_fetchmeth_pv
596 Exactly like L</gv_fetchmeth_pvn>, but takes a nul-terminated string
597 instead of a string/length pair.
603 Perl_gv_fetchmeth_pv(pTHX_ HV *stash, const char *name, I32 level, U32 flags)
605 PERL_ARGS_ASSERT_GV_FETCHMETH_PV;
606 return gv_fetchmeth_pvn(stash, name, strlen(name), level, flags);
610 =for apidoc gv_fetchmeth_pvn
612 Returns the glob with the given C<name> and a defined subroutine or
613 C<NULL>. The glob lives in the given C<stash>, or in the stashes
614 accessible via @ISA and UNIVERSAL::.
616 The argument C<level> should be either 0 or -1. If C<level==0>, as a
617 side-effect creates a glob with the given C<name> in the given C<stash>
618 which in the case of success contains an alias for the subroutine, and sets
619 up caching info for this glob.
621 The only significant values for C<flags> are GV_SUPER and SVf_UTF8.
623 GV_SUPER indicates that we want to look up the method in the superclasses
627 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
628 visible to Perl code. So when calling C<call_sv>, you should not use
629 the GV directly; instead, you should use the method's CV, which can be
630 obtained from the GV with the C<GvCV> macro.
635 /* NOTE: No support for tied ISA */
638 Perl_gv_fetchmeth_pvn(pTHX_ HV *stash, const char *name, STRLEN len, I32 level, U32 flags)
645 HV* cstash, *cachestash;
646 GV* candidate = NULL;
650 I32 create = (level >= 0) ? 1 : 0;
653 U32 is_utf8 = flags & SVf_UTF8;
655 PERL_ARGS_ASSERT_GV_FETCHMETH_PVN;
657 /* UNIVERSAL methods should be callable without a stash */
659 create = 0; /* probably appropriate */
660 if(!(stash = gv_stashpvs("UNIVERSAL", 0)))
666 hvname = HvNAME_get(stash);
668 Perl_croak(aTHX_ "Can't use anonymous symbol table for method lookup");
673 DEBUG_o( Perl_deb(aTHX_ "Looking for %smethod %s in package %s\n",
674 flags & GV_SUPER ? "SUPER " : "",name,hvname) );
676 topgen_cmp = HvMROMETA(stash)->cache_gen + PL_sub_generation;
678 if (flags & GV_SUPER) {
679 if (!HvAUX(stash)->xhv_super) HvAUX(stash)->xhv_super = newHV();
680 cachestash = HvAUX(stash)->xhv_super;
682 else cachestash = stash;
684 /* check locally for a real method or a cache entry */
685 gvp = (GV**)hv_fetch(cachestash, name, is_utf8 ? -(I32)len : (I32)len,
691 if (SvTYPE(topgv) != SVt_PVGV)
692 gv_init_pvn(topgv, stash, name, len, GV_ADDMULTI|is_utf8);
693 if ((cand_cv = GvCV(topgv))) {
694 /* If genuine method or valid cache entry, use it */
695 if (!GvCVGEN(topgv) || GvCVGEN(topgv) == topgen_cmp) {
699 /* stale cache entry, junk it and move on */
700 SvREFCNT_dec_NN(cand_cv);
701 GvCV_set(topgv, NULL);
706 else if (GvCVGEN(topgv) == topgen_cmp) {
707 /* cache indicates no such method definitively */
710 else if (stash == cachestash
711 && len > 1 /* shortest is uc */ && HvNAMELEN_get(stash) == 4
712 && strnEQ(hvname, "CORE", 4)
713 && S_maybe_add_coresub(aTHX_ NULL,topgv,name,len))
717 linear_av = mro_get_linear_isa(stash); /* has ourselves at the top of the list */
718 linear_svp = AvARRAY(linear_av) + 1; /* skip over self */
719 items = AvFILLp(linear_av); /* no +1, to skip over self */
721 linear_sv = *linear_svp++;
723 cstash = gv_stashsv(linear_sv, 0);
726 Perl_ck_warner(aTHX_ packWARN(WARN_SYNTAX),
727 "Can't locate package %"SVf" for @%"HEKf"::ISA",
729 HEKfARG(HvNAME_HEK(stash)));
735 gvp = (GV**)hv_fetch(cstash, name, is_utf8 ? -(I32)len : (I32)len, 0);
737 if (len > 1 && HvNAMELEN_get(cstash) == 4) {
738 const char *hvname = HvNAME(cstash); assert(hvname);
739 if (strnEQ(hvname, "CORE", 4)
741 S_maybe_add_coresub(aTHX_ cstash,NULL,name,len)
747 else candidate = *gvp;
750 if (SvTYPE(candidate) != SVt_PVGV)
751 gv_init_pvn(candidate, cstash, name, len, GV_ADDMULTI|is_utf8);
752 if (SvTYPE(candidate) == SVt_PVGV && (cand_cv = GvCV(candidate)) && !GvCVGEN(candidate)) {
754 * Found real method, cache method in topgv if:
755 * 1. topgv has no synonyms (else inheritance crosses wires)
756 * 2. method isn't a stub (else AUTOLOAD fails spectacularly)
758 if (topgv && (GvREFCNT(topgv) == 1) && (CvROOT(cand_cv) || CvXSUB(cand_cv))) {
759 CV *old_cv = GvCV(topgv);
760 SvREFCNT_dec(old_cv);
761 SvREFCNT_inc_simple_void_NN(cand_cv);
762 GvCV_set(topgv, cand_cv);
763 GvCVGEN(topgv) = topgen_cmp;
769 /* Check UNIVERSAL without caching */
770 if(level == 0 || level == -1) {
771 candidate = gv_fetchmeth_pvn(NULL, name, len, 1, flags &~GV_SUPER);
773 cand_cv = GvCV(candidate);
774 if (topgv && (GvREFCNT(topgv) == 1) && (CvROOT(cand_cv) || CvXSUB(cand_cv))) {
775 CV *old_cv = GvCV(topgv);
776 SvREFCNT_dec(old_cv);
777 SvREFCNT_inc_simple_void_NN(cand_cv);
778 GvCV_set(topgv, cand_cv);
779 GvCVGEN(topgv) = topgen_cmp;
785 if (topgv && GvREFCNT(topgv) == 1) {
786 /* cache the fact that the method is not defined */
787 GvCVGEN(topgv) = topgen_cmp;
794 =for apidoc gv_fetchmeth_autoload
796 This is the old form of L</gv_fetchmeth_pvn_autoload>, which has no flags
799 =for apidoc gv_fetchmeth_sv_autoload
801 Exactly like L</gv_fetchmeth_pvn_autoload>, but takes the name string in the form
802 of an SV instead of a string/length pair.
808 Perl_gv_fetchmeth_sv_autoload(pTHX_ HV *stash, SV *namesv, I32 level, U32 flags)
812 PERL_ARGS_ASSERT_GV_FETCHMETH_SV_AUTOLOAD;
813 namepv = SvPV(namesv, namelen);
816 return gv_fetchmeth_pvn_autoload(stash, namepv, namelen, level, flags);
820 =for apidoc gv_fetchmeth_pv_autoload
822 Exactly like L</gv_fetchmeth_pvn_autoload>, but takes a nul-terminated string
823 instead of a string/length pair.
829 Perl_gv_fetchmeth_pv_autoload(pTHX_ HV *stash, const char *name, I32 level, U32 flags)
831 PERL_ARGS_ASSERT_GV_FETCHMETH_PV_AUTOLOAD;
832 return gv_fetchmeth_pvn_autoload(stash, name, strlen(name), level, flags);
836 =for apidoc gv_fetchmeth_pvn_autoload
838 Same as gv_fetchmeth_pvn(), but looks for autoloaded subroutines too.
839 Returns a glob for the subroutine.
841 For an autoloaded subroutine without a GV, will create a GV even
842 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
843 of the result may be zero.
845 Currently, the only significant value for C<flags> is SVf_UTF8.
851 Perl_gv_fetchmeth_pvn_autoload(pTHX_ HV *stash, const char *name, STRLEN len, I32 level, U32 flags)
853 GV *gv = gv_fetchmeth_pvn(stash, name, len, level, flags);
855 PERL_ARGS_ASSERT_GV_FETCHMETH_PVN_AUTOLOAD;
862 return NULL; /* UNIVERSAL::AUTOLOAD could cause trouble */
863 if (len == S_autolen && memEQ(name, S_autoload, S_autolen))
865 if (!(gv = gv_fetchmeth_pvn(stash, S_autoload, S_autolen, FALSE, flags)))
868 if (!(CvROOT(cv) || CvXSUB(cv)))
870 /* Have an autoload */
871 if (level < 0) /* Cannot do without a stub */
872 gv_fetchmeth_pvn(stash, name, len, 0, flags);
873 gvp = (GV**)hv_fetch(stash, name,
874 (flags & SVf_UTF8) ? -(I32)len : (I32)len, (level >= 0));
883 =for apidoc gv_fetchmethod_autoload
885 Returns the glob which contains the subroutine to call to invoke the method
886 on the C<stash>. In fact in the presence of autoloading this may be the
887 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
890 The third parameter of C<gv_fetchmethod_autoload> determines whether
891 AUTOLOAD lookup is performed if the given method is not present: non-zero
892 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
893 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
894 with a non-zero C<autoload> parameter.
896 These functions grant C<"SUPER"> token as a prefix of the method name. Note
897 that if you want to keep the returned glob for a long time, you need to
898 check for it being "AUTOLOAD", since at the later time the call may load a
899 different subroutine due to $AUTOLOAD changing its value. Use the glob
900 created via a side effect to do this.
902 These functions have the same side-effects and as C<gv_fetchmeth> with
903 C<level==0>. C<name> should be writable if contains C<':'> or C<'
904 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
905 C<call_sv> apply equally to these functions.
911 Perl_gv_fetchmethod_autoload(pTHX_ HV *stash, const char *name, I32 autoload)
913 PERL_ARGS_ASSERT_GV_FETCHMETHOD_AUTOLOAD;
915 return gv_fetchmethod_flags(stash, name, autoload ? GV_AUTOLOAD : 0);
919 Perl_gv_fetchmethod_sv_flags(pTHX_ HV *stash, SV *namesv, U32 flags)
923 PERL_ARGS_ASSERT_GV_FETCHMETHOD_SV_FLAGS;
924 namepv = SvPV(namesv, namelen);
927 return gv_fetchmethod_pvn_flags(stash, namepv, namelen, flags);
931 Perl_gv_fetchmethod_pv_flags(pTHX_ HV *stash, const char *name, U32 flags)
933 PERL_ARGS_ASSERT_GV_FETCHMETHOD_PV_FLAGS;
934 return gv_fetchmethod_pvn_flags(stash, name, strlen(name), flags);
937 /* Don't merge this yet, as it's likely to get a len parameter, and possibly
940 Perl_gv_fetchmethod_pvn_flags(pTHX_ HV *stash, const char *name, const STRLEN len, U32 flags)
944 const char *nsplit = NULL;
947 const char * const origname = name;
948 SV *const error_report = MUTABLE_SV(stash);
949 const U32 autoload = flags & GV_AUTOLOAD;
950 const U32 do_croak = flags & GV_CROAK;
951 const U32 is_utf8 = flags & SVf_UTF8;
953 PERL_ARGS_ASSERT_GV_FETCHMETHOD_PVN_FLAGS;
955 if (SvTYPE(stash) < SVt_PVHV)
958 /* The only way stash can become NULL later on is if nsplit is set,
959 which in turn means that there is no need for a SVt_PVHV case
960 the error reporting code. */
963 for (nend = name; *nend || nend != (origname + len); nend++) {
968 else if (*nend == ':' && *(nend + 1) == ':') {
974 if ((nsplit - origname) == 5 && memEQ(origname, "SUPER", 5)) {
975 /* ->SUPER::method should really be looked up in original stash */
976 stash = CopSTASH(PL_curcop);
978 DEBUG_o( Perl_deb(aTHX_ "Treating %s as %s::%s\n",
979 origname, HvENAME_get(stash), name) );
981 else if ((nsplit - origname) >= 7 &&
982 strnEQ(nsplit - 7, "::SUPER", 7)) {
983 /* don't autovifify if ->NoSuchStash::SUPER::method */
984 stash = gv_stashpvn(origname, nsplit - origname - 7, is_utf8);
985 if (stash) flags |= GV_SUPER;
988 /* don't autovifify if ->NoSuchStash::method */
989 stash = gv_stashpvn(origname, nsplit - origname, is_utf8);
994 gv = gv_fetchmeth_pvn(stash, name, nend - name, 0, flags);
996 if (strEQ(name,"import") || strEQ(name,"unimport"))
997 gv = MUTABLE_GV(&PL_sv_yes);
999 gv = gv_autoload_pvn(
1000 ostash, name, nend - name, GV_AUTOLOAD_ISMETHOD|flags
1002 if (!gv && do_croak) {
1003 /* Right now this is exclusively for the benefit of S_method_common
1006 /* If we can't find an IO::File method, it might be a call on
1007 * a filehandle. If IO:File has not been loaded, try to
1008 * require it first instead of croaking */
1009 const char *stash_name = HvNAME_get(stash);
1010 if (stash_name && memEQs(stash_name, HvNAMELEN_get(stash), "IO::File")
1011 && !Perl_hv_common(aTHX_ GvHVn(PL_incgv), NULL,
1012 STR_WITH_LEN("IO/File.pm"), 0,
1013 HV_FETCH_ISEXISTS, NULL, 0)
1015 require_pv("IO/File.pm");
1016 gv = gv_fetchmeth_pvn(stash, name, nend - name, 0, flags);
1021 "Can't locate object method \"%"SVf
1022 "\" via package \"%"HEKf"\"",
1023 SVfARG(newSVpvn_flags(name, nend - name,
1024 SVs_TEMP | is_utf8)),
1025 HEKfARG(HvNAME_HEK(stash)));
1031 packnamesv = newSVpvn_flags(origname, nsplit - origname,
1032 SVs_TEMP | is_utf8);
1034 packnamesv = sv_2mortal(newSVsv(error_report));
1038 "Can't locate object method \"%"SVf"\" via package \"%"SVf"\""
1039 " (perhaps you forgot to load \"%"SVf"\"?)",
1040 SVfARG(newSVpvn_flags(name, nend - name,
1041 SVs_TEMP | is_utf8)),
1042 SVfARG(packnamesv), SVfARG(packnamesv));
1046 else if (autoload) {
1047 CV* const cv = GvCV(gv);
1048 if (!CvROOT(cv) && !CvXSUB(cv)) {
1056 if (GvCV(stubgv) != cv) /* orphaned import */
1059 autogv = gv_autoload_pvn(GvSTASH(stubgv),
1060 GvNAME(stubgv), GvNAMELEN(stubgv),
1061 GV_AUTOLOAD_ISMETHOD
1062 | (GvNAMEUTF8(stubgv) ? SVf_UTF8 : 0));
1072 Perl_gv_autoload_sv(pTHX_ HV *stash, SV* namesv, U32 flags)
1076 PERL_ARGS_ASSERT_GV_AUTOLOAD_SV;
1077 namepv = SvPV(namesv, namelen);
1080 return gv_autoload_pvn(stash, namepv, namelen, flags);
1084 Perl_gv_autoload_pv(pTHX_ HV *stash, const char *namepv, U32 flags)
1086 PERL_ARGS_ASSERT_GV_AUTOLOAD_PV;
1087 return gv_autoload_pvn(stash, namepv, strlen(namepv), flags);
1091 Perl_gv_autoload_pvn(pTHX_ HV *stash, const char *name, STRLEN len, U32 flags)
1099 SV *packname = NULL;
1100 U32 is_utf8 = flags & SVf_UTF8 ? SVf_UTF8 : 0;
1102 PERL_ARGS_ASSERT_GV_AUTOLOAD_PVN;
1104 if (len == S_autolen && memEQ(name, S_autoload, S_autolen))
1107 if (SvTYPE(stash) < SVt_PVHV) {
1108 STRLEN packname_len = 0;
1109 const char * const packname_ptr = SvPV_const(MUTABLE_SV(stash), packname_len);
1110 packname = newSVpvn_flags(packname_ptr, packname_len,
1111 SVs_TEMP | SvUTF8(stash));
1115 packname = sv_2mortal(newSVhek(HvNAME_HEK(stash)));
1116 if (flags & GV_SUPER) sv_catpvs(packname, "::SUPER");
1118 if (!(gv = gv_fetchmeth_pvn(stash, S_autoload, S_autolen, FALSE, is_utf8)))
1122 if (!(CvROOT(cv) || CvXSUB(cv)))
1126 * Inheriting AUTOLOAD for non-methods works ... for now.
1129 !(flags & GV_AUTOLOAD_ISMETHOD)
1130 && (GvCVGEN(gv) || GvSTASH(gv) != stash)
1132 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED),
1133 "Use of inherited AUTOLOAD for non-method %"SVf"::%"SVf"() is deprecated",
1135 SVfARG(newSVpvn_flags(name, len, SVs_TEMP | is_utf8)));
1138 /* Instead of forcing the XSUB do another lookup for $AUTOLOAD
1139 * and split that value on the last '::', pass along the same data
1140 * via the SvPVX field in the CV, and the stash in CvSTASH.
1142 * Due to an unfortunate accident of history, the SvPVX field
1143 * serves two purposes. It is also used for the subroutine's pro-
1144 * type. Since SvPVX has been documented as returning the sub name
1145 * for a long time, but not as returning the prototype, we have
1146 * to preserve the SvPVX AUTOLOAD behaviour and put the prototype
1149 * We put the prototype in the same allocated buffer, but after
1150 * the sub name. The SvPOK flag indicates the presence of a proto-
1151 * type. The CvAUTOLOAD flag indicates the presence of a sub name.
1152 * If both flags are on, then SvLEN is used to indicate the end of
1153 * the prototype (artificially lower than what is actually allo-
1154 * cated), at the risk of having to reallocate a few bytes unneces-
1155 * sarily--but that should happen very rarely, if ever.
1157 * We use SvUTF8 for both prototypes and sub names, so if one is
1158 * UTF8, the other must be upgraded.
1160 CvSTASH_set(cv, stash);
1161 if (SvPOK(cv)) { /* Ouch! */
1162 SV * const tmpsv = newSVpvn_flags(name, len, is_utf8);
1164 const char *proto = CvPROTO(cv);
1167 sv_utf8_upgrade_flags_grow(tmpsv, 0, CvPROTOLEN(cv) + 2);
1168 ulen = SvCUR(tmpsv);
1169 SvCUR(tmpsv)++; /* include null in string */
1171 tmpsv, proto, CvPROTOLEN(cv), SV_CATBYTES*!SvUTF8(cv)
1173 SvTEMP_on(tmpsv); /* Allow theft */
1174 sv_setsv_nomg((SV *)cv, tmpsv);
1176 SvREFCNT_dec_NN(tmpsv);
1177 SvLEN(cv) = SvCUR(cv) + 1;
1181 sv_setpvn((SV *)cv, name, len);
1185 else SvUTF8_off(cv);
1191 * Given &FOO::AUTOLOAD, set $FOO::AUTOLOAD to desired function name.
1192 * The subroutine's original name may not be "AUTOLOAD", so we don't
1193 * use that, but for lack of anything better we will use the sub's
1194 * original package to look up $AUTOLOAD.
1196 varstash = GvSTASH(CvGV(cv));
1197 vargv = *(GV**)hv_fetch(varstash, S_autoload, S_autolen, TRUE);
1201 gv_init_pvn(vargv, varstash, S_autoload, S_autolen, 0);
1202 #ifdef PERL_DONT_CREATE_GVSV
1203 GvSV(vargv) = newSV(0);
1207 varsv = GvSVn(vargv);
1208 SvTAINTED_off(varsv); /* previous $AUTOLOAD taint is obsolete */
1209 /* XXX: this process is not careful to avoid extra magic gets and sets; tied $AUTOLOAD will get noise */
1210 sv_setsv(varsv, packname);
1211 sv_catpvs(varsv, "::");
1212 /* Ensure SvSETMAGIC() is called if necessary. In particular, to clear
1213 tainting if $FOO::AUTOLOAD was previously tainted, but is not now. */
1216 SV_SMAGIC|(is_utf8 ? SV_CATUTF8 : SV_CATBYTES)
1224 /* require_tie_mod() internal routine for requiring a module
1225 * that implements the logic of automatic ties like %! and %-
1227 * The "gv" parameter should be the glob.
1228 * "varpv" holds the name of the var, used for error messages.
1229 * "namesv" holds the module name. Its refcount will be decremented.
1230 * "methpv" holds the method name to test for to check that things
1231 * are working reasonably close to as expected.
1232 * "flags": if flag & 1 then save the scalar before loading.
1233 * For the protection of $! to work (it is set by this routine)
1234 * the sv slot must already be magicalized.
1237 S_require_tie_mod(pTHX_ GV *gv, const char *varpv, SV* namesv, const char *methpv,const U32 flags)
1240 HV* stash = gv_stashsv(namesv, 0);
1242 PERL_ARGS_ASSERT_REQUIRE_TIE_MOD;
1244 if (!stash || !(gv_fetchmethod_autoload(stash, methpv, FALSE))) {
1245 SV *module = newSVsv(namesv);
1246 char varname = *varpv; /* varpv might be clobbered by load_module,
1247 so save it. For the moment it's always
1249 const char type = varname == '[' ? '$' : '%';
1255 PUSHSTACKi(PERLSI_MAGIC);
1256 Perl_load_module(aTHX_ PERL_LOADMOD_NOIMPORT, module, NULL);
1258 stash = gv_stashsv(namesv, 0);
1260 Perl_croak(aTHX_ "panic: Can't use %c%c because %"SVf" is not available",
1261 type, varname, SVfARG(namesv));
1262 else if (!gv_fetchmethod(stash, methpv))
1263 Perl_croak(aTHX_ "panic: Can't use %c%c because %"SVf" does not support method %s",
1264 type, varname, SVfARG(namesv), methpv);
1267 else SvREFCNT_dec_NN(namesv);
1272 =for apidoc gv_stashpv
1274 Returns a pointer to the stash for a specified package. Uses C<strlen> to
1275 determine the length of C<name>, then calls C<gv_stashpvn()>.
1281 Perl_gv_stashpv(pTHX_ const char *name, I32 create)
1283 PERL_ARGS_ASSERT_GV_STASHPV;
1284 return gv_stashpvn(name, strlen(name), create);
1288 =for apidoc gv_stashpvn
1290 Returns a pointer to the stash for a specified package. The C<namelen>
1291 parameter indicates the length of the C<name>, in bytes. C<flags> is passed
1292 to C<gv_fetchpvn_flags()>, so if set to C<GV_ADD> then the package will be
1293 created if it does not already exist. If the package does not exist and
1294 C<flags> is 0 (or any other setting that does not create packages) then NULL
1297 Flags may be one of:
1306 The most important of which are probably GV_ADD and SVf_UTF8.
1312 Perl_gv_stashpvn(pTHX_ const char *name, U32 namelen, I32 flags)
1318 U32 tmplen = namelen + 2;
1320 PERL_ARGS_ASSERT_GV_STASHPVN;
1322 if (tmplen <= sizeof smallbuf)
1325 Newx(tmpbuf, tmplen, char);
1326 Copy(name, tmpbuf, namelen, char);
1327 tmpbuf[namelen] = ':';
1328 tmpbuf[namelen+1] = ':';
1329 tmpgv = gv_fetchpvn_flags(tmpbuf, tmplen, flags, SVt_PVHV);
1330 if (tmpbuf != smallbuf)
1334 stash = GvHV(tmpgv);
1335 if (!(flags & ~GV_NOADD_MASK) && !stash) return NULL;
1337 if (!HvNAME_get(stash)) {
1338 hv_name_set(stash, name, namelen, flags & SVf_UTF8 ? SVf_UTF8 : 0 );
1340 /* FIXME: This is a repeat of logic in gv_fetchpvn_flags */
1341 /* If the containing stash has multiple effective
1342 names, see that this one gets them, too. */
1343 if (HvAUX(GvSTASH(tmpgv))->xhv_name_count)
1344 mro_package_moved(stash, NULL, tmpgv, 1);
1350 =for apidoc gv_stashsv
1352 Returns a pointer to the stash for a specified package. See C<gv_stashpvn>.
1358 Perl_gv_stashsv(pTHX_ SV *sv, I32 flags)
1361 const char * const ptr = SvPV_const(sv,len);
1363 PERL_ARGS_ASSERT_GV_STASHSV;
1365 return gv_stashpvn(ptr, len, flags | SvUTF8(sv));
1370 Perl_gv_fetchpv(pTHX_ const char *nambeg, I32 add, const svtype sv_type) {
1371 PERL_ARGS_ASSERT_GV_FETCHPV;
1372 return gv_fetchpvn_flags(nambeg, strlen(nambeg), add, sv_type);
1376 Perl_gv_fetchsv(pTHX_ SV *name, I32 flags, const svtype sv_type) {
1378 const char * const nambeg =
1379 SvPV_flags_const(name, len, flags & GV_NO_SVGMAGIC ? 0 : SV_GMAGIC);
1380 PERL_ARGS_ASSERT_GV_FETCHSV;
1381 return gv_fetchpvn_flags(nambeg, len, flags | SvUTF8(name), sv_type);
1385 S_gv_magicalize_isa(pTHX_ GV *gv)
1389 PERL_ARGS_ASSERT_GV_MAGICALIZE_ISA;
1393 sv_magic(MUTABLE_SV(av), MUTABLE_SV(gv), PERL_MAGIC_isa,
1398 Perl_gv_fetchpvn_flags(pTHX_ const char *nambeg, STRLEN full_len, I32 flags,
1399 const svtype sv_type)
1402 const char *name = nambeg;
1406 const char *name_cursor;
1408 const I32 no_init = flags & (GV_NOADD_NOINIT | GV_NOINIT);
1409 const I32 no_expand = flags & GV_NOEXPAND;
1410 const I32 add = flags & ~GV_NOADD_MASK;
1411 const U32 is_utf8 = flags & SVf_UTF8;
1412 bool addmg = !!(flags & GV_ADDMG);
1413 const char *const name_end = nambeg + full_len;
1414 const char *const name_em1 = name_end - 1;
1417 PERL_ARGS_ASSERT_GV_FETCHPVN_FLAGS;
1419 if (flags & GV_NOTQUAL) {
1420 /* Caller promised that there is no stash, so we can skip the check. */
1425 if (full_len > 2 && *name == '*' && isIDFIRST_lazy_if(name + 1, is_utf8)) {
1426 /* accidental stringify on a GV? */
1430 for (name_cursor = name; name_cursor < name_end; name_cursor++) {
1431 if (name_cursor < name_em1 &&
1432 ((*name_cursor == ':'
1433 && name_cursor[1] == ':')
1434 || *name_cursor == '\''))
1437 stash = PL_defstash;
1438 if (!stash || !SvREFCNT(stash)) /* symbol table under destruction */
1441 len = name_cursor - name;
1442 if (name_cursor > nambeg) { /* Skip for initial :: or ' */
1444 if (*name_cursor == ':') {
1449 Newx(tmpbuf, len+2, char);
1450 Copy(name, tmpbuf, len, char);
1451 tmpbuf[len++] = ':';
1452 tmpbuf[len++] = ':';
1455 gvp = (GV**)hv_fetch(stash, key, is_utf8 ? -len : len, add);
1456 gv = gvp ? *gvp : NULL;
1457 if (gv && gv != (const GV *)&PL_sv_undef) {
1458 if (SvTYPE(gv) != SVt_PVGV)
1459 gv_init_pvn(gv, stash, key, len, (add & GV_ADDMULTI)|is_utf8);
1465 if (!gv || gv == (const GV *)&PL_sv_undef)
1468 if (!(stash = GvHV(gv)))
1470 stash = GvHV(gv) = newHV();
1471 if (!HvNAME_get(stash)) {
1472 if (GvSTASH(gv) == PL_defstash && len == 6
1473 && strnEQ(name, "CORE", 4))
1474 hv_name_set(stash, "CORE", 4, 0);
1477 stash, nambeg, name_cursor-nambeg, is_utf8
1479 /* If the containing stash has multiple effective
1480 names, see that this one gets them, too. */
1481 if (HvAUX(GvSTASH(gv))->xhv_name_count)
1482 mro_package_moved(stash, NULL, gv, 1);
1485 else if (!HvNAME_get(stash))
1486 hv_name_set(stash, nambeg, name_cursor - nambeg, is_utf8);
1489 if (*name_cursor == ':')
1491 name = name_cursor+1;
1492 if (name == name_end)
1494 ? gv : MUTABLE_GV(*hv_fetchs(PL_defstash, "main::", TRUE));
1497 len = name_cursor - name;
1499 /* No stash in name, so see how we can default */
1503 if (len && isIDFIRST_lazy_if(name, is_utf8)) {
1504 bool global = FALSE;
1512 if ((name[0] == 'I' && name[1] == 'N' && name[2] == 'C')
1513 || (name[0] == 'E' && name[1] == 'N' && name[2] == 'V')
1514 || (name[0] == 'S' && name[1] == 'I' && name[2] == 'G'))
1518 if (name[0] == 'A' && name[1] == 'R' && name[2] == 'G'
1523 if (name[0] == 'S' && name[1] == 'T' && name[2] == 'D'
1524 && name[3] == 'I' && name[4] == 'N')
1528 if ((name[0] == 'S' && name[1] == 'T' && name[2] == 'D')
1529 &&((name[3] == 'O' && name[4] == 'U' && name[5] == 'T')
1530 ||(name[3] == 'E' && name[4] == 'R' && name[5] == 'R')))
1534 if (name[0] == 'A' && name[1] == 'R' && name[2] == 'G'
1535 && name[3] == 'V' && name[4] == 'O' && name[5] == 'U'
1542 stash = PL_defstash;
1543 else if (IN_PERL_COMPILETIME) {
1544 stash = PL_curstash;
1545 if (add && (PL_hints & HINT_STRICT_VARS) &&
1546 sv_type != SVt_PVCV &&
1547 sv_type != SVt_PVGV &&
1548 sv_type != SVt_PVFM &&
1549 sv_type != SVt_PVIO &&
1550 !(len == 1 && sv_type == SVt_PV &&
1551 (*name == 'a' || *name == 'b')) )
1553 gvp = (GV**)hv_fetch(stash,name,is_utf8 ? -len : len,0);
1555 *gvp == (const GV *)&PL_sv_undef ||
1556 SvTYPE(*gvp) != SVt_PVGV)
1560 else if ((sv_type == SVt_PV && !GvIMPORTED_SV(*gvp)) ||
1561 (sv_type == SVt_PVAV && !GvIMPORTED_AV(*gvp)) ||
1562 (sv_type == SVt_PVHV && !GvIMPORTED_HV(*gvp)) )
1564 SV* namesv = newSVpvn_flags(name, len, SVs_TEMP | is_utf8);
1565 /* diag_listed_as: Variable "%s" is not imported%s */
1567 aTHX_ packWARN(WARN_MISC),
1568 "Variable \"%c%"SVf"\" is not imported",
1569 sv_type == SVt_PVAV ? '@' :
1570 sv_type == SVt_PVHV ? '%' : '$',
1574 aTHX_ packWARN(WARN_MISC),
1575 "\t(Did you mean &%"SVf" instead?)\n", SVfARG(namesv)
1582 stash = CopSTASH(PL_curcop);
1585 stash = PL_defstash;
1588 /* By this point we should have a stash and a name */
1591 if (add && !PL_in_clean_all) {
1592 SV * const namesv = newSVpvn_flags(name, len, is_utf8);
1593 SV * const err = Perl_mess(aTHX_
1594 "Global symbol \"%s%"SVf"\" requires explicit package name",
1595 (sv_type == SVt_PV ? "$"
1596 : sv_type == SVt_PVAV ? "@"
1597 : sv_type == SVt_PVHV ? "%"
1598 : ""), SVfARG(namesv));
1600 SvREFCNT_dec_NN(namesv);
1604 gv = gv_fetchpvs("<none>::", GV_ADDMULTI, SVt_PVHV);
1606 /* symbol table under destruction */
1615 if (!SvREFCNT(stash)) /* symbol table under destruction */
1618 gvp = (GV**)hv_fetch(stash,name,is_utf8 ? -len : len,add);
1619 if (!gvp || *gvp == (const GV *)&PL_sv_undef) {
1620 if (addmg) gv = (GV *)newSV(0);
1623 else gv = *gvp, addmg = 0;
1624 /* From this point on, addmg means gv has not been inserted in the
1627 if (SvTYPE(gv) == SVt_PVGV) {
1630 gv_init_svtype(gv, sv_type);
1631 /* You reach this path once the typeglob has already been created,
1632 either by the same or a different sigil. If this path didn't
1633 exist, then (say) referencing $! first, and %! second would
1634 mean that %! was not handled correctly. */
1635 if (len == 1 && stash == PL_defstash) {
1636 if (sv_type == SVt_PVHV || sv_type == SVt_PVGV) {
1638 require_tie_mod(gv, "!", newSVpvs("Errno"), "TIEHASH", 1);
1639 else if (*name == '-' || *name == '+')
1640 require_tie_mod(gv, name, newSVpvs("Tie::Hash::NamedCapture"), "TIEHASH", 0);
1641 } else if (sv_type == SVt_PV && *name == '#') {
1642 Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED,
1644 "$# is no longer supported");
1647 if (sv_type == SVt_PV)
1648 Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED,
1650 "$* is no longer supported, and will become a syntax error");
1652 Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_SYNTAX),
1653 "%c* is deprecated, and will become a syntax error",
1654 sv_type == SVt_PVAV ? '@'
1655 : sv_type == SVt_PVCV ? '&'
1656 : sv_type == SVt_PVHV ? '%'
1659 if (sv_type==SVt_PV || sv_type==SVt_PVGV) {
1662 require_tie_mod(gv,name,newSVpvs("arybase"),"FETCH",0);
1664 #ifdef PERL_SAWAMPERSAND
1666 PL_sawampersand |= SAWAMPERSAND_LEFT;
1670 PL_sawampersand |= SAWAMPERSAND_MIDDLE;
1674 PL_sawampersand |= SAWAMPERSAND_RIGHT;
1681 else if (len == 3 && sv_type == SVt_PVAV
1682 && strnEQ(name, "ISA", 3)
1683 && (!GvAV(gv) || !SvSMAGICAL(GvAV(gv))))
1684 gv_magicalize_isa(gv);
1687 } else if (no_init) {
1690 } else if (no_expand && SvROK(gv)) {
1695 /* Adding a new symbol.
1696 Unless of course there was already something non-GV here, in which case
1697 we want to behave as if there was always a GV here, containing some sort
1699 Otherwise we run the risk of creating things like GvIO, which can cause
1700 subtle bugs. eg the one that tripped up SQL::Translator */
1702 faking_it = SvOK(gv);
1704 if (add & GV_ADDWARN)
1705 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL), "Had to create %"SVf" unexpectedly",
1706 SVfARG(newSVpvn_flags(nambeg, name_end-nambeg, SVs_TEMP | is_utf8 )));
1707 gv_init_pvn(gv, stash, name, len, (add & GV_ADDMULTI)|is_utf8);
1709 if ( isIDFIRST_lazy_if(name, is_utf8)
1710 && ! (isLEXWARN_on ? ckWARN(WARN_ONCE) : (PL_dowarn & G_WARN_ON ) ) )
1713 /* set up magic where warranted */
1714 if (stash != PL_defstash) { /* not the main stash */
1715 /* We only have to check for three names here: EXPORT, ISA
1716 and VERSION. All the others apply only to the main stash or to
1717 CORE (which is checked right after this). */
1719 const char * const name2 = name + 1;
1722 if (strnEQ(name2, "XPORT", 5))
1726 if (strEQ(name2, "SA"))
1727 gv_magicalize_isa(gv);
1730 if (strEQ(name2, "ERSION"))
1736 goto add_magical_gv;
1739 if (len > 1 /* shortest is uc */ && HvNAMELEN_get(stash) == 4) {
1740 /* Avoid null warning: */
1741 const char * const stashname = HvNAME(stash); assert(stashname);
1742 if (strnEQ(stashname, "CORE", 4))
1743 S_maybe_add_coresub(aTHX_ 0, gv, name, len);
1750 /* Nothing else to do.
1751 The compiler will probably turn the switch statement into a
1752 branch table. Make sure we avoid even that small overhead for
1753 the common case of lower case variable names. */
1757 const char * const name2 = name + 1;
1760 if (strEQ(name2, "RGV")) {
1761 IoFLAGS(GvIOn(gv)) |= IOf_ARGV|IOf_START;
1763 else if (strEQ(name2, "RGVOUT")) {
1768 if (strnEQ(name2, "XPORT", 5))
1772 if (strEQ(name2, "SA")) {
1773 gv_magicalize_isa(gv);
1777 if (strEQ(name2, "IG")) {
1780 if (!PL_psig_name) {
1781 Newxz(PL_psig_name, 2 * SIG_SIZE, SV*);
1782 Newxz(PL_psig_pend, SIG_SIZE, int);
1783 PL_psig_ptr = PL_psig_name + SIG_SIZE;
1785 /* I think that the only way to get here is to re-use an
1786 embedded perl interpreter, where the previous
1787 use didn't clean up fully because
1788 PL_perl_destruct_level was 0. I'm not sure that we
1789 "support" that, in that I suspect in that scenario
1790 there are sufficient other garbage values left in the
1791 interpreter structure that something else will crash
1792 before we get here. I suspect that this is one of
1793 those "doctor, it hurts when I do this" bugs. */
1794 Zero(PL_psig_name, 2 * SIG_SIZE, SV*);
1795 Zero(PL_psig_pend, SIG_SIZE, int);
1799 hv_magic(hv, NULL, PERL_MAGIC_sig);
1800 for (i = 1; i < SIG_SIZE; i++) {
1801 SV * const * const init = hv_fetch(hv, PL_sig_name[i], strlen(PL_sig_name[i]), 1);
1803 sv_setsv(*init, &PL_sv_undef);
1808 if (strEQ(name2, "ERSION"))
1811 case '\003': /* $^CHILD_ERROR_NATIVE */
1812 if (strEQ(name2, "HILD_ERROR_NATIVE"))
1815 case '\005': /* $^ENCODING */
1816 if (strEQ(name2, "NCODING"))
1819 case '\007': /* $^GLOBAL_PHASE */
1820 if (strEQ(name2, "LOBAL_PHASE"))
1823 case '\014': /* $^LAST_FH */
1824 if (strEQ(name2, "AST_FH"))
1827 case '\015': /* $^MATCH */
1828 if (strEQ(name2, "ATCH"))
1830 case '\017': /* $^OPEN */
1831 if (strEQ(name2, "PEN"))
1834 case '\020': /* $^PREMATCH $^POSTMATCH */
1835 if (strEQ(name2, "REMATCH") || strEQ(name2, "OSTMATCH"))
1838 case '\024': /* ${^TAINT} */
1839 if (strEQ(name2, "AINT"))
1842 case '\025': /* ${^UNICODE}, ${^UTF8LOCALE} */
1843 if (strEQ(name2, "NICODE"))
1845 if (strEQ(name2, "TF8LOCALE"))
1847 if (strEQ(name2, "TF8CACHE"))
1850 case '\027': /* $^WARNING_BITS */
1851 if (strEQ(name2, "ARNING_BITS"))
1864 /* Ensures that we have an all-digit variable, ${"1foo"} fails
1866 /* This snippet is taken from is_gv_magical */
1867 const char *end = name + len;
1868 while (--end > name) {
1869 if (!isDIGIT(*end)) goto add_magical_gv;
1876 /* Names of length 1. (Or 0. But name is NUL terminated, so that will
1877 be case '\0' in this switch statement (ie a default case) */
1882 #ifdef PERL_SAWAMPERSAND
1884 sv_type == SVt_PVAV ||
1885 sv_type == SVt_PVHV ||
1886 sv_type == SVt_PVCV ||
1887 sv_type == SVt_PVFM ||
1889 )) { PL_sawampersand |=
1893 ? SAWAMPERSAND_MIDDLE
1894 : SAWAMPERSAND_RIGHT;
1900 sv_setpv(GvSVn(gv),PL_chopset);
1904 #ifdef COMPLEX_STATUS
1905 SvUPGRADE(GvSVn(gv), SVt_PVLV);
1911 /* If %! has been used, automatically load Errno.pm. */
1913 sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
1915 /* magicalization must be done before require_tie_mod is called */
1916 if (sv_type == SVt_PVHV || sv_type == SVt_PVGV)
1918 if (addmg) (void)hv_store(stash,name,len,(SV *)gv,0);
1920 require_tie_mod(gv, "!", newSVpvs("Errno"), "TIEHASH", 1);
1926 GvMULTI_on(gv); /* no used once warnings here */
1928 AV* const av = GvAVn(gv);
1929 SV* const avc = (*name == '+') ? MUTABLE_SV(av) : NULL;
1931 sv_magic(MUTABLE_SV(av), avc, PERL_MAGIC_regdata, NULL, 0);
1932 sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
1934 SvREADONLY_on(GvSVn(gv));
1937 if (sv_type == SVt_PVHV || sv_type == SVt_PVGV)
1939 if (addmg) (void)hv_store(stash,name,len,(SV *)gv,0);
1941 require_tie_mod(gv, name, newSVpvs("Tie::Hash::NamedCapture"), "TIEHASH", 0);
1947 if (sv_type == SVt_PV)
1948 Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_SYNTAX),
1949 "$* is no longer supported, and will become a syntax error");
1951 Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_SYNTAX),
1952 "%c* is deprecated, and will become a syntax error",
1953 sv_type == SVt_PVAV ? '@'
1954 : sv_type == SVt_PVCV ? '&'
1955 : sv_type == SVt_PVHV ? '%'
1960 if (sv_type == SVt_PV)
1961 Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_SYNTAX),
1962 "$# is no longer supported");
1964 case '\010': /* $^H */
1966 HV *const hv = GvHVn(gv);
1967 hv_magic(hv, NULL, PERL_MAGIC_hints);
1971 if ((sv_type == SVt_PV || sv_type == SVt_PVGV)
1972 && FEATURE_ARYBASE_IS_ENABLED) {
1973 if (addmg) (void)hv_store(stash,name,len,(SV *)gv,0);
1974 require_tie_mod(gv,name,newSVpvs("arybase"),"FETCH",0);
1977 else goto magicalize;
1979 case '\023': /* $^S */
1981 SvREADONLY_on(GvSVn(gv));
2006 case '\001': /* $^A */
2007 case '\003': /* $^C */
2008 case '\004': /* $^D */
2009 case '\005': /* $^E */
2010 case '\006': /* $^F */
2011 case '\011': /* $^I, NOT \t in EBCDIC */
2012 case '\016': /* $^N */
2013 case '\017': /* $^O */
2014 case '\020': /* $^P */
2015 case '\024': /* $^T */
2016 case '\027': /* $^W */
2018 sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
2021 case '\014': /* $^L */
2022 sv_setpvs(GvSVn(gv),"\f");
2025 sv_setpvs(GvSVn(gv),"\034");
2029 SV * const sv = GvSV(gv);
2030 if (!sv_derived_from(PL_patchlevel, "version"))
2031 upg_version(PL_patchlevel, TRUE);
2032 GvSV(gv) = vnumify(PL_patchlevel);
2033 SvREADONLY_on(GvSV(gv));
2037 case '\026': /* $^V */
2039 SV * const sv = GvSV(gv);
2040 GvSV(gv) = new_version(PL_patchlevel);
2041 SvREADONLY_on(GvSV(gv));
2049 if (GvAV(gv) || GvHV(gv) || GvIO(gv) || GvCV(gv) || (
2050 GvSV(gv) && (SvOK(GvSV(gv)) || SvMAGICAL(GvSV(gv)))
2052 (void)hv_store(stash,name,len,(SV *)gv,0);
2053 else SvREFCNT_dec_NN(gv), gv = NULL;
2055 if (gv) gv_init_svtype(gv, faking_it ? SVt_PVCV : sv_type);
2060 Perl_gv_fullname4(pTHX_ SV *sv, const GV *gv, const char *prefix, bool keepmain)
2063 const HV * const hv = GvSTASH(gv);
2065 PERL_ARGS_ASSERT_GV_FULLNAME4;
2067 sv_setpv(sv, prefix ? prefix : "");
2069 if (hv && (name = HvNAME(hv))) {
2070 const STRLEN len = HvNAMELEN(hv);
2071 if (keepmain || strnNE(name, "main", len)) {
2072 sv_catpvn_flags(sv,name,len,HvNAMEUTF8(hv)?SV_CATUTF8:SV_CATBYTES);
2076 else sv_catpvs(sv,"__ANON__::");
2077 sv_catsv(sv,sv_2mortal(newSVhek(GvNAME_HEK(gv))));
2081 Perl_gv_efullname4(pTHX_ SV *sv, const GV *gv, const char *prefix, bool keepmain)
2083 const GV * const egv = GvEGVx(gv);
2085 PERL_ARGS_ASSERT_GV_EFULLNAME4;
2087 gv_fullname4(sv, egv ? egv : gv, prefix, keepmain);
2091 Perl_gv_check(pTHX_ const HV *stash)
2096 PERL_ARGS_ASSERT_GV_CHECK;
2098 if (!HvARRAY(stash))
2100 for (i = 0; i <= (I32) HvMAX(stash); i++) {
2102 for (entry = HvARRAY(stash)[i]; entry; entry = HeNEXT(entry)) {
2105 if (HeKEY(entry)[HeKLEN(entry)-1] == ':' &&
2106 (gv = MUTABLE_GV(HeVAL(entry))) && isGV(gv) && (hv = GvHV(gv)))
2108 if (hv != PL_defstash && hv != stash)
2109 gv_check(hv); /* nested package */
2111 else if ( *HeKEY(entry) != '_'
2112 && isIDFIRST_lazy_if(HeKEY(entry), HeUTF8(entry)) ) {
2114 gv = MUTABLE_GV(HeVAL(entry));
2115 if (SvTYPE(gv) != SVt_PVGV || GvMULTI(gv))
2118 CopLINE_set(PL_curcop, GvLINE(gv));
2120 CopFILE(PL_curcop) = (char *)file; /* set for warning */
2122 CopFILEGV(PL_curcop)
2123 = gv_fetchfile_flags(file, HEK_LEN(GvFILE_HEK(gv)), 0);
2125 Perl_warner(aTHX_ packWARN(WARN_ONCE),
2126 "Name \"%"HEKf"::%"HEKf
2127 "\" used only once: possible typo",
2128 HEKfARG(HvNAME_HEK(stash)),
2129 HEKfARG(GvNAME_HEK(gv)));
2136 Perl_newGVgen_flags(pTHX_ const char *pack, U32 flags)
2139 PERL_ARGS_ASSERT_NEWGVGEN_FLAGS;
2141 return gv_fetchpv(Perl_form(aTHX_ "%"SVf"::_GEN_%ld",
2142 SVfARG(newSVpvn_flags(pack, strlen(pack),
2148 /* hopefully this is only called on local symbol table entries */
2151 Perl_gp_ref(pTHX_ GP *gp)
2159 /* If the GP they asked for a reference to contains
2160 a method cache entry, clear it first, so that we
2161 don't infect them with our cached entry */
2162 SvREFCNT_dec_NN(gp->gp_cv);
2171 Perl_gp_free(pTHX_ GV *gv)
2177 if (!gv || !isGV_with_GP(gv) || !(gp = GvGP(gv)))
2179 if (gp->gp_refcnt == 0) {
2180 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
2181 "Attempt to free unreferenced glob pointers"
2182 pTHX__FORMAT pTHX__VALUE);
2185 if (--gp->gp_refcnt > 0) {
2186 if (gp->gp_egv == gv)
2193 /* Copy and null out all the glob slots, so destructors do not see
2195 HEK * const file_hek = gp->gp_file_hek;
2196 SV * const sv = gp->gp_sv;
2197 AV * const av = gp->gp_av;
2198 HV * const hv = gp->gp_hv;
2199 IO * const io = gp->gp_io;
2200 CV * const cv = gp->gp_cv;
2201 CV * const form = gp->gp_form;
2203 gp->gp_file_hek = NULL;
2212 unshare_hek(file_hek);
2216 /* FIXME - another reference loop GV -> symtab -> GV ?
2217 Somehow gp->gp_hv can end up pointing at freed garbage. */
2218 if (hv && SvTYPE(hv) == SVt_PVHV) {
2219 const HEK *hvname_hek = HvNAME_HEK(hv);
2220 DEBUG_o(Perl_deb(aTHX_ "gp_free clearing PL_stashcache for '%"HEKf"'\n", hvname_hek));
2221 if (PL_stashcache && hvname_hek)
2222 (void)hv_delete(PL_stashcache, HEK_KEY(hvname_hek),
2223 (HEK_UTF8(hvname_hek) ? -HEK_LEN(hvname_hek) : HEK_LEN(hvname_hek)),
2231 if (!gp->gp_file_hek
2237 && !gp->gp_form) break;
2239 if (--attempts == 0) {
2241 "panic: gp_free failed to free glob pointer - "
2242 "something is repeatedly re-creating entries"
2252 Perl_magic_freeovrld(pTHX_ SV *sv, MAGIC *mg)
2254 AMT * const amtp = (AMT*)mg->mg_ptr;
2255 PERL_UNUSED_ARG(sv);
2257 PERL_ARGS_ASSERT_MAGIC_FREEOVRLD;
2259 if (amtp && AMT_AMAGIC(amtp)) {
2261 for (i = 1; i < NofAMmeth; i++) {
2262 CV * const cv = amtp->table[i];
2264 SvREFCNT_dec_NN(MUTABLE_SV(cv));
2265 amtp->table[i] = NULL;
2272 /* Updates and caches the CV's */
2274 * 1 on success and there is some overload
2275 * 0 if there is no overload
2276 * -1 if some error occurred and it couldn't croak
2280 Perl_Gv_AMupdate(pTHX_ HV *stash, bool destructing)
2283 MAGIC* const mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
2285 const struct mro_meta* stash_meta = HvMROMETA(stash);
2288 PERL_ARGS_ASSERT_GV_AMUPDATE;
2290 newgen = PL_sub_generation + stash_meta->pkg_gen + stash_meta->cache_gen;
2292 const AMT * const amtp = (AMT*)mg->mg_ptr;
2293 if (amtp->was_ok_sub == newgen) {
2294 return AMT_AMAGIC(amtp) ? 1 : 0;
2296 sv_unmagic(MUTABLE_SV(stash), PERL_MAGIC_overload_table);
2299 DEBUG_o( Perl_deb(aTHX_ "Recalcing overload magic in package %s\n",HvNAME_get(stash)) );
2302 amt.was_ok_sub = newgen;
2303 amt.fallback = AMGfallNO;
2310 /* Work with "fallback" key, which we assume to be first in PL_AMG_names */
2312 /* Try to find via inheritance. */
2313 GV *gv = gv_fetchmeth_pvn(stash, PL_AMG_names[0], 2, -1, 0);
2314 SV * const sv = gv ? GvSV(gv) : NULL;
2319 if (!gv_fetchmeth_pvn(stash, "((", 2, -1, 0))
2322 #ifdef PERL_DONT_CREATE_GVSV
2324 NOOP; /* Equivalent to !SvTRUE and !SvOK */
2327 else if (SvTRUE(sv))
2328 /* don't need to set overloading here because fallback => 1
2329 * is the default setting for classes without overloading */
2330 amt.fallback=AMGfallYES;
2331 else if (SvOK(sv)) {
2332 amt.fallback=AMGfallNEVER;
2339 for (i = 1; i < NofAMmeth; i++) {
2340 const char * const cooky = PL_AMG_names[i];
2341 /* Human-readable form, for debugging: */
2342 const char * const cp = AMG_id2name(i);
2343 const STRLEN l = PL_AMG_namelens[i];
2345 DEBUG_o( Perl_deb(aTHX_ "Checking overloading of \"%s\" in package \"%.256s\"\n",
2346 cp, HvNAME_get(stash)) );
2347 /* don't fill the cache while looking up!
2348 Creation of inheritance stubs in intermediate packages may
2349 conflict with the logic of runtime method substitution.
2350 Indeed, for inheritance A -> B -> C, if C overloads "+0",
2351 then we could have created stubs for "(+0" in A and C too.
2352 But if B overloads "bool", we may want to use it for
2353 numifying instead of C's "+0". */
2354 gv = Perl_gv_fetchmeth_pvn(aTHX_ stash, cooky, l, -1, 0);
2356 if (gv && (cv = GvCV(gv))) {
2357 if(GvNAMELEN(CvGV(cv)) == 3 && strEQ(GvNAME(CvGV(cv)), "nil")){
2358 const char * const hvname = HvNAME_get(GvSTASH(CvGV(cv)));
2359 if (hvname && HEK_LEN(HvNAME_HEK(GvSTASH(CvGV(cv)))) == 8
2360 && strEQ(hvname, "overload")) {
2361 /* This is a hack to support autoloading..., while
2362 knowing *which* methods were declared as overloaded. */
2363 /* GvSV contains the name of the method. */
2365 SV *gvsv = GvSV(gv);
2367 DEBUG_o( Perl_deb(aTHX_ "Resolving method \"%"SVf256\
2368 "\" for overloaded \"%s\" in package \"%.256s\"\n",
2369 (void*)GvSV(gv), cp, HvNAME(stash)) );
2370 if (!gvsv || !SvPOK(gvsv)
2371 || !(ngv = gv_fetchmethod_sv_flags(stash, gvsv, 0)))
2373 /* Can be an import stub (created by "can"). */
2378 const SV * const name = (gvsv && SvPOK(gvsv))
2380 : newSVpvs_flags("???", SVs_TEMP);
2381 /* diag_listed_as: Can't resolve method "%s" overloading "%s" in package "%s" */
2382 Perl_croak(aTHX_ "%s method \"%"SVf256
2383 "\" overloading \"%s\" "\
2384 "in package \"%"HEKf256"\"",
2385 (GvCVGEN(gv) ? "Stub found while resolving"
2393 cv = GvCV(gv = ngv);
2396 DEBUG_o( Perl_deb(aTHX_ "Overloading \"%s\" in package \"%.256s\" via \"%.256s::%.256s\"\n",
2397 cp, HvNAME_get(stash), HvNAME_get(GvSTASH(CvGV(cv))),
2398 GvNAME(CvGV(cv))) );
2400 } else if (gv) { /* Autoloaded... */
2401 cv = MUTABLE_CV(gv);
2404 amt.table[i]=MUTABLE_CV(SvREFCNT_inc_simple(cv));
2407 AMT_AMAGIC_on(&amt);
2408 sv_magic(MUTABLE_SV(stash), 0, PERL_MAGIC_overload_table,
2409 (char*)&amt, sizeof(AMT));
2413 /* Here we have no table: */
2415 AMT_AMAGIC_off(&amt);
2416 sv_magic(MUTABLE_SV(stash), 0, PERL_MAGIC_overload_table,
2417 (char*)&amt, sizeof(AMTS));
2423 Perl_gv_handler(pTHX_ HV *stash, I32 id)
2429 struct mro_meta* stash_meta;
2431 if (!stash || !HvNAME_get(stash))
2434 stash_meta = HvMROMETA(stash);
2435 newgen = PL_sub_generation + stash_meta->pkg_gen + stash_meta->cache_gen;
2437 mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
2440 if (Gv_AMupdate(stash, 0) == -1)
2442 mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
2445 amtp = (AMT*)mg->mg_ptr;
2446 if ( amtp->was_ok_sub != newgen )
2448 if (AMT_AMAGIC(amtp)) {
2449 CV * const ret = amtp->table[id];
2450 if (ret && isGV(ret)) { /* Autoloading stab */
2451 /* Passing it through may have resulted in a warning
2452 "Inherited AUTOLOAD for a non-method deprecated", since
2453 our caller is going through a function call, not a method call.
2454 So return the CV for AUTOLOAD, setting $AUTOLOAD. */
2455 GV * const gv = gv_fetchmethod(stash, PL_AMG_names[id]);
2467 /* Implement tryAMAGICun_MG macro.
2468 Do get magic, then see if the stack arg is overloaded and if so call it.
2470 AMGf_set return the arg using SETs rather than assigning to
2472 AMGf_numeric apply sv_2num to the stack arg.
2476 Perl_try_amagic_un(pTHX_ int method, int flags) {
2480 SV* const arg = TOPs;
2484 if (SvAMAGIC(arg) && (tmpsv = amagic_call(arg, &PL_sv_undef, method,
2485 AMGf_noright | AMGf_unary))) {
2486 if (flags & AMGf_set) {
2491 if (SvPADMY(TARG)) {
2492 sv_setsv(TARG, tmpsv);
2502 if ((flags & AMGf_numeric) && SvROK(arg))
2508 /* Implement tryAMAGICbin_MG macro.
2509 Do get magic, then see if the two stack args are overloaded and if so
2512 AMGf_set return the arg using SETs rather than assigning to
2514 AMGf_assign op may be called as mutator (eg +=)
2515 AMGf_numeric apply sv_2num to the stack arg.
2519 Perl_try_amagic_bin(pTHX_ int method, int flags) {
2522 SV* const left = TOPm1s;
2523 SV* const right = TOPs;
2529 if (SvAMAGIC(left) || SvAMAGIC(right)) {
2530 SV * const tmpsv = amagic_call(left, right, method,
2531 ((flags & AMGf_assign) && opASSIGN ? AMGf_assign: 0));
2533 if (flags & AMGf_set) {
2540 if (opASSIGN || SvPADMY(TARG)) {
2541 sv_setsv(TARG, tmpsv);
2551 if(left==right && SvGMAGICAL(left)) {
2552 SV * const left = sv_newmortal();
2554 /* Print the uninitialized warning now, so it includes the vari-
2557 if (ckWARN(WARN_UNINITIALIZED)) report_uninit(right);
2558 sv_setsv_flags(left, &PL_sv_no, 0);
2560 else sv_setsv_flags(left, right, 0);
2563 if (flags & AMGf_numeric) {
2565 *(sp-1) = sv_2num(TOPm1s);
2567 *sp = sv_2num(right);
2573 Perl_amagic_deref_call(pTHX_ SV *ref, int method) {
2576 PERL_ARGS_ASSERT_AMAGIC_DEREF_CALL;
2578 while (SvAMAGIC(ref) &&
2579 (tmpsv = amagic_call(ref, &PL_sv_undef, method,
2580 AMGf_noright | AMGf_unary))) {
2582 Perl_croak(aTHX_ "Overloaded dereference did not return a reference");
2583 if (tmpsv == ref || SvRV(tmpsv) == SvRV(ref)) {
2584 /* Bail out if it returns us the same reference. */
2589 return tmpsv ? tmpsv : ref;
2593 Perl_amagic_is_enabled(pTHX_ int method)
2595 SV *lex_mask = cop_hints_fetch_pvs(PL_curcop, "overloading", 0);
2597 assert(PL_curcop->cop_hints & HINT_NO_AMAGIC);
2599 if ( !lex_mask || !SvOK(lex_mask) )
2600 /* overloading lexically disabled */
2602 else if ( lex_mask && SvPOK(lex_mask) ) {
2603 /* we have an entry in the hints hash, check if method has been
2604 * masked by overloading.pm */
2606 const int offset = method / 8;
2607 const int bit = method % 8;
2608 char *pv = SvPV(lex_mask, len);
2610 /* Bit set, so this overloading operator is disabled */
2611 if ( (STRLEN)offset < len && pv[offset] & ( 1 << bit ) )
2618 Perl_amagic_call(pTHX_ SV *left, SV *right, int method, int flags)
2623 CV **cvp=NULL, **ocvp=NULL;
2624 AMT *amtp=NULL, *oamtp=NULL;
2625 int off = 0, off1, lr = 0, notfound = 0;
2626 int postpr = 0, force_cpy = 0;
2627 int assign = AMGf_assign & flags;
2628 const int assignshift = assign ? 1 : 0;
2629 int use_default_op = 0;
2630 int force_scalar = 0;
2636 PERL_ARGS_ASSERT_AMAGIC_CALL;
2638 if ( PL_curcop->cop_hints & HINT_NO_AMAGIC ) {
2639 if (!amagic_is_enabled(method)) return NULL;
2642 if (!(AMGf_noleft & flags) && SvAMAGIC(left)
2643 && (stash = SvSTASH(SvRV(left))) && Gv_AMG(stash)
2644 && (mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table))
2645 && (ocvp = cvp = (AMT_AMAGIC((AMT*)mg->mg_ptr)
2646 ? (oamtp = amtp = (AMT*)mg->mg_ptr)->table
2648 && ((cv = cvp[off=method+assignshift])
2649 || (assign && amtp->fallback > AMGfallNEVER && /* fallback to
2655 cv = cvp[off=method])))) {
2656 lr = -1; /* Call method for left argument */
2658 if (cvp && amtp->fallback > AMGfallNEVER && flags & AMGf_unary) {
2661 /* look for substituted methods */
2662 /* In all the covered cases we should be called with assign==0. */
2666 if ((cv = cvp[off=add_ass_amg])
2667 || ((cv = cvp[off = add_amg]) && (force_cpy = 0, postpr = 1))) {
2668 right = &PL_sv_yes; lr = -1; assign = 1;
2673 if ((cv = cvp[off = subtr_ass_amg])
2674 || ((cv = cvp[off = subtr_amg]) && (force_cpy = 0, postpr=1))) {
2675 right = &PL_sv_yes; lr = -1; assign = 1;
2679 (void)((cv = cvp[off=numer_amg]) || (cv = cvp[off=string_amg]));
2682 (void)((cv = cvp[off=string_amg]) || (cv = cvp[off=bool__amg]));
2685 (void)((cv = cvp[off=numer_amg]) || (cv = cvp[off=bool__amg]));
2688 (void)((cv = cvp[off=bool__amg])
2689 || (cv = cvp[off=numer_amg])
2690 || (cv = cvp[off=string_amg]));
2697 * SV* ref causes confusion with the interpreter variable of
2700 SV* const tmpRef=SvRV(left);
2701 if (!SvROK(tmpRef) && SvTYPE(tmpRef) <= SVt_PVMG) {
2703 * Just to be extra cautious. Maybe in some
2704 * additional cases sv_setsv is safe, too.
2706 SV* const newref = newSVsv(tmpRef);
2707 SvOBJECT_on(newref);
2708 /* No need to do SvAMAGIC_on here, as SvAMAGIC macros
2709 delegate to the stash. */
2710 SvSTASH_set(newref, MUTABLE_HV(SvREFCNT_inc(SvSTASH(tmpRef))));
2716 if ((cvp[off1=lt_amg] || cvp[off1=ncmp_amg])
2717 && ((cv = cvp[off=neg_amg]) || (cv = cvp[off=subtr_amg]))) {
2718 SV* const nullsv=sv_2mortal(newSViv(0));
2720 SV* const lessp = amagic_call(left,nullsv,
2721 lt_amg,AMGf_noright);
2722 logic = SvTRUE(lessp);
2724 SV* const lessp = amagic_call(left,nullsv,
2725 ncmp_amg,AMGf_noright);
2726 logic = (SvNV(lessp) < 0);
2729 if (off==subtr_amg) {
2740 if ((cv = cvp[off=subtr_amg])) {
2742 left = sv_2mortal(newSViv(0));
2747 case iter_amg: /* XXXX Eventually should do to_gv. */
2748 case ftest_amg: /* XXXX Eventually should do to_gv. */
2751 return NULL; /* Delegate operation to standard mechanisms. */
2759 return left; /* Delegate operation to standard mechanisms. */
2764 if (!cv) goto not_found;
2765 } else if (!(AMGf_noright & flags) && SvAMAGIC(right)
2766 && (stash = SvSTASH(SvRV(right))) && Gv_AMG(stash)
2767 && (mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table))
2768 && (cvp = (AMT_AMAGIC((AMT*)mg->mg_ptr)
2769 ? (amtp = (AMT*)mg->mg_ptr)->table
2771 && (cv = cvp[off=method])) { /* Method for right
2774 } else if (((cvp && amtp->fallback > AMGfallNEVER)
2775 || (ocvp && oamtp->fallback > AMGfallNEVER))
2776 && !(flags & AMGf_unary)) {
2777 /* We look for substitution for
2778 * comparison operations and
2780 if (method==concat_amg || method==concat_ass_amg
2781 || method==repeat_amg || method==repeat_ass_amg) {
2782 return NULL; /* Delegate operation to string conversion */
2804 if (ocvp && (oamtp->fallback > AMGfallNEVER)) {
2808 if (!cv && (cvp && amtp->fallback > AMGfallNEVER)) {
2818 not_found: /* No method found, either report or croak */
2826 return left; /* Delegate operation to standard mechanisms. */
2829 if (ocvp && (cv=ocvp[nomethod_amg])) { /* Call report method */
2830 notfound = 1; lr = -1;
2831 } else if (cvp && (cv=cvp[nomethod_amg])) {
2832 notfound = 1; lr = 1;
2833 } else if ((use_default_op =
2834 (!ocvp || oamtp->fallback >= AMGfallYES)
2835 && (!cvp || amtp->fallback >= AMGfallYES))
2837 /* Skip generating the "no method found" message. */
2841 if (off==-1) off=method;
2842 msg = sv_2mortal(Perl_newSVpvf(aTHX_
2843 "Operation \"%s\": no method found,%sargument %s%"SVf"%s%"SVf,
2844 AMG_id2name(method + assignshift),
2845 (flags & AMGf_unary ? " " : "\n\tleft "),
2847 "in overloaded package ":
2848 "has no overloaded magic",
2850 SVfARG(sv_2mortal(newSVhek(HvNAME_HEK(SvSTASH(SvRV(left)))))):
2853 ",\n\tright argument in overloaded package ":
2856 : ",\n\tright argument has no overloaded magic"),
2858 SVfARG(sv_2mortal(newSVhek(HvNAME_HEK(SvSTASH(SvRV(right)))))):
2859 SVfARG(&PL_sv_no)));
2860 if (use_default_op) {
2861 DEBUG_o( Perl_deb(aTHX_ "%"SVf, SVfARG(msg)) );
2863 Perl_croak(aTHX_ "%"SVf, SVfARG(msg));
2867 force_cpy = force_cpy || assign;
2872 /* in these cases, we're calling '+' or '-' as a fallback for a ++ or --
2873 * operation. we need this to return a value, so that it can be assigned
2874 * later on, in the postpr block (case inc_amg/dec_amg), even if the
2875 * increment or decrement was itself called in void context */
2881 if (off == subtr_amg)
2884 /* in these cases, we're calling an assignment variant of an operator
2885 * (+= rather than +, for instance). regardless of whether it's a
2886 * fallback or not, it always has to return a value, which will be
2887 * assigned to the proper variable later */
2904 /* the copy constructor always needs to return a value */
2908 /* because of the way these are implemented (they don't perform the
2909 * dereferencing themselves, they return a reference that perl then
2910 * dereferences later), they always have to be in scalar context */
2918 /* these don't have an op of their own; they're triggered by their parent
2919 * op, so the context there isn't meaningful ('$a and foo()' in void
2920 * context still needs to pass scalar context on to $a's bool overload) */
2930 DEBUG_o(Perl_deb(aTHX_
2931 "Overloaded operator \"%s\"%s%s%s:\n\tmethod%s found%s in package %"SVf"%s\n",
2933 method+assignshift==off? "" :
2935 method+assignshift==off? "" :
2936 AMG_id2name(method+assignshift),
2937 method+assignshift==off? "" : "\")",
2938 flags & AMGf_unary? "" :
2939 lr==1 ? " for right argument": " for left argument",
2940 flags & AMGf_unary? " for argument" : "",
2941 stash ? SVfARG(sv_2mortal(newSVhek(HvNAME_HEK(stash)))) : SVfARG(newSVpvs_flags("null", SVs_TEMP)),
2942 fl? ",\n\tassignment variant used": "") );
2945 /* Since we use shallow copy during assignment, we need
2946 * to dublicate the contents, probably calling user-supplied
2947 * version of copy operator
2949 /* We need to copy in following cases:
2950 * a) Assignment form was called.
2951 * assignshift==1, assign==T, method + 1 == off
2952 * b) Increment or decrement, called directly.
2953 * assignshift==0, assign==0, method + 0 == off
2954 * c) Increment or decrement, translated to assignment add/subtr.
2955 * assignshift==0, assign==T,
2957 * d) Increment or decrement, translated to nomethod.
2958 * assignshift==0, assign==0,
2960 * e) Assignment form translated to nomethod.
2961 * assignshift==1, assign==T, method + 1 != off
2964 /* off is method, method+assignshift, or a result of opcode substitution.
2965 * In the latter case assignshift==0, so only notfound case is important.
2967 if ( (lr == -1) && ( ( (method + assignshift == off)
2968 && (assign || (method == inc_amg) || (method == dec_amg)))
2971 /* newSVsv does not behave as advertised, so we copy missing
2972 * information by hand */
2973 SV *tmpRef = SvRV(left);
2975 if (SvREFCNT(tmpRef) > 1 && (rv_copy = AMG_CALLunary(left,copy_amg))) {
2976 SvRV_set(left, rv_copy);
2978 SvREFCNT_dec_NN(tmpRef);
2986 const bool oldcatch = CATCH_GET;
2988 int gimme = force_scalar ? G_SCALAR : GIMME_V;
2991 Zero(&myop, 1, BINOP);
2992 myop.op_last = (OP *) &myop;
2993 myop.op_next = NULL;
2994 myop.op_flags = OPf_STACKED;
2998 myop.op_flags |= OPf_WANT_VOID;
3001 if (flags & AMGf_want_list) {
3002 myop.op_flags |= OPf_WANT_LIST;
3007 myop.op_flags |= OPf_WANT_SCALAR;
3011 PUSHSTACKi(PERLSI_OVERLOAD);
3014 PL_op = (OP *) &myop;
3015 if (PERLDB_SUB && PL_curstash != PL_debstash)
3016 PL_op->op_private |= OPpENTERSUB_DB;
3018 Perl_pp_pushmark(aTHX);
3020 EXTEND(SP, notfound + 5);
3021 PUSHs(lr>0? right: left);
3022 PUSHs(lr>0? left: right);
3023 PUSHs( lr > 0 ? &PL_sv_yes : ( assign ? &PL_sv_undef : &PL_sv_no ));
3025 PUSHs(newSVpvn_flags(AMG_id2name(method + assignshift),
3026 AMG_id2namelen(method + assignshift), SVs_TEMP));
3028 PUSHs(MUTABLE_SV(cv));
3032 if ((PL_op = PL_ppaddr[OP_ENTERSUB](aTHX)))
3036 nret = SP - (PL_stack_base + oldmark);
3040 /* returning NULL has another meaning, and we check the context
3041 * at the call site too, so this can be differentiated from the
3044 SP = PL_stack_base + oldmark;
3047 if (flags & AMGf_want_list) {
3048 res = sv_2mortal((SV *)newAV());
3049 av_extend((AV *)res, nret);
3051 av_store((AV *)res, nret, POPs);
3063 CATCH_SET(oldcatch);
3070 ans=SvIV(res)<=0; break;
3073 ans=SvIV(res)<0; break;
3076 ans=SvIV(res)>=0; break;
3079 ans=SvIV(res)>0; break;
3082 ans=SvIV(res)==0; break;
3085 ans=SvIV(res)!=0; break;
3088 SvSetSV(left,res); return left;
3090 ans=!SvTRUE(res); break;
3095 } else if (method==copy_amg) {
3097 Perl_croak(aTHX_ "Copy method did not return a reference");
3099 return SvREFCNT_inc(SvRV(res));
3107 Perl_gv_name_set(pTHX_ GV *gv, const char *name, U32 len, U32 flags)
3112 PERL_ARGS_ASSERT_GV_NAME_SET;
3115 Perl_croak(aTHX_ "panic: gv name too long (%"UVuf")", (UV) len);
3117 if (!(flags & GV_ADD) && GvNAME_HEK(gv)) {
3118 unshare_hek(GvNAME_HEK(gv));
3121 PERL_HASH(hash, name, len);
3122 GvNAME_HEK(gv) = share_hek(name, (flags & SVf_UTF8 ? -(I32)len : (I32)len), hash);
3126 =for apidoc gv_try_downgrade
3128 If the typeglob C<gv> can be expressed more succinctly, by having
3129 something other than a real GV in its place in the stash, replace it
3130 with the optimised form. Basic requirements for this are that C<gv>
3131 is a real typeglob, is sufficiently ordinary, and is only referenced
3132 from its package. This function is meant to be used when a GV has been
3133 looked up in part to see what was there, causing upgrading, but based
3134 on what was found it turns out that the real GV isn't required after all.
3136 If C<gv> is a completely empty typeglob, it is deleted from the stash.
3138 If C<gv> is a typeglob containing only a sufficiently-ordinary constant
3139 sub, the typeglob is replaced with a scalar-reference placeholder that
3140 more compactly represents the same thing.
3146 Perl_gv_try_downgrade(pTHX_ GV *gv)
3152 PERL_ARGS_ASSERT_GV_TRY_DOWNGRADE;
3154 /* XXX Why and where does this leave dangling pointers during global
3156 if (PL_phase == PERL_PHASE_DESTRUCT) return;
3158 if (!(SvREFCNT(gv) == 1 && SvTYPE(gv) == SVt_PVGV && !SvFAKE(gv) &&
3159 !SvOBJECT(gv) && !SvREADONLY(gv) &&
3160 isGV_with_GP(gv) && GvGP(gv) &&
3161 !GvINTRO(gv) && GvREFCNT(gv) == 1 &&
3162 !GvSV(gv) && !GvAV(gv) && !GvHV(gv) && !GvIOp(gv) && !GvFORM(gv) &&
3163 GvEGVx(gv) == gv && (stash = GvSTASH(gv))))
3165 if (SvMAGICAL(gv)) {
3167 /* only backref magic is allowed */
3168 if (SvGMAGICAL(gv) || SvSMAGICAL(gv))
3170 for (mg = SvMAGIC(gv); mg; mg = mg->mg_moremagic) {
3171 if (mg->mg_type != PERL_MAGIC_backref)
3177 HEK *gvnhek = GvNAME_HEK(gv);
3178 (void)hv_delete(stash, HEK_KEY(gvnhek),
3179 HEK_UTF8(gvnhek) ? -HEK_LEN(gvnhek) : HEK_LEN(gvnhek), G_DISCARD);
3180 } else if (GvMULTI(gv) && cv &&
3181 !SvOBJECT(cv) && !SvMAGICAL(cv) && !SvREADONLY(cv) &&
3182 CvSTASH(cv) == stash && CvGV(cv) == gv &&
3183 CvCONST(cv) && !CvMETHOD(cv) && !CvLVALUE(cv) && !CvUNIQUE(cv) &&
3184 !CvNODEBUG(cv) && !CvCLONE(cv) && !CvCLONED(cv) && !CvANON(cv) &&
3185 (namehek = GvNAME_HEK(gv)) &&
3186 (gvp = hv_fetch(stash, HEK_KEY(namehek),
3187 HEK_LEN(namehek)*(HEK_UTF8(namehek) ? -1 : 1), 0)) &&
3189 SV *value = SvREFCNT_inc(CvXSUBANY(cv).any_ptr);
3193 SvFLAGS(gv) = SVt_IV|SVf_ROK;
3194 SvANY(gv) = (XPVGV*)((char*)&(gv->sv_u.svu_iv) -
3195 STRUCT_OFFSET(XPVIV, xiv_iv));
3196 SvRV_set(gv, value);
3203 core_xsub(pTHX_ CV* cv)
3206 "&CORE::%s cannot be called directly", GvNAME(CvGV(cv))
3212 * c-indentation-style: bsd
3214 * indent-tabs-mode: nil
3217 * ex: set ts=8 sts=4 sw=4 et: