This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Assignment to \(@array)
[perl5.git] / op.c
1 #line 2 "op.c"
2 /*    op.c
3  *
4  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
5  *    2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
6  *
7  *    You may distribute under the terms of either the GNU General Public
8  *    License or the Artistic License, as specified in the README file.
9  *
10  */
11
12 /*
13  * 'You see: Mr. Drogo, he married poor Miss Primula Brandybuck.  She was
14  *  our Mr. Bilbo's first cousin on the mother's side (her mother being the
15  *  youngest of the Old Took's daughters); and Mr. Drogo was his second
16  *  cousin.  So Mr. Frodo is his first *and* second cousin, once removed
17  *  either way, as the saying is, if you follow me.'       --the Gaffer
18  *
19  *     [p.23 of _The Lord of the Rings_, I/i: "A Long-Expected Party"]
20  */
21
22 /* This file contains the functions that create, manipulate and optimize
23  * the OP structures that hold a compiled perl program.
24  *
25  * A Perl program is compiled into a tree of OPs. Each op contains
26  * structural pointers (eg to its siblings and the next op in the
27  * execution sequence), a pointer to the function that would execute the
28  * op, plus any data specific to that op. For example, an OP_CONST op
29  * points to the pp_const() function and to an SV containing the constant
30  * value. When pp_const() is executed, its job is to push that SV onto the
31  * stack.
32  *
33  * OPs are mainly created by the newFOO() functions, which are mainly
34  * called from the parser (in perly.y) as the code is parsed. For example
35  * the Perl code $a + $b * $c would cause the equivalent of the following
36  * to be called (oversimplifying a bit):
37  *
38  *  newBINOP(OP_ADD, flags,
39  *      newSVREF($a),
40  *      newBINOP(OP_MULTIPLY, flags, newSVREF($b), newSVREF($c))
41  *  )
42  *
43  * Note that during the build of miniperl, a temporary copy of this file
44  * is made, called opmini.c.
45  */
46
47 /*
48 Perl's compiler is essentially a 3-pass compiler with interleaved phases:
49
50     A bottom-up pass
51     A top-down pass
52     An execution-order pass
53
54 The bottom-up pass is represented by all the "newOP" routines and
55 the ck_ routines.  The bottom-upness is actually driven by yacc.
56 So at the point that a ck_ routine fires, we have no idea what the
57 context is, either upward in the syntax tree, or either forward or
58 backward in the execution order.  (The bottom-up parser builds that
59 part of the execution order it knows about, but if you follow the "next"
60 links around, you'll find it's actually a closed loop through the
61 top level node.)
62
63 Whenever the bottom-up parser gets to a node that supplies context to
64 its components, it invokes that portion of the top-down pass that applies
65 to that part of the subtree (and marks the top node as processed, so
66 if a node further up supplies context, it doesn't have to take the
67 plunge again).  As a particular subcase of this, as the new node is
68 built, it takes all the closed execution loops of its subcomponents
69 and links them into a new closed loop for the higher level node.  But
70 it's still not the real execution order.
71
72 The actual execution order is not known till we get a grammar reduction
73 to a top-level unit like a subroutine or file that will be called by
74 "name" rather than via a "next" pointer.  At that point, we can call
75 into peep() to do that code's portion of the 3rd pass.  It has to be
76 recursive, but it's recursive on basic blocks, not on tree nodes.
77 */
78
79 /* To implement user lexical pragmas, there needs to be a way at run time to
80    get the compile time state of %^H for that block.  Storing %^H in every
81    block (or even COP) would be very expensive, so a different approach is
82    taken.  The (running) state of %^H is serialised into a tree of HE-like
83    structs.  Stores into %^H are chained onto the current leaf as a struct
84    refcounted_he * with the key and the value.  Deletes from %^H are saved
85    with a value of PL_sv_placeholder.  The state of %^H at any point can be
86    turned back into a regular HV by walking back up the tree from that point's
87    leaf, ignoring any key you've already seen (placeholder or not), storing
88    the rest into the HV structure, then removing the placeholders. Hence
89    memory is only used to store the %^H deltas from the enclosing COP, rather
90    than the entire %^H on each COP.
91
92    To cause actions on %^H to write out the serialisation records, it has
93    magic type 'H'. This magic (itself) does nothing, but its presence causes
94    the values to gain magic type 'h', which has entries for set and clear.
95    C<Perl_magic_sethint> updates C<PL_compiling.cop_hints_hash> with a store
96    record, with deletes written by C<Perl_magic_clearhint>. C<SAVEHINTS>
97    saves the current C<PL_compiling.cop_hints_hash> on the save stack, so that
98    it will be correctly restored when any inner compiling scope is exited.
99 */
100
101 #include "EXTERN.h"
102 #define PERL_IN_OP_C
103 #include "perl.h"
104 #include "keywords.h"
105 #include "feature.h"
106 #include "regcomp.h"
107
108 #define CALL_PEEP(o) PL_peepp(aTHX_ o)
109 #define CALL_RPEEP(o) PL_rpeepp(aTHX_ o)
110 #define CALL_OPFREEHOOK(o) if (PL_opfreehook) PL_opfreehook(aTHX_ o)
111
112 /* remove any leading "empty" ops from the op_next chain whose first
113  * node's address is stored in op_p. Store the updated address of the
114  * first node in op_p.
115  */
116
117 STATIC void
118 S_prune_chain_head(OP** op_p)
119 {
120     while (*op_p
121         && (   (*op_p)->op_type == OP_NULL
122             || (*op_p)->op_type == OP_SCOPE
123             || (*op_p)->op_type == OP_SCALAR
124             || (*op_p)->op_type == OP_LINESEQ)
125     )
126         *op_p = (*op_p)->op_next;
127 }
128
129
130 /* See the explanatory comments above struct opslab in op.h. */
131
132 #ifdef PERL_DEBUG_READONLY_OPS
133 #  define PERL_SLAB_SIZE 128
134 #  define PERL_MAX_SLAB_SIZE 4096
135 #  include <sys/mman.h>
136 #endif
137
138 #ifndef PERL_SLAB_SIZE
139 #  define PERL_SLAB_SIZE 64
140 #endif
141 #ifndef PERL_MAX_SLAB_SIZE
142 #  define PERL_MAX_SLAB_SIZE 2048
143 #endif
144
145 /* rounds up to nearest pointer */
146 #define SIZE_TO_PSIZE(x)        (((x) + sizeof(I32 *) - 1)/sizeof(I32 *))
147 #define DIFF(o,p)               ((size_t)((I32 **)(p) - (I32**)(o)))
148
149 static OPSLAB *
150 S_new_slab(pTHX_ size_t sz)
151 {
152 #ifdef PERL_DEBUG_READONLY_OPS
153     OPSLAB *slab = (OPSLAB *) mmap(0, sz * sizeof(I32 *),
154                                    PROT_READ|PROT_WRITE,
155                                    MAP_ANON|MAP_PRIVATE, -1, 0);
156     DEBUG_m(PerlIO_printf(Perl_debug_log, "mapped %lu at %p\n",
157                           (unsigned long) sz, slab));
158     if (slab == MAP_FAILED) {
159         perror("mmap failed");
160         abort();
161     }
162     slab->opslab_size = (U16)sz;
163 #else
164     OPSLAB *slab = (OPSLAB *)PerlMemShared_calloc(sz, sizeof(I32 *));
165 #endif
166 #ifndef WIN32
167     /* The context is unused in non-Windows */
168     PERL_UNUSED_CONTEXT;
169 #endif
170     slab->opslab_first = (OPSLOT *)((I32 **)slab + sz - 1);
171     return slab;
172 }
173
174 /* requires double parens and aTHX_ */
175 #define DEBUG_S_warn(args)                                             \
176     DEBUG_S(                                                            \
177         PerlIO_printf(Perl_debug_log, "%s", SvPVx_nolen(Perl_mess args)) \
178     )
179
180 void *
181 Perl_Slab_Alloc(pTHX_ size_t sz)
182 {
183     OPSLAB *slab;
184     OPSLAB *slab2;
185     OPSLOT *slot;
186     OP *o;
187     size_t opsz, space;
188
189     /* We only allocate ops from the slab during subroutine compilation.
190        We find the slab via PL_compcv, hence that must be non-NULL. It could
191        also be pointing to a subroutine which is now fully set up (CvROOT()
192        pointing to the top of the optree for that sub), or a subroutine
193        which isn't using the slab allocator. If our sanity checks aren't met,
194        don't use a slab, but allocate the OP directly from the heap.  */
195     if (!PL_compcv || CvROOT(PL_compcv)
196      || (CvSTART(PL_compcv) && !CvSLABBED(PL_compcv)))
197     {
198         o = (OP*)PerlMemShared_calloc(1, sz);
199         goto gotit;
200     }
201
202     /* While the subroutine is under construction, the slabs are accessed via
203        CvSTART(), to avoid needing to expand PVCV by one pointer for something
204        unneeded at runtime. Once a subroutine is constructed, the slabs are
205        accessed via CvROOT(). So if CvSTART() is NULL, no slab has been
206        allocated yet.  See the commit message for 8be227ab5eaa23f2 for more
207        details.  */
208     if (!CvSTART(PL_compcv)) {
209         CvSTART(PL_compcv) =
210             (OP *)(slab = S_new_slab(aTHX_ PERL_SLAB_SIZE));
211         CvSLABBED_on(PL_compcv);
212         slab->opslab_refcnt = 2; /* one for the CV; one for the new OP */
213     }
214     else ++(slab = (OPSLAB *)CvSTART(PL_compcv))->opslab_refcnt;
215
216     opsz = SIZE_TO_PSIZE(sz);
217     sz = opsz + OPSLOT_HEADER_P;
218
219     /* The slabs maintain a free list of OPs. In particular, constant folding
220        will free up OPs, so it makes sense to re-use them where possible. A
221        freed up slot is used in preference to a new allocation.  */
222     if (slab->opslab_freed) {
223         OP **too = &slab->opslab_freed;
224         o = *too;
225         DEBUG_S_warn((aTHX_ "found free op at %p, slab %p", (void*)o, (void*)slab));
226         while (o && DIFF(OpSLOT(o), OpSLOT(o)->opslot_next) < sz) {
227             DEBUG_S_warn((aTHX_ "Alas! too small"));
228             o = *(too = &o->op_next);
229             if (o) { DEBUG_S_warn((aTHX_ "found another free op at %p", (void*)o)); }
230         }
231         if (o) {
232             *too = o->op_next;
233             Zero(o, opsz, I32 *);
234             o->op_slabbed = 1;
235             goto gotit;
236         }
237     }
238
239 #define INIT_OPSLOT \
240             slot->opslot_slab = slab;                   \
241             slot->opslot_next = slab2->opslab_first;    \
242             slab2->opslab_first = slot;                 \
243             o = &slot->opslot_op;                       \
244             o->op_slabbed = 1
245
246     /* The partially-filled slab is next in the chain. */
247     slab2 = slab->opslab_next ? slab->opslab_next : slab;
248     if ((space = DIFF(&slab2->opslab_slots, slab2->opslab_first)) < sz) {
249         /* Remaining space is too small. */
250
251         /* If we can fit a BASEOP, add it to the free chain, so as not
252            to waste it. */
253         if (space >= SIZE_TO_PSIZE(sizeof(OP)) + OPSLOT_HEADER_P) {
254             slot = &slab2->opslab_slots;
255             INIT_OPSLOT;
256             o->op_type = OP_FREED;
257             o->op_next = slab->opslab_freed;
258             slab->opslab_freed = o;
259         }
260
261         /* Create a new slab.  Make this one twice as big. */
262         slot = slab2->opslab_first;
263         while (slot->opslot_next) slot = slot->opslot_next;
264         slab2 = S_new_slab(aTHX_
265                             (DIFF(slab2, slot)+1)*2 > PERL_MAX_SLAB_SIZE
266                                         ? PERL_MAX_SLAB_SIZE
267                                         : (DIFF(slab2, slot)+1)*2);
268         slab2->opslab_next = slab->opslab_next;
269         slab->opslab_next = slab2;
270     }
271     assert(DIFF(&slab2->opslab_slots, slab2->opslab_first) >= sz);
272
273     /* Create a new op slot */
274     slot = (OPSLOT *)((I32 **)slab2->opslab_first - sz);
275     assert(slot >= &slab2->opslab_slots);
276     if (DIFF(&slab2->opslab_slots, slot)
277          < SIZE_TO_PSIZE(sizeof(OP)) + OPSLOT_HEADER_P)
278         slot = &slab2->opslab_slots;
279     INIT_OPSLOT;
280     DEBUG_S_warn((aTHX_ "allocating op at %p, slab %p", (void*)o, (void*)slab));
281
282   gotit:
283     /* lastsib == 1, op_sibling == 0 implies a solitary unattached op */
284     o->op_lastsib = 1;
285     assert(!o->op_sibling);
286
287     return (void *)o;
288 }
289
290 #undef INIT_OPSLOT
291
292 #ifdef PERL_DEBUG_READONLY_OPS
293 void
294 Perl_Slab_to_ro(pTHX_ OPSLAB *slab)
295 {
296     PERL_ARGS_ASSERT_SLAB_TO_RO;
297
298     if (slab->opslab_readonly) return;
299     slab->opslab_readonly = 1;
300     for (; slab; slab = slab->opslab_next) {
301         /*DEBUG_U(PerlIO_printf(Perl_debug_log,"mprotect ->ro %lu at %p\n",
302                               (unsigned long) slab->opslab_size, slab));*/
303         if (mprotect(slab, slab->opslab_size * sizeof(I32 *), PROT_READ))
304             Perl_warn(aTHX_ "mprotect for %p %lu failed with %d", slab,
305                              (unsigned long)slab->opslab_size, errno);
306     }
307 }
308
309 void
310 Perl_Slab_to_rw(pTHX_ OPSLAB *const slab)
311 {
312     OPSLAB *slab2;
313
314     PERL_ARGS_ASSERT_SLAB_TO_RW;
315
316     if (!slab->opslab_readonly) return;
317     slab2 = slab;
318     for (; slab2; slab2 = slab2->opslab_next) {
319         /*DEBUG_U(PerlIO_printf(Perl_debug_log,"mprotect ->rw %lu at %p\n",
320                               (unsigned long) size, slab2));*/
321         if (mprotect((void *)slab2, slab2->opslab_size * sizeof(I32 *),
322                      PROT_READ|PROT_WRITE)) {
323             Perl_warn(aTHX_ "mprotect RW for %p %lu failed with %d", slab,
324                              (unsigned long)slab2->opslab_size, errno);
325         }
326     }
327     slab->opslab_readonly = 0;
328 }
329
330 #else
331 #  define Slab_to_rw(op)    NOOP
332 #endif
333
334 /* This cannot possibly be right, but it was copied from the old slab
335    allocator, to which it was originally added, without explanation, in
336    commit 083fcd5. */
337 #ifdef NETWARE
338 #    define PerlMemShared PerlMem
339 #endif
340
341 void
342 Perl_Slab_Free(pTHX_ void *op)
343 {
344     OP * const o = (OP *)op;
345     OPSLAB *slab;
346
347     PERL_ARGS_ASSERT_SLAB_FREE;
348
349     if (!o->op_slabbed) {
350         if (!o->op_static)
351             PerlMemShared_free(op);
352         return;
353     }
354
355     slab = OpSLAB(o);
356     /* If this op is already freed, our refcount will get screwy. */
357     assert(o->op_type != OP_FREED);
358     o->op_type = OP_FREED;
359     o->op_next = slab->opslab_freed;
360     slab->opslab_freed = o;
361     DEBUG_S_warn((aTHX_ "free op at %p, recorded in slab %p", (void*)o, (void*)slab));
362     OpslabREFCNT_dec_padok(slab);
363 }
364
365 void
366 Perl_opslab_free_nopad(pTHX_ OPSLAB *slab)
367 {
368     const bool havepad = !!PL_comppad;
369     PERL_ARGS_ASSERT_OPSLAB_FREE_NOPAD;
370     if (havepad) {
371         ENTER;
372         PAD_SAVE_SETNULLPAD();
373     }
374     opslab_free(slab);
375     if (havepad) LEAVE;
376 }
377
378 void
379 Perl_opslab_free(pTHX_ OPSLAB *slab)
380 {
381     OPSLAB *slab2;
382     PERL_ARGS_ASSERT_OPSLAB_FREE;
383     PERL_UNUSED_CONTEXT;
384     DEBUG_S_warn((aTHX_ "freeing slab %p", (void*)slab));
385     assert(slab->opslab_refcnt == 1);
386     for (; slab; slab = slab2) {
387         slab2 = slab->opslab_next;
388 #ifdef DEBUGGING
389         slab->opslab_refcnt = ~(size_t)0;
390 #endif
391 #ifdef PERL_DEBUG_READONLY_OPS
392         DEBUG_m(PerlIO_printf(Perl_debug_log, "Deallocate slab at %p\n",
393                                                (void*)slab));
394         if (munmap(slab, slab->opslab_size * sizeof(I32 *))) {
395             perror("munmap failed");
396             abort();
397         }
398 #else
399         PerlMemShared_free(slab);
400 #endif
401     }
402 }
403
404 void
405 Perl_opslab_force_free(pTHX_ OPSLAB *slab)
406 {
407     OPSLAB *slab2;
408     OPSLOT *slot;
409 #ifdef DEBUGGING
410     size_t savestack_count = 0;
411 #endif
412     PERL_ARGS_ASSERT_OPSLAB_FORCE_FREE;
413     slab2 = slab;
414     do {
415         for (slot = slab2->opslab_first;
416              slot->opslot_next;
417              slot = slot->opslot_next) {
418             if (slot->opslot_op.op_type != OP_FREED
419              && !(slot->opslot_op.op_savefree
420 #ifdef DEBUGGING
421                   && ++savestack_count
422 #endif
423                  )
424             ) {
425                 assert(slot->opslot_op.op_slabbed);
426                 op_free(&slot->opslot_op);
427                 if (slab->opslab_refcnt == 1) goto free;
428             }
429         }
430     } while ((slab2 = slab2->opslab_next));
431     /* > 1 because the CV still holds a reference count. */
432     if (slab->opslab_refcnt > 1) { /* still referenced by the savestack */
433 #ifdef DEBUGGING
434         assert(savestack_count == slab->opslab_refcnt-1);
435 #endif
436         /* Remove the CV’s reference count. */
437         slab->opslab_refcnt--;
438         return;
439     }
440    free:
441     opslab_free(slab);
442 }
443
444 #ifdef PERL_DEBUG_READONLY_OPS
445 OP *
446 Perl_op_refcnt_inc(pTHX_ OP *o)
447 {
448     if(o) {
449         OPSLAB *const slab = o->op_slabbed ? OpSLAB(o) : NULL;
450         if (slab && slab->opslab_readonly) {
451             Slab_to_rw(slab);
452             ++o->op_targ;
453             Slab_to_ro(slab);
454         } else {
455             ++o->op_targ;
456         }
457     }
458     return o;
459
460 }
461
462 PADOFFSET
463 Perl_op_refcnt_dec(pTHX_ OP *o)
464 {
465     PADOFFSET result;
466     OPSLAB *const slab = o->op_slabbed ? OpSLAB(o) : NULL;
467
468     PERL_ARGS_ASSERT_OP_REFCNT_DEC;
469
470     if (slab && slab->opslab_readonly) {
471         Slab_to_rw(slab);
472         result = --o->op_targ;
473         Slab_to_ro(slab);
474     } else {
475         result = --o->op_targ;
476     }
477     return result;
478 }
479 #endif
480 /*
481  * In the following definition, the ", (OP*)0" is just to make the compiler
482  * think the expression is of the right type: croak actually does a Siglongjmp.
483  */
484 #define CHECKOP(type,o) \
485     ((PL_op_mask && PL_op_mask[type])                           \
486      ? ( op_free((OP*)o),                                       \
487          Perl_croak(aTHX_ "'%s' trapped by operation mask", PL_op_desc[type]),  \
488          (OP*)0 )                                               \
489      : PL_check[type](aTHX_ (OP*)o))
490
491 #define RETURN_UNLIMITED_NUMBER (PERL_INT_MAX / 2)
492
493 #define CHANGE_TYPE(o,type) \
494     STMT_START {                                \
495         o->op_type = (OPCODE)type;              \
496         o->op_ppaddr = PL_ppaddr[type];         \
497     } STMT_END
498
499 STATIC OP *
500 S_no_fh_allowed(pTHX_ OP *o)
501 {
502     PERL_ARGS_ASSERT_NO_FH_ALLOWED;
503
504     yyerror(Perl_form(aTHX_ "Missing comma after first argument to %s function",
505                  OP_DESC(o)));
506     return o;
507 }
508
509 STATIC OP *
510 S_too_few_arguments_pv(pTHX_ OP *o, const char* name, U32 flags)
511 {
512     PERL_ARGS_ASSERT_TOO_FEW_ARGUMENTS_PV;
513     yyerror_pv(Perl_form(aTHX_ "Not enough arguments for %s", name), flags);
514     return o;
515 }
516  
517 STATIC OP *
518 S_too_many_arguments_pv(pTHX_ OP *o, const char *name, U32 flags)
519 {
520     PERL_ARGS_ASSERT_TOO_MANY_ARGUMENTS_PV;
521
522     yyerror_pv(Perl_form(aTHX_ "Too many arguments for %s", name), flags);
523     return o;
524 }
525
526 STATIC void
527 S_bad_type_pv(pTHX_ I32 n, const char *t, const char *name, U32 flags, const OP *kid)
528 {
529     PERL_ARGS_ASSERT_BAD_TYPE_PV;
530
531     yyerror_pv(Perl_form(aTHX_ "Type of arg %d to %s must be %s (not %s)",
532                  (int)n, name, t, OP_DESC(kid)), flags);
533 }
534
535 STATIC void
536 S_bad_type_gv(pTHX_ I32 n, const char *t, GV *gv, U32 flags, const OP *kid)
537 {
538     SV * const namesv = cv_name((CV *)gv, NULL, 0);
539     PERL_ARGS_ASSERT_BAD_TYPE_GV;
540  
541     yyerror_pv(Perl_form(aTHX_ "Type of arg %d to %"SVf" must be %s (not %s)",
542                  (int)n, SVfARG(namesv), t, OP_DESC(kid)), SvUTF8(namesv) | flags);
543 }
544
545 STATIC void
546 S_no_bareword_allowed(pTHX_ OP *o)
547 {
548     PERL_ARGS_ASSERT_NO_BAREWORD_ALLOWED;
549
550     qerror(Perl_mess(aTHX_
551                      "Bareword \"%"SVf"\" not allowed while \"strict subs\" in use",
552                      SVfARG(cSVOPo_sv)));
553     o->op_private &= ~OPpCONST_STRICT; /* prevent warning twice about the same OP */
554 }
555
556 /* "register" allocation */
557
558 PADOFFSET
559 Perl_allocmy(pTHX_ const char *const name, const STRLEN len, const U32 flags)
560 {
561     PADOFFSET off;
562     const bool is_our = (PL_parser->in_my == KEY_our);
563
564     PERL_ARGS_ASSERT_ALLOCMY;
565
566     if (flags & ~SVf_UTF8)
567         Perl_croak(aTHX_ "panic: allocmy illegal flag bits 0x%" UVxf,
568                    (UV)flags);
569
570     /* complain about "my $<special_var>" etc etc */
571     if (len &&
572         !(is_our ||
573           isALPHA(name[1]) ||
574           ((flags & SVf_UTF8) && isIDFIRST_utf8((U8 *)name+1)) ||
575           (name[1] == '_' && (*name == '$' || len > 2))))
576     {
577         if (!(flags & SVf_UTF8 && UTF8_IS_START(name[1]))
578          && (!isPRINT(name[1]) || strchr("\t\n\r\f", name[1]))) {
579             yyerror(Perl_form(aTHX_ "Can't use global %c^%c%.*s in \"%s\"",
580                               name[0], toCTRL(name[1]), (int)(len - 2), name + 2,
581                               PL_parser->in_my == KEY_state ? "state" : "my"));
582         } else {
583             yyerror_pv(Perl_form(aTHX_ "Can't use global %.*s in \"%s\"", (int) len, name,
584                               PL_parser->in_my == KEY_state ? "state" : "my"), flags & SVf_UTF8);
585         }
586     }
587     else if (len == 2 && name[1] == '_' && !is_our)
588         /* diag_listed_as: Use of my $_ is experimental */
589         Perl_ck_warner_d(aTHX_ packWARN(WARN_EXPERIMENTAL__LEXICAL_TOPIC),
590                               "Use of %s $_ is experimental",
591                                PL_parser->in_my == KEY_state
592                                  ? "state"
593                                  : "my");
594
595     /* allocate a spare slot and store the name in that slot */
596
597     off = pad_add_name_pvn(name, len,
598                        (is_our ? padadd_OUR :
599                         PL_parser->in_my == KEY_state ? padadd_STATE : 0)
600                             | ( flags & SVf_UTF8 ? SVf_UTF8 : 0 ),
601                     PL_parser->in_my_stash,
602                     (is_our
603                         /* $_ is always in main::, even with our */
604                         ? (PL_curstash && !memEQs(name,len,"$_")
605                             ? PL_curstash
606                             : PL_defstash)
607                         : NULL
608                     )
609     );
610     /* anon sub prototypes contains state vars should always be cloned,
611      * otherwise the state var would be shared between anon subs */
612
613     if (PL_parser->in_my == KEY_state && CvANON(PL_compcv))
614         CvCLONE_on(PL_compcv);
615
616     return off;
617 }
618
619 /*
620 =head1 Optree Manipulation Functions
621
622 =for apidoc alloccopstash
623
624 Available only under threaded builds, this function allocates an entry in
625 C<PL_stashpad> for the stash passed to it.
626
627 =cut
628 */
629
630 #ifdef USE_ITHREADS
631 PADOFFSET
632 Perl_alloccopstash(pTHX_ HV *hv)
633 {
634     PADOFFSET off = 0, o = 1;
635     bool found_slot = FALSE;
636
637     PERL_ARGS_ASSERT_ALLOCCOPSTASH;
638
639     if (PL_stashpad[PL_stashpadix] == hv) return PL_stashpadix;
640
641     for (; o < PL_stashpadmax; ++o) {
642         if (PL_stashpad[o] == hv) return PL_stashpadix = o;
643         if (!PL_stashpad[o] || SvTYPE(PL_stashpad[o]) != SVt_PVHV)
644             found_slot = TRUE, off = o;
645     }
646     if (!found_slot) {
647         Renew(PL_stashpad, PL_stashpadmax + 10, HV *);
648         Zero(PL_stashpad + PL_stashpadmax, 10, HV *);
649         off = PL_stashpadmax;
650         PL_stashpadmax += 10;
651     }
652
653     PL_stashpad[PL_stashpadix = off] = hv;
654     return off;
655 }
656 #endif
657
658 /* free the body of an op without examining its contents.
659  * Always use this rather than FreeOp directly */
660
661 static void
662 S_op_destroy(pTHX_ OP *o)
663 {
664     FreeOp(o);
665 }
666
667 /* Destructor */
668
669 /*
670 =for apidoc Am|void|op_free|OP *o
671
672 Free an op.  Only use this when an op is no longer linked to from any
673 optree.
674
675 =cut
676 */
677
678 void
679 Perl_op_free(pTHX_ OP *o)
680 {
681 #ifdef USE_ITHREADS
682     dVAR;
683 #endif
684     OPCODE type;
685
686     /* Though ops may be freed twice, freeing the op after its slab is a
687        big no-no. */
688     assert(!o || !o->op_slabbed || OpSLAB(o)->opslab_refcnt != ~(size_t)0); 
689     /* During the forced freeing of ops after compilation failure, kidops
690        may be freed before their parents. */
691     if (!o || o->op_type == OP_FREED)
692         return;
693
694     type = o->op_type;
695
696     /* an op should only ever acquire op_private flags that we know about.
697      * If this fails, you may need to fix something in regen/op_private */
698     assert(!(o->op_private & ~PL_op_private_valid[type]));
699
700     if (o->op_private & OPpREFCOUNTED) {
701         switch (type) {
702         case OP_LEAVESUB:
703         case OP_LEAVESUBLV:
704         case OP_LEAVEEVAL:
705         case OP_LEAVE:
706         case OP_SCOPE:
707         case OP_LEAVEWRITE:
708             {
709             PADOFFSET refcnt;
710             OP_REFCNT_LOCK;
711             refcnt = OpREFCNT_dec(o);
712             OP_REFCNT_UNLOCK;
713             if (refcnt) {
714                 /* Need to find and remove any pattern match ops from the list
715                    we maintain for reset().  */
716                 find_and_forget_pmops(o);
717                 return;
718             }
719             }
720             break;
721         default:
722             break;
723         }
724     }
725
726     /* Call the op_free hook if it has been set. Do it now so that it's called
727      * at the right time for refcounted ops, but still before all of the kids
728      * are freed. */
729     CALL_OPFREEHOOK(o);
730
731     if (o->op_flags & OPf_KIDS) {
732         OP *kid, *nextkid;
733         for (kid = cUNOPo->op_first; kid; kid = nextkid) {
734             nextkid = OP_SIBLING(kid); /* Get before next freeing kid */
735             op_free(kid);
736         }
737     }
738     if (type == OP_NULL)
739         type = (OPCODE)o->op_targ;
740
741     if (o->op_slabbed)
742         Slab_to_rw(OpSLAB(o));
743
744     /* COP* is not cleared by op_clear() so that we may track line
745      * numbers etc even after null() */
746     if (type == OP_NEXTSTATE || type == OP_DBSTATE) {
747         cop_free((COP*)o);
748     }
749
750     op_clear(o);
751     FreeOp(o);
752 #ifdef DEBUG_LEAKING_SCALARS
753     if (PL_op == o)
754         PL_op = NULL;
755 #endif
756 }
757
758 void
759 Perl_op_clear(pTHX_ OP *o)
760 {
761
762     dVAR;
763
764     PERL_ARGS_ASSERT_OP_CLEAR;
765
766     switch (o->op_type) {
767     case OP_NULL:       /* Was holding old type, if any. */
768         /* FALLTHROUGH */
769     case OP_ENTERTRY:
770     case OP_ENTEREVAL:  /* Was holding hints. */
771         o->op_targ = 0;
772         break;
773     default:
774         if (!(o->op_flags & OPf_REF)
775             || (PL_check[o->op_type] != Perl_ck_ftst))
776             break;
777         /* FALLTHROUGH */
778     case OP_GVSV:
779     case OP_GV:
780     case OP_AELEMFAST:
781         {
782             GV *gv = (o->op_type == OP_GV || o->op_type == OP_GVSV)
783 #ifdef USE_ITHREADS
784                         && PL_curpad
785 #endif
786                         ? cGVOPo_gv : NULL;
787             /* It's possible during global destruction that the GV is freed
788                before the optree. Whilst the SvREFCNT_inc is happy to bump from
789                0 to 1 on a freed SV, the corresponding SvREFCNT_dec from 1 to 0
790                will trigger an assertion failure, because the entry to sv_clear
791                checks that the scalar is not already freed.  A check of for
792                !SvIS_FREED(gv) turns out to be invalid, because during global
793                destruction the reference count can be forced down to zero
794                (with SVf_BREAK set).  In which case raising to 1 and then
795                dropping to 0 triggers cleanup before it should happen.  I
796                *think* that this might actually be a general, systematic,
797                weakness of the whole idea of SVf_BREAK, in that code *is*
798                allowed to raise and lower references during global destruction,
799                so any *valid* code that happens to do this during global
800                destruction might well trigger premature cleanup.  */
801             bool still_valid = gv && SvREFCNT(gv);
802
803             if (still_valid)
804                 SvREFCNT_inc_simple_void(gv);
805 #ifdef USE_ITHREADS
806             if (cPADOPo->op_padix > 0) {
807                 pad_swipe(cPADOPo->op_padix, TRUE);
808                 cPADOPo->op_padix = 0;
809             }
810 #else
811             SvREFCNT_dec(cSVOPo->op_sv);
812             cSVOPo->op_sv = NULL;
813 #endif
814             if (still_valid) {
815                 int try_downgrade = SvREFCNT(gv) == 2;
816                 SvREFCNT_dec_NN(gv);
817                 if (try_downgrade)
818                     gv_try_downgrade(gv);
819             }
820         }
821         break;
822     case OP_METHOD_NAMED:
823         SvREFCNT_dec(cMETHOPx(o)->op_u.op_meth_sv);
824         cMETHOPx(o)->op_u.op_meth_sv = NULL;
825 #ifdef USE_ITHREADS
826         if (o->op_targ) {
827             pad_swipe(o->op_targ, 1);
828             o->op_targ = 0;
829         }
830 #endif
831         break;
832     case OP_CONST:
833     case OP_HINTSEVAL:
834         SvREFCNT_dec(cSVOPo->op_sv);
835         cSVOPo->op_sv = NULL;
836 #ifdef USE_ITHREADS
837         /** Bug #15654
838           Even if op_clear does a pad_free for the target of the op,
839           pad_free doesn't actually remove the sv that exists in the pad;
840           instead it lives on. This results in that it could be reused as 
841           a target later on when the pad was reallocated.
842         **/
843         if(o->op_targ) {
844           pad_swipe(o->op_targ,1);
845           o->op_targ = 0;
846         }
847 #endif
848         break;
849     case OP_DUMP:
850     case OP_GOTO:
851     case OP_NEXT:
852     case OP_LAST:
853     case OP_REDO:
854         if (o->op_flags & (OPf_SPECIAL|OPf_STACKED|OPf_KIDS))
855             break;
856         /* FALLTHROUGH */
857     case OP_TRANS:
858     case OP_TRANSR:
859         if (o->op_private & (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF)) {
860             assert(o->op_type == OP_TRANS || o->op_type == OP_TRANSR);
861 #ifdef USE_ITHREADS
862             if (cPADOPo->op_padix > 0) {
863                 pad_swipe(cPADOPo->op_padix, TRUE);
864                 cPADOPo->op_padix = 0;
865             }
866 #else
867             SvREFCNT_dec(cSVOPo->op_sv);
868             cSVOPo->op_sv = NULL;
869 #endif
870         }
871         else {
872             PerlMemShared_free(cPVOPo->op_pv);
873             cPVOPo->op_pv = NULL;
874         }
875         break;
876     case OP_SUBST:
877         op_free(cPMOPo->op_pmreplrootu.op_pmreplroot);
878         goto clear_pmop;
879     case OP_PUSHRE:
880 #ifdef USE_ITHREADS
881         if (cPMOPo->op_pmreplrootu.op_pmtargetoff) {
882             pad_swipe(cPMOPo->op_pmreplrootu.op_pmtargetoff, TRUE);
883         }
884 #else
885         SvREFCNT_dec(MUTABLE_SV(cPMOPo->op_pmreplrootu.op_pmtargetgv));
886 #endif
887         /* FALLTHROUGH */
888     case OP_MATCH:
889     case OP_QR:
890 clear_pmop:
891         if (!(cPMOPo->op_pmflags & PMf_CODELIST_PRIVATE))
892             op_free(cPMOPo->op_code_list);
893         cPMOPo->op_code_list = NULL;
894         forget_pmop(cPMOPo);
895         cPMOPo->op_pmreplrootu.op_pmreplroot = NULL;
896         /* we use the same protection as the "SAFE" version of the PM_ macros
897          * here since sv_clean_all might release some PMOPs
898          * after PL_regex_padav has been cleared
899          * and the clearing of PL_regex_padav needs to
900          * happen before sv_clean_all
901          */
902 #ifdef USE_ITHREADS
903         if(PL_regex_pad) {        /* We could be in destruction */
904             const IV offset = (cPMOPo)->op_pmoffset;
905             ReREFCNT_dec(PM_GETRE(cPMOPo));
906             PL_regex_pad[offset] = &PL_sv_undef;
907             sv_catpvn_nomg(PL_regex_pad[0], (const char *)&offset,
908                            sizeof(offset));
909         }
910 #else
911         ReREFCNT_dec(PM_GETRE(cPMOPo));
912         PM_SETRE(cPMOPo, NULL);
913 #endif
914
915         break;
916     }
917
918     if (o->op_targ > 0) {
919         pad_free(o->op_targ);
920         o->op_targ = 0;
921     }
922 }
923
924 STATIC void
925 S_cop_free(pTHX_ COP* cop)
926 {
927     PERL_ARGS_ASSERT_COP_FREE;
928
929     CopFILE_free(cop);
930     if (! specialWARN(cop->cop_warnings))
931         PerlMemShared_free(cop->cop_warnings);
932     cophh_free(CopHINTHASH_get(cop));
933     if (PL_curcop == cop)
934        PL_curcop = NULL;
935 }
936
937 STATIC void
938 S_forget_pmop(pTHX_ PMOP *const o
939               )
940 {
941     HV * const pmstash = PmopSTASH(o);
942
943     PERL_ARGS_ASSERT_FORGET_PMOP;
944
945     if (pmstash && !SvIS_FREED(pmstash) && SvMAGICAL(pmstash)) {
946         MAGIC * const mg = mg_find((const SV *)pmstash, PERL_MAGIC_symtab);
947         if (mg) {
948             PMOP **const array = (PMOP**) mg->mg_ptr;
949             U32 count = mg->mg_len / sizeof(PMOP**);
950             U32 i = count;
951
952             while (i--) {
953                 if (array[i] == o) {
954                     /* Found it. Move the entry at the end to overwrite it.  */
955                     array[i] = array[--count];
956                     mg->mg_len = count * sizeof(PMOP**);
957                     /* Could realloc smaller at this point always, but probably
958                        not worth it. Probably worth free()ing if we're the
959                        last.  */
960                     if(!count) {
961                         Safefree(mg->mg_ptr);
962                         mg->mg_ptr = NULL;
963                     }
964                     break;
965                 }
966             }
967         }
968     }
969     if (PL_curpm == o) 
970         PL_curpm = NULL;
971 }
972
973 STATIC void
974 S_find_and_forget_pmops(pTHX_ OP *o)
975 {
976     PERL_ARGS_ASSERT_FIND_AND_FORGET_PMOPS;
977
978     if (o->op_flags & OPf_KIDS) {
979         OP *kid = cUNOPo->op_first;
980         while (kid) {
981             switch (kid->op_type) {
982             case OP_SUBST:
983             case OP_PUSHRE:
984             case OP_MATCH:
985             case OP_QR:
986                 forget_pmop((PMOP*)kid);
987             }
988             find_and_forget_pmops(kid);
989             kid = OP_SIBLING(kid);
990         }
991     }
992 }
993
994 /*
995 =for apidoc Am|void|op_null|OP *o
996
997 Neutralizes an op when it is no longer needed, but is still linked to from
998 other ops.
999
1000 =cut
1001 */
1002
1003 void
1004 Perl_op_null(pTHX_ OP *o)
1005 {
1006     dVAR;
1007
1008     PERL_ARGS_ASSERT_OP_NULL;
1009
1010     if (o->op_type == OP_NULL)
1011         return;
1012     op_clear(o);
1013     o->op_targ = o->op_type;
1014     o->op_type = OP_NULL;
1015     o->op_ppaddr = PL_ppaddr[OP_NULL];
1016 }
1017
1018 void
1019 Perl_op_refcnt_lock(pTHX)
1020 {
1021 #ifdef USE_ITHREADS
1022     dVAR;
1023 #endif
1024     PERL_UNUSED_CONTEXT;
1025     OP_REFCNT_LOCK;
1026 }
1027
1028 void
1029 Perl_op_refcnt_unlock(pTHX)
1030 {
1031 #ifdef USE_ITHREADS
1032     dVAR;
1033 #endif
1034     PERL_UNUSED_CONTEXT;
1035     OP_REFCNT_UNLOCK;
1036 }
1037
1038
1039 /*
1040 =for apidoc op_sibling_splice
1041
1042 A general function for editing the structure of an existing chain of
1043 op_sibling nodes.  By analogy with the perl-level splice() function, allows
1044 you to delete zero or more sequential nodes, replacing them with zero or
1045 more different nodes.  Performs the necessary op_first/op_last
1046 housekeeping on the parent node and op_sibling manipulation on the
1047 children.  The last deleted node will be marked as as the last node by
1048 updating the op_sibling or op_lastsib field as appropriate.
1049
1050 Note that op_next is not manipulated, and nodes are not freed; that is the
1051 responsibility of the caller.  It also won't create a new list op for an
1052 empty list etc; use higher-level functions like op_append_elem() for that.
1053
1054 parent is the parent node of the sibling chain.
1055
1056 start is the node preceding the first node to be spliced.  Node(s)
1057 following it will be deleted, and ops will be inserted after it.  If it is
1058 NULL, the first node onwards is deleted, and nodes are inserted at the
1059 beginning.
1060
1061 del_count is the number of nodes to delete.  If zero, no nodes are deleted.
1062 If -1 or greater than or equal to the number of remaining kids, all
1063 remaining kids are deleted.
1064
1065 insert is the first of a chain of nodes to be inserted in place of the nodes.
1066 If NULL, no nodes are inserted.
1067
1068 The head of the chain of deleted ops is returned, or NULL if no ops were
1069 deleted.
1070
1071 For example:
1072
1073     action                    before      after         returns
1074     ------                    -----       -----         -------
1075
1076                               P           P
1077     splice(P, A, 2, X-Y-Z)    |           |             B-C
1078                               A-B-C-D     A-X-Y-Z-D
1079
1080                               P           P
1081     splice(P, NULL, 1, X-Y)   |           |             A
1082                               A-B-C-D     X-Y-B-C-D
1083
1084                               P           P
1085     splice(P, NULL, 3, NULL)  |           |             A-B-C
1086                               A-B-C-D     D
1087
1088                               P           P
1089     splice(P, B, 0, X-Y)      |           |             NULL
1090                               A-B-C-D     A-B-X-Y-C-D
1091
1092 =cut
1093 */
1094
1095 OP *
1096 Perl_op_sibling_splice(OP *parent, OP *start, int del_count, OP* insert)
1097 {
1098     OP *first = start ? OP_SIBLING(start) : cLISTOPx(parent)->op_first;
1099     OP *rest;
1100     OP *last_del = NULL;
1101     OP *last_ins = NULL;
1102
1103     PERL_ARGS_ASSERT_OP_SIBLING_SPLICE;
1104
1105     assert(del_count >= -1);
1106
1107     if (del_count && first) {
1108         last_del = first;
1109         while (--del_count && OP_HAS_SIBLING(last_del))
1110             last_del = OP_SIBLING(last_del);
1111         rest = OP_SIBLING(last_del);
1112         OP_SIBLING_set(last_del, NULL);
1113         last_del->op_lastsib = 1;
1114     }
1115     else
1116         rest = first;
1117
1118     if (insert) {
1119         last_ins = insert;
1120         while (OP_HAS_SIBLING(last_ins))
1121             last_ins = OP_SIBLING(last_ins);
1122         OP_SIBLING_set(last_ins, rest);
1123         last_ins->op_lastsib = rest ? 0 : 1;
1124     }
1125     else
1126         insert = rest;
1127
1128     if (start) {
1129         OP_SIBLING_set(start, insert);
1130         start->op_lastsib = insert ? 0 : 1;
1131     }
1132     else
1133         cLISTOPx(parent)->op_first = insert;
1134
1135     if (!rest) {
1136         /* update op_last etc */
1137         U32 type = parent->op_type;
1138         OP *lastop;
1139
1140         if (type == OP_NULL)
1141             type = parent->op_targ;
1142         type = PL_opargs[type] & OA_CLASS_MASK;
1143
1144         lastop = last_ins ? last_ins : start ? start : NULL;
1145         if (   type == OA_BINOP
1146             || type == OA_LISTOP
1147             || type == OA_PMOP
1148             || type == OA_LOOP
1149         )
1150             cLISTOPx(parent)->op_last = lastop;
1151
1152         if (lastop) {
1153             lastop->op_lastsib = 1;
1154 #ifdef PERL_OP_PARENT
1155             lastop->op_sibling = parent;
1156 #endif
1157         }
1158     }
1159     return last_del ? first : NULL;
1160 }
1161
1162 /*
1163 =for apidoc op_parent
1164
1165 returns the parent OP of o, if it has a parent.  Returns NULL otherwise.
1166 (Currently perl must be built with C<-DPERL_OP_PARENT> for this feature to
1167 work.
1168
1169 =cut
1170 */
1171
1172 OP *
1173 Perl_op_parent(OP *o)
1174 {
1175     PERL_ARGS_ASSERT_OP_PARENT;
1176 #ifdef PERL_OP_PARENT
1177     while (OP_HAS_SIBLING(o))
1178         o = OP_SIBLING(o);
1179     return o->op_sibling;
1180 #else
1181     PERL_UNUSED_ARG(o);
1182     return NULL;
1183 #endif
1184 }
1185
1186
1187 /* replace the sibling following start with a new UNOP, which becomes
1188  * the parent of the original sibling; e.g.
1189  *
1190  *  op_sibling_newUNOP(P, A, unop-args...)
1191  *
1192  *  P              P
1193  *  |      becomes |
1194  *  A-B-C          A-U-C
1195  *                   |
1196  *                   B
1197  *
1198  * where U is the new UNOP.
1199  *
1200  * parent and start args are the same as for op_sibling_splice();
1201  * type and flags args are as newUNOP().
1202  *
1203  * Returns the new UNOP.
1204  */
1205
1206 OP *
1207 S_op_sibling_newUNOP(pTHX_ OP *parent, OP *start, I32 type, I32 flags)
1208 {
1209     OP *kid, *newop;
1210
1211     kid = op_sibling_splice(parent, start, 1, NULL);
1212     newop = newUNOP(type, flags, kid);
1213     op_sibling_splice(parent, start, 0, newop);
1214     return newop;
1215 }
1216
1217
1218 /* lowest-level newLOGOP-style function - just allocates and populates
1219  * the struct. Higher-level stuff should be done by S_new_logop() /
1220  * newLOGOP(). This function exists mainly to avoid op_first assignment
1221  * being spread throughout this file.
1222  */
1223
1224 LOGOP *
1225 S_alloc_LOGOP(pTHX_ I32 type, OP *first, OP* other)
1226 {
1227     LOGOP *logop;
1228     OP *kid = first;
1229     NewOp(1101, logop, 1, LOGOP);
1230     logop->op_type = (OPCODE)type;
1231     logop->op_first = first;
1232     logop->op_other = other;
1233     logop->op_flags = OPf_KIDS;
1234     while (kid && OP_HAS_SIBLING(kid))
1235         kid = OP_SIBLING(kid);
1236     if (kid) {
1237         kid->op_lastsib = 1;
1238 #ifdef PERL_OP_PARENT
1239         kid->op_sibling = (OP*)logop;
1240 #endif
1241     }
1242     return logop;
1243 }
1244
1245
1246 /* Contextualizers */
1247
1248 /*
1249 =for apidoc Am|OP *|op_contextualize|OP *o|I32 context
1250
1251 Applies a syntactic context to an op tree representing an expression.
1252 I<o> is the op tree, and I<context> must be C<G_SCALAR>, C<G_ARRAY>,
1253 or C<G_VOID> to specify the context to apply.  The modified op tree
1254 is returned.
1255
1256 =cut
1257 */
1258
1259 OP *
1260 Perl_op_contextualize(pTHX_ OP *o, I32 context)
1261 {
1262     PERL_ARGS_ASSERT_OP_CONTEXTUALIZE;
1263     switch (context) {
1264         case G_SCALAR: return scalar(o);
1265         case G_ARRAY:  return list(o);
1266         case G_VOID:   return scalarvoid(o);
1267         default:
1268             Perl_croak(aTHX_ "panic: op_contextualize bad context %ld",
1269                        (long) context);
1270     }
1271 }
1272
1273 /*
1274
1275 =for apidoc Am|OP*|op_linklist|OP *o
1276 This function is the implementation of the L</LINKLIST> macro.  It should
1277 not be called directly.
1278
1279 =cut
1280 */
1281
1282 OP *
1283 Perl_op_linklist(pTHX_ OP *o)
1284 {
1285     OP *first;
1286
1287     PERL_ARGS_ASSERT_OP_LINKLIST;
1288
1289     if (o->op_next)
1290         return o->op_next;
1291
1292     /* establish postfix order */
1293     first = cUNOPo->op_first;
1294     if (first) {
1295         OP *kid;
1296         o->op_next = LINKLIST(first);
1297         kid = first;
1298         for (;;) {
1299             OP *sibl = OP_SIBLING(kid);
1300             if (sibl) {
1301                 kid->op_next = LINKLIST(sibl);
1302                 kid = sibl;
1303             } else {
1304                 kid->op_next = o;
1305                 break;
1306             }
1307         }
1308     }
1309     else
1310         o->op_next = o;
1311
1312     return o->op_next;
1313 }
1314
1315 static OP *
1316 S_scalarkids(pTHX_ OP *o)
1317 {
1318     if (o && o->op_flags & OPf_KIDS) {
1319         OP *kid;
1320         for (kid = cLISTOPo->op_first; kid; kid = OP_SIBLING(kid))
1321             scalar(kid);
1322     }
1323     return o;
1324 }
1325
1326 STATIC OP *
1327 S_scalarboolean(pTHX_ OP *o)
1328 {
1329     PERL_ARGS_ASSERT_SCALARBOOLEAN;
1330
1331     if (o->op_type == OP_SASSIGN && cBINOPo->op_first->op_type == OP_CONST
1332      && !(cBINOPo->op_first->op_flags & OPf_SPECIAL)) {
1333         if (ckWARN(WARN_SYNTAX)) {
1334             const line_t oldline = CopLINE(PL_curcop);
1335
1336             if (PL_parser && PL_parser->copline != NOLINE) {
1337                 /* This ensures that warnings are reported at the first line
1338                    of the conditional, not the last.  */
1339                 CopLINE_set(PL_curcop, PL_parser->copline);
1340             }
1341             Perl_warner(aTHX_ packWARN(WARN_SYNTAX), "Found = in conditional, should be ==");
1342             CopLINE_set(PL_curcop, oldline);
1343         }
1344     }
1345     return scalar(o);
1346 }
1347
1348 static SV *
1349 S_op_varname(pTHX_ const OP *o)
1350 {
1351     assert(o);
1352     assert(o->op_type == OP_PADAV || o->op_type == OP_RV2AV ||
1353            o->op_type == OP_PADHV || o->op_type == OP_RV2HV);
1354     {
1355         const char funny  = o->op_type == OP_PADAV
1356                          || o->op_type == OP_RV2AV ? '@' : '%';
1357         if (o->op_type == OP_RV2AV || o->op_type == OP_RV2HV) {
1358             GV *gv;
1359             if (cUNOPo->op_first->op_type != OP_GV
1360              || !(gv = cGVOPx_gv(cUNOPo->op_first)))
1361                 return NULL;
1362             return varname(gv, funny, 0, NULL, 0, 1);
1363         }
1364         return
1365             varname(MUTABLE_GV(PL_compcv), funny, o->op_targ, NULL, 0, 1);
1366     }
1367 }
1368
1369 static void
1370 S_op_pretty(pTHX_ const OP *o, SV **retsv, const char **retpv)
1371 { /* or not so pretty :-) */
1372     if (o->op_type == OP_CONST) {
1373         *retsv = cSVOPo_sv;
1374         if (SvPOK(*retsv)) {
1375             SV *sv = *retsv;
1376             *retsv = sv_newmortal();
1377             pv_pretty(*retsv, SvPVX_const(sv), SvCUR(sv), 32, NULL, NULL,
1378                       PERL_PV_PRETTY_DUMP |PERL_PV_ESCAPE_UNI_DETECT);
1379         }
1380         else if (!SvOK(*retsv))
1381             *retpv = "undef";
1382     }
1383     else *retpv = "...";
1384 }
1385
1386 static void
1387 S_scalar_slice_warning(pTHX_ const OP *o)
1388 {
1389     OP *kid;
1390     const char lbrack =
1391         o->op_type == OP_HSLICE ? '{' : '[';
1392     const char rbrack =
1393         o->op_type == OP_HSLICE ? '}' : ']';
1394     SV *name;
1395     SV *keysv = NULL; /* just to silence compiler warnings */
1396     const char *key = NULL;
1397
1398     if (!(o->op_private & OPpSLICEWARNING))
1399         return;
1400     if (PL_parser && PL_parser->error_count)
1401         /* This warning can be nonsensical when there is a syntax error. */
1402         return;
1403
1404     kid = cLISTOPo->op_first;
1405     kid = OP_SIBLING(kid); /* get past pushmark */
1406     /* weed out false positives: any ops that can return lists */
1407     switch (kid->op_type) {
1408     case OP_BACKTICK:
1409     case OP_GLOB:
1410     case OP_READLINE:
1411     case OP_MATCH:
1412     case OP_RV2AV:
1413     case OP_EACH:
1414     case OP_VALUES:
1415     case OP_KEYS:
1416     case OP_SPLIT:
1417     case OP_LIST:
1418     case OP_SORT:
1419     case OP_REVERSE:
1420     case OP_ENTERSUB:
1421     case OP_CALLER:
1422     case OP_LSTAT:
1423     case OP_STAT:
1424     case OP_READDIR:
1425     case OP_SYSTEM:
1426     case OP_TMS:
1427     case OP_LOCALTIME:
1428     case OP_GMTIME:
1429     case OP_ENTEREVAL:
1430     case OP_REACH:
1431     case OP_RKEYS:
1432     case OP_RVALUES:
1433         return;
1434     }
1435
1436     /* Don't warn if we have a nulled list either. */
1437     if (kid->op_type == OP_NULL && kid->op_targ == OP_LIST)
1438         return;
1439
1440     assert(OP_SIBLING(kid));
1441     name = S_op_varname(aTHX_ OP_SIBLING(kid));
1442     if (!name) /* XS module fiddling with the op tree */
1443         return;
1444     S_op_pretty(aTHX_ kid, &keysv, &key);
1445     assert(SvPOK(name));
1446     sv_chop(name,SvPVX(name)+1);
1447     if (key)
1448        /* diag_listed_as: Scalar value @%s[%s] better written as $%s[%s] */
1449         Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
1450                    "Scalar value @%"SVf"%c%s%c better written as $%"SVf
1451                    "%c%s%c",
1452                     SVfARG(name), lbrack, key, rbrack, SVfARG(name),
1453                     lbrack, key, rbrack);
1454     else
1455        /* diag_listed_as: Scalar value @%s[%s] better written as $%s[%s] */
1456         Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
1457                    "Scalar value @%"SVf"%c%"SVf"%c better written as $%"
1458                     SVf"%c%"SVf"%c",
1459                     SVfARG(name), lbrack, SVfARG(keysv), rbrack,
1460                     SVfARG(name), lbrack, SVfARG(keysv), rbrack);
1461 }
1462
1463 OP *
1464 Perl_scalar(pTHX_ OP *o)
1465 {
1466     OP *kid;
1467
1468     /* assumes no premature commitment */
1469     if (!o || (PL_parser && PL_parser->error_count)
1470          || (o->op_flags & OPf_WANT)
1471          || o->op_type == OP_RETURN)
1472     {
1473         return o;
1474     }
1475
1476     o->op_flags = (o->op_flags & ~OPf_WANT) | OPf_WANT_SCALAR;
1477
1478     switch (o->op_type) {
1479     case OP_REPEAT:
1480         scalar(cBINOPo->op_first);
1481         break;
1482     case OP_OR:
1483     case OP_AND:
1484     case OP_COND_EXPR:
1485         for (kid = OP_SIBLING(cUNOPo->op_first); kid; kid = OP_SIBLING(kid))
1486             scalar(kid);
1487         break;
1488         /* FALLTHROUGH */
1489     case OP_SPLIT:
1490     case OP_MATCH:
1491     case OP_QR:
1492     case OP_SUBST:
1493     case OP_NULL:
1494     default:
1495         if (o->op_flags & OPf_KIDS) {
1496             for (kid = cUNOPo->op_first; kid; kid = OP_SIBLING(kid))
1497                 scalar(kid);
1498         }
1499         break;
1500     case OP_LEAVE:
1501     case OP_LEAVETRY:
1502         kid = cLISTOPo->op_first;
1503         scalar(kid);
1504         kid = OP_SIBLING(kid);
1505     do_kids:
1506         while (kid) {
1507             OP *sib = OP_SIBLING(kid);
1508             if (sib && kid->op_type != OP_LEAVEWHEN)
1509                 scalarvoid(kid);
1510             else
1511                 scalar(kid);
1512             kid = sib;
1513         }
1514         PL_curcop = &PL_compiling;
1515         break;
1516     case OP_SCOPE:
1517     case OP_LINESEQ:
1518     case OP_LIST:
1519         kid = cLISTOPo->op_first;
1520         goto do_kids;
1521     case OP_SORT:
1522         Perl_ck_warner(aTHX_ packWARN(WARN_VOID), "Useless use of sort in scalar context");
1523         break;
1524     case OP_KVHSLICE:
1525     case OP_KVASLICE:
1526     {
1527         /* Warn about scalar context */
1528         const char lbrack = o->op_type == OP_KVHSLICE ? '{' : '[';
1529         const char rbrack = o->op_type == OP_KVHSLICE ? '}' : ']';
1530         SV *name;
1531         SV *keysv;
1532         const char *key = NULL;
1533
1534         /* This warning can be nonsensical when there is a syntax error. */
1535         if (PL_parser && PL_parser->error_count)
1536             break;
1537
1538         if (!ckWARN(WARN_SYNTAX)) break;
1539
1540         kid = cLISTOPo->op_first;
1541         kid = OP_SIBLING(kid); /* get past pushmark */
1542         assert(OP_SIBLING(kid));
1543         name = S_op_varname(aTHX_ OP_SIBLING(kid));
1544         if (!name) /* XS module fiddling with the op tree */
1545             break;
1546         S_op_pretty(aTHX_ kid, &keysv, &key);
1547         assert(SvPOK(name));
1548         sv_chop(name,SvPVX(name)+1);
1549         if (key)
1550   /* diag_listed_as: %%s[%s] in scalar context better written as $%s[%s] */
1551             Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
1552                        "%%%"SVf"%c%s%c in scalar context better written "
1553                        "as $%"SVf"%c%s%c",
1554                         SVfARG(name), lbrack, key, rbrack, SVfARG(name),
1555                         lbrack, key, rbrack);
1556         else
1557   /* diag_listed_as: %%s[%s] in scalar context better written as $%s[%s] */
1558             Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
1559                        "%%%"SVf"%c%"SVf"%c in scalar context better "
1560                        "written as $%"SVf"%c%"SVf"%c",
1561                         SVfARG(name), lbrack, SVfARG(keysv), rbrack,
1562                         SVfARG(name), lbrack, SVfARG(keysv), rbrack);
1563     }
1564     }
1565     return o;
1566 }
1567
1568 OP *
1569 Perl_scalarvoid(pTHX_ OP *o)
1570 {
1571     dVAR;
1572     OP *kid;
1573     SV *useless_sv = NULL;
1574     const char* useless = NULL;
1575     SV* sv;
1576     U8 want;
1577
1578     PERL_ARGS_ASSERT_SCALARVOID;
1579
1580     if (o->op_type == OP_NEXTSTATE
1581         || o->op_type == OP_DBSTATE
1582         || (o->op_type == OP_NULL && (o->op_targ == OP_NEXTSTATE
1583                                       || o->op_targ == OP_DBSTATE)))
1584         PL_curcop = (COP*)o;            /* for warning below */
1585
1586     /* assumes no premature commitment */
1587     want = o->op_flags & OPf_WANT;
1588     if ((want && want != OPf_WANT_SCALAR)
1589          || (PL_parser && PL_parser->error_count)
1590          || o->op_type == OP_RETURN || o->op_type == OP_REQUIRE || o->op_type == OP_LEAVEWHEN)
1591     {
1592         return o;
1593     }
1594
1595     if ((o->op_private & OPpTARGET_MY)
1596         && (PL_opargs[o->op_type] & OA_TARGLEX))/* OPp share the meaning */
1597     {
1598         return scalar(o);                       /* As if inside SASSIGN */
1599     }
1600
1601     o->op_flags = (o->op_flags & ~OPf_WANT) | OPf_WANT_VOID;
1602
1603     switch (o->op_type) {
1604     default:
1605         if (!(PL_opargs[o->op_type] & OA_FOLDCONST))
1606             break;
1607         /* FALLTHROUGH */
1608     case OP_REPEAT:
1609         if (o->op_flags & OPf_STACKED)
1610             break;
1611         goto func_ops;
1612     case OP_SUBSTR:
1613         if (o->op_private == 4)
1614             break;
1615         /* FALLTHROUGH */
1616     case OP_GVSV:
1617     case OP_WANTARRAY:
1618     case OP_GV:
1619     case OP_SMARTMATCH:
1620     case OP_PADSV:
1621     case OP_PADAV:
1622     case OP_PADHV:
1623     case OP_PADANY:
1624     case OP_AV2ARYLEN:
1625     case OP_REF:
1626     case OP_REFGEN:
1627     case OP_SREFGEN:
1628     case OP_DEFINED:
1629     case OP_HEX:
1630     case OP_OCT:
1631     case OP_LENGTH:
1632     case OP_VEC:
1633     case OP_INDEX:
1634     case OP_RINDEX:
1635     case OP_SPRINTF:
1636     case OP_AELEM:
1637     case OP_AELEMFAST:
1638     case OP_AELEMFAST_LEX:
1639     case OP_ASLICE:
1640     case OP_KVASLICE:
1641     case OP_HELEM:
1642     case OP_HSLICE:
1643     case OP_KVHSLICE:
1644     case OP_UNPACK:
1645     case OP_PACK:
1646     case OP_JOIN:
1647     case OP_LSLICE:
1648     case OP_ANONLIST:
1649     case OP_ANONHASH:
1650     case OP_SORT:
1651     case OP_REVERSE:
1652     case OP_RANGE:
1653     case OP_FLIP:
1654     case OP_FLOP:
1655     case OP_CALLER:
1656     case OP_FILENO:
1657     case OP_EOF:
1658     case OP_TELL:
1659     case OP_GETSOCKNAME:
1660     case OP_GETPEERNAME:
1661     case OP_READLINK:
1662     case OP_TELLDIR:
1663     case OP_GETPPID:
1664     case OP_GETPGRP:
1665     case OP_GETPRIORITY:
1666     case OP_TIME:
1667     case OP_TMS:
1668     case OP_LOCALTIME:
1669     case OP_GMTIME:
1670     case OP_GHBYNAME:
1671     case OP_GHBYADDR:
1672     case OP_GHOSTENT:
1673     case OP_GNBYNAME:
1674     case OP_GNBYADDR:
1675     case OP_GNETENT:
1676     case OP_GPBYNAME:
1677     case OP_GPBYNUMBER:
1678     case OP_GPROTOENT:
1679     case OP_GSBYNAME:
1680     case OP_GSBYPORT:
1681     case OP_GSERVENT:
1682     case OP_GPWNAM:
1683     case OP_GPWUID:
1684     case OP_GGRNAM:
1685     case OP_GGRGID:
1686     case OP_GETLOGIN:
1687     case OP_PROTOTYPE:
1688     case OP_RUNCV:
1689       func_ops:
1690         if (!(o->op_private & (OPpLVAL_INTRO|OPpOUR_INTRO)))
1691             /* Otherwise it's "Useless use of grep iterator" */
1692             useless = OP_DESC(o);
1693         break;
1694
1695     case OP_SPLIT:
1696         kid = cLISTOPo->op_first;
1697         if (kid && kid->op_type == OP_PUSHRE
1698 #ifdef USE_ITHREADS
1699                 && !((PMOP*)kid)->op_pmreplrootu.op_pmtargetoff)
1700 #else
1701                 && !((PMOP*)kid)->op_pmreplrootu.op_pmtargetgv)
1702 #endif
1703             useless = OP_DESC(o);
1704         break;
1705
1706     case OP_NOT:
1707        kid = cUNOPo->op_first;
1708        if (kid->op_type != OP_MATCH && kid->op_type != OP_SUBST &&
1709            kid->op_type != OP_TRANS && kid->op_type != OP_TRANSR) {
1710                 goto func_ops;
1711        }
1712        useless = "negative pattern binding (!~)";
1713        break;
1714
1715     case OP_SUBST:
1716         if (cPMOPo->op_pmflags & PMf_NONDESTRUCT)
1717             useless = "non-destructive substitution (s///r)";
1718         break;
1719
1720     case OP_TRANSR:
1721         useless = "non-destructive transliteration (tr///r)";
1722         break;
1723
1724     case OP_RV2GV:
1725     case OP_RV2SV:
1726     case OP_RV2AV:
1727     case OP_RV2HV:
1728         if (!(o->op_private & (OPpLVAL_INTRO|OPpOUR_INTRO)) &&
1729                 (!OP_HAS_SIBLING(o) || OP_SIBLING(o)->op_type != OP_READLINE))
1730             useless = "a variable";
1731         break;
1732
1733     case OP_CONST:
1734         sv = cSVOPo_sv;
1735         if (cSVOPo->op_private & OPpCONST_STRICT)
1736             no_bareword_allowed(o);
1737         else {
1738             if (ckWARN(WARN_VOID)) {
1739                 NV nv;
1740                 /* don't warn on optimised away booleans, eg 
1741                  * use constant Foo, 5; Foo || print; */
1742                 if (cSVOPo->op_private & OPpCONST_SHORTCIRCUIT)
1743                     useless = NULL;
1744                 /* the constants 0 and 1 are permitted as they are
1745                    conventionally used as dummies in constructs like
1746                         1 while some_condition_with_side_effects;  */
1747                 else if (SvNIOK(sv) && ((nv = SvNV(sv)) == 0.0 || nv == 1.0))
1748                     useless = NULL;
1749                 else if (SvPOK(sv)) {
1750                     SV * const dsv = newSVpvs("");
1751                     useless_sv
1752                         = Perl_newSVpvf(aTHX_
1753                                         "a constant (%s)",
1754                                         pv_pretty(dsv, SvPVX_const(sv),
1755                                                   SvCUR(sv), 32, NULL, NULL,
1756                                                   PERL_PV_PRETTY_DUMP
1757                                                   | PERL_PV_ESCAPE_NOCLEAR
1758                                                   | PERL_PV_ESCAPE_UNI_DETECT));
1759                     SvREFCNT_dec_NN(dsv);
1760                 }
1761                 else if (SvOK(sv)) {
1762                     useless_sv = Perl_newSVpvf(aTHX_ "a constant (%"SVf")", SVfARG(sv));
1763                 }
1764                 else
1765                     useless = "a constant (undef)";
1766             }
1767         }
1768         op_null(o);             /* don't execute or even remember it */
1769         break;
1770
1771     case OP_POSTINC:
1772         o->op_type = OP_PREINC;         /* pre-increment is faster */
1773         o->op_ppaddr = PL_ppaddr[OP_PREINC];
1774         break;
1775
1776     case OP_POSTDEC:
1777         o->op_type = OP_PREDEC;         /* pre-decrement is faster */
1778         o->op_ppaddr = PL_ppaddr[OP_PREDEC];
1779         break;
1780
1781     case OP_I_POSTINC:
1782         o->op_type = OP_I_PREINC;       /* pre-increment is faster */
1783         o->op_ppaddr = PL_ppaddr[OP_I_PREINC];
1784         break;
1785
1786     case OP_I_POSTDEC:
1787         o->op_type = OP_I_PREDEC;       /* pre-decrement is faster */
1788         o->op_ppaddr = PL_ppaddr[OP_I_PREDEC];
1789         break;
1790
1791     case OP_SASSIGN: {
1792         OP *rv2gv;
1793         UNOP *refgen, *rv2cv;
1794         LISTOP *exlist;
1795
1796         if ((o->op_private & ~OPpASSIGN_BACKWARDS) != 2)
1797             break;
1798
1799         rv2gv = ((BINOP *)o)->op_last;
1800         if (!rv2gv || rv2gv->op_type != OP_RV2GV)
1801             break;
1802
1803         refgen = (UNOP *)((BINOP *)o)->op_first;
1804
1805         if (!refgen || (refgen->op_type != OP_REFGEN
1806                         && refgen->op_type != OP_SREFGEN))
1807             break;
1808
1809         exlist = (LISTOP *)refgen->op_first;
1810         if (!exlist || exlist->op_type != OP_NULL
1811             || exlist->op_targ != OP_LIST)
1812             break;
1813
1814         if (exlist->op_first->op_type != OP_PUSHMARK
1815          && exlist->op_first != exlist->op_last)
1816             break;
1817
1818         rv2cv = (UNOP*)exlist->op_last;
1819
1820         if (rv2cv->op_type != OP_RV2CV)
1821             break;
1822
1823         assert ((rv2gv->op_private & OPpDONT_INIT_GV) == 0);
1824         assert ((o->op_private & OPpASSIGN_CV_TO_GV) == 0);
1825         assert ((rv2cv->op_private & OPpMAY_RETURN_CONSTANT) == 0);
1826
1827         o->op_private |= OPpASSIGN_CV_TO_GV;
1828         rv2gv->op_private |= OPpDONT_INIT_GV;
1829         rv2cv->op_private |= OPpMAY_RETURN_CONSTANT;
1830
1831         break;
1832     }
1833
1834     case OP_AASSIGN: {
1835         inplace_aassign(o);
1836         break;
1837     }
1838
1839     case OP_OR:
1840     case OP_AND:
1841         kid = cLOGOPo->op_first;
1842         if (kid->op_type == OP_NOT
1843             && (kid->op_flags & OPf_KIDS)) {
1844             if (o->op_type == OP_AND) {
1845                 o->op_type = OP_OR;
1846                 o->op_ppaddr = PL_ppaddr[OP_OR];
1847             } else {
1848                 o->op_type = OP_AND;
1849                 o->op_ppaddr = PL_ppaddr[OP_AND];
1850             }
1851             op_null(kid);
1852         }
1853         /* FALLTHROUGH */
1854
1855     case OP_DOR:
1856     case OP_COND_EXPR:
1857     case OP_ENTERGIVEN:
1858     case OP_ENTERWHEN:
1859         for (kid = OP_SIBLING(cUNOPo->op_first); kid; kid = OP_SIBLING(kid))
1860             scalarvoid(kid);
1861         break;
1862
1863     case OP_NULL:
1864         if (o->op_flags & OPf_STACKED)
1865             break;
1866         /* FALLTHROUGH */
1867     case OP_NEXTSTATE:
1868     case OP_DBSTATE:
1869     case OP_ENTERTRY:
1870     case OP_ENTER:
1871         if (!(o->op_flags & OPf_KIDS))
1872             break;
1873         /* FALLTHROUGH */
1874     case OP_SCOPE:
1875     case OP_LEAVE:
1876     case OP_LEAVETRY:
1877     case OP_LEAVELOOP:
1878     case OP_LINESEQ:
1879     case OP_LIST:
1880     case OP_LEAVEGIVEN:
1881     case OP_LEAVEWHEN:
1882         for (kid = cLISTOPo->op_first; kid; kid = OP_SIBLING(kid))
1883             scalarvoid(kid);
1884         break;
1885     case OP_ENTEREVAL:
1886         scalarkids(o);
1887         break;
1888     case OP_SCALAR:
1889         return scalar(o);
1890     }
1891
1892     if (useless_sv) {
1893         /* mortalise it, in case warnings are fatal.  */
1894         Perl_ck_warner(aTHX_ packWARN(WARN_VOID),
1895                        "Useless use of %"SVf" in void context",
1896                        SVfARG(sv_2mortal(useless_sv)));
1897     }
1898     else if (useless) {
1899        Perl_ck_warner(aTHX_ packWARN(WARN_VOID),
1900                       "Useless use of %s in void context",
1901                       useless);
1902     }
1903     return o;
1904 }
1905
1906 static OP *
1907 S_listkids(pTHX_ OP *o)
1908 {
1909     if (o && o->op_flags & OPf_KIDS) {
1910         OP *kid;
1911         for (kid = cLISTOPo->op_first; kid; kid = OP_SIBLING(kid))
1912             list(kid);
1913     }
1914     return o;
1915 }
1916
1917 OP *
1918 Perl_list(pTHX_ OP *o)
1919 {
1920     OP *kid;
1921
1922     /* assumes no premature commitment */
1923     if (!o || (o->op_flags & OPf_WANT)
1924          || (PL_parser && PL_parser->error_count)
1925          || o->op_type == OP_RETURN)
1926     {
1927         return o;
1928     }
1929
1930     if ((o->op_private & OPpTARGET_MY)
1931         && (PL_opargs[o->op_type] & OA_TARGLEX))/* OPp share the meaning */
1932     {
1933         return o;                               /* As if inside SASSIGN */
1934     }
1935
1936     o->op_flags = (o->op_flags & ~OPf_WANT) | OPf_WANT_LIST;
1937
1938     switch (o->op_type) {
1939     case OP_FLOP:
1940     case OP_REPEAT:
1941         list(cBINOPo->op_first);
1942         break;
1943     case OP_OR:
1944     case OP_AND:
1945     case OP_COND_EXPR:
1946         for (kid = OP_SIBLING(cUNOPo->op_first); kid; kid = OP_SIBLING(kid))
1947             list(kid);
1948         break;
1949     default:
1950     case OP_MATCH:
1951     case OP_QR:
1952     case OP_SUBST:
1953     case OP_NULL:
1954         if (!(o->op_flags & OPf_KIDS))
1955             break;
1956         if (!o->op_next && cUNOPo->op_first->op_type == OP_FLOP) {
1957             list(cBINOPo->op_first);
1958             return gen_constant_list(o);
1959         }
1960     case OP_LIST:
1961         listkids(o);
1962         break;
1963     case OP_LEAVE:
1964     case OP_LEAVETRY:
1965         kid = cLISTOPo->op_first;
1966         list(kid);
1967         kid = OP_SIBLING(kid);
1968     do_kids:
1969         while (kid) {
1970             OP *sib = OP_SIBLING(kid);
1971             if (sib && kid->op_type != OP_LEAVEWHEN)
1972                 scalarvoid(kid);
1973             else
1974                 list(kid);
1975             kid = sib;
1976         }
1977         PL_curcop = &PL_compiling;
1978         break;
1979     case OP_SCOPE:
1980     case OP_LINESEQ:
1981         kid = cLISTOPo->op_first;
1982         goto do_kids;
1983     }
1984     return o;
1985 }
1986
1987 static OP *
1988 S_scalarseq(pTHX_ OP *o)
1989 {
1990     if (o) {
1991         const OPCODE type = o->op_type;
1992
1993         if (type == OP_LINESEQ || type == OP_SCOPE ||
1994             type == OP_LEAVE || type == OP_LEAVETRY)
1995         {
1996             OP *kid;
1997             for (kid = cLISTOPo->op_first; kid; kid = OP_SIBLING(kid)) {
1998                 if (OP_HAS_SIBLING(kid)) {
1999                     scalarvoid(kid);
2000                 }
2001             }
2002             PL_curcop = &PL_compiling;
2003         }
2004         o->op_flags &= ~OPf_PARENS;
2005         if (PL_hints & HINT_BLOCK_SCOPE)
2006             o->op_flags |= OPf_PARENS;
2007     }
2008     else
2009         o = newOP(OP_STUB, 0);
2010     return o;
2011 }
2012
2013 STATIC OP *
2014 S_modkids(pTHX_ OP *o, I32 type)
2015 {
2016     if (o && o->op_flags & OPf_KIDS) {
2017         OP *kid;
2018         for (kid = cLISTOPo->op_first; kid; kid = OP_SIBLING(kid))
2019             op_lvalue(kid, type);
2020     }
2021     return o;
2022 }
2023
2024 /*
2025 =for apidoc finalize_optree
2026
2027 This function finalizes the optree.  Should be called directly after
2028 the complete optree is built.  It does some additional
2029 checking which can't be done in the normal ck_xxx functions and makes
2030 the tree thread-safe.
2031
2032 =cut
2033 */
2034 void
2035 Perl_finalize_optree(pTHX_ OP* o)
2036 {
2037     PERL_ARGS_ASSERT_FINALIZE_OPTREE;
2038
2039     ENTER;
2040     SAVEVPTR(PL_curcop);
2041
2042     finalize_op(o);
2043
2044     LEAVE;
2045 }
2046
2047 #ifdef USE_ITHREADS
2048 /* Relocate sv to the pad for thread safety.
2049  * Despite being a "constant", the SV is written to,
2050  * for reference counts, sv_upgrade() etc. */
2051 PERL_STATIC_INLINE void
2052 S_op_relocate_sv(pTHX_ SV** svp, PADOFFSET* targp)
2053 {
2054     PADOFFSET ix;
2055     PERL_ARGS_ASSERT_OP_RELOCATE_SV;
2056     if (!*svp) return;
2057     ix = pad_alloc(OP_CONST, SVf_READONLY);
2058     SvREFCNT_dec(PAD_SVl(ix));
2059     PAD_SETSV(ix, *svp);
2060     /* XXX I don't know how this isn't readonly already. */
2061     if (!SvIsCOW(PAD_SVl(ix))) SvREADONLY_on(PAD_SVl(ix));
2062     *svp = NULL;
2063     *targp = ix;
2064 }
2065 #endif
2066
2067
2068 STATIC void
2069 S_finalize_op(pTHX_ OP* o)
2070 {
2071     PERL_ARGS_ASSERT_FINALIZE_OP;
2072
2073
2074     switch (o->op_type) {
2075     case OP_NEXTSTATE:
2076     case OP_DBSTATE:
2077         PL_curcop = ((COP*)o);          /* for warnings */
2078         break;
2079     case OP_EXEC:
2080         if (OP_HAS_SIBLING(o)) {
2081             OP *sib = OP_SIBLING(o);
2082             if ((  sib->op_type == OP_NEXTSTATE || sib->op_type == OP_DBSTATE)
2083                 && ckWARN(WARN_EXEC)
2084                 && OP_HAS_SIBLING(sib))
2085             {
2086                     const OPCODE type = OP_SIBLING(sib)->op_type;
2087                     if (type != OP_EXIT && type != OP_WARN && type != OP_DIE) {
2088                         const line_t oldline = CopLINE(PL_curcop);
2089                         CopLINE_set(PL_curcop, CopLINE((COP*)sib));
2090                         Perl_warner(aTHX_ packWARN(WARN_EXEC),
2091                             "Statement unlikely to be reached");
2092                         Perl_warner(aTHX_ packWARN(WARN_EXEC),
2093                             "\t(Maybe you meant system() when you said exec()?)\n");
2094                         CopLINE_set(PL_curcop, oldline);
2095                     }
2096             }
2097         }
2098         break;
2099
2100     case OP_GV:
2101         if ((o->op_private & OPpEARLY_CV) && ckWARN(WARN_PROTOTYPE)) {
2102             GV * const gv = cGVOPo_gv;
2103             if (SvTYPE(gv) == SVt_PVGV && GvCV(gv) && SvPVX_const(GvCV(gv))) {
2104                 /* XXX could check prototype here instead of just carping */
2105                 SV * const sv = sv_newmortal();
2106                 gv_efullname3(sv, gv, NULL);
2107                 Perl_warner(aTHX_ packWARN(WARN_PROTOTYPE),
2108                     "%"SVf"() called too early to check prototype",
2109                     SVfARG(sv));
2110             }
2111         }
2112         break;
2113
2114     case OP_CONST:
2115         if (cSVOPo->op_private & OPpCONST_STRICT)
2116             no_bareword_allowed(o);
2117         /* FALLTHROUGH */
2118 #ifdef USE_ITHREADS
2119     case OP_HINTSEVAL:
2120         op_relocate_sv(&cSVOPo->op_sv, &o->op_targ);
2121 #endif
2122         break;
2123
2124 #ifdef USE_ITHREADS
2125     /* Relocate all the METHOP's SVs to the pad for thread safety. */
2126     case OP_METHOD_NAMED:
2127         op_relocate_sv(&cMETHOPx(o)->op_u.op_meth_sv, &o->op_targ);
2128         break;
2129 #endif
2130
2131     case OP_HELEM: {
2132         UNOP *rop;
2133         SV *lexname;
2134         GV **fields;
2135         SVOP *key_op;
2136         OP *kid;
2137         bool check_fields;
2138
2139         if ((key_op = cSVOPx(((BINOP*)o)->op_last))->op_type != OP_CONST)
2140             break;
2141
2142         rop = (UNOP*)((BINOP*)o)->op_first;
2143
2144         goto check_keys;
2145
2146     case OP_HSLICE:
2147         S_scalar_slice_warning(aTHX_ o);
2148         /* FALLTHROUGH */
2149
2150     case OP_KVHSLICE:
2151         kid = OP_SIBLING(cLISTOPo->op_first);
2152         if (/* I bet there's always a pushmark... */
2153             OP_TYPE_ISNT_AND_WASNT_NN(kid, OP_LIST)
2154             && OP_TYPE_ISNT_NN(kid, OP_CONST))
2155         {
2156             break;
2157         }
2158
2159         key_op = (SVOP*)(kid->op_type == OP_CONST
2160                                 ? kid
2161                                 : OP_SIBLING(kLISTOP->op_first));
2162
2163         rop = (UNOP*)((LISTOP*)o)->op_last;
2164
2165       check_keys:       
2166         if (o->op_private & OPpLVAL_INTRO || rop->op_type != OP_RV2HV)
2167             rop = NULL;
2168         else if (rop->op_first->op_type == OP_PADSV)
2169             /* @$hash{qw(keys here)} */
2170             rop = (UNOP*)rop->op_first;
2171         else {
2172             /* @{$hash}{qw(keys here)} */
2173             if (rop->op_first->op_type == OP_SCOPE
2174                 && cLISTOPx(rop->op_first)->op_last->op_type == OP_PADSV)
2175                 {
2176                     rop = (UNOP*)cLISTOPx(rop->op_first)->op_last;
2177                 }
2178             else
2179                 rop = NULL;
2180         }
2181
2182         lexname = NULL; /* just to silence compiler warnings */
2183         fields  = NULL; /* just to silence compiler warnings */
2184
2185         check_fields =
2186             rop
2187          && (lexname = *av_fetch(PL_comppad_name, rop->op_targ, TRUE),
2188              SvPAD_TYPED(lexname))
2189          && (fields = (GV**)hv_fetchs(SvSTASH(lexname), "FIELDS", FALSE))
2190          && isGV(*fields) && GvHV(*fields);
2191         for (; key_op;
2192              key_op = (SVOP*)OP_SIBLING(key_op)) {
2193             SV **svp, *sv;
2194             if (key_op->op_type != OP_CONST)
2195                 continue;
2196             svp = cSVOPx_svp(key_op);
2197
2198             /* Make the CONST have a shared SV */
2199             if ((!SvIsCOW_shared_hash(sv = *svp))
2200              && SvTYPE(sv) < SVt_PVMG && SvOK(sv) && !SvROK(sv)) {
2201                 SSize_t keylen;
2202                 const char * const key = SvPV_const(sv, *(STRLEN*)&keylen);
2203                 SV *nsv = newSVpvn_share(key,
2204                                          SvUTF8(sv) ? -keylen : keylen, 0);
2205                 SvREFCNT_dec_NN(sv);
2206                 *svp = nsv;
2207             }
2208
2209             if (check_fields
2210              && !hv_fetch_ent(GvHV(*fields), *svp, FALSE, 0)) {
2211                 Perl_croak(aTHX_ "No such class field \"%"SVf"\" " 
2212                            "in variable %"SVf" of type %"HEKf, 
2213                       SVfARG(*svp), SVfARG(lexname),
2214                       HEKfARG(HvNAME_HEK(SvSTASH(lexname))));
2215             }
2216         }
2217         break;
2218     }
2219     case OP_ASLICE:
2220         S_scalar_slice_warning(aTHX_ o);
2221         break;
2222
2223     case OP_SUBST: {
2224         if (cPMOPo->op_pmreplrootu.op_pmreplroot)
2225             finalize_op(cPMOPo->op_pmreplrootu.op_pmreplroot);
2226         break;
2227     }
2228     default:
2229         break;
2230     }
2231
2232     if (o->op_flags & OPf_KIDS) {
2233         OP *kid;
2234
2235 #ifdef DEBUGGING
2236         /* check that op_last points to the last sibling, and that
2237          * the last op_sibling field points back to the parent, and
2238          * that the only ops with KIDS are those which are entitled to
2239          * them */
2240         U32 type = o->op_type;
2241         U32 family;
2242         bool has_last;
2243
2244         if (type == OP_NULL) {
2245             type = o->op_targ;
2246             /* ck_glob creates a null UNOP with ex-type GLOB
2247              * (which is a list op. So pretend it wasn't a listop */
2248             if (type == OP_GLOB)
2249                 type = OP_NULL;
2250         }
2251         family = PL_opargs[type] & OA_CLASS_MASK;
2252
2253         has_last = (   family == OA_BINOP
2254                     || family == OA_LISTOP
2255                     || family == OA_PMOP
2256                     || family == OA_LOOP
2257                    );
2258         assert(  has_last /* has op_first and op_last, or ...
2259               ... has (or may have) op_first: */
2260               || family == OA_UNOP
2261               || family == OA_LOGOP
2262               || family == OA_BASEOP_OR_UNOP
2263               || family == OA_FILESTATOP
2264               || family == OA_LOOPEXOP
2265               || family == OA_METHOP
2266               /* I don't know why SASSIGN is tagged as OA_BASEOP - DAPM */
2267               || type == OP_SASSIGN
2268               || type == OP_CUSTOM
2269               || type == OP_NULL /* new_logop does this */
2270               );
2271         /* XXX list form of 'x' is has a null op_last. This is wrong,
2272          * but requires too much hacking (e.g. in Deparse) to fix for
2273          * now */
2274         if (type == OP_REPEAT && (o->op_private & OPpREPEAT_DOLIST)) {
2275             assert(has_last);
2276             has_last = 0;
2277         }
2278
2279         for (kid = cUNOPo->op_first; kid; kid = OP_SIBLING(kid)) {
2280 #  ifdef PERL_OP_PARENT
2281             if (!OP_HAS_SIBLING(kid)) {
2282                 if (has_last)
2283                     assert(kid == cLISTOPo->op_last);
2284                 assert(kid->op_sibling == o);
2285             }
2286 #  else
2287             if (OP_HAS_SIBLING(kid)) {
2288                 assert(!kid->op_lastsib);
2289             }
2290             else {
2291                 assert(kid->op_lastsib);
2292                 if (has_last)
2293                     assert(kid == cLISTOPo->op_last);
2294             }
2295 #  endif
2296         }
2297 #endif
2298
2299         for (kid = cUNOPo->op_first; kid; kid = OP_SIBLING(kid))
2300             finalize_op(kid);
2301     }
2302 }
2303
2304 /*
2305 =for apidoc Amx|OP *|op_lvalue|OP *o|I32 type
2306
2307 Propagate lvalue ("modifiable") context to an op and its children.
2308 I<type> represents the context type, roughly based on the type of op that
2309 would do the modifying, although C<local()> is represented by OP_NULL,
2310 because it has no op type of its own (it is signalled by a flag on
2311 the lvalue op).
2312
2313 This function detects things that can't be modified, such as C<$x+1>, and
2314 generates errors for them.  For example, C<$x+1 = 2> would cause it to be
2315 called with an op of type OP_ADD and a C<type> argument of OP_SASSIGN.
2316
2317 It also flags things that need to behave specially in an lvalue context,
2318 such as C<$$x = 5> which might have to vivify a reference in C<$x>.
2319
2320 =cut
2321 */
2322
2323 static bool
2324 S_vivifies(const OPCODE type)
2325 {
2326     switch(type) {
2327     case OP_RV2AV:     case   OP_ASLICE:
2328     case OP_RV2HV:     case OP_KVASLICE:
2329     case OP_RV2SV:     case   OP_HSLICE:
2330     case OP_AELEMFAST: case OP_KVHSLICE:
2331     case OP_HELEM:
2332     case OP_AELEM:
2333         return 1;
2334     }
2335     return 0;
2336 }
2337
2338 OP *
2339 Perl_op_lvalue_flags(pTHX_ OP *o, I32 type, U32 flags)
2340 {
2341     dVAR;
2342     OP *kid;
2343     /* -1 = error on localize, 0 = ignore localize, 1 = ok to localize */
2344     int localize = -1;
2345
2346     if (!o || (PL_parser && PL_parser->error_count))
2347         return o;
2348
2349     if ((o->op_private & OPpTARGET_MY)
2350         && (PL_opargs[o->op_type] & OA_TARGLEX))/* OPp share the meaning */
2351     {
2352         return o;
2353     }
2354
2355     assert( (o->op_flags & OPf_WANT) != OPf_WANT_VOID );
2356
2357     if (type == OP_PRTF || type == OP_SPRINTF) type = OP_ENTERSUB;
2358
2359     switch (o->op_type) {
2360     case OP_UNDEF:
2361         PL_modcount++;
2362         return o;
2363     case OP_STUB:
2364         if ((o->op_flags & OPf_PARENS))
2365             break;
2366         goto nomod;
2367     case OP_ENTERSUB:
2368         if ((type == OP_UNDEF || type == OP_REFGEN || type == OP_LOCK) &&
2369             !(o->op_flags & OPf_STACKED)) {
2370             o->op_type = OP_RV2CV;              /* entersub => rv2cv */
2371             o->op_ppaddr = PL_ppaddr[OP_RV2CV];
2372             assert(cUNOPo->op_first->op_type == OP_NULL);
2373             op_null(((LISTOP*)cUNOPo->op_first)->op_first);/* disable pushmark */
2374             break;
2375         }
2376         else {                          /* lvalue subroutine call */
2377             o->op_private |= OPpLVAL_INTRO;
2378             PL_modcount = RETURN_UNLIMITED_NUMBER;
2379             if (type == OP_GREPSTART || type == OP_ENTERSUB
2380              || type == OP_REFGEN    || type == OP_LEAVESUBLV) {
2381                 /* Potential lvalue context: */
2382                 o->op_private |= OPpENTERSUB_INARGS;
2383                 break;
2384             }
2385             else {                      /* Compile-time error message: */
2386                 OP *kid = cUNOPo->op_first;
2387                 CV *cv;
2388                 GV *gv;
2389
2390                 if (kid->op_type != OP_PUSHMARK) {
2391                     if (kid->op_type != OP_NULL || kid->op_targ != OP_LIST)
2392                         Perl_croak(aTHX_
2393                                 "panic: unexpected lvalue entersub "
2394                                 "args: type/targ %ld:%"UVuf,
2395                                 (long)kid->op_type, (UV)kid->op_targ);
2396                     kid = kLISTOP->op_first;
2397                 }
2398                 while (OP_HAS_SIBLING(kid))
2399                     kid = OP_SIBLING(kid);
2400                 if (!(kid->op_type == OP_NULL && kid->op_targ == OP_RV2CV)) {
2401                     break;      /* Postpone until runtime */
2402                 }
2403
2404                 kid = kUNOP->op_first;
2405                 if (kid->op_type == OP_NULL && kid->op_targ == OP_RV2SV)
2406                     kid = kUNOP->op_first;
2407                 if (kid->op_type == OP_NULL)
2408                     Perl_croak(aTHX_
2409                                "Unexpected constant lvalue entersub "
2410                                "entry via type/targ %ld:%"UVuf,
2411                                (long)kid->op_type, (UV)kid->op_targ);
2412                 if (kid->op_type != OP_GV) {
2413                     break;
2414                 }
2415
2416                 gv = kGVOP_gv;
2417                 cv = isGV(gv)
2418                     ? GvCV(gv)
2419                     : SvROK(gv) && SvTYPE(SvRV(gv)) == SVt_PVCV
2420                         ? MUTABLE_CV(SvRV(gv))
2421                         : NULL;
2422                 if (!cv)
2423                     break;
2424                 if (CvLVALUE(cv))
2425                     break;
2426             }
2427         }
2428         /* FALLTHROUGH */
2429     default:
2430       nomod:
2431         if (flags & OP_LVALUE_NO_CROAK) return NULL;
2432         /* grep, foreach, subcalls, refgen */
2433         if (type == OP_GREPSTART || type == OP_ENTERSUB
2434          || type == OP_REFGEN    || type == OP_LEAVESUBLV)
2435             break;
2436         yyerror(Perl_form(aTHX_ "Can't modify %s in %s",
2437                      (o->op_type == OP_NULL && (o->op_flags & OPf_SPECIAL)
2438                       ? "do block"
2439                       : (o->op_type == OP_ENTERSUB
2440                         ? "non-lvalue subroutine call"
2441                         : OP_DESC(o))),
2442                      type ? PL_op_desc[type] : "local"));
2443         return o;
2444
2445     case OP_PREINC:
2446     case OP_PREDEC:
2447     case OP_POW:
2448     case OP_MULTIPLY:
2449     case OP_DIVIDE:
2450     case OP_MODULO:
2451     case OP_REPEAT:
2452     case OP_ADD:
2453     case OP_SUBTRACT:
2454     case OP_CONCAT:
2455     case OP_LEFT_SHIFT:
2456     case OP_RIGHT_SHIFT:
2457     case OP_BIT_AND:
2458     case OP_BIT_XOR:
2459     case OP_BIT_OR:
2460     case OP_I_MULTIPLY:
2461     case OP_I_DIVIDE:
2462     case OP_I_MODULO:
2463     case OP_I_ADD:
2464     case OP_I_SUBTRACT:
2465         if (!(o->op_flags & OPf_STACKED))
2466             goto nomod;
2467         PL_modcount++;
2468         break;
2469
2470     case OP_COND_EXPR:
2471         localize = 1;
2472         for (kid = OP_SIBLING(cUNOPo->op_first); kid; kid = OP_SIBLING(kid))
2473             op_lvalue(kid, type);
2474         break;
2475
2476     case OP_RV2AV:
2477     case OP_RV2HV:
2478         if (type == OP_REFGEN && o->op_flags & OPf_PARENS) {
2479            PL_modcount = RETURN_UNLIMITED_NUMBER;
2480             return o;           /* Treat \(@foo) like ordinary list. */
2481         }
2482         /* FALLTHROUGH */
2483     case OP_RV2GV:
2484         if (scalar_mod_type(o, type))
2485             goto nomod;
2486         ref(cUNOPo->op_first, o->op_type);
2487         /* FALLTHROUGH */
2488     case OP_ASLICE:
2489     case OP_HSLICE:
2490         localize = 1;
2491         /* FALLTHROUGH */
2492     case OP_AASSIGN:
2493         /* Do not apply the lvsub flag for rv2[ah]v in scalar context.  */
2494         if (type == OP_LEAVESUBLV && (
2495                 (o->op_type != OP_RV2AV && o->op_type != OP_RV2HV)
2496              || (o->op_flags & OPf_WANT) != OPf_WANT_SCALAR
2497            ))
2498             o->op_private |= OPpMAYBE_LVSUB;
2499         /* FALLTHROUGH */
2500     case OP_NEXTSTATE:
2501     case OP_DBSTATE:
2502        PL_modcount = RETURN_UNLIMITED_NUMBER;
2503         break;
2504     case OP_KVHSLICE:
2505     case OP_KVASLICE:
2506         if (type == OP_LEAVESUBLV)
2507             o->op_private |= OPpMAYBE_LVSUB;
2508         goto nomod;
2509     case OP_AV2ARYLEN:
2510         PL_hints |= HINT_BLOCK_SCOPE;
2511         if (type == OP_LEAVESUBLV)
2512             o->op_private |= OPpMAYBE_LVSUB;
2513         PL_modcount++;
2514         break;
2515     case OP_RV2SV:
2516         ref(cUNOPo->op_first, o->op_type);
2517         localize = 1;
2518         /* FALLTHROUGH */
2519     case OP_GV:
2520         PL_hints |= HINT_BLOCK_SCOPE;
2521         /* FALLTHROUGH */
2522     case OP_SASSIGN:
2523     case OP_ANDASSIGN:
2524     case OP_ORASSIGN:
2525     case OP_DORASSIGN:
2526         PL_modcount++;
2527         break;
2528
2529     case OP_AELEMFAST:
2530     case OP_AELEMFAST_LEX:
2531         localize = -1;
2532         PL_modcount++;
2533         break;
2534
2535     case OP_PADAV:
2536     case OP_PADHV:
2537        PL_modcount = RETURN_UNLIMITED_NUMBER;
2538         if (type == OP_REFGEN && o->op_flags & OPf_PARENS)
2539             return o;           /* Treat \(@foo) like ordinary list. */
2540         if (scalar_mod_type(o, type))
2541             goto nomod;
2542         if ((o->op_flags & OPf_WANT) != OPf_WANT_SCALAR
2543           && type == OP_LEAVESUBLV)
2544             o->op_private |= OPpMAYBE_LVSUB;
2545         /* FALLTHROUGH */
2546     case OP_PADSV:
2547         PL_modcount++;
2548         if (!type) /* local() */
2549             Perl_croak(aTHX_ "Can't localize lexical variable %"SVf,
2550                  PAD_COMPNAME_SV(o->op_targ));
2551         break;
2552
2553     case OP_PUSHMARK:
2554         localize = 0;
2555         break;
2556
2557     case OP_KEYS:
2558     case OP_RKEYS:
2559         if (type != OP_SASSIGN && type != OP_LEAVESUBLV)
2560             goto nomod;
2561         goto lvalue_func;
2562     case OP_SUBSTR:
2563         if (o->op_private == 4) /* don't allow 4 arg substr as lvalue */
2564             goto nomod;
2565         /* FALLTHROUGH */
2566     case OP_POS:
2567     case OP_VEC:
2568       lvalue_func:
2569         if (type == OP_LEAVESUBLV)
2570             o->op_private |= OPpMAYBE_LVSUB;
2571         if (o->op_flags & OPf_KIDS)
2572             op_lvalue(OP_SIBLING(cBINOPo->op_first), type);
2573         break;
2574
2575     case OP_AELEM:
2576     case OP_HELEM:
2577         ref(cBINOPo->op_first, o->op_type);
2578         if (type == OP_ENTERSUB &&
2579              !(o->op_private & (OPpLVAL_INTRO | OPpDEREF)))
2580             o->op_private |= OPpLVAL_DEFER;
2581         if (type == OP_LEAVESUBLV)
2582             o->op_private |= OPpMAYBE_LVSUB;
2583         localize = 1;
2584         PL_modcount++;
2585         break;
2586
2587     case OP_LEAVE:
2588     case OP_LEAVELOOP:
2589         o->op_private |= OPpLVALUE;
2590         /* FALLTHROUGH */
2591     case OP_SCOPE:
2592     case OP_ENTER:
2593     case OP_LINESEQ:
2594         localize = 0;
2595         if (o->op_flags & OPf_KIDS)
2596             op_lvalue(cLISTOPo->op_last, type);
2597         break;
2598
2599     case OP_NULL:
2600         localize = 0;
2601         if (o->op_flags & OPf_SPECIAL)          /* do BLOCK */
2602             goto nomod;
2603         else if (!(o->op_flags & OPf_KIDS))
2604             break;
2605         if (o->op_targ != OP_LIST) {
2606             op_lvalue(cBINOPo->op_first, type);
2607             break;
2608         }
2609         /* FALLTHROUGH */
2610     case OP_LIST:
2611         localize = 0;
2612         for (kid = cLISTOPo->op_first; kid; kid = OP_SIBLING(kid))
2613             /* elements might be in void context because the list is
2614                in scalar context or because they are attribute sub calls */
2615             if ( (kid->op_flags & OPf_WANT) != OPf_WANT_VOID )
2616                 op_lvalue(kid, type);
2617         break;
2618
2619     case OP_COREARGS:
2620         return o;
2621
2622     case OP_AND:
2623     case OP_OR:
2624         if (type == OP_LEAVESUBLV
2625          || !S_vivifies(cLOGOPo->op_first->op_type))
2626             op_lvalue(cLOGOPo->op_first, type);
2627         if (type == OP_LEAVESUBLV
2628          || !S_vivifies(OP_SIBLING(cLOGOPo->op_first)->op_type))
2629             op_lvalue(OP_SIBLING(cLOGOPo->op_first), type);
2630         goto nomod;
2631
2632     case OP_SREFGEN:
2633         if (type != OP_AASSIGN) goto nomod;
2634         kid = cUNOPx(cUNOPo->op_first)->op_first;
2635         assert (!OP_HAS_SIBLING(kid));
2636         goto kid_2lvref;
2637     case OP_REFGEN:
2638         if (type != OP_AASSIGN) goto nomod;
2639         kid = OP_SIBLING(cUNOPx(cUNOPo->op_first)->op_first);
2640         do {
2641          kid_2lvref:
2642           switch (kid->op_type) {
2643           case OP_RV2AV:
2644             if (kUNOP->op_first->op_type != OP_GV) goto badref;
2645             kid->op_flags |= OPf_STACKED;
2646             if (kid->op_flags & OPf_PARENS) {
2647                 if (kid->op_private & OPpLVAL_INTRO) {
2648                      /* diag_listed_as: Can't modify %s in %s */
2649                      yyerror(Perl_form(aTHX_ "Can't modify reference to "
2650                                              "localized parenthesized "
2651                                              "array in list assignment"));
2652                     return o;
2653                 }
2654               slurpy:
2655                 kid->op_type = OP_LVAVREF;
2656                 kid->op_ppaddr = PL_ppaddr[OP_LVAVREF];
2657                 kid->op_private &= OPpLVAL_INTRO|OPpPAD_STATE;
2658                 kid->op_flags |= OPf_MOD|OPf_REF;
2659                 continue;
2660             }
2661             kid->op_private |= OPpLVREF_AV;
2662             goto checkgv;
2663           case OP_RV2HV:
2664             if (kid->op_flags & OPf_PARENS) {
2665                 /* diag_listed_as: Can't modify %s in %s */
2666               parenhash:
2667                 yyerror(Perl_form(aTHX_ "Can't modify reference to "
2668                                 "parenthesized hash in list assignment"));
2669                 return o;
2670             }
2671             kid->op_private |= OPpLVREF_HV;
2672           case OP_RV2SV:
2673            checkgv:
2674             if (kUNOP->op_first->op_type != OP_GV) goto badref;
2675             kid->op_flags |= OPf_STACKED;
2676           case OP_PADSV:
2677             break;
2678           case OP_PADAV:
2679             if (kid->op_flags & OPf_PARENS) goto slurpy;
2680             kid->op_private |= OPpLVREF_AV;
2681             break;
2682           case OP_PADHV:
2683             if (kid->op_flags & OPf_PARENS) goto parenhash;
2684             kid->op_private |= OPpLVREF_HV;
2685             break;
2686           case OP_AELEM:
2687           case OP_HELEM:
2688             kid->op_private |= OPpLVREF_ELEM;
2689             kid->op_flags   |= OPf_STACKED;
2690             break;
2691           case OP_ASLICE:
2692           case OP_HSLICE:
2693             kid->op_type = OP_LVREFSLICE;
2694             kid->op_ppaddr = PL_ppaddr[OP_LVREFSLICE];
2695             kid->op_private &= OPpLVAL_INTRO|OPpLVREF_ELEM;
2696             continue;
2697           default:
2698            badref:
2699             /* diag_listed_as: Can't modify %s in %s */
2700             yyerror(Perl_form(aTHX_ "Can't modify reference to %s in list "
2701                                     "assignment",
2702                      o->op_type == OP_NULL && o->op_flags & OPf_SPECIAL
2703                       ? "do block"
2704                       : OP_DESC(kid)));
2705             return o;
2706           }
2707           kid->op_type = OP_LVREF;
2708           kid->op_ppaddr = PL_ppaddr[OP_LVREF];
2709           kid->op_private &= OPpLVAL_INTRO|OPpLVREF_ELEM|OPpLVREF_TYPE;
2710         } while ((kid = OP_SIBLING(kid)));
2711         if (!FEATURE_LVREF_IS_ENABLED)
2712             Perl_croak(aTHX_ "Experimental lvalue references not enabled");
2713         Perl_ck_warner_d(aTHX_ packWARN(WARN_EXPERIMENTAL__LVALUE_REFS),
2714                               "Lvalue references are experimental");
2715         if (o->op_type == OP_REFGEN)
2716             op_null(cUNOPx(cUNOPo->op_first)->op_first); /* pushmark */
2717         op_null(o);
2718         return o;
2719     }
2720
2721     /* [20011101.069] File test operators interpret OPf_REF to mean that
2722        their argument is a filehandle; thus \stat(".") should not set
2723        it. AMS 20011102 */
2724     if (type == OP_REFGEN &&
2725         PL_check[o->op_type] == Perl_ck_ftst)
2726         return o;
2727
2728     if (type != OP_LEAVESUBLV)
2729         o->op_flags |= OPf_MOD;
2730
2731     if (type == OP_AASSIGN || type == OP_SASSIGN)
2732         o->op_flags |= OPf_SPECIAL|OPf_REF;
2733     else if (!type) { /* local() */
2734         switch (localize) {
2735         case 1:
2736             o->op_private |= OPpLVAL_INTRO;
2737             o->op_flags &= ~OPf_SPECIAL;
2738             PL_hints |= HINT_BLOCK_SCOPE;
2739             break;
2740         case 0:
2741             break;
2742         case -1:
2743             Perl_ck_warner(aTHX_ packWARN(WARN_SYNTAX),
2744                            "Useless localization of %s", OP_DESC(o));
2745         }
2746     }
2747     else if (type != OP_GREPSTART && type != OP_ENTERSUB
2748              && type != OP_LEAVESUBLV)
2749         o->op_flags |= OPf_REF;
2750     return o;
2751 }
2752
2753 STATIC bool
2754 S_scalar_mod_type(const OP *o, I32 type)
2755 {
2756     switch (type) {
2757     case OP_POS:
2758     case OP_SASSIGN:
2759         if (o && o->op_type == OP_RV2GV)
2760             return FALSE;
2761         /* FALLTHROUGH */
2762     case OP_PREINC:
2763     case OP_PREDEC:
2764     case OP_POSTINC:
2765     case OP_POSTDEC:
2766     case OP_I_PREINC:
2767     case OP_I_PREDEC:
2768     case OP_I_POSTINC:
2769     case OP_I_POSTDEC:
2770     case OP_POW:
2771     case OP_MULTIPLY:
2772     case OP_DIVIDE:
2773     case OP_MODULO:
2774     case OP_REPEAT:
2775     case OP_ADD:
2776     case OP_SUBTRACT:
2777     case OP_I_MULTIPLY:
2778     case OP_I_DIVIDE:
2779     case OP_I_MODULO:
2780     case OP_I_ADD:
2781     case OP_I_SUBTRACT:
2782     case OP_LEFT_SHIFT:
2783     case OP_RIGHT_SHIFT:
2784     case OP_BIT_AND:
2785     case OP_BIT_XOR:
2786     case OP_BIT_OR:
2787     case OP_CONCAT:
2788     case OP_SUBST:
2789     case OP_TRANS:
2790     case OP_TRANSR:
2791     case OP_READ:
2792     case OP_SYSREAD:
2793     case OP_RECV:
2794     case OP_ANDASSIGN:
2795     case OP_ORASSIGN:
2796     case OP_DORASSIGN:
2797         return TRUE;
2798     default:
2799         return FALSE;
2800     }
2801 }
2802
2803 STATIC bool
2804 S_is_handle_constructor(const OP *o, I32 numargs)
2805 {
2806     PERL_ARGS_ASSERT_IS_HANDLE_CONSTRUCTOR;
2807
2808     switch (o->op_type) {
2809     case OP_PIPE_OP:
2810     case OP_SOCKPAIR:
2811         if (numargs == 2)
2812             return TRUE;
2813         /* FALLTHROUGH */
2814     case OP_SYSOPEN:
2815     case OP_OPEN:
2816     case OP_SELECT:             /* XXX c.f. SelectSaver.pm */
2817     case OP_SOCKET:
2818     case OP_OPEN_DIR:
2819     case OP_ACCEPT:
2820         if (numargs == 1)
2821             return TRUE;
2822         /* FALLTHROUGH */
2823     default:
2824         return FALSE;
2825     }
2826 }
2827
2828 static OP *
2829 S_refkids(pTHX_ OP *o, I32 type)
2830 {
2831     if (o && o->op_flags & OPf_KIDS) {
2832         OP *kid;
2833         for (kid = cLISTOPo->op_first; kid; kid = OP_SIBLING(kid))
2834             ref(kid, type);
2835     }
2836     return o;
2837 }
2838
2839 OP *
2840 Perl_doref(pTHX_ OP *o, I32 type, bool set_op_ref)
2841 {
2842     dVAR;
2843     OP *kid;
2844
2845     PERL_ARGS_ASSERT_DOREF;
2846
2847     if (!o || (PL_parser && PL_parser->error_count))
2848         return o;
2849
2850     switch (o->op_type) {
2851     case OP_ENTERSUB:
2852         if ((type == OP_EXISTS || type == OP_DEFINED) &&
2853             !(o->op_flags & OPf_STACKED)) {
2854             o->op_type = OP_RV2CV;             /* entersub => rv2cv */
2855             o->op_ppaddr = PL_ppaddr[OP_RV2CV];
2856             assert(cUNOPo->op_first->op_type == OP_NULL);
2857             op_null(((LISTOP*)cUNOPo->op_first)->op_first);     /* disable pushmark */
2858             o->op_flags |= OPf_SPECIAL;
2859         }
2860         else if (type == OP_RV2SV || type == OP_RV2AV || type == OP_RV2HV){
2861             o->op_private |= (type == OP_RV2AV ? OPpDEREF_AV
2862                               : type == OP_RV2HV ? OPpDEREF_HV
2863                               : OPpDEREF_SV);
2864             o->op_flags |= OPf_MOD;
2865         }
2866
2867         break;
2868
2869     case OP_COND_EXPR:
2870         for (kid = OP_SIBLING(cUNOPo->op_first); kid; kid = OP_SIBLING(kid))
2871             doref(kid, type, set_op_ref);
2872         break;
2873     case OP_RV2SV:
2874         if (type == OP_DEFINED)
2875             o->op_flags |= OPf_SPECIAL;         /* don't create GV */
2876         doref(cUNOPo->op_first, o->op_type, set_op_ref);
2877         /* FALLTHROUGH */
2878     case OP_PADSV:
2879         if (type == OP_RV2SV || type == OP_RV2AV || type == OP_RV2HV) {
2880             o->op_private |= (type == OP_RV2AV ? OPpDEREF_AV
2881                               : type == OP_RV2HV ? OPpDEREF_HV
2882                               : OPpDEREF_SV);
2883             o->op_flags |= OPf_MOD;
2884         }
2885         break;
2886
2887     case OP_RV2AV:
2888     case OP_RV2HV:
2889         if (set_op_ref)
2890             o->op_flags |= OPf_REF;
2891         /* FALLTHROUGH */
2892     case OP_RV2GV:
2893         if (type == OP_DEFINED)
2894             o->op_flags |= OPf_SPECIAL;         /* don't create GV */
2895         doref(cUNOPo->op_first, o->op_type, set_op_ref);
2896         break;
2897
2898     case OP_PADAV:
2899     case OP_PADHV:
2900         if (set_op_ref)
2901             o->op_flags |= OPf_REF;
2902         break;
2903
2904     case OP_SCALAR:
2905     case OP_NULL:
2906         if (!(o->op_flags & OPf_KIDS) || type == OP_DEFINED)
2907             break;
2908         doref(cBINOPo->op_first, type, set_op_ref);
2909         break;
2910     case OP_AELEM:
2911     case OP_HELEM:
2912         doref(cBINOPo->op_first, o->op_type, set_op_ref);
2913         if (type == OP_RV2SV || type == OP_RV2AV || type == OP_RV2HV) {
2914             o->op_private |= (type == OP_RV2AV ? OPpDEREF_AV
2915                               : type == OP_RV2HV ? OPpDEREF_HV
2916                               : OPpDEREF_SV);
2917             o->op_flags |= OPf_MOD;
2918         }
2919         break;
2920
2921     case OP_SCOPE:
2922     case OP_LEAVE:
2923         set_op_ref = FALSE;
2924         /* FALLTHROUGH */
2925     case OP_ENTER:
2926     case OP_LIST:
2927         if (!(o->op_flags & OPf_KIDS))
2928             break;
2929         doref(cLISTOPo->op_last, type, set_op_ref);
2930         break;
2931     default:
2932         break;
2933     }
2934     return scalar(o);
2935
2936 }
2937
2938 STATIC OP *
2939 S_dup_attrlist(pTHX_ OP *o)
2940 {
2941     OP *rop;
2942
2943     PERL_ARGS_ASSERT_DUP_ATTRLIST;
2944
2945     /* An attrlist is either a simple OP_CONST or an OP_LIST with kids,
2946      * where the first kid is OP_PUSHMARK and the remaining ones
2947      * are OP_CONST.  We need to push the OP_CONST values.
2948      */
2949     if (o->op_type == OP_CONST)
2950         rop = newSVOP(OP_CONST, o->op_flags, SvREFCNT_inc_NN(cSVOPo->op_sv));
2951     else {
2952         assert((o->op_type == OP_LIST) && (o->op_flags & OPf_KIDS));
2953         rop = NULL;
2954         for (o = cLISTOPo->op_first; o; o = OP_SIBLING(o)) {
2955             if (o->op_type == OP_CONST)
2956                 rop = op_append_elem(OP_LIST, rop,
2957                                   newSVOP(OP_CONST, o->op_flags,
2958                                           SvREFCNT_inc_NN(cSVOPo->op_sv)));
2959         }
2960     }
2961     return rop;
2962 }
2963
2964 STATIC void
2965 S_apply_attrs(pTHX_ HV *stash, SV *target, OP *attrs)
2966 {
2967     SV * const stashsv = stash ? newSVhek(HvNAME_HEK(stash)) : &PL_sv_no;
2968
2969     PERL_ARGS_ASSERT_APPLY_ATTRS;
2970
2971     /* fake up C<use attributes $pkg,$rv,@attrs> */
2972
2973 #define ATTRSMODULE "attributes"
2974 #define ATTRSMODULE_PM "attributes.pm"
2975
2976     Perl_load_module(aTHX_ PERL_LOADMOD_IMPORT_OPS,
2977                          newSVpvs(ATTRSMODULE),
2978                          NULL,
2979                          op_prepend_elem(OP_LIST,
2980                                       newSVOP(OP_CONST, 0, stashsv),
2981                                       op_prepend_elem(OP_LIST,
2982                                                    newSVOP(OP_CONST, 0,
2983                                                            newRV(target)),
2984                                                    dup_attrlist(attrs))));
2985 }
2986
2987 STATIC void
2988 S_apply_attrs_my(pTHX_ HV *stash, OP *target, OP *attrs, OP **imopsp)
2989 {
2990     OP *pack, *imop, *arg;
2991     SV *meth, *stashsv, **svp;
2992
2993     PERL_ARGS_ASSERT_APPLY_ATTRS_MY;
2994
2995     if (!attrs)
2996         return;
2997
2998     assert(target->op_type == OP_PADSV ||
2999            target->op_type == OP_PADHV ||
3000            target->op_type == OP_PADAV);
3001
3002     /* Ensure that attributes.pm is loaded. */
3003     /* Don't force the C<use> if we don't need it. */
3004     svp = hv_fetchs(GvHVn(PL_incgv), ATTRSMODULE_PM, FALSE);
3005     if (svp && *svp != &PL_sv_undef)
3006         NOOP;   /* already in %INC */
3007     else
3008         Perl_load_module(aTHX_ PERL_LOADMOD_NOIMPORT,
3009                                newSVpvs(ATTRSMODULE), NULL);
3010
3011     /* Need package name for method call. */
3012     pack = newSVOP(OP_CONST, 0, newSVpvs(ATTRSMODULE));
3013
3014     /* Build up the real arg-list. */
3015     stashsv = stash ? newSVhek(HvNAME_HEK(stash)) : &PL_sv_no;
3016
3017     arg = newOP(OP_PADSV, 0);
3018     arg->op_targ = target->op_targ;
3019     arg = op_prepend_elem(OP_LIST,
3020                        newSVOP(OP_CONST, 0, stashsv),
3021                        op_prepend_elem(OP_LIST,
3022                                     newUNOP(OP_REFGEN, 0,
3023                                             op_lvalue(arg, OP_REFGEN)),
3024                                     dup_attrlist(attrs)));
3025
3026     /* Fake up a method call to import */
3027     meth = newSVpvs_share("import");
3028     imop = convert(OP_ENTERSUB, OPf_STACKED|OPf_SPECIAL|OPf_WANT_VOID,
3029                    op_append_elem(OP_LIST,
3030                                op_prepend_elem(OP_LIST, pack, list(arg)),
3031                                newMETHOP_named(OP_METHOD_NAMED, 0, meth)));
3032
3033     /* Combine the ops. */
3034     *imopsp = op_append_elem(OP_LIST, *imopsp, imop);
3035 }
3036
3037 /*
3038 =notfor apidoc apply_attrs_string
3039
3040 Attempts to apply a list of attributes specified by the C<attrstr> and
3041 C<len> arguments to the subroutine identified by the C<cv> argument which
3042 is expected to be associated with the package identified by the C<stashpv>
3043 argument (see L<attributes>).  It gets this wrong, though, in that it
3044 does not correctly identify the boundaries of the individual attribute
3045 specifications within C<attrstr>.  This is not really intended for the
3046 public API, but has to be listed here for systems such as AIX which
3047 need an explicit export list for symbols.  (It's called from XS code
3048 in support of the C<ATTRS:> keyword from F<xsubpp>.)  Patches to fix it
3049 to respect attribute syntax properly would be welcome.
3050
3051 =cut
3052 */
3053
3054 void
3055 Perl_apply_attrs_string(pTHX_ const char *stashpv, CV *cv,
3056                         const char *attrstr, STRLEN len)
3057 {
3058     OP *attrs = NULL;
3059
3060     PERL_ARGS_ASSERT_APPLY_ATTRS_STRING;
3061
3062     if (!len) {
3063         len = strlen(attrstr);
3064     }
3065
3066     while (len) {
3067         for (; isSPACE(*attrstr) && len; --len, ++attrstr) ;
3068         if (len) {
3069             const char * const sstr = attrstr;
3070             for (; !isSPACE(*attrstr) && len; --len, ++attrstr) ;
3071             attrs = op_append_elem(OP_LIST, attrs,
3072                                 newSVOP(OP_CONST, 0,
3073                                         newSVpvn(sstr, attrstr-sstr)));
3074         }
3075     }
3076
3077     Perl_load_module(aTHX_ PERL_LOADMOD_IMPORT_OPS,
3078                      newSVpvs(ATTRSMODULE),
3079                      NULL, op_prepend_elem(OP_LIST,
3080                                   newSVOP(OP_CONST, 0, newSVpv(stashpv,0)),
3081                                   op_prepend_elem(OP_LIST,
3082                                                newSVOP(OP_CONST, 0,
3083                                                        newRV(MUTABLE_SV(cv))),
3084                                                attrs)));
3085 }
3086
3087 STATIC void
3088 S_move_proto_attr(pTHX_ OP **proto, OP **attrs, const GV * name)
3089 {
3090     OP *new_proto = NULL;
3091     STRLEN pvlen;
3092     char *pv;
3093     OP *o;
3094
3095     PERL_ARGS_ASSERT_MOVE_PROTO_ATTR;
3096
3097     if (!*attrs)
3098         return;
3099
3100     o = *attrs;
3101     if (o->op_type == OP_CONST) {
3102         pv = SvPV(cSVOPo_sv, pvlen);
3103         if (pvlen >= 10 && memEQ(pv, "prototype(", 10)) {
3104             SV * const tmpsv = newSVpvn_flags(pv + 10, pvlen - 11, SvUTF8(cSVOPo_sv));
3105             SV ** const tmpo = cSVOPx_svp(o);
3106             SvREFCNT_dec(cSVOPo_sv);
3107             *tmpo = tmpsv;
3108             new_proto = o;
3109             *attrs = NULL;
3110         }
3111     } else if (o->op_type == OP_LIST) {
3112         OP * lasto;
3113         assert(o->op_flags & OPf_KIDS);
3114         lasto = cLISTOPo->op_first;
3115         assert(lasto->op_type == OP_PUSHMARK);
3116         for (o = OP_SIBLING(lasto); o; o = OP_SIBLING(o)) {
3117             if (o->op_type == OP_CONST) {
3118                 pv = SvPV(cSVOPo_sv, pvlen);
3119                 if (pvlen >= 10 && memEQ(pv, "prototype(", 10)) {
3120                     SV * const tmpsv = newSVpvn_flags(pv + 10, pvlen - 11, SvUTF8(cSVOPo_sv));
3121                     SV ** const tmpo = cSVOPx_svp(o);
3122                     SvREFCNT_dec(cSVOPo_sv);
3123                     *tmpo = tmpsv;
3124                     if (new_proto && ckWARN(WARN_MISC)) {
3125                         STRLEN new_len;
3126                         const char * newp = SvPV(cSVOPo_sv, new_len);
3127                         Perl_warner(aTHX_ packWARN(WARN_MISC),
3128                             "Attribute prototype(%"UTF8f") discards earlier prototype attribute in same sub",
3129                             UTF8fARG(SvUTF8(cSVOPo_sv), new_len, newp));
3130                         op_free(new_proto);
3131                     }
3132                     else if (new_proto)
3133                         op_free(new_proto);
3134                     new_proto = o;
3135                     /* excise new_proto from the list */
3136                     op_sibling_splice(*attrs, lasto, 1, NULL);
3137                     o = lasto;
3138                     continue;
3139                 }
3140             }
3141             lasto = o;
3142         }
3143         /* If the list is now just the PUSHMARK, scrap the whole thing; otherwise attributes.xs
3144            would get pulled in with no real need */
3145         if (!OP_HAS_SIBLING(cLISTOPx(*attrs)->op_first)) {
3146             op_free(*attrs);
3147             *attrs = NULL;
3148         }
3149     }
3150
3151     if (new_proto) {
3152         SV *svname;
3153         if (isGV(name)) {
3154             svname = sv_newmortal();
3155             gv_efullname3(svname, name, NULL);
3156         }
3157         else if (SvPOK(name) && *SvPVX((SV *)name) == '&')
3158             svname = newSVpvn_flags(SvPVX((SV *)name)+1, SvCUR(name)-1, SvUTF8(name)|SVs_TEMP);
3159         else
3160             svname = (SV *)name;
3161         if (ckWARN(WARN_ILLEGALPROTO))
3162             (void)validate_proto(svname, cSVOPx_sv(new_proto), TRUE);
3163         if (*proto && ckWARN(WARN_PROTOTYPE)) {
3164             STRLEN old_len, new_len;
3165             const char * oldp = SvPV(cSVOPx_sv(*proto), old_len);
3166             const char * newp = SvPV(cSVOPx_sv(new_proto), new_len);
3167
3168             Perl_warner(aTHX_ packWARN(WARN_PROTOTYPE),
3169                 "Prototype '%"UTF8f"' overridden by attribute 'prototype(%"UTF8f")'"
3170                 " in %"SVf,
3171                 UTF8fARG(SvUTF8(cSVOPx_sv(*proto)), old_len, oldp),
3172                 UTF8fARG(SvUTF8(cSVOPx_sv(new_proto)), new_len, newp),
3173                 SVfARG(svname));
3174         }
3175         if (*proto)
3176             op_free(*proto);
3177         *proto = new_proto;
3178     }
3179 }
3180
3181 static void
3182 S_cant_declare(pTHX_ OP *o)
3183 {
3184     if (o->op_type == OP_NULL
3185      && (o->op_flags & (OPf_SPECIAL|OPf_KIDS)) == OPf_KIDS)
3186         o = cUNOPo->op_first;
3187     yyerror(Perl_form(aTHX_ "Can't declare %s in \"%s\"",
3188                              o->op_type == OP_NULL
3189                                && o->op_flags & OPf_SPECIAL
3190                                  ? "do block"
3191                                  : OP_DESC(o),
3192                              PL_parser->in_my == KEY_our   ? "our"   :
3193                              PL_parser->in_my == KEY_state ? "state" :
3194                                                              "my"));
3195 }
3196
3197 STATIC OP *
3198 S_my_kid(pTHX_ OP *o, OP *attrs, OP **imopsp)
3199 {
3200     I32 type;
3201     const bool stately = PL_parser && PL_parser->in_my == KEY_state;
3202
3203     PERL_ARGS_ASSERT_MY_KID;
3204
3205     if (!o || (PL_parser && PL_parser->error_count))
3206         return o;
3207
3208     type = o->op_type;
3209
3210     if (type == OP_LIST) {
3211         OP *kid;
3212         for (kid = cLISTOPo->op_first; kid; kid = OP_SIBLING(kid))
3213             my_kid(kid, attrs, imopsp);
3214         return o;
3215     } else if (type == OP_UNDEF || type == OP_STUB) {
3216         return o;
3217     } else if (type == OP_RV2SV ||      /* "our" declaration */
3218                type == OP_RV2AV ||
3219                type == OP_RV2HV) { /* XXX does this let anything illegal in? */
3220         if (cUNOPo->op_first->op_type != OP_GV) { /* MJD 20011224 */
3221             S_cant_declare(aTHX_ o);
3222         } else if (attrs) {
3223             GV * const gv = cGVOPx_gv(cUNOPo->op_first);
3224             assert(PL_parser);
3225             PL_parser->in_my = FALSE;
3226             PL_parser->in_my_stash = NULL;
3227             apply_attrs(GvSTASH(gv),
3228                         (type == OP_RV2SV ? GvSV(gv) :
3229                          type == OP_RV2AV ? MUTABLE_SV(GvAV(gv)) :
3230                          type == OP_RV2HV ? MUTABLE_SV(GvHV(gv)) : MUTABLE_SV(gv)),
3231                         attrs);
3232         }
3233         o->op_private |= OPpOUR_INTRO;
3234         return o;
3235     }
3236     else if (type != OP_PADSV &&
3237              type != OP_PADAV &&
3238              type != OP_PADHV &&
3239              type != OP_PUSHMARK)
3240     {
3241         S_cant_declare(aTHX_ o);
3242         return o;
3243     }
3244     else if (attrs && type != OP_PUSHMARK) {
3245         HV *stash;
3246
3247         assert(PL_parser);
3248         PL_parser->in_my = FALSE;
3249         PL_parser->in_my_stash = NULL;
3250
3251         /* check for C<my Dog $spot> when deciding package */
3252         stash = PAD_COMPNAME_TYPE(o->op_targ);
3253         if (!stash)
3254             stash = PL_curstash;
3255         apply_attrs_my(stash, o, attrs, imopsp);
3256     }
3257     o->op_flags |= OPf_MOD;
3258     o->op_private |= OPpLVAL_INTRO;
3259     if (stately)
3260         o->op_private |= OPpPAD_STATE;
3261     return o;
3262 }
3263
3264 OP *
3265 Perl_my_attrs(pTHX_ OP *o, OP *attrs)
3266 {
3267     OP *rops;
3268     int maybe_scalar = 0;
3269
3270     PERL_ARGS_ASSERT_MY_ATTRS;
3271
3272 /* [perl #17376]: this appears to be premature, and results in code such as
3273    C< our(%x); > executing in list mode rather than void mode */
3274 #if 0
3275     if (o->op_flags & OPf_PARENS)
3276         list(o);
3277     else
3278         maybe_scalar = 1;
3279 #else
3280     maybe_scalar = 1;
3281 #endif
3282     if (attrs)
3283         SAVEFREEOP(attrs);
3284     rops = NULL;
3285     o = my_kid(o, attrs, &rops);
3286     if (rops) {
3287         if (maybe_scalar && o->op_type == OP_PADSV) {
3288             o = scalar(op_append_list(OP_LIST, rops, o));
3289             o->op_private |= OPpLVAL_INTRO;
3290         }
3291         else {
3292             /* The listop in rops might have a pushmark at the beginning,
3293                which will mess up list assignment. */
3294             LISTOP * const lrops = (LISTOP *)rops; /* for brevity */
3295             if (rops->op_type == OP_LIST && 
3296                 lrops->op_first && lrops->op_first->op_type == OP_PUSHMARK)
3297             {
3298                 OP * const pushmark = lrops->op_first;
3299                 /* excise pushmark */
3300                 op_sibling_splice(rops, NULL, 1, NULL);
3301                 op_free(pushmark);
3302             }
3303             o = op_append_list(OP_LIST, o, rops);
3304         }
3305     }
3306     PL_parser->in_my = FALSE;
3307     PL_parser->in_my_stash = NULL;
3308     return o;
3309 }
3310
3311 OP *
3312 Perl_sawparens(pTHX_ OP *o)
3313 {
3314     PERL_UNUSED_CONTEXT;
3315     if (o)
3316         o->op_flags |= OPf_PARENS;
3317     return o;
3318 }
3319
3320 OP *
3321 Perl_bind_match(pTHX_ I32 type, OP *left, OP *right)
3322 {
3323     OP *o;
3324     bool ismatchop = 0;
3325     const OPCODE ltype = left->op_type;
3326     const OPCODE rtype = right->op_type;
3327
3328     PERL_ARGS_ASSERT_BIND_MATCH;
3329
3330     if ( (ltype == OP_RV2AV || ltype == OP_RV2HV || ltype == OP_PADAV
3331           || ltype == OP_PADHV) && ckWARN(WARN_MISC))
3332     {
3333       const char * const desc
3334           = PL_op_desc[(
3335                           rtype == OP_SUBST || rtype == OP_TRANS
3336                        || rtype == OP_TRANSR
3337                        )
3338                        ? (int)rtype : OP_MATCH];
3339       const bool isary = ltype == OP_RV2AV || ltype == OP_PADAV;
3340       SV * const name =
3341         S_op_varname(aTHX_ left);
3342       if (name)
3343         Perl_warner(aTHX_ packWARN(WARN_MISC),
3344              "Applying %s to %"SVf" will act on scalar(%"SVf")",
3345              desc, SVfARG(name), SVfARG(name));
3346       else {
3347         const char * const sample = (isary
3348              ? "@array" : "%hash");
3349         Perl_warner(aTHX_ packWARN(WARN_MISC),
3350              "Applying %s to %s will act on scalar(%s)",
3351              desc, sample, sample);
3352       }
3353     }
3354
3355     if (rtype == OP_CONST &&
3356         cSVOPx(right)->op_private & OPpCONST_BARE &&
3357         cSVOPx(right)->op_private & OPpCONST_STRICT)
3358     {
3359         no_bareword_allowed(right);
3360     }
3361
3362     /* !~ doesn't make sense with /r, so error on it for now */
3363     if (rtype == OP_SUBST && (cPMOPx(right)->op_pmflags & PMf_NONDESTRUCT) &&
3364         type == OP_NOT)
3365         /* diag_listed_as: Using !~ with %s doesn't make sense */
3366         yyerror("Using !~ with s///r doesn't make sense");
3367     if (rtype == OP_TRANSR && type == OP_NOT)
3368         /* diag_listed_as: Using !~ with %s doesn't make sense */
3369         yyerror("Using !~ with tr///r doesn't make sense");
3370
3371     ismatchop = (rtype == OP_MATCH ||
3372                  rtype == OP_SUBST ||
3373                  rtype == OP_TRANS || rtype == OP_TRANSR)
3374              && !(right->op_flags & OPf_SPECIAL);
3375     if (ismatchop && right->op_private & OPpTARGET_MY) {
3376         right->op_targ = 0;
3377         right->op_private &= ~OPpTARGET_MY;
3378     }
3379     if (!(right->op_flags & OPf_STACKED) && ismatchop) {
3380         OP *newleft;
3381
3382         right->op_flags |= OPf_STACKED;
3383         if (rtype != OP_MATCH && rtype != OP_TRANSR &&
3384             ! (rtype == OP_TRANS &&
3385                right->op_private & OPpTRANS_IDENTICAL) &&
3386             ! (rtype == OP_SUBST &&
3387                (cPMOPx(right)->op_pmflags & PMf_NONDESTRUCT)))
3388             newleft = op_lvalue(left, rtype);
3389         else
3390             newleft = left;
3391         if (right->op_type == OP_TRANS || right->op_type == OP_TRANSR)
3392             o = newBINOP(OP_NULL, OPf_STACKED, scalar(newleft), right);
3393         else
3394             o = op_prepend_elem(rtype, scalar(newleft), right);
3395         if (type == OP_NOT)
3396             return newUNOP(OP_NOT, 0, scalar(o));
3397         return o;
3398     }
3399     else
3400         return bind_match(type, left,
3401                 pmruntime(newPMOP(OP_MATCH, 0), right, 0, 0));
3402 }
3403
3404 OP *
3405 Perl_invert(pTHX_ OP *o)
3406 {
3407     if (!o)
3408         return NULL;
3409     return newUNOP(OP_NOT, OPf_SPECIAL, scalar(o));
3410 }
3411
3412 /*
3413 =for apidoc Amx|OP *|op_scope|OP *o
3414
3415 Wraps up an op tree with some additional ops so that at runtime a dynamic
3416 scope will be created.  The original ops run in the new dynamic scope,
3417 and then, provided that they exit normally, the scope will be unwound.
3418 The additional ops used to create and unwind the dynamic scope will
3419 normally be an C<enter>/C<leave> pair, but a C<scope> op may be used
3420 instead if the ops are simple enough to not need the full dynamic scope
3421 structure.
3422
3423 =cut
3424 */
3425
3426 OP *
3427 Perl_op_scope(pTHX_ OP *o)
3428 {
3429     dVAR;
3430     if (o) {
3431         if (o->op_flags & OPf_PARENS || PERLDB_NOOPT || TAINTING_get) {
3432             o = op_prepend_elem(OP_LINESEQ, newOP(OP_ENTER, 0), o);
3433             o->op_type = OP_LEAVE;
3434             o->op_ppaddr = PL_ppaddr[OP_LEAVE];
3435         }
3436         else if (o->op_type == OP_LINESEQ) {
3437             OP *kid;
3438             o->op_type = OP_SCOPE;
3439             o->op_ppaddr = PL_ppaddr[OP_SCOPE];
3440             kid = ((LISTOP*)o)->op_first;
3441             if (kid->op_type == OP_NEXTSTATE || kid->op_type == OP_DBSTATE) {
3442                 op_null(kid);
3443
3444                 /* The following deals with things like 'do {1 for 1}' */
3445                 kid = OP_SIBLING(kid);
3446                 if (kid &&
3447                     (kid->op_type == OP_NEXTSTATE || kid->op_type == OP_DBSTATE))
3448                     op_null(kid);
3449             }
3450         }
3451         else
3452             o = newLISTOP(OP_SCOPE, 0, o, NULL);
3453     }
3454     return o;
3455 }
3456
3457 OP *
3458 Perl_op_unscope(pTHX_ OP *o)
3459 {
3460     if (o && o->op_type == OP_LINESEQ) {
3461         OP *kid = cLISTOPo->op_first;
3462         for(; kid; kid = OP_SIBLING(kid))
3463             if (kid->op_type == OP_NEXTSTATE || kid->op_type == OP_DBSTATE)
3464                 op_null(kid);
3465     }
3466     return o;
3467 }
3468
3469 int
3470 Perl_block_start(pTHX_ int full)
3471 {
3472     const int retval = PL_savestack_ix;
3473
3474     pad_block_start(full);
3475     SAVEHINTS();
3476     PL_hints &= ~HINT_BLOCK_SCOPE;
3477     SAVECOMPILEWARNINGS();
3478     PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
3479
3480     CALL_BLOCK_HOOKS(bhk_start, full);
3481
3482     return retval;
3483 }
3484
3485 OP*
3486 Perl_block_end(pTHX_ I32 floor, OP *seq)
3487 {
3488     const int needblockscope = PL_hints & HINT_BLOCK_SCOPE;
3489     OP* retval = scalarseq(seq);
3490     OP *o;
3491
3492     CALL_BLOCK_HOOKS(bhk_pre_end, &retval);
3493
3494     LEAVE_SCOPE(floor);
3495     if (needblockscope)
3496         PL_hints |= HINT_BLOCK_SCOPE; /* propagate out */
3497     o = pad_leavemy();
3498
3499     if (o) {
3500         /* pad_leavemy has created a sequence of introcv ops for all my
3501            subs declared in the block.  We have to replicate that list with
3502            clonecv ops, to deal with this situation:
3503
3504                sub {
3505                    my sub s1;
3506                    my sub s2;
3507                    sub s1 { state sub foo { \&s2 } }
3508                }->()
3509
3510            Originally, I was going to have introcv clone the CV and turn
3511            off the stale flag.  Since &s1 is declared before &s2, the
3512            introcv op for &s1 is executed (on sub entry) before the one for
3513            &s2.  But the &foo sub inside &s1 (which is cloned when &s1 is
3514            cloned, since it is a state sub) closes over &s2 and expects
3515            to see it in its outer CV’s pad.  If the introcv op clones &s1,
3516            then &s2 is still marked stale.  Since &s1 is not active, and
3517            &foo closes over &s1’s implicit entry for &s2, we get a ‘Varia-
3518            ble will not stay shared’ warning.  Because it is the same stub
3519            that will be used when the introcv op for &s2 is executed, clos-
3520            ing over it is safe.  Hence, we have to turn off the stale flag
3521            on all lexical subs in the block before we clone any of them.
3522            Hence, having introcv clone the sub cannot work.  So we create a
3523            list of ops like this:
3524
3525                lineseq
3526                   |
3527                   +-- introcv
3528                   |
3529                   +-- introcv
3530                   |
3531                   +-- introcv
3532                   |
3533                   .
3534                   .
3535                   .
3536                   |
3537                   +-- clonecv
3538                   |
3539                   +-- clonecv
3540                   |
3541                   +-- clonecv
3542                   |
3543                   .
3544                   .
3545                   .
3546          */
3547         OP *kid = o->op_flags & OPf_KIDS ? cLISTOPo->op_first : o;
3548         OP * const last = o->op_flags & OPf_KIDS ? cLISTOPo->op_last : o;
3549         for (;; kid = OP_SIBLING(kid)) {
3550             OP *newkid = newOP(OP_CLONECV, 0);
3551             newkid->op_targ = kid->op_targ;
3552             o = op_append_elem(OP_LINESEQ, o, newkid);
3553             if (kid == last) break;
3554         }
3555         retval = op_prepend_elem(OP_LINESEQ, o, retval);
3556     }
3557
3558     CALL_BLOCK_HOOKS(bhk_post_end, &retval);
3559
3560     return retval;
3561 }
3562
3563 /*
3564 =head1 Compile-time scope hooks
3565
3566 =for apidoc Aox||blockhook_register
3567
3568 Register a set of hooks to be called when the Perl lexical scope changes
3569 at compile time.  See L<perlguts/"Compile-time scope hooks">.
3570
3571 =cut
3572 */
3573
3574 void
3575 Perl_blockhook_register(pTHX_ BHK *hk)
3576 {
3577     PERL_ARGS_ASSERT_BLOCKHOOK_REGISTER;
3578
3579     Perl_av_create_and_push(aTHX_ &PL_blockhooks, newSViv(PTR2IV(hk)));
3580 }
3581
3582 STATIC OP *
3583 S_newDEFSVOP(pTHX)
3584 {
3585     const PADOFFSET offset = pad_findmy_pvs("$_", 0);
3586     if (offset == NOT_IN_PAD || PAD_COMPNAME_FLAGS_isOUR(offset)) {
3587         return newSVREF(newGVOP(OP_GV, 0, PL_defgv));
3588     }
3589     else {
3590         OP * const o = newOP(OP_PADSV, 0);
3591         o->op_targ = offset;
3592         return o;
3593     }
3594 }
3595
3596 void
3597 Perl_newPROG(pTHX_ OP *o)
3598 {
3599     PERL_ARGS_ASSERT_NEWPROG;
3600
3601     if (PL_in_eval) {
3602         PERL_CONTEXT *cx;
3603         I32 i;
3604         if (PL_eval_root)
3605                 return;
3606         PL_eval_root = newUNOP(OP_LEAVEEVAL,
3607                                ((PL_in_eval & EVAL_KEEPERR)
3608                                 ? OPf_SPECIAL : 0), o);
3609
3610         cx = &cxstack[cxstack_ix];
3611         assert(CxTYPE(cx) == CXt_EVAL);
3612
3613         if ((cx->blk_gimme & G_WANT) == G_VOID)
3614             scalarvoid(PL_eval_root);
3615         else if ((cx->blk_gimme & G_WANT) == G_ARRAY)
3616             list(PL_eval_root);
3617         else
3618             scalar(PL_eval_root);
3619
3620         PL_eval_start = op_linklist(PL_eval_root);
3621         PL_eval_root->op_private |= OPpREFCOUNTED;
3622         OpREFCNT_set(PL_eval_root, 1);
3623         PL_eval_root->op_next = 0;
3624         i = PL_savestack_ix;
3625         SAVEFREEOP(o);
3626         ENTER;
3627         CALL_PEEP(PL_eval_start);
3628         finalize_optree(PL_eval_root);
3629         S_prune_chain_head(&PL_eval_start);
3630         LEAVE;
3631         PL_savestack_ix = i;
3632     }
3633     else {
3634         if (o->op_type == OP_STUB) {
3635             /* This block is entered if nothing is compiled for the main
3636                program. This will be the case for an genuinely empty main
3637                program, or one which only has BEGIN blocks etc, so already
3638                run and freed.
3639
3640                Historically (5.000) the guard above was !o. However, commit
3641                f8a08f7b8bd67b28 (Jun 2001), integrated to blead as
3642                c71fccf11fde0068, changed perly.y so that newPROG() is now
3643                called with the output of block_end(), which returns a new
3644                OP_STUB for the case of an empty optree. ByteLoader (and
3645                maybe other things) also take this path, because they set up
3646                PL_main_start and PL_main_root directly, without generating an
3647                optree.
3648
3649                If the parsing the main program aborts (due to parse errors,
3650                or due to BEGIN or similar calling exit), then newPROG()
3651                isn't even called, and hence this code path and its cleanups
3652                are skipped. This shouldn't make a make a difference:
3653                * a non-zero return from perl_parse is a failure, and
3654                  perl_destruct() should be called immediately.
3655                * however, if exit(0) is called during the parse, then
3656                  perl_parse() returns 0, and perl_run() is called. As
3657                  PL_main_start will be NULL, perl_run() will return
3658                  promptly, and the exit code will remain 0.
3659             */
3660
3661             PL_comppad_name = 0;
3662             PL_compcv = 0;
3663             S_op_destroy(aTHX_ o);
3664             return;
3665         }
3666         PL_main_root = op_scope(sawparens(scalarvoid(o)));
3667         PL_curcop = &PL_compiling;
3668         PL_main_start = LINKLIST(PL_main_root);
3669         PL_main_root->op_private |= OPpREFCOUNTED;
3670         OpREFCNT_set(PL_main_root, 1);
3671         PL_main_root->op_next = 0;
3672         CALL_PEEP(PL_main_start);
3673         finalize_optree(PL_main_root);
3674         S_prune_chain_head(&PL_main_start);
3675         cv_forget_slab(PL_compcv);
3676         PL_compcv = 0;
3677
3678         /* Register with debugger */
3679         if (PERLDB_INTER) {
3680             CV * const cv = get_cvs("DB::postponed", 0);
3681             if (cv) {
3682                 dSP;
3683                 PUSHMARK(SP);
3684                 XPUSHs(MUTABLE_SV(CopFILEGV(&PL_compiling)));
3685                 PUTBACK;
3686                 call_sv(MUTABLE_SV(cv), G_DISCARD);
3687             }
3688         }
3689     }
3690 }
3691
3692 OP *
3693 Perl_localize(pTHX_ OP *o, I32 lex)
3694 {
3695     PERL_ARGS_ASSERT_LOCALIZE;
3696
3697     if (o->op_flags & OPf_PARENS)
3698 /* [perl #17376]: this appears to be premature, and results in code such as
3699    C< our(%x); > executing in list mode rather than void mode */
3700 #if 0
3701         list(o);
3702 #else
3703         NOOP;
3704 #endif
3705     else {
3706         if ( PL_parser->bufptr > PL_parser->oldbufptr
3707             && PL_parser->bufptr[-1] == ','
3708             && ckWARN(WARN_PARENTHESIS))
3709         {
3710             char *s = PL_parser->bufptr;
3711             bool sigil = FALSE;
3712
3713             /* some heuristics to detect a potential error */
3714             while (*s && (strchr(", \t\n", *s)))
3715                 s++;
3716
3717             while (1) {
3718                 if (*s && strchr("@$%*", *s) && *++s
3719                        && (isWORDCHAR(*s) || UTF8_IS_CONTINUED(*s))) {
3720                     s++;
3721                     sigil = TRUE;
3722                     while (*s && (isWORDCHAR(*s) || UTF8_IS_CONTINUED(*s)))
3723                         s++;
3724                     while (*s && (strchr(", \t\n", *s)))
3725                         s++;
3726                 }
3727                 else
3728                     break;
3729             }
3730             if (sigil && (*s == ';' || *s == '=')) {
3731                 Perl_warner(aTHX_ packWARN(WARN_PARENTHESIS),
3732                                 "Parentheses missing around \"%s\" list",
3733                                 lex
3734                                     ? (PL_parser->in_my == KEY_our
3735                                         ? "our"
3736                                         : PL_parser->in_my == KEY_state
3737                                             ? "state"
3738                                             : "my")
3739                                     : "local");
3740             }
3741         }
3742     }
3743     if (lex)
3744         o = my(o);
3745     else
3746         o = op_lvalue(o, OP_NULL);              /* a bit kludgey */
3747     PL_parser->in_my = FALSE;
3748     PL_parser->in_my_stash = NULL;
3749     return o;
3750 }
3751
3752 OP *
3753 Perl_jmaybe(pTHX_ OP *o)
3754 {
3755     PERL_ARGS_ASSERT_JMAYBE;
3756
3757     if (o->op_type == OP_LIST) {
3758         OP * const o2
3759             = newSVREF(newGVOP(OP_GV, 0, gv_fetchpvs(";", GV_ADD|GV_NOTQUAL, SVt_PV)));
3760         o = convert(OP_JOIN, 0, op_prepend_elem(OP_LIST, o2, o));
3761     }
3762     return o;
3763 }
3764
3765 PERL_STATIC_INLINE OP *
3766 S_op_std_init(pTHX_ OP *o)
3767 {
3768     I32 type = o->op_type;
3769
3770     PERL_ARGS_ASSERT_OP_STD_INIT;
3771
3772     if (PL_opargs[type] & OA_RETSCALAR)
3773         scalar(o);
3774     if (PL_opargs[type] & OA_TARGET && !o->op_targ)
3775         o->op_targ = pad_alloc(type, SVs_PADTMP);
3776
3777     return o;
3778 }
3779
3780 PERL_STATIC_INLINE OP *
3781 S_op_integerize(pTHX_ OP *o)
3782 {
3783     I32 type = o->op_type;
3784
3785     PERL_ARGS_ASSERT_OP_INTEGERIZE;
3786
3787     /* integerize op. */
3788     if ((PL_opargs[type] & OA_OTHERINT) && (PL_hints & HINT_INTEGER))
3789     {
3790         dVAR;
3791         o->op_ppaddr = PL_ppaddr[++(o->op_type)];
3792     }
3793
3794     if (type == OP_NEGATE)
3795         /* XXX might want a ck_negate() for this */
3796         cUNOPo->op_first->op_private &= ~OPpCONST_STRICT;
3797
3798     return o;
3799 }
3800
3801 static OP *
3802 S_fold_constants(pTHX_ OP *o)
3803 {
3804     dVAR;
3805     OP * VOL curop;
3806     OP *newop;
3807     VOL I32 type = o->op_type;
3808     SV * VOL sv = NULL;
3809     int ret = 0;
3810     I32 oldscope;
3811     OP *old_next;
3812     SV * const oldwarnhook = PL_warnhook;
3813     SV * const olddiehook  = PL_diehook;
3814     COP not_compiling;
3815     U8 oldwarn = PL_dowarn;
3816     dJMPENV;
3817
3818     PERL_ARGS_ASSERT_FOLD_CONSTANTS;
3819
3820     if (!(PL_opargs[type] & OA_FOLDCONST))
3821         goto nope;
3822
3823     switch (type) {
3824     case OP_UCFIRST:
3825     case OP_LCFIRST:
3826     case OP_UC:
3827     case OP_LC:
3828     case OP_FC:
3829 #ifdef USE_LOCALE_CTYPE
3830         if (IN_LC_COMPILETIME(LC_CTYPE))
3831             goto nope;
3832 #endif
3833         break;
3834     case OP_SLT:
3835     case OP_SGT:
3836     case OP_SLE:
3837     case OP_SGE:
3838     case OP_SCMP:
3839 #ifdef USE_LOCALE_COLLATE
3840         if (IN_LC_COMPILETIME(LC_COLLATE))
3841             goto nope;
3842 #endif
3843         break;
3844     case OP_SPRINTF:
3845         /* XXX what about the numeric ops? */
3846 #ifdef USE_LOCALE_NUMERIC
3847         if (IN_LC_COMPILETIME(LC_NUMERIC))
3848             goto nope;
3849 #endif
3850         break;
3851     case OP_PACK:
3852         if (!OP_HAS_SIBLING(cLISTOPo->op_first)
3853           || OP_SIBLING(cLISTOPo->op_first)->op_type != OP_CONST)
3854             goto nope;
3855         {
3856             SV * const sv = cSVOPx_sv(OP_SIBLING(cLISTOPo->op_first));
3857             if (!SvPOK(sv) || SvGMAGICAL(sv)) goto nope;
3858             {
3859                 const char *s = SvPVX_const(sv);
3860                 while (s < SvEND(sv)) {
3861                     if (isALPHA_FOLD_EQ(*s, 'p')) goto nope;
3862                     s++;
3863                 }
3864             }
3865         }
3866         break;
3867     case OP_REPEAT:
3868         if (o->op_private & OPpREPEAT_DOLIST) goto nope;
3869         break;
3870     case OP_SREFGEN:
3871         if (cUNOPx(cUNOPo->op_first)->op_first->op_type != OP_CONST
3872          || SvPADTMP(cSVOPx_sv(cUNOPx(cUNOPo->op_first)->op_first)))
3873             goto nope;
3874     }
3875
3876     if (PL_parser && PL_parser->error_count)
3877         goto nope;              /* Don't try to run w/ errors */
3878
3879     for (curop = LINKLIST(o); curop != o; curop = LINKLIST(curop)) {
3880         const OPCODE type = curop->op_type;
3881         if ((type != OP_CONST || (curop->op_private & OPpCONST_BARE)) &&
3882             type != OP_LIST &&
3883             type != OP_SCALAR &&
3884             type != OP_NULL &&
3885             type != OP_PUSHMARK)
3886         {
3887             goto nope;
3888         }
3889     }
3890
3891     curop = LINKLIST(o);
3892     old_next = o->op_next;
3893     o->op_next = 0;
3894     PL_op = curop;
3895
3896     oldscope = PL_scopestack_ix;
3897     create_eval_scope(G_FAKINGEVAL);
3898
3899     /* Verify that we don't need to save it:  */
3900     assert(PL_curcop == &PL_compiling);
3901     StructCopy(&PL_compiling, &not_compiling, COP);
3902     PL_curcop = &not_compiling;
3903     /* The above ensures that we run with all the correct hints of the
3904        currently compiling COP, but that IN_PERL_RUNTIME is not true. */
3905     assert(IN_PERL_RUNTIME);
3906     PL_warnhook = PERL_WARNHOOK_FATAL;
3907     PL_diehook  = NULL;
3908     JMPENV_PUSH(ret);
3909
3910     /* Effective $^W=1.  */
3911     if ( ! (PL_dowarn & G_WARN_ALL_MASK))
3912         PL_dowarn |= G_WARN_ON;
3913
3914     switch (ret) {
3915     case 0:
3916         CALLRUNOPS(aTHX);
3917         sv = *(PL_stack_sp--);
3918         if (o->op_targ && sv == PAD_SV(o->op_targ)) {   /* grab pad temp? */
3919             pad_swipe(o->op_targ,  FALSE);
3920         }
3921         else if (SvTEMP(sv)) {                  /* grab mortal temp? */
3922             SvREFCNT_inc_simple_void(sv);
3923             SvTEMP_off(sv);
3924         }
3925         else { assert(SvIMMORTAL(sv)); }
3926         break;
3927     case 3:
3928         /* Something tried to die.  Abandon constant folding.  */
3929         /* Pretend the error never happened.  */
3930         CLEAR_ERRSV();
3931         o->op_next = old_next;
3932         break;
3933     default:
3934         JMPENV_POP;
3935         /* Don't expect 1 (setjmp failed) or 2 (something called my_exit)  */
3936         PL_warnhook = oldwarnhook;
3937         PL_diehook  = olddiehook;
3938         /* XXX note that this croak may fail as we've already blown away
3939          * the stack - eg any nested evals */
3940         Perl_croak(aTHX_ "panic: fold_constants JMPENV_PUSH returned %d", ret);
3941     }
3942     JMPENV_POP;
3943     PL_dowarn   = oldwarn;
3944     PL_warnhook = oldwarnhook;
3945     PL_diehook  = olddiehook;
3946     PL_curcop = &PL_compiling;
3947
3948     if (PL_scopestack_ix > oldscope)
3949         delete_eval_scope();
3950
3951     if (ret)
3952         goto nope;
3953
3954     op_free(o);
3955     assert(sv);
3956     if (type == OP_STRINGIFY) SvPADTMP_off(sv);
3957     else if (!SvIMMORTAL(sv)) {
3958         SvPADTMP_on(sv);
3959         SvREADONLY_on(sv);
3960     }
3961     if (type == OP_RV2GV)
3962         newop = newGVOP(OP_GV, 0, MUTABLE_GV(sv));
3963     else
3964     {
3965         newop = newSVOP(OP_CONST, 0, MUTABLE_SV(sv));
3966         if (type != OP_STRINGIFY) newop->op_folded = 1;
3967     }
3968     return newop;
3969
3970  nope:
3971     return o;
3972 }
3973
3974 static OP *
3975 S_gen_constant_list(pTHX_ OP *o)
3976 {
3977     dVAR;
3978     OP *curop;
3979     const SSize_t oldtmps_floor = PL_tmps_floor;
3980     SV **svp;
3981     AV *av;
3982
3983     list(o);
3984     if (PL_parser && PL_parser->error_count)
3985         return o;               /* Don't attempt to run with errors */
3986
3987     curop = LINKLIST(o);
3988     o->op_next = 0;
3989     CALL_PEEP(curop);
3990     S_prune_chain_head(&curop);
3991     PL_op = curop;
3992     Perl_pp_pushmark(aTHX);
3993     CALLRUNOPS(aTHX);
3994     PL_op = curop;
3995     assert (!(curop->op_flags & OPf_SPECIAL));
3996     assert(curop->op_type == OP_RANGE);
3997     Perl_pp_anonlist(aTHX);
3998     PL_tmps_floor = oldtmps_floor;
3999
4000     o->op_type = OP_RV2AV;
4001     o->op_ppaddr = PL_ppaddr[OP_RV2AV];
4002     o->op_flags &= ~OPf_REF;    /* treat \(1..2) like an ordinary list */
4003     o->op_flags |= OPf_PARENS;  /* and flatten \(1..2,3) */
4004     o->op_opt = 0;              /* needs to be revisited in rpeep() */
4005     av = (AV *)SvREFCNT_inc_NN(*PL_stack_sp--);
4006
4007     /* replace subtree with an OP_CONST */
4008     curop = ((UNOP*)o)->op_first;
4009     op_sibling_splice(o, NULL, -1, newSVOP(OP_CONST, 0, (SV *)av));
4010     op_free(curop);
4011
4012     if (AvFILLp(av) != -1)
4013         for (svp = AvARRAY(av) + AvFILLp(av); svp >= AvARRAY(av); --svp)
4014         {
4015             SvPADTMP_on(*svp);
4016             SvREADONLY_on(*svp);
4017         }
4018     LINKLIST(o);
4019     return list(o);
4020 }
4021
4022 /* convert o (and any siblings) into a list if not already, then
4023  * convert the parent OP_LIST to type 'type', and CHECKOP() and fold it
4024  */
4025
4026 OP *
4027 Perl_convert(pTHX_ I32 type, I32 flags, OP *o)
4028 {
4029     dVAR;
4030     if (type < 0) type = -type, flags |= OPf_SPECIAL;
4031     if (!o || o->op_type != OP_LIST)
4032         o = force_list(o, 0);
4033     else
4034         o->op_flags &= ~OPf_WANT;
4035
4036     if (!(PL_opargs[type] & OA_MARK))
4037         op_null(cLISTOPo->op_first);
4038     else {
4039         OP * const kid2 = OP_SIBLING(cLISTOPo->op_first);
4040         if (kid2 && kid2->op_type == OP_COREARGS) {
4041             op_null(cLISTOPo->op_first);
4042             kid2->op_private |= OPpCOREARGS_PUSHMARK;
4043         }
4044     }   
4045
4046     o->op_type = (OPCODE)type;
4047     o->op_ppaddr = PL_ppaddr[type];
4048     o->op_flags |= flags;
4049
4050     o = CHECKOP(type, o);
4051     if (o->op_type != (unsigned)type)
4052         return o;
4053
4054     return fold_constants(op_integerize(op_std_init(o)));
4055 }
4056
4057 /*
4058 =head1 Optree Manipulation Functions
4059 */
4060
4061 /* List constructors */
4062
4063 /*
4064 =for apidoc Am|OP *|op_append_elem|I32 optype|OP *first|OP *last
4065
4066 Append an item to the list of ops contained directly within a list-type
4067 op, returning the lengthened list.  I<first> is the list-type op,
4068 and I<last> is the op to append to the list.  I<optype> specifies the
4069 intended opcode for the list.  If I<first> is not already a list of the
4070 right type, it will be upgraded into one.  If either I<first> or I<last>
4071 is null, the other is returned unchanged.
4072
4073 =cut
4074 */
4075
4076 OP *
4077 Perl_op_append_elem(pTHX_ I32 type, OP *first, OP *last)
4078 {
4079     if (!first)
4080         return last;
4081
4082     if (!last)
4083         return first;
4084
4085     if (first->op_type != (unsigned)type
4086         || (type == OP_LIST && (first->op_flags & OPf_PARENS)))
4087     {
4088         return newLISTOP(type, 0, first, last);
4089     }
4090
4091     op_sibling_splice(first, ((LISTOP*)first)->op_last, 0, last);
4092     first->op_flags |= OPf_KIDS;
4093     return first;
4094 }
4095
4096 /*
4097 =for apidoc Am|OP *|op_append_list|I32 optype|OP *first|OP *last
4098
4099 Concatenate the lists of ops contained directly within two list-type ops,
4100 returning the combined list.  I<first> and I<last> are the list-type ops
4101 to concatenate.  I<optype> specifies the intended opcode for the list.
4102 If either I<first> or I<last> is not already a list of the right type,
4103 it will be upgraded into one.  If either I<first> or I<last> is null,
4104 the other is returned unchanged.
4105
4106 =cut
4107 */
4108
4109 OP *
4110 Perl_op_append_list(pTHX_ I32 type, OP *first, OP *last)
4111 {
4112     if (!first)
4113         return last;
4114
4115     if (!last)
4116         return first;
4117
4118     if (first->op_type != (unsigned)type)
4119         return op_prepend_elem(type, first, last);
4120
4121     if (last->op_type != (unsigned)type)
4122         return op_append_elem(type, first, last);
4123
4124     ((LISTOP*)first)->op_last->op_lastsib = 0;
4125     OP_SIBLING_set(((LISTOP*)first)->op_last, ((LISTOP*)last)->op_first);
4126     ((LISTOP*)first)->op_last = ((LISTOP*)last)->op_last;
4127     ((LISTOP*)first)->op_last->op_lastsib = 1;
4128 #ifdef PERL_OP_PARENT
4129     ((LISTOP*)first)->op_last->op_sibling = first;
4130 #endif
4131     first->op_flags |= (last->op_flags & OPf_KIDS);
4132
4133
4134     S_op_destroy(aTHX_ last);
4135
4136     return first;
4137 }
4138
4139 /*
4140 =for apidoc Am|OP *|op_prepend_elem|I32 optype|OP *first|OP *last
4141
4142 Prepend an item to the list of ops contained directly within a list-type
4143 op, returning the lengthened list.  I<first> is the op to prepend to the
4144 list, and I<last> is the list-type op.  I<optype> specifies the intended
4145 opcode for the list.  If I<last> is not already a list of the right type,
4146 it will be upgraded into one.  If either I<first> or I<last> is null,
4147 the other is returned unchanged.
4148
4149 =cut
4150 */
4151
4152 OP *
4153 Perl_op_prepend_elem(pTHX_ I32 type, OP *first, OP *last)
4154 {
4155     if (!first)
4156         return last;
4157
4158     if (!last)
4159         return first;
4160
4161     if (last->op_type == (unsigned)type) {
4162         if (type == OP_LIST) {  /* already a PUSHMARK there */
4163             /* insert 'first' after pushmark */
4164             op_sibling_splice(last, cLISTOPx(last)->op_first, 0, first);
4165             if (!(first->op_flags & OPf_PARENS))
4166                 last->op_flags &= ~OPf_PARENS;
4167         }
4168         else
4169             op_sibling_splice(last, NULL, 0, first);
4170         last->op_flags |= OPf_KIDS;
4171         return last;
4172     }
4173
4174     return newLISTOP(type, 0, first, last);
4175 }
4176
4177 /* Constructors */
4178
4179
4180 /*
4181 =head1 Optree construction
4182
4183 =for apidoc Am|OP *|newNULLLIST
4184
4185 Constructs, checks, and returns a new C<stub> op, which represents an
4186 empty list expression.
4187
4188 =cut
4189 */
4190
4191 OP *
4192 Perl_newNULLLIST(pTHX)
4193 {
4194     return newOP(OP_STUB, 0);
4195 }
4196
4197 /* promote o and any siblings to be a list if its not already; i.e.
4198  *
4199  *  o - A - B
4200  *
4201  * becomes
4202  *
4203  *  list
4204  *    |
4205  *  pushmark - o - A - B
4206  *
4207  * If nullit it true, the list op is nulled.
4208  */
4209
4210 static OP *
4211 S_force_list(pTHX_ OP *o, bool nullit)
4212 {
4213     if (!o || o->op_type != OP_LIST) {
4214         OP *rest = NULL;
4215         if (o) {
4216             /* manually detach any siblings then add them back later */
4217             rest = OP_SIBLING(o);
4218             OP_SIBLING_set(o, NULL);
4219             o->op_lastsib = 1;
4220         }
4221         o = newLISTOP(OP_LIST, 0, o, NULL);
4222         if (rest)
4223             op_sibling_splice(o, cLISTOPo->op_last, 0, rest);
4224     }
4225     if (nullit)
4226         op_null(o);
4227     return o;
4228 }
4229
4230 /*
4231 =for apidoc Am|OP *|newLISTOP|I32 type|I32 flags|OP *first|OP *last
4232
4233 Constructs, checks, and returns an op of any list type.  I<type> is
4234 the opcode.  I<flags> gives the eight bits of C<op_flags>, except that
4235 C<OPf_KIDS> will be set automatically if required.  I<first> and I<last>
4236 supply up to two ops to be direct children of the list op; they are
4237 consumed by this function and become part of the constructed op tree.
4238
4239 =cut
4240 */
4241
4242 OP *
4243 Perl_newLISTOP(pTHX_ I32 type, I32 flags, OP *first, OP *last)
4244 {
4245     dVAR;
4246     LISTOP *listop;
4247
4248     assert((PL_opargs[type] & OA_CLASS_MASK) == OA_LISTOP);
4249
4250     NewOp(1101, listop, 1, LISTOP);
4251
4252     listop->op_type = (OPCODE)type;
4253     listop->op_ppaddr = PL_ppaddr[type];
4254     if (first || last)
4255         flags |= OPf_KIDS;
4256     listop->op_flags = (U8)flags;
4257
4258     if (!last && first)
4259         last = first;
4260     else if (!first && last)
4261         first = last;
4262     else if (first)
4263         OP_SIBLING_set(first, last);
4264     listop->op_first = first;
4265     listop->op_last = last;
4266     if (type == OP_LIST) {
4267         OP* const pushop = newOP(OP_PUSHMARK, 0);
4268         pushop->op_lastsib = 0;
4269         OP_SIBLING_set(pushop, first);
4270         listop->op_first = pushop;
4271         listop->op_flags |= OPf_KIDS;
4272         if (!last)
4273             listop->op_last = pushop;
4274     }
4275     if (first)
4276         first->op_lastsib = 0;
4277     if (listop->op_last) {
4278         listop->op_last->op_lastsib = 1;
4279 #ifdef PERL_OP_PARENT
4280         listop->op_last->op_sibling = (OP*)listop;
4281 #endif
4282     }
4283
4284     return CHECKOP(type, listop);
4285 }
4286
4287 /*
4288 =for apidoc Am|OP *|newOP|I32 type|I32 flags
4289
4290 Constructs, checks, and returns an op of any base type (any type that
4291 has no extra fields).  I<type> is the opcode.  I<flags> gives the
4292 eight bits of C<op_flags>, and, shifted up eight bits, the eight bits
4293 of C<op_private>.
4294
4295 =cut
4296 */
4297
4298 OP *
4299 Perl_newOP(pTHX_ I32 type, I32 flags)
4300 {
4301     dVAR;
4302     OP *o;
4303
4304     if (type == -OP_ENTEREVAL) {
4305         type = OP_ENTEREVAL;
4306         flags |= OPpEVAL_BYTES<<8;
4307     }
4308
4309     assert((PL_opargs[type] & OA_CLASS_MASK) == OA_BASEOP
4310         || (PL_opargs[type] & OA_CLASS_MASK) == OA_BASEOP_OR_UNOP
4311         || (PL_opargs[type] & OA_CLASS_MASK) == OA_FILESTATOP
4312         || (PL_opargs[type] & OA_CLASS_MASK) == OA_LOOPEXOP);
4313
4314     NewOp(1101, o, 1, OP);
4315     o->op_type = (OPCODE)type;
4316     o->op_ppaddr = PL_ppaddr[type];
4317     o->op_flags = (U8)flags;
4318
4319     o->op_next = o;
4320     o->op_private = (U8)(0 | (flags >> 8));
4321     if (PL_opargs[type] & OA_RETSCALAR)
4322         scalar(o);
4323     if (PL_opargs[type] & OA_TARGET)
4324         o->op_targ = pad_alloc(type, SVs_PADTMP);
4325     return CHECKOP(type, o);
4326 }
4327
4328 /*
4329 =for apidoc Am|OP *|newUNOP|I32 type|I32 flags|OP *first
4330
4331 Constructs, checks, and returns an op of any unary type.  I<type> is
4332 the opcode.  I<flags> gives the eight bits of C<op_flags>, except that
4333 C<OPf_KIDS> will be set automatically if required, and, shifted up eight
4334 bits, the eight bits of C<op_private>, except that the bit with value 1
4335 is automatically set.  I<first> supplies an optional op to be the direct
4336 child of the unary op; it is consumed by this function and become part
4337 of the constructed op tree.
4338
4339 =cut
4340 */
4341
4342 OP *
4343 Perl_newUNOP(pTHX_ I32 type, I32 flags, OP *first)
4344 {
4345     dVAR;
4346     UNOP *unop;
4347
4348     if (type == -OP_ENTEREVAL) {
4349         type = OP_ENTEREVAL;
4350         flags |= OPpEVAL_BYTES<<8;
4351     }
4352
4353     assert((PL_opargs[type] & OA_CLASS_MASK) == OA_UNOP
4354         || (PL_opargs[type] & OA_CLASS_MASK) == OA_BASEOP_OR_UNOP
4355         || (PL_opargs[type] & OA_CLASS_MASK) == OA_FILESTATOP
4356         || (PL_opargs[type] & OA_CLASS_MASK) == OA_LOOPEXOP
4357         || type == OP_SASSIGN
4358         || type == OP_ENTERTRY
4359         || type == OP_NULL );
4360
4361     if (!first)
4362         first = newOP(OP_STUB, 0);
4363     if (PL_opargs[type] & OA_MARK)
4364         first = force_list(first, 1);
4365
4366     NewOp(1101, unop, 1, UNOP);
4367     unop->op_type = (OPCODE)type;
4368     unop->op_ppaddr = PL_ppaddr[type];
4369     unop->op_first = first;
4370     unop->op_flags = (U8)(flags | OPf_KIDS);
4371     unop->op_private = (U8)(1 | (flags >> 8));
4372
4373 #ifdef PERL_OP_PARENT
4374     if (!OP_HAS_SIBLING(first)) /* true unless weird syntax error */
4375         first->op_sibling = (OP*)unop;
4376 #endif
4377
4378     unop = (UNOP*) CHECKOP(type, unop);
4379     if (unop->op_next)
4380         return (OP*)unop;
4381
4382     return fold_constants(op_integerize(op_std_init((OP *) unop)));
4383 }
4384
4385 /*
4386 =for apidoc Am|OP *|newMETHOP|I32 type|I32 flags|OP *first
4387
4388 Constructs, checks, and returns an op of method type with a method name
4389 evaluated at runtime. I<type> is the opcode. I<flags> gives the eight
4390 bits of C<op_flags>, except that C<OPf_KIDS> will be set automatically,
4391 and, shifted up eight bits, the eight bits of C<op_private>, except that
4392 the bit with value 1 is automatically set. I<dynamic_meth> supplies an
4393 op which evaluates method name; it is consumed by this function and
4394 become part of the constructed op tree.
4395 Supported optypes: OP_METHOD.
4396
4397 =cut
4398 */
4399
4400 static OP*
4401 S_newMETHOP_internal(pTHX_ I32 type, I32 flags, OP* dynamic_meth, SV* const_meth) {
4402     dVAR;
4403     METHOP *methop;
4404
4405     assert((PL_opargs[type] & OA_CLASS_MASK) == OA_METHOP);
4406
4407     NewOp(1101, methop, 1, METHOP);
4408     if (dynamic_meth) {
4409         if (PL_opargs[type] & OA_MARK) dynamic_meth = force_list(dynamic_meth, 1);
4410         methop->op_flags = (U8)(flags | OPf_KIDS);
4411         methop->op_u.op_first = dynamic_meth;
4412         methop->op_private = (U8)(1 | (flags >> 8));
4413     }
4414     else {
4415         assert(const_meth);
4416         methop->op_flags = (U8)(flags & ~OPf_KIDS);
4417         methop->op_u.op_meth_sv = const_meth;
4418         methop->op_private = (U8)(0 | (flags >> 8));
4419         methop->op_next = (OP*)methop;
4420     }
4421
4422     methop->op_type = (OPCODE)type;
4423     methop->op_ppaddr = PL_ppaddr[type];
4424     methop = (METHOP*) CHECKOP(type, methop);
4425
4426     if (methop->op_next) return (OP*)methop;
4427
4428     return fold_constants(op_integerize(op_std_init((OP *) methop)));
4429 }
4430
4431 OP *
4432 Perl_newMETHOP (pTHX_ I32 type, I32 flags, OP* dynamic_meth) {
4433     PERL_ARGS_ASSERT_NEWMETHOP;
4434     return newMETHOP_internal(type, flags, dynamic_meth, NULL);
4435 }
4436
4437 /*
4438 =for apidoc Am|OP *|newMETHOP_named|I32 type|I32 flags|SV *const_meth
4439
4440 Constructs, checks, and returns an op of method type with a constant
4441 method name. I<type> is the opcode. I<flags> gives the eight bits of
4442 C<op_flags>, and, shifted up eight bits, the eight bits of
4443 C<op_private>. I<const_meth> supplies a constant method name;
4444 it must be a shared COW string.
4445 Supported optypes: OP_METHOD_NAMED.
4446
4447 =cut
4448 */
4449
4450 OP *
4451 Perl_newMETHOP_named (pTHX_ I32 type, I32 flags, SV* const_meth) {
4452     PERL_ARGS_ASSERT_NEWMETHOP_NAMED;
4453     return newMETHOP_internal(type, flags, NULL, const_meth);
4454 }
4455
4456 /*
4457 =for apidoc Am|OP *|newBINOP|I32 type|I32 flags|OP *first|OP *last
4458
4459 Constructs, checks, and returns an op of any binary type.  I<type>
4460 is the opcode.  I<flags> gives the eight bits of C<op_flags>, except
4461 that C<OPf_KIDS> will be set automatically, and, shifted up eight bits,
4462 the eight bits of C<op_private>, except that the bit with value 1 or
4463 2 is automatically set as required.  I<first> and I<last> supply up to
4464 two ops to be the direct children of the binary op; they are consumed
4465 by this function and become part of the constructed op tree.
4466
4467 =cut
4468 */
4469
4470 OP *
4471 Perl_newBINOP(pTHX_ I32 type, I32 flags, OP *first, OP *last)
4472 {
4473     dVAR;
4474     BINOP *binop;
4475
4476     ASSUME((PL_opargs[type] & OA_CLASS_MASK) == OA_BINOP
4477         || type == OP_SASSIGN || type == OP_NULL );
4478
4479     NewOp(1101, binop, 1, BINOP);
4480
4481     if (!first)
4482         first = newOP(OP_NULL, 0);
4483
4484     binop->op_type = (OPCODE)type;
4485     binop->op_ppaddr = PL_ppaddr[type];
4486     binop->op_first = first;
4487     binop->op_flags = (U8)(flags | OPf_KIDS);
4488     if (!last) {
4489         last = first;
4490         binop->op_private = (U8)(1 | (flags >> 8));
4491     }
4492     else {
4493         binop->op_private = (U8)(2 | (flags >> 8));
4494         OP_SIBLING_set(first, last);
4495         first->op_lastsib = 0;
4496     }
4497
4498 #ifdef PERL_OP_PARENT
4499     if (!OP_HAS_SIBLING(last)) /* true unless weird syntax error */
4500         last->op_sibling = (OP*)binop;
4501 #endif
4502
4503     binop->op_last = OP_SIBLING(binop->op_first);
4504 #ifdef PERL_OP_PARENT
4505     if (binop->op_last)
4506         binop->op_last->op_sibling = (OP*)binop;
4507 #endif
4508
4509     binop = (BINOP*)CHECKOP(type, binop);
4510     if (binop->op_next || binop->op_type != (OPCODE)type)
4511         return (OP*)binop;
4512
4513     return fold_constants(op_integerize(op_std_init((OP *)binop)));
4514 }
4515
4516 static int uvcompare(const void *a, const void *b)
4517     __attribute__nonnull__(1)
4518     __attribute__nonnull__(2)
4519     __attribute__pure__;
4520 static int uvcompare(const void *a, const void *b)
4521 {
4522     if (*((const UV *)a) < (*(const UV *)b))
4523         return -1;
4524     if (*((const UV *)a) > (*(const UV *)b))
4525         return 1;
4526     if (*((const UV *)a+1) < (*(const UV *)b+1))
4527         return -1;
4528     if (*((const UV *)a+1) > (*(const UV *)b+1))
4529         return 1;
4530     return 0;
4531 }
4532
4533 static OP *
4534 S_pmtrans(pTHX_ OP *o, OP *expr, OP *repl)
4535 {
4536     SV * const tstr = ((SVOP*)expr)->op_sv;
4537     SV * const rstr =
4538                               ((SVOP*)repl)->op_sv;
4539     STRLEN tlen;
4540     STRLEN rlen;
4541     const U8 *t = (U8*)SvPV_const(tstr, tlen);
4542     const U8 *r = (U8*)SvPV_const(rstr, rlen);
4543     I32 i;
4544     I32 j;
4545     I32 grows = 0;
4546     short *tbl;
4547
4548     const I32 complement = o->op_private & OPpTRANS_COMPLEMENT;
4549     const I32 squash     = o->op_private & OPpTRANS_SQUASH;
4550     I32 del              = o->op_private & OPpTRANS_DELETE;
4551     SV* swash;
4552
4553     PERL_ARGS_ASSERT_PMTRANS;
4554
4555     PL_hints |= HINT_BLOCK_SCOPE;
4556
4557     if (SvUTF8(tstr))
4558         o->op_private |= OPpTRANS_FROM_UTF;
4559
4560     if (SvUTF8(rstr))
4561         o->op_private |= OPpTRANS_TO_UTF;
4562
4563     if (o->op_private & (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF)) {
4564         SV* const listsv = newSVpvs("# comment\n");
4565         SV* transv = NULL;
4566         const U8* tend = t + tlen;
4567         const U8* rend = r + rlen;
4568         STRLEN ulen;
4569         UV tfirst = 1;
4570         UV tlast = 0;
4571         IV tdiff;
4572         UV rfirst = 1;
4573         UV rlast = 0;
4574         IV rdiff;
4575         IV diff;
4576         I32 none = 0;
4577         U32 max = 0;
4578         I32 bits;
4579         I32 havefinal = 0;
4580         U32 final = 0;
4581         const I32 from_utf  = o->op_private & OPpTRANS_FROM_UTF;
4582         const I32 to_utf    = o->op_private & OPpTRANS_TO_UTF;
4583         U8* tsave = NULL;
4584         U8* rsave = NULL;
4585         const U32 flags = UTF8_ALLOW_DEFAULT;
4586
4587         if (!from_utf) {
4588             STRLEN len = tlen;
4589             t = tsave = bytes_to_utf8(t, &len);
4590             tend = t + len;
4591         }
4592         if (!to_utf && rlen) {
4593             STRLEN len = rlen;
4594             r = rsave = bytes_to_utf8(r, &len);
4595             rend = r + len;
4596         }
4597
4598 /* There is a snag with this code on EBCDIC: scan_const() in toke.c has
4599  * encoded chars in native encoding which makes ranges in the EBCDIC 0..255
4600  * odd.  */
4601
4602         if (complement) {
4603             U8 tmpbuf[UTF8_MAXBYTES+1];
4604             UV *cp;
4605             UV nextmin = 0;
4606             Newx(cp, 2*tlen, UV);
4607             i = 0;
4608             transv = newSVpvs("");
4609             while (t < tend) {
4610                 cp[2*i] = utf8n_to_uvchr(t, tend-t, &ulen, flags);
4611                 t += ulen;
4612                 if (t < tend && *t == ILLEGAL_UTF8_BYTE) {
4613                     t++;
4614                     cp[2*i+1] = utf8n_to_uvchr(t, tend-t, &ulen, flags);
4615                     t += ulen;
4616                 }
4617                 else {
4618                  cp[2*i+1] = cp[2*i];
4619                 }
4620                 i++;
4621             }
4622             qsort(cp, i, 2*sizeof(UV), uvcompare);
4623             for (j = 0; j < i; j++) {
4624                 UV  val = cp[2*j];
4625                 diff = val - nextmin;
4626                 if (diff > 0) {
4627                     t = uvchr_to_utf8(tmpbuf,nextmin);
4628                     sv_catpvn(transv, (char*)tmpbuf, t - tmpbuf);
4629                     if (diff > 1) {
4630                         U8  range_mark = ILLEGAL_UTF8_BYTE;
4631                         t = uvchr_to_utf8(tmpbuf, val - 1);
4632                         sv_catpvn(transv, (char *)&range_mark, 1);
4633                         sv_catpvn(transv, (char*)tmpbuf, t - tmpbuf);
4634                     }
4635                 }
4636                 val = cp[2*j+1];
4637                 if (val >= nextmin)
4638                     nextmin = val + 1;
4639             }
4640             t = uvchr_to_utf8(tmpbuf,nextmin);
4641             sv_catpvn(transv, (char*)tmpbuf, t - tmpbuf);
4642             {
4643                 U8 range_mark = ILLEGAL_UTF8_BYTE;
4644                 sv_catpvn(transv, (char *)&range_mark, 1);
4645             }
4646             t = uvchr_to_utf8(tmpbuf, 0x7fffffff);
4647             sv_catpvn(transv, (char*)tmpbuf, t - tmpbuf);
4648             t = (const U8*)SvPVX_const(transv);
4649             tlen = SvCUR(transv);
4650             tend = t + tlen;
4651             Safefree(cp);
4652         }
4653         else if (!rlen && !del) {
4654             r = t; rlen = tlen; rend = tend;
4655         }
4656         if (!squash) {
4657                 if ((!rlen && !del) || t == r ||
4658                     (tlen == rlen && memEQ((char *)t, (char *)r, tlen)))
4659                 {
4660                     o->op_private |= OPpTRANS_IDENTICAL;
4661                 }
4662         }
4663
4664         while (t < tend || tfirst <= tlast) {
4665             /* see if we need more "t" chars */
4666             if (tfirst > tlast) {
4667                 tfirst = (I32)utf8n_to_uvchr(t, tend - t, &ulen, flags);
4668                 t += ulen;
4669                 if (t < tend && *t == ILLEGAL_UTF8_BYTE) {      /* illegal utf8 val indicates range */
4670                     t++;
4671                     tlast = (I32)utf8n_to_uvchr(t, tend - t, &ulen, flags);
4672                     t += ulen;
4673                 }
4674                 else
4675                     tlast = tfirst;
4676             }
4677
4678             /* now see if we need more "r" chars */
4679             if (rfirst > rlast) {
4680                 if (r < rend) {
4681                     rfirst = (I32)utf8n_to_uvchr(r, rend - r, &ulen, flags);
4682                     r += ulen;
4683                     if (r < rend && *r == ILLEGAL_UTF8_BYTE) {  /* illegal utf8 val indicates range */
4684                         r++;
4685                         rlast = (I32)utf8n_to_uvchr(r, rend - r, &ulen, flags);
4686                         r += ulen;
4687                     }
4688                     else
4689                         rlast = rfirst;
4690                 }
4691                 else {
4692                     if (!havefinal++)
4693                         final = rlast;
4694                     rfirst = rlast = 0xffffffff;
4695                 }
4696             }
4697
4698             /* now see which range will peter our first, if either. */
4699             tdiff = tlast - tfirst;
4700             rdiff = rlast - rfirst;
4701
4702             if (tdiff <= rdiff)
4703                 diff = tdiff;
4704             else
4705                 diff = rdiff;
4706
4707             if (rfirst == 0xffffffff) {
4708                 diff = tdiff;   /* oops, pretend rdiff is infinite */
4709                 if (diff > 0)
4710                     Perl_sv_catpvf(aTHX_ listsv, "%04lx\t%04lx\tXXXX\n",
4711                                    (long)tfirst, (long)tlast);
4712                 else
4713                     Perl_sv_catpvf(aTHX_ listsv, "%04lx\t\tXXXX\n", (long)tfirst);
4714             }
4715             else {
4716                 if (diff > 0)
4717                     Perl_sv_catpvf(aTHX_ listsv, "%04lx\t%04lx\t%04lx\n",
4718                                    (long)tfirst, (long)(tfirst + diff),
4719                                    (long)rfirst);
4720                 else
4721                     Perl_sv_catpvf(aTHX_ listsv, "%04lx\t\t%04lx\n",
4722                                    (long)tfirst, (long)rfirst);
4723
4724                 if (rfirst + diff > max)
4725                     max = rfirst + diff;
4726                 if (!grows)
4727                     grows = (tfirst < rfirst &&
4728                              UNISKIP(tfirst) < UNISKIP(rfirst + diff));
4729                 rfirst += diff + 1;
4730             }
4731             tfirst += diff + 1;
4732         }
4733
4734         none = ++max;
4735         if (del)
4736             del = ++max;
4737
4738         if (max > 0xffff)
4739             bits = 32;
4740         else if (max > 0xff)
4741             bits = 16;
4742         else
4743             bits = 8;
4744
4745         swash = MUTABLE_SV(swash_init("utf8", "", listsv, bits, none));
4746 #ifdef USE_ITHREADS
4747         cPADOPo->op_padix = pad_alloc(OP_TRANS, SVf_READONLY);
4748         SvREFCNT_dec(PAD_SVl(cPADOPo->op_padix));
4749         PAD_SETSV(cPADOPo->op_padix, swash);
4750         SvPADTMP_on(swash);
4751         SvREADONLY_on(swash);
4752 #else
4753         cSVOPo->op_sv = swash;
4754 #endif
4755         SvREFCNT_dec(listsv);
4756         SvREFCNT_dec(transv);
4757
4758         if (!del && havefinal && rlen)
4759             (void)hv_store(MUTABLE_HV(SvRV(swash)), "FINAL", 5,
4760                            newSVuv((UV)final), 0);
4761
4762         if (grows)
4763             o->op_private |= OPpTRANS_GROWS;
4764
4765         Safefree(tsave);
4766         Safefree(rsave);
4767
4768         op_free(expr);
4769         op_free(repl);
4770         return o;
4771     }
4772
4773     tbl = (short*)PerlMemShared_calloc(
4774         (o->op_private & OPpTRANS_COMPLEMENT) &&
4775             !(o->op_private & OPpTRANS_DELETE) ? 258 : 256,
4776         sizeof(short));
4777     cPVOPo->op_pv = (char*)tbl;
4778     if (complement) {
4779         for (i = 0; i < (I32)tlen; i++)
4780             tbl[t[i]] = -1;
4781         for (i = 0, j = 0; i < 256; i++) {
4782             if (!tbl[i]) {
4783                 if (j >= (I32)rlen) {
4784                     if (del)
4785                         tbl[i] = -2;
4786                     else if (rlen)
4787                         tbl[i] = r[j-1];
4788                     else
4789                         tbl[i] = (short)i;
4790                 }
4791                 else {
4792                     if (i < 128 && r[j] >= 128)
4793                         grows = 1;
4794                     tbl[i] = r[j++];
4795                 }
4796             }
4797         }
4798         if (!del) {
4799             if (!rlen) {
4800                 j = rlen;
4801                 if (!squash)
4802                     o->op_private |= OPpTRANS_IDENTICAL;
4803             }
4804             else if (j >= (I32)rlen)
4805                 j = rlen - 1;
4806             else {
4807                 tbl = 
4808                     (short *)
4809                     PerlMemShared_realloc(tbl,
4810                                           (0x101+rlen-j) * sizeof(short));
4811                 cPVOPo->op_pv = (char*)tbl;
4812             }
4813             tbl[0x100] = (short)(rlen - j);
4814             for (i=0; i < (I32)rlen - j; i++)
4815                 tbl[0x101+i] = r[j+i];
4816         }
4817     }
4818     else {
4819         if (!rlen && !del) {
4820             r = t; rlen = tlen;
4821             if (!squash)
4822                 o->op_private |= OPpTRANS_IDENTICAL;
4823         }
4824         else if (!squash && rlen == tlen && memEQ((char*)t, (char*)r, tlen)) {
4825             o->op_private |= OPpTRANS_IDENTICAL;
4826         }
4827         for (i = 0; i < 256; i++)
4828             tbl[i] = -1;
4829         for (i = 0, j = 0; i < (I32)tlen; i++,j++) {
4830             if (j >= (I32)rlen) {
4831                 if (del) {
4832                     if (tbl[t[i]] == -1)
4833                         tbl[t[i]] = -2;
4834                     continue;
4835                 }
4836                 --j;
4837             }
4838             if (tbl[t[i]] == -1) {
4839                 if (t[i] < 128 && r[j] >= 128)
4840                     grows = 1;
4841                 tbl[t[i]] = r[j];
4842             }
4843         }
4844     }
4845
4846     if(del && rlen == tlen) {
4847         Perl_ck_warner(aTHX_ packWARN(WARN_MISC), "Useless use of /d modifier in transliteration operator"); 
4848     } else if(rlen > tlen && !complement) {
4849         Perl_ck_warner(aTHX_ packWARN(WARN_MISC), "Replacement list is longer than search list");
4850     }
4851
4852     if (grows)
4853         o->op_private |= OPpTRANS_GROWS;
4854     op_free(expr);
4855     op_free(repl);
4856
4857     return o;
4858 }
4859
4860 /*
4861 =for apidoc Am|OP *|newPMOP|