This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Salvage 'use filetest "access"' from compiletime to runtime.
[perl5.git] / op.h
1 /*    op.h
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4  *    2000, 2001, 2002, 2003, 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_flags        Flags common to all operations.  See OPf_* below.
21  *      op_private      Flags peculiar to a particular operation (BUT,
22  *                      by default, set to the number of children until
23  *                      the operation is privatized by a check routine,
24  *                      which may or may not check number of children).
25  */
26
27 #ifdef DEBUGGING_OPS
28 #define OPCODE opcode
29 #else
30 #define OPCODE U16
31 #endif
32
33 #ifdef BASEOP_DEFINITION
34 #define BASEOP BASEOP_DEFINITION
35 #else
36 #define BASEOP                          \
37     OP*         op_next;                \
38     OP*         op_sibling;             \
39     OP*         (CPERLscope(*op_ppaddr))(pTHX);         \
40     PADOFFSET   op_targ;                \
41     OPCODE      op_type;                \
42     U16         op_seq;                 \
43     U8          op_flags;               \
44     U8          op_private;
45 #endif
46
47 #define OP_GIMME(op,dfl) \
48         (((op)->op_flags & OPf_WANT) == OPf_WANT_VOID   ? G_VOID   : \
49          ((op)->op_flags & OPf_WANT) == OPf_WANT_SCALAR ? G_SCALAR : \
50          ((op)->op_flags & OPf_WANT) == OPf_WANT_LIST   ? G_ARRAY   : \
51          dfl)
52
53 /*
54 =head1 "Gimme" Values
55
56 =for apidoc Amn|U32|GIMME_V
57 The XSUB-writer's equivalent to Perl's C<wantarray>.  Returns C<G_VOID>,
58 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
59 respectively.
60
61 =for apidoc Amn|U32|GIMME
62 A backward-compatible version of C<GIMME_V> which can only return
63 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
64 Deprecated.  Use C<GIMME_V> instead.
65
66 =cut
67 */
68
69 #define GIMME_V         OP_GIMME(PL_op, block_gimme())
70
71 /* Public flags */
72
73 #define OPf_WANT        3       /* Mask for "want" bits: */
74 #define  OPf_WANT_VOID   1      /*   Want nothing */
75 #define  OPf_WANT_SCALAR 2      /*   Want single value */
76 #define  OPf_WANT_LIST   3      /*   Want list of any length */
77 #define OPf_KIDS        4       /* There is a firstborn child. */
78 #define OPf_PARENS      8       /* This operator was parenthesized. */
79                                 /*  (Or block needs explicit scope entry.) */
80 #define OPf_REF         16      /* Certified reference. */
81                                 /*  (Return container, not containee). */
82 #define OPf_MOD         32      /* Will modify (lvalue). */
83 #define OPf_STACKED     64      /* Some arg is arriving on the stack. */
84 #define OPf_SPECIAL     128     /* Do something weird for this op: */
85                                 /*  On local LVAL, don't init local value. */
86                                 /*  On OP_SORT, subroutine is inlined. */
87                                 /*  On OP_NOT, inversion was implicit. */
88                                 /*  On OP_LEAVE, don't restore curpm. */
89                                 /*  On truncate, we truncate filehandle */
90                                 /*  On control verbs, we saw no label */
91                                 /*  On flipflop, we saw ... instead of .. */
92                                 /*  On UNOPs, saw bare parens, e.g. eof(). */
93                                 /*  On OP_ENTERSUB || OP_NULL, saw a "do". */
94                                 /*  On OP_EXISTS, treat av as av, not avhv.  */
95                                 /*  On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
96                                 /*  On OP_ENTERITER, loop var is per-thread */
97                                 /*  On pushre, re is /\s+/ imp. by split " " */
98                                 /*  On regcomp, "use re 'eval'" was in scope */
99                                 /*  On OP_READLINE, was <$filehandle> */
100                                 /*  On RV2[SG]V, don't create GV--in defined()*/
101                                 /*  On OP_DBSTATE, indicates breakpoint
102                                  *    (runtime property) */
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
127 /* Private for OP_SASSIGN */
128 #define OPpASSIGN_BACKWARDS     64      /* Left & right switched. */
129
130 /* Private for OP_MATCH and OP_SUBST{,CONST} */
131 #define OPpRUNTIME              64      /* Pattern coming in on the stack */
132
133 /* Private for OP_TRANS */
134 #define OPpTRANS_FROM_UTF       1
135 #define OPpTRANS_TO_UTF         2
136 #define OPpTRANS_IDENTICAL      4       /* right side is same as left */
137 #define OPpTRANS_SQUASH         8
138 #define OPpTRANS_DELETE         16
139 #define OPpTRANS_COMPLEMENT     32
140 #define OPpTRANS_GROWS          64
141
142 /* Private for OP_REPEAT */
143 #define OPpREPEAT_DOLIST        64      /* List replication. */
144
145 /* Private for OP_RV2?V, OP_?ELEM */
146 #define OPpDEREF                (32|64) /* Want ref to something: */
147 #define OPpDEREF_AV             32      /*   Want ref to AV. */
148 #define OPpDEREF_HV             64      /*   Want ref to HV. */
149 #define OPpDEREF_SV             (32|64) /*   Want ref to SV. */
150   /* OP_ENTERSUB only */
151 #define OPpENTERSUB_DB          16      /* Debug subroutine. */
152 #define OPpENTERSUB_HASTARG     32      /* Called from OP tree. */
153 #define OPpENTERSUB_NOMOD       64      /* Immune to mod() for :attrlist. */
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 /* Private of OP_FTXXX */
209 #define OPpFT_ACCESS            2       /* use filetest 'access' */
210 #define OP_IS_FILETEST_ACCESS(op)               \
211         (((op)->op_type) == OP_FTRREAD  ||      \
212          ((op)->op_type) == OP_FTRWRITE ||      \
213          ((op)->op_type) == OP_FTREXEC  ||      \
214          ((op)->op_type) == OP_FTEREAD  ||      \
215          ((op)->op_type) == OP_FTEWRITE ||      \
216          ((op)->op_type) == OP_FTEEXEC)
217
218 struct op {
219     BASEOP
220 };
221
222 struct unop {
223     BASEOP
224     OP *        op_first;
225 };
226
227 struct binop {
228     BASEOP
229     OP *        op_first;
230     OP *        op_last;
231 };
232
233 struct logop {
234     BASEOP
235     OP *        op_first;
236     OP *        op_other;
237 };
238
239 struct listop {
240     BASEOP
241     OP *        op_first;
242     OP *        op_last;
243 };
244
245 struct pmop {
246     BASEOP
247     OP *        op_first;
248     OP *        op_last;
249     OP *        op_pmreplroot;
250     OP *        op_pmreplstart;
251     PMOP *      op_pmnext;              /* list of all scanpats */
252 #ifdef USE_ITHREADS
253     IV          op_pmoffset;
254 #else
255     REGEXP *    op_pmregexp;            /* compiled expression */
256 #endif
257     U32         op_pmflags;
258     U32         op_pmpermflags;
259     U8          op_pmdynflags;
260 #ifdef USE_ITHREADS
261     char *      op_pmstashpv;
262 #else
263     HV *        op_pmstash;
264 #endif
265 };
266
267 #ifdef USE_ITHREADS
268 #define PM_GETRE(o)     (INT2PTR(REGEXP*,SvIVX(PL_regex_pad[(o)->op_pmoffset])))
269 #define PM_SETRE(o,r)   STMT_START { SV* sv = PL_regex_pad[(o)->op_pmoffset]; sv_setiv(sv, PTR2IV(r)); } STMT_END
270 #define PM_GETRE_SAFE(o) (PL_regex_pad ? PM_GETRE(o) : (REGEXP*)0)
271 #define PM_SETRE_SAFE(o,r) if (PL_regex_pad) PM_SETRE(o,r)
272 #else
273 #define PM_GETRE(o)     ((o)->op_pmregexp)
274 #define PM_SETRE(o,r)   ((o)->op_pmregexp = (r))
275 #define PM_GETRE_SAFE PM_GETRE
276 #define PM_SETRE_SAFE PM_SETRE
277 #endif
278
279 #define PMdf_USED       0x01            /* pm has been used once already */
280 #define PMdf_TAINTED    0x02            /* pm compiled from tainted pattern */
281 #define PMdf_UTF8       0x04            /* pm compiled from utf8 data */
282 #define PMdf_DYN_UTF8   0x08
283
284 #define PMdf_CMP_UTF8   (PMdf_UTF8|PMdf_DYN_UTF8)
285
286 #define PMf_RETAINT     0x0001          /* taint $1 etc. if target tainted */
287 #define PMf_ONCE        0x0002          /* use pattern only once per reset */
288 #define PMf_UNUSED      0x0004          /* free for use */
289 #define PMf_MAYBE_CONST 0x0008          /* replacement contains variables */
290 #define PMf_SKIPWHITE   0x0010          /* skip leading whitespace for split */
291 #define PMf_WHITE       0x0020          /* pattern is \s+ */
292 #define PMf_CONST       0x0040          /* subst replacement is constant */
293 #define PMf_KEEP        0x0080          /* keep 1st runtime pattern forever */
294 #define PMf_GLOBAL      0x0100          /* pattern had a g modifier */
295 #define PMf_CONTINUE    0x0200          /* don't reset pos() if //g fails */
296 #define PMf_EVAL        0x0400          /* evaluating replacement as expr */
297 #define PMf_LOCALE      0x0800          /* use locale for character types */
298 #define PMf_MULTILINE   0x1000          /* assume multiple lines */
299 #define PMf_SINGLELINE  0x2000          /* assume single line */
300 #define PMf_FOLD        0x4000          /* case insensitivity */
301 #define PMf_EXTENDED    0x8000          /* chuck embedded whitespace */
302
303 /* mask of bits stored in regexp->reganch */
304 #define PMf_COMPILETIME (PMf_MULTILINE|PMf_SINGLELINE|PMf_LOCALE|PMf_FOLD|PMf_EXTENDED)
305
306 #ifdef USE_ITHREADS
307
308 #  define PmopSTASHPV(o)        ((o)->op_pmstashpv)
309 #  define PmopSTASHPV_set(o,pv) (PmopSTASHPV(o) = savesharedpv(pv))
310 #  define PmopSTASH(o)          (PmopSTASHPV(o) \
311                                  ? gv_stashpv(PmopSTASHPV(o),GV_ADD) : Nullhv)
312 #  define PmopSTASH_set(o,hv)   PmopSTASHPV_set(o, ((hv) ? HvNAME(hv) : Nullch))
313 #  define PmopSTASH_free(o)     PerlMemShared_free(PmopSTASHPV(o))
314
315 #else
316 #  define PmopSTASH(o)          ((o)->op_pmstash)
317 #  define PmopSTASH_set(o,hv)   ((o)->op_pmstash = (hv))
318 #  define PmopSTASHPV(o)        (PmopSTASH(o) ? HvNAME(PmopSTASH(o)) : Nullch)
319    /* op_pmstash is not refcounted */
320 #  define PmopSTASHPV_set(o,pv) PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
321 #  define PmopSTASH_free(o)    
322 #endif
323
324 struct svop {
325     BASEOP
326     SV *        op_sv;
327 };
328
329 struct padop {
330     BASEOP
331     PADOFFSET   op_padix;
332 };
333
334 struct pvop {
335     BASEOP
336     char *      op_pv;
337 };
338
339 struct loop {
340     BASEOP
341     OP *        op_first;
342     OP *        op_last;
343     OP *        op_redoop;
344     OP *        op_nextop;
345     OP *        op_lastop;
346 };
347
348 #define cUNOPx(o)       ((UNOP*)o)
349 #define cBINOPx(o)      ((BINOP*)o)
350 #define cLISTOPx(o)     ((LISTOP*)o)
351 #define cLOGOPx(o)      ((LOGOP*)o)
352 #define cPMOPx(o)       ((PMOP*)o)
353 #define cSVOPx(o)       ((SVOP*)o)
354 #define cPADOPx(o)      ((PADOP*)o)
355 #define cPVOPx(o)       ((PVOP*)o)
356 #define cCOPx(o)        ((COP*)o)
357 #define cLOOPx(o)       ((LOOP*)o)
358
359 #define cUNOP           cUNOPx(PL_op)
360 #define cBINOP          cBINOPx(PL_op)
361 #define cLISTOP         cLISTOPx(PL_op)
362 #define cLOGOP          cLOGOPx(PL_op)
363 #define cPMOP           cPMOPx(PL_op)
364 #define cSVOP           cSVOPx(PL_op)
365 #define cPADOP          cPADOPx(PL_op)
366 #define cPVOP           cPVOPx(PL_op)
367 #define cCOP            cCOPx(PL_op)
368 #define cLOOP           cLOOPx(PL_op)
369
370 #define cUNOPo          cUNOPx(o)
371 #define cBINOPo         cBINOPx(o)
372 #define cLISTOPo        cLISTOPx(o)
373 #define cLOGOPo         cLOGOPx(o)
374 #define cPMOPo          cPMOPx(o)
375 #define cSVOPo          cSVOPx(o)
376 #define cPADOPo         cPADOPx(o)
377 #define cPVOPo          cPVOPx(o)
378 #define cCOPo           cCOPx(o)
379 #define cLOOPo          cLOOPx(o)
380
381 #define kUNOP           cUNOPx(kid)
382 #define kBINOP          cBINOPx(kid)
383 #define kLISTOP         cLISTOPx(kid)
384 #define kLOGOP          cLOGOPx(kid)
385 #define kPMOP           cPMOPx(kid)
386 #define kSVOP           cSVOPx(kid)
387 #define kPADOP          cPADOPx(kid)
388 #define kPVOP           cPVOPx(kid)
389 #define kCOP            cCOPx(kid)
390 #define kLOOP           cLOOPx(kid)
391
392
393 #ifdef USE_ITHREADS
394 #  define       cGVOPx_gv(o)    ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
395 #  define       IS_PADGV(v)     (v && SvTYPE(v) == SVt_PVGV && GvIN_PAD(v))
396 #  define       IS_PADCONST(v)  (v && SvREADONLY(v))
397 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv \
398                                  ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
399 #  define       cSVOPx_svp(v)   (cSVOPx(v)->op_sv \
400                                  ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
401 #else
402 #  define       cGVOPx_gv(o)    ((GV*)cSVOPx(o)->op_sv)
403 #  define       IS_PADGV(v)     FALSE
404 #  define       IS_PADCONST(v)  FALSE
405 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv)
406 #  define       cSVOPx_svp(v)   (&cSVOPx(v)->op_sv)
407 #endif
408
409 #define cGVOP_gv                cGVOPx_gv(PL_op)
410 #define cGVOPo_gv               cGVOPx_gv(o)
411 #define kGVOP_gv                cGVOPx_gv(kid)
412 #define cSVOP_sv                cSVOPx_sv(PL_op)
413 #define cSVOPo_sv               cSVOPx_sv(o)
414 #define kSVOP_sv                cSVOPx_sv(kid)
415
416 #define Nullop Null(OP*)
417
418 /* Lowest byte-and-a-bit of PL_opargs */
419 #define OA_MARK 1
420 #define OA_FOLDCONST 2
421 #define OA_RETSCALAR 4
422 #define OA_TARGET 8
423 #define OA_RETINTEGER 16
424 #define OA_OTHERINT 32
425 #define OA_DANGEROUS 64
426 #define OA_DEFGV 128
427 #define OA_TARGLEX 256
428
429 /* The next 4 bits encode op class information */
430 #define OCSHIFT 9
431
432 #define OA_CLASS_MASK (15 << OCSHIFT)
433
434 #define OA_BASEOP (0 << OCSHIFT)
435 #define OA_UNOP (1 << OCSHIFT)
436 #define OA_BINOP (2 << OCSHIFT)
437 #define OA_LOGOP (3 << OCSHIFT)
438 #define OA_LISTOP (4 << OCSHIFT)
439 #define OA_PMOP (5 << OCSHIFT)
440 #define OA_SVOP (6 << OCSHIFT)
441 #define OA_PADOP (7 << OCSHIFT)
442 #define OA_PVOP_OR_SVOP (8 << OCSHIFT)
443 #define OA_LOOP (9 << OCSHIFT)
444 #define OA_COP (10 << OCSHIFT)
445 #define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
446 #define OA_FILESTATOP (12 << OCSHIFT)
447 #define OA_LOOPEXOP (13 << OCSHIFT)
448
449 #define OASHIFT 13
450
451 /* Remaining nybbles of PL_opargs */
452 #define OA_SCALAR 1
453 #define OA_LIST 2
454 #define OA_AVREF 3
455 #define OA_HVREF 4
456 #define OA_CVREF 5
457 #define OA_FILEREF 6
458 #define OA_SCALARREF 7
459 #define OA_OPTIONAL 8
460
461 #ifdef USE_ITHREADS
462 #  define OP_REFCNT_INIT                MUTEX_INIT(&PL_op_mutex)
463 #  define OP_REFCNT_LOCK                MUTEX_LOCK(&PL_op_mutex)
464 #  define OP_REFCNT_UNLOCK              MUTEX_UNLOCK(&PL_op_mutex)
465 #  define OP_REFCNT_TERM                MUTEX_DESTROY(&PL_op_mutex)
466 #else
467 #  define OP_REFCNT_INIT                NOOP
468 #  define OP_REFCNT_LOCK                NOOP
469 #  define OP_REFCNT_UNLOCK              NOOP
470 #  define OP_REFCNT_TERM                NOOP
471 #endif
472
473 #define OpREFCNT_set(o,n)               ((o)->op_targ = (n))
474 #define OpREFCNT_inc(o)                 ((o) ? (++(o)->op_targ, (o)) : Nullop)
475 #define OpREFCNT_dec(o)                 (--(o)->op_targ)
476
477 /* flags used by Perl_load_module() */
478 #define PERL_LOADMOD_DENY               0x1
479 #define PERL_LOADMOD_NOIMPORT           0x2
480 #define PERL_LOADMOD_IMPORT_OPS         0x4
481
482 #ifdef USE_REENTRANT_API
483 #include "reentr.h"
484 #endif
485