Revert change #22520 (optimise away my $foo = undef and similar

[p5sagit/p5-mst-13.2.git] / universal.c

/*    universal.c
 *
 *    Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
 *    2005, by Larry Wall and others
 *
 *    You may distribute under the terms of either the GNU General Public
 *    License or the Artistic License, as specified in the README file.
 *
 */

/*
 * "The roots of those mountains must be roots indeed; there must be
 * great secrets buried there which have not been discovered since the
 * beginning." --Gandalf, relating Gollum's story
 */

/* This file contains the code that implements the functions in Perl's
 * UNIVERSAL package, such as UNIVERSAL->can().
 */

#include "EXTERN.h"
#define PERL_IN_UNIVERSAL_C
#include "perl.h"

#ifdef USE_PERLIO
#include "perliol.h" /* For the PERLIO_F_XXX */
#endif

/*
 * Contributed by Graham Barr  <Graham.Barr@tiuk.ti.com>
 * The main guts of traverse_isa was actually copied from gv_fetchmeth
 */

STATIC SV *
S_isa_lookup(pTHX_ HV *stash, const char *name, HV* name_stash,
             int len, int level)
{
    AV* av;
    GV* gv;
    GV** gvp;
    HV* hv = Nullhv;
    SV* subgen = Nullsv;
    const char *hvname;

    /* A stash/class can go by many names (ie. User == main::User), so 
       we compare the stash itself just in case */
    if (name_stash && (stash == name_stash))
        return &PL_sv_yes;

    hvname = HvNAME_get(stash);

    if (strEQ(hvname, name))
	return &PL_sv_yes;

    if (strEQ(name, "UNIVERSAL"))
	return &PL_sv_yes;

    if (level > 100)
	Perl_croak(aTHX_ "Recursive inheritance detected in package '%s'",
		   hvname);

    gvp = (GV**)hv_fetch(stash, "::ISA::CACHE::", 14, FALSE);

    if (gvp && (gv = *gvp) != (GV*)&PL_sv_undef && (subgen = GvSV(gv))
	&& (hv = GvHV(gv)))
    {
	if (SvIV(subgen) == (IV)PL_sub_generation) {
	    SV* sv;
	    SV** const svp = (SV**)hv_fetch(hv, name, len, FALSE);
	    if (svp && (sv = *svp) != (SV*)&PL_sv_undef) {
	        DEBUG_o( Perl_deb(aTHX_ "Using cached ISA %s for package %s\n",
				  name, hvname) );
		return sv;
	    }
	}
	else {
	    DEBUG_o( Perl_deb(aTHX_ "ISA Cache in package %s is stale\n",
			      hvname) );
	    hv_clear(hv);
	    sv_setiv(subgen, PL_sub_generation);
	}
    }

    gvp = (GV**)hv_fetch(stash,"ISA",3,FALSE);

    if (gvp && (gv = *gvp) != (GV*)&PL_sv_undef && (av = GvAV(gv))) {
	if (!hv || !subgen) {
	    gvp = (GV**)hv_fetch(stash, "::ISA::CACHE::", 14, TRUE);

	    gv = *gvp;

	    if (SvTYPE(gv) != SVt_PVGV)
		gv_init(gv, stash, "::ISA::CACHE::", 14, TRUE);

	    if (!hv)
		hv = GvHVn(gv);
	    if (!subgen) {
		subgen = newSViv(PL_sub_generation);
		GvSV(gv) = subgen;
	    }
	}
	if (hv) {
	    SV** svp = AvARRAY(av);
	    /* NOTE: No support for tied ISA */
	    I32 items = AvFILLp(av) + 1;
	    while (items--) {
		SV* const sv = *svp++;
		HV* const basestash = gv_stashsv(sv, FALSE);
		if (!basestash) {
		    if (ckWARN(WARN_MISC))
			Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
				    "Can't locate package %"SVf" for @%s::ISA",
				    sv, hvname);
		    continue;
		}
		if (&PL_sv_yes == isa_lookup(basestash, name, name_stash, 
                                             len, level + 1)) {
		    (void)hv_store(hv,name,len,&PL_sv_yes,0);
		    return &PL_sv_yes;
		}
	    }
	    (void)hv_store(hv,name,len,&PL_sv_no,0);
	}
    }
    return &PL_sv_no;
}

/*
=head1 SV Manipulation Functions

=for apidoc sv_derived_from

Returns a boolean indicating whether the SV is derived from the specified
class.  This is the function that implements C<UNIVERSAL::isa>.  It works
for class names as well as for objects.

=cut
*/

bool
Perl_sv_derived_from(pTHX_ SV *sv, const char *name)
{
    const char *type = Nullch;
    HV *stash = Nullhv;
    HV *name_stash;

    SvGETMAGIC(sv);

    if (SvROK(sv)) {
        sv = SvRV(sv);
        type = sv_reftype(sv,0);
        if (SvOBJECT(sv))
            stash = SvSTASH(sv);
    }
    else {
        stash = gv_stashsv(sv, FALSE);
    }

    name_stash = gv_stashpv(name, FALSE);

    return (type && strEQ(type,name)) ||
            (stash && isa_lookup(stash, name, name_stash, strlen(name), 0) 
             == &PL_sv_yes)
        ? TRUE
        : FALSE ;
}

#include "XSUB.h"

PERL_XS_EXPORT_C void XS_UNIVERSAL_isa(pTHX_ CV *cv);
PERL_XS_EXPORT_C void XS_UNIVERSAL_can(pTHX_ CV *cv);
PERL_XS_EXPORT_C void XS_UNIVERSAL_VERSION(pTHX_ CV *cv);
XS(XS_version_new);
XS(XS_version_stringify);
XS(XS_version_numify);
XS(XS_version_normal);
XS(XS_version_vcmp);
XS(XS_version_boolean);
#ifdef HASATTRIBUTE_NORETURN
XS(XS_version_noop) __attribute__noreturn__;
#else
XS(XS_version_noop);
#endif
XS(XS_version_is_alpha);
XS(XS_version_qv);
XS(XS_utf8_is_utf8);
XS(XS_utf8_valid);
XS(XS_utf8_encode);
XS(XS_utf8_decode);
XS(XS_utf8_upgrade);
XS(XS_utf8_downgrade);
XS(XS_utf8_unicode_to_native);
XS(XS_utf8_native_to_unicode);
XS(XS_Internals_SvREADONLY);
XS(XS_Internals_SvREFCNT);
XS(XS_Internals_hv_clear_placehold);
XS(XS_PerlIO_get_layers);
XS(XS_Regexp_DESTROY);
XS(XS_Internals_hash_seed);
XS(XS_Internals_rehash_seed);
XS(XS_Internals_HvREHASH);
XS(XS_utf8_SWASHGET_heavy);

void
Perl_boot_core_UNIVERSAL(pTHX)
{
    const char file[] = __FILE__;

    newXS("UNIVERSAL::isa",             XS_UNIVERSAL_isa,         file);
    newXS("UNIVERSAL::can",             XS_UNIVERSAL_can,         file);
    newXS("UNIVERSAL::VERSION", 	XS_UNIVERSAL_VERSION, 	  file);
    {
	/* register the overloading (type 'A') magic */
	PL_amagic_generation++;
	/* Make it findable via fetchmethod */
	newXS("version::()", XS_version_noop, file);
	newXS("version::new", XS_version_new, file);
	newXS("version::(\"\"", XS_version_stringify, file);
	newXS("version::stringify", XS_version_stringify, file);
	newXS("version::(0+", XS_version_numify, file);
	newXS("version::numify", XS_version_numify, file);
	newXS("version::normal", XS_version_normal, file);
	newXS("version::(cmp", XS_version_vcmp, file);
	newXS("version::(<=>", XS_version_vcmp, file);
	newXS("version::vcmp", XS_version_vcmp, file);
	newXS("version::(bool", XS_version_boolean, file);
	newXS("version::boolean", XS_version_boolean, file);
	newXS("version::(nomethod", XS_version_noop, file);
	newXS("version::noop", XS_version_noop, file);
	newXS("version::is_alpha", XS_version_is_alpha, file);
	newXS("version::qv", XS_version_qv, file);
    }
    newXS("utf8::is_utf8", XS_utf8_is_utf8, file);
    newXS("utf8::valid", XS_utf8_valid, file);
    newXS("utf8::encode", XS_utf8_encode, file);
    newXS("utf8::decode", XS_utf8_decode, file);
    newXS("utf8::upgrade", XS_utf8_upgrade, file);
    newXS("utf8::downgrade", XS_utf8_downgrade, file);
    newXS("utf8::native_to_unicode", XS_utf8_native_to_unicode, file);
    newXS("utf8::unicode_to_native", XS_utf8_unicode_to_native, file);
    newXSproto("Internals::SvREADONLY",XS_Internals_SvREADONLY, file, "\\[$%@];$");
    newXSproto("Internals::SvREFCNT",XS_Internals_SvREFCNT, file, "\\[$%@];$");
    newXSproto("Internals::hv_clear_placeholders",
               XS_Internals_hv_clear_placehold, file, "\\%");
    newXSproto("PerlIO::get_layers",
               XS_PerlIO_get_layers, file, "*;@");
    newXS("Regexp::DESTROY", XS_Regexp_DESTROY, file);
    newXSproto("Internals::hash_seed",XS_Internals_hash_seed, file, "");
    newXSproto("Internals::rehash_seed",XS_Internals_rehash_seed, file, "");
    newXSproto("Internals::HvREHASH", XS_Internals_HvREHASH, file, "\\%");
    newXS("utf8::SWASHGET_heavy", XS_utf8_SWASHGET_heavy, file);
}


XS(XS_UNIVERSAL_isa)
{
    dXSARGS;

    if (items != 2)
	Perl_croak(aTHX_ "Usage: UNIVERSAL::isa(reference, kind)");
    else {
	SV * const sv = ST(0);
	const char *name;

	SvGETMAGIC(sv);

	if (!SvOK(sv) || !(SvROK(sv) || (SvPOK(sv) && SvCUR(sv))
		    || (SvGMAGICAL(sv) && SvPOKp(sv) && SvCUR(sv))))
	    XSRETURN_UNDEF;

	name = SvPV_nolen_const(ST(1));

	ST(0) = boolSV(sv_derived_from(sv, name));
	XSRETURN(1);
    }
}

XS(XS_UNIVERSAL_can)
{
    dXSARGS;
    SV   *sv;
    const char *name;
    SV   *rv;
    HV   *pkg = NULL;

    if (items != 2)
	Perl_croak(aTHX_ "Usage: UNIVERSAL::can(object-ref, method)");

    sv = ST(0);

    SvGETMAGIC(sv);

    if (!SvOK(sv) || !(SvROK(sv) || (SvPOK(sv) && SvCUR(sv))
		|| (SvGMAGICAL(sv) && SvPOKp(sv) && SvCUR(sv))))
	XSRETURN_UNDEF;

    name = SvPV_nolen_const(ST(1));
    rv = &PL_sv_undef;

    if (SvROK(sv)) {
        sv = (SV*)SvRV(sv);
        if (SvOBJECT(sv))
            pkg = SvSTASH(sv);
    }
    else {
        pkg = gv_stashsv(sv, FALSE);
    }

    if (pkg) {
	GV * const gv = gv_fetchmethod_autoload(pkg, name, FALSE);
        if (gv && isGV(gv))
	    rv = sv_2mortal(newRV((SV*)GvCV(gv)));
    }

    ST(0) = rv;
    XSRETURN(1);
}

XS(XS_UNIVERSAL_VERSION)
{
    dXSARGS;
    HV *pkg;
    GV **gvp;
    GV *gv;
    SV *sv;
    const char *undef;

    if (SvROK(ST(0))) {
        sv = (SV*)SvRV(ST(0));
        if (!SvOBJECT(sv))
            Perl_croak(aTHX_ "Cannot find version of an unblessed reference");
        pkg = SvSTASH(sv);
    }
    else {
        pkg = gv_stashsv(ST(0), FALSE);
    }

    gvp = pkg ? (GV**)hv_fetch(pkg,"VERSION",7,FALSE) : Null(GV**);

    if (gvp && isGV(gv = *gvp) && (sv = GvSV(gv)) && SvOK(sv)) {
        SV * const nsv = sv_newmortal();
        sv_setsv(nsv, sv);
        sv = nsv;
	if ( !sv_derived_from(sv, "version"))
	    upg_version(sv);
        undef = Nullch;
    }
    else {
        sv = (SV*)&PL_sv_undef;
        undef = "(undef)";
    }

    if (items > 1) {
	SV *req = ST(1);

	if (undef) {
	    if (pkg) {
		const char * const name = HvNAME_get(pkg);
		Perl_croak(aTHX_
			   "%s does not define $%s::VERSION--version check failed",
			   name, name);
	    } else {
		Perl_croak(aTHX_
			     "%s defines neither package nor VERSION--version check failed",
			     SvPVx_nolen_const(ST(0)) );
	     }
	}

	if ( !sv_derived_from(req, "version")) {
	    /* req may very well be R/O, so create a new object */
	    SV * const nsv = sv_newmortal();
	    sv_setsv(nsv, req);
	    req = nsv;
	    upg_version(req);
	}

	if ( vcmp( req, sv ) > 0 )
	    Perl_croak(aTHX_ "%s version %"SVf" (%"SVf") required--"
		    "this is only version %"SVf" (%"SVf")", HvNAME_get(pkg),
		    vnumify(req),vnormal(req),vnumify(sv),vnormal(sv));
    }

    if ( SvOK(sv) && sv_derived_from(sv, "version") ) {
	ST(0) = vnumify(sv);
    } else {
	ST(0) = sv;
    }

    XSRETURN(1);
}

XS(XS_version_new)
{
    dXSARGS;
    if (items > 3)
	Perl_croak(aTHX_ "Usage: version::new(class, version)");
    SP -= items;
    {
        SV *vs = ST(1);
	SV *rv;
	const char * const classname =
	    sv_isobject(ST(0)) /* get the class if called as an object method */
		? HvNAME(SvSTASH(SvRV(ST(0))))
		: (char *)SvPV_nolen(ST(0));

	if ( items == 1 ) {
	    /* no parameter provided */
	    if ( sv_isobject(ST(0)) ) {
		/* copy existing object */
		vs = ST(0);
	    }
	    else {
		/* create empty object */
		vs = sv_newmortal();
		sv_setpvn(vs,"",0);
	    }
	}
	else if ( items == 3 ) {
	    vs = sv_newmortal();
	    Perl_sv_setpvf(aTHX_ vs,"v%s",SvPV_nolen_const(ST(2)));
	}

	rv = new_version(vs);
	if ( strcmp(classname,"version") != 0 ) /* inherited new() */
	    sv_bless(rv, gv_stashpv(classname,TRUE));

	PUSHs(sv_2mortal(rv));
	PUTBACK;
	return;
    }
}

XS(XS_version_stringify)
{
     dXSARGS;
     if (items < 1)
	  Perl_croak(aTHX_ "Usage: version::stringify(lobj, ...)");
     SP -= items;
     {
	  SV *	lobj;

	  if (sv_derived_from(ST(0), "version")) {
	       lobj = SvRV(ST(0));
	  }
	  else
	       Perl_croak(aTHX_ "lobj is not of type version");

	  PUSHs(sv_2mortal(vstringify(lobj)));

	  PUTBACK;
	  return;
     }
}

XS(XS_version_numify)
{
     dXSARGS;
     if (items < 1)
	  Perl_croak(aTHX_ "Usage: version::numify(lobj, ...)");
     SP -= items;
     {
	  SV *	lobj;

	  if (sv_derived_from(ST(0), "version")) {
	       lobj = SvRV(ST(0));
	  }
	  else
	       Perl_croak(aTHX_ "lobj is not of type version");

	  PUSHs(sv_2mortal(vnumify(lobj)));

	  PUTBACK;
	  return;
     }
}

XS(XS_version_normal)
{
     dXSARGS;
     if (items < 1)
	  Perl_croak(aTHX_ "Usage: version::normal(lobj, ...)");
     SP -= items;
     {
	  SV *	lobj;

	  if (sv_derived_from(ST(0), "version")) {
	       lobj = SvRV(ST(0));
	  }
	  else
	       Perl_croak(aTHX_ "lobj is not of type version");

	  PUSHs(sv_2mortal(vnormal(lobj)));

	  PUTBACK;
	  return;
     }
}

XS(XS_version_vcmp)
{
     dXSARGS;
     if (items < 1)
	  Perl_croak(aTHX_ "Usage: version::vcmp(lobj, ...)");
     SP -= items;
     {
	  SV *	lobj;

	  if (sv_derived_from(ST(0), "version")) {
	       lobj = SvRV(ST(0));
	  }
	  else
	       Perl_croak(aTHX_ "lobj is not of type version");

	  {
	       SV	*rs;
	       SV	*rvs;
	       SV * robj = ST(1);
	       const IV	 swap = (IV)SvIV(ST(2));

	       if ( ! sv_derived_from(robj, "version") )
	       {
		    robj = new_version(robj);
	       }
	       rvs = SvRV(robj);

	       if ( swap )
	       {
		    rs = newSViv(vcmp(rvs,lobj));
	       }
	       else
	       {
		    rs = newSViv(vcmp(lobj,rvs));
	       }

	       PUSHs(sv_2mortal(rs));
	  }

	  PUTBACK;
	  return;
     }
}

XS(XS_version_boolean)
{
     dXSARGS;
     if (items < 1)
	  Perl_croak(aTHX_ "Usage: version::boolean(lobj, ...)");
     SP -= items;
    if (sv_derived_from(ST(0), "version")) {
	SV * const lobj = SvRV(ST(0));
	SV * const rs = newSViv( vcmp(lobj,new_version(newSVpvn("0",1))) );
	PUSHs(sv_2mortal(rs));
	PUTBACK;
	return;
    }
    else
	Perl_croak(aTHX_ "lobj is not of type version");
}

XS(XS_version_noop)
{
    dXSARGS;
    if (items < 1)
	Perl_croak(aTHX_ "Usage: version::noop(lobj, ...)");
    if (sv_derived_from(ST(0), "version"))
	Perl_croak(aTHX_ "operation not supported with version object");
    else
	Perl_croak(aTHX_ "lobj is not of type version");
#ifndef HASATTRIBUTE_NORETURN
    XSRETURN_EMPTY;
#endif
}

XS(XS_version_is_alpha)
{
    dXSARGS;
    if (items != 1)
	Perl_croak(aTHX_ "Usage: version::is_alpha(lobj)");
    SP -= items;
    if (sv_derived_from(ST(0), "version")) {
	SV * const lobj = ST(0);
	if ( hv_exists((HV*)SvRV(lobj), "alpha", 5 ) )
	    XSRETURN_YES;
	else
	    XSRETURN_NO;
	PUTBACK;
	return;
    }
    else
	Perl_croak(aTHX_ "lobj is not of type version");
}

XS(XS_version_qv)
{
    dXSARGS;
    if (items != 1)
	Perl_croak(aTHX_ "Usage: version::qv(ver)");
    SP -= items;
    {
	SV *	ver = ST(0);
	if ( !SvVOK(ver) ) { /* only need to do with if not already v-string */
	    SV * const vs = sv_newmortal();
	    char *version;
	    if ( SvNOK(ver) ) /* may get too much accuracy */
	    {
		char tbuf[64];
		const STRLEN len = my_sprintf(tbuf,"%.9"NVgf, SvNVX(ver));
		version = savepvn(tbuf, len);
	    }
	    else
	    {
		version = savesvpv(ver);
	    }
	    (void)scan_version(version,vs,TRUE);
	    Safefree(version);

	    PUSHs(vs);
	}
	else
	{
	    PUSHs(sv_2mortal(new_version(ver)));
	}

	PUTBACK;
	return;
    }
}

XS(XS_utf8_is_utf8)
{
     dXSARGS;
     if (items != 1)
	  Perl_croak(aTHX_ "Usage: utf8::is_utf8(sv)");
     else {
	const SV * const sv = ST(0);
	    if (SvUTF8(sv))
		XSRETURN_YES;
	    else
		XSRETURN_NO;
     }
     XSRETURN_EMPTY;
}

XS(XS_utf8_valid)
{
     dXSARGS;
     if (items != 1)
	  Perl_croak(aTHX_ "Usage: utf8::valid(sv)");
    else {
	SV * const sv = ST(0);
	STRLEN len;
	const char * const s = SvPV_const(sv,len);
	if (!SvUTF8(sv) || is_utf8_string((const U8*)s,len))
	    XSRETURN_YES;
	else
	    XSRETURN_NO;
    }
     XSRETURN_EMPTY;
}

XS(XS_utf8_encode)
{
    dXSARGS;
    if (items != 1)
	Perl_croak(aTHX_ "Usage: utf8::encode(sv)");
    sv_utf8_encode(ST(0));
    XSRETURN_EMPTY;
}

XS(XS_utf8_decode)
{
    dXSARGS;
    if (items != 1)
	Perl_croak(aTHX_ "Usage: utf8::decode(sv)");
    else {
	SV * const sv = ST(0);
	const bool RETVAL = sv_utf8_decode(sv);
	ST(0) = boolSV(RETVAL);
	sv_2mortal(ST(0));
    }
    XSRETURN(1);
}

XS(XS_utf8_upgrade)
{
    dXSARGS;
    if (items != 1)
	Perl_croak(aTHX_ "Usage: utf8::upgrade(sv)");
    else {
	SV * const sv = ST(0);
	STRLEN	RETVAL;
	dXSTARG;

	RETVAL = sv_utf8_upgrade(sv);
	XSprePUSH; PUSHi((IV)RETVAL);
    }
    XSRETURN(1);
}

XS(XS_utf8_downgrade)
{
    dXSARGS;
    if (items < 1 || items > 2)
	Perl_croak(aTHX_ "Usage: utf8::downgrade(sv, failok=0)");
    else {
	SV * const sv = ST(0);
        const bool failok = (items < 2) ? 0 : (int)SvIV(ST(1));
        const bool RETVAL = sv_utf8_downgrade(sv, failok);

	ST(0) = boolSV(RETVAL);
	sv_2mortal(ST(0));
    }
    XSRETURN(1);
}

XS(XS_utf8_native_to_unicode)
{
 dXSARGS;
 const UV uv = SvUV(ST(0));

 if (items > 1)
     Perl_croak(aTHX_ "Usage: utf8::native_to_unicode(sv)");

 ST(0) = sv_2mortal(newSViv(NATIVE_TO_UNI(uv)));
 XSRETURN(1);
}

XS(XS_utf8_unicode_to_native)
{
 dXSARGS;
 const UV uv = SvUV(ST(0));

 if (items > 1)
     Perl_croak(aTHX_ "Usage: utf8::unicode_to_native(sv)");

 ST(0) = sv_2mortal(newSViv(UNI_TO_NATIVE(uv)));
 XSRETURN(1);
}

XS(XS_Internals_SvREADONLY)	/* This is dangerous stuff. */
{
    dXSARGS;
    SV * const sv = SvRV(ST(0));

    if (items == 1) {
	 if (SvREADONLY(sv))
	     XSRETURN_YES;
	 else
	     XSRETURN_NO;
    }
    else if (items == 2) {
	if (SvTRUE(ST(1))) {
	    SvREADONLY_on(sv);
	    XSRETURN_YES;
	}
	else {
	    /* I hope you really know what you are doing. */
	    SvREADONLY_off(sv);
	    XSRETURN_NO;
	}
    }
    XSRETURN_UNDEF; /* Can't happen. */
}

XS(XS_Internals_SvREFCNT)	/* This is dangerous stuff. */
{
    dXSARGS;
    SV * const sv = SvRV(ST(0));

    if (items == 1)
	 XSRETURN_IV(SvREFCNT(sv) - 1); /* Minus the ref created for us. */
    else if (items == 2) {
         /* I hope you really know what you are doing. */
	 SvREFCNT(sv) = SvIV(ST(1));
	 XSRETURN_IV(SvREFCNT(sv));
    }
    XSRETURN_UNDEF; /* Can't happen. */
}

XS(XS_Internals_hv_clear_placehold)
{
    dXSARGS;

    if (items != 1)
	Perl_croak(aTHX_ "Usage: UNIVERSAL::hv_clear_placeholders(hv)");
    else {
	HV * const hv = (HV *) SvRV(ST(0));
	hv_clear_placeholders(hv);
	XSRETURN(0);
    }
}

XS(XS_Regexp_DESTROY)
{
    PERL_UNUSED_ARG(cv);
}

XS(XS_PerlIO_get_layers)
{
    dXSARGS;
    if (items < 1 || items % 2 == 0)
	Perl_croak(aTHX_ "Usage: PerlIO_get_layers(filehandle[,args])");
#ifdef USE_PERLIO
    {
	SV *	sv;
	GV *	gv;
	IO *	io;
	bool	input = TRUE;
	bool	details = FALSE;

	if (items > 1) {
	     SV * const *svp;
	     for (svp = MARK + 2; svp <= SP; svp += 2) {
		  SV * const * const varp = svp;
		  SV * const * const valp = svp + 1;
		  STRLEN klen;
		  const char * const key = SvPV_const(*varp, klen);

		  switch (*key) {
		  case 'i':
		       if (klen == 5 && memEQ(key, "input", 5)) {
			    input = SvTRUE(*valp);
			    break;
		       }
		       goto fail;
		  case 'o': 
		       if (klen == 6 && memEQ(key, "output", 6)) {
			    input = !SvTRUE(*valp);
			    break;
		       }
		       goto fail;
		  case 'd':
		       if (klen == 7 && memEQ(key, "details", 7)) {
			    details = SvTRUE(*valp);
			    break;
		       }
		       goto fail;
		  default:
		  fail:
		       Perl_croak(aTHX_
				  "get_layers: unknown argument '%s'",
				  key);
		  }
	     }

	     SP -= (items - 1);
	}

	sv = POPs;
	gv = (GV*)sv;

	if (!isGV(sv)) {
	     if (SvROK(sv) && isGV(SvRV(sv)))
		  gv = (GV*)SvRV(sv);
	     else if (SvPOKp(sv))
		  gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
	}

	if (gv && (io = GvIO(gv))) {
	     dTARGET;
	     AV* const av = PerlIO_get_layers(aTHX_ input ?
					IoIFP(io) : IoOFP(io));
	     I32 i;
	     const I32 last = av_len(av);
	     I32 nitem = 0;
	     
	     for (i = last; i >= 0; i -= 3) {
		  SV * const * const namsvp = av_fetch(av, i - 2, FALSE);
		  SV * const * const argsvp = av_fetch(av, i - 1, FALSE);
		  SV * const * const flgsvp = av_fetch(av, i,     FALSE);

		  const bool namok = namsvp && *namsvp && SvPOK(*namsvp);
		  const bool argok = argsvp && *argsvp && SvPOK(*argsvp);
		  const bool flgok = flgsvp && *flgsvp && SvIOK(*flgsvp);

		  if (details) {
		       XPUSHs(namok
			      ? newSVpvn(SvPVX_const(*namsvp), SvCUR(*namsvp))
			      : &PL_sv_undef);
		       XPUSHs(argok
			      ? newSVpvn(SvPVX_const(*argsvp), SvCUR(*argsvp))
			      : &PL_sv_undef);
		       if (flgok)
			    XPUSHi(SvIVX(*flgsvp));
		       else
			    XPUSHs(&PL_sv_undef);
		       nitem += 3;
		  }
		  else {
		       if (namok && argok)
			    XPUSHs(Perl_newSVpvf(aTHX_ "%"SVf"(%"SVf")",
					       *namsvp, *argsvp));
		       else if (namok)
			    XPUSHs(Perl_newSVpvf(aTHX_ "%"SVf, *namsvp));
		       else
			    XPUSHs(&PL_sv_undef);
		       nitem++;
		       if (flgok) {
			    const IV flags = SvIVX(*flgsvp);

			    if (flags & PERLIO_F_UTF8) {
				 XPUSHs(newSVpvn("utf8", 4));
				 nitem++;
			    }
		       }
		  }
	     }

	     SvREFCNT_dec(av);

	     XSRETURN(nitem);
	}
    }
#endif

    XSRETURN(0);
}

XS(XS_Internals_hash_seed)
{
    /* Using dXSARGS would also have dITEM and dSP,
     * which define 2 unused local variables.  */
    dAXMARK;
    PERL_UNUSED_ARG(cv);
    PERL_UNUSED_VAR(mark);
    XSRETURN_UV(PERL_HASH_SEED);
}

XS(XS_Internals_rehash_seed)
{
    /* Using dXSARGS would also have dITEM and dSP,
     * which define 2 unused local variables.  */
    dAXMARK;
    PERL_UNUSED_ARG(cv);
    PERL_UNUSED_VAR(mark);
    XSRETURN_UV(PL_rehash_seed);
}

XS(XS_Internals_HvREHASH)	/* Subject to change  */
{
    dXSARGS;
    if (SvROK(ST(0))) {
	const HV * const hv = (HV *) SvRV(ST(0));
	if (items == 1 && SvTYPE(hv) == SVt_PVHV) {
	    if (HvREHASH(hv))
		XSRETURN_YES;
	    else
		XSRETURN_NO;
	}
    }
    Perl_croak(aTHX_ "Internals::HvREHASH $hashref");
}

