[perl5.git] / xsutils.c

/*    xsutils.c
 *
 *    Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004,
 *    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.
 *
 */

/*
 * "Perilous to us all are the devices of an art deeper than we possess
 * ourselves." --Gandalf
 */


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

/*
 * Contributed by Spider Boardman (spider.boardman@orb.nashua.nh.us).
 */

/* package attributes; */
void XS_attributes__warn_reserved(pTHX_ CV *cv);
void XS_attributes_reftype(pTHX_ CV *cv);
void XS_attributes__modify_attrs(pTHX_ CV *cv);
void XS_attributes__guess_stash(pTHX_ CV *cv);
void XS_attributes__fetch_attrs(pTHX_ CV *cv);
void XS_attributes_bootstrap(pTHX_ CV *cv);


/*
 * Note that only ${pkg}::bootstrap definitions should go here.
 * This helps keep down the start-up time, which is especially
 * relevant for users who don't invoke any features which are
 * (partially) implemented here.
 *
 * The various bootstrap definitions can take care of doing
 * package-specific newXS() calls.  Since the layout of the
 * bundled *.pm files is in a version-specific directory,
 * version checks in these bootstrap calls are optional.
 */

void
Perl_boot_core_xsutils(pTHX)
{
    char *file = __FILE__;

    newXS("attributes::bootstrap",	XS_attributes_bootstrap,	file);
}

#include "XSUB.h"

static int
modify_SV_attributes(pTHX_ SV *sv, SV **retlist, SV **attrlist, int numattrs)
{
    SV *attr;
    char *name;
    STRLEN len;
    bool negated;
    int nret;

    for (nret = 0 ; numattrs && (attr = *attrlist++); numattrs--) {
	name = SvPV(attr, len);
	if ((negated = (*name == '-'))) {
	    name++;
	    len--;
	}
	switch (SvTYPE(sv)) {
	case SVt_PVCV:
	    switch ((int)len) {
	    case 6:
		switch (*name) {
		case 'a':
		    if (strEQ(name, "assertion")) {
			if (negated)
			    CvFLAGS((CV*)sv) &= ~CVf_ASSERTION;
			else
			    CvFLAGS((CV*)sv) |= CVf_ASSERTION;
			continue;
		    }
		    break;
		case 'l':
#ifdef CVf_LVALUE
		    if (strEQ(name, "lvalue")) {
			if (negated)
			    CvFLAGS((CV*)sv) &= ~CVf_LVALUE;
			else
			    CvFLAGS((CV*)sv) |= CVf_LVALUE;
			continue;
		    }
#endif /* defined CVf_LVALUE */
		    if (strEQ(name, "locked")) {
			if (negated)
			    CvFLAGS((CV*)sv) &= ~CVf_LOCKED;
			else
			    CvFLAGS((CV*)sv) |= CVf_LOCKED;
			continue;
		    }
		    break;
		case 'm':
		    if (strEQ(name, "method")) {
			if (negated)
			    CvFLAGS((CV*)sv) &= ~CVf_METHOD;
			else
			    CvFLAGS((CV*)sv) |= CVf_METHOD;
			continue;
		    }
		    break;
		}
		break;
	    }
	    break;
	default:
	    switch ((int)len) {
	    case 6:
		switch (*name) {
		case 's':
		    if (strEQ(name, "shared")) {
			if (negated)
			    Perl_croak(aTHX_ "A variable may not be unshared");
			SvSHARE(sv);
                        continue;
                    }
		    break;
		case 'u':
		    if (strEQ(name, "unique")) {
			if (SvTYPE(sv) == SVt_PVGV) {
			    if (negated)
				GvUNIQUE_off(sv);
			    else
				GvUNIQUE_on(sv);
			}
			/* Hope this came from toke.c if not a GV. */
                        continue;
                    }
                }
            }
	    break;
	}
	/* anything recognized had a 'continue' above */
	*retlist++ = attr;
	nret++;
    }

    return nret;
}


/* package attributes; */

XS(XS_attributes_bootstrap)
{
    dXSARGS;
    char *file = __FILE__;

    if( items > 1 )
        Perl_croak(aTHX_ "Usage: attributes::bootstrap $module");

    newXSproto("attributes::_warn_reserved", XS_attributes__warn_reserved, file, "");
    newXS("attributes::_modify_attrs",	XS_attributes__modify_attrs,	file);
    newXSproto("attributes::_guess_stash", XS_attributes__guess_stash, file, "$");
    newXSproto("attributes::_fetch_attrs", XS_attributes__fetch_attrs, file, "$");
    newXSproto("attributes::reftype",	XS_attributes_reftype,	file, "$");

    XSRETURN(0);
}

XS(XS_attributes__modify_attrs)
{
    dXSARGS;
    SV *rv, *sv;

    if (items < 1) {
usage:
	Perl_croak(aTHX_
		   "Usage: attributes::_modify_attrs $reference, @attributes");
    }

    rv = ST(0);
    if (!(SvOK(rv) && SvROK(rv)))
	goto usage;
    sv = SvRV(rv);
    if (items > 1)
	XSRETURN(modify_SV_attributes(aTHX_ sv, &ST(0), &ST(1), items-1));

    XSRETURN(0);
}

XS(XS_attributes__fetch_attrs)
{
    dXSARGS;
    SV *rv, *sv;
    cv_flags_t cvflags;

    if (items != 1) {
usage:
	Perl_croak(aTHX_
		   "Usage: attributes::_fetch_attrs $reference");
    }

    rv = ST(0);
    SP -= items;
    if (!(SvOK(rv) && SvROK(rv)))
	goto usage;
    sv = SvRV(rv);

    switch (SvTYPE(sv)) {
    case SVt_PVCV:
	cvflags = CvFLAGS((CV*)sv);
	if (cvflags & CVf_LOCKED)
	    XPUSHs(sv_2mortal(newSVpvn("locked", 6)));
#ifdef CVf_LVALUE
	if (cvflags & CVf_LVALUE)
	    XPUSHs(sv_2mortal(newSVpvn("lvalue", 6)));
#endif
	if (cvflags & CVf_METHOD)
	    XPUSHs(sv_2mortal(newSVpvn("method", 6)));
        if (GvUNIQUE(CvGV((CV*)sv)))
	    XPUSHs(sv_2mortal(newSVpvn("unique", 6)));
	if (cvflags & CVf_ASSERTION)
	    XPUSHs(sv_2mortal(newSVpvn("assertion", 9)));
	break;
    case SVt_PVGV:
	if (GvUNIQUE(sv))
	    XPUSHs(sv_2mortal(newSVpvn("unique", 6)));
	break;
    default:
	break;
    }

    PUTBACK;
}

XS(XS_attributes__guess_stash)
{
    dXSARGS;
    SV *rv, *sv;
#ifdef dXSTARGET
    dXSTARGET;
#else
    SV * TARG = sv_newmortal();
#endif

    if (items != 1) {
usage:
	Perl_croak(aTHX_
		   "Usage: attributes::_guess_stash $reference");
    }

    rv = ST(0);
    ST(0) = TARG;
    if (!(SvOK(rv) && SvROK(rv)))
	goto usage;
    sv = SvRV(rv);

    if (SvOBJECT(sv))
	sv_setpv(TARG, HvNAME(SvSTASH(sv)));
#if 0	/* this was probably a bad idea */
    else if (SvPADMY(sv))
	sv_setsv(TARG, &PL_sv_no);	/* unblessed lexical */
#endif
    else {
	HV *stash = Nullhv;
	switch (SvTYPE(sv)) {
	case SVt_PVCV:
	    if (CvGV(sv) && isGV(CvGV(sv)) && GvSTASH(CvGV(sv)))
		stash = GvSTASH(CvGV(sv));
	    else if (/* !CvANON(sv) && */ CvSTASH(sv))
		stash = CvSTASH(sv);
	    break;
	case SVt_PVMG:
	    if (!(SvFAKE(sv) && SvTIED_mg(sv, PERL_MAGIC_glob)))
		break;
	    /*FALLTHROUGH*/
	case SVt_PVGV:
	    if (GvGP(sv) && GvESTASH((GV*)sv))
		stash = GvESTASH((GV*)sv);
	    break;
	default:
	    break;
	}
	if (stash)
	    sv_setpv(TARG, HvNAME(stash));
    }

#ifdef dXSTARGET
    SvSETMAGIC(TARG);
#endif
    XSRETURN(1);
}

XS(XS_attributes_reftype)
{
    dXSARGS;
    SV *rv, *sv;
#ifdef dXSTARGET
    dXSTARGET;
#else
    SV * TARG = sv_newmortal();
#endif

    if (items != 1) {
usage:
	Perl_croak(aTHX_
		   "Usage: attributes::reftype $reference");
    }

    rv = ST(0);
    ST(0) = TARG;
    if (SvGMAGICAL(rv))
	mg_get(rv);
    if (!(SvOK(rv) && SvROK(rv)))
	goto usage;
    sv = SvRV(rv);
    sv_setpv(TARG, sv_reftype(sv, 0));
#ifdef dXSTARGET
    SvSETMAGIC(TARG);
#endif

    XSRETURN(1);
}

XS(XS_attributes__warn_reserved)
{
    dXSARGS;
#ifdef dXSTARGET
    dXSTARGET;
#else
    SV * TARG = sv_newmortal();
#endif

    if (items != 0) {
	Perl_croak(aTHX_
		   "Usage: attributes::_warn_reserved ()");
    }

    EXTEND(SP,1);
    ST(0) = TARG;
    sv_setiv(TARG, ckWARN(WARN_RESERVED) != 0);
#ifdef dXSTARGET
    SvSETMAGIC(TARG);
#endif

    XSRETURN(1);
}
Commit	Line	Data
d6376244 JH	1	/* xsutils.c
d6376244 JH	2	*
371fce9b DM	3	* Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004,
371fce9b DM	4	* by Larry Wall and others
d6376244 JH	5	*
	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.
	8	*
	9	*/
	10
d31a8517 AT	11	/*
	12	* "Perilous to us all are the devices of an art deeper than we possess
	13	* ourselves." --Gandalf
	14	*/
	15
	16
09bef843 SB	17	#include "EXTERN.h"
	18	#define PERL_IN_XSUTILS_C
	19	#include "perl.h"
	20
	21	/*
	22	* Contributed by Spider Boardman (spider.boardman@orb.nashua.nh.us).
	23	*/
	24
349fd7b7	25	/* package attributes; */
acfe0abc GS	26	void XS_attributes__warn_reserved(pTHX_ CV *cv);
	27	void XS_attributes_reftype(pTHX_ CV *cv);
	28	void XS_attributes__modify_attrs(pTHX_ CV *cv);
	29	void XS_attributes__guess_stash(pTHX_ CV *cv);
	30	void XS_attributes__fetch_attrs(pTHX_ CV *cv);
	31	void XS_attributes_bootstrap(pTHX_ CV *cv);
349fd7b7 GS	32
	33
	34	/*
	35	* Note that only ${pkg}::bootstrap definitions should go here.
	36	* This helps keep down the start-up time, which is especially
	37	* relevant for users who don't invoke any features which are
	38	* (partially) implemented here.
	39	*
	40	* The various bootstrap definitions can take care of doing
	41	* package-specific newXS() calls. Since the layout of the
6a34af38	42	* bundled *.pm files is in a version-specific directory,
349fd7b7 GS	43	* version checks in these bootstrap calls are optional.
	44	*/
	45
	46	void
	47	Perl_boot_core_xsutils(pTHX)
	48	{
	49	char *file = __FILE__;
	50
	51	newXS("attributes::bootstrap", XS_attributes_bootstrap, file);
	52	}
	53
349fd7b7 GS	54	#include "XSUB.h"
	55
	56	static int
acfe0abc	57	modify_SV_attributes(pTHX_ SV sv, SV retlist, SV *attrlist, int numattrs)
09bef843 SB	58	{
	59	SV *attr;
	60	char *name;
	61	STRLEN len;
	62	bool negated;
	63	int nret;
	64
	65	for (nret = 0 ; numattrs && (attr = *attrlist++); numattrs--) {
	66	name = SvPV(attr, len);
155aba94	67	if ((negated = (*name == '-'))) {
09bef843 SB	68	name++;
	69	len--;
	70	}
	71	switch (SvTYPE(sv)) {
	72	case SVt_PVCV:
	73	switch ((int)len) {
	74	case 6:
	75	switch (*name) {
06492da6 SF	76	case 'a':
	77	if (strEQ(name, "assertion")) {
	78	if (negated)
	79	CvFLAGS((CV*)sv) &= ~CVf_ASSERTION;
	80	else
	81	CvFLAGS((CV*)sv) \|= CVf_ASSERTION;
	82	continue;
	83	}
	84	break;
09bef843 SB	85	case 'l':
	86	#ifdef CVf_LVALUE
	87	if (strEQ(name, "lvalue")) {
	88	if (negated)
	89	CvFLAGS((CV*)sv) &= ~CVf_LVALUE;
	90	else
	91	CvFLAGS((CV*)sv) \|= CVf_LVALUE;
	92	continue;
	93	}
	94	#endif /* defined CVf_LVALUE */
	95	if (strEQ(name, "locked")) {
	96	if (negated)
	97	CvFLAGS((CV*)sv) &= ~CVf_LOCKED;
	98	else
	99	CvFLAGS((CV*)sv) \|= CVf_LOCKED;
	100	continue;
	101	}
	102	break;
	103	case 'm':
	104	if (strEQ(name, "method")) {
	105	if (negated)
	106	CvFLAGS((CV*)sv) &= ~CVf_METHOD;
	107	else
	108	CvFLAGS((CV*)sv) \|= CVf_METHOD;
	109	continue;
	110	}
	111	break;
	112	}
	113	break;
	114	}
	115	break;
	116	default:
0256094b	117	switch ((int)len) {
95f0a2f1	118	case 6:
0256094b	119	switch (*name) {
13c1b207 DM	120	case 's':
	121	if (strEQ(name, "shared")) {
	122	if (negated)
	123	Perl_croak(aTHX_ "A variable may not be unshared");
	124	SvSHARE(sv);
	125	continue;
	126	}
	127	break;
95f0a2f1 SB	128	case 'u':
	129	if (strEQ(name, "unique")) {
	130	if (SvTYPE(sv) == SVt_PVGV) {
	131	if (negated)
	132	GvUNIQUE_off(sv);
	133	else
	134	GvUNIQUE_on(sv);
	135	}
	136	/* Hope this came from toke.c if not a GV. */
0256094b DM	137	continue;
	138	}
	139	}
	140	}
09bef843 SB	141	break;
	142	}
	143	/* anything recognized had a 'continue' above */
	144	*retlist++ = attr;
	145	nret++;
	146	}
	147
	148	return nret;
	149	}
	150
	151
09bef843 SB	152
	153	/* package attributes; */
	154
	155	XS(XS_attributes_bootstrap)
	156	{
	157	dXSARGS;
	158	char *file = __FILE__;
	159
592f5969 MS	160	if( items > 1 )
592f5969 MS	161	Perl_croak(aTHX_ "Usage: attributes::bootstrap $module");
b7953727	162
09bef843 SB	163	newXSproto("attributes::_warn_reserved", XS_attributes__warn_reserved, file, "");
	164	newXS("attributes::_modify_attrs", XS_attributes__modify_attrs, file);
	165	newXSproto("attributes::_guess_stash", XS_attributes__guess_stash, file, "$");
	166	newXSproto("attributes::_fetch_attrs", XS_attributes__fetch_attrs, file, "$");
	167	newXSproto("attributes::reftype", XS_attributes_reftype, file, "$");
	168
	169	XSRETURN(0);
	170	}
	171
	172	XS(XS_attributes__modify_attrs)
	173	{
	174	dXSARGS;
	175	SV rv, sv;
	176
	177	if (items < 1) {
	178	usage:
	179	Perl_croak(aTHX_
	180	"Usage: attributes::_modify_attrs $reference, @attributes");
	181	}
	182
	183	rv = ST(0);
	184	if (!(SvOK(rv) && SvROK(rv)))
	185	goto usage;
	186	sv = SvRV(rv);
	187	if (items > 1)
acfe0abc	188	XSRETURN(modify_SV_attributes(aTHX_ sv, &ST(0), &ST(1), items-1));
09bef843 SB	189
	190	XSRETURN(0);
	191	}
	192
	193	XS(XS_attributes__fetch_attrs)
	194	{
	195	dXSARGS;
	196	SV rv, sv;
	197	cv_flags_t cvflags;
	198
	199	if (items != 1) {
	200	usage:
	201	Perl_croak(aTHX_
	202	"Usage: attributes::_fetch_attrs $reference");
	203	}
	204
	205	rv = ST(0);
	206	SP -= items;
	207	if (!(SvOK(rv) && SvROK(rv)))
	208	goto usage;
	209	sv = SvRV(rv);
	210
	211	switch (SvTYPE(sv)) {
	212	case SVt_PVCV:
	213	cvflags = CvFLAGS((CV*)sv);
	214	if (cvflags & CVf_LOCKED)
	215	XPUSHs(sv_2mortal(newSVpvn("locked", 6)));
	216	#ifdef CVf_LVALUE
	217	if (cvflags & CVf_LVALUE)
	218	XPUSHs(sv_2mortal(newSVpvn("lvalue", 6)));
	219	#endif
	220	if (cvflags & CVf_METHOD)
	221	XPUSHs(sv_2mortal(newSVpvn("method", 6)));
7fb37951	222	if (GvUNIQUE(CvGV((CV*)sv)))
95f0a2f1	223	XPUSHs(sv_2mortal(newSVpvn("unique", 6)));
06492da6 SF	224	if (cvflags & CVf_ASSERTION)
06492da6 SF	225	XPUSHs(sv_2mortal(newSVpvn("assertion", 9)));
95f0a2f1 SB	226	break;
	227	case SVt_PVGV:
	228	if (GvUNIQUE(sv))
	229	XPUSHs(sv_2mortal(newSVpvn("unique", 6)));
09bef843 SB	230	break;
	231	default:
	232	break;
	233	}
	234
	235	PUTBACK;
	236	}
	237
	238	XS(XS_attributes__guess_stash)
	239	{
	240	dXSARGS;
	241	SV rv, sv;
	242	#ifdef dXSTARGET
	243	dXSTARGET;
	244	#else
	245	SV * TARG = sv_newmortal();
	246	#endif
	247
	248	if (items != 1) {
	249	usage:
	250	Perl_croak(aTHX_
	251	"Usage: attributes::_guess_stash $reference");
	252	}
	253
	254	rv = ST(0);
	255	ST(0) = TARG;
	256	if (!(SvOK(rv) && SvROK(rv)))
	257	goto usage;
	258	sv = SvRV(rv);
	259
	260	if (SvOBJECT(sv))
	261	sv_setpv(TARG, HvNAME(SvSTASH(sv)));
	262	#if 0 /* this was probably a bad idea */
	263	else if (SvPADMY(sv))
	264	sv_setsv(TARG, &PL_sv_no); /* unblessed lexical */
	265	#endif
	266	else {
	267	HV *stash = Nullhv;
	268	switch (SvTYPE(sv)) {
	269	case SVt_PVCV:
6676db26	270	if (CvGV(sv) && isGV(CvGV(sv)) && GvSTASH(CvGV(sv)))
09bef843	271	stash = GvSTASH(CvGV(sv));
6676db26	272	else if (/* !CvANON(sv) && */ CvSTASH(sv))
09bef843 SB	273	stash = CvSTASH(sv);
	274	break;
	275	case SVt_PVMG:
14befaf4	276	if (!(SvFAKE(sv) && SvTIED_mg(sv, PERL_MAGIC_glob)))
09bef843 SB	277	break;
	278	/FALLTHROUGH/
	279	case SVt_PVGV:
6676db26	280	if (GvGP(sv) && GvESTASH((GV*)sv))
09bef843 SB	281	stash = GvESTASH((GV*)sv);
	282	break;
	283	default:
	284	break;
	285	}
	286	if (stash)
	287	sv_setpv(TARG, HvNAME(stash));
	288	}
	289
	290	#ifdef dXSTARGET
	291	SvSETMAGIC(TARG);
	292	#endif
	293	XSRETURN(1);
	294	}
	295
	296	XS(XS_attributes_reftype)
	297	{
	298	dXSARGS;
	299	SV rv, sv;
	300	#ifdef dXSTARGET
	301	dXSTARGET;
	302	#else
	303	SV * TARG = sv_newmortal();
	304	#endif
	305
	306	if (items != 1) {
	307	usage:
	308	Perl_croak(aTHX_
	309	"Usage: attributes::reftype $reference");
	310	}
	311
	312	rv = ST(0);
	313	ST(0) = TARG;
4694d0ea GS	314	if (SvGMAGICAL(rv))
4694d0ea GS	315	mg_get(rv);
121e869f	316	if (!(SvOK(rv) && SvROK(rv)))
09bef843 SB	317	goto usage;
	318	sv = SvRV(rv);
	319	sv_setpv(TARG, sv_reftype(sv, 0));
	320	#ifdef dXSTARGET
	321	SvSETMAGIC(TARG);
	322	#endif
	323
	324	XSRETURN(1);
	325	}
	326
	327	XS(XS_attributes__warn_reserved)
	328	{
	329	dXSARGS;
09bef843 SB	330	#ifdef dXSTARGET
	331	dXSTARGET;
	332	#else
	333	SV * TARG = sv_newmortal();
	334	#endif
	335
	336	if (items != 0) {
	337	Perl_croak(aTHX_
	338	"Usage: attributes::_warn_reserved ()");
	339	}
	340
	341	EXTEND(SP,1);
	342	ST(0) = TARG;
	343	sv_setiv(TARG, ckWARN(WARN_RESERVED) != 0);
	344	#ifdef dXSTARGET
	345	SvSETMAGIC(TARG);
	346	#endif
	347
	348	XSRETURN(1);
	349	}
	350