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