perlhack.pod addendum for consideration (perlbug mail interface)
[p5sagit/p5-mst-13.2.git] / op.h
1 /*    op.h
2  *
3  *    Copyright (c) 1991-2001, Larry Wall
4  *
5  *    You may distribute under the terms of either the GNU General Public
6  *    License or the Artistic License, as specified in the README file.
7  *
8  */
9
10 /*
11  * The fields of BASEOP are:
12  *      op_next         Pointer to next ppcode to execute after this one.
13  *                      (Top level pre-grafted op points to first op,
14  *                      but this is replaced when op is grafted in, when
15  *                      this op will point to the real next op, and the new
16  *                      parent takes over role of remembering starting op.)
17  *      op_ppaddr       Pointer to current ppcode's function.
18  *      op_type         The type of the operation.
19  *      op_flags        Flags common to all operations.  See OPf_* below.
20  *      op_private      Flags peculiar to a particular operation (BUT,
21  *                      by default, set to the number of children until
22  *                      the operation is privatized by a check routine,
23  *                      which may or may not check number of children).
24  */
25
26 #if PTRSIZE == 8
27 typedef U64TYPE PADOFFSET;
28 #else
29 typedef U32TYPE PADOFFSET;
30 #endif
31 #define NOT_IN_PAD ((PADOFFSET) -1)
32
33 #ifdef DEBUGGING_OPS
34 #define OPCODE opcode
35 #else
36 #define OPCODE U16
37 #endif
38
39 #ifdef BASEOP_DEFINITION
40 #define BASEOP BASEOP_DEFINITION
41 #else
42 #define BASEOP                          \
43     OP*         op_next;                \
44     OP*         op_sibling;             \
45     OP*         (CPERLscope(*op_ppaddr))(pTHX);         \
46     PADOFFSET   op_targ;                \
47     OPCODE      op_type;                \
48     U16         op_seq;                 \
49     U8          op_flags;               \
50     U8          op_private;
51 #endif
52
53 #define OP_GIMME(op,dfl) \
54         (((op)->op_flags & OPf_WANT) == OPf_WANT_VOID   ? G_VOID   : \
55          ((op)->op_flags & OPf_WANT) == OPf_WANT_SCALAR ? G_SCALAR : \
56          ((op)->op_flags & OPf_WANT) == OPf_WANT_LIST   ? G_ARRAY   : \
57          dfl)
58
59 /*
60 =for apidoc Amn|U32|GIMME_V
61 The XSUB-writer's equivalent to Perl's C<wantarray>.  Returns C<G_VOID>,
62 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
63 respectively.
64
65 =for apidoc Amn|U32|GIMME
66 A backward-compatible version of C<GIMME_V> which can only return
67 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
68 Deprecated.  Use C<GIMME_V> instead.
69
70 =cut
71 */
72
73 #define GIMME_V         OP_GIMME(PL_op, block_gimme())
74
75 /* Public flags */
76
77 #define OPf_WANT        3       /* Mask for "want" bits: */
78 #define  OPf_WANT_VOID   1      /*   Want nothing */
79 #define  OPf_WANT_SCALAR 2      /*   Want single value */
80 #define  OPf_WANT_LIST   3      /*   Want list of any length */
81 #define OPf_KIDS        4       /* There is a firstborn child. */
82 #define OPf_PARENS      8       /* This operator was parenthesized. */
83                                 /*  (Or block needs explicit scope entry.) */
84 #define OPf_REF         16      /* Certified reference. */
85                                 /*  (Return container, not containee). */
86 #define OPf_MOD         32      /* Will modify (lvalue). */
87 #define OPf_STACKED     64      /* Some arg is arriving on the stack. */
88 #define OPf_SPECIAL     128     /* Do something weird for this op: */
89                                 /*  On local LVAL, don't init local value. */
90                                 /*  On OP_SORT, subroutine is inlined. */
91                                 /*  On OP_NOT, inversion was implicit. */
92                                 /*  On OP_LEAVE, don't restore curpm. */
93                                 /*  On truncate, we truncate filehandle */
94                                 /*  On control verbs, we saw no label */
95                                 /*  On flipflop, we saw ... instead of .. */
96                                 /*  On UNOPs, saw bare parens, e.g. eof(). */
97                                 /*  On OP_ENTERSUB || OP_NULL, saw a "do". */
98                                 /*  On OP_EXISTS, treat av as av, not avhv.  */
99                                 /*  On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
100                                 /*  On OP_ENTERITER, loop var is per-thread */
101                                 /*  On pushre, re is /\s+/ imp. by split " " */
102                                 /*  On regcomp, "use re 'eval'" was in scope */
103
104 /* old names; don't use in new code, but don't break them, either */
105 #define OPf_LIST        OPf_WANT_LIST
106 #define OPf_KNOW        OPf_WANT
107
108 #define GIMME \
109           (PL_op->op_flags & OPf_WANT                                   \
110            ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST             \
111               ? G_ARRAY                                                 \
112               : G_SCALAR)                                               \
113            : dowantarray())
114
115 /* NOTE: OP_NEXTSTATE, OP_DBSTATE, and OP_SETSTATE (i.e. COPs) carry lower
116  * bits of PL_hints in op_private */
117
118 /* Private for lvalues */
119 #define OPpLVAL_INTRO   128     /* Lvalue must be localized or lvalue sub */
120
121 /* Private for OP_LEAVE, OP_LEAVESUB, OP_LEAVESUBLV and OP_LEAVEWRITE */
122 #define OPpREFCOUNTED           64      /* op_targ carries a refcount */
123
124 /* Private for OP_AASSIGN */
125 #define OPpASSIGN_COMMON        64      /* Left & right have syms in common. */
126 #define OPpASSIGN_HASH          32      /* Assigning to possible pseudohash. */
127
128 /* Private for OP_SASSIGN */
129 #define OPpASSIGN_BACKWARDS     64      /* Left & right switched. */
130
131 /* Private for OP_MATCH and OP_SUBST{,CONST} */
132 #define OPpRUNTIME              64      /* Pattern coming in on the stack */
133
134 /* Private for OP_TRANS */
135 #define OPpTRANS_FROM_UTF       1
136 #define OPpTRANS_TO_UTF         2
137 #define OPpTRANS_IDENTICAL      4       /* right side is same as left */
138 #define OPpTRANS_SQUASH         8
139 #define OPpTRANS_DELETE         16
140 #define OPpTRANS_COMPLEMENT     32
141 #define OPpTRANS_GROWS          64
142
143 /* Private for OP_REPEAT */
144 #define OPpREPEAT_DOLIST        64      /* List replication. */
145
146 /* Private for OP_RV2?V, OP_?ELEM */
147 #define OPpDEREF                (32|64) /* Want ref to something: */
148 #define OPpDEREF_AV             32      /*   Want ref to AV. */
149 #define OPpDEREF_HV             64      /*   Want ref to HV. */
150 #define OPpDEREF_SV             (32|64) /*   Want ref to SV. */
151   /* OP_ENTERSUB only */
152 #define OPpENTERSUB_DB          16      /* Debug subroutine. */
153 #define OPpENTERSUB_HASTARG     32      /* Called from OP tree. */
154   /* OP_RV2CV only */
155 #define OPpENTERSUB_AMPER       8       /* Used & form to call. */
156 #define OPpENTERSUB_NOPAREN     128     /* bare sub call (without parens) */
157 #define OPpENTERSUB_INARGS      4       /* Lval used as arg to a sub. */
158   /* OP_GV only */
159 #define OPpEARLY_CV             32      /* foo() called before sub foo was parsed */
160   /* OP_?ELEM only */
161 #define OPpLVAL_DEFER           16      /* Defer creation of array/hash elem */
162   /* OP_RV2?V, OP_GVSV only */
163 #define OPpOUR_INTRO            16      /* Variable was in an our() */
164   /* OP_RV2[AH]V, OP_PAD[AH]V, OP_[AH]ELEM */
165 #define OPpMAYBE_LVSUB          8       /* We might be an lvalue to return */
166   /* for OP_RV2?V, lower bits carry hints (currently only HINT_STRICT_REFS) */
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_CONST */
173 #define OPpCONST_STRICT         8       /* bearword subject to strict 'subs' */
174 #define OPpCONST_ENTERED        16      /* Has been entered as symbol. */
175 #define OPpCONST_ARYBASE        32      /* Was a $[ translated to constant. */
176 #define OPpCONST_BARE           64      /* Was a bare word (filehandle?). */
177 #define OPpCONST_WARNING        128     /* Was a $^W translated to constant. */
178
179 /* Private for OP_FLIP/FLOP */
180 #define OPpFLIP_LINENUM         64      /* Range arg potentially a line num. */
181
182 /* Private for OP_LIST */
183 #define OPpLIST_GUESSED         64      /* Guessed that pushmark was needed. */
184
185 /* Private for OP_DELETE */
186 #define OPpSLICE                64      /* Operating on a list of keys */
187
188 /* Private for OP_EXISTS */
189 #define OPpEXISTS_SUB           64      /* Checking for &sub, not {} or [].  */
190
191 /* Private for OP_SORT */
192 #define OPpSORT_NUMERIC         1       /* Optimized away { $a <=> $b } */
193 #define OPpSORT_INTEGER         2       /* Ditto while under "use integer" */
194 #define OPpSORT_REVERSE         4       /* Descending sort */
195 /* Private for OP_THREADSV */
196 #define OPpDONE_SVREF           64      /* Been through newSVREF once */
197
198 /* Private for OP_OPEN and OP_BACKTICK */
199 #define OPpOPEN_IN_RAW          16      /* binmode(F,":raw") on input fh */
200 #define OPpOPEN_IN_CRLF         32      /* binmode(F,":crlf") on input fh */
201 #define OPpOPEN_OUT_RAW         64      /* binmode(F,":raw") on output fh */
202 #define OPpOPEN_OUT_CRLF        128     /* binmode(F,":crlf") on output fh */
203
204 /* Private for OP_EXIT, HUSH also for OP_DIE */
205 #define OPpHUSH_VMSISH          64      /* hush DCL exit msg vmsish mode*/
206 #define OPpEXIT_VMSISH          128     /* exit(0) vs. exit(1) vmsish mode*/
207
208 struct op {
209     BASEOP
210 };
211
212 struct unop {
213     BASEOP
214     OP *        op_first;
215 };
216
217 struct binop {
218     BASEOP
219     OP *        op_first;
220     OP *        op_last;
221 };
222
223 struct logop {
224     BASEOP
225     OP *        op_first;
226     OP *        op_other;
227 };
228
229 struct listop {
230     BASEOP
231     OP *        op_first;
232     OP *        op_last;
233 };
234
235 struct pmop {
236     BASEOP
237     OP *        op_first;
238     OP *        op_last;
239     OP *        op_pmreplroot;
240     OP *        op_pmreplstart;
241     PMOP *      op_pmnext;              /* list of all scanpats */
242 #ifdef USE_ITHREADS
243     IV          op_pmoffset;
244 #else
245     REGEXP *    op_pmregexp;            /* compiled expression */
246 #endif
247     U16         op_pmflags;
248     U16         op_pmpermflags;
249     U8          op_pmdynflags;
250 #ifdef USE_ITHREADS
251     char *      op_pmstashpv;
252 #else
253     HV *        op_pmstash;
254 #endif
255 };
256
257 #ifdef USE_ITHREADS
258 #define PM_GETRE(o)     (INT2PTR(REGEXP*,SvIVX(PL_regex_pad[(o)->op_pmoffset])))
259 #define PM_SETRE(o,r)   (sv_setiv(PL_regex_pad[(o)->op_pmoffset], PTR2IV(r)))
260 #define PM_GETRE_SAFE(o) (PL_regex_pad ? PM_GETRE(o) : (REGEXP*)0)
261 #define PM_SETRE_SAFE(o,r) if (PL_regex_pad) PM_SETRE(o,r)
262 #else
263 #define PM_GETRE(o)     ((o)->op_pmregexp)
264 #define PM_SETRE(o,r)   ((o)->op_pmregexp = (r))
265 #define PM_GETRE_SAFE PM_GETRE
266 #define PM_SETRE_SAFE PM_SETRE
267 #endif
268
269 #define PMdf_USED       0x01            /* pm has been used once already */
270 #define PMdf_TAINTED    0x02            /* pm compiled from tainted pattern */
271 #define PMdf_UTF8       0x04            /* pm compiled from utf8 data */
272 #define PMdf_DYN_UTF8   0x08
273
274 #define PMdf_CMP_UTF8   (PMdf_UTF8|PMdf_DYN_UTF8)
275
276 #define PMf_RETAINT     0x0001          /* taint $1 etc. if target tainted */
277 #define PMf_ONCE        0x0002          /* use pattern only once per reset */
278 #define PMf_REVERSED    0x0004          /* Should be matched right->left */
279 #define PMf_MAYBE_CONST 0x0008          /* replacement contains variables */
280 #define PMf_SKIPWHITE   0x0010          /* skip leading whitespace for split */
281 #define PMf_WHITE       0x0020          /* pattern is \s+ */
282 #define PMf_CONST       0x0040          /* subst replacement is constant */
283 #define PMf_KEEP        0x0080          /* keep 1st runtime pattern forever */
284 #define PMf_GLOBAL      0x0100          /* pattern had a g modifier */
285 #define PMf_CONTINUE    0x0200          /* don't reset pos() if //g fails */
286 #define PMf_EVAL        0x0400          /* evaluating replacement as expr */
287 #define PMf_LOCALE      0x0800          /* use locale for character types */
288 #define PMf_MULTILINE   0x1000          /* assume multiple lines */
289 #define PMf_SINGLELINE  0x2000          /* assume single line */
290 #define PMf_FOLD        0x4000          /* case insensitivity */
291 #define PMf_EXTENDED    0x8000          /* chuck embedded whitespace */
292
293 /* mask of bits stored in regexp->reganch */
294 #define PMf_COMPILETIME (PMf_MULTILINE|PMf_SINGLELINE|PMf_LOCALE|PMf_FOLD|PMf_EXTENDED)
295
296 #ifdef USE_ITHREADS
297 #  define PmopSTASHPV(o)        ((o)->op_pmstashpv)
298 #  define PmopSTASHPV_set(o,pv) ((o)->op_pmstashpv = ((pv) ? savepv(pv) : Nullch))
299 #  define PmopSTASH(o)          (PmopSTASHPV(o) \
300                                  ? gv_stashpv(PmopSTASHPV(o),GV_ADD) : Nullhv)
301 #  define PmopSTASH_set(o,hv)   PmopSTASHPV_set(o, (hv) ? HvNAME(hv) : Nullch)
302 #else
303 #  define PmopSTASH(o)          ((o)->op_pmstash)
304 #  define PmopSTASH_set(o,hv)   ((o)->op_pmstash = (hv))
305 #  define PmopSTASHPV(o)        (PmopSTASH(o) ? HvNAME(PmopSTASH(o)) : Nullch)
306    /* op_pmstash is not refcounted */
307 #  define PmopSTASHPV_set(o,pv) PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
308 #endif
309
310 struct svop {
311     BASEOP
312     SV *        op_sv;
313 };
314
315 struct padop {
316     BASEOP
317     PADOFFSET   op_padix;
318 };
319
320 struct pvop {
321     BASEOP
322     char *      op_pv;
323 };
324
325 struct loop {
326     BASEOP
327     OP *        op_first;
328     OP *        op_last;
329     OP *        op_redoop;
330     OP *        op_nextop;
331     OP *        op_lastop;
332 };
333
334 #define cUNOPx(o)       ((UNOP*)o)
335 #define cBINOPx(o)      ((BINOP*)o)
336 #define cLISTOPx(o)     ((LISTOP*)o)
337 #define cLOGOPx(o)      ((LOGOP*)o)
338 #define cPMOPx(o)       ((PMOP*)o)
339 #define cSVOPx(o)       ((SVOP*)o)
340 #define cPADOPx(o)      ((PADOP*)o)
341 #define cPVOPx(o)       ((PVOP*)o)
342 #define cCOPx(o)        ((COP*)o)
343 #define cLOOPx(o)       ((LOOP*)o)
344
345 #define cUNOP           cUNOPx(PL_op)
346 #define cBINOP          cBINOPx(PL_op)
347 #define cLISTOP         cLISTOPx(PL_op)
348 #define cLOGOP          cLOGOPx(PL_op)
349 #define cPMOP           cPMOPx(PL_op)
350 #define cSVOP           cSVOPx(PL_op)
351 #define cPADOP          cPADOPx(PL_op)
352 #define cPVOP           cPVOPx(PL_op)
353 #define cCOP            cCOPx(PL_op)
354 #define cLOOP           cLOOPx(PL_op)
355
356 #define cUNOPo          cUNOPx(o)
357 #define cBINOPo         cBINOPx(o)
358 #define cLISTOPo        cLISTOPx(o)
359 #define cLOGOPo         cLOGOPx(o)
360 #define cPMOPo          cPMOPx(o)
361 #define cSVOPo          cSVOPx(o)
362 #define cPADOPo         cPADOPx(o)
363 #define cPVOPo          cPVOPx(o)
364 #define cCOPo           cCOPx(o)
365 #define cLOOPo          cLOOPx(o)
366
367 #define kUNOP           cUNOPx(kid)
368 #define kBINOP          cBINOPx(kid)
369 #define kLISTOP         cLISTOPx(kid)
370 #define kLOGOP          cLOGOPx(kid)
371 #define kPMOP           cPMOPx(kid)
372 #define kSVOP           cSVOPx(kid)
373 #define kPADOP          cPADOPx(kid)
374 #define kPVOP           cPVOPx(kid)
375 #define kCOP            cCOPx(kid)
376 #define kLOOP           cLOOPx(kid)
377
378
379 #ifdef USE_ITHREADS
380 #  define       cGVOPx_gv(o)    ((GV*)PL_curpad[cPADOPx(o)->op_padix])
381 #  define       IS_PADGV(v)     (v && SvTYPE(v) == SVt_PVGV && GvIN_PAD(v))
382 #  define       IS_PADCONST(v)  (v && SvREADONLY(v))
383 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv \
384                                  ? cSVOPx(v)->op_sv : PL_curpad[(v)->op_targ])
385 #  define       cSVOPx_svp(v)   (cSVOPx(v)->op_sv \
386                                  ? &cSVOPx(v)->op_sv : &PL_curpad[(v)->op_targ])
387 #else
388 #  define       cGVOPx_gv(o)    ((GV*)cSVOPx(o)->op_sv)
389 #  define       IS_PADGV(v)     FALSE
390 #  define       IS_PADCONST(v)  FALSE
391 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv)
392 #  define       cSVOPx_svp(v)   (&cSVOPx(v)->op_sv)
393 #endif
394
395 #define cGVOP_gv                cGVOPx_gv(PL_op)
396 #define cGVOPo_gv               cGVOPx_gv(o)
397 #define kGVOP_gv                cGVOPx_gv(kid)
398 #define cSVOP_sv                cSVOPx_sv(PL_op)
399 #define cSVOPo_sv               cSVOPx_sv(o)
400 #define kSVOP_sv                cSVOPx_sv(kid)
401
402 #define Nullop Null(OP*)
403
404 /* Lowest byte-and-a-bit of PL_opargs */
405 #define OA_MARK 1
406 #define OA_FOLDCONST 2
407 #define OA_RETSCALAR 4
408 #define OA_TARGET 8
409 #define OA_RETINTEGER 16
410 #define OA_OTHERINT 32
411 #define OA_DANGEROUS 64
412 #define OA_DEFGV 128
413 #define OA_TARGLEX 256
414
415 /* The next 4 bits encode op class information */
416 #define OCSHIFT 9
417
418 #define OA_CLASS_MASK (15 << OCSHIFT)
419
420 #define OA_BASEOP (0 << OCSHIFT)
421 #define OA_UNOP (1 << OCSHIFT)
422 #define OA_BINOP (2 << OCSHIFT)
423 #define OA_LOGOP (3 << OCSHIFT)
424 #define OA_LISTOP (4 << OCSHIFT)
425 #define OA_PMOP (5 << OCSHIFT)
426 #define OA_SVOP (6 << OCSHIFT)
427 #define OA_PADOP (7 << OCSHIFT)
428 #define OA_PVOP_OR_SVOP (8 << OCSHIFT)
429 #define OA_LOOP (9 << OCSHIFT)
430 #define OA_COP (10 << OCSHIFT)
431 #define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
432 #define OA_FILESTATOP (12 << OCSHIFT)
433 #define OA_LOOPEXOP (13 << OCSHIFT)
434
435 #define OASHIFT 13
436
437 /* Remaining nybbles of PL_opargs */
438 #define OA_SCALAR 1
439 #define OA_LIST 2
440 #define OA_AVREF 3
441 #define OA_HVREF 4
442 #define OA_CVREF 5
443 #define OA_FILEREF 6
444 #define OA_SCALARREF 7
445 #define OA_OPTIONAL 8
446
447 #ifdef USE_ITHREADS
448 #  define OP_REFCNT_INIT                MUTEX_INIT(&PL_op_mutex)
449 #  define OP_REFCNT_LOCK                MUTEX_LOCK(&PL_op_mutex)
450 #  define OP_REFCNT_UNLOCK              MUTEX_UNLOCK(&PL_op_mutex)
451 #  define OP_REFCNT_TERM                MUTEX_DESTROY(&PL_op_mutex)
452 #else
453 #  define OP_REFCNT_INIT                NOOP
454 #  define OP_REFCNT_LOCK                NOOP
455 #  define OP_REFCNT_UNLOCK              NOOP
456 #  define OP_REFCNT_TERM                NOOP
457 #endif
458
459 #define OpREFCNT_set(o,n)               ((o)->op_targ = (n))
460 #define OpREFCNT_inc(o)                 ((o) ? (++(o)->op_targ, (o)) : Nullop)
461 #define OpREFCNT_dec(o)                 (--(o)->op_targ)
462
463 /* flags used by Perl_load_module() */
464 #define PERL_LOADMOD_DENY               0x1
465 #define PERL_LOADMOD_NOIMPORT           0x2
466 #define PERL_LOADMOD_IMPORT_OPS         0x4
467
468 #ifdef USE_REENTRANT_API
469
470 typedef struct {
471   struct tm* tmbuff;
472 } REBUF;
473
474 #define localtime(a)       (localtime_r((a),PL_reentrant_buffer->tmbuff) ? PL_reentrant_buffer->tmbuff : NULL)
475 #define gmtime(a)          (gmtime_r((a),PL_reentrant_buffer->tmbuff) ?  PL_reentrant_buffer->tmbuff : NULL)
476
477 #ifdef OLD_PTHREADS_API
478
479 /* HP-UX 10.20 returns 0 on success, what it returns on failure is hidden
480    in the fog somewhere, possibly -1 which means the following should do 
481    the right thing - 20010816 sky */
482
483 #undef localtime
484 #undef gmtime
485 #define localtime(a)       ((localtime_r((a),PL_reentrant_buffer->tmbuff) == 0) ? PL_reentrant_buffer->tmbuff : NULL)
486 #define gmtime(a)          ((gmtime_r((a),PL_reentrant_buffer->tmbuff) == 0) ? PL_reentrant_buffer->tmbuff : NULL)
487 #endif /* HP-UX 10.20 */
488
489 #endif
490