This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Remove flagging OP_READLINE with OPf_SPECIAL
[perl5.git] / toke.c
1 /*    toke.c
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4  *    2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
5  *
6  *    You may distribute under the terms of either the GNU General Public
7  *    License or the Artistic License, as specified in the README file.
8  *
9  */
10
11 /*
12  *  'It all comes from here, the stench and the peril.'    --Frodo
13  *
14  *     [p.719 of _The Lord of the Rings_, IV/ix: "Shelob's Lair"]
15  */
16
17 /*
18  * This file is the lexer for Perl.  It's closely linked to the
19  * parser, perly.y.
20  *
21  * The main routine is yylex(), which returns the next token.
22  */
23
24 /*
25 =head1 Lexer interface
26 This is the lower layer of the Perl parser, managing characters and tokens.
27
28 =for apidoc AmU|yy_parser *|PL_parser
29
30 Pointer to a structure encapsulating the state of the parsing operation
31 currently in progress.  The pointer can be locally changed to perform
32 a nested parse without interfering with the state of an outer parse.
33 Individual members of C<PL_parser> have their own documentation.
34
35 =cut
36 */
37
38 #include "EXTERN.h"
39 #define PERL_IN_TOKE_C
40 #include "perl.h"
41 #include "dquote_static.c"
42
43 #define new_constant(a,b,c,d,e,f,g)     \
44         S_new_constant(aTHX_ a,b,STR_WITH_LEN(c),d,e,f, g)
45
46 #define pl_yylval       (PL_parser->yylval)
47
48 /* XXX temporary backwards compatibility */
49 #define PL_lex_brackets         (PL_parser->lex_brackets)
50 #define PL_lex_allbrackets      (PL_parser->lex_allbrackets)
51 #define PL_lex_fakeeof          (PL_parser->lex_fakeeof)
52 #define PL_lex_brackstack       (PL_parser->lex_brackstack)
53 #define PL_lex_casemods         (PL_parser->lex_casemods)
54 #define PL_lex_casestack        (PL_parser->lex_casestack)
55 #define PL_lex_defer            (PL_parser->lex_defer)
56 #define PL_lex_dojoin           (PL_parser->lex_dojoin)
57 #define PL_lex_expect           (PL_parser->lex_expect)
58 #define PL_lex_formbrack        (PL_parser->lex_formbrack)
59 #define PL_lex_inpat            (PL_parser->lex_inpat)
60 #define PL_lex_inwhat           (PL_parser->lex_inwhat)
61 #define PL_lex_op               (PL_parser->lex_op)
62 #define PL_lex_repl             (PL_parser->lex_repl)
63 #define PL_lex_starts           (PL_parser->lex_starts)
64 #define PL_lex_stuff            (PL_parser->lex_stuff)
65 #define PL_multi_start          (PL_parser->multi_start)
66 #define PL_multi_open           (PL_parser->multi_open)
67 #define PL_multi_close          (PL_parser->multi_close)
68 #define PL_preambled            (PL_parser->preambled)
69 #define PL_sublex_info          (PL_parser->sublex_info)
70 #define PL_linestr              (PL_parser->linestr)
71 #define PL_expect               (PL_parser->expect)
72 #define PL_copline              (PL_parser->copline)
73 #define PL_bufptr               (PL_parser->bufptr)
74 #define PL_oldbufptr            (PL_parser->oldbufptr)
75 #define PL_oldoldbufptr         (PL_parser->oldoldbufptr)
76 #define PL_linestart            (PL_parser->linestart)
77 #define PL_bufend               (PL_parser->bufend)
78 #define PL_last_uni             (PL_parser->last_uni)
79 #define PL_last_lop             (PL_parser->last_lop)
80 #define PL_last_lop_op          (PL_parser->last_lop_op)
81 #define PL_lex_state            (PL_parser->lex_state)
82 #define PL_rsfp                 (PL_parser->rsfp)
83 #define PL_rsfp_filters         (PL_parser->rsfp_filters)
84 #define PL_in_my                (PL_parser->in_my)
85 #define PL_in_my_stash          (PL_parser->in_my_stash)
86 #define PL_tokenbuf             (PL_parser->tokenbuf)
87 #define PL_multi_end            (PL_parser->multi_end)
88 #define PL_error_count          (PL_parser->error_count)
89
90 #  define PL_nexttoke           (PL_parser->nexttoke)
91 #  define PL_nexttype           (PL_parser->nexttype)
92 #  define PL_nextval            (PL_parser->nextval)
93
94 static const char* const ident_too_long = "Identifier too long";
95
96 #  define NEXTVAL_NEXTTOKE PL_nextval[PL_nexttoke]
97
98 #define XENUMMASK  0x3f
99 #define XFAKEEOF   0x40
100 #define XFAKEBRACK 0x80
101
102 #ifdef USE_UTF8_SCRIPTS
103 #   define UTF (!IN_BYTES)
104 #else
105 #   define UTF ((PL_linestr && DO_UTF8(PL_linestr)) || ( !(PL_parser->lex_flags & LEX_IGNORE_UTF8_HINTS) && (PL_hints & HINT_UTF8)))
106 #endif
107
108 /* The maximum number of characters preceding the unrecognized one to display */
109 #define UNRECOGNIZED_PRECEDE_COUNT 10
110
111 /* In variables named $^X, these are the legal values for X.
112  * 1999-02-27 mjd-perl-patch@plover.com */
113 #define isCONTROLVAR(x) (isUPPER(x) || strchr("[\\]^_?", (x)))
114
115 #define SPACE_OR_TAB(c) isBLANK_A(c)
116
117 /* LEX_* are values for PL_lex_state, the state of the lexer.
118  * They are arranged oddly so that the guard on the switch statement
119  * can get by with a single comparison (if the compiler is smart enough).
120  *
121  * These values refer to the various states within a sublex parse,
122  * i.e. within a double quotish string
123  */
124
125 /* #define LEX_NOTPARSING               11 is done in perl.h. */
126
127 #define LEX_NORMAL              10 /* normal code (ie not within "...")     */
128 #define LEX_INTERPNORMAL         9 /* code within a string, eg "$foo[$x+1]" */
129 #define LEX_INTERPCASEMOD        8 /* expecting a \U, \Q or \E etc          */
130 #define LEX_INTERPPUSH           7 /* starting a new sublex parse level     */
131 #define LEX_INTERPSTART          6 /* expecting the start of a $var         */
132
133                                    /* at end of code, eg "$x" followed by:  */
134 #define LEX_INTERPEND            5 /* ... eg not one of [, { or ->          */
135 #define LEX_INTERPENDMAYBE       4 /* ... eg one of [, { or ->              */
136
137 #define LEX_INTERPCONCAT         3 /* expecting anything, eg at start of
138                                         string or after \E, $foo, etc       */
139 #define LEX_INTERPCONST          2 /* NOT USED */
140 #define LEX_FORMLINE             1 /* expecting a format line               */
141 #define LEX_KNOWNEXT             0 /* next token known; just return it      */
142
143
144 #ifdef DEBUGGING
145 static const char* const lex_state_names[] = {
146     "KNOWNEXT",
147     "FORMLINE",
148     "INTERPCONST",
149     "INTERPCONCAT",
150     "INTERPENDMAYBE",
151     "INTERPEND",
152     "INTERPSTART",
153     "INTERPPUSH",
154     "INTERPCASEMOD",
155     "INTERPNORMAL",
156     "NORMAL"
157 };
158 #endif
159
160 #include "keywords.h"
161
162 /* CLINE is a macro that ensures PL_copline has a sane value */
163
164 #define CLINE (PL_copline = (CopLINE(PL_curcop) < PL_copline ? CopLINE(PL_curcop) : PL_copline))
165
166 #  define SKIPSPACE0(s) skipspace(s)
167 #  define SKIPSPACE1(s) skipspace(s)
168 #  define SKIPSPACE2(s,tsv) skipspace(s)
169 #  define PEEKSPACE(s) skipspace(s)
170
171 /*
172  * Convenience functions to return different tokens and prime the
173  * lexer for the next token.  They all take an argument.
174  *
175  * TOKEN        : generic token (used for '(', DOLSHARP, etc)
176  * OPERATOR     : generic operator
177  * AOPERATOR    : assignment operator
178  * PREBLOCK     : beginning the block after an if, while, foreach, ...
179  * PRETERMBLOCK : beginning a non-code-defining {} block (eg, hash ref)
180  * PREREF       : *EXPR where EXPR is not a simple identifier
181  * TERM         : expression term
182  * POSTDEREF    : postfix dereference (->$* ->@[...] etc.)
183  * LOOPX        : loop exiting command (goto, last, dump, etc)
184  * FTST         : file test operator
185  * FUN0         : zero-argument function
186  * FUN0OP       : zero-argument function, with its op created in this file
187  * FUN1         : not used, except for not, which isn't a UNIOP
188  * BOop         : bitwise or or xor
189  * BAop         : bitwise and
190  * SHop         : shift operator
191  * PWop         : power operator
192  * PMop         : pattern-matching operator
193  * Aop          : addition-level operator
194  * Mop          : multiplication-level operator
195  * Eop          : equality-testing operator
196  * Rop          : relational operator <= != gt
197  *
198  * Also see LOP and lop() below.
199  */
200
201 #ifdef DEBUGGING /* Serve -DT. */
202 #   define REPORT(retval) tokereport((I32)retval, &pl_yylval)
203 #else
204 #   define REPORT(retval) (retval)
205 #endif
206
207 #define TOKEN(retval) return ( PL_bufptr = s, REPORT(retval))
208 #define OPERATOR(retval) return (PL_expect = XTERM, PL_bufptr = s, REPORT(retval))
209 #define AOPERATOR(retval) return ao((PL_expect = XTERM, PL_bufptr = s, REPORT(retval)))
210 #define PREBLOCK(retval) return (PL_expect = XBLOCK,PL_bufptr = s, REPORT(retval))
211 #define PRETERMBLOCK(retval) return (PL_expect = XTERMBLOCK,PL_bufptr = s, REPORT(retval))
212 #define PREREF(retval) return (PL_expect = XREF,PL_bufptr = s, REPORT(retval))
213 #define TERM(retval) return (CLINE, PL_expect = XOPERATOR, PL_bufptr = s, REPORT(retval))
214 #define POSTDEREF(f) return (PL_bufptr = s, S_postderef(aTHX_ REPORT(f),s[1]))
215 #define LOOPX(f) return (pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)LOOPEX))
216 #define FTST(f)  return (pl_yylval.ival=f, PL_expect=XTERMORDORDOR, PL_bufptr=s, REPORT((int)UNIOP))
217 #define FUN0(f)  return (pl_yylval.ival=f, PL_expect=XOPERATOR, PL_bufptr=s, REPORT((int)FUNC0))
218 #define FUN0OP(f)  return (pl_yylval.opval=f, CLINE, PL_expect=XOPERATOR, PL_bufptr=s, REPORT((int)FUNC0OP))
219 #define FUN1(f)  return (pl_yylval.ival=f, PL_expect=XOPERATOR, PL_bufptr=s, REPORT((int)FUNC1))
220 #define BOop(f)  return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)BITOROP)))
221 #define BAop(f)  return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)BITANDOP)))
222 #define SHop(f)  return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)SHIFTOP)))
223 #define PWop(f)  return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)POWOP)))
224 #define PMop(f)  return(pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)MATCHOP))
225 #define Aop(f)   return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)ADDOP)))
226 #define Mop(f)   return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)MULOP)))
227 #define Eop(f)   return (pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)EQOP))
228 #define Rop(f)   return (pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)RELOP))
229
230 /* This bit of chicanery makes a unary function followed by
231  * a parenthesis into a function with one argument, highest precedence.
232  * The UNIDOR macro is for unary functions that can be followed by the //
233  * operator (such as C<shift // 0>).
234  */
235 #define UNI3(f,x,have_x) { \
236         pl_yylval.ival = f; \
237         if (have_x) PL_expect = x; \
238         PL_bufptr = s; \
239         PL_last_uni = PL_oldbufptr; \
240         PL_last_lop_op = f; \
241         if (*s == '(') \
242             return REPORT( (int)FUNC1 ); \
243         s = PEEKSPACE(s); \
244         return REPORT( *s=='(' ? (int)FUNC1 : (int)UNIOP ); \
245         }
246 #define UNI(f)    UNI3(f,XTERM,1)
247 #define UNIDOR(f) UNI3(f,XTERMORDORDOR,1)
248 #define UNIPROTO(f,optional) { \
249         if (optional) PL_last_uni = PL_oldbufptr; \
250         OPERATOR(f); \
251         }
252
253 #define UNIBRACK(f) UNI3(f,0,0)
254
255 /* grandfather return to old style */
256 #define OLDLOP(f) \
257         do { \
258             if (!PL_lex_allbrackets && PL_lex_fakeeof > LEX_FAKEEOF_LOWLOGIC) \
259                 PL_lex_fakeeof = LEX_FAKEEOF_LOWLOGIC; \
260             pl_yylval.ival = (f); \
261             PL_expect = XTERM; \
262             PL_bufptr = s; \
263             return (int)LSTOP; \
264         } while(0)
265
266 #define COPLINE_INC_WITH_HERELINES                  \
267     STMT_START {                                     \
268         CopLINE_inc(PL_curcop);                       \
269         if (PL_parser->herelines)                      \
270             CopLINE(PL_curcop) += PL_parser->herelines, \
271             PL_parser->herelines = 0;                    \
272     } STMT_END
273 /* Called after scan_str to update CopLINE(PL_curcop), but only when there
274  * is no sublex_push to follow. */
275 #define COPLINE_SET_FROM_MULTI_END            \
276     STMT_START {                               \
277         CopLINE_set(PL_curcop, PL_multi_end);   \
278         if (PL_multi_end != PL_multi_start)      \
279             PL_parser->herelines = 0;             \
280     } STMT_END
281
282
283 #ifdef DEBUGGING
284
285 /* how to interpret the pl_yylval associated with the token */
286 enum token_type {
287     TOKENTYPE_NONE,
288     TOKENTYPE_IVAL,
289     TOKENTYPE_OPNUM, /* pl_yylval.ival contains an opcode number */
290     TOKENTYPE_PVAL,
291     TOKENTYPE_OPVAL
292 };
293
294 static struct debug_tokens {
295     const int token;
296     enum token_type type;
297     const char *name;
298 } const debug_tokens[] =
299 {
300     { ADDOP,            TOKENTYPE_OPNUM,        "ADDOP" },
301     { ANDAND,           TOKENTYPE_NONE,         "ANDAND" },
302     { ANDOP,            TOKENTYPE_NONE,         "ANDOP" },
303     { ANONSUB,          TOKENTYPE_IVAL,         "ANONSUB" },
304     { ARROW,            TOKENTYPE_NONE,         "ARROW" },
305     { ASSIGNOP,         TOKENTYPE_OPNUM,        "ASSIGNOP" },
306     { BITANDOP,         TOKENTYPE_OPNUM,        "BITANDOP" },
307     { BITOROP,          TOKENTYPE_OPNUM,        "BITOROP" },
308     { COLONATTR,        TOKENTYPE_NONE,         "COLONATTR" },
309     { CONTINUE,         TOKENTYPE_NONE,         "CONTINUE" },
310     { DEFAULT,          TOKENTYPE_NONE,         "DEFAULT" },
311     { DO,               TOKENTYPE_NONE,         "DO" },
312     { DOLSHARP,         TOKENTYPE_NONE,         "DOLSHARP" },
313     { DORDOR,           TOKENTYPE_NONE,         "DORDOR" },
314     { DOROP,            TOKENTYPE_OPNUM,        "DOROP" },
315     { DOTDOT,           TOKENTYPE_IVAL,         "DOTDOT" },
316     { ELSE,             TOKENTYPE_NONE,         "ELSE" },
317     { ELSIF,            TOKENTYPE_IVAL,         "ELSIF" },
318     { EQOP,             TOKENTYPE_OPNUM,        "EQOP" },
319     { FOR,              TOKENTYPE_IVAL,         "FOR" },
320     { FORMAT,           TOKENTYPE_NONE,         "FORMAT" },
321     { FORMLBRACK,       TOKENTYPE_NONE,         "FORMLBRACK" },
322     { FORMRBRACK,       TOKENTYPE_NONE,         "FORMRBRACK" },
323     { FUNC,             TOKENTYPE_OPNUM,        "FUNC" },
324     { FUNC0,            TOKENTYPE_OPNUM,        "FUNC0" },
325     { FUNC0OP,          TOKENTYPE_OPVAL,        "FUNC0OP" },
326     { FUNC0SUB,         TOKENTYPE_OPVAL,        "FUNC0SUB" },
327     { FUNC1,            TOKENTYPE_OPNUM,        "FUNC1" },
328     { FUNCMETH,         TOKENTYPE_OPVAL,        "FUNCMETH" },
329     { GIVEN,            TOKENTYPE_IVAL,         "GIVEN" },
330     { HASHBRACK,        TOKENTYPE_NONE,         "HASHBRACK" },
331     { IF,               TOKENTYPE_IVAL,         "IF" },
332     { LABEL,            TOKENTYPE_PVAL,         "LABEL" },
333     { LOCAL,            TOKENTYPE_IVAL,         "LOCAL" },
334     { LOOPEX,           TOKENTYPE_OPNUM,        "LOOPEX" },
335     { LSTOP,            TOKENTYPE_OPNUM,        "LSTOP" },
336     { LSTOPSUB,         TOKENTYPE_OPVAL,        "LSTOPSUB" },
337     { MATCHOP,          TOKENTYPE_OPNUM,        "MATCHOP" },
338     { METHOD,           TOKENTYPE_OPVAL,        "METHOD" },
339     { MULOP,            TOKENTYPE_OPNUM,        "MULOP" },
340     { MY,               TOKENTYPE_IVAL,         "MY" },
341     { NOAMP,            TOKENTYPE_NONE,         "NOAMP" },
342     { NOTOP,            TOKENTYPE_NONE,         "NOTOP" },
343     { OROP,             TOKENTYPE_IVAL,         "OROP" },
344     { OROR,             TOKENTYPE_NONE,         "OROR" },
345     { PACKAGE,          TOKENTYPE_NONE,         "PACKAGE" },
346     { PLUGEXPR,         TOKENTYPE_OPVAL,        "PLUGEXPR" },
347     { PLUGSTMT,         TOKENTYPE_OPVAL,        "PLUGSTMT" },
348     { PMFUNC,           TOKENTYPE_OPVAL,        "PMFUNC" },
349     { POSTJOIN,         TOKENTYPE_NONE,         "POSTJOIN" },
350     { POSTDEC,          TOKENTYPE_NONE,         "POSTDEC" },
351     { POSTINC,          TOKENTYPE_NONE,         "POSTINC" },
352     { POWOP,            TOKENTYPE_OPNUM,        "POWOP" },
353     { PREDEC,           TOKENTYPE_NONE,         "PREDEC" },
354     { PREINC,           TOKENTYPE_NONE,         "PREINC" },
355     { PRIVATEREF,       TOKENTYPE_OPVAL,        "PRIVATEREF" },
356     { QWLIST,           TOKENTYPE_OPVAL,        "QWLIST" },
357     { REFGEN,           TOKENTYPE_NONE,         "REFGEN" },
358     { RELOP,            TOKENTYPE_OPNUM,        "RELOP" },
359     { REQUIRE,          TOKENTYPE_NONE,         "REQUIRE" },
360     { SHIFTOP,          TOKENTYPE_OPNUM,        "SHIFTOP" },
361     { SUB,              TOKENTYPE_NONE,         "SUB" },
362     { THING,            TOKENTYPE_OPVAL,        "THING" },
363     { UMINUS,           TOKENTYPE_NONE,         "UMINUS" },
364     { UNIOP,            TOKENTYPE_OPNUM,        "UNIOP" },
365     { UNIOPSUB,         TOKENTYPE_OPVAL,        "UNIOPSUB" },
366     { UNLESS,           TOKENTYPE_IVAL,         "UNLESS" },
367     { UNTIL,            TOKENTYPE_IVAL,         "UNTIL" },
368     { USE,              TOKENTYPE_IVAL,         "USE" },
369     { WHEN,             TOKENTYPE_IVAL,         "WHEN" },
370     { WHILE,            TOKENTYPE_IVAL,         "WHILE" },
371     { WORD,             TOKENTYPE_OPVAL,        "WORD" },
372     { YADAYADA,         TOKENTYPE_IVAL,         "YADAYADA" },
373     { 0,                TOKENTYPE_NONE,         NULL }
374 };
375
376 /* dump the returned token in rv, plus any optional arg in pl_yylval */
377
378 STATIC int
379 S_tokereport(pTHX_ I32 rv, const YYSTYPE* lvalp)
380 {
381     dVAR;
382
383     PERL_ARGS_ASSERT_TOKEREPORT;
384
385     if (DEBUG_T_TEST) {
386         const char *name = NULL;
387         enum token_type type = TOKENTYPE_NONE;
388         const struct debug_tokens *p;
389         SV* const report = newSVpvs("<== ");
390
391         for (p = debug_tokens; p->token; p++) {
392             if (p->token == (int)rv) {
393                 name = p->name;
394                 type = p->type;
395                 break;
396             }
397         }
398         if (name)
399             Perl_sv_catpv(aTHX_ report, name);
400         else if ((char)rv > ' ' && (char)rv <= '~')
401         {
402             Perl_sv_catpvf(aTHX_ report, "'%c'", (char)rv);
403             if ((char)rv == 'p')
404                 sv_catpvs(report, " (pending identifier)");
405         }
406         else if (!rv)
407             sv_catpvs(report, "EOF");
408         else
409             Perl_sv_catpvf(aTHX_ report, "?? %"IVdf, (IV)rv);
410         switch (type) {
411         case TOKENTYPE_NONE:
412             break;
413         case TOKENTYPE_IVAL:
414             Perl_sv_catpvf(aTHX_ report, "(ival=%"IVdf")", (IV)lvalp->ival);
415             break;
416         case TOKENTYPE_OPNUM:
417             Perl_sv_catpvf(aTHX_ report, "(ival=op_%s)",
418                                     PL_op_name[lvalp->ival]);
419             break;
420         case TOKENTYPE_PVAL:
421             Perl_sv_catpvf(aTHX_ report, "(pval=\"%s\")", lvalp->pval);
422             break;
423         case TOKENTYPE_OPVAL:
424             if (lvalp->opval) {
425                 Perl_sv_catpvf(aTHX_ report, "(opval=op_%s)",
426                                     PL_op_name[lvalp->opval->op_type]);
427                 if (lvalp->opval->op_type == OP_CONST) {
428                     Perl_sv_catpvf(aTHX_ report, " %s",
429                         SvPEEK(cSVOPx_sv(lvalp->opval)));
430                 }
431
432             }
433             else
434                 sv_catpvs(report, "(opval=null)");
435             break;
436         }
437         PerlIO_printf(Perl_debug_log, "### %s\n\n", SvPV_nolen_const(report));
438     };
439     return (int)rv;
440 }
441
442
443 /* print the buffer with suitable escapes */
444
445 STATIC void
446 S_printbuf(pTHX_ const char *const fmt, const char *const s)
447 {
448     SV* const tmp = newSVpvs("");
449
450     PERL_ARGS_ASSERT_PRINTBUF;
451
452     GCC_DIAG_IGNORE(-Wformat-nonliteral); /* fmt checked by caller */
453     PerlIO_printf(Perl_debug_log, fmt, pv_display(tmp, s, strlen(s), 0, 60));
454     GCC_DIAG_RESTORE;
455     SvREFCNT_dec(tmp);
456 }
457
458 #endif
459
460 static int
461 S_deprecate_commaless_var_list(pTHX) {
462     PL_expect = XTERM;
463     deprecate("comma-less variable list");
464     return REPORT(','); /* grandfather non-comma-format format */
465 }
466
467 /*
468  * S_ao
469  *
470  * This subroutine detects &&=, ||=, and //= and turns an ANDAND, OROR or DORDOR
471  * into an OP_ANDASSIGN, OP_ORASSIGN, or OP_DORASSIGN
472  */
473
474 STATIC int
475 S_ao(pTHX_ int toketype)
476 {
477     if (*PL_bufptr == '=') {
478         PL_bufptr++;
479         if (toketype == ANDAND)
480             pl_yylval.ival = OP_ANDASSIGN;
481         else if (toketype == OROR)
482             pl_yylval.ival = OP_ORASSIGN;
483         else if (toketype == DORDOR)
484             pl_yylval.ival = OP_DORASSIGN;
485         toketype = ASSIGNOP;
486     }
487     return toketype;
488 }
489
490 /*
491  * S_no_op
492  * When Perl expects an operator and finds something else, no_op
493  * prints the warning.  It always prints "<something> found where
494  * operator expected.  It prints "Missing semicolon on previous line?"
495  * if the surprise occurs at the start of the line.  "do you need to
496  * predeclare ..." is printed out for code like "sub bar; foo bar $x"
497  * where the compiler doesn't know if foo is a method call or a function.
498  * It prints "Missing operator before end of line" if there's nothing
499  * after the missing operator, or "... before <...>" if there is something
500  * after the missing operator.
501  */
502
503 STATIC void
504 S_no_op(pTHX_ const char *const what, char *s)
505 {
506     char * const oldbp = PL_bufptr;
507     const bool is_first = (PL_oldbufptr == PL_linestart);
508
509     PERL_ARGS_ASSERT_NO_OP;
510
511     if (!s)
512         s = oldbp;
513     else
514         PL_bufptr = s;
515     yywarn(Perl_form(aTHX_ "%s found where operator expected", what), UTF ? SVf_UTF8 : 0);
516     if (ckWARN_d(WARN_SYNTAX)) {
517         if (is_first)
518             Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
519                     "\t(Missing semicolon on previous line?)\n");
520         else if (PL_oldoldbufptr && isIDFIRST_lazy_if(PL_oldoldbufptr,UTF)) {
521             const char *t;
522             for (t = PL_oldoldbufptr; (isWORDCHAR_lazy_if(t,UTF) || *t == ':');
523                                                             t += UTF ? UTF8SKIP(t) : 1)
524                 NOOP;
525             if (t < PL_bufptr && isSPACE(*t))
526                 Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
527                         "\t(Do you need to predeclare %"UTF8f"?)\n",
528                       UTF8fARG(UTF, t - PL_oldoldbufptr, PL_oldoldbufptr));
529         }
530         else {
531             assert(s >= oldbp);
532             Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
533                     "\t(Missing operator before %"UTF8f"?)\n",
534                      UTF8fARG(UTF, s - oldbp, oldbp));
535         }
536     }
537     PL_bufptr = oldbp;
538 }
539
540 /*
541  * S_missingterm
542  * Complain about missing quote/regexp/heredoc terminator.
543  * If it's called with NULL then it cauterizes the line buffer.
544  * If we're in a delimited string and the delimiter is a control
545  * character, it's reformatted into a two-char sequence like ^C.
546  * This is fatal.
547  */
548
549 STATIC void
550 S_missingterm(pTHX_ char *s)
551 {
552     char tmpbuf[3];
553     char q;
554     if (s) {
555         char * const nl = strrchr(s,'\n');
556         if (nl)
557             *nl = '\0';
558     }
559     else if ((U8) PL_multi_close < 32) {
560         *tmpbuf = '^';
561         tmpbuf[1] = (char)toCTRL(PL_multi_close);
562         tmpbuf[2] = '\0';
563         s = tmpbuf;
564     }
565     else {
566         *tmpbuf = (char)PL_multi_close;
567         tmpbuf[1] = '\0';
568         s = tmpbuf;
569     }
570     q = strchr(s,'"') ? '\'' : '"';
571     Perl_croak(aTHX_ "Can't find string terminator %c%s%c anywhere before EOF",q,s,q);
572 }
573
574 #include "feature.h"
575
576 /*
577  * Check whether the named feature is enabled.
578  */
579 bool
580 Perl_feature_is_enabled(pTHX_ const char *const name, STRLEN namelen)
581 {
582     char he_name[8 + MAX_FEATURE_LEN] = "feature_";
583
584     PERL_ARGS_ASSERT_FEATURE_IS_ENABLED;
585
586     assert(CURRENT_FEATURE_BUNDLE == FEATURE_BUNDLE_CUSTOM);
587
588     if (namelen > MAX_FEATURE_LEN)
589         return FALSE;
590     memcpy(&he_name[8], name, namelen);
591
592     return cBOOL(cop_hints_fetch_pvn(PL_curcop, he_name, 8 + namelen, 0,
593                                      REFCOUNTED_HE_EXISTS));
594 }
595
596 /*
597  * experimental text filters for win32 carriage-returns, utf16-to-utf8 and
598  * utf16-to-utf8-reversed.
599  */
600
601 #ifdef PERL_CR_FILTER
602 static void
603 strip_return(SV *sv)
604 {
605     const char *s = SvPVX_const(sv);
606     const char * const e = s + SvCUR(sv);
607
608     PERL_ARGS_ASSERT_STRIP_RETURN;
609
610     /* outer loop optimized to do nothing if there are no CR-LFs */
611     while (s < e) {
612         if (*s++ == '\r' && *s == '\n') {
613             /* hit a CR-LF, need to copy the rest */
614             char *d = s - 1;
615             *d++ = *s++;
616             while (s < e) {
617                 if (*s == '\r' && s[1] == '\n')
618                     s++;
619                 *d++ = *s++;
620             }
621             SvCUR(sv) -= s - d;
622             return;
623         }
624     }
625 }
626
627 STATIC I32
628 S_cr_textfilter(pTHX_ int idx, SV *sv, int maxlen)
629 {
630     const I32 count = FILTER_READ(idx+1, sv, maxlen);
631     if (count > 0 && !maxlen)
632         strip_return(sv);
633     return count;
634 }
635 #endif
636
637 /*
638 =for apidoc Amx|void|lex_start|SV *line|PerlIO *rsfp|U32 flags
639
640 Creates and initialises a new lexer/parser state object, supplying
641 a context in which to lex and parse from a new source of Perl code.
642 A pointer to the new state object is placed in L</PL_parser>.  An entry
643 is made on the save stack so that upon unwinding the new state object
644 will be destroyed and the former value of L</PL_parser> will be restored.
645 Nothing else need be done to clean up the parsing context.
646
647 The code to be parsed comes from I<line> and I<rsfp>.  I<line>, if
648 non-null, provides a string (in SV form) containing code to be parsed.
649 A copy of the string is made, so subsequent modification of I<line>
650 does not affect parsing.  I<rsfp>, if non-null, provides an input stream
651 from which code will be read to be parsed.  If both are non-null, the
652 code in I<line> comes first and must consist of complete lines of input,
653 and I<rsfp> supplies the remainder of the source.
654
655 The I<flags> parameter is reserved for future use.  Currently it is only
656 used by perl internally, so extensions should always pass zero.
657
658 =cut
659 */
660
661 /* LEX_START_SAME_FILTER indicates that this is not a new file, so it
662    can share filters with the current parser.
663    LEX_START_DONT_CLOSE indicates that the file handle wasn't opened by the
664    caller, hence isn't owned by the parser, so shouldn't be closed on parser
665    destruction. This is used to handle the case of defaulting to reading the
666    script from the standard input because no filename was given on the command
667    line (without getting confused by situation where STDIN has been closed, so
668    the script handle is opened on fd 0)  */
669
670 void
671 Perl_lex_start(pTHX_ SV *line, PerlIO *rsfp, U32 flags)
672 {
673     const char *s = NULL;
674     yy_parser *parser, *oparser;
675     if (flags && flags & ~LEX_START_FLAGS)
676         Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_start");
677
678     /* create and initialise a parser */
679
680     Newxz(parser, 1, yy_parser);
681     parser->old_parser = oparser = PL_parser;
682     PL_parser = parser;
683
684     parser->stack = NULL;
685     parser->ps = NULL;
686     parser->stack_size = 0;
687
688     /* on scope exit, free this parser and restore any outer one */
689     SAVEPARSER(parser);
690     parser->saved_curcop = PL_curcop;
691
692     /* initialise lexer state */
693
694     parser->nexttoke = 0;
695     parser->error_count = oparser ? oparser->error_count : 0;
696     parser->copline = parser->preambling = NOLINE;
697     parser->lex_state = LEX_NORMAL;
698     parser->expect = XSTATE;
699     parser->rsfp = rsfp;
700     parser->rsfp_filters =
701       !(flags & LEX_START_SAME_FILTER) || !oparser
702         ? NULL
703         : MUTABLE_AV(SvREFCNT_inc(
704             oparser->rsfp_filters
705              ? oparser->rsfp_filters
706              : (oparser->rsfp_filters = newAV())
707           ));
708
709     Newx(parser->lex_brackstack, 120, char);
710     Newx(parser->lex_casestack, 12, char);
711     *parser->lex_casestack = '\0';
712     Newxz(parser->lex_shared, 1, LEXSHARED);
713
714     if (line) {
715         STRLEN len;
716         s = SvPV_const(line, len);
717         parser->linestr = flags & LEX_START_COPIED
718                             ? SvREFCNT_inc_simple_NN(line)
719                             : newSVpvn_flags(s, len, SvUTF8(line));
720         sv_catpvn(parser->linestr, "\n;", rsfp ? 1 : 2);
721     } else {
722         parser->linestr = newSVpvn("\n;", rsfp ? 1 : 2);
723     }
724     parser->oldoldbufptr =
725         parser->oldbufptr =
726         parser->bufptr =
727         parser->linestart = SvPVX(parser->linestr);
728     parser->bufend = parser->bufptr + SvCUR(parser->linestr);
729     parser->last_lop = parser->last_uni = NULL;
730
731     assert(FITS_IN_8_BITS(LEX_IGNORE_UTF8_HINTS|LEX_EVALBYTES
732                                                         |LEX_DONT_CLOSE_RSFP));
733     parser->lex_flags = (U8) (flags & (LEX_IGNORE_UTF8_HINTS|LEX_EVALBYTES
734                                                         |LEX_DONT_CLOSE_RSFP));
735
736     parser->in_pod = parser->filtered = 0;
737 }
738
739
740 /* delete a parser object */
741
742 void
743 Perl_parser_free(pTHX_  const yy_parser *parser)
744 {
745     PERL_ARGS_ASSERT_PARSER_FREE;
746
747     PL_curcop = parser->saved_curcop;
748     SvREFCNT_dec(parser->linestr);
749
750     if (PL_parser->lex_flags & LEX_DONT_CLOSE_RSFP)
751         PerlIO_clearerr(parser->rsfp);
752     else if (parser->rsfp && (!parser->old_parser ||
753                 (parser->old_parser && parser->rsfp != parser->old_parser->rsfp)))
754         PerlIO_close(parser->rsfp);
755     SvREFCNT_dec(parser->rsfp_filters);
756     SvREFCNT_dec(parser->lex_stuff);
757     SvREFCNT_dec(parser->sublex_info.repl);
758
759     Safefree(parser->lex_brackstack);
760     Safefree(parser->lex_casestack);
761     Safefree(parser->lex_shared);
762     PL_parser = parser->old_parser;
763     Safefree(parser);
764 }
765
766 void
767 Perl_parser_free_nexttoke_ops(pTHX_  yy_parser *parser, OPSLAB *slab)
768 {
769     I32 nexttoke = parser->nexttoke;
770     PERL_ARGS_ASSERT_PARSER_FREE_NEXTTOKE_OPS;
771     while (nexttoke--) {
772         if (S_is_opval_token(parser->nexttype[nexttoke] & 0xffff)
773          && parser->nextval[nexttoke].opval
774          && parser->nextval[nexttoke].opval->op_slabbed
775          && OpSLAB(parser->nextval[nexttoke].opval) == slab) {
776             op_free(parser->nextval[nexttoke].opval);
777             parser->nextval[nexttoke].opval = NULL;
778         }
779     }
780 }
781
782
783 /*
784 =for apidoc AmxU|SV *|PL_parser-E<gt>linestr
785
786 Buffer scalar containing the chunk currently under consideration of the
787 text currently being lexed.  This is always a plain string scalar (for
788 which C<SvPOK> is true).  It is not intended to be used as a scalar by
789 normal scalar means; instead refer to the buffer directly by the pointer
790 variables described below.
791
792 The lexer maintains various C<char*> pointers to things in the
793 C<PL_parser-E<gt>linestr> buffer.  If C<PL_parser-E<gt>linestr> is ever
794 reallocated, all of these pointers must be updated.  Don't attempt to
795 do this manually, but rather use L</lex_grow_linestr> if you need to
796 reallocate the buffer.
797
798 The content of the text chunk in the buffer is commonly exactly one
799 complete line of input, up to and including a newline terminator,
800 but there are situations where it is otherwise.  The octets of the
801 buffer may be intended to be interpreted as either UTF-8 or Latin-1.
802 The function L</lex_bufutf8> tells you which.  Do not use the C<SvUTF8>
803 flag on this scalar, which may disagree with it.
804
805 For direct examination of the buffer, the variable
806 L</PL_parser-E<gt>bufend> points to the end of the buffer.  The current
807 lexing position is pointed to by L</PL_parser-E<gt>bufptr>.  Direct use
808 of these pointers is usually preferable to examination of the scalar
809 through normal scalar means.
810
811 =for apidoc AmxU|char *|PL_parser-E<gt>bufend
812
813 Direct pointer to the end of the chunk of text currently being lexed, the
814 end of the lexer buffer.  This is equal to C<SvPVX(PL_parser-E<gt>linestr)
815 + SvCUR(PL_parser-E<gt>linestr)>.  A C<NUL> character (zero octet) is
816 always located at the end of the buffer, and does not count as part of
817 the buffer's contents.
818
819 =for apidoc AmxU|char *|PL_parser-E<gt>bufptr
820
821 Points to the current position of lexing inside the lexer buffer.
822 Characters around this point may be freely examined, within
823 the range delimited by C<SvPVX(L</PL_parser-E<gt>linestr>)> and
824 L</PL_parser-E<gt>bufend>.  The octets of the buffer may be intended to be
825 interpreted as either UTF-8 or Latin-1, as indicated by L</lex_bufutf8>.
826
827 Lexing code (whether in the Perl core or not) moves this pointer past
828 the characters that it consumes.  It is also expected to perform some
829 bookkeeping whenever a newline character is consumed.  This movement
830 can be more conveniently performed by the function L</lex_read_to>,
831 which handles newlines appropriately.
832
833 Interpretation of the buffer's octets can be abstracted out by
834 using the slightly higher-level functions L</lex_peek_unichar> and
835 L</lex_read_unichar>.
836
837 =for apidoc AmxU|char *|PL_parser-E<gt>linestart
838
839 Points to the start of the current line inside the lexer buffer.
840 This is useful for indicating at which column an error occurred, and
841 not much else.  This must be updated by any lexing code that consumes
842 a newline; the function L</lex_read_to> handles this detail.
843
844 =cut
845 */
846
847 /*
848 =for apidoc Amx|bool|lex_bufutf8
849
850 Indicates whether the octets in the lexer buffer
851 (L</PL_parser-E<gt>linestr>) should be interpreted as the UTF-8 encoding
852 of Unicode characters.  If not, they should be interpreted as Latin-1
853 characters.  This is analogous to the C<SvUTF8> flag for scalars.
854
855 In UTF-8 mode, it is not guaranteed that the lexer buffer actually
856 contains valid UTF-8.  Lexing code must be robust in the face of invalid
857 encoding.
858
859 The actual C<SvUTF8> flag of the L</PL_parser-E<gt>linestr> scalar
860 is significant, but not the whole story regarding the input character
861 encoding.  Normally, when a file is being read, the scalar contains octets
862 and its C<SvUTF8> flag is off, but the octets should be interpreted as
863 UTF-8 if the C<use utf8> pragma is in effect.  During a string eval,
864 however, the scalar may have the C<SvUTF8> flag on, and in this case its
865 octets should be interpreted as UTF-8 unless the C<use bytes> pragma
866 is in effect.  This logic may change in the future; use this function
867 instead of implementing the logic yourself.
868
869 =cut
870 */
871
872 bool
873 Perl_lex_bufutf8(pTHX)
874 {
875     return UTF;
876 }
877
878 /*
879 =for apidoc Amx|char *|lex_grow_linestr|STRLEN len
880
881 Reallocates the lexer buffer (L</PL_parser-E<gt>linestr>) to accommodate
882 at least I<len> octets (including terminating C<NUL>).  Returns a
883 pointer to the reallocated buffer.  This is necessary before making
884 any direct modification of the buffer that would increase its length.
885 L</lex_stuff_pvn> provides a more convenient way to insert text into
886 the buffer.
887
888 Do not use C<SvGROW> or C<sv_grow> directly on C<PL_parser-E<gt>linestr>;
889 this function updates all of the lexer's variables that point directly
890 into the buffer.
891
892 =cut
893 */
894
895 char *
896 Perl_lex_grow_linestr(pTHX_ STRLEN len)
897 {
898     SV *linestr;
899     char *buf;
900     STRLEN bufend_pos, bufptr_pos, oldbufptr_pos, oldoldbufptr_pos;
901     STRLEN linestart_pos, last_uni_pos, last_lop_pos, re_eval_start_pos;
902     linestr = PL_parser->linestr;
903     buf = SvPVX(linestr);
904     if (len <= SvLEN(linestr))
905         return buf;
906     bufend_pos = PL_parser->bufend - buf;
907     bufptr_pos = PL_parser->bufptr - buf;
908     oldbufptr_pos = PL_parser->oldbufptr - buf;
909     oldoldbufptr_pos = PL_parser->oldoldbufptr - buf;
910     linestart_pos = PL_parser->linestart - buf;
911     last_uni_pos = PL_parser->last_uni ? PL_parser->last_uni - buf : 0;
912     last_lop_pos = PL_parser->last_lop ? PL_parser->last_lop - buf : 0;
913     re_eval_start_pos = PL_parser->lex_shared->re_eval_start ?
914                             PL_parser->lex_shared->re_eval_start - buf : 0;
915
916     buf = sv_grow(linestr, len);
917
918     PL_parser->bufend = buf + bufend_pos;
919     PL_parser->bufptr = buf + bufptr_pos;
920     PL_parser->oldbufptr = buf + oldbufptr_pos;
921     PL_parser->oldoldbufptr = buf + oldoldbufptr_pos;
922     PL_parser->linestart = buf + linestart_pos;
923     if (PL_parser->last_uni)
924         PL_parser->last_uni = buf + last_uni_pos;
925     if (PL_parser->last_lop)
926         PL_parser->last_lop = buf + last_lop_pos;
927     if (PL_parser->lex_shared->re_eval_start)
928         PL_parser->lex_shared->re_eval_start  = buf + re_eval_start_pos;
929     return buf;
930 }
931
932 /*
933 =for apidoc Amx|void|lex_stuff_pvn|const char *pv|STRLEN len|U32 flags
934
935 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
936 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
937 reallocating the buffer if necessary.  This means that lexing code that
938 runs later will see the characters as if they had appeared in the input.
939 It is not recommended to do this as part of normal parsing, and most
940 uses of this facility run the risk of the inserted characters being
941 interpreted in an unintended manner.
942
943 The string to be inserted is represented by I<len> octets starting
944 at I<pv>.  These octets are interpreted as either UTF-8 or Latin-1,
945 according to whether the C<LEX_STUFF_UTF8> flag is set in I<flags>.
946 The characters are recoded for the lexer buffer, according to how the
947 buffer is currently being interpreted (L</lex_bufutf8>).  If a string
948 to be inserted is available as a Perl scalar, the L</lex_stuff_sv>
949 function is more convenient.
950
951 =cut
952 */
953
954 void
955 Perl_lex_stuff_pvn(pTHX_ const char *pv, STRLEN len, U32 flags)
956 {
957     dVAR;
958     char *bufptr;
959     PERL_ARGS_ASSERT_LEX_STUFF_PVN;
960     if (flags & ~(LEX_STUFF_UTF8))
961         Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_stuff_pvn");
962     if (UTF) {
963         if (flags & LEX_STUFF_UTF8) {
964             goto plain_copy;
965         } else {
966             STRLEN highhalf = 0;    /* Count of variants */
967             const char *p, *e = pv+len;
968             for (p = pv; p != e; p++) {
969                 if (! UTF8_IS_INVARIANT(*p)) {
970                     highhalf++;
971                 }
972             }
973             if (!highhalf)
974                 goto plain_copy;
975             lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len+highhalf);
976             bufptr = PL_parser->bufptr;
977             Move(bufptr, bufptr+len+highhalf, PL_parser->bufend+1-bufptr, char);
978             SvCUR_set(PL_parser->linestr,
979                 SvCUR(PL_parser->linestr) + len+highhalf);
980             PL_parser->bufend += len+highhalf;
981             for (p = pv; p != e; p++) {
982                 U8 c = (U8)*p;
983                 if (! UTF8_IS_INVARIANT(c)) {
984                     *bufptr++ = UTF8_TWO_BYTE_HI(c);
985                     *bufptr++ = UTF8_TWO_BYTE_LO(c);
986                 } else {
987                     *bufptr++ = (char)c;
988                 }
989             }
990         }
991     } else {
992         if (flags & LEX_STUFF_UTF8) {
993             STRLEN highhalf = 0;
994             const char *p, *e = pv+len;
995             for (p = pv; p != e; p++) {
996                 U8 c = (U8)*p;
997                 if (UTF8_IS_ABOVE_LATIN1(c)) {
998                     Perl_croak(aTHX_ "Lexing code attempted to stuff "
999                                 "non-Latin-1 character into Latin-1 input");
1000                 } else if (UTF8_IS_NEXT_CHAR_DOWNGRADEABLE(p, e)) {
1001                     p++;
1002                     highhalf++;
1003                 } else if (! UTF8_IS_INVARIANT(c)) {
1004                     /* malformed UTF-8 */
1005                     ENTER;
1006                     SAVESPTR(PL_warnhook);
1007                     PL_warnhook = PERL_WARNHOOK_FATAL;
1008                     utf8n_to_uvchr((U8*)p, e-p, NULL, 0);
1009                     LEAVE;
1010                 }
1011             }
1012             if (!highhalf)
1013                 goto plain_copy;
1014             lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len-highhalf);
1015             bufptr = PL_parser->bufptr;
1016             Move(bufptr, bufptr+len-highhalf, PL_parser->bufend+1-bufptr, char);
1017             SvCUR_set(PL_parser->linestr,
1018                 SvCUR(PL_parser->linestr) + len-highhalf);
1019             PL_parser->bufend += len-highhalf;
1020             p = pv;
1021             while (p < e) {
1022                 if (UTF8_IS_INVARIANT(*p)) {
1023                     *bufptr++ = *p;
1024                     p++;
1025                 }
1026                 else {
1027                     assert(p < e -1 );
1028                     *bufptr++ = TWO_BYTE_UTF8_TO_NATIVE(*p, *(p+1));
1029                     p += 2;
1030                 }
1031             }
1032         } else {
1033           plain_copy:
1034             lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len);
1035             bufptr = PL_parser->bufptr;
1036             Move(bufptr, bufptr+len, PL_parser->bufend+1-bufptr, char);
1037             SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) + len);
1038             PL_parser->bufend += len;
1039             Copy(pv, bufptr, len, char);
1040         }
1041     }
1042 }
1043
1044 /*
1045 =for apidoc Amx|void|lex_stuff_pv|const char *pv|U32 flags
1046
1047 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
1048 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
1049 reallocating the buffer if necessary.  This means that lexing code that
1050 runs later will see the characters as if they had appeared in the input.
1051 It is not recommended to do this as part of normal parsing, and most
1052 uses of this facility run the risk of the inserted characters being
1053 interpreted in an unintended manner.
1054
1055 The string to be inserted is represented by octets starting at I<pv>
1056 and continuing to the first nul.  These octets are interpreted as either
1057 UTF-8 or Latin-1, according to whether the C<LEX_STUFF_UTF8> flag is set
1058 in I<flags>.  The characters are recoded for the lexer buffer, according
1059 to how the buffer is currently being interpreted (L</lex_bufutf8>).
1060 If it is not convenient to nul-terminate a string to be inserted, the
1061 L</lex_stuff_pvn> function is more appropriate.
1062
1063 =cut
1064 */
1065
1066 void
1067 Perl_lex_stuff_pv(pTHX_ const char *pv, U32 flags)
1068 {
1069     PERL_ARGS_ASSERT_LEX_STUFF_PV;
1070     lex_stuff_pvn(pv, strlen(pv), flags);
1071 }
1072
1073 /*
1074 =for apidoc Amx|void|lex_stuff_sv|SV *sv|U32 flags
1075
1076 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
1077 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
1078 reallocating the buffer if necessary.  This means that lexing code that
1079 runs later will see the characters as if they had appeared in the input.
1080 It is not recommended to do this as part of normal parsing, and most
1081 uses of this facility run the risk of the inserted characters being
1082 interpreted in an unintended manner.
1083
1084 The string to be inserted is the string value of I<sv>.  The characters
1085 are recoded for the lexer buffer, according to how the buffer is currently
1086 being interpreted (L</lex_bufutf8>).  If a string to be inserted is
1087 not already a Perl scalar, the L</lex_stuff_pvn> function avoids the
1088 need to construct a scalar.
1089
1090 =cut
1091 */
1092
1093 void
1094 Perl_lex_stuff_sv(pTHX_ SV *sv, U32 flags)
1095 {
1096     char *pv;
1097     STRLEN len;
1098     PERL_ARGS_ASSERT_LEX_STUFF_SV;
1099     if (flags)
1100         Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_stuff_sv");
1101     pv = SvPV(sv, len);
1102     lex_stuff_pvn(pv, len, flags | (SvUTF8(sv) ? LEX_STUFF_UTF8 : 0));
1103 }
1104
1105 /*
1106 =for apidoc Amx|void|lex_unstuff|char *ptr
1107
1108 Discards text about to be lexed, from L</PL_parser-E<gt>bufptr> up to
1109 I<ptr>.  Text following I<ptr> will be moved, and the buffer shortened.
1110 This hides the discarded text from any lexing code that runs later,
1111 as if the text had never appeared.
1112
1113 This is not the normal way to consume lexed text.  For that, use
1114 L</lex_read_to>.
1115
1116 =cut
1117 */
1118
1119 void
1120 Perl_lex_unstuff(pTHX_ char *ptr)
1121 {
1122     char *buf, *bufend;
1123     STRLEN unstuff_len;
1124     PERL_ARGS_ASSERT_LEX_UNSTUFF;
1125     buf = PL_parser->bufptr;
1126     if (ptr < buf)
1127         Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_unstuff");
1128     if (ptr == buf)
1129         return;
1130     bufend = PL_parser->bufend;
1131     if (ptr > bufend)
1132         Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_unstuff");
1133     unstuff_len = ptr - buf;
1134     Move(ptr, buf, bufend+1-ptr, char);
1135     SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) - unstuff_len);
1136     PL_parser->bufend = bufend - unstuff_len;
1137 }
1138
1139 /*
1140 =for apidoc Amx|void|lex_read_to|char *ptr
1141
1142 Consume text in the lexer buffer, from L</PL_parser-E<gt>bufptr> up
1143 to I<ptr>.  This advances L</PL_parser-E<gt>bufptr> to match I<ptr>,
1144 performing the correct bookkeeping whenever a newline character is passed.
1145 This is the normal way to consume lexed text.
1146
1147 Interpretation of the buffer's octets can be abstracted out by
1148 using the slightly higher-level functions L</lex_peek_unichar> and
1149 L</lex_read_unichar>.
1150
1151 =cut
1152 */
1153
1154 void
1155 Perl_lex_read_to(pTHX_ char *ptr)
1156 {
1157     char *s;
1158     PERL_ARGS_ASSERT_LEX_READ_TO;
1159     s = PL_parser->bufptr;
1160     if (ptr < s || ptr > PL_parser->bufend)
1161         Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_to");
1162     for (; s != ptr; s++)
1163         if (*s == '\n') {
1164             COPLINE_INC_WITH_HERELINES;
1165             PL_parser->linestart = s+1;
1166         }
1167     PL_parser->bufptr = ptr;
1168 }
1169
1170 /*
1171 =for apidoc Amx|void|lex_discard_to|char *ptr
1172
1173 Discards the first part of the L</PL_parser-E<gt>linestr> buffer,
1174 up to I<ptr>.  The remaining content of the buffer will be moved, and
1175 all pointers into the buffer updated appropriately.  I<ptr> must not
1176 be later in the buffer than the position of L</PL_parser-E<gt>bufptr>:
1177 it is not permitted to discard text that has yet to be lexed.
1178
1179 Normally it is not necessarily to do this directly, because it suffices to
1180 use the implicit discarding behaviour of L</lex_next_chunk> and things
1181 based on it.  However, if a token stretches across multiple lines,
1182 and the lexing code has kept multiple lines of text in the buffer for
1183 that purpose, then after completion of the token it would be wise to
1184 explicitly discard the now-unneeded earlier lines, to avoid future
1185 multi-line tokens growing the buffer without bound.
1186
1187 =cut
1188 */
1189
1190 void
1191 Perl_lex_discard_to(pTHX_ char *ptr)
1192 {
1193     char *buf;
1194     STRLEN discard_len;
1195     PERL_ARGS_ASSERT_LEX_DISCARD_TO;
1196     buf = SvPVX(PL_parser->linestr);
1197     if (ptr < buf)
1198         Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_discard_to");
1199     if (ptr == buf)
1200         return;
1201     if (ptr > PL_parser->bufptr)
1202         Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_discard_to");
1203     discard_len = ptr - buf;
1204     if (PL_parser->oldbufptr < ptr)
1205         PL_parser->oldbufptr = ptr;
1206     if (PL_parser->oldoldbufptr < ptr)
1207         PL_parser->oldoldbufptr = ptr;
1208     if (PL_parser->last_uni && PL_parser->last_uni < ptr)
1209         PL_parser->last_uni = NULL;
1210     if (PL_parser->last_lop && PL_parser->last_lop < ptr)
1211         PL_parser->last_lop = NULL;
1212     Move(ptr, buf, PL_parser->bufend+1-ptr, char);
1213     SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) - discard_len);
1214     PL_parser->bufend -= discard_len;
1215     PL_parser->bufptr -= discard_len;
1216     PL_parser->oldbufptr -= discard_len;
1217     PL_parser->oldoldbufptr -= discard_len;
1218     if (PL_parser->last_uni)
1219         PL_parser->last_uni -= discard_len;
1220     if (PL_parser->last_lop)
1221         PL_parser->last_lop -= discard_len;
1222 }
1223
1224 /*
1225 =for apidoc Amx|bool|lex_next_chunk|U32 flags
1226
1227 Reads in the next chunk of text to be lexed, appending it to
1228 L</PL_parser-E<gt>linestr>.  This should be called when lexing code has
1229 looked to the end of the current chunk and wants to know more.  It is
1230 usual, but not necessary, for lexing to have consumed the entirety of
1231 the current chunk at this time.
1232
1233 If L</PL_parser-E<gt>bufptr> is pointing to the very end of the current
1234 chunk (i.e., the current chunk has been entirely consumed), normally the
1235 current chunk will be discarded at the same time that the new chunk is
1236 read in.  If I<flags> includes C<LEX_KEEP_PREVIOUS>, the current chunk
1237 will not be discarded.  If the current chunk has not been entirely
1238 consumed, then it will not be discarded regardless of the flag.
1239
1240 Returns true if some new text was added to the buffer, or false if the
1241 buffer has reached the end of the input text.
1242
1243 =cut
1244 */
1245
1246 #define LEX_FAKE_EOF 0x80000000
1247 #define LEX_NO_TERM  0x40000000
1248
1249 bool
1250 Perl_lex_next_chunk(pTHX_ U32 flags)
1251 {
1252     SV *linestr;
1253     char *buf;
1254     STRLEN old_bufend_pos, new_bufend_pos;
1255     STRLEN bufptr_pos, oldbufptr_pos, oldoldbufptr_pos;
1256     STRLEN linestart_pos, last_uni_pos, last_lop_pos;
1257     bool got_some_for_debugger = 0;
1258     bool got_some;
1259     if (flags & ~(LEX_KEEP_PREVIOUS|LEX_FAKE_EOF|LEX_NO_TERM))
1260         Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_next_chunk");
1261     linestr = PL_parser->linestr;
1262     buf = SvPVX(linestr);
1263     if (!(flags & LEX_KEEP_PREVIOUS) &&
1264             PL_parser->bufptr == PL_parser->bufend) {
1265         old_bufend_pos = bufptr_pos = oldbufptr_pos = oldoldbufptr_pos = 0;
1266         linestart_pos = 0;
1267         if (PL_parser->last_uni != PL_parser->bufend)
1268             PL_parser->last_uni = NULL;
1269         if (PL_parser->last_lop != PL_parser->bufend)
1270             PL_parser->last_lop = NULL;
1271         last_uni_pos = last_lop_pos = 0;
1272         *buf = 0;
1273         SvCUR(linestr) = 0;
1274     } else {
1275         old_bufend_pos = PL_parser->bufend - buf;
1276         bufptr_pos = PL_parser->bufptr - buf;
1277         oldbufptr_pos = PL_parser->oldbufptr - buf;
1278         oldoldbufptr_pos = PL_parser->oldoldbufptr - buf;
1279         linestart_pos = PL_parser->linestart - buf;
1280         last_uni_pos = PL_parser->last_uni ? PL_parser->last_uni - buf : 0;
1281         last_lop_pos = PL_parser->last_lop ? PL_parser->last_lop - buf : 0;
1282     }
1283     if (flags & LEX_FAKE_EOF) {
1284         goto eof;
1285     } else if (!PL_parser->rsfp && !PL_parser->filtered) {
1286         got_some = 0;
1287     } else if (filter_gets(linestr, old_bufend_pos)) {
1288         got_some = 1;
1289         got_some_for_debugger = 1;
1290     } else if (flags & LEX_NO_TERM) {
1291         got_some = 0;
1292     } else {
1293         if (!SvPOK(linestr))   /* can get undefined by filter_gets */
1294             sv_setpvs(linestr, "");
1295         eof:
1296         /* End of real input.  Close filehandle (unless it was STDIN),
1297          * then add implicit termination.
1298          */
1299         if (PL_parser->lex_flags & LEX_DONT_CLOSE_RSFP)
1300             PerlIO_clearerr(PL_parser->rsfp);
1301         else if (PL_parser->rsfp)
1302             (void)PerlIO_close(PL_parser->rsfp);
1303         PL_parser->rsfp = NULL;
1304         PL_parser->in_pod = PL_parser->filtered = 0;
1305         if (!PL_in_eval && PL_minus_p) {
1306             sv_catpvs(linestr,
1307                 /*{*/";}continue{print or die qq(-p destination: $!\\n);}");
1308             PL_minus_n = PL_minus_p = 0;
1309         } else if (!PL_in_eval && PL_minus_n) {
1310             sv_catpvs(linestr, /*{*/";}");
1311             PL_minus_n = 0;
1312         } else
1313             sv_catpvs(linestr, ";");
1314         got_some = 1;
1315     }
1316     buf = SvPVX(linestr);
1317     new_bufend_pos = SvCUR(linestr);
1318     PL_parser->bufend = buf + new_bufend_pos;
1319     PL_parser->bufptr = buf + bufptr_pos;
1320     PL_parser->oldbufptr = buf + oldbufptr_pos;
1321     PL_parser->oldoldbufptr = buf + oldoldbufptr_pos;
1322     PL_parser->linestart = buf + linestart_pos;
1323     if (PL_parser->last_uni)
1324         PL_parser->last_uni = buf + last_uni_pos;
1325     if (PL_parser->last_lop)
1326         PL_parser->last_lop = buf + last_lop_pos;
1327     if (PL_parser->preambling != NOLINE) {
1328         CopLINE_set(PL_curcop, PL_parser->preambling + 1);
1329         PL_parser->preambling = NOLINE;
1330     }
1331     if (got_some_for_debugger && (PERLDB_LINE || PERLDB_SAVESRC) &&
1332             PL_curstash != PL_debstash) {
1333         /* debugger active and we're not compiling the debugger code,
1334          * so store the line into the debugger's array of lines
1335          */
1336         update_debugger_info(NULL, buf+old_bufend_pos,
1337             new_bufend_pos-old_bufend_pos);
1338     }
1339     return got_some;
1340 }
1341
1342 /*
1343 =for apidoc Amx|I32|lex_peek_unichar|U32 flags
1344
1345 Looks ahead one (Unicode) character in the text currently being lexed.
1346 Returns the codepoint (unsigned integer value) of the next character,
1347 or -1 if lexing has reached the end of the input text.  To consume the
1348 peeked character, use L</lex_read_unichar>.
1349
1350 If the next character is in (or extends into) the next chunk of input
1351 text, the next chunk will be read in.  Normally the current chunk will be
1352 discarded at the same time, but if I<flags> includes C<LEX_KEEP_PREVIOUS>
1353 then the current chunk will not be discarded.
1354
1355 If the input is being interpreted as UTF-8 and a UTF-8 encoding error
1356 is encountered, an exception is generated.
1357
1358 =cut
1359 */
1360
1361 I32
1362 Perl_lex_peek_unichar(pTHX_ U32 flags)
1363 {
1364     dVAR;
1365     char *s, *bufend;
1366     if (flags & ~(LEX_KEEP_PREVIOUS))
1367         Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_peek_unichar");
1368     s = PL_parser->bufptr;
1369     bufend = PL_parser->bufend;
1370     if (UTF) {
1371         U8 head;
1372         I32 unichar;
1373         STRLEN len, retlen;
1374         if (s == bufend) {
1375             if (!lex_next_chunk(flags))
1376                 return -1;
1377             s = PL_parser->bufptr;
1378             bufend = PL_parser->bufend;
1379         }
1380         head = (U8)*s;
1381         if (UTF8_IS_INVARIANT(head))
1382             return head;
1383         if (UTF8_IS_START(head)) {
1384             len = UTF8SKIP(&head);
1385             while ((STRLEN)(bufend-s) < len) {
1386                 if (!lex_next_chunk(flags | LEX_KEEP_PREVIOUS))
1387                     break;
1388                 s = PL_parser->bufptr;
1389                 bufend = PL_parser->bufend;
1390             }
1391         }
1392         unichar = utf8n_to_uvchr((U8*)s, bufend-s, &retlen, UTF8_CHECK_ONLY);
1393         if (retlen == (STRLEN)-1) {
1394             /* malformed UTF-8 */
1395             ENTER;
1396             SAVESPTR(PL_warnhook);
1397             PL_warnhook = PERL_WARNHOOK_FATAL;
1398             utf8n_to_uvchr((U8*)s, bufend-s, NULL, 0);
1399             LEAVE;
1400         }
1401         return unichar;
1402     } else {
1403         if (s == bufend) {
1404             if (!lex_next_chunk(flags))
1405                 return -1;
1406             s = PL_parser->bufptr;
1407         }
1408         return (U8)*s;
1409     }
1410 }
1411
1412 /*
1413 =for apidoc Amx|I32|lex_read_unichar|U32 flags
1414
1415 Reads the next (Unicode) character in the text currently being lexed.
1416 Returns the codepoint (unsigned integer value) of the character read,
1417 and moves L</PL_parser-E<gt>bufptr> past the character, or returns -1
1418 if lexing has reached the end of the input text.  To non-destructively
1419 examine the next character, use L</lex_peek_unichar> instead.
1420
1421 If the next character is in (or extends into) the next chunk of input
1422 text, the next chunk will be read in.  Normally the current chunk will be
1423 discarded at the same time, but if I<flags> includes C<LEX_KEEP_PREVIOUS>
1424 then the current chunk will not be discarded.
1425
1426 If the input is being interpreted as UTF-8 and a UTF-8 encoding error
1427 is encountered, an exception is generated.
1428
1429 =cut
1430 */
1431
1432 I32
1433 Perl_lex_read_unichar(pTHX_ U32 flags)
1434 {
1435     I32 c;
1436     if (flags & ~(LEX_KEEP_PREVIOUS))
1437         Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_unichar");
1438     c = lex_peek_unichar(flags);
1439     if (c != -1) {
1440         if (c == '\n')
1441             COPLINE_INC_WITH_HERELINES;
1442         if (UTF)
1443             PL_parser->bufptr += UTF8SKIP(PL_parser->bufptr);
1444         else
1445             ++(PL_parser->bufptr);
1446     }
1447     return c;
1448 }
1449
1450 /*
1451 =for apidoc Amx|void|lex_read_space|U32 flags
1452
1453 Reads optional spaces, in Perl style, in the text currently being
1454 lexed.  The spaces may include ordinary whitespace characters and
1455 Perl-style comments.  C<#line> directives are processed if encountered.
1456 L</PL_parser-E<gt>bufptr> is moved past the spaces, so that it points
1457 at a non-space character (or the end of the input text).
1458
1459 If spaces extend into the next chunk of input text, the next chunk will
1460 be read in.  Normally the current chunk will be discarded at the same
1461 time, but if I<flags> includes C<LEX_KEEP_PREVIOUS> then the current
1462 chunk will not be discarded.
1463
1464 =cut
1465 */
1466
1467 #define LEX_NO_INCLINE    0x40000000
1468 #define LEX_NO_NEXT_CHUNK 0x80000000
1469
1470 void
1471 Perl_lex_read_space(pTHX_ U32 flags)
1472 {
1473     char *s, *bufend;
1474     const bool can_incline = !(flags & LEX_NO_INCLINE);
1475     bool need_incline = 0;
1476     if (flags & ~(LEX_KEEP_PREVIOUS|LEX_NO_NEXT_CHUNK|LEX_NO_INCLINE))
1477         Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_space");
1478     s = PL_parser->bufptr;
1479     bufend = PL_parser->bufend;
1480     while (1) {
1481         char c = *s;
1482         if (c == '#') {
1483             do {
1484                 c = *++s;
1485             } while (!(c == '\n' || (c == 0 && s == bufend)));
1486         } else if (c == '\n') {
1487             s++;
1488             if (can_incline) {
1489                 PL_parser->linestart = s;
1490                 if (s == bufend)
1491                     need_incline = 1;
1492                 else
1493                     incline(s);
1494             }
1495         } else if (isSPACE(c)) {
1496             s++;
1497         } else if (c == 0 && s == bufend) {
1498             bool got_more;
1499             line_t l;
1500             if (flags & LEX_NO_NEXT_CHUNK)
1501                 break;
1502             PL_parser->bufptr = s;
1503             l = CopLINE(PL_curcop);
1504             CopLINE(PL_curcop) += PL_parser->herelines + 1;
1505             got_more = lex_next_chunk(flags);
1506             CopLINE_set(PL_curcop, l);
1507             s = PL_parser->bufptr;
1508             bufend = PL_parser->bufend;
1509             if (!got_more)
1510                 break;
1511             if (can_incline && need_incline && PL_parser->rsfp) {
1512                 incline(s);
1513                 need_incline = 0;
1514             }
1515         } else {
1516             break;
1517         }
1518     }
1519     PL_parser->bufptr = s;
1520 }
1521
1522 /*
1523
1524 =for apidoc EXMp|bool|validate_proto|SV *name|SV *proto|bool warn
1525
1526 This function performs syntax checking on a prototype, C<proto>.
1527 If C<warn> is true, any illegal characters or mismatched brackets
1528 will trigger illegalproto warnings, declaring that they were
1529 detected in the prototype for C<name>.
1530
1531 The return value is C<true> if this is a valid prototype, and
1532 C<false> if it is not, regardless of whether C<warn> was C<true> or
1533 C<false>.
1534
1535 Note that C<NULL> is a valid C<proto> and will always return C<true>.
1536
1537 =cut
1538
1539  */
1540
1541 bool
1542 Perl_validate_proto(pTHX_ SV *name, SV *proto, bool warn)
1543 {
1544     STRLEN len, origlen;
1545     char *p = proto ? SvPV(proto, len) : NULL;
1546     bool bad_proto = FALSE;
1547     bool in_brackets = FALSE;
1548     bool after_slash = FALSE;
1549     char greedy_proto = ' ';
1550     bool proto_after_greedy_proto = FALSE;
1551     bool must_be_last = FALSE;
1552     bool underscore = FALSE;
1553     bool bad_proto_after_underscore = FALSE;
1554
1555     PERL_ARGS_ASSERT_VALIDATE_PROTO;
1556
1557     if (!proto)
1558         return TRUE;
1559
1560     origlen = len;
1561     for (; len--; p++) {
1562         if (!isSPACE(*p)) {
1563             if (must_be_last)
1564                 proto_after_greedy_proto = TRUE;
1565             if (underscore) {
1566                 if (!strchr(";@%", *p))
1567                     bad_proto_after_underscore = TRUE;
1568                 underscore = FALSE;
1569             }
1570             if (!strchr("$@%*;[]&\\_+", *p) || *p == '\0') {
1571                 bad_proto = TRUE;
1572             }
1573             else {
1574                 if (*p == '[')
1575                     in_brackets = TRUE;
1576                 else if (*p == ']')
1577                     in_brackets = FALSE;
1578                 else if ((*p == '@' || *p == '%') &&
1579                     !after_slash &&
1580                     !in_brackets ) {
1581                     must_be_last = TRUE;
1582                     greedy_proto = *p;
1583                 }
1584                 else if (*p == '_')
1585                     underscore = TRUE;
1586             }
1587             if (*p == '\\')
1588                 after_slash = TRUE;
1589             else
1590                 after_slash = FALSE;
1591         }
1592     }
1593
1594     if (warn) {
1595         SV *tmpsv = newSVpvs_flags("", SVs_TEMP);
1596         p -= origlen;
1597         p = SvUTF8(proto)
1598             ? sv_uni_display(tmpsv, newSVpvn_flags(p, origlen, SVs_TEMP | SVf_UTF8),
1599                              origlen, UNI_DISPLAY_ISPRINT)
1600             : pv_pretty(tmpsv, p, origlen, 60, NULL, NULL, PERL_PV_ESCAPE_NONASCII);
1601
1602         if (proto_after_greedy_proto)
1603             Perl_warner(aTHX_ packWARN(WARN_ILLEGALPROTO),
1604                         "Prototype after '%c' for %"SVf" : %s",
1605                         greedy_proto, SVfARG(name), p);
1606         if (in_brackets)
1607             Perl_warner(aTHX_ packWARN(WARN_ILLEGALPROTO),
1608                         "Missing ']' in prototype for %"SVf" : %s",
1609                         SVfARG(name), p);
1610         if (bad_proto)
1611             Perl_warner(aTHX_ packWARN(WARN_ILLEGALPROTO),
1612                         "Illegal character in prototype for %"SVf" : %s",
1613                         SVfARG(name), p);
1614         if (bad_proto_after_underscore)
1615             Perl_warner(aTHX_ packWARN(WARN_ILLEGALPROTO),
1616                         "Illegal character after '_' in prototype for %"SVf" : %s",
1617                         SVfARG(name), p);
1618     }
1619
1620     return (! (proto_after_greedy_proto || bad_proto) );
1621 }
1622
1623 /*
1624  * S_incline
1625  * This subroutine has nothing to do with tilting, whether at windmills
1626  * or pinball tables.  Its name is short for "increment line".  It
1627  * increments the current line number in CopLINE(PL_curcop) and checks
1628  * to see whether the line starts with a comment of the form
1629  *    # line 500 "foo.pm"
1630  * If so, it sets the current line number and file to the values in the comment.
1631  */
1632
1633 STATIC void
1634 S_incline(pTHX_ const char *s)
1635 {
1636     const char *t;
1637     const char *n;
1638     const char *e;
1639     line_t line_num;
1640
1641     PERL_ARGS_ASSERT_INCLINE;
1642
1643     COPLINE_INC_WITH_HERELINES;
1644     if (!PL_rsfp && !PL_parser->filtered && PL_lex_state == LEX_NORMAL
1645      && s+1 == PL_bufend && *s == ';') {
1646         /* fake newline in string eval */
1647         CopLINE_dec(PL_curcop);
1648         return;
1649     }
1650     if (*s++ != '#')
1651         return;
1652     while (SPACE_OR_TAB(*s))
1653         s++;
1654     if (strnEQ(s, "line", 4))
1655         s += 4;
1656     else
1657         return;
1658     if (SPACE_OR_TAB(*s))
1659         s++;
1660     else
1661         return;
1662     while (SPACE_OR_TAB(*s))
1663         s++;
1664     if (!isDIGIT(*s))
1665         return;
1666
1667     n = s;
1668     while (isDIGIT(*s))
1669         s++;
1670     if (!SPACE_OR_TAB(*s) && *s != '\r' && *s != '\n' && *s != '\0')
1671         return;
1672     while (SPACE_OR_TAB(*s))
1673         s++;
1674     if (*s == '"' && (t = strchr(s+1, '"'))) {
1675         s++;
1676         e = t + 1;
1677     }
1678     else {
1679         t = s;
1680         while (!isSPACE(*t))
1681             t++;
1682         e = t;
1683     }
1684     while (SPACE_OR_TAB(*e) || *e == '\r' || *e == '\f')
1685         e++;
1686     if (*e != '\n' && *e != '\0')
1687         return;         /* false alarm */
1688
1689     line_num = grok_atou(n, &e) - 1;
1690
1691     if (t - s > 0) {
1692         const STRLEN len = t - s;
1693
1694         if (!PL_rsfp && !PL_parser->filtered) {
1695             /* must copy *{"::_<(eval N)[oldfilename:L]"}
1696              * to *{"::_<newfilename"} */
1697             /* However, the long form of evals is only turned on by the
1698                debugger - usually they're "(eval %lu)" */
1699             GV * const cfgv = CopFILEGV(PL_curcop);
1700             if (cfgv) {
1701                 char smallbuf[128];
1702                 STRLEN tmplen2 = len;
1703                 char *tmpbuf2;
1704                 GV *gv2;
1705
1706                 if (tmplen2 + 2 <= sizeof smallbuf)
1707                     tmpbuf2 = smallbuf;
1708                 else
1709                     Newx(tmpbuf2, tmplen2 + 2, char);
1710
1711                 tmpbuf2[0] = '_';
1712                 tmpbuf2[1] = '<';
1713
1714                 memcpy(tmpbuf2 + 2, s, tmplen2);
1715                 tmplen2 += 2;
1716
1717                 gv2 = *(GV**)hv_fetch(PL_defstash, tmpbuf2, tmplen2, TRUE);
1718                 if (!isGV(gv2)) {
1719                     gv_init(gv2, PL_defstash, tmpbuf2, tmplen2, FALSE);
1720                     /* adjust ${"::_<newfilename"} to store the new file name */
1721                     GvSV(gv2) = newSVpvn(tmpbuf2 + 2, tmplen2 - 2);
1722                     /* The line number may differ. If that is the case,
1723                        alias the saved lines that are in the array.
1724                        Otherwise alias the whole array. */
1725                     if (CopLINE(PL_curcop) == line_num) {
1726                         GvHV(gv2) = MUTABLE_HV(SvREFCNT_inc(GvHV(cfgv)));
1727                         GvAV(gv2) = MUTABLE_AV(SvREFCNT_inc(GvAV(cfgv)));
1728                     }
1729                     else if (GvAV(cfgv)) {
1730                         AV * const av = GvAV(cfgv);
1731                         const I32 start = CopLINE(PL_curcop)+1;
1732                         I32 items = AvFILLp(av) - start;
1733                         if (items > 0) {
1734                             AV * const av2 = GvAVn(gv2);
1735                             SV **svp = AvARRAY(av) + start;
1736                             I32 l = (I32)line_num+1;
1737                             while (items--)
1738                                 av_store(av2, l++, SvREFCNT_inc(*svp++));
1739                         }
1740                     }
1741                 }
1742
1743                 if (tmpbuf2 != smallbuf) Safefree(tmpbuf2);
1744             }
1745         }
1746         CopFILE_free(PL_curcop);
1747         CopFILE_setn(PL_curcop, s, len);
1748     }
1749     CopLINE_set(PL_curcop, line_num);
1750 }
1751
1752 #define skipspace(s) skipspace_flags(s, 0)
1753
1754
1755 STATIC void
1756 S_update_debugger_info(pTHX_ SV *orig_sv, const char *const buf, STRLEN len)
1757 {
1758     AV *av = CopFILEAVx(PL_curcop);
1759     if (av) {
1760         SV * sv;
1761         if (PL_parser->preambling == NOLINE) sv = newSV_type(SVt_PVMG);
1762         else {
1763             sv = *av_fetch(av, 0, 1);
1764             SvUPGRADE(sv, SVt_PVMG);
1765         }
1766         if (!SvPOK(sv)) sv_setpvs(sv,"");
1767         if (orig_sv)
1768             sv_catsv(sv, orig_sv);
1769         else
1770             sv_catpvn(sv, buf, len);
1771         if (!SvIOK(sv)) {
1772             (void)SvIOK_on(sv);
1773             SvIV_set(sv, 0);
1774         }
1775         if (PL_parser->preambling == NOLINE)
1776             av_store(av, CopLINE(PL_curcop), sv);
1777     }
1778 }
1779
1780 /*
1781  * S_skipspace
1782  * Called to gobble the appropriate amount and type of whitespace.
1783  * Skips comments as well.
1784  */
1785
1786 STATIC char *
1787 S_skipspace_flags(pTHX_ char *s, U32 flags)
1788 {
1789     PERL_ARGS_ASSERT_SKIPSPACE_FLAGS;
1790     if (PL_lex_formbrack && PL_lex_brackets <= PL_lex_formbrack) {
1791         while (s < PL_bufend && SPACE_OR_TAB(*s))
1792             s++;
1793     } else {
1794         STRLEN bufptr_pos = PL_bufptr - SvPVX(PL_linestr);
1795         PL_bufptr = s;
1796         lex_read_space(flags | LEX_KEEP_PREVIOUS |
1797                 (PL_sublex_info.sub_inwhat || PL_lex_state == LEX_FORMLINE ?
1798                     LEX_NO_NEXT_CHUNK : 0));
1799         s = PL_bufptr;
1800         PL_bufptr = SvPVX(PL_linestr) + bufptr_pos;
1801         if (PL_linestart > PL_bufptr)
1802             PL_bufptr = PL_linestart;
1803         return s;
1804     }
1805     return s;
1806 }
1807
1808 /*
1809  * S_check_uni
1810  * Check the unary operators to ensure there's no ambiguity in how they're
1811  * used.  An ambiguous piece of code would be:
1812  *     rand + 5
1813  * This doesn't mean rand() + 5.  Because rand() is a unary operator,
1814  * the +5 is its argument.
1815  */
1816
1817 STATIC void
1818 S_check_uni(pTHX)
1819 {
1820     const char *s;
1821     const char *t;
1822
1823     if (PL_oldoldbufptr != PL_last_uni)
1824         return;
1825     while (isSPACE(*PL_last_uni))
1826         PL_last_uni++;
1827     s = PL_last_uni;
1828     while (isWORDCHAR_lazy_if(s,UTF) || *s == '-')
1829         s++;
1830     if ((t = strchr(s, '(')) && t < PL_bufptr)
1831         return;
1832
1833     Perl_ck_warner_d(aTHX_ packWARN(WARN_AMBIGUOUS),
1834                      "Warning: Use of \"%.*s\" without parentheses is ambiguous",
1835                      (int)(s - PL_last_uni), PL_last_uni);
1836 }
1837
1838 /*
1839  * LOP : macro to build a list operator.  Its behaviour has been replaced
1840  * with a subroutine, S_lop() for which LOP is just another name.
1841  */
1842
1843 #define LOP(f,x) return lop(f,x,s)
1844
1845 /*
1846  * S_lop
1847  * Build a list operator (or something that might be one).  The rules:
1848  *  - if we have a next token, then it's a list operator [why?]
1849  *  - if the next thing is an opening paren, then it's a function
1850  *  - else it's a list operator
1851  */
1852
1853 STATIC I32
1854 S_lop(pTHX_ I32 f, int x, char *s)
1855 {
1856     PERL_ARGS_ASSERT_LOP;
1857
1858     pl_yylval.ival = f;
1859     CLINE;
1860     PL_expect = x;
1861     PL_bufptr = s;
1862     PL_last_lop = PL_oldbufptr;
1863     PL_last_lop_op = (OPCODE)f;
1864     if (PL_nexttoke)
1865         goto lstop;
1866     if (*s == '(')
1867         return REPORT(FUNC);
1868     s = PEEKSPACE(s);
1869     if (*s == '(')
1870         return REPORT(FUNC);
1871     else {
1872         lstop:
1873         if (!PL_lex_allbrackets && PL_lex_fakeeof > LEX_FAKEEOF_LOWLOGIC)
1874             PL_lex_fakeeof = LEX_FAKEEOF_LOWLOGIC;
1875         return REPORT(LSTOP);
1876     }
1877 }
1878
1879 /*
1880  * S_force_next
1881  * When the lexer realizes it knows the next token (for instance,
1882  * it is reordering tokens for the parser) then it can call S_force_next
1883  * to know what token to return the next time the lexer is called.  Caller
1884  * will need to set PL_nextval[] and possibly PL_expect to ensure
1885  * the lexer handles the token correctly.
1886  */
1887
1888 STATIC void
1889 S_force_next(pTHX_ I32 type)
1890 {
1891 #ifdef DEBUGGING
1892     if (DEBUG_T_TEST) {
1893         PerlIO_printf(Perl_debug_log, "### forced token:\n");
1894         tokereport(type, &NEXTVAL_NEXTTOKE);
1895     }
1896 #endif
1897     PL_nexttype[PL_nexttoke] = type;
1898     PL_nexttoke++;
1899     if (PL_lex_state != LEX_KNOWNEXT) {
1900         PL_lex_defer = PL_lex_state;
1901         PL_lex_expect = PL_expect;
1902         PL_lex_state = LEX_KNOWNEXT;
1903     }
1904 }
1905
1906 /*
1907  * S_postderef
1908  *
1909  * This subroutine handles postfix deref syntax after the arrow has already
1910  * been emitted.  @* $* etc. are emitted as two separate token right here.
1911  * @[ @{ %[ %{ *{ are emitted also as two tokens, but this function emits
1912  * only the first, leaving yylex to find the next.
1913  */
1914
1915 static int
1916 S_postderef(pTHX_ int const funny, char const next)
1917 {
1918     assert(funny == DOLSHARP || strchr("$@%&*", funny));
1919     assert(strchr("*[{", next));
1920     if (next == '*') {
1921         PL_expect = XOPERATOR;
1922         if (PL_lex_state == LEX_INTERPNORMAL && !PL_lex_brackets) {
1923             assert('@' == funny || '$' == funny || DOLSHARP == funny);
1924             PL_lex_state = LEX_INTERPEND;
1925             force_next(POSTJOIN);
1926         }
1927         force_next(next);
1928         PL_bufptr+=2;
1929     }
1930     else {
1931         if ('@' == funny && PL_lex_state == LEX_INTERPNORMAL
1932          && !PL_lex_brackets)
1933             PL_lex_dojoin = 2;
1934         PL_expect = XOPERATOR;
1935         PL_bufptr++;
1936     }
1937     return funny;
1938 }
1939
1940 void
1941 Perl_yyunlex(pTHX)
1942 {
1943     int yyc = PL_parser->yychar;
1944     if (yyc != YYEMPTY) {
1945         if (yyc) {
1946             NEXTVAL_NEXTTOKE = PL_parser->yylval;
1947             if (yyc == '{'/*}*/ || yyc == HASHBRACK || yyc == '['/*]*/) {
1948                 PL_lex_allbrackets--;
1949                 PL_lex_brackets--;
1950                 yyc |= (3<<24) | (PL_lex_brackstack[PL_lex_brackets] << 16);
1951             } else if (yyc == '('/*)*/) {
1952                 PL_lex_allbrackets--;
1953                 yyc |= (2<<24);
1954             }
1955             force_next(yyc);
1956         }
1957         PL_parser->yychar = YYEMPTY;
1958     }
1959 }
1960
1961 STATIC SV *
1962 S_newSV_maybe_utf8(pTHX_ const char *const start, STRLEN len)
1963 {
1964     SV * const sv = newSVpvn_utf8(start, len,
1965                                   !IN_BYTES
1966                                   && UTF
1967                                   && !is_ascii_string((const U8*)start, len)
1968                                   && is_utf8_string((const U8*)start, len));
1969     return sv;
1970 }
1971
1972 /*
1973  * S_force_word
1974  * When the lexer knows the next thing is a word (for instance, it has
1975  * just seen -> and it knows that the next char is a word char, then
1976  * it calls S_force_word to stick the next word into the PL_nexttoke/val
1977  * lookahead.
1978  *
1979  * Arguments:
1980  *   char *start : buffer position (must be within PL_linestr)
1981  *   int token   : PL_next* will be this type of bare word (e.g., METHOD,WORD)
1982  *   int check_keyword : if true, Perl checks to make sure the word isn't
1983  *       a keyword (do this if the word is a label, e.g. goto FOO)
1984  *   int allow_pack : if true, : characters will also be allowed (require,
1985  *       use, etc. do this)
1986  *   int allow_initial_tick : used by the "sub" lexer only.
1987  */
1988
1989 STATIC char *
1990 S_force_word(pTHX_ char *start, int token, int check_keyword, int allow_pack)
1991 {
1992     char *s;
1993     STRLEN len;
1994
1995     PERL_ARGS_ASSERT_FORCE_WORD;
1996
1997     start = SKIPSPACE1(start);
1998     s = start;
1999     if (isIDFIRST_lazy_if(s,UTF) ||
2000         (allow_pack && *s == ':') )
2001     {
2002         s = scan_word(s, PL_tokenbuf, sizeof PL_tokenbuf, allow_pack, &len);
2003         if (check_keyword) {
2004           char *s2 = PL_tokenbuf;
2005           if (allow_pack && len > 6 && strnEQ(s2, "CORE::", 6))
2006             s2 += 6, len -= 6;
2007           if (keyword(s2, len, 0))
2008             return start;
2009         }
2010         if (token == METHOD) {
2011             s = SKIPSPACE1(s);
2012             if (*s == '(')
2013                 PL_expect = XTERM;
2014             else {
2015                 PL_expect = XOPERATOR;
2016             }
2017         }
2018         NEXTVAL_NEXTTOKE.opval
2019             = (OP*)newSVOP(OP_CONST,0,
2020                            S_newSV_maybe_utf8(aTHX_ PL_tokenbuf, len));
2021         NEXTVAL_NEXTTOKE.opval->op_private |= OPpCONST_BARE;
2022         force_next(token);
2023     }
2024     return s;
2025 }
2026
2027 /*
2028  * S_force_ident
2029  * Called when the lexer wants $foo *foo &foo etc, but the program
2030  * text only contains the "foo" portion.  The first argument is a pointer
2031  * to the "foo", and the second argument is the type symbol to prefix.
2032  * Forces the next token to be a "WORD".
2033  * Creates the symbol if it didn't already exist (via gv_fetchpv()).
2034  */
2035
2036 STATIC void
2037 S_force_ident(pTHX_ const char *s, int kind)
2038 {
2039     PERL_ARGS_ASSERT_FORCE_IDENT;
2040
2041     if (s[0]) {
2042         const STRLEN len = s[1] ? strlen(s) : 1; /* s = "\"" see yylex */
2043         OP* const o = (OP*)newSVOP(OP_CONST, 0, newSVpvn_flags(s, len,
2044                                                                 UTF ? SVf_UTF8 : 0));
2045         NEXTVAL_NEXTTOKE.opval = o;
2046         force_next(WORD);
2047         if (kind) {
2048             o->op_private = OPpCONST_ENTERED;
2049             /* XXX see note in pp_entereval() for why we forgo typo
2050                warnings if the symbol must be introduced in an eval.
2051                GSAR 96-10-12 */
2052             gv_fetchpvn_flags(s, len,
2053                               (PL_in_eval ? (GV_ADDMULTI | GV_ADDINEVAL)
2054                               : GV_ADD) | ( UTF ? SVf_UTF8 : 0 ),
2055                               kind == '$' ? SVt_PV :
2056                               kind == '@' ? SVt_PVAV :
2057                               kind == '%' ? SVt_PVHV :
2058                               SVt_PVGV
2059                               );
2060         }
2061     }
2062 }
2063
2064 static void
2065 S_force_ident_maybe_lex(pTHX_ char pit)
2066 {
2067     NEXTVAL_NEXTTOKE.ival = pit;
2068     force_next('p');
2069 }
2070
2071 NV
2072 Perl_str_to_version(pTHX_ SV *sv)
2073 {
2074     NV retval = 0.0;
2075     NV nshift = 1.0;
2076     STRLEN len;
2077     const char *start = SvPV_const(sv,len);
2078     const char * const end = start + len;
2079     const bool utf = SvUTF8(sv) ? TRUE : FALSE;
2080
2081     PERL_ARGS_ASSERT_STR_TO_VERSION;
2082
2083     while (start < end) {
2084         STRLEN skip;
2085         UV n;
2086         if (utf)
2087             n = utf8n_to_uvchr((U8*)start, len, &skip, 0);
2088         else {
2089             n = *(U8*)start;
2090             skip = 1;
2091         }
2092         retval += ((NV)n)/nshift;
2093         start += skip;
2094         nshift *= 1000;
2095     }
2096     return retval;
2097 }
2098
2099 /*
2100  * S_force_version
2101  * Forces the next token to be a version number.
2102  * If the next token appears to be an invalid version number, (e.g. "v2b"),
2103  * and if "guessing" is TRUE, then no new token is created (and the caller
2104  * must use an alternative parsing method).
2105  */
2106
2107 STATIC char *
2108 S_force_version(pTHX_ char *s, int guessing)
2109 {
2110     OP *version = NULL;
2111     char *d;
2112
2113     PERL_ARGS_ASSERT_FORCE_VERSION;
2114
2115     s = SKIPSPACE1(s);
2116
2117     d = s;
2118     if (*d == 'v')
2119         d++;
2120     if (isDIGIT(*d)) {
2121         while (isDIGIT(*d) || *d == '_' || *d == '.')
2122             d++;
2123         if (*d == ';' || isSPACE(*d) || *d == '{' || *d == '}' || !*d) {
2124             SV *ver;
2125             s = scan_num(s, &pl_yylval);
2126             version = pl_yylval.opval;
2127             ver = cSVOPx(version)->op_sv;
2128             if (SvPOK(ver) && !SvNIOK(ver)) {
2129                 SvUPGRADE(ver, SVt_PVNV);
2130                 SvNV_set(ver, str_to_version(ver));
2131                 SvNOK_on(ver);          /* hint that it is a version */
2132             }
2133         }
2134         else if (guessing) {
2135             return s;
2136         }
2137     }
2138
2139     /* NOTE: The parser sees the package name and the VERSION swapped */
2140     NEXTVAL_NEXTTOKE.opval = version;
2141     force_next(WORD);
2142
2143     return s;
2144 }
2145
2146 /*
2147  * S_force_strict_version
2148  * Forces the next token to be a version number using strict syntax rules.
2149  */
2150
2151 STATIC char *
2152 S_force_strict_version(pTHX_ char *s)
2153 {
2154     OP *version = NULL;
2155     const char *errstr = NULL;
2156
2157     PERL_ARGS_ASSERT_FORCE_STRICT_VERSION;
2158
2159     while (isSPACE(*s)) /* leading whitespace */
2160         s++;
2161
2162     if (is_STRICT_VERSION(s,&errstr)) {
2163         SV *ver = newSV(0);
2164         s = (char *)scan_version(s, ver, 0);
2165         version = newSVOP(OP_CONST, 0, ver);
2166     }
2167     else if ( (*s != ';' && *s != '{' && *s != '}' ) &&
2168             (s = SKIPSPACE1(s), (*s != ';' && *s != '{' && *s != '}' )))
2169     {
2170         PL_bufptr = s;
2171         if (errstr)
2172             yyerror(errstr); /* version required */
2173         return s;
2174     }
2175
2176     /* NOTE: The parser sees the package name and the VERSION swapped */
2177     NEXTVAL_NEXTTOKE.opval = version;
2178     force_next(WORD);
2179
2180     return s;
2181 }
2182
2183 /*
2184  * S_tokeq
2185  * Tokenize a quoted string passed in as an SV.  It finds the next
2186  * chunk, up to end of string or a backslash.  It may make a new
2187  * SV containing that chunk (if HINT_NEW_STRING is on).  It also
2188  * turns \\ into \.
2189  */
2190
2191 STATIC SV *
2192 S_tokeq(pTHX_ SV *sv)
2193 {
2194     char *s;
2195     char *send;
2196     char *d;
2197     SV *pv = sv;
2198
2199     PERL_ARGS_ASSERT_TOKEQ;
2200
2201     assert (SvPOK(sv));
2202     assert (SvLEN(sv));
2203     assert (!SvIsCOW(sv));
2204     if (SvTYPE(sv) >= SVt_PVIV && SvIVX(sv) == -1) /* <<'heredoc' */
2205         goto finish;
2206     s = SvPVX(sv);
2207     send = SvEND(sv);
2208     /* This is relying on the SV being "well formed" with a trailing '\0'  */
2209     while (s < send && !(*s == '\\' && s[1] == '\\'))
2210         s++;
2211     if (s == send)
2212         goto finish;
2213     d = s;
2214     if ( PL_hints & HINT_NEW_STRING ) {
2215         pv = newSVpvn_flags(SvPVX_const(pv), SvCUR(sv),
2216                             SVs_TEMP | SvUTF8(sv));
2217     }
2218     while (s < send) {
2219         if (*s == '\\') {
2220             if (s + 1 < send && (s[1] == '\\'))
2221                 s++;            /* all that, just for this */
2222         }
2223         *d++ = *s++;
2224     }
2225     *d = '\0';
2226     SvCUR_set(sv, d - SvPVX_const(sv));
2227   finish:
2228     if ( PL_hints & HINT_NEW_STRING )
2229        return new_constant(NULL, 0, "q", sv, pv, "q", 1);
2230     return sv;
2231 }
2232
2233 /*
2234  * Now come three functions related to double-quote context,
2235  * S_sublex_start, S_sublex_push, and S_sublex_done.  They're used when
2236  * converting things like "\u\Lgnat" into ucfirst(lc("gnat")).  They
2237  * interact with PL_lex_state, and create fake ( ... ) argument lists
2238  * to handle functions and concatenation.
2239  * For example,
2240  *   "foo\lbar"
2241  * is tokenised as
2242  *    stringify ( const[foo] concat lcfirst ( const[bar] ) )
2243  */
2244
2245 /*
2246  * S_sublex_start
2247  * Assumes that pl_yylval.ival is the op we're creating (e.g. OP_LCFIRST).
2248  *
2249  * Pattern matching will set PL_lex_op to the pattern-matching op to
2250  * make (we return THING if pl_yylval.ival is OP_NULL, PMFUNC otherwise).
2251  *
2252  * OP_CONST and OP_READLINE are easy--just make the new op and return.
2253  *
2254  * Everything else becomes a FUNC.
2255  *
2256  * Sets PL_lex_state to LEX_INTERPPUSH unless (ival was OP_NULL or we
2257  * had an OP_CONST or OP_READLINE).  This just sets us up for a
2258  * call to S_sublex_push().
2259  */
2260
2261 STATIC I32
2262 S_sublex_start(pTHX)
2263 {
2264     const I32 op_type = pl_yylval.ival;
2265
2266     if (op_type == OP_NULL) {
2267         pl_yylval.opval = PL_lex_op;
2268         PL_lex_op = NULL;
2269         return THING;
2270     }
2271     if (op_type == OP_CONST) {
2272         SV *sv = tokeq(PL_lex_stuff);
2273
2274         if (SvTYPE(sv) == SVt_PVIV) {
2275             /* Overloaded constants, nothing fancy: Convert to SVt_PV: */
2276             STRLEN len;
2277             const char * const p = SvPV_const(sv, len);
2278             SV * const nsv = newSVpvn_flags(p, len, SvUTF8(sv));
2279             SvREFCNT_dec(sv);
2280             sv = nsv;
2281         }
2282         pl_yylval.opval = (OP*)newSVOP(op_type, 0, sv);
2283         PL_lex_stuff = NULL;
2284         return THING;
2285     }
2286
2287     PL_sublex_info.super_state = PL_lex_state;
2288     PL_sublex_info.sub_inwhat = (U16)op_type;
2289     PL_sublex_info.sub_op = PL_lex_op;
2290     PL_lex_state = LEX_INTERPPUSH;
2291
2292     PL_expect = XTERM;
2293     if (PL_lex_op) {
2294         pl_yylval.opval = PL_lex_op;
2295         PL_lex_op = NULL;
2296         return PMFUNC;
2297     }
2298     else
2299         return FUNC;
2300 }
2301
2302 /*
2303  * S_sublex_push
2304  * Create a new scope to save the lexing state.  The scope will be
2305  * ended in S_sublex_done.  Returns a '(', starting the function arguments
2306  * to the uc, lc, etc. found before.
2307  * Sets PL_lex_state to LEX_INTERPCONCAT.
2308  */
2309
2310 STATIC I32
2311 S_sublex_push(pTHX)
2312 {
2313     LEXSHARED *shared;
2314     const bool is_heredoc = PL_multi_close == '<';
2315     ENTER;
2316
2317     PL_lex_state = PL_sublex_info.super_state;
2318     SAVEI8(PL_lex_dojoin);
2319     SAVEI32(PL_lex_brackets);
2320     SAVEI32(PL_lex_allbrackets);
2321     SAVEI32(PL_lex_formbrack);
2322     SAVEI8(PL_lex_fakeeof);
2323     SAVEI32(PL_lex_casemods);
2324     SAVEI32(PL_lex_starts);
2325     SAVEI8(PL_lex_state);
2326     SAVESPTR(PL_lex_repl);
2327     SAVEVPTR(PL_lex_inpat);
2328     SAVEI16(PL_lex_inwhat);
2329     if (is_heredoc)
2330     {
2331         SAVECOPLINE(PL_curcop);
2332         SAVEI32(PL_multi_end);
2333         SAVEI32(PL_parser->herelines);
2334         PL_parser->herelines = 0;
2335     }
2336     SAVEI8(PL_multi_close);
2337     SAVEPPTR(PL_bufptr);
2338     SAVEPPTR(PL_bufend);
2339     SAVEPPTR(PL_oldbufptr);
2340     SAVEPPTR(PL_oldoldbufptr);
2341     SAVEPPTR(PL_last_lop);
2342     SAVEPPTR(PL_last_uni);
2343     SAVEPPTR(PL_linestart);
2344     SAVESPTR(PL_linestr);
2345     SAVEGENERICPV(PL_lex_brackstack);
2346     SAVEGENERICPV(PL_lex_casestack);
2347     SAVEGENERICPV(PL_parser->lex_shared);
2348     SAVEBOOL(PL_parser->lex_re_reparsing);
2349     SAVEI32(PL_copline);
2350
2351     /* The here-doc parser needs to be able to peek into outer lexing
2352        scopes to find the body of the here-doc.  So we put PL_linestr and
2353        PL_bufptr into lex_shared, to ‘share’ those values.
2354      */
2355     PL_parser->lex_shared->ls_linestr = PL_linestr;
2356     PL_parser->lex_shared->ls_bufptr  = PL_bufptr;
2357
2358     PL_linestr = PL_lex_stuff;
2359     PL_lex_repl = PL_sublex_info.repl;
2360     PL_lex_stuff = NULL;
2361     PL_sublex_info.repl = NULL;
2362
2363     PL_bufend = PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart
2364         = SvPVX(PL_linestr);
2365     PL_bufend += SvCUR(PL_linestr);
2366     PL_last_lop = PL_last_uni = NULL;
2367     SAVEFREESV(PL_linestr);
2368     if (PL_lex_repl) SAVEFREESV(PL_lex_repl);
2369
2370     PL_lex_dojoin = FALSE;
2371     PL_lex_brackets = PL_lex_formbrack = 0;
2372     PL_lex_allbrackets = 0;
2373     PL_lex_fakeeof = LEX_FAKEEOF_NEVER;
2374     Newx(PL_lex_brackstack, 120, char);
2375     Newx(PL_lex_casestack, 12, char);
2376     PL_lex_casemods = 0;
2377     *PL_lex_casestack = '\0';
2378     PL_lex_starts = 0;
2379     PL_lex_state = LEX_INTERPCONCAT;
2380     if (is_heredoc)
2381         CopLINE_set(PL_curcop, (line_t)PL_multi_start);
2382     PL_copline = NOLINE;
2383     
2384     Newxz(shared, 1, LEXSHARED);
2385     shared->ls_prev = PL_parser->lex_shared;
2386     PL_parser->lex_shared = shared;
2387
2388     PL_lex_inwhat = PL_sublex_info.sub_inwhat;
2389     if (PL_lex_inwhat == OP_TRANSR) PL_lex_inwhat = OP_TRANS;
2390     if (PL_lex_inwhat == OP_MATCH || PL_lex_inwhat == OP_QR || PL_lex_inwhat == OP_SUBST)
2391         PL_lex_inpat = PL_sublex_info.sub_op;
2392     else
2393         PL_lex_inpat = NULL;
2394
2395     PL_parser->lex_re_reparsing = cBOOL(PL_in_eval & EVAL_RE_REPARSING);
2396     PL_in_eval &= ~EVAL_RE_REPARSING;
2397
2398     return '(';
2399 }
2400
2401 /*
2402  * S_sublex_done
2403  * Restores lexer state after a S_sublex_push.
2404  */
2405
2406 STATIC I32
2407 S_sublex_done(pTHX)
2408 {
2409     if (!PL_lex_starts++) {
2410         SV * const sv = newSVpvs("");
2411         if (SvUTF8(PL_linestr))
2412             SvUTF8_on(sv);
2413         PL_expect = XOPERATOR;
2414         pl_yylval.opval = (OP*)newSVOP(OP_CONST, 0, sv);
2415         return THING;
2416     }
2417
2418     if (PL_lex_casemods) {              /* oops, we've got some unbalanced parens */
2419         PL_lex_state = LEX_INTERPCASEMOD;
2420         return yylex();
2421     }
2422
2423     /* Is there a right-hand side to take care of? (s//RHS/ or tr//RHS/) */
2424     assert(PL_lex_inwhat != OP_TRANSR);
2425     if (PL_lex_repl) {
2426         assert (PL_lex_inwhat == OP_SUBST || PL_lex_inwhat == OP_TRANS);
2427         PL_linestr = PL_lex_repl;
2428         PL_lex_inpat = 0;
2429         PL_bufend = PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
2430         PL_bufend += SvCUR(PL_linestr);
2431         PL_last_lop = PL_last_uni = NULL;
2432         PL_lex_dojoin = FALSE;
2433         PL_lex_brackets = 0;
2434         PL_lex_allbrackets = 0;
2435         PL_lex_fakeeof = LEX_FAKEEOF_NEVER;
2436         PL_lex_casemods = 0;
2437         *PL_lex_casestack = '\0';
2438         PL_lex_starts = 0;
2439         if (SvEVALED(PL_lex_repl)) {
2440             PL_lex_state = LEX_INTERPNORMAL;
2441             PL_lex_starts++;
2442             /*  we don't clear PL_lex_repl here, so that we can check later
2443                 whether this is an evalled subst; that means we rely on the
2444                 logic to ensure sublex_done() is called again only via the
2445                 branch (in yylex()) that clears PL_lex_repl, else we'll loop */
2446         }
2447         else {
2448             PL_lex_state = LEX_INTERPCONCAT;
2449             PL_lex_repl = NULL;
2450         }
2451         if (SvTYPE(PL_linestr) >= SVt_PVNV) {
2452             CopLINE(PL_curcop) +=
2453                 ((XPVNV*)SvANY(PL_linestr))->xnv_u.xpad_cop_seq.xlow
2454                  + PL_parser->herelines;
2455             PL_parser->herelines = 0;
2456         }
2457         return ',';
2458     }
2459     else {
2460         const line_t l = CopLINE(PL_curcop);
2461         LEAVE;
2462         if (PL_multi_close == '<')
2463             PL_parser->herelines += l - PL_multi_end;
2464         PL_bufend = SvPVX(PL_linestr);
2465         PL_bufend += SvCUR(PL_linestr);
2466         PL_expect = XOPERATOR;
2467         PL_sublex_info.sub_inwhat = 0;
2468         return ')';
2469     }
2470 }
2471
2472 PERL_STATIC_INLINE SV*
2473 S_get_and_check_backslash_N_name(pTHX_ const char* s, const char* const e)
2474 {
2475     /* <s> points to first character of interior of \N{}, <e> to one beyond the
2476      * interior, hence to the "}".  Finds what the name resolves to, returning
2477      * an SV* containing it; NULL if no valid one found */
2478
2479     SV* res = newSVpvn_flags(s, e - s, UTF ? SVf_UTF8 : 0);
2480
2481     HV * table;
2482     SV **cvp;
2483     SV *cv;
2484     SV *rv;
2485     HV *stash;
2486     const U8* first_bad_char_loc;
2487     const char* backslash_ptr = s - 3; /* Points to the <\> of \N{... */
2488
2489     PERL_ARGS_ASSERT_GET_AND_CHECK_BACKSLASH_N_NAME;
2490
2491     if (UTF && ! is_utf8_string_loc((U8 *) backslash_ptr,
2492                                      e - backslash_ptr,
2493                                      &first_bad_char_loc))
2494     {
2495         /* If warnings are on, this will print a more detailed analysis of what
2496          * is wrong than the error message below */
2497         utf8n_to_uvchr(first_bad_char_loc,
2498                        e - ((char *) first_bad_char_loc),
2499                        NULL, 0);
2500
2501         /* We deliberately don't try to print the malformed character, which
2502          * might not print very well; it also may be just the first of many
2503          * malformations, so don't print what comes after it */
2504         yyerror(Perl_form(aTHX_
2505             "Malformed UTF-8 character immediately after '%.*s'",
2506             (int) (first_bad_char_loc - (U8 *) backslash_ptr), backslash_ptr));
2507         return NULL;
2508     }
2509
2510     res = new_constant( NULL, 0, "charnames", res, NULL, backslash_ptr,
2511                         /* include the <}> */
2512                         e - backslash_ptr + 1);
2513     if (! SvPOK(res)) {
2514         SvREFCNT_dec_NN(res);
2515         return NULL;
2516     }
2517
2518     /* See if the charnames handler is the Perl core's, and if so, we can skip
2519      * the validation needed for a user-supplied one, as Perl's does its own
2520      * validation. */
2521     table = GvHV(PL_hintgv);             /* ^H */
2522     cvp = hv_fetchs(table, "charnames", FALSE);
2523     if (cvp && (cv = *cvp) && SvROK(cv) && (rv = SvRV(cv),
2524         SvTYPE(rv) == SVt_PVCV) && ((stash = CvSTASH(rv)) != NULL))
2525     {
2526         const char * const name = HvNAME(stash);
2527         if (HvNAMELEN(stash) == sizeof("_charnames")-1
2528          && strEQ(name, "_charnames")) {
2529            return res;
2530        }
2531     }
2532
2533     /* Here, it isn't Perl's charname handler.  We can't rely on a
2534      * user-supplied handler to validate the input name.  For non-ut8 input,
2535      * look to see that the first character is legal.  Then loop through the
2536      * rest checking that each is a continuation */
2537
2538     /* This code makes the reasonable assumption that the only Latin1-range
2539      * characters that begin a character name alias are alphabetic, otherwise
2540      * would have to create a isCHARNAME_BEGIN macro */
2541
2542     if (! UTF) {
2543         if (! isALPHAU(*s)) {
2544             goto bad_charname;
2545         }
2546         s++;
2547         while (s < e) {
2548             if (! isCHARNAME_CONT(*s)) {
2549                 goto bad_charname;
2550             }
2551             if (*s == ' ' && *(s-1) == ' ') {
2552                 goto multi_spaces;
2553             }
2554             if ((U8) *s == NBSP_NATIVE && ckWARN_d(WARN_DEPRECATED)) {
2555                 Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),
2556                            "NO-BREAK SPACE in a charnames "
2557                            "alias definition is deprecated");
2558             }
2559             s++;
2560         }
2561     }
2562     else {
2563         /* Similarly for utf8.  For invariants can check directly; for other
2564          * Latin1, can calculate their code point and check; otherwise  use a
2565          * swash */
2566         if (UTF8_IS_INVARIANT(*s)) {
2567             if (! isALPHAU(*s)) {
2568                 goto bad_charname;
2569             }
2570             s++;
2571         } else if (UTF8_IS_DOWNGRADEABLE_START(*s)) {
2572             if (! isALPHAU(TWO_BYTE_UTF8_TO_NATIVE(*s, *(s+1)))) {
2573                 goto bad_charname;
2574             }
2575             s += 2;
2576         }
2577         else {
2578             if (! PL_utf8_charname_begin) {
2579                 U8 flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
2580                 PL_utf8_charname_begin = _core_swash_init("utf8",
2581                                                         "_Perl_Charname_Begin",
2582                                                         &PL_sv_undef,
2583                                                         1, 0, NULL, &flags);
2584             }
2585             if (! swash_fetch(PL_utf8_charname_begin, (U8 *) s, TRUE)) {
2586                 goto bad_charname;
2587             }
2588             s += UTF8SKIP(s);
2589         }
2590
2591         while (s < e) {
2592             if (UTF8_IS_INVARIANT(*s)) {
2593                 if (! isCHARNAME_CONT(*s)) {
2594                     goto bad_charname;
2595                 }
2596                 if (*s == ' ' && *(s-1) == ' ') {
2597                     goto multi_spaces;
2598                 }
2599                 s++;
2600             }
2601             else if (UTF8_IS_DOWNGRADEABLE_START(*s)) {
2602                 if (! isCHARNAME_CONT(TWO_BYTE_UTF8_TO_NATIVE(*s, *(s+1))))
2603                 {
2604                     goto bad_charname;
2605                 }
2606                 if (*s == *NBSP_UTF8
2607                     && *(s+1) == *(NBSP_UTF8+1)
2608                     && ckWARN_d(WARN_DEPRECATED))
2609                 {
2610                     Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),
2611                                 "NO-BREAK SPACE in a charnames "
2612                                 "alias definition is deprecated");
2613                 }
2614                 s += 2;
2615             }
2616             else {
2617                 if (! PL_utf8_charname_continue) {
2618                     U8 flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
2619                     PL_utf8_charname_continue = _core_swash_init("utf8",
2620                                                 "_Perl_Charname_Continue",
2621                                                 &PL_sv_undef,
2622                                                 1, 0, NULL, &flags);
2623                 }
2624                 if (! swash_fetch(PL_utf8_charname_continue, (U8 *) s, TRUE)) {
2625                     goto bad_charname;
2626                 }
2627                 s += UTF8SKIP(s);
2628             }
2629         }
2630     }
2631     if (*(s-1) == ' ') {
2632         yyerror_pv(
2633             Perl_form(aTHX_
2634             "charnames alias definitions may not contain trailing "
2635             "white-space; marked by <-- HERE in %.*s<-- HERE %.*s",
2636             (int)(s - backslash_ptr + 1), backslash_ptr,
2637             (int)(e - s + 1), s + 1
2638             ),
2639         UTF ? SVf_UTF8 : 0);
2640         return NULL;
2641     }
2642
2643     if (SvUTF8(res)) { /* Don't accept malformed input */
2644         const U8* first_bad_char_loc;
2645         STRLEN len;
2646         const char* const str = SvPV_const(res, len);
2647         if (! is_utf8_string_loc((U8 *) str, len, &first_bad_char_loc)) {
2648             /* If warnings are on, this will print a more detailed analysis of
2649              * what is wrong than the error message below */
2650             utf8n_to_uvchr(first_bad_char_loc,
2651                            (char *) first_bad_char_loc - str,
2652                            NULL, 0);
2653
2654             /* We deliberately don't try to print the malformed character,
2655              * which might not print very well; it also may be just the first
2656              * of many malformations, so don't print what comes after it */
2657             yyerror_pv(
2658               Perl_form(aTHX_
2659                 "Malformed UTF-8 returned by %.*s immediately after '%.*s'",
2660                  (int) (e - backslash_ptr + 1), backslash_ptr,
2661                  (int) ((char *) first_bad_char_loc - str), str
2662               ),
2663               SVf_UTF8);
2664             return NULL;
2665         }
2666     }
2667
2668     return res;
2669
2670   bad_charname: {
2671
2672         /* The final %.*s makes sure that should the trailing NUL be missing
2673          * that this print won't run off the end of the string */
2674         yyerror_pv(
2675           Perl_form(aTHX_
2676             "Invalid character in \\N{...}; marked by <-- HERE in %.*s<-- HERE %.*s",
2677             (int)(s - backslash_ptr + 1), backslash_ptr,
2678             (int)(e - s + 1), s + 1
2679           ),
2680           UTF ? SVf_UTF8 : 0);
2681         return NULL;
2682     }
2683
2684   multi_spaces:
2685         yyerror_pv(
2686           Perl_form(aTHX_
2687             "charnames alias definitions may not contain a sequence of "
2688             "multiple spaces; marked by <-- HERE in %.*s<-- HERE %.*s",
2689             (int)(s - backslash_ptr + 1), backslash_ptr,
2690             (int)(e - s + 1), s + 1
2691           ),
2692           UTF ? SVf_UTF8 : 0);
2693         return NULL;
2694 }
2695
2696 /*
2697   scan_const
2698
2699   Extracts the next constant part of a pattern, double-quoted string,
2700   or transliteration.  This is terrifying code.
2701
2702   For example, in parsing the double-quoted string "ab\x63$d", it would
2703   stop at the '$' and return an OP_CONST containing 'abc'.
2704
2705   It looks at PL_lex_inwhat and PL_lex_inpat to find out whether it's
2706   processing a pattern (PL_lex_inpat is true), a transliteration
2707   (PL_lex_inwhat == OP_TRANS is true), or a double-quoted string.
2708
2709   Returns a pointer to the character scanned up to. If this is
2710   advanced from the start pointer supplied (i.e. if anything was
2711   successfully parsed), will leave an OP_CONST for the substring scanned
2712   in pl_yylval. Caller must intuit reason for not parsing further
2713   by looking at the next characters herself.
2714
2715   In patterns:
2716     expand:
2717       \N{FOO}  => \N{U+hex_for_character_FOO}
2718       (if FOO expands to multiple characters, expands to \N{U+xx.XX.yy ...})
2719
2720     pass through:
2721         all other \-char, including \N and \N{ apart from \N{ABC}
2722
2723     stops on:
2724         @ and $ where it appears to be a var, but not for $ as tail anchor
2725         \l \L \u \U \Q \E
2726         (?{  or  (??{
2727
2728
2729   In transliterations:
2730     characters are VERY literal, except for - not at the start or end
2731     of the string, which indicates a range. If the range is in bytes,
2732     scan_const expands the range to the full set of intermediate
2733     characters. If the range is in utf8, the hyphen is replaced with
2734     a certain range mark which will be handled by pmtrans() in op.c.
2735
2736   In double-quoted strings:
2737     backslashes:
2738       double-quoted style: \r and \n
2739       constants: \x31, etc.
2740       deprecated backrefs: \1 (in substitution replacements)
2741       case and quoting: \U \Q \E
2742     stops on @ and $
2743
2744   scan_const does *not* construct ops to handle interpolated strings.
2745   It stops processing as soon as it finds an embedded $ or @ variable
2746   and leaves it to the caller to work out what's going on.
2747
2748   embedded arrays (whether in pattern or not) could be:
2749       @foo, @::foo, @'foo, @{foo}, @$foo, @+, @-.
2750
2751   $ in double-quoted strings must be the symbol of an embedded scalar.
2752
2753   $ in pattern could be $foo or could be tail anchor.  Assumption:
2754   it's a tail anchor if $ is the last thing in the string, or if it's
2755   followed by one of "()| \r\n\t"
2756
2757   \1 (backreferences) are turned into $1 in substitutions
2758
2759   The structure of the code is
2760       while (there's a character to process) {
2761           handle transliteration ranges
2762           skip regexp comments /(?#comment)/ and codes /(?{code})/
2763           skip #-initiated comments in //x patterns
2764           check for embedded arrays
2765           check for embedded scalars
2766           if (backslash) {
2767               deprecate \1 in substitution replacements
2768               handle string-changing backslashes \l \U \Q \E, etc.
2769               switch (what was escaped) {
2770                   handle \- in a transliteration (becomes a literal -)
2771                   if a pattern and not \N{, go treat as regular character
2772                   handle \132 (octal characters)
2773                   handle \x15 and \x{1234} (hex characters)
2774                   handle \N{name} (named characters, also \N{3,5} in a pattern)
2775                   handle \cV (control characters)
2776                   handle printf-style backslashes (\f, \r, \n, etc)
2777               } (end switch)
2778               continue
2779           } (end if backslash)
2780           handle regular character
2781     } (end while character to read)
2782                 
2783 */
2784
2785 STATIC char *
2786 S_scan_const(pTHX_ char *start)
2787 {
2788     char *send = PL_bufend;             /* end of the constant */
2789     SV *sv = newSV(send - start);       /* sv for the constant.  See note below
2790                                            on sizing. */
2791     char *s = start;                    /* start of the constant */
2792     char *d = SvPVX(sv);                /* destination for copies */
2793     bool dorange = FALSE;               /* are we in a translit range? */
2794     bool didrange = FALSE;              /* did we just finish a range? */
2795     bool in_charclass = FALSE;          /* within /[...]/ */
2796     bool has_utf8 = FALSE;              /* Output constant is UTF8 */
2797     bool  this_utf8 = cBOOL(UTF);       /* Is the source string assumed to be
2798                                            UTF8?  But, this can show as true
2799                                            when the source isn't utf8, as for
2800                                            example when it is entirely composed
2801                                            of hex constants */
2802     SV *res;                            /* result from charnames */
2803
2804     /* Note on sizing:  The scanned constant is placed into sv, which is
2805      * initialized by newSV() assuming one byte of output for every byte of
2806      * input.  This routine expects newSV() to allocate an extra byte for a
2807      * trailing NUL, which this routine will append if it gets to the end of
2808      * the input.  There may be more bytes of input than output (eg., \N{LATIN
2809      * CAPITAL LETTER A}), or more output than input if the constant ends up
2810      * recoded to utf8, but each time a construct is found that might increase
2811      * the needed size, SvGROW() is called.  Its size parameter each time is
2812      * based on the best guess estimate at the time, namely the length used so
2813      * far, plus the length the current construct will occupy, plus room for
2814      * the trailing NUL, plus one byte for every input byte still unscanned */ 
2815
2816     UV uv = UV_MAX; /* Initialize to weird value to try to catch any uses
2817                        before set */
2818 #ifdef EBCDIC
2819     UV literal_endpoint = 0;
2820     bool native_range = TRUE; /* turned to FALSE if the first endpoint is Unicode. */
2821 #endif
2822
2823     PERL_ARGS_ASSERT_SCAN_CONST;
2824
2825     assert(PL_lex_inwhat != OP_TRANSR);
2826     if (PL_lex_inwhat == OP_TRANS && PL_sublex_info.sub_op) {
2827         /* If we are doing a trans and we know we want UTF8 set expectation */
2828         has_utf8   = PL_sublex_info.sub_op->op_private & (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF);
2829         this_utf8  = PL_sublex_info.sub_op->op_private & (PL_lex_repl ? OPpTRANS_FROM_UTF : OPpTRANS_TO_UTF);
2830     }
2831
2832     /* Protect sv from errors and fatal warnings. */
2833     ENTER_with_name("scan_const");
2834     SAVEFREESV(sv);
2835
2836     while (s < send || dorange) {
2837
2838         /* get transliterations out of the way (they're most literal) */
2839         if (PL_lex_inwhat == OP_TRANS) {
2840             /* expand a range A-Z to the full set of characters.  AIE! */
2841             if (dorange) {
2842                 I32 i;                          /* current expanded character */
2843                 I32 min;                        /* first character in range */
2844                 I32 max;                        /* last character in range */
2845
2846 #ifdef EBCDIC
2847                 UV uvmax = 0;
2848 #endif
2849
2850                 if (has_utf8
2851 #ifdef EBCDIC
2852                     && !native_range
2853 #endif
2854                 ) {
2855                     char * const c = (char*)utf8_hop((U8*)d, -1);
2856                     char *e = d++;
2857                     while (e-- > c)
2858                         *(e + 1) = *e;
2859                     *c = (char) ILLEGAL_UTF8_BYTE;
2860                     /* mark the range as done, and continue */
2861                     dorange = FALSE;
2862                     didrange = TRUE;
2863                     continue;
2864                 }
2865
2866                 i = d - SvPVX_const(sv);                /* remember current offset */
2867 #ifdef EBCDIC
2868                 SvGROW(sv,
2869                        SvLEN(sv) + ((has_utf8)
2870                                     ?  (512 - UTF_CONTINUATION_MARK
2871                                         + UNISKIP(0x100))
2872                                     : 256));
2873                 /* How many two-byte within 0..255: 128 in UTF-8,
2874                  * 96 in UTF-8-mod. */
2875 #else
2876                 SvGROW(sv, SvLEN(sv) + 256);    /* never more than 256 chars in a range */
2877 #endif
2878                 d = SvPVX(sv) + i;              /* refresh d after realloc */
2879 #ifdef EBCDIC
2880                 if (has_utf8) {
2881                     int j;
2882                     for (j = 0; j <= 1; j++) {
2883                         char * const c = (char*)utf8_hop((U8*)d, -1);
2884                         const UV uv    = utf8n_to_uvchr((U8*)c, d - c, NULL, 0);
2885                         if (j)
2886                             min = (U8)uv;
2887                         else if (uv < 256)
2888                             max = (U8)uv;
2889                         else {
2890                             max = (U8)0xff; /* only to \xff */
2891                             uvmax = uv; /* \x{100} to uvmax */
2892                         }
2893                         d = c; /* eat endpoint chars */
2894                      }
2895                 }
2896                else {
2897 #endif
2898                    d -= 2;              /* eat the first char and the - */
2899                    min = (U8)*d;        /* first char in range */
2900                    max = (U8)d[1];      /* last char in range  */
2901 #ifdef EBCDIC
2902                }
2903 #endif
2904
2905                 if (min > max) {
2906                     Perl_croak(aTHX_
2907                                "Invalid range \"%c-%c\" in transliteration operator",
2908                                (char)min, (char)max);
2909                 }
2910
2911 #ifdef EBCDIC
2912                 /* Because of the discontinuities in EBCDIC A-Z and a-z, expand
2913                  * any subsets of these ranges into individual characters */
2914                 if (literal_endpoint == 2 &&
2915                     ((isLOWER_A(min) && isLOWER_A(max)) ||
2916                      (isUPPER_A(min) && isUPPER_A(max))))
2917                 {
2918                     for (i = min; i <= max; i++) {
2919                         if (isALPHA_A(i))
2920                             *d++ = i;
2921                     }
2922                 }
2923                 else
2924 #endif
2925                     for (i = min; i <= max; i++)
2926 #ifdef EBCDIC
2927                         if (has_utf8) {
2928                             append_utf8_from_native_byte(i, &d);
2929                         }
2930                         else
2931 #endif
2932                             *d++ = (char)i;
2933  
2934 #ifdef EBCDIC
2935                 if (uvmax) {
2936                     d = (char*)uvchr_to_utf8((U8*)d, 0x100);
2937                     if (uvmax > 0x101)
2938                         *d++ = (char) ILLEGAL_UTF8_BYTE;
2939                     if (uvmax > 0x100)
2940                         d = (char*)uvchr_to_utf8((U8*)d, uvmax);
2941                 }
2942 #endif
2943
2944                 /* mark the range as done, and continue */
2945                 dorange = FALSE;
2946                 didrange = TRUE;
2947 #ifdef EBCDIC
2948                 literal_endpoint = 0;
2949 #endif
2950                 continue;
2951             }
2952
2953             /* range begins (ignore - as first or last char) */
2954             else if (*s == '-' && s+1 < send  && s != start) {
2955                 if (didrange) {
2956                     Perl_croak(aTHX_ "Ambiguous range in transliteration operator");
2957                 }
2958                 if (has_utf8
2959 #ifdef EBCDIC
2960                     && !native_range
2961 #endif
2962                     ) {
2963                     *d++ = (char) ILLEGAL_UTF8_BYTE;    /* use illegal utf8 byte--see pmtrans */
2964                     s++;
2965                     continue;
2966                 }
2967                 dorange = TRUE;
2968                 s++;
2969             }
2970             else {
2971                 didrange = FALSE;
2972 #ifdef EBCDIC
2973                 literal_endpoint = 0;
2974                 native_range = TRUE;
2975 #endif
2976             }
2977         }
2978
2979         /* if we get here, we're not doing a transliteration */
2980
2981         else if (*s == '[' && PL_lex_inpat && !in_charclass) {
2982             char *s1 = s-1;
2983             int esc = 0;
2984             while (s1 >= start && *s1-- == '\\')
2985                 esc = !esc;
2986             if (!esc)
2987                 in_charclass = TRUE;
2988         }
2989
2990         else if (*s == ']' && PL_lex_inpat &&  in_charclass) {
2991             char *s1 = s-1;
2992             int esc = 0;
2993             while (s1 >= start && *s1-- == '\\')
2994                 esc = !esc;
2995             if (!esc)
2996                 in_charclass = FALSE;
2997         }
2998
2999         /* skip for regexp comments /(?#comment)/, except for the last
3000          * char, which will be done separately.
3001          * Stop on (?{..}) and friends */
3002
3003         else if (*s == '(' && PL_lex_inpat && s[1] == '?' && !in_charclass) {
3004             if (s[2] == '#') {
3005                 while (s+1 < send && *s != ')')
3006                     *d++ = *s++;
3007             }
3008             else if (!PL_lex_casemods &&
3009                      (    s[2] == '{' /* This should match regcomp.c */
3010                       || (s[2] == '?' && s[3] == '{')))
3011             {
3012                 break;
3013             }
3014         }
3015
3016         /* likewise skip #-initiated comments in //x patterns */
3017         else if (*s == '#' && PL_lex_inpat && !in_charclass &&
3018           ((PMOP*)PL_lex_inpat)->op_pmflags & RXf_PMf_EXTENDED) {
3019             while (s+1 < send && *s != '\n')
3020                 *d++ = *s++;
3021         }
3022
3023         /* no further processing of single-quoted regex */
3024         else if (PL_lex_inpat && SvIVX(PL_linestr) == '\'')
3025             goto default_action;
3026
3027         /* check for embedded arrays
3028            (@foo, @::foo, @'foo, @{foo}, @$foo, @+, @-)
3029            */
3030         else if (*s == '@' && s[1]) {
3031             if (isWORDCHAR_lazy_if(s+1,UTF))
3032                 break;
3033             if (strchr(":'{$", s[1]))
3034                 break;
3035             if (!PL_lex_inpat && (s[1] == '+' || s[1] == '-'))
3036                 break; /* in regexp, neither @+ nor @- are interpolated */
3037         }
3038
3039         /* check for embedded scalars.  only stop if we're sure it's a
3040            variable.
3041         */
3042         else if (*s == '$') {
3043             if (!PL_lex_inpat)  /* not a regexp, so $ must be var */
3044                 break;
3045             if (s + 1 < send && !strchr("()| \r\n\t", s[1])) {
3046                 if (s[1] == '\\') {
3047                     Perl_ck_warner(aTHX_ packWARN(WARN_AMBIGUOUS),
3048                                    "Possible unintended interpolation of $\\ in regex");
3049                 }
3050                 break;          /* in regexp, $ might be tail anchor */
3051             }
3052         }
3053
3054         /* End of else if chain - OP_TRANS rejoin rest */
3055
3056         /* backslashes */
3057         if (*s == '\\' && s+1 < send) {
3058             char* e;    /* Can be used for ending '}', etc. */
3059
3060             s++;
3061
3062             /* warn on \1 - \9 in substitution replacements, but note that \11
3063              * is an octal; and \19 is \1 followed by '9' */
3064             if (PL_lex_inwhat == OP_SUBST && !PL_lex_inpat &&
3065                 isDIGIT(*s) && *s != '0' && !isDIGIT(s[1]))
3066             {
3067                 /* diag_listed_as: \%d better written as $%d */
3068                 Perl_ck_warner(aTHX_ packWARN(WARN_SYNTAX), "\\%c better written as $%c", *s, *s);
3069                 *--s = '$';
3070                 break;
3071             }
3072
3073             /* string-change backslash escapes */
3074             if (PL_lex_inwhat != OP_TRANS && *s && strchr("lLuUEQF", *s)) {
3075                 --s;
3076                 break;
3077             }
3078             /* In a pattern, process \N, but skip any other backslash escapes.
3079              * This is because we don't want to translate an escape sequence
3080              * into a meta symbol and have the regex compiler use the meta
3081              * symbol meaning, e.g. \x{2E} would be confused with a dot.  But
3082              * in spite of this, we do have to process \N here while the proper
3083              * charnames handler is in scope.  See bugs #56444 and #62056.
3084              * There is a complication because \N in a pattern may also stand
3085              * for 'match a non-nl', and not mean a charname, in which case its
3086              * processing should be deferred to the regex compiler.  To be a
3087              * charname it must be followed immediately by a '{', and not look
3088              * like \N followed by a curly quantifier, i.e., not something like
3089              * \N{3,}.  regcurly returns a boolean indicating if it is a legal
3090              * quantifier */
3091             else if (PL_lex_inpat
3092                     && (*s != 'N'
3093                         || s[1] != '{'
3094                         || regcurly(s + 1)))
3095             {
3096                 *d++ = '\\';
3097                 goto default_action;
3098             }
3099
3100             switch (*s) {
3101
3102             /* quoted - in transliterations */
3103             case '-':
3104                 if (PL_lex_inwhat == OP_TRANS) {
3105                     *d++ = *s++;
3106                     continue;
3107                 }
3108                 /* FALLTHROUGH */
3109             default:
3110                 {
3111                     if ((isALPHANUMERIC(*s)))
3112                         Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
3113                                        "Unrecognized escape \\%c passed through",
3114                                        *s);
3115                     /* default action is to copy the quoted character */
3116                     goto default_action;
3117                 }
3118
3119             /* eg. \132 indicates the octal constant 0132 */
3120             case '0': case '1': case '2': case '3':
3121             case '4': case '5': case '6': case '7':
3122                 {
3123                     I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
3124                     STRLEN len = 3;
3125                     uv = grok_oct(s, &len, &flags, NULL);
3126                     s += len;
3127                     if (len < 3 && s < send && isDIGIT(*s)
3128                         && ckWARN(WARN_MISC))
3129                     {
3130                         Perl_warner(aTHX_ packWARN(WARN_MISC),
3131                                     "%s", form_short_octal_warning(s, len));
3132                     }
3133                 }
3134                 goto NUM_ESCAPE_INSERT;
3135
3136             /* eg. \o{24} indicates the octal constant \024 */
3137             case 'o':
3138                 {
3139                     const char* error;
3140
3141                     bool valid = grok_bslash_o(&s, &uv, &error,
3142                                                TRUE, /* Output warning */
3143                                                FALSE, /* Not strict */
3144                                                TRUE, /* Output warnings for
3145                                                          non-portables */
3146                                                UTF);
3147                     if (! valid) {
3148                         yyerror(error);
3149                         continue;
3150                     }
3151                     goto NUM_ESCAPE_INSERT;
3152                 }
3153
3154             /* eg. \x24 indicates the hex constant 0x24 */
3155             case 'x':
3156                 {
3157                     const char* error;
3158
3159                     bool valid = grok_bslash_x(&s, &uv, &error,
3160                                                TRUE, /* Output warning */
3161                                                FALSE, /* Not strict */
3162                                                TRUE,  /* Output warnings for
3163                                                          non-portables */
3164                                                UTF);
3165                     if (! valid) {
3166                         yyerror(error);
3167                         continue;
3168                     }
3169                 }
3170
3171               NUM_ESCAPE_INSERT:
3172                 /* Insert oct or hex escaped character.  There will always be
3173                  * enough room in sv since such escapes will be longer than any
3174                  * UTF-8 sequence they can end up as, except if they force us
3175                  * to recode the rest of the string into utf8 */
3176                 
3177                 /* Here uv is the ordinal of the next character being added */
3178                 if (!UVCHR_IS_INVARIANT(uv)) {
3179                     if (!has_utf8 && uv > 255) {
3180                         /* Might need to recode whatever we have accumulated so
3181                          * far if it contains any chars variant in utf8 or
3182                          * utf-ebcdic. */
3183                           
3184                         SvCUR_set(sv, d - SvPVX_const(sv));
3185                         SvPOK_on(sv);
3186                         *d = '\0';
3187                         /* See Note on sizing above.  */
3188                         sv_utf8_upgrade_flags_grow(sv,
3189                                         SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3190                                         UNISKIP(uv) + (STRLEN)(send - s) + 1);
3191                         d = SvPVX(sv) + SvCUR(sv);
3192                         has_utf8 = TRUE;
3193                     }
3194
3195                     if (has_utf8) {
3196                         d = (char*)uvchr_to_utf8((U8*)d, uv);
3197                         if (PL_lex_inwhat == OP_TRANS &&
3198                             PL_sublex_info.sub_op) {
3199                             PL_sublex_info.sub_op->op_private |=
3200                                 (PL_lex_repl ? OPpTRANS_FROM_UTF
3201                                              : OPpTRANS_TO_UTF);
3202                         }
3203 #ifdef EBCDIC
3204                         if (uv > 255 && !dorange)
3205                             native_range = FALSE;
3206 #endif
3207                     }
3208                     else {
3209                         *d++ = (char)uv;
3210                     }
3211                 }
3212                 else {
3213                     *d++ = (char) uv;
3214                 }
3215                 continue;
3216
3217             case 'N':
3218                 /* In a non-pattern \N must be a named character, like \N{LATIN
3219                  * SMALL LETTER A} or \N{U+0041}.  For patterns, it also can
3220                  * mean to match a non-newline.  For non-patterns, named
3221                  * characters are converted to their string equivalents. In
3222                  * patterns, named characters are not converted to their
3223                  * ultimate forms for the same reasons that other escapes
3224                  * aren't.  Instead, they are converted to the \N{U+...} form
3225                  * to get the value from the charnames that is in effect right
3226                  * now, while preserving the fact that it was a named character
3227                  * so that the regex compiler knows this */
3228
3229                 /* The structure of this section of code (besides checking for
3230                  * errors and upgrading to utf8) is:
3231                  *  Further disambiguate between the two meanings of \N, and if
3232                  *      not a charname, go process it elsewhere
3233                  *  If of form \N{U+...}, pass it through if a pattern;
3234                  *      otherwise convert to utf8
3235                  *  Otherwise must be \N{NAME}: convert to \N{U+c1.c2...} if a
3236                  *  pattern; otherwise convert to utf8 */
3237
3238                 /* Here, s points to the 'N'; the test below is guaranteed to
3239                  * succeed if we are being called on a pattern as we already
3240                  * know from a test above that the next character is a '{'.
3241                  * On a non-pattern \N must mean 'named sequence, which
3242                  * requires braces */
3243                 s++;
3244                 if (*s != '{') {
3245                     yyerror("Missing braces on \\N{}"); 
3246                     continue;
3247                 }
3248                 s++;
3249
3250                 /* If there is no matching '}', it is an error. */
3251                 if (! (e = strchr(s, '}'))) {
3252                     if (! PL_lex_inpat) {
3253                         yyerror("Missing right brace on \\N{}");
3254                     } else {
3255                         yyerror("Missing right brace on \\N{} or unescaped left brace after \\N");
3256                     }
3257                     continue;
3258                 }
3259
3260                 /* Here it looks like a named character */
3261
3262                 if (*s == 'U' && s[1] == '+') { /* \N{U+...} */
3263                     I32 flags = PERL_SCAN_ALLOW_UNDERSCORES
3264                                 | PERL_SCAN_DISALLOW_PREFIX;
3265                     STRLEN len;
3266
3267                     /* For \N{U+...}, the '...' is a unicode value even on
3268                      * EBCDIC machines */
3269                     s += 2;         /* Skip to next char after the 'U+' */
3270                     len = e - s;
3271                     uv = grok_hex(s, &len, &flags, NULL);
3272                     if (len == 0 || len != (STRLEN)(e - s)) {
3273                         yyerror("Invalid hexadecimal number in \\N{U+...}");
3274                         s = e + 1;
3275                         continue;
3276                     }
3277
3278                     if (PL_lex_inpat) {
3279
3280                         /* On non-EBCDIC platforms, pass through to the regex
3281                          * compiler unchanged.  The reason we evaluated the
3282                          * number above is to make sure there wasn't a syntax
3283                          * error.  But on EBCDIC we convert to native so
3284                          * downstream code can continue to assume it's native
3285                          */
3286                         s -= 5;     /* Include the '\N{U+' */
3287 #ifdef EBCDIC
3288                         d += my_snprintf(d, e - s + 1 + 1,  /* includes the }
3289                                                                and the \0 */
3290                                     "\\N{U+%X}",
3291                                     (unsigned int) UNI_TO_NATIVE(uv));
3292 #else
3293                         Copy(s, d, e - s + 1, char);    /* 1 = include the } */
3294                         d += e - s + 1;
3295 #endif
3296                     }
3297                     else {  /* Not a pattern: convert the hex to string */
3298
3299                          /* If destination is not in utf8, unconditionally
3300                           * recode it to be so.  This is because \N{} implies
3301                           * Unicode semantics, and scalars have to be in utf8
3302                           * to guarantee those semantics */
3303                         if (! has_utf8) {
3304                             SvCUR_set(sv, d - SvPVX_const(sv));
3305                             SvPOK_on(sv);
3306                             *d = '\0';
3307                             /* See Note on sizing above.  */
3308                             sv_utf8_upgrade_flags_grow(
3309                                         sv,
3310                                         SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3311                                         UNISKIP(uv) + (STRLEN)(send - e) + 1);
3312                             d = SvPVX(sv) + SvCUR(sv);
3313                             has_utf8 = TRUE;
3314                         }
3315
3316                         /* Add the (Unicode) code point to the output. */
3317                         if (UNI_IS_INVARIANT(uv)) {
3318                             *d++ = (char) LATIN1_TO_NATIVE(uv);
3319                         }
3320                         else {
3321                             d = (char*) uvoffuni_to_utf8_flags((U8*)d, uv, 0);
3322                         }
3323                     }
3324                 }
3325                 else /* Here is \N{NAME} but not \N{U+...}. */
3326                      if ((res = get_and_check_backslash_N_name(s, e)))
3327                 {
3328                     STRLEN len;
3329                     const char *str = SvPV_const(res, len);
3330                     if (PL_lex_inpat) {
3331
3332                         if (! len) { /* The name resolved to an empty string */
3333                             Copy("\\N{}", d, 4, char);
3334                             d += 4;
3335                         }
3336                         else {
3337                             /* In order to not lose information for the regex
3338                             * compiler, pass the result in the specially made
3339                             * syntax: \N{U+c1.c2.c3...}, where c1 etc. are
3340                             * the code points in hex of each character
3341                             * returned by charnames */
3342
3343                             const char *str_end = str + len;
3344                             const STRLEN off = d - SvPVX_const(sv);
3345
3346                             if (! SvUTF8(res)) {
3347                                 /* For the non-UTF-8 case, we can determine the
3348                                  * exact length needed without having to parse
3349                                  * through the string.  Each character takes up
3350                                  * 2 hex digits plus either a trailing dot or
3351                                  * the "}" */
3352                                 d = off + SvGROW(sv, off
3353                                                     + 3 * len
3354                                                     + 6 /* For the "\N{U+", and
3355                                                            trailing NUL */
3356                                                     + (STRLEN)(send - e));
3357                                 Copy("\\N{U+", d, 5, char);
3358                                 d += 5;
3359                                 while (str < str_end) {
3360                                     char hex_string[4];
3361                                     int len =
3362                                         my_snprintf(hex_string,
3363                                                     sizeof(hex_string),
3364                                                     "%02X.", (U8) *str);
3365                                     PERL_MY_SNPRINTF_POST_GUARD(len, sizeof(hex_string));
3366                                     Copy(hex_string, d, 3, char);
3367                                     d += 3;
3368                                     str++;
3369                                 }
3370                                 d--;    /* We will overwrite below the final
3371                                            dot with a right brace */
3372                             }
3373                             else {
3374                                 STRLEN char_length; /* cur char's byte length */
3375
3376                                 /* and the number of bytes after this is
3377                                  * translated into hex digits */
3378                                 STRLEN output_length;
3379
3380                                 /* 2 hex per byte; 2 chars for '\N'; 2 chars
3381                                  * for max('U+', '.'); and 1 for NUL */
3382                                 char hex_string[2 * UTF8_MAXBYTES + 5];
3383
3384                                 /* Get the first character of the result. */
3385                                 U32 uv = utf8n_to_uvchr((U8 *) str,
3386                                                         len,
3387                                                         &char_length,
3388                                                         UTF8_ALLOW_ANYUV);
3389                                 /* Convert first code point to hex, including
3390                                  * the boiler plate before it. */
3391                                 output_length =
3392                                     my_snprintf(hex_string, sizeof(hex_string),
3393                                                 "\\N{U+%X",
3394                                                 (unsigned int) uv);
3395
3396                                 /* Make sure there is enough space to hold it */
3397                                 d = off + SvGROW(sv, off
3398                                                     + output_length
3399                                                     + (STRLEN)(send - e)
3400                                                     + 2);       /* '}' + NUL */
3401                                 /* And output it */
3402                                 Copy(hex_string, d, output_length, char);
3403                                 d += output_length;
3404
3405                                 /* For each subsequent character, append dot and
3406                                 * its ordinal in hex */
3407                                 while ((str += char_length) < str_end) {
3408                                     const STRLEN off = d - SvPVX_const(sv);
3409                                     U32 uv = utf8n_to_uvchr((U8 *) str,
3410                                                             str_end - str,
3411                                                             &char_length,
3412                                                             UTF8_ALLOW_ANYUV);
3413                                     output_length =
3414                                         my_snprintf(hex_string,
3415                                                     sizeof(hex_string),
3416                                                     ".%X",
3417                                                     (unsigned int) uv);
3418
3419                                     d = off + SvGROW(sv, off
3420                                                         + output_length
3421                                                         + (STRLEN)(send - e)
3422                                                         + 2);   /* '}' +  NUL */
3423                                     Copy(hex_string, d, output_length, char);
3424                                     d += output_length;
3425                                 }
3426                             }
3427
3428                             *d++ = '}'; /* Done.  Add the trailing brace */
3429                         }
3430                     }
3431                     else { /* Here, not in a pattern.  Convert the name to a
3432                             * string. */
3433
3434                          /* If destination is not in utf8, unconditionally
3435                           * recode it to be so.  This is because \N{} implies
3436                           * Unicode semantics, and scalars have to be in utf8
3437                           * to guarantee those semantics */
3438                         if (! has_utf8) {
3439                             SvCUR_set(sv, d - SvPVX_const(sv));
3440                             SvPOK_on(sv);
3441                             *d = '\0';
3442                             /* See Note on sizing above.  */
3443                             sv_utf8_upgrade_flags_grow(sv,
3444                                                 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3445                                                 len + (STRLEN)(send - s) + 1);
3446                             d = SvPVX(sv) + SvCUR(sv);
3447                             has_utf8 = TRUE;
3448                         } else if (len > (STRLEN)(e - s + 4)) { /* I _guess_ 4 is \N{} --jhi */
3449
3450                             /* See Note on sizing above.  (NOTE: SvCUR() is not
3451                              * set correctly here). */
3452                             const STRLEN off = d - SvPVX_const(sv);
3453                             d = off + SvGROW(sv, off + len + (STRLEN)(send - s) + 1);
3454                         }
3455                         if (! SvUTF8(res)) {    /* Make sure is \N{} return is UTF-8 */
3456                             sv_utf8_upgrade(res);
3457                             str = SvPV_const(res, len);
3458                         }
3459                         Copy(str, d, len, char);
3460                         d += len;
3461                     }
3462
3463                     SvREFCNT_dec(res);
3464
3465                 } /* End \N{NAME} */
3466 #ifdef EBCDIC
3467                 if (!dorange) 
3468                     native_range = FALSE; /* \N{} is defined to be Unicode */
3469 #endif
3470                 s = e + 1;  /* Point to just after the '}' */
3471                 continue;
3472
3473             /* \c is a control character */
3474             case 'c':
3475                 s++;
3476                 if (s < send) {
3477                     *d++ = grok_bslash_c(*s++, 1);
3478                 }
3479                 else {
3480                     yyerror("Missing control char name in \\c");
3481                 }
3482                 continue;
3483
3484             /* printf-style backslashes, formfeeds, newlines, etc */
3485             case 'b':
3486                 *d++ = '\b';
3487                 break;
3488             case 'n':
3489                 *d++ = '\n';
3490                 break;
3491             case 'r':
3492                 *d++ = '\r';
3493                 break;
3494             case 'f':
3495                 *d++ = '\f';
3496                 break;
3497             case 't':
3498                 *d++ = '\t';
3499                 break;
3500             case 'e':
3501                 *d++ = ASCII_TO_NATIVE('\033');
3502                 break;
3503             case 'a':
3504                 *d++ = '\a';
3505                 break;
3506             } /* end switch */
3507
3508             s++;
3509             continue;
3510         } /* end if (backslash) */
3511 #ifdef EBCDIC
3512         else
3513             literal_endpoint++;
3514 #endif
3515
3516     default_action:
3517         /* If we started with encoded form, or already know we want it,
3518            then encode the next character */
3519         if (! NATIVE_BYTE_IS_INVARIANT((U8)(*s)) && (this_utf8 || has_utf8)) {
3520             STRLEN len  = 1;
3521
3522
3523             /* One might think that it is wasted effort in the case of the
3524              * source being utf8 (this_utf8 == TRUE) to take the next character
3525              * in the source, convert it to an unsigned value, and then convert
3526              * it back again.  But the source has not been validated here.  The
3527              * routine that does the conversion checks for errors like
3528              * malformed utf8 */
3529
3530             const UV nextuv   = (this_utf8)
3531                                 ? utf8n_to_uvchr((U8*)s, send - s, &len, 0)
3532                                 : (UV) ((U8) *s);
3533             const STRLEN need = UNISKIP(nextuv);
3534             if (!has_utf8) {
3535                 SvCUR_set(sv, d - SvPVX_const(sv));
3536                 SvPOK_on(sv);
3537                 *d = '\0';
3538                 /* See Note on sizing above.  */
3539                 sv_utf8_upgrade_flags_grow(sv,
3540                                         SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3541                                         need + (STRLEN)(send - s) + 1);
3542                 d = SvPVX(sv) + SvCUR(sv);
3543                 has_utf8 = TRUE;
3544             } else if (need > len) {
3545                 /* encoded value larger than old, may need extra space (NOTE:
3546                  * SvCUR() is not set correctly here).   See Note on sizing
3547                  * above.  */
3548                 const STRLEN off = d - SvPVX_const(sv);
3549                 d = SvGROW(sv, off + need + (STRLEN)(send - s) + 1) + off;
3550             }
3551             s += len;
3552
3553             d = (char*)uvchr_to_utf8((U8*)d, nextuv);
3554 #ifdef EBCDIC
3555             if (uv > 255 && !dorange)
3556                 native_range = FALSE;
3557 #endif
3558         }
3559         else {
3560             *d++ = *s++;
3561         }
3562     } /* while loop to process each character */
3563
3564     /* terminate the string and set up the sv */
3565     *d = '\0';
3566     SvCUR_set(sv, d - SvPVX_const(sv));
3567     if (SvCUR(sv) >= SvLEN(sv))
3568         Perl_croak(aTHX_ "panic: constant overflowed allocated space, %"UVuf
3569                    " >= %"UVuf, (UV)SvCUR(sv), (UV)SvLEN(sv));
3570
3571     SvPOK_on(sv);
3572     if (PL_encoding && !has_utf8) {
3573         sv_recode_to_utf8(sv, PL_encoding);
3574         if (SvUTF8(sv))
3575             has_utf8 = TRUE;
3576     }
3577     if (has_utf8) {
3578         SvUTF8_on(sv);
3579         if (PL_lex_inwhat == OP_TRANS && PL_sublex_info.sub_op) {
3580             PL_sublex_info.sub_op->op_private |=
3581                     (PL_lex_repl ? OPpTRANS_FROM_UTF : OPpTRANS_TO_UTF);
3582         }
3583     }
3584
3585     /* shrink the sv if we allocated more than we used */
3586     if (SvCUR(sv) + 5 < SvLEN(sv)) {
3587         SvPV_shrink_to_cur(sv);
3588     }
3589
3590     /* return the substring (via pl_yylval) only if we parsed anything */
3591     if (s > start) {
3592         char *s2 = start;
3593         for (; s2 < s; s2++) {
3594             if (*s2 == '\n')
3595                 COPLINE_INC_WITH_HERELINES;
3596         }
3597         SvREFCNT_inc_simple_void_NN(sv);
3598         if (   (PL_hints & ( PL_lex_inpat ? HINT_NEW_RE : HINT_NEW_STRING ))
3599             && ! PL_parser->lex_re_reparsing)
3600         {
3601             const char *const key = PL_lex_inpat ? "qr" : "q";
3602             const STRLEN keylen = PL_lex_inpat ? 2 : 1;
3603             const char *type;
3604             STRLEN typelen;
3605
3606             if (PL_lex_inwhat == OP_TRANS) {
3607                 type = "tr";
3608                 typelen = 2;
3609             } else if (PL_lex_inwhat == OP_SUBST && !PL_lex_inpat) {
3610                 type = "s";
3611                 typelen = 1;
3612             } else if (PL_lex_inpat && SvIVX(PL_linestr) == '\'') {
3613                 type = "q";
3614                 typelen = 1;
3615             } else  {
3616                 type = "qq";
3617                 typelen = 2;
3618             }
3619
3620             sv = S_new_constant(aTHX_ start, s - start, key, keylen, sv, NULL,
3621                                 type, typelen);
3622         }
3623         pl_yylval.opval = (OP*)newSVOP(OP_CONST, 0, sv);
3624     }
3625     LEAVE_with_name("scan_const");
3626     return s;
3627 }
3628
3629 /* S_intuit_more
3630  * Returns TRUE if there's more to the expression (e.g., a subscript),
3631  * FALSE otherwise.
3632  *
3633  * It deals with "$foo[3]" and /$foo[3]/ and /$foo[0123456789$]+/
3634  *
3635  * ->[ and ->{ return TRUE
3636  * ->$* ->$#* ->@* ->@[ ->@{ return TRUE if postderef_qq is enabled
3637  * { and [ outside a pattern are always subscripts, so return TRUE
3638  * if we're outside a pattern and it's not { or [, then return FALSE
3639  * if we're in a pattern and the first char is a {
3640  *   {4,5} (any digits around the comma) returns FALSE
3641  * if we're in a pattern and the first char is a [
3642  *   [] returns FALSE
3643  *   [SOMETHING] has a funky algorithm to decide whether it's a
3644  *      character class or not.  It has to deal with things like
3645  *      /$foo[-3]/ and /$foo[$bar]/ as well as /$foo[$\d]+/
3646  * anything else returns TRUE
3647  */
3648
3649 /* This is the one truly awful dwimmer necessary to conflate C and sed. */
3650
3651 STATIC int
3652 S_intuit_more(pTHX_ char *s)
3653 {
3654     PERL_ARGS_ASSERT_INTUIT_MORE;
3655
3656     if (PL_lex_brackets)
3657         return TRUE;
3658     if (*s == '-' && s[1] == '>' && (s[2] == '[' || s[2] == '{'))
3659         return TRUE;
3660     if (*s == '-' && s[1] == '>'
3661      && FEATURE_POSTDEREF_QQ_IS_ENABLED
3662      && ( (s[2] == '$' && (s[3] == '*' || (s[3] == '#' && s[4] == '*')))
3663         ||(s[2] == '@' && strchr("*[{",s[3])) ))
3664         return TRUE;
3665     if (*s != '{' && *s != '[')
3666         return FALSE;
3667     if (!PL_lex_inpat)
3668         return TRUE;
3669
3670     /* In a pattern, so maybe we have {n,m}. */
3671     if (*s == '{') {
3672         if (regcurly(s)) {
3673             return FALSE;
3674         }
3675         return TRUE;
3676     }
3677
3678     /* On the other hand, maybe we have a character class */
3679
3680     s++;
3681     if (*s == ']' || *s == '^')
3682         return FALSE;
3683     else {
3684         /* this is terrifying, and it works */
3685         int weight;
3686         char seen[256];
3687         const char * const send = strchr(s,']');
3688         unsigned char un_char, last_un_char;
3689         char tmpbuf[sizeof PL_tokenbuf * 4];
3690
3691         if (!send)              /* has to be an expression */
3692             return TRUE;
3693         weight = 2;             /* let's weigh the evidence */
3694
3695         if (*s == '$')
3696             weight -= 3;
3697         else if (isDIGIT(*s)) {
3698             if (s[1] != ']') {
3699                 if (isDIGIT(s[1]) && s[2] == ']')
3700                     weight -= 10;
3701             }
3702             else
3703                 weight -= 100;
3704         }
3705         Zero(seen,256,char);
3706         un_char = 255;
3707         for (; s < send; s++) {
3708             last_un_char = un_char;
3709             un_char = (unsigned char)*s;
3710             switch (*s) {
3711             case '@':
3712             case '&':
3713             case '$':
3714                 weight -= seen[un_char] * 10;
3715                 if (isWORDCHAR_lazy_if(s+1,UTF)) {
3716                     int len;
3717                     char *tmp = PL_bufend;
3718                     PL_bufend = (char*)send;
3719                     scan_ident(s, tmpbuf, sizeof tmpbuf, FALSE);
3720                     PL_bufend = tmp;
3721                     len = (int)strlen(tmpbuf);
3722                     if (len > 1 && gv_fetchpvn_flags(tmpbuf, len,
3723                                                     UTF ? SVf_UTF8 : 0, SVt_PV))
3724                         weight -= 100;
3725                     else
3726                         weight -= 10;
3727                 }
3728                 else if (*s == '$' && s[1] &&
3729                   strchr("[#!%*<>()-=",s[1])) {
3730                     if (/*{*/ strchr("])} =",s[2]))
3731                         weight -= 10;
3732                     else
3733                         weight -= 1;
3734                 }
3735                 break;
3736             case '\\':
3737                 un_char = 254;
3738                 if (s[1]) {
3739                     if (strchr("wds]",s[1]))
3740                         weight += 100;
3741                     else if (seen[(U8)'\''] || seen[(U8)'"'])
3742                         weight += 1;
3743                     else if (strchr("rnftbxcav",s[1]))
3744                         weight += 40;
3745                     else if (isDIGIT(s[1])) {
3746                         weight += 40;
3747                         while (s[1] && isDIGIT(s[1]))
3748                             s++;
3749                     }
3750                 }
3751                 else
3752                     weight += 100;
3753                 break;
3754             case '-':
3755                 if (s[1] == '\\')
3756                     weight += 50;
3757                 if (strchr("aA01! ",last_un_char))
3758                     weight += 30;
3759                 if (strchr("zZ79~",s[1]))
3760                     weight += 30;
3761                 if (last_un_char == 255 && (isDIGIT(s[1]) || s[1] == '$'))
3762                     weight -= 5;        /* cope with negative subscript */
3763                 break;
3764             default:
3765                 if (!isWORDCHAR(last_un_char)
3766                     && !(last_un_char == '$' || last_un_char == '@'
3767                          || last_un_char == '&')
3768                     && isALPHA(*s) && s[1] && isALPHA(s[1])) {
3769                     char *d = tmpbuf;
3770                     while (isALPHA(*s))
3771                         *d++ = *s++;
3772                     *d = '\0';
3773                     if (keyword(tmpbuf, d - tmpbuf, 0))
3774                         weight -= 150;
3775                 }
3776                 if (un_char == last_un_char + 1)
3777                     weight += 5;
3778                 weight -= seen[un_char];
3779                 break;
3780             }
3781             seen[un_char]++;
3782         }
3783         if (weight >= 0)        /* probably a character class */
3784             return FALSE;
3785     }
3786
3787     return TRUE;
3788 }
3789
3790 /*
3791  * S_intuit_method
3792  *
3793  * Does all the checking to disambiguate
3794  *   foo bar
3795  * between foo(bar) and bar->foo.  Returns 0 if not a method, otherwise
3796  * FUNCMETH (bar->foo(args)) or METHOD (bar->foo args).
3797  *
3798  * First argument is the stuff after the first token, e.g. "bar".
3799  *
3800  * Not a method if foo is a filehandle.
3801  * Not a method if foo is a subroutine prototyped to take a filehandle.
3802  * Not a method if it's really "Foo $bar"
3803  * Method if it's "foo $bar"
3804  * Not a method if it's really "print foo $bar"
3805  * Method if it's really "foo package::" (interpreted as package->foo)
3806  * Not a method if bar is known to be a subroutine ("sub bar; foo bar")
3807  * Not a method if bar is a filehandle or package, but is quoted with
3808  *   =>
3809  */
3810
3811 STATIC int
3812 S_intuit_method(pTHX_ char *start, GV *gv, CV *cv)
3813 {
3814     char *s = start + (*start == '$');
3815     char tmpbuf[sizeof PL_tokenbuf];
3816     STRLEN len;
3817     GV* indirgv;
3818
3819     PERL_ARGS_ASSERT_INTUIT_METHOD;
3820
3821     if (gv && SvTYPE(gv) == SVt_PVGV && GvIO(gv))
3822             return 0;
3823     if (cv && SvPOK(cv)) {
3824         const char *proto = CvPROTO(cv);
3825         if (proto) {
3826             while (*proto && (isSPACE(*proto) || *proto == ';'))
3827                 proto++;
3828             if (*proto == '*')
3829                 return 0;
3830         }
3831     }
3832
3833     if (*start == '$') {
3834         if (cv || PL_last_lop_op == OP_PRINT || PL_last_lop_op == OP_SAY ||
3835                 isUPPER(*PL_tokenbuf))
3836             return 0;
3837         s = PEEKSPACE(s);
3838         PL_bufptr = start;
3839         PL_expect = XREF;
3840         return *s == '(' ? FUNCMETH : METHOD;
3841     }
3842
3843     s = scan_word(s, tmpbuf, sizeof tmpbuf, TRUE, &len);
3844     /* start is the beginning of the possible filehandle/object,
3845      * and s is the end of it
3846      * tmpbuf is a copy of it (but with single quotes as double colons)
3847      */
3848
3849     if (!keyword(tmpbuf, len, 0)) {
3850         if (len > 2 && tmpbuf[len - 2] == ':' && tmpbuf[len - 1] == ':') {
3851             len -= 2;
3852             tmpbuf[len] = '\0';
3853             goto bare_package;
3854         }
3855         indirgv = gv_fetchpvn_flags(tmpbuf, len, ( UTF ? SVf_UTF8 : 0 ), SVt_PVCV);
3856         if (indirgv && GvCVu(indirgv))
3857             return 0;
3858         /* filehandle or package name makes it a method */
3859         if (!cv || GvIO(indirgv) || gv_stashpvn(tmpbuf, len, UTF ? SVf_UTF8 : 0)) {
3860             s = PEEKSPACE(s);
3861             if ((PL_bufend - s) >= 2 && *s == '=' && *(s+1) == '>')
3862                 return 0;       /* no assumptions -- "=>" quotes bareword */
3863       bare_package:
3864             NEXTVAL_NEXTTOKE.opval = (OP*)newSVOP(OP_CONST, 0,
3865                                                   S_newSV_maybe_utf8(aTHX_ tmpbuf, len));
3866             NEXTVAL_NEXTTOKE.opval->op_private = OPpCONST_BARE;
3867             PL_expect = XTERM;
3868             force_next(WORD);
3869             PL_bufptr = s;
3870             return *s == '(' ? FUNCMETH : METHOD;
3871         }
3872     }
3873     return 0;
3874 }
3875
3876 /* Encoded script support. filter_add() effectively inserts a
3877  * 'pre-processing' function into the current source input stream.
3878  * Note that the filter function only applies to the current source file
3879  * (e.g., it will not affect files 'require'd or 'use'd by this one).
3880  *
3881  * The datasv parameter (which may be NULL) can be used to pass
3882  * private data to this instance of the filter. The filter function
3883  * can recover the SV using the FILTER_DATA macro and use it to
3884  * store private buffers and state information.
3885  *
3886  * The supplied datasv parameter is upgraded to a PVIO type
3887  * and the IoDIRP/IoANY field is used to store the function pointer,
3888  * and IOf_FAKE_DIRP is enabled on datasv to mark this as such.
3889  * Note that IoTOP_NAME, IoFMT_NAME, IoBOTTOM_NAME, if set for
3890  * private use must be set using malloc'd pointers.
3891  */
3892
3893 SV *
3894 Perl_filter_add(pTHX_ filter_t funcp, SV *datasv)
3895 {
3896     if (!funcp)
3897         return NULL;
3898
3899     if (!PL_parser)
3900         return NULL;
3901
3902     if (PL_parser->lex_flags & LEX_IGNORE_UTF8_HINTS)
3903         Perl_croak(aTHX_ "Source filters apply only to byte streams");
3904
3905     if (!PL_rsfp_filters)
3906         PL_rsfp_filters = newAV();
3907     if (!datasv)
3908         datasv = newSV(0);
3909     SvUPGRADE(datasv, SVt_PVIO);
3910     IoANY(datasv) = FPTR2DPTR(void *, funcp); /* stash funcp into spare field */
3911     IoFLAGS(datasv) |= IOf_FAKE_DIRP;
3912     DEBUG_P(PerlIO_printf(Perl_debug_log, "filter_add func %p (%s)\n",
3913                           FPTR2DPTR(void *, IoANY(datasv)),
3914                           SvPV_nolen(datasv)));
3915     av_unshift(PL_rsfp_filters, 1);
3916     av_store(PL_rsfp_filters, 0, datasv) ;
3917     if (
3918         !PL_parser->filtered
3919      && PL_parser->lex_flags & LEX_EVALBYTES
3920      && PL_bufptr < PL_bufend
3921     ) {
3922         const char *s = PL_bufptr;
3923         while (s < PL_bufend) {
3924             if (*s == '\n') {
3925                 SV *linestr = PL_parser->linestr;
3926                 char *buf = SvPVX(linestr);
3927                 STRLEN const bufptr_pos = PL_parser->bufptr - buf;
3928                 STRLEN const oldbufptr_pos = PL_parser->oldbufptr - buf;
3929                 STRLEN const oldoldbufptr_pos=PL_parser->oldoldbufptr-buf;
3930                 STRLEN const linestart_pos = PL_parser->linestart - buf;
3931                 STRLEN const last_uni_pos =
3932                     PL_parser->last_uni ? PL_parser->last_uni - buf : 0;
3933                 STRLEN const last_lop_pos =
3934                     PL_parser->last_lop ? PL_parser->last_lop - buf : 0;
3935                 av_push(PL_rsfp_filters, linestr);
3936                 PL_parser->linestr = 
3937                     newSVpvn(SvPVX(linestr), ++s-SvPVX(linestr));
3938                 buf = SvPVX(PL_parser->linestr);
3939                 PL_parser->bufend = buf + SvCUR(PL_parser->linestr);
3940                 PL_parser->bufptr = buf + bufptr_pos;
3941                 PL_parser->oldbufptr = buf + oldbufptr_pos;
3942                 PL_parser->oldoldbufptr = buf + oldoldbufptr_pos;
3943                 PL_parser->linestart = buf + linestart_pos;
3944                 if (PL_parser->last_uni)
3945                     PL_parser->last_uni = buf + last_uni_pos;
3946                 if (PL_parser->last_lop)
3947                     PL_parser->last_lop = buf + last_lop_pos;
3948                 SvLEN(linestr) = SvCUR(linestr);
3949                 SvCUR(linestr) = s-SvPVX(linestr);
3950                 PL_parser->filtered = 1;
3951                 break;
3952             }
3953             s++;
3954         }
3955     }
3956     return(datasv);
3957 }
3958
3959
3960 /* Delete most recently added instance of this filter function. */
3961 void
3962 Perl_filter_del(pTHX_ filter_t funcp)
3963 {
3964     SV *datasv;
3965
3966     PERL_ARGS_ASSERT_FILTER_DEL;
3967
3968 #ifdef DEBUGGING
3969     DEBUG_P(PerlIO_printf(Perl_debug_log, "filter_del func %p",
3970                           FPTR2DPTR(void*, funcp)));
3971 #endif
3972     if (!PL_parser || !PL_rsfp_filters || AvFILLp(PL_rsfp_filters)<0)
3973         return;
3974     /* if filter is on top of stack (usual case) just pop it off */
3975     datasv = FILTER_DATA(AvFILLp(PL_rsfp_filters));
3976     if (IoANY(datasv) == FPTR2DPTR(void *, funcp)) {
3977         sv_free(av_pop(PL_rsfp_filters));
3978
3979         return;
3980     }
3981     /* we need to search for the correct entry and clear it     */
3982     Perl_die(aTHX_ "filter_del can only delete in reverse order (currently)");
3983 }
3984
3985
3986 /* Invoke the idxth filter function for the current rsfp.        */
3987 /* maxlen 0 = read one text line */
3988 I32
3989 Perl_filter_read(pTHX_ int idx, SV *buf_sv, int maxlen)
3990 {
3991     filter_t funcp;
3992     SV *datasv = NULL;
3993     /* This API is bad. It should have been using unsigned int for maxlen.
3994        Not sure if we want to change the API, but if not we should sanity
3995        check the value here.  */
3996     unsigned int correct_length = maxlen < 0 ?  PERL_INT_MAX : maxlen;
3997
3998     PERL_ARGS_ASSERT_FILTER_READ;
3999
4000     if (!PL_parser || !PL_rsfp_filters)
4001         return -1;
4002     if (idx > AvFILLp(PL_rsfp_filters)) {       /* Any more filters?    */
4003         /* Provide a default input filter to make life easy.    */
4004         /* Note that we append to the line. This is handy.      */
4005         DEBUG_P(PerlIO_printf(Perl_debug_log,
4006                               "filter_read %d: from rsfp\n", idx));
4007         if (correct_length) {
4008             /* Want a block */
4009             int len ;
4010             const int old_len = SvCUR(buf_sv);
4011
4012             /* ensure buf_sv is large enough */
4013             SvGROW(buf_sv, (STRLEN)(old_len + correct_length + 1)) ;
4014             if ((len = PerlIO_read(PL_rsfp, SvPVX(buf_sv) + old_len,
4015                                    correct_length)) <= 0) {
4016                 if (PerlIO_error(PL_rsfp))
4017                     return -1;          /* error */
4018                 else
4019                     return 0 ;          /* end of file */
4020             }
4021             SvCUR_set(buf_sv, old_len + len) ;
4022             SvPVX(buf_sv)[old_len + len] = '\0';
4023         } else {
4024             /* Want a line */
4025             if (sv_gets(buf_sv, PL_rsfp, SvCUR(buf_sv)) == NULL) {
4026                 if (PerlIO_error(PL_rsfp))
4027                     return -1;          /* error */
4028                 else
4029                     return 0 ;          /* end of file */
4030             }
4031         }
4032         return SvCUR(buf_sv);
4033     }
4034     /* Skip this filter slot if filter has been deleted */
4035     if ( (datasv = FILTER_DATA(idx)) == &PL_sv_undef) {
4036         DEBUG_P(PerlIO_printf(Perl_debug_log,
4037                               "filter_read %d: skipped (filter deleted)\n",
4038                               idx));
4039         return FILTER_READ(idx+1, buf_sv, correct_length); /* recurse */
4040     }
4041     if (SvTYPE(datasv) != SVt_PVIO) {
4042         if (correct_length) {
4043             /* Want a block */
4044             const STRLEN remainder = SvLEN(datasv) - SvCUR(datasv);
4045             if (!remainder) return 0; /* eof */
4046             if (correct_length > remainder) correct_length = remainder;
4047             sv_catpvn(buf_sv, SvEND(datasv), correct_length);
4048             SvCUR_set(datasv, SvCUR(datasv) + correct_length);
4049         } else {
4050             /* Want a line */
4051             const char *s = SvEND(datasv);
4052             const char *send = SvPVX(datasv) + SvLEN(datasv);
4053             while (s < send) {
4054                 if (*s == '\n') {
4055                     s++;
4056                     break;
4057                 }
4058                 s++;
4059             }
4060             if (s == send) return 0; /* eof */
4061             sv_catpvn(buf_sv, SvEND(datasv), s-SvEND(datasv));
4062             SvCUR_set(datasv, s-SvPVX(datasv));
4063         }
4064         return SvCUR(buf_sv);
4065     }
4066     /* Get function pointer hidden within datasv        */
4067     funcp = DPTR2FPTR(filter_t, IoANY(datasv));
4068     DEBUG_P(PerlIO_printf(Perl_debug_log,
4069                           "filter_read %d: via function %p (%s)\n",
4070                           idx, (void*)datasv, SvPV_nolen_const(datasv)));
4071     /* Call function. The function is expected to       */
4072     /* call "FILTER_READ(idx+1, buf_sv)" first.         */
4073     /* Return: <0:error, =0:eof, >0:not eof             */
4074     return (*funcp)(aTHX_ idx, buf_sv, correct_length);
4075 }
4076
4077 STATIC char *
4078 S_filter_gets(pTHX_ SV *sv, STRLEN append)
4079 {
4080     PERL_ARGS_ASSERT_FILTER_GETS;
4081
4082 #ifdef PERL_CR_FILTER
4083     if (!PL_rsfp_filters) {
4084         filter_add(S_cr_textfilter,NULL);
4085     }
4086 #endif
4087     if (PL_rsfp_filters) {
4088         if (!append)
4089             SvCUR_set(sv, 0);   /* start with empty line        */
4090         if (FILTER_READ(0, sv, 0) > 0)
4091             return ( SvPVX(sv) ) ;
4092         else
4093             return NULL ;
4094     }
4095     else
4096         return (sv_gets(sv, PL_rsfp, append));
4097 }
4098
4099 STATIC HV *
4100 S_find_in_my_stash(pTHX_ const char *pkgname, STRLEN len)
4101 {
4102     GV *gv;
4103
4104     PERL_ARGS_ASSERT_FIND_IN_MY_STASH;
4105
4106     if (len == 11 && *pkgname == '_' && strEQ(pkgname, "__PACKAGE__"))
4107         return PL_curstash;
4108
4109     if (len > 2 &&
4110         (pkgname[len - 2] == ':' && pkgname[len - 1] == ':') &&
4111         (gv = gv_fetchpvn_flags(pkgname, len, ( UTF ? SVf_UTF8 : 0 ), SVt_PVHV)))
4112     {
4113         return GvHV(gv);                        /* Foo:: */
4114     }
4115
4116     /* use constant CLASS => 'MyClass' */
4117     gv = gv_fetchpvn_flags(pkgname, len, UTF ? SVf_UTF8 : 0, SVt_PVCV);
4118     if (gv && GvCV(gv)) {
4119         SV * const sv = cv_const_sv(GvCV(gv));
4120         if (sv)
4121             pkgname = SvPV_const(sv, len);
4122     }
4123
4124     return gv_stashpvn(pkgname, len, UTF ? SVf_UTF8 : 0);
4125 }
4126
4127
4128 STATIC char *
4129 S_tokenize_use(pTHX_ int is_use, char *s) {
4130     PERL_ARGS_ASSERT_TOKENIZE_USE;
4131
4132     if (PL_expect != XSTATE)
4133         yyerror(Perl_form(aTHX_ "\"%s\" not allowed in expression",
4134                     is_use ? "use" : "no"));
4135     PL_expect = XTERM;
4136     s = SKIPSPACE1(s);
4137     if (isDIGIT(*s) || (*s == 'v' && isDIGIT(s[1]))) {
4138         s = force_version(s, TRUE);
4139         if (*s == ';' || *s == '}'
4140                 || (s = SKIPSPACE1(s), (*s == ';' || *s == '}'))) {
4141             NEXTVAL_NEXTTOKE.opval = NULL;
4142             force_next(WORD);
4143         }
4144         else if (*s == 'v') {
4145             s = force_word(s,WORD,FALSE,TRUE);
4146             s = force_version(s, FALSE);
4147         }
4148     }
4149     else {
4150         s = force_word(s,WORD,FALSE,TRUE);
4151         s = force_version(s, FALSE);
4152     }
4153     pl_yylval.ival = is_use;
4154     return s;
4155 }
4156 #ifdef DEBUGGING
4157     static const char* const exp_name[] =
4158         { "OPERATOR", "TERM", "REF", "STATE", "BLOCK", "ATTRBLOCK",
4159           "ATTRTERM", "TERMBLOCK", "POSTDEREF", "TERMORDORDOR"
4160         };
4161 #endif
4162
4163 #define word_takes_any_delimeter(p,l) S_word_takes_any_delimeter(p,l)
4164 STATIC bool
4165 S_word_takes_any_delimeter(char *p, STRLEN len)
4166 {
4167     return (len == 1 && strchr("msyq", p[0])) ||
4168            (len == 2 && (
4169             (p[0] == 't' && p[1] == 'r') ||
4170             (p[0] == 'q' && strchr("qwxr", p[1]))));
4171 }
4172
4173 static void
4174 S_check_scalar_slice(pTHX_ char *s)
4175 {
4176     s++;
4177     while (*s == ' ' || *s == '\t') s++;
4178     if (*s == 'q' && s[1] == 'w'
4179      && !isWORDCHAR_lazy_if(s+2,UTF))
4180         return;
4181     while (*s && (isWORDCHAR_lazy_if(s,UTF) || strchr(" \t$#+-'\"", *s)))
4182         s += UTF ? UTF8SKIP(s) : 1;
4183     if (*s == '}' || *s == ']')
4184         pl_yylval.ival = OPpSLICEWARNING;
4185 }
4186
4187 /*
4188   yylex
4189
4190   Works out what to call the token just pulled out of the input
4191   stream.  The yacc parser takes care of taking the ops we return and
4192   stitching them into a tree.
4193
4194   Returns:
4195     The type of the next token
4196
4197   Structure:
4198       Switch based on the current state:
4199           - if we already built the token before, use it
4200           - if we have a case modifier in a string, deal with that
4201           - handle other cases of interpolation inside a string
4202           - scan the next line if we are inside a format
4203       In the normal state switch on the next character:
4204           - default:
4205             if alphabetic, go to key lookup
4206             unrecoginized character - croak
4207           - 0/4/26: handle end-of-line or EOF
4208           - cases for whitespace
4209           - \n and #: handle comments and line numbers
4210           - various operators, brackets and sigils
4211           - numbers
4212           - quotes
4213           - 'v': vstrings (or go to key lookup)
4214           - 'x' repetition operator (or go to key lookup)
4215           - other ASCII alphanumerics (key lookup begins here):
4216               word before => ?
4217               keyword plugin
4218               scan built-in keyword (but do nothing with it yet)
4219               check for statement label
4220               check for lexical subs
4221                   goto just_a_word if there is one
4222               see whether built-in keyword is overridden
4223               switch on keyword number:
4224                   - default: just_a_word:
4225                       not a built-in keyword; handle bareword lookup
4226                       disambiguate between method and sub call
4227                       fall back to bareword
4228                   - cases for built-in keywords
4229 */
4230
4231
4232 int
4233 Perl_yylex(pTHX)
4234 {
4235     dVAR;
4236     char *s = PL_bufptr;
4237     char *d;
4238     STRLEN len;
4239     bool bof = FALSE;
4240     const bool saw_infix_sigil = cBOOL(PL_parser->saw_infix_sigil);
4241     U8 formbrack = 0;
4242     U32 fake_eof = 0;
4243
4244     /* orig_keyword, gvp, and gv are initialized here because
4245      * jump to the label just_a_word_zero can bypass their
4246      * initialization later. */
4247     I32 orig_keyword = 0;
4248     GV *gv = NULL;
4249     GV **gvp = NULL;
4250
4251     DEBUG_T( {
4252         SV* tmp = newSVpvs("");
4253         PerlIO_printf(Perl_debug_log, "### %"IVdf":LEX_%s/X%s %s\n",
4254             (IV)CopLINE(PL_curcop),
4255             lex_state_names[PL_lex_state],
4256             exp_name[PL_expect],
4257             pv_display(tmp, s, strlen(s), 0, 60));
4258         SvREFCNT_dec(tmp);
4259     } );
4260
4261     switch (PL_lex_state) {
4262     case LEX_NORMAL:
4263     case LEX_INTERPNORMAL:
4264         break;
4265
4266     /* when we've already built the next token, just pull it out of the queue */
4267     case LEX_KNOWNEXT:
4268         PL_nexttoke--;
4269         pl_yylval = PL_nextval[PL_nexttoke];
4270         if (!PL_nexttoke) {
4271             PL_lex_state = PL_lex_defer;
4272             PL_expect = PL_lex_expect;
4273             PL_lex_defer = LEX_NORMAL;
4274         }
4275         {
4276             I32 next_type;
4277             next_type = PL_nexttype[PL_nexttoke];
4278             if (next_type & (7<<24)) {
4279                 if (next_type & (1<<24)) {
4280                     if (PL_lex_brackets > 100)
4281                         Renew(PL_lex_brackstack, PL_lex_brackets + 10, char);
4282                     PL_lex_brackstack[PL_lex_brackets++] =
4283                         (char) ((next_type >> 16) & 0xff);
4284                 }
4285                 if (next_type & (2<<24))
4286                     PL_lex_allbrackets++;
4287                 if (next_type & (4<<24))
4288                     PL_lex_allbrackets--;
4289                 next_type &= 0xffff;
4290             }
4291             return REPORT(next_type == 'p' ? pending_ident() : next_type);
4292         }
4293
4294     /* interpolated case modifiers like \L \U, including \Q and \E.
4295        when we get here, PL_bufptr is at the \
4296     */
4297     case LEX_INTERPCASEMOD:
4298 #ifdef DEBUGGING
4299         if (PL_bufptr != PL_bufend && *PL_bufptr != '\\')
4300             Perl_croak(aTHX_
4301                        "panic: INTERPCASEMOD bufptr=%p, bufend=%p, *bufptr=%u",
4302                        PL_bufptr, PL_bufend, *PL_bufptr);
4303 #endif
4304         /* handle \E or end of string */
4305         if (PL_bufptr == PL_bufend || PL_bufptr[1] == 'E') {
4306             /* if at a \E */
4307             if (PL_lex_casemods) {
4308                 const char oldmod = PL_lex_casestack[--PL_lex_casemods];
4309                 PL_lex_casestack[PL_lex_casemods] = '\0';
4310
4311                 if (PL_bufptr != PL_bufend
4312                     && (oldmod == 'L' || oldmod == 'U' || oldmod == 'Q'
4313                         || oldmod == 'F')) {
4314                     PL_bufptr += 2;
4315                     PL_lex_state = LEX_INTERPCONCAT;
4316                 }
4317                 PL_lex_allbrackets--;
4318                 return REPORT(')');
4319             }
4320             else if ( PL_bufptr != PL_bufend && PL_bufptr[1] == 'E' ) {
4321                /* Got an unpaired \E */
4322                Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
4323                         "Useless use of \\E");
4324             }
4325             if (PL_bufptr != PL_bufend)
4326                 PL_bufptr += 2;
4327             PL_lex_state = LEX_INTERPCONCAT;
4328             return yylex();
4329         }
4330         else {
4331             DEBUG_T({ PerlIO_printf(Perl_debug_log,
4332               "### Saw case modifier\n"); });
4333             s = PL_bufptr + 1;
4334             if (s[1] == '\\' && s[2] == 'E') {
4335                 PL_bufptr = s + 3;
4336                 PL_lex_state = LEX_INTERPCONCAT;
4337                 return yylex();
4338             }
4339             else {
4340                 I32 tmp;
4341                 if (strnEQ(s, "L\\u", 3) || strnEQ(s, "U\\l", 3))
4342                     tmp = *s, *s = s[2], s[2] = (char)tmp;      /* misordered... */
4343                 if ((*s == 'L' || *s == 'U' || *s == 'F') &&
4344                     (strchr(PL_lex_casestack, 'L')
4345                         || strchr(PL_lex_casestack, 'U')
4346                         || strchr(PL_lex_casestack, 'F'))) {
4347                     PL_lex_casestack[--PL_lex_casemods] = '\0';
4348                     PL_lex_allbrackets--;
4349                     return REPORT(')');
4350                 }
4351                 if (PL_lex_casemods > 10)
4352                     Renew(PL_lex_casestack, PL_lex_casemods + 2, char);
4353                 PL_lex_casestack[PL_lex_casemods++] = *s;
4354                 PL_lex_casestack[PL_lex_casemods] = '\0';
4355                 PL_lex_state = LEX_INTERPCONCAT;
4356                 NEXTVAL_NEXTTOKE.ival = 0;
4357                 force_next((2<<24)|'(');
4358                 if (*s == 'l')
4359                     NEXTVAL_NEXTTOKE.ival = OP_LCFIRST;
4360                 else if (*s == 'u')
4361                     NEXTVAL_NEXTTOKE.ival = OP_UCFIRST;
4362                 else if (*s == 'L')
4363                     NEXTVAL_NEXTTOKE.ival = OP_LC;
4364                 else if (*s == 'U')
4365                     NEXTVAL_NEXTTOKE.ival = OP_UC;
4366                 else if (*s == 'Q')
4367                     NEXTVAL_NEXTTOKE.ival = OP_QUOTEMETA;
4368                 else if (*s == 'F')
4369                     NEXTVAL_NEXTTOKE.ival = OP_FC;
4370                 else
4371                     Perl_croak(aTHX_ "panic: yylex, *s=%u", *s);
4372                 PL_bufptr = s + 1;
4373             }
4374             force_next(FUNC);
4375             if (PL_lex_starts) {
4376                 s = PL_bufptr;
4377                 PL_lex_starts = 0;
4378                 /* commas only at base level: /$a\Ub$c/ => ($a,uc(b.$c)) */
4379                 if (PL_lex_casemods == 1 && PL_lex_inpat)
4380                     OPERATOR(',');
4381                 else
4382                     Aop(OP_CONCAT);
4383             }
4384             else
4385                 return yylex();
4386         }
4387
4388     case LEX_INTERPPUSH:
4389         return REPORT(sublex_push());
4390
4391     case LEX_INTERPSTART:
4392         if (PL_bufptr == PL_bufend)
4393             return REPORT(sublex_done());
4394         DEBUG_T({ if(*PL_bufptr != '(') PerlIO_printf(Perl_debug_log,
4395               "### Interpolated variable\n"); });
4396         PL_expect = XTERM;
4397         /* for /@a/, we leave the joining for the regex engine to do
4398          * (unless we're within \Q etc) */
4399         PL_lex_dojoin = (*PL_bufptr == '@'
4400                             && (!PL_lex_inpat || PL_lex_casemods));
4401         PL_lex_state = LEX_INTERPNORMAL;
4402         if (PL_lex_dojoin) {