[perl5.git] / regexp.h

/*    regexp.h
 *
 *    Copyright (C) 1993, 1994, 1996, 1997, 1999, 2000, 2001, 2003,
 *    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.
 *
 */

/*
 * Definitions etc. for regexp(3) routines.
 *
 * Caveat:  this is V8 regexp(3) [actually, a reimplementation thereof],
 * not the System V one.
 */
#ifndef PLUGGABLE_RE_EXTENSION
/* we don't want to include this stuff if we are inside Nicholas'
 * pluggable regex engine code */

struct regnode {
    U8	flags;
    U8  type;
    U16 next_off;
};

typedef struct regnode regnode;

struct reg_substr_data;

struct reg_data;

struct regexp_engine;

typedef struct regexp {
	I32 *startp;
	I32 *endp;
	regnode *regstclass;
        struct reg_substr_data *substrs;
	char *precomp;		/* pre-compilation regular expression */
        struct reg_data *data;	/* Additional data. */
	char *subbeg;		/* saved or original string 
				   so \digit works forever. */
#ifdef PERL_OLD_COPY_ON_WRITE
        SV *saved_copy;         /* If non-NULL, SV which is COW from original */
#endif
        U32 *offsets;           /* offset annotations 20001228 MJD */
	I32 sublen;		/* Length of string pointed by subbeg */
	I32 refcnt;
	I32 minlen;		/* mininum possible length of $& */
	I32 prelen;		/* length of precomp */
	U32 nparens;		/* number of parentheses */
	U32 lastparen;		/* last paren matched */
	U32 lastcloseparen;	/* last paren matched */
	U32 reganch;		/* Internal use only +
				   Tainted information used by regexec? */
	HV *paren_names;	/* Paren names */
	const struct regexp_engine* engine;
	regnode program[1];	/* Unwarranted chumminess with compiler. */
} regexp;


typedef struct re_scream_pos_data_s
{
    char **scream_olds;		/* match pos */
    I32 *scream_pos;		/* Internal iterator of scream. */
} re_scream_pos_data;

typedef struct regexp_engine {
    regexp* (*comp) (pTHX_ char* exp, char* xend, PMOP* pm);
    I32	    (*exec) (pTHX_ regexp* prog, char* stringarg, char* strend,
			    char* strbeg, I32 minend, SV* screamer,
			    void* data, U32 flags);
    char*   (*intuit) (pTHX_ regexp *prog, SV *sv, char *strpos,
			    char *strend, U32 flags,
			    struct re_scream_pos_data_s *data);
    SV*	    (*checkstr) (pTHX_ regexp *prog);
    void    (*free) (pTHX_ struct regexp* r);
#ifdef USE_ITHREADS
    regexp* (*dupe) (pTHX_ const regexp *r, CLONE_PARAMS *param);
#endif    
} regexp_engine;

#define ROPT_ANCH		(ROPT_ANCH_BOL|ROPT_ANCH_MBOL|ROPT_ANCH_GPOS|ROPT_ANCH_SBOL)
#define ROPT_ANCH_SINGLE	(ROPT_ANCH_SBOL|ROPT_ANCH_GPOS)
#define ROPT_ANCH_BOL	 	0x00000001
#define ROPT_ANCH_MBOL	 	0x00000002
#define ROPT_ANCH_SBOL	 	0x00000004
#define ROPT_ANCH_GPOS	 	0x00000008
#define ROPT_SKIP		0x00000010
#define ROPT_IMPLICIT		0x00000020	/* Converted .* to ^.* */
#define ROPT_NOSCAN		0x00000040	/* Check-string always at start. */
#define ROPT_GPOS_SEEN		0x00000080
#define ROPT_CHECK_ALL		0x00000100
#define ROPT_LOOKBEHIND_SEEN	0x00000200
#define ROPT_EVAL_SEEN		0x00000400
#define ROPT_CANY_SEEN		0x00000800
#define ROPT_SANY_SEEN		ROPT_CANY_SEEN /* src bckwrd cmpt */
#define ROPT_GPOS_CHECK         (ROPT_GPOS_SEEN|ROPT_ANCH_GPOS)
#define ROPT_RECURSE_SEEN       0x00001000

/* 0xf800 of reganch is used by PMf_COMPILETIME */

#define ROPT_UTF8		0x00010000
#define ROPT_NAUGHTY		0x00020000 /* how exponential is this pattern? */
#define ROPT_COPY_DONE		0x00040000	/* subbeg is a copy of the string */
#define ROPT_TAINTED_SEEN	0x00080000
#define ROPT_MATCH_UTF8		0x10000000 /* subbeg is utf-8 */

#define RE_USE_INTUIT_NOML	0x00100000 /* Best to intuit before matching */
#define RE_USE_INTUIT_ML	0x00200000
#define REINT_AUTORITATIVE_NOML	0x00400000 /* Can trust a positive answer */
#define REINT_AUTORITATIVE_ML	0x00800000
#define REINT_ONCE_NOML		0x01000000 /* Intuit can succed once only. */
#define REINT_ONCE_ML		0x02000000
#define RE_INTUIT_ONECHAR	0x04000000
#define RE_INTUIT_TAIL		0x08000000


#define RE_USE_INTUIT		(RE_USE_INTUIT_NOML|RE_USE_INTUIT_ML)
#define REINT_AUTORITATIVE	(REINT_AUTORITATIVE_NOML|REINT_AUTORITATIVE_ML)
#define REINT_ONCE		(REINT_ONCE_NOML|REINT_ONCE_ML)

#define RX_MATCH_TAINTED(prog)	((prog)->reganch & ROPT_TAINTED_SEEN)
#define RX_MATCH_TAINTED_on(prog) ((prog)->reganch |= ROPT_TAINTED_SEEN)
#define RX_MATCH_TAINTED_off(prog) ((prog)->reganch &= ~ROPT_TAINTED_SEEN)
#define RX_MATCH_TAINTED_set(prog, t) ((t) \
				       ? RX_MATCH_TAINTED_on(prog) \
				       : RX_MATCH_TAINTED_off(prog))

#define RX_MATCH_COPIED(prog)		((prog)->reganch & ROPT_COPY_DONE)
#define RX_MATCH_COPIED_on(prog)	((prog)->reganch |= ROPT_COPY_DONE)
#define RX_MATCH_COPIED_off(prog)	((prog)->reganch &= ~ROPT_COPY_DONE)
#define RX_MATCH_COPIED_set(prog,t)	((t) \
					 ? RX_MATCH_COPIED_on(prog) \
					 : RX_MATCH_COPIED_off(prog))

#endif /* PLUGGABLE_RE_EXTENSION */

/* Stuff that needs to be included in the plugable extension goes below here */

#define RE_DEBUG_BIT            0x20000000
#define RX_DEBUG(prog)	((prog)->reganch & RE_DEBUG_BIT)
#define RX_DEBUG_on(prog) ((prog)->reganch |= RE_DEBUG_BIT)

#ifdef PERL_OLD_COPY_ON_WRITE
#define RX_MATCH_COPY_FREE(rx) \
	STMT_START {if (rx->saved_copy) { \
	    SV_CHECK_THINKFIRST_COW_DROP(rx->saved_copy); \
	} \
	if (RX_MATCH_COPIED(rx)) { \
	    Safefree(rx->subbeg); \
	    RX_MATCH_COPIED_off(rx); \
	}} STMT_END
#else
#define RX_MATCH_COPY_FREE(rx) \
	STMT_START {if (RX_MATCH_COPIED(rx)) { \
	    Safefree(rx->subbeg); \
	    RX_MATCH_COPIED_off(rx); \
	}} STMT_END
#endif

#define RX_MATCH_UTF8(prog)		((prog)->reganch & ROPT_MATCH_UTF8)
#define RX_MATCH_UTF8_on(prog)		((prog)->reganch |= ROPT_MATCH_UTF8)
#define RX_MATCH_UTF8_off(prog)		((prog)->reganch &= ~ROPT_MATCH_UTF8)
#define RX_MATCH_UTF8_set(prog, t)	((t) \
			? (RX_MATCH_UTF8_on(prog), (PL_reg_match_utf8 = 1)) \
			: (RX_MATCH_UTF8_off(prog), (PL_reg_match_utf8 = 0)))
    
#define REXEC_COPY_STR	0x01		/* Need to copy the string. */
#define REXEC_CHECKED	0x02		/* check_substr already checked. */
#define REXEC_SCREAM	0x04		/* use scream table. */
#define REXEC_IGNOREPOS	0x08		/* \G matches at start. */
#define REXEC_NOT_FIRST	0x10		/* This is another iteration of //g. */

#define ReREFCNT_inc(re) ((void)(re && re->refcnt++), re)
#define ReREFCNT_dec(re) CALLREGFREE(re)

#define FBMcf_TAIL_DOLLAR	1
#define FBMcf_TAIL_DOLLARM	2
#define FBMcf_TAIL_Z		4
#define FBMcf_TAIL_z		8
#define FBMcf_TAIL		(FBMcf_TAIL_DOLLAR|FBMcf_TAIL_DOLLARM|FBMcf_TAIL_Z|FBMcf_TAIL_z)

#define FBMrf_MULTILINE	1

struct re_scream_pos_data_s;

/* an accepting state/position*/
struct _reg_trie_accepted {
    U8   *endpos;
    U16  wordnum;
};
typedef struct _reg_trie_accepted reg_trie_accepted;

/* some basic information about the current match that is created by
 * Perl_regexec_flags and then passed to regtry(), regmatch() etc */

typedef struct {
    regexp *prog;
    char *bol;
    char *till;
    SV *sv;
    char *ganch;
} regmatch_info;
 

/* structures for holding and saving the state maintained by regmatch() */

#define MAX_RECURSE_EVAL_NOCHANGE_DEPTH 50

typedef I32 CHECKPOINT;

typedef struct regmatch_state {
    int resume_state;		/* where to jump to on return */
    char *locinput;		/* where to backtrack in string on failure */

    union {

	/* this is a fake union member that matches the first element
	 * of each member that needs to store positive backtrack
	 * information */
	struct {
	    struct regmatch_state *prev_yes_state;
	} yes;

	struct {
	    reg_trie_accepted *accept_buff;
	    U32		accepted; /* how many accepting states we have seen */
	    U16         *jump;  /* negative offsets from B */
	    regnode	*B;	/* node following the trie */
	    regnode	*me;	/* only needed for debugging */
	} trie;

	struct {
	    /* this first element must match u.yes */
	    struct regmatch_state *prev_yes_state;
	    struct regmatch_state *prev_eval;
	    struct regmatch_state *prev_curlyx;
	    regexp	*prev_rex;
	    U32		toggle_reg_flags; /* what bits in PL_reg_flags to
					    flip when transitioning between
					    inner and outer rexen */
	    CHECKPOINT	cp;	/* remember current savestack indexes */
	    CHECKPOINT	lastcp;
	    regnode	*B;	/* the node following us  */
	    U32        close_paren; /* which close bracket is our end */
	} eval;

	struct {
	    /* this first element must match u.yes */
	    struct regmatch_state *prev_yes_state;
	    struct regmatch_state *prev_curlyx; /* previous cur_curlyx */
	    CHECKPOINT	cp;	/* remember current savestack index */
	    bool	minmod;
	    int		parenfloor;/* how far back to strip paren data */
	    int		min;	/* the minimal number of A's to match */
	    int		max;	/* the maximal number of A's to match */
	    regnode	*A, *B;	/* the nodes corresponding to /A*B/  */

	    /* these two are modified by WHILEM */
	    int		count;	/* how many instances of A we've matched */
	    char	*lastloc;/* where previous A matched (0-len detect) */
	} curlyx;

	struct {
	    /* this first element must match u.yes */
	    struct regmatch_state *prev_yes_state;
	    struct regmatch_state *save_curlyx;
	    CHECKPOINT	cp;	/* remember current savestack indexes */
	    CHECKPOINT	lastcp;
	    char	*save_lastloc;	/* previous curlyx.lastloc */
	    I32		cache_offset;
	    I32		cache_mask;
	} whilem;

	struct {
	    I32 lastparen;
	    regnode *next_branch; /* next branch node */
	    CHECKPOINT cp;
	} branch;

	struct {
	    /* this first element must match u.yes */
	    struct regmatch_state *prev_yes_state;
	    I32 c1, c2;		/* case fold search */
	    CHECKPOINT cp;
	    I32 alen;		/* length of first-matched A string */
	    I32 count;
	    bool minmod;
	    regnode *A, *B;	/* the nodes corresponding to /A*B/  */
	    regnode *me;	/* the curlym node */
	} curlym;

	struct {
	    I32 paren;
	    CHECKPOINT cp;
	    I32 c1, c2;		/* case fold search */
	    char *maxpos;	/* highest possible point in string to match */
	    char *oldloc;	/* the previous locinput */
	    int count;
	    int min, max;	/* {m,n} */
	    regnode *A, *B;	/* the nodes corresponding to /A*B/  */
	} curly; /* and CURLYN/PLUS/STAR */

	struct {
	    /* this first element must match u.yes */
	    struct regmatch_state *prev_yes_state;
	    I32 wanted;
	    I32 logical;	/* saved copy of 'logical' var */
	    regnode  *me; /* the IFMATCH/SUSPEND/UNLESSM node  */
	} ifmatch; /* and SUSPEND/UNLESSM */
    } u;
} regmatch_state;

/* how many regmatch_state structs to allocate as a single slab.
 * We do it in 4K blocks for efficiency. The "3" is 2 for the next/prev
 * pointers, plus 1 for any mythical malloc overhead. */
 
#define PERL_REGMATCH_SLAB_SLOTS \
    ((4096 - 3 * sizeof (void*)) / sizeof(regmatch_state))

typedef struct regmatch_slab {
    regmatch_state states[PERL_REGMATCH_SLAB_SLOTS];
    struct regmatch_slab *prev, *next;
} regmatch_slab;

#define PL_reg_flags		PL_reg_state.re_state_reg_flags
#define PL_bostr		PL_reg_state.re_state_bostr
#define PL_reginput		PL_reg_state.re_state_reginput
#define PL_regeol		PL_reg_state.re_state_regeol
#define PL_regstartp		PL_reg_state.re_state_regstartp
#define PL_regendp		PL_reg_state.re_state_regendp
#define PL_reglastparen		PL_reg_state.re_state_reglastparen
#define PL_reglastcloseparen	PL_reg_state.re_state_reglastcloseparen
#define PL_reg_start_tmp	PL_reg_state.re_state_reg_start_tmp
#define PL_reg_start_tmpl	PL_reg_state.re_state_reg_start_tmpl
#define PL_reg_eval_set		PL_reg_state.re_state_reg_eval_set
#define PL_reg_match_utf8	PL_reg_state.re_state_reg_match_utf8
#define PL_reg_magic		PL_reg_state.re_state_reg_magic
#define PL_reg_oldpos		PL_reg_state.re_state_reg_oldpos
#define PL_reg_oldcurpm		PL_reg_state.re_state_reg_oldcurpm
#define PL_reg_curpm		PL_reg_state.re_state_reg_curpm
#define PL_reg_oldsaved		PL_reg_state.re_state_reg_oldsaved
#define PL_reg_oldsavedlen	PL_reg_state.re_state_reg_oldsavedlen
#define PL_reg_maxiter		PL_reg_state.re_state_reg_maxiter
#define PL_reg_leftiter		PL_reg_state.re_state_reg_leftiter
#define PL_reg_poscache		PL_reg_state.re_state_reg_poscache
#define PL_reg_poscache_size	PL_reg_state.re_state_reg_poscache_size
#define PL_regsize		PL_reg_state.re_state_regsize
#define PL_reg_starttry		PL_reg_state.re_state_reg_starttry
#define PL_nrs			PL_reg_state.re_state_nrs

struct re_save_state {
    U32 re_state_reg_flags;		/* from regexec.c */
    char *re_state_bostr;
    char *re_state_reginput;		/* String-input pointer. */
    char *re_state_regeol;		/* End of input, for $ check. */
    I32 *re_state_regstartp;		/* Pointer to startp array. */
    I32 *re_state_regendp;		/* Ditto for endp. */
    U32 *re_state_reglastparen;		/* Similarly for lastparen. */
    U32 *re_state_reglastcloseparen;	/* Similarly for lastcloseparen. */
    char **re_state_reg_start_tmp;	/* from regexec.c */
    U32 re_state_reg_start_tmpl;	/* from regexec.c */
    I32 re_state_reg_eval_set;		/* from regexec.c */
    bool re_state_reg_match_utf8;	/* from regexec.c */
    MAGIC *re_state_reg_magic;		/* from regexec.c */
    I32 re_state_reg_oldpos;		/* from regexec.c */
    PMOP *re_state_reg_oldcurpm;	/* from regexec.c */
    PMOP *re_state_reg_curpm;		/* from regexec.c */
    char *re_state_reg_oldsaved;	/* old saved substr during match */
    STRLEN re_state_reg_oldsavedlen;	/* old length of saved substr during match */
    I32 re_state_reg_maxiter;		/* max wait until caching pos */
    I32 re_state_reg_leftiter;		/* wait until caching pos */
    char *re_state_reg_poscache;	/* cache of pos of WHILEM */
    STRLEN re_state_reg_poscache_size;	/* size of pos cache of WHILEM */
    I32 re_state_regsize;		/* from regexec.c */
    char *re_state_reg_starttry;	/* from regexec.c */
#ifdef PERL_OLD_COPY_ON_WRITE
    SV *re_state_nrs;			/* was placeholder: unused since 5.8.0 (5.7.2 patch #12027 for bug ID 20010815.012). Used to save rx->saved_copy */
#endif
};

#define SAVESTACK_ALLOC_FOR_RE_SAVE_STATE \
	(1 + ((sizeof(struct re_save_state) - 1) / sizeof(*PL_savestack)))
/*
 * Local variables:
 * c-indentation-style: bsd
 * c-basic-offset: 4
 * indent-tabs-mode: t
 * End:
 *
 * ex: set ts=8 sts=4 sw=4 noet:
 */
Commit	Line	Data
a0d0e21e	1	/* regexp.h
d6376244	2	*
4bb101f2 JH	3	* Copyright (C) 1993, 1994, 1996, 1997, 1999, 2000, 2001, 2003,
4bb101f2 JH	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	*
a0d0e21e LW	9	*/
a0d0e21e LW	10
378cc40b LW	11	/*
	12	* Definitions etc. for regexp(3) routines.
	13	*
	14	* Caveat: this is V8 regexp(3) [actually, a reimplementation thereof],
	15	* not the System V one.
	16	*/
be8e71aa YO	17	#ifndef PLUGGABLE_RE_EXTENSION
	18	/* we don't want to include this stuff if we are inside Nicholas'
	19	* pluggable regex engine code */
378cc40b	20
c277df42 IZ	21	struct regnode {
	22	U8 flags;
	23	U8 type;
	24	U16 next_off;
	25	};
	26
	27	typedef struct regnode regnode;
	28
cad2e5aa	29	struct reg_substr_data;
2779dcf1	30
0ee3c8d0 JH	31	struct reg_data;
0ee3c8d0 JH	32
f9f4320a YO	33	struct regexp_engine;
f9f4320a YO	34
378cc40b	35	typedef struct regexp {
cf93c79d IZ	36	I32 *startp;
cf93c79d IZ	37	I32 *endp;
c277df42	38	regnode *regstclass;
2779dcf1	39	struct reg_substr_data *substrs;
cf93c79d	40	char precomp; / pre-compilation regular expression */
c277df42	41	struct reg_data data; / Additional data. */
cf93c79d IZ	42	char subbeg; / saved or original string
cf93c79d IZ	43	so \digit works forever. */
f8c7b90f	44	#ifdef PERL_OLD_COPY_ON_WRITE
ed252734 NC	45	SV saved_copy; / If non-NULL, SV which is COW from original */
ed252734 NC	46	#endif
fac92740	47	U32 offsets; / offset annotations 20001228 MJD */
cf93c79d IZ	48	I32 sublen; /* Length of string pointed by subbeg */
	49	I32 refcnt;
	50	I32 minlen; /* mininum possible length of $& */
	51	I32 prelen; /* length of precomp */
	52	U32 nparens; /* number of parentheses */
	53	U32 lastparen; /* last paren matched */
a01268b5	54	U32 lastcloseparen; /* last paren matched */
cf93c79d IZ	55	U32 reganch; /* Internal use only +
cf93c79d IZ	56	Tainted information used by regexec? */
81714fb9 YO	57	HV paren_names; / Paren names */
81714fb9 YO	58	const struct regexp_engine* engine;
c277df42	59	regnode program[1]; /* Unwarranted chumminess with compiler. */
378cc40b LW	60	} regexp;
378cc40b LW	61
f9f4320a YO	62
	63	typedef struct re_scream_pos_data_s
	64	{
	65	char *scream_olds; / match pos */
	66	I32 scream_pos; / Internal iterator of scream. */
	67	} re_scream_pos_data;
	68
	69	typedef struct regexp_engine {
f2f78491 YO	70	regexp* (comp) (pTHX_ char exp, char* xend, PMOP* pm);
f2f78491 YO	71	I32 (exec) (pTHX_ regexp prog, char* stringarg, char* strend,
f9f4320a YO	72	char* strbeg, I32 minend, SV* screamer,
f9f4320a YO	73	void* data, U32 flags);
f2f78491 YO	74	char* (intuit) (pTHX_ regexp prog, SV sv, char strpos,
	75	char *strend, U32 flags,
	76	struct re_scream_pos_data_s *data);
	77	SV* (checkstr) (pTHX_ regexp prog);
	78	void (free) (pTHX_ struct regexp r);
	79	#ifdef USE_ITHREADS
	80	regexp* (dupe) (pTHX_ const regexp r, CLONE_PARAMS *param);
f9f4320a YO	81	#endif
	82	} regexp_engine;
	83
cad2e5aa JH	84	#define ROPT_ANCH (ROPT_ANCH_BOL\|ROPT_ANCH_MBOL\|ROPT_ANCH_GPOS\|ROPT_ANCH_SBOL)
cad2e5aa JH	85	#define ROPT_ANCH_SINGLE (ROPT_ANCH_SBOL\|ROPT_ANCH_GPOS)
f2278c82 YO	86	#define ROPT_ANCH_BOL 0x00000001
	87	#define ROPT_ANCH_MBOL 0x00000002
	88	#define ROPT_ANCH_SBOL 0x00000004
	89	#define ROPT_ANCH_GPOS 0x00000008
	90	#define ROPT_SKIP 0x00000010
	91	#define ROPT_IMPLICIT 0x00000020 /* Converted .* to ^.* */
	92	#define ROPT_NOSCAN 0x00000040 /* Check-string always at start. */
	93	#define ROPT_GPOS_SEEN 0x00000080
	94	#define ROPT_CHECK_ALL 0x00000100
	95	#define ROPT_LOOKBEHIND_SEEN 0x00000200
	96	#define ROPT_EVAL_SEEN 0x00000400
	97	#define ROPT_CANY_SEEN 0x00000800
cce850e4	98	#define ROPT_SANY_SEEN ROPT_CANY_SEEN /* src bckwrd cmpt */
f9f4320a	99	#define ROPT_GPOS_CHECK (ROPT_GPOS_SEEN\|ROPT_ANCH_GPOS)
6bda09f9	100	#define ROPT_RECURSE_SEEN 0x00001000
a0ed51b3	101
8782bef2	102	/* 0xf800 of reganch is used by PMf_COMPILETIME */
c277df42	103
f2278c82 YO	104	#define ROPT_UTF8 0x00010000
	105	#define ROPT_NAUGHTY 0x00020000 /* how exponential is this pattern? */
	106	#define ROPT_COPY_DONE 0x00040000 /* subbeg is a copy of the string */
	107	#define ROPT_TAINTED_SEEN 0x00080000
a30b2f1f	108	#define ROPT_MATCH_UTF8 0x10000000 /* subbeg is utf-8 */
a0ed51b3	109
f2278c82 YO	110	#define RE_USE_INTUIT_NOML 0x00100000 /* Best to intuit before matching */
	111	#define RE_USE_INTUIT_ML 0x00200000
	112	#define REINT_AUTORITATIVE_NOML 0x00400000 /* Can trust a positive answer */
be8e71aa	113	#define REINT_AUTORITATIVE_ML 0x00800000
f2278c82 YO	114	#define REINT_ONCE_NOML 0x01000000 /* Intuit can succed once only. */
	115	#define REINT_ONCE_ML 0x02000000
	116	#define RE_INTUIT_ONECHAR 0x04000000
	117	#define RE_INTUIT_TAIL 0x08000000
	118
cad2e5aa JH	119
	120	#define RE_USE_INTUIT (RE_USE_INTUIT_NOML\|RE_USE_INTUIT_ML)
	121	#define REINT_AUTORITATIVE (REINT_AUTORITATIVE_NOML\|REINT_AUTORITATIVE_ML)
	122	#define REINT_ONCE (REINT_ONCE_NOML\|REINT_ONCE_ML)
	123
c277df42	124	#define RX_MATCH_TAINTED(prog) ((prog)->reganch & ROPT_TAINTED_SEEN)
72311751 GS	125	#define RX_MATCH_TAINTED_on(prog) ((prog)->reganch \|= ROPT_TAINTED_SEEN)
	126	#define RX_MATCH_TAINTED_off(prog) ((prog)->reganch &= ~ROPT_TAINTED_SEEN)
	127	#define RX_MATCH_TAINTED_set(prog, t) ((t) \
	128	? RX_MATCH_TAINTED_on(prog) \
	129	: RX_MATCH_TAINTED_off(prog))
c277df42	130
cf93c79d IZ	131	#define RX_MATCH_COPIED(prog) ((prog)->reganch & ROPT_COPY_DONE)
	132	#define RX_MATCH_COPIED_on(prog) ((prog)->reganch \|= ROPT_COPY_DONE)
	133	#define RX_MATCH_COPIED_off(prog) ((prog)->reganch &= ~ROPT_COPY_DONE)
	134	#define RX_MATCH_COPIED_set(prog,t) ((t) \
	135	? RX_MATCH_COPIED_on(prog) \
	136	: RX_MATCH_COPIED_off(prog))
f9f4320a	137
be8e71aa YO	138	#endif /* PLUGGABLE_RE_EXTENSION */
	139
	140	/* Stuff that needs to be included in the plugable extension goes below here */
	141
	142	#define RE_DEBUG_BIT 0x20000000
	143	#define RX_DEBUG(prog) ((prog)->reganch & RE_DEBUG_BIT)
	144	#define RX_DEBUG_on(prog) ((prog)->reganch \|= RE_DEBUG_BIT)
cf93c79d	145
f8c7b90f	146	#ifdef PERL_OLD_COPY_ON_WRITE
ed252734 NC	147	#define RX_MATCH_COPY_FREE(rx) \
	148	STMT_START {if (rx->saved_copy) { \
	149	SV_CHECK_THINKFIRST_COW_DROP(rx->saved_copy); \
	150	} \
	151	if (RX_MATCH_COPIED(rx)) { \
	152	Safefree(rx->subbeg); \
	153	RX_MATCH_COPIED_off(rx); \
	154	}} STMT_END
	155	#else
	156	#define RX_MATCH_COPY_FREE(rx) \
	157	STMT_START {if (RX_MATCH_COPIED(rx)) { \
	158	Safefree(rx->subbeg); \
	159	RX_MATCH_COPIED_off(rx); \
	160	}} STMT_END
	161	#endif
	162
a30b2f1f RGS	163	#define RX_MATCH_UTF8(prog) ((prog)->reganch & ROPT_MATCH_UTF8)
	164	#define RX_MATCH_UTF8_on(prog) ((prog)->reganch \|= ROPT_MATCH_UTF8)
	165	#define RX_MATCH_UTF8_off(prog) ((prog)->reganch &= ~ROPT_MATCH_UTF8)
	166	#define RX_MATCH_UTF8_set(prog, t) ((t) \
	167	? (RX_MATCH_UTF8_on(prog), (PL_reg_match_utf8 = 1)) \
	168	: (RX_MATCH_UTF8_off(prog), (PL_reg_match_utf8 = 0)))
	169
cad2e5aa JH	170	#define REXEC_COPY_STR 0x01 /* Need to copy the string. */
	171	#define REXEC_CHECKED 0x02 /* check_substr already checked. */
	172	#define REXEC_SCREAM 0x04 /* use scream table. */
	173	#define REXEC_IGNOREPOS 0x08 /* \G matches at start. */
cf93c79d	174	#define REXEC_NOT_FIRST 0x10 /* This is another iteration of //g. */
c277df42	175
155aba94	176	#define ReREFCNT_inc(re) ((void)(re && re->refcnt++), re)
f9f4320a	177	#define ReREFCNT_dec(re) CALLREGFREE(re)
cf93c79d IZ	178
cf93c79d IZ	179	#define FBMcf_TAIL_DOLLAR 1
cad2e5aa JH	180	#define FBMcf_TAIL_DOLLARM 2
	181	#define FBMcf_TAIL_Z 4
	182	#define FBMcf_TAIL_z 8
	183	#define FBMcf_TAIL (FBMcf_TAIL_DOLLAR\|FBMcf_TAIL_DOLLARM\|FBMcf_TAIL_Z\|FBMcf_TAIL_z)
cf93c79d IZ	184
cf93c79d IZ	185	#define FBMrf_MULTILINE 1
cad2e5aa JH	186
cad2e5aa JH	187	struct re_scream_pos_data_s;
5d9a96ca DM	188
	189	/* an accepting state/position*/
	190	struct _reg_trie_accepted {
	191	U8 *endpos;
	192	U16 wordnum;
	193	};
	194	typedef struct _reg_trie_accepted reg_trie_accepted;
	195
3b0527fe DM	196	/* some basic information about the current match that is created by
	197	* Perl_regexec_flags and then passed to regtry(), regmatch() etc */
	198
	199	typedef struct {
	200	regexp *prog;
	201	char *bol;
	202	char *till;
	203	SV *sv;
	204	char *ganch;
	205	} regmatch_info;
	206
5d9a96ca DM	207
	208	/* structures for holding and saving the state maintained by regmatch() */
	209
6bda09f9 YO	210	#define MAX_RECURSE_EVAL_NOCHANGE_DEPTH 50
6bda09f9 YO	211
5d9a96ca DM	212	typedef I32 CHECKPOINT;
5d9a96ca DM	213
a0374537	214	typedef struct regmatch_state {
40a82448	215	int resume_state; /* where to jump to on return */
24d3c4a9	216	char locinput; / where to backtrack in string on failure */
e822a8b4 DM	217
e822a8b4 DM	218	union {
77cb431f DM	219
	220	/* this is a fake union member that matches the first element
	221	* of each member that needs to store positive backtrack
	222	* information */
	223	struct {
	224	struct regmatch_state *prev_yes_state;
	225	} yes;
	226
e822a8b4 DM	227	struct {
e822a8b4 DM	228	reg_trie_accepted *accept_buff;
166ba7cd	229	U32 accepted; /* how many accepting states we have seen */
786e8c11	230	U16 jump; / negative offsets from B */
166ba7cd DM	231	regnode B; / node following the trie */
166ba7cd DM	232	regnode me; / only needed for debugging */
e822a8b4 DM	233	} trie;
	234
	235	struct {
77cb431f DM	236	/* this first element must match u.yes */
77cb431f DM	237	struct regmatch_state *prev_yes_state;
faec1544 DM	238	struct regmatch_state *prev_eval;
faec1544 DM	239	struct regmatch_state *prev_curlyx;
aa283a38	240	regexp *prev_rex;
faec1544 DM	241	U32 toggle_reg_flags; /* what bits in PL_reg_flags to
	242	flip when transitioning between
	243	inner and outer rexen */
aa283a38 DM	244	CHECKPOINT cp; /* remember current savestack indexes */
aa283a38 DM	245	CHECKPOINT lastcp;
40a82448	246	regnode B; / the node following us */
6bda09f9	247	U32 close_paren; /* which close bracket is our end */
e822a8b4 DM	248	} eval;
	249
	250	struct {
c476f425	251	/* this first element must match u.yes */
262b90c4	252	struct regmatch_state *prev_yes_state;
c476f425 DM	253	struct regmatch_state prev_curlyx; / previous cur_curlyx */
	254	CHECKPOINT cp; /* remember current savestack index */
	255	bool minmod;
a0374537	256	int parenfloor;/* how far back to strip paren data */
c476f425 DM	257	int min; /* the minimal number of A's to match */
	258	int max; /* the maximal number of A's to match */
	259	regnode A, B; /* the nodes corresponding to /AB/ /
	260
	261	/* these two are modified by WHILEM */
	262	int count; /* how many instances of A we've matched */
	263	char lastloc;/ where previous A matched (0-len detect) */
e822a8b4 DM	264	} curlyx;
	265
	266	struct {
c476f425	267	/* this first element must match u.yes */
262b90c4	268	struct regmatch_state *prev_yes_state;
c476f425 DM	269	struct regmatch_state *save_curlyx;
	270	CHECKPOINT cp; /* remember current savestack indexes */
	271	CHECKPOINT lastcp;
	272	char save_lastloc; / previous curlyx.lastloc */
	273	I32 cache_offset;
	274	I32 cache_mask;
e822a8b4 DM	275	} whilem;
	276
	277	struct {
40a82448 DM	278	I32 lastparen;
	279	regnode next_branch; / next branch node */
	280	CHECKPOINT cp;
	281	} branch;
	282
	283	struct {
dad79028 DM	284	/* this first element must match u.yes */
dad79028 DM	285	struct regmatch_state *prev_yes_state;
e822a8b4	286	I32 c1, c2; /* case fold search */
40a82448 DM	287	CHECKPOINT cp;
	288	I32 alen; /* length of first-matched A string */
	289	I32 count;
0cadcf80	290	bool minmod;
40a82448 DM	291	regnode A, B; /* the nodes corresponding to /AB/ /
40a82448 DM	292	regnode me; / the curlym node */
e822a8b4 DM	293	} curlym;
	294
	295	struct {
	296	I32 paren;
c255a977	297	CHECKPOINT cp;
e822a8b4	298	I32 c1, c2; /* case fold search */
c255a977 DM	299	char maxpos; / highest possible point in string to match */
c255a977 DM	300	char oldloc; / the previous locinput */
e822a8b4	301	int count;
c255a977 DM	302	int min, max; /* {m,n} */
	303	regnode A, B; /* the nodes corresponding to /AB/ /
	304	} curly; /* and CURLYN/PLUS/STAR */
dad79028 DM	305
	306	struct {
	307	/* this first element must match u.yes */
	308	struct regmatch_state *prev_yes_state;
	309	I32 wanted;
24d3c4a9	310	I32 logical; /* saved copy of 'logical' var */
40a82448	311	regnode me; / the IFMATCH/SUSPEND/UNLESSM node */
dad79028	312	} ifmatch; /* and SUSPEND/UNLESSM */
d8319b27	313	} u;
5d9a96ca DM	314	} regmatch_state;
	315
	316	/* how many regmatch_state structs to allocate as a single slab.
	317	* We do it in 4K blocks for efficiency. The "3" is 2 for the next/prev
	318	* pointers, plus 1 for any mythical malloc overhead. */
	319
	320	#define PERL_REGMATCH_SLAB_SLOTS \
	321	((4096 - 3 * sizeof (void*)) / sizeof(regmatch_state))
	322
	323	typedef struct regmatch_slab {
	324	regmatch_state states[PERL_REGMATCH_SLAB_SLOTS];
	325	struct regmatch_slab prev, next;
	326	} regmatch_slab;
1ade1aa1	327
46ab3289 NC	328	#define PL_reg_flags PL_reg_state.re_state_reg_flags
	329	#define PL_bostr PL_reg_state.re_state_bostr
	330	#define PL_reginput PL_reg_state.re_state_reginput
46ab3289 NC	331	#define PL_regeol PL_reg_state.re_state_regeol
	332	#define PL_regstartp PL_reg_state.re_state_regstartp
	333	#define PL_regendp PL_reg_state.re_state_regendp
	334	#define PL_reglastparen PL_reg_state.re_state_reglastparen
	335	#define PL_reglastcloseparen PL_reg_state.re_state_reglastcloseparen
46ab3289 NC	336	#define PL_reg_start_tmp PL_reg_state.re_state_reg_start_tmp
	337	#define PL_reg_start_tmpl PL_reg_state.re_state_reg_start_tmpl
	338	#define PL_reg_eval_set PL_reg_state.re_state_reg_eval_set
46ab3289 NC	339	#define PL_reg_match_utf8 PL_reg_state.re_state_reg_match_utf8
	340	#define PL_reg_magic PL_reg_state.re_state_reg_magic
	341	#define PL_reg_oldpos PL_reg_state.re_state_reg_oldpos
	342	#define PL_reg_oldcurpm PL_reg_state.re_state_reg_oldcurpm
	343	#define PL_reg_curpm PL_reg_state.re_state_reg_curpm
	344	#define PL_reg_oldsaved PL_reg_state.re_state_reg_oldsaved
	345	#define PL_reg_oldsavedlen PL_reg_state.re_state_reg_oldsavedlen
	346	#define PL_reg_maxiter PL_reg_state.re_state_reg_maxiter
	347	#define PL_reg_leftiter PL_reg_state.re_state_reg_leftiter
	348	#define PL_reg_poscache PL_reg_state.re_state_reg_poscache
	349	#define PL_reg_poscache_size PL_reg_state.re_state_reg_poscache_size
	350	#define PL_regsize PL_reg_state.re_state_regsize
	351	#define PL_reg_starttry PL_reg_state.re_state_reg_starttry
	352	#define PL_nrs PL_reg_state.re_state_nrs
	353
1ade1aa1 NC	354	struct re_save_state {
	355	U32 re_state_reg_flags; /* from regexec.c */
	356	char *re_state_bostr;
	357	char re_state_reginput; / String-input pointer. */
1ade1aa1 NC	358	char re_state_regeol; / End of input, for $ check. */
	359	I32 re_state_regstartp; / Pointer to startp array. */
	360	I32 re_state_regendp; / Ditto for endp. */
	361	U32 re_state_reglastparen; / Similarly for lastparen. */
	362	U32 re_state_reglastcloseparen; / Similarly for lastcloseparen. */
1ade1aa1 NC	363	char *re_state_reg_start_tmp; / from regexec.c */
	364	U32 re_state_reg_start_tmpl; /* from regexec.c */
	365	I32 re_state_reg_eval_set; /* from regexec.c */
1ade1aa1 NC	366	bool re_state_reg_match_utf8; /* from regexec.c */
	367	MAGIC re_state_reg_magic; / from regexec.c */
	368	I32 re_state_reg_oldpos; /* from regexec.c */
	369	PMOP re_state_reg_oldcurpm; / from regexec.c */
	370	PMOP re_state_reg_curpm; / from regexec.c */
	371	char re_state_reg_oldsaved; / old saved substr during match */
	372	STRLEN re_state_reg_oldsavedlen; /* old length of saved substr during match */
	373	I32 re_state_reg_maxiter; /* max wait until caching pos */
	374	I32 re_state_reg_leftiter; /* wait until caching pos */
	375	char re_state_reg_poscache; / cache of pos of WHILEM */
	376	STRLEN re_state_reg_poscache_size; /* size of pos cache of WHILEM */
	377	I32 re_state_regsize; /* from regexec.c */
	378	char re_state_reg_starttry; / from regexec.c */
	379	#ifdef PERL_OLD_COPY_ON_WRITE
46ab3289	380	SV re_state_nrs; / was placeholder: unused since 5.8.0 (5.7.2 patch #12027 for bug ID 20010815.012). Used to save rx->saved_copy */
1ade1aa1 NC	381	#endif
	382	};
	383
	384	#define SAVESTACK_ALLOC_FOR_RE_SAVE_STATE \
	385	(1 + ((sizeof(struct re_save_state) - 1) / sizeof(*PL_savestack)))
	386	/*
	387	* Local variables:
	388	* c-indentation-style: bsd
	389	* c-basic-offset: 4
	390	* indent-tabs-mode: t
	391	* End:
	392	*
	393	* ex: set ts=8 sts=4 sw=4 noet:
	394	*/