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.
41 static const char S_autoload[] = "AUTOLOAD";
42 static const STRLEN S_autolen = sizeof(S_autoload)-1;
45 Perl_gv_add_by_type(pTHX_ GV *gv, svtype type)
52 SvTYPE((const SV *)gv) != SVt_PVGV
53 && SvTYPE((const SV *)gv) != SVt_PVLV
57 if (type == SVt_PVIO) {
59 * if it walks like a dirhandle, then let's assume that
60 * this is a dirhandle.
62 what = OP_IS_DIRHOP(PL_op->op_type) ?
63 "dirhandle" : "filehandle";
64 /* diag_listed_as: Bad symbol for filehandle */
65 } else if (type == SVt_PVHV) {
68 what = type == SVt_PVAV ? "array" : "scalar";
70 Perl_croak(aTHX_ "Bad symbol for %s", what);
73 if (type == SVt_PVHV) {
74 where = (SV **)&GvHV(gv);
75 } else if (type == SVt_PVAV) {
76 where = (SV **)&GvAV(gv);
77 } else if (type == SVt_PVIO) {
78 where = (SV **)&GvIOp(gv);
84 *where = newSV_type(type);
89 Perl_gv_fetchfile(pTHX_ const char *name)
91 PERL_ARGS_ASSERT_GV_FETCHFILE;
92 return gv_fetchfile_flags(name, strlen(name), 0);
96 Perl_gv_fetchfile_flags(pTHX_ const char *const name, const STRLEN namelen,
102 const STRLEN tmplen = namelen + 2;
105 PERL_ARGS_ASSERT_GV_FETCHFILE_FLAGS;
106 PERL_UNUSED_ARG(flags);
111 if (tmplen <= sizeof smallbuf)
114 Newx(tmpbuf, tmplen, char);
115 /* This is where the debugger's %{"::_<$filename"} hash is created */
118 memcpy(tmpbuf + 2, name, namelen);
119 gv = *(GV**)hv_fetch(PL_defstash, tmpbuf, tmplen, TRUE);
121 gv_init(gv, PL_defstash, tmpbuf, tmplen, FALSE);
122 #ifdef PERL_DONT_CREATE_GVSV
123 GvSV(gv) = newSVpvn(name, namelen);
125 sv_setpvn(GvSV(gv), name, namelen);
128 if ((PERLDB_LINE || PERLDB_SAVESRC) && !GvAV(gv))
129 hv_magic(GvHVn(gv_AVadd(gv)), NULL, PERL_MAGIC_dbfile);
130 if (tmpbuf != smallbuf)
136 =for apidoc gv_const_sv
138 If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
139 inlining, or C<gv> is a placeholder reference that would be promoted to such
140 a typeglob, then returns the value returned by the sub. Otherwise, returns
147 Perl_gv_const_sv(pTHX_ GV *gv)
149 PERL_ARGS_ASSERT_GV_CONST_SV;
151 if (SvTYPE(gv) == SVt_PVGV)
152 return cv_const_sv(GvCVu(gv));
153 return SvROK(gv) ? SvRV(gv) : NULL;
157 Perl_newGP(pTHX_ GV *const gv)
162 const char *const file
163 = (PL_curcop && CopFILE(PL_curcop)) ? CopFILE(PL_curcop) : "";
164 const STRLEN len = strlen(file);
166 SV *const temp_sv = CopFILESV(PL_curcop);
170 PERL_ARGS_ASSERT_NEWGP;
173 file = SvPVX(temp_sv);
174 len = SvCUR(temp_sv);
181 PERL_HASH(hash, file, len);
185 #ifndef PERL_DONT_CREATE_GVSV
186 gp->gp_sv = newSV(0);
189 gp->gp_line = PL_curcop ? CopLINE(PL_curcop) : 0;
190 /* XXX Ideally this cast would be replaced with a change to const char*
192 gp->gp_file_hek = share_hek(file, len, hash);
199 /* Assign CvGV(cv) = gv, handling weak references.
200 * See also S_anonymise_cv_maybe */
203 Perl_cvgv_set(pTHX_ CV* cv, GV* gv)
205 GV * const oldgv = CvGV(cv);
206 PERL_ARGS_ASSERT_CVGV_SET;
217 sv_del_backref(MUTABLE_SV(oldgv), MUTABLE_SV(cv));
221 SvANY(cv)->xcv_gv = gv;
222 assert(!CvCVGV_RC(cv));
227 if (isGV_with_GP(gv) && GvGP(gv) && (GvCV(gv) == cv || GvFORM(gv) == cv))
228 Perl_sv_add_backref(aTHX_ MUTABLE_SV(gv), MUTABLE_SV(cv));
231 SvREFCNT_inc_simple_void_NN(gv);
235 /* Assign CvSTASH(cv) = st, handling weak references. */
238 Perl_cvstash_set(pTHX_ CV *cv, HV *st)
240 HV *oldst = CvSTASH(cv);
241 PERL_ARGS_ASSERT_CVSTASH_SET;
245 sv_del_backref(MUTABLE_SV(oldst), MUTABLE_SV(cv));
246 SvANY(cv)->xcv_stash = st;
248 Perl_sv_add_backref(aTHX_ MUTABLE_SV(st), MUTABLE_SV(cv));
252 =for apidoc gv_init_pvn
254 Converts a scalar into a typeglob. This is an incoercible typeglob;
255 assigning a reference to it will assign to one of its slots, instead of
256 overwriting it as happens with typeglobs created by SvSetSV. Converting
257 any scalar that is SvOK() may produce unpredictable results and is reserved
258 for perl's internal use.
260 C<gv> is the scalar to be converted.
262 C<stash> is the parent stash/package, if any.
264 C<name> and C<len> give the name. The name must be unqualified;
265 that is, it must not include the package name. If C<gv> is a
266 stash element, it is the caller's responsibility to ensure that the name
267 passed to this function matches the name of the element. If it does not
268 match, perl's internal bookkeeping will get out of sync.
270 C<flags> can be set to SVf_UTF8 if C<name> is a UTF8 string, or
271 the return value of SvUTF8(sv). It can also take the
272 GV_ADDMULTI flag, which means to pretend that the GV has been
273 seen before (i.e., suppress "Used once" warnings).
277 The old form of gv_init_pvn(). It does not work with UTF8 strings, as it
278 has no flags parameter. If the C<multi> parameter is set, the
279 GV_ADDMULTI flag will be passed to gv_init_pvn().
281 =for apidoc gv_init_pv
283 Same as gv_init_pvn(), but takes a nul-terminated string for the name
284 instead of separate char * and length parameters.
286 =for apidoc gv_init_sv
288 Same as gv_init_pvn(), but takes an SV * for the name instead of separate
289 char * and length parameters. C<flags> is currently unused.
295 Perl_gv_init_sv(pTHX_ GV *gv, HV *stash, SV* namesv, U32 flags)
299 PERL_ARGS_ASSERT_GV_INIT_SV;
300 namepv = SvPV(namesv, namelen);
303 gv_init_pvn(gv, stash, namepv, namelen, flags);
307 Perl_gv_init_pv(pTHX_ GV *gv, HV *stash, const char *name, U32 flags)
309 PERL_ARGS_ASSERT_GV_INIT_PV;
310 gv_init_pvn(gv, stash, name, strlen(name), flags);
314 Perl_gv_init_pvn(pTHX_ GV *gv, HV *stash, const char *name, STRLEN len, U32 flags)
317 const U32 old_type = SvTYPE(gv);
318 const bool doproto = old_type > SVt_NULL;
319 char * const proto = (doproto && SvPOK(gv)) ? SvPVX(gv) : NULL;
320 const STRLEN protolen = proto ? SvCUR(gv) : 0;
321 const U32 proto_utf8 = proto ? SvUTF8(gv) : 0;
322 SV *const has_constant = doproto && SvROK(gv) ? SvRV(gv) : NULL;
323 const U32 exported_constant = has_constant ? SvPCS_IMPORTED(gv) : 0;
325 PERL_ARGS_ASSERT_GV_INIT_PVN;
326 assert (!(proto && has_constant));
329 /* The constant has to be a simple scalar type. */
330 switch (SvTYPE(has_constant)) {
336 Perl_croak(aTHX_ "Cannot convert a reference to %s to typeglob",
337 sv_reftype(has_constant, 0));
345 if (old_type < SVt_PVGV) {
346 if (old_type >= SVt_PV)
348 sv_upgrade(MUTABLE_SV(gv), SVt_PVGV);
356 Safefree(SvPVX_mutable(gv));
361 GvGP_set(gv, Perl_newGP(aTHX_ gv));
364 Perl_sv_add_backref(aTHX_ MUTABLE_SV(stash), MUTABLE_SV(gv));
365 gv_name_set(gv, name, len, GV_ADD | ( flags & SVf_UTF8 ? SVf_UTF8 : 0 ));
366 if (flags & GV_ADDMULTI || doproto) /* doproto means it */
367 GvMULTI_on(gv); /* _was_ mentioned */
368 if (doproto) { /* Replicate part of newSUB here. */
372 /* newCONSTSUB takes ownership of the reference from us. */
373 cv = newCONSTSUB_flags(stash, name, len, flags, has_constant);
374 /* In case op.c:S_process_special_blocks stole it: */
376 GvCV_set(gv, (CV *)SvREFCNT_inc_simple_NN(cv));
377 assert(GvCV(gv) == cv); /* newCONSTSUB should have set this */
378 /* If this reference was a copy of another, then the subroutine
379 must have been "imported", by a Perl space assignment to a GV
380 from a reference to CV. */
381 if (exported_constant)
382 GvIMPORTED_CV_on(gv);
384 (void) start_subparse(0,0); /* Create empty CV in compcv. */
390 mro_method_changed_in(GvSTASH(gv)); /* sub Foo::bar($) { (shift) } sub ASDF::baz($); *ASDF::baz = \&Foo::bar */
392 CvFILE_set_from_cop(cv, PL_curcop);
393 CvSTASH_set(cv, PL_curstash);
395 sv_usepvn_flags(MUTABLE_SV(cv), proto, protolen,
396 SV_HAS_TRAILING_NUL);
397 if ( proto_utf8 ) SvUTF8_on(MUTABLE_SV(cv));
403 S_gv_init_svtype(pTHX_ GV *gv, const svtype sv_type)
405 PERL_ARGS_ASSERT_GV_INIT_SVTYPE;
417 #ifdef PERL_DONT_CREATE_GVSV
425 /* Work round what appears to be a bug in Sun C++ 5.8 2005/10/13
426 If we just cast GvSVn(gv) to void, it ignores evaluating it for
433 static void core_xsub(pTHX_ CV* cv);
436 S_maybe_add_coresub(pTHX_ HV * const stash, GV *gv,
437 const char * const name, const STRLEN len,
438 const char * const fullname, STRLEN const fullen)
440 const int code = keyword(name, len, 1);
441 static const char file[] = __FILE__;
442 CV *cv, *oldcompcv = NULL;
445 bool ampable = TRUE; /* &{}-able */
446 COP *oldcurcop = NULL;
447 yy_parser *oldparser = NULL;
448 I32 oldsavestack_ix = 0;
452 assert(stash || fullname);
454 if (!fullname && !HvENAME(stash)) return NULL; /* pathological case
456 inlining newATTRSUB */
457 if (code >= 0) return NULL; /* not overridable */
459 /* no support for \&CORE::infix;
460 no support for funcs that take labels, as their parsing is
462 case KEY_and: case KEY_cmp: case KEY_CORE: case KEY_dump:
463 case KEY_eq: case KEY_ge:
464 case KEY_gt: case KEY_le: case KEY_lt: case KEY_ne:
465 case KEY_or: case KEY_x: case KEY_xor:
468 case KEY_chomp: case KEY_chop:
469 case KEY_each: case KEY_eof: case KEY_exec:
478 case KEY_truncate: case KEY_unlink:
485 gv_init(gv, stash, name, len, TRUE);
489 oldcurcop = PL_curcop;
490 oldparser = PL_parser;
491 lex_start(NULL, NULL, 0);
492 oldcompcv = PL_compcv;
493 PL_compcv = NULL; /* Prevent start_subparse from setting
495 oldsavestack_ix = start_subparse(FALSE,0);
499 /* Avoid calling newXS, as it calls us, and things start to
501 cv = MUTABLE_CV(newSV_type(SVt_PVCV));
504 mro_method_changed_in(GvSTASH(gv));
506 CvXSUB(cv) = core_xsub;
508 CvGV_set(cv, gv); /* This stops new ATTRSUB from setting CvFILE
510 (void)gv_fetchfile(file);
511 CvFILE(cv) = (char *)file;
512 /* XXX This is inefficient, as doing things this order causes
513 a prototype check in newATTRSUB. But we have to do
514 it this order as we need an op number before calling
516 (void)core_prototype((SV *)cv, name, code, &opnum);
517 if (stash && (fullname || !fullen))
518 (void)hv_store(stash,name,len,(SV *)gv,0);
523 tmpstr = newSVhek(HvENAME_HEK(stash));
524 sv_catpvs(tmpstr, "::");
525 sv_catpvn(tmpstr,name,len);
527 else tmpstr = newSVpvn_share(fullname,fullen,0);
528 newATTRSUB(oldsavestack_ix,
529 newSVOP(OP_CONST, 0, tmpstr),
534 : newSVpvn(name,len),
538 assert(GvCV(gv) == cv);
539 if (opnum != OP_VEC && opnum != OP_SUBSTR)
540 CvLVALUE_off(cv); /* Now *that* was a neat trick. */
542 PL_parser = oldparser;
543 PL_curcop = oldcurcop;
544 PL_compcv = oldcompcv;
546 opnumsv = opnum ? newSVuv((UV)opnum) : (SV *)NULL;
548 cv, Perl_ck_entersub_args_core, opnumsv ? opnumsv : (SV *)cv
550 SvREFCNT_dec(opnumsv);
555 =for apidoc gv_fetchmeth
557 Like L</gv_fetchmeth_pvn>, but lacks a flags parameter.
559 =for apidoc gv_fetchmeth_sv
561 Exactly like L</gv_fetchmeth_pvn>, but takes the name string in the form
562 of an SV instead of a string/length pair.
568 Perl_gv_fetchmeth_sv(pTHX_ HV *stash, SV *namesv, I32 level, U32 flags)
572 PERL_ARGS_ASSERT_GV_FETCHMETH_SV;
573 namepv = SvPV(namesv, namelen);
576 return gv_fetchmeth_pvn(stash, namepv, namelen, level, flags);
580 =for apidoc gv_fetchmeth_pv
582 Exactly like L</gv_fetchmeth_pvn>, but takes a nul-terminated string
583 instead of a string/length pair.
589 Perl_gv_fetchmeth_pv(pTHX_ HV *stash, const char *name, I32 level, U32 flags)
591 PERL_ARGS_ASSERT_GV_FETCHMETH_PV;
592 return gv_fetchmeth_pvn(stash, name, strlen(name), level, flags);
596 =for apidoc gv_fetchmeth_pvn
598 Returns the glob with the given C<name> and a defined subroutine or
599 C<NULL>. The glob lives in the given C<stash>, or in the stashes
600 accessible via @ISA and UNIVERSAL::.
602 The argument C<level> should be either 0 or -1. If C<level==0>, as a
603 side-effect creates a glob with the given C<name> in the given C<stash>
604 which in the case of success contains an alias for the subroutine, and sets
605 up caching info for this glob.
607 Currently, the only significant value for C<flags> is SVf_UTF8.
609 This function grants C<"SUPER"> token as a postfix of the stash name. The
610 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
611 visible to Perl code. So when calling C<call_sv>, you should not use
612 the GV directly; instead, you should use the method's CV, which can be
613 obtained from the GV with the C<GvCV> macro.
618 /* NOTE: No support for tied ISA */
621 Perl_gv_fetchmeth_pvn(pTHX_ HV *stash, const char *name, STRLEN len, I32 level, U32 flags)
629 GV* candidate = NULL;
633 I32 create = (level >= 0) ? 1 : 0;
637 U32 is_utf8 = flags & SVf_UTF8;
639 PERL_ARGS_ASSERT_GV_FETCHMETH_PVN;
641 /* UNIVERSAL methods should be callable without a stash */
643 create = 0; /* probably appropriate */
644 if(!(stash = gv_stashpvs("UNIVERSAL", 0)))
650 hvname = HvNAME_get(stash);
652 Perl_croak(aTHX_ "Can't use anonymous symbol table for method lookup");
657 DEBUG_o( Perl_deb(aTHX_ "Looking for method %s in package %s\n",name,hvname) );
659 topgen_cmp = HvMROMETA(stash)->cache_gen + PL_sub_generation;
661 /* check locally for a real method or a cache entry */
662 gvp = (GV**)hv_fetch(stash, name, is_utf8 ? -(I32)len : (I32)len, create);
667 if (SvTYPE(topgv) != SVt_PVGV)
668 gv_init_pvn(topgv, stash, name, len, GV_ADDMULTI|is_utf8);
669 if ((cand_cv = GvCV(topgv))) {
670 /* If genuine method or valid cache entry, use it */
671 if (!GvCVGEN(topgv) || GvCVGEN(topgv) == topgen_cmp) {
675 /* stale cache entry, junk it and move on */
676 SvREFCNT_dec(cand_cv);
677 GvCV_set(topgv, NULL);
682 else if (GvCVGEN(topgv) == topgen_cmp) {
683 /* cache indicates no such method definitively */
686 else if (len > 1 /* shortest is uc */ && HvNAMELEN_get(stash) == 4
687 && strnEQ(hvname, "CORE", 4)
688 && S_maybe_add_coresub(aTHX_ stash,topgv,name,len,0,1))
692 packlen = HvNAMELEN_get(stash);
693 if (packlen >= 7 && strEQ(hvname + packlen - 7, "::SUPER")) {
696 basestash = gv_stashpvn(hvname, packlen,
697 GV_ADD | (HvNAMEUTF8(stash) ? SVf_UTF8 : 0));
698 linear_av = mro_get_linear_isa(basestash);
701 linear_av = mro_get_linear_isa(stash); /* has ourselves at the top of the list */
704 linear_svp = AvARRAY(linear_av) + 1; /* skip over self */
705 items = AvFILLp(linear_av); /* no +1, to skip over self */
707 linear_sv = *linear_svp++;
709 cstash = gv_stashsv(linear_sv, 0);
712 Perl_ck_warner(aTHX_ packWARN(WARN_SYNTAX),
713 "Can't locate package %"SVf" for @%"HEKf"::ISA",
715 HEKfARG(HvNAME_HEK(stash)));
721 gvp = (GV**)hv_fetch(cstash, name, is_utf8 ? -(I32)len : (I32)len, 0);
723 if (len > 1 && HvNAMELEN_get(cstash) == 4) {
724 const char *hvname = HvNAME(cstash); assert(hvname);
725 if (strnEQ(hvname, "CORE", 4)
727 S_maybe_add_coresub(aTHX_ cstash,NULL,name,len,0,0)
733 else candidate = *gvp;
736 if (SvTYPE(candidate) != SVt_PVGV)
737 gv_init_pvn(candidate, cstash, name, len, GV_ADDMULTI|is_utf8);
738 if (SvTYPE(candidate) == SVt_PVGV && (cand_cv = GvCV(candidate)) && !GvCVGEN(candidate)) {
740 * Found real method, cache method in topgv if:
741 * 1. topgv has no synonyms (else inheritance crosses wires)
742 * 2. method isn't a stub (else AUTOLOAD fails spectacularly)
744 if (topgv && (GvREFCNT(topgv) == 1) && (CvROOT(cand_cv) || CvXSUB(cand_cv))) {
745 CV *old_cv = GvCV(topgv);
746 SvREFCNT_dec(old_cv);
747 SvREFCNT_inc_simple_void_NN(cand_cv);
748 GvCV_set(topgv, cand_cv);
749 GvCVGEN(topgv) = topgen_cmp;
755 /* Check UNIVERSAL without caching */
756 if(level == 0 || level == -1) {
757 candidate = gv_fetchmeth_pvn(NULL, name, len, 1, flags);
759 cand_cv = GvCV(candidate);
760 if (topgv && (GvREFCNT(topgv) == 1) && (CvROOT(cand_cv) || CvXSUB(cand_cv))) {
761 CV *old_cv = GvCV(topgv);
762 SvREFCNT_dec(old_cv);
763 SvREFCNT_inc_simple_void_NN(cand_cv);
764 GvCV_set(topgv, cand_cv);
765 GvCVGEN(topgv) = topgen_cmp;
771 if (topgv && GvREFCNT(topgv) == 1) {
772 /* cache the fact that the method is not defined */
773 GvCVGEN(topgv) = topgen_cmp;
780 =for apidoc gv_fetchmeth_autoload
782 This is the old form of L</gv_fetchmeth_pvn_autoload>, which has no flags
785 =for apidoc gv_fetchmeth_sv_autoload
787 Exactly like L</gv_fetchmeth_pvn_autoload>, but takes the name string in the form
788 of an SV instead of a string/length pair.
794 Perl_gv_fetchmeth_sv_autoload(pTHX_ HV *stash, SV *namesv, I32 level, U32 flags)
798 PERL_ARGS_ASSERT_GV_FETCHMETH_SV_AUTOLOAD;
799 namepv = SvPV(namesv, namelen);
802 return gv_fetchmeth_pvn_autoload(stash, namepv, namelen, level, flags);
806 =for apidoc gv_fetchmeth_pv_autoload
808 Exactly like L</gv_fetchmeth_pvn_autoload>, but takes a nul-terminated string
809 instead of a string/length pair.
815 Perl_gv_fetchmeth_pv_autoload(pTHX_ HV *stash, const char *name, I32 level, U32 flags)
817 PERL_ARGS_ASSERT_GV_FETCHMETH_PV_AUTOLOAD;
818 return gv_fetchmeth_pvn_autoload(stash, name, strlen(name), level, flags);
822 =for apidoc gv_fetchmeth_pvn_autoload
824 Same as gv_fetchmeth_pvn(), but looks for autoloaded subroutines too.
825 Returns a glob for the subroutine.
827 For an autoloaded subroutine without a GV, will create a GV even
828 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
829 of the result may be zero.
831 Currently, the only significant value for C<flags> is SVf_UTF8.
837 Perl_gv_fetchmeth_pvn_autoload(pTHX_ HV *stash, const char *name, STRLEN len, I32 level, U32 flags)
839 GV *gv = gv_fetchmeth_pvn(stash, name, len, level, flags);
841 PERL_ARGS_ASSERT_GV_FETCHMETH_PVN_AUTOLOAD;
848 return NULL; /* UNIVERSAL::AUTOLOAD could cause trouble */
849 if (len == S_autolen && memEQ(name, S_autoload, S_autolen))
851 if (!(gv = gv_fetchmeth_pvn(stash, S_autoload, S_autolen, FALSE, flags)))
854 if (!(CvROOT(cv) || CvXSUB(cv)))
856 /* Have an autoload */
857 if (level < 0) /* Cannot do without a stub */
858 gv_fetchmeth_pvn(stash, name, len, 0, flags);
859 gvp = (GV**)hv_fetch(stash, name,
860 (flags & SVf_UTF8) ? -(I32)len : (I32)len, (level >= 0));
869 =for apidoc gv_fetchmethod_autoload
871 Returns the glob which contains the subroutine to call to invoke the method
872 on the C<stash>. In fact in the presence of autoloading this may be the
873 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
876 The third parameter of C<gv_fetchmethod_autoload> determines whether
877 AUTOLOAD lookup is performed if the given method is not present: non-zero
878 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
879 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
880 with a non-zero C<autoload> parameter.
882 These functions grant C<"SUPER"> token as a prefix of the method name. Note
883 that if you want to keep the returned glob for a long time, you need to
884 check for it being "AUTOLOAD", since at the later time the call may load a
885 different subroutine due to $AUTOLOAD changing its value. Use the glob
886 created via a side effect to do this.
888 These functions have the same side-effects and as C<gv_fetchmeth> with
889 C<level==0>. C<name> should be writable if contains C<':'> or C<'
890 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
891 C<call_sv> apply equally to these functions.
897 S_gv_get_super_pkg(pTHX_ const char* name, I32 namelen, U32 flags)
904 PERL_ARGS_ASSERT_GV_GET_SUPER_PKG;
906 stash = gv_stashpvn(name, namelen, flags);
907 if(stash) return stash;
909 /* If we must create it, give it an @ISA array containing
910 the real package this SUPER is for, so that it's tied
911 into the cache invalidation code correctly */
912 stash = gv_stashpvn(name, namelen, GV_ADD | flags);
913 gvp = (GV**)hv_fetchs(stash, "ISA", TRUE);
915 gv_init(gv, stash, "ISA", 3, TRUE);
916 superisa = GvAVn(gv);
918 sv_magic(MUTABLE_SV(superisa), MUTABLE_SV(gv), PERL_MAGIC_isa, NULL, 0);
920 av_push(superisa, newSVpvn_flags(CopSTASHPV(PL_curcop),
921 strlen(CopSTASHPV(PL_curcop)),
922 CopSTASH_flags(PL_curcop)
925 av_push(superisa, newSVhek(CopSTASH(PL_curcop)
926 ? HvNAME_HEK(CopSTASH(PL_curcop)) : NULL));
933 Perl_gv_fetchmethod_autoload(pTHX_ HV *stash, const char *name, I32 autoload)
935 PERL_ARGS_ASSERT_GV_FETCHMETHOD_AUTOLOAD;
937 return gv_fetchmethod_flags(stash, name, autoload ? GV_AUTOLOAD : 0);
941 Perl_gv_fetchmethod_sv_flags(pTHX_ HV *stash, SV *namesv, U32 flags)
945 PERL_ARGS_ASSERT_GV_FETCHMETHOD_SV_FLAGS;
946 namepv = SvPV(namesv, namelen);
949 return gv_fetchmethod_pvn_flags(stash, namepv, namelen, flags);
953 Perl_gv_fetchmethod_pv_flags(pTHX_ HV *stash, const char *name, U32 flags)
955 PERL_ARGS_ASSERT_GV_FETCHMETHOD_PV_FLAGS;
956 return gv_fetchmethod_pvn_flags(stash, name, strlen(name), flags);
959 /* Don't merge this yet, as it's likely to get a len parameter, and possibly
962 Perl_gv_fetchmethod_pvn_flags(pTHX_ HV *stash, const char *name, const STRLEN len, U32 flags)
965 register const char *nend;
966 const char *nsplit = NULL;
969 const char * const origname = name;
970 SV *const error_report = MUTABLE_SV(stash);
971 const U32 autoload = flags & GV_AUTOLOAD;
972 const U32 do_croak = flags & GV_CROAK;
973 const U32 is_utf8 = flags & SVf_UTF8;
975 PERL_ARGS_ASSERT_GV_FETCHMETHOD_PVN_FLAGS;
977 if (SvTYPE(stash) < SVt_PVHV)
980 /* The only way stash can become NULL later on is if nsplit is set,
981 which in turn means that there is no need for a SVt_PVHV case
982 the error reporting code. */
985 for (nend = name; *nend || nend != (origname + len); nend++) {
990 else if (*nend == ':' && *(nend + 1) == ':') {
996 if ((nsplit - origname) == 5 && memEQ(origname, "SUPER", 5)) {
997 /* ->SUPER::method should really be looked up in original stash */
998 SV * const tmpstr = sv_2mortal(Perl_newSVpvf(aTHX_
1000 HEKfARG(HvNAME_HEK((HV*)CopSTASH(PL_curcop)))
1002 /* __PACKAGE__::SUPER stash should be autovivified */
1003 stash = gv_get_super_pkg(SvPVX_const(tmpstr), SvCUR(tmpstr), SvUTF8(tmpstr));
1004 DEBUG_o( Perl_deb(aTHX_ "Treating %s as %s::%s\n",
1005 origname, HvNAME_get(stash), name) );
1008 /* don't autovifify if ->NoSuchStash::method */
1009 stash = gv_stashpvn(origname, nsplit - origname, is_utf8);
1011 /* however, explicit calls to Pkg::SUPER::method may
1012 happen, and may require autovivification to work */
1013 if (!stash && (nsplit - origname) >= 7 &&
1014 strnEQ(nsplit - 7, "::SUPER", 7) &&
1015 gv_stashpvn(origname, nsplit - origname - 7, is_utf8))
1016 stash = gv_get_super_pkg(origname, nsplit - origname, flags);
1021 gv = gv_fetchmeth_pvn(stash, name, nend - name, 0, flags);
1023 if (strEQ(name,"import") || strEQ(name,"unimport"))
1024 gv = MUTABLE_GV(&PL_sv_yes);
1026 gv = gv_autoload_pvn(
1027 ostash, name, nend - name, GV_AUTOLOAD_ISMETHOD|flags
1029 if (!gv && do_croak) {
1030 /* Right now this is exclusively for the benefit of S_method_common
1033 /* If we can't find an IO::File method, it might be a call on
1034 * a filehandle. If IO:File has not been loaded, try to
1035 * require it first instead of croaking */
1036 const char *stash_name = HvNAME_get(stash);
1037 if (stash_name && memEQs(stash_name, HvNAMELEN_get(stash), "IO::File")
1038 && !Perl_hv_common(aTHX_ GvHVn(PL_incgv), NULL,
1039 STR_WITH_LEN("IO/File.pm"), 0,
1040 HV_FETCH_ISEXISTS, NULL, 0)
1042 require_pv("IO/File.pm");
1043 gv = gv_fetchmeth_pvn(stash, name, nend - name, 0, flags);
1048 "Can't locate object method \"%"SVf
1049 "\" via package \"%"HEKf"\"",
1050 SVfARG(newSVpvn_flags(name, nend - name,
1051 SVs_TEMP | is_utf8)),
1052 HEKfARG(HvNAME_HEK(stash)));
1058 packnamesv = newSVpvn_flags(origname, nsplit - origname,
1059 SVs_TEMP | is_utf8);
1061 packnamesv = sv_2mortal(newSVsv(error_report));
1065 "Can't locate object method \"%"SVf"\" via package \"%"SVf"\""
1066 " (perhaps you forgot to load \"%"SVf"\"?)",
1067 SVfARG(newSVpvn_flags(name, nend - name,
1068 SVs_TEMP | is_utf8)),
1069 SVfARG(packnamesv), SVfARG(packnamesv));
1073 else if (autoload) {
1074 CV* const cv = GvCV(gv);
1075 if (!CvROOT(cv) && !CvXSUB(cv)) {
1083 if (GvCV(stubgv) != cv) /* orphaned import */
1086 autogv = gv_autoload_pvn(GvSTASH(stubgv),
1087 GvNAME(stubgv), GvNAMELEN(stubgv),
1088 GV_AUTOLOAD_ISMETHOD
1089 | (GvNAMEUTF8(stubgv) ? SVf_UTF8 : 0));
1099 Perl_gv_autoload_sv(pTHX_ HV *stash, SV* namesv, U32 flags)
1103 PERL_ARGS_ASSERT_GV_AUTOLOAD_SV;
1104 namepv = SvPV(namesv, namelen);
1107 return gv_autoload_pvn(stash, namepv, namelen, flags);
1111 Perl_gv_autoload_pv(pTHX_ HV *stash, const char *namepv, U32 flags)
1113 PERL_ARGS_ASSERT_GV_AUTOLOAD_PV;
1114 return gv_autoload_pvn(stash, namepv, strlen(namepv), flags);
1118 Perl_gv_autoload_pvn(pTHX_ HV *stash, const char *name, STRLEN len, U32 flags)
1126 SV *packname = NULL;
1127 U32 is_utf8 = flags & SVf_UTF8 ? SVf_UTF8 : 0;
1129 PERL_ARGS_ASSERT_GV_AUTOLOAD_PVN;
1131 if (len == S_autolen && memEQ(name, S_autoload, S_autolen))
1134 if (SvTYPE(stash) < SVt_PVHV) {
1135 STRLEN packname_len = 0;
1136 const char * const packname_ptr = SvPV_const(MUTABLE_SV(stash), packname_len);
1137 packname = newSVpvn_flags(packname_ptr, packname_len,
1138 SVs_TEMP | SvUTF8(stash));
1142 packname = sv_2mortal(newSVhek(HvNAME_HEK(stash)));
1144 if (!(gv = gv_fetchmeth_pvn(stash, S_autoload, S_autolen, FALSE, is_utf8)))
1148 if (!(CvROOT(cv) || CvXSUB(cv)))
1152 * Inheriting AUTOLOAD for non-methods works ... for now.
1155 !(flags & GV_AUTOLOAD_ISMETHOD)
1156 && (GvCVGEN(gv) || GvSTASH(gv) != stash)
1158 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED),
1159 "Use of inherited AUTOLOAD for non-method %"SVf"::%"SVf"() is deprecated",
1161 SVfARG(newSVpvn_flags(name, len, SVs_TEMP | is_utf8)));
1164 /* Instead of forcing the XSUB do another lookup for $AUTOLOAD
1165 * and split that value on the last '::', pass along the same data
1166 * via the SvPVX field in the CV, and the stash in CvSTASH.
1168 * Due to an unfortunate accident of history, the SvPVX field
1169 * serves two purposes. It is also used for the subroutine's pro-
1170 * type. Since SvPVX has been documented as returning the sub name
1171 * for a long time, but not as returning the prototype, we have
1172 * to preserve the SvPVX AUTOLOAD behaviour and put the prototype
1175 * We put the prototype in the same allocated buffer, but after
1176 * the sub name. The SvPOK flag indicates the presence of a proto-
1177 * type. The CvAUTOLOAD flag indicates the presence of a sub name.
1178 * If both flags are on, then SvLEN is used to indicate the end of
1179 * the prototype (artificially lower than what is actually allo-
1180 * cated), at the risk of having to reallocate a few bytes unneces-
1181 * sarily--but that should happen very rarely, if ever.
1183 * We use SvUTF8 for both prototypes and sub names, so if one is
1184 * UTF8, the other must be upgraded.
1186 CvSTASH_set(cv, stash);
1187 if (SvPOK(cv)) { /* Ouch! */
1188 SV *tmpsv = newSVpvn_flags(name, len, is_utf8);
1190 const char *proto = CvPROTO(cv);
1193 sv_utf8_upgrade_flags_grow(tmpsv, 0, CvPROTOLEN(cv) + 2);
1194 ulen = SvCUR(tmpsv);
1195 SvCUR(tmpsv)++; /* include null in string */
1197 tmpsv, proto, CvPROTOLEN(cv), SV_CATBYTES*!SvUTF8(cv)
1199 SvTEMP_on(tmpsv); /* Allow theft */
1200 sv_setsv_nomg((SV *)cv, tmpsv);
1202 SvREFCNT_dec(tmpsv);
1203 SvLEN(cv) = SvCUR(cv) + 1;
1207 sv_setpvn((SV *)cv, name, len);
1211 else SvUTF8_off(cv);
1217 * Given &FOO::AUTOLOAD, set $FOO::AUTOLOAD to desired function name.
1218 * The subroutine's original name may not be "AUTOLOAD", so we don't
1219 * use that, but for lack of anything better we will use the sub's
1220 * original package to look up $AUTOLOAD.
1222 varstash = GvSTASH(CvGV(cv));
1223 vargv = *(GV**)hv_fetch(varstash, S_autoload, S_autolen, TRUE);
1227 gv_init_pvn(vargv, varstash, S_autoload, S_autolen, 0);
1228 #ifdef PERL_DONT_CREATE_GVSV
1229 GvSV(vargv) = newSV(0);
1233 varsv = GvSVn(vargv);
1234 sv_setsv(varsv, packname);
1235 sv_catpvs(varsv, "::");
1236 /* Ensure SvSETMAGIC() is called if necessary. In particular, to clear
1237 tainting if $FOO::AUTOLOAD was previously tainted, but is not now. */
1240 SV_SMAGIC|(is_utf8 ? SV_CATUTF8 : SV_CATBYTES)
1248 /* require_tie_mod() internal routine for requiring a module
1249 * that implements the logic of automatic ties like %! and %-
1251 * The "gv" parameter should be the glob.
1252 * "varpv" holds the name of the var, used for error messages.
1253 * "namesv" holds the module name. Its refcount will be decremented.
1254 * "methpv" holds the method name to test for to check that things
1255 * are working reasonably close to as expected.
1256 * "flags": if flag & 1 then save the scalar before loading.
1257 * For the protection of $! to work (it is set by this routine)
1258 * the sv slot must already be magicalized.
1261 S_require_tie_mod(pTHX_ GV *gv, const char *varpv, SV* namesv, const char *methpv,const U32 flags)
1264 HV* stash = gv_stashsv(namesv, 0);
1266 PERL_ARGS_ASSERT_REQUIRE_TIE_MOD;
1268 if (!stash || !(gv_fetchmethod(stash, methpv))) {
1269 SV *module = newSVsv(namesv);
1270 char varname = *varpv; /* varpv might be clobbered by load_module,
1271 so save it. For the moment it's always
1273 const char type = varname == '[' ? '$' : '%';
1278 PUSHSTACKi(PERLSI_MAGIC);
1279 Perl_load_module(aTHX_ PERL_LOADMOD_NOIMPORT, module, NULL);
1283 stash = gv_stashsv(namesv, 0);
1285 Perl_croak(aTHX_ "panic: Can't use %c%c because %"SVf" is not available",
1286 type, varname, SVfARG(namesv));
1287 else if (!gv_fetchmethod(stash, methpv))
1288 Perl_croak(aTHX_ "panic: Can't use %c%c because %"SVf" does not support method %s",
1289 type, varname, SVfARG(namesv), methpv);
1291 SvREFCNT_dec(namesv);
1296 =for apidoc gv_stashpv
1298 Returns a pointer to the stash for a specified package. Uses C<strlen> to
1299 determine the length of C<name>, then calls C<gv_stashpvn()>.
1305 Perl_gv_stashpv(pTHX_ const char *name, I32 create)
1307 PERL_ARGS_ASSERT_GV_STASHPV;
1308 return gv_stashpvn(name, strlen(name), create);
1312 =for apidoc gv_stashpvn
1314 Returns a pointer to the stash for a specified package. The C<namelen>
1315 parameter indicates the length of the C<name>, in bytes. C<flags> is passed
1316 to C<gv_fetchpvn_flags()>, so if set to C<GV_ADD> then the package will be
1317 created if it does not already exist. If the package does not exist and
1318 C<flags> is 0 (or any other setting that does not create packages) then NULL
1326 Perl_gv_stashpvn(pTHX_ const char *name, U32 namelen, I32 flags)
1332 U32 tmplen = namelen + 2;
1334 PERL_ARGS_ASSERT_GV_STASHPVN;
1336 if (tmplen <= sizeof smallbuf)
1339 Newx(tmpbuf, tmplen, char);
1340 Copy(name, tmpbuf, namelen, char);
1341 tmpbuf[namelen] = ':';
1342 tmpbuf[namelen+1] = ':';
1343 tmpgv = gv_fetchpvn_flags(tmpbuf, tmplen, flags, SVt_PVHV);
1344 if (tmpbuf != smallbuf)
1348 stash = GvHV(tmpgv);
1349 if (!(flags & ~GV_NOADD_MASK) && !stash) return NULL;
1351 if (!HvNAME_get(stash)) {
1352 hv_name_set(stash, name, namelen, flags & SVf_UTF8 ? SVf_UTF8 : 0 );
1354 /* FIXME: This is a repeat of logic in gv_fetchpvn_flags */
1355 /* If the containing stash has multiple effective
1356 names, see that this one gets them, too. */
1357 if (HvAUX(GvSTASH(tmpgv))->xhv_name_count)
1358 mro_package_moved(stash, NULL, tmpgv, 1);
1364 =for apidoc gv_stashsv
1366 Returns a pointer to the stash for a specified package. See C<gv_stashpvn>.
1372 Perl_gv_stashsv(pTHX_ SV *sv, I32 flags)
1375 const char * const ptr = SvPV_const(sv,len);
1377 PERL_ARGS_ASSERT_GV_STASHSV;
1379 return gv_stashpvn(ptr, len, flags | SvUTF8(sv));
1384 Perl_gv_fetchpv(pTHX_ const char *nambeg, I32 add, const svtype sv_type) {
1385 PERL_ARGS_ASSERT_GV_FETCHPV;
1386 return gv_fetchpvn_flags(nambeg, strlen(nambeg), add, sv_type);
1390 Perl_gv_fetchsv(pTHX_ SV *name, I32 flags, const svtype sv_type) {
1392 const char * const nambeg =
1393 SvPV_flags_const(name, len, flags & GV_NO_SVGMAGIC ? 0 : SV_GMAGIC);
1394 PERL_ARGS_ASSERT_GV_FETCHSV;
1395 return gv_fetchpvn_flags(nambeg, len, flags | SvUTF8(name), sv_type);
1399 S_gv_magicalize_isa(pTHX_ GV *gv)
1403 PERL_ARGS_ASSERT_GV_MAGICALIZE_ISA;
1407 sv_magic(MUTABLE_SV(av), MUTABLE_SV(gv), PERL_MAGIC_isa,
1412 S_gv_magicalize_overload(pTHX_ GV *gv)
1416 PERL_ARGS_ASSERT_GV_MAGICALIZE_OVERLOAD;
1420 hv_magic(hv, NULL, PERL_MAGIC_overload);
1424 Perl_gv_fetchpvn_flags(pTHX_ const char *nambeg, STRLEN full_len, I32 flags,
1425 const svtype sv_type)
1428 register const char *name = nambeg;
1429 register GV *gv = NULL;
1432 register const char *name_cursor;
1434 const I32 no_init = flags & (GV_NOADD_NOINIT | GV_NOINIT);
1435 const I32 no_expand = flags & GV_NOEXPAND;
1436 const I32 add = flags & ~GV_NOADD_MASK;
1437 const U32 is_utf8 = flags & SVf_UTF8;
1438 bool addmg = !!(flags & GV_ADDMG);
1439 const char *const name_end = nambeg + full_len;
1440 const char *const name_em1 = name_end - 1;
1443 PERL_ARGS_ASSERT_GV_FETCHPVN_FLAGS;
1445 if (flags & GV_NOTQUAL) {
1446 /* Caller promised that there is no stash, so we can skip the check. */
1451 if (full_len > 2 && *name == '*' && isIDFIRST_lazy_if(name + 1, is_utf8)) {
1452 /* accidental stringify on a GV? */
1456 for (name_cursor = name; name_cursor < name_end; name_cursor++) {
1457 if (name_cursor < name_em1 &&
1458 ((*name_cursor == ':'
1459 && name_cursor[1] == ':')
1460 || *name_cursor == '\''))
1463 stash = PL_defstash;
1464 if (!stash || !SvREFCNT(stash)) /* symbol table under destruction */
1467 len = name_cursor - name;
1468 if (name_cursor > nambeg) { /* Skip for initial :: or ' */
1470 if (*name_cursor == ':') {
1475 Newx(tmpbuf, len+2, char);
1476 Copy(name, tmpbuf, len, char);
1477 tmpbuf[len++] = ':';
1478 tmpbuf[len++] = ':';
1481 gvp = (GV**)hv_fetch(stash, key, is_utf8 ? -len : len, add);
1482 gv = gvp ? *gvp : NULL;
1483 if (gv && gv != (const GV *)&PL_sv_undef) {
1484 if (SvTYPE(gv) != SVt_PVGV)
1485 gv_init_pvn(gv, stash, key, len, (add & GV_ADDMULTI)|is_utf8);
1491 if (!gv || gv == (const GV *)&PL_sv_undef)
1494 if (!(stash = GvHV(gv)))
1496 stash = GvHV(gv) = newHV();
1497 if (!HvNAME_get(stash)) {
1498 if (GvSTASH(gv) == PL_defstash && len == 6
1499 && strnEQ(name, "CORE", 4))
1500 hv_name_set(stash, "CORE", 4, 0);
1503 stash, nambeg, name_cursor-nambeg, is_utf8
1505 /* If the containing stash has multiple effective
1506 names, see that this one gets them, too. */
1507 if (HvAUX(GvSTASH(gv))->xhv_name_count)
1508 mro_package_moved(stash, NULL, gv, 1);
1511 else if (!HvNAME_get(stash))
1512 hv_name_set(stash, nambeg, name_cursor - nambeg, is_utf8);
1515 if (*name_cursor == ':')
1517 name = name_cursor+1;
1518 if (name == name_end)
1520 ? gv : MUTABLE_GV(*hv_fetchs(PL_defstash, "main::", TRUE));
1523 len = name_cursor - name;
1525 /* No stash in name, so see how we can default */
1529 if (len && isIDFIRST_lazy(name)) {
1530 bool global = FALSE;
1538 if ((name[0] == 'I' && name[1] == 'N' && name[2] == 'C')
1539 || (name[0] == 'E' && name[1] == 'N' && name[2] == 'V')
1540 || (name[0] == 'S' && name[1] == 'I' && name[2] == 'G'))
1544 if (name[0] == 'A' && name[1] == 'R' && name[2] == 'G'
1549 if (name[0] == 'S' && name[1] == 'T' && name[2] == 'D'
1550 && name[3] == 'I' && name[4] == 'N')
1554 if ((name[0] == 'S' && name[1] == 'T' && name[2] == 'D')
1555 &&((name[3] == 'O' && name[4] == 'U' && name[5] == 'T')
1556 ||(name[3] == 'E' && name[4] == 'R' && name[5] == 'R')))
1560 if (name[0] == 'A' && name[1] == 'R' && name[2] == 'G'
1561 && name[3] == 'V' && name[4] == 'O' && name[5] == 'U'
1568 stash = PL_defstash;
1569 else if (IN_PERL_COMPILETIME) {
1570 stash = PL_curstash;
1571 if (add && (PL_hints & HINT_STRICT_VARS) &&
1572 sv_type != SVt_PVCV &&
1573 sv_type != SVt_PVGV &&
1574 sv_type != SVt_PVFM &&
1575 sv_type != SVt_PVIO &&
1576 !(len == 1 && sv_type == SVt_PV &&
1577 (*name == 'a' || *name == 'b')) )
1579 gvp = (GV**)hv_fetch(stash,name,is_utf8 ? -len : len,0);
1581 *gvp == (const GV *)&PL_sv_undef ||
1582 SvTYPE(*gvp) != SVt_PVGV)
1586 else if ((sv_type == SVt_PV && !GvIMPORTED_SV(*gvp)) ||
1587 (sv_type == SVt_PVAV && !GvIMPORTED_AV(*gvp)) ||
1588 (sv_type == SVt_PVHV && !GvIMPORTED_HV(*gvp)) )
1590 SV* namesv = newSVpvn_flags(name, len, SVs_TEMP | is_utf8);
1591 /* diag_listed_as: Variable "%s" is not imported%s */
1593 aTHX_ packWARN(WARN_MISC),
1594 "Variable \"%c%"SVf"\" is not imported",
1595 sv_type == SVt_PVAV ? '@' :
1596 sv_type == SVt_PVHV ? '%' : '$',
1600 aTHX_ packWARN(WARN_MISC),
1601 "\t(Did you mean &%"SVf" instead?)\n", SVfARG(namesv)
1608 stash = CopSTASH(PL_curcop);
1611 stash = PL_defstash;
1614 /* By this point we should have a stash and a name */
1618 SV * const err = Perl_mess(aTHX_
1619 "Global symbol \"%s%"SVf"\" requires explicit package name",
1620 (sv_type == SVt_PV ? "$"
1621 : sv_type == SVt_PVAV ? "@"
1622 : sv_type == SVt_PVHV ? "%"
1623 : ""), SVfARG(newSVpvn_flags(name, len, SVs_TEMP | is_utf8)));
1625 if (USE_UTF8_IN_NAMES)
1628 gv = gv_fetchpvs("<none>::", GV_ADDMULTI, SVt_PVHV);
1630 /* symbol table under destruction */
1639 if (!SvREFCNT(stash)) /* symbol table under destruction */
1642 gvp = (GV**)hv_fetch(stash,name,is_utf8 ? -len : len,add);
1643 if (!gvp || *gvp == (const GV *)&PL_sv_undef) {
1644 if (addmg) gv = (GV *)newSV(0);
1647 else gv = *gvp, addmg = 0;
1648 /* From this point on, addmg means gv has not been inserted in the
1651 if (SvTYPE(gv) == SVt_PVGV) {
1654 gv_init_svtype(gv, sv_type);
1655 if (len == 1 && stash == PL_defstash) {
1656 if (sv_type == SVt_PVHV || sv_type == SVt_PVGV) {
1658 require_tie_mod(gv, "!", newSVpvs("Errno"), "TIEHASH", 1);
1659 else if (*name == '-' || *name == '+')
1660 require_tie_mod(gv, name, newSVpvs("Tie::Hash::NamedCapture"), "TIEHASH", 0);
1662 if ((sv_type==SVt_PV || sv_type==SVt_PVGV) && *name == '[')
1663 require_tie_mod(gv,name,newSVpvs("arybase"),"FETCH",0);
1665 else if (len == 3 && sv_type == SVt_PVAV
1666 && strnEQ(name, "ISA", 3)
1667 && (!GvAV(gv) || !SvSMAGICAL(GvAV(gv))))
1668 gv_magicalize_isa(gv);
1671 } else if (no_init) {
1674 } else if (no_expand && SvROK(gv)) {
1679 /* Adding a new symbol.
1680 Unless of course there was already something non-GV here, in which case
1681 we want to behave as if there was always a GV here, containing some sort
1683 Otherwise we run the risk of creating things like GvIO, which can cause
1684 subtle bugs. eg the one that tripped up SQL::Translator */
1686 faking_it = SvOK(gv);
1688 if (add & GV_ADDWARN)
1689 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL), "Had to create %"SVf" unexpectedly",
1690 SVfARG(newSVpvn_flags(nambeg, name_end-nambeg, SVs_TEMP | is_utf8 )));
1691 gv_init_pvn(gv, stash, name, len, (add & GV_ADDMULTI)|is_utf8);
1693 if ( isIDFIRST_lazy_if(name, is_utf8)
1694 && ! (isLEXWARN_on ? ckWARN(WARN_ONCE) : (PL_dowarn & G_WARN_ON ) ) )
1697 /* set up magic where warranted */
1698 if (stash != PL_defstash) { /* not the main stash */
1699 /* We only have to check for four names here: EXPORT, ISA, OVERLOAD
1700 and VERSION. All the others apply only to the main stash or to
1701 CORE (which is checked right after this). */
1703 const char * const name2 = name + 1;
1706 if (strnEQ(name2, "XPORT", 5))
1710 if (strEQ(name2, "SA"))
1711 gv_magicalize_isa(gv);
1714 if (strEQ(name2, "VERLOAD"))
1715 gv_magicalize_overload(gv);
1718 if (strEQ(name2, "ERSION"))
1724 goto add_magical_gv;
1727 if (len > 1 /* shortest is uc */ && HvNAMELEN_get(stash) == 4) {
1728 /* Avoid null warning: */
1729 const char * const stashname = HvNAME(stash); assert(stashname);
1730 if (strnEQ(stashname, "CORE", 4)
1731 && S_maybe_add_coresub(aTHX_
1732 addmg ? stash : 0, gv, name, len, nambeg, full_len
1741 /* Nothing else to do.
1742 The compiler will probably turn the switch statement into a
1743 branch table. Make sure we avoid even that small overhead for
1744 the common case of lower case variable names. */
1748 const char * const name2 = name + 1;
1751 if (strEQ(name2, "RGV")) {
1752 IoFLAGS(GvIOn(gv)) |= IOf_ARGV|IOf_START;
1754 else if (strEQ(name2, "RGVOUT")) {
1759 if (strnEQ(name2, "XPORT", 5))
1763 if (strEQ(name2, "SA")) {
1764 gv_magicalize_isa(gv);
1768 if (strEQ(name2, "VERLOAD")) {
1769 gv_magicalize_overload(gv);
1773 if (strEQ(name2, "IG")) {
1776 if (!PL_psig_name) {
1777 Newxz(PL_psig_name, 2 * SIG_SIZE, SV*);
1778 Newxz(PL_psig_pend, SIG_SIZE, int);
1779 PL_psig_ptr = PL_psig_name + SIG_SIZE;
1781 /* I think that the only way to get here is to re-use an
1782 embedded perl interpreter, where the previous
1783 use didn't clean up fully because
1784 PL_perl_destruct_level was 0. I'm not sure that we
1785 "support" that, in that I suspect in that scenario
1786 there are sufficient other garbage values left in the
1787 interpreter structure that something else will crash
1788 before we get here. I suspect that this is one of
1789 those "doctor, it hurts when I do this" bugs. */
1790 Zero(PL_psig_name, 2 * SIG_SIZE, SV*);
1791 Zero(PL_psig_pend, SIG_SIZE, int);
1795 hv_magic(hv, NULL, PERL_MAGIC_sig);
1796 for (i = 1; i < SIG_SIZE; i++) {
1797 SV * const * const init = hv_fetch(hv, PL_sig_name[i], strlen(PL_sig_name[i]), 1);
1799 sv_setsv(*init, &PL_sv_undef);
1804 if (strEQ(name2, "ERSION"))
1807 case '\003': /* $^CHILD_ERROR_NATIVE */
1808 if (strEQ(name2, "HILD_ERROR_NATIVE"))
1811 case '\005': /* $^ENCODING */
1812 if (strEQ(name2, "NCODING"))
1815 case '\007': /* $^GLOBAL_PHASE */
1816 if (strEQ(name2, "LOBAL_PHASE"))
1819 case '\015': /* $^MATCH */
1820 if (strEQ(name2, "ATCH"))
1822 case '\017': /* $^OPEN */
1823 if (strEQ(name2, "PEN"))
1826 case '\020': /* $^PREMATCH $^POSTMATCH */
1827 if (strEQ(name2, "REMATCH") || strEQ(name2, "OSTMATCH"))
1830 case '\024': /* ${^TAINT} */
1831 if (strEQ(name2, "AINT"))
1834 case '\025': /* ${^UNICODE}, ${^UTF8LOCALE} */
1835 if (strEQ(name2, "NICODE"))
1837 if (strEQ(name2, "TF8LOCALE"))
1839 if (strEQ(name2, "TF8CACHE"))
1842 case '\027': /* $^WARNING_BITS */
1843 if (strEQ(name2, "ARNING_BITS"))
1856 /* Ensures that we have an all-digit variable, ${"1foo"} fails
1858 /* This snippet is taken from is_gv_magical */
1859 const char *end = name + len;
1860 while (--end > name) {
1861 if (!isDIGIT(*end)) goto add_magical_gv;
1868 /* Names of length 1. (Or 0. But name is NUL terminated, so that will
1869 be case '\0' in this switch statement (ie a default case) */
1875 sv_type == SVt_PVAV ||
1876 sv_type == SVt_PVHV ||
1877 sv_type == SVt_PVCV ||
1878 sv_type == SVt_PVFM ||
1881 PL_sawampersand = TRUE;
1885 sv_setpv(GvSVn(gv),PL_chopset);
1889 #ifdef COMPLEX_STATUS
1890 SvUPGRADE(GvSVn(gv), SVt_PVLV);
1896 /* If %! has been used, automatically load Errno.pm. */
1898 sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
1900 /* magicalization must be done before require_tie_mod is called */
1901 if (sv_type == SVt_PVHV || sv_type == SVt_PVGV)
1902 require_tie_mod(gv, "!", newSVpvs("Errno"), "TIEHASH", 1);
1907 GvMULTI_on(gv); /* no used once warnings here */
1909 AV* const av = GvAVn(gv);
1910 SV* const avc = (*name == '+') ? MUTABLE_SV(av) : NULL;
1912 sv_magic(MUTABLE_SV(av), avc, PERL_MAGIC_regdata, NULL, 0);
1913 sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
1915 SvREADONLY_on(GvSVn(gv));
1918 if (sv_type == SVt_PVHV || sv_type == SVt_PVGV)
1919 require_tie_mod(gv, name, newSVpvs("Tie::Hash::NamedCapture"), "TIEHASH", 0);
1925 if (sv_type == SVt_PV)
1926 Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_SYNTAX),
1927 "$%c is no longer supported", *name);
1930 sv_setiv(GvSVn(gv), (IV)(IoFLAGS(GvIOp(PL_defoutgv)) & IOf_FLUSH) != 0);
1933 case '\010': /* $^H */
1935 HV *const hv = GvHVn(gv);
1936 hv_magic(hv, NULL, PERL_MAGIC_hints);
1940 if (sv_type == SVt_PV || sv_type == SVt_PVGV) {
1941 if (addmg) (void)hv_store(stash,name,len,(SV *)gv,0);
1942 require_tie_mod(gv,name,newSVpvs("arybase"),"FETCH",0);
1946 case '\023': /* $^S */
1948 SvREADONLY_on(GvSVn(gv));
1972 case '\001': /* $^A */
1973 case '\003': /* $^C */
1974 case '\004': /* $^D */
1975 case '\005': /* $^E */
1976 case '\006': /* $^F */
1977 case '\011': /* $^I, NOT \t in EBCDIC */
1978 case '\016': /* $^N */
1979 case '\017': /* $^O */
1980 case '\020': /* $^P */
1981 case '\024': /* $^T */
1982 case '\027': /* $^W */
1984 sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
1987 case '\014': /* $^L */
1988 sv_setpvs(GvSVn(gv),"\f");
1989 PL_formfeed = GvSVn(gv);
1992 sv_setpvs(GvSVn(gv),"\034");
1996 SV * const sv = GvSV(gv);
1997 if (!sv_derived_from(PL_patchlevel, "version"))
1998 upg_version(PL_patchlevel, TRUE);
1999 GvSV(gv) = vnumify(PL_patchlevel);
2000 SvREADONLY_on(GvSV(gv));
2004 case '\026': /* $^V */
2006 SV * const sv = GvSV(gv);
2007 GvSV(gv) = new_version(PL_patchlevel);
2008 SvREADONLY_on(GvSV(gv));
2016 if (GvAV(gv) || GvHV(gv) || GvIO(gv) || GvCV(gv) || (
2017 GvSV(gv) && (SvOK(GvSV(gv)) || SvMAGICAL(GvSV(gv)))
2019 (void)hv_store(stash,name,len,(SV *)gv,0);
2020 else SvREFCNT_dec(gv), gv = NULL;
2022 if (gv) gv_init_svtype(gv, faking_it ? SVt_PVCV : sv_type);
2027 Perl_gv_fullname4(pTHX_ SV *sv, const GV *gv, const char *prefix, bool keepmain)
2030 const HV * const hv = GvSTASH(gv);
2032 PERL_ARGS_ASSERT_GV_FULLNAME4;
2034 sv_setpv(sv, prefix ? prefix : "");
2036 if (hv && (name = HvNAME(hv))) {
2037 const STRLEN len = HvNAMELEN(hv);
2038 if (keepmain || strnNE(name, "main", len)) {
2039 sv_catpvn_flags(sv,name,len,HvNAMEUTF8(hv)?SV_CATUTF8:SV_CATBYTES);
2043 else sv_catpvs(sv,"__ANON__::");
2044 sv_catsv(sv,sv_2mortal(newSVhek(GvNAME_HEK(gv))));
2048 Perl_gv_efullname4(pTHX_ SV *sv, const GV *gv, const char *prefix, bool keepmain)
2050 const GV * const egv = GvEGVx(gv);
2052 PERL_ARGS_ASSERT_GV_EFULLNAME4;
2054 gv_fullname4(sv, egv ? egv : gv, prefix, keepmain);
2058 Perl_gv_check(pTHX_ const HV *stash)
2063 PERL_ARGS_ASSERT_GV_CHECK;
2065 if (!HvARRAY(stash))
2067 for (i = 0; i <= (I32) HvMAX(stash); i++) {
2069 for (entry = HvARRAY(stash)[i]; entry; entry = HeNEXT(entry)) {
2072 if (HeKEY(entry)[HeKLEN(entry)-1] == ':' &&
2073 (gv = MUTABLE_GV(HeVAL(entry))) && isGV(gv) && (hv = GvHV(gv)))
2075 if (hv != PL_defstash && hv != stash)
2076 gv_check(hv); /* nested package */
2078 else if ( *HeKEY(entry) != '_'
2079 && isIDFIRST_lazy_if(HeKEY(entry), HeUTF8(entry)) ) {
2081 gv = MUTABLE_GV(HeVAL(entry));
2082 if (SvTYPE(gv) != SVt_PVGV || GvMULTI(gv))
2085 CopLINE_set(PL_curcop, GvLINE(gv));
2087 CopFILE(PL_curcop) = (char *)file; /* set for warning */
2089 CopFILEGV(PL_curcop)
2090 = gv_fetchfile_flags(file, HEK_LEN(GvFILE_HEK(gv)), 0);
2092 Perl_warner(aTHX_ packWARN(WARN_ONCE),
2093 "Name \"%"HEKf"::%"HEKf
2094 "\" used only once: possible typo",
2095 HEKfARG(HvNAME_HEK(stash)),
2096 HEKfARG(GvNAME_HEK(gv)));
2103 Perl_newGVgen_flags(pTHX_ const char *pack, U32 flags)
2106 PERL_ARGS_ASSERT_NEWGVGEN_FLAGS;
2108 return gv_fetchpv(Perl_form(aTHX_ "%"SVf"::_GEN_%ld",
2109 SVfARG(newSVpvn_flags(pack, strlen(pack),
2115 /* hopefully this is only called on local symbol table entries */
2118 Perl_gp_ref(pTHX_ GP *gp)
2126 /* If the GP they asked for a reference to contains
2127 a method cache entry, clear it first, so that we
2128 don't infect them with our cached entry */
2129 SvREFCNT_dec(gp->gp_cv);
2138 Perl_gp_free(pTHX_ GV *gv)
2144 if (!gv || !isGV_with_GP(gv) || !(gp = GvGP(gv)))
2146 if (gp->gp_refcnt == 0) {
2147 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
2148 "Attempt to free unreferenced glob pointers"
2149 pTHX__FORMAT pTHX__VALUE);
2152 if (--gp->gp_refcnt > 0) {
2153 if (gp->gp_egv == gv)
2160 /* Copy and null out all the glob slots, so destructors do not see
2162 HEK * const file_hek = gp->gp_file_hek;
2163 SV * const sv = gp->gp_sv;
2164 AV * const av = gp->gp_av;
2165 HV * const hv = gp->gp_hv;
2166 IO * const io = gp->gp_io;
2167 CV * const cv = gp->gp_cv;
2168 CV * const form = gp->gp_form;
2170 gp->gp_file_hek = NULL;
2179 unshare_hek(file_hek);
2183 /* FIXME - another reference loop GV -> symtab -> GV ?
2184 Somehow gp->gp_hv can end up pointing at freed garbage. */
2185 if (hv && SvTYPE(hv) == SVt_PVHV) {
2186 const HEK *hvname_hek = HvNAME_HEK(hv);
2187 if (PL_stashcache && hvname_hek)
2188 (void)hv_delete(PL_stashcache, HEK_KEY(hvname_hek),
2189 (HEK_UTF8(hvname_hek) ? -HEK_LEN(hvname_hek) : HEK_LEN(hvname_hek)),
2197 if (!gp->gp_file_hek
2203 && !gp->gp_form) break;
2205 if (--attempts == 0) {
2207 "panic: gp_free failed to free glob pointer - "
2208 "something is repeatedly re-creating entries"
2218 Perl_magic_freeovrld(pTHX_ SV *sv, MAGIC *mg)
2220 AMT * const amtp = (AMT*)mg->mg_ptr;
2221 PERL_UNUSED_ARG(sv);
2223 PERL_ARGS_ASSERT_MAGIC_FREEOVRLD;
2225 if (amtp && AMT_AMAGIC(amtp)) {
2227 for (i = 1; i < NofAMmeth; i++) {
2228 CV * const cv = amtp->table[i];
2230 SvREFCNT_dec(MUTABLE_SV(cv));
2231 amtp->table[i] = NULL;
2238 /* Updates and caches the CV's */
2240 * 1 on success and there is some overload
2241 * 0 if there is no overload
2242 * -1 if some error occurred and it couldn't croak
2246 Perl_Gv_AMupdate(pTHX_ HV *stash, bool destructing)
2249 MAGIC* const mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
2251 const struct mro_meta* stash_meta = HvMROMETA(stash);
2254 PERL_ARGS_ASSERT_GV_AMUPDATE;
2256 newgen = PL_sub_generation + stash_meta->pkg_gen + stash_meta->cache_gen;
2258 const AMT * const amtp = (AMT*)mg->mg_ptr;
2259 if (amtp->was_ok_am == PL_amagic_generation
2260 && amtp->was_ok_sub == newgen) {
2261 return AMT_OVERLOADED(amtp) ? 1 : 0;
2263 sv_unmagic(MUTABLE_SV(stash), PERL_MAGIC_overload_table);
2266 DEBUG_o( Perl_deb(aTHX_ "Recalcing overload magic in package %s\n",HvNAME_get(stash)) );
2269 amt.was_ok_am = PL_amagic_generation;
2270 amt.was_ok_sub = newgen;
2271 amt.fallback = AMGfallNO;
2275 int filled = 0, have_ovl = 0;
2278 /* Work with "fallback" key, which we assume to be first in PL_AMG_names */
2280 /* Try to find via inheritance. */
2281 GV *gv = gv_fetchmeth_pvn(stash, PL_AMG_names[0], 2, -1, 0);
2282 SV * const sv = gv ? GvSV(gv) : NULL;
2286 lim = DESTROY_amg; /* Skip overloading entries. */
2287 #ifdef PERL_DONT_CREATE_GVSV
2289 NOOP; /* Equivalent to !SvTRUE and !SvOK */
2292 else if (SvTRUE(sv))
2293 amt.fallback=AMGfallYES;
2295 amt.fallback=AMGfallNEVER;
2297 for (i = 1; i < lim; i++)
2298 amt.table[i] = NULL;
2299 for (; i < NofAMmeth; i++) {
2300 const char * const cooky = PL_AMG_names[i];
2301 /* Human-readable form, for debugging: */
2302 const char * const cp = (i >= DESTROY_amg ? cooky : AMG_id2name(i));
2303 const STRLEN l = PL_AMG_namelens[i];
2305 DEBUG_o( Perl_deb(aTHX_ "Checking overloading of \"%s\" in package \"%.256s\"\n",
2306 cp, HvNAME_get(stash)) );
2307 /* don't fill the cache while looking up!
2308 Creation of inheritance stubs in intermediate packages may
2309 conflict with the logic of runtime method substitution.
2310 Indeed, for inheritance A -> B -> C, if C overloads "+0",
2311 then we could have created stubs for "(+0" in A and C too.
2312 But if B overloads "bool", we may want to use it for
2313 numifying instead of C's "+0". */
2314 if (i >= DESTROY_amg)
2315 gv = Perl_gv_fetchmeth_pvn_autoload(aTHX_ stash, cooky, l, 0, 0);
2316 else /* Autoload taken care of below */
2317 gv = Perl_gv_fetchmeth_pvn(aTHX_ stash, cooky, l, -1, 0);
2319 if (gv && (cv = GvCV(gv))) {
2320 if(GvNAMELEN(CvGV(cv)) == 3 && strEQ(GvNAME(CvGV(cv)), "nil")){
2321 const char * const hvname = HvNAME_get(GvSTASH(CvGV(cv)));
2322 if (hvname && HEK_LEN(HvNAME_HEK(GvSTASH(CvGV(cv)))) == 8
2323 && strEQ(hvname, "overload")) {
2324 /* This is a hack to support autoloading..., while
2325 knowing *which* methods were declared as overloaded. */
2326 /* GvSV contains the name of the method. */
2328 SV *gvsv = GvSV(gv);
2330 DEBUG_o( Perl_deb(aTHX_ "Resolving method \"%"SVf256\
2331 "\" for overloaded \"%s\" in package \"%.256s\"\n",
2332 (void*)GvSV(gv), cp, HvNAME(stash)) );
2333 if (!gvsv || !SvPOK(gvsv)
2334 || !(ngv = gv_fetchmethod_sv_flags(stash, gvsv, 0)))
2336 /* Can be an import stub (created by "can"). */
2341 const SV * const name = (gvsv && SvPOK(gvsv))
2343 : newSVpvs_flags("???", SVs_TEMP);
2344 Perl_croak(aTHX_ "%s method \"%"SVf256
2345 "\" overloading \"%s\" "\
2346 "in package \"%"HEKf256"\"",
2347 (GvCVGEN(gv) ? "Stub found while resolving"
2355 cv = GvCV(gv = ngv);
2358 DEBUG_o( Perl_deb(aTHX_ "Overloading \"%s\" in package \"%.256s\" via \"%.256s::%.256s\"\n",
2359 cp, HvNAME_get(stash), HvNAME_get(GvSTASH(CvGV(cv))),
2360 GvNAME(CvGV(cv))) );
2362 if (i < DESTROY_amg)
2364 } else if (gv) { /* Autoloaded... */
2365 cv = MUTABLE_CV(gv);
2368 amt.table[i]=MUTABLE_CV(SvREFCNT_inc_simple(cv));
2371 AMT_AMAGIC_on(&amt);
2373 AMT_OVERLOADED_on(&amt);
2374 sv_magic(MUTABLE_SV(stash), 0, PERL_MAGIC_overload_table,
2375 (char*)&amt, sizeof(AMT));
2379 /* Here we have no table: */
2381 AMT_AMAGIC_off(&amt);
2382 sv_magic(MUTABLE_SV(stash), 0, PERL_MAGIC_overload_table,
2383 (char*)&amt, sizeof(AMTS));
2389 Perl_gv_handler(pTHX_ HV *stash, I32 id)
2395 struct mro_meta* stash_meta;
2397 if (!stash || !HvNAME_get(stash))
2400 stash_meta = HvMROMETA(stash);
2401 newgen = PL_sub_generation + stash_meta->pkg_gen + stash_meta->cache_gen;
2403 mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
2406 /* If we're looking up a destructor to invoke, we must avoid
2407 * that Gv_AMupdate croaks, because we might be dying already */
2408 if (Gv_AMupdate(stash, cBOOL(id == DESTROY_amg)) == -1) {
2409 /* and if it didn't found a destructor, we fall back
2410 * to a simpler method that will only look for the
2411 * destructor instead of the whole magic */
2412 if (id == DESTROY_amg) {
2413 GV * const gv = gv_fetchmethod(stash, "DESTROY");
2419 mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
2422 amtp = (AMT*)mg->mg_ptr;
2423 if ( amtp->was_ok_am != PL_amagic_generation
2424 || amtp->was_ok_sub != newgen )
2426 if (AMT_AMAGIC(amtp)) {
2427 CV * const ret = amtp->table[id];
2428 if (ret && isGV(ret)) { /* Autoloading stab */
2429 /* Passing it through may have resulted in a warning
2430 "Inherited AUTOLOAD for a non-method deprecated", since
2431 our caller is going through a function call, not a method call.
2432 So return the CV for AUTOLOAD, setting $AUTOLOAD. */
2433 GV * const gv = gv_fetchmethod(stash, PL_AMG_names[id]);
2445 /* Implement tryAMAGICun_MG macro.
2446 Do get magic, then see if the stack arg is overloaded and if so call it.
2448 AMGf_set return the arg using SETs rather than assigning to
2450 AMGf_numeric apply sv_2num to the stack arg.
2454 Perl_try_amagic_un(pTHX_ int method, int flags) {
2458 SV* const arg = TOPs;
2462 if (SvAMAGIC(arg) && (tmpsv = amagic_call(arg, &PL_sv_undef, method,
2463 AMGf_noright | AMGf_unary))) {
2464 if (flags & AMGf_set) {
2469 if (SvPADMY(TARG)) {
2470 sv_setsv(TARG, tmpsv);
2480 if ((flags & AMGf_numeric) && SvROK(arg))
2486 /* Implement tryAMAGICbin_MG macro.
2487 Do get magic, then see if the two stack args are overloaded and if so
2490 AMGf_set return the arg using SETs rather than assigning to
2492 AMGf_assign op may be called as mutator (eg +=)
2493 AMGf_numeric apply sv_2num to the stack arg.
2497 Perl_try_amagic_bin(pTHX_ int method, int flags) {
2500 SV* const left = TOPm1s;
2501 SV* const right = TOPs;
2507 if (SvAMAGIC(left) || SvAMAGIC(right)) {
2508 SV * const tmpsv = amagic_call(left, right, method,
2509 ((flags & AMGf_assign) && opASSIGN ? AMGf_assign: 0));
2511 if (flags & AMGf_set) {
2518 if (opASSIGN || SvPADMY(TARG)) {
2519 sv_setsv(TARG, tmpsv);
2529 if(left==right && SvGMAGICAL(left)) {
2530 SV * const left = sv_newmortal();
2532 /* Print the uninitialized warning now, so it includes the vari-
2535 if (ckWARN(WARN_UNINITIALIZED)) report_uninit(right);
2536 sv_setsv_flags(left, &PL_sv_no, 0);
2538 else sv_setsv_flags(left, right, 0);
2541 if (flags & AMGf_numeric) {
2543 *(sp-1) = sv_2num(TOPm1s);
2545 *sp = sv_2num(right);
2551 Perl_amagic_deref_call(pTHX_ SV *ref, int method) {
2554 PERL_ARGS_ASSERT_AMAGIC_DEREF_CALL;
2556 while (SvAMAGIC(ref) &&
2557 (tmpsv = amagic_call(ref, &PL_sv_undef, method,
2558 AMGf_noright | AMGf_unary))) {
2560 Perl_croak(aTHX_ "Overloaded dereference did not return a reference");
2561 if (tmpsv == ref || SvRV(tmpsv) == SvRV(ref)) {
2562 /* Bail out if it returns us the same reference. */
2567 return tmpsv ? tmpsv : ref;
2571 Perl_amagic_call(pTHX_ SV *left, SV *right, int method, int flags)
2576 CV **cvp=NULL, **ocvp=NULL;
2577 AMT *amtp=NULL, *oamtp=NULL;
2578 int off = 0, off1, lr = 0, notfound = 0;
2579 int postpr = 0, force_cpy = 0;
2580 int assign = AMGf_assign & flags;
2581 const int assignshift = assign ? 1 : 0;
2582 int use_default_op = 0;
2588 PERL_ARGS_ASSERT_AMAGIC_CALL;
2590 if ( PL_curcop->cop_hints & HINT_NO_AMAGIC ) {
2591 SV *lex_mask = cop_hints_fetch_pvs(PL_curcop, "overloading", 0);
2593 if ( !lex_mask || !SvOK(lex_mask) )
2594 /* overloading lexically disabled */
2596 else if ( lex_mask && SvPOK(lex_mask) ) {
2597 /* we have an entry in the hints hash, check if method has been
2598 * masked by overloading.pm */
2600 const int offset = method / 8;
2601 const int bit = method % 8;
2602 char *pv = SvPV(lex_mask, len);
2604 /* Bit set, so this overloading operator is disabled */
2605 if ( (STRLEN)offset < len && pv[offset] & ( 1 << bit ) )
2610 if (!(AMGf_noleft & flags) && SvAMAGIC(left)
2611 && (stash = SvSTASH(SvRV(left)))
2612 && (mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table))
2613 && (ocvp = cvp = (AMT_AMAGIC((AMT*)mg->mg_ptr)
2614 ? (oamtp = amtp = (AMT*)mg->mg_ptr)->table
2616 && ((cv = cvp[off=method+assignshift])
2617 || (assign && amtp->fallback > AMGfallNEVER && /* fallback to
2623 cv = cvp[off=method])))) {
2624 lr = -1; /* Call method for left argument */
2626 if (cvp && amtp->fallback > AMGfallNEVER && flags & AMGf_unary) {
2629 /* look for substituted methods */
2630 /* In all the covered cases we should be called with assign==0. */
2634 if ((cv = cvp[off=add_ass_amg])
2635 || ((cv = cvp[off = add_amg]) && (force_cpy = 0, postpr = 1))) {
2636 right = &PL_sv_yes; lr = -1; assign = 1;
2641 if ((cv = cvp[off = subtr_ass_amg])
2642 || ((cv = cvp[off = subtr_amg]) && (force_cpy = 0, postpr=1))) {
2643 right = &PL_sv_yes; lr = -1; assign = 1;
2647 (void)((cv = cvp[off=numer_amg]) || (cv = cvp[off=string_amg]));
2650 (void)((cv = cvp[off=string_amg]) || (cv = cvp[off=bool__amg]));
2653 (void)((cv = cvp[off=numer_amg]) || (cv = cvp[off=bool__amg]));
2656 (void)((cv = cvp[off=bool__amg])
2657 || (cv = cvp[off=numer_amg])
2658 || (cv = cvp[off=string_amg]));
2665 * SV* ref causes confusion with the interpreter variable of
2668 SV* const tmpRef=SvRV(left);
2669 if (!SvROK(tmpRef) && SvTYPE(tmpRef) <= SVt_PVMG) {
2671 * Just to be extra cautious. Maybe in some
2672 * additional cases sv_setsv is safe, too.
2674 SV* const newref = newSVsv(tmpRef);
2675 SvOBJECT_on(newref);
2676 /* As a bit of a source compatibility hack, SvAMAGIC() and
2677 friends dereference an RV, to behave the same was as when
2678 overloading was stored on the reference, not the referant.
2679 Hence we can't use SvAMAGIC_on()
2681 SvFLAGS(newref) |= SVf_AMAGIC;
2682 SvSTASH_set(newref, MUTABLE_HV(SvREFCNT_inc(SvSTASH(tmpRef))));
2688 if ((cvp[off1=lt_amg] || cvp[off1=ncmp_amg])
2689 && ((cv = cvp[off=neg_amg]) || (cv = cvp[off=subtr_amg]))) {
2690 SV* const nullsv=sv_2mortal(newSViv(0));
2692 SV* const lessp = amagic_call(left,nullsv,
2693 lt_amg,AMGf_noright);
2694 logic = SvTRUE(lessp);
2696 SV* const lessp = amagic_call(left,nullsv,
2697 ncmp_amg,AMGf_noright);
2698 logic = (SvNV(lessp) < 0);
2701 if (off==subtr_amg) {
2712 if ((cv = cvp[off=subtr_amg])) {
2714 left = sv_2mortal(newSViv(0));
2719 case iter_amg: /* XXXX Eventually should do to_gv. */
2720 case ftest_amg: /* XXXX Eventually should do to_gv. */
2723 return NULL; /* Delegate operation to standard mechanisms. */
2731 return left; /* Delegate operation to standard mechanisms. */
2736 if (!cv) goto not_found;
2737 } else if (!(AMGf_noright & flags) && SvAMAGIC(right)
2738 && (stash = SvSTASH(SvRV(right)))
2739 && (mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table))
2740 && (cvp = (AMT_AMAGIC((AMT*)mg->mg_ptr)
2741 ? (amtp = (AMT*)mg->mg_ptr)->table
2743 && (cv = cvp[off=method])) { /* Method for right
2746 } else if (((cvp && amtp->fallback > AMGfallNEVER)
2747 || (ocvp && oamtp->fallback > AMGfallNEVER))
2748 && !(flags & AMGf_unary)) {
2749 /* We look for substitution for
2750 * comparison operations and
2752 if (method==concat_amg || method==concat_ass_amg
2753 || method==repeat_amg || method==repeat_ass_amg) {
2754 return NULL; /* Delegate operation to string conversion */
2776 if (ocvp && (oamtp->fallback > AMGfallNEVER)) {
2780 if (!cv && (cvp && amtp->fallback > AMGfallNEVER)) {
2790 not_found: /* No method found, either report or croak */
2798 return left; /* Delegate operation to standard mechanisms. */
2801 if (ocvp && (cv=ocvp[nomethod_amg])) { /* Call report method */
2802 notfound = 1; lr = -1;
2803 } else if (cvp && (cv=cvp[nomethod_amg])) {
2804 notfound = 1; lr = 1;
2805 } else if ((use_default_op =
2806 (!ocvp || oamtp->fallback >= AMGfallYES)
2807 && (!cvp || amtp->fallback >= AMGfallYES))
2809 /* Skip generating the "no method found" message. */
2813 if (off==-1) off=method;
2814 msg = sv_2mortal(Perl_newSVpvf(aTHX_
2815 "Operation \"%s\": no method found,%sargument %s%"SVf"%s%"SVf,
2816 AMG_id2name(method + assignshift),
2817 (flags & AMGf_unary ? " " : "\n\tleft "),
2819 "in overloaded package ":
2820 "has no overloaded magic",
2822 SVfARG(sv_2mortal(newSVhek(HvNAME_HEK(SvSTASH(SvRV(left)))))):
2825 ",\n\tright argument in overloaded package ":
2828 : ",\n\tright argument has no overloaded magic"),
2830 SVfARG(sv_2mortal(newSVhek(HvNAME_HEK(SvSTASH(SvRV(right)))))):
2831 SVfARG(&PL_sv_no)));
2832 if (use_default_op) {
2833 DEBUG_o( Perl_deb(aTHX_ "%"SVf, SVfARG(msg)) );
2835 Perl_croak(aTHX_ "%"SVf, SVfARG(msg));
2839 force_cpy = force_cpy || assign;
2844 DEBUG_o(Perl_deb(aTHX_
2845 "Overloaded operator \"%s\"%s%s%s:\n\tmethod%s found%s in package %"SVf"%s\n",
2847 method+assignshift==off? "" :
2849 method+assignshift==off? "" :
2850 AMG_id2name(method+assignshift),
2851 method+assignshift==off? "" : "\")",
2852 flags & AMGf_unary? "" :
2853 lr==1 ? " for right argument": " for left argument",
2854 flags & AMGf_unary? " for argument" : "",
2855 stash ? SVfARG(sv_2mortal(newSVhek(HvNAME_HEK(stash)))) : SVfARG(newSVpvs_flags("null", SVs_TEMP)),
2856 fl? ",\n\tassignment variant used": "") );
2859 /* Since we use shallow copy during assignment, we need
2860 * to dublicate the contents, probably calling user-supplied
2861 * version of copy operator
2863 /* We need to copy in following cases:
2864 * a) Assignment form was called.
2865 * assignshift==1, assign==T, method + 1 == off
2866 * b) Increment or decrement, called directly.
2867 * assignshift==0, assign==0, method + 0 == off
2868 * c) Increment or decrement, translated to assignment add/subtr.
2869 * assignshift==0, assign==T,
2871 * d) Increment or decrement, translated to nomethod.
2872 * assignshift==0, assign==0,
2874 * e) Assignment form translated to nomethod.
2875 * assignshift==1, assign==T, method + 1 != off
2878 /* off is method, method+assignshift, or a result of opcode substitution.
2879 * In the latter case assignshift==0, so only notfound case is important.
2881 if (( (method + assignshift == off)
2882 && (assign || (method == inc_amg) || (method == dec_amg)))
2885 /* newSVsv does not behave as advertised, so we copy missing
2886 * information by hand */
2887 SV *tmpRef = SvRV(left);
2889 if (SvREFCNT(tmpRef) > 1 && (rv_copy = AMG_CALLunary(left,copy_amg))) {
2890 SvRV_set(left, rv_copy);
2892 SvREFCNT_dec(tmpRef);
2900 const bool oldcatch = CATCH_GET;
2903 Zero(&myop, 1, BINOP);
2904 myop.op_last = (OP *) &myop;
2905 myop.op_next = NULL;
2906 myop.op_flags = OPf_WANT_SCALAR | OPf_STACKED;
2908 PUSHSTACKi(PERLSI_OVERLOAD);
2911 PL_op = (OP *) &myop;
2912 if (PERLDB_SUB && PL_curstash != PL_debstash)
2913 PL_op->op_private |= OPpENTERSUB_DB;
2915 Perl_pp_pushmark(aTHX);
2917 EXTEND(SP, notfound + 5);
2918 PUSHs(lr>0? right: left);
2919 PUSHs(lr>0? left: right);
2920 PUSHs( lr > 0 ? &PL_sv_yes : ( assign ? &PL_sv_undef : &PL_sv_no ));
2922 PUSHs(newSVpvn_flags(AMG_id2name(method + assignshift),
2923 AMG_id2namelen(method + assignshift), SVs_TEMP));
2925 PUSHs(MUTABLE_SV(cv));
2928 if ((PL_op = PL_ppaddr[OP_ENTERSUB](aTHX)))
2936 CATCH_SET(oldcatch);
2943 ans=SvIV(res)<=0; break;
2946 ans=SvIV(res)<0; break;
2949 ans=SvIV(res)>=0; break;
2952 ans=SvIV(res)>0; break;
2955 ans=SvIV(res)==0; break;
2958 ans=SvIV(res)!=0; break;
2961 SvSetSV(left,res); return left;
2963 ans=!SvTRUE(res); break;
2968 } else if (method==copy_amg) {
2970 Perl_croak(aTHX_ "Copy method did not return a reference");
2972 return SvREFCNT_inc(SvRV(res));
2980 Perl_gv_name_set(pTHX_ GV *gv, const char *name, U32 len, U32 flags)
2985 PERL_ARGS_ASSERT_GV_NAME_SET;
2988 Perl_croak(aTHX_ "panic: gv name too long (%"UVuf")", (UV) len);
2990 if (!(flags & GV_ADD) && GvNAME_HEK(gv)) {
2991 unshare_hek(GvNAME_HEK(gv));
2994 PERL_HASH(hash, name, len);
2995 GvNAME_HEK(gv) = share_hek(name, (flags & SVf_UTF8 ? -(I32)len : (I32)len), hash);
2999 =for apidoc gv_try_downgrade
3001 If the typeglob C<gv> can be expressed more succinctly, by having
3002 something other than a real GV in its place in the stash, replace it
3003 with the optimised form. Basic requirements for this are that C<gv>
3004 is a real typeglob, is sufficiently ordinary, and is only referenced
3005 from its package. This function is meant to be used when a GV has been
3006 looked up in part to see what was there, causing upgrading, but based
3007 on what was found it turns out that the real GV isn't required after all.
3009 If C<gv> is a completely empty typeglob, it is deleted from the stash.
3011 If C<gv> is a typeglob containing only a sufficiently-ordinary constant
3012 sub, the typeglob is replaced with a scalar-reference placeholder that
3013 more compactly represents the same thing.
3019 Perl_gv_try_downgrade(pTHX_ GV *gv)
3025 PERL_ARGS_ASSERT_GV_TRY_DOWNGRADE;
3027 /* XXX Why and where does this leave dangling pointers during global
3029 if (PL_phase == PERL_PHASE_DESTRUCT) return;
3031 if (!(SvREFCNT(gv) == 1 && SvTYPE(gv) == SVt_PVGV && !SvFAKE(gv) &&
3032 !SvOBJECT(gv) && !SvREADONLY(gv) &&
3033 isGV_with_GP(gv) && GvGP(gv) &&
3034 !GvINTRO(gv) && GvREFCNT(gv) == 1 &&
3035 !GvSV(gv) && !GvAV(gv) && !GvHV(gv) && !GvIOp(gv) && !GvFORM(gv) &&
3036 GvEGVx(gv) == gv && (stash = GvSTASH(gv))))
3038 if (SvMAGICAL(gv)) {
3040 /* only backref magic is allowed */
3041 if (SvGMAGICAL(gv) || SvSMAGICAL(gv))
3043 for (mg = SvMAGIC(gv); mg; mg = mg->mg_moremagic) {
3044 if (mg->mg_type != PERL_MAGIC_backref)
3050 HEK *gvnhek = GvNAME_HEK(gv);
3051 (void)hv_delete(stash, HEK_KEY(gvnhek),
3052 HEK_UTF8(gvnhek) ? -HEK_LEN(gvnhek) : HEK_LEN(gvnhek), G_DISCARD);
3053 } else if (GvMULTI(gv) && cv &&
3054 !SvOBJECT(cv) && !SvMAGICAL(cv) && !SvREADONLY(cv) &&
3055 CvSTASH(cv) == stash && CvGV(cv) == gv &&
3056 CvCONST(cv) && !CvMETHOD(cv) && !CvLVALUE(cv) && !CvUNIQUE(cv) &&
3057 !CvNODEBUG(cv) && !CvCLONE(cv) && !CvCLONED(cv) && !CvANON(cv) &&
3058 (namehek = GvNAME_HEK(gv)) &&
3059 (gvp = hv_fetch(stash, HEK_KEY(namehek),
3060 HEK_LEN(namehek)*(HEK_UTF8(namehek) ? -1 : 1), 0)) &&
3062 SV *value = SvREFCNT_inc(CvXSUBANY(cv).any_ptr);
3066 SvFLAGS(gv) = SVt_IV|SVf_ROK;
3067 SvANY(gv) = (XPVGV*)((char*)&(gv->sv_u.svu_iv) -
3068 STRUCT_OFFSET(XPVIV, xiv_iv));
3069 SvRV_set(gv, value);
3076 core_xsub(pTHX_ CV* cv)
3079 "&CORE::%s cannot be called directly", GvNAME(CvGV(cv))
3085 * c-indentation-style: bsd
3087 * indent-tabs-mode: t
3090 * ex: set ts=8 sts=4 sw=4 noet: