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,
44 /* A stash/class can go by many names (ie. User == main::User), so
45 we compare the stash itself just in case */
46 if (name_stash && (stash == name_stash))
49 if (strEQ(HvNAME(stash), name))
52 if (strEQ(name, "UNIVERSAL"))
56 Perl_croak(aTHX_ "Recursive inheritance detected in package '%s'",
59 gvp = (GV**)hv_fetch(stash, "::ISA::CACHE::", 14, FALSE);
61 if (gvp && (gv = *gvp) != (GV*)&PL_sv_undef && (subgen = GvSV(gv))
64 if (SvIV(subgen) == (IV)PL_sub_generation) {
66 SV** svp = (SV**)hv_fetch(hv, name, len, FALSE);
67 if (svp && (sv = *svp) != (SV*)&PL_sv_undef) {
68 DEBUG_o( Perl_deb(aTHX_ "Using cached ISA %s for package %s\n",
69 name, HvNAME(stash)) );
74 DEBUG_o( Perl_deb(aTHX_ "ISA Cache in package %s is stale\n",
77 sv_setiv(subgen, PL_sub_generation);
81 gvp = (GV**)hv_fetch(stash,"ISA",3,FALSE);
83 if (gvp && (gv = *gvp) != (GV*)&PL_sv_undef && (av = GvAV(gv))) {
85 gvp = (GV**)hv_fetch(stash, "::ISA::CACHE::", 14, TRUE);
89 if (SvTYPE(gv) != SVt_PVGV)
90 gv_init(gv, stash, "::ISA::CACHE::", 14, TRUE);
95 subgen = newSViv(PL_sub_generation);
100 SV** svp = AvARRAY(av);
101 /* NOTE: No support for tied ISA */
102 I32 items = AvFILLp(av) + 1;
105 HV* basestash = gv_stashsv(sv, FALSE);
107 if (ckWARN(WARN_MISC))
108 Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
109 "Can't locate package %"SVf" for @%s::ISA",
113 if (&PL_sv_yes == isa_lookup(basestash, name, name_stash,
115 (void)hv_store(hv,name,len,&PL_sv_yes,0);
119 (void)hv_store(hv,name,len,&PL_sv_no,0);
126 =head1 SV Manipulation Functions
128 =for apidoc sv_derived_from
130 Returns a boolean indicating whether the SV is derived from the specified
131 class. This is the function that implements C<UNIVERSAL::isa>. It works
132 for class names as well as for objects.
138 Perl_sv_derived_from(pTHX_ SV *sv, const char *name)
140 const char *type = Nullch;
149 type = sv_reftype(sv,0);
154 stash = gv_stashsv(sv, FALSE);
157 name_stash = gv_stashpv(name, FALSE);
159 return (type && strEQ(type,name)) ||
160 (stash && isa_lookup(stash, name, name_stash, strlen(name), 0)
168 PERL_XS_EXPORT_C void XS_UNIVERSAL_isa(pTHX_ CV *cv);
169 PERL_XS_EXPORT_C void XS_UNIVERSAL_can(pTHX_ CV *cv);
170 PERL_XS_EXPORT_C void XS_UNIVERSAL_VERSION(pTHX_ CV *cv);
172 XS(XS_version_stringify);
173 XS(XS_version_numify);
175 XS(XS_version_boolean);
177 XS(XS_version_is_alpha);
184 XS(XS_utf8_downgrade);
185 XS(XS_utf8_unicode_to_native);
186 XS(XS_utf8_native_to_unicode);
187 XS(XS_Internals_SvREADONLY);
188 XS(XS_Internals_SvREFCNT);
189 XS(XS_Internals_hv_clear_placehold);
190 XS(XS_PerlIO_get_layers);
191 XS(XS_Regexp_DESTROY);
192 XS(XS_Internals_hash_seed);
193 XS(XS_Internals_rehash_seed);
194 XS(XS_Internals_HvREHASH);
197 Perl_boot_core_UNIVERSAL(pTHX)
199 const char file[] = __FILE__;
201 newXS("UNIVERSAL::isa", XS_UNIVERSAL_isa, file);
202 newXS("UNIVERSAL::can", XS_UNIVERSAL_can, file);
203 newXS("UNIVERSAL::VERSION", XS_UNIVERSAL_VERSION, file);
205 /* register the overloading (type 'A') magic */
206 PL_amagic_generation++;
207 /* Make it findable via fetchmethod */
208 newXS("version::()", XS_version_noop, file);
209 newXS("version::new", XS_version_new, file);
210 newXS("version::(\"\"", XS_version_stringify, file);
211 newXS("version::stringify", XS_version_stringify, file);
212 newXS("version::(0+", XS_version_numify, file);
213 newXS("version::numify", XS_version_numify, file);
214 newXS("version::(cmp", XS_version_vcmp, file);
215 newXS("version::(<=>", XS_version_vcmp, file);
216 newXS("version::vcmp", XS_version_vcmp, file);
217 newXS("version::(bool", XS_version_boolean, file);
218 newXS("version::boolean", XS_version_boolean, file);
219 newXS("version::(nomethod", XS_version_noop, file);
220 newXS("version::noop", XS_version_noop, file);
221 newXS("version::is_alpha", XS_version_is_alpha, file);
222 newXS("version::qv", XS_version_qv, file);
224 newXS("utf8::is_utf8", XS_utf8_is_utf8, file);
225 newXS("utf8::valid", XS_utf8_valid, file);
226 newXS("utf8::encode", XS_utf8_encode, file);
227 newXS("utf8::decode", XS_utf8_decode, file);
228 newXS("utf8::upgrade", XS_utf8_upgrade, file);
229 newXS("utf8::downgrade", XS_utf8_downgrade, file);
230 newXS("utf8::native_to_unicode", XS_utf8_native_to_unicode, file);
231 newXS("utf8::unicode_to_native", XS_utf8_unicode_to_native, file);
232 newXSproto("Internals::SvREADONLY",XS_Internals_SvREADONLY, file, "\\[$%@];$");
233 newXSproto("Internals::SvREFCNT",XS_Internals_SvREFCNT, file, "\\[$%@];$");
234 newXSproto("Internals::hv_clear_placeholders",
235 XS_Internals_hv_clear_placehold, file, "\\%");
236 newXSproto("PerlIO::get_layers",
237 XS_PerlIO_get_layers, file, "*;@");
238 newXS("Regexp::DESTROY", XS_Regexp_DESTROY, file);
239 newXSproto("Internals::hash_seed",XS_Internals_hash_seed, file, "");
240 newXSproto("Internals::rehash_seed",XS_Internals_rehash_seed, file, "");
241 newXSproto("Internals::HvREHASH", XS_Internals_HvREHASH, file, "\\%");
253 Perl_croak(aTHX_ "Usage: UNIVERSAL::isa(reference, kind)");
260 if (!SvOK(sv) || !(SvROK(sv) || (SvPOK(sv) && SvCUR(sv))
261 || (SvGMAGICAL(sv) && SvPOKp(sv) && SvCUR(sv))))
264 name = (const char *)SvPV(ST(1),n_a);
266 ST(0) = boolSV(sv_derived_from(sv, name));
280 Perl_croak(aTHX_ "Usage: UNIVERSAL::can(object-ref, method)");
287 if (!SvOK(sv) || !(SvROK(sv) || (SvPOK(sv) && SvCUR(sv))
288 || (SvGMAGICAL(sv) && SvPOKp(sv) && SvCUR(sv))))
291 name = (const char *)SvPV(ST(1),n_a);
300 pkg = gv_stashsv(sv, FALSE);
304 GV *gv = gv_fetchmethod_autoload(pkg, name, FALSE);
306 rv = sv_2mortal(newRV((SV*)GvCV(gv)));
313 XS(XS_UNIVERSAL_VERSION)
323 sv = (SV*)SvRV(ST(0));
325 Perl_croak(aTHX_ "Cannot find version of an unblessed reference");
329 pkg = gv_stashsv(ST(0), FALSE);
332 gvp = pkg ? (GV**)hv_fetch(pkg,"VERSION",7,FALSE) : Null(GV**);
334 if (gvp && isGV(gv = *gvp) && SvOK(sv = GvSV(gv))) {
335 SV *nsv = sv_newmortal();
338 if ( !sv_derived_from(sv, "version"))
343 sv = (SV*)&PL_sv_undef;
353 "%s does not define $%s::VERSION--version check failed",
354 HvNAME(pkg), HvNAME(pkg));
358 "%s defines neither package nor VERSION--version check failed",
363 if ( !sv_derived_from(req, "version")) {
364 /* req may very well be R/O, so create a new object */
365 SV *nsv = sv_newmortal();
371 if ( vcmp( req, sv ) > 0 )
372 Perl_croak(aTHX_ "%s version %"SVf" (%"SVf") required--"
373 "this is only version %"SVf" (%"SVf")", HvNAME(pkg),
374 vnumify(req),vnormal(req),vnumify(sv),vnormal(sv));
377 if ( SvOK(sv) && sv_derived_from(sv, "version") ) {
390 Perl_croak(aTHX_ "Usage: version::new(class, version)");
393 const char *classname = SvPV_nolen(ST(0));
399 Perl_sv_setpvf(aTHX_ vs,"v%s",SvPV_nolen(ST(2)));
402 rv = new_version(vs);
403 if ( strcmp(classname,"version") != 0 ) /* inherited new() */
404 sv_bless(rv, gv_stashpv(classname,TRUE));
406 PUSHs(sv_2mortal(rv));
412 XS(XS_version_stringify)
416 Perl_croak(aTHX_ "Usage: version::stringify(lobj, ...)");
421 if (sv_derived_from(ST(0), "version")) {
422 SV *tmp = SvRV(ST(0));
426 Perl_croak(aTHX_ "lobj is not of type version");
428 PUSHs(sv_2mortal(vstringify(lobj)));
435 XS(XS_version_numify)
439 Perl_croak(aTHX_ "Usage: version::numify(lobj, ...)");
444 if (sv_derived_from(ST(0), "version")) {
445 SV *tmp = SvRV(ST(0));
449 Perl_croak(aTHX_ "lobj is not of type version");
451 PUSHs(sv_2mortal(vnumify(lobj)));
462 Perl_croak(aTHX_ "Usage: version::vcmp(lobj, ...)");
467 if (sv_derived_from(ST(0), "version")) {
468 SV *tmp = SvRV(ST(0));
472 Perl_croak(aTHX_ "lobj is not of type version");
478 IV swap = (IV)SvIV(ST(2));
480 if ( ! sv_derived_from(robj, "version") )
482 robj = new_version(robj);
488 rs = newSViv(vcmp(rvs,lobj));
492 rs = newSViv(vcmp(lobj,rvs));
495 PUSHs(sv_2mortal(rs));
503 XS(XS_version_boolean)
507 Perl_croak(aTHX_ "Usage: version::boolean(lobj, ...)");
512 if (sv_derived_from(ST(0), "version")) {
513 /* XXX If tmp serves a purpose, explain it. */
514 SV *tmp = SvRV(ST(0));
518 Perl_croak(aTHX_ "lobj is not of type version");
522 rs = newSViv( vcmp(lobj,new_version(newSVpvn("0",1))) );
523 PUSHs(sv_2mortal(rs));
535 Perl_croak(aTHX_ "Usage: version::noop(lobj, ...)");
539 if (sv_derived_from(ST(0), "version")) {
540 SV *tmp = SvRV(ST(0));
544 Perl_croak(aTHX_ "lobj is not of type version");
547 Perl_croak(aTHX_ "operation not supported with version object");
554 XS(XS_version_is_alpha)
558 Perl_croak(aTHX_ "Usage: version::is_alpha(lobj)");
563 if (sv_derived_from(ST(0), "version")) {
564 /* XXX If tmp serves a purpose, explain it. */
565 SV *tmp = SvRV(ST(0));
569 Perl_croak(aTHX_ "lobj is not of type version");
571 const I32 len = av_len((AV *)lobj);
572 const I32 digit = SvIVX(*av_fetch((AV *)lobj, len, 0));
587 Perl_croak(aTHX_ "Usage: version::qv(ver)");
591 if ( !SvVOK(ver) ) /* only need to do with if not already v-string */
593 SV *vs = sv_newmortal();
595 if ( SvNOK(ver) ) /* may get too much accuracy */
598 sprintf(tbuf,"%.9"NVgf, SvNVX(ver));
599 version = savepv(tbuf);
603 version = savesvpv(ver);
605 (void)scan_version(version,vs,TRUE);
612 PUSHs(sv_2mortal(new_version(ver)));
624 Perl_croak(aTHX_ "Usage: utf8::is_utf8(sv)");
626 const SV *sv = ST(0);
641 Perl_croak(aTHX_ "Usage: utf8::valid(sv)");
646 const char *s = SvPV(sv,len);
647 if (!SvUTF8(sv) || is_utf8_string((const U8*)s,len))
660 Perl_croak(aTHX_ "Usage: utf8::encode(sv)");
673 Perl_croak(aTHX_ "Usage: utf8::decode(sv)");
676 const bool RETVAL = sv_utf8_decode(sv);
677 ST(0) = boolSV(RETVAL);
687 Perl_croak(aTHX_ "Usage: utf8::upgrade(sv)");
693 RETVAL = sv_utf8_upgrade(sv);
694 XSprePUSH; PUSHi((IV)RETVAL);
699 XS(XS_utf8_downgrade)
702 if (items < 1 || items > 2)
703 Perl_croak(aTHX_ "Usage: utf8::downgrade(sv, failok=0)");
706 const bool failok = (items < 2) ? 0 : (int)SvIV(ST(1));
707 const bool RETVAL = sv_utf8_downgrade(sv, failok);
709 ST(0) = boolSV(RETVAL);
715 XS(XS_utf8_native_to_unicode)
718 const UV uv = SvUV(ST(0));
721 Perl_croak(aTHX_ "Usage: utf8::native_to_unicode(sv)");
723 ST(0) = sv_2mortal(newSViv(NATIVE_TO_UNI(uv)));
727 XS(XS_utf8_unicode_to_native)
730 const UV uv = SvUV(ST(0));
733 Perl_croak(aTHX_ "Usage: utf8::unicode_to_native(sv)");
735 ST(0) = sv_2mortal(newSViv(UNI_TO_NATIVE(uv)));
739 XS(XS_Internals_SvREADONLY) /* This is dangerous stuff. */
742 SV *sv = SvRV(ST(0));
750 else if (items == 2) {
756 /* I hope you really know what you are doing. */
761 XSRETURN_UNDEF; /* Can't happen. */
764 XS(XS_Internals_SvREFCNT) /* This is dangerous stuff. */
767 SV *sv = SvRV(ST(0));
770 XSRETURN_IV(SvREFCNT(sv) - 1); /* Minus the ref created for us. */
771 else if (items == 2) {
772 /* I hope you really know what you are doing. */
773 SvREFCNT(sv) = SvIV(ST(1));
774 XSRETURN_IV(SvREFCNT(sv));
776 XSRETURN_UNDEF; /* Can't happen. */
779 XS(XS_Internals_hv_clear_placehold)
782 HV *hv = (HV *) SvRV(ST(0));
785 Perl_croak(aTHX_ "Usage: UNIVERSAL::hv_clear_placeholders(hv)");
786 hv_clear_placeholders(hv);
790 XS(XS_Regexp_DESTROY)
794 XS(XS_PerlIO_get_layers)
797 if (items < 1 || items % 2 == 0)
798 Perl_croak(aTHX_ "Usage: PerlIO_get_layers(filehandle[,args])");
805 bool details = FALSE;
810 for (svp = MARK + 2; svp <= SP; svp += 2) {
814 const char *key = SvPV(*varp, klen);
818 if (klen == 5 && memEQ(key, "input", 5)) {
819 input = SvTRUE(*valp);
824 if (klen == 6 && memEQ(key, "output", 6)) {
825 input = !SvTRUE(*valp);
830 if (klen == 7 && memEQ(key, "details", 7)) {
831 details = SvTRUE(*valp);
838 "get_layers: unknown argument '%s'",
850 if (SvROK(sv) && isGV(SvRV(sv)))
853 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
856 if (gv && (io = GvIO(gv))) {
858 AV* av = PerlIO_get_layers(aTHX_ input ?
859 IoIFP(io) : IoOFP(io));
861 I32 last = av_len(av);
864 for (i = last; i >= 0; i -= 3) {
868 bool namok, argok, flgok;
870 namsvp = av_fetch(av, i - 2, FALSE);
871 argsvp = av_fetch(av, i - 1, FALSE);
872 flgsvp = av_fetch(av, i, FALSE);
874 namok = namsvp && *namsvp && SvPOK(*namsvp);
875 argok = argsvp && *argsvp && SvPOK(*argsvp);
876 flgok = flgsvp && *flgsvp && SvIOK(*flgsvp);
880 newSVpv(SvPVX(*namsvp), 0) : &PL_sv_undef);
882 newSVpv(SvPVX(*argsvp), 0) : &PL_sv_undef);
884 XPUSHi(SvIVX(*flgsvp));
886 XPUSHs(&PL_sv_undef);
891 XPUSHs(Perl_newSVpvf(aTHX_ "%"SVf"(%"SVf")",
894 XPUSHs(Perl_newSVpvf(aTHX_ "%"SVf, *namsvp));
896 XPUSHs(&PL_sv_undef);
899 IV flags = SvIVX(*flgsvp);
901 if (flags & PERLIO_F_UTF8) {
902 XPUSHs(newSVpvn("utf8", 4));
919 XS(XS_Internals_hash_seed)
921 /* Using dXSARGS would also have dITEM and dSP,
922 * which define 2 unused local variables. */
924 XSRETURN_UV(PERL_HASH_SEED);
927 XS(XS_Internals_rehash_seed)
929 /* Using dXSARGS would also have dITEM and dSP,
930 * which define 2 unused local variables. */
932 XSRETURN_UV(PL_rehash_seed);
935 XS(XS_Internals_HvREHASH) /* Subject to change */
939 const HV *hv = (HV *) SvRV(ST(0));
940 if (items == 1 && SvTYPE(hv) == SVt_PVHV) {
947 Perl_croak(aTHX_ "Internals::HvREHASH $hashref");
952 * c-indentation-style: bsd
954 * indent-tabs-mode: t
957 * ex: set ts=8 sts=4 sw=4 noet: