source: vendor/perl/5.8.8/op.h@ 3312

Last change on this file since 3312 was 3181, checked in by bird, 19 years ago

perl 5.8.8
File size: 15.9 KB
Line 
1/* op.h
2 *
3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005 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
57The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
58C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
59respectively.
60
61=for apidoc Amn|U32|GIMME
62A backward-compatible version of C<GIMME_V> which can only return
63C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
64Deprecated. 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[ACGHS]V, don't create GV--in
101 defined()*/
102 /* On OP_DBSTATE, indicates breakpoint
103 * (runtime property) */
104 /* On OP_AELEMFAST, indiciates pad var */
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_RV2GV, OP_RV2SV, OP_AELEM, OP_HELEM, OP_PADSV */
149#define OPpDEREF (32|64) /* autovivify: 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#define OPpENTERSUB_NOMOD 64 /* Immune to mod() for :attrlist. */
157 /* OP_RV2CV only */
158#define OPpENTERSUB_AMPER 8 /* Used & form to call. */
159#define OPpENTERSUB_NOPAREN 128 /* bare sub call (without parens) */
160#define OPpENTERSUB_INARGS 4 /* Lval used as arg to a sub. */
161 /* OP_GV only */
162#define OPpEARLY_CV 32 /* foo() called before sub foo was parsed */
163 /* OP_?ELEM only */
164#define OPpLVAL_DEFER 16 /* Defer creation of array/hash elem */
165 /* OP_RV2?V, OP_GVSV, OP_ENTERITER only */
166#define OPpOUR_INTRO 16 /* Variable was in an our() */
167 /* OP_RV2[AH]V, OP_PAD[AH]V, OP_[AH]ELEM */
168#define OPpMAYBE_LVSUB 8 /* We might be an lvalue to return */
169 /* for OP_RV2?V, lower bits carry hints (currently only HINT_STRICT_REFS) */
170
171/* Private for OPs with TARGLEX */
172 /* (lower bits may carry MAXARG) */
173#define OPpTARGET_MY 16 /* Target is PADMY. */
174
175/* Private for OP_ENTERITER and OP_ITER */
176#define OPpITER_REVERSED 4 /* for (reverse ...) */
177
178/* Private for OP_CONST */
179#define OPpCONST_SHORTCIRCUIT 4 /* eg the constant 5 in (5 || foo) */
180#define OPpCONST_STRICT 8 /* bearword subject to strict 'subs' */
181#define OPpCONST_ENTERED 16 /* Has been entered as symbol. */
182#define OPpCONST_ARYBASE 32 /* Was a $[ translated to constant. */
183#define OPpCONST_BARE 64 /* Was a bare word (filehandle?). */
184#define OPpCONST_WARNING 128 /* Was a $^W translated to constant. */
185
186/* Private for OP_FLIP/FLOP */
187#define OPpFLIP_LINENUM 64 /* Range arg potentially a line num. */
188
189/* Private for OP_LIST */
190#define OPpLIST_GUESSED 64 /* Guessed that pushmark was needed. */
191
192/* Private for OP_DELETE */
193#define OPpSLICE 64 /* Operating on a list of keys */
194
195/* Private for OP_EXISTS */
196#define OPpEXISTS_SUB 64 /* Checking for &sub, not {} or []. */
197
198/* Private for OP_SORT */
199#define OPpSORT_NUMERIC 1 /* Optimized away { $a <=> $b } */
200#define OPpSORT_INTEGER 2 /* Ditto while under "use integer" */
201#define OPpSORT_REVERSE 4 /* Reversed sort */
202#define OPpSORT_INPLACE 8 /* sort in-place; eg @a = sort @a */
203#define OPpSORT_DESCEND 16 /* Descending sort */
204/* Private for OP_THREADSV */
205#define OPpDONE_SVREF 64 /* Been through newSVREF once */
206
207/* Private for OP_OPEN and OP_BACKTICK */
208#define OPpOPEN_IN_RAW 16 /* binmode(F,":raw") on input fh */
209#define OPpOPEN_IN_CRLF 32 /* binmode(F,":crlf") on input fh */
210#define OPpOPEN_OUT_RAW 64 /* binmode(F,":raw") on output fh */
211#define OPpOPEN_OUT_CRLF 128 /* binmode(F,":crlf") on output fh */
212
213/* Private for OP_EXIT, HUSH also for OP_DIE */
214#define OPpHUSH_VMSISH 64 /* hush DCL exit msg vmsish mode*/
215#define OPpEXIT_VMSISH 128 /* exit(0) vs. exit(1) vmsish mode*/
216
217/* Private of OP_FTXXX */
218#define OPpFT_ACCESS 2 /* use filetest 'access' */
219#define OP_IS_FILETEST_ACCESS(op) \
220 (((op)->op_type) == OP_FTRREAD || \
221 ((op)->op_type) == OP_FTRWRITE || \
222 ((op)->op_type) == OP_FTREXEC || \
223 ((op)->op_type) == OP_FTEREAD || \
224 ((op)->op_type) == OP_FTEWRITE || \
225 ((op)->op_type) == OP_FTEEXEC)
226
227struct op {
228 BASEOP
229};
230
231struct unop {
232 BASEOP
233 OP * op_first;
234};
235
236struct binop {
237 BASEOP
238 OP * op_first;
239 OP * op_last;
240};
241
242struct logop {
243 BASEOP
244 OP * op_first;
245 OP * op_other;
246};
247
248struct listop {
249 BASEOP
250 OP * op_first;
251 OP * op_last;
252};
253
254struct pmop {
255 BASEOP
256 OP * op_first;
257 OP * op_last;
258 OP * op_pmreplroot; /* (type is really union {OP*,GV*,PADOFFSET}) */
259 OP * op_pmreplstart;
260 PMOP * op_pmnext; /* list of all scanpats */
261#ifdef USE_ITHREADS
262 IV op_pmoffset;
263#else
264 REGEXP * op_pmregexp; /* compiled expression */
265#endif
266 U32 op_pmflags;
267 U32 op_pmpermflags;
268 U8 op_pmdynflags;
269#ifdef USE_ITHREADS
270 char * op_pmstashpv;
271#else
272 HV * op_pmstash;
273#endif
274};
275
276#ifdef USE_ITHREADS
277#define PM_GETRE(o) (INT2PTR(REGEXP*,SvIVX(PL_regex_pad[(o)->op_pmoffset])))
278#define PM_SETRE(o,r) STMT_START { SV* sv = PL_regex_pad[(o)->op_pmoffset]; sv_setiv(sv, PTR2IV(r)); } STMT_END
279#define PM_GETRE_SAFE(o) (PL_regex_pad ? PM_GETRE(o) : (REGEXP*)0)
280#define PM_SETRE_SAFE(o,r) if (PL_regex_pad) PM_SETRE(o,r)
281#else
282#define PM_GETRE(o) ((o)->op_pmregexp)
283#define PM_SETRE(o,r) ((o)->op_pmregexp = (r))
284#define PM_GETRE_SAFE PM_GETRE
285#define PM_SETRE_SAFE PM_SETRE
286#endif
287
288#define PMdf_USED 0x01 /* pm has been used once already */
289#define PMdf_TAINTED 0x02 /* pm compiled from tainted pattern */
290#define PMdf_UTF8 0x04 /* pm compiled from utf8 data */
291#define PMdf_DYN_UTF8 0x08
292
293#define PMdf_CMP_UTF8 (PMdf_UTF8|PMdf_DYN_UTF8)
294
295#define PMf_RETAINT 0x0001 /* taint $1 etc. if target tainted */
296#define PMf_ONCE 0x0002 /* use pattern only once per reset */
297#define PMf_UNUSED 0x0004 /* free for use */
298#define PMf_MAYBE_CONST 0x0008 /* replacement contains variables */
299#define PMf_SKIPWHITE 0x0010 /* skip leading whitespace for split */
300#define PMf_WHITE 0x0020 /* pattern is \s+ */
301#define PMf_CONST 0x0040 /* subst replacement is constant */
302#define PMf_KEEP 0x0080 /* keep 1st runtime pattern forever */
303#define PMf_GLOBAL 0x0100 /* pattern had a g modifier */
304#define PMf_CONTINUE 0x0200 /* don't reset pos() if //g fails */
305#define PMf_EVAL 0x0400 /* evaluating replacement as expr */
306#define PMf_LOCALE 0x0800 /* use locale for character types */
307#define PMf_MULTILINE 0x1000 /* assume multiple lines */
308#define PMf_SINGLELINE 0x2000 /* assume single line */
309#define PMf_FOLD 0x4000 /* case insensitivity */
310#define PMf_EXTENDED 0x8000 /* chuck embedded whitespace */
311
312/* mask of bits stored in regexp->reganch */
313#define PMf_COMPILETIME (PMf_MULTILINE|PMf_SINGLELINE|PMf_LOCALE|PMf_FOLD|PMf_EXTENDED)
314
315#ifdef USE_ITHREADS
316
317# define PmopSTASHPV(o) ((o)->op_pmstashpv)
318# define PmopSTASHPV_set(o,pv) (PmopSTASHPV(o) = savesharedpv(pv))
319# define PmopSTASH(o) (PmopSTASHPV(o) \
320 ? gv_stashpv(PmopSTASHPV(o),GV_ADD) : Nullhv)
321# define PmopSTASH_set(o,hv) PmopSTASHPV_set(o, ((hv) ? HvNAME_get(hv) : Nullch))
322# define PmopSTASH_free(o) PerlMemShared_free(PmopSTASHPV(o))
323
324#else
325# define PmopSTASH(o) ((o)->op_pmstash)
326# define PmopSTASH_set(o,hv) ((o)->op_pmstash = (hv))
327# define PmopSTASHPV(o) (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : Nullch)
328 /* op_pmstash is not refcounted */
329# define PmopSTASHPV_set(o,pv) PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
330# define PmopSTASH_free(o)
331#endif
332
333struct svop {
334 BASEOP
335 SV * op_sv;
336};
337
338struct padop {
339 BASEOP
340 PADOFFSET op_padix;
341};
342
343struct pvop {
344 BASEOP
345 char * op_pv;
346};
347
348struct loop {
349 BASEOP
350 OP * op_first;
351 OP * op_last;
352 OP * op_redoop;
353 OP * op_nextop;
354 OP * op_lastop;
355};
356
357#define cUNOPx(o) ((UNOP*)o)
358#define cBINOPx(o) ((BINOP*)o)
359#define cLISTOPx(o) ((LISTOP*)o)
360#define cLOGOPx(o) ((LOGOP*)o)
361#define cPMOPx(o) ((PMOP*)o)
362#define cSVOPx(o) ((SVOP*)o)
363#define cPADOPx(o) ((PADOP*)o)
364#define cPVOPx(o) ((PVOP*)o)
365#define cCOPx(o) ((COP*)o)
366#define cLOOPx(o) ((LOOP*)o)
367
368#define cUNOP cUNOPx(PL_op)
369#define cBINOP cBINOPx(PL_op)
370#define cLISTOP cLISTOPx(PL_op)
371#define cLOGOP cLOGOPx(PL_op)
372#define cPMOP cPMOPx(PL_op)
373#define cSVOP cSVOPx(PL_op)
374#define cPADOP cPADOPx(PL_op)
375#define cPVOP cPVOPx(PL_op)
376#define cCOP cCOPx(PL_op)
377#define cLOOP cLOOPx(PL_op)
378
379#define cUNOPo cUNOPx(o)
380#define cBINOPo cBINOPx(o)
381#define cLISTOPo cLISTOPx(o)
382#define cLOGOPo cLOGOPx(o)
383#define cPMOPo cPMOPx(o)
384#define cSVOPo cSVOPx(o)
385#define cPADOPo cPADOPx(o)
386#define cPVOPo cPVOPx(o)
387#define cCOPo cCOPx(o)
388#define cLOOPo cLOOPx(o)
389
390#define kUNOP cUNOPx(kid)
391#define kBINOP cBINOPx(kid)
392#define kLISTOP cLISTOPx(kid)
393#define kLOGOP cLOGOPx(kid)
394#define kPMOP cPMOPx(kid)
395#define kSVOP cSVOPx(kid)
396#define kPADOP cPADOPx(kid)
397#define kPVOP cPVOPx(kid)
398#define kCOP cCOPx(kid)
399#define kLOOP cLOOPx(kid)
400
401
402#ifdef USE_ITHREADS
403# define cGVOPx_gv(o) ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
404# define IS_PADGV(v) (v && SvTYPE(v) == SVt_PVGV && GvIN_PAD(v))
405# define IS_PADCONST(v) (v && SvREADONLY(v))
406# define cSVOPx_sv(v) (cSVOPx(v)->op_sv \
407 ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
408# define cSVOPx_svp(v) (cSVOPx(v)->op_sv \
409 ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
410#else
411# define cGVOPx_gv(o) ((GV*)cSVOPx(o)->op_sv)
412# define IS_PADGV(v) FALSE
413# define IS_PADCONST(v) FALSE
414# define cSVOPx_sv(v) (cSVOPx(v)->op_sv)
415# define cSVOPx_svp(v) (&cSVOPx(v)->op_sv)
416#endif
417
418#define cGVOP_gv cGVOPx_gv(PL_op)
419#define cGVOPo_gv cGVOPx_gv(o)
420#define kGVOP_gv cGVOPx_gv(kid)
421#define cSVOP_sv cSVOPx_sv(PL_op)
422#define cSVOPo_sv cSVOPx_sv(o)
423#define kSVOP_sv cSVOPx_sv(kid)
424
425#define Nullop Null(OP*)
426
427/* Lowest byte-and-a-bit of PL_opargs */
428#define OA_MARK 1
429#define OA_FOLDCONST 2
430#define OA_RETSCALAR 4
431#define OA_TARGET 8
432#define OA_RETINTEGER 16
433#define OA_OTHERINT 32
434#define OA_DANGEROUS 64
435#define OA_DEFGV 128
436#define OA_TARGLEX 256
437
438/* The next 4 bits encode op class information */
439#define OCSHIFT 9
440
441#define OA_CLASS_MASK (15 << OCSHIFT)
442
443#define OA_BASEOP (0 << OCSHIFT)
444#define OA_UNOP (1 << OCSHIFT)
445#define OA_BINOP (2 << OCSHIFT)
446#define OA_LOGOP (3 << OCSHIFT)
447#define OA_LISTOP (4 << OCSHIFT)
448#define OA_PMOP (5 << OCSHIFT)
449#define OA_SVOP (6 << OCSHIFT)
450#define OA_PADOP (7 << OCSHIFT)
451#define OA_PVOP_OR_SVOP (8 << OCSHIFT)
452#define OA_LOOP (9 << OCSHIFT)
453#define OA_COP (10 << OCSHIFT)
454#define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
455#define OA_FILESTATOP (12 << OCSHIFT)
456#define OA_LOOPEXOP (13 << OCSHIFT)
457
458#define OASHIFT 13
459
460/* Remaining nybbles of PL_opargs */
461#define OA_SCALAR 1
462#define OA_LIST 2
463#define OA_AVREF 3
464#define OA_HVREF 4
465#define OA_CVREF 5
466#define OA_FILEREF 6
467#define OA_SCALARREF 7
468#define OA_OPTIONAL 8
469
470#ifdef USE_ITHREADS
471# define OP_REFCNT_INIT MUTEX_INIT(&PL_op_mutex)
472# ifdef PERL_CORE
473# define OP_REFCNT_LOCK MUTEX_LOCK(&PL_op_mutex)
474# define OP_REFCNT_UNLOCK MUTEX_UNLOCK(&PL_op_mutex)
475# else
476# define OP_REFCNT_LOCK op_refcnt_lock()
477# define OP_REFCNT_UNLOCK op_refcnt_unlock()
478# endif
479# define OP_REFCNT_TERM MUTEX_DESTROY(&PL_op_mutex)
480#else
481# define OP_REFCNT_INIT NOOP
482# define OP_REFCNT_LOCK NOOP
483# define OP_REFCNT_UNLOCK NOOP
484# define OP_REFCNT_TERM NOOP
485#endif
486
487#define OpREFCNT_set(o,n) ((o)->op_targ = (n))
488#define OpREFCNT_inc(o) ((o) ? (++(o)->op_targ, (o)) : Nullop)
489#define OpREFCNT_dec(o) (--(o)->op_targ)
490
491/* flags used by Perl_load_module() */
492#define PERL_LOADMOD_DENY 0x1
493#define PERL_LOADMOD_NOIMPORT 0x2
494#define PERL_LOADMOD_IMPORT_OPS 0x4
495
496#ifdef USE_REENTRANT_API
497#include "reentr.h"
498#endif
499
500#if defined(PL_OP_SLAB_ALLOC)
501#define NewOp(m,var,c,type) \
502 (var = (type *) Perl_Slab_Alloc(aTHX_ m,c*sizeof(type)))
503#define NewOpSz(m,var,size) \
504 (var = (OP *) Perl_Slab_Alloc(aTHX_ m,size))
505#define FreeOp(p) Perl_Slab_Free(aTHX_ p)
506#else
507#define NewOp(m, var, c, type) Newxz(var, c, type)
508#define NewOpSz(m, var, size) \
509 (var = (OP*)safemalloc(size), memzero(var, size))
510#define FreeOp(p) Safefree(p)
511#endif
Note: See TracBrowser for help on using the repository browser.