3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 * 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
12 * 'Mercy!' cried Gandalf. 'If the giving of information is to be the cure
13 * of your inquisitiveness, I shall spend all the rest of my days in answering
14 * you. What more do you want to know?'
15 * 'The names of all the stars, and of all living things, and the whole
16 * history of Middle-earth and Over-heaven and of the Sundering Seas,'
19 * [p.599 of _The Lord of the Rings_, III/xi: "The PalantÃr"]
25 A GV is a structure which corresponds to to a Perl typeglob, ie *foo.
26 It is a structure that holds a pointer to a scalar, an array, a hash etc,
27 corresponding to $foo, @foo, %foo.
29 GVs are usually found as values in stashes (symbol table hashes) where
30 Perl stores its global variables.
42 static const char S_autoload[] = "AUTOLOAD";
43 static const STRLEN S_autolen = sizeof(S_autoload)-1;
46 Perl_gv_add_by_type(pTHX_ GV *gv, svtype type)
53 SvTYPE((const SV *)gv) != SVt_PVGV
54 && SvTYPE((const SV *)gv) != SVt_PVLV
58 if (type == SVt_PVIO) {
60 * if it walks like a dirhandle, then let's assume that
61 * this is a dirhandle.
63 what = OP_IS_DIRHOP(PL_op->op_type) ?
64 "dirhandle" : "filehandle";
65 } else if (type == SVt_PVHV) {
68 what = type == SVt_PVAV ? "array" : "scalar";
70 /* diag_listed_as: Bad symbol for filehandle */
71 Perl_croak(aTHX_ "Bad symbol for %s", what);
74 if (type == SVt_PVHV) {
75 where = (SV **)&GvHV(gv);
76 } else if (type == SVt_PVAV) {
77 where = (SV **)&GvAV(gv);
78 } else if (type == SVt_PVIO) {
79 where = (SV **)&GvIOp(gv);
85 *where = newSV_type(type);
86 if (type == SVt_PVAV && GvNAMELEN(gv) == 3
87 && strnEQ(GvNAME(gv), "ISA", 3))
88 sv_magic(*where, (SV *)gv, PERL_MAGIC_isa, NULL, 0);
93 Perl_gv_fetchfile(pTHX_ const char *name)
95 PERL_ARGS_ASSERT_GV_FETCHFILE;
96 return gv_fetchfile_flags(name, strlen(name), 0);
100 Perl_gv_fetchfile_flags(pTHX_ const char *const name, const STRLEN namelen,
106 const STRLEN tmplen = namelen + 2;
109 PERL_ARGS_ASSERT_GV_FETCHFILE_FLAGS;
110 PERL_UNUSED_ARG(flags);
115 if (tmplen <= sizeof smallbuf)
118 Newx(tmpbuf, tmplen, char);
119 /* This is where the debugger's %{"::_<$filename"} hash is created */
122 memcpy(tmpbuf + 2, name, namelen);
123 gv = *(GV**)hv_fetch(PL_defstash, tmpbuf, tmplen, TRUE);
125 gv_init(gv, PL_defstash, tmpbuf, tmplen, FALSE);
126 #ifdef PERL_DONT_CREATE_GVSV
127 GvSV(gv) = newSVpvn(name, namelen);
129 sv_setpvn(GvSV(gv), name, namelen);
132 if ((PERLDB_LINE || PERLDB_SAVESRC) && !GvAV(gv))
133 hv_magic(GvHVn(gv_AVadd(gv)), NULL, PERL_MAGIC_dbfile);
134 if (tmpbuf != smallbuf)
140 =for apidoc gv_const_sv
142 If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
143 inlining, or C<gv> is a placeholder reference that would be promoted to such
144 a typeglob, then returns the value returned by the sub. Otherwise, returns
151 Perl_gv_const_sv(pTHX_ GV *gv)
153 PERL_ARGS_ASSERT_GV_CONST_SV;
155 if (SvTYPE(gv) == SVt_PVGV)
156 return cv_const_sv(GvCVu(gv));
157 return SvROK(gv) ? SvRV(gv) : NULL;
161 Perl_newGP(pTHX_ GV *const gv)
166 const char *const file
167 = (PL_curcop && CopFILE(PL_curcop)) ? CopFILE(PL_curcop) : "";
168 const STRLEN len = strlen(file);
170 SV *const temp_sv = CopFILESV(PL_curcop);
174 PERL_ARGS_ASSERT_NEWGP;
177 file = SvPVX(temp_sv);
178 len = SvCUR(temp_sv);
185 PERL_HASH(hash, file, len);
189 #ifndef PERL_DONT_CREATE_GVSV
190 gp->gp_sv = newSV(0);
193 gp->gp_line = PL_curcop ? CopLINE(PL_curcop) : 0;
194 /* XXX Ideally this cast would be replaced with a change to const char*
196 gp->gp_file_hek = share_hek(file, len, hash);
203 /* Assign CvGV(cv) = gv, handling weak references.
204 * See also S_anonymise_cv_maybe */
207 Perl_cvgv_set(pTHX_ CV* cv, GV* gv)
209 GV * const oldgv = CvGV(cv);
210 PERL_ARGS_ASSERT_CVGV_SET;
221 sv_del_backref(MUTABLE_SV(oldgv), MUTABLE_SV(cv));
225 SvANY(cv)->xcv_gv = gv;
226 assert(!CvCVGV_RC(cv));
231 if (isGV_with_GP(gv) && GvGP(gv) && (GvCV(gv) == cv || GvFORM(gv) == cv))
232 Perl_sv_add_backref(aTHX_ MUTABLE_SV(gv), MUTABLE_SV(cv));
235 SvREFCNT_inc_simple_void_NN(gv);
239 /* Assign CvSTASH(cv) = st, handling weak references. */
242 Perl_cvstash_set(pTHX_ CV *cv, HV *st)
244 HV *oldst = CvSTASH(cv);
245 PERL_ARGS_ASSERT_CVSTASH_SET;
249 sv_del_backref(MUTABLE_SV(oldst), MUTABLE_SV(cv));
250 SvANY(cv)->xcv_stash = st;
252 Perl_sv_add_backref(aTHX_ MUTABLE_SV(st), MUTABLE_SV(cv));
256 =for apidoc gv_init_pvn
258 Converts a scalar into a typeglob. This is an incoercible typeglob;
259 assigning a reference to it will assign to one of its slots, instead of
260 overwriting it as happens with typeglobs created by SvSetSV. Converting
261 any scalar that is SvOK() may produce unpredictable results and is reserved
262 for perl's internal use.
264 C<gv> is the scalar to be converted.
266 C<stash> is the parent stash/package, if any.
268 C<name> and C<len> give the name. The name must be unqualified;
269 that is, it must not include the package name. If C<gv> is a
270 stash element, it is the caller's responsibility to ensure that the name
271 passed to this function matches the name of the element. If it does not
272 match, perl's internal bookkeeping will get out of sync.
274 C<flags> can be set to SVf_UTF8 if C<name> is a UTF8 string, or
275 the return value of SvUTF8(sv). It can also take the
276 GV_ADDMULTI flag, which means to pretend that the GV has been
277 seen before (i.e., suppress "Used once" warnings).
281 The old form of gv_init_pvn(). It does not work with UTF8 strings, as it
282 has no flags parameter. If the C<multi> parameter is set, the
283 GV_ADDMULTI flag will be passed to gv_init_pvn().
285 =for apidoc gv_init_pv
287 Same as gv_init_pvn(), but takes a nul-terminated string for the name
288 instead of separate char * and length parameters.
290 =for apidoc gv_init_sv
292 Same as gv_init_pvn(), but takes an SV * for the name instead of separate
293 char * and length parameters. C<flags> is currently unused.
299 Perl_gv_init_sv(pTHX_ GV *gv, HV *stash, SV* namesv, U32 flags)
303 PERL_ARGS_ASSERT_GV_INIT_SV;
304 namepv = SvPV(namesv, namelen);
307 gv_init_pvn(gv, stash, namepv, namelen, flags);
311 Perl_gv_init_pv(pTHX_ GV *gv, HV *stash, const char *name, U32 flags)
313 PERL_ARGS_ASSERT_GV_INIT_PV;
314 gv_init_pvn(gv, stash, name, strlen(name), flags);
318 Perl_gv_init_pvn(pTHX_ GV *gv, HV *stash, const char *name, STRLEN len, U32 flags)
321 const U32 old_type = SvTYPE(gv);
322 const bool doproto = old_type > SVt_NULL;
323 char * const proto = (doproto && SvPOK(gv))
324 ? ((void)(SvIsCOW(gv) && (sv_force_normal((SV *)gv), 0)), SvPVX(gv))
326 const STRLEN protolen = proto ? SvCUR(gv) : 0;
327 const U32 proto_utf8 = proto ? SvUTF8(gv) : 0;
328 SV *const has_constant = doproto && SvROK(gv) ? SvRV(gv) : NULL;
329 const U32 exported_constant = has_constant ? SvPCS_IMPORTED(gv) : 0;
331 PERL_ARGS_ASSERT_GV_INIT_PVN;
332 assert (!(proto && has_constant));
335 /* The constant has to be a simple scalar type. */
336 switch (SvTYPE(has_constant)) {
342 Perl_croak(aTHX_ "Cannot convert a reference to %s to typeglob",
343 sv_reftype(has_constant, 0));
351 if (old_type < SVt_PVGV) {
352 if (old_type >= SVt_PV)
354 sv_upgrade(MUTABLE_SV(gv), SVt_PVGV);
362 Safefree(SvPVX_mutable(gv));
367 GvGP_set(gv, Perl_newGP(aTHX_ gv));
370 Perl_sv_add_backref(aTHX_ MUTABLE_SV(stash), MUTABLE_SV(gv));
371 gv_name_set(gv, name, len, GV_ADD | ( flags & SVf_UTF8 ? SVf_UTF8 : 0 ));
372 if (flags & GV_ADDMULTI || doproto) /* doproto means it */
373 GvMULTI_on(gv); /* _was_ mentioned */
377 /* newCONSTSUB takes ownership of the reference from us. */
378 cv = newCONSTSUB_flags(stash, name, len, flags, has_constant);
379 /* In case op.c:S_process_special_blocks stole it: */
381 GvCV_set(gv, (CV *)SvREFCNT_inc_simple_NN(cv));
382 assert(GvCV(gv) == cv); /* newCONSTSUB should have set this */
383 /* If this reference was a copy of another, then the subroutine
384 must have been "imported", by a Perl space assignment to a GV
385 from a reference to CV. */
386 if (exported_constant)
387 GvIMPORTED_CV_on(gv);
388 CvSTASH_set(cv, PL_curstash); /* XXX Why is this needed? */
393 sv_usepvn_flags(MUTABLE_SV(cv), proto, protolen,
394 SV_HAS_TRAILING_NUL);
395 if ( proto_utf8 ) SvUTF8_on(MUTABLE_SV(cv));
401 S_gv_init_svtype(pTHX_ GV *gv, const svtype sv_type)
403 PERL_ARGS_ASSERT_GV_INIT_SVTYPE;
415 #ifdef PERL_DONT_CREATE_GVSV
423 /* Work round what appears to be a bug in Sun C++ 5.8 2005/10/13
424 If we just cast GvSVn(gv) to void, it ignores evaluating it for
431 static void core_xsub(pTHX_ CV* cv);
434 S_maybe_add_coresub(pTHX_ HV * const stash, GV *gv,
435 const char * const name, const STRLEN len)
437 const int code = keyword(name, len, 1);
438 static const char file[] = __FILE__;
439 CV *cv, *oldcompcv = NULL;
442 bool ampable = TRUE; /* &{}-able */
443 COP *oldcurcop = NULL;
444 yy_parser *oldparser = NULL;
445 I32 oldsavestack_ix = 0;
450 if (!code) return NULL; /* Not a keyword */
451 switch (code < 0 ? -code : code) {
452 /* no support for \&CORE::infix;
453 no support for funcs that do not parse like funcs */
454 case KEY___DATA__: case KEY___END__: case KEY_and: case KEY_AUTOLOAD:
455 case KEY_BEGIN : case KEY_CHECK : case KEY_cmp: case KEY_CORE :
456 case KEY_default : case KEY_DESTROY:
457 case KEY_do : case KEY_dump : case KEY_else : case KEY_elsif :
458 case KEY_END : case KEY_eq : case KEY_eval :
459 case KEY_for : case KEY_foreach: case KEY_format: case KEY_ge :
460 case KEY_given : case KEY_goto : case KEY_grep :
461 case KEY_gt : case KEY_if: case KEY_INIT: case KEY_last: case KEY_le:
462 case KEY_local: case KEY_lt: case KEY_m : case KEY_map : case KEY_my:
463 case KEY_ne : case KEY_next : case KEY_no: case KEY_or: case KEY_our:
464 case KEY_package: case KEY_print: case KEY_printf:
465 case KEY_q : case KEY_qq : case KEY_qr : case KEY_qw :
466 case KEY_qx : case KEY_redo : case KEY_require: case KEY_return:
467 case KEY_s : case KEY_say : case KEY_sort :
468 case KEY_state: case KEY_sub :
469 case KEY_tr : case KEY_UNITCHECK: case KEY_unless:
470 case KEY_until: case KEY_use : case KEY_when : case KEY_while :
471 case KEY_x : case KEY_xor : case KEY_y :
474 case KEY_chomp: case KEY_chop: case KEY_defined: case KEY_delete:
475 case KEY_each : case KEY_eof : case KEY_exec : case KEY_exists:
481 case KEY_splice: case KEY_split:
484 case KEY_truncate: case KEY_unlink:
491 gv_init(gv, stash, name, len, TRUE);
496 oldcurcop = PL_curcop;
497 oldparser = PL_parser;
498 lex_start(NULL, NULL, 0);
499 oldcompcv = PL_compcv;
500 PL_compcv = NULL; /* Prevent start_subparse from setting
502 oldsavestack_ix = start_subparse(FALSE,0);
506 /* Avoid calling newXS, as it calls us, and things start to
508 cv = MUTABLE_CV(newSV_type(SVt_PVCV));
511 mro_method_changed_in(GvSTASH(gv));
513 CvXSUB(cv) = core_xsub;
515 CvGV_set(cv, gv); /* This stops new ATTRSUB from setting CvFILE
517 (void)gv_fetchfile(file);
518 CvFILE(cv) = (char *)file;
519 /* XXX This is inefficient, as doing things this order causes
520 a prototype check in newATTRSUB. But we have to do
521 it this order as we need an op number before calling
523 (void)core_prototype((SV *)cv, name, code, &opnum);
525 (void)hv_store(stash,name,len,(SV *)gv,0);
529 oldsavestack_ix, (OP *)gv,
534 : newSVpvn(name,len),
539 assert(GvCV(gv) == cv);
540 if (opnum != OP_VEC && opnum != OP_SUBSTR && opnum != OP_POS
541 && opnum != OP_UNDEF)
542 CvLVALUE_off(cv); /* Now *that* was a neat trick. */
544 PL_parser = oldparser;
545 PL_curcop = oldcurcop;
546 PL_compcv = oldcompcv;
548 opnumsv = opnum ? newSVuv((UV)opnum) : (SV *)NULL;
550 cv, Perl_ck_entersub_args_core, opnumsv ? opnumsv : (SV *)cv
552 SvREFCNT_dec(opnumsv);
557 =for apidoc gv_fetchmeth
559 Like L</gv_fetchmeth_pvn>, but lacks a flags parameter.
561 =for apidoc gv_fetchmeth_sv
563 Exactly like L</gv_fetchmeth_pvn>, but takes the name string in the form
564 of an SV instead of a string/length pair.
570 Perl_gv_fetchmeth_sv(pTHX_ HV *stash, SV *namesv, I32 level, U32 flags)
574 PERL_ARGS_ASSERT_GV_FETCHMETH_SV;
575 namepv = SvPV(namesv, namelen);
578 return gv_fetchmeth_pvn(stash, namepv, namelen, level, flags);
582 =for apidoc gv_fetchmeth_pv
584 Exactly like L</gv_fetchmeth_pvn>, but takes a nul-terminated string
585 instead of a string/length pair.
591 Perl_gv_fetchmeth_pv(pTHX_ HV *stash, const char *name, I32 level, U32 flags)
593 PERL_ARGS_ASSERT_GV_FETCHMETH_PV;
594 return gv_fetchmeth_pvn(stash, name, strlen(name), level, flags);
598 =for apidoc gv_fetchmeth_pvn
600 Returns the glob with the given C<name> and a defined subroutine or
601 C<NULL>. The glob lives in the given C<stash>, or in the stashes
602 accessible via @ISA and UNIVERSAL::.
604 The argument C<level> should be either 0 or -1. If C<level==0>, as a
605 side-effect creates a glob with the given C<name> in the given C<stash>
606 which in the case of success contains an alias for the subroutine, and sets
607 up caching info for this glob.
609 Currently, the only significant value for C<flags> is SVf_UTF8.
611 This function grants C<"SUPER"> token as a postfix of the stash name. The
612 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
613 visible to Perl code. So when calling C<call_sv>, you should not use
614 the GV directly; instead, you should use the method's CV, which can be
615 obtained from the GV with the C<GvCV> macro.
620 /* NOTE: No support for tied ISA */
623 Perl_gv_fetchmeth_pvn(pTHX_ HV *stash, const char *name, STRLEN len, I32 level, U32 flags)
631 GV* candidate = NULL;
635 I32 create = (level >= 0) ? 1 : 0;
639 U32 is_utf8 = flags & SVf_UTF8;
641 PERL_ARGS_ASSERT_GV_FETCHMETH_PVN;
643 /* UNIVERSAL methods should be callable without a stash */
645 create = 0; /* probably appropriate */
646 if(!(stash = gv_stashpvs("UNIVERSAL", 0)))
652 hvname = HvNAME_get(stash);
654 Perl_croak(aTHX_ "Can't use anonymous symbol table for method lookup");
659 DEBUG_o( Perl_deb(aTHX_ "Looking for method %s in package %s\n",name,hvname) );
661 topgen_cmp = HvMROMETA(stash)->cache_gen + PL_sub_generation;
663 /* check locally for a real method or a cache entry */
664 gvp = (GV**)hv_fetch(stash, name, is_utf8 ? -(I32)len : (I32)len, create);
669 if (SvTYPE(topgv) != SVt_PVGV)
670 gv_init_pvn(topgv, stash, name, len, GV_ADDMULTI|is_utf8);
671 if ((cand_cv = GvCV(topgv))) {
672 /* If genuine method or valid cache entry, use it */
673 if (!GvCVGEN(topgv) || GvCVGEN(topgv) == topgen_cmp) {
677 /* stale cache entry, junk it and move on */
678 SvREFCNT_dec(cand_cv);
679 GvCV_set(topgv, NULL);
684 else if (GvCVGEN(topgv) == topgen_cmp) {
685 /* cache indicates no such method definitively */
688 else if (len > 1 /* shortest is uc */ && HvNAMELEN_get(stash) == 4
689 && strnEQ(hvname, "CORE", 4)
690 && S_maybe_add_coresub(aTHX_ NULL,topgv,name,len))
694 packlen = HvNAMELEN_get(stash);
695 if (packlen >= 7 && strEQ(hvname + packlen - 7, "::SUPER")) {
698 basestash = gv_stashpvn(hvname, packlen,
699 GV_ADD | (HvNAMEUTF8(stash) ? SVf_UTF8 : 0));
700 linear_av = mro_get_linear_isa(basestash);
703 linear_av = mro_get_linear_isa(stash); /* has ourselves at the top of the list */
706 linear_svp = AvARRAY(linear_av) + 1; /* skip over self */
707 items = AvFILLp(linear_av); /* no +1, to skip over self */
709 linear_sv = *linear_svp++;
711 cstash = gv_stashsv(linear_sv, 0);
714 Perl_ck_warner(aTHX_ packWARN(WARN_SYNTAX),
715 "Can't locate package %"SVf" for @%"HEKf"::ISA",
717 HEKfARG(HvNAME_HEK(stash)));
723 gvp = (GV**)hv_fetch(cstash, name, is_utf8 ? -(I32)len : (I32)len, 0);
725 if (len > 1 && HvNAMELEN_get(cstash) == 4) {
726 const char *hvname = HvNAME(cstash); assert(hvname);
727 if (strnEQ(hvname, "CORE", 4)
729 S_maybe_add_coresub(aTHX_ cstash,NULL,name,len)
735 else candidate = *gvp;
738 if (SvTYPE(candidate) != SVt_PVGV)
739 gv_init_pvn(candidate, cstash, name, len, GV_ADDMULTI|is_utf8);
740 if (SvTYPE(candidate) == SVt_PVGV && (cand_cv = GvCV(candidate)) && !GvCVGEN(candidate)) {
742 * Found real method, cache method in topgv if:
743 * 1. topgv has no synonyms (else inheritance crosses wires)
744 * 2. method isn't a stub (else AUTOLOAD fails spectacularly)
746 if (topgv && (GvREFCNT(topgv) == 1) && (CvROOT(cand_cv) || CvXSUB(cand_cv))) {
747 CV *old_cv = GvCV(topgv);
748 SvREFCNT_dec(old_cv);
749 SvREFCNT_inc_simple_void_NN(cand_cv);
750 GvCV_set(topgv, cand_cv);
751 GvCVGEN(topgv) = topgen_cmp;
757 /* Check UNIVERSAL without caching */
758 if(level == 0 || level == -1) {
759 candidate = gv_fetchmeth_pvn(NULL, name, len, 1, flags);
761 cand_cv = GvCV(candidate);
762 if (topgv && (GvREFCNT(topgv) == 1) && (CvROOT(cand_cv) || CvXSUB(cand_cv))) {
763 CV *old_cv = GvCV(topgv);
764 SvREFCNT_dec(old_cv);
765 SvREFCNT_inc_simple_void_NN(cand_cv);
766 GvCV_set(topgv, cand_cv);
767 GvCVGEN(topgv) = topgen_cmp;
773 if (topgv && GvREFCNT(topgv) == 1) {
774 /* cache the fact that the method is not defined */
775 GvCVGEN(topgv) = topgen_cmp;
782 =for apidoc gv_fetchmeth_autoload
784 This is the old form of L</gv_fetchmeth_pvn_autoload>, which has no flags
787 =for apidoc gv_fetchmeth_sv_autoload
789 Exactly like L</gv_fetchmeth_pvn_autoload>, but takes the name string in the form
790 of an SV instead of a string/length pair.
796 Perl_gv_fetchmeth_sv_autoload(pTHX_ HV *stash, SV *namesv, I32 level, U32 flags)
800 PERL_ARGS_ASSERT_GV_FETCHMETH_SV_AUTOLOAD;
801 namepv = SvPV(namesv, namelen);
804 return gv_fetchmeth_pvn_autoload(stash, namepv, namelen, level, flags);
808 =for apidoc gv_fetchmeth_pv_autoload
810 Exactly like L</gv_fetchmeth_pvn_autoload>, but takes a nul-terminated string
811 instead of a string/length pair.
817 Perl_gv_fetchmeth_pv_autoload(pTHX_ HV *stash, const char *name, I32 level, U32 flags)
819 PERL_ARGS_ASSERT_GV_FETCHMETH_PV_AUTOLOAD;
820 return gv_fetchmeth_pvn_autoload(stash, name, strlen(name), level, flags);
824 =for apidoc gv_fetchmeth_pvn_autoload
826 Same as gv_fetchmeth_pvn(), but looks for autoloaded subroutines too.
827 Returns a glob for the subroutine.
829 For an autoloaded subroutine without a GV, will create a GV even
830 if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
831 of the result may be zero.
833 Currently, the only significant value for C<flags> is SVf_UTF8.
839 Perl_gv_fetchmeth_pvn_autoload(pTHX_ HV *stash, const char *name, STRLEN len, I32 level, U32 flags)
841 GV *gv = gv_fetchmeth_pvn(stash, name, len, level, flags);
843 PERL_ARGS_ASSERT_GV_FETCHMETH_PVN_AUTOLOAD;
850 return NULL; /* UNIVERSAL::AUTOLOAD could cause trouble */
851 if (len == S_autolen && memEQ(name, S_autoload, S_autolen))
853 if (!(gv = gv_fetchmeth_pvn(stash, S_autoload, S_autolen, FALSE, flags)))
856 if (!(CvROOT(cv) || CvXSUB(cv)))
858 /* Have an autoload */
859 if (level < 0) /* Cannot do without a stub */
860 gv_fetchmeth_pvn(stash, name, len, 0, flags);
861 gvp = (GV**)hv_fetch(stash, name,
862 (flags & SVf_UTF8) ? -(I32)len : (I32)len, (level >= 0));
871 =for apidoc gv_fetchmethod_autoload
873 Returns the glob which contains the subroutine to call to invoke the method
874 on the C<stash>. In fact in the presence of autoloading this may be the
875 glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
878 The third parameter of C<gv_fetchmethod_autoload> determines whether
879 AUTOLOAD lookup is performed if the given method is not present: non-zero
880 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
881 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
882 with a non-zero C<autoload> parameter.
884 These functions grant C<"SUPER"> token as a prefix of the method name. Note
885 that if you want to keep the returned glob for a long time, you need to
886 check for it being "AUTOLOAD", since at the later time the call may load a
887 different subroutine due to $AUTOLOAD changing its value. Use the glob
888 created via a side effect to do this.
890 These functions have the same side-effects and as C<gv_fetchmeth> with
891 C<level==0>. C<name> should be writable if contains C<':'> or C<'
892 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
893 C<call_sv> apply equally to these functions.
899 S_gv_get_super_pkg(pTHX_ const char* name, I32 namelen, U32 flags)
906 PERL_ARGS_ASSERT_GV_GET_SUPER_PKG;
908 stash = gv_stashpvn(name, namelen, flags);
909 if(stash) return stash;
911 /* If we must create it, give it an @ISA array containing
912 the real package this SUPER is for, so that it's tied
913 into the cache invalidation code correctly */
914 stash = gv_stashpvn(name, namelen, GV_ADD | flags);
915 gvp = (GV**)hv_fetchs(stash, "ISA", TRUE);
917 gv_init(gv, stash, "ISA", 3, TRUE);
918 superisa = GvAVn(gv);
920 sv_magic(MUTABLE_SV(superisa), MUTABLE_SV(gv), PERL_MAGIC_isa, NULL, 0);
921 av_push(superisa, newSVhek(CopSTASH(PL_curcop)
922 ? HvNAME_HEK(CopSTASH(PL_curcop)) : NULL));
928 Perl_gv_fetchmethod_autoload(pTHX_ HV *stash, const char *name, I32 autoload)
930 PERL_ARGS_ASSERT_GV_FETCHMETHOD_AUTOLOAD;
932 return gv_fetchmethod_flags(stash, name, autoload ? GV_AUTOLOAD : 0);
936 Perl_gv_fetchmethod_sv_flags(pTHX_ HV *stash, SV *namesv, U32 flags)
940 PERL_ARGS_ASSERT_GV_FETCHMETHOD_SV_FLAGS;
941 namepv = SvPV(namesv, namelen);
944 return gv_fetchmethod_pvn_flags(stash, namepv, namelen, flags);
948 Perl_gv_fetchmethod_pv_flags(pTHX_ HV *stash, const char *name, U32 flags)
950 PERL_ARGS_ASSERT_GV_FETCHMETHOD_PV_FLAGS;
951 return gv_fetchmethod_pvn_flags(stash, name, strlen(name), flags);
954 /* Don't merge this yet, as it's likely to get a len parameter, and possibly
957 Perl_gv_fetchmethod_pvn_flags(pTHX_ HV *stash, const char *name, const STRLEN len, U32 flags)
961 const char *nsplit = NULL;
964 const char * const origname = name;
965 SV *const error_report = MUTABLE_SV(stash);
966 const U32 autoload = flags & GV_AUTOLOAD;
967 const U32 do_croak = flags & GV_CROAK;
968 const U32 is_utf8 = flags & SVf_UTF8;
970 PERL_ARGS_ASSERT_GV_FETCHMETHOD_PVN_FLAGS;
972 if (SvTYPE(stash) < SVt_PVHV)
975 /* The only way stash can become NULL later on is if nsplit is set,
976 which in turn means that there is no need for a SVt_PVHV case
977 the error reporting code. */
980 for (nend = name; *nend || nend != (origname + len); nend++) {
985 else if (*nend == ':' && *(nend + 1) == ':') {
991 if ((nsplit - origname) == 5 && memEQ(origname, "SUPER", 5)) {
992 /* ->SUPER::method should really be looked up in original stash */
993 SV * const tmpstr = sv_2mortal(Perl_newSVpvf(aTHX_
995 HEKfARG(HvNAME_HEK((HV*)CopSTASH(PL_curcop)))
997 /* __PACKAGE__::SUPER stash should be autovivified */
998 stash = gv_get_super_pkg(SvPVX_const(tmpstr), SvCUR(tmpstr), SvUTF8(tmpstr));
999 DEBUG_o( Perl_deb(aTHX_ "Treating %s as %s::%s\n",
1000 origname, HvNAME_get(stash), name) );
1003 /* don't autovifify if ->NoSuchStash::method */
1004 stash = gv_stashpvn(origname, nsplit - origname, is_utf8);
1006 /* however, explicit calls to Pkg::SUPER::method may
1007 happen, and may require autovivification to work */
1008 if (!stash && (nsplit - origname) >= 7 &&
1009 strnEQ(nsplit - 7, "::SUPER", 7) &&
1010 gv_stashpvn(origname, nsplit - origname - 7, is_utf8))
1011 stash = gv_get_super_pkg(origname, nsplit - origname, flags);
1016 gv = gv_fetchmeth_pvn(stash, name, nend - name, 0, flags);
1018 if (strEQ(name,"import") || strEQ(name,"unimport"))
1019 gv = MUTABLE_GV(&PL_sv_yes);
1021 gv = gv_autoload_pvn(
1022 ostash, name, nend - name, GV_AUTOLOAD_ISMETHOD|flags
1024 if (!gv && do_croak) {
1025 /* Right now this is exclusively for the benefit of S_method_common
1028 /* If we can't find an IO::File method, it might be a call on
1029 * a filehandle. If IO:File has not been loaded, try to
1030 * require it first instead of croaking */
1031 const char *stash_name = HvNAME_get(stash);
1032 if (stash_name && memEQs(stash_name, HvNAMELEN_get(stash), "IO::File")
1033 && !Perl_hv_common(aTHX_ GvHVn(PL_incgv), NULL,
1034 STR_WITH_LEN("IO/File.pm"), 0,
1035 HV_FETCH_ISEXISTS, NULL, 0)
1037 require_pv("IO/File.pm");
1038 gv = gv_fetchmeth_pvn(stash, name, nend - name, 0, flags);
1043 "Can't locate object method \"%"SVf
1044 "\" via package \"%"HEKf"\"",
1045 SVfARG(newSVpvn_flags(name, nend - name,
1046 SVs_TEMP | is_utf8)),
1047 HEKfARG(HvNAME_HEK(stash)));
1053 packnamesv = newSVpvn_flags(origname, nsplit - origname,
1054 SVs_TEMP | is_utf8);
1056 packnamesv = sv_2mortal(newSVsv(error_report));
1060 "Can't locate object method \"%"SVf"\" via package \"%"SVf"\""
1061 " (perhaps you forgot to load \"%"SVf"\"?)",
1062 SVfARG(newSVpvn_flags(name, nend - name,
1063 SVs_TEMP | is_utf8)),
1064 SVfARG(packnamesv), SVfARG(packnamesv));
1068 else if (autoload) {
1069 CV* const cv = GvCV(gv);
1070 if (!CvROOT(cv) && !CvXSUB(cv)) {
1078 if (GvCV(stubgv) != cv) /* orphaned import */
1081 autogv = gv_autoload_pvn(GvSTASH(stubgv),
1082 GvNAME(stubgv), GvNAMELEN(stubgv),
1083 GV_AUTOLOAD_ISMETHOD
1084 | (GvNAMEUTF8(stubgv) ? SVf_UTF8 : 0));
1094 Perl_gv_autoload_sv(pTHX_ HV *stash, SV* namesv, U32 flags)
1098 PERL_ARGS_ASSERT_GV_AUTOLOAD_SV;
1099 namepv = SvPV(namesv, namelen);
1102 return gv_autoload_pvn(stash, namepv, namelen, flags);
1106 Perl_gv_autoload_pv(pTHX_ HV *stash, const char *namepv, U32 flags)
1108 PERL_ARGS_ASSERT_GV_AUTOLOAD_PV;
1109 return gv_autoload_pvn(stash, namepv, strlen(namepv), flags);
1113 Perl_gv_autoload_pvn(pTHX_ HV *stash, const char *name, STRLEN len, U32 flags)
1121 SV *packname = NULL;
1122 U32 is_utf8 = flags & SVf_UTF8 ? SVf_UTF8 : 0;
1124 PERL_ARGS_ASSERT_GV_AUTOLOAD_PVN;
1126 if (len == S_autolen && memEQ(name, S_autoload, S_autolen))
1129 if (SvTYPE(stash) < SVt_PVHV) {
1130 STRLEN packname_len = 0;
1131 const char * const packname_ptr = SvPV_const(MUTABLE_SV(stash), packname_len);
1132 packname = newSVpvn_flags(packname_ptr, packname_len,
1133 SVs_TEMP | SvUTF8(stash));
1137 packname = sv_2mortal(newSVhek(HvNAME_HEK(stash)));
1139 if (!(gv = gv_fetchmeth_pvn(stash, S_autoload, S_autolen, FALSE, is_utf8)))
1143 if (!(CvROOT(cv) || CvXSUB(cv)))
1147 * Inheriting AUTOLOAD for non-methods works ... for now.
1150 !(flags & GV_AUTOLOAD_ISMETHOD)
1151 && (GvCVGEN(gv) || GvSTASH(gv) != stash)
1153 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED),
1154 "Use of inherited AUTOLOAD for non-method %"SVf"::%"SVf"() is deprecated",
1156 SVfARG(newSVpvn_flags(name, len, SVs_TEMP | is_utf8)));
1159 /* Instead of forcing the XSUB do another lookup for $AUTOLOAD
1160 * and split that value on the last '::', pass along the same data
1161 * via the SvPVX field in the CV, and the stash in CvSTASH.
1163 * Due to an unfortunate accident of history, the SvPVX field
1164 * serves two purposes. It is also used for the subroutine's pro-
1165 * type. Since SvPVX has been documented as returning the sub name
1166 * for a long time, but not as returning the prototype, we have
1167 * to preserve the SvPVX AUTOLOAD behaviour and put the prototype
1170 * We put the prototype in the same allocated buffer, but after
1171 * the sub name. The SvPOK flag indicates the presence of a proto-
1172 * type. The CvAUTOLOAD flag indicates the presence of a sub name.
1173 * If both flags are on, then SvLEN is used to indicate the end of
1174 * the prototype (artificially lower than what is actually allo-
1175 * cated), at the risk of having to reallocate a few bytes unneces-
1176 * sarily--but that should happen very rarely, if ever.
1178 * We use SvUTF8 for both prototypes and sub names, so if one is
1179 * UTF8, the other must be upgraded.
1181 CvSTASH_set(cv, stash);
1182 if (SvPOK(cv)) { /* Ouch! */
1183 SV *tmpsv = newSVpvn_flags(name, len, is_utf8);
1185 const char *proto = CvPROTO(cv);
1188 sv_utf8_upgrade_flags_grow(tmpsv, 0, CvPROTOLEN(cv) + 2);
1189 ulen = SvCUR(tmpsv);
1190 SvCUR(tmpsv)++; /* include null in string */
1192 tmpsv, proto, CvPROTOLEN(cv), SV_CATBYTES*!SvUTF8(cv)
1194 SvTEMP_on(tmpsv); /* Allow theft */
1195 sv_setsv_nomg((SV *)cv, tmpsv);
1197 SvREFCNT_dec(tmpsv);
1198 SvLEN(cv) = SvCUR(cv) + 1;
1202 sv_setpvn((SV *)cv, name, len);
1206 else SvUTF8_off(cv);
1212 * Given &FOO::AUTOLOAD, set $FOO::AUTOLOAD to desired function name.
1213 * The subroutine's original name may not be "AUTOLOAD", so we don't
1214 * use that, but for lack of anything better we will use the sub's
1215 * original package to look up $AUTOLOAD.
1217 varstash = GvSTASH(CvGV(cv));
1218 vargv = *(GV**)hv_fetch(varstash, S_autoload, S_autolen, TRUE);
1222 gv_init_pvn(vargv, varstash, S_autoload, S_autolen, 0);
1223 #ifdef PERL_DONT_CREATE_GVSV
1224 GvSV(vargv) = newSV(0);
1228 varsv = GvSVn(vargv);
1229 SvTAINTED_off(varsv); /* previous $AUTOLOAD taint is obsolete */
1230 /* XXX: this process is not careful to avoid extra magic gets and sets; tied $AUTOLOAD will get noise */
1231 sv_setsv(varsv, packname);
1232 sv_catpvs(varsv, "::");
1233 /* Ensure SvSETMAGIC() is called if necessary. In particular, to clear
1234 tainting if $FOO::AUTOLOAD was previously tainted, but is not now. */
1237 SV_SMAGIC|(is_utf8 ? SV_CATUTF8 : SV_CATBYTES)
1245 /* require_tie_mod() internal routine for requiring a module
1246 * that implements the logic of automatic ties like %! and %-
1248 * The "gv" parameter should be the glob.
1249 * "varpv" holds the name of the var, used for error messages.
1250 * "namesv" holds the module name. Its refcount will be decremented.
1251 * "methpv" holds the method name to test for to check that things
1252 * are working reasonably close to as expected.
1253 * "flags": if flag & 1 then save the scalar before loading.
1254 * For the protection of $! to work (it is set by this routine)
1255 * the sv slot must already be magicalized.
1258 S_require_tie_mod(pTHX_ GV *gv, const char *varpv, SV* namesv, const char *methpv,const U32 flags)
1261 HV* stash = gv_stashsv(namesv, 0);
1263 PERL_ARGS_ASSERT_REQUIRE_TIE_MOD;
1265 if (!stash || !(gv_fetchmethod_autoload(stash, methpv, FALSE))) {
1266 SV *module = newSVsv(namesv);
1267 char varname = *varpv; /* varpv might be clobbered by load_module,
1268 so save it. For the moment it's always
1270 const char type = varname == '[' ? '$' : '%';
1275 PUSHSTACKi(PERLSI_MAGIC);
1276 Perl_load_module(aTHX_ PERL_LOADMOD_NOIMPORT, module, NULL);
1280 stash = gv_stashsv(namesv, 0);
1282 Perl_croak(aTHX_ "panic: Can't use %c%c because %"SVf" is not available",
1283 type, varname, SVfARG(namesv));
1284 else if (!gv_fetchmethod(stash, methpv))
1285 Perl_croak(aTHX_ "panic: Can't use %c%c because %"SVf" does not support method %s",
1286 type, varname, SVfARG(namesv), methpv);
1288 SvREFCNT_dec(namesv);
1293 =for apidoc gv_stashpv
1295 Returns a pointer to the stash for a specified package. Uses C<strlen> to
1296 determine the length of C<name>, then calls C<gv_stashpvn()>.
1302 Perl_gv_stashpv(pTHX_ const char *name, I32 create)
1304 PERL_ARGS_ASSERT_GV_STASHPV;
1305 return gv_stashpvn(name, strlen(name), create);
1309 =for apidoc gv_stashpvn
1311 Returns a pointer to the stash for a specified package. The C<namelen>
1312 parameter indicates the length of the C<name>, in bytes. C<flags> is passed
1313 to C<gv_fetchpvn_flags()>, so if set to C<GV_ADD> then the package will be
1314 created if it does not already exist. If the package does not exist and
1315 C<flags> is 0 (or any other setting that does not create packages) then NULL
1318 Flags may be one of:
1327 The most important of which are probably GV_ADD and SVf_UTF8.
1333 Perl_gv_stashpvn(pTHX_ const char *name, U32 namelen, I32 flags)
1339 U32 tmplen = namelen + 2;
1341 PERL_ARGS_ASSERT_GV_STASHPVN;
1343 if (tmplen <= sizeof smallbuf)
1346 Newx(tmpbuf, tmplen, char);
1347 Copy(name, tmpbuf, namelen, char);
1348 tmpbuf[namelen] = ':';
1349 tmpbuf[namelen+1] = ':';
1350 tmpgv = gv_fetchpvn_flags(tmpbuf, tmplen, flags, SVt_PVHV);
1351 if (tmpbuf != smallbuf)
1355 stash = GvHV(tmpgv);
1356 if (!(flags & ~GV_NOADD_MASK) && !stash) return NULL;
1358 if (!HvNAME_get(stash)) {
1359 hv_name_set(stash, name, namelen, flags & SVf_UTF8 ? SVf_UTF8 : 0 );
1361 /* FIXME: This is a repeat of logic in gv_fetchpvn_flags */
1362 /* If the containing stash has multiple effective
1363 names, see that this one gets them, too. */
1364 if (HvAUX(GvSTASH(tmpgv))->xhv_name_count)
1365 mro_package_moved(stash, NULL, tmpgv, 1);
1371 =for apidoc gv_stashsv
1373 Returns a pointer to the stash for a specified package. See C<gv_stashpvn>.
1379 Perl_gv_stashsv(pTHX_ SV *sv, I32 flags)
1382 const char * const ptr = SvPV_const(sv,len);
1384 PERL_ARGS_ASSERT_GV_STASHSV;
1386 return gv_stashpvn(ptr, len, flags | SvUTF8(sv));
1391 Perl_gv_fetchpv(pTHX_ const char *nambeg, I32 add, const svtype sv_type) {
1392 PERL_ARGS_ASSERT_GV_FETCHPV;
1393 return gv_fetchpvn_flags(nambeg, strlen(nambeg), add, sv_type);
1397 Perl_gv_fetchsv(pTHX_ SV *name, I32 flags, const svtype sv_type) {
1399 const char * const nambeg =
1400 SvPV_flags_const(name, len, flags & GV_NO_SVGMAGIC ? 0 : SV_GMAGIC);
1401 PERL_ARGS_ASSERT_GV_FETCHSV;
1402 return gv_fetchpvn_flags(nambeg, len, flags | SvUTF8(name), sv_type);
1406 S_gv_magicalize_isa(pTHX_ GV *gv)
1410 PERL_ARGS_ASSERT_GV_MAGICALIZE_ISA;
1414 sv_magic(MUTABLE_SV(av), MUTABLE_SV(gv), PERL_MAGIC_isa,
1419 Perl_gv_fetchpvn_flags(pTHX_ const char *nambeg, STRLEN full_len, I32 flags,
1420 const svtype sv_type)
1423 const char *name = nambeg;
1427 const char *name_cursor;
1429 const I32 no_init = flags & (GV_NOADD_NOINIT | GV_NOINIT);
1430 const I32 no_expand = flags & GV_NOEXPAND;
1431 const I32 add = flags & ~GV_NOADD_MASK;
1432 const U32 is_utf8 = flags & SVf_UTF8;
1433 bool addmg = !!(flags & GV_ADDMG);
1434 const char *const name_end = nambeg + full_len;
1435 const char *const name_em1 = name_end - 1;
1438 PERL_ARGS_ASSERT_GV_FETCHPVN_FLAGS;
1440 if (flags & GV_NOTQUAL) {
1441 /* Caller promised that there is no stash, so we can skip the check. */
1446 if (full_len > 2 && *name == '*' && isIDFIRST_lazy_if(name + 1, is_utf8)) {
1447 /* accidental stringify on a GV? */
1451 for (name_cursor = name; name_cursor < name_end; name_cursor++) {
1452 if (name_cursor < name_em1 &&
1453 ((*name_cursor == ':'
1454 && name_cursor[1] == ':')
1455 || *name_cursor == '\''))
1458 stash = PL_defstash;
1459 if (!stash || !SvREFCNT(stash)) /* symbol table under destruction */
1462 len = name_cursor - name;
1463 if (name_cursor > nambeg) { /* Skip for initial :: or ' */
1465 if (*name_cursor == ':') {
1470 Newx(tmpbuf, len+2, char);
1471 Copy(name, tmpbuf, len, char);
1472 tmpbuf[len++] = ':';
1473 tmpbuf[len++] = ':';
1476 gvp = (GV**)hv_fetch(stash, key, is_utf8 ? -len : len, add);
1477 gv = gvp ? *gvp : NULL;
1478 if (gv && gv != (const GV *)&PL_sv_undef) {
1479 if (SvTYPE(gv) != SVt_PVGV)
1480 gv_init_pvn(gv, stash, key, len, (add & GV_ADDMULTI)|is_utf8);
1486 if (!gv || gv == (const GV *)&PL_sv_undef)
1489 if (!(stash = GvHV(gv)))
1491 stash = GvHV(gv) = newHV();
1492 if (!HvNAME_get(stash)) {
1493 if (GvSTASH(gv) == PL_defstash && len == 6
1494 && strnEQ(name, "CORE", 4))
1495 hv_name_set(stash, "CORE", 4, 0);
1498 stash, nambeg, name_cursor-nambeg, is_utf8
1500 /* If the containing stash has multiple effective
1501 names, see that this one gets them, too. */
1502 if (HvAUX(GvSTASH(gv))->xhv_name_count)
1503 mro_package_moved(stash, NULL, gv, 1);
1506 else if (!HvNAME_get(stash))
1507 hv_name_set(stash, nambeg, name_cursor - nambeg, is_utf8);
1510 if (*name_cursor == ':')
1512 name = name_cursor+1;
1513 if (name == name_end)
1515 ? gv : MUTABLE_GV(*hv_fetchs(PL_defstash, "main::", TRUE));
1518 len = name_cursor - name;
1520 /* No stash in name, so see how we can default */
1524 if (len && isIDFIRST_lazy(name)) {
1525 bool global = FALSE;
1533 if ((name[0] == 'I' && name[1] == 'N' && name[2] == 'C')
1534 || (name[0] == 'E' && name[1] == 'N' && name[2] == 'V')
1535 || (name[0] == 'S' && name[1] == 'I' && name[2] == 'G'))
1539 if (name[0] == 'A' && name[1] == 'R' && name[2] == 'G'
1544 if (name[0] == 'S' && name[1] == 'T' && name[2] == 'D'
1545 && name[3] == 'I' && name[4] == 'N')
1549 if ((name[0] == 'S' && name[1] == 'T' && name[2] == 'D')
1550 &&((name[3] == 'O' && name[4] == 'U' && name[5] == 'T')
1551 ||(name[3] == 'E' && name[4] == 'R' && name[5] == 'R')))
1555 if (name[0] == 'A' && name[1] == 'R' && name[2] == 'G'
1556 && name[3] == 'V' && name[4] == 'O' && name[5] == 'U'
1563 stash = PL_defstash;
1564 else if (IN_PERL_COMPILETIME) {
1565 stash = PL_curstash;
1566 if (add && (PL_hints & HINT_STRICT_VARS) &&
1567 sv_type != SVt_PVCV &&
1568 sv_type != SVt_PVGV &&
1569 sv_type != SVt_PVFM &&
1570 sv_type != SVt_PVIO &&
1571 !(len == 1 && sv_type == SVt_PV &&
1572 (*name == 'a' || *name == 'b')) )
1574 gvp = (GV**)hv_fetch(stash,name,is_utf8 ? -len : len,0);
1576 *gvp == (const GV *)&PL_sv_undef ||
1577 SvTYPE(*gvp) != SVt_PVGV)
1581 else if ((sv_type == SVt_PV && !GvIMPORTED_SV(*gvp)) ||
1582 (sv_type == SVt_PVAV && !GvIMPORTED_AV(*gvp)) ||
1583 (sv_type == SVt_PVHV && !GvIMPORTED_HV(*gvp)) )
1585 SV* namesv = newSVpvn_flags(name, len, SVs_TEMP | is_utf8);
1586 /* diag_listed_as: Variable "%s" is not imported%s */
1588 aTHX_ packWARN(WARN_MISC),
1589 "Variable \"%c%"SVf"\" is not imported",
1590 sv_type == SVt_PVAV ? '@' :
1591 sv_type == SVt_PVHV ? '%' : '$',
1595 aTHX_ packWARN(WARN_MISC),
1596 "\t(Did you mean &%"SVf" instead?)\n", SVfARG(namesv)
1603 stash = CopSTASH(PL_curcop);
1606 stash = PL_defstash;
1609 /* By this point we should have a stash and a name */
1613 SV * const err = Perl_mess(aTHX_
1614 "Global symbol \"%s%"SVf"\" requires explicit package name",
1615 (sv_type == SVt_PV ? "$"
1616 : sv_type == SVt_PVAV ? "@"
1617 : sv_type == SVt_PVHV ? "%"
1618 : ""), SVfARG(newSVpvn_flags(name, len, SVs_TEMP | is_utf8)));
1620 if (USE_UTF8_IN_NAMES)
1623 gv = gv_fetchpvs("<none>::", GV_ADDMULTI, SVt_PVHV);
1625 /* symbol table under destruction */
1634 if (!SvREFCNT(stash)) /* symbol table under destruction */
1637 gvp = (GV**)hv_fetch(stash,name,is_utf8 ? -len : len,add);
1638 if (!gvp || *gvp == (const GV *)&PL_sv_undef) {
1639 if (addmg) gv = (GV *)newSV(0);
1642 else gv = *gvp, addmg = 0;
1643 /* From this point on, addmg means gv has not been inserted in the
1646 if (SvTYPE(gv) == SVt_PVGV) {
1649 gv_init_svtype(gv, sv_type);
1650 if (len == 1 && stash == PL_defstash) {
1651 if (sv_type == SVt_PVHV || sv_type == SVt_PVGV) {
1653 require_tie_mod(gv, "!", newSVpvs("Errno"), "TIEHASH", 1);
1654 else if (*name == '-' || *name == '+')
1655 require_tie_mod(gv, name, newSVpvs("Tie::Hash::NamedCapture"), "TIEHASH", 0);
1657 if (sv_type==SVt_PV || sv_type==SVt_PVGV) {
1659 require_tie_mod(gv,name,newSVpvs("arybase"),"FETCH",0);
1660 else if (*name == '&' || *name == '`' || *name == '\'') {
1661 PL_sawampersand = TRUE;
1666 else if (len == 3 && sv_type == SVt_PVAV
1667 && strnEQ(name, "ISA", 3)
1668 && (!GvAV(gv) || !SvSMAGICAL(GvAV(gv))))
1669 gv_magicalize_isa(gv);
1672 } else if (no_init) {
1675 } else if (no_expand && SvROK(gv)) {
1680 /* Adding a new symbol.
1681 Unless of course there was already something non-GV here, in which case
1682 we want to behave as if there was always a GV here, containing some sort
1684 Otherwise we run the risk of creating things like GvIO, which can cause
1685 subtle bugs. eg the one that tripped up SQL::Translator */
1687 faking_it = SvOK(gv);
1689 if (add & GV_ADDWARN)
1690 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL), "Had to create %"SVf" unexpectedly",
1691 SVfARG(newSVpvn_flags(nambeg, name_end-nambeg, SVs_TEMP | is_utf8 )));
1692 gv_init_pvn(gv, stash, name, len, (add & GV_ADDMULTI)|is_utf8);
1694 if ( isIDFIRST_lazy_if(name, is_utf8)
1695 && ! (isLEXWARN_on ? ckWARN(WARN_ONCE) : (PL_dowarn & G_WARN_ON ) ) )
1698 /* set up magic where warranted */
1699 if (stash != PL_defstash) { /* not the main stash */
1700 /* We only have to check for three names here: EXPORT, ISA
1701 and VERSION. All the others apply only to the main stash or to
1702 CORE (which is checked right after this). */
1704 const char * const name2 = name + 1;
1707 if (strnEQ(name2, "XPORT", 5))
1711 if (strEQ(name2, "SA"))
1712 gv_magicalize_isa(gv);
1715 if (strEQ(name2, "ERSION"))
1721 goto add_magical_gv;
1724 if (len > 1 /* shortest is uc */ && HvNAMELEN_get(stash) == 4) {
1725 /* Avoid null warning: */
1726 const char * const stashname = HvNAME(stash); assert(stashname);
1727 if (strnEQ(stashname, "CORE", 4))
1728 S_maybe_add_coresub(aTHX_ 0, gv, name, len);
1735 /* Nothing else to do.
1736 The compiler will probably turn the switch statement into a
1737 branch table. Make sure we avoid even that small overhead for
1738 the common case of lower case variable names. */
1742 const char * const name2 = name + 1;
1745 if (strEQ(name2, "RGV")) {
1746 IoFLAGS(GvIOn(gv)) |= IOf_ARGV|IOf_START;
1748 else if (strEQ(name2, "RGVOUT")) {
1753 if (strnEQ(name2, "XPORT", 5))
1757 if (strEQ(name2, "SA")) {
1758 gv_magicalize_isa(gv);
1762 if (strEQ(name2, "IG")) {
1765 if (!PL_psig_name) {
1766 Newxz(PL_psig_name, 2 * SIG_SIZE, SV*);
1767 Newxz(PL_psig_pend, SIG_SIZE, int);
1768 PL_psig_ptr = PL_psig_name + SIG_SIZE;
1770 /* I think that the only way to get here is to re-use an
1771 embedded perl interpreter, where the previous
1772 use didn't clean up fully because
1773 PL_perl_destruct_level was 0. I'm not sure that we
1774 "support" that, in that I suspect in that scenario
1775 there are sufficient other garbage values left in the
1776 interpreter structure that something else will crash
1777 before we get here. I suspect that this is one of
1778 those "doctor, it hurts when I do this" bugs. */
1779 Zero(PL_psig_name, 2 * SIG_SIZE, SV*);
1780 Zero(PL_psig_pend, SIG_SIZE, int);
1784 hv_magic(hv, NULL, PERL_MAGIC_sig);
1785 for (i = 1; i < SIG_SIZE; i++) {
1786 SV * const * const init = hv_fetch(hv, PL_sig_name[i], strlen(PL_sig_name[i]), 1);
1788 sv_setsv(*init, &PL_sv_undef);
1793 if (strEQ(name2, "ERSION"))
1796 case '\003': /* $^CHILD_ERROR_NATIVE */
1797 if (strEQ(name2, "HILD_ERROR_NATIVE"))
1800 case '\005': /* $^ENCODING */
1801 if (strEQ(name2, "NCODING"))
1804 case '\007': /* $^GLOBAL_PHASE */
1805 if (strEQ(name2, "LOBAL_PHASE"))
1808 case '\015': /* $^MATCH */
1809 if (strEQ(name2, "ATCH"))
1811 case '\017': /* $^OPEN */
1812 if (strEQ(name2, "PEN"))
1815 case '\020': /* $^PREMATCH $^POSTMATCH */
1816 if (strEQ(name2, "REMATCH") || strEQ(name2, "OSTMATCH"))
1819 case '\024': /* ${^TAINT} */
1820 if (strEQ(name2, "AINT"))
1823 case '\025': /* ${^UNICODE}, ${^UTF8LOCALE} */
1824 if (strEQ(name2, "NICODE"))
1826 if (strEQ(name2, "TF8LOCALE"))
1828 if (strEQ(name2, "TF8CACHE"))
1831 case '\027': /* $^WARNING_BITS */
1832 if (strEQ(name2, "ARNING_BITS"))
1845 /* Ensures that we have an all-digit variable, ${"1foo"} fails
1847 /* This snippet is taken from is_gv_magical */
1848 const char *end = name + len;
1849 while (--end > name) {
1850 if (!isDIGIT(*end)) goto add_magical_gv;
1857 /* Names of length 1. (Or 0. But name is NUL terminated, so that will
1858 be case '\0' in this switch statement (ie a default case) */
1864 sv_type == SVt_PVAV ||
1865 sv_type == SVt_PVHV ||
1866 sv_type == SVt_PVCV ||
1867 sv_type == SVt_PVFM ||
1869 )) { PL_sawampersand = TRUE; }
1873 sv_setpv(GvSVn(gv),PL_chopset);
1877 #ifdef COMPLEX_STATUS
1878 SvUPGRADE(GvSVn(gv), SVt_PVLV);
1884 /* If %! has been used, automatically load Errno.pm. */
1886 sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
1888 /* magicalization must be done before require_tie_mod is called */
1889 if (sv_type == SVt_PVHV || sv_type == SVt_PVGV)
1891 if (addmg) (void)hv_store(stash,name,len,(SV *)gv,0);
1893 require_tie_mod(gv, "!", newSVpvs("Errno"), "TIEHASH", 1);
1899 GvMULTI_on(gv); /* no used once warnings here */
1901 AV* const av = GvAVn(gv);
1902 SV* const avc = (*name == '+') ? MUTABLE_SV(av) : NULL;
1904 sv_magic(MUTABLE_SV(av), avc, PERL_MAGIC_regdata, NULL, 0);
1905 sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
1907 SvREADONLY_on(GvSVn(gv));
1910 if (sv_type == SVt_PVHV || sv_type == SVt_PVGV)
1912 if (addmg) (void)hv_store(stash,name,len,(SV *)gv,0);
1914 require_tie_mod(gv, name, newSVpvs("Tie::Hash::NamedCapture"), "TIEHASH", 0);
1921 if (sv_type == SVt_PV)
1922 /* diag_listed_as: $* is no longer supported */
1923 Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_SYNTAX),
1924 "$%c is no longer supported", *name);
1927 sv_setiv(GvSVn(gv), (IV)(IoFLAGS(GvIOp(PL_defoutgv)) & IOf_FLUSH) != 0);
1930 case '\010': /* $^H */
1932 HV *const hv = GvHVn(gv);
1933 hv_magic(hv, NULL, PERL_MAGIC_hints);
1937 if ((sv_type == SVt_PV || sv_type == SVt_PVGV)
1938 && FEATURE_ARYBASE_IS_ENABLED) {
1939 if (addmg) (void)hv_store(stash,name,len,(SV *)gv,0);
1940 require_tie_mod(gv,name,newSVpvs("arybase"),"FETCH",0);
1943 else goto magicalize;
1945 case '\023': /* $^S */
1947 SvREADONLY_on(GvSVn(gv));
1971 case '\001': /* $^A */
1972 case '\003': /* $^C */
1973 case '\004': /* $^D */
1974 case '\005': /* $^E */
1975 case '\006': /* $^F */
1976 case '\011': /* $^I, NOT \t in EBCDIC */
1977 case '\016': /* $^N */
1978 case '\017': /* $^O */
1979 case '\020': /* $^P */
1980 case '\024': /* $^T */
1981 case '\027': /* $^W */
1983 sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
1986 case '\014': /* $^L */
1987 sv_setpvs(GvSVn(gv),"\f");
1988 PL_formfeed = GvSV(gv);
1991 sv_setpvs(GvSVn(gv),"\034");
1995 SV * const sv = GvSV(gv);
1996 if (!sv_derived_from(PL_patchlevel, "version"))
1997 upg_version(PL_patchlevel, TRUE);
1998 GvSV(gv) = vnumify(PL_patchlevel);
1999 SvREADONLY_on(GvSV(gv));
2003 case '\026': /* $^V */
2005 SV * const sv = GvSV(gv);
2006 GvSV(gv) = new_version(PL_patchlevel);
2007 SvREADONLY_on(GvSV(gv));
2015 if (GvAV(gv) || GvHV(gv) || GvIO(gv) || GvCV(gv) || (
2016 GvSV(gv) && (SvOK(GvSV(gv)) || SvMAGICAL(GvSV(gv)))
2018 (void)hv_store(stash,name,len,(SV *)gv,0);
2019 else SvREFCNT_dec(gv), gv = NULL;
2021 if (gv) gv_init_svtype(gv, faking_it ? SVt_PVCV : sv_type);
2026 Perl_gv_fullname4(pTHX_ SV *sv, const GV *gv, const char *prefix, bool keepmain)
2029 const HV * const hv = GvSTASH(gv);
2031 PERL_ARGS_ASSERT_GV_FULLNAME4;
2033 sv_setpv(sv, prefix ? prefix : "");
2035 if (hv && (name = HvNAME(hv))) {
2036 const STRLEN len = HvNAMELEN(hv);
2037 if (keepmain || strnNE(name, "main", len)) {
2038 sv_catpvn_flags(sv,name,len,HvNAMEUTF8(hv)?SV_CATUTF8:SV_CATBYTES);
2042 else sv_catpvs(sv,"__ANON__::");
2043 sv_catsv(sv,sv_2mortal(newSVhek(GvNAME_HEK(gv))));
2047 Perl_gv_efullname4(pTHX_ SV *sv, const GV *gv, const char *prefix, bool keepmain)
2049 const GV * const egv = GvEGVx(gv);
2051 PERL_ARGS_ASSERT_GV_EFULLNAME4;
2053 gv_fullname4(sv, egv ? egv : gv, prefix, keepmain);
2057 Perl_gv_check(pTHX_ const HV *stash)
2062 PERL_ARGS_ASSERT_GV_CHECK;
2064 if (!HvARRAY(stash))
2066 for (i = 0; i <= (I32) HvMAX(stash); i++) {
2068 for (entry = HvARRAY(stash)[i]; entry; entry = HeNEXT(entry)) {
2071 if (HeKEY(entry)[HeKLEN(entry)-1] == ':' &&
2072 (gv = MUTABLE_GV(HeVAL(entry))) && isGV(gv) && (hv = GvHV(gv)))
2074 if (hv != PL_defstash && hv != stash)
2075 gv_check(hv); /* nested package */
2077 else if ( *HeKEY(entry) != '_'
2078 && isIDFIRST_lazy_if(HeKEY(entry), HeUTF8(entry)) ) {
2080 gv = MUTABLE_GV(HeVAL(entry));
2081 if (SvTYPE(gv) != SVt_PVGV || GvMULTI(gv))
2084 CopLINE_set(PL_curcop, GvLINE(gv));
2086 CopFILE(PL_curcop) = (char *)file; /* set for warning */
2088 CopFILEGV(PL_curcop)
2089 = gv_fetchfile_flags(file, HEK_LEN(GvFILE_HEK(gv)), 0);
2091 Perl_warner(aTHX_ packWARN(WARN_ONCE),
2092 "Name \"%"HEKf"::%"HEKf
2093 "\" used only once: possible typo",
2094 HEKfARG(HvNAME_HEK(stash)),
2095 HEKfARG(GvNAME_HEK(gv)));
2102 Perl_newGVgen_flags(pTHX_ const char *pack, U32 flags)
2105 PERL_ARGS_ASSERT_NEWGVGEN_FLAGS;
2107 return gv_fetchpv(Perl_form(aTHX_ "%"SVf"::_GEN_%ld",
2108 SVfARG(newSVpvn_flags(pack, strlen(pack),
2114 /* hopefully this is only called on local symbol table entries */
2117 Perl_gp_ref(pTHX_ GP *gp)
2125 /* If the GP they asked for a reference to contains
2126 a method cache entry, clear it first, so that we
2127 don't infect them with our cached entry */
2128 SvREFCNT_dec(gp->gp_cv);
2137 Perl_gp_free(pTHX_ GV *gv)
2143 if (!gv || !isGV_with_GP(gv) || !(gp = GvGP(gv)))
2145 if (gp->gp_refcnt == 0) {
2146 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
2147 "Attempt to free unreferenced glob pointers"
2148 pTHX__FORMAT pTHX__VALUE);
2151 if (--gp->gp_refcnt > 0) {
2152 if (gp->gp_egv == gv)
2159 /* Copy and null out all the glob slots, so destructors do not see
2161 HEK * const file_hek = gp->gp_file_hek;
2162 SV * const sv = gp->gp_sv;
2163 AV * const av = gp->gp_av;
2164 HV * const hv = gp->gp_hv;
2165 IO * const io = gp->gp_io;
2166 CV * const cv = gp->gp_cv;
2167 CV * const form = gp->gp_form;
2169 gp->gp_file_hek = NULL;
2178 unshare_hek(file_hek);
2182 /* FIXME - another reference loop GV -> symtab -> GV ?
2183 Somehow gp->gp_hv can end up pointing at freed garbage. */
2184 if (hv && SvTYPE(hv) == SVt_PVHV) {
2185 const HEK *hvname_hek = HvNAME_HEK(hv);
2186 if (PL_stashcache && hvname_hek)
2187 (void)hv_delete(PL_stashcache, HEK_KEY(hvname_hek),
2188 (HEK_UTF8(hvname_hek) ? -HEK_LEN(hvname_hek) : HEK_LEN(hvname_hek)),
2196 if (!gp->gp_file_hek
2202 && !gp->gp_form) break;
2204 if (--attempts == 0) {
2206 "panic: gp_free failed to free glob pointer - "
2207 "something is repeatedly re-creating entries"
2217 Perl_magic_freeovrld(pTHX_ SV *sv, MAGIC *mg)
2219 AMT * const amtp = (AMT*)mg->mg_ptr;
2220 PERL_UNUSED_ARG(sv);
2222 PERL_ARGS_ASSERT_MAGIC_FREEOVRLD;
2224 if (amtp && AMT_AMAGIC(amtp)) {
2226 for (i = 1; i < NofAMmeth; i++) {
2227 CV * const cv = amtp->table[i];
2229 SvREFCNT_dec(MUTABLE_SV(cv));
2230 amtp->table[i] = NULL;
2237 /* Updates and caches the CV's */
2239 * 1 on success and there is some overload
2240 * 0 if there is no overload
2241 * -1 if some error occurred and it couldn't croak
2245 Perl_Gv_AMupdate(pTHX_ HV *stash, bool destructing)
2248 MAGIC* const mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
2250 const struct mro_meta* stash_meta = HvMROMETA(stash);
2253 PERL_ARGS_ASSERT_GV_AMUPDATE;
2255 newgen = PL_sub_generation + stash_meta->pkg_gen + stash_meta->cache_gen;
2257 const AMT * const amtp = (AMT*)mg->mg_ptr;
2258 if (amtp->was_ok_sub == newgen) {
2259 return AMT_OVERLOADED(amtp) ? 1 : 0;
2261 sv_unmagic(MUTABLE_SV(stash), PERL_MAGIC_overload_table);
2264 DEBUG_o( Perl_deb(aTHX_ "Recalcing overload magic in package %s\n",HvNAME_get(stash)) );
2267 amt.was_ok_sub = newgen;
2268 amt.fallback = AMGfallNO;
2272 int filled = 0, have_ovl = 0;
2275 /* Work with "fallback" key, which we assume to be first in PL_AMG_names */
2277 /* Try to find via inheritance. */
2278 GV *gv = gv_fetchmeth_pvn(stash, PL_AMG_names[0], 2, -1, 0);
2279 SV * const sv = gv ? GvSV(gv) : NULL;
2284 if (!gv_fetchmeth_pvn(stash, "((", 2, -1, 0))
2285 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 /* don't need to set overloading here because fallback => 1
2294 * is the default setting for classes without overloading */
2295 amt.fallback=AMGfallYES;
2296 else if (SvOK(sv)) {
2297 amt.fallback=AMGfallNEVER;
2306 for (i = 1; i < lim; i++)
2307 amt.table[i] = NULL;
2308 for (; i < NofAMmeth; i++) {
2309 const char * const cooky = PL_AMG_names[i];
2310 /* Human-readable form, for debugging: */
2311 const char * const cp = (i >= DESTROY_amg ? cooky : AMG_id2name(i));
2312 const STRLEN l = PL_AMG_namelens[i];
2314 DEBUG_o( Perl_deb(aTHX_ "Checking overloading of \"%s\" in package \"%.256s\"\n",
2315 cp, HvNAME_get(stash)) );
2316 /* don't fill the cache while looking up!
2317 Creation of inheritance stubs in intermediate packages may
2318 conflict with the logic of runtime method substitution.
2319 Indeed, for inheritance A -> B -> C, if C overloads "+0",
2320 then we could have created stubs for "(+0" in A and C too.
2321 But if B overloads "bool", we may want to use it for
2322 numifying instead of C's "+0". */
2323 if (i >= DESTROY_amg)
2324 gv = Perl_gv_fetchmeth_pvn_autoload(aTHX_ stash, cooky, l, 0, 0);
2325 else /* Autoload taken care of below */
2326 gv = Perl_gv_fetchmeth_pvn(aTHX_ stash, cooky, l, -1, 0);
2328 if (gv && (cv = GvCV(gv))) {
2329 if(GvNAMELEN(CvGV(cv)) == 3 && strEQ(GvNAME(CvGV(cv)), "nil")){
2330 const char * const hvname = HvNAME_get(GvSTASH(CvGV(cv)));
2331 if (hvname && HEK_LEN(HvNAME_HEK(GvSTASH(CvGV(cv)))) == 8
2332 && strEQ(hvname, "overload")) {
2333 /* This is a hack to support autoloading..., while
2334 knowing *which* methods were declared as overloaded. */
2335 /* GvSV contains the name of the method. */
2337 SV *gvsv = GvSV(gv);
2339 DEBUG_o( Perl_deb(aTHX_ "Resolving method \"%"SVf256\
2340 "\" for overloaded \"%s\" in package \"%.256s\"\n",
2341 (void*)GvSV(gv), cp, HvNAME(stash)) );
2342 if (!gvsv || !SvPOK(gvsv)
2343 || !(ngv = gv_fetchmethod_sv_flags(stash, gvsv, 0)))
2345 /* Can be an import stub (created by "can"). */
2350 const SV * const name = (gvsv && SvPOK(gvsv))
2352 : newSVpvs_flags("???", SVs_TEMP);
2353 /* diag_listed_as: Can't resolve method "%s" overloading "%s" in package "%s" */
2354 Perl_croak(aTHX_ "%s method \"%"SVf256
2355 "\" overloading \"%s\" "\
2356 "in package \"%"HEKf256"\"",
2357 (GvCVGEN(gv) ? "Stub found while resolving"
2365 cv = GvCV(gv = ngv);
2368 DEBUG_o( Perl_deb(aTHX_ "Overloading \"%s\" in package \"%.256s\" via \"%.256s::%.256s\"\n",
2369 cp, HvNAME_get(stash), HvNAME_get(GvSTASH(CvGV(cv))),
2370 GvNAME(CvGV(cv))) );
2372 if (i < DESTROY_amg)
2374 } else if (gv) { /* Autoloaded... */
2375 cv = MUTABLE_CV(gv);
2378 amt.table[i]=MUTABLE_CV(SvREFCNT_inc_simple(cv));
2381 AMT_AMAGIC_on(&amt);
2383 AMT_OVERLOADED_on(&amt);
2384 sv_magic(MUTABLE_SV(stash), 0, PERL_MAGIC_overload_table,
2385 (char*)&amt, sizeof(AMT));
2389 /* Here we have no table: */
2391 AMT_AMAGIC_off(&amt);
2392 sv_magic(MUTABLE_SV(stash), 0, PERL_MAGIC_overload_table,
2393 (char*)&amt, sizeof(AMTS));
2399 Perl_gv_handler(pTHX_ HV *stash, I32 id)
2405 struct mro_meta* stash_meta;
2407 if (!stash || !HvNAME_get(stash))
2410 stash_meta = HvMROMETA(stash);
2411 newgen = PL_sub_generation + stash_meta->pkg_gen + stash_meta->cache_gen;
2413 mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
2416 /* If we're looking up a destructor to invoke, we must avoid
2417 * that Gv_AMupdate croaks, because we might be dying already */
2418 if (Gv_AMupdate(stash, cBOOL(id == DESTROY_amg)) == -1) {
2419 /* and if it didn't found a destructor, we fall back
2420 * to a simpler method that will only look for the
2421 * destructor instead of the whole magic */
2422 if (id == DESTROY_amg) {
2423 GV * const gv = gv_fetchmethod(stash, "DESTROY");
2429 mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
2432 amtp = (AMT*)mg->mg_ptr;
2433 if ( amtp->was_ok_sub != newgen )
2435 if (AMT_AMAGIC(amtp)) {
2436 CV * const ret = amtp->table[id];
2437 if (ret && isGV(ret)) { /* Autoloading stab */
2438 /* Passing it through may have resulted in a warning
2439 "Inherited AUTOLOAD for a non-method deprecated", since
2440 our caller is going through a function call, not a method call.
2441 So return the CV for AUTOLOAD, setting $AUTOLOAD. */
2442 GV * const gv = gv_fetchmethod(stash, PL_AMG_names[id]);
2454 /* Implement tryAMAGICun_MG macro.
2455 Do get magic, then see if the stack arg is overloaded and if so call it.
2457 AMGf_set return the arg using SETs rather than assigning to
2459 AMGf_numeric apply sv_2num to the stack arg.
2463 Perl_try_amagic_un(pTHX_ int method, int flags) {
2467 SV* const arg = TOPs;
2471 if (SvAMAGIC(arg) && (tmpsv = amagic_call(arg, &PL_sv_undef, method,
2472 AMGf_noright | AMGf_unary))) {
2473 if (flags & AMGf_set) {
2478 if (SvPADMY(TARG)) {
2479 sv_setsv(TARG, tmpsv);
2489 if ((flags & AMGf_numeric) && SvROK(arg))
2495 /* Implement tryAMAGICbin_MG macro.
2496 Do get magic, then see if the two stack args are overloaded and if so
2499 AMGf_set return the arg using SETs rather than assigning to
2501 AMGf_assign op may be called as mutator (eg +=)
2502 AMGf_numeric apply sv_2num to the stack arg.
2506 Perl_try_amagic_bin(pTHX_ int method, int flags) {
2509 SV* const left = TOPm1s;
2510 SV* const right = TOPs;
2516 if (SvAMAGIC(left) || SvAMAGIC(right)) {
2517 SV * const tmpsv = amagic_call(left, right, method,
2518 ((flags & AMGf_assign) && opASSIGN ? AMGf_assign: 0));
2520 if (flags & AMGf_set) {
2527 if (opASSIGN || SvPADMY(TARG)) {
2528 sv_setsv(TARG, tmpsv);
2538 if(left==right && SvGMAGICAL(left)) {
2539 SV * const left = sv_newmortal();
2541 /* Print the uninitialized warning now, so it includes the vari-
2544 if (ckWARN(WARN_UNINITIALIZED)) report_uninit(right);
2545 sv_setsv_flags(left, &PL_sv_no, 0);
2547 else sv_setsv_flags(left, right, 0);
2550 if (flags & AMGf_numeric) {
2552 *(sp-1) = sv_2num(TOPm1s);
2554 *sp = sv_2num(right);
2560 Perl_amagic_deref_call(pTHX_ SV *ref, int method) {
2563 PERL_ARGS_ASSERT_AMAGIC_DEREF_CALL;
2565 while (SvAMAGIC(ref) &&
2566 (tmpsv = amagic_call(ref, &PL_sv_undef, method,
2567 AMGf_noright | AMGf_unary))) {
2569 Perl_croak(aTHX_ "Overloaded dereference did not return a reference");
2570 if (tmpsv == ref || SvRV(tmpsv) == SvRV(ref)) {
2571 /* Bail out if it returns us the same reference. */
2576 return tmpsv ? tmpsv : ref;
2580 Perl_amagic_is_enabled(pTHX_ int method)
2582 SV *lex_mask = cop_hints_fetch_pvs(PL_curcop, "overloading", 0);
2584 assert(PL_curcop->cop_hints & HINT_NO_AMAGIC);
2586 if ( !lex_mask || !SvOK(lex_mask) )
2587 /* overloading lexically disabled */
2589 else if ( lex_mask && SvPOK(lex_mask) ) {
2590 /* we have an entry in the hints hash, check if method has been
2591 * masked by overloading.pm */
2593 const int offset = method / 8;
2594 const int bit = method % 8;
2595 char *pv = SvPV(lex_mask, len);
2597 /* Bit set, so this overloading operator is disabled */
2598 if ( (STRLEN)offset < len && pv[offset] & ( 1 << bit ) )
2605 Perl_amagic_call(pTHX_ SV *left, SV *right, int method, int flags)
2610 CV **cvp=NULL, **ocvp=NULL;
2611 AMT *amtp=NULL, *oamtp=NULL;
2612 int off = 0, off1, lr = 0, notfound = 0;
2613 int postpr = 0, force_cpy = 0;
2614 int assign = AMGf_assign & flags;
2615 const int assignshift = assign ? 1 : 0;
2616 int use_default_op = 0;
2617 int force_scalar = 0;
2623 PERL_ARGS_ASSERT_AMAGIC_CALL;
2625 if ( PL_curcop->cop_hints & HINT_NO_AMAGIC ) {
2626 if (!amagic_is_enabled(method)) return NULL;
2629 if (!(AMGf_noleft & flags) && SvAMAGIC(left)
2630 && (stash = SvSTASH(SvRV(left))) && Gv_AMG(stash)
2631 && (mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table))
2632 && (ocvp = cvp = (AMT_AMAGIC((AMT*)mg->mg_ptr)
2633 ? (oamtp = amtp = (AMT*)mg->mg_ptr)->table
2635 && ((cv = cvp[off=method+assignshift])
2636 || (assign && amtp->fallback > AMGfallNEVER && /* fallback to
2642 cv = cvp[off=method])))) {
2643 lr = -1; /* Call method for left argument */
2645 if (cvp && amtp->fallback > AMGfallNEVER && flags & AMGf_unary) {
2648 /* look for substituted methods */
2649 /* In all the covered cases we should be called with assign==0. */
2653 if ((cv = cvp[off=add_ass_amg])
2654 || ((cv = cvp[off = add_amg]) && (force_cpy = 0, postpr = 1))) {
2655 right = &PL_sv_yes; lr = -1; assign = 1;
2660 if ((cv = cvp[off = subtr_ass_amg])
2661 || ((cv = cvp[off = subtr_amg]) && (force_cpy = 0, postpr=1))) {
2662 right = &PL_sv_yes; lr = -1; assign = 1;
2666 (void)((cv = cvp[off=numer_amg]) || (cv = cvp[off=string_amg]));
2669 (void)((cv = cvp[off=string_amg]) || (cv = cvp[off=bool__amg]));
2672 (void)((cv = cvp[off=numer_amg]) || (cv = cvp[off=bool__amg]));
2675 (void)((cv = cvp[off=bool__amg])
2676 || (cv = cvp[off=numer_amg])
2677 || (cv = cvp[off=string_amg]));
2684 * SV* ref causes confusion with the interpreter variable of
2687 SV* const tmpRef=SvRV(left);
2688 if (!SvROK(tmpRef) && SvTYPE(tmpRef) <= SVt_PVMG) {
2690 * Just to be extra cautious. Maybe in some
2691 * additional cases sv_setsv is safe, too.
2693 SV* const newref = newSVsv(tmpRef);
2694 SvOBJECT_on(newref);
2695 /* No need to do SvAMAGIC_on here, as SvAMAGIC macros
2696 delegate to the stash. */
2697 SvSTASH_set(newref, MUTABLE_HV(SvREFCNT_inc(SvSTASH(tmpRef))));
2703 if ((cvp[off1=lt_amg] || cvp[off1=ncmp_amg])
2704 && ((cv = cvp[off=neg_amg]) || (cv = cvp[off=subtr_amg]))) {
2705 SV* const nullsv=sv_2mortal(newSViv(0));
2707 SV* const lessp = amagic_call(left,nullsv,
2708 lt_amg,AMGf_noright);
2709 logic = SvTRUE(lessp);
2711 SV* const lessp = amagic_call(left,nullsv,
2712 ncmp_amg,AMGf_noright);
2713 logic = (SvNV(lessp) < 0);
2716 if (off==subtr_amg) {
2727 if ((cv = cvp[off=subtr_amg])) {
2729 left = sv_2mortal(newSViv(0));
2734 case iter_amg: /* XXXX Eventually should do to_gv. */
2735 case ftest_amg: /* XXXX Eventually should do to_gv. */
2738 return NULL; /* Delegate operation to standard mechanisms. */
2746 return left; /* Delegate operation to standard mechanisms. */
2751 if (!cv) goto not_found;
2752 } else if (!(AMGf_noright & flags) && SvAMAGIC(right)
2753 && (stash = SvSTASH(SvRV(right))) && Gv_AMG(stash)
2754 && (mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table))
2755 && (cvp = (AMT_AMAGIC((AMT*)mg->mg_ptr)
2756 ? (amtp = (AMT*)mg->mg_ptr)->table
2758 && ((cv = cvp[off=method+assignshift])
2759 || (assign && amtp->fallback > AMGfallNEVER && /* fallback to
2765 cv = cvp[off=method])))) { /* Method for right
2768 } else if (((cvp && amtp->fallback > AMGfallNEVER)
2769 || (ocvp && oamtp->fallback > AMGfallNEVER))
2770 && !(flags & AMGf_unary)) {
2771 /* We look for substitution for
2772 * comparison operations and
2774 if (method==concat_amg || method==concat_ass_amg
2775 || method==repeat_amg || method==repeat_ass_amg) {
2776 return NULL; /* Delegate operation to string conversion */
2798 if (ocvp && (oamtp->fallback > AMGfallNEVER)) {
2802 if (!cv && (cvp && amtp->fallback > AMGfallNEVER)) {
2812 not_found: /* No method found, either report or croak */
2820 return left; /* Delegate operation to standard mechanisms. */
2823 if (ocvp && (cv=ocvp[nomethod_amg])) { /* Call report method */
2824 notfound = 1; lr = -1;
2825 } else if (cvp && (cv=cvp[nomethod_amg])) {
2826 notfound = 1; lr = 1;
2827 } else if ((use_default_op =
2828 (!ocvp || oamtp->fallback >= AMGfallYES)
2829 && (!cvp || amtp->fallback >= AMGfallYES))
2831 /* Skip generating the "no method found" message. */
2835 if (off==-1) off=method;
2836 msg = sv_2mortal(Perl_newSVpvf(aTHX_
2837 "Operation \"%s\": no method found,%sargument %s%"SVf"%s%"SVf,
2838 AMG_id2name(method + assignshift),
2839 (flags & AMGf_unary ? " " : "\n\tleft "),
2841 "in overloaded package ":
2842 "has no overloaded magic",
2844 SVfARG(sv_2mortal(newSVhek(HvNAME_HEK(SvSTASH(SvRV(left)))))):
2847 ",\n\tright argument in overloaded package ":
2850 : ",\n\tright argument has no overloaded magic"),
2852 SVfARG(sv_2mortal(newSVhek(HvNAME_HEK(SvSTASH(SvRV(right)))))):
2853 SVfARG(&PL_sv_no)));
2854 if (use_default_op) {
2855 DEBUG_o( Perl_deb(aTHX_ "%"SVf, SVfARG(msg)) );
2857 Perl_croak(aTHX_ "%"SVf, SVfARG(msg));
2861 force_cpy = force_cpy || assign;
2866 /* in these cases, we're calling '+' or '-' as a fallback for a ++ or --
2867 * operation. we need this to return a value, so that it can be assigned
2868 * later on, in the postpr block (case inc_amg/dec_amg), even if the
2869 * increment or decrement was itself called in void context */
2875 if (off == subtr_amg)
2878 /* in these cases, we're calling an assignment variant of an operator
2879 * (+= rather than +, for instance). regardless of whether it's a
2880 * fallback or not, it always has to return a value, which will be
2881 * assigned to the proper variable later */
2898 /* the copy constructor always needs to return a value */
2902 /* because of the way these are implemented (they don't perform the
2903 * dereferencing themselves, they return a reference that perl then
2904 * dereferences later), they always have to be in scalar context */
2912 /* these don't have an op of their own; they're triggered by their parent
2913 * op, so the context there isn't meaningful ('$a and foo()' in void
2914 * context still needs to pass scalar context on to $a's bool overload) */
2924 DEBUG_o(Perl_deb(aTHX_
2925 "Overloaded operator \"%s\"%s%s%s:\n\tmethod%s found%s in package %"SVf"%s\n",
2927 method+assignshift==off? "" :
2929 method+assignshift==off? "" :
2930 AMG_id2name(method+assignshift),
2931 method+assignshift==off? "" : "\")",
2932 flags & AMGf_unary? "" :
2933 lr==1 ? " for right argument": " for left argument",
2934 flags & AMGf_unary? " for argument" : "",
2935 stash ? SVfARG(sv_2mortal(newSVhek(HvNAME_HEK(stash)))) : SVfARG(newSVpvs_flags("null", SVs_TEMP)),
2936 fl? ",\n\tassignment variant used": "") );
2939 /* Since we use shallow copy during assignment, we need
2940 * to dublicate the contents, probably calling user-supplied
2941 * version of copy operator
2943 /* We need to copy in following cases:
2944 * a) Assignment form was called.
2945 * assignshift==1, assign==T, method + 1 == off
2946 * b) Increment or decrement, called directly.
2947 * assignshift==0, assign==0, method + 0 == off
2948 * c) Increment or decrement, translated to assignment add/subtr.
2949 * assignshift==0, assign==T,
2951 * d) Increment or decrement, translated to nomethod.
2952 * assignshift==0, assign==0,
2954 * e) Assignment form translated to nomethod.
2955 * assignshift==1, assign==T, method + 1 != off
2958 /* off is method, method+assignshift, or a result of opcode substitution.
2959 * In the latter case assignshift==0, so only notfound case is important.
2961 if ( (lr == -1) && ( ( (method + assignshift == off)
2962 && (assign || (method == inc_amg) || (method == dec_amg)))
2965 /* newSVsv does not behave as advertised, so we copy missing
2966 * information by hand */
2967 SV *tmpRef = SvRV(left);
2969 if (SvREFCNT(tmpRef) > 1 && (rv_copy = AMG_CALLunary(left,copy_amg))) {
2970 SvRV_set(left, rv_copy);
2972 SvREFCNT_dec(tmpRef);
2980 const bool oldcatch = CATCH_GET;
2982 int gimme = force_scalar ? G_SCALAR : GIMME_V;
2985 Zero(&myop, 1, BINOP);
2986 myop.op_last = (OP *) &myop;
2987 myop.op_next = NULL;
2988 myop.op_flags = OPf_STACKED;
2992 myop.op_flags |= OPf_WANT_VOID;
2995 if (flags & AMGf_want_list) {
2996 myop.op_flags |= OPf_WANT_LIST;
3001 myop.op_flags |= OPf_WANT_SCALAR;
3005 PUSHSTACKi(PERLSI_OVERLOAD);
3008 PL_op = (OP *) &myop;
3009 if (PERLDB_SUB && PL_curstash != PL_debstash)
3010 PL_op->op_private |= OPpENTERSUB_DB;
3012 Perl_pp_pushmark(aTHX);
3014 EXTEND(SP, notfound + 5);
3015 PUSHs(lr>0? right: left);
3016 PUSHs(lr>0? left: right);
3017 PUSHs( lr > 0 ? &PL_sv_yes : ( assign ? &PL_sv_undef : &PL_sv_no ));
3019 PUSHs(newSVpvn_flags(AMG_id2name(method + assignshift),
3020 AMG_id2namelen(method + assignshift), SVs_TEMP));
3022 PUSHs(MUTABLE_SV(cv));
3026 if ((PL_op = PL_ppaddr[OP_ENTERSUB](aTHX)))
3030 nret = SP - (PL_stack_base + oldmark);
3034 /* returning NULL has another meaning, and we check the context
3035 * at the call site too, so this can be differentiated from the
3038 SP = PL_stack_base + oldmark;
3041 if (flags & AMGf_want_list) {
3042 res = sv_2mortal((SV *)newAV());
3043 av_extend((AV *)res, nret);
3045 av_store((AV *)res, nret, POPs);
3057 CATCH_SET(oldcatch);
3064 ans=SvIV(res)<=0; break;
3067 ans=SvIV(res)<0; break;
3070 ans=SvIV(res)>=0; break;
3073 ans=SvIV(res)>0; break;
3076 ans=SvIV(res)==0; break;
3079 ans=SvIV(res)!=0; break;
3082 SvSetSV(left,res); return left;
3084 ans=!SvTRUE(res); break;
3089 } else if (method==copy_amg) {
3091 Perl_croak(aTHX_ "Copy method did not return a reference");
3093 return SvREFCNT_inc(SvRV(res));
3101 Perl_gv_name_set(pTHX_ GV *gv, const char *name, U32 len, U32 flags)
3106 PERL_ARGS_ASSERT_GV_NAME_SET;
3109 Perl_croak(aTHX_ "panic: gv name too long (%"UVuf")", (UV) len);
3111 if (!(flags & GV_ADD) && GvNAME_HEK(gv)) {
3112 unshare_hek(GvNAME_HEK(gv));
3115 PERL_HASH(hash, name, len);
3116 GvNAME_HEK(gv) = share_hek(name, (flags & SVf_UTF8 ? -(I32)len : (I32)len), hash);
3120 =for apidoc gv_try_downgrade
3122 If the typeglob C<gv> can be expressed more succinctly, by having
3123 something other than a real GV in its place in the stash, replace it
3124 with the optimised form. Basic requirements for this are that C<gv>
3125 is a real typeglob, is sufficiently ordinary, and is only referenced
3126 from its package. This function is meant to be used when a GV has been
3127 looked up in part to see what was there, causing upgrading, but based
3128 on what was found it turns out that the real GV isn't required after all.
3130 If C<gv> is a completely empty typeglob, it is deleted from the stash.
3132 If C<gv> is a typeglob containing only a sufficiently-ordinary constant
3133 sub, the typeglob is replaced with a scalar-reference placeholder that
3134 more compactly represents the same thing.
3140 Perl_gv_try_downgrade(pTHX_ GV *gv)
3146 PERL_ARGS_ASSERT_GV_TRY_DOWNGRADE;
3148 /* XXX Why and where does this leave dangling pointers during global
3150 if (PL_phase == PERL_PHASE_DESTRUCT) return;
3152 if (!(SvREFCNT(gv) == 1 && SvTYPE(gv) == SVt_PVGV && !SvFAKE(gv) &&
3153 !SvOBJECT(gv) && !SvREADONLY(gv) &&
3154 isGV_with_GP(gv) && GvGP(gv) &&
3155 !GvINTRO(gv) && GvREFCNT(gv) == 1 &&
3156 !GvSV(gv) && !GvAV(gv) && !GvHV(gv) && !GvIOp(gv) && !GvFORM(gv) &&
3157 GvEGVx(gv) == gv && (stash = GvSTASH(gv))))
3159 if (SvMAGICAL(gv)) {
3161 /* only backref magic is allowed */
3162 if (SvGMAGICAL(gv) || SvSMAGICAL(gv))
3164 for (mg = SvMAGIC(gv); mg; mg = mg->mg_moremagic) {
3165 if (mg->mg_type != PERL_MAGIC_backref)
3171 HEK *gvnhek = GvNAME_HEK(gv);
3172 (void)hv_delete(stash, HEK_KEY(gvnhek),
3173 HEK_UTF8(gvnhek) ? -HEK_LEN(gvnhek) : HEK_LEN(gvnhek), G_DISCARD);
3174 } else if (GvMULTI(gv) && cv &&
3175 !SvOBJECT(cv) && !SvMAGICAL(cv) && !SvREADONLY(cv) &&
3176 CvSTASH(cv) == stash && CvGV(cv) == gv &&
3177 CvCONST(cv) && !CvMETHOD(cv) && !CvLVALUE(cv) && !CvUNIQUE(cv) &&
3178 !CvNODEBUG(cv) && !CvCLONE(cv) && !CvCLONED(cv) && !CvANON(cv) &&
3179 (namehek = GvNAME_HEK(gv)) &&
3180 (gvp = hv_fetch(stash, HEK_KEY(namehek),
3181 HEK_LEN(namehek)*(HEK_UTF8(namehek) ? -1 : 1), 0)) &&
3183 SV *value = SvREFCNT_inc(CvXSUBANY(cv).any_ptr);
3187 SvFLAGS(gv) = SVt_IV|SVf_ROK;
3188 SvANY(gv) = (XPVGV*)((char*)&(gv->sv_u.svu_iv) -
3189 STRUCT_OFFSET(XPVIV, xiv_iv));
3190 SvRV_set(gv, value);
3197 core_xsub(pTHX_ CV* cv)
3200 "&CORE::%s cannot be called directly", GvNAME(CvGV(cv))
3206 * c-indentation-style: bsd
3208 * indent-tabs-mode: nil
3211 * ex: set ts=8 sts=4 sw=4 et: