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.
40 static const char S_autoload[] = "AUTOLOAD";
41 static const STRLEN S_autolen = sizeof(S_autoload)-1;
44 Perl_gv_add_by_type(pTHX_ GV *gv, svtype type)
51 SvTYPE((const SV *)gv) != SVt_PVGV
52 && SvTYPE((const SV *)gv) != SVt_PVLV
56 if (type == SVt_PVIO) {
58 * if it walks like a dirhandle, then let's assume that
59 * this is a dirhandle.
61 what = PL_op->op_type == OP_READDIR ||
62 PL_op->op_type == OP_TELLDIR ||
63 PL_op->op_type == OP_SEEKDIR ||
64 PL_op->op_type == OP_REWINDDIR ||
65 PL_op->op_type == OP_CLOSEDIR ?
66 "dirhandle" : "filehandle";
67 /* diag_listed_as: Bad symbol for filehandle */
68 } else if (type == SVt_PVHV) {
71 what = type == SVt_PVAV ? "array" : "scalar";
73 Perl_croak(aTHX_ "Bad symbol for %s", what);
76 if (type == SVt_PVHV) {
77 where = (SV **)&GvHV(gv);
78 } else if (type == SVt_PVAV) {
79 where = (SV **)&GvAV(gv);
80 } else if (type == SVt_PVIO) {
81 where = (SV **)&GvIOp(gv);
87 *where = newSV_type(type);
92 Perl_gv_fetchfile(pTHX_ const char *name)
94 PERL_ARGS_ASSERT_GV_FETCHFILE;
95 return gv_fetchfile_flags(name, strlen(name), 0);
99 Perl_gv_fetchfile_flags(pTHX_ const char *const name, const STRLEN namelen,
105 const STRLEN tmplen = namelen + 2;
108 PERL_ARGS_ASSERT_GV_FETCHFILE_FLAGS;
109 PERL_UNUSED_ARG(flags);
114 if (tmplen <= sizeof smallbuf)
117 Newx(tmpbuf, tmplen, char);
118 /* This is where the debugger's %{"::_<$filename"} hash is created */
121 memcpy(tmpbuf + 2, name, namelen);
122 gv = *(GV**)hv_fetch(PL_defstash, tmpbuf, tmplen, TRUE);
124 gv_init(gv, PL_defstash, tmpbuf, tmplen, FALSE);
125 #ifdef PERL_DONT_CREATE_GVSV
126 GvSV(gv) = newSVpvn(name, namelen);
128 sv_setpvn(GvSV(gv), name, namelen);
131 if ((PERLDB_LINE || PERLDB_SAVESRC) && !GvAV(gv))
132 hv_magic(GvHVn(gv_AVadd(gv)), NULL, PERL_MAGIC_dbfile);
133 if (tmpbuf != smallbuf)
139 =for apidoc gv_const_sv
141 If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
142 inlining, or C<gv> is a placeholder reference that would be promoted to such
143 a typeglob, then returns the value returned by the sub. Otherwise, returns
150 Perl_gv_const_sv(pTHX_ GV *gv)
152 PERL_ARGS_ASSERT_GV_CONST_SV;
154 if (SvTYPE(gv) == SVt_PVGV)
155 return cv_const_sv(GvCVu(gv));
156 return SvROK(gv) ? SvRV(gv) : NULL;
160 Perl_newGP(pTHX_ GV *const gv)
165 const char *const file
166 = (PL_curcop && CopFILE(PL_curcop)) ? CopFILE(PL_curcop) : "";
167 const STRLEN len = strlen(file);
169 SV *const temp_sv = CopFILESV(PL_curcop);
173 PERL_ARGS_ASSERT_NEWGP;
176 file = SvPVX(temp_sv);
177 len = SvCUR(temp_sv);
184 PERL_HASH(hash, file, len);
188 #ifndef PERL_DONT_CREATE_GVSV
189 gp->gp_sv = newSV(0);
192 gp->gp_line = PL_curcop ? CopLINE(PL_curcop) : 0;
193 /* XXX Ideally this cast would be replaced with a change to const char*
195 gp->gp_file_hek = share_hek(file, len, hash);
202 /* Assign CvGV(cv) = gv, handling weak references.
203 * See also S_anonymise_cv_maybe */
206 Perl_cvgv_set(pTHX_ CV* cv, GV* gv)
208 GV * const oldgv = CvGV(cv);
209 PERL_ARGS_ASSERT_CVGV_SET;
220 sv_del_backref(MUTABLE_SV(oldgv), MUTABLE_SV(cv));
224 SvANY(cv)->xcv_gv = gv;
225 assert(!CvCVGV_RC(cv));
230 if (isGV_with_GP(gv) && GvGP(gv) && (GvCV(gv) == cv || GvFORM(gv) == cv))
231 Perl_sv_add_backref(aTHX_ MUTABLE_SV(gv), MUTABLE_SV(cv));
234 SvREFCNT_inc_simple_void_NN(gv);
238 /* Assign CvSTASH(cv) = st, handling weak references. */
241 Perl_cvstash_set(pTHX_ CV *cv, HV *st)
243 HV *oldst = CvSTASH(cv);
244 PERL_ARGS_ASSERT_CVSTASH_SET;
248 sv_del_backref(MUTABLE_SV(oldst), MUTABLE_SV(cv));
249 SvANY(cv)->xcv_stash = st;
251 Perl_sv_add_backref(aTHX_ MUTABLE_SV(st), MUTABLE_SV(cv));
255 Perl_gv_init(pTHX_ GV *gv, HV *stash, const char *name, STRLEN len, int multi)
258 const U32 old_type = SvTYPE(gv);
259 const bool doproto = old_type > SVt_NULL;
260 char * const proto = (doproto && SvPOK(gv)) ? SvPVX(gv) : NULL;
261 const STRLEN protolen = proto ? SvCUR(gv) : 0;
262 SV *const has_constant = doproto && SvROK(gv) ? SvRV(gv) : NULL;
263 const U32 exported_constant = has_constant ? SvPCS_IMPORTED(gv) : 0;
265 PERL_ARGS_ASSERT_GV_INIT;
266 assert (!(proto && has_constant));
269 /* The constant has to be a simple scalar type. */
270 switch (SvTYPE(has_constant)) {
276 Perl_croak(aTHX_ "Cannot convert a reference to %s to typeglob",
277 sv_reftype(has_constant, 0));
285 if (old_type < SVt_PVGV) {
286 if (old_type >= SVt_PV)
288 sv_upgrade(MUTABLE_SV(gv), SVt_PVGV);
296 Safefree(SvPVX_mutable(gv));
301 GvGP(gv) = Perl_newGP(aTHX_ gv);
304 Perl_sv_add_backref(aTHX_ MUTABLE_SV(stash), MUTABLE_SV(gv));
305 gv_name_set(gv, name, len, GV_ADD);
306 if (multi || doproto) /* doproto means it _was_ mentioned */
308 if (doproto) { /* Replicate part of newSUB here. */
314 /* newCONSTSUB doesn't take a len arg, so make sure we
315 * give it a \0-terminated string */
316 name0 = savepvn(name,len);
318 /* newCONSTSUB takes ownership of the reference from us. */
319 cv = newCONSTSUB(stash, (name0 ? name0 : name), has_constant);
320 /* In case op.c:S_process_special_blocks stole it: */
322 GvCV(gv) = (CV *)SvREFCNT_inc_simple_NN(cv);
323 assert(GvCV(gv) == cv); /* newCONSTSUB should have set this */
326 /* If this reference was a copy of another, then the subroutine
327 must have been "imported", by a Perl space assignment to a GV
328 from a reference to CV. */
329 if (exported_constant)
330 GvIMPORTED_CV_on(gv);
332 (void) start_subparse(0,0); /* Create empty CV in compcv. */
338 mro_method_changed_in(GvSTASH(gv)); /* sub Foo::bar($) { (shift) } sub ASDF::baz($); *ASDF::baz = \&Foo::bar */
340 CvFILE_set_from_cop(cv, PL_curcop);
341 CvSTASH_set(cv, PL_curstash);
343 sv_usepvn_flags(MUTABLE_SV(cv), proto, protolen,
344 SV_HAS_TRAILING_NUL);
350 S_gv_init_sv(pTHX_ GV *gv, const svtype sv_type)
352 PERL_ARGS_ASSERT_GV_INIT_SV;
364 #ifdef PERL_DONT_CREATE_GVSV
372 /* Work round what appears to be a bug in Sun C++ 5.8 2005/10/13
373 If we just cast GvSVn(gv) to void, it ignores evaluating it for
381 =for apidoc gv_fetchmeth
383 Returns the glob with the given C<name> and a defined subroutine or
384 C<NULL>. The glob lives in the given C<stash>, or in the stashes
385 accessible via @ISA and UNIVERSAL::.
387 The argument C<level> should be either 0 or -1. If C<level==0>, as a
388 side-effect creates a glob with the given C<name> in the given C<stash>
389 which in the case of success contains an alias for the subroutine, and sets
390 up caching info for this glob.
392 This function grants C<"SUPER"> token as a postfix of the stash name. The
393 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
394 visible to Perl code. So when calling C<call_sv>, you should not use
395 the GV directly; instead, you should use the method's CV, which can be
396 obtained from the GV with the C<GvCV> macro.
401 /* NOTE: No support for tied ISA */
404 Perl_gv_fetchmeth(pTHX_ HV *stash, const char *name, STRLEN len, I32 level)
412 GV* candidate = NULL;
417 I32 create = (level >= 0) ? 1 : 0;
422 PERL_ARGS_ASSERT_GV_FETCHMETH;
424 /* UNIVERSAL methods should be callable without a stash */
426 create = 0; /* probably appropriate */
427 if(!(stash = gv_stashpvs("UNIVERSAL", 0)))
433 hvname = HvNAME_get(stash);
435 Perl_croak(aTHX_ "Can't use anonymous symbol table for method lookup");
440 DEBUG_o( Perl_deb(aTHX_ "Looking for method %s in package %s\n",name,hvname) );
442 topgen_cmp = HvMROMETA(stash)->cache_gen + PL_sub_generation;
444 /* check locally for a real method or a cache entry */
445 gvp = (GV**)hv_fetch(stash, name, len, create);
449 if (SvTYPE(topgv) != SVt_PVGV)
450 gv_init(topgv, stash, name, len, TRUE);
451 if ((cand_cv = GvCV(topgv))) {
452 /* If genuine method or valid cache entry, use it */
453 if (!GvCVGEN(topgv) || GvCVGEN(topgv) == topgen_cmp) {
457 /* stale cache entry, junk it and move on */
458 SvREFCNT_dec(cand_cv);
459 GvCV(topgv) = cand_cv = NULL;
463 else if (GvCVGEN(topgv) == topgen_cmp) {
464 /* cache indicates no such method definitively */
469 packlen = HvNAMELEN_get(stash);
470 if (packlen >= 7 && strEQ(hvname + packlen - 7, "::SUPER")) {
473 basestash = gv_stashpvn(hvname, packlen, GV_ADD);
474 linear_av = mro_get_linear_isa(basestash);
477 linear_av = mro_get_linear_isa(stash); /* has ourselves at the top of the list */
480 linear_svp = AvARRAY(linear_av) + 1; /* skip over self */
481 items = AvFILLp(linear_av); /* no +1, to skip over self */
483 linear_sv = *linear_svp++;
485 cstash = gv_stashsv(linear_sv, 0);
488 Perl_ck_warner(aTHX_ packWARN(WARN_SYNTAX), "Can't locate package %"SVf" for @%s::ISA",
489 SVfARG(linear_sv), hvname);
495 gvp = (GV**)hv_fetch(cstash, name, len, 0);
499 if (SvTYPE(candidate) != SVt_PVGV) gv_init(candidate, cstash, name, len, TRUE);
500 if (SvTYPE(candidate) == SVt_PVGV && (cand_cv = GvCV(candidate)) && !GvCVGEN(candidate)) {
502 * Found real method, cache method in topgv if:
503 * 1. topgv has no synonyms (else inheritance crosses wires)
504 * 2. method isn't a stub (else AUTOLOAD fails spectacularly)
506 if (topgv && (GvREFCNT(topgv) == 1) && (CvROOT(cand_cv) || CvXSUB(cand_cv))) {
507 if ((old_cv = GvCV(topgv))) SvREFCNT_dec(old_cv);
508 SvREFCNT_inc_simple_void_NN(cand_cv);
509 GvCV(topgv) = cand_cv;
510 GvCVGEN(topgv) = topgen_cmp;
516 /* Check UNIVERSAL without caching */
517 if(level == 0 || level == -1) {
518 candidate = gv_fetchmeth(NULL, name, len, 1);
520 cand_cv = GvCV(candidate);
521 if (topgv && (GvREFCNT(topgv) == 1) && (CvROOT(cand_cv) || CvXSUB(cand_cv))) {
522 if ((old_cv = GvCV(topgv))) SvREFCNT_dec(old_cv);
523 SvREFCNT_inc_simple_void_NN(cand_cv);
524 GvCV(topgv) = cand_cv;
525 GvCVGEN(topgv) = topgen_cmp;
531 if (topgv && GvREFCNT(topgv) == 1) {
532 /* cache the fact that the method is not defined */
533 GvCVGEN(topgv) = topgen_cmp;
540 =for apidoc gv_fetchmeth_autoload
542 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
543 Returns a glob for the subroutine.
545 For an autoloaded subroutine without a GV, will create a GV even
546 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
547 of the result may be zero.
553 Perl_gv_fetchmeth_autoload(pTHX_ HV *stash, const char *name, STRLEN len, I32 level)
555 GV *gv = gv_fetchmeth(stash, name, len, level);
557 PERL_ARGS_ASSERT_GV_FETCHMETH_AUTOLOAD;
564 return NULL; /* UNIVERSAL::AUTOLOAD could cause trouble */
565 if (len == S_autolen && memEQ(name, S_autoload, S_autolen))
567 if (!(gv = gv_fetchmeth(stash, S_autoload, S_autolen, FALSE)))
570 if (!(CvROOT(cv) || CvXSUB(cv)))
572 /* Have an autoload */
573 if (level < 0) /* Cannot do without a stub */
574 gv_fetchmeth(stash, name, len, 0);
575 gvp = (GV**)hv_fetch(stash, name, len, (level >= 0));
584 =for apidoc gv_fetchmethod_autoload
586 Returns the glob which contains the subroutine to call to invoke the method
587 on the C<stash>. In fact in the presence of autoloading this may be the
588 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
591 The third parameter of C<gv_fetchmethod_autoload> determines whether
592 AUTOLOAD lookup is performed if the given method is not present: non-zero
593 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
594 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
595 with a non-zero C<autoload> parameter.
597 These functions grant C<"SUPER"> token as a prefix of the method name. Note
598 that if you want to keep the returned glob for a long time, you need to
599 check for it being "AUTOLOAD", since at the later time the call may load a
600 different subroutine due to $AUTOLOAD changing its value. Use the glob
601 created via a side effect to do this.
603 These functions have the same side-effects and as C<gv_fetchmeth> with
604 C<level==0>. C<name> should be writable if contains C<':'> or C<'
605 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
606 C<call_sv> apply equally to these functions.
612 S_gv_get_super_pkg(pTHX_ const char* name, I32 namelen)
619 PERL_ARGS_ASSERT_GV_GET_SUPER_PKG;
621 stash = gv_stashpvn(name, namelen, 0);
622 if(stash) return stash;
624 /* If we must create it, give it an @ISA array containing
625 the real package this SUPER is for, so that it's tied
626 into the cache invalidation code correctly */
627 stash = gv_stashpvn(name, namelen, GV_ADD);
628 gvp = (GV**)hv_fetchs(stash, "ISA", TRUE);
630 gv_init(gv, stash, "ISA", 3, TRUE);
631 superisa = GvAVn(gv);
633 sv_magic(MUTABLE_SV(superisa), MUTABLE_SV(gv), PERL_MAGIC_isa, NULL, 0);
635 av_push(superisa, newSVpv(CopSTASHPV(PL_curcop), 0));
637 av_push(superisa, newSVhek(CopSTASH(PL_curcop)
638 ? HvNAME_HEK(CopSTASH(PL_curcop)) : NULL));
645 Perl_gv_fetchmethod_autoload(pTHX_ HV *stash, const char *name, I32 autoload)
647 PERL_ARGS_ASSERT_GV_FETCHMETHOD_AUTOLOAD;
649 return gv_fetchmethod_flags(stash, name, autoload ? GV_AUTOLOAD : 0);
652 /* Don't merge this yet, as it's likely to get a len parameter, and possibly
655 Perl_gv_fetchmethod_flags(pTHX_ HV *stash, const char *name, U32 flags)
658 register const char *nend;
659 const char *nsplit = NULL;
662 const char * const origname = name;
663 SV *const error_report = MUTABLE_SV(stash);
664 const U32 autoload = flags & GV_AUTOLOAD;
665 const U32 do_croak = flags & GV_CROAK;
667 PERL_ARGS_ASSERT_GV_FETCHMETHOD_FLAGS;
669 if (SvTYPE(stash) < SVt_PVHV)
672 /* The only way stash can become NULL later on is if nsplit is set,
673 which in turn means that there is no need for a SVt_PVHV case
674 the error reporting code. */
677 for (nend = name; *nend; nend++) {
682 else if (*nend == ':' && *(nend + 1) == ':') {
688 if ((nsplit - origname) == 5 && memEQ(origname, "SUPER", 5)) {
689 /* ->SUPER::method should really be looked up in original stash */
690 SV * const tmpstr = sv_2mortal(Perl_newSVpvf(aTHX_ "%s::SUPER",
691 CopSTASHPV(PL_curcop)));
692 /* __PACKAGE__::SUPER stash should be autovivified */
693 stash = gv_get_super_pkg(SvPVX_const(tmpstr), SvCUR(tmpstr));
694 DEBUG_o( Perl_deb(aTHX_ "Treating %s as %s::%s\n",
695 origname, HvNAME_get(stash), name) );
698 /* don't autovifify if ->NoSuchStash::method */
699 stash = gv_stashpvn(origname, nsplit - origname, 0);
701 /* however, explicit calls to Pkg::SUPER::method may
702 happen, and may require autovivification to work */
703 if (!stash && (nsplit - origname) >= 7 &&
704 strnEQ(nsplit - 7, "::SUPER", 7) &&
705 gv_stashpvn(origname, nsplit - origname - 7, 0))
706 stash = gv_get_super_pkg(origname, nsplit - origname);
711 gv = gv_fetchmeth(stash, name, nend - name, 0);
713 if (strEQ(name,"import") || strEQ(name,"unimport"))
714 gv = MUTABLE_GV(&PL_sv_yes);
716 gv = gv_autoload4(ostash, name, nend - name, TRUE);
717 if (!gv && do_croak) {
718 /* Right now this is exclusively for the benefit of S_method_common
722 "Can't locate object method \"%s\" via package \"%.*s\"",
723 name, (int)HvNAMELEN_get(stash), HvNAME_get(stash));
727 const char *packname;
730 packlen = nsplit - origname;
733 packname = SvPV_const(error_report, packlen);
737 "Can't locate object method \"%s\" via package \"%.*s\""
738 " (perhaps you forgot to load \"%.*s\"?)",
739 name, (int)packlen, packname, (int)packlen, packname);
744 CV* const cv = GvCV(gv);
745 if (!CvROOT(cv) && !CvXSUB(cv)) {
753 if (GvCV(stubgv) != cv) /* orphaned import */
756 autogv = gv_autoload4(GvSTASH(stubgv),
757 GvNAME(stubgv), GvNAMELEN(stubgv), TRUE);
767 Perl_gv_autoload4(pTHX_ HV *stash, const char *name, STRLEN len, I32 method)
775 const char *packname = "";
776 STRLEN packname_len = 0;
778 PERL_ARGS_ASSERT_GV_AUTOLOAD4;
780 if (len == S_autolen && memEQ(name, S_autoload, S_autolen))
783 if (SvTYPE(stash) < SVt_PVHV) {
784 packname = SvPV_const(MUTABLE_SV(stash), packname_len);
788 packname = HvNAME_get(stash);
789 packname_len = HvNAMELEN_get(stash);
792 if (!(gv = gv_fetchmeth(stash, S_autoload, S_autolen, FALSE)))
796 if (!(CvROOT(cv) || CvXSUB(cv)))
800 * Inheriting AUTOLOAD for non-methods works ... for now.
802 if (!method && (GvCVGEN(gv) || GvSTASH(gv) != stash)
804 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED),
805 "Use of inherited AUTOLOAD for non-method %s::%.*s() is deprecated",
806 packname, (int)len, name);
809 /* rather than lookup/init $AUTOLOAD here
810 * only to have the XSUB do another lookup for $AUTOLOAD
811 * and split that value on the last '::',
812 * pass along the same data via some unused fields in the CV
814 CvSTASH_set(cv, stash);
815 SvPV_set(cv, (char *)name); /* cast to lose constness warning */
821 * Given &FOO::AUTOLOAD, set $FOO::AUTOLOAD to desired function name.
822 * The subroutine's original name may not be "AUTOLOAD", so we don't
823 * use that, but for lack of anything better we will use the sub's
824 * original package to look up $AUTOLOAD.
826 varstash = GvSTASH(CvGV(cv));
827 vargv = *(GV**)hv_fetch(varstash, S_autoload, S_autolen, TRUE);
831 gv_init(vargv, varstash, S_autoload, S_autolen, FALSE);
832 #ifdef PERL_DONT_CREATE_GVSV
833 GvSV(vargv) = newSV(0);
837 varsv = GvSVn(vargv);
838 sv_setpvn(varsv, packname, packname_len);
839 sv_catpvs(varsv, "::");
840 sv_catpvn(varsv, name, len);
845 /* require_tie_mod() internal routine for requiring a module
846 * that implements the logic of automatical ties like %! and %-
848 * The "gv" parameter should be the glob.
849 * "varpv" holds the name of the var, used for error messages.
850 * "namesv" holds the module name. Its refcount will be decremented.
851 * "methpv" holds the method name to test for to check that things
852 * are working reasonably close to as expected.
853 * "flags": if flag & 1 then save the scalar before loading.
854 * For the protection of $! to work (it is set by this routine)
855 * the sv slot must already be magicalized.
858 S_require_tie_mod(pTHX_ GV *gv, const char *varpv, SV* namesv, const char *methpv,const U32 flags)
861 HV* stash = gv_stashsv(namesv, 0);
863 PERL_ARGS_ASSERT_REQUIRE_TIE_MOD;
865 if (!stash || !(gv_fetchmethod(stash, methpv))) {
866 SV *module = newSVsv(namesv);
867 char varname = *varpv; /* varpv might be clobbered by load_module,
868 so save it. For the moment it's always
874 PUSHSTACKi(PERLSI_MAGIC);
875 Perl_load_module(aTHX_ PERL_LOADMOD_NOIMPORT, module, NULL);
879 stash = gv_stashsv(namesv, 0);
881 Perl_croak(aTHX_ "panic: Can't use %%%c because %"SVf" is not available",
882 varname, SVfARG(namesv));
883 else if (!gv_fetchmethod(stash, methpv))
884 Perl_croak(aTHX_ "panic: Can't use %%%c because %"SVf" does not support method %s",
885 varname, SVfARG(namesv), methpv);
887 SvREFCNT_dec(namesv);
892 =for apidoc gv_stashpv
894 Returns a pointer to the stash for a specified package. Uses C<strlen> to
895 determine the length of C<name>, then calls C<gv_stashpvn()>.
901 Perl_gv_stashpv(pTHX_ const char *name, I32 create)
903 PERL_ARGS_ASSERT_GV_STASHPV;
904 return gv_stashpvn(name, strlen(name), create);
908 =for apidoc gv_stashpvn
910 Returns a pointer to the stash for a specified package. The C<namelen>
911 parameter indicates the length of the C<name>, in bytes. C<flags> is passed
912 to C<gv_fetchpvn_flags()>, so if set to C<GV_ADD> then the package will be
913 created if it does not already exist. If the package does not exist and
914 C<flags> is 0 (or any other setting that does not create packages) then NULL
922 Perl_gv_stashpvn(pTHX_ const char *name, U32 namelen, I32 flags)
928 U32 tmplen = namelen + 2;
930 PERL_ARGS_ASSERT_GV_STASHPVN;
932 if (tmplen <= sizeof smallbuf)
935 Newx(tmpbuf, tmplen, char);
936 Copy(name, tmpbuf, namelen, char);
937 tmpbuf[namelen] = ':';
938 tmpbuf[namelen+1] = ':';
939 tmpgv = gv_fetchpvn_flags(tmpbuf, tmplen, flags, SVt_PVHV);
940 if (tmpbuf != smallbuf)
946 assert(HvNAME_get(stash));
951 =for apidoc gv_stashsv
953 Returns a pointer to the stash for a specified package. See C<gv_stashpvn>.
959 Perl_gv_stashsv(pTHX_ SV *sv, I32 flags)
962 const char * const ptr = SvPV_const(sv,len);
964 PERL_ARGS_ASSERT_GV_STASHSV;
966 return gv_stashpvn(ptr, len, flags);
971 Perl_gv_fetchpv(pTHX_ const char *nambeg, I32 add, const svtype sv_type) {
972 PERL_ARGS_ASSERT_GV_FETCHPV;
973 return gv_fetchpvn_flags(nambeg, strlen(nambeg), add, sv_type);
977 Perl_gv_fetchsv(pTHX_ SV *name, I32 flags, const svtype sv_type) {
979 const char * const nambeg = SvPV_const(name, len);
980 PERL_ARGS_ASSERT_GV_FETCHSV;
981 return gv_fetchpvn_flags(nambeg, len, flags | SvUTF8(name), sv_type);
985 S_gv_magicalize_isa(pTHX_ GV *gv)
989 PERL_ARGS_ASSERT_GV_MAGICALIZE_ISA;
993 sv_magic(MUTABLE_SV(av), MUTABLE_SV(gv), PERL_MAGIC_isa,
998 S_gv_magicalize_overload(pTHX_ GV *gv)
1002 PERL_ARGS_ASSERT_GV_MAGICALIZE_OVERLOAD;
1006 hv_magic(hv, NULL, PERL_MAGIC_overload);
1010 Perl_gv_fetchpvn_flags(pTHX_ const char *nambeg, STRLEN full_len, I32 flags,
1011 const svtype sv_type)
1014 register const char *name = nambeg;
1015 register GV *gv = NULL;
1018 register const char *name_cursor;
1020 const I32 no_init = flags & (GV_NOADD_NOINIT | GV_NOINIT);
1021 const I32 no_expand = flags & GV_NOEXPAND;
1022 const I32 add = flags & ~GV_NOADD_MASK;
1023 const char *const name_end = nambeg + full_len;
1024 const char *const name_em1 = name_end - 1;
1027 PERL_ARGS_ASSERT_GV_FETCHPVN_FLAGS;
1029 if (flags & GV_NOTQUAL) {
1030 /* Caller promised that there is no stash, so we can skip the check. */
1035 if (full_len > 2 && *name == '*' && isALPHA(name[1])) {
1036 /* accidental stringify on a GV? */
1040 for (name_cursor = name; name_cursor < name_end; name_cursor++) {
1041 if ((*name_cursor == ':' && name_cursor < name_em1
1042 && name_cursor[1] == ':')
1043 || (*name_cursor == '\'' && name_cursor[1]))
1046 stash = PL_defstash;
1047 if (!stash || !SvREFCNT(stash)) /* symbol table under destruction */
1050 len = name_cursor - name;
1053 if (*name_cursor == ':') {
1058 Newx(tmpbuf, len+2, char);
1059 Copy(name, tmpbuf, len, char);
1060 tmpbuf[len++] = ':';
1061 tmpbuf[len++] = ':';
1064 gvp = (GV**)hv_fetch(stash, key, len, add);
1065 gv = gvp ? *gvp : NULL;
1066 if (gv && gv != (const GV *)&PL_sv_undef) {
1067 if (SvTYPE(gv) != SVt_PVGV)
1068 gv_init(gv, stash, key, len, (add & GV_ADDMULTI));
1073 Safefree((char *)key);
1074 if (!gv || gv == (const GV *)&PL_sv_undef)
1077 if (!(stash = GvHV(gv)))
1079 stash = GvHV(gv) = newHV();
1080 if (!HvNAME_get(stash)) {
1081 hv_name_set(stash, nambeg, name_cursor-nambeg, 0);
1082 /* If the containing stash has multiple effective
1083 names, see that this one gets them, too. */
1084 if (HvAUX(GvSTASH(gv))->xhv_name_count)
1085 mro_package_moved(stash, NULL, gv, 1);
1088 else if (!HvNAME_get(stash))
1089 hv_name_set(stash, nambeg, name_cursor - nambeg, 0);
1092 if (*name_cursor == ':')
1096 if (name == name_end)
1098 ? gv : MUTABLE_GV(*hv_fetchs(PL_defstash, "main::", TRUE));
1101 len = name_cursor - name;
1103 /* No stash in name, so see how we can default */
1107 if (len && isIDFIRST_lazy(name)) {
1108 bool global = FALSE;
1116 if ((name[0] == 'I' && name[1] == 'N' && name[2] == 'C')
1117 || (name[0] == 'E' && name[1] == 'N' && name[2] == 'V')
1118 || (name[0] == 'S' && name[1] == 'I' && name[2] == 'G'))
1122 if (name[0] == 'A' && name[1] == 'R' && name[2] == 'G'
1127 if (name[0] == 'S' && name[1] == 'T' && name[2] == 'D'
1128 && name[3] == 'I' && name[4] == 'N')
1132 if ((name[0] == 'S' && name[1] == 'T' && name[2] == 'D')
1133 &&((name[3] == 'O' && name[4] == 'U' && name[5] == 'T')
1134 ||(name[3] == 'E' && name[4] == 'R' && name[5] == 'R')))
1138 if (name[0] == 'A' && name[1] == 'R' && name[2] == 'G'
1139 && name[3] == 'V' && name[4] == 'O' && name[5] == 'U'
1146 stash = PL_defstash;
1147 else if (IN_PERL_COMPILETIME) {
1148 stash = PL_curstash;
1149 if (add && (PL_hints & HINT_STRICT_VARS) &&
1150 sv_type != SVt_PVCV &&
1151 sv_type != SVt_PVGV &&
1152 sv_type != SVt_PVFM &&
1153 sv_type != SVt_PVIO &&
1154 !(len == 1 && sv_type == SVt_PV &&
1155 (*name == 'a' || *name == 'b')) )
1157 gvp = (GV**)hv_fetch(stash,name,len,0);
1159 *gvp == (const GV *)&PL_sv_undef ||
1160 SvTYPE(*gvp) != SVt_PVGV)
1164 else if ((sv_type == SVt_PV && !GvIMPORTED_SV(*gvp)) ||
1165 (sv_type == SVt_PVAV && !GvIMPORTED_AV(*gvp)) ||
1166 (sv_type == SVt_PVHV && !GvIMPORTED_HV(*gvp)) )
1168 /* diag_listed_as: Variable "%s" is not imported%s */
1170 aTHX_ packWARN(WARN_MISC),
1171 "Variable \"%c%s\" is not imported",
1172 sv_type == SVt_PVAV ? '@' :
1173 sv_type == SVt_PVHV ? '%' : '$',
1177 aTHX_ packWARN(WARN_MISC),
1178 "\t(Did you mean &%s instead?)\n", name
1185 stash = CopSTASH(PL_curcop);
1188 stash = PL_defstash;
1191 /* By this point we should have a stash and a name */
1195 SV * const err = Perl_mess(aTHX_
1196 "Global symbol \"%s%s\" requires explicit package name",
1197 (sv_type == SVt_PV ? "$"
1198 : sv_type == SVt_PVAV ? "@"
1199 : sv_type == SVt_PVHV ? "%"
1202 if (USE_UTF8_IN_NAMES)
1205 gv = gv_fetchpvs("<none>::", GV_ADDMULTI, SVt_PVHV);
1207 /* symbol table under destruction */
1216 if (!SvREFCNT(stash)) /* symbol table under destruction */
1219 gvp = (GV**)hv_fetch(stash,name,len,add);
1220 if (!gvp || *gvp == (const GV *)&PL_sv_undef)
1223 if (SvTYPE(gv) == SVt_PVGV) {
1226 gv_init_sv(gv, sv_type);
1227 if (len == 1 && (sv_type == SVt_PVHV || sv_type == SVt_PVGV)) {
1229 require_tie_mod(gv, "!", newSVpvs("Errno"), "TIEHASH", 1);
1230 else if (*name == '-' || *name == '+')
1231 require_tie_mod(gv, name, newSVpvs("Tie::Hash::NamedCapture"), "TIEHASH", 0);
1233 else if (len == 3 && sv_type == SVt_PVAV
1234 && strnEQ(name, "ISA", 3)
1235 && (!GvAV(gv) || !SvSMAGICAL(GvAV(gv))))
1236 gv_magicalize_isa(gv);
1239 } else if (no_init) {
1241 } else if (no_expand && SvROK(gv)) {
1245 /* Adding a new symbol.
1246 Unless of course there was already something non-GV here, in which case
1247 we want to behave as if there was always a GV here, containing some sort
1249 Otherwise we run the risk of creating things like GvIO, which can cause
1250 subtle bugs. eg the one that tripped up SQL::Translator */
1252 faking_it = SvOK(gv);
1254 if (add & GV_ADDWARN)
1255 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL), "Had to create %s unexpectedly", nambeg);
1256 gv_init(gv, stash, name, len, add & GV_ADDMULTI);
1257 gv_init_sv(gv, faking_it ? SVt_PVCV : sv_type);
1259 if (isALPHA(name[0]) && ! (isLEXWARN_on ? ckWARN(WARN_ONCE)
1260 : (PL_dowarn & G_WARN_ON ) ) )
1263 /* set up magic where warranted */
1264 if (stash != PL_defstash) { /* not the main stash */
1265 /* We only have to check for four names here: EXPORT, ISA, OVERLOAD
1266 and VERSION. All the others apply only to the main stash. */
1268 const char * const name2 = name + 1;
1271 if (strnEQ(name2, "XPORT", 5))
1275 if (strEQ(name2, "SA"))
1276 gv_magicalize_isa(gv);
1279 if (strEQ(name2, "VERLOAD"))
1280 gv_magicalize_overload(gv);
1283 if (strEQ(name2, "ERSION"))
1293 /* Nothing else to do.
1294 The compiler will probably turn the switch statement into a
1295 branch table. Make sure we avoid even that small overhead for
1296 the common case of lower case variable names. */
1300 const char * const name2 = name + 1;
1303 if (strEQ(name2, "RGV")) {
1304 IoFLAGS(GvIOn(gv)) |= IOf_ARGV|IOf_START;
1306 else if (strEQ(name2, "RGVOUT")) {
1311 if (strnEQ(name2, "XPORT", 5))
1315 if (strEQ(name2, "SA")) {
1316 gv_magicalize_isa(gv);
1320 if (strEQ(name2, "VERLOAD")) {
1321 gv_magicalize_overload(gv);
1325 if (strEQ(name2, "IG")) {
1328 if (!PL_psig_name) {
1329 Newxz(PL_psig_name, 2 * SIG_SIZE, SV*);
1330 Newxz(PL_psig_pend, SIG_SIZE, int);
1331 PL_psig_ptr = PL_psig_name + SIG_SIZE;
1333 /* I think that the only way to get here is to re-use an
1334 embedded perl interpreter, where the previous
1335 use didn't clean up fully because
1336 PL_perl_destruct_level was 0. I'm not sure that we
1337 "support" that, in that I suspect in that scenario
1338 there are sufficient other garbage values left in the
1339 interpreter structure that something else will crash
1340 before we get here. I suspect that this is one of
1341 those "doctor, it hurts when I do this" bugs. */
1342 Zero(PL_psig_name, 2 * SIG_SIZE, SV*);
1343 Zero(PL_psig_pend, SIG_SIZE, int);
1347 hv_magic(hv, NULL, PERL_MAGIC_sig);
1348 for (i = 1; i < SIG_SIZE; i++) {
1349 SV * const * const init = hv_fetch(hv, PL_sig_name[i], strlen(PL_sig_name[i]), 1);
1351 sv_setsv(*init, &PL_sv_undef);
1356 if (strEQ(name2, "ERSION"))
1359 case '\003': /* $^CHILD_ERROR_NATIVE */
1360 if (strEQ(name2, "HILD_ERROR_NATIVE"))
1363 case '\005': /* $^ENCODING */
1364 if (strEQ(name2, "NCODING"))
1367 case '\007': /* $^GLOBAL_PHASE */
1368 if (strEQ(name2, "LOBAL_PHASE"))
1371 case '\015': /* $^MATCH */
1372 if (strEQ(name2, "ATCH"))
1374 case '\017': /* $^OPEN */
1375 if (strEQ(name2, "PEN"))
1378 case '\020': /* $^PREMATCH $^POSTMATCH */
1379 if (strEQ(name2, "REMATCH") || strEQ(name2, "OSTMATCH"))
1382 case '\024': /* ${^TAINT} */
1383 if (strEQ(name2, "AINT"))
1386 case '\025': /* ${^UNICODE}, ${^UTF8LOCALE} */
1387 if (strEQ(name2, "NICODE"))
1389 if (strEQ(name2, "TF8LOCALE"))
1391 if (strEQ(name2, "TF8CACHE"))
1394 case '\027': /* $^WARNING_BITS */
1395 if (strEQ(name2, "ARNING_BITS"))
1408 /* Ensures that we have an all-digit variable, ${"1foo"} fails
1410 /* This snippet is taken from is_gv_magical */
1411 const char *end = name + len;
1412 while (--end > name) {
1413 if (!isDIGIT(*end)) return gv;
1420 /* Names of length 1. (Or 0. But name is NUL terminated, so that will
1421 be case '\0' in this switch statement (ie a default case) */
1427 sv_type == SVt_PVAV ||
1428 sv_type == SVt_PVHV ||
1429 sv_type == SVt_PVCV ||
1430 sv_type == SVt_PVFM ||
1433 PL_sawampersand = TRUE;
1437 sv_setpv(GvSVn(gv),PL_chopset);
1441 #ifdef COMPLEX_STATUS
1442 SvUPGRADE(GvSVn(gv), SVt_PVLV);
1448 /* If %! has been used, automatically load Errno.pm. */
1450 sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
1452 /* magicalization must be done before require_tie_mod is called */
1453 if (sv_type == SVt_PVHV || sv_type == SVt_PVGV)
1454 require_tie_mod(gv, "!", newSVpvs("Errno"), "TIEHASH", 1);
1459 GvMULTI_on(gv); /* no used once warnings here */
1461 AV* const av = GvAVn(gv);
1462 SV* const avc = (*name == '+') ? MUTABLE_SV(av) : NULL;
1464 sv_magic(MUTABLE_SV(av), avc, PERL_MAGIC_regdata, NULL, 0);
1465 sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
1467 SvREADONLY_on(GvSVn(gv));
1470 if (sv_type == SVt_PVHV || sv_type == SVt_PVGV)
1471 require_tie_mod(gv, name, newSVpvs("Tie::Hash::NamedCapture"), "TIEHASH", 0);
1477 if (sv_type == SVt_PV)
1478 Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_SYNTAX),
1479 "$%c is no longer supported", *name);
1482 sv_setiv(GvSVn(gv), (IV)(IoFLAGS(GvIOp(PL_defoutgv)) & IOf_FLUSH) != 0);
1485 case '\010': /* $^H */
1487 HV *const hv = GvHVn(gv);
1488 hv_magic(hv, NULL, PERL_MAGIC_hints);
1491 case '\023': /* $^S */
1493 SvREADONLY_on(GvSVn(gv));
1517 case '\001': /* $^A */
1518 case '\003': /* $^C */
1519 case '\004': /* $^D */
1520 case '\005': /* $^E */
1521 case '\006': /* $^F */
1522 case '\011': /* $^I, NOT \t in EBCDIC */
1523 case '\016': /* $^N */
1524 case '\017': /* $^O */
1525 case '\020': /* $^P */
1526 case '\024': /* $^T */
1527 case '\027': /* $^W */
1529 sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
1532 case '\014': /* $^L */
1533 sv_setpvs(GvSVn(gv),"\f");
1534 PL_formfeed = GvSVn(gv);
1537 sv_setpvs(GvSVn(gv),"\034");
1541 SV * const sv = GvSVn(gv);
1542 if (!sv_derived_from(PL_patchlevel, "version"))
1543 upg_version(PL_patchlevel, TRUE);
1544 GvSV(gv) = vnumify(PL_patchlevel);
1545 SvREADONLY_on(GvSV(gv));
1549 case '\026': /* $^V */
1551 SV * const sv = GvSVn(gv);
1552 GvSV(gv) = new_version(PL_patchlevel);
1553 SvREADONLY_on(GvSV(gv));
1563 Perl_gv_fullname4(pTHX_ SV *sv, const GV *gv, const char *prefix, bool keepmain)
1567 const HV * const hv = GvSTASH(gv);
1569 PERL_ARGS_ASSERT_GV_FULLNAME4;
1575 sv_setpv(sv, prefix ? prefix : "");
1577 name = HvNAME_get(hv);
1579 namelen = HvNAMELEN_get(hv);
1585 if (keepmain || strNE(name, "main")) {
1586 sv_catpvn(sv,name,namelen);
1589 sv_catpvn(sv,GvNAME(gv),GvNAMELEN(gv));
1593 Perl_gv_efullname4(pTHX_ SV *sv, const GV *gv, const char *prefix, bool keepmain)
1595 const GV * const egv = GvEGVx(gv);
1597 PERL_ARGS_ASSERT_GV_EFULLNAME4;
1599 gv_fullname4(sv, egv ? egv : gv, prefix, keepmain);
1603 Perl_gv_check(pTHX_ const HV *stash)
1608 PERL_ARGS_ASSERT_GV_CHECK;
1610 if (!HvARRAY(stash))
1612 for (i = 0; i <= (I32) HvMAX(stash); i++) {
1614 for (entry = HvARRAY(stash)[i]; entry; entry = HeNEXT(entry)) {
1617 if (HeKEY(entry)[HeKLEN(entry)-1] == ':' &&
1618 (gv = MUTABLE_GV(HeVAL(entry))) && isGV(gv) && (hv = GvHV(gv)))
1620 if (hv != PL_defstash && hv != stash)
1621 gv_check(hv); /* nested package */
1623 else if (isALPHA(*HeKEY(entry))) {
1625 gv = MUTABLE_GV(HeVAL(entry));
1626 if (SvTYPE(gv) != SVt_PVGV || GvMULTI(gv))
1629 CopLINE_set(PL_curcop, GvLINE(gv));
1631 CopFILE(PL_curcop) = (char *)file; /* set for warning */
1633 CopFILEGV(PL_curcop)
1634 = gv_fetchfile_flags(file, HEK_LEN(GvFILE_HEK(gv)), 0);
1636 Perl_warner(aTHX_ packWARN(WARN_ONCE),
1637 "Name \"%s::%s\" used only once: possible typo",
1638 HvNAME_get(stash), GvNAME(gv));
1645 Perl_newGVgen(pTHX_ const char *pack)
1649 PERL_ARGS_ASSERT_NEWGVGEN;
1651 return gv_fetchpv(Perl_form(aTHX_ "%s::_GEN_%ld", pack, (long)PL_gensym++),
1655 /* hopefully this is only called on local symbol table entries */
1658 Perl_gp_ref(pTHX_ GP *gp)
1666 /* If the GP they asked for a reference to contains
1667 a method cache entry, clear it first, so that we
1668 don't infect them with our cached entry */
1669 SvREFCNT_dec(gp->gp_cv);
1678 Perl_gp_free(pTHX_ GV *gv)
1683 if (!gv || !isGV_with_GP(gv) || !(gp = GvGP(gv)))
1685 if (gp->gp_refcnt == 0) {
1686 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1687 "Attempt to free unreferenced glob pointers"
1688 pTHX__FORMAT pTHX__VALUE);
1691 if (--gp->gp_refcnt > 0) {
1692 if (gp->gp_egv == gv)
1698 if (gp->gp_file_hek)
1699 unshare_hek(gp->gp_file_hek);
1700 SvREFCNT_dec(gp->gp_sv);
1701 SvREFCNT_dec(gp->gp_av);
1702 /* FIXME - another reference loop GV -> symtab -> GV ?
1703 Somehow gp->gp_hv can end up pointing at freed garbage. */
1704 if (gp->gp_hv && SvTYPE(gp->gp_hv) == SVt_PVHV) {
1705 const char *hvname = HvNAME_get(gp->gp_hv);
1706 if (PL_stashcache && hvname)
1707 (void)hv_delete(PL_stashcache, hvname, HvNAMELEN_get(gp->gp_hv),
1709 SvREFCNT_dec(gp->gp_hv);
1711 SvREFCNT_dec(gp->gp_io);
1712 SvREFCNT_dec(gp->gp_cv);
1713 SvREFCNT_dec(gp->gp_form);
1720 Perl_magic_freeovrld(pTHX_ SV *sv, MAGIC *mg)
1722 AMT * const amtp = (AMT*)mg->mg_ptr;
1723 PERL_UNUSED_ARG(sv);
1725 PERL_ARGS_ASSERT_MAGIC_FREEOVRLD;
1727 if (amtp && AMT_AMAGIC(amtp)) {
1729 for (i = 1; i < NofAMmeth; i++) {
1730 CV * const cv = amtp->table[i];
1732 SvREFCNT_dec(MUTABLE_SV(cv));
1733 amtp->table[i] = NULL;
1740 /* Updates and caches the CV's */
1742 * 1 on success and there is some overload
1743 * 0 if there is no overload
1744 * -1 if some error occurred and it couldn't croak
1748 Perl_Gv_AMupdate(pTHX_ HV *stash, bool destructing)
1751 MAGIC* const mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
1753 const struct mro_meta* stash_meta = HvMROMETA(stash);
1756 PERL_ARGS_ASSERT_GV_AMUPDATE;
1758 newgen = PL_sub_generation + stash_meta->pkg_gen + stash_meta->cache_gen;
1760 const AMT * const amtp = (AMT*)mg->mg_ptr;
1761 if (amtp->was_ok_am == PL_amagic_generation
1762 && amtp->was_ok_sub == newgen) {
1763 return AMT_OVERLOADED(amtp) ? 1 : 0;
1765 sv_unmagic(MUTABLE_SV(stash), PERL_MAGIC_overload_table);
1768 DEBUG_o( Perl_deb(aTHX_ "Recalcing overload magic in package %s\n",HvNAME_get(stash)) );
1771 amt.was_ok_am = PL_amagic_generation;
1772 amt.was_ok_sub = newgen;
1773 amt.fallback = AMGfallNO;
1777 int filled = 0, have_ovl = 0;
1780 /* Work with "fallback" key, which we assume to be first in PL_AMG_names */
1782 /* Try to find via inheritance. */
1783 GV *gv = gv_fetchmeth(stash, PL_AMG_names[0], 2, -1);
1784 SV * const sv = gv ? GvSV(gv) : NULL;
1788 lim = DESTROY_amg; /* Skip overloading entries. */
1789 #ifdef PERL_DONT_CREATE_GVSV
1791 NOOP; /* Equivalent to !SvTRUE and !SvOK */
1794 else if (SvTRUE(sv))
1795 amt.fallback=AMGfallYES;
1797 amt.fallback=AMGfallNEVER;
1799 for (i = 1; i < lim; i++)
1800 amt.table[i] = NULL;
1801 for (; i < NofAMmeth; i++) {
1802 const char * const cooky = PL_AMG_names[i];
1803 /* Human-readable form, for debugging: */
1804 const char * const cp = (i >= DESTROY_amg ? cooky : AMG_id2name(i));
1805 const STRLEN l = PL_AMG_namelens[i];
1807 DEBUG_o( Perl_deb(aTHX_ "Checking overloading of \"%s\" in package \"%.256s\"\n",
1808 cp, HvNAME_get(stash)) );
1809 /* don't fill the cache while looking up!
1810 Creation of inheritance stubs in intermediate packages may
1811 conflict with the logic of runtime method substitution.
1812 Indeed, for inheritance A -> B -> C, if C overloads "+0",
1813 then we could have created stubs for "(+0" in A and C too.
1814 But if B overloads "bool", we may want to use it for
1815 numifying instead of C's "+0". */
1816 if (i >= DESTROY_amg)
1817 gv = Perl_gv_fetchmeth_autoload(aTHX_ stash, cooky, l, 0);
1818 else /* Autoload taken care of below */
1819 gv = Perl_gv_fetchmeth(aTHX_ stash, cooky, l, -1);
1821 if (gv && (cv = GvCV(gv))) {
1823 if (GvNAMELEN(CvGV(cv)) == 3 && strEQ(GvNAME(CvGV(cv)), "nil")
1824 && strEQ(hvname = HvNAME_get(GvSTASH(CvGV(cv))), "overload")) {
1825 /* This is a hack to support autoloading..., while
1826 knowing *which* methods were declared as overloaded. */
1827 /* GvSV contains the name of the method. */
1829 SV *gvsv = GvSV(gv);
1831 DEBUG_o( Perl_deb(aTHX_ "Resolving method \"%"SVf256\
1832 "\" for overloaded \"%s\" in package \"%.256s\"\n",
1833 (void*)GvSV(gv), cp, hvname) );
1834 if (!gvsv || !SvPOK(gvsv)
1835 || !(ngv = gv_fetchmethod_autoload(stash, SvPVX_const(gvsv),
1838 /* Can be an import stub (created by "can"). */
1843 const char * const name = (gvsv && SvPOK(gvsv)) ? SvPVX_const(gvsv) : "???";
1844 Perl_croak(aTHX_ "%s method \"%.256s\" overloading \"%s\" "\
1845 "in package \"%.256s\"",
1846 (GvCVGEN(gv) ? "Stub found while resolving"
1851 cv = GvCV(gv = ngv);
1853 DEBUG_o( Perl_deb(aTHX_ "Overloading \"%s\" in package \"%.256s\" via \"%.256s::%.256s\"\n",
1854 cp, HvNAME_get(stash), HvNAME_get(GvSTASH(CvGV(cv))),
1855 GvNAME(CvGV(cv))) );
1857 if (i < DESTROY_amg)
1859 } else if (gv) { /* Autoloaded... */
1860 cv = MUTABLE_CV(gv);
1863 amt.table[i]=MUTABLE_CV(SvREFCNT_inc_simple(cv));
1866 AMT_AMAGIC_on(&amt);
1868 AMT_OVERLOADED_on(&amt);
1869 sv_magic(MUTABLE_SV(stash), 0, PERL_MAGIC_overload_table,
1870 (char*)&amt, sizeof(AMT));
1874 /* Here we have no table: */
1876 AMT_AMAGIC_off(&amt);
1877 sv_magic(MUTABLE_SV(stash), 0, PERL_MAGIC_overload_table,
1878 (char*)&amt, sizeof(AMTS));
1884 Perl_gv_handler(pTHX_ HV *stash, I32 id)
1890 struct mro_meta* stash_meta;
1892 if (!stash || !HvNAME_get(stash))
1895 stash_meta = HvMROMETA(stash);
1896 newgen = PL_sub_generation + stash_meta->pkg_gen + stash_meta->cache_gen;
1898 mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
1901 /* If we're looking up a destructor to invoke, we must avoid
1902 * that Gv_AMupdate croaks, because we might be dying already */
1903 if (Gv_AMupdate(stash, id == DESTROY_amg) == -1) {
1904 /* and if it didn't found a destructor, we fall back
1905 * to a simpler method that will only look for the
1906 * destructor instead of the whole magic */
1907 if (id == DESTROY_amg) {
1908 GV * const gv = gv_fetchmethod(stash, "DESTROY");
1914 mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
1917 amtp = (AMT*)mg->mg_ptr;
1918 if ( amtp->was_ok_am != PL_amagic_generation
1919 || amtp->was_ok_sub != newgen )
1921 if (AMT_AMAGIC(amtp)) {
1922 CV * const ret = amtp->table[id];
1923 if (ret && isGV(ret)) { /* Autoloading stab */
1924 /* Passing it through may have resulted in a warning
1925 "Inherited AUTOLOAD for a non-method deprecated", since
1926 our caller is going through a function call, not a method call.
1927 So return the CV for AUTOLOAD, setting $AUTOLOAD. */
1928 GV * const gv = gv_fetchmethod(stash, PL_AMG_names[id]);
1940 /* Implement tryAMAGICun_MG macro.
1941 Do get magic, then see if the stack arg is overloaded and if so call it.
1943 AMGf_set return the arg using SETs rather than assigning to
1945 AMGf_numeric apply sv_2num to the stack arg.
1949 Perl_try_amagic_un(pTHX_ int method, int flags) {
1953 SV* const arg = TOPs;
1957 if (SvAMAGIC(arg) && (tmpsv = amagic_call(arg, &PL_sv_undef, method,
1958 AMGf_noright | AMGf_unary))) {
1959 if (flags & AMGf_set) {
1964 if (SvPADMY(TARG)) {
1965 sv_setsv(TARG, tmpsv);
1975 if ((flags & AMGf_numeric) && SvROK(arg))
1981 /* Implement tryAMAGICbin_MG macro.
1982 Do get magic, then see if the two stack args are overloaded and if so
1985 AMGf_set return the arg using SETs rather than assigning to
1987 AMGf_assign op may be called as mutator (eg +=)
1988 AMGf_numeric apply sv_2num to the stack arg.
1992 Perl_try_amagic_bin(pTHX_ int method, int flags) {
1995 SV* const left = TOPm1s;
1996 SV* const right = TOPs;
2002 if (SvAMAGIC(left) || SvAMAGIC(right)) {
2003 SV * const tmpsv = amagic_call(left, right, method,
2004 ((flags & AMGf_assign) && opASSIGN ? AMGf_assign: 0));
2006 if (flags & AMGf_set) {
2013 if (opASSIGN || SvPADMY(TARG)) {
2014 sv_setsv(TARG, tmpsv);
2024 if (flags & AMGf_numeric) {
2026 *(sp-1) = sv_2num(left);
2028 *sp = sv_2num(right);
2034 Perl_amagic_deref_call(pTHX_ SV *ref, int method) {
2037 PERL_ARGS_ASSERT_AMAGIC_DEREF_CALL;
2039 while (SvAMAGIC(ref) &&
2040 (tmpsv = amagic_call(ref, &PL_sv_undef, method,
2041 AMGf_noright | AMGf_unary))) {
2043 Perl_croak(aTHX_ "Overloaded dereference did not return a reference");
2044 if (tmpsv == ref || SvRV(tmpsv) == SvRV(ref)) {
2045 /* Bail out if it returns us the same reference. */
2050 return tmpsv ? tmpsv : ref;
2054 Perl_amagic_call(pTHX_ SV *left, SV *right, int method, int flags)
2059 CV **cvp=NULL, **ocvp=NULL;
2060 AMT *amtp=NULL, *oamtp=NULL;
2061 int off = 0, off1, lr = 0, notfound = 0;
2062 int postpr = 0, force_cpy = 0;
2063 int assign = AMGf_assign & flags;
2064 const int assignshift = assign ? 1 : 0;
2070 PERL_ARGS_ASSERT_AMAGIC_CALL;
2072 if ( PL_curcop->cop_hints & HINT_NO_AMAGIC ) {
2073 SV *lex_mask = cop_hints_fetch_pvs(PL_curcop, "overloading", 0);
2075 if ( !lex_mask || !SvOK(lex_mask) )
2076 /* overloading lexically disabled */
2078 else if ( lex_mask && SvPOK(lex_mask) ) {
2079 /* we have an entry in the hints hash, check if method has been
2080 * masked by overloading.pm */
2082 const int offset = method / 8;
2083 const int bit = method % 8;
2084 char *pv = SvPV(lex_mask, len);
2086 /* Bit set, so this overloading operator is disabled */
2087 if ( (STRLEN)offset < len && pv[offset] & ( 1 << bit ) )
2092 if (!(AMGf_noleft & flags) && SvAMAGIC(left)
2093 && (stash = SvSTASH(SvRV(left)))
2094 && (mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table))
2095 && (ocvp = cvp = (AMT_AMAGIC((AMT*)mg->mg_ptr)
2096 ? (oamtp = amtp = (AMT*)mg->mg_ptr)->table
2098 && ((cv = cvp[off=method+assignshift])
2099 || (assign && amtp->fallback > AMGfallNEVER && /* fallback to
2105 cv = cvp[off=method])))) {
2106 lr = -1; /* Call method for left argument */
2108 if (cvp && amtp->fallback > AMGfallNEVER && flags & AMGf_unary) {
2111 /* look for substituted methods */
2112 /* In all the covered cases we should be called with assign==0. */
2116 if ((cv = cvp[off=add_ass_amg])
2117 || ((cv = cvp[off = add_amg]) && (force_cpy = 0, postpr = 1))) {
2118 right = &PL_sv_yes; lr = -1; assign = 1;
2123 if ((cv = cvp[off = subtr_ass_amg])
2124 || ((cv = cvp[off = subtr_amg]) && (force_cpy = 0, postpr=1))) {
2125 right = &PL_sv_yes; lr = -1; assign = 1;
2129 (void)((cv = cvp[off=numer_amg]) || (cv = cvp[off=string_amg]));
2132 (void)((cv = cvp[off=string_amg]) || (cv = cvp[off=bool__amg]));
2135 (void)((cv = cvp[off=numer_amg]) || (cv = cvp[off=bool__amg]));
2138 (void)((cv = cvp[off=bool__amg])
2139 || (cv = cvp[off=numer_amg])
2140 || (cv = cvp[off=string_amg]));
2147 * SV* ref causes confusion with the interpreter variable of
2150 SV* const tmpRef=SvRV(left);
2151 if (!SvROK(tmpRef) && SvTYPE(tmpRef) <= SVt_PVMG) {
2153 * Just to be extra cautious. Maybe in some
2154 * additional cases sv_setsv is safe, too.
2156 SV* const newref = newSVsv(tmpRef);
2157 SvOBJECT_on(newref);
2158 /* As a bit of a source compatibility hack, SvAMAGIC() and
2159 friends dereference an RV, to behave the same was as when
2160 overloading was stored on the reference, not the referant.
2161 Hence we can't use SvAMAGIC_on()
2163 SvFLAGS(newref) |= SVf_AMAGIC;
2164 SvSTASH_set(newref, MUTABLE_HV(SvREFCNT_inc(SvSTASH(tmpRef))));
2170 if ((cvp[off1=lt_amg] || cvp[off1=ncmp_amg])
2171 && ((cv = cvp[off=neg_amg]) || (cv = cvp[off=subtr_amg]))) {
2172 SV* const nullsv=sv_2mortal(newSViv(0));
2174 SV* const lessp = amagic_call(left,nullsv,
2175 lt_amg,AMGf_noright);
2176 logic = SvTRUE(lessp);
2178 SV* const lessp = amagic_call(left,nullsv,
2179 ncmp_amg,AMGf_noright);
2180 logic = (SvNV(lessp) < 0);
2183 if (off==subtr_amg) {
2194 if ((cv = cvp[off=subtr_amg])) {
2196 left = sv_2mortal(newSViv(0));
2201 case iter_amg: /* XXXX Eventually should do to_gv. */
2202 case ftest_amg: /* XXXX Eventually should do to_gv. */
2205 return NULL; /* Delegate operation to standard mechanisms. */
2213 return left; /* Delegate operation to standard mechanisms. */
2218 if (!cv) goto not_found;
2219 } else if (!(AMGf_noright & flags) && SvAMAGIC(right)
2220 && (stash = SvSTASH(SvRV(right)))
2221 && (mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table))
2222 && (cvp = (AMT_AMAGIC((AMT*)mg->mg_ptr)
2223 ? (amtp = (AMT*)mg->mg_ptr)->table
2225 && (cv = cvp[off=method])) { /* Method for right
2228 } else if (((ocvp && oamtp->fallback > AMGfallNEVER
2229 && (cvp=ocvp) && (lr = -1))
2230 || (cvp && amtp->fallback > AMGfallNEVER && (lr=1)))
2231 && !(flags & AMGf_unary)) {
2232 /* We look for substitution for
2233 * comparison operations and
2235 if (method==concat_amg || method==concat_ass_amg
2236 || method==repeat_amg || method==repeat_ass_amg) {
2237 return NULL; /* Delegate operation to string conversion */
2258 if ((off != -1) && (cv = cvp[off]))
2263 not_found: /* No method found, either report or croak */
2271 return left; /* Delegate operation to standard mechanisms. */
2274 if (ocvp && (cv=ocvp[nomethod_amg])) { /* Call report method */
2275 notfound = 1; lr = -1;
2276 } else if (cvp && (cv=cvp[nomethod_amg])) {
2277 notfound = 1; lr = 1;
2278 } else if ((amtp && amtp->fallback >= AMGfallYES) && !DEBUG_o_TEST) {
2279 /* Skip generating the "no method found" message. */
2283 if (off==-1) off=method;
2284 msg = sv_2mortal(Perl_newSVpvf(aTHX_
2285 "Operation \"%s\": no method found,%sargument %s%s%s%s",
2286 AMG_id2name(method + assignshift),
2287 (flags & AMGf_unary ? " " : "\n\tleft "),
2289 "in overloaded package ":
2290 "has no overloaded magic",
2292 HvNAME_get(SvSTASH(SvRV(left))):
2295 ",\n\tright argument in overloaded package ":
2298 : ",\n\tright argument has no overloaded magic"),
2300 HvNAME_get(SvSTASH(SvRV(right))):
2302 if (amtp && amtp->fallback >= AMGfallYES) {
2303 DEBUG_o( Perl_deb(aTHX_ "%s", SvPVX_const(msg)) );
2305 Perl_croak(aTHX_ "%"SVf, SVfARG(msg));
2309 force_cpy = force_cpy || assign;
2314 DEBUG_o(Perl_deb(aTHX_
2315 "Overloaded operator \"%s\"%s%s%s:\n\tmethod%s found%s in package %s%s\n",
2317 method+assignshift==off? "" :
2319 method+assignshift==off? "" :
2320 AMG_id2name(method+assignshift),
2321 method+assignshift==off? "" : "\")",
2322 flags & AMGf_unary? "" :
2323 lr==1 ? " for right argument": " for left argument",
2324 flags & AMGf_unary? " for argument" : "",
2325 stash ? HvNAME_get(stash) : "null",
2326 fl? ",\n\tassignment variant used": "") );
2329 /* Since we use shallow copy during assignment, we need
2330 * to dublicate the contents, probably calling user-supplied
2331 * version of copy operator
2333 /* We need to copy in following cases:
2334 * a) Assignment form was called.
2335 * assignshift==1, assign==T, method + 1 == off
2336 * b) Increment or decrement, called directly.
2337 * assignshift==0, assign==0, method + 0 == off
2338 * c) Increment or decrement, translated to assignment add/subtr.
2339 * assignshift==0, assign==T,
2341 * d) Increment or decrement, translated to nomethod.
2342 * assignshift==0, assign==0,
2344 * e) Assignment form translated to nomethod.
2345 * assignshift==1, assign==T, method + 1 != off
2348 /* off is method, method+assignshift, or a result of opcode substitution.
2349 * In the latter case assignshift==0, so only notfound case is important.
2351 if (( (method + assignshift == off)
2352 && (assign || (method == inc_amg) || (method == dec_amg)))
2355 /* newSVsv does not behave as advertised, so we copy missing
2356 * information by hand */
2357 SV *tmpRef = SvRV(left);
2359 if (SvREFCNT(tmpRef) > 1 && (rv_copy = AMG_CALLun(left,copy))) {
2360 SvRV_set(left, rv_copy);
2362 SvREFCNT_dec(tmpRef);
2370 const bool oldcatch = CATCH_GET;
2373 Zero(&myop, 1, BINOP);
2374 myop.op_last = (OP *) &myop;
2375 myop.op_next = NULL;
2376 myop.op_flags = OPf_WANT_SCALAR | OPf_STACKED;
2378 PUSHSTACKi(PERLSI_OVERLOAD);
2381 PL_op = (OP *) &myop;
2382 if (PERLDB_SUB && PL_curstash != PL_debstash)
2383 PL_op->op_private |= OPpENTERSUB_DB;
2387 EXTEND(SP, notfound + 5);
2388 PUSHs(lr>0? right: left);
2389 PUSHs(lr>0? left: right);
2390 PUSHs( lr > 0 ? &PL_sv_yes : ( assign ? &PL_sv_undef : &PL_sv_no ));
2392 PUSHs(newSVpvn_flags(AMG_id2name(method + assignshift),
2393 AMG_id2namelen(method + assignshift), SVs_TEMP));
2395 PUSHs(MUTABLE_SV(cv));
2398 if ((PL_op = PL_ppaddr[OP_ENTERSUB](aTHX)))
2406 CATCH_SET(oldcatch);
2413 ans=SvIV(res)<=0; break;
2416 ans=SvIV(res)<0; break;
2419 ans=SvIV(res)>=0; break;
2422 ans=SvIV(res)>0; break;
2425 ans=SvIV(res)==0; break;
2428 ans=SvIV(res)!=0; break;
2431 SvSetSV(left,res); return left;
2433 ans=!SvTRUE(res); break;
2438 } else if (method==copy_amg) {
2440 Perl_croak(aTHX_ "Copy method did not return a reference");
2442 return SvREFCNT_inc(SvRV(res));
2450 =for apidoc is_gv_magical_sv
2452 Returns C<TRUE> if given the name of a magical GV.
2454 Currently only useful internally when determining if a GV should be
2455 created even in rvalue contexts.
2457 C<flags> is not used at present but available for future extension to
2458 allow selecting particular classes of magical variable.
2460 Currently assumes that C<name> is NUL terminated (as well as len being valid).
2461 This assumption is met by all callers within the perl core, which all pass
2462 pointers returned by SvPV.
2468 Perl_is_gv_magical_sv(pTHX_ SV *const name_sv, U32 flags)
2471 const char *const name = SvPV_const(name_sv, len);
2473 PERL_UNUSED_ARG(flags);
2474 PERL_ARGS_ASSERT_IS_GV_MAGICAL_SV;
2477 const char * const name1 = name + 1;
2480 if (len == 3 && name[1] == 'S' && name[2] == 'A')
2484 if (len == 8 && strEQ(name1, "VERLOAD"))
2488 if (len == 3 && name[1] == 'I' && name[2] == 'G')
2491 /* Using ${^...} variables is likely to be sufficiently rare that
2492 it seems sensible to avoid the space hit of also checking the
2494 case '\017': /* ${^OPEN} */
2495 if (strEQ(name1, "PEN"))
2498 case '\024': /* ${^TAINT} */
2499 if (strEQ(name1, "AINT"))
2502 case '\025': /* ${^UNICODE} */
2503 if (strEQ(name1, "NICODE"))
2505 if (strEQ(name1, "TF8LOCALE"))
2508 case '\027': /* ${^WARNING_BITS} */
2509 if (strEQ(name1, "ARNING_BITS"))
2522 const char *end = name + len;
2523 while (--end > name) {
2531 /* Because we're already assuming that name is NUL terminated
2532 below, we can treat an empty name as "\0" */
2558 case '\001': /* $^A */
2559 case '\003': /* $^C */
2560 case '\004': /* $^D */
2561 case '\005': /* $^E */
2562 case '\006': /* $^F */
2563 case '\010': /* $^H */
2564 case '\011': /* $^I, NOT \t in EBCDIC */
2565 case '\014': /* $^L */
2566 case '\016': /* $^N */
2567 case '\017': /* $^O */
2568 case '\020': /* $^P */
2569 case '\023': /* $^S */
2570 case '\024': /* $^T */
2571 case '\026': /* $^V */
2572 case '\027': /* $^W */
2592 Perl_gv_name_set(pTHX_ GV *gv, const char *name, U32 len, U32 flags)
2597 PERL_ARGS_ASSERT_GV_NAME_SET;
2598 PERL_UNUSED_ARG(flags);
2601 Perl_croak(aTHX_ "panic: gv name too long (%"UVuf")", (UV) len);
2603 if (!(flags & GV_ADD) && GvNAME_HEK(gv)) {
2604 unshare_hek(GvNAME_HEK(gv));
2607 PERL_HASH(hash, name, len);
2608 GvNAME_HEK(gv) = share_hek(name, len, hash);
2612 =for apidoc gv_try_downgrade
2614 If the typeglob C<gv> can be expressed more succinctly, by having
2615 something other than a real GV in its place in the stash, replace it
2616 with the optimised form. Basic requirements for this are that C<gv>
2617 is a real typeglob, is sufficiently ordinary, and is only referenced
2618 from its package. This function is meant to be used when a GV has been
2619 looked up in part to see what was there, causing upgrading, but based
2620 on what was found it turns out that the real GV isn't required after all.
2622 If C<gv> is a completely empty typeglob, it is deleted from the stash.
2624 If C<gv> is a typeglob containing only a sufficiently-ordinary constant
2625 sub, the typeglob is replaced with a scalar-reference placeholder that
2626 more compactly represents the same thing.
2632 Perl_gv_try_downgrade(pTHX_ GV *gv)
2638 PERL_ARGS_ASSERT_GV_TRY_DOWNGRADE;
2640 /* XXX Why and where does this leave dangling pointers during global
2642 if (PL_phase == PERL_PHASE_DESTRUCT) return;
2644 if (!(SvREFCNT(gv) == 1 && SvTYPE(gv) == SVt_PVGV && !SvFAKE(gv) &&
2645 !SvOBJECT(gv) && !SvREADONLY(gv) &&
2646 isGV_with_GP(gv) && GvGP(gv) &&
2647 !GvINTRO(gv) && GvREFCNT(gv) == 1 &&
2648 !GvSV(gv) && !GvAV(gv) && !GvHV(gv) && !GvIOp(gv) && !GvFORM(gv) &&
2649 GvEGVx(gv) == gv && (stash = GvSTASH(gv))))
2651 if (SvMAGICAL(gv)) {
2653 /* only backref magic is allowed */
2654 if (SvGMAGICAL(gv) || SvSMAGICAL(gv))
2656 for (mg = SvMAGIC(gv); mg; mg = mg->mg_moremagic) {
2657 if (mg->mg_type != PERL_MAGIC_backref)
2663 HEK *gvnhek = GvNAME_HEK(gv);
2664 (void)hv_delete(stash, HEK_KEY(gvnhek),
2665 HEK_UTF8(gvnhek) ? -HEK_LEN(gvnhek) : HEK_LEN(gvnhek), G_DISCARD);
2666 } else if (GvMULTI(gv) && cv &&
2667 !SvOBJECT(cv) && !SvMAGICAL(cv) && !SvREADONLY(cv) &&
2668 CvSTASH(cv) == stash && CvGV(cv) == gv &&
2669 CvCONST(cv) && !CvMETHOD(cv) && !CvLVALUE(cv) && !CvUNIQUE(cv) &&
2670 !CvNODEBUG(cv) && !CvCLONE(cv) && !CvCLONED(cv) && !CvANON(cv) &&
2671 (namehek = GvNAME_HEK(gv)) &&
2672 (gvp = hv_fetch(stash, HEK_KEY(namehek),
2673 HEK_LEN(namehek)*(HEK_UTF8(namehek) ? -1 : 1), 0)) &&
2675 SV *value = SvREFCNT_inc(CvXSUBANY(cv).any_ptr);
2679 SvFLAGS(gv) = SVt_IV|SVf_ROK;
2680 SvANY(gv) = (XPVGV*)((char*)&(gv->sv_u.svu_iv) -
2681 STRUCT_OFFSET(XPVIV, xiv_iv));
2682 SvRV_set(gv, value);
2688 * c-indentation-style: bsd
2690 * indent-tabs-mode: t
2693 * ex: set ts=8 sts=4 sw=4 noet: