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) {
1660 require_tie_mod(gv,name,newSVpvs("arybase"),"FETCH",0);
1663 PL_sawampersand |= SAWAMPERSAND_LEFT;
1667 PL_sawampersand |= SAWAMPERSAND_MIDDLE;
1671 PL_sawampersand |= SAWAMPERSAND_RIGHT;
1677 else if (len == 3 && sv_type == SVt_PVAV
1678 && strnEQ(name, "ISA", 3)
1679 && (!GvAV(gv) || !SvSMAGICAL(GvAV(gv))))
1680 gv_magicalize_isa(gv);
1683 } else if (no_init) {
1686 } else if (no_expand && SvROK(gv)) {
1691 /* Adding a new symbol.
1692 Unless of course there was already something non-GV here, in which case
1693 we want to behave as if there was always a GV here, containing some sort
1695 Otherwise we run the risk of creating things like GvIO, which can cause
1696 subtle bugs. eg the one that tripped up SQL::Translator */
1698 faking_it = SvOK(gv);
1700 if (add & GV_ADDWARN)
1701 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL), "Had to create %"SVf" unexpectedly",
1702 SVfARG(newSVpvn_flags(nambeg, name_end-nambeg, SVs_TEMP | is_utf8 )));
1703 gv_init_pvn(gv, stash, name, len, (add & GV_ADDMULTI)|is_utf8);
1705 if ( isIDFIRST_lazy_if(name, is_utf8)
1706 && ! (isLEXWARN_on ? ckWARN(WARN_ONCE) : (PL_dowarn & G_WARN_ON ) ) )
1709 /* set up magic where warranted */
1710 if (stash != PL_defstash) { /* not the main stash */
1711 /* We only have to check for three names here: EXPORT, ISA
1712 and VERSION. All the others apply only to the main stash or to
1713 CORE (which is checked right after this). */
1715 const char * const name2 = name + 1;
1718 if (strnEQ(name2, "XPORT", 5))
1722 if (strEQ(name2, "SA"))
1723 gv_magicalize_isa(gv);
1726 if (strEQ(name2, "ERSION"))
1732 goto add_magical_gv;
1735 if (len > 1 /* shortest is uc */ && HvNAMELEN_get(stash) == 4) {
1736 /* Avoid null warning: */
1737 const char * const stashname = HvNAME(stash); assert(stashname);
1738 if (strnEQ(stashname, "CORE", 4))
1739 S_maybe_add_coresub(aTHX_ 0, gv, name, len);
1746 /* Nothing else to do.
1747 The compiler will probably turn the switch statement into a
1748 branch table. Make sure we avoid even that small overhead for
1749 the common case of lower case variable names. */
1753 const char * const name2 = name + 1;
1756 if (strEQ(name2, "RGV")) {
1757 IoFLAGS(GvIOn(gv)) |= IOf_ARGV|IOf_START;
1759 else if (strEQ(name2, "RGVOUT")) {
1764 if (strnEQ(name2, "XPORT", 5))
1768 if (strEQ(name2, "SA")) {
1769 gv_magicalize_isa(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 ||
1880 )) { PL_sawampersand |=
1884 ? SAWAMPERSAND_MIDDLE
1885 : SAWAMPERSAND_RIGHT;
1890 sv_setpv(GvSVn(gv),PL_chopset);
1894 #ifdef COMPLEX_STATUS
1895 SvUPGRADE(GvSVn(gv), SVt_PVLV);
1901 /* If %! has been used, automatically load Errno.pm. */
1903 sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
1905 /* magicalization must be done before require_tie_mod is called */
1906 if (sv_type == SVt_PVHV || sv_type == SVt_PVGV)
1908 if (addmg) (void)hv_store(stash,name,len,(SV *)gv,0);
1910 require_tie_mod(gv, "!", newSVpvs("Errno"), "TIEHASH", 1);
1916 GvMULTI_on(gv); /* no used once warnings here */
1918 AV* const av = GvAVn(gv);
1919 SV* const avc = (*name == '+') ? MUTABLE_SV(av) : NULL;
1921 sv_magic(MUTABLE_SV(av), avc, PERL_MAGIC_regdata, NULL, 0);
1922 sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
1924 SvREADONLY_on(GvSVn(gv));
1927 if (sv_type == SVt_PVHV || sv_type == SVt_PVGV)
1929 if (addmg) (void)hv_store(stash,name,len,(SV *)gv,0);
1931 require_tie_mod(gv, name, newSVpvs("Tie::Hash::NamedCapture"), "TIEHASH", 0);
1938 if (sv_type == SVt_PV)
1939 /* diag_listed_as: $* is no longer supported */
1940 Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_SYNTAX),
1941 "$%c is no longer supported", *name);
1944 sv_setiv(GvSVn(gv), (IV)(IoFLAGS(GvIOp(PL_defoutgv)) & IOf_FLUSH) != 0);
1947 case '\010': /* $^H */
1949 HV *const hv = GvHVn(gv);
1950 hv_magic(hv, NULL, PERL_MAGIC_hints);
1954 if ((sv_type == SVt_PV || sv_type == SVt_PVGV)
1955 && FEATURE_ARYBASE_IS_ENABLED) {
1956 if (addmg) (void)hv_store(stash,name,len,(SV *)gv,0);
1957 require_tie_mod(gv,name,newSVpvs("arybase"),"FETCH",0);
1960 else goto magicalize;
1962 case '\023': /* $^S */
1964 SvREADONLY_on(GvSVn(gv));
1988 case '\001': /* $^A */
1989 case '\003': /* $^C */
1990 case '\004': /* $^D */
1991 case '\005': /* $^E */
1992 case '\006': /* $^F */
1993 case '\011': /* $^I, NOT \t in EBCDIC */
1994 case '\016': /* $^N */
1995 case '\017': /* $^O */
1996 case '\020': /* $^P */
1997 case '\024': /* $^T */
1998 case '\027': /* $^W */
2000 sv_magic(GvSVn(gv), MUTABLE_SV(gv), PERL_MAGIC_sv, name, len);
2003 case '\014': /* $^L */
2004 sv_setpvs(GvSVn(gv),"\f");
2005 PL_formfeed = GvSV(gv);
2008 sv_setpvs(GvSVn(gv),"\034");
2012 SV * const sv = GvSV(gv);
2013 if (!sv_derived_from(PL_patchlevel, "version"))
2014 upg_version(PL_patchlevel, TRUE);
2015 GvSV(gv) = vnumify(PL_patchlevel);
2016 SvREADONLY_on(GvSV(gv));
2020 case '\026': /* $^V */
2022 SV * const sv = GvSV(gv);
2023 GvSV(gv) = new_version(PL_patchlevel);
2024 SvREADONLY_on(GvSV(gv));
2032 if (GvAV(gv) || GvHV(gv) || GvIO(gv) || GvCV(gv) || (
2033 GvSV(gv) && (SvOK(GvSV(gv)) || SvMAGICAL(GvSV(gv)))
2035 (void)hv_store(stash,name,len,(SV *)gv,0);
2036 else SvREFCNT_dec(gv), gv = NULL;
2038 if (gv) gv_init_svtype(gv, faking_it ? SVt_PVCV : sv_type);
2043 Perl_gv_fullname4(pTHX_ SV *sv, const GV *gv, const char *prefix, bool keepmain)
2046 const HV * const hv = GvSTASH(gv);
2048 PERL_ARGS_ASSERT_GV_FULLNAME4;
2050 sv_setpv(sv, prefix ? prefix : "");
2052 if (hv && (name = HvNAME(hv))) {
2053 const STRLEN len = HvNAMELEN(hv);
2054 if (keepmain || strnNE(name, "main", len)) {
2055 sv_catpvn_flags(sv,name,len,HvNAMEUTF8(hv)?SV_CATUTF8:SV_CATBYTES);
2059 else sv_catpvs(sv,"__ANON__::");
2060 sv_catsv(sv,sv_2mortal(newSVhek(GvNAME_HEK(gv))));
2064 Perl_gv_efullname4(pTHX_ SV *sv, const GV *gv, const char *prefix, bool keepmain)
2066 const GV * const egv = GvEGVx(gv);
2068 PERL_ARGS_ASSERT_GV_EFULLNAME4;
2070 gv_fullname4(sv, egv ? egv : gv, prefix, keepmain);
2074 Perl_gv_check(pTHX_ const HV *stash)
2079 PERL_ARGS_ASSERT_GV_CHECK;
2081 if (!HvARRAY(stash))
2083 for (i = 0; i <= (I32) HvMAX(stash); i++) {
2085 for (entry = HvARRAY(stash)[i]; entry; entry = HeNEXT(entry)) {
2088 if (HeKEY(entry)[HeKLEN(entry)-1] == ':' &&
2089 (gv = MUTABLE_GV(HeVAL(entry))) && isGV(gv) && (hv = GvHV(gv)))
2091 if (hv != PL_defstash && hv != stash)
2092 gv_check(hv); /* nested package */
2094 else if ( *HeKEY(entry) != '_'
2095 && isIDFIRST_lazy_if(HeKEY(entry), HeUTF8(entry)) ) {
2097 gv = MUTABLE_GV(HeVAL(entry));
2098 if (SvTYPE(gv) != SVt_PVGV || GvMULTI(gv))
2101 CopLINE_set(PL_curcop, GvLINE(gv));
2103 CopFILE(PL_curcop) = (char *)file; /* set for warning */
2105 CopFILEGV(PL_curcop)
2106 = gv_fetchfile_flags(file, HEK_LEN(GvFILE_HEK(gv)), 0);
2108 Perl_warner(aTHX_ packWARN(WARN_ONCE),
2109 "Name \"%"HEKf"::%"HEKf
2110 "\" used only once: possible typo",
2111 HEKfARG(HvNAME_HEK(stash)),
2112 HEKfARG(GvNAME_HEK(gv)));
2119 Perl_newGVgen_flags(pTHX_ const char *pack, U32 flags)
2122 PERL_ARGS_ASSERT_NEWGVGEN_FLAGS;
2124 return gv_fetchpv(Perl_form(aTHX_ "%"SVf"::_GEN_%ld",
2125 SVfARG(newSVpvn_flags(pack, strlen(pack),
2131 /* hopefully this is only called on local symbol table entries */
2134 Perl_gp_ref(pTHX_ GP *gp)
2142 /* If the GP they asked for a reference to contains
2143 a method cache entry, clear it first, so that we
2144 don't infect them with our cached entry */
2145 SvREFCNT_dec(gp->gp_cv);
2154 Perl_gp_free(pTHX_ GV *gv)
2160 if (!gv || !isGV_with_GP(gv) || !(gp = GvGP(gv)))
2162 if (gp->gp_refcnt == 0) {
2163 Perl_ck_warner_d(aTHX_ packWARN(WARN_INTERNAL),
2164 "Attempt to free unreferenced glob pointers"
2165 pTHX__FORMAT pTHX__VALUE);
2168 if (--gp->gp_refcnt > 0) {
2169 if (gp->gp_egv == gv)
2176 /* Copy and null out all the glob slots, so destructors do not see
2178 HEK * const file_hek = gp->gp_file_hek;
2179 SV * const sv = gp->gp_sv;
2180 AV * const av = gp->gp_av;
2181 HV * const hv = gp->gp_hv;
2182 IO * const io = gp->gp_io;
2183 CV * const cv = gp->gp_cv;
2184 CV * const form = gp->gp_form;
2186 gp->gp_file_hek = NULL;
2195 unshare_hek(file_hek);
2199 /* FIXME - another reference loop GV -> symtab -> GV ?
2200 Somehow gp->gp_hv can end up pointing at freed garbage. */
2201 if (hv && SvTYPE(hv) == SVt_PVHV) {
2202 const HEK *hvname_hek = HvNAME_HEK(hv);
2203 if (PL_stashcache && hvname_hek)
2204 (void)hv_delete(PL_stashcache, HEK_KEY(hvname_hek),
2205 (HEK_UTF8(hvname_hek) ? -HEK_LEN(hvname_hek) : HEK_LEN(hvname_hek)),
2213 if (!gp->gp_file_hek
2219 && !gp->gp_form) break;
2221 if (--attempts == 0) {
2223 "panic: gp_free failed to free glob pointer - "
2224 "something is repeatedly re-creating entries"
2234 Perl_magic_freeovrld(pTHX_ SV *sv, MAGIC *mg)
2236 AMT * const amtp = (AMT*)mg->mg_ptr;
2237 PERL_UNUSED_ARG(sv);
2239 PERL_ARGS_ASSERT_MAGIC_FREEOVRLD;
2241 if (amtp && AMT_AMAGIC(amtp)) {
2243 for (i = 1; i < NofAMmeth; i++) {
2244 CV * const cv = amtp->table[i];
2246 SvREFCNT_dec(MUTABLE_SV(cv));
2247 amtp->table[i] = NULL;
2254 /* Updates and caches the CV's */
2256 * 1 on success and there is some overload
2257 * 0 if there is no overload
2258 * -1 if some error occurred and it couldn't croak
2262 Perl_Gv_AMupdate(pTHX_ HV *stash, bool destructing)
2265 MAGIC* const mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
2267 const struct mro_meta* stash_meta = HvMROMETA(stash);
2270 PERL_ARGS_ASSERT_GV_AMUPDATE;
2272 newgen = PL_sub_generation + stash_meta->pkg_gen + stash_meta->cache_gen;
2274 const AMT * const amtp = (AMT*)mg->mg_ptr;
2275 if (amtp->was_ok_sub == newgen) {
2276 return AMT_OVERLOADED(amtp) ? 1 : 0;
2278 sv_unmagic(MUTABLE_SV(stash), PERL_MAGIC_overload_table);
2281 DEBUG_o( Perl_deb(aTHX_ "Recalcing overload magic in package %s\n",HvNAME_get(stash)) );
2284 amt.was_ok_sub = newgen;
2285 amt.fallback = AMGfallNO;
2289 int filled = 0, have_ovl = 0;
2292 /* Work with "fallback" key, which we assume to be first in PL_AMG_names */
2294 /* Try to find via inheritance. */
2295 GV *gv = gv_fetchmeth_pvn(stash, PL_AMG_names[0], 2, -1, 0);
2296 SV * const sv = gv ? GvSV(gv) : NULL;
2301 if (!gv_fetchmeth_pvn(stash, "((", 2, -1, 0))
2302 lim = DESTROY_amg; /* Skip overloading entries. */
2304 #ifdef PERL_DONT_CREATE_GVSV
2306 NOOP; /* Equivalent to !SvTRUE and !SvOK */
2309 else if (SvTRUE(sv))
2310 /* don't need to set overloading here because fallback => 1
2311 * is the default setting for classes without overloading */
2312 amt.fallback=AMGfallYES;
2313 else if (SvOK(sv)) {
2314 amt.fallback=AMGfallNEVER;
2323 for (i = 1; i < lim; i++)
2324 amt.table[i] = NULL;
2325 for (; i < NofAMmeth; i++) {
2326 const char * const cooky = PL_AMG_names[i];
2327 /* Human-readable form, for debugging: */
2328 const char * const cp = (i >= DESTROY_amg ? cooky : AMG_id2name(i));
2329 const STRLEN l = PL_AMG_namelens[i];
2331 DEBUG_o( Perl_deb(aTHX_ "Checking overloading of \"%s\" in package \"%.256s\"\n",
2332 cp, HvNAME_get(stash)) );
2333 /* don't fill the cache while looking up!
2334 Creation of inheritance stubs in intermediate packages may
2335 conflict with the logic of runtime method substitution.
2336 Indeed, for inheritance A -> B -> C, if C overloads "+0",
2337 then we could have created stubs for "(+0" in A and C too.
2338 But if B overloads "bool", we may want to use it for
2339 numifying instead of C's "+0". */
2340 if (i >= DESTROY_amg)
2341 gv = Perl_gv_fetchmeth_pvn_autoload(aTHX_ stash, cooky, l, 0, 0);
2342 else /* Autoload taken care of below */
2343 gv = Perl_gv_fetchmeth_pvn(aTHX_ stash, cooky, l, -1, 0);
2345 if (gv && (cv = GvCV(gv))) {
2346 if(GvNAMELEN(CvGV(cv)) == 3 && strEQ(GvNAME(CvGV(cv)), "nil")){
2347 const char * const hvname = HvNAME_get(GvSTASH(CvGV(cv)));
2348 if (hvname && HEK_LEN(HvNAME_HEK(GvSTASH(CvGV(cv)))) == 8
2349 && strEQ(hvname, "overload")) {
2350 /* This is a hack to support autoloading..., while
2351 knowing *which* methods were declared as overloaded. */
2352 /* GvSV contains the name of the method. */
2354 SV *gvsv = GvSV(gv);
2356 DEBUG_o( Perl_deb(aTHX_ "Resolving method \"%"SVf256\
2357 "\" for overloaded \"%s\" in package \"%.256s\"\n",
2358 (void*)GvSV(gv), cp, HvNAME(stash)) );
2359 if (!gvsv || !SvPOK(gvsv)
2360 || !(ngv = gv_fetchmethod_sv_flags(stash, gvsv, 0)))
2362 /* Can be an import stub (created by "can"). */
2367 const SV * const name = (gvsv && SvPOK(gvsv))
2369 : newSVpvs_flags("???", SVs_TEMP);
2370 /* diag_listed_as: Can't resolve method "%s" overloading "%s" in package "%s" */
2371 Perl_croak(aTHX_ "%s method \"%"SVf256
2372 "\" overloading \"%s\" "\
2373 "in package \"%"HEKf256"\"",
2374 (GvCVGEN(gv) ? "Stub found while resolving"
2382 cv = GvCV(gv = ngv);
2385 DEBUG_o( Perl_deb(aTHX_ "Overloading \"%s\" in package \"%.256s\" via \"%.256s::%.256s\"\n",
2386 cp, HvNAME_get(stash), HvNAME_get(GvSTASH(CvGV(cv))),
2387 GvNAME(CvGV(cv))) );
2389 if (i < DESTROY_amg)
2391 } else if (gv) { /* Autoloaded... */
2392 cv = MUTABLE_CV(gv);
2395 amt.table[i]=MUTABLE_CV(SvREFCNT_inc_simple(cv));
2398 AMT_AMAGIC_on(&amt);
2400 AMT_OVERLOADED_on(&amt);
2401 sv_magic(MUTABLE_SV(stash), 0, PERL_MAGIC_overload_table,
2402 (char*)&amt, sizeof(AMT));
2406 /* Here we have no table: */
2408 AMT_AMAGIC_off(&amt);
2409 sv_magic(MUTABLE_SV(stash), 0, PERL_MAGIC_overload_table,
2410 (char*)&amt, sizeof(AMTS));
2416 Perl_gv_handler(pTHX_ HV *stash, I32 id)
2422 struct mro_meta* stash_meta;
2424 if (!stash || !HvNAME_get(stash))
2427 stash_meta = HvMROMETA(stash);
2428 newgen = PL_sub_generation + stash_meta->pkg_gen + stash_meta->cache_gen;
2430 mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
2433 /* If we're looking up a destructor to invoke, we must avoid
2434 * that Gv_AMupdate croaks, because we might be dying already */
2435 if (Gv_AMupdate(stash, cBOOL(id == DESTROY_amg)) == -1) {
2436 /* and if it didn't found a destructor, we fall back
2437 * to a simpler method that will only look for the
2438 * destructor instead of the whole magic */
2439 if (id == DESTROY_amg) {
2440 GV * const gv = gv_fetchmethod(stash, "DESTROY");
2446 mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table);
2449 amtp = (AMT*)mg->mg_ptr;
2450 if ( amtp->was_ok_sub != newgen )
2452 if (AMT_AMAGIC(amtp)) {
2453 CV * const ret = amtp->table[id];
2454 if (ret && isGV(ret)) { /* Autoloading stab */
2455 /* Passing it through may have resulted in a warning
2456 "Inherited AUTOLOAD for a non-method deprecated", since
2457 our caller is going through a function call, not a method call.
2458 So return the CV for AUTOLOAD, setting $AUTOLOAD. */
2459 GV * const gv = gv_fetchmethod(stash, PL_AMG_names[id]);
2471 /* Implement tryAMAGICun_MG macro.
2472 Do get magic, then see if the stack arg is overloaded and if so call it.
2474 AMGf_set return the arg using SETs rather than assigning to
2476 AMGf_numeric apply sv_2num to the stack arg.
2480 Perl_try_amagic_un(pTHX_ int method, int flags) {
2484 SV* const arg = TOPs;
2488 if (SvAMAGIC(arg) && (tmpsv = amagic_call(arg, &PL_sv_undef, method,
2489 AMGf_noright | AMGf_unary))) {
2490 if (flags & AMGf_set) {
2495 if (SvPADMY(TARG)) {
2496 sv_setsv(TARG, tmpsv);
2506 if ((flags & AMGf_numeric) && SvROK(arg))
2512 /* Implement tryAMAGICbin_MG macro.
2513 Do get magic, then see if the two stack args are overloaded and if so
2516 AMGf_set return the arg using SETs rather than assigning to
2518 AMGf_assign op may be called as mutator (eg +=)
2519 AMGf_numeric apply sv_2num to the stack arg.
2523 Perl_try_amagic_bin(pTHX_ int method, int flags) {
2526 SV* const left = TOPm1s;
2527 SV* const right = TOPs;
2533 if (SvAMAGIC(left) || SvAMAGIC(right)) {
2534 SV * const tmpsv = amagic_call(left, right, method,
2535 ((flags & AMGf_assign) && opASSIGN ? AMGf_assign: 0));
2537 if (flags & AMGf_set) {
2544 if (opASSIGN || SvPADMY(TARG)) {
2545 sv_setsv(TARG, tmpsv);
2555 if(left==right && SvGMAGICAL(left)) {
2556 SV * const left = sv_newmortal();
2558 /* Print the uninitialized warning now, so it includes the vari-
2561 if (ckWARN(WARN_UNINITIALIZED)) report_uninit(right);
2562 sv_setsv_flags(left, &PL_sv_no, 0);
2564 else sv_setsv_flags(left, right, 0);
2567 if (flags & AMGf_numeric) {
2569 *(sp-1) = sv_2num(TOPm1s);
2571 *sp = sv_2num(right);
2577 Perl_amagic_deref_call(pTHX_ SV *ref, int method) {
2580 PERL_ARGS_ASSERT_AMAGIC_DEREF_CALL;
2582 while (SvAMAGIC(ref) &&
2583 (tmpsv = amagic_call(ref, &PL_sv_undef, method,
2584 AMGf_noright | AMGf_unary))) {
2586 Perl_croak(aTHX_ "Overloaded dereference did not return a reference");
2587 if (tmpsv == ref || SvRV(tmpsv) == SvRV(ref)) {
2588 /* Bail out if it returns us the same reference. */
2593 return tmpsv ? tmpsv : ref;
2597 Perl_amagic_is_enabled(pTHX_ int method)
2599 SV *lex_mask = cop_hints_fetch_pvs(PL_curcop, "overloading", 0);
2601 assert(PL_curcop->cop_hints & HINT_NO_AMAGIC);
2603 if ( !lex_mask || !SvOK(lex_mask) )
2604 /* overloading lexically disabled */
2606 else if ( lex_mask && SvPOK(lex_mask) ) {
2607 /* we have an entry in the hints hash, check if method has been
2608 * masked by overloading.pm */
2610 const int offset = method / 8;
2611 const int bit = method % 8;
2612 char *pv = SvPV(lex_mask, len);
2614 /* Bit set, so this overloading operator is disabled */
2615 if ( (STRLEN)offset < len && pv[offset] & ( 1 << bit ) )
2622 Perl_amagic_call(pTHX_ SV *left, SV *right, int method, int flags)
2627 CV **cvp=NULL, **ocvp=NULL;
2628 AMT *amtp=NULL, *oamtp=NULL;
2629 int off = 0, off1, lr = 0, notfound = 0;
2630 int postpr = 0, force_cpy = 0;
2631 int assign = AMGf_assign & flags;
2632 const int assignshift = assign ? 1 : 0;
2633 int use_default_op = 0;
2634 int force_scalar = 0;
2640 PERL_ARGS_ASSERT_AMAGIC_CALL;
2642 if ( PL_curcop->cop_hints & HINT_NO_AMAGIC ) {
2643 if (!amagic_is_enabled(method)) return NULL;
2646 if (!(AMGf_noleft & flags) && SvAMAGIC(left)
2647 && (stash = SvSTASH(SvRV(left))) && Gv_AMG(stash)
2648 && (mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table))
2649 && (ocvp = cvp = (AMT_AMAGIC((AMT*)mg->mg_ptr)
2650 ? (oamtp = amtp = (AMT*)mg->mg_ptr)->table
2652 && ((cv = cvp[off=method+assignshift])
2653 || (assign && amtp->fallback > AMGfallNEVER && /* fallback to
2659 cv = cvp[off=method])))) {
2660 lr = -1; /* Call method for left argument */
2662 if (cvp && amtp->fallback > AMGfallNEVER && flags & AMGf_unary) {
2665 /* look for substituted methods */
2666 /* In all the covered cases we should be called with assign==0. */
2670 if ((cv = cvp[off=add_ass_amg])
2671 || ((cv = cvp[off = add_amg]) && (force_cpy = 0, postpr = 1))) {
2672 right = &PL_sv_yes; lr = -1; assign = 1;
2677 if ((cv = cvp[off = subtr_ass_amg])
2678 || ((cv = cvp[off = subtr_amg]) && (force_cpy = 0, postpr=1))) {
2679 right = &PL_sv_yes; lr = -1; assign = 1;
2683 (void)((cv = cvp[off=numer_amg]) || (cv = cvp[off=string_amg]));
2686 (void)((cv = cvp[off=string_amg]) || (cv = cvp[off=bool__amg]));
2689 (void)((cv = cvp[off=numer_amg]) || (cv = cvp[off=bool__amg]));
2692 (void)((cv = cvp[off=bool__amg])
2693 || (cv = cvp[off=numer_amg])
2694 || (cv = cvp[off=string_amg]));
2701 * SV* ref causes confusion with the interpreter variable of
2704 SV* const tmpRef=SvRV(left);
2705 if (!SvROK(tmpRef) && SvTYPE(tmpRef) <= SVt_PVMG) {
2707 * Just to be extra cautious. Maybe in some
2708 * additional cases sv_setsv is safe, too.
2710 SV* const newref = newSVsv(tmpRef);
2711 SvOBJECT_on(newref);
2712 /* No need to do SvAMAGIC_on here, as SvAMAGIC macros
2713 delegate to the stash. */
2714 SvSTASH_set(newref, MUTABLE_HV(SvREFCNT_inc(SvSTASH(tmpRef))));
2720 if ((cvp[off1=lt_amg] || cvp[off1=ncmp_amg])
2721 && ((cv = cvp[off=neg_amg]) || (cv = cvp[off=subtr_amg]))) {
2722 SV* const nullsv=sv_2mortal(newSViv(0));
2724 SV* const lessp = amagic_call(left,nullsv,
2725 lt_amg,AMGf_noright);
2726 logic = SvTRUE(lessp);
2728 SV* const lessp = amagic_call(left,nullsv,
2729 ncmp_amg,AMGf_noright);
2730 logic = (SvNV(lessp) < 0);
2733 if (off==subtr_amg) {
2744 if ((cv = cvp[off=subtr_amg])) {
2746 left = sv_2mortal(newSViv(0));
2751 case iter_amg: /* XXXX Eventually should do to_gv. */
2752 case ftest_amg: /* XXXX Eventually should do to_gv. */
2755 return NULL; /* Delegate operation to standard mechanisms. */
2763 return left; /* Delegate operation to standard mechanisms. */
2768 if (!cv) goto not_found;
2769 } else if (!(AMGf_noright & flags) && SvAMAGIC(right)
2770 && (stash = SvSTASH(SvRV(right))) && Gv_AMG(stash)
2771 && (mg = mg_find((const SV *)stash, PERL_MAGIC_overload_table))
2772 && (cvp = (AMT_AMAGIC((AMT*)mg->mg_ptr)
2773 ? (amtp = (AMT*)mg->mg_ptr)->table
2775 && ((cv = cvp[off=method+assignshift])
2776 || (assign && amtp->fallback > AMGfallNEVER && /* fallback to
2782 cv = cvp[off=method])))) { /* Method for right
2785 } else if (((cvp && amtp->fallback > AMGfallNEVER)
2786 || (ocvp && oamtp->fallback > AMGfallNEVER))
2787 && !(flags & AMGf_unary)) {
2788 /* We look for substitution for
2789 * comparison operations and
2791 if (method==concat_amg || method==concat_ass_amg
2792 || method==repeat_amg || method==repeat_ass_amg) {
2793 return NULL; /* Delegate operation to string conversion */
2815 if (ocvp && (oamtp->fallback > AMGfallNEVER)) {
2819 if (!cv && (cvp && amtp->fallback > AMGfallNEVER)) {
2829 not_found: /* No method found, either report or croak */
2837 return left; /* Delegate operation to standard mechanisms. */
2840 if (ocvp && (cv=ocvp[nomethod_amg])) { /* Call report method */
2841 notfound = 1; lr = -1;
2842 } else if (cvp && (cv=cvp[nomethod_amg])) {
2843 notfound = 1; lr = 1;
2844 } else if ((use_default_op =
2845 (!ocvp || oamtp->fallback >= AMGfallYES)
2846 && (!cvp || amtp->fallback >= AMGfallYES))
2848 /* Skip generating the "no method found" message. */
2852 if (off==-1) off=method;
2853 msg = sv_2mortal(Perl_newSVpvf(aTHX_
2854 "Operation \"%s\": no method found,%sargument %s%"SVf"%s%"SVf,
2855 AMG_id2name(method + assignshift),
2856 (flags & AMGf_unary ? " " : "\n\tleft "),
2858 "in overloaded package ":
2859 "has no overloaded magic",
2861 SVfARG(sv_2mortal(newSVhek(HvNAME_HEK(SvSTASH(SvRV(left)))))):
2864 ",\n\tright argument in overloaded package ":
2867 : ",\n\tright argument has no overloaded magic"),
2869 SVfARG(sv_2mortal(newSVhek(HvNAME_HEK(SvSTASH(SvRV(right)))))):
2870 SVfARG(&PL_sv_no)));
2871 if (use_default_op) {
2872 DEBUG_o( Perl_deb(aTHX_ "%"SVf, SVfARG(msg)) );
2874 Perl_croak(aTHX_ "%"SVf, SVfARG(msg));
2878 force_cpy = force_cpy || assign;
2883 /* in these cases, we're calling '+' or '-' as a fallback for a ++ or --
2884 * operation. we need this to return a value, so that it can be assigned
2885 * later on, in the postpr block (case inc_amg/dec_amg), even if the
2886 * increment or decrement was itself called in void context */
2892 if (off == subtr_amg)
2895 /* in these cases, we're calling an assignment variant of an operator
2896 * (+= rather than +, for instance). regardless of whether it's a
2897 * fallback or not, it always has to return a value, which will be
2898 * assigned to the proper variable later */
2915 /* the copy constructor always needs to return a value */
2919 /* because of the way these are implemented (they don't perform the
2920 * dereferencing themselves, they return a reference that perl then
2921 * dereferences later), they always have to be in scalar context */
2929 /* these don't have an op of their own; they're triggered by their parent
2930 * op, so the context there isn't meaningful ('$a and foo()' in void
2931 * context still needs to pass scalar context on to $a's bool overload) */
2941 DEBUG_o(Perl_deb(aTHX_
2942 "Overloaded operator \"%s\"%s%s%s:\n\tmethod%s found%s in package %"SVf"%s\n",
2944 method+assignshift==off? "" :
2946 method+assignshift==off? "" :
2947 AMG_id2name(method+assignshift),
2948 method+assignshift==off? "" : "\")",
2949 flags & AMGf_unary? "" :
2950 lr==1 ? " for right argument": " for left argument",
2951 flags & AMGf_unary? " for argument" : "",
2952 stash ? SVfARG(sv_2mortal(newSVhek(HvNAME_HEK(stash)))) : SVfARG(newSVpvs_flags("null", SVs_TEMP)),
2953 fl? ",\n\tassignment variant used": "") );
2956 /* Since we use shallow copy during assignment, we need
2957 * to dublicate the contents, probably calling user-supplied
2958 * version of copy operator
2960 /* We need to copy in following cases:
2961 * a) Assignment form was called.
2962 * assignshift==1, assign==T, method + 1 == off
2963 * b) Increment or decrement, called directly.
2964 * assignshift==0, assign==0, method + 0 == off
2965 * c) Increment or decrement, translated to assignment add/subtr.
2966 * assignshift==0, assign==T,
2968 * d) Increment or decrement, translated to nomethod.
2969 * assignshift==0, assign==0,
2971 * e) Assignment form translated to nomethod.
2972 * assignshift==1, assign==T, method + 1 != off
2975 /* off is method, method+assignshift, or a result of opcode substitution.
2976 * In the latter case assignshift==0, so only notfound case is important.
2978 if ( (lr == -1) && ( ( (method + assignshift == off)
2979 && (assign || (method == inc_amg) || (method == dec_amg)))
2982 /* newSVsv does not behave as advertised, so we copy missing
2983 * information by hand */
2984 SV *tmpRef = SvRV(left);
2986 if (SvREFCNT(tmpRef) > 1 && (rv_copy = AMG_CALLunary(left,copy_amg))) {
2987 SvRV_set(left, rv_copy);
2989 SvREFCNT_dec(tmpRef);
2997 const bool oldcatch = CATCH_GET;
2999 int gimme = force_scalar ? G_SCALAR : GIMME_V;
3002 Zero(&myop, 1, BINOP);
3003 myop.op_last = (OP *) &myop;
3004 myop.op_next = NULL;
3005 myop.op_flags = OPf_STACKED;
3009 myop.op_flags |= OPf_WANT_VOID;
3012 if (flags & AMGf_want_list) {
3013 myop.op_flags |= OPf_WANT_LIST;
3018 myop.op_flags |= OPf_WANT_SCALAR;
3022 PUSHSTACKi(PERLSI_OVERLOAD);
3025 PL_op = (OP *) &myop;
3026 if (PERLDB_SUB && PL_curstash != PL_debstash)
3027 PL_op->op_private |= OPpENTERSUB_DB;
3029 Perl_pp_pushmark(aTHX);
3031 EXTEND(SP, notfound + 5);
3032 PUSHs(lr>0? right: left);
3033 PUSHs(lr>0? left: right);
3034 PUSHs( lr > 0 ? &PL_sv_yes : ( assign ? &PL_sv_undef : &PL_sv_no ));
3036 PUSHs(newSVpvn_flags(AMG_id2name(method + assignshift),
3037 AMG_id2namelen(method + assignshift), SVs_TEMP));
3039 PUSHs(MUTABLE_SV(cv));
3043 if ((PL_op = PL_ppaddr[OP_ENTERSUB](aTHX)))
3047 nret = SP - (PL_stack_base + oldmark);
3051 /* returning NULL has another meaning, and we check the context
3052 * at the call site too, so this can be differentiated from the
3055 SP = PL_stack_base + oldmark;
3058 if (flags & AMGf_want_list) {
3059 res = sv_2mortal((SV *)newAV());
3060 av_extend((AV *)res, nret);
3062 av_store((AV *)res, nret, POPs);
3074 CATCH_SET(oldcatch);
3081 ans=SvIV(res)<=0; break;
3084 ans=SvIV(res)<0; break;
3087 ans=SvIV(res)>=0; break;
3090 ans=SvIV(res)>0; break;
3093 ans=SvIV(res)==0; break;
3096 ans=SvIV(res)!=0; break;
3099 SvSetSV(left,res); return left;
3101 ans=!SvTRUE(res); break;
3106 } else if (method==copy_amg) {
3108 Perl_croak(aTHX_ "Copy method did not return a reference");
3110 return SvREFCNT_inc(SvRV(res));
3118 Perl_gv_name_set(pTHX_ GV *gv, const char *name, U32 len, U32 flags)
3123 PERL_ARGS_ASSERT_GV_NAME_SET;
3126 Perl_croak(aTHX_ "panic: gv name too long (%"UVuf")", (UV) len);
3128 if (!(flags & GV_ADD) && GvNAME_HEK(gv)) {
3129 unshare_hek(GvNAME_HEK(gv));
3132 PERL_HASH(hash, name, len);
3133 GvNAME_HEK(gv) = share_hek(name, (flags & SVf_UTF8 ? -(I32)len : (I32)len), hash);
3137 =for apidoc gv_try_downgrade
3139 If the typeglob C<gv> can be expressed more succinctly, by having
3140 something other than a real GV in its place in the stash, replace it
3141 with the optimised form. Basic requirements for this are that C<gv>
3142 is a real typeglob, is sufficiently ordinary, and is only referenced
3143 from its package. This function is meant to be used when a GV has been
3144 looked up in part to see what was there, causing upgrading, but based
3145 on what was found it turns out that the real GV isn't required after all.
3147 If C<gv> is a completely empty typeglob, it is deleted from the stash.
3149 If C<gv> is a typeglob containing only a sufficiently-ordinary constant
3150 sub, the typeglob is replaced with a scalar-reference placeholder that
3151 more compactly represents the same thing.
3157 Perl_gv_try_downgrade(pTHX_ GV *gv)
3163 PERL_ARGS_ASSERT_GV_TRY_DOWNGRADE;
3165 /* XXX Why and where does this leave dangling pointers during global
3167 if (PL_phase == PERL_PHASE_DESTRUCT) return;
3169 if (!(SvREFCNT(gv) == 1 && SvTYPE(gv) == SVt_PVGV && !SvFAKE(gv) &&
3170 !SvOBJECT(gv) && !SvREADONLY(gv) &&
3171 isGV_with_GP(gv) && GvGP(gv) &&
3172 !GvINTRO(gv) && GvREFCNT(gv) == 1 &&
3173 !GvSV(gv) && !GvAV(gv) && !GvHV(gv) && !GvIOp(gv) && !GvFORM(gv) &&
3174 GvEGVx(gv) == gv && (stash = GvSTASH(gv))))
3176 if (SvMAGICAL(gv)) {
3178 /* only backref magic is allowed */
3179 if (SvGMAGICAL(gv) || SvSMAGICAL(gv))
3181 for (mg = SvMAGIC(gv); mg; mg = mg->mg_moremagic) {
3182 if (mg->mg_type != PERL_MAGIC_backref)
3188 HEK *gvnhek = GvNAME_HEK(gv);
3189 (void)hv_delete(stash, HEK_KEY(gvnhek),
3190 HEK_UTF8(gvnhek) ? -HEK_LEN(gvnhek) : HEK_LEN(gvnhek), G_DISCARD);
3191 } else if (GvMULTI(gv) && cv &&
3192 !SvOBJECT(cv) && !SvMAGICAL(cv) && !SvREADONLY(cv) &&
3193 CvSTASH(cv) == stash && CvGV(cv) == gv &&
3194 CvCONST(cv) && !CvMETHOD(cv) && !CvLVALUE(cv) && !CvUNIQUE(cv) &&
3195 !CvNODEBUG(cv) && !CvCLONE(cv) && !CvCLONED(cv) && !CvANON(cv) &&
3196 (namehek = GvNAME_HEK(gv)) &&
3197 (gvp = hv_fetch(stash, HEK_KEY(namehek),
3198 HEK_LEN(namehek)*(HEK_UTF8(namehek) ? -1 : 1), 0)) &&
3200 SV *value = SvREFCNT_inc(CvXSUBANY(cv).any_ptr);
3204 SvFLAGS(gv) = SVt_IV|SVf_ROK;
3205 SvANY(gv) = (XPVGV*)((char*)&(gv->sv_u.svu_iv) -
3206 STRUCT_OFFSET(XPVIV, xiv_iv));
3207 SvRV_set(gv, value);
3214 core_xsub(pTHX_ CV* cv)
3217 "&CORE::%s cannot be called directly", GvNAME(CvGV(cv))
3223 * c-indentation-style: bsd
3225 * indent-tabs-mode: nil
3228 * ex: set ts=8 sts=4 sw=4 et: