[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;

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? */
	regnode program[1];	/* Unwarranted chumminess with compiler. */
} regexp;

#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 */

/* 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(aTHX_ 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() */

typedef I32 CHECKPOINT;

typedef enum {
    resume_TRIE1,
    resume_TRIE2,
    resume_EVAL,
    resume_CURLYX,
    resume_WHILEM1,
    resume_WHILEM2,
    resume_WHILEM3,
    resume_WHILEM4,
    resume_WHILEM5,
    resume_WHILEM6,
    resume_CURLYM1,
    resume_CURLYM2,
    resume_CURLYM3,
    resume_IFMATCH,
    resume_PLUS1,
    resume_PLUS2,
    resume_PLUS3,
    resume_PLUS4
} regmatch_resume_states;


typedef struct regmatch_state {

    /* these vars contain state that needs to be maintained
     * across the main while loop ... */

    regmatch_resume_states resume_state; /* where to jump to on return */
    regnode *scan;		/* Current node. */
    regnode *next;		/* Next node. */
    bool minmod;		/* the next "{n,m}" is a "{n,m}?" */
    bool sw;			/* the condition value in (?(cond)a|b) */
    int logical;
    I32 unwind;			/* savestack index of current unwind block */
    struct regmatch_state  *cc;	/* current innermost curly state */
    char *locinput;

    /* ... while the rest of these are local to an individual branch */

    I32 n;			/* no or next */
    I32 ln;			/* len or last */

    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 */
	} trie;

	struct {
	    /* this first element must match u.yes */
	    struct regmatch_state *prev_yes_state;
	    regexp	*prev_rex;
	    int		toggleutf;
	    CHECKPOINT	cp;	/* remember current savestack indexes */
	    CHECKPOINT	lastcp;
	} eval;

	struct {
	    CHECKPOINT cp;	/* remember current savestack indexes */
	    struct regmatch_state *outercc; /* outer CURLYX state if any */

	    /* these contain the current curly state, and are accessed
	     * by subsequent WHILEMs */
	    int		parenfloor;/* how far back to strip paren data */
	    int		cur;	/* how many instances of scan we've matched */
	    int		min;	/* the minimal number of scans to match */
	    int		max;	/* the maximal number of scans to match */
	    regnode *	scan;	/* the thing to match */
	    char *	lastloc;/* where we started matching this scan */
	} curlyx;

	struct {
	    CHECKPOINT cp;	/* remember current savestack indexes */
	    CHECKPOINT lastcp;
	    struct regmatch_state *savecc;
	    char *lastloc;	/* Detection of 0-len. */
	    I32 cache_offset;
	    I32 cache_bit;
	} whilem;

	struct {
	    /* this first element must match u.yes */
	    struct regmatch_state *prev_yes_state;
	    I32 paren;
	    I32 c1, c2;		/* case fold search */
	    CHECKPOINT lastcp;
	    I32 l;
	    I32 matches;
	    I32 maxwanted;
	    bool minmod;
	} curlym;

	struct {
	    I32 paren;
	    CHECKPOINT lastcp;
	    I32 c1, c2;		/* case fold search */
	    char *e;
	    char *old;
	    int count;
	} plus; /* and CURLYN/CURLY/STAR */

	struct {
	    /* this first element must match u.yes */
	    struct regmatch_state *prev_yes_state;
	    I32 wanted;
	} 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_regindent		PL_reg_state.re_state_regindent
#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 */
    int re_state_regindent;		/* 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
378cc40b	33	typedef struct regexp {
cf93c79d IZ	34	I32 *startp;
cf93c79d IZ	35	I32 *endp;
c277df42	36	regnode *regstclass;
2779dcf1	37	struct reg_substr_data *substrs;
cf93c79d	38	char precomp; / pre-compilation regular expression */
c277df42	39	struct reg_data data; / Additional data. */
cf93c79d IZ	40	char subbeg; / saved or original string
cf93c79d IZ	41	so \digit works forever. */
f8c7b90f	42	#ifdef PERL_OLD_COPY_ON_WRITE
ed252734 NC	43	SV saved_copy; / If non-NULL, SV which is COW from original */
ed252734 NC	44	#endif
fac92740	45	U32 offsets; / offset annotations 20001228 MJD */
cf93c79d IZ	46	I32 sublen; /* Length of string pointed by subbeg */
	47	I32 refcnt;
	48	I32 minlen; /* mininum possible length of $& */
	49	I32 prelen; /* length of precomp */
	50	U32 nparens; /* number of parentheses */
	51	U32 lastparen; /* last paren matched */
a01268b5	52	U32 lastcloseparen; /* last paren matched */
cf93c79d IZ	53	U32 reganch; /* Internal use only +
cf93c79d IZ	54	Tainted information used by regexec? */
c277df42	55	regnode program[1]; /* Unwarranted chumminess with compiler. */
378cc40b LW	56	} regexp;
378cc40b LW	57
cad2e5aa JH	58	#define ROPT_ANCH (ROPT_ANCH_BOL\|ROPT_ANCH_MBOL\|ROPT_ANCH_GPOS\|ROPT_ANCH_SBOL)
cad2e5aa JH	59	#define ROPT_ANCH_SINGLE (ROPT_ANCH_SBOL\|ROPT_ANCH_GPOS)
f2278c82 YO	60	#define ROPT_ANCH_BOL 0x00000001
	61	#define ROPT_ANCH_MBOL 0x00000002
	62	#define ROPT_ANCH_SBOL 0x00000004
	63	#define ROPT_ANCH_GPOS 0x00000008
	64	#define ROPT_SKIP 0x00000010
	65	#define ROPT_IMPLICIT 0x00000020 /* Converted .* to ^.* */
	66	#define ROPT_NOSCAN 0x00000040 /* Check-string always at start. */
	67	#define ROPT_GPOS_SEEN 0x00000080
	68	#define ROPT_CHECK_ALL 0x00000100
	69	#define ROPT_LOOKBEHIND_SEEN 0x00000200
	70	#define ROPT_EVAL_SEEN 0x00000400
	71	#define ROPT_CANY_SEEN 0x00000800
cce850e4	72	#define ROPT_SANY_SEEN ROPT_CANY_SEEN /* src bckwrd cmpt */
a0ed51b3	73
8782bef2	74	/* 0xf800 of reganch is used by PMf_COMPILETIME */
c277df42	75
f2278c82 YO	76	#define ROPT_UTF8 0x00010000
	77	#define ROPT_NAUGHTY 0x00020000 /* how exponential is this pattern? */
	78	#define ROPT_COPY_DONE 0x00040000 /* subbeg is a copy of the string */
	79	#define ROPT_TAINTED_SEEN 0x00080000
a30b2f1f	80	#define ROPT_MATCH_UTF8 0x10000000 /* subbeg is utf-8 */
a0ed51b3	81
f2278c82 YO	82	#define RE_USE_INTUIT_NOML 0x00100000 /* Best to intuit before matching */
	83	#define RE_USE_INTUIT_ML 0x00200000
	84	#define REINT_AUTORITATIVE_NOML 0x00400000 /* Can trust a positive answer */
be8e71aa	85	#define REINT_AUTORITATIVE_ML 0x00800000
f2278c82 YO	86	#define REINT_ONCE_NOML 0x01000000 /* Intuit can succed once only. */
	87	#define REINT_ONCE_ML 0x02000000
	88	#define RE_INTUIT_ONECHAR 0x04000000
	89	#define RE_INTUIT_TAIL 0x08000000
	90
cad2e5aa JH	91
	92	#define RE_USE_INTUIT (RE_USE_INTUIT_NOML\|RE_USE_INTUIT_ML)
	93	#define REINT_AUTORITATIVE (REINT_AUTORITATIVE_NOML\|REINT_AUTORITATIVE_ML)
	94	#define REINT_ONCE (REINT_ONCE_NOML\|REINT_ONCE_ML)
	95
c277df42	96	#define RX_MATCH_TAINTED(prog) ((prog)->reganch & ROPT_TAINTED_SEEN)
72311751 GS	97	#define RX_MATCH_TAINTED_on(prog) ((prog)->reganch \|= ROPT_TAINTED_SEEN)
	98	#define RX_MATCH_TAINTED_off(prog) ((prog)->reganch &= ~ROPT_TAINTED_SEEN)
	99	#define RX_MATCH_TAINTED_set(prog, t) ((t) \
	100	? RX_MATCH_TAINTED_on(prog) \
	101	: RX_MATCH_TAINTED_off(prog))
c277df42	102
cf93c79d IZ	103	#define RX_MATCH_COPIED(prog) ((prog)->reganch & ROPT_COPY_DONE)
	104	#define RX_MATCH_COPIED_on(prog) ((prog)->reganch \|= ROPT_COPY_DONE)
	105	#define RX_MATCH_COPIED_off(prog) ((prog)->reganch &= ~ROPT_COPY_DONE)
	106	#define RX_MATCH_COPIED_set(prog,t) ((t) \
	107	? RX_MATCH_COPIED_on(prog) \
	108	: RX_MATCH_COPIED_off(prog))
be8e71aa YO	109	#endif /* PLUGGABLE_RE_EXTENSION */
	110
	111	/* Stuff that needs to be included in the plugable extension goes below here */
	112
	113	#define RE_DEBUG_BIT 0x20000000
	114	#define RX_DEBUG(prog) ((prog)->reganch & RE_DEBUG_BIT)
	115	#define RX_DEBUG_on(prog) ((prog)->reganch \|= RE_DEBUG_BIT)
cf93c79d	116
f8c7b90f	117	#ifdef PERL_OLD_COPY_ON_WRITE
ed252734 NC	118	#define RX_MATCH_COPY_FREE(rx) \
	119	STMT_START {if (rx->saved_copy) { \
	120	SV_CHECK_THINKFIRST_COW_DROP(rx->saved_copy); \
	121	} \
	122	if (RX_MATCH_COPIED(rx)) { \
	123	Safefree(rx->subbeg); \
	124	RX_MATCH_COPIED_off(rx); \
	125	}} STMT_END
	126	#else
	127	#define RX_MATCH_COPY_FREE(rx) \
	128	STMT_START {if (RX_MATCH_COPIED(rx)) { \
	129	Safefree(rx->subbeg); \
	130	RX_MATCH_COPIED_off(rx); \
	131	}} STMT_END
	132	#endif
	133
a30b2f1f RGS	134	#define RX_MATCH_UTF8(prog) ((prog)->reganch & ROPT_MATCH_UTF8)
	135	#define RX_MATCH_UTF8_on(prog) ((prog)->reganch \|= ROPT_MATCH_UTF8)
	136	#define RX_MATCH_UTF8_off(prog) ((prog)->reganch &= ~ROPT_MATCH_UTF8)
	137	#define RX_MATCH_UTF8_set(prog, t) ((t) \
	138	? (RX_MATCH_UTF8_on(prog), (PL_reg_match_utf8 = 1)) \
	139	: (RX_MATCH_UTF8_off(prog), (PL_reg_match_utf8 = 0)))
	140
cad2e5aa JH	141	#define REXEC_COPY_STR 0x01 /* Need to copy the string. */
	142	#define REXEC_CHECKED 0x02 /* check_substr already checked. */
	143	#define REXEC_SCREAM 0x04 /* use scream table. */
	144	#define REXEC_IGNOREPOS 0x08 /* \G matches at start. */
cf93c79d	145	#define REXEC_NOT_FIRST 0x10 /* This is another iteration of //g. */
c277df42	146
155aba94	147	#define ReREFCNT_inc(re) ((void)(re && re->refcnt++), re)
cad2e5aa	148	#define ReREFCNT_dec(re) CALLREGFREE(aTHX_ re)
cf93c79d IZ	149
cf93c79d IZ	150	#define FBMcf_TAIL_DOLLAR 1
cad2e5aa JH	151	#define FBMcf_TAIL_DOLLARM 2
	152	#define FBMcf_TAIL_Z 4
	153	#define FBMcf_TAIL_z 8
	154	#define FBMcf_TAIL (FBMcf_TAIL_DOLLAR\|FBMcf_TAIL_DOLLARM\|FBMcf_TAIL_Z\|FBMcf_TAIL_z)
cf93c79d IZ	155
cf93c79d IZ	156	#define FBMrf_MULTILINE 1
cad2e5aa JH	157
cad2e5aa JH	158	struct re_scream_pos_data_s;
5d9a96ca DM	159
	160	/* an accepting state/position*/
	161	struct _reg_trie_accepted {
	162	U8 *endpos;
	163	U16 wordnum;
	164	};
	165	typedef struct _reg_trie_accepted reg_trie_accepted;
	166
3b0527fe DM	167	/* some basic information about the current match that is created by
	168	* Perl_regexec_flags and then passed to regtry(), regmatch() etc */
	169
	170	typedef struct {
	171	regexp *prog;
	172	char *bol;
	173	char *till;
	174	SV *sv;
	175	char *ganch;
	176	} regmatch_info;
	177
5d9a96ca DM	178
	179	/* structures for holding and saving the state maintained by regmatch() */
	180
	181	typedef I32 CHECKPOINT;
	182
5d9a96ca DM	183	typedef enum {
	184	resume_TRIE1,
	185	resume_TRIE2,
aa283a38	186	resume_EVAL,
5d9a96ca DM	187	resume_CURLYX,
	188	resume_WHILEM1,
	189	resume_WHILEM2,
	190	resume_WHILEM3,
	191	resume_WHILEM4,
	192	resume_WHILEM5,
	193	resume_WHILEM6,
	194	resume_CURLYM1,
	195	resume_CURLYM2,
	196	resume_CURLYM3,
5d9a96ca DM	197	resume_IFMATCH,
	198	resume_PLUS1,
	199	resume_PLUS2,
	200	resume_PLUS3,
aa283a38	201	resume_PLUS4
5d9a96ca DM	202	} regmatch_resume_states;
	203
	204
a0374537	205	typedef struct regmatch_state {
5d9a96ca DM	206
	207	/* these vars contain state that needs to be maintained
	208	* across the main while loop ... */
	209
	210	regmatch_resume_states resume_state; /* where to jump to on return */
	211	regnode scan; / Current node. */
	212	regnode next; / Next node. */
aa283a38	213	bool minmod; /* the next "{n,m}" is a "{n,m}?" */
5d9a96ca DM	214	bool sw; /* the condition value in (?(cond)a\|b) */
	215	int logical;
	216	I32 unwind; /* savestack index of current unwind block */
a0374537	217	struct regmatch_state cc; / current innermost curly state */
5d9a96ca DM	218	char *locinput;
5d9a96ca DM	219
e822a8b4	220	/* ... while the rest of these are local to an individual branch */
5d9a96ca DM	221
	222	I32 n; /* no or next */
	223	I32 ln; /* len or last */
e822a8b4 DM	224
e822a8b4 DM	225	union {
77cb431f DM	226
	227	/* this is a fake union member that matches the first element
	228	* of each member that needs to store positive backtrack
	229	* information */
	230	struct {
	231	struct regmatch_state *prev_yes_state;
	232	} yes;
	233
e822a8b4 DM	234	struct {
	235	reg_trie_accepted *accept_buff;
	236	U32 accepted; /* how many accepting states we have seen */
	237	} trie;
	238
	239	struct {
77cb431f DM	240	/* this first element must match u.yes */
77cb431f DM	241	struct regmatch_state *prev_yes_state;
aa283a38 DM	242	regexp *prev_rex;
	243	int toggleutf;
	244	CHECKPOINT cp; /* remember current savestack indexes */
	245	CHECKPOINT lastcp;
e822a8b4 DM	246	} eval;
	247
	248	struct {
	249	CHECKPOINT cp; /* remember current savestack indexes */
a0374537 DM	250	struct regmatch_state outercc; / outer CURLYX state if any */
	251
	252	/* these contain the current curly state, and are accessed
	253	* by subsequent WHILEMs */
	254	int parenfloor;/* how far back to strip paren data */
	255	int cur; /* how many instances of scan we've matched */
	256	int min; /* the minimal number of scans to match */
	257	int max; /* the maximal number of scans to match */
	258	regnode * scan; /* the thing to match */
	259	char * lastloc;/* where we started matching this scan */
e822a8b4 DM	260	} curlyx;
	261
	262	struct {
	263	CHECKPOINT cp; /* remember current savestack indexes */
	264	CHECKPOINT lastcp;
a0374537	265	struct regmatch_state *savecc;
e822a8b4 DM	266	char lastloc; / Detection of 0-len. */
	267	I32 cache_offset;
	268	I32 cache_bit;
	269	} whilem;
	270
	271	struct {
dad79028 DM	272	/* this first element must match u.yes */
dad79028 DM	273	struct regmatch_state *prev_yes_state;
e822a8b4 DM	274	I32 paren;
	275	I32 c1, c2; /* case fold search */
	276	CHECKPOINT lastcp;
	277	I32 l;
	278	I32 matches;
	279	I32 maxwanted;
0cadcf80	280	bool minmod;
e822a8b4 DM	281	} curlym;
	282
	283	struct {
	284	I32 paren;
	285	CHECKPOINT lastcp;
	286	I32 c1, c2; /* case fold search */
	287	char *e;
	288	char *old;
	289	int count;
	290	} plus; /* and CURLYN/CURLY/STAR */
dad79028 DM	291
	292	struct {
	293	/* this first element must match u.yes */
	294	struct regmatch_state *prev_yes_state;
	295	I32 wanted;
	296	} ifmatch; /* and SUSPEND/UNLESSM */
d8319b27	297	} u;
5d9a96ca DM	298	} regmatch_state;
	299
	300	/* how many regmatch_state structs to allocate as a single slab.
	301	* We do it in 4K blocks for efficiency. The "3" is 2 for the next/prev
	302	* pointers, plus 1 for any mythical malloc overhead. */
	303
	304	#define PERL_REGMATCH_SLAB_SLOTS \
	305	((4096 - 3 * sizeof (void*)) / sizeof(regmatch_state))
	306
	307	typedef struct regmatch_slab {
	308	regmatch_state states[PERL_REGMATCH_SLAB_SLOTS];
	309	struct regmatch_slab prev, next;
	310	} regmatch_slab;
1ade1aa1	311
46ab3289 NC	312	#define PL_reg_flags PL_reg_state.re_state_reg_flags
	313	#define PL_bostr PL_reg_state.re_state_bostr
	314	#define PL_reginput PL_reg_state.re_state_reginput
46ab3289 NC	315	#define PL_regeol PL_reg_state.re_state_regeol
	316	#define PL_regstartp PL_reg_state.re_state_regstartp
	317	#define PL_regendp PL_reg_state.re_state_regendp
	318	#define PL_reglastparen PL_reg_state.re_state_reglastparen
	319	#define PL_reglastcloseparen PL_reg_state.re_state_reglastcloseparen
46ab3289 NC	320	#define PL_reg_start_tmp PL_reg_state.re_state_reg_start_tmp
	321	#define PL_reg_start_tmpl PL_reg_state.re_state_reg_start_tmpl
	322	#define PL_reg_eval_set PL_reg_state.re_state_reg_eval_set
46ab3289	323	#define PL_regindent PL_reg_state.re_state_regindent
46ab3289 NC	324	#define PL_reg_match_utf8 PL_reg_state.re_state_reg_match_utf8
	325	#define PL_reg_magic PL_reg_state.re_state_reg_magic
	326	#define PL_reg_oldpos PL_reg_state.re_state_reg_oldpos
	327	#define PL_reg_oldcurpm PL_reg_state.re_state_reg_oldcurpm
	328	#define PL_reg_curpm PL_reg_state.re_state_reg_curpm
	329	#define PL_reg_oldsaved PL_reg_state.re_state_reg_oldsaved
	330	#define PL_reg_oldsavedlen PL_reg_state.re_state_reg_oldsavedlen
	331	#define PL_reg_maxiter PL_reg_state.re_state_reg_maxiter
	332	#define PL_reg_leftiter PL_reg_state.re_state_reg_leftiter
	333	#define PL_reg_poscache PL_reg_state.re_state_reg_poscache
	334	#define PL_reg_poscache_size PL_reg_state.re_state_reg_poscache_size
	335	#define PL_regsize PL_reg_state.re_state_regsize
	336	#define PL_reg_starttry PL_reg_state.re_state_reg_starttry
	337	#define PL_nrs PL_reg_state.re_state_nrs
	338
1ade1aa1 NC	339	struct re_save_state {
	340	U32 re_state_reg_flags; /* from regexec.c */
	341	char *re_state_bostr;
	342	char re_state_reginput; / String-input pointer. */
1ade1aa1 NC	343	char re_state_regeol; / End of input, for $ check. */
	344	I32 re_state_regstartp; / Pointer to startp array. */
	345	I32 re_state_regendp; / Ditto for endp. */
	346	U32 re_state_reglastparen; / Similarly for lastparen. */
	347	U32 re_state_reglastcloseparen; / Similarly for lastcloseparen. */
1ade1aa1 NC	348	char *re_state_reg_start_tmp; / from regexec.c */
	349	U32 re_state_reg_start_tmpl; /* from regexec.c */
	350	I32 re_state_reg_eval_set; /* from regexec.c */
1ade1aa1	351	int re_state_regindent; /* from regexec.c */
1ade1aa1 NC	352	bool re_state_reg_match_utf8; /* from regexec.c */
	353	MAGIC re_state_reg_magic; / from regexec.c */
	354	I32 re_state_reg_oldpos; /* from regexec.c */
	355	PMOP re_state_reg_oldcurpm; / from regexec.c */
	356	PMOP re_state_reg_curpm; / from regexec.c */
	357	char re_state_reg_oldsaved; / old saved substr during match */
	358	STRLEN re_state_reg_oldsavedlen; /* old length of saved substr during match */
	359	I32 re_state_reg_maxiter; /* max wait until caching pos */
	360	I32 re_state_reg_leftiter; /* wait until caching pos */
	361	char re_state_reg_poscache; / cache of pos of WHILEM */
	362	STRLEN re_state_reg_poscache_size; /* size of pos cache of WHILEM */
	363	I32 re_state_regsize; /* from regexec.c */
	364	char re_state_reg_starttry; / from regexec.c */
	365	#ifdef PERL_OLD_COPY_ON_WRITE
46ab3289	366	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	367	#endif
	368	};
	369
	370	#define SAVESTACK_ALLOC_FOR_RE_SAVE_STATE \
	371	(1 + ((sizeof(struct re_save_state) - 1) / sizeof(*PL_savestack)))
	372	/*
	373	* Local variables:
	374	* c-indentation-style: bsd
	375	* c-basic-offset: 4
	376	* indent-tabs-mode: t
	377	* End:
	378	*
	379	* ex: set ts=8 sts=4 sw=4 noet:
	380	*/