This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Also fix wince for caretx after e2051532106.
[perl5.git] / op.h
1 /*    op.h
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4  *    2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
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
11 /*
12  * The fields of BASEOP are:
13  *      op_next         Pointer to next ppcode to execute after this one.
14  *                      (Top level pre-grafted op points to first op,
15  *                      but this is replaced when op is grafted in, when
16  *                      this op will point to the real next op, and the new
17  *                      parent takes over role of remembering starting op.)
18  *      op_ppaddr       Pointer to current ppcode's function.
19  *      op_type         The type of the operation.
20  *      op_opt          Whether or not the op has been optimised by the
21  *                      peephole optimiser.
22  *      op_slabbed      allocated via opslab
23  *      op_static       tell op_free() to skip PerlMemShared_free(), when
24  *                      !op_slabbed.
25  *      op_savefree     on savestack via SAVEFREEOP
26  *      op_folded       Result/remainder of a constant fold operation.
27  *      op_spare        Two spare bits
28  *      op_flags        Flags common to all operations.  See OPf_* below.
29  *      op_private      Flags peculiar to a particular operation (BUT,
30  *                      by default, set to the number of children until
31  *                      the operation is privatized by a check routine,
32  *                      which may or may not check number of children).
33  */
34 #include "op_reg_common.h"
35
36 #define OPCODE U16
37
38 #ifdef PERL_MAD
39 #  define MADPROP_IN_BASEOP     MADPROP*        op_madprop;
40 #else
41 #  define MADPROP_IN_BASEOP
42 #endif
43
44 typedef PERL_BITFIELD16 Optype;
45
46 #ifdef BASEOP_DEFINITION
47 #define BASEOP BASEOP_DEFINITION
48 #else
49 #define BASEOP                          \
50     OP*         op_next;                \
51     OP*         op_sibling;             \
52     OP*         (*op_ppaddr)(pTHX);     \
53     MADPROP_IN_BASEOP                   \
54     PADOFFSET   op_targ;                \
55     PERL_BITFIELD16 op_type:9;          \
56     PERL_BITFIELD16 op_opt:1;           \
57     PERL_BITFIELD16 op_slabbed:1;       \
58     PERL_BITFIELD16 op_savefree:1;      \
59     PERL_BITFIELD16 op_static:1;        \
60     PERL_BITFIELD16 op_folded:1;        \
61     PERL_BITFIELD16 op_spare:2;         \
62     U8          op_flags;               \
63     U8          op_private;
64 #endif
65
66 /* If op_type:9 is changed to :10, also change PUSHEVAL in cop.h.
67    Also, if the type of op_type is ever changed (e.g. to PERL_BITFIELD32)
68    then all the other bit-fields before/after it should change their
69    types too to let VC pack them into the same 4 byte integer.*/
70
71 /* for efficiency, requires OPf_WANT_VOID == G_VOID etc */
72 #define OP_GIMME(op,dfl) \
73         (((op)->op_flags & OPf_WANT) ? ((op)->op_flags & OPf_WANT) : dfl)
74
75 #define OP_GIMME_REVERSE(flags) ((flags) & G_WANT)
76
77 /*
78 =head1 "Gimme" Values
79
80 =for apidoc Amn|U32|GIMME_V
81 The XSUB-writer's equivalent to Perl's C<wantarray>.  Returns C<G_VOID>,
82 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
83 respectively. See L<perlcall> for a usage example.
84
85 =for apidoc Amn|U32|GIMME
86 A backward-compatible version of C<GIMME_V> which can only return
87 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
88 Deprecated.  Use C<GIMME_V> instead.
89
90 =cut
91 */
92
93 #define GIMME_V         OP_GIMME(PL_op, block_gimme())
94
95 /* Public flags */
96
97 #define OPf_WANT        3       /* Mask for "want" bits: */
98 #define  OPf_WANT_VOID   1      /*   Want nothing */
99 #define  OPf_WANT_SCALAR 2      /*   Want single value */
100 #define  OPf_WANT_LIST   3      /*   Want list of any length */
101 #define OPf_KIDS        4       /* There is a firstborn child. */
102 #define OPf_PARENS      8       /* This operator was parenthesized. */
103                                 /*  (Or block needs explicit scope entry.) */
104 #define OPf_REF         16      /* Certified reference. */
105                                 /*  (Return container, not containee). */
106 #define OPf_MOD         32      /* Will modify (lvalue). */
107 #define OPf_STACKED     64      /* Some arg is arriving on the stack. */
108 #define OPf_SPECIAL     128     /* Do something weird for this op: */
109                                 /*  On local LVAL, don't init local value. */
110                                 /*  On OP_SORT, subroutine is inlined. */
111                                 /*  On OP_NOT, inversion was implicit. */
112                                 /*  On OP_LEAVE, don't restore curpm. */
113                                 /*  On truncate, we truncate filehandle */
114                                 /*  On control verbs, we saw no label */
115                                 /*  On flipflop, we saw ... instead of .. */
116                                 /*  On UNOPs, saw bare parens, e.g. eof(). */
117                                 /*  On OP_ENTERSUB || OP_NULL, saw a "do". */
118                                 /*  On OP_EXISTS, treat av as av, not avhv.  */
119                                 /*  On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
120                                 /*  On pushre, rx is used as part of split, e.g. split " " */
121                                 /*  On regcomp, "use re 'eval'" was in scope */
122                                 /*  On OP_READLINE, was <$filehandle> */
123                                 /*  On RV2[ACGHS]V, don't create GV--in
124                                     defined()*/
125                                 /*  On OP_DBSTATE, indicates breakpoint
126                                  *    (runtime property) */
127                                 /*  On OP_REQUIRE, was seen as CORE::require */
128                                 /*  On OP_(ENTER|LEAVE)WHEN, there's
129                                     no condition */
130                                 /*  On OP_SMARTMATCH, an implicit smartmatch */
131                                 /*  On OP_ANONHASH and OP_ANONLIST, create a
132                                     reference to the new anon hash or array */
133                                 /*  On OP_HELEM and OP_HSLICE, localization will be followed
134                                     by assignment, so do not wipe the target if it is special
135                                     (e.g. a glob or a magic SV) */
136                                 /*  On OP_MATCH, OP_SUBST & OP_TRANS, the
137                                     operand of a logical or conditional
138                                     that was optimised away, so it should
139                                     not be bound via =~ */
140                                 /*  On OP_CONST, from a constant CV */
141                                 /*  On OP_GLOB, two meanings:
142                                     - Before ck_glob, called as CORE::glob
143                                     - After ck_glob, use Perl glob function
144                                  */
145                                 /*  On OP_PADRANGE, push @_ */
146                                 /*  On OP_DUMP, has no label */
147
148 /* old names; don't use in new code, but don't break them, either */
149 #define OPf_LIST        OPf_WANT_LIST
150 #define OPf_KNOW        OPf_WANT
151
152 #define GIMME \
153           (PL_op->op_flags & OPf_WANT                                   \
154            ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST             \
155               ? G_ARRAY                                                 \
156               : G_SCALAR)                                               \
157            : dowantarray())
158
159 /* Lower bits of op_private often carry the number of arguments, as
160  * set by newBINOP, newUNOP and ck_fun */
161
162 /* NOTE: OP_NEXTSTATE and OP_DBSTATE (i.e. COPs) carry NATIVE_HINTS
163  * in op_private */
164
165 /* Private for lvalues */
166 #define OPpLVAL_INTRO   128     /* Lvalue must be localized or lvalue sub */
167
168 /* Private for OPs with TARGLEX */
169   /* (lower bits may carry MAXARG) */
170 #define OPpTARGET_MY            16      /* Target is PADMY. */
171
172 /* Private for OP_LEAVE, OP_LEAVESUB, OP_LEAVESUBLV and OP_LEAVEWRITE */
173 #define OPpREFCOUNTED           64      /* op_targ carries a refcount */
174
175 /* Private for OP_LEAVE and OP_LEAVELOOP */
176 #define OPpLVALUE               128     /* Do not copy return value */
177
178 /* Private for OP_AASSIGN */
179 #define OPpASSIGN_COMMON        64      /* Left & right have syms in common. */
180
181 /* Private for OP_SASSIGN */
182 #define OPpASSIGN_BACKWARDS     64      /* Left & right switched. */
183 #define OPpASSIGN_CV_TO_GV      128     /* Possible optimisation for constants. */
184
185 /* Private for OP_MATCH and OP_SUBST{,CONT} */
186 #define OPpRUNTIME              64      /* Pattern coming in on the stack */
187
188 /* Private for OP_TRANS */
189 #define OPpTRANS_FROM_UTF       1
190 #define OPpTRANS_TO_UTF         2
191 #define OPpTRANS_IDENTICAL      4       /* right side is same as left */
192 #define OPpTRANS_SQUASH         8
193     /* 16 is used for OPpTARGET_MY */
194 #define OPpTRANS_COMPLEMENT     32
195 #define OPpTRANS_GROWS          64
196 #define OPpTRANS_DELETE         128
197 #define OPpTRANS_ALL    (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF|OPpTRANS_IDENTICAL|OPpTRANS_SQUASH|OPpTRANS_COMPLEMENT|OPpTRANS_GROWS|OPpTRANS_DELETE)
198
199 /* Private for OP_REPEAT */
200 #define OPpREPEAT_DOLIST        64      /* List replication. */
201
202 /* Private for OP_RV2GV, OP_RV2SV, OP_AELEM, OP_HELEM, OP_PADSV */
203 #define OPpDEREF                (32|64) /* autovivify: Want ref to something: */
204 #define OPpDEREF_AV             32      /*   Want ref to AV. */
205 #define OPpDEREF_HV             64      /*   Want ref to HV. */
206 #define OPpDEREF_SV             (32|64) /*   Want ref to SV. */
207
208 /* OP_ENTERSUB and OP_RV2CV flags
209
210 Flags are set on entersub and rv2cv in three phases:
211   parser  - the parser passes the flag to the op constructor
212   check   - the check routine called by the op constructor sets the flag
213   context - application of scalar/ref/lvalue context applies the flag
214
215 In the third stage, an entersub op might turn into an rv2cv op (undef &foo,
216 \&foo, lock &foo, exists &foo, defined &foo).  The two places where that
217 happens (op_lvalue_flags and doref in op.c) need to make sure the flags do
218 not conflict.  Flags applied in the context phase are only set when there
219 is no conversion of op type.
220
221   bit  entersub flag       phase   rv2cv flag             phase
222   ---  -------------       -----   ----------             -----
223     1  OPpENTERSUB_INARGS  context OPpMAY_RETURN_CONSTANT context
224     2  HINT_STRICT_REFS    check   HINT_STRICT_REFS       check
225     4  OPpENTERSUB_HASTARG check
226     8                              OPpENTERSUB_AMPER      parser
227    16  OPpENTERSUB_DB      check
228    32  OPpDEREF_AV         context
229    64  OPpDEREF_HV         context
230   128  OPpLVAL_INTRO       context OPpENTERSUB_NOPAREN    parser
231
232 */
233
234   /* OP_ENTERSUB only */
235 #define OPpENTERSUB_DB          16      /* Debug subroutine. */
236 #define OPpENTERSUB_HASTARG     4       /* Called from OP tree. */
237 #define OPpENTERSUB_INARGS      1       /* Lval used as arg to a sub. */
238 /* used by OPpDEREF             (32|64) */
239 /* used by HINT_STRICT_REFS     2          */
240   /* Mask for OP_ENTERSUB flags, the absence of which must be propagated
241      in dynamic context */
242 #define OPpENTERSUB_LVAL_MASK (OPpLVAL_INTRO|OPpENTERSUB_INARGS)
243
244   /* OP_RV2CV only */
245 #define OPpENTERSUB_AMPER       8       /* Used & form to call. */
246 #define OPpENTERSUB_NOPAREN     128     /* bare sub call (without parens) */
247 #define OPpMAY_RETURN_CONSTANT  1       /* If a constant sub, return the constant */
248
249   /* OP_GV only */
250 #define OPpEARLY_CV             32      /* foo() called before sub foo was parsed */
251   /* OP_?ELEM only */
252 #define OPpLVAL_DEFER           16      /* Defer creation of array/hash elem */
253   /* OP_RV2[AH]V OP_KV[AH]SLICE OP_[AH]SLICE */
254 #define OPpSLICEWARNING         4       /* warn about %hash{$scalar} */
255   /* OP_RV2[SAH]V, OP_GVSV, OP_ENTERITER only */
256 #define OPpOUR_INTRO            16      /* Variable was in an our() */
257   /* OP_RV2[AGH]V, OP_PAD[AH]V, OP_[AH]ELEM, OP_[AH]SLICE OP_AV2ARYLEN,
258      OP_R?KEYS, OP_SUBSTR, OP_POS, OP_VEC */
259 #define OPpMAYBE_LVSUB          8       /* We might be an lvalue to return */
260   /* OP_RV2HV and OP_PADHV */
261 #define OPpTRUEBOOL             32      /* %hash in (%hash || $foo) in
262                                            void context */
263 #define OPpMAYBE_TRUEBOOL       64      /* %hash in (%hash || $foo) where
264                                            cx is not known till run time */
265
266   /* OP_SUBSTR only */
267 #define OPpSUBSTR_REPL_FIRST    16      /* 1st arg is replacement string */
268
269   /* OP_PADSV only */
270 #define OPpPAD_STATE            16      /* is a "state" pad */
271   /* for OP_RV2?V, lower bits carry hints (currently only HINT_STRICT_REFS) */
272
273   /* OP_PADRANGE only */
274   /* bit 7 is OPpLVAL_INTRO */
275 #define OPpPADRANGE_COUNTMASK   127     /* bits 6..0 hold target range, */
276 #define OPpPADRANGE_COUNTSHIFT  7       /* 7 bits in total */
277
278   /* OP_RV2GV only */
279 #define OPpDONT_INIT_GV         4       /* Call gv_fetchpv with GV_NOINIT */
280 /* (Therefore will return whatever is currently in the symbol table, not
281    guaranteed to be a PVGV)  */
282 #define OPpALLOW_FAKE           16      /* OK to return fake glob */
283
284 /* Private for OP_ENTERITER and OP_ITER */
285 #define OPpITER_REVERSED        4       /* for (reverse ...) */
286 #define OPpITER_DEF             8       /* for $_ or for my $_ */
287
288 /* Private for OP_CONST */
289 #define OPpCONST_NOVER          2       /* no 6; */
290 #define OPpCONST_SHORTCIRCUIT   4       /* eg the constant 5 in (5 || foo) */
291 #define OPpCONST_STRICT         8       /* bareword subject to strict 'subs' */
292 #define OPpCONST_ENTERED        16      /* Has been entered as symbol. */
293 #define OPpCONST_BARE           64      /* Was a bare word (filehandle?). */
294
295 /* Private for OP_FLIP/FLOP */
296 #define OPpFLIP_LINENUM         64      /* Range arg potentially a line num. */
297
298 /* Private for OP_LIST */
299 #define OPpLIST_GUESSED         64      /* Guessed that pushmark was needed. */
300
301 /* Private for OP_DELETE */
302 #define OPpSLICE                64      /* Operating on a list of keys */
303 /* Also OPpLVAL_INTRO (128) */
304
305 /* Private for OP_EXISTS */
306 #define OPpEXISTS_SUB           64      /* Checking for &sub, not {} or [].  */
307
308 /* Private for OP_SORT */
309 #define OPpSORT_NUMERIC         1       /* Optimized away { $a <=> $b } */
310 #define OPpSORT_INTEGER         2       /* Ditto while under "use integer" */
311 #define OPpSORT_REVERSE         4       /* Reversed sort */
312 #define OPpSORT_INPLACE         8       /* sort in-place; eg @a = sort @a */
313 #define OPpSORT_DESCEND         16      /* Descending sort */
314 #define OPpSORT_QSORT           32      /* Use quicksort (not mergesort) */
315 #define OPpSORT_STABLE          64      /* Use a stable algorithm */
316
317 /* Private for OP_REVERSE */
318 #define OPpREVERSE_INPLACE      8       /* reverse in-place (@a = reverse @a) */
319
320 /* Private for OP_OPEN and OP_BACKTICK */
321 #define OPpOPEN_IN_RAW          16      /* binmode(F,":raw") on input fh */
322 #define OPpOPEN_IN_CRLF         32      /* binmode(F,":crlf") on input fh */
323 #define OPpOPEN_OUT_RAW         64      /* binmode(F,":raw") on output fh */
324 #define OPpOPEN_OUT_CRLF        128     /* binmode(F,":crlf") on output fh */
325
326 /* Private for OP_EXIT, HUSH also for OP_DIE */
327 #define OPpHUSH_VMSISH          64      /* hush DCL exit msg vmsish mode*/
328 #define OPpEXIT_VMSISH          128     /* exit(0) vs. exit(1) vmsish mode*/
329
330 /* Private for OP_FTXXX */
331 #define OPpFT_ACCESS            2       /* use filetest 'access' */
332 #define OPpFT_STACKED           4       /* stacked filetest, as "-f" in "-f -x $f" */
333 #define OPpFT_STACKING          8       /* stacking filetest, as "-x" in "-f -x $f" */
334 #define OPpFT_AFTER_t           16      /* previous op was -t */
335
336 /* Private for OP_(MAP|GREP)(WHILE|START) */
337 #define OPpGREP_LEX             2       /* iterate over lexical $_ */
338     
339 /* Private for OP_ENTEREVAL */
340 #define OPpEVAL_HAS_HH          2       /* Does it have a copy of %^H */
341 #define OPpEVAL_UNICODE         4
342 #define OPpEVAL_BYTES           8
343 #define OPpEVAL_COPHH           16      /* Construct %^H from cop hints */
344 #define OPpEVAL_RE_REPARSING    32      /* eval_sv(..., G_RE_REPARSING) */
345     
346 /* Private for OP_CALLER, OP_WANTARRAY and OP_RUNCV */
347 #define OPpOFFBYONE             128     /* Treat caller(1) as caller(2) */
348
349 /* Private for OP_COREARGS */
350 /* These must not conflict with OPpDONT_INIT_GV or OPpALLOW_FAKE.
351    See pp.c:S_rv2gv. */
352 #define OPpCOREARGS_DEREF1      1       /* Arg 1 is a handle constructor */
353 #define OPpCOREARGS_DEREF2      2       /* Arg 2 is a handle constructor */
354 #define OPpCOREARGS_SCALARMOD   64      /* \$ rather than \[$@%*] */
355 #define OPpCOREARGS_PUSHMARK    128     /* Call pp_pushmark */
356
357 /* Private for OP_(LAST|REDO|NEXT|GOTO|DUMP) */
358 #define OPpPV_IS_UTF8           128     /* label is in UTF8 */
359
360 /* Private for OP_SPLIT */
361 #define OPpSPLIT_IMPLIM         128     /* implicit limit */
362
363 struct op {
364     BASEOP
365 };
366
367 struct unop {
368     BASEOP
369     OP *        op_first;
370 };
371
372 struct binop {
373     BASEOP
374     OP *        op_first;
375     OP *        op_last;
376 };
377
378 struct logop {
379     BASEOP
380     OP *        op_first;
381     OP *        op_other;
382 };
383
384 struct listop {
385     BASEOP
386     OP *        op_first;
387     OP *        op_last;
388 };
389
390 struct pmop {
391     BASEOP
392     OP *        op_first;
393     OP *        op_last;
394 #ifdef USE_ITHREADS
395     PADOFFSET   op_pmoffset;
396 #else
397     REGEXP *    op_pmregexp;            /* compiled expression */
398 #endif
399     U32         op_pmflags;
400     union {
401         OP *    op_pmreplroot;          /* For OP_SUBST */
402 #ifdef USE_ITHREADS
403         PADOFFSET  op_pmtargetoff;      /* For OP_PUSHRE */
404 #else
405         GV *    op_pmtargetgv;
406 #endif
407     }   op_pmreplrootu;
408     union {
409         OP *    op_pmreplstart; /* Only used in OP_SUBST */
410 #ifdef USE_ITHREADS
411         PADOFFSET op_pmstashoff; /* Only used in OP_MATCH, with PMf_ONCE set */
412 #else
413         HV *    op_pmstash;
414 #endif
415     }           op_pmstashstartu;
416     OP *        op_code_list;   /* list of (?{}) code blocks */
417 };
418
419 #ifdef USE_ITHREADS
420 #define PM_GETRE(o)     (SvTYPE(PL_regex_pad[(o)->op_pmoffset]) == SVt_REGEXP \
421                          ? (REGEXP*)(PL_regex_pad[(o)->op_pmoffset]) : NULL)
422 /* The assignment is just to enforce type safety (or at least get a warning).
423  */
424 /* With first class regexps not via a reference one needs to assign
425    &PL_sv_undef under ithreads. (This would probably work unthreaded, but NULL
426    is cheaper. I guess we could allow NULL, but the check above would get
427    more complex, and we'd have an AV with (SV*)NULL in it, which feels bad */
428 /* BEWARE - something that calls this macro passes (r) which has a side
429    effect.  */
430 #define PM_SETRE(o,r)   STMT_START {                                    \
431                             REGEXP *const _pm_setre = (r);              \
432                             assert(_pm_setre);                          \
433                             PL_regex_pad[(o)->op_pmoffset] = MUTABLE_SV(_pm_setre); \
434                         } STMT_END
435 #else
436 #define PM_GETRE(o)     ((o)->op_pmregexp)
437 #define PM_SETRE(o,r)   ((o)->op_pmregexp = (r))
438 #endif
439
440 /* Leave some space, so future bit allocations can go either in the shared or
441  * unshared area without affecting binary compatibility */
442 #define PMf_BASE_SHIFT (_RXf_PMf_SHIFT_NEXT+6)
443
444 /* 'use re "taint"' in scope: taint $1 etc. if target tainted */
445 #define PMf_RETAINT     (1<<(PMf_BASE_SHIFT+0))
446
447 /* match successfully only once per reset, with related flag RXf_USED in
448  * re->extflags holding state.  This is used only for ?? matches, and only on
449  * OP_MATCH and OP_QR */
450 #define PMf_ONCE        (1<<(PMf_BASE_SHIFT+1))
451
452 /* PMf_ONCE, i.e. ?pat?, has matched successfully.  Not used under threading. */
453 #define PMf_USED        (1<<(PMf_BASE_SHIFT+3))
454
455 /* subst replacement is constant */
456 #define PMf_CONST       (1<<(PMf_BASE_SHIFT+4))
457
458 /* keep 1st runtime pattern forever */
459 #define PMf_KEEP        (1<<(PMf_BASE_SHIFT+5))
460
461 #define PMf_GLOBAL      (1<<(PMf_BASE_SHIFT+6)) /* pattern had a g modifier */
462
463 /* don't reset pos() if //g fails */
464 #define PMf_CONTINUE    (1<<(PMf_BASE_SHIFT+7))
465
466 /* evaluating replacement as expr */
467 #define PMf_EVAL        (1<<(PMf_BASE_SHIFT+8))
468
469 /* Return substituted string instead of modifying it. */
470 #define PMf_NONDESTRUCT (1<<(PMf_BASE_SHIFT+9))
471
472 /* the pattern has a CV attached (currently only under qr/...(?{}).../) */
473 #define PMf_HAS_CV      (1<<(PMf_BASE_SHIFT+10))
474
475 /* op_code_list is private; don't free it etc. It may well point to
476  * code within another sub, with different pad etc */
477 #define PMf_CODELIST_PRIVATE    (1<<(PMf_BASE_SHIFT+11))
478
479 /* the PMOP is a QR (we should be able to detect that from the op type,
480  * but the regex compilation API passes just the pm flags, not the op
481  * itself */
482 #define PMf_IS_QR       (1<<(PMf_BASE_SHIFT+12))
483 #define PMf_USE_RE_EVAL (1<<(PMf_BASE_SHIFT+13)) /* use re'eval' in scope */
484
485 #if PMf_BASE_SHIFT+13 > 31
486 #   error Too many PMf_ bits used.  See above and regnodes.h for any spare in middle
487 #endif
488
489 #ifdef USE_ITHREADS
490
491 #  define PmopSTASH(o)         ((o)->op_pmflags & PMf_ONCE                         \
492                                 ? PL_stashpad[(o)->op_pmstashstartu.op_pmstashoff]   \
493                                 : NULL)
494 #  define PmopSTASH_set(o,hv)   \
495         (assert_((o)->op_pmflags & PMf_ONCE)                            \
496          (o)->op_pmstashstartu.op_pmstashoff =                          \
497             (hv) ? alloccopstash(hv) : 0)
498 #else
499 #  define PmopSTASH(o)                                                  \
500     (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstash : NULL)
501 #  if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
502 #    define PmopSTASH_set(o,hv)         ({                              \
503         assert((o)->op_pmflags & PMf_ONCE);                             \
504         ((o)->op_pmstashstartu.op_pmstash = (hv));                      \
505     })
506 #  else
507 #    define PmopSTASH_set(o,hv) ((o)->op_pmstashstartu.op_pmstash = (hv))
508 #  endif
509 #endif
510 #define PmopSTASHPV(o)  (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL)
511    /* op_pmstashstartu.op_pmstash is not refcounted */
512 #define PmopSTASHPV_set(o,pv)   PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
513
514 struct svop {
515     BASEOP
516     SV *        op_sv;
517 };
518
519 struct padop {
520     BASEOP
521     PADOFFSET   op_padix;
522 };
523
524 struct pvop {
525     BASEOP
526     char *      op_pv;
527 };
528
529 struct loop {
530     BASEOP
531     OP *        op_first;
532     OP *        op_last;
533     OP *        op_redoop;
534     OP *        op_nextop;
535     OP *        op_lastop;
536 };
537
538 #define cUNOPx(o)       ((UNOP*)o)
539 #define cBINOPx(o)      ((BINOP*)o)
540 #define cLISTOPx(o)     ((LISTOP*)o)
541 #define cLOGOPx(o)      ((LOGOP*)o)
542 #define cPMOPx(o)       ((PMOP*)o)
543 #define cSVOPx(o)       ((SVOP*)o)
544 #define cPADOPx(o)      ((PADOP*)o)
545 #define cPVOPx(o)       ((PVOP*)o)
546 #define cCOPx(o)        ((COP*)o)
547 #define cLOOPx(o)       ((LOOP*)o)
548
549 #define cUNOP           cUNOPx(PL_op)
550 #define cBINOP          cBINOPx(PL_op)
551 #define cLISTOP         cLISTOPx(PL_op)
552 #define cLOGOP          cLOGOPx(PL_op)
553 #define cPMOP           cPMOPx(PL_op)
554 #define cSVOP           cSVOPx(PL_op)
555 #define cPADOP          cPADOPx(PL_op)
556 #define cPVOP           cPVOPx(PL_op)
557 #define cCOP            cCOPx(PL_op)
558 #define cLOOP           cLOOPx(PL_op)
559
560 #define cUNOPo          cUNOPx(o)
561 #define cBINOPo         cBINOPx(o)
562 #define cLISTOPo        cLISTOPx(o)
563 #define cLOGOPo         cLOGOPx(o)
564 #define cPMOPo          cPMOPx(o)
565 #define cSVOPo          cSVOPx(o)
566 #define cPADOPo         cPADOPx(o)
567 #define cPVOPo          cPVOPx(o)
568 #define cCOPo           cCOPx(o)
569 #define cLOOPo          cLOOPx(o)
570
571 #define kUNOP           cUNOPx(kid)
572 #define kBINOP          cBINOPx(kid)
573 #define kLISTOP         cLISTOPx(kid)
574 #define kLOGOP          cLOGOPx(kid)
575 #define kPMOP           cPMOPx(kid)
576 #define kSVOP           cSVOPx(kid)
577 #define kPADOP          cPADOPx(kid)
578 #define kPVOP           cPVOPx(kid)
579 #define kCOP            cCOPx(kid)
580 #define kLOOP           cLOOPx(kid)
581
582
583 #ifdef USE_ITHREADS
584 #  define       cGVOPx_gv(o)    ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
585 #  define       IS_PADGV(v)     (v && SvTYPE(v) == SVt_PVGV && isGV_with_GP(v) \
586                                  && GvIN_PAD(v))
587 #  define       IS_PADCONST(v) \
588         (v && (SvREADONLY(v) || (SvIsCOW(v) && !SvLEN(v))))
589 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv \
590                                  ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
591 #  define       cSVOPx_svp(v)   (cSVOPx(v)->op_sv \
592                                  ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
593 #else
594 #  define       cGVOPx_gv(o)    ((GV*)cSVOPx(o)->op_sv)
595 #  define       IS_PADGV(v)     FALSE
596 #  define       IS_PADCONST(v)  FALSE
597 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv)
598 #  define       cSVOPx_svp(v)   (&cSVOPx(v)->op_sv)
599 #endif
600
601 #define cGVOP_gv                cGVOPx_gv(PL_op)
602 #define cGVOPo_gv               cGVOPx_gv(o)
603 #define kGVOP_gv                cGVOPx_gv(kid)
604 #define cSVOP_sv                cSVOPx_sv(PL_op)
605 #define cSVOPo_sv               cSVOPx_sv(o)
606 #define kSVOP_sv                cSVOPx_sv(kid)
607
608 #ifndef PERL_CORE
609 #  define Nullop ((OP*)NULL)
610 #endif
611
612 /* Lowest byte of PL_opargs */
613 #define OA_MARK 1
614 #define OA_FOLDCONST 2
615 #define OA_RETSCALAR 4
616 #define OA_TARGET 8
617 #define OA_TARGLEX 16
618 #define OA_OTHERINT 32
619 #define OA_DANGEROUS 64
620 #define OA_DEFGV 128
621
622 /* The next 4 bits encode op class information */
623 #define OCSHIFT 8
624
625 #define OA_CLASS_MASK (15 << OCSHIFT)
626
627 #define OA_BASEOP (0 << OCSHIFT)
628 #define OA_UNOP (1 << OCSHIFT)
629 #define OA_BINOP (2 << OCSHIFT)
630 #define OA_LOGOP (3 << OCSHIFT)
631 #define OA_LISTOP (4 << OCSHIFT)
632 #define OA_PMOP (5 << OCSHIFT)
633 #define OA_SVOP (6 << OCSHIFT)
634 #define OA_PADOP (7 << OCSHIFT)
635 #define OA_PVOP_OR_SVOP (8 << OCSHIFT)
636 #define OA_LOOP (9 << OCSHIFT)
637 #define OA_COP (10 << OCSHIFT)
638 #define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
639 #define OA_FILESTATOP (12 << OCSHIFT)
640 #define OA_LOOPEXOP (13 << OCSHIFT)
641
642 #define OASHIFT 12
643
644 /* Remaining nybbles of PL_opargs */
645 #define OA_SCALAR 1
646 #define OA_LIST 2
647 #define OA_AVREF 3
648 #define OA_HVREF 4
649 #define OA_CVREF 5
650 #define OA_FILEREF 6
651 #define OA_SCALARREF 7
652 #define OA_OPTIONAL 8
653
654 /* Op_REFCNT is a reference count at the head of each op tree: needed
655  * since the tree is shared between threads, and between cloned closure
656  * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
657  * this count.
658  * The same mutex is used to protect the refcounts of the reg_trie_data
659  * and reg_ac_data structures, which are shared between duplicated
660  * regexes.
661  */
662
663 #ifdef USE_ITHREADS
664 #  define OP_REFCNT_INIT                MUTEX_INIT(&PL_op_mutex)
665 #  ifdef PERL_CORE
666 #    define OP_REFCNT_LOCK              MUTEX_LOCK(&PL_op_mutex)
667 #    define OP_REFCNT_UNLOCK            MUTEX_UNLOCK(&PL_op_mutex)
668 #  else
669 #    define OP_REFCNT_LOCK              op_refcnt_lock()
670 #    define OP_REFCNT_UNLOCK            op_refcnt_unlock()
671 #  endif
672 #  define OP_REFCNT_TERM                MUTEX_DESTROY(&PL_op_mutex)
673 #else
674 #  define OP_REFCNT_INIT                NOOP
675 #  define OP_REFCNT_LOCK                NOOP
676 #  define OP_REFCNT_UNLOCK              NOOP
677 #  define OP_REFCNT_TERM                NOOP
678 #endif
679
680 #define OpREFCNT_set(o,n)               ((o)->op_targ = (n))
681 #ifdef PERL_DEBUG_READONLY_OPS
682 #  define OpREFCNT_inc(o)               Perl_op_refcnt_inc(aTHX_ o)
683 #  define OpREFCNT_dec(o)               Perl_op_refcnt_dec(aTHX_ o)
684 #else
685 #  define OpREFCNT_inc(o)               ((o) ? (++(o)->op_targ, (o)) : NULL)
686 #  define OpREFCNT_dec(o)               (--(o)->op_targ)
687 #endif
688
689 /* flags used by Perl_load_module() */
690 #define PERL_LOADMOD_DENY               0x1     /* no Module */
691 #define PERL_LOADMOD_NOIMPORT           0x2     /* use Module () */
692 #define PERL_LOADMOD_IMPORT_OPS         0x4     /* use Module (...) */
693
694 #if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C)
695 #define ref(o, type) doref(o, type, TRUE)
696 #endif
697
698 /*
699 =head1 Optree Manipulation Functions
700
701 =for apidoc Am|OP*|LINKLIST|OP *o
702 Given the root of an optree, link the tree in execution order using the
703 C<op_next> pointers and return the first op executed. If this has
704 already been done, it will not be redone, and C<< o->op_next >> will be
705 returned. If C<< o->op_next >> is not already set, I<o> should be at
706 least an C<UNOP>.
707
708 =cut
709 */
710
711 #define LINKLIST(o) ((o)->op_next ? (o)->op_next : op_linklist((OP*)o))
712
713 /* no longer used anywhere in core */
714 #ifndef PERL_CORE
715 #define cv_ckproto(cv, gv, p) \
716    cv_ckproto_len_flags((cv), (gv), (p), (p) ? strlen(p) : 0, 0)
717 #endif
718
719 #ifdef PERL_CORE
720 #  define my(o) my_attrs((o), NULL)
721 #endif
722
723 #ifdef USE_REENTRANT_API
724 #include "reentr.h"
725 #endif
726
727 #define NewOp(m,var,c,type)     \
728         (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type)))
729 #define NewOpSz(m,var,size)     \
730         (var = (OP *) Perl_Slab_Alloc(aTHX_ size))
731 #define FreeOp(p) Perl_Slab_Free(aTHX_ p)
732
733 /*
734  * The per-CV op slabs consist of a header (the opslab struct) and a bunch
735  * of space for allocating op slots, each of which consists of two pointers
736  * followed by an op.  The first pointer points to the next op slot.  The
737  * second points to the slab.  At the end of the slab is a null pointer,
738  * so that slot->opslot_next - slot can be used to determine the size
739  * of the op.
740  *
741  * Each CV can have multiple slabs; opslab_next points to the next slab, to
742  * form a chain.  All bookkeeping is done on the first slab, which is where
743  * all the op slots point.
744  *
745  * Freed ops are marked as freed and attached to the freed chain
746  * via op_next pointers.
747  *
748  * When there is more than one slab, the second slab in the slab chain is
749  * assumed to be the one with free space available.  It is used when allo-
750  * cating an op if there are no freed ops available or big enough.
751  */
752
753 #ifdef PERL_CORE
754 struct opslot {
755     /* keep opslot_next first */
756     OPSLOT *    opslot_next;            /* next slot */
757     OPSLAB *    opslot_slab;            /* owner */
758     OP          opslot_op;              /* the op itself */
759 };
760
761 struct opslab {
762     OPSLOT *    opslab_first;           /* first op in this slab */
763     OPSLAB *    opslab_next;            /* next slab */
764     OP *        opslab_freed;           /* chain of freed ops */
765     size_t      opslab_refcnt;          /* number of ops */
766 # ifdef PERL_DEBUG_READONLY_OPS
767     U16         opslab_size;            /* size of slab in pointers */
768     bool        opslab_readonly;
769 # endif
770     OPSLOT      opslab_slots;           /* slots begin here */
771 };
772
773 # define OPSLOT_HEADER          STRUCT_OFFSET(OPSLOT, opslot_op)
774 # define OPSLOT_HEADER_P        (OPSLOT_HEADER/sizeof(I32 *))
775 # define OpSLOT(o)              (assert_(o->op_slabbed) \
776                                  (OPSLOT *)(((char *)o)-OPSLOT_HEADER))
777 # define OpSLAB(o)              OpSLOT(o)->opslot_slab
778 # define OpslabREFCNT_dec(slab)      \
779         (((slab)->opslab_refcnt == 1) \
780          ? opslab_free_nopad(slab)     \
781          : (void)--(slab)->opslab_refcnt)
782   /* Variant that does not null out the pads */
783 # define OpslabREFCNT_dec_padok(slab) \
784         (((slab)->opslab_refcnt == 1)  \
785          ? opslab_free(slab)            \
786          : (void)--(slab)->opslab_refcnt)
787 #endif
788
789 struct block_hooks {
790     U32     bhk_flags;
791     void    (*bhk_start)        (pTHX_ int full);
792     void    (*bhk_pre_end)      (pTHX_ OP **seq);
793     void    (*bhk_post_end)     (pTHX_ OP **seq);
794     void    (*bhk_eval)         (pTHX_ OP *const saveop);
795 };
796
797 /*
798 =head1 Compile-time scope hooks
799
800 =for apidoc mx|U32|BhkFLAGS|BHK *hk
801 Return the BHK's flags.
802
803 =for apidoc mx|void *|BhkENTRY|BHK *hk|which
804 Return an entry from the BHK structure. I<which> is a preprocessor token
805 indicating which entry to return. If the appropriate flag is not set
806 this will return NULL. The type of the return value depends on which
807 entry you ask for.
808
809 =for apidoc Amx|void|BhkENTRY_set|BHK *hk|which|void *ptr
810 Set an entry in the BHK structure, and set the flags to indicate it is
811 valid. I<which> is a preprocessing token indicating which entry to set.
812 The type of I<ptr> depends on the entry.
813
814 =for apidoc Amx|void|BhkDISABLE|BHK *hk|which
815 Temporarily disable an entry in this BHK structure, by clearing the
816 appropriate flag. I<which> is a preprocessor token indicating which
817 entry to disable.
818
819 =for apidoc Amx|void|BhkENABLE|BHK *hk|which
820 Re-enable an entry in this BHK structure, by setting the appropriate
821 flag. I<which> is a preprocessor token indicating which entry to enable.
822 This will assert (under -DDEBUGGING) if the entry doesn't contain a valid
823 pointer.
824
825 =for apidoc mx|void|CALL_BLOCK_HOOKS|which|arg
826 Call all the registered block hooks for type I<which>. I<which> is a
827 preprocessing token; the type of I<arg> depends on I<which>.
828
829 =cut
830 */
831
832 #define BhkFLAGS(hk)            ((hk)->bhk_flags)
833
834 #define BHKf_bhk_start      0x01
835 #define BHKf_bhk_pre_end    0x02
836 #define BHKf_bhk_post_end   0x04
837 #define BHKf_bhk_eval       0x08
838
839 #define BhkENTRY(hk, which) \
840     ((BhkFLAGS(hk) & BHKf_ ## which) ? ((hk)->which) : NULL)
841
842 #define BhkENABLE(hk, which) \
843     STMT_START { \
844         BhkFLAGS(hk) |= BHKf_ ## which; \
845         assert(BhkENTRY(hk, which)); \
846     } STMT_END
847
848 #define BhkDISABLE(hk, which) \
849     STMT_START { \
850         BhkFLAGS(hk) &= ~(BHKf_ ## which); \
851     } STMT_END
852
853 #define BhkENTRY_set(hk, which, ptr) \
854     STMT_START { \
855         (hk)->which = ptr; \
856         BhkENABLE(hk, which); \
857     } STMT_END
858
859 #define CALL_BLOCK_HOOKS(which, arg) \
860     STMT_START { \
861         if (PL_blockhooks) { \
862             SSize_t i; \
863             for (i = av_len(PL_blockhooks); i >= 0; i--) { \
864                 SV *sv = AvARRAY(PL_blockhooks)[i]; \
865                 BHK *hk; \
866                 \
867                 assert(SvIOK(sv)); \
868                 if (SvUOK(sv)) \
869                     hk = INT2PTR(BHK *, SvUVX(sv)); \
870                 else \
871                     hk = INT2PTR(BHK *, SvIVX(sv)); \
872                 \
873                 if (BhkENTRY(hk, which)) \
874                     BhkENTRY(hk, which)(aTHX_ arg); \
875             } \
876         } \
877     } STMT_END
878
879 /* flags for rv2cv_op_cv */
880
881 #define RV2CVOPCV_MARK_EARLY     0x00000001
882 #define RV2CVOPCV_RETURN_NAME_GV 0x00000002
883
884 #define op_lvalue(op,t) Perl_op_lvalue_flags(aTHX_ op,t,0)
885
886 /* flags for op_lvalue_flags */
887
888 #define OP_LVALUE_NO_CROAK 1
889
890 /*
891 =head1 Custom Operators
892
893 =for apidoc Am|U32|XopFLAGS|XOP *xop
894 Return the XOP's flags.
895
896 =for apidoc Am||XopENTRY|XOP *xop|which
897 Return a member of the XOP structure. I<which> is a cpp token indicating
898 which entry to return. If the member is not set this will return a
899 default value. The return type depends on I<which>.
900
901 =for apidoc Am|void|XopENTRY_set|XOP *xop|which|value
902 Set a member of the XOP structure. I<which> is a cpp token indicating
903 which entry to set. See L<perlguts/"Custom Operators"> for details about
904 the available members and how they are used.
905
906 =for apidoc Am|void|XopDISABLE|XOP *xop|which
907 Temporarily disable a member of the XOP, by clearing the appropriate flag.
908
909 =for apidoc Am|void|XopENABLE|XOP *xop|which
910 Reenable a member of the XOP which has been disabled.
911
912 =cut
913 */
914
915 struct custom_op {
916     U32             xop_flags;    
917     const char     *xop_name;
918     const char     *xop_desc;
919     U32             xop_class;
920     void          (*xop_peep)(pTHX_ OP *o, OP *oldop);
921 };
922
923 #define XopFLAGS(xop) ((xop)->xop_flags)
924
925 #define XOPf_xop_name   0x01
926 #define XOPf_xop_desc   0x02
927 #define XOPf_xop_class  0x04
928 #define XOPf_xop_peep   0x08
929
930 #define XOPd_xop_name   PL_op_name[OP_CUSTOM]
931 #define XOPd_xop_desc   PL_op_desc[OP_CUSTOM]
932 #define XOPd_xop_class  OA_BASEOP
933 #define XOPd_xop_peep   ((Perl_cpeep_t)0)
934
935 #define XopENTRY_set(xop, which, to) \
936     STMT_START { \
937         (xop)->which = (to); \
938         (xop)->xop_flags |= XOPf_ ## which; \
939     } STMT_END
940
941 #define XopENTRY(xop, which) \
942     ((XopFLAGS(xop) & XOPf_ ## which) ? (xop)->which : XOPd_ ## which)
943
944 #define XopDISABLE(xop, which) ((xop)->xop_flags &= ~XOPf_ ## which)
945 #define XopENABLE(xop, which) \
946     STMT_START { \
947         (xop)->xop_flags |= XOPf_ ## which; \
948         assert(XopENTRY(xop, which)); \
949     } STMT_END
950
951 /*
952 =head1 Optree Manipulation Functions
953
954 =for apidoc Am|const char *|OP_NAME|OP *o
955 Return the name of the provided OP. For core ops this looks up the name
956 from the op_type; for custom ops from the op_ppaddr.
957
958 =for apidoc Am|const char *|OP_DESC|OP *o
959 Return a short description of the provided OP.
960
961 =for apidoc Am|U32|OP_CLASS|OP *o
962 Return the class of the provided OP: that is, which of the *OP
963 structures it uses. For core ops this currently gets the information out
964 of PL_opargs, which does not always accurately reflect the type used.
965 For custom ops the type is returned from the registration, and it is up
966 to the registree to ensure it is accurate. The value returned will be
967 one of the OA_* constants from op.h.
968
969 =cut
970 */
971
972 #define OP_NAME(o) ((o)->op_type == OP_CUSTOM \
973                     ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_name) \
974                     : PL_op_name[(o)->op_type])
975 #define OP_DESC(o) ((o)->op_type == OP_CUSTOM \
976                     ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_desc) \
977                     : PL_op_desc[(o)->op_type])
978 #define OP_CLASS(o) ((o)->op_type == OP_CUSTOM \
979                      ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_class) \
980                      : (PL_opargs[(o)->op_type] & OA_CLASS_MASK))
981
982 #define newSUB(f, o, p, b)      Perl_newATTRSUB(aTHX_ (f), (o), (p), NULL, (b))
983
984 #ifdef PERL_MAD
985 #  define MAD_NULL 1
986 #  define MAD_PV 2
987 #  define MAD_OP 3
988 #  define MAD_SV 4
989
990 struct madprop {
991     MADPROP* mad_next;
992     void *mad_val;
993     U32 mad_vlen;
994 /*    short mad_count; */
995     char mad_key;
996     char mad_type;
997 };
998
999 struct token {
1000     I32 tk_type;
1001     YYSTYPE tk_lval;
1002     MADPROP* tk_mad;
1003 };
1004 #endif
1005
1006 /*
1007  * Values that can be held by mad_key :
1008  * ^       unfilled head spot
1009  * ,       literal ,
1010  * ;       literal ; (blank if implicit ; at end of block)
1011  * :       literal : from ?: or attr list
1012  * +       unary +
1013  * ?       literal ? from ?:
1014  * (       literal (
1015  * )       literal )
1016  * [       literal [
1017  * ]       literal ]
1018  * {       literal {
1019  * }       literal }
1020  * @       literal @ sigil
1021  * $       literal $ sigil
1022  * *       literal * sigil
1023  * !       use is source filtered
1024  * &       & or sub
1025  * #       whitespace/comment following ; or }
1026  * #       $# sigil
1027  * 1       1st ; from for(;;)
1028  * 1       retired protasis
1029  * 2       2nd ; from for(;;)
1030  * 2       retired apodosis
1031  * 3       C-style for list
1032  * a       sub or var attributes
1033  * a       non-method arrow operator
1034  * A       method arrow operator
1035  * A       use import args
1036  * b       format block
1037  * B       retired stub block
1038  * C       constant conditional op
1039  * d       declarator
1040  * D       do block
1041  * e       unreached "else" (see C)
1042  * e       expression producing E
1043  * E       tr/E/R/, /E/
1044  * f       folded constant op
1045  * F       peg op for format
1046  * g       op was forced to be a word
1047  * i       if/unless modifier
1048  * I       if/elsif/unless statement
1049  * k       local declarator
1050  * K       retired kid op
1051  * l       last index of array ($#foo)
1052  * L       label
1053  * m       modifier on regex
1054  * n       sub or format name
1055  * o       current operator/declarator name
1056  * o       else/continue
1057  * O       generic optimized op
1058  * p       peg to hold extra whitespace at statement level
1059  * P       peg op for package declaration
1060  * q       opening quote
1061  * =       quoted material
1062  * Q       closing quote
1063  * Q       optimized qw//
1064  * r       expression producing R
1065  * R       tr/E/R/ s/E/R/
1066  * s       sub signature
1067  * S       use import stub (no import)
1068  * S       retired sort block
1069  * t       unreached "then" (see C)
1070  * U       use import op
1071  * v       private sv of for loop
1072  * V       use version
1073  * w       while/until modifier
1074  * W       while/for statement
1075  * x       optimized qw
1076  * X       random thing
1077  * _       whitespace/comments preceding anything else
1078  * ~       =~ operator
1079  */
1080
1081 /*
1082 =head1 Hook manipulation
1083 */
1084
1085 #ifdef USE_ITHREADS
1086 #  define OP_CHECK_MUTEX_INIT           MUTEX_INIT(&PL_check_mutex)
1087 #  define OP_CHECK_MUTEX_LOCK           MUTEX_LOCK(&PL_check_mutex)
1088 #  define OP_CHECK_MUTEX_UNLOCK         MUTEX_UNLOCK(&PL_check_mutex)
1089 #  define OP_CHECK_MUTEX_TERM           MUTEX_DESTROY(&PL_check_mutex)
1090 #else
1091 #  define OP_CHECK_MUTEX_INIT           NOOP
1092 #  define OP_CHECK_MUTEX_LOCK           NOOP
1093 #  define OP_CHECK_MUTEX_UNLOCK         NOOP
1094 #  define OP_CHECK_MUTEX_TERM           NOOP
1095 #endif
1096
1097 /*
1098  * Local variables:
1099  * c-indentation-style: bsd
1100  * c-basic-offset: 4
1101  * indent-tabs-mode: nil
1102  * End:
1103  *
1104  * ex: set ts=8 sts=4 sw=4 et:
1105  */