3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 * 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 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 #ifdef PERL_DONT_CREATE_GVSV
46 Perl_gv_SVadd(pTHX_ GV *gv)
48 PERL_ARGS_ASSERT_GV_SVADD;
50 if (!gv || SvTYPE((const SV *)gv) != SVt_PVGV)
51 Perl_croak(aTHX_ "Bad symbol for scalar");
59 Perl_gv_AVadd(pTHX_ register GV *gv)
61 PERL_ARGS_ASSERT_GV_AVADD;
63 if (!gv || SvTYPE((const SV *)gv) != SVt_PVGV)
64 Perl_croak(aTHX_ "Bad symbol for array");
71 Perl_gv_HVadd(pTHX_ register GV *gv)
73 PERL_ARGS_ASSERT_GV_HVADD;
75 if (!gv || SvTYPE((const SV *)gv) != SVt_PVGV)
76 Perl_croak(aTHX_ "Bad symbol for hash");
83 Perl_gv_IOadd(pTHX_ register GV *gv)
87 PERL_ARGS_ASSERT_GV_IOADD;
89 if (!gv || SvTYPE((const SV *)gv) != SVt_PVGV) {
92 * if it walks like a dirhandle, then let's assume that
93 * this is a dirhandle.
95 const char * const fh =
96 PL_op->op_type == OP_READDIR ||
97 PL_op->op_type == OP_TELLDIR ||
98 PL_op->op_type == OP_SEEKDIR ||
99 PL_op->op_type == OP_REWINDDIR ||
100 PL_op->op_type == OP_CLOSEDIR ?
101 "dirhandle" : "filehandle";
102 Perl_croak(aTHX_ "Bad symbol for %s", fh);
106 #ifdef GV_UNIQUE_CHECK
108 Perl_croak(aTHX_ "Bad symbol for filehandle (GV is unique)");
117 Perl_gv_fetchfile(pTHX_ const char *name)
119 PERL_ARGS_ASSERT_GV_FETCHFILE;
120 return gv_fetchfile_flags(name, strlen(name), 0);
124 Perl_gv_fetchfile_flags(pTHX_ const char *const name, const STRLEN namelen,
130 const STRLEN tmplen = namelen + 2;
133 PERL_ARGS_ASSERT_GV_FETCHFILE_FLAGS;
134 PERL_UNUSED_ARG(flags);
139 if (tmplen <= sizeof smallbuf)
142 Newx(tmpbuf, tmplen, char);
143 /* This is where the debugger's %{"::_<$filename"} hash is created */
146 memcpy(tmpbuf + 2, name, namelen);
147 gv = *(GV**)hv_fetch(PL_defstash, tmpbuf, tmplen, TRUE);
149 gv_init(gv, PL_defstash, tmpbuf, tmplen, FALSE);
150 #ifdef PERL_DONT_CREATE_GVSV
151 GvSV(gv) = newSVpvn(name, namelen);
153 sv_setpvn(GvSV(gv), name, namelen);
155 if (PERLDB_LINE || PERLDB_SAVESRC)
156 hv_magic(GvHVn(gv_AVadd(gv)), NULL, PERL_MAGIC_dbfile);
158 if (tmpbuf != smallbuf)
164 =for apidoc gv_const_sv
166 If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
167 inlining, or C<gv> is a placeholder reference that would be promoted to such
168 a typeglob, then returns the value returned by the sub. Otherwise, returns
175 Perl_gv_const_sv(pTHX_ GV *gv)
177 PERL_ARGS_ASSERT_GV_CONST_SV;
179 if (SvTYPE(gv) == SVt_PVGV)
180 return cv_const_sv(GvCVu(gv));
181 return SvROK(gv) ? SvRV(gv) : NULL;
185 Perl_newGP(pTHX_ GV *const gv)
190 const char *const file
191 = (PL_curcop && CopFILE(PL_curcop)) ? CopFILE(PL_curcop) : "";
192 const STRLEN len = strlen(file);
194 SV *const temp_sv = CopFILESV(PL_curcop);
198 PERL_ARGS_ASSERT_NEWGP;
201 file = SvPVX(temp_sv);
202 len = SvCUR(temp_sv);
209 PERL_HASH(hash, file, len);
213 #ifndef PERL_DONT_CREATE_GVSV
214 gp->gp_sv = newSV(0);
217 gp->gp_line = PL_curcop ? CopLINE(PL_curcop) : 0;
218 /* XXX Ideally this cast would be replaced with a change to const char*
220 gp->gp_file_hek = share_hek(file, len, hash);
228 Perl_gv_init(pTHX_ GV *gv, HV *stash, const char *name, STRLEN len, int multi)
231 const U32 old_type = SvTYPE(gv);
232 const bool doproto = old_type > SVt_NULL;
233 char * const proto = (doproto && SvPOK(gv)) ? SvPVX(gv) : NULL;
234 const STRLEN protolen = proto ? SvCUR(gv) : 0;
235 SV *const has_constant = doproto && SvROK(gv) ? SvRV(gv) : NULL;
236 const U32 exported_constant = has_constant ? SvPCS_IMPORTED(gv) : 0;
238 PERL_ARGS_ASSERT_GV_INIT;
239 assert (!(proto && has_constant));
242 /* The constant has to be a simple scalar type. */
243 switch (SvTYPE(has_constant)) {
249 Perl_croak(aTHX_ "Cannot convert a reference to %s to typeglob",
250 sv_reftype(has_constant, 0));
258 if (old_type < SVt_PVGV) {
259 if (old_type >= SVt_PV)
261 sv_upgrade(MUTABLE_SV(gv), SVt_PVGV);
269 Safefree(SvPVX_mutable(gv));
274 GvGP(gv) = Perl_newGP(aTHX_ gv);
277 Perl_sv_add_backref(aTHX_ MUTABLE_SV(stash), MUTABLE_SV(gv));
278 gv_name_set(gv, name, len, GV_ADD);
279 if (multi || doproto) /* doproto means it _was_ mentioned */
281 if (doproto) { /* Replicate part of newSUB here. */
284 /* newCONSTSUB takes ownership of the reference from us. */
285 GvCV(gv) = newCONSTSUB(stash, name, has_constant);
286 /* If this reference was a copy of another, then the subroutine
287 must have been "imported", by a Perl space assignment to a GV
288 from a reference to CV. */
289 if (exported_constant)
290 GvIMPORTED_CV_on(gv);
292 (void) start_subparse(0,0); /* Create empty CV in compcv. */
293 GvCV(gv) = PL_compcv;
297 mro_method_changed_in(GvSTASH(gv)); /* sub Foo::bar($) { (shift) } sub ASDF::baz($); *ASDF::baz = \&Foo::bar */
299 CvFILE_set_from_cop(GvCV(gv), PL_curcop);
300 CvSTASH(GvCV(gv)) = PL_curstash;
302 sv_usepvn_flags(MUTABLE_SV(GvCV(gv)), proto, protolen,
303 SV_HAS_TRAILING_NUL);
309 S_gv_init_sv(pTHX_ GV *gv, const svtype sv_type)
311 PERL_ARGS_ASSERT_GV_INIT_SV;
323 #ifdef PERL_DONT_CREATE_GVSV
331 /* Work round what appears to be a bug in Sun C++ 5.8 2005/10/13
332 If we just cast GvSVn(gv) to void, it ignores evaluating it for
340 =for apidoc gv_fetchmeth
342 Returns the glob with the given C<name> and a defined subroutine or
343 C<NULL>. The glob lives in the given C<stash>, or in the stashes
344 accessible via @ISA and UNIVERSAL::.
346 The argument C<level> should be either 0 or -1. If C<level==0>, as a
347 side-effect creates a glob with the given C<name> in the given C<stash>
348 which in the case of success contains an alias for the subroutine, and sets
349 up caching info for this glob.
351 This function grants C<"SUPER"> token as a postfix of the stash name. The
352 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
353 visible to Perl code. So when calling C<call_sv>, you should not use
354 the GV directly; instead, you should use the method's CV, which can be
355 obtained from the GV with the C<GvCV> macro.
360 /* NOTE: No support for tied ISA */
363 Perl_gv_fetchmeth(pTHX_ HV *stash, const char *name, STRLEN len, I32 level)
371 GV* candidate = NULL;
376 I32 create = (level >= 0) ? 1 : 0;
381 PERL_ARGS_ASSERT_GV_FETCHMETH;
383 /* UNIVERSAL methods should be callable without a stash */
385 create = 0; /* probably appropriate */
386 if(!(stash = gv_stashpvs("UNIVERSAL", 0)))
392 hvname = HvNAME_get(stash);
394 Perl_croak(aTHX_ "Can't use anonymous symbol table for method lookup");
399 DEBUG_o( Perl_deb(aTHX_ "Looking for method %s in package %s\n",name,hvname) );
401 topgen_cmp = HvMROMETA(stash)->cache_gen + PL_sub_generation;
403 /* check locally for a real method or a cache entry */
404 gvp = (GV**)hv_fetch(stash, name, len, create);
408 if (SvTYPE(topgv) != SVt_PVGV)
409 gv_init(topgv, stash, name, len, TRUE);
410 if ((cand_cv = GvCV(topgv))) {
411 /* If genuine method or valid cache entry, use it */
412 if (!GvCVGEN(topgv) || GvCVGEN(topgv) == topgen_cmp) {
416 /* stale cache entry, junk it and move on */
417 SvREFCNT_dec(cand_cv);
418 GvCV(topgv) = cand_cv = NULL;
422 else if (GvCVGEN(topgv) == topgen_cmp) {
423 /* cache indicates no such method definitively */
428 packlen = HvNAMELEN_get(stash);
429 if (packlen >= 7 && strEQ(hvname + packlen - 7, "::SUPER")) {
432 basestash = gv_stashpvn(hvname, packlen, GV_ADD);
433 linear_av = mro_get_linear_isa(basestash);
436 linear_av = mro_get_linear_isa(stash); /* has ourselves at the top of the list */
439 linear_svp = AvARRAY(linear_av) + 1; /* skip over self */
440 items = AvFILLp(linear_av); /* no +1, to skip over self */
442 linear_sv = *linear_svp++;
444 cstash = gv_stashsv(linear_sv, 0);
447 if (ckWARN(WARN_SYNTAX))
448 Perl_warner(aTHX_ packWARN(WARN_SYNTAX), "Can't locate package %"SVf" for @%s::ISA",
449 SVfARG(linear_sv), hvname);
455 gvp = (GV**)hv_fetch(cstash, name, len, 0);
459 if (SvTYPE(candidate) != SVt_PVGV) gv_init(candidate, cstash, name, len, TRUE);
460 if (SvTYPE(candidate) == SVt_PVGV && (cand_cv = GvCV(candidate)) && !GvCVGEN(candidate)) {
462 * Found real method, cache method in topgv if:
463 * 1. topgv has no synonyms (else inheritance crosses wires)
464 * 2. method isn't a stub (else AUTOLOAD fails spectacularly)
466 if (topgv && (GvREFCNT(topgv) == 1) && (CvROOT(cand_cv) || CvXSUB(cand_cv))) {
467 if ((old_cv = GvCV(topgv))) SvREFCNT_dec(old_cv);
468 SvREFCNT_inc_simple_void_NN(cand_cv);
469 GvCV(topgv) = cand_cv;
470 GvCVGEN(topgv) = topgen_cmp;
476 /* Check UNIVERSAL without caching */
477 if(level == 0 || level == -1) {
478 candidate = gv_fetchmeth(NULL, name, len, 1);
480 cand_cv = GvCV(candidate);
481 if (topgv && (GvREFCNT(topgv) == 1) && (CvROOT(cand_cv) || CvXSUB(cand_cv))) {
482 if ((old_cv = GvCV(topgv))) SvREFCNT_dec(old_cv);
483 SvREFCNT_inc_simple_void_NN(cand_cv);
484 GvCV(topgv) = cand_cv;
485 GvCVGEN(topgv) = topgen_cmp;
491 if (topgv && GvREFCNT(topgv) == 1) {
492 /* cache the fact that the method is not defined */
493 GvCVGEN(topgv) = topgen_cmp;
500 =for apidoc gv_fetchmeth_autoload
502 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
503 Returns a glob for the subroutine.
505 For an autoloaded subroutine without a GV, will create a GV even
506 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
507 of the result may be zero.
513 Perl_gv_fetchmeth_autoload(pTHX_ HV *stash, const char *name, STRLEN len, I32 level)
515 GV *gv = gv_fetchmeth(stash, name, len, level);
517 PERL_ARGS_ASSERT_GV_FETCHMETH_AUTOLOAD;
524 return NULL; /* UNIVERSAL::AUTOLOAD could cause trouble */
525 if (len == S_autolen && memEQ(name, S_autoload, S_autolen))
527 if (!(gv = gv_fetchmeth(stash, S_autoload, S_autolen, FALSE)))
530 if (!(CvROOT(cv) || CvXSUB(cv)))
532 /* Have an autoload */
533 if (level < 0) /* Cannot do without a stub */
534 gv_fetchmeth(stash, name, len, 0);
535 gvp = (GV**)hv_fetch(stash, name, len, (level >= 0));
544 =for apidoc gv_fetchmethod_autoload
546 Returns the glob which contains the subroutine to call to invoke the method
547 on the C<stash>. In fact in the presence of autoloading this may be the
548 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
551 The third parameter of C<gv_fetchmethod_autoload> determines whether
552 AUTOLOAD lookup is performed if the given method is not present: non-zero
553 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
554 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
555 with a non-zero C<autoload> parameter.
557 These functions grant C<"SUPER"> token as a prefix of the method name. Note
558 that if you want to keep the returned glob for a long time, you need to
559 check for it being "AUTOLOAD", since at the later time the call may load a
560 different subroutine due to $AUTOLOAD changing its value. Use the glob
561 created via a side effect to do this.
563 These functions have the same side-effects and as C<gv_fetchmeth> with
564 C<level==0>. C<name> should be writable if contains C<':'> or C<'
565 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
566 C<call_sv> apply equally to these functions.
572 S_gv_get_super_pkg(pTHX_ const char* name, I32 namelen)
579 PERL_ARGS_ASSERT_GV_GET_SUPER_PKG;
581 stash = gv_stashpvn(name, namelen, 0);
582 if(stash) return stash;
584 /* If we must create it, give it an @ISA array containing
585 the real package this SUPER is for, so that it's tied
586 into the cache invalidation code correctly */
587 stash = gv_stashpvn(name, namelen, GV_ADD);
588 gvp = (GV**)hv_fetchs(stash, "ISA", TRUE);
590 gv_init(gv, stash, "ISA", 3, TRUE);
591 superisa = GvAVn(gv);
593 sv_magic(MUTABLE_SV(superisa), MUTABLE_SV(gv), PERL_MAGIC_isa, NULL, 0);
595 av_push(superisa, newSVpv(CopSTASHPV(PL_curcop), 0));
597 av_push(superisa, newSVhek(CopSTASH(PL_curcop)
598 ? HvNAME_HEK(CopSTASH(PL_curcop)) : NULL));
605 Perl_gv_fetchmethod_autoload(pTHX_ HV *stash, const char *name, I32 autoload)
607 PERL_ARGS_ASSERT_GV_FETCHMETHOD_AUTOLOAD;
609 return gv_fetchmethod_flags(stash, name, autoload ? GV_AUTOLOAD : 0);
612 /* Don't merge this yet, as it's likely to get a len parameter, and possibly
615 Perl_gv_fetchmethod_flags(pTHX_ HV *stash, const char *name, U32 flags)
618 register const char *nend;
619 const char *nsplit = NULL;
622 const char * const origname = name;
623 SV *const error_report = MUTABLE_SV(stash);
624 const U32 autoload = flags & GV_AUTOLOAD;
625 const U32 do_croak = flags & GV_CROAK;
627 PERL_ARGS_ASSERT_GV_FETCHMETHOD_FLAGS;
629 if (SvTYPE(stash) < SVt_PVHV)
632 /* The only way stash can become NULL later on is if nsplit is set,
633 which in turn means that there is no need for a SVt_PVHV case
634 the error reporting code. */
637 for (nend = name; *nend; nend++) {
642 else if (*nend == ':' && *(nend + 1) == ':') {
648 if ((nsplit - origname) == 5 && memEQ(origname, "SUPER", 5)) {
649 /* ->SUPER::method should really be looked up in original stash */
650 SV * const tmpstr = sv_2mortal(Perl_newSVpvf(aTHX_ "%s::SUPER",
651 CopSTASHPV(PL_curcop)));
652 /* __PACKAGE__::SUPER stash should be autovivified */
653 stash = gv_get_super_pkg(SvPVX_const(tmpstr), SvCUR(tmpstr));
654 DEBUG_o( Perl_deb(aTHX_ "Treating %s as %s::%s\n",
655 origname, HvNAME_get(stash), name) );
658 /* don't autovifify if ->NoSuchStash::method */
659 stash = gv_stashpvn(origname, nsplit - origname, 0);
661 /* however, explicit calls to Pkg::SUPER::method may
662 happen, and may require autovivification to work */
663 if (!stash && (nsplit - origname) >= 7 &&
664 strnEQ(nsplit - 7, "::SUPER", 7) &&
665 gv_stashpvn(origname, nsplit - origname - 7, 0))
666 stash = gv_get_super_pkg(origname, nsplit - origname);
671 gv = gv_fetchmeth(stash, name, nend - name, 0);
673 if (strEQ(name,"import") || strEQ(name,"unimport"))
674 gv = MUTABLE_GV(&PL_sv_yes);
676 gv = gv_autoload4(ostash, name, nend - name, TRUE);
677 if (!gv && do_croak) {
678 /* Right now this is exclusively for the benefit of S_method_common
682 "Can't locate object method \"%s\" via package \"%.*s\"",
683 name, (int)HvNAMELEN_get(stash), HvNAME_get(stash));
687 const char *packname;
690 packlen = nsplit - origname;
693 packname = SvPV_const(error_report, packlen);
697 "Can't locate object method \"%s\" via package \"%.*s\""
698 " (perhaps you forgot to load \"%.*s\"?)",
699 name, (int)packlen, packname, (int)packlen, packname);
704 CV* const cv = GvCV(gv);
705 if (!CvROOT(cv) && !CvXSUB(cv)) {
713 if (GvCV(stubgv) != cv) /* orphaned import */
716 autogv = gv_autoload4(GvSTASH(stubgv),
717 GvNAME(stubgv), GvNAMELEN(stubgv), TRUE);
727 Perl_gv_autoload4(pTHX_ HV *stash, const char *name, STRLEN len, I32 method)
735 const char *packname = "";
736 STRLEN packname_len = 0;
738 PERL_ARGS_ASSERT_GV_AUTOLOAD4;
740 if (len == S_autolen && memEQ(name, S_autoload, S_autolen))
743 if (SvTYPE(stash) < SVt_PVHV) {
744 packname = SvPV_const(MUTABLE_SV(stash), packname_len);
748 packname = HvNAME_get(stash);
749 packname_len = HvNAMELEN_get(stash);
752 if (!(gv = gv_fetchmeth(stash, S_autoload, S_autolen, FALSE)))
756 if (!(CvROOT(cv) || CvXSUB(cv)))
760 * Inheriting AUTOLOAD for non-methods works ... for now.
762 if (!method && (GvCVGEN(gv) || GvSTASH(gv) != stash)
763 && ckWARN2(WARN_DEPRECATED, WARN_SYNTAX)
765 Perl_warner(aTHX_ packWARN2(WARN_DEPRECATED, WARN_SYNTAX),
766 "Use of inherited AUTOLOAD for non-method %s::%.*s() is deprecated",
767 packname, (int)len, name);
770 /* rather than lookup/init $AUTOLOAD here
771 * only to have the XSUB do another lookup for $AUTOLOAD
772 * and split that value on the last '::',
773 * pass along the same data via some unused fields in the CV
776 SvPV_set(cv, (char *)name); /* cast to lose constness warning */
782 * Given &FOO::AUTOLOAD, set $FOO::AUTOLOAD to desired function name.
783 * The subroutine's original name may not be "AUTOLOAD", so we don't
784 * use that, but for lack of anything better we will use the sub's
785 * original package to look up $AUTOLOAD.
787 varstash = GvSTASH(CvGV(cv));
788 vargv = *(GV**)hv_fetch(varstash, S_autoload, S_autolen, TRUE);
792 gv_init(vargv, varstash, S_autoload, S_autolen, FALSE);
793 #ifdef PERL_DONT_CREATE_GVSV
794 GvSV(vargv) = newSV(0);
798 varsv = GvSVn(vargv);
799 sv_setpvn(varsv, packname, packname_len);
800 sv_catpvs(varsv, "::");
801 sv_catpvn(varsv, name, len);
806 /* require_tie_mod() internal routine for requiring a module
807 * that implements the logic of automatical ties like %! and %-
809 * The "gv" parameter should be the glob.
810 * "varpv" holds the name of the var, used for error messages.
811 * "namesv" holds the module name. Its refcount will be decremented.
812 * "methpv" holds the method name to test for to check that things
813 * are working reasonably close to as expected.
814 * "flags": if flag & 1 then save the scalar before loading.
815 * For the protection of $! to work (it is set by this routine)
816 * the sv slot must already be magicalized.
819 S_require_tie_mod(pTHX_ GV *gv, const char *varpv, SV* namesv, const char *methpv,const U32 flags)
822 HV* stash = gv_stashsv(namesv, 0);
824 PERL_ARGS_ASSERT_REQUIRE_TIE_MOD;
826 if (!stash || !(gv_fetchmethod(stash, methpv))) {
827 SV *module = newSVsv(namesv);
828 char varname = *varpv; /* varpv might be clobbered by load_module,
829 so save it. For the moment it's always
835 PUSHSTACKi(PERLSI_MAGIC);
836 Perl_load_module(aTHX_ PERL_LOADMOD_NOIMPORT, module, NULL);
840 stash = gv_stashsv(namesv, 0);
842 Perl_croak(aTHX_ "panic: Can't use %%%c because %"SVf" is not available",
843 varname, SVfARG(namesv));
844 else if (!gv_fetchmethod(stash, methpv))
845 Perl_croak(aTHX_ "panic: Can't use %%%c because %"SVf" does not support method %s",
846 varname, SVfARG(namesv), methpv);
848 SvREFCNT_dec(namesv);
853 =for apidoc gv_stashpv
855 Returns a pointer to the stash for a specified package. Uses C<strlen> to
856 determine the length of C<name>, then calls C<gv_stashpvn()>.
862 Perl_gv_stashpv(pTHX_ const char *name, I32 create)
864 PERL_ARGS_ASSERT_GV_STASHPV;
865 return gv_stashpvn(name, strlen(name), create);
869 =for apidoc gv_stashpvn
871 Returns a pointer to the stash for a specified package. The C<namelen>
872 parameter indicates the length of the C<name>, in bytes. C<flags> is passed
873 to C<gv_fetchpvn_flags()>, so if set to C<GV_ADD> then the package will be
874 created if it does not already exist. If the package does not exist and
875 C<flags> is 0 (or any other setting that does not create packages) then NULL
883 Perl_gv_stashpvn(pTHX_ const char *name, U32 namelen, I32 flags)
890 PERL_ARGS_ASSERT_GV_STASHPVN;
892 if (namelen + 2 <= sizeof smallbuf)
895 Newx(tmpbuf, namelen + 2, char);
896 Copy(name,tmpbuf,namelen,char);
897 tmpbuf[namelen++] = ':';
898 tmpbuf[namelen++] = ':';
899 tmpgv = gv_fetchpvn_flags(tmpbuf, namelen, flags, SVt_PVHV);
900 if (tmpbuf != smallbuf)
905 GvHV(tmpgv) = newHV();
907 if (!HvNAME_get(stash))
908 hv_name_set(stash, name, namelen, 0);
913 =for apidoc gv_stashsv
915 Returns a pointer to the stash for a specified package. See C<gv_stashpvn>.
921 Perl_gv_stashsv(pTHX_ SV *sv, I32 flags)
924 const char * const ptr = SvPV_const(sv,len);
926 PERL_ARGS_ASSERT_GV_STASHSV;
928 return gv_stashpvn(ptr, len, flags);
933 Perl_gv_fetchpv(pTHX_ const char *nambeg, I32 add, const svtype sv_type) {
934 PERL_ARGS_ASSERT_GV_FETCHPV;
935 return gv_fetchpvn_flags(nambeg, strlen(nambeg), add, sv_type);
939 Perl_gv_fetchsv(pTHX_ SV *name, I32 flags, const svtype sv_type) {
941 const char * const nambeg = SvPV_const(name, len);
942 PERL_ARGS_ASSERT_GV_FETCHSV;
943 return gv_fetchpvn_flags(nambeg, len, flags | SvUTF8(name), sv_type);
947 Perl_gv_fetchpvn_flags(pTHX_ const char *nambeg, STRLEN full_len, I32 flags,
948 const svtype sv_type)
951 register const char *name = nambeg;
952 register GV *gv = NULL;
955 register const char *name_cursor;
957 const I32 no_init = flags & (GV_NOADD_NOINIT | GV_NOINIT);
958 const I32 no_expand = flags & GV_NOEXPAND;
959 const I32 add = flags & ~GV_NOADD_MASK;
960 const char *const name_end = nambeg + full_len;
961 const char *const name_em1 = name_end - 1;
964 PERL_ARGS_ASSERT_GV_FETCHPVN_FLAGS;
966 if (flags & GV_NOTQUAL) {
967 /* Caller promised that there is no stash, so we can skip the check. */
972 if (full_len > 2 && *name == '*' && isALPHA(name[1])) {
973 /* accidental stringify on a GV? */
977 for (name_cursor = name; name_cursor < name_end; name_cursor++) {
978 if ((*name_cursor == ':' && name_cursor < name_em1
979 && name_cursor[1] == ':')
980 || (*name_cursor == '\'' && name_cursor[1]))
984 if (!stash || !SvREFCNT(stash)) /* symbol table under destruction */
987 len = name_cursor - name;
992 if (len + 2 <= (I32)sizeof (smallbuf))
995 Newx(tmpbuf, len+2, char);
996 Copy(name, tmpbuf, len, char);
999 gvp = (GV**)hv_fetch(stash,tmpbuf,len,add);
1000 gv = gvp ? *gvp : NULL;
1001 if (gv && gv != (const GV *)&PL_sv_undef) {
1002 if (SvTYPE(gv) != SVt_PVGV)
1003 gv_init(gv, stash, tmpbuf, len, (add & GV_ADDMULTI));
1007 if (tmpbuf != smallbuf)
1009 if (!gv || gv == (const GV *)&PL_sv_undef)
1012 if (!(stash = GvHV(gv)))
1013 stash = GvHV(gv) = newHV();
1015 if (!HvNAME_get(stash))
1016 hv_name_set(stash, nambeg, name_cursor - nambeg, 0);
1019 if (*name_cursor == ':')
1023 if (name == name_end)
1025 ? gv : MUTABLE_GV(*hv_fetchs(PL_defstash, "main::", TRUE));
1028 len = name_cursor - name;
1030 /* No stash in name, so see how we can default */
1034 if (len && isIDFIRST_lazy(name)) {
1035 bool global = FALSE;
1043 if ((name[0] == 'I' && name[1] == 'N' && name[2] == 'C')
1044 || (name[0] == 'E' && name[1] == 'N' && name[2] == 'V')
1045 || (name[0] == 'S' && name[1] == 'I' && name[2] == 'G'))
1049 if (name[0] == 'A' && name[1] == 'R' && name[2] == 'G'
1054 if (name[0] == 'S' && name[1] == 'T' && name[2] == 'D'
1055 && name[3] == 'I' && name[4] == 'N')
1059 if ((name[0] == 'S' && name[1] == 'T' && name[2] == 'D')
1060 &&((name[3] == 'O' && name[4] == 'U' && name[5] == 'T')
1061 ||(name[3] == 'E' && name[4] == 'R' && name[5] == 'R')))
1065 if (name[0] == 'A' && name[1] == 'R' && name[2] == 'G'
1066 && name[3] == 'V' && name[4] == 'O' && name[5] == 'U'
1073 stash = PL_defstash;
1074 else if (IN_PERL_COMPILETIME) {
1075 stash = PL_curstash;
1076 if (add && (PL_hints & HINT_STRICT_VARS) &&
1077 sv_type != SVt_PVCV &&
1078 sv_type != SVt_PVGV &&
1079 sv_type != SVt_PVFM &&
1080 sv_type != SVt_PVIO &&
1081 !(len == 1 && sv_type == SVt_PV &&
1082 (*name == 'a' || *name == 'b')) )
1084 gvp = (GV**)hv_fetch(stash,name,len,0);
1086 *gvp == (const GV *)&PL_sv_undef ||
1087 SvTYPE(*gvp) != SVt_PVGV)
1091 else if ((sv_type == SVt_PV && !GvIMPORTED_SV(*gvp)) ||
1092 (sv_type == SVt_PVAV && !GvIMPORTED_AV(*gvp)) ||
1093 (sv_type == SVt_PVHV && !GvIMPORTED_HV(*gvp)) )
1095 Perl_warn(aTHX_ "Variable \"%c%s\" is not imported",
1096 sv_type == SVt_PVAV ? '@' :
1097 sv_type == SVt_PVHV ? '%' : '$',
1100 Perl_warn(aTHX_ "\t(Did you mean &%s instead?)\n", name);
1106 stash = CopSTASH(PL_curcop);
1109 stash = PL_defstash;
1112 /* By this point we should have a stash and a name */
1116 SV * const err = Perl_mess(aTHX_
1117 "Global symbol \"%s%s\" requires explicit package name",
1118 (sv_type == SVt_PV ? "$"
1119 : sv_type == SVt_PVAV ? "@"
1120 : sv_type == SVt_PVHV ? "%"
1123 if (USE_UTF8_IN_NAMES)
1126 gv = gv_fetchpvs("<none>::", GV_ADDMULTI, SVt_PVHV);
1128 /* symbol table under destruction */
1137 if (!SvREFCNT(stash)) /* symbol table under destruction */
1140 gvp = (GV**)hv_fetch(stash,name,len,add);
1141 if (!gvp || *gvp == (const GV *)&PL_sv_undef)
1144 if (SvTYPE(gv) == SVt_PVGV) {
1147 gv_init_sv(gv, sv_type);
1148 if (len == 1 && (sv_type == SVt_PVHV || sv_type == SVt_PVGV)) {
1150 require_tie_mod(gv, "!", newSVpvs("Errno"), "TIEHASH", 1);
1151 else if (*name == '-' || *name == '+')
1152 require_tie_mod(gv, name, newSVpvs("Tie::Hash::NamedCapture"), "TIEHASH", 0);
1156 } else if (no_init) {
1158 } else if (no_expand && SvROK(gv)) {
1162 /* Adding a new symbol.
1163 Unless of course there was already something non-GV here, in which case
1164 we want to behave as if there was always a GV here, containing some sort
1166 Otherwise we run the risk of creating things like GvIO, which can cause
1167 subtle bugs. eg the one that tripped up SQL::Translator */
1169 faking_it = SvOK(gv);
1171 if (add & GV_ADDWARN && ckWARN_d(WARN_INTERNAL))
1172 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Had to create %s unexpectedly", nambeg);
1173 gv_init(gv, stash, name, len, add & GV_ADDMULTI);
1174 gv_init_sv(gv, faking_it ? SVt_PVCV : sv_type);
1176 if (isALPHA(name[0]) && ! (isLEXWARN_on ? ckWARN(WARN_ONCE)
1177 : (PL_dowarn & G_WARN_ON ) ) )
1180 /* set up magic where warranted */
1185 /* Nothing else to do.
1186 The compiler will probably turn the switch statement into a
1187 branch table. Make sure we avoid even that small overhead for
1188 the common case of lower case variable names. */
1192 const char * const name2 = name + 1;
1195 if (strEQ(name2, "RGV")) {
1196 IoFLAGS(GvIOn(gv)) |= IOf_ARGV|IOf_START;
1198 else if (strEQ(name2, "RGVOUT")) {
1203 if (strnEQ(name2, "XPORT", 5))
1207 if (strEQ(name2, "SA")) {
1208 AV* const av = GvAVn(gv);
1210 sv_magic(MUTABLE_SV(av), MUTABLE_SV(gv), PERL_MAGIC_isa,
1212 /* NOTE: No support for tied ISA */
1213 if ((add & GV_ADDMULTI) && strEQ(nambeg,"AnyDBM_File::ISA")
1214 && AvFILLp(av) == -1)
1217 av_push(av, newSVpvs(pname = "NDBM_File"));
1218 gv_stashpvn(pname, 9, GV_ADD);
1219 av_push(av, newSVpvs(pname = "DB_File"));
1220 gv_stashpvn(pname, 7, GV_ADD);
1221 av_push(av, newSVpvs(pname = "GDBM_File"));
1222 gv_stashpvn(pname, 9, GV_ADD);
1223 av_push(av, newSVpvs(pname = "SDBM_File"));
1224 gv_stashpvn(pname, 9, GV_ADD);
1225 av_push(av, newSVpvs(pname = "ODBM_File"));
1226 gv_stashpvn(pname, 9, GV_ADD);
1231 if (strEQ(name2, "VERLOAD")) {
1232 HV* const hv = GvHVn(gv);
1234 hv_magic(hv, NULL, PERL_MAGIC_overload);
1238 if (strEQ(name2, "IG")) {
1242 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
1243 Newxz(PL_psig_name, SIG_SIZE, SV*);
1244 Newxz(PL_psig_pend, SIG_SIZE, int);
1248 hv_magic(hv, NULL, PERL_MAGIC_sig);
1249 for (i = 1; i < SIG_SIZE; i++) {
1250 SV * const * const init = hv_fetch(hv, PL_sig_name[i], strlen(PL_sig_name[i]), 1);
1252 sv_setsv(*init, &PL_sv_undef);
1254 PL_psig_name[i] = 0;
1255 PL_psig_pend[i] = 0;
1260 if (strEQ(name2, "ERSION"))
1263 case '\003': /* $^CHILD_ERROR_NATIVE */
1264 if (strEQ(name2, "HILD_ERROR_NATIVE"))
1267 case '\005': /* $^ENCODING */
1268 if (strEQ(name2, "NCODING"))
1271 case '\015': /* $^MATCH */
1272 if (strEQ(name2, "ATCH"))
1274 case '\017': /* $^OPEN */
1275 if (strEQ(name2, "PEN"))
1278 case '\020': /* $^PREMATCH $^POSTMATCH */
1279 if (strEQ(name2, "REMATCH") || strEQ(name2, "OSTMATCH"))
1281 case '\024': /* ${^TAINT} */
1282 if (strEQ(name2, "AINT"))
1285 case '\025': /* ${^UNICODE}, ${^UTF8LOCALE} */
1286 if (strEQ(name2, "NICODE"))
1288 if (strEQ(name2, "TF8LOCALE"))
1290 if (strEQ(name2, "TF8CACHE"))
1293 case '\027': /* $^WARNING_BITS */
1294 if (strEQ(name2, "ARNING_BITS"))
1307 /* Ensures that we have an all-digit variable, ${"1foo"} fails
1309 /* This snippet is taken from is_gv_magical */
1310 const char *end = name + len;
1311 while (--end > name) {
1312 if (!isDIGIT(*end)) return gv;
1319 /* Names of length 1. (Or 0. But name is NUL terminated, so that will
1320 be case '\0' in this switch statement (ie a default case) */
1326 sv_type == SVt_PVAV ||
1327 sv_type == SVt_PVHV ||
1328 sv_type == SVt_PVCV ||
1329 sv_type == SVt_PVFM ||
1332 PL_sawampersand = TRUE;
1336 sv_setpv(GvSVn(gv),PL_chopset);
1340 #ifdef COMPLEX_STATUS
1341 SvUPGRADE(GvSVn(gv), SVt_PVLV);
1347 /* If %! has been used, automatically load Errno.pm. */
1349 sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
1351 /* magicalization must be done before require_tie_mod is called */
1352 if (sv_type == SVt_PVHV || sv_type == SVt_PVGV)
1353 require_tie_mod(gv, "!", newSVpvs("Errno"), "TIEHASH", 1);
1358 GvMULTI_on(gv); /* no used once warnings here */
1360 AV* const av = GvAVn(gv);
1361 SV* const avc = (*name == '+') ? MUTABLE_SV(av) : NULL;
1363 sv_magic(MUTABLE_SV(av), avc, PERL_MAGIC_regdata, NULL, 0);
1364 sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
1366 SvREADONLY_on(GvSVn(gv));
1369 if (sv_type == SVt_PVHV || sv_type == SVt_PVGV)
1370 require_tie_mod(gv, name, newSVpvs("Tie::Hash::NamedCapture"), "TIEHASH", 0);
1376 if (sv_type == SVt_PV && ckWARN2_d(WARN_DEPRECATED, WARN_SYNTAX))
1377 Perl_warner(aTHX_ packWARN2(WARN_DEPRECATED, WARN_SYNTAX),
1378 "$%c is no longer supported", *name);
1381 sv_setiv(GvSVn(gv), (IV)(IoFLAGS(GvIOp(PL_defoutgv)) & IOf_FLUSH) != 0);
1384 case '\010': /* $^H */
1386 HV *const hv = GvHVn(gv);
1387 hv_magic(hv, NULL, PERL_MAGIC_hints);
1390 case '\023': /* $^S */
1392 SvREADONLY_on(GvSVn(gv));
1416 case '\001': /* $^A */
1417 case '\003': /* $^C */
1418 case '\004': /* $^D */
1419 case '\005': /* $^E */
1420 case '\006': /* $^F */
1421 case '\011': /* $^I, NOT \t in EBCDIC */
1422 case '\016': /* $^N */
1423 case '\017': /* $^O */
1424 case '\020': /* $^P */
1425 case '\024': /* $^T */
1426 case '\027': /* $^W */
1428 sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
1431 case '\014': /* $^L */
1432 sv_setpvs(GvSVn(gv),"\f");
1433 PL_formfeed = GvSVn(gv);
1436 sv_setpvs(GvSVn(gv),"\034");
1440 SV * const sv = GvSVn(gv);
1441 if (!sv_derived_from(PL_patchlevel, "version"))
1442 upg_version(PL_patchlevel, TRUE);
1443 GvSV(gv) = vnumify(PL_patchlevel);
1444 SvREADONLY_on(GvSV(gv));
1448 case '\026': /* $^V */
1450 SV * const sv = GvSVn(gv);
1451 GvSV(gv) = new_version(PL_patchlevel);
1452 SvREADONLY_on(GvSV(gv));
1462 Perl_gv_fullname4(pTHX_ SV *sv, const GV *gv, const char *prefix, bool keepmain)
1466 const HV * const hv = GvSTASH(gv);
1468 PERL_ARGS_ASSERT_GV_FULLNAME4;
1474 sv_setpv(sv, prefix ? prefix : "");
1476 name = HvNAME_get(hv);
1478 namelen = HvNAMELEN_get(hv);
1484 if (keepmain || strNE(name, "main")) {
1485 sv_catpvn(sv,name,namelen);
1488 sv_catpvn(sv,GvNAME(gv),GvNAMELEN(gv));
1492 Perl_gv_efullname4(pTHX_ SV *sv, const GV *gv, const char *prefix, bool keepmain)
1494 const GV * const egv = GvEGV(gv);
1496 PERL_ARGS_ASSERT_GV_EFULLNAME4;
1498 gv_fullname4(sv, egv ? egv : gv, prefix, keepmain);
1506 IO * const io = MUTABLE_IO(newSV_type(SVt_PVIO));
1507 /* This used to read SvREFCNT(io) = 1;
1508 It's not clear why the reference count needed an explicit reset. NWC
1510 assert (SvREFCNT(io) == 1);
1512 /* Clear the stashcache because a new IO could overrule a package name */
1513 hv_clear(PL_stashcache);
1514 iogv = gv_fetchpvs("FileHandle::", 0, SVt_PVHV);
1515 /* unless exists($main::{FileHandle}) and defined(%main::FileHandle::) */
1516 if (!(iogv && GvHV(iogv) && HvARRAY(GvHV(iogv))))
1517 iogv = gv_fetchpvs("IO::Handle::", GV_ADD, SVt_PVHV);
1518 SvSTASH_set(io, MUTABLE_HV(SvREFCNT_inc(GvHV(iogv))));
1523 Perl_gv_check(pTHX_ const HV *stash)
1528 PERL_ARGS_ASSERT_GV_CHECK;
1530 if (!HvARRAY(stash))
1532 for (i = 0; i <= (I32) HvMAX(stash); i++) {
1534 for (entry = HvARRAY(stash)[i]; entry; entry = HeNEXT(entry)) {
1537 if (HeKEY(entry)[HeKLEN(entry)-1] == ':' &&
1538 (gv = MUTABLE_GV(HeVAL(entry))) && isGV(gv) && (hv = GvHV(gv)))
1540 if (hv != PL_defstash && hv != stash)
1541 gv_check(hv); /* nested package */
1543 else if (isALPHA(*HeKEY(entry))) {
1545 gv = MUTABLE_GV(HeVAL(entry));
1546 if (SvTYPE(gv) != SVt_PVGV || GvMULTI(gv))
1549 CopLINE_set(PL_curcop, GvLINE(gv));
1551 CopFILE(PL_curcop) = (char *)file; /* set for warning */
1553 CopFILEGV(PL_curcop)
1554 = gv_fetchfile_flags(file, HEK_LEN(GvFILE_HEK(gv)), 0);
1556 Perl_warner(aTHX_ packWARN(WARN_ONCE),
1557 "Name \"%s::%s\" used only once: possible typo",
1558 HvNAME_get(stash), GvNAME(gv));
1565 Perl_newGVgen(pTHX_ const char *pack)
1569 PERL_ARGS_ASSERT_NEWGVGEN;
1571 return gv_fetchpv(Perl_form(aTHX_ "%s::_GEN_%ld", pack, (long)PL_gensym++),
1575 /* hopefully this is only called on local symbol table entries */
1578 Perl_gp_ref(pTHX_ GP *gp)
1586 /* If the GP they asked for a reference to contains
1587 a method cache entry, clear it first, so that we
1588 don't infect them with our cached entry */
1589 SvREFCNT_dec(gp->gp_cv);
1598 Perl_gp_free(pTHX_ GV *gv)
1603 if (!gv || !isGV_with_GP(gv) || !(gp = GvGP(gv)))
1605 if (gp->gp_refcnt == 0) {
1606 if (ckWARN_d(WARN_INTERNAL))
1607 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1608 "Attempt to free unreferenced glob pointers"
1609 pTHX__FORMAT pTHX__VALUE);
1612 if (--gp->gp_refcnt > 0) {
1613 if (gp->gp_egv == gv)
1619 if (gp->gp_file_hek)
1620 unshare_hek(gp->gp_file_hek);
1621 SvREFCNT_dec(gp->gp_sv);
1622 SvREFCNT_dec(gp->gp_av);
1623 /* FIXME - another reference loop GV -> symtab -> GV ?
1624 Somehow gp->gp_hv can end up pointing at freed garbage. */
1625 if (gp->gp_hv && SvTYPE(gp->gp_hv) == SVt_PVHV) {
1626 const char *hvname = HvNAME_get(gp->gp_hv);
1627 if (PL_stashcache && hvname)
1628 (void)hv_delete(PL_stashcache, hvname, HvNAMELEN_get(gp->gp_hv),
1630 SvREFCNT_dec(gp->gp_hv);
1632 SvREFCNT_dec(gp->gp_io);
1633 SvREFCNT_dec(gp->gp_cv);
1634 SvREFCNT_dec(gp->gp_form);
1641 Perl_magic_freeovrld(pTHX_ SV *sv, MAGIC *mg)
1643 AMT * const amtp = (AMT*)mg->mg_ptr;
1644 PERL_UNUSED_ARG(sv);
1646 PERL_ARGS_ASSERT_MAGIC_FREEOVRLD;
1648 if (amtp && AMT_AMAGIC(amtp)) {
1650 for (i = 1; i < NofAMmeth; i++) {
1651 CV * const cv = amtp->table[i];
1653 SvREFCNT_dec(MUTABLE_SV(cv));
1654 amtp->table[i] = NULL;
1661 /* Updates and caches the CV's */
1664 Perl_Gv_AMupdate(pTHX_ HV *stash)
1667 MAGIC* const mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
1669 const struct mro_meta* stash_meta = HvMROMETA(stash);
1672 PERL_ARGS_ASSERT_GV_AMUPDATE;
1674 newgen = PL_sub_generation + stash_meta->pkg_gen + stash_meta->cache_gen;
1676 const AMT * const amtp = (AMT*)mg->mg_ptr;
1677 if (amtp->was_ok_am == PL_amagic_generation
1678 && amtp->was_ok_sub == newgen) {
1679 return (bool)AMT_OVERLOADED(amtp);
1681 sv_unmagic(MUTABLE_SV(stash), PERL_MAGIC_overload_table);
1684 DEBUG_o( Perl_deb(aTHX_ "Recalcing overload magic in package %s\n",HvNAME_get(stash)) );
1687 amt.was_ok_am = PL_amagic_generation;
1688 amt.was_ok_sub = newgen;
1689 amt.fallback = AMGfallNO;
1693 int filled = 0, have_ovl = 0;
1696 /* Work with "fallback" key, which we assume to be first in PL_AMG_names */
1698 /* Try to find via inheritance. */
1699 GV *gv = gv_fetchmeth(stash, PL_AMG_names[0], 2, -1);
1700 SV * const sv = gv ? GvSV(gv) : NULL;
1704 lim = DESTROY_amg; /* Skip overloading entries. */
1705 #ifdef PERL_DONT_CREATE_GVSV
1707 NOOP; /* Equivalent to !SvTRUE and !SvOK */
1710 else if (SvTRUE(sv))
1711 amt.fallback=AMGfallYES;
1713 amt.fallback=AMGfallNEVER;
1715 for (i = 1; i < lim; i++)
1716 amt.table[i] = NULL;
1717 for (; i < NofAMmeth; i++) {
1718 const char * const cooky = PL_AMG_names[i];
1719 /* Human-readable form, for debugging: */
1720 const char * const cp = (i >= DESTROY_amg ? cooky : AMG_id2name(i));
1721 const STRLEN l = PL_AMG_namelens[i];
1723 DEBUG_o( Perl_deb(aTHX_ "Checking overloading of \"%s\" in package \"%.256s\"\n",
1724 cp, HvNAME_get(stash)) );
1725 /* don't fill the cache while looking up!
1726 Creation of inheritance stubs in intermediate packages may
1727 conflict with the logic of runtime method substitution.
1728 Indeed, for inheritance A -> B -> C, if C overloads "+0",
1729 then we could have created stubs for "(+0" in A and C too.
1730 But if B overloads "bool", we may want to use it for
1731 numifying instead of C's "+0". */
1732 if (i >= DESTROY_amg)
1733 gv = Perl_gv_fetchmeth_autoload(aTHX_ stash, cooky, l, 0);
1734 else /* Autoload taken care of below */
1735 gv = Perl_gv_fetchmeth(aTHX_ stash, cooky, l, -1);
1737 if (gv && (cv = GvCV(gv))) {
1739 if (GvNAMELEN(CvGV(cv)) == 3 && strEQ(GvNAME(CvGV(cv)), "nil")
1740 && strEQ(hvname = HvNAME_get(GvSTASH(CvGV(cv))), "overload")) {
1741 /* This is a hack to support autoloading..., while
1742 knowing *which* methods were declared as overloaded. */
1743 /* GvSV contains the name of the method. */
1745 SV *gvsv = GvSV(gv);
1747 DEBUG_o( Perl_deb(aTHX_ "Resolving method \"%"SVf256\
1748 "\" for overloaded \"%s\" in package \"%.256s\"\n",
1749 (void*)GvSV(gv), cp, hvname) );
1750 if (!gvsv || !SvPOK(gvsv)
1751 || !(ngv = gv_fetchmethod_autoload(stash, SvPVX_const(gvsv),
1754 /* Can be an import stub (created by "can"). */
1755 const char * const name = (gvsv && SvPOK(gvsv)) ? SvPVX_const(gvsv) : "???";
1756 Perl_croak(aTHX_ "%s method \"%.256s\" overloading \"%s\" "\
1757 "in package \"%.256s\"",
1758 (GvCVGEN(gv) ? "Stub found while resolving"
1762 cv = GvCV(gv = ngv);
1764 DEBUG_o( Perl_deb(aTHX_ "Overloading \"%s\" in package \"%.256s\" via \"%.256s::%.256s\"\n",
1765 cp, HvNAME_get(stash), HvNAME_get(GvSTASH(CvGV(cv))),
1766 GvNAME(CvGV(cv))) );
1768 if (i < DESTROY_amg)
1770 } else if (gv) { /* Autoloaded... */
1771 cv = MUTABLE_CV(gv);
1774 amt.table[i]=MUTABLE_CV(SvREFCNT_inc_simple(cv));
1777 AMT_AMAGIC_on(&amt);
1779 AMT_OVERLOADED_on(&amt);
1780 sv_magic(MUTABLE_SV(stash), 0, PERL_MAGIC_overload_table,
1781 (char*)&amt, sizeof(AMT));
1785 /* Here we have no table: */
1787 AMT_AMAGIC_off(&amt);
1788 sv_magic(MUTABLE_SV(stash), 0, PERL_MAGIC_overload_table,
1789 (char*)&amt, sizeof(AMTS));
1795 Perl_gv_handler(pTHX_ HV *stash, I32 id)
1801 struct mro_meta* stash_meta;
1803 if (!stash || !HvNAME_get(stash))
1806 stash_meta = HvMROMETA(stash);
1807 newgen = PL_sub_generation + stash_meta->pkg_gen + stash_meta->cache_gen;
1809 mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
1813 mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
1816 amtp = (AMT*)mg->mg_ptr;
1817 if ( amtp->was_ok_am != PL_amagic_generation
1818 || amtp->was_ok_sub != newgen )
1820 if (AMT_AMAGIC(amtp)) {
1821 CV * const ret = amtp->table[id];
1822 if (ret && isGV(ret)) { /* Autoloading stab */
1823 /* Passing it through may have resulted in a warning
1824 "Inherited AUTOLOAD for a non-method deprecated", since
1825 our caller is going through a function call, not a method call.
1826 So return the CV for AUTOLOAD, setting $AUTOLOAD. */
1827 GV * const gv = gv_fetchmethod(stash, PL_AMG_names[id]);
1840 Perl_amagic_call(pTHX_ SV *left, SV *right, int method, int flags)
1845 CV **cvp=NULL, **ocvp=NULL;
1846 AMT *amtp=NULL, *oamtp=NULL;
1847 int off = 0, off1, lr = 0, notfound = 0;
1848 int postpr = 0, force_cpy = 0;
1849 int assign = AMGf_assign & flags;
1850 const int assignshift = assign ? 1 : 0;
1856 PERL_ARGS_ASSERT_AMAGIC_CALL;
1858 if (!(AMGf_noleft & flags) && SvAMAGIC(left)
1859 && (stash = SvSTASH(SvRV(left)))
1860 && (mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table))
1861 && (ocvp = cvp = (AMT_AMAGIC((AMT*)mg->mg_ptr)
1862 ? (oamtp = amtp = (AMT*)mg->mg_ptr)->table
1864 && ((cv = cvp[off=method+assignshift])
1865 || (assign && amtp->fallback > AMGfallNEVER && /* fallback to
1871 cv = cvp[off=method])))) {
1872 lr = -1; /* Call method for left argument */
1874 if (cvp && amtp->fallback > AMGfallNEVER && flags & AMGf_unary) {
1877 /* look for substituted methods */
1878 /* In all the covered cases we should be called with assign==0. */
1882 if ((cv = cvp[off=add_ass_amg])
1883 || ((cv = cvp[off = add_amg]) && (force_cpy = 0, postpr = 1))) {
1884 right = &PL_sv_yes; lr = -1; assign = 1;
1889 if ((cv = cvp[off = subtr_ass_amg])
1890 || ((cv = cvp[off = subtr_amg]) && (force_cpy = 0, postpr=1))) {
1891 right = &PL_sv_yes; lr = -1; assign = 1;
1895 (void)((cv = cvp[off=numer_amg]) || (cv = cvp[off=string_amg]));
1898 (void)((cv = cvp[off=string_amg]) || (cv = cvp[off=bool__amg]));
1901 (void)((cv = cvp[off=numer_amg]) || (cv = cvp[off=bool__amg]));
1904 (void)((cv = cvp[off=bool__amg])
1905 || (cv = cvp[off=numer_amg])
1906 || (cv = cvp[off=string_amg]));
1912 * SV* ref causes confusion with the interpreter variable of
1915 SV* const tmpRef=SvRV(left);
1916 if (!SvROK(tmpRef) && SvTYPE(tmpRef) <= SVt_PVMG) {
1918 * Just to be extra cautious. Maybe in some
1919 * additional cases sv_setsv is safe, too.
1921 SV* const newref = newSVsv(tmpRef);
1922 SvOBJECT_on(newref);
1923 /* As a bit of a source compatibility hack, SvAMAGIC() and
1924 friends dereference an RV, to behave the same was as when
1925 overloading was stored on the reference, not the referant.
1926 Hence we can't use SvAMAGIC_on()
1928 SvFLAGS(newref) |= SVf_AMAGIC;
1929 SvSTASH_set(newref, MUTABLE_HV(SvREFCNT_inc(SvSTASH(tmpRef))));
1935 if ((cvp[off1=lt_amg] || cvp[off1=ncmp_amg])
1936 && ((cv = cvp[off=neg_amg]) || (cv = cvp[off=subtr_amg]))) {
1937 SV* const nullsv=sv_2mortal(newSViv(0));
1939 SV* const lessp = amagic_call(left,nullsv,
1940 lt_amg,AMGf_noright);
1941 logic = SvTRUE(lessp);
1943 SV* const lessp = amagic_call(left,nullsv,
1944 ncmp_amg,AMGf_noright);
1945 logic = (SvNV(lessp) < 0);
1948 if (off==subtr_amg) {
1959 if ((cv = cvp[off=subtr_amg])) {
1961 left = sv_2mortal(newSViv(0));
1966 case iter_amg: /* XXXX Eventually should do to_gv. */
1968 return NULL; /* Delegate operation to standard mechanisms. */
1976 return left; /* Delegate operation to standard mechanisms. */
1981 if (!cv) goto not_found;
1982 } else if (!(AMGf_noright & flags) && SvAMAGIC(right)
1983 && (stash = SvSTASH(SvRV(right)))
1984 && (mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table))
1985 && (cvp = (AMT_AMAGIC((AMT*)mg->mg_ptr)
1986 ? (amtp = (AMT*)mg->mg_ptr)->table
1988 && (cv = cvp[off=method])) { /* Method for right
1991 } else if (((ocvp && oamtp->fallback > AMGfallNEVER
1992 && (cvp=ocvp) && (lr = -1))
1993 || (cvp && amtp->fallback > AMGfallNEVER && (lr=1)))
1994 && !(flags & AMGf_unary)) {
1995 /* We look for substitution for
1996 * comparison operations and
1998 if (method==concat_amg || method==concat_ass_amg
1999 || method==repeat_amg || method==repeat_ass_amg) {
2000 return NULL; /* Delegate operation to string conversion */
2010 postpr = 1; off=ncmp_amg; break;
2017 postpr = 1; off=scmp_amg; break;
2019 if (off != -1) cv = cvp[off];
2024 not_found: /* No method found, either report or croak */
2045 return left; /* Delegate operation to standard mechanisms. */
2048 if (ocvp && (cv=ocvp[nomethod_amg])) { /* Call report method */
2049 notfound = 1; lr = -1;
2050 } else if (cvp && (cv=cvp[nomethod_amg])) {
2051 notfound = 1; lr = 1;
2052 } else if ((amtp && amtp->fallback >= AMGfallYES) && !DEBUG_o_TEST) {
2053 /* Skip generating the "no method found" message. */
2057 if (off==-1) off=method;
2058 msg = sv_2mortal(Perl_newSVpvf(aTHX_
2059 "Operation \"%s\": no method found,%sargument %s%s%s%s",
2060 AMG_id2name(method + assignshift),
2061 (flags & AMGf_unary ? " " : "\n\tleft "),
2063 "in overloaded package ":
2064 "has no overloaded magic",
2066 HvNAME_get(SvSTASH(SvRV(left))):
2069 ",\n\tright argument in overloaded package ":
2072 : ",\n\tright argument has no overloaded magic"),
2074 HvNAME_get(SvSTASH(SvRV(right))):
2076 if (amtp && amtp->fallback >= AMGfallYES) {
2077 DEBUG_o( Perl_deb(aTHX_ "%s", SvPVX_const(msg)) );
2079 Perl_croak(aTHX_ "%"SVf, SVfARG(msg));
2083 force_cpy = force_cpy || assign;
2088 DEBUG_o(Perl_deb(aTHX_
2089 "Overloaded operator \"%s\"%s%s%s:\n\tmethod%s found%s in package %s%s\n",
2091 method+assignshift==off? "" :
2093 method+assignshift==off? "" :
2094 AMG_id2name(method+assignshift),
2095 method+assignshift==off? "" : "\")",
2096 flags & AMGf_unary? "" :
2097 lr==1 ? " for right argument": " for left argument",
2098 flags & AMGf_unary? " for argument" : "",
2099 stash ? HvNAME_get(stash) : "null",
2100 fl? ",\n\tassignment variant used": "") );
2103 /* Since we use shallow copy during assignment, we need
2104 * to dublicate the contents, probably calling user-supplied
2105 * version of copy operator
2107 /* We need to copy in following cases:
2108 * a) Assignment form was called.
2109 * assignshift==1, assign==T, method + 1 == off
2110 * b) Increment or decrement, called directly.
2111 * assignshift==0, assign==0, method + 0 == off
2112 * c) Increment or decrement, translated to assignment add/subtr.
2113 * assignshift==0, assign==T,
2115 * d) Increment or decrement, translated to nomethod.
2116 * assignshift==0, assign==0,
2118 * e) Assignment form translated to nomethod.
2119 * assignshift==1, assign==T, method + 1 != off
2122 /* off is method, method+assignshift, or a result of opcode substitution.
2123 * In the latter case assignshift==0, so only notfound case is important.
2125 if (( (method + assignshift == off)
2126 && (assign || (method == inc_amg) || (method == dec_amg)))
2133 const bool oldcatch = CATCH_GET;
2136 Zero(&myop, 1, BINOP);
2137 myop.op_last = (OP *) &myop;
2138 myop.op_next = NULL;
2139 myop.op_flags = OPf_WANT_SCALAR | OPf_STACKED;
2141 PUSHSTACKi(PERLSI_OVERLOAD);
2144 PL_op = (OP *) &myop;
2145 if (PERLDB_SUB && PL_curstash != PL_debstash)
2146 PL_op->op_private |= OPpENTERSUB_DB;
2150 EXTEND(SP, notfound + 5);
2151 PUSHs(lr>0? right: left);
2152 PUSHs(lr>0? left: right);
2153 PUSHs( lr > 0 ? &PL_sv_yes : ( assign ? &PL_sv_undef : &PL_sv_no ));
2155 PUSHs(newSVpvn_flags(AMG_id2name(method + assignshift),
2156 AMG_id2namelen(method + assignshift), SVs_TEMP));
2158 PUSHs(MUTABLE_SV(cv));
2161 if ((PL_op = Perl_pp_entersub(aTHX)))
2169 CATCH_SET(oldcatch);
2176 ans=SvIV(res)<=0; break;
2179 ans=SvIV(res)<0; break;
2182 ans=SvIV(res)>=0; break;
2185 ans=SvIV(res)>0; break;
2188 ans=SvIV(res)==0; break;
2191 ans=SvIV(res)!=0; break;
2194 SvSetSV(left,res); return left;
2196 ans=!SvTRUE(res); break;
2201 } else if (method==copy_amg) {
2203 Perl_croak(aTHX_ "Copy method did not return a reference");
2205 return SvREFCNT_inc(SvRV(res));
2213 =for apidoc is_gv_magical_sv
2215 Returns C<TRUE> if given the name of a magical GV. Calls is_gv_magical.
2221 Perl_is_gv_magical_sv(pTHX_ SV *name, U32 flags)
2224 const char * const temp = SvPV_const(name, len);
2226 PERL_ARGS_ASSERT_IS_GV_MAGICAL_SV;
2228 return is_gv_magical(temp, len, flags);
2232 =for apidoc is_gv_magical
2234 Returns C<TRUE> if given the name of a magical GV.
2236 Currently only useful internally when determining if a GV should be
2237 created even in rvalue contexts.
2239 C<flags> is not used at present but available for future extension to
2240 allow selecting particular classes of magical variable.
2242 Currently assumes that C<name> is NUL terminated (as well as len being valid).
2243 This assumption is met by all callers within the perl core, which all pass
2244 pointers returned by SvPV.
2249 Perl_is_gv_magical(pTHX_ const char *name, STRLEN len, U32 flags)
2251 PERL_UNUSED_CONTEXT;
2252 PERL_UNUSED_ARG(flags);
2254 PERL_ARGS_ASSERT_IS_GV_MAGICAL;
2257 const char * const name1 = name + 1;
2260 if (len == 3 && name[1] == 'S' && name[2] == 'A')
2264 if (len == 8 && strEQ(name1, "VERLOAD"))
2268 if (len == 3 && name[1] == 'I' && name[2] == 'G')
2271 /* Using ${^...} variables is likely to be sufficiently rare that
2272 it seems sensible to avoid the space hit of also checking the
2274 case '\017': /* ${^OPEN} */
2275 if (strEQ(name1, "PEN"))
2278 case '\024': /* ${^TAINT} */
2279 if (strEQ(name1, "AINT"))
2282 case '\025': /* ${^UNICODE} */
2283 if (strEQ(name1, "NICODE"))
2285 if (strEQ(name1, "TF8LOCALE"))
2288 case '\027': /* ${^WARNING_BITS} */
2289 if (strEQ(name1, "ARNING_BITS"))
2302 const char *end = name + len;
2303 while (--end > name) {
2311 /* Because we're already assuming that name is NUL terminated
2312 below, we can treat an empty name as "\0" */
2339 case '\001': /* $^A */
2340 case '\003': /* $^C */
2341 case '\004': /* $^D */
2342 case '\005': /* $^E */
2343 case '\006': /* $^F */
2344 case '\010': /* $^H */
2345 case '\011': /* $^I, NOT \t in EBCDIC */
2346 case '\014': /* $^L */
2347 case '\016': /* $^N */
2348 case '\017': /* $^O */
2349 case '\020': /* $^P */
2350 case '\023': /* $^S */
2351 case '\024': /* $^T */
2352 case '\026': /* $^V */
2353 case '\027': /* $^W */
2373 Perl_gv_name_set(pTHX_ GV *gv, const char *name, U32 len, U32 flags)
2378 PERL_ARGS_ASSERT_GV_NAME_SET;
2379 PERL_UNUSED_ARG(flags);
2382 Perl_croak(aTHX_ "panic: gv name too long (%"UVuf")", (UV) len);
2384 if (!(flags & GV_ADD) && GvNAME_HEK(gv)) {
2385 unshare_hek(GvNAME_HEK(gv));
2388 PERL_HASH(hash, name, len);
2389 GvNAME_HEK(gv) = share_hek(name, len, hash);
2394 * c-indentation-style: bsd
2396 * indent-tabs-mode: t
2399 * ex: set ts=8 sts=4 sw=4 noet: