[perl5.git] / ext / File-Glob / Glob.xs

#define PERL_NO_GET_CONTEXT

#include "EXTERN.h"
#include "perl.h"
#include "XSUB.h"

#include "bsd_glob.h"

#define MY_CXT_KEY "File::Glob::_guts" XS_VERSION

typedef struct {
    int		x_GLOB_ERROR;
    HV *	x_GLOB_ITER;
    HV *	x_GLOB_ENTRIES;
} my_cxt_t;

START_MY_CXT

#define GLOB_ERROR	(MY_CXT.x_GLOB_ERROR)

#include "const-c.inc"

#ifdef WIN32
#define errfunc		NULL
#else
static int
errfunc(const char *foo, int bar) {
  PERL_UNUSED_ARG(foo);
  return !(bar == EACCES || bar == ENOENT || bar == ENOTDIR);
}
#endif

static void
doglob(pTHX_ const char *pattern, int flags)
{
    dSP;
    glob_t pglob;
    int i;
    int retval;
    SV *tmp;
    {
	dMY_CXT;

	/* call glob */
	memset(&pglob, 0, sizeof(glob_t));
	retval = bsd_glob(pattern, flags, errfunc, &pglob);
	GLOB_ERROR = retval;

	/* return any matches found */
	EXTEND(sp, pglob.gl_pathc);
	for (i = 0; i < pglob.gl_pathc; i++) {
	    /* printf("# bsd_glob: %s\n", pglob.gl_pathv[i]); */
	    tmp = newSVpvn_flags(pglob.gl_pathv[i], strlen(pglob.gl_pathv[i]),
				 SVs_TEMP);
	    TAINT;
	    SvTAINT(tmp);
	    PUSHs(tmp);
	}
	PUTBACK;

	bsd_globfree(&pglob);
    }
}

/* borrowed heavily from gsar's File::DosGlob, but translated into C */
static void
csh_glob(pTHX)
{
    dSP;
    dMY_CXT;

    SV *cxixsv = POPs;
    const char *cxixpv;
    STRLEN cxixlen;
    STRLEN len;
    const char *s = NULL;
    SV *itersv;
    SV *entriesv;
    AV *entries = NULL;
    U32 gimme = GIMME_V;
    SV *patsv = POPs;

    /* assume global context if not provided one */
    SvGETMAGIC(cxixsv);
    if (SvOK(cxixsv)) cxixpv = SvPV_nomg(cxixsv, cxixlen);
    else cxixpv = "_G_", cxixlen = 3;

    if (!MY_CXT.x_GLOB_ITER) MY_CXT.x_GLOB_ITER = newHV();
    itersv = *(hv_fetch(MY_CXT.x_GLOB_ITER, cxixpv, cxixlen, 1));
    if (!SvOK(itersv)) sv_setiv(itersv,0);

    if (!MY_CXT.x_GLOB_ENTRIES) MY_CXT.x_GLOB_ENTRIES = newHV();
    entriesv = *(hv_fetch(MY_CXT.x_GLOB_ENTRIES, cxixpv, cxixlen, 1));

    /* if we're just beginning, do it all first */
    if (!SvIV(itersv)) {
	const char *pat;
	AV *patav = NULL;
	const char *patend;
	const char *piece = NULL;
	SV *word = NULL;
	int const flags =
	    (int)SvIV(get_sv("File::Glob::DEFAULT_FLAGS", GV_ADD));
	bool is_utf8;

	/* glob without args defaults to $_ */
	SvGETMAGIC(patsv);
	if (
	    !SvOK(patsv)
	 && (patsv = DEFSV, SvGETMAGIC(patsv), !SvOK(patsv))
	)
	     pat = "", len = 0, is_utf8 = 0;
	else pat = SvPV_nomg(patsv,len), is_utf8 = !!SvUTF8(patsv);
	patend = pat + len;

	/* extract patterns */
	/* XXX this is needed for compatibility with the csh
	 * implementation in Perl.  Need to support a flag
	 * to disable this behavior.
	 */
	s = pat-1;
	while (++s < patend) {
	    switch (*s) {
	    case '\'':
	    case '"' :
	      {
		bool found = FALSE;
		if (!word) {
		    word = newSVpvs("");
		    if (is_utf8) SvUTF8_on(word);
		}
		if (piece) sv_catpvn(word, piece, s-piece);
		piece = s+1;
		while (++s <= patend)
		    if (*s == '\\') s++;
		    else if (*s == *(piece-1)) {
			sv_catpvn(word, piece, s-piece);
			piece = NULL;
			found = TRUE;
			break;
		    }
		if (!found) { /* unmatched quote */
		    /* Give up on tokenisation and treat the whole string
		       as a single token, but with whitespace stripped. */
		    piece = pat;
		    while (isSPACE(*pat)) pat++;
		    while (isSPACE(*(patend-1))) patend--;
		    /* bsd_glob expects a trailing null, but we cannot mod-
		       ify the original */
		    if (patend < SvEND(patsv)) {
			if (word) sv_setpvn(word, pat, patend-pat);
			else
			    word = newSVpvn_flags(
				pat, patend-pat, SVf_UTF8*is_utf8
			    );
			piece = NULL;
		    }
		    else {
			if (word) SvREFCNT_dec(word), word=NULL;
			piece = pat;
			s = patend;
		    }
		    goto end_of_parsing;
		}
		break;
	      }
	    case '\\': if (!piece) piece = s; s++; break;
	    default:
		if (isSPACE(*s)) {
		    if (piece) {
			if (!word) {
			    word = newSVpvn(piece,s-piece);
			    if (is_utf8) SvUTF8_on(word);
			}
			else sv_catpvn(word, piece, s-piece);
		    }
		    if (!word) break;
		    if (!patav) patav = (AV *)sv_2mortal((SV *)newAV());
		    av_push(patav, word);
		    word = NULL;
		    piece = NULL;
		}
		else if (!piece) piece = s;
		break;
	    }
	}
      end_of_parsing:

	assert(!SvROK(entriesv));
	entries = (AV *)newSVrv(entriesv,NULL);
	sv_upgrade((SV *)entries, SVt_PVAV);
	
	if (patav) {
	    I32 items = AvFILLp(patav) + 1;
	    SV **svp = AvARRAY(patav);
	    while (items--) {
		PUSHMARK(SP);
		PUTBACK;
		doglob(aTHX_ SvPVXx(*svp++), flags);
		SPAGAIN;
		{
		    dMARK;
		    dORIGMARK;
		    while (++MARK <= SP)
			av_push(entries, SvREFCNT_inc_simple_NN(*MARK));
		    SP = ORIGMARK;
		}
	    }
	}
	/* piece is set at this point if there is no trailing whitespace.
	   It is the beginning of the last token or quote-delimited
	   piece thereof.  word is set at this point if the last token has
	   multiple quoted pieces. */
	if (piece || word) {
	    if (word) {
		if (piece) sv_catpvn(word, piece, s-piece);
		piece = SvPVX(word);
	    }
	    PUSHMARK(SP);
	    PUTBACK;
	    doglob(aTHX_ piece, flags);
	    if (word) SvREFCNT_dec(word);
	    SPAGAIN;
	    {
		dMARK;
		dORIGMARK;
		/* short-circuit here for a fairly common case */
		if (!patav && gimme == G_ARRAY) goto return_list;
		while (++MARK <= SP)
		    av_push(entries, SvREFCNT_inc_simple_NN(*MARK));

		SP = ORIGMARK;
	    }
	}
    }

    /* chuck it all out, quick or slow */
    assert(SvROK(entriesv));
    if (!entries) entries = (AV *)SvRV(entriesv);
    if (gimme == G_ARRAY) {
	Copy(AvARRAY(entries), SP+1, AvFILLp(entries)+1, SV *);
	SP += AvFILLp(entries)+1;
      return_list:
	hv_delete(MY_CXT.x_GLOB_ITER, cxixpv, cxixlen, G_DISCARD);
	/* No G_DISCARD here!  It will free the stack items. */
	hv_delete(MY_CXT.x_GLOB_ENTRIES, cxixpv, cxixlen, 0);
    }
    else {
	if (AvFILLp(entries) + 1) {
	    sv_setiv(itersv, AvFILLp(entries) + 1);
	    mPUSHs(av_shift(entries));
	}
	else {
	    /* return undef for EOL */
	    hv_delete(MY_CXT.x_GLOB_ITER, cxixpv, cxixlen, G_DISCARD);
	    hv_delete(MY_CXT.x_GLOB_ENTRIES, cxixpv, cxixlen, G_DISCARD);
	    PUSHs(&PL_sv_undef);
	}
    }
    PUTBACK;
}

MODULE = File::Glob		PACKAGE = File::Glob

int
GLOB_ERROR()
    PREINIT:
	dMY_CXT;
    CODE:
	RETVAL = GLOB_ERROR;
    OUTPUT:
	RETVAL

void
bsd_glob(pattern,...)
    char *pattern
PREINIT:
    glob_t pglob;
    int i;
    int retval;
    int flags = 0;
    SV *tmp;
PPCODE:
    {
	dMY_CXT;

	/* allow for optional flags argument */
	if (items > 1) {
	    flags = (int) SvIV(ST(1));
	    /* remove unsupported flags */
	    flags &= ~(GLOB_APPEND | GLOB_DOOFFS | GLOB_ALTDIRFUNC | GLOB_MAGCHAR);
	} else {
	    flags = (int) SvIV(get_sv("File::Glob::DEFAULT_FLAGS", GV_ADD));
	}
	
	PUTBACK;
	doglob(aTHX_ pattern, flags);
	SPAGAIN;
    }

PROTOTYPES: DISABLE
void
csh_glob(...)
PPCODE:
    /* For backward-compatibility with the original Perl function, we sim-
     * ply take the first two arguments, regardless of how many there are.
     */
    if (items >= 2) SP += 2;
    else {
	SP += items;
	XPUSHs(&PL_sv_undef);
	if (!items) XPUSHs(&PL_sv_undef);
    }
    PUTBACK;
    csh_glob(aTHX);
    SPAGAIN;

BOOT:
{
#ifndef PERL_EXTERNAL_GLOB
    /* Don’t do this at home! The globhook interface is highly volatile. */
    PL_globhook = csh_glob;
#endif
}

BOOT:
{
    MY_CXT_INIT;
    {
	dMY_CXT;
	MY_CXT.x_GLOB_ITER = MY_CXT.x_GLOB_ENTRIES = NULL;
    }  
}

INCLUDE: const-xs.inc
Commit	Line	Data
8e9c4baf NC	1	#define PERL_NO_GET_CONTEXT
8e9c4baf NC	2
72b16652 GS	3	#include "EXTERN.h"
	4	#include "perl.h"
	5	#include "XSUB.h"
	6
	7	#include "bsd_glob.h"
	8
df3728a2	9	#define MY_CXT_KEY "File::Glob::_guts" XS_VERSION
89ca4ac7 JH	10
	11	typedef struct {
	12	int x_GLOB_ERROR;
1bb8785a FC	13	HV * x_GLOB_ITER;
1bb8785a FC	14	HV * x_GLOB_ENTRIES;
89ca4ac7 JH	15	} my_cxt_t;
	16
	17	START_MY_CXT
	18
	19	#define GLOB_ERROR (MY_CXT.x_GLOB_ERROR)
72b16652	20
1cb0fb50	21	#include "const-c.inc"
72b16652 GS	22
	23	#ifdef WIN32
	24	#define errfunc NULL
	25	#else
f681a178	26	static int
72b16652	27	errfunc(const char *foo, int bar) {
c33e8be1	28	PERL_UNUSED_ARG(foo);
5f18268b	29	return !(bar == EACCES \|\| bar == ENOENT \|\| bar == ENOTDIR);
72b16652 GS	30	}
	31	#endif
	32
1bb8785a FC	33	static void
	34	doglob(pTHX_ const char *pattern, int flags)
	35	{
	36	dSP;
	37	glob_t pglob;
	38	int i;
	39	int retval;
	40	SV *tmp;
	41	{
	42	dMY_CXT;
	43
	44	/* call glob */
	45	memset(&pglob, 0, sizeof(glob_t));
	46	retval = bsd_glob(pattern, flags, errfunc, &pglob);
	47	GLOB_ERROR = retval;
	48
	49	/* return any matches found */
	50	EXTEND(sp, pglob.gl_pathc);
	51	for (i = 0; i < pglob.gl_pathc; i++) {
	52	/* printf("# bsd_glob: %s\n", pglob.gl_pathv[i]); */
	53	tmp = newSVpvn_flags(pglob.gl_pathv[i], strlen(pglob.gl_pathv[i]),
	54	SVs_TEMP);
	55	TAINT;
	56	SvTAINT(tmp);
	57	PUSHs(tmp);
	58	}
	59	PUTBACK;
	60
	61	bsd_globfree(&pglob);
	62	}
	63	}
	64
	65	/* borrowed heavily from gsar's File::DosGlob, but translated into C */
	66	static void
	67	csh_glob(pTHX)
	68	{
	69	dSP;
	70	dMY_CXT;
	71
	72	SV *cxixsv = POPs;
	73	const char *cxixpv;
	74	STRLEN cxixlen;
	75	STRLEN len;
	76	const char *s = NULL;
	77	SV *itersv;
	78	SV *entriesv;
	79	AV *entries = NULL;
	80	U32 gimme = GIMME_V;
	81	SV *patsv = POPs;
	82
	83	/* assume global context if not provided one */
	84	SvGETMAGIC(cxixsv);
	85	if (SvOK(cxixsv)) cxixpv = SvPV_nomg(cxixsv, cxixlen);
	86	else cxixpv = "_G_", cxixlen = 3;
	87
	88	if (!MY_CXT.x_GLOB_ITER) MY_CXT.x_GLOB_ITER = newHV();
	89	itersv = *(hv_fetch(MY_CXT.x_GLOB_ITER, cxixpv, cxixlen, 1));
	90	if (!SvOK(itersv)) sv_setiv(itersv,0);
	91
	92	if (!MY_CXT.x_GLOB_ENTRIES) MY_CXT.x_GLOB_ENTRIES = newHV();
	93	entriesv = *(hv_fetch(MY_CXT.x_GLOB_ENTRIES, cxixpv, cxixlen, 1));
	94
	95	/* if we're just beginning, do it all first */
	96	if (!SvIV(itersv)) {
97	const char *pat;
98	AV *patav = NULL;
99	const char *patend;
100	const char *piece = NULL;
101	SV *word = NULL;
102	int const flags =
103	(int)SvIV(get_sv("File::Glob::DEFAULT_FLAGS", GV_ADD));
104	bool is_utf8;
105
106	/* glob without args defaults to $_ */
107	SvGETMAGIC(patsv);
108	if (
109	!SvOK(patsv)
110	&& (patsv = DEFSV, SvGETMAGIC(patsv), !SvOK(patsv))
111	)
112	pat = "", len = 0, is_utf8 = 0;
113	else pat = SvPV_nomg(patsv,len), is_utf8 = !!SvUTF8(patsv);
114	patend = pat + len;
115
116	/* extract patterns */
117	/* XXX this is needed for compatibility with the csh
118	* implementation in Perl. Need to support a flag
119	* to disable this behavior.
120	*/
121	s = pat-1;
122	while (++s < patend) {
123	switch (*s) {
124	case '\'':
125	case '"' :
126	{
127	bool found = FALSE;
128	if (!word) {
129	word = newSVpvs("");
130	if (is_utf8) SvUTF8_on(word);
131	}
132	if (piece) sv_catpvn(word, piece, s-piece);
133	piece = s+1;
134	while (++s <= patend)
135	if (*s == '\\') s++;
136	else if (s == (piece-1)) {
137	sv_catpvn(word, piece, s-piece);
138	piece = NULL;
139	found = TRUE;
140	break;
141	}
142	if (!found) { /* unmatched quote */
143	/* Give up on tokenisation and treat the whole string
144	as a single token, but with whitespace stripped. */
145	piece = pat;
146	while (isSPACE(*pat)) pat++;
147	while (isSPACE(*(patend-1))) patend--;
148	/* bsd_glob expects a trailing null, but we cannot mod-
149	ify the original */
150	if (patend < SvEND(patsv)) {
151	if (word) sv_setpvn(word, pat, patend-pat);
152	else
153	word = newSVpvn_flags(
154	pat, patend-pat, SVf_UTF8*is_utf8
155	);
156	piece = NULL;
157	}
158	else {
159	if (word) SvREFCNT_dec(word), word=NULL;
160	piece = pat;
161	s = patend;
162	}
163	goto end_of_parsing;
164	}
165	break;
166	}
167	case '\\': if (!piece) piece = s; s++; break;
168	default:
169	if (isSPACE(*s)) {
170	if (piece) {
171	if (!word) {
172	word = newSVpvn(piece,s-piece);
173	if (is_utf8) SvUTF8_on(word);
174	}
175	else sv_catpvn(word, piece, s-piece);
176	}
177	if (!word) break;
178	if (!patav) patav = (AV )sv_2mortal((SV )newAV());
179	av_push(patav, word);
180	word = NULL;
181	piece = NULL;
182	}
183	else if (!piece) piece = s;
184	break;
185	}
186	}
187	end_of_parsing:
188
189	assert(!SvROK(entriesv));
190	entries = (AV *)newSVrv(entriesv,NULL);
191	sv_upgrade((SV *)entries, SVt_PVAV);
192
193	if (patav) {
194	I32 items = AvFILLp(patav) + 1;
195	SV **svp = AvARRAY(patav);
196	while (items--) {
197	PUSHMARK(SP);
198	PUTBACK;
199	doglob(aTHX_ SvPVXx(*svp++), flags);
200	SPAGAIN;
201	{
202	dMARK;
203	dORIGMARK;
204	while (++MARK <= SP)
205	av_push(entries, SvREFCNT_inc_simple_NN(*MARK));
206	SP = ORIGMARK;
207	}
208	}
209	}
210	/* piece is set at this point if there is no trailing whitespace.
211	It is the beginning of the last token or quote-delimited
212	piece thereof. word is set at this point if the last token has
213	multiple quoted pieces. */
214	if (piece \|\| word) {
215	if (word) {
216	if (piece) sv_catpvn(word, piece, s-piece);
217	piece = SvPVX(word);
218	}
219	PUSHMARK(SP);
220	PUTBACK;
221	doglob(aTHX_ piece, flags);
222	if (word) SvREFCNT_dec(word);
223	SPAGAIN;
224	{
225	dMARK;
226	dORIGMARK;
1bb8785a FC	227	/* short-circuit here for a fairly common case */
1bb8785a FC	228	if (!patav && gimme == G_ARRAY) goto return_list;
c0d74586 FC	229	while (++MARK <= SP)
c0d74586 FC	230	av_push(entries, SvREFCNT_inc_simple_NN(*MARK));
1bb8785a FC	231
	232	SP = ORIGMARK;
	233	}
	234	}
	235	}
	236
	237	/* chuck it all out, quick or slow */
	238	assert(SvROK(entriesv));
	239	if (!entries) entries = (AV *)SvRV(entriesv);
	240	if (gimme == G_ARRAY) {
	241	Copy(AvARRAY(entries), SP+1, AvFILLp(entries)+1, SV *);
	242	SP += AvFILLp(entries)+1;
	243	return_list:
	244	hv_delete(MY_CXT.x_GLOB_ITER, cxixpv, cxixlen, G_DISCARD);
	245	/* No G_DISCARD here! It will free the stack items. */
	246	hv_delete(MY_CXT.x_GLOB_ENTRIES, cxixpv, cxixlen, 0);
	247	}
	248	else {
	249	if (AvFILLp(entries) + 1) {
	250	sv_setiv(itersv, AvFILLp(entries) + 1);
	251	mPUSHs(av_shift(entries));
	252	}
	253	else {
	254	/* return undef for EOL */
	255	hv_delete(MY_CXT.x_GLOB_ITER, cxixpv, cxixlen, G_DISCARD);
	256	hv_delete(MY_CXT.x_GLOB_ENTRIES, cxixpv, cxixlen, G_DISCARD);
	257	PUSHs(&PL_sv_undef);
	258	}
	259	}
	260	PUTBACK;
	261	}
	262
72b16652 GS	263	MODULE = File::Glob PACKAGE = File::Glob
72b16652 GS	264
b84cd0b1 NC	265	int
	266	GLOB_ERROR()
	267	PREINIT:
	268	dMY_CXT;
	269	CODE:
	270	RETVAL = GLOB_ERROR;
	271	OUTPUT:
	272	RETVAL
	273
72b16652	274	void
960ddb65	275	bsd_glob(pattern,...)
72b16652	276	char *pattern
72b16652 GS	277	PREINIT:
	278	glob_t pglob;
	279	int i;
	280	int retval;
	281	int flags = 0;
	282	SV *tmp;
	283	PPCODE:
	284	{
89ca4ac7 JH	285	dMY_CXT;
89ca4ac7 JH	286
72b16652 GS	287	/* allow for optional flags argument */
	288	if (items > 1) {
	289	flags = (int) SvIV(ST(1));
3c97495f CB	290	/* remove unsupported flags */
3c97495f CB	291	flags &= ~(GLOB_APPEND \| GLOB_DOOFFS \| GLOB_ALTDIRFUNC \| GLOB_MAGCHAR);
960ddb65	292	} else {
28cd8e1d	293	flags = (int) SvIV(get_sv("File::Glob::DEFAULT_FLAGS", GV_ADD));
72b16652	294	}
1bb8785a FC	295
	296	PUTBACK;
	297	doglob(aTHX_ pattern, flags);
	298	SPAGAIN;
	299	}
72b16652	300
1bb8785a FC	301	PROTOTYPES: DISABLE
	302	void
	303	csh_glob(...)
	304	PPCODE:
	305	/* For backward-compatibility with the original Perl function, we sim-
	306	* ply take the first two arguments, regardless of how many there are.
	307	*/
	308	if (items >= 2) SP += 2;
	309	else {
	310	SP += items;
	311	XPUSHs(&PL_sv_undef);
	312	if (!items) XPUSHs(&PL_sv_undef);
72b16652	313	}
1bb8785a FC	314	PUTBACK;
	315	csh_glob(aTHX);
	316	SPAGAIN;
72b16652	317
28cd8e1d NC	318	BOOT:
28cd8e1d NC	319	{
d67594ff FC	320	#ifndef PERL_EXTERNAL_GLOB
	321	/* Don’t do this at home! The globhook interface is highly volatile. */
	322	PL_globhook = csh_glob;
	323	#endif
bcd258b8	324	}
28cd8e1d	325
bcd258b8 NC	326	BOOT:
bcd258b8 NC	327	{
28cd8e1d	328	MY_CXT_INIT;
1bb8785a FC	329	{
	330	dMY_CXT;
	331	MY_CXT.x_GLOB_ITER = MY_CXT.x_GLOB_ENTRIES = NULL;
	332	}
28cd8e1d NC	333	}
28cd8e1d NC	334
1cb0fb50	335	INCLUDE: const-xs.inc