XS(XS_utf8_SWASHGET_heavy)
{
    dXSARGS;
    if (items != 4) {
	Perl_croak(aTHX_
	    "Usage: utf8::SWASHGET_heavy($self, $start, $len, DEBUG)");
    }
    {
	SV* self    = ST(0);
	const I32 i_start = (I32)SvIV(ST(1));
	const I32 i_len   = (I32)SvIV(ST(2));
	const I32 debug   = (I32)SvIV(ST(3));
	U32 start = (U32)i_start;
	U32 len   = (U32)i_len;

	HV *hv;
	SV **listsvp, **typesvp, **bitssvp, **nonesvp, **extssvp, *swatch;
	U8 *l, *lend, *x, *xend, *s, *nextline;
	STRLEN lcur, xcur, scur;
	U8* typestr;
	int typeto;
	U32 bits, none, end, octets;

	if (SvROK(self) && SvTYPE(SvRV(self))==SVt_PVHV)
	    hv = (HV*)SvRV(self);
	else
	    Perl_croak(aTHX_ "hv is not a hash reference");

	if (i_start < 0)
	    Perl_croak(aTHX_ "SWASHGET negative start");
	if (i_len < 0)
	    Perl_croak(aTHX_ "SWASHGET negative len");

	listsvp = hv_fetch(hv, "LIST", 4, FALSE);
	typesvp = hv_fetch(hv, "TYPE", 4, FALSE);
	bitssvp = hv_fetch(hv, "BITS", 4, FALSE);
	nonesvp = hv_fetch(hv, "NONE", 4, FALSE);
	extssvp = hv_fetch(hv, "EXTRAS", 6, FALSE);
	typestr = (U8*)SvPV_nolen(*typesvp);
	typeto  = typestr[0] == 'T' && typestr[1] == 'o';
	bits    = (U32)SvUV(*bitssvp);
	none    = (U32)SvUV(*nonesvp);
	end     = start + len;
	octets  = bits >> 3; /* if bits == 1, then octets == 0 */

	if (bits != 1 && bits != 8 && bits != 16 && bits != 32) {
	    Perl_croak(aTHX_ "SWASHGET unknown bits %"UVuf, (UV)bits);
	}
	if (debug) {
	    char* selfstr = SvPV_nolen(self);
	    PerlIO_printf(Perl_error_log, "SWASHGET ");
	    PerlIO_printf(Perl_error_log, "%s %"UVuf" %"UVuf" ",
					  selfstr, (UV)start, (UV)len);
	    PerlIO_printf(Perl_error_log, "[%s/%"UVuf"/%"UVuf"]\n",
					  typestr, (UV)bits, (UV)none);
	}

	/* initialize $swatch */
	swatch = newSVpvn("",0);
	scur   = octets ? (len * octets) : (len + 7) / 8;
	SvGROW(swatch, scur + 1);
	s = (U8*)SvPVX(swatch);
	if (octets && none) {
	    const U8* e = s + scur;
	    while (s < e) {
		if (bits == 8)
		    *s++ = (U8)(none & 0xff);
		else if (bits == 16) {
		    *s++ = (U8)((none >>  8) & 0xff);
		    *s++ = (U8)( none        & 0xff);
		}
		else if (bits == 32) {
		    *s++ = (U8)((none >> 24) & 0xff);
		    *s++ = (U8)((none >> 16) & 0xff);
		    *s++ = (U8)((none >>  8) & 0xff);
		    *s++ = (U8)( none        & 0xff);
		}
	    }
	    *s = '\0';
	}
	else {
	    (void)memzero((U8*)s, scur + 1);
	}
	SvCUR_set(swatch, scur);
	s = (U8*)SvPVX(swatch);

	/* read $self->{LIST} */
	l = (U8*)SvPV(*listsvp, lcur);
	lend = l + lcur;
	while (l < lend) {
	    U32 min, max, val, key;
	    STRLEN numlen;
	    I32 flags = PERL_SCAN_SILENT_ILLDIGIT | PERL_SCAN_DISALLOW_PREFIX;

	    nextline = (U8*)memchr(l, '\n', lend - l);

	    numlen = lend - l;
	    min = (U32)grok_hex((char *)l, &numlen, &flags, NULL);
	    if (numlen)
		l += numlen;
	    else if (nextline) {
		l = nextline + 1; /* 1 is length of "\n" */
		continue;
	    }
	    else {
		l = lend; /* to the end of LIST, at which no \n */
		break;
	    }

	    if (isBLANK(*l)) {
		++l;
		flags = PERL_SCAN_SILENT_ILLDIGIT | PERL_SCAN_DISALLOW_PREFIX;
		numlen = lend - l;
		max = (U32)grok_hex((char *)l, &numlen, &flags, NULL);
		if (numlen)
		    l += numlen;
		else
		    max = min;

		if (octets) {
		    if (isBLANK(*l)) {
			++l;
			flags = PERL_SCAN_SILENT_ILLDIGIT |
				PERL_SCAN_DISALLOW_PREFIX;
			numlen = lend - l;
			val = (U32)grok_hex((char *)l, &numlen, &flags, NULL);
			if (numlen)
			    l += numlen;
			else
			    val = 0;
		    }
		    else {
			val = 0;
			if (typeto) {
			    Perl_croak(aTHX_ "%s: illegal mapping '%s'",
					     typestr, l);
			}
		    }
		}
	    }
	    else {
		max = min;
		if (octets) {
		    val = 0;
		    if (typeto) {
			Perl_croak(aTHX_ "%s: illegal mapping '%s'",
					 typestr, l);
		    }
		}
	    }

	    if (nextline)
		l = nextline + 1;
	    else
		l = lend;

	    if (max < start)
		continue;

	    if (octets) {
		if (debug) {
		    PerlIO_printf(Perl_error_log,
			"%"UVuf" %"UVuf" %"UVuf"\n",
			(UV)min, (UV)max, (UV)val);
		}
		if (min < start) {
		    if (!none || val < none) {
			val += start - min;
		    }
		    min = start;
		}
		for (key = min; key <= max; key++) {
		    U32 offset;
		    if (key >= end)
			goto go_out_list;
		    if (debug) {
			PerlIO_printf(Perl_error_log,
				"%"UVuf" => %"UVuf"\n",
				(UV)key, (UV)val);
		    }

		/* offset must be non-negative (start <= min <= key < end) */
		    offset = (key - start) * octets;
		    if (bits == 8)
			s[offset] = (U8)(val & 0xff);
		    else if (bits == 16) {
			s[offset    ] = (U8)((val >>  8) & 0xff);
			s[offset + 1] = (U8)( val        & 0xff);
		    }
		    else if (bits == 32) {
			s[offset    ] = (U8)((val >> 24) & 0xff);
			s[offset + 1] = (U8)((val >> 16) & 0xff);
			s[offset + 2] = (U8)((val >>  8) & 0xff);
			s[offset + 3] = (U8)( val        & 0xff);
		    }

		    if (!none || val < none)
			++val;
		}
	    }
	    else {
		if (min < start)
		    min = start;
		for (key = min; key <= max; key++) {
		    U32 offset = key - start;
		    if (key >= end)
			goto go_out_list;
		    if (debug) {
			PerlIO_printf(Perl_error_log,
				"%"UVuf" => 1\n", (UV)key);
		    }
		    s[offset >> 3] |= 1 << (offset & 7);
		}
	    }
	}
    go_out_list:

	/* read $self->{EXTRAS} */
	x = (U8*)SvPV(*extssvp, xcur);
	xend = x + xcur;
	while (x < xend) {
	    STRLEN namelen;
	    U8 *namestr;
	    SV** othersvp;
	    U32 otherbits;

	    U8 opc = *x++;
	    if (opc == '\n')
		continue;

	    nextline = (U8*)memchr(x, '\n', xend - x);

	    if (opc != '-' && opc != '+' && opc != '!' && opc != '&') {
		if (nextline) {
		    x = nextline + 1;
		    continue;
		}
		else {
		    x = xend;
		    break;
		}
	    }

	    namestr = x;

	    if (nextline) {
		namelen = nextline - namestr;
		x = nextline + 1;
	    }
	    else {
		namelen = xend - namestr;
		x = xend;
	    }

	    if (debug) {
		U8* tmpstr;
		Newx(tmpstr, namelen + 1, U8);
		Move(namestr, tmpstr, namelen, U8);
		tmpstr[namelen] = '\0';
		PerlIO_printf(Perl_error_log,
			"INDIRECT %c %s\n", opc, tmpstr);
		Safefree(tmpstr);
	    }

	    {
		HV* otherhv;
		SV **otherbitssvp;

		othersvp = hv_fetch(hv, (char *)namestr, namelen, FALSE);
		if (*othersvp && SvROK(*othersvp) &&
				 SvTYPE(SvRV(*othersvp))==SVt_PVHV)
		    otherhv = (HV*)SvRV(*othersvp);
		else
		    Perl_croak(aTHX_ "otherhv is not a hash reference");

		otherbitssvp = hv_fetch(otherhv, "BITS", 4, FALSE);
		otherbits = (U32)SvUV(*otherbitssvp);
		if (bits < otherbits)
		    Perl_croak(aTHX_ "SWASHGET size mismatch");
	    }

	    {
		dSP;
		ENTER;
		SAVETMPS;
		PUSHMARK(SP);
		EXTEND(SP,3);
		PUSHs(*othersvp);
		PUSHs(sv_2mortal(newSViv(start)));
		PUSHs(sv_2mortal(newSViv(len)));
		PUTBACK;
		if (call_method("SWASHGET", G_SCALAR)) {
		    U8 *s, *o;
		    STRLEN slen, olen;
		    SV* tmpsv = *PL_stack_sp--;
		    o = (U8*)SvPV(tmpsv, olen);

		    if (!olen)
			Perl_croak(aTHX_ "SWASHGET didn't return valid swatch");
		    s = (U8*)SvPV(swatch, slen);
		    if (bits == 1 && otherbits == 1) {
			if (slen != olen)
			    Perl_croak(aTHX_ "SWASHGET length mismatch");

			switch (opc) {
			case '+':
			    while (slen--)
				*s++ |= *o++;
			    break;
			case '!':
			    while (slen--)
				*s++ |= ~*o++;
			    break;
			case '-':
			    while (slen--)
				*s++ &= ~*o++;
			    break;
			case '&':
			    while (slen--)
				*s++ &= *o++;
			    break;
			default:
			    break;
			}
		    }
		    else {
			U32 otheroctets = otherbits / 8;
			U32 offset = 0;
			U8* send = s + slen;

			while (s < send) {
			    U32 val = 0;

			    if (otherbits == 1) {
				val = (o[offset >> 3] >> (offset & 7)) & 1;
				++offset;
			    }
			    else {
				U32 vlen = otheroctets;
				val = *o++;
				while (--vlen) {
				    val <<= 8;
				    val |= *o++;
				}
			    }

			    if      (opc == '+' && val)
				val = 1;
			    else if (opc == '!' && !val)
				val = 1;
			    else if (opc == '-' && val)
				val = 0;
			    else if (opc == '&' && !val)
				val = 0;
			    else {
				s += octets;
				continue;
			    }

			    if (bits == 8)
				*s++ = (U8)( val & 0xff);
			    else if (bits == 16) {
				*s++ = (U8)((val >>  8) & 0xff);
				*s++ = (U8)( val        & 0xff);
			    }
			    else if (bits == 32) {
				*s++ = (U8)((val >> 24) & 0xff);
				*s++ = (U8)((val >> 16) & 0xff);
				*s++ = (U8)((val >>  8) & 0xff);
				*s++ = (U8)( val        & 0xff);
			    }
			}
		    }
		}
		FREETMPS;
		LEAVE;
	    }
	}

	if (debug) {
	    U8* s = (U8*)SvPVX(swatch);
	    PerlIO_printf(Perl_error_log, "CELLS ");
	    if (bits == 1) {
		U32 key;
		for (key = 0; key < len; key++) {
		    int val = (s[key >> 3] >> (key & 7)) & 1;
		    PerlIO_printf(Perl_error_log, val ? "1 " : "0 ");
		}
	    }
	    else {
		U8* send = s + len * octets;
		while (s < send) {
		    U32 vlen = octets;
		    U32 val = *s++;
		    while (--vlen) {
			val <<= 8;
			val |= *s++;
		    }
		    PerlIO_printf(Perl_error_log, "%"UVuf" ", (UV)val);
		}
	    }
	    PerlIO_printf(Perl_error_log, "\n");
	}

	ST(0) = swatch;
	sv_2mortal(ST(0));
    }
    XSRETURN(1);
}


/*
 * Local variables:
 * c-indentation-style: bsd
 * c-basic-offset: 4
 * indent-tabs-mode: t
 * End:
 *
 * ex: set ts=8 sts=4 sw=4 noet:
 */