3 * Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 * 2005, 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 * "The roots of those mountains must be roots indeed; there must be
13 * great secrets buried there which have not been discovered since the
14 * beginning." --Gandalf, relating Gollum's story
17 /* This file contains the code that implements the functions in Perl's
18 * UNIVERSAL package, such as UNIVERSAL->can().
22 #define PERL_IN_UNIVERSAL_C
26 #include "perliol.h" /* For the PERLIO_F_XXX */
30 * Contributed by Graham Barr <Graham.Barr@tiuk.ti.com>
31 * The main guts of traverse_isa was actually copied from gv_fetchmeth
35 S_isa_lookup(pTHX_ HV *stash, const char *name, HV* name_stash,
45 /* A stash/class can go by many names (ie. User == main::User), so
46 we compare the stash itself just in case */
47 if (name_stash && (stash == name_stash))
50 hvname = HvNAME_get(stash);
52 if (strEQ(hvname, name))
55 if (strEQ(name, "UNIVERSAL"))
59 Perl_croak(aTHX_ "Recursive inheritance detected in package '%s'",
62 gvp = (GV**)hv_fetch(stash, "::ISA::CACHE::", 14, FALSE);
64 if (gvp && (gv = *gvp) != (GV*)&PL_sv_undef && (subgen = GvSV(gv))
67 if (SvIV(subgen) == (IV)PL_sub_generation) {
69 SV** svp = (SV**)hv_fetch(hv, name, len, FALSE);
70 if (svp && (sv = *svp) != (SV*)&PL_sv_undef) {
71 DEBUG_o( Perl_deb(aTHX_ "Using cached ISA %s for package %s\n",
77 DEBUG_o( Perl_deb(aTHX_ "ISA Cache in package %s is stale\n",
80 sv_setiv(subgen, PL_sub_generation);
84 gvp = (GV**)hv_fetch(stash,"ISA",3,FALSE);
86 if (gvp && (gv = *gvp) != (GV*)&PL_sv_undef && (av = GvAV(gv))) {
88 gvp = (GV**)hv_fetch(stash, "::ISA::CACHE::", 14, TRUE);
92 if (SvTYPE(gv) != SVt_PVGV)
93 gv_init(gv, stash, "::ISA::CACHE::", 14, TRUE);
98 subgen = newSViv(PL_sub_generation);
103 SV** svp = AvARRAY(av);
104 /* NOTE: No support for tied ISA */
105 I32 items = AvFILLp(av) + 1;
108 HV* basestash = gv_stashsv(sv, FALSE);
110 if (ckWARN(WARN_MISC))
111 Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
112 "Can't locate package %"SVf" for @%s::ISA",
116 if (&PL_sv_yes == isa_lookup(basestash, name, name_stash,
118 (void)hv_store(hv,name,len,&PL_sv_yes,0);
122 (void)hv_store(hv,name,len,&PL_sv_no,0);
129 =head1 SV Manipulation Functions
131 =for apidoc sv_derived_from
133 Returns a boolean indicating whether the SV is derived from the specified
134 class. This is the function that implements C<UNIVERSAL::isa>. It works
135 for class names as well as for objects.
141 Perl_sv_derived_from(pTHX_ SV *sv, const char *name)
143 const char *type = Nullch;
152 type = sv_reftype(sv,0);
157 stash = gv_stashsv(sv, FALSE);
160 name_stash = gv_stashpv(name, FALSE);
162 return (type && strEQ(type,name)) ||
163 (stash && isa_lookup(stash, name, name_stash, strlen(name), 0)
171 PERL_XS_EXPORT_C void XS_UNIVERSAL_isa(pTHX_ CV *cv);
172 PERL_XS_EXPORT_C void XS_UNIVERSAL_can(pTHX_ CV *cv);
173 PERL_XS_EXPORT_C void XS_UNIVERSAL_VERSION(pTHX_ CV *cv);
175 XS(XS_version_stringify);
176 XS(XS_version_numify);
178 XS(XS_version_boolean);
179 #ifdef HASATTRIBUTE_NORETURN
180 XS(XS_version_noop) __attribute__noreturn__;
184 XS(XS_version_is_alpha);
191 XS(XS_utf8_downgrade);
192 XS(XS_utf8_unicode_to_native);
193 XS(XS_utf8_native_to_unicode);
194 XS(XS_Internals_SvREADONLY);
195 XS(XS_Internals_SvREFCNT);
196 XS(XS_Internals_hv_clear_placehold);
197 XS(XS_PerlIO_get_layers);
198 XS(XS_Regexp_DESTROY);
199 XS(XS_Internals_hash_seed);
200 XS(XS_Internals_rehash_seed);
201 XS(XS_Internals_HvREHASH);
204 Perl_boot_core_UNIVERSAL(pTHX)
206 const char file[] = __FILE__;
208 newXS("UNIVERSAL::isa", XS_UNIVERSAL_isa, file);
209 newXS("UNIVERSAL::can", XS_UNIVERSAL_can, file);
210 newXS("UNIVERSAL::VERSION", XS_UNIVERSAL_VERSION, file);
212 /* register the overloading (type 'A') magic */
213 PL_amagic_generation++;
214 /* Make it findable via fetchmethod */
215 newXS("version::()", XS_version_noop, file);
216 newXS("version::new", XS_version_new, file);
217 newXS("version::(\"\"", XS_version_stringify, file);
218 newXS("version::stringify", XS_version_stringify, file);
219 newXS("version::(0+", XS_version_numify, file);
220 newXS("version::numify", XS_version_numify, file);
221 newXS("version::(cmp", XS_version_vcmp, file);
222 newXS("version::(<=>", XS_version_vcmp, file);
223 newXS("version::vcmp", XS_version_vcmp, file);
224 newXS("version::(bool", XS_version_boolean, file);
225 newXS("version::boolean", XS_version_boolean, file);
226 newXS("version::(nomethod", XS_version_noop, file);
227 newXS("version::noop", XS_version_noop, file);
228 newXS("version::is_alpha", XS_version_is_alpha, file);
229 newXS("version::qv", XS_version_qv, file);
231 newXS("utf8::is_utf8", XS_utf8_is_utf8, file);
232 newXS("utf8::valid", XS_utf8_valid, file);
233 newXS("utf8::encode", XS_utf8_encode, file);
234 newXS("utf8::decode", XS_utf8_decode, file);
235 newXS("utf8::upgrade", XS_utf8_upgrade, file);
236 newXS("utf8::downgrade", XS_utf8_downgrade, file);
237 newXS("utf8::native_to_unicode", XS_utf8_native_to_unicode, file);
238 newXS("utf8::unicode_to_native", XS_utf8_unicode_to_native, file);
239 newXSproto("Internals::SvREADONLY",XS_Internals_SvREADONLY, file, "\\[$%@];$");
240 newXSproto("Internals::SvREFCNT",XS_Internals_SvREFCNT, file, "\\[$%@];$");
241 newXSproto("Internals::hv_clear_placeholders",
242 XS_Internals_hv_clear_placehold, file, "\\%");
243 newXSproto("PerlIO::get_layers",
244 XS_PerlIO_get_layers, file, "*;@");
245 newXS("Regexp::DESTROY", XS_Regexp_DESTROY, file);
246 newXSproto("Internals::hash_seed",XS_Internals_hash_seed, file, "");
247 newXSproto("Internals::rehash_seed",XS_Internals_rehash_seed, file, "");
248 newXSproto("Internals::HvREHASH", XS_Internals_HvREHASH, file, "\\%");
259 Perl_croak(aTHX_ "Usage: UNIVERSAL::isa(reference, kind)");
266 if (!SvOK(sv) || !(SvROK(sv) || (SvPOK(sv) && SvCUR(sv))
267 || (SvGMAGICAL(sv) && SvPOKp(sv) && SvCUR(sv))))
270 name = SvPV_nolen_const(ST(1));
272 ST(0) = boolSV(sv_derived_from(sv, name));
285 Perl_croak(aTHX_ "Usage: UNIVERSAL::can(object-ref, method)");
292 if (!SvOK(sv) || !(SvROK(sv) || (SvPOK(sv) && SvCUR(sv))
293 || (SvGMAGICAL(sv) && SvPOKp(sv) && SvCUR(sv))))
296 name = SvPV_nolen_const(ST(1));
305 pkg = gv_stashsv(sv, FALSE);
309 GV *gv = gv_fetchmethod_autoload(pkg, name, FALSE);
311 rv = sv_2mortal(newRV((SV*)GvCV(gv)));
318 XS(XS_UNIVERSAL_VERSION)
328 sv = (SV*)SvRV(ST(0));
330 Perl_croak(aTHX_ "Cannot find version of an unblessed reference");
334 pkg = gv_stashsv(ST(0), FALSE);
337 gvp = pkg ? (GV**)hv_fetch(pkg,"VERSION",7,FALSE) : Null(GV**);
339 if (gvp && isGV(gv = *gvp) && SvOK(sv = GvSV(gv))) {
340 SV *nsv = sv_newmortal();
343 if ( !sv_derived_from(sv, "version"))
348 sv = (SV*)&PL_sv_undef;
357 const char *name = HvNAME_get(pkg);
359 "%s does not define $%s::VERSION--version check failed",
363 "%s defines neither package nor VERSION--version check failed",
364 SvPVx_nolen_const(ST(0)) );
368 if ( !sv_derived_from(req, "version")) {
369 /* req may very well be R/O, so create a new object */
370 SV *nsv = sv_newmortal();
376 if ( vcmp( req, sv ) > 0 )
377 Perl_croak(aTHX_ "%s version %"SVf" (%"SVf") required--"
378 "this is only version %"SVf" (%"SVf")", HvNAME_get(pkg),
379 vnumify(req),vnormal(req),vnumify(sv),vnormal(sv));
382 if ( SvOK(sv) && sv_derived_from(sv, "version") ) {
395 Perl_croak(aTHX_ "Usage: version::new(class, version)");
398 const char *classname = SvPV_nolen(ST(0));
404 Perl_sv_setpvf(aTHX_ vs,"v%s",SvPV_nolen(ST(2)));
407 rv = new_version(vs);
408 if ( strcmp(classname,"version") != 0 ) /* inherited new() */
409 sv_bless(rv, gv_stashpv(classname,TRUE));
411 PUSHs(sv_2mortal(rv));
417 XS(XS_version_stringify)
421 Perl_croak(aTHX_ "Usage: version::stringify(lobj, ...)");
426 if (sv_derived_from(ST(0), "version")) {
427 SV *tmp = SvRV(ST(0));
431 Perl_croak(aTHX_ "lobj is not of type version");
433 PUSHs(sv_2mortal(vstringify(lobj)));
440 XS(XS_version_numify)
444 Perl_croak(aTHX_ "Usage: version::numify(lobj, ...)");
449 if (sv_derived_from(ST(0), "version")) {
450 SV *tmp = SvRV(ST(0));
454 Perl_croak(aTHX_ "lobj is not of type version");
456 PUSHs(sv_2mortal(vnumify(lobj)));
467 Perl_croak(aTHX_ "Usage: version::vcmp(lobj, ...)");
472 if (sv_derived_from(ST(0), "version")) {
473 SV *tmp = SvRV(ST(0));
477 Perl_croak(aTHX_ "lobj is not of type version");
483 IV swap = (IV)SvIV(ST(2));
485 if ( ! sv_derived_from(robj, "version") )
487 robj = new_version(robj);
493 rs = newSViv(vcmp(rvs,lobj));
497 rs = newSViv(vcmp(lobj,rvs));
500 PUSHs(sv_2mortal(rs));
508 XS(XS_version_boolean)
512 Perl_croak(aTHX_ "Usage: version::boolean(lobj, ...)");
517 if (sv_derived_from(ST(0), "version")) {
518 /* XXX If tmp serves a purpose, explain it. */
519 SV *tmp = SvRV(ST(0));
523 Perl_croak(aTHX_ "lobj is not of type version");
527 rs = newSViv( vcmp(lobj,new_version(newSVpvn("0",1))) );
528 PUSHs(sv_2mortal(rs));
540 Perl_croak(aTHX_ "Usage: version::noop(lobj, ...)");
541 if (sv_derived_from(ST(0), "version"))
542 Perl_croak(aTHX_ "operation not supported with version object");
544 Perl_croak(aTHX_ "lobj is not of type version");
545 #ifndef HASATTRIBUTE_NORETURN
550 XS(XS_version_is_alpha)
554 Perl_croak(aTHX_ "Usage: version::is_alpha(lobj)");
559 if (sv_derived_from(ST(0), "version")) {
560 /* XXX If tmp serves a purpose, explain it. */
561 SV *tmp = SvRV(ST(0));
565 Perl_croak(aTHX_ "lobj is not of type version");
567 const I32 len = av_len((AV *)lobj);
568 const I32 digit = SvIVX(*av_fetch((AV *)lobj, len, 0));
583 Perl_croak(aTHX_ "Usage: version::qv(ver)");
587 if ( !SvVOK(ver) ) /* only need to do with if not already v-string */
589 SV *vs = sv_newmortal();
591 if ( SvNOK(ver) ) /* may get too much accuracy */
594 sprintf(tbuf,"%.9"NVgf, SvNVX(ver));
595 version = savepv(tbuf);
599 version = savesvpv(ver);
601 (void)scan_version(version,vs,TRUE);
608 PUSHs(sv_2mortal(new_version(ver)));
620 Perl_croak(aTHX_ "Usage: utf8::is_utf8(sv)");
622 const SV *sv = ST(0);
637 Perl_croak(aTHX_ "Usage: utf8::valid(sv)");
642 const char *s = SvPV_const(sv,len);
643 if (!SvUTF8(sv) || is_utf8_string((const U8*)s,len))
656 Perl_croak(aTHX_ "Usage: utf8::encode(sv)");
669 Perl_croak(aTHX_ "Usage: utf8::decode(sv)");
672 const bool RETVAL = sv_utf8_decode(sv);
673 ST(0) = boolSV(RETVAL);
683 Perl_croak(aTHX_ "Usage: utf8::upgrade(sv)");
689 RETVAL = sv_utf8_upgrade(sv);
690 XSprePUSH; PUSHi((IV)RETVAL);
695 XS(XS_utf8_downgrade)
698 if (items < 1 || items > 2)
699 Perl_croak(aTHX_ "Usage: utf8::downgrade(sv, failok=0)");
702 const bool failok = (items < 2) ? 0 : (int)SvIV(ST(1));
703 const bool RETVAL = sv_utf8_downgrade(sv, failok);
705 ST(0) = boolSV(RETVAL);
711 XS(XS_utf8_native_to_unicode)
714 const UV uv = SvUV(ST(0));
717 Perl_croak(aTHX_ "Usage: utf8::native_to_unicode(sv)");
719 ST(0) = sv_2mortal(newSViv(NATIVE_TO_UNI(uv)));
723 XS(XS_utf8_unicode_to_native)
726 const UV uv = SvUV(ST(0));
729 Perl_croak(aTHX_ "Usage: utf8::unicode_to_native(sv)");
731 ST(0) = sv_2mortal(newSViv(UNI_TO_NATIVE(uv)));
735 XS(XS_Internals_SvREADONLY) /* This is dangerous stuff. */
738 SV *sv = SvRV(ST(0));
746 else if (items == 2) {
752 /* I hope you really know what you are doing. */
757 XSRETURN_UNDEF; /* Can't happen. */
760 XS(XS_Internals_SvREFCNT) /* This is dangerous stuff. */
763 SV *sv = SvRV(ST(0));
766 XSRETURN_IV(SvREFCNT(sv) - 1); /* Minus the ref created for us. */
767 else if (items == 2) {
768 /* I hope you really know what you are doing. */
769 SvREFCNT(sv) = SvIV(ST(1));
770 XSRETURN_IV(SvREFCNT(sv));
772 XSRETURN_UNDEF; /* Can't happen. */
775 XS(XS_Internals_hv_clear_placehold)
778 HV *hv = (HV *) SvRV(ST(0));
781 Perl_croak(aTHX_ "Usage: UNIVERSAL::hv_clear_placeholders(hv)");
782 hv_clear_placeholders(hv);
786 XS(XS_Regexp_DESTROY)
790 XS(XS_PerlIO_get_layers)
793 if (items < 1 || items % 2 == 0)
794 Perl_croak(aTHX_ "Usage: PerlIO_get_layers(filehandle[,args])");
801 bool details = FALSE;
806 for (svp = MARK + 2; svp <= SP; svp += 2) {
810 const char *key = SvPV_const(*varp, klen);
814 if (klen == 5 && memEQ(key, "input", 5)) {
815 input = SvTRUE(*valp);
820 if (klen == 6 && memEQ(key, "output", 6)) {
821 input = !SvTRUE(*valp);
826 if (klen == 7 && memEQ(key, "details", 7)) {
827 details = SvTRUE(*valp);
834 "get_layers: unknown argument '%s'",
846 if (SvROK(sv) && isGV(SvRV(sv)))
849 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
852 if (gv && (io = GvIO(gv))) {
854 AV* av = PerlIO_get_layers(aTHX_ input ?
855 IoIFP(io) : IoOFP(io));
857 I32 last = av_len(av);
860 for (i = last; i >= 0; i -= 3) {
864 bool namok, argok, flgok;
866 namsvp = av_fetch(av, i - 2, FALSE);
867 argsvp = av_fetch(av, i - 1, FALSE);
868 flgsvp = av_fetch(av, i, FALSE);
870 namok = namsvp && *namsvp && SvPOK(*namsvp);
871 argok = argsvp && *argsvp && SvPOK(*argsvp);
872 flgok = flgsvp && *flgsvp && SvIOK(*flgsvp);
876 newSVpv(SvPVX_const(*namsvp), 0) : &PL_sv_undef);
878 newSVpv(SvPVX_const(*argsvp), 0) : &PL_sv_undef);
880 XPUSHi(SvIVX(*flgsvp));
882 XPUSHs(&PL_sv_undef);
887 XPUSHs(Perl_newSVpvf(aTHX_ "%"SVf"(%"SVf")",
890 XPUSHs(Perl_newSVpvf(aTHX_ "%"SVf, *namsvp));
892 XPUSHs(&PL_sv_undef);
895 IV flags = SvIVX(*flgsvp);
897 if (flags & PERLIO_F_UTF8) {
898 XPUSHs(newSVpvn("utf8", 4));
915 XS(XS_Internals_hash_seed)
917 /* Using dXSARGS would also have dITEM and dSP,
918 * which define 2 unused local variables. */
921 XSRETURN_UV(PERL_HASH_SEED);
924 XS(XS_Internals_rehash_seed)
926 /* Using dXSARGS would also have dITEM and dSP,
927 * which define 2 unused local variables. */
930 XSRETURN_UV(PL_rehash_seed);
933 XS(XS_Internals_HvREHASH) /* Subject to change */
937 const HV *hv = (HV *) SvRV(ST(0));
938 if (items == 1 && SvTYPE(hv) == SVt_PVHV) {
945 Perl_croak(aTHX_ "Internals::HvREHASH $hashref");
950 * c-indentation-style: bsd
952 * indent-tabs-mode: t
955 * ex: set ts=8 sts=4 sw=4 noet: