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