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)
48 if (!gv || SvTYPE((const SV *)gv) != SVt_PVGV) {
50 if (type == SVt_PVIO) {
52 * if it walks like a dirhandle, then let's assume that
53 * this is a dirhandle.
55 what = PL_op->op_type == OP_READDIR ||
56 PL_op->op_type == OP_TELLDIR ||
57 PL_op->op_type == OP_SEEKDIR ||
58 PL_op->op_type == OP_REWINDDIR ||
59 PL_op->op_type == OP_CLOSEDIR ?
60 "dirhandle" : "filehandle";
61 /* diag_listed_as: Bad symbol for filehandle */
62 } else if (type == SVt_PVHV) {
65 what = type == SVt_PVAV ? "array" : "scalar";
67 Perl_croak(aTHX_ "Bad symbol for %s", what);
70 if (type == SVt_PVHV) {
71 where = (SV **)&GvHV(gv);
72 } else if (type == SVt_PVAV) {
73 where = (SV **)&GvAV(gv);
74 } else if (type == SVt_PVIO) {
75 where = (SV **)&GvIOp(gv);
81 *where = newSV_type(type);
86 Perl_gv_fetchfile(pTHX_ const char *name)
88 PERL_ARGS_ASSERT_GV_FETCHFILE;
89 return gv_fetchfile_flags(name, strlen(name), 0);
93 Perl_gv_fetchfile_flags(pTHX_ const char *const name, const STRLEN namelen,
99 const STRLEN tmplen = namelen + 2;
102 PERL_ARGS_ASSERT_GV_FETCHFILE_FLAGS;
103 PERL_UNUSED_ARG(flags);
108 if (tmplen <= sizeof smallbuf)
111 Newx(tmpbuf, tmplen, char);
112 /* This is where the debugger's %{"::_<$filename"} hash is created */
115 memcpy(tmpbuf + 2, name, namelen);
116 gv = *(GV**)hv_fetch(PL_defstash, tmpbuf, tmplen, TRUE);
118 gv_init(gv, PL_defstash, tmpbuf, tmplen, FALSE);
119 #ifdef PERL_DONT_CREATE_GVSV
120 GvSV(gv) = newSVpvn(name, namelen);
122 sv_setpvn(GvSV(gv), name, namelen);
124 if (PERLDB_LINE || PERLDB_SAVESRC)
125 hv_magic(GvHVn(gv_AVadd(gv)), NULL, PERL_MAGIC_dbfile);
127 if (tmpbuf != smallbuf)
133 =for apidoc gv_const_sv
135 If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
136 inlining, or C<gv> is a placeholder reference that would be promoted to such
137 a typeglob, then returns the value returned by the sub. Otherwise, returns
144 Perl_gv_const_sv(pTHX_ GV *gv)
146 PERL_ARGS_ASSERT_GV_CONST_SV;
148 if (SvTYPE(gv) == SVt_PVGV)
149 return cv_const_sv(GvCVu(gv));
150 return SvROK(gv) ? SvRV(gv) : NULL;
154 Perl_newGP(pTHX_ GV *const gv)
159 const char *const file
160 = (PL_curcop && CopFILE(PL_curcop)) ? CopFILE(PL_curcop) : "";
161 const STRLEN len = strlen(file);
163 SV *const temp_sv = CopFILESV(PL_curcop);
167 PERL_ARGS_ASSERT_NEWGP;
170 file = SvPVX(temp_sv);
171 len = SvCUR(temp_sv);
178 PERL_HASH(hash, file, len);
182 #ifndef PERL_DONT_CREATE_GVSV
183 gp->gp_sv = newSV(0);
186 gp->gp_line = PL_curcop ? CopLINE(PL_curcop) : 0;
187 /* XXX Ideally this cast would be replaced with a change to const char*
189 gp->gp_file_hek = share_hek(file, len, hash);
197 Perl_gv_init(pTHX_ GV *gv, HV *stash, const char *name, STRLEN len, int multi)
200 const U32 old_type = SvTYPE(gv);
201 const bool doproto = old_type > SVt_NULL;
202 char * const proto = (doproto && SvPOK(gv)) ? SvPVX(gv) : NULL;
203 const STRLEN protolen = proto ? SvCUR(gv) : 0;
204 SV *const has_constant = doproto && SvROK(gv) ? SvRV(gv) : NULL;
205 const U32 exported_constant = has_constant ? SvPCS_IMPORTED(gv) : 0;
207 PERL_ARGS_ASSERT_GV_INIT;
208 assert (!(proto && has_constant));
211 /* The constant has to be a simple scalar type. */
212 switch (SvTYPE(has_constant)) {
218 Perl_croak(aTHX_ "Cannot convert a reference to %s to typeglob",
219 sv_reftype(has_constant, 0));
227 if (old_type < SVt_PVGV) {
228 if (old_type >= SVt_PV)
230 sv_upgrade(MUTABLE_SV(gv), SVt_PVGV);
238 Safefree(SvPVX_mutable(gv));
243 GvGP(gv) = Perl_newGP(aTHX_ gv);
246 Perl_sv_add_backref(aTHX_ MUTABLE_SV(stash), MUTABLE_SV(gv));
247 gv_name_set(gv, name, len, GV_ADD);
248 if (multi || doproto) /* doproto means it _was_ mentioned */
250 if (doproto) { /* Replicate part of newSUB here. */
254 /* newCONSTSUB takes ownership of the reference from us. */
255 cv = newCONSTSUB(stash, name, has_constant);
256 /* If this reference was a copy of another, then the subroutine
257 must have been "imported", by a Perl space assignment to a GV
258 from a reference to CV. */
259 if (exported_constant)
260 GvIMPORTED_CV_on(gv);
262 (void) start_subparse(0,0); /* Create empty CV in compcv. */
268 mro_method_changed_in(GvSTASH(gv)); /* sub Foo::bar($) { (shift) } sub ASDF::baz($); *ASDF::baz = \&Foo::bar */
270 CvFILE_set_from_cop(cv, PL_curcop);
271 CvSTASH(cv) = PL_curstash;
273 Perl_sv_add_backref(aTHX_ MUTABLE_SV(PL_curstash), MUTABLE_SV(cv));
275 sv_usepvn_flags(MUTABLE_SV(cv), proto, protolen,
276 SV_HAS_TRAILING_NUL);
282 S_gv_init_sv(pTHX_ GV *gv, const svtype sv_type)
284 PERL_ARGS_ASSERT_GV_INIT_SV;
296 #ifdef PERL_DONT_CREATE_GVSV
304 /* Work round what appears to be a bug in Sun C++ 5.8 2005/10/13
305 If we just cast GvSVn(gv) to void, it ignores evaluating it for
313 =for apidoc gv_fetchmeth
315 Returns the glob with the given C<name> and a defined subroutine or
316 C<NULL>. The glob lives in the given C<stash>, or in the stashes
317 accessible via @ISA and UNIVERSAL::.
319 The argument C<level> should be either 0 or -1. If C<level==0>, as a
320 side-effect creates a glob with the given C<name> in the given C<stash>
321 which in the case of success contains an alias for the subroutine, and sets
322 up caching info for this glob.
324 This function grants C<"SUPER"> token as a postfix of the stash name. The
325 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
326 visible to Perl code. So when calling C<call_sv>, you should not use
327 the GV directly; instead, you should use the method's CV, which can be
328 obtained from the GV with the C<GvCV> macro.
333 /* NOTE: No support for tied ISA */
336 Perl_gv_fetchmeth(pTHX_ HV *stash, const char *name, STRLEN len, I32 level)
344 GV* candidate = NULL;
349 I32 create = (level >= 0) ? 1 : 0;
354 PERL_ARGS_ASSERT_GV_FETCHMETH;
356 /* UNIVERSAL methods should be callable without a stash */
358 create = 0; /* probably appropriate */
359 if(!(stash = gv_stashpvs("UNIVERSAL", 0)))
365 hvname = HvNAME_get(stash);
367 Perl_croak(aTHX_ "Can't use anonymous symbol table for method lookup");
372 DEBUG_o( Perl_deb(aTHX_ "Looking for method %s in package %s\n",name,hvname) );
374 topgen_cmp = HvMROMETA(stash)->cache_gen + PL_sub_generation;
376 /* check locally for a real method or a cache entry */
377 gvp = (GV**)hv_fetch(stash, name, len, create);
381 if (SvTYPE(topgv) != SVt_PVGV)
382 gv_init(topgv, stash, name, len, TRUE);
383 if ((cand_cv = GvCV(topgv))) {
384 /* If genuine method or valid cache entry, use it */
385 if (!GvCVGEN(topgv) || GvCVGEN(topgv) == topgen_cmp) {
389 /* stale cache entry, junk it and move on */
390 SvREFCNT_dec(cand_cv);
391 GvCV(topgv) = cand_cv = NULL;
395 else if (GvCVGEN(topgv) == topgen_cmp) {
396 /* cache indicates no such method definitively */
401 packlen = HvNAMELEN_get(stash);
402 if (packlen >= 7 && strEQ(hvname + packlen - 7, "::SUPER")) {
405 basestash = gv_stashpvn(hvname, packlen, GV_ADD);
406 linear_av = mro_get_linear_isa(basestash);
409 linear_av = mro_get_linear_isa(stash); /* has ourselves at the top of the list */
412 linear_svp = AvARRAY(linear_av) + 1; /* skip over self */
413 items = AvFILLp(linear_av); /* no +1, to skip over self */
415 linear_sv = *linear_svp++;
417 cstash = gv_stashsv(linear_sv, 0);
420 Perl_ck_warner(aTHX_ packWARN(WARN_SYNTAX), "Can't locate package %"SVf" for @%s::ISA",
421 SVfARG(linear_sv), hvname);
427 gvp = (GV**)hv_fetch(cstash, name, len, 0);
431 if (SvTYPE(candidate) != SVt_PVGV) gv_init(candidate, cstash, name, len, TRUE);
432 if (SvTYPE(candidate) == SVt_PVGV && (cand_cv = GvCV(candidate)) && !GvCVGEN(candidate)) {
434 * Found real method, cache method in topgv if:
435 * 1. topgv has no synonyms (else inheritance crosses wires)
436 * 2. method isn't a stub (else AUTOLOAD fails spectacularly)
438 if (topgv && (GvREFCNT(topgv) == 1) && (CvROOT(cand_cv) || CvXSUB(cand_cv))) {
439 if ((old_cv = GvCV(topgv))) SvREFCNT_dec(old_cv);
440 SvREFCNT_inc_simple_void_NN(cand_cv);
441 GvCV(topgv) = cand_cv;
442 GvCVGEN(topgv) = topgen_cmp;
448 /* Check UNIVERSAL without caching */
449 if(level == 0 || level == -1) {
450 candidate = gv_fetchmeth(NULL, name, len, 1);
452 cand_cv = GvCV(candidate);
453 if (topgv && (GvREFCNT(topgv) == 1) && (CvROOT(cand_cv) || CvXSUB(cand_cv))) {
454 if ((old_cv = GvCV(topgv))) SvREFCNT_dec(old_cv);
455 SvREFCNT_inc_simple_void_NN(cand_cv);
456 GvCV(topgv) = cand_cv;
457 GvCVGEN(topgv) = topgen_cmp;
463 if (topgv && GvREFCNT(topgv) == 1) {
464 /* cache the fact that the method is not defined */
465 GvCVGEN(topgv) = topgen_cmp;
472 =for apidoc gv_fetchmeth_autoload
474 Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
475 Returns a glob for the subroutine.
477 For an autoloaded subroutine without a GV, will create a GV even
478 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
479 of the result may be zero.
485 Perl_gv_fetchmeth_autoload(pTHX_ HV *stash, const char *name, STRLEN len, I32 level)
487 GV *gv = gv_fetchmeth(stash, name, len, level);
489 PERL_ARGS_ASSERT_GV_FETCHMETH_AUTOLOAD;
496 return NULL; /* UNIVERSAL::AUTOLOAD could cause trouble */
497 if (len == S_autolen && memEQ(name, S_autoload, S_autolen))
499 if (!(gv = gv_fetchmeth(stash, S_autoload, S_autolen, FALSE)))
502 if (!(CvROOT(cv) || CvXSUB(cv)))
504 /* Have an autoload */
505 if (level < 0) /* Cannot do without a stub */
506 gv_fetchmeth(stash, name, len, 0);
507 gvp = (GV**)hv_fetch(stash, name, len, (level >= 0));
516 =for apidoc gv_fetchmethod_autoload
518 Returns the glob which contains the subroutine to call to invoke the method
519 on the C<stash>. In fact in the presence of autoloading this may be the
520 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
523 The third parameter of C<gv_fetchmethod_autoload> determines whether
524 AUTOLOAD lookup is performed if the given method is not present: non-zero
525 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
526 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
527 with a non-zero C<autoload> parameter.
529 These functions grant C<"SUPER"> token as a prefix of the method name. Note
530 that if you want to keep the returned glob for a long time, you need to
531 check for it being "AUTOLOAD", since at the later time the call may load a
532 different subroutine due to $AUTOLOAD changing its value. Use the glob
533 created via a side effect to do this.
535 These functions have the same side-effects and as C<gv_fetchmeth> with
536 C<level==0>. C<name> should be writable if contains C<':'> or C<'
537 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
538 C<call_sv> apply equally to these functions.
544 S_gv_get_super_pkg(pTHX_ const char* name, I32 namelen)
551 PERL_ARGS_ASSERT_GV_GET_SUPER_PKG;
553 stash = gv_stashpvn(name, namelen, 0);
554 if(stash) return stash;
556 /* If we must create it, give it an @ISA array containing
557 the real package this SUPER is for, so that it's tied
558 into the cache invalidation code correctly */
559 stash = gv_stashpvn(name, namelen, GV_ADD);
560 gvp = (GV**)hv_fetchs(stash, "ISA", TRUE);
562 gv_init(gv, stash, "ISA", 3, TRUE);
563 superisa = GvAVn(gv);
565 sv_magic(MUTABLE_SV(superisa), MUTABLE_SV(gv), PERL_MAGIC_isa, NULL, 0);
567 av_push(superisa, newSVpv(CopSTASHPV(PL_curcop), 0));
569 av_push(superisa, newSVhek(CopSTASH(PL_curcop)
570 ? HvNAME_HEK(CopSTASH(PL_curcop)) : NULL));
577 Perl_gv_fetchmethod_autoload(pTHX_ HV *stash, const char *name, I32 autoload)
579 PERL_ARGS_ASSERT_GV_FETCHMETHOD_AUTOLOAD;
581 return gv_fetchmethod_flags(stash, name, autoload ? GV_AUTOLOAD : 0);
584 /* Don't merge this yet, as it's likely to get a len parameter, and possibly
587 Perl_gv_fetchmethod_flags(pTHX_ HV *stash, const char *name, U32 flags)
590 register const char *nend;
591 const char *nsplit = NULL;
594 const char * const origname = name;
595 SV *const error_report = MUTABLE_SV(stash);
596 const U32 autoload = flags & GV_AUTOLOAD;
597 const U32 do_croak = flags & GV_CROAK;
599 PERL_ARGS_ASSERT_GV_FETCHMETHOD_FLAGS;
601 if (SvTYPE(stash) < SVt_PVHV)
604 /* The only way stash can become NULL later on is if nsplit is set,
605 which in turn means that there is no need for a SVt_PVHV case
606 the error reporting code. */
609 for (nend = name; *nend; nend++) {
614 else if (*nend == ':' && *(nend + 1) == ':') {
620 if ((nsplit - origname) == 5 && memEQ(origname, "SUPER", 5)) {
621 /* ->SUPER::method should really be looked up in original stash */
622 SV * const tmpstr = sv_2mortal(Perl_newSVpvf(aTHX_ "%s::SUPER",
623 CopSTASHPV(PL_curcop)));
624 /* __PACKAGE__::SUPER stash should be autovivified */
625 stash = gv_get_super_pkg(SvPVX_const(tmpstr), SvCUR(tmpstr));
626 DEBUG_o( Perl_deb(aTHX_ "Treating %s as %s::%s\n",
627 origname, HvNAME_get(stash), name) );
630 /* don't autovifify if ->NoSuchStash::method */
631 stash = gv_stashpvn(origname, nsplit - origname, 0);
633 /* however, explicit calls to Pkg::SUPER::method may
634 happen, and may require autovivification to work */
635 if (!stash && (nsplit - origname) >= 7 &&
636 strnEQ(nsplit - 7, "::SUPER", 7) &&
637 gv_stashpvn(origname, nsplit - origname - 7, 0))
638 stash = gv_get_super_pkg(origname, nsplit - origname);
643 gv = gv_fetchmeth(stash, name, nend - name, 0);
645 if (strEQ(name,"import") || strEQ(name,"unimport"))
646 gv = MUTABLE_GV(&PL_sv_yes);
648 gv = gv_autoload4(ostash, name, nend - name, TRUE);
649 if (!gv && do_croak) {
650 /* Right now this is exclusively for the benefit of S_method_common
654 "Can't locate object method \"%s\" via package \"%.*s\"",
655 name, (int)HvNAMELEN_get(stash), HvNAME_get(stash));
659 const char *packname;
662 packlen = nsplit - origname;
665 packname = SvPV_const(error_report, packlen);
669 "Can't locate object method \"%s\" via package \"%.*s\""
670 " (perhaps you forgot to load \"%.*s\"?)",
671 name, (int)packlen, packname, (int)packlen, packname);
676 CV* const cv = GvCV(gv);
677 if (!CvROOT(cv) && !CvXSUB(cv)) {
685 if (GvCV(stubgv) != cv) /* orphaned import */
688 autogv = gv_autoload4(GvSTASH(stubgv),
689 GvNAME(stubgv), GvNAMELEN(stubgv), TRUE);
699 Perl_gv_autoload4(pTHX_ HV *stash, const char *name, STRLEN len, I32 method)
707 const char *packname = "";
708 STRLEN packname_len = 0;
710 PERL_ARGS_ASSERT_GV_AUTOLOAD4;
712 if (len == S_autolen && memEQ(name, S_autoload, S_autolen))
715 if (SvTYPE(stash) < SVt_PVHV) {
716 packname = SvPV_const(MUTABLE_SV(stash), packname_len);
720 packname = HvNAME_get(stash);
721 packname_len = HvNAMELEN_get(stash);
724 if (!(gv = gv_fetchmeth(stash, S_autoload, S_autolen, FALSE)))
728 if (!(CvROOT(cv) || CvXSUB(cv)))
732 * Inheriting AUTOLOAD for non-methods works ... for now.
734 if (!method && (GvCVGEN(gv) || GvSTASH(gv) != stash)
736 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED),
737 "Use of inherited AUTOLOAD for non-method %s::%.*s() is deprecated",
738 packname, (int)len, name);
741 /* rather than lookup/init $AUTOLOAD here
742 * only to have the XSUB do another lookup for $AUTOLOAD
743 * and split that value on the last '::',
744 * pass along the same data via some unused fields in the CV
748 Perl_sv_add_backref(aTHX_ MUTABLE_SV(stash), MUTABLE_SV(cv));
749 SvPV_set(cv, (char *)name); /* cast to lose constness warning */
755 * Given &FOO::AUTOLOAD, set $FOO::AUTOLOAD to desired function name.
756 * The subroutine's original name may not be "AUTOLOAD", so we don't
757 * use that, but for lack of anything better we will use the sub's
758 * original package to look up $AUTOLOAD.
760 varstash = GvSTASH(CvGV(cv));
761 vargv = *(GV**)hv_fetch(varstash, S_autoload, S_autolen, TRUE);
765 gv_init(vargv, varstash, S_autoload, S_autolen, FALSE);
766 #ifdef PERL_DONT_CREATE_GVSV
767 GvSV(vargv) = newSV(0);
771 varsv = GvSVn(vargv);
772 sv_setpvn(varsv, packname, packname_len);
773 sv_catpvs(varsv, "::");
774 sv_catpvn(varsv, name, len);
779 /* require_tie_mod() internal routine for requiring a module
780 * that implements the logic of automatical ties like %! and %-
782 * The "gv" parameter should be the glob.
783 * "varpv" holds the name of the var, used for error messages.
784 * "namesv" holds the module name. Its refcount will be decremented.
785 * "methpv" holds the method name to test for to check that things
786 * are working reasonably close to as expected.
787 * "flags": if flag & 1 then save the scalar before loading.
788 * For the protection of $! to work (it is set by this routine)
789 * the sv slot must already be magicalized.
792 S_require_tie_mod(pTHX_ GV *gv, const char *varpv, SV* namesv, const char *methpv,const U32 flags)
795 HV* stash = gv_stashsv(namesv, 0);
797 PERL_ARGS_ASSERT_REQUIRE_TIE_MOD;
799 if (!stash || !(gv_fetchmethod(stash, methpv))) {
800 SV *module = newSVsv(namesv);
801 char varname = *varpv; /* varpv might be clobbered by load_module,
802 so save it. For the moment it's always
808 PUSHSTACKi(PERLSI_MAGIC);
809 Perl_load_module(aTHX_ PERL_LOADMOD_NOIMPORT, module, NULL);
813 stash = gv_stashsv(namesv, 0);
815 Perl_croak(aTHX_ "panic: Can't use %%%c because %"SVf" is not available",
816 varname, SVfARG(namesv));
817 else if (!gv_fetchmethod(stash, methpv))
818 Perl_croak(aTHX_ "panic: Can't use %%%c because %"SVf" does not support method %s",
819 varname, SVfARG(namesv), methpv);
821 SvREFCNT_dec(namesv);
826 =for apidoc gv_stashpv
828 Returns a pointer to the stash for a specified package. Uses C<strlen> to
829 determine the length of C<name>, then calls C<gv_stashpvn()>.
835 Perl_gv_stashpv(pTHX_ const char *name, I32 create)
837 PERL_ARGS_ASSERT_GV_STASHPV;
838 return gv_stashpvn(name, strlen(name), create);
842 =for apidoc gv_stashpvn
844 Returns a pointer to the stash for a specified package. The C<namelen>
845 parameter indicates the length of the C<name>, in bytes. C<flags> is passed
846 to C<gv_fetchpvn_flags()>, so if set to C<GV_ADD> then the package will be
847 created if it does not already exist. If the package does not exist and
848 C<flags> is 0 (or any other setting that does not create packages) then NULL
856 Perl_gv_stashpvn(pTHX_ const char *name, U32 namelen, I32 flags)
862 U32 tmplen = namelen + 2;
864 PERL_ARGS_ASSERT_GV_STASHPVN;
866 if (tmplen <= sizeof smallbuf)
869 Newx(tmpbuf, tmplen, char);
870 Copy(name, tmpbuf, namelen, char);
871 tmpbuf[namelen] = ':';
872 tmpbuf[namelen+1] = ':';
873 tmpgv = gv_fetchpvn_flags(tmpbuf, tmplen, flags, SVt_PVHV);
874 if (tmpbuf != smallbuf)
879 GvHV(tmpgv) = newHV();
881 if (!HvNAME_get(stash))
882 hv_name_set(stash, name, namelen, 0);
887 =for apidoc gv_stashsv
889 Returns a pointer to the stash for a specified package. See C<gv_stashpvn>.
895 Perl_gv_stashsv(pTHX_ SV *sv, I32 flags)
898 const char * const ptr = SvPV_const(sv,len);
900 PERL_ARGS_ASSERT_GV_STASHSV;
902 return gv_stashpvn(ptr, len, flags);
907 Perl_gv_fetchpv(pTHX_ const char *nambeg, I32 add, const svtype sv_type) {
908 PERL_ARGS_ASSERT_GV_FETCHPV;
909 return gv_fetchpvn_flags(nambeg, strlen(nambeg), add, sv_type);
913 Perl_gv_fetchsv(pTHX_ SV *name, I32 flags, const svtype sv_type) {
915 const char * const nambeg = SvPV_const(name, len);
916 PERL_ARGS_ASSERT_GV_FETCHSV;
917 return gv_fetchpvn_flags(nambeg, len, flags | SvUTF8(name), sv_type);
921 Perl_gv_fetchpvn_flags(pTHX_ const char *nambeg, STRLEN full_len, I32 flags,
922 const svtype sv_type)
925 register const char *name = nambeg;
926 register GV *gv = NULL;
929 register const char *name_cursor;
931 const I32 no_init = flags & (GV_NOADD_NOINIT | GV_NOINIT);
932 const I32 no_expand = flags & GV_NOEXPAND;
933 const I32 add = flags & ~GV_NOADD_MASK;
934 const char *const name_end = nambeg + full_len;
935 const char *const name_em1 = name_end - 1;
938 PERL_ARGS_ASSERT_GV_FETCHPVN_FLAGS;
940 if (flags & GV_NOTQUAL) {
941 /* Caller promised that there is no stash, so we can skip the check. */
946 if (full_len > 2 && *name == '*' && isALPHA(name[1])) {
947 /* accidental stringify on a GV? */
951 for (name_cursor = name; name_cursor < name_end; name_cursor++) {
952 if ((*name_cursor == ':' && name_cursor < name_em1
953 && name_cursor[1] == ':')
954 || (*name_cursor == '\'' && name_cursor[1]))
958 if (!stash || !SvREFCNT(stash)) /* symbol table under destruction */
961 len = name_cursor - name;
966 if (len + 2 <= (I32)sizeof (smallbuf))
969 Newx(tmpbuf, len+2, char);
970 Copy(name, tmpbuf, len, char);
973 gvp = (GV**)hv_fetch(stash,tmpbuf,len,add);
974 gv = gvp ? *gvp : NULL;
975 if (gv && gv != (const GV *)&PL_sv_undef) {
976 if (SvTYPE(gv) != SVt_PVGV)
977 gv_init(gv, stash, tmpbuf, len, (add & GV_ADDMULTI));
981 if (tmpbuf != smallbuf)
983 if (!gv || gv == (const GV *)&PL_sv_undef)
986 if (!(stash = GvHV(gv)))
987 stash = GvHV(gv) = newHV();
989 if (!HvNAME_get(stash))
990 hv_name_set(stash, nambeg, name_cursor - nambeg, 0);
993 if (*name_cursor == ':')
997 if (name == name_end)
999 ? gv : MUTABLE_GV(*hv_fetchs(PL_defstash, "main::", TRUE));
1002 len = name_cursor - name;
1004 /* No stash in name, so see how we can default */
1008 if (len && isIDFIRST_lazy(name)) {
1009 bool global = FALSE;
1017 if ((name[0] == 'I' && name[1] == 'N' && name[2] == 'C')
1018 || (name[0] == 'E' && name[1] == 'N' && name[2] == 'V')
1019 || (name[0] == 'S' && name[1] == 'I' && name[2] == 'G'))
1023 if (name[0] == 'A' && name[1] == 'R' && name[2] == 'G'
1028 if (name[0] == 'S' && name[1] == 'T' && name[2] == 'D'
1029 && name[3] == 'I' && name[4] == 'N')
1033 if ((name[0] == 'S' && name[1] == 'T' && name[2] == 'D')
1034 &&((name[3] == 'O' && name[4] == 'U' && name[5] == 'T')
1035 ||(name[3] == 'E' && name[4] == 'R' && name[5] == 'R')))
1039 if (name[0] == 'A' && name[1] == 'R' && name[2] == 'G'
1040 && name[3] == 'V' && name[4] == 'O' && name[5] == 'U'
1047 stash = PL_defstash;
1048 else if (IN_PERL_COMPILETIME) {
1049 stash = PL_curstash;
1050 if (add && (PL_hints & HINT_STRICT_VARS) &&
1051 sv_type != SVt_PVCV &&
1052 sv_type != SVt_PVGV &&
1053 sv_type != SVt_PVFM &&
1054 sv_type != SVt_PVIO &&
1055 !(len == 1 && sv_type == SVt_PV &&
1056 (*name == 'a' || *name == 'b')) )
1058 gvp = (GV**)hv_fetch(stash,name,len,0);
1060 *gvp == (const GV *)&PL_sv_undef ||
1061 SvTYPE(*gvp) != SVt_PVGV)
1065 else if ((sv_type == SVt_PV && !GvIMPORTED_SV(*gvp)) ||
1066 (sv_type == SVt_PVAV && !GvIMPORTED_AV(*gvp)) ||
1067 (sv_type == SVt_PVHV && !GvIMPORTED_HV(*gvp)) )
1069 /* diag_listed_as: Variable "%s" is not imported%s */
1071 aTHX_ packWARN(WARN_MISC),
1072 "Variable \"%c%s\" is not imported",
1073 sv_type == SVt_PVAV ? '@' :
1074 sv_type == SVt_PVHV ? '%' : '$',
1078 aTHX_ packWARN(WARN_MISC),
1079 "\t(Did you mean &%s instead?)\n", name
1086 stash = CopSTASH(PL_curcop);
1089 stash = PL_defstash;
1092 /* By this point we should have a stash and a name */
1096 SV * const err = Perl_mess(aTHX_
1097 "Global symbol \"%s%s\" requires explicit package name",
1098 (sv_type == SVt_PV ? "$"
1099 : sv_type == SVt_PVAV ? "@"
1100 : sv_type == SVt_PVHV ? "%"
1103 if (USE_UTF8_IN_NAMES)
1106 gv = gv_fetchpvs("<none>::", GV_ADDMULTI, SVt_PVHV);
1108 /* symbol table under destruction */
1117 if (!SvREFCNT(stash)) /* symbol table under destruction */
1120 gvp = (GV**)hv_fetch(stash,name,len,add);
1121 if (!gvp || *gvp == (const GV *)&PL_sv_undef)
1124 if (SvTYPE(gv) == SVt_PVGV) {
1127 gv_init_sv(gv, sv_type);
1128 if (len == 1 && (sv_type == SVt_PVHV || sv_type == SVt_PVGV)) {
1130 require_tie_mod(gv, "!", newSVpvs("Errno"), "TIEHASH", 1);
1131 else if (*name == '-' || *name == '+')
1132 require_tie_mod(gv, name, newSVpvs("Tie::Hash::NamedCapture"), "TIEHASH", 0);
1136 } else if (no_init) {
1138 } else if (no_expand && SvROK(gv)) {
1142 /* Adding a new symbol.
1143 Unless of course there was already something non-GV here, in which case
1144 we want to behave as if there was always a GV here, containing some sort
1146 Otherwise we run the risk of creating things like GvIO, which can cause
1147 subtle bugs. eg the one that tripped up SQL::Translator */
1149 faking_it = SvOK(gv);
1151 if (add & GV_ADDWARN)
1152 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL), "Had to create %s unexpectedly", nambeg);
1153 gv_init(gv, stash, name, len, add & GV_ADDMULTI);
1154 gv_init_sv(gv, faking_it ? SVt_PVCV : sv_type);
1156 if (isALPHA(name[0]) && ! (isLEXWARN_on ? ckWARN(WARN_ONCE)
1157 : (PL_dowarn & G_WARN_ON ) ) )
1160 /* set up magic where warranted */
1165 /* Nothing else to do.
1166 The compiler will probably turn the switch statement into a
1167 branch table. Make sure we avoid even that small overhead for
1168 the common case of lower case variable names. */
1172 const char * const name2 = name + 1;
1175 if (strEQ(name2, "RGV")) {
1176 IoFLAGS(GvIOn(gv)) |= IOf_ARGV|IOf_START;
1178 else if (strEQ(name2, "RGVOUT")) {
1183 if (strnEQ(name2, "XPORT", 5))
1187 if (strEQ(name2, "SA")) {
1188 AV* const av = GvAVn(gv);
1190 sv_magic(MUTABLE_SV(av), MUTABLE_SV(gv), PERL_MAGIC_isa,
1192 /* NOTE: No support for tied ISA */
1193 if ((add & GV_ADDMULTI) && strEQ(nambeg,"AnyDBM_File::ISA")
1194 && AvFILLp(av) == -1)
1196 av_push(av, newSVpvs("NDBM_File"));
1197 gv_stashpvs("NDBM_File", GV_ADD);
1198 av_push(av, newSVpvs("DB_File"));
1199 gv_stashpvs("DB_File", GV_ADD);
1200 av_push(av, newSVpvs("GDBM_File"));
1201 gv_stashpvs("GDBM_File", GV_ADD);
1202 av_push(av, newSVpvs("SDBM_File"));
1203 gv_stashpvs("SDBM_File", GV_ADD);
1204 av_push(av, newSVpvs("ODBM_File"));
1205 gv_stashpvs("ODBM_File", GV_ADD);
1210 if (strEQ(name2, "VERLOAD")) {
1211 HV* const hv = GvHVn(gv);
1213 hv_magic(hv, NULL, PERL_MAGIC_overload);
1217 if (strEQ(name2, "IG")) {
1220 if (!PL_psig_name) {
1221 Newxz(PL_psig_name, 2 * SIG_SIZE, SV*);
1222 Newxz(PL_psig_pend, SIG_SIZE, int);
1223 PL_psig_ptr = PL_psig_name + SIG_SIZE;
1225 /* I think that the only way to get here is to re-use an
1226 embedded perl interpreter, where the previous
1227 use didn't clean up fully because
1228 PL_perl_destruct_level was 0. I'm not sure that we
1229 "support" that, in that I suspect in that scenario
1230 there are sufficient other garbage values left in the
1231 interpreter structure that something else will crash
1232 before we get here. I suspect that this is one of
1233 those "doctor, it hurts when I do this" bugs. */
1234 Zero(PL_psig_name, 2 * SIG_SIZE, SV*);
1235 Zero(PL_psig_pend, SIG_SIZE, int);
1239 hv_magic(hv, NULL, PERL_MAGIC_sig);
1240 for (i = 1; i < SIG_SIZE; i++) {
1241 SV * const * const init = hv_fetch(hv, PL_sig_name[i], strlen(PL_sig_name[i]), 1);
1243 sv_setsv(*init, &PL_sv_undef);
1248 if (strEQ(name2, "ERSION"))
1251 case '\003': /* $^CHILD_ERROR_NATIVE */
1252 if (strEQ(name2, "HILD_ERROR_NATIVE"))
1255 case '\005': /* $^ENCODING */
1256 if (strEQ(name2, "NCODING"))
1259 case '\015': /* $^MATCH */
1260 if (strEQ(name2, "ATCH"))
1262 case '\017': /* $^OPEN */
1263 if (strEQ(name2, "PEN"))
1266 case '\020': /* $^PREMATCH $^POSTMATCH */
1267 if (strEQ(name2, "REMATCH") || strEQ(name2, "OSTMATCH"))
1269 case '\024': /* ${^TAINT} */
1270 if (strEQ(name2, "AINT"))
1273 case '\025': /* ${^UNICODE}, ${^UTF8LOCALE} */
1274 if (strEQ(name2, "NICODE"))
1276 if (strEQ(name2, "TF8LOCALE"))
1278 if (strEQ(name2, "TF8CACHE"))
1281 case '\027': /* $^WARNING_BITS */
1282 if (strEQ(name2, "ARNING_BITS"))
1295 /* Ensures that we have an all-digit variable, ${"1foo"} fails
1297 /* This snippet is taken from is_gv_magical */
1298 const char *end = name + len;
1299 while (--end > name) {
1300 if (!isDIGIT(*end)) return gv;
1307 /* Names of length 1. (Or 0. But name is NUL terminated, so that will
1308 be case '\0' in this switch statement (ie a default case) */
1314 sv_type == SVt_PVAV ||
1315 sv_type == SVt_PVHV ||
1316 sv_type == SVt_PVCV ||
1317 sv_type == SVt_PVFM ||
1320 PL_sawampersand = TRUE;
1324 sv_setpv(GvSVn(gv),PL_chopset);
1328 #ifdef COMPLEX_STATUS
1329 SvUPGRADE(GvSVn(gv), SVt_PVLV);
1335 /* If %! has been used, automatically load Errno.pm. */
1337 sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
1339 /* magicalization must be done before require_tie_mod is called */
1340 if (sv_type == SVt_PVHV || sv_type == SVt_PVGV)
1341 require_tie_mod(gv, "!", newSVpvs("Errno"), "TIEHASH", 1);
1346 GvMULTI_on(gv); /* no used once warnings here */
1348 AV* const av = GvAVn(gv);
1349 SV* const avc = (*name == '+') ? MUTABLE_SV(av) : NULL;
1351 sv_magic(MUTABLE_SV(av), avc, PERL_MAGIC_regdata, NULL, 0);
1352 sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
1354 SvREADONLY_on(GvSVn(gv));
1357 if (sv_type == SVt_PVHV || sv_type == SVt_PVGV)
1358 require_tie_mod(gv, name, newSVpvs("Tie::Hash::NamedCapture"), "TIEHASH", 0);
1364 if (sv_type == SVt_PV)
1365 Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_SYNTAX),
1366 "$%c is no longer supported", *name);
1369 sv_setiv(GvSVn(gv), (IV)(IoFLAGS(GvIOp(PL_defoutgv)) & IOf_FLUSH) != 0);
1372 case '\010': /* $^H */
1374 HV *const hv = GvHVn(gv);
1375 hv_magic(hv, NULL, PERL_MAGIC_hints);
1378 case '\023': /* $^S */
1380 SvREADONLY_on(GvSVn(gv));
1404 case '\001': /* $^A */
1405 case '\003': /* $^C */
1406 case '\004': /* $^D */
1407 case '\005': /* $^E */
1408 case '\006': /* $^F */
1409 case '\011': /* $^I, NOT \t in EBCDIC */
1410 case '\016': /* $^N */
1411 case '\017': /* $^O */
1412 case '\020': /* $^P */
1413 case '\024': /* $^T */
1414 case '\027': /* $^W */
1416 sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
1419 case '\014': /* $^L */
1420 sv_setpvs(GvSVn(gv),"\f");
1421 PL_formfeed = GvSVn(gv);
1424 sv_setpvs(GvSVn(gv),"\034");
1428 SV * const sv = GvSVn(gv);
1429 if (!sv_derived_from(PL_patchlevel, "version"))
1430 upg_version(PL_patchlevel, TRUE);
1431 GvSV(gv) = vnumify(PL_patchlevel);
1432 SvREADONLY_on(GvSV(gv));
1436 case '\026': /* $^V */
1438 SV * const sv = GvSVn(gv);
1439 GvSV(gv) = new_version(PL_patchlevel);
1440 SvREADONLY_on(GvSV(gv));
1450 Perl_gv_fullname4(pTHX_ SV *sv, const GV *gv, const char *prefix, bool keepmain)
1454 const HV * const hv = GvSTASH(gv);
1456 PERL_ARGS_ASSERT_GV_FULLNAME4;
1462 sv_setpv(sv, prefix ? prefix : "");
1464 name = HvNAME_get(hv);
1466 namelen = HvNAMELEN_get(hv);
1472 if (keepmain || strNE(name, "main")) {
1473 sv_catpvn(sv,name,namelen);
1476 sv_catpvn(sv,GvNAME(gv),GvNAMELEN(gv));
1480 Perl_gv_efullname4(pTHX_ SV *sv, const GV *gv, const char *prefix, bool keepmain)
1482 const GV * const egv = GvEGVx(gv);
1484 PERL_ARGS_ASSERT_GV_EFULLNAME4;
1486 gv_fullname4(sv, egv ? egv : gv, prefix, keepmain);
1490 Perl_gv_check(pTHX_ const HV *stash)
1495 PERL_ARGS_ASSERT_GV_CHECK;
1497 if (!HvARRAY(stash))
1499 for (i = 0; i <= (I32) HvMAX(stash); i++) {
1501 for (entry = HvARRAY(stash)[i]; entry; entry = HeNEXT(entry)) {
1504 if (HeKEY(entry)[HeKLEN(entry)-1] == ':' &&
1505 (gv = MUTABLE_GV(HeVAL(entry))) && isGV(gv) && (hv = GvHV(gv)))
1507 if (hv != PL_defstash && hv != stash)
1508 gv_check(hv); /* nested package */
1510 else if (isALPHA(*HeKEY(entry))) {
1512 gv = MUTABLE_GV(HeVAL(entry));
1513 if (SvTYPE(gv) != SVt_PVGV || GvMULTI(gv))
1516 CopLINE_set(PL_curcop, GvLINE(gv));
1518 CopFILE(PL_curcop) = (char *)file; /* set for warning */
1520 CopFILEGV(PL_curcop)
1521 = gv_fetchfile_flags(file, HEK_LEN(GvFILE_HEK(gv)), 0);
1523 Perl_warner(aTHX_ packWARN(WARN_ONCE),
1524 "Name \"%s::%s\" used only once: possible typo",
1525 HvNAME_get(stash), GvNAME(gv));
1532 Perl_newGVgen(pTHX_ const char *pack)
1536 PERL_ARGS_ASSERT_NEWGVGEN;
1538 return gv_fetchpv(Perl_form(aTHX_ "%s::_GEN_%ld", pack, (long)PL_gensym++),
1542 /* hopefully this is only called on local symbol table entries */
1545 Perl_gp_ref(pTHX_ GP *gp)
1553 /* If the GP they asked for a reference to contains
1554 a method cache entry, clear it first, so that we
1555 don't infect them with our cached entry */
1556 SvREFCNT_dec(gp->gp_cv);
1565 Perl_gp_free(pTHX_ GV *gv)
1570 if (!gv || !isGV_with_GP(gv) || !(gp = GvGP(gv)))
1572 if (gp->gp_refcnt == 0) {
1573 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
1574 "Attempt to free unreferenced glob pointers"
1575 pTHX__FORMAT pTHX__VALUE);
1578 if (--gp->gp_refcnt > 0) {
1579 if (gp->gp_egv == gv)
1585 if (gp->gp_file_hek)
1586 unshare_hek(gp->gp_file_hek);
1587 SvREFCNT_dec(gp->gp_sv);
1588 SvREFCNT_dec(gp->gp_av);
1589 /* FIXME - another reference loop GV -> symtab -> GV ?
1590 Somehow gp->gp_hv can end up pointing at freed garbage. */
1591 if (gp->gp_hv && SvTYPE(gp->gp_hv) == SVt_PVHV) {
1592 const char *hvname = HvNAME_get(gp->gp_hv);
1593 if (PL_stashcache && hvname)
1594 (void)hv_delete(PL_stashcache, hvname, HvNAMELEN_get(gp->gp_hv),
1596 SvREFCNT_dec(gp->gp_hv);
1598 SvREFCNT_dec(gp->gp_io);
1599 SvREFCNT_dec(gp->gp_cv);
1600 SvREFCNT_dec(gp->gp_form);
1607 Perl_magic_freeovrld(pTHX_ SV *sv, MAGIC *mg)
1609 AMT * const amtp = (AMT*)mg->mg_ptr;
1610 PERL_UNUSED_ARG(sv);
1612 PERL_ARGS_ASSERT_MAGIC_FREEOVRLD;
1614 if (amtp && AMT_AMAGIC(amtp)) {
1616 for (i = 1; i < NofAMmeth; i++) {
1617 CV * const cv = amtp->table[i];
1619 SvREFCNT_dec(MUTABLE_SV(cv));
1620 amtp->table[i] = NULL;
1627 /* Updates and caches the CV's */
1629 * 1 on success and there is some overload
1630 * 0 if there is no overload
1631 * -1 if some error occurred and it couldn't croak
1635 Perl_Gv_AMupdate(pTHX_ HV *stash, bool destructing)
1638 MAGIC* const mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
1640 const struct mro_meta* stash_meta = HvMROMETA(stash);
1643 PERL_ARGS_ASSERT_GV_AMUPDATE;
1645 newgen = PL_sub_generation + stash_meta->pkg_gen + stash_meta->cache_gen;
1647 const AMT * const amtp = (AMT*)mg->mg_ptr;
1648 if (amtp->was_ok_am == PL_amagic_generation
1649 && amtp->was_ok_sub == newgen) {
1650 return AMT_OVERLOADED(amtp) ? 1 : 0;
1652 sv_unmagic(MUTABLE_SV(stash), PERL_MAGIC_overload_table);
1655 DEBUG_o( Perl_deb(aTHX_ "Recalcing overload magic in package %s\n",HvNAME_get(stash)) );
1658 amt.was_ok_am = PL_amagic_generation;
1659 amt.was_ok_sub = newgen;
1660 amt.fallback = AMGfallNO;
1664 int filled = 0, have_ovl = 0;
1667 /* Work with "fallback" key, which we assume to be first in PL_AMG_names */
1669 /* Try to find via inheritance. */
1670 GV *gv = gv_fetchmeth(stash, PL_AMG_names[0], 2, -1);
1671 SV * const sv = gv ? GvSV(gv) : NULL;
1675 lim = DESTROY_amg; /* Skip overloading entries. */
1676 #ifdef PERL_DONT_CREATE_GVSV
1678 NOOP; /* Equivalent to !SvTRUE and !SvOK */
1681 else if (SvTRUE(sv))
1682 amt.fallback=AMGfallYES;
1684 amt.fallback=AMGfallNEVER;
1686 for (i = 1; i < lim; i++)
1687 amt.table[i] = NULL;
1688 for (; i < NofAMmeth; i++) {
1689 const char * const cooky = PL_AMG_names[i];
1690 /* Human-readable form, for debugging: */
1691 const char * const cp = (i >= DESTROY_amg ? cooky : AMG_id2name(i));
1692 const STRLEN l = PL_AMG_namelens[i];
1694 DEBUG_o( Perl_deb(aTHX_ "Checking overloading of \"%s\" in package \"%.256s\"\n",
1695 cp, HvNAME_get(stash)) );
1696 /* don't fill the cache while looking up!
1697 Creation of inheritance stubs in intermediate packages may
1698 conflict with the logic of runtime method substitution.
1699 Indeed, for inheritance A -> B -> C, if C overloads "+0",
1700 then we could have created stubs for "(+0" in A and C too.
1701 But if B overloads "bool", we may want to use it for
1702 numifying instead of C's "+0". */
1703 if (i >= DESTROY_amg)
1704 gv = Perl_gv_fetchmeth_autoload(aTHX_ stash, cooky, l, 0);
1705 else /* Autoload taken care of below */
1706 gv = Perl_gv_fetchmeth(aTHX_ stash, cooky, l, -1);
1708 if (gv && (cv = GvCV(gv))) {
1710 if (GvNAMELEN(CvGV(cv)) == 3 && strEQ(GvNAME(CvGV(cv)), "nil")
1711 && strEQ(hvname = HvNAME_get(GvSTASH(CvGV(cv))), "overload")) {
1712 /* This is a hack to support autoloading..., while
1713 knowing *which* methods were declared as overloaded. */
1714 /* GvSV contains the name of the method. */
1716 SV *gvsv = GvSV(gv);
1718 DEBUG_o( Perl_deb(aTHX_ "Resolving method \"%"SVf256\
1719 "\" for overloaded \"%s\" in package \"%.256s\"\n",
1720 (void*)GvSV(gv), cp, hvname) );
1721 if (!gvsv || !SvPOK(gvsv)
1722 || !(ngv = gv_fetchmethod_autoload(stash, SvPVX_const(gvsv),
1725 /* Can be an import stub (created by "can"). */
1730 const char * const name = (gvsv && SvPOK(gvsv)) ? SvPVX_const(gvsv) : "???";
1731 Perl_croak(aTHX_ "%s method \"%.256s\" overloading \"%s\" "\
1732 "in package \"%.256s\"",
1733 (GvCVGEN(gv) ? "Stub found while resolving"
1738 cv = GvCV(gv = ngv);
1740 DEBUG_o( Perl_deb(aTHX_ "Overloading \"%s\" in package \"%.256s\" via \"%.256s::%.256s\"\n",
1741 cp, HvNAME_get(stash), HvNAME_get(GvSTASH(CvGV(cv))),
1742 GvNAME(CvGV(cv))) );
1744 if (i < DESTROY_amg)
1746 } else if (gv) { /* Autoloaded... */
1747 cv = MUTABLE_CV(gv);
1750 amt.table[i]=MUTABLE_CV(SvREFCNT_inc_simple(cv));
1753 AMT_AMAGIC_on(&amt);
1755 AMT_OVERLOADED_on(&amt);
1756 sv_magic(MUTABLE_SV(stash), 0, PERL_MAGIC_overload_table,
1757 (char*)&amt, sizeof(AMT));
1761 /* Here we have no table: */
1763 AMT_AMAGIC_off(&amt);
1764 sv_magic(MUTABLE_SV(stash), 0, PERL_MAGIC_overload_table,
1765 (char*)&amt, sizeof(AMTS));
1771 Perl_gv_handler(pTHX_ HV *stash, I32 id)
1777 struct mro_meta* stash_meta;
1779 if (!stash || !HvNAME_get(stash))
1782 stash_meta = HvMROMETA(stash);
1783 newgen = PL_sub_generation + stash_meta->pkg_gen + stash_meta->cache_gen;
1785 mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
1788 /* If we're looking up a destructor to invoke, we must avoid
1789 * that Gv_AMupdate croaks, because we might be dying already */
1790 if (Gv_AMupdate(stash, id == DESTROY_amg) == -1) {
1791 /* and if it didn't found a destructor, we fall back
1792 * to a simpler method that will only look for the
1793 * destructor instead of the whole magic */
1794 if (id == DESTROY_amg) {
1795 GV * const gv = gv_fetchmethod(stash, "DESTROY");
1801 mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
1804 amtp = (AMT*)mg->mg_ptr;
1805 if ( amtp->was_ok_am != PL_amagic_generation
1806 || amtp->was_ok_sub != newgen )
1808 if (AMT_AMAGIC(amtp)) {
1809 CV * const ret = amtp->table[id];
1810 if (ret && isGV(ret)) { /* Autoloading stab */
1811 /* Passing it through may have resulted in a warning
1812 "Inherited AUTOLOAD for a non-method deprecated", since
1813 our caller is going through a function call, not a method call.
1814 So return the CV for AUTOLOAD, setting $AUTOLOAD. */
1815 GV * const gv = gv_fetchmethod(stash, PL_AMG_names[id]);
1827 /* Implement tryAMAGICun_MG macro.
1828 Do get magic, then see if the stack arg is overloaded and if so call it.
1830 AMGf_set return the arg using SETs rather than assigning to
1832 AMGf_numeric apply sv_2num to the stack arg.
1836 Perl_try_amagic_un(pTHX_ int method, int flags) {
1840 SV* const arg = TOPs;
1844 if (SvAMAGIC(arg) && (tmpsv = AMG_CALLun_var(arg,method))) {
1845 if (flags & AMGf_set) {
1850 if (SvPADMY(TARG)) {
1851 sv_setsv(TARG, tmpsv);
1861 if ((flags & AMGf_numeric) && SvROK(arg))
1867 /* Implement tryAMAGICbin_MG macro.
1868 Do get magic, then see if the two stack args are overloaded and if so
1871 AMGf_set return the arg using SETs rather than assigning to
1873 AMGf_assign op may be called as mutator (eg +=)
1874 AMGf_numeric apply sv_2num to the stack arg.
1878 Perl_try_amagic_bin(pTHX_ int method, int flags) {
1881 SV* const left = TOPm1s;
1882 SV* const right = TOPs;
1888 if (SvAMAGIC(left) || SvAMAGIC(right)) {
1889 SV * const tmpsv = amagic_call(left, right, method,
1890 ((flags & AMGf_assign) && opASSIGN ? AMGf_assign: 0));
1892 if (flags & AMGf_set) {
1899 if (opASSIGN || SvPADMY(TARG)) {
1900 sv_setsv(TARG, tmpsv);
1910 if (flags & AMGf_numeric) {
1912 *(sp-1) = sv_2num(left);
1914 *sp = sv_2num(right);
1921 Perl_amagic_call(pTHX_ SV *left, SV *right, int method, int flags)
1926 CV **cvp=NULL, **ocvp=NULL;
1927 AMT *amtp=NULL, *oamtp=NULL;
1928 int off = 0, off1, lr = 0, notfound = 0;
1929 int postpr = 0, force_cpy = 0;
1930 int assign = AMGf_assign & flags;
1931 const int assignshift = assign ? 1 : 0;
1937 PERL_ARGS_ASSERT_AMAGIC_CALL;
1939 if ( PL_curcop->cop_hints & HINT_NO_AMAGIC ) {
1940 SV *lex_mask = Perl_refcounted_he_fetch(aTHX_ PL_curcop->cop_hints_hash,
1941 0, "overloading", 11, 0, 0);
1943 if ( !lex_mask || !SvOK(lex_mask) )
1944 /* overloading lexically disabled */
1946 else if ( lex_mask && SvPOK(lex_mask) ) {
1947 /* we have an entry in the hints hash, check if method has been
1948 * masked by overloading.pm */
1950 const int offset = method / 8;
1951 const int bit = method % 8;
1952 char *pv = SvPV(lex_mask, len);
1954 /* Bit set, so this overloading operator is disabled */
1955 if ( (STRLEN)offset < len && pv[offset] & ( 1 << bit ) )
1960 if (!(AMGf_noleft & flags) && SvAMAGIC(left)
1961 && (stash = SvSTASH(SvRV(left)))
1962 && (mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table))
1963 && (ocvp = cvp = (AMT_AMAGIC((AMT*)mg->mg_ptr)
1964 ? (oamtp = amtp = (AMT*)mg->mg_ptr)->table
1966 && ((cv = cvp[off=method+assignshift])
1967 || (assign && amtp->fallback > AMGfallNEVER && /* fallback to
1973 cv = cvp[off=method])))) {
1974 lr = -1; /* Call method for left argument */
1976 if (cvp && amtp->fallback > AMGfallNEVER && flags & AMGf_unary) {
1979 /* look for substituted methods */
1980 /* In all the covered cases we should be called with assign==0. */
1984 if ((cv = cvp[off=add_ass_amg])
1985 || ((cv = cvp[off = add_amg]) && (force_cpy = 0, postpr = 1))) {
1986 right = &PL_sv_yes; lr = -1; assign = 1;
1991 if ((cv = cvp[off = subtr_ass_amg])
1992 || ((cv = cvp[off = subtr_amg]) && (force_cpy = 0, postpr=1))) {
1993 right = &PL_sv_yes; lr = -1; assign = 1;
1997 (void)((cv = cvp[off=numer_amg]) || (cv = cvp[off=string_amg]));
2000 (void)((cv = cvp[off=string_amg]) || (cv = cvp[off=bool__amg]));
2003 (void)((cv = cvp[off=numer_amg]) || (cv = cvp[off=bool__amg]));
2006 (void)((cv = cvp[off=bool__amg])
2007 || (cv = cvp[off=numer_amg])
2008 || (cv = cvp[off=string_amg]));
2015 * SV* ref causes confusion with the interpreter variable of
2018 SV* const tmpRef=SvRV(left);
2019 if (!SvROK(tmpRef) && SvTYPE(tmpRef) <= SVt_PVMG) {
2021 * Just to be extra cautious. Maybe in some
2022 * additional cases sv_setsv is safe, too.
2024 SV* const newref = newSVsv(tmpRef);
2025 SvOBJECT_on(newref);
2026 /* As a bit of a source compatibility hack, SvAMAGIC() and
2027 friends dereference an RV, to behave the same was as when
2028 overloading was stored on the reference, not the referant.
2029 Hence we can't use SvAMAGIC_on()
2031 SvFLAGS(newref) |= SVf_AMAGIC;
2032 SvSTASH_set(newref, MUTABLE_HV(SvREFCNT_inc(SvSTASH(tmpRef))));
2038 if ((cvp[off1=lt_amg] || cvp[off1=ncmp_amg])
2039 && ((cv = cvp[off=neg_amg]) || (cv = cvp[off=subtr_amg]))) {
2040 SV* const nullsv=sv_2mortal(newSViv(0));
2042 SV* const lessp = amagic_call(left,nullsv,
2043 lt_amg,AMGf_noright);
2044 logic = SvTRUE(lessp);
2046 SV* const lessp = amagic_call(left,nullsv,
2047 ncmp_amg,AMGf_noright);
2048 logic = (SvNV(lessp) < 0);
2051 if (off==subtr_amg) {
2062 if ((cv = cvp[off=subtr_amg])) {
2064 left = sv_2mortal(newSViv(0));
2069 case iter_amg: /* XXXX Eventually should do to_gv. */
2070 case ftest_amg: /* XXXX Eventually should do to_gv. */
2073 return NULL; /* Delegate operation to standard mechanisms. */
2081 return left; /* Delegate operation to standard mechanisms. */
2086 if (!cv) goto not_found;
2087 } else if (!(AMGf_noright & flags) && SvAMAGIC(right)
2088 && (stash = SvSTASH(SvRV(right)))
2089 && (mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table))
2090 && (cvp = (AMT_AMAGIC((AMT*)mg->mg_ptr)
2091 ? (amtp = (AMT*)mg->mg_ptr)->table
2093 && (cv = cvp[off=method])) { /* Method for right
2096 } else if (((ocvp && oamtp->fallback > AMGfallNEVER
2097 && (cvp=ocvp) && (lr = -1))
2098 || (cvp && amtp->fallback > AMGfallNEVER && (lr=1)))
2099 && !(flags & AMGf_unary)) {
2100 /* We look for substitution for
2101 * comparison operations and
2103 if (method==concat_amg || method==concat_ass_amg
2104 || method==repeat_amg || method==repeat_ass_amg) {
2105 return NULL; /* Delegate operation to string conversion */
2126 if ((off != -1) && (cv = cvp[off]))
2131 not_found: /* No method found, either report or croak */
2139 return left; /* Delegate operation to standard mechanisms. */
2142 if (ocvp && (cv=ocvp[nomethod_amg])) { /* Call report method */
2143 notfound = 1; lr = -1;
2144 } else if (cvp && (cv=cvp[nomethod_amg])) {
2145 notfound = 1; lr = 1;
2146 } else if ((amtp && amtp->fallback >= AMGfallYES) && !DEBUG_o_TEST) {
2147 /* Skip generating the "no method found" message. */
2151 if (off==-1) off=method;
2152 msg = sv_2mortal(Perl_newSVpvf(aTHX_
2153 "Operation \"%s\": no method found,%sargument %s%s%s%s",
2154 AMG_id2name(method + assignshift),
2155 (flags & AMGf_unary ? " " : "\n\tleft "),
2157 "in overloaded package ":
2158 "has no overloaded magic",
2160 HvNAME_get(SvSTASH(SvRV(left))):
2163 ",\n\tright argument in overloaded package ":
2166 : ",\n\tright argument has no overloaded magic"),
2168 HvNAME_get(SvSTASH(SvRV(right))):
2170 if (amtp && amtp->fallback >= AMGfallYES) {
2171 DEBUG_o( Perl_deb(aTHX_ "%s", SvPVX_const(msg)) );
2173 Perl_croak(aTHX_ "%"SVf, SVfARG(msg));
2177 force_cpy = force_cpy || assign;
2182 DEBUG_o(Perl_deb(aTHX_
2183 "Overloaded operator \"%s\"%s%s%s:\n\tmethod%s found%s in package %s%s\n",
2185 method+assignshift==off? "" :
2187 method+assignshift==off? "" :
2188 AMG_id2name(method+assignshift),
2189 method+assignshift==off? "" : "\")",
2190 flags & AMGf_unary? "" :
2191 lr==1 ? " for right argument": " for left argument",
2192 flags & AMGf_unary? " for argument" : "",
2193 stash ? HvNAME_get(stash) : "null",
2194 fl? ",\n\tassignment variant used": "") );
2197 /* Since we use shallow copy during assignment, we need
2198 * to dublicate the contents, probably calling user-supplied
2199 * version of copy operator
2201 /* We need to copy in following cases:
2202 * a) Assignment form was called.
2203 * assignshift==1, assign==T, method + 1 == off
2204 * b) Increment or decrement, called directly.
2205 * assignshift==0, assign==0, method + 0 == off
2206 * c) Increment or decrement, translated to assignment add/subtr.
2207 * assignshift==0, assign==T,
2209 * d) Increment or decrement, translated to nomethod.
2210 * assignshift==0, assign==0,
2212 * e) Assignment form translated to nomethod.
2213 * assignshift==1, assign==T, method + 1 != off
2216 /* off is method, method+assignshift, or a result of opcode substitution.
2217 * In the latter case assignshift==0, so only notfound case is important.
2219 if (( (method + assignshift == off)
2220 && (assign || (method == inc_amg) || (method == dec_amg)))
2230 const bool oldcatch = CATCH_GET;
2233 Zero(&myop, 1, BINOP);
2234 myop.op_last = (OP *) &myop;
2235 myop.op_next = NULL;
2236 myop.op_flags = OPf_WANT_SCALAR | OPf_STACKED;
2238 PUSHSTACKi(PERLSI_OVERLOAD);
2241 PL_op = (OP *) &myop;
2242 if (PERLDB_SUB && PL_curstash != PL_debstash)
2243 PL_op->op_private |= OPpENTERSUB_DB;
2247 EXTEND(SP, notfound + 5);
2248 PUSHs(lr>0? right: left);
2249 PUSHs(lr>0? left: right);
2250 PUSHs( lr > 0 ? &PL_sv_yes : ( assign ? &PL_sv_undef : &PL_sv_no ));
2252 PUSHs(newSVpvn_flags(AMG_id2name(method + assignshift),
2253 AMG_id2namelen(method + assignshift), SVs_TEMP));
2255 PUSHs(MUTABLE_SV(cv));
2258 if ((PL_op = PL_ppaddr[OP_ENTERSUB](aTHX)))
2266 CATCH_SET(oldcatch);
2273 ans=SvIV(res)<=0; break;
2276 ans=SvIV(res)<0; break;
2279 ans=SvIV(res)>=0; break;
2282 ans=SvIV(res)>0; break;
2285 ans=SvIV(res)==0; break;
2288 ans=SvIV(res)!=0; break;
2291 SvSetSV(left,res); return left;
2293 ans=!SvTRUE(res); break;
2298 } else if (method==copy_amg) {
2300 Perl_croak(aTHX_ "Copy method did not return a reference");
2302 return SvREFCNT_inc(SvRV(res));
2310 =for apidoc is_gv_magical_sv
2312 Returns C<TRUE> if given the name of a magical GV.
2314 Currently only useful internally when determining if a GV should be
2315 created even in rvalue contexts.
2317 C<flags> is not used at present but available for future extension to
2318 allow selecting particular classes of magical variable.
2320 Currently assumes that C<name> is NUL terminated (as well as len being valid).
2321 This assumption is met by all callers within the perl core, which all pass
2322 pointers returned by SvPV.
2328 Perl_is_gv_magical_sv(pTHX_ SV *const name_sv, U32 flags)
2331 const char *const name = SvPV_const(name_sv, len);
2333 PERL_UNUSED_ARG(flags);
2334 PERL_ARGS_ASSERT_IS_GV_MAGICAL_SV;
2337 const char * const name1 = name + 1;
2340 if (len == 3 && name[1] == 'S' && name[2] == 'A')
2344 if (len == 8 && strEQ(name1, "VERLOAD"))
2348 if (len == 3 && name[1] == 'I' && name[2] == 'G')
2351 /* Using ${^...} variables is likely to be sufficiently rare that
2352 it seems sensible to avoid the space hit of also checking the
2354 case '\017': /* ${^OPEN} */
2355 if (strEQ(name1, "PEN"))
2358 case '\024': /* ${^TAINT} */
2359 if (strEQ(name1, "AINT"))
2362 case '\025': /* ${^UNICODE} */
2363 if (strEQ(name1, "NICODE"))
2365 if (strEQ(name1, "TF8LOCALE"))
2368 case '\027': /* ${^WARNING_BITS} */
2369 if (strEQ(name1, "ARNING_BITS"))
2382 const char *end = name + len;
2383 while (--end > name) {
2391 /* Because we're already assuming that name is NUL terminated
2392 below, we can treat an empty name as "\0" */
2418 case '\001': /* $^A */
2419 case '\003': /* $^C */
2420 case '\004': /* $^D */
2421 case '\005': /* $^E */
2422 case '\006': /* $^F */
2423 case '\010': /* $^H */
2424 case '\011': /* $^I, NOT \t in EBCDIC */
2425 case '\014': /* $^L */
2426 case '\016': /* $^N */
2427 case '\017': /* $^O */
2428 case '\020': /* $^P */
2429 case '\023': /* $^S */
2430 case '\024': /* $^T */
2431 case '\026': /* $^V */
2432 case '\027': /* $^W */
2452 Perl_gv_name_set(pTHX_ GV *gv, const char *name, U32 len, U32 flags)
2457 PERL_ARGS_ASSERT_GV_NAME_SET;
2458 PERL_UNUSED_ARG(flags);
2461 Perl_croak(aTHX_ "panic: gv name too long (%"UVuf")", (UV) len);
2463 if (!(flags & GV_ADD) && GvNAME_HEK(gv)) {
2464 unshare_hek(GvNAME_HEK(gv));
2467 PERL_HASH(hash, name, len);
2468 GvNAME_HEK(gv) = share_hek(name, len, hash);
2472 =for apidoc gv_try_downgrade
2474 If the typeglob C<gv> can be expressed more succinctly, by having
2475 something other than a real GV in its place in the stash, replace it
2476 with the optimised form. Basic requirements for this are that C<gv>
2477 is a real typeglob, is sufficiently ordinary, and is only referenced
2478 from its package. This function is meant to be used when a GV has been
2479 looked up in part to see what was there, causing upgrading, but based
2480 on what was found it turns out that the real GV isn't required after all.
2482 If C<gv> is a completely empty typeglob, it is deleted from the stash.
2484 If C<gv> is a typeglob containing only a sufficiently-ordinary constant
2485 sub, the typeglob is replaced with a scalar-reference placeholder that
2486 more compactly represents the same thing.
2492 Perl_gv_try_downgrade(pTHX_ GV *gv)
2498 PERL_ARGS_ASSERT_GV_TRY_DOWNGRADE;
2499 if (!(SvREFCNT(gv) == 1 && SvTYPE(gv) == SVt_PVGV && !SvFAKE(gv) &&
2500 !SvOBJECT(gv) && !SvMAGICAL(gv) && !SvREADONLY(gv) &&
2501 isGV_with_GP(gv) && GvGP(gv) &&
2502 !GvINTRO(gv) && GvREFCNT(gv) == 1 &&
2503 !GvSV(gv) && !GvAV(gv) && !GvHV(gv) && !GvIOp(gv) && !GvFORM(gv) &&
2504 GvEGVx(gv) == gv && (stash = GvSTASH(gv))))
2508 HEK *gvnhek = GvNAME_HEK(gv);
2509 (void)hv_delete(stash, HEK_KEY(gvnhek),
2510 HEK_UTF8(gvnhek) ? -HEK_LEN(gvnhek) : HEK_LEN(gvnhek), G_DISCARD);
2511 } else if (GvMULTI(gv) && cv &&
2512 !SvOBJECT(cv) && !SvMAGICAL(cv) && !SvREADONLY(cv) &&
2513 CvSTASH(cv) == stash && CvGV(cv) == gv &&
2514 CvCONST(cv) && !CvMETHOD(cv) && !CvLVALUE(cv) && !CvUNIQUE(cv) &&
2515 !CvNODEBUG(cv) && !CvCLONE(cv) && !CvCLONED(cv) && !CvANON(cv) &&
2516 (namehek = GvNAME_HEK(gv)) &&
2517 (gvp = hv_fetch(stash, HEK_KEY(namehek),
2518 HEK_LEN(namehek)*(HEK_UTF8(namehek) ? -1 : 1), 0)) &&
2520 SV *value = SvREFCNT_inc(CvXSUBANY(cv).any_ptr);
2524 SvFLAGS(gv) = SVt_IV|SVf_ROK;
2525 SvANY(gv) = (XPVGV*)((char*)&(gv->sv_u.svu_iv) -
2526 STRUCT_OFFSET(XPVIV, xiv_iv));
2527 SvRV_set(gv, value);
2533 * c-indentation-style: bsd
2535 * indent-tabs-mode: t
2538 * ex: set ts=8 sts=4 sw=4 noet: