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