This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
[perl #71748] Bleadperl f0e67a1 breaks CPAN: Template::Plugin::YAML::Encode 0.02
[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|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_ char *pv, STRLEN len, U32 flags)
940 {
941     char *bufptr;
942     PERL_ARGS_ASSERT_LEX_STUFF_PVN;
943     if (flags & ~(LEX_STUFF_UTF8))
944         Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_stuff_pvn");
945     if (UTF) {
946         if (flags & LEX_STUFF_UTF8) {
947             goto plain_copy;
948         } else {
949             STRLEN highhalf = 0;
950             char *p, *e = pv+len;
951             for (p = pv; p != e; p++)
952                 highhalf += !!(((U8)*p) & 0x80);
953             if (!highhalf)
954                 goto plain_copy;
955             lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len+highhalf);
956             bufptr = PL_parser->bufptr;
957             Move(bufptr, bufptr+len+highhalf, PL_parser->bufend+1-bufptr, char);
958             PL_parser->bufend += len+highhalf;
959             for (p = pv; p != e; p++) {
960                 U8 c = (U8)*p;
961                 if (c & 0x80) {
962                     *bufptr++ = (char)(0xc0 | (c >> 6));
963                     *bufptr++ = (char)(0x80 | (c & 0x3f));
964                 } else {
965                     *bufptr++ = (char)c;
966                 }
967             }
968         }
969     } else {
970         if (flags & LEX_STUFF_UTF8) {
971             STRLEN highhalf = 0;
972             char *p, *e = pv+len;
973             for (p = pv; p != e; p++) {
974                 U8 c = (U8)*p;
975                 if (c >= 0xc4) {
976                     Perl_croak(aTHX_ "Lexing code attempted to stuff "
977                                 "non-Latin-1 character into Latin-1 input");
978                 } else if (c >= 0xc2 && p+1 != e &&
979                             (((U8)p[1]) & 0xc0) == 0x80) {
980                     p++;
981                     highhalf++;
982                 } else if (c >= 0x80) {
983                     /* malformed UTF-8 */
984                     ENTER;
985                     SAVESPTR(PL_warnhook);
986                     PL_warnhook = PERL_WARNHOOK_FATAL;
987                     utf8n_to_uvuni((U8*)p, e-p, NULL, 0);
988                     LEAVE;
989                 }
990             }
991             if (!highhalf)
992                 goto plain_copy;
993             lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len-highhalf);
994             bufptr = PL_parser->bufptr;
995             Move(bufptr, bufptr+len-highhalf, PL_parser->bufend+1-bufptr, char);
996             PL_parser->bufend += len-highhalf;
997             for (p = pv; p != e; p++) {
998                 U8 c = (U8)*p;
999                 if (c & 0x80) {
1000                     *bufptr++ = (char)(((c & 0x3) << 6) | (p[1] & 0x3f));
1001                     p++;
1002                 } else {
1003                     *bufptr++ = (char)c;
1004                 }
1005             }
1006         } else {
1007             plain_copy:
1008             lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len);
1009             bufptr = PL_parser->bufptr;
1010             Move(bufptr, bufptr+len, PL_parser->bufend+1-bufptr, char);
1011             PL_parser->bufend += len;
1012             Copy(pv, bufptr, len, char);
1013         }
1014     }
1015 }
1016
1017 /*
1018 =for apidoc Amx|void|lex_stuff_sv|SV *sv|U32 flags
1019
1020 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
1021 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
1022 reallocating the buffer if necessary.  This means that lexing code that
1023 runs later will see the characters as if they had appeared in the input.
1024 It is not recommended to do this as part of normal parsing, and most
1025 uses of this facility run the risk of the inserted characters being
1026 interpreted in an unintended manner.
1027
1028 The string to be inserted is the string value of I<sv>.  The characters
1029 are recoded for the lexer buffer, according to how the buffer is currently
1030 being interpreted (L</lex_bufutf8>).  If a string to be interpreted is
1031 not already a Perl scalar, the L</lex_stuff_pvn> function avoids the
1032 need to construct a scalar.
1033
1034 =cut
1035 */
1036
1037 void
1038 Perl_lex_stuff_sv(pTHX_ SV *sv, U32 flags)
1039 {
1040     char *pv;
1041     STRLEN len;
1042     PERL_ARGS_ASSERT_LEX_STUFF_SV;
1043     if (flags)
1044         Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_stuff_sv");
1045     pv = SvPV(sv, len);
1046     lex_stuff_pvn(pv, len, flags | (SvUTF8(sv) ? LEX_STUFF_UTF8 : 0));
1047 }
1048
1049 /*
1050 =for apidoc Amx|void|lex_unstuff|char *ptr
1051
1052 Discards text about to be lexed, from L</PL_parser-E<gt>bufptr> up to
1053 I<ptr>.  Text following I<ptr> will be moved, and the buffer shortened.
1054 This hides the discarded text from any lexing code that runs later,
1055 as if the text had never appeared.
1056
1057 This is not the normal way to consume lexed text.  For that, use
1058 L</lex_read_to>.
1059
1060 =cut
1061 */
1062
1063 void
1064 Perl_lex_unstuff(pTHX_ char *ptr)
1065 {
1066     char *buf, *bufend;
1067     STRLEN unstuff_len;
1068     PERL_ARGS_ASSERT_LEX_UNSTUFF;
1069     buf = PL_parser->bufptr;
1070     if (ptr < buf)
1071         Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_unstuff");
1072     if (ptr == buf)
1073         return;
1074     bufend = PL_parser->bufend;
1075     if (ptr > bufend)
1076         Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_unstuff");
1077     unstuff_len = ptr - buf;
1078     Move(ptr, buf, bufend+1-ptr, char);
1079     SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) - unstuff_len);
1080     PL_parser->bufend = bufend - unstuff_len;
1081 }
1082
1083 /*
1084 =for apidoc Amx|void|lex_read_to|char *ptr
1085
1086 Consume text in the lexer buffer, from L</PL_parser-E<gt>bufptr> up
1087 to I<ptr>.  This advances L</PL_parser-E<gt>bufptr> to match I<ptr>,
1088 performing the correct bookkeeping whenever a newline character is passed.
1089 This is the normal way to consume lexed text.
1090
1091 Interpretation of the buffer's octets can be abstracted out by
1092 using the slightly higher-level functions L</lex_peek_unichar> and
1093 L</lex_read_unichar>.
1094
1095 =cut
1096 */
1097
1098 void
1099 Perl_lex_read_to(pTHX_ char *ptr)
1100 {
1101     char *s;
1102     PERL_ARGS_ASSERT_LEX_READ_TO;
1103     s = PL_parser->bufptr;
1104     if (ptr < s || ptr > PL_parser->bufend)
1105         Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_to");
1106     for (; s != ptr; s++)
1107         if (*s == '\n') {
1108             CopLINE_inc(PL_curcop);
1109             PL_parser->linestart = s+1;
1110         }
1111     PL_parser->bufptr = ptr;
1112 }
1113
1114 /*
1115 =for apidoc Amx|void|lex_discard_to|char *ptr
1116
1117 Discards the first part of the L</PL_parser-E<gt>linestr> buffer,
1118 up to I<ptr>.  The remaining content of the buffer will be moved, and
1119 all pointers into the buffer updated appropriately.  I<ptr> must not
1120 be later in the buffer than the position of L</PL_parser-E<gt>bufptr>:
1121 it is not permitted to discard text that has yet to be lexed.
1122
1123 Normally it is not necessarily to do this directly, because it suffices to
1124 use the implicit discarding behaviour of L</lex_next_chunk> and things
1125 based on it.  However, if a token stretches across multiple lines,
1126 and the lexing code has kept multiple lines of text in the buffer fof
1127 that purpose, then after completion of the token it would be wise to
1128 explicitly discard the now-unneeded earlier lines, to avoid future
1129 multi-line tokens growing the buffer without bound.
1130
1131 =cut
1132 */
1133
1134 void
1135 Perl_lex_discard_to(pTHX_ char *ptr)
1136 {
1137     char *buf;
1138     STRLEN discard_len;
1139     PERL_ARGS_ASSERT_LEX_DISCARD_TO;
1140     buf = SvPVX(PL_parser->linestr);
1141     if (ptr < buf)
1142         Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_discard_to");
1143     if (ptr == buf)
1144         return;
1145     if (ptr > PL_parser->bufptr)
1146         Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_discard_to");
1147     discard_len = ptr - buf;
1148     if (PL_parser->oldbufptr < ptr)
1149         PL_parser->oldbufptr = ptr;
1150     if (PL_parser->oldoldbufptr < ptr)
1151         PL_parser->oldoldbufptr = ptr;
1152     if (PL_parser->last_uni && PL_parser->last_uni < ptr)
1153         PL_parser->last_uni = NULL;
1154     if (PL_parser->last_lop && PL_parser->last_lop < ptr)
1155         PL_parser->last_lop = NULL;
1156     Move(ptr, buf, PL_parser->bufend+1-ptr, char);
1157     SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) - discard_len);
1158     PL_parser->bufend -= discard_len;
1159     PL_parser->bufptr -= discard_len;
1160     PL_parser->oldbufptr -= discard_len;
1161     PL_parser->oldoldbufptr -= discard_len;
1162     if (PL_parser->last_uni)
1163         PL_parser->last_uni -= discard_len;
1164     if (PL_parser->last_lop)
1165         PL_parser->last_lop -= discard_len;
1166 }
1167
1168 /*
1169 =for apidoc Amx|bool|lex_next_chunk|U32 flags
1170
1171 Reads in the next chunk of text to be lexed, appending it to
1172 L</PL_parser-E<gt>linestr>.  This should be called when lexing code has
1173 looked to the end of the current chunk and wants to know more.  It is
1174 usual, but not necessary, for lexing to have consumed the entirety of
1175 the current chunk at this time.
1176
1177 If L</PL_parser-E<gt>bufptr> is pointing to the very end of the current
1178 chunk (i.e., the current chunk has been entirely consumed), normally the
1179 current chunk will be discarded at the same time that the new chunk is
1180 read in.  If I<flags> includes C<LEX_KEEP_PREVIOUS>, the current chunk
1181 will not be discarded.  If the current chunk has not been entirely
1182 consumed, then it will not be discarded regardless of the flag.
1183
1184 Returns true if some new text was added to the buffer, or false if the
1185 buffer has reached the end of the input text.
1186
1187 =cut
1188 */
1189
1190 #define LEX_FAKE_EOF 0x80000000
1191
1192 bool
1193 Perl_lex_next_chunk(pTHX_ U32 flags)
1194 {
1195     SV *linestr;
1196     char *buf;
1197     STRLEN old_bufend_pos, new_bufend_pos;
1198     STRLEN bufptr_pos, oldbufptr_pos, oldoldbufptr_pos;
1199     STRLEN linestart_pos, last_uni_pos, last_lop_pos;
1200     bool got_some_for_debugger = 0;
1201     bool got_some;
1202     if (flags & ~(LEX_KEEP_PREVIOUS|LEX_FAKE_EOF))
1203         Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_next_chunk");
1204     linestr = PL_parser->linestr;
1205     buf = SvPVX(linestr);
1206     if (!(flags & LEX_KEEP_PREVIOUS) &&
1207             PL_parser->bufptr == PL_parser->bufend) {
1208         old_bufend_pos = bufptr_pos = oldbufptr_pos = oldoldbufptr_pos = 0;
1209         linestart_pos = 0;
1210         if (PL_parser->last_uni != PL_parser->bufend)
1211             PL_parser->last_uni = NULL;
1212         if (PL_parser->last_lop != PL_parser->bufend)
1213             PL_parser->last_lop = NULL;
1214         last_uni_pos = last_lop_pos = 0;
1215         *buf = 0;
1216         SvCUR(linestr) = 0;
1217     } else {
1218         old_bufend_pos = PL_parser->bufend - buf;
1219         bufptr_pos = PL_parser->bufptr - buf;
1220         oldbufptr_pos = PL_parser->oldbufptr - buf;
1221         oldoldbufptr_pos = PL_parser->oldoldbufptr - buf;
1222         linestart_pos = PL_parser->linestart - buf;
1223         last_uni_pos = PL_parser->last_uni ? PL_parser->last_uni - buf : 0;
1224         last_lop_pos = PL_parser->last_lop ? PL_parser->last_lop - buf : 0;
1225     }
1226     if (flags & LEX_FAKE_EOF) {
1227         goto eof;
1228     } else if (!PL_parser->rsfp) {
1229         got_some = 0;
1230     } else if (filter_gets(linestr, old_bufend_pos)) {
1231         got_some = 1;
1232         got_some_for_debugger = 1;
1233     } else {
1234         if (!SvPOK(linestr))   /* can get undefined by filter_gets */
1235             sv_setpvs(linestr, "");
1236         eof:
1237         /* End of real input.  Close filehandle (unless it was STDIN),
1238          * then add implicit termination.
1239          */
1240         if ((PerlIO*)PL_parser->rsfp == PerlIO_stdin())
1241             PerlIO_clearerr(PL_parser->rsfp);
1242         else if (PL_parser->rsfp)
1243             (void)PerlIO_close(PL_parser->rsfp);
1244         PL_parser->rsfp = NULL;
1245         PL_doextract = FALSE;
1246 #ifdef PERL_MAD
1247         if (PL_madskills && !PL_in_eval && (PL_minus_p || PL_minus_n))
1248             PL_faketokens = 1;
1249 #endif
1250         if (!PL_in_eval && PL_minus_p) {
1251             sv_catpvs(linestr,
1252                 /*{*/";}continue{print or die qq(-p destination: $!\\n);}");
1253             PL_minus_n = PL_minus_p = 0;
1254         } else if (!PL_in_eval && PL_minus_n) {
1255             sv_catpvs(linestr, /*{*/";}");
1256             PL_minus_n = 0;
1257         } else
1258             sv_catpvs(linestr, ";");
1259         got_some = 1;
1260     }
1261     buf = SvPVX(linestr);
1262     new_bufend_pos = SvCUR(linestr);
1263     PL_parser->bufend = buf + new_bufend_pos;
1264     PL_parser->bufptr = buf + bufptr_pos;
1265     PL_parser->oldbufptr = buf + oldbufptr_pos;
1266     PL_parser->oldoldbufptr = buf + oldoldbufptr_pos;
1267     PL_parser->linestart = buf + linestart_pos;
1268     if (PL_parser->last_uni)
1269         PL_parser->last_uni = buf + last_uni_pos;
1270     if (PL_parser->last_lop)
1271         PL_parser->last_lop = buf + last_lop_pos;
1272     if (got_some_for_debugger && (PERLDB_LINE || PERLDB_SAVESRC) &&
1273             PL_curstash != PL_debstash) {
1274         /* debugger active and we're not compiling the debugger code,
1275          * so store the line into the debugger's array of lines
1276          */
1277         update_debugger_info(NULL, buf+old_bufend_pos,
1278             new_bufend_pos-old_bufend_pos);
1279     }
1280     return got_some;
1281 }
1282
1283 /*
1284 =for apidoc Amx|I32|lex_peek_unichar|U32 flags
1285
1286 Looks ahead one (Unicode) character in the text currently being lexed.
1287 Returns the codepoint (unsigned integer value) of the next character,
1288 or -1 if lexing has reached the end of the input text.  To consume the
1289 peeked character, use L</lex_read_unichar>.
1290
1291 If the next character is in (or extends into) the next chunk of input
1292 text, the next chunk will be read in.  Normally the current chunk will be
1293 discarded at the same time, but if I<flags> includes C<LEX_KEEP_PREVIOUS>
1294 then the current chunk will not be discarded.
1295
1296 If the input is being interpreted as UTF-8 and a UTF-8 encoding error
1297 is encountered, an exception is generated.
1298
1299 =cut
1300 */
1301
1302 I32
1303 Perl_lex_peek_unichar(pTHX_ U32 flags)
1304 {
1305     char *s, *bufend;
1306     if (flags & ~(LEX_KEEP_PREVIOUS))
1307         Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_peek_unichar");
1308     s = PL_parser->bufptr;
1309     bufend = PL_parser->bufend;
1310     if (UTF) {
1311         U8 head;
1312         I32 unichar;
1313         STRLEN len, retlen;
1314         if (s == bufend) {
1315             if (!lex_next_chunk(flags))
1316                 return -1;
1317             s = PL_parser->bufptr;
1318             bufend = PL_parser->bufend;
1319         }
1320         head = (U8)*s;
1321         if (!(head & 0x80))
1322             return head;
1323         if (head & 0x40) {
1324             len = PL_utf8skip[head];
1325             while ((STRLEN)(bufend-s) < len) {
1326                 if (!lex_next_chunk(flags | LEX_KEEP_PREVIOUS))
1327                     break;
1328                 s = PL_parser->bufptr;
1329                 bufend = PL_parser->bufend;
1330             }
1331         }
1332         unichar = utf8n_to_uvuni((U8*)s, bufend-s, &retlen, UTF8_CHECK_ONLY);
1333         if (retlen == (STRLEN)-1) {
1334             /* malformed UTF-8 */
1335             ENTER;
1336             SAVESPTR(PL_warnhook);
1337             PL_warnhook = PERL_WARNHOOK_FATAL;
1338             utf8n_to_uvuni((U8*)s, bufend-s, NULL, 0);
1339             LEAVE;
1340         }
1341         return unichar;
1342     } else {
1343         if (s == bufend) {
1344             if (!lex_next_chunk(flags))
1345                 return -1;
1346             s = PL_parser->bufptr;
1347         }
1348         return (U8)*s;
1349     }
1350 }
1351
1352 /*
1353 =for apidoc Amx|I32|lex_read_unichar|U32 flags
1354
1355 Reads the next (Unicode) character in the text currently being lexed.
1356 Returns the codepoint (unsigned integer value) of the character read,
1357 and moves L</PL_parser-E<gt>bufptr> past the character, or returns -1
1358 if lexing has reached the end of the input text.  To non-destructively
1359 examine the next character, use L</lex_peek_unichar> instead.
1360
1361 If the next character is in (or extends into) the next chunk of input
1362 text, the next chunk will be read in.  Normally the current chunk will be
1363 discarded at the same time, but if I<flags> includes C<LEX_KEEP_PREVIOUS>
1364 then the current chunk will not be discarded.
1365
1366 If the input is being interpreted as UTF-8 and a UTF-8 encoding error
1367 is encountered, an exception is generated.
1368
1369 =cut
1370 */
1371
1372 I32
1373 Perl_lex_read_unichar(pTHX_ U32 flags)
1374 {
1375     I32 c;
1376     if (flags & ~(LEX_KEEP_PREVIOUS))
1377         Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_unichar");
1378     c = lex_peek_unichar(flags);
1379     if (c != -1) {
1380         if (c == '\n')
1381             CopLINE_inc(PL_curcop);
1382         PL_parser->bufptr += UTF8SKIP(PL_parser->bufptr);
1383     }
1384     return c;
1385 }
1386
1387 /*
1388 =for apidoc Amx|void|lex_read_space|U32 flags
1389
1390 Reads optional spaces, in Perl style, in the text currently being
1391 lexed.  The spaces may include ordinary whitespace characters and
1392 Perl-style comments.  C<#line> directives are processed if encountered.
1393 L</PL_parser-E<gt>bufptr> is moved past the spaces, so that it points
1394 at a non-space character (or the end of the input text).
1395
1396 If spaces extend into the next chunk of input text, the next chunk will
1397 be read in.  Normally the current chunk will be discarded at the same
1398 time, but if I<flags> includes C<LEX_KEEP_PREVIOUS> then the current
1399 chunk will not be discarded.
1400
1401 =cut
1402 */
1403
1404 #define LEX_NO_NEXT_CHUNK 0x80000000
1405
1406 void
1407 Perl_lex_read_space(pTHX_ U32 flags)
1408 {
1409     char *s, *bufend;
1410     bool need_incline = 0;
1411     if (flags & ~(LEX_KEEP_PREVIOUS|LEX_NO_NEXT_CHUNK))
1412         Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_space");
1413 #ifdef PERL_MAD
1414     if (PL_skipwhite) {
1415         sv_free(PL_skipwhite);
1416         PL_skipwhite = NULL;
1417     }
1418     if (PL_madskills)
1419         PL_skipwhite = newSVpvs("");
1420 #endif /* PERL_MAD */
1421     s = PL_parser->bufptr;
1422     bufend = PL_parser->bufend;
1423     while (1) {
1424         char c = *s;
1425         if (c == '#') {
1426             do {
1427                 c = *++s;
1428             } while (!(c == '\n' || (c == 0 && s == bufend)));
1429         } else if (c == '\n') {
1430             s++;
1431             PL_parser->linestart = s;
1432             if (s == bufend)
1433                 need_incline = 1;
1434             else
1435                 incline(s);
1436         } else if (isSPACE(c)) {
1437             s++;
1438         } else if (c == 0 && s == bufend) {
1439             bool got_more;
1440 #ifdef PERL_MAD
1441             if (PL_madskills)
1442                 sv_catpvn(PL_skipwhite, PL_parser->bufptr, s-PL_parser->bufptr);
1443 #endif /* PERL_MAD */
1444             if (flags & LEX_NO_NEXT_CHUNK)
1445                 break;
1446             PL_parser->bufptr = s;
1447             CopLINE_inc(PL_curcop);
1448             got_more = lex_next_chunk(flags);
1449             CopLINE_dec(PL_curcop);
1450             s = PL_parser->bufptr;
1451             bufend = PL_parser->bufend;
1452             if (!got_more)
1453                 break;
1454             if (need_incline && PL_parser->rsfp) {
1455                 incline(s);
1456                 need_incline = 0;
1457             }
1458         } else {
1459             break;
1460         }
1461     }
1462 #ifdef PERL_MAD
1463     if (PL_madskills)
1464         sv_catpvn(PL_skipwhite, PL_parser->bufptr, s-PL_parser->bufptr);
1465 #endif /* PERL_MAD */
1466     PL_parser->bufptr = s;
1467 }
1468
1469 /*
1470  * S_incline
1471  * This subroutine has nothing to do with tilting, whether at windmills
1472  * or pinball tables.  Its name is short for "increment line".  It
1473  * increments the current line number in CopLINE(PL_curcop) and checks
1474  * to see whether the line starts with a comment of the form
1475  *    # line 500 "foo.pm"
1476  * If so, it sets the current line number and file to the values in the comment.
1477  */
1478
1479 STATIC void
1480 S_incline(pTHX_ const char *s)
1481 {
1482     dVAR;
1483     const char *t;
1484     const char *n;
1485     const char *e;
1486
1487     PERL_ARGS_ASSERT_INCLINE;
1488
1489     CopLINE_inc(PL_curcop);
1490     if (*s++ != '#')
1491         return;
1492     while (SPACE_OR_TAB(*s))
1493         s++;
1494     if (strnEQ(s, "line", 4))
1495         s += 4;
1496     else
1497         return;
1498     if (SPACE_OR_TAB(*s))
1499         s++;
1500     else
1501         return;
1502     while (SPACE_OR_TAB(*s))
1503         s++;
1504     if (!isDIGIT(*s))
1505         return;
1506
1507     n = s;
1508     while (isDIGIT(*s))
1509         s++;
1510     if (!SPACE_OR_TAB(*s) && *s != '\r' && *s != '\n' && *s != '\0')
1511         return;
1512     while (SPACE_OR_TAB(*s))
1513         s++;
1514     if (*s == '"' && (t = strchr(s+1, '"'))) {
1515         s++;
1516         e = t + 1;
1517     }
1518     else {
1519         t = s;
1520         while (!isSPACE(*t))
1521             t++;
1522         e = t;
1523     }
1524     while (SPACE_OR_TAB(*e) || *e == '\r' || *e == '\f')
1525         e++;
1526     if (*e != '\n' && *e != '\0')
1527         return;         /* false alarm */
1528
1529     if (t - s > 0) {
1530         const STRLEN len = t - s;
1531 #ifndef USE_ITHREADS
1532         SV *const temp_sv = CopFILESV(PL_curcop);
1533         const char *cf;
1534         STRLEN tmplen;
1535
1536         if (temp_sv) {
1537             cf = SvPVX(temp_sv);
1538             tmplen = SvCUR(temp_sv);
1539         } else {
1540             cf = NULL;
1541             tmplen = 0;
1542         }
1543
1544         if (tmplen > 7 && strnEQ(cf, "(eval ", 6)) {
1545             /* must copy *{"::_<(eval N)[oldfilename:L]"}
1546              * to *{"::_<newfilename"} */
1547             /* However, the long form of evals is only turned on by the
1548                debugger - usually they're "(eval %lu)" */
1549             char smallbuf[128];
1550             char *tmpbuf;
1551             GV **gvp;
1552             STRLEN tmplen2 = len;
1553             if (tmplen + 2 <= sizeof smallbuf)
1554                 tmpbuf = smallbuf;
1555             else
1556                 Newx(tmpbuf, tmplen + 2, char);
1557             tmpbuf[0] = '_';
1558             tmpbuf[1] = '<';
1559             memcpy(tmpbuf + 2, cf, tmplen);
1560             tmplen += 2;
1561             gvp = (GV**)hv_fetch(PL_defstash, tmpbuf, tmplen, FALSE);
1562             if (gvp) {
1563                 char *tmpbuf2;
1564                 GV *gv2;
1565
1566                 if (tmplen2 + 2 <= sizeof smallbuf)
1567                     tmpbuf2 = smallbuf;
1568                 else
1569                     Newx(tmpbuf2, tmplen2 + 2, char);
1570
1571                 if (tmpbuf2 != smallbuf || tmpbuf != smallbuf) {
1572                     /* Either they malloc'd it, or we malloc'd it,
1573                        so no prefix is present in ours.  */
1574                     tmpbuf2[0] = '_';
1575                     tmpbuf2[1] = '<';
1576                 }
1577
1578                 memcpy(tmpbuf2 + 2, s, tmplen2);
1579                 tmplen2 += 2;
1580
1581                 gv2 = *(GV**)hv_fetch(PL_defstash, tmpbuf2, tmplen2, TRUE);
1582                 if (!isGV(gv2)) {
1583                     gv_init(gv2, PL_defstash, tmpbuf2, tmplen2, FALSE);
1584                     /* adjust ${"::_<newfilename"} to store the new file name */
1585                     GvSV(gv2) = newSVpvn(tmpbuf2 + 2, tmplen2 - 2);
1586                     GvHV(gv2) = MUTABLE_HV(SvREFCNT_inc(GvHV(*gvp)));
1587                     GvAV(gv2) = MUTABLE_AV(SvREFCNT_inc(GvAV(*gvp)));
1588                 }
1589
1590                 if (tmpbuf2 != smallbuf) Safefree(tmpbuf2);
1591             }
1592             if (tmpbuf != smallbuf) Safefree(tmpbuf);
1593         }
1594 #endif
1595         CopFILE_free(PL_curcop);
1596         CopFILE_setn(PL_curcop, s, len);
1597     }
1598     CopLINE_set(PL_curcop, atoi(n)-1);
1599 }
1600
1601 #ifdef PERL_MAD
1602 /* skip space before PL_thistoken */
1603
1604 STATIC char *
1605 S_skipspace0(pTHX_ register char *s)
1606 {
1607     PERL_ARGS_ASSERT_SKIPSPACE0;
1608
1609     s = skipspace(s);
1610     if (!PL_madskills)
1611         return s;
1612     if (PL_skipwhite) {
1613         if (!PL_thiswhite)
1614             PL_thiswhite = newSVpvs("");
1615         sv_catsv(PL_thiswhite, PL_skipwhite);
1616         sv_free(PL_skipwhite);
1617         PL_skipwhite = 0;
1618     }
1619     PL_realtokenstart = s - SvPVX(PL_linestr);
1620     return s;
1621 }
1622
1623 /* skip space after PL_thistoken */
1624
1625 STATIC char *
1626 S_skipspace1(pTHX_ register char *s)
1627 {
1628     const char *start = s;
1629     I32 startoff = start - SvPVX(PL_linestr);
1630
1631     PERL_ARGS_ASSERT_SKIPSPACE1;
1632
1633     s = skipspace(s);
1634     if (!PL_madskills)
1635         return s;
1636     start = SvPVX(PL_linestr) + startoff;
1637     if (!PL_thistoken && PL_realtokenstart >= 0) {
1638         const char * const tstart = SvPVX(PL_linestr) + PL_realtokenstart;
1639         PL_thistoken = newSVpvn(tstart, start - tstart);
1640     }
1641     PL_realtokenstart = -1;
1642     if (PL_skipwhite) {
1643         if (!PL_nextwhite)
1644             PL_nextwhite = newSVpvs("");
1645         sv_catsv(PL_nextwhite, PL_skipwhite);
1646         sv_free(PL_skipwhite);
1647         PL_skipwhite = 0;
1648     }
1649     return s;
1650 }
1651
1652 STATIC char *
1653 S_skipspace2(pTHX_ register char *s, SV **svp)
1654 {
1655     char *start;
1656     const I32 bufptroff = PL_bufptr - SvPVX(PL_linestr);
1657     const I32 startoff = s - SvPVX(PL_linestr);
1658
1659     PERL_ARGS_ASSERT_SKIPSPACE2;
1660
1661     s = skipspace(s);
1662     PL_bufptr = SvPVX(PL_linestr) + bufptroff;
1663     if (!PL_madskills || !svp)
1664         return s;
1665     start = SvPVX(PL_linestr) + startoff;
1666     if (!PL_thistoken && PL_realtokenstart >= 0) {
1667         char * const tstart = SvPVX(PL_linestr) + PL_realtokenstart;
1668         PL_thistoken = newSVpvn(tstart, start - tstart);
1669         PL_realtokenstart = -1;
1670     }
1671     if (PL_skipwhite) {
1672         if (!*svp)
1673             *svp = newSVpvs("");
1674         sv_setsv(*svp, PL_skipwhite);
1675         sv_free(PL_skipwhite);
1676         PL_skipwhite = 0;
1677     }
1678     
1679     return s;
1680 }
1681 #endif
1682
1683 STATIC void
1684 S_update_debugger_info(pTHX_ SV *orig_sv, const char *const buf, STRLEN len)
1685 {
1686     AV *av = CopFILEAVx(PL_curcop);
1687     if (av) {
1688         SV * const sv = newSV_type(SVt_PVMG);
1689         if (orig_sv)
1690             sv_setsv(sv, orig_sv);
1691         else
1692             sv_setpvn(sv, buf, len);
1693         (void)SvIOK_on(sv);
1694         SvIV_set(sv, 0);
1695         av_store(av, (I32)CopLINE(PL_curcop), sv);
1696     }
1697 }
1698
1699 /*
1700  * S_skipspace
1701  * Called to gobble the appropriate amount and type of whitespace.
1702  * Skips comments as well.
1703  */
1704
1705 STATIC char *
1706 S_skipspace(pTHX_ register char *s)
1707 {
1708 #ifdef PERL_MAD
1709     char *start = s;
1710 #endif /* PERL_MAD */
1711     PERL_ARGS_ASSERT_SKIPSPACE;
1712 #ifdef PERL_MAD
1713     if (PL_skipwhite) {
1714         sv_free(PL_skipwhite);
1715         PL_skipwhite = NULL;
1716     }
1717 #endif /* PERL_MAD */
1718     if (PL_lex_formbrack && PL_lex_brackets <= PL_lex_formbrack) {
1719         while (s < PL_bufend && SPACE_OR_TAB(*s))
1720             s++;
1721     } else {
1722         STRLEN bufptr_pos = PL_bufptr - SvPVX(PL_linestr);
1723         PL_bufptr = s;
1724         lex_read_space(LEX_KEEP_PREVIOUS |
1725                 (PL_sublex_info.sub_inwhat || PL_lex_state == LEX_FORMLINE ?
1726                     LEX_NO_NEXT_CHUNK : 0));
1727         s = PL_bufptr;
1728         PL_bufptr = SvPVX(PL_linestr) + bufptr_pos;
1729         if (PL_linestart > PL_bufptr)
1730             PL_bufptr = PL_linestart;
1731         return s;
1732     }
1733 #ifdef PERL_MAD
1734     if (PL_madskills)
1735         PL_skipwhite = newSVpvn(start, s-start);
1736 #endif /* PERL_MAD */
1737     return s;
1738 }
1739
1740 /*
1741  * S_check_uni
1742  * Check the unary operators to ensure there's no ambiguity in how they're
1743  * used.  An ambiguous piece of code would be:
1744  *     rand + 5
1745  * This doesn't mean rand() + 5.  Because rand() is a unary operator,
1746  * the +5 is its argument.
1747  */
1748
1749 STATIC void
1750 S_check_uni(pTHX)
1751 {
1752     dVAR;
1753     const char *s;
1754     const char *t;
1755
1756     if (PL_oldoldbufptr != PL_last_uni)
1757         return;
1758     while (isSPACE(*PL_last_uni))
1759         PL_last_uni++;
1760     s = PL_last_uni;
1761     while (isALNUM_lazy_if(s,UTF) || *s == '-')
1762         s++;
1763     if ((t = strchr(s, '(')) && t < PL_bufptr)
1764         return;
1765
1766     Perl_ck_warner_d(aTHX_ packWARN(WARN_AMBIGUOUS),
1767                      "Warning: Use of \"%.*s\" without parentheses is ambiguous",
1768                      (int)(s - PL_last_uni), PL_last_uni);
1769 }
1770
1771 /*
1772  * LOP : macro to build a list operator.  Its behaviour has been replaced
1773  * with a subroutine, S_lop() for which LOP is just another name.
1774  */
1775
1776 #define LOP(f,x) return lop(f,x,s)
1777
1778 /*
1779  * S_lop
1780  * Build a list operator (or something that might be one).  The rules:
1781  *  - if we have a next token, then it's a list operator [why?]
1782  *  - if the next thing is an opening paren, then it's a function
1783  *  - else it's a list operator
1784  */
1785
1786 STATIC I32
1787 S_lop(pTHX_ I32 f, int x, char *s)
1788 {
1789     dVAR;
1790
1791     PERL_ARGS_ASSERT_LOP;
1792
1793     pl_yylval.ival = f;
1794     CLINE;
1795     PL_expect = x;
1796     PL_bufptr = s;
1797     PL_last_lop = PL_oldbufptr;
1798     PL_last_lop_op = (OPCODE)f;
1799 #ifdef PERL_MAD
1800     if (PL_lasttoke)
1801         return REPORT(LSTOP);
1802 #else
1803     if (PL_nexttoke)
1804         return REPORT(LSTOP);
1805 #endif
1806     if (*s == '(')
1807         return REPORT(FUNC);
1808     s = PEEKSPACE(s);
1809     if (*s == '(')
1810         return REPORT(FUNC);
1811     else
1812         return REPORT(LSTOP);
1813 }
1814
1815 #ifdef PERL_MAD
1816  /*
1817  * S_start_force
1818  * Sets up for an eventual force_next().  start_force(0) basically does
1819  * an unshift, while start_force(-1) does a push.  yylex removes items
1820  * on the "pop" end.
1821  */
1822
1823 STATIC void
1824 S_start_force(pTHX_ int where)
1825 {
1826     int i;
1827
1828     if (where < 0)      /* so people can duplicate start_force(PL_curforce) */
1829         where = PL_lasttoke;
1830     assert(PL_curforce < 0 || PL_curforce == where);
1831     if (PL_curforce != where) {
1832         for (i = PL_lasttoke; i > where; --i) {
1833             PL_nexttoke[i] = PL_nexttoke[i-1];
1834         }
1835         PL_lasttoke++;
1836     }
1837     if (PL_curforce < 0)        /* in case of duplicate start_force() */
1838         Zero(&PL_nexttoke[where], 1, NEXTTOKE);
1839     PL_curforce = where;
1840     if (PL_nextwhite) {
1841         if (PL_madskills)
1842             curmad('^', newSVpvs(""));
1843         CURMAD('_', PL_nextwhite);
1844     }
1845 }
1846
1847 STATIC void
1848 S_curmad(pTHX_ char slot, SV *sv)
1849 {
1850     MADPROP **where;
1851
1852     if (!sv)
1853         return;
1854     if (PL_curforce < 0)
1855         where = &PL_thismad;
1856     else
1857         where = &PL_nexttoke[PL_curforce].next_mad;
1858
1859     if (PL_faketokens)
1860         sv_setpvs(sv, "");
1861     else {
1862         if (!IN_BYTES) {
1863             if (UTF && is_utf8_string((U8*)SvPVX(sv), SvCUR(sv)))
1864                 SvUTF8_on(sv);
1865             else if (PL_encoding) {
1866                 sv_recode_to_utf8(sv, PL_encoding);
1867             }
1868         }
1869     }
1870
1871     /* keep a slot open for the head of the list? */
1872     if (slot != '_' && *where && (*where)->mad_key == '^') {
1873         (*where)->mad_key = slot;
1874         sv_free(MUTABLE_SV(((*where)->mad_val)));
1875         (*where)->mad_val = (void*)sv;
1876     }
1877     else
1878         addmad(newMADsv(slot, sv), where, 0);
1879 }
1880 #else
1881 #  define start_force(where)    NOOP
1882 #  define curmad(slot, sv)      NOOP
1883 #endif
1884
1885 /*
1886  * S_force_next
1887  * When the lexer realizes it knows the next token (for instance,
1888  * it is reordering tokens for the parser) then it can call S_force_next
1889  * to know what token to return the next time the lexer is called.  Caller
1890  * will need to set PL_nextval[] (or PL_nexttoke[].next_val with PERL_MAD),
1891  * and possibly PL_expect to ensure the lexer handles the token correctly.
1892  */
1893
1894 STATIC void
1895 S_force_next(pTHX_ I32 type)
1896 {
1897     dVAR;
1898 #ifdef DEBUGGING
1899     if (DEBUG_T_TEST) {
1900         PerlIO_printf(Perl_debug_log, "### forced token:\n");
1901         tokereport(type, &NEXTVAL_NEXTTOKE);
1902     }
1903 #endif
1904 #ifdef PERL_MAD
1905     if (PL_curforce < 0)
1906         start_force(PL_lasttoke);
1907     PL_nexttoke[PL_curforce].next_type = type;
1908     if (PL_lex_state != LEX_KNOWNEXT)
1909         PL_lex_defer = PL_lex_state;
1910     PL_lex_state = LEX_KNOWNEXT;
1911     PL_lex_expect = PL_expect;
1912     PL_curforce = -1;
1913 #else
1914     PL_nexttype[PL_nexttoke] = type;
1915     PL_nexttoke++;
1916     if (PL_lex_state != LEX_KNOWNEXT) {
1917         PL_lex_defer = PL_lex_state;
1918         PL_lex_expect = PL_expect;
1919         PL_lex_state = LEX_KNOWNEXT;
1920     }
1921 #endif
1922 }
1923
1924 STATIC SV *
1925 S_newSV_maybe_utf8(pTHX_ const char *const start, STRLEN len)
1926 {
1927     dVAR;
1928     SV * const sv = newSVpvn_utf8(start, len,
1929                                   !IN_BYTES
1930                                   && UTF
1931                                   && !is_ascii_string((const U8*)start, len)
1932                                   && is_utf8_string((const U8*)start, len));
1933     return sv;
1934 }
1935
1936 /*
1937  * S_force_word
1938  * When the lexer knows the next thing is a word (for instance, it has
1939  * just seen -> and it knows that the next char is a word char, then
1940  * it calls S_force_word to stick the next word into the PL_nexttoke/val
1941  * lookahead.
1942  *
1943  * Arguments:
1944  *   char *start : buffer position (must be within PL_linestr)
1945  *   int token   : PL_next* will be this type of bare word (e.g., METHOD,WORD)
1946  *   int check_keyword : if true, Perl checks to make sure the word isn't
1947  *       a keyword (do this if the word is a label, e.g. goto FOO)
1948  *   int allow_pack : if true, : characters will also be allowed (require,
1949  *       use, etc. do this)
1950  *   int allow_initial_tick : used by the "sub" lexer only.
1951  */
1952
1953 STATIC char *
1954 S_force_word(pTHX_ register char *start, int token, int check_keyword, int allow_pack, int allow_initial_tick)
1955 {
1956     dVAR;
1957     register char *s;
1958     STRLEN len;
1959
1960     PERL_ARGS_ASSERT_FORCE_WORD;
1961
1962     start = SKIPSPACE1(start);
1963     s = start;
1964     if (isIDFIRST_lazy_if(s,UTF) ||
1965         (allow_pack && *s == ':') ||
1966         (allow_initial_tick && *s == '\'') )
1967     {
1968         s = scan_word(s, PL_tokenbuf, sizeof PL_tokenbuf, allow_pack, &len);
1969         if (check_keyword && keyword(PL_tokenbuf, len, 0))
1970             return start;
1971         start_force(PL_curforce);
1972         if (PL_madskills)
1973             curmad('X', newSVpvn(start,s-start));
1974         if (token == METHOD) {
1975             s = SKIPSPACE1(s);
1976             if (*s == '(')
1977                 PL_expect = XTERM;
1978             else {
1979                 PL_expect = XOPERATOR;
1980             }
1981         }
1982         if (PL_madskills)
1983             curmad('g', newSVpvs( "forced" ));
1984         NEXTVAL_NEXTTOKE.opval
1985             = (OP*)newSVOP(OP_CONST,0,
1986                            S_newSV_maybe_utf8(aTHX_ PL_tokenbuf, len));
1987         NEXTVAL_NEXTTOKE.opval->op_private |= OPpCONST_BARE;
1988         force_next(token);
1989     }
1990     return s;
1991 }
1992
1993 /*
1994  * S_force_ident
1995  * Called when the lexer wants $foo *foo &foo etc, but the program
1996  * text only contains the "foo" portion.  The first argument is a pointer
1997  * to the "foo", and the second argument is the type symbol to prefix.
1998  * Forces the next token to be a "WORD".
1999  * Creates the symbol if it didn't already exist (via gv_fetchpv()).
2000  */
2001
2002 STATIC void
2003 S_force_ident(pTHX_ register const char *s, int kind)
2004 {
2005     dVAR;
2006
2007     PERL_ARGS_ASSERT_FORCE_IDENT;
2008
2009     if (*s) {
2010         const STRLEN len = strlen(s);
2011         OP* const o = (OP*)newSVOP(OP_CONST, 0, newSVpvn(s, len));
2012         start_force(PL_curforce);
2013         NEXTVAL_NEXTTOKE.opval = o;
2014         force_next(WORD);
2015         if (kind) {
2016             o->op_private = OPpCONST_ENTERED;
2017             /* XXX see note in pp_entereval() for why we forgo typo
2018                warnings if the symbol must be introduced in an eval.
2019                GSAR 96-10-12 */
2020             gv_fetchpvn_flags(s, len,
2021                               PL_in_eval ? (GV_ADDMULTI | GV_ADDINEVAL)
2022                               : GV_ADD,
2023                               kind == '$' ? SVt_PV :
2024                               kind == '@' ? SVt_PVAV :
2025                               kind == '%' ? SVt_PVHV :
2026                               SVt_PVGV
2027                               );
2028         }
2029     }
2030 }
2031
2032 NV
2033 Perl_str_to_version(pTHX_ SV *sv)
2034 {
2035     NV retval = 0.0;
2036     NV nshift = 1.0;
2037     STRLEN len;
2038     const char *start = SvPV_const(sv,len);
2039     const char * const end = start + len;
2040     const bool utf = SvUTF8(sv) ? TRUE : FALSE;
2041
2042     PERL_ARGS_ASSERT_STR_TO_VERSION;
2043
2044     while (start < end) {
2045         STRLEN skip;
2046         UV n;
2047         if (utf)
2048             n = utf8n_to_uvchr((U8*)start, len, &skip, 0);
2049         else {
2050             n = *(U8*)start;
2051             skip = 1;
2052         }
2053         retval += ((NV)n)/nshift;
2054         start += skip;
2055         nshift *= 1000;
2056     }
2057     return retval;
2058 }
2059
2060 /*
2061  * S_force_version
2062  * Forces the next token to be a version number.
2063  * If the next token appears to be an invalid version number, (e.g. "v2b"),
2064  * and if "guessing" is TRUE, then no new token is created (and the caller
2065  * must use an alternative parsing method).
2066  */
2067
2068 STATIC char *
2069 S_force_version(pTHX_ char *s, int guessing)
2070 {
2071     dVAR;
2072     OP *version = NULL;
2073     char *d;
2074 #ifdef PERL_MAD
2075     I32 startoff = s - SvPVX(PL_linestr);
2076 #endif
2077
2078     PERL_ARGS_ASSERT_FORCE_VERSION;
2079
2080     s = SKIPSPACE1(s);
2081
2082     d = s;
2083     if (*d == 'v')
2084         d++;
2085     if (isDIGIT(*d)) {
2086         while (isDIGIT(*d) || *d == '_' || *d == '.')
2087             d++;
2088 #ifdef PERL_MAD
2089         if (PL_madskills) {
2090             start_force(PL_curforce);
2091             curmad('X', newSVpvn(s,d-s));
2092         }
2093 #endif
2094         if (*d == ';' || isSPACE(*d) || *d == '}' || !*d) {
2095             SV *ver;
2096             s = scan_num(s, &pl_yylval);
2097             version = pl_yylval.opval;
2098             ver = cSVOPx(version)->op_sv;
2099             if (SvPOK(ver) && !SvNIOK(ver)) {
2100                 SvUPGRADE(ver, SVt_PVNV);
2101                 SvNV_set(ver, str_to_version(ver));
2102                 SvNOK_on(ver);          /* hint that it is a version */
2103             }
2104         }
2105         else if (guessing) {
2106 #ifdef PERL_MAD
2107             if (PL_madskills) {
2108                 sv_free(PL_nextwhite);  /* let next token collect whitespace */
2109                 PL_nextwhite = 0;
2110                 s = SvPVX(PL_linestr) + startoff;
2111             }
2112 #endif
2113             return s;
2114         }
2115     }
2116
2117 #ifdef PERL_MAD
2118     if (PL_madskills && !version) {
2119         sv_free(PL_nextwhite);  /* let next token collect whitespace */
2120         PL_nextwhite = 0;
2121         s = SvPVX(PL_linestr) + startoff;
2122     }
2123 #endif
2124     /* NOTE: The parser sees the package name and the VERSION swapped */
2125     start_force(PL_curforce);
2126     NEXTVAL_NEXTTOKE.opval = version;
2127     force_next(WORD);
2128
2129     return s;
2130 }
2131
2132 /*
2133  * S_tokeq
2134  * Tokenize a quoted string passed in as an SV.  It finds the next
2135  * chunk, up to end of string or a backslash.  It may make a new
2136  * SV containing that chunk (if HINT_NEW_STRING is on).  It also
2137  * turns \\ into \.
2138  */
2139
2140 STATIC SV *
2141 S_tokeq(pTHX_ SV *sv)
2142 {
2143     dVAR;
2144     register char *s;
2145     register char *send;
2146     register char *d;
2147     STRLEN len = 0;
2148     SV *pv = sv;
2149
2150     PERL_ARGS_ASSERT_TOKEQ;
2151
2152     if (!SvLEN(sv))
2153         goto finish;
2154
2155     s = SvPV_force(sv, len);
2156     if (SvTYPE(sv) >= SVt_PVIV && SvIVX(sv) == -1)
2157         goto finish;
2158     send = s + len;
2159     while (s < send && *s != '\\')
2160         s++;
2161     if (s == send)
2162         goto finish;
2163     d = s;
2164     if ( PL_hints & HINT_NEW_STRING ) {
2165         pv = newSVpvn_flags(SvPVX_const(pv), len, SVs_TEMP | SvUTF8(sv));
2166     }
2167     while (s < send) {
2168         if (*s == '\\') {
2169             if (s + 1 < send && (s[1] == '\\'))
2170                 s++;            /* all that, just for this */
2171         }
2172         *d++ = *s++;
2173     }
2174     *d = '\0';
2175     SvCUR_set(sv, d - SvPVX_const(sv));
2176   finish:
2177     if ( PL_hints & HINT_NEW_STRING )
2178        return new_constant(NULL, 0, "q", sv, pv, "q", 1);
2179     return sv;
2180 }
2181
2182 /*
2183  * Now come three functions related to double-quote context,
2184  * S_sublex_start, S_sublex_push, and S_sublex_done.  They're used when
2185  * converting things like "\u\Lgnat" into ucfirst(lc("gnat")).  They
2186  * interact with PL_lex_state, and create fake ( ... ) argument lists
2187  * to handle functions and concatenation.
2188  * They assume that whoever calls them will be setting up a fake
2189  * join call, because each subthing puts a ',' after it.  This lets
2190  *   "lower \luPpEr"
2191  * become
2192  *  join($, , 'lower ', lcfirst( 'uPpEr', ) ,)
2193  *
2194  * (I'm not sure whether the spurious commas at the end of lcfirst's
2195  * arguments and join's arguments are created or not).
2196  */
2197
2198 /*
2199  * S_sublex_start
2200  * Assumes that pl_yylval.ival is the op we're creating (e.g. OP_LCFIRST).
2201  *
2202  * Pattern matching will set PL_lex_op to the pattern-matching op to
2203  * make (we return THING if pl_yylval.ival is OP_NULL, PMFUNC otherwise).
2204  *
2205  * OP_CONST and OP_READLINE are easy--just make the new op and return.
2206  *
2207  * Everything else becomes a FUNC.
2208  *
2209  * Sets PL_lex_state to LEX_INTERPPUSH unless (ival was OP_NULL or we
2210  * had an OP_CONST or OP_READLINE).  This just sets us up for a
2211  * call to S_sublex_push().
2212  */
2213
2214 STATIC I32
2215 S_sublex_start(pTHX)
2216 {
2217     dVAR;
2218     register const I32 op_type = pl_yylval.ival;
2219
2220     if (op_type == OP_NULL) {
2221         pl_yylval.opval = PL_lex_op;
2222         PL_lex_op = NULL;
2223         return THING;
2224     }
2225     if (op_type == OP_CONST || op_type == OP_READLINE) {
2226         SV *sv = tokeq(PL_lex_stuff);
2227
2228         if (SvTYPE(sv) == SVt_PVIV) {
2229             /* Overloaded constants, nothing fancy: Convert to SVt_PV: */
2230             STRLEN len;
2231             const char * const p = SvPV_const(sv, len);
2232             SV * const nsv = newSVpvn_flags(p, len, SvUTF8(sv));
2233             SvREFCNT_dec(sv);
2234             sv = nsv;
2235         }
2236         pl_yylval.opval = (OP*)newSVOP(op_type, 0, sv);
2237         PL_lex_stuff = NULL;
2238         /* Allow <FH> // "foo" */
2239         if (op_type == OP_READLINE)
2240             PL_expect = XTERMORDORDOR;
2241         return THING;
2242     }
2243     else if (op_type == OP_BACKTICK && PL_lex_op) {
2244         /* readpipe() vas overriden */
2245         cSVOPx(cLISTOPx(cUNOPx(PL_lex_op)->op_first)->op_first->op_sibling)->op_sv = tokeq(PL_lex_stuff);
2246         pl_yylval.opval = PL_lex_op;
2247         PL_lex_op = NULL;
2248         PL_lex_stuff = NULL;
2249         return THING;
2250     }
2251
2252     PL_sublex_info.super_state = PL_lex_state;
2253     PL_sublex_info.sub_inwhat = (U16)op_type;
2254     PL_sublex_info.sub_op = PL_lex_op;
2255     PL_lex_state = LEX_INTERPPUSH;
2256
2257     PL_expect = XTERM;
2258     if (PL_lex_op) {
2259         pl_yylval.opval = PL_lex_op;
2260         PL_lex_op = NULL;
2261         return PMFUNC;
2262     }
2263     else
2264         return FUNC;
2265 }
2266
2267 /*
2268  * S_sublex_push
2269  * Create a new scope to save the lexing state.  The scope will be
2270  * ended in S_sublex_done.  Returns a '(', starting the function arguments
2271  * to the uc, lc, etc. found before.
2272  * Sets PL_lex_state to LEX_INTERPCONCAT.
2273  */
2274
2275 STATIC I32
2276 S_sublex_push(pTHX)
2277 {
2278     dVAR;
2279     ENTER;
2280
2281     PL_lex_state = PL_sublex_info.super_state;
2282     SAVEBOOL(PL_lex_dojoin);
2283     SAVEI32(PL_lex_brackets);
2284     SAVEI32(PL_lex_casemods);
2285     SAVEI32(PL_lex_starts);
2286     SAVEI8(PL_lex_state);
2287     SAVEVPTR(PL_lex_inpat);
2288     SAVEI16(PL_lex_inwhat);
2289     SAVECOPLINE(PL_curcop);
2290     SAVEPPTR(PL_bufptr);
2291     SAVEPPTR(PL_bufend);
2292     SAVEPPTR(PL_oldbufptr);
2293     SAVEPPTR(PL_oldoldbufptr);
2294     SAVEPPTR(PL_last_lop);
2295     SAVEPPTR(PL_last_uni);
2296     SAVEPPTR(PL_linestart);
2297     SAVESPTR(PL_linestr);
2298     SAVEGENERICPV(PL_lex_brackstack);
2299     SAVEGENERICPV(PL_lex_casestack);
2300
2301     PL_linestr = PL_lex_stuff;
2302     PL_lex_stuff = NULL;
2303
2304     PL_bufend = PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart
2305         = SvPVX(PL_linestr);
2306     PL_bufend += SvCUR(PL_linestr);
2307     PL_last_lop = PL_last_uni = NULL;
2308     SAVEFREESV(PL_linestr);
2309
2310     PL_lex_dojoin = FALSE;
2311     PL_lex_brackets = 0;
2312     Newx(PL_lex_brackstack, 120, char);
2313     Newx(PL_lex_casestack, 12, char);
2314     PL_lex_casemods = 0;
2315     *PL_lex_casestack = '\0';
2316     PL_lex_starts = 0;
2317     PL_lex_state = LEX_INTERPCONCAT;
2318     CopLINE_set(PL_curcop, (line_t)PL_multi_start);
2319
2320     PL_lex_inwhat = PL_sublex_info.sub_inwhat;
2321     if (PL_lex_inwhat == OP_MATCH || PL_lex_inwhat == OP_QR || PL_lex_inwhat == OP_SUBST)
2322         PL_lex_inpat = PL_sublex_info.sub_op;
2323     else
2324         PL_lex_inpat = NULL;
2325
2326     return '(';
2327 }
2328
2329 /*
2330  * S_sublex_done
2331  * Restores lexer state after a S_sublex_push.
2332  */
2333
2334 STATIC I32
2335 S_sublex_done(pTHX)
2336 {
2337     dVAR;
2338     if (!PL_lex_starts++) {
2339         SV * const sv = newSVpvs("");
2340         if (SvUTF8(PL_linestr))
2341             SvUTF8_on(sv);
2342         PL_expect = XOPERATOR;
2343         pl_yylval.opval = (OP*)newSVOP(OP_CONST, 0, sv);
2344         return THING;
2345     }
2346
2347     if (PL_lex_casemods) {              /* oops, we've got some unbalanced parens */
2348         PL_lex_state = LEX_INTERPCASEMOD;
2349         return yylex();
2350     }
2351
2352     /* Is there a right-hand side to take care of? (s//RHS/ or tr//RHS/) */
2353     if (PL_lex_repl && (PL_lex_inwhat == OP_SUBST || PL_lex_inwhat == OP_TRANS)) {
2354         PL_linestr = PL_lex_repl;
2355         PL_lex_inpat = 0;
2356         PL_bufend = PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
2357         PL_bufend += SvCUR(PL_linestr);
2358         PL_last_lop = PL_last_uni = NULL;
2359         SAVEFREESV(PL_linestr);
2360         PL_lex_dojoin = FALSE;
2361         PL_lex_brackets = 0;
2362         PL_lex_casemods = 0;
2363         *PL_lex_casestack = '\0';
2364         PL_lex_starts = 0;
2365         if (SvEVALED(PL_lex_repl)) {
2366             PL_lex_state = LEX_INTERPNORMAL;
2367             PL_lex_starts++;
2368             /*  we don't clear PL_lex_repl here, so that we can check later
2369                 whether this is an evalled subst; that means we rely on the
2370                 logic to ensure sublex_done() is called again only via the
2371                 branch (in yylex()) that clears PL_lex_repl, else we'll loop */
2372         }
2373         else {
2374             PL_lex_state = LEX_INTERPCONCAT;
2375             PL_lex_repl = NULL;
2376         }
2377         return ',';
2378     }
2379     else {
2380 #ifdef PERL_MAD
2381         if (PL_madskills) {
2382             if (PL_thiswhite) {
2383                 if (!PL_endwhite)
2384                     PL_endwhite = newSVpvs("");
2385                 sv_catsv(PL_endwhite, PL_thiswhite);
2386                 PL_thiswhite = 0;
2387             }
2388             if (PL_thistoken)
2389                 sv_setpvs(PL_thistoken,"");
2390             else
2391                 PL_realtokenstart = -1;
2392         }
2393 #endif
2394         LEAVE;
2395         PL_bufend = SvPVX(PL_linestr);
2396         PL_bufend += SvCUR(PL_linestr);
2397         PL_expect = XOPERATOR;
2398         PL_sublex_info.sub_inwhat = 0;
2399         return ')';
2400     }
2401 }
2402
2403 /*
2404   scan_const
2405
2406   Extracts a pattern, double-quoted string, or transliteration.  This
2407   is terrifying code.
2408
2409   It looks at PL_lex_inwhat and PL_lex_inpat to find out whether it's
2410   processing a pattern (PL_lex_inpat is true), a transliteration
2411   (PL_lex_inwhat == OP_TRANS is true), or a double-quoted string.
2412
2413   Returns a pointer to the character scanned up to. If this is
2414   advanced from the start pointer supplied (i.e. if anything was
2415   successfully parsed), will leave an OP for the substring scanned
2416   in pl_yylval. Caller must intuit reason for not parsing further
2417   by looking at the next characters herself.
2418
2419   In patterns:
2420     backslashes:
2421       double-quoted style: \r and \n
2422       regexp special ones: \D \s
2423       constants: \x31
2424       backrefs: \1
2425       case and quoting: \U \Q \E
2426     stops on @ and $, but not for $ as tail anchor
2427
2428   In transliterations:
2429     characters are VERY literal, except for - not at the start or end
2430     of the string, which indicates a range. If the range is in bytes,
2431     scan_const expands the range to the full set of intermediate
2432     characters. If the range is in utf8, the hyphen is replaced with
2433     a certain range mark which will be handled by pmtrans() in op.c.
2434
2435   In double-quoted strings:
2436     backslashes:
2437       double-quoted style: \r and \n
2438       constants: \x31
2439       deprecated backrefs: \1 (in substitution replacements)
2440       case and quoting: \U \Q \E
2441     stops on @ and $
2442
2443   scan_const does *not* construct ops to handle interpolated strings.
2444   It stops processing as soon as it finds an embedded $ or @ variable
2445   and leaves it to the caller to work out what's going on.
2446
2447   embedded arrays (whether in pattern or not) could be:
2448       @foo, @::foo, @'foo, @{foo}, @$foo, @+, @-.
2449
2450   $ in double-quoted strings must be the symbol of an embedded scalar.
2451
2452   $ in pattern could be $foo or could be tail anchor.  Assumption:
2453   it's a tail anchor if $ is the last thing in the string, or if it's
2454   followed by one of "()| \r\n\t"
2455
2456   \1 (backreferences) are turned into $1
2457
2458   The structure of the code is
2459       while (there's a character to process) {
2460           handle transliteration ranges
2461           skip regexp comments /(?#comment)/ and codes /(?{code})/
2462           skip #-initiated comments in //x patterns
2463           check for embedded arrays
2464           check for embedded scalars
2465           if (backslash) {
2466               leave intact backslashes from leaveit (below)
2467               deprecate \1 in substitution replacements
2468               handle string-changing backslashes \l \U \Q \E, etc.
2469               switch (what was escaped) {
2470                   handle \- in a transliteration (becomes a literal -)
2471                   handle \132 (octal characters)
2472                   handle \x15 and \x{1234} (hex characters)
2473                   handle \N{name} (named characters)
2474                   handle \cV (control characters)
2475                   handle printf-style backslashes (\f, \r, \n, etc)
2476               } (end switch)
2477               continue
2478           } (end if backslash)
2479           handle regular character
2480     } (end while character to read)
2481                 
2482 */
2483
2484 STATIC char *
2485 S_scan_const(pTHX_ char *start)
2486 {
2487     dVAR;
2488     register char *send = PL_bufend;            /* end of the constant */
2489     SV *sv = newSV(send - start);               /* sv for the constant.  See
2490                                                    note below on sizing. */
2491     register char *s = start;                   /* start of the constant */
2492     register char *d = SvPVX(sv);               /* destination for copies */
2493     bool dorange = FALSE;                       /* are we in a translit range? */
2494     bool didrange = FALSE;                      /* did we just finish a range? */
2495     I32  has_utf8 = FALSE;                      /* Output constant is UTF8 */
2496     I32  this_utf8 = UTF;                       /* Is the source string assumed
2497                                                    to be UTF8?  But, this can
2498                                                    show as true when the source
2499                                                    isn't utf8, as for example
2500                                                    when it is entirely composed
2501                                                    of hex constants */
2502
2503     /* Note on sizing:  The scanned constant is placed into sv, which is
2504      * initialized by newSV() assuming one byte of output for every byte of
2505      * input.  This routine expects newSV() to allocate an extra byte for a
2506      * trailing NUL, which this routine will append if it gets to the end of
2507      * the input.  There may be more bytes of input than output (eg., \N{LATIN
2508      * CAPITAL LETTER A}), or more output than input if the constant ends up
2509      * recoded to utf8, but each time a construct is found that might increase
2510      * the needed size, SvGROW() is called.  Its size parameter each time is
2511      * based on the best guess estimate at the time, namely the length used so
2512      * far, plus the length the current construct will occupy, plus room for
2513      * the trailing NUL, plus one byte for every input byte still unscanned */ 
2514
2515     UV uv;
2516 #ifdef EBCDIC
2517     UV literal_endpoint = 0;
2518     bool native_range = TRUE; /* turned to FALSE if the first endpoint is Unicode. */
2519 #endif
2520
2521     PERL_ARGS_ASSERT_SCAN_CONST;
2522
2523     if (PL_lex_inwhat == OP_TRANS && PL_sublex_info.sub_op) {
2524         /* If we are doing a trans and we know we want UTF8 set expectation */
2525         has_utf8   = PL_sublex_info.sub_op->op_private & (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF);
2526         this_utf8  = PL_sublex_info.sub_op->op_private & (PL_lex_repl ? OPpTRANS_FROM_UTF : OPpTRANS_TO_UTF);
2527     }
2528
2529
2530     while (s < send || dorange) {
2531         /* get transliterations out of the way (they're most literal) */
2532         if (PL_lex_inwhat == OP_TRANS) {
2533             /* expand a range A-Z to the full set of characters.  AIE! */
2534             if (dorange) {
2535                 I32 i;                          /* current expanded character */
2536                 I32 min;                        /* first character in range */
2537                 I32 max;                        /* last character in range */
2538
2539 #ifdef EBCDIC
2540                 UV uvmax = 0;
2541 #endif
2542
2543                 if (has_utf8
2544 #ifdef EBCDIC
2545                     && !native_range
2546 #endif
2547                     ) {
2548                     char * const c = (char*)utf8_hop((U8*)d, -1);
2549                     char *e = d++;
2550                     while (e-- > c)
2551                         *(e + 1) = *e;
2552                     *c = (char)UTF_TO_NATIVE(0xff);
2553                     /* mark the range as done, and continue */
2554                     dorange = FALSE;
2555                     didrange = TRUE;
2556                     continue;
2557                 }
2558
2559                 i = d - SvPVX_const(sv);                /* remember current offset */
2560 #ifdef EBCDIC
2561                 SvGROW(sv,
2562                        SvLEN(sv) + (has_utf8 ?
2563                                     (512 - UTF_CONTINUATION_MARK +
2564                                      UNISKIP(0x100))
2565                                     : 256));
2566                 /* How many two-byte within 0..255: 128 in UTF-8,
2567                  * 96 in UTF-8-mod. */
2568 #else
2569                 SvGROW(sv, SvLEN(sv) + 256);    /* never more than 256 chars in a range */
2570 #endif
2571                 d = SvPVX(sv) + i;              /* refresh d after realloc */
2572 #ifdef EBCDIC
2573                 if (has_utf8) {
2574                     int j;
2575                     for (j = 0; j <= 1; j++) {
2576                         char * const c = (char*)utf8_hop((U8*)d, -1);
2577                         const UV uv    = utf8n_to_uvchr((U8*)c, d - c, NULL, 0);
2578                         if (j)
2579                             min = (U8)uv;
2580                         else if (uv < 256)
2581                             max = (U8)uv;
2582                         else {
2583                             max = (U8)0xff; /* only to \xff */
2584                             uvmax = uv; /* \x{100} to uvmax */
2585                         }
2586                         d = c; /* eat endpoint chars */
2587                      }
2588                 }
2589                else {
2590 #endif
2591                    d -= 2;              /* eat the first char and the - */
2592                    min = (U8)*d;        /* first char in range */
2593                    max = (U8)d[1];      /* last char in range  */
2594 #ifdef EBCDIC
2595                }
2596 #endif
2597
2598                 if (min > max) {
2599                     Perl_croak(aTHX_
2600                                "Invalid range \"%c-%c\" in transliteration operator",
2601                                (char)min, (char)max);
2602                 }
2603
2604 #ifdef EBCDIC
2605                 if (literal_endpoint == 2 &&
2606                     ((isLOWER(min) && isLOWER(max)) ||
2607                      (isUPPER(min) && isUPPER(max)))) {
2608                     if (isLOWER(min)) {
2609                         for (i = min; i <= max; i++)
2610                             if (isLOWER(i))
2611                                 *d++ = NATIVE_TO_NEED(has_utf8,i);
2612                     } else {
2613                         for (i = min; i <= max; i++)
2614                             if (isUPPER(i))
2615                                 *d++ = NATIVE_TO_NEED(has_utf8,i);
2616                     }
2617                 }
2618                 else
2619 #endif
2620                     for (i = min; i <= max; i++)
2621 #ifdef EBCDIC
2622                         if (has_utf8) {
2623                             const U8 ch = (U8)NATIVE_TO_UTF(i);
2624                             if (UNI_IS_INVARIANT(ch))
2625                                 *d++ = (U8)i;
2626                             else {
2627                                 *d++ = (U8)UTF8_EIGHT_BIT_HI(ch);
2628                                 *d++ = (U8)UTF8_EIGHT_BIT_LO(ch);
2629                             }
2630                         }
2631                         else
2632 #endif
2633                             *d++ = (char)i;
2634  
2635 #ifdef EBCDIC
2636                 if (uvmax) {
2637                     d = (char*)uvchr_to_utf8((U8*)d, 0x100);
2638                     if (uvmax > 0x101)
2639                         *d++ = (char)UTF_TO_NATIVE(0xff);
2640                     if (uvmax > 0x100)
2641                         d = (char*)uvchr_to_utf8((U8*)d, uvmax);
2642                 }
2643 #endif
2644
2645                 /* mark the range as done, and continue */
2646                 dorange = FALSE;
2647                 didrange = TRUE;
2648 #ifdef EBCDIC
2649                 literal_endpoint = 0;
2650 #endif
2651                 continue;
2652             }
2653
2654             /* range begins (ignore - as first or last char) */
2655             else if (*s == '-' && s+1 < send  && s != start) {
2656                 if (didrange) {
2657                     Perl_croak(aTHX_ "Ambiguous range in transliteration operator");
2658                 }
2659                 if (has_utf8
2660 #ifdef EBCDIC
2661                     && !native_range
2662 #endif
2663                     ) {
2664                     *d++ = (char)UTF_TO_NATIVE(0xff);   /* use illegal utf8 byte--see pmtrans */
2665                     s++;
2666                     continue;
2667                 }
2668                 dorange = TRUE;
2669                 s++;
2670             }
2671             else {
2672                 didrange = FALSE;
2673 #ifdef EBCDIC
2674                 literal_endpoint = 0;
2675                 native_range = TRUE;
2676 #endif
2677             }
2678         }
2679
2680         /* if we get here, we're not doing a transliteration */
2681
2682         /* skip for regexp comments /(?#comment)/ and code /(?{code})/,
2683            except for the last char, which will be done separately. */
2684         else if (*s == '(' && PL_lex_inpat && s[1] == '?') {
2685             if (s[2] == '#') {
2686                 while (s+1 < send && *s != ')')
2687                     *d++ = NATIVE_TO_NEED(has_utf8,*s++);
2688             }
2689             else if (s[2] == '{' /* This should match regcomp.c */
2690                     || (s[2] == '?' && s[3] == '{'))
2691             {
2692                 I32 count = 1;
2693                 char *regparse = s + (s[2] == '{' ? 3 : 4);
2694                 char c;
2695
2696                 while (count && (c = *regparse)) {
2697                     if (c == '\\' && regparse[1])
2698                         regparse++;
2699                     else if (c == '{')
2700                         count++;
2701                     else if (c == '}')
2702                         count--;
2703                     regparse++;
2704                 }
2705                 if (*regparse != ')')
2706                     regparse--;         /* Leave one char for continuation. */
2707                 while (s < regparse)
2708                     *d++ = NATIVE_TO_NEED(has_utf8,*s++);
2709             }
2710         }
2711
2712         /* likewise skip #-initiated comments in //x patterns */
2713         else if (*s == '#' && PL_lex_inpat &&
2714           ((PMOP*)PL_lex_inpat)->op_pmflags & PMf_EXTENDED) {
2715             while (s+1 < send && *s != '\n')
2716                 *d++ = NATIVE_TO_NEED(has_utf8,*s++);
2717         }
2718
2719         /* check for embedded arrays
2720            (@foo, @::foo, @'foo, @{foo}, @$foo, @+, @-)
2721            */
2722         else if (*s == '@' && s[1]) {
2723             if (isALNUM_lazy_if(s+1,UTF))
2724                 break;
2725             if (strchr(":'{$", s[1]))
2726                 break;
2727             if (!PL_lex_inpat && (s[1] == '+' || s[1] == '-'))
2728                 break; /* in regexp, neither @+ nor @- are interpolated */
2729         }
2730
2731         /* check for embedded scalars.  only stop if we're sure it's a
2732            variable.
2733         */
2734         else if (*s == '$') {
2735             if (!PL_lex_inpat)  /* not a regexp, so $ must be var */
2736                 break;
2737             if (s + 1 < send && !strchr("()| \r\n\t", s[1])) {
2738                 if (s[1] == '\\') {
2739                     Perl_ck_warner(aTHX_ packWARN(WARN_AMBIGUOUS),
2740                                    "Possible unintended interpolation of $\\ in regex");
2741                 }
2742                 break;          /* in regexp, $ might be tail anchor */
2743             }
2744         }
2745
2746         /* End of else if chain - OP_TRANS rejoin rest */
2747
2748         /* backslashes */
2749         if (*s == '\\' && s+1 < send) {
2750             s++;
2751
2752             /* deprecate \1 in strings and substitution replacements */
2753             if (PL_lex_inwhat == OP_SUBST && !PL_lex_inpat &&
2754                 isDIGIT(*s) && *s != '0' && !isDIGIT(s[1]))
2755             {
2756                 Perl_ck_warner(aTHX_ packWARN(WARN_SYNTAX), "\\%c better written as $%c", *s, *s);
2757                 *--s = '$';
2758                 break;
2759             }
2760
2761             /* string-change backslash escapes */
2762             if (PL_lex_inwhat != OP_TRANS && *s && strchr("lLuUEQ", *s)) {
2763                 --s;
2764                 break;
2765             }
2766             /* skip any other backslash escapes in a pattern */
2767             else if (PL_lex_inpat) {
2768                 *d++ = NATIVE_TO_NEED(has_utf8,'\\');
2769                 goto default_action;
2770             }
2771
2772             /* if we get here, it's either a quoted -, or a digit */
2773             switch (*s) {
2774
2775             /* quoted - in transliterations */
2776             case '-':
2777                 if (PL_lex_inwhat == OP_TRANS) {
2778                     *d++ = *s++;
2779                     continue;
2780                 }
2781                 /* FALL THROUGH */
2782             default:
2783                 {
2784                     if ((isALPHA(*s) || isDIGIT(*s)))
2785                         Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
2786                                        "Unrecognized escape \\%c passed through",
2787                                        *s);
2788                     /* default action is to copy the quoted character */
2789                     goto default_action;
2790                 }
2791
2792             /* eg. \132 indicates the octal constant 0x132 */
2793             case '0': case '1': case '2': case '3':
2794             case '4': case '5': case '6': case '7':
2795                 {
2796                     I32 flags = 0;
2797                     STRLEN len = 3;
2798                     uv = NATIVE_TO_UNI(grok_oct(s, &len, &flags, NULL));
2799                     s += len;
2800                 }
2801                 goto NUM_ESCAPE_INSERT;
2802
2803             /* eg. \x24 indicates the hex constant 0x24 */
2804             case 'x':
2805                 ++s;
2806                 if (*s == '{') {
2807                     char* const e = strchr(s, '}');
2808                     I32 flags = PERL_SCAN_ALLOW_UNDERSCORES |
2809                       PERL_SCAN_DISALLOW_PREFIX;
2810                     STRLEN len;
2811
2812                     ++s;
2813                     if (!e) {
2814                         yyerror("Missing right brace on \\x{}");
2815                         continue;
2816                     }
2817                     len = e - s;
2818                     uv = NATIVE_TO_UNI(grok_hex(s, &len, &flags, NULL));
2819                     s = e + 1;
2820                 }
2821                 else {
2822                     {
2823                         STRLEN len = 2;
2824                         I32 flags = PERL_SCAN_DISALLOW_PREFIX;
2825                         uv = NATIVE_TO_UNI(grok_hex(s, &len, &flags, NULL));
2826                         s += len;
2827                     }
2828                 }
2829
2830               NUM_ESCAPE_INSERT:
2831                 /* Insert oct, hex, or \N{U+...} escaped character.  There will
2832                  * always be enough room in sv since such escapes will be
2833                  * longer than any UTF-8 sequence they can end up as, except if
2834                  * they force us to recode the rest of the string into utf8 */
2835                 
2836                 /* Here uv is the ordinal of the next character being added in
2837                  * unicode (converted from native).  (It has to be done before
2838                  * here because \N is interpreted as unicode, and oct and hex
2839                  * as native.) */
2840                 if (!UNI_IS_INVARIANT(uv)) {
2841                     if (!has_utf8 && uv > 255) {
2842                         /* Might need to recode whatever we have accumulated so
2843                          * far if it contains any chars variant in utf8 or
2844                          * utf-ebcdic. */
2845                           
2846                         SvCUR_set(sv, d - SvPVX_const(sv));
2847                         SvPOK_on(sv);
2848                         *d = '\0';
2849                         /* See Note on sizing above.  */
2850                         sv_utf8_upgrade_flags_grow(sv,
2851                                         SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
2852                                         UNISKIP(uv) + (STRLEN)(send - s) + 1);
2853                         d = SvPVX(sv) + SvCUR(sv);
2854                         has_utf8 = TRUE;
2855                     }
2856
2857                     if (has_utf8) {
2858                         d = (char*)uvuni_to_utf8((U8*)d, uv);
2859                         if (PL_lex_inwhat == OP_TRANS &&
2860                             PL_sublex_info.sub_op) {
2861                             PL_sublex_info.sub_op->op_private |=
2862                                 (PL_lex_repl ? OPpTRANS_FROM_UTF
2863                                              : OPpTRANS_TO_UTF);
2864                         }
2865 #ifdef EBCDIC
2866                         if (uv > 255 && !dorange)
2867                             native_range = FALSE;
2868 #endif
2869                     }
2870                     else {
2871                         *d++ = (char)uv;
2872                     }
2873                 }
2874                 else {
2875                     *d++ = (char) uv;
2876                 }
2877                 continue;
2878
2879             /* \N{LATIN SMALL LETTER A} is a named character, and so is
2880              * \N{U+0041} */
2881             case 'N':
2882                 ++s;
2883                 if (*s == '{') {
2884                     char* e = strchr(s, '}');
2885                     SV *res;
2886                     STRLEN len;
2887                     const char *str;
2888
2889                     if (!e) {
2890                         yyerror("Missing right brace on \\N{}");
2891                         e = s - 1;
2892                         goto cont_scan;
2893                     }
2894                     if (e > s + 2 && s[1] == 'U' && s[2] == '+') {
2895                         /* \N{U+...} The ... is a unicode value even on EBCDIC
2896                          * machines */
2897                         I32 flags = PERL_SCAN_ALLOW_UNDERSCORES |
2898                           PERL_SCAN_DISALLOW_PREFIX;
2899                         s += 3;
2900                         len = e - s;
2901                         uv = grok_hex(s, &len, &flags, NULL);
2902                         if ( e > s && len != (STRLEN)(e - s) ) {
2903                             uv = 0xFFFD;
2904                         }
2905                         s = e + 1;
2906                         goto NUM_ESCAPE_INSERT;
2907                     }
2908                     res = newSVpvn(s + 1, e - s - 1);
2909                     res = new_constant( NULL, 0, "charnames",
2910                                         res, NULL, s - 2, e - s + 3 );
2911                     if (has_utf8)
2912                         sv_utf8_upgrade(res);
2913                     str = SvPV_const(res,len);
2914 #ifdef EBCDIC_NEVER_MIND
2915                     /* charnames uses pack U and that has been
2916                      * recently changed to do the below uni->native
2917                      * mapping, so this would be redundant (and wrong,
2918                      * the code point would be doubly converted).
2919                      * But leave this in just in case the pack U change
2920                      * gets revoked, but the semantics is still
2921                      * desireable for charnames. --jhi */
2922                     {
2923                          UV uv = utf8_to_uvchr((const U8*)str, 0);
2924
2925                          if (uv < 0x100) {
2926                               U8 tmpbuf[UTF8_MAXBYTES+1], *d;
2927
2928                               d = uvchr_to_utf8(tmpbuf, UNI_TO_NATIVE(uv));
2929                               sv_setpvn(res, (char *)tmpbuf, d - tmpbuf);
2930                               str = SvPV_const(res, len);
2931                          }
2932                     }
2933 #endif
2934                     /* If destination is not in utf8 but this new character is,
2935                      * recode the dest to utf8 */
2936                     if (!has_utf8 && SvUTF8(res)) {
2937                         SvCUR_set(sv, d - SvPVX_const(sv));
2938                         SvPOK_on(sv);
2939                         *d = '\0';
2940                         /* See Note on sizing above.  */
2941                         sv_utf8_upgrade_flags_grow(sv,
2942                                             SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
2943                                             len + (STRLEN)(send - s) + 1);
2944                         d = SvPVX(sv) + SvCUR(sv);
2945                         has_utf8 = TRUE;
2946                     } else if (len > (STRLEN)(e - s + 4)) { /* I _guess_ 4 is \N{} --jhi */
2947
2948                         /* See Note on sizing above.  (NOTE: SvCUR() is not set
2949                          * correctly here). */
2950                         const STRLEN off = d - SvPVX_const(sv);
2951                         d = SvGROW(sv, off + len + (STRLEN)(send - s) + 1) + off;
2952                     }
2953 #ifdef EBCDIC
2954                     if (!dorange)
2955                         native_range = FALSE; /* \N{} is guessed to be Unicode */
2956 #endif
2957                     Copy(str, d, len, char);
2958                     d += len;
2959                     SvREFCNT_dec(res);
2960                   cont_scan:
2961                     s = e + 1;
2962                 }
2963                 else
2964                     yyerror("Missing braces on \\N{}");
2965                 continue;
2966
2967             /* \c is a control character */
2968             case 'c':
2969                 s++;
2970                 if (s < send) {
2971                     U8 c = *s++;
2972 #ifdef EBCDIC
2973                     if (isLOWER(c))
2974                         c = toUPPER(c);
2975 #endif
2976                     *d++ = NATIVE_TO_NEED(has_utf8,toCTRL(c));
2977                 }
2978                 else {
2979                     yyerror("Missing control char name in \\c");
2980                 }
2981                 continue;
2982
2983             /* printf-style backslashes, formfeeds, newlines, etc */
2984             case 'b':
2985                 *d++ = NATIVE_TO_NEED(has_utf8,'\b');
2986                 break;
2987             case 'n':
2988                 *d++ = NATIVE_TO_NEED(has_utf8,'\n');
2989                 break;
2990             case 'r':
2991                 *d++ = NATIVE_TO_NEED(has_utf8,'\r');
2992                 break;
2993             case 'f':
2994                 *d++ = NATIVE_TO_NEED(has_utf8,'\f');
2995                 break;
2996             case 't':
2997                 *d++ = NATIVE_TO_NEED(has_utf8,'\t');
2998                 break;
2999             case 'e':
3000                 *d++ = ASCII_TO_NEED(has_utf8,'\033');
3001                 break;
3002             case 'a':
3003                 *d++ = ASCII_TO_NEED(has_utf8,'\007');
3004                 break;
3005             } /* end switch */
3006
3007             s++;
3008             continue;
3009         } /* end if (backslash) */
3010 #ifdef EBCDIC
3011         else
3012             literal_endpoint++;
3013 #endif
3014
3015     default_action:
3016         /* If we started with encoded form, or already know we want it,
3017            then encode the next character */
3018         if (! NATIVE_IS_INVARIANT((U8)(*s)) && (this_utf8 || has_utf8)) {
3019             STRLEN len  = 1;
3020
3021
3022             /* One might think that it is wasted effort in the case of the
3023              * source being utf8 (this_utf8 == TRUE) to take the next character
3024              * in the source, convert it to an unsigned value, and then convert
3025              * it back again.  But the source has not been validated here.  The
3026              * routine that does the conversion checks for errors like
3027              * malformed utf8 */
3028
3029             const UV nextuv   = (this_utf8) ? utf8n_to_uvchr((U8*)s, send - s, &len, 0) : (UV) ((U8) *s);
3030             const STRLEN need = UNISKIP(NATIVE_TO_UNI(nextuv));
3031             if (!has_utf8) {
3032                 SvCUR_set(sv, d - SvPVX_const(sv));
3033                 SvPOK_on(sv);
3034                 *d = '\0';
3035                 /* See Note on sizing above.  */
3036                 sv_utf8_upgrade_flags_grow(sv,
3037                                         SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3038                                         need + (STRLEN)(send - s) + 1);
3039                 d = SvPVX(sv) + SvCUR(sv);
3040                 has_utf8 = TRUE;
3041             } else if (need > len) {
3042                 /* encoded value larger than old, may need extra space (NOTE:
3043                  * SvCUR() is not set correctly here).   See Note on sizing
3044                  * above.  */
3045                 const STRLEN off = d - SvPVX_const(sv);
3046                 d = SvGROW(sv, off + need + (STRLEN)(send - s) + 1) + off;
3047             }
3048             s += len;
3049
3050             d = (char*)uvchr_to_utf8((U8*)d, nextuv);
3051 #ifdef EBCDIC
3052             if (uv > 255 && !dorange)
3053                 native_range = FALSE;
3054 #endif
3055         }
3056         else {
3057             *d++ = NATIVE_TO_NEED(has_utf8,*s++);
3058         }
3059     } /* while loop to process each character */
3060
3061     /* terminate the string and set up the sv */
3062     *d = '\0';
3063     SvCUR_set(sv, d - SvPVX_const(sv));
3064     if (SvCUR(sv) >= SvLEN(sv))
3065         Perl_croak(aTHX_ "panic: constant overflowed allocated space");
3066
3067     SvPOK_on(sv);
3068     if (PL_encoding && !has_utf8) {
3069         sv_recode_to_utf8(sv, PL_encoding);
3070         if (SvUTF8(sv))
3071             has_utf8 = TRUE;
3072     }
3073     if (has_utf8) {
3074         SvUTF8_on(sv);
3075         if (PL_lex_inwhat == OP_TRANS && PL_sublex_info.sub_op) {
3076             PL_sublex_info.sub_op->op_private |=
3077                     (PL_lex_repl ? OPpTRANS_FROM_UTF : OPpTRANS_TO_UTF);
3078         }
3079     }
3080
3081     /* shrink the sv if we allocated more than we used */
3082     if (SvCUR(sv) + 5 < SvLEN(sv)) {
3083         SvPV_shrink_to_cur(sv);
3084     }
3085
3086     /* return the substring (via pl_yylval) only if we parsed anything */
3087     if (s > PL_bufptr) {
3088         if ( PL_hints & ( PL_lex_inpat ? HINT_NEW_RE : HINT_NEW_STRING ) ) {
3089             const char *const key = PL_lex_inpat ? "qr" : "q";
3090             const STRLEN keylen = PL_lex_inpat ? 2 : 1;
3091             const char *type;
3092             STRLEN typelen;
3093
3094             if (PL_lex_inwhat == OP_TRANS) {
3095                 type = "tr";
3096                 typelen = 2;
3097             } else if (PL_lex_inwhat == OP_SUBST && !PL_lex_inpat) {
3098                 type = "s";
3099                 typelen = 1;
3100             } else  {
3101                 type = "qq";
3102                 typelen = 2;
3103             }
3104
3105             sv = S_new_constant(aTHX_ start, s - start, key, keylen, sv, NULL,
3106                                 type, typelen);
3107         }
3108         pl_yylval.opval = (OP*)newSVOP(OP_CONST, 0, sv);
3109     } else
3110         SvREFCNT_dec(sv);
3111     return s;
3112 }
3113
3114 /* S_intuit_more
3115  * Returns TRUE if there's more to the expression (e.g., a subscript),
3116  * FALSE otherwise.
3117  *
3118  * It deals with "$foo[3]" and /$foo[3]/ and /$foo[0123456789$]+/
3119  *
3120  * ->[ and ->{ return TRUE
3121  * { and [ outside a pattern are always subscripts, so return TRUE
3122  * if we're outside a pattern and it's not { or [, then return FALSE
3123  * if we're in a pattern and the first char is a {
3124  *   {4,5} (any digits around the comma) returns FALSE
3125  * if we're in a pattern and the first char is a [
3126  *   [] returns FALSE
3127  *   [SOMETHING] has a funky algorithm to decide whether it's a
3128  *      character class or not.  It has to deal with things like
3129  *      /$foo[-3]/ and /$foo[$bar]/ as well as /$foo[$\d]+/
3130  * anything else returns TRUE
3131  */
3132
3133 /* This is the one truly awful dwimmer necessary to conflate C and sed. */
3134
3135 STATIC int
3136 S_intuit_more(pTHX_ register char *s)
3137 {
3138     dVAR;
3139
3140     PERL_ARGS_ASSERT_INTUIT_MORE;
3141
3142     if (PL_lex_brackets)
3143         return TRUE;
3144     if (*s == '-' && s[1] == '>' && (s[2] == '[' || s[2] == '{'))
3145         return TRUE;
3146     if (*s != '{' && *s != '[')
3147         return FALSE;
3148     if (!PL_lex_inpat)
3149         return TRUE;
3150
3151     /* In a pattern, so maybe we have {n,m}. */
3152     if (*s == '{') {
3153         s++;
3154         if (!isDIGIT(*s))
3155             return TRUE;
3156         while (isDIGIT(*s))
3157             s++;
3158         if (*s == ',')
3159             s++;
3160         while (isDIGIT(*s))
3161             s++;
3162         if (*s == '}')
3163             return FALSE;
3164         return TRUE;
3165         
3166     }
3167
3168     /* On the other hand, maybe we have a character class */
3169
3170     s++;
3171     if (*s == ']' || *s == '^')
3172         return FALSE;
3173     else {
3174         /* this is terrifying, and it works */
3175         int weight = 2;         /* let's weigh the evidence */
3176         char seen[256];
3177         unsigned char un_char = 255, last_un_char;
3178         const char * const send = strchr(s,']');
3179         char tmpbuf[sizeof PL_tokenbuf * 4];
3180
3181         if (!send)              /* has to be an expression */
3182             return TRUE;
3183
3184         Zero(seen,256,char);
3185         if (*s == '$')
3186             weight -= 3;
3187         else if (isDIGIT(*s)) {
3188             if (s[1] != ']') {
3189                 if (isDIGIT(s[1]) && s[2] == ']')
3190                     weight -= 10;
3191             }
3192             else
3193                 weight -= 100;
3194         }
3195         for (; s < send; s++) {
3196             last_un_char = un_char;
3197             un_char = (unsigned char)*s;
3198             switch (*s) {
3199             case '@':
3200             case '&':
3201             case '$':
3202                 weight -= seen[un_char] * 10;
3203                 if (isALNUM_lazy_if(s+1,UTF)) {
3204                     int len;
3205                     scan_ident(s, send, tmpbuf, sizeof tmpbuf, FALSE);
3206                     len = (int)strlen(tmpbuf);
3207                     if (len > 1 && gv_fetchpvn_flags(tmpbuf, len, 0, SVt_PV))
3208                         weight -= 100;
3209                     else
3210                         weight -= 10;
3211                 }
3212                 else if (*s == '$' && s[1] &&
3213                   strchr("[#!%*<>()-=",s[1])) {
3214                     if (/*{*/ strchr("])} =",s[2]))
3215                         weight -= 10;
3216                     else
3217                         weight -= 1;
3218                 }
3219                 break;
3220             case '\\':
3221                 un_char = 254;
3222                 if (s[1]) {
3223                     if (strchr("wds]",s[1]))
3224                         weight += 100;
3225                     else if (seen[(U8)'\''] || seen[(U8)'"'])
3226                         weight += 1;
3227                     else if (strchr("rnftbxcav",s[1]))
3228                         weight += 40;
3229                     else if (isDIGIT(s[1])) {
3230                         weight += 40;
3231                         while (s[1] && isDIGIT(s[1]))
3232                             s++;
3233                     }
3234                 }
3235                 else
3236                     weight += 100;
3237                 break;
3238             case '-':
3239                 if (s[1] == '\\')
3240                     weight += 50;
3241                 if (strchr("aA01! ",last_un_char))
3242                     weight += 30;
3243                 if (strchr("zZ79~",s[1]))
3244                     weight += 30;
3245                 if (last_un_char == 255 && (isDIGIT(s[1]) || s[1] == '$'))
3246                     weight -= 5;        /* cope with negative subscript */
3247                 break;
3248             default:
3249                 if (!isALNUM(last_un_char)
3250                     && !(last_un_char == '$' || last_un_char == '@'
3251                          || last_un_char == '&')
3252                     && isALPHA(*s) && s[1] && isALPHA(s[1])) {
3253                     char *d = tmpbuf;
3254                     while (isALPHA(*s))
3255                         *d++ = *s++;
3256                     *d = '\0';
3257                     if (keyword(tmpbuf, d - tmpbuf, 0))
3258                         weight -= 150;
3259                 }
3260                 if (un_char == last_un_char + 1)
3261                     weight += 5;
3262                 weight -= seen[un_char];
3263                 break;
3264             }
3265             seen[un_char]++;
3266         }
3267         if (weight >= 0)        /* probably a character class */
3268             return FALSE;
3269     }
3270
3271     return TRUE;
3272 }
3273
3274 /*
3275  * S_intuit_method
3276  *
3277  * Does all the checking to disambiguate
3278  *   foo bar
3279  * between foo(bar) and bar->foo.  Returns 0 if not a method, otherwise
3280  * FUNCMETH (bar->foo(args)) or METHOD (bar->foo args).
3281  *
3282  * First argument is the stuff after the first token, e.g. "bar".
3283  *
3284  * Not a method if bar is a filehandle.
3285  * Not a method if foo is a subroutine prototyped to take a filehandle.
3286  * Not a method if it's really "Foo $bar"
3287  * Method if it's "foo $bar"
3288  * Not a method if it's really "print foo $bar"
3289  * Method if it's really "foo package::" (interpreted as package->foo)
3290  * Not a method if bar is known to be a subroutine ("sub bar; foo bar")
3291  * Not a method if bar is a filehandle or package, but is quoted with
3292  *   =>
3293  */
3294
3295 STATIC int
3296 S_intuit_method(pTHX_ char *start, GV *gv, CV *cv)
3297 {
3298     dVAR;
3299     char *s = start + (*start == '$');
3300     char tmpbuf[sizeof PL_tokenbuf];
3301     STRLEN len;
3302     GV* indirgv;
3303 #ifdef PERL_MAD
3304     int soff;
3305 #endif
3306
3307     PERL_ARGS_ASSERT_INTUIT_METHOD;
3308
3309     if (gv) {
3310         if (SvTYPE(gv) == SVt_PVGV && GvIO(gv))
3311             return 0;
3312         if (cv) {
3313             if (SvPOK(cv)) {
3314                 const char *proto = SvPVX_const(cv);
3315                 if (proto) {
3316                     if (*proto == ';')
3317                         proto++;
3318                     if (*proto == '*')
3319                         return 0;
3320                 }
3321             }
3322         } else
3323             gv = NULL;
3324     }
3325     s = scan_word(s, tmpbuf, sizeof tmpbuf, TRUE, &len);
3326     /* start is the beginning of the possible filehandle/object,
3327      * and s is the end of it
3328      * tmpbuf is a copy of it
3329      */
3330
3331     if (*start == '$') {
3332         if (gv || PL_last_lop_op == OP_PRINT || PL_last_lop_op == OP_SAY ||
3333                 isUPPER(*PL_tokenbuf))
3334             return 0;
3335 #ifdef PERL_MAD
3336         len = start - SvPVX(PL_linestr);
3337 #endif
3338         s = PEEKSPACE(s);
3339 #ifdef PERL_MAD
3340         start = SvPVX(PL_linestr) + len;
3341 #endif
3342         PL_bufptr = start;
3343         PL_expect = XREF;
3344         return *s == '(' ? FUNCMETH : METHOD;
3345     }
3346     if (!keyword(tmpbuf, len, 0)) {
3347         if (len > 2 && tmpbuf[len - 2] == ':' && tmpbuf[len - 1] == ':') {
3348             len -= 2;
3349             tmpbuf[len] = '\0';
3350 #ifdef PERL_MAD
3351             soff = s - SvPVX(PL_linestr);
3352 #endif
3353             goto bare_package;
3354         }
3355         indirgv = gv_fetchpvn_flags(tmpbuf, len, 0, SVt_PVCV);
3356         if (indirgv && GvCVu(indirgv))
3357             return 0;
3358         /* filehandle or package name makes it a method */
3359         if (!gv || GvIO(indirgv) || gv_stashpvn(tmpbuf, len, 0)) {
3360 #ifdef PERL_MAD
3361             soff = s - SvPVX(PL_linestr);
3362 #endif
3363             s = PEEKSPACE(s);
3364             if ((PL_bufend - s) >= 2 && *s == '=' && *(s+1) == '>')
3365                 return 0;       /* no assumptions -- "=>" quotes bearword */
3366       bare_package:
3367             start_force(PL_curforce);
3368             NEXTVAL_NEXTTOKE.opval = (OP*)newSVOP(OP_CONST, 0,
3369                                                   S_newSV_maybe_utf8(aTHX_ tmpbuf, len));
3370             NEXTVAL_NEXTTOKE.opval->op_private = OPpCONST_BARE;
3371             if (PL_madskills)
3372                 curmad('X', newSVpvn(start,SvPVX(PL_linestr) + soff - start));
3373             PL_expect = XTERM;
3374             force_next(WORD);
3375             PL_bufptr = s;
3376 #ifdef PERL_MAD
3377             PL_bufptr = SvPVX(PL_linestr) + soff; /* restart before space */
3378 #endif
3379             return *s == '(' ? FUNCMETH : METHOD;
3380         }
3381     }
3382     return 0;
3383 }
3384
3385 /* Encoded script support. filter_add() effectively inserts a
3386  * 'pre-processing' function into the current source input stream.
3387  * Note that the filter function only applies to the current source file
3388  * (e.g., it will not affect files 'require'd or 'use'd by this one).
3389  *
3390  * The datasv parameter (which may be NULL) can be used to pass
3391  * private data to this instance of the filter. The filter function
3392  * can recover the SV using the FILTER_DATA macro and use it to
3393  * store private buffers and state information.
3394  *
3395  * The supplied datasv parameter is upgraded to a PVIO type
3396  * and the IoDIRP/IoANY field is used to store the function pointer,
3397  * and IOf_FAKE_DIRP is enabled on datasv to mark this as such.
3398  * Note that IoTOP_NAME, IoFMT_NAME, IoBOTTOM_NAME, if set for
3399  * private use must be set using malloc'd pointers.
3400  */
3401
3402 SV *
3403 Perl_filter_add(pTHX_ filter_t funcp, SV *datasv)
3404 {
3405     dVAR;
3406     if (!funcp)
3407         return NULL;
3408
3409     if (!PL_parser)
3410         return NULL;
3411
3412     if (!PL_rsfp_filters)
3413         PL_rsfp_filters = newAV();
3414     if (!datasv)
3415         datasv = newSV(0);
3416     SvUPGRADE(datasv, SVt_PVIO);
3417     IoANY(datasv) = FPTR2DPTR(void *, funcp); /* stash funcp into spare field */
3418     IoFLAGS(datasv) |= IOf_FAKE_DIRP;
3419     DEBUG_P(PerlIO_printf(Perl_debug_log, "filter_add func %p (%s)\n",
3420                           FPTR2DPTR(void *, IoANY(datasv)),
3421                           SvPV_nolen(datasv)));
3422     av_unshift(PL_rsfp_filters, 1);
3423     av_store(PL_rsfp_filters, 0, datasv) ;
3424     return(datasv);
3425 }
3426
3427
3428 /* Delete most recently added instance of this filter function. */
3429 void
3430 Perl_filter_del(pTHX_ filter_t funcp)
3431 {
3432     dVAR;
3433     SV *datasv;
3434
3435     PERL_ARGS_ASSERT_FILTER_DEL;
3436
3437 #ifdef DEBUGGING
3438     DEBUG_P(PerlIO_printf(Perl_debug_log, "filter_del func %p",
3439                           FPTR2DPTR(void*, funcp)));
3440 #endif
3441     if (!PL_parser || !PL_rsfp_filters || AvFILLp(PL_rsfp_filters)<0)
3442         return;
3443     /* if filter is on top of stack (usual case) just pop it off */
3444     datasv = FILTER_DATA(AvFILLp(PL_rsfp_filters));
3445     if (IoANY(datasv) == FPTR2DPTR(void *, funcp)) {
3446         IoFLAGS(datasv) &= ~IOf_FAKE_DIRP;
3447         IoANY(datasv) = (void *)NULL;
3448         sv_free(av_pop(PL_rsfp_filters));
3449
3450         return;
3451     }
3452     /* we need to search for the correct entry and clear it     */
3453     Perl_die(aTHX_ "filter_del can only delete in reverse order (currently)");
3454 }
3455
3456
3457 /* Invoke the idxth filter function for the current rsfp.        */
3458 /* maxlen 0 = read one text line */
3459 I32
3460 Perl_filter_read(pTHX_ int idx, SV *buf_sv, int maxlen)
3461 {
3462     dVAR;
3463     filter_t funcp;
3464     SV *datasv = NULL;
3465     /* This API is bad. It should have been using unsigned int for maxlen.
3466        Not sure if we want to change the API, but if not we should sanity
3467        check the value here.  */
3468     const unsigned int correct_length
3469         = maxlen < 0 ?
3470 #ifdef PERL_MICRO
3471         0x7FFFFFFF
3472 #else
3473         INT_MAX
3474 #endif
3475         : maxlen;
3476
3477     PERL_ARGS_ASSERT_FILTER_READ;
3478
3479     if (!PL_parser || !PL_rsfp_filters)
3480         return -1;
3481     if (idx > AvFILLp(PL_rsfp_filters)) {       /* Any more filters?    */
3482         /* Provide a default input filter to make life easy.    */
3483         /* Note that we append to the line. This is handy.      */
3484         DEBUG_P(PerlIO_printf(Perl_debug_log,
3485                               "filter_read %d: from rsfp\n", idx));
3486         if (correct_length) {
3487             /* Want a block */
3488             int len ;
3489             const int old_len = SvCUR(buf_sv);
3490
3491             /* ensure buf_sv is large enough */
3492             SvGROW(buf_sv, (STRLEN)(old_len + correct_length + 1)) ;
3493             if ((len = PerlIO_read(PL_rsfp, SvPVX(buf_sv) + old_len,
3494                                    correct_length)) <= 0) {
3495                 if (PerlIO_error(PL_rsfp))
3496                     return -1;          /* error */
3497                 else
3498                     return 0 ;          /* end of file */
3499             }
3500             SvCUR_set(buf_sv, old_len + len) ;
3501             SvPVX(buf_sv)[old_len + len] = '\0';
3502         } else {
3503             /* Want a line */
3504             if (sv_gets(buf_sv, PL_rsfp, SvCUR(buf_sv)) == NULL) {
3505                 if (PerlIO_error(PL_rsfp))
3506                     return -1;          /* error */
3507                 else
3508                     return 0 ;          /* end of file */
3509             }
3510         }
3511         return SvCUR(buf_sv);
3512     }
3513     /* Skip this filter slot if filter has been deleted */
3514     if ( (datasv = FILTER_DATA(idx)) == &PL_sv_undef) {
3515         DEBUG_P(PerlIO_printf(Perl_debug_log,
3516                               "filter_read %d: skipped (filter deleted)\n",
3517                               idx));
3518         return FILTER_READ(idx+1, buf_sv, correct_length); /* recurse */
3519     }
3520     /* Get function pointer hidden within datasv        */
3521     funcp = DPTR2FPTR(filter_t, IoANY(datasv));
3522     DEBUG_P(PerlIO_printf(Perl_debug_log,
3523                           "filter_read %d: via function %p (%s)\n",
3524                           idx, (void*)datasv, SvPV_nolen_const(datasv)));
3525     /* Call function. The function is expected to       */
3526     /* call "FILTER_READ(idx+1, buf_sv)" first.         */
3527     /* Return: <0:error, =0:eof, >0:not eof             */
3528     return (*funcp)(aTHX_ idx, buf_sv, correct_length);
3529 }
3530
3531 STATIC char *
3532 S_filter_gets(pTHX_ register SV *sv, STRLEN append)
3533 {
3534     dVAR;
3535
3536     PERL_ARGS_ASSERT_FILTER_GETS;
3537
3538 #ifdef PERL_CR_FILTER
3539     if (!PL_rsfp_filters) {
3540         filter_add(S_cr_textfilter,NULL);
3541     }
3542 #endif
3543     if (PL_rsfp_filters) {
3544         if (!append)
3545             SvCUR_set(sv, 0);   /* start with empty line        */
3546         if (FILTER_READ(0, sv, 0) > 0)
3547             return ( SvPVX(sv) ) ;
3548         else
3549             return NULL ;
3550     }
3551     else
3552         return (sv_gets(sv, PL_rsfp, append));
3553 }
3554
3555 STATIC HV *
3556 S_find_in_my_stash(pTHX_ const char *pkgname, STRLEN len)
3557 {
3558     dVAR;
3559     GV *gv;
3560
3561     PERL_ARGS_ASSERT_FIND_IN_MY_STASH;
3562
3563     if (len == 11 && *pkgname == '_' && strEQ(pkgname, "__PACKAGE__"))
3564         return PL_curstash;
3565
3566     if (len > 2 &&
3567         (pkgname[len - 2] == ':' && pkgname[len - 1] == ':') &&
3568         (gv = gv_fetchpvn_flags(pkgname, len, 0, SVt_PVHV)))
3569     {
3570         return GvHV(gv);                        /* Foo:: */
3571     }
3572
3573     /* use constant CLASS => 'MyClass' */
3574     gv = gv_fetchpvn_flags(pkgname, len, 0, SVt_PVCV);
3575     if (gv && GvCV(gv)) {
3576         SV * const sv = cv_const_sv(GvCV(gv));
3577         if (sv)
3578             pkgname = SvPV_const(sv, len);
3579     }
3580
3581     return gv_stashpvn(pkgname, len, 0);
3582 }
3583
3584 /*
3585  * S_readpipe_override
3586  * Check whether readpipe() is overriden, and generates the appropriate
3587  * optree, provided sublex_start() is called afterwards.
3588  */
3589 STATIC void
3590 S_readpipe_override(pTHX)
3591 {
3592     GV **gvp;
3593     GV *gv_readpipe = gv_fetchpvs("readpipe", GV_NOTQUAL, SVt_PVCV);
3594     pl_yylval.ival = OP_BACKTICK;
3595     if ((gv_readpipe
3596                 && GvCVu(gv_readpipe) && GvIMPORTED_CV(gv_readpipe))
3597             ||
3598             ((gvp = (GV**)hv_fetchs(PL_globalstash, "readpipe", FALSE))
3599              && (gv_readpipe = *gvp) && isGV_with_GP(gv_readpipe)
3600              && GvCVu(gv_readpipe) && GvIMPORTED_CV(gv_readpipe)))
3601     {
3602         PL_lex_op = (OP*)newUNOP(OP_ENTERSUB, OPf_STACKED,
3603             append_elem(OP_LIST,
3604                 newSVOP(OP_CONST, 0, &PL_sv_undef), /* value will be read later */
3605                 newCVREF(0, newGVOP(OP_GV, 0, gv_readpipe))));
3606     }
3607 }
3608
3609 #ifdef PERL_MAD 
3610  /*
3611  * Perl_madlex
3612  * The intent of this yylex wrapper is to minimize the changes to the
3613  * tokener when we aren't interested in collecting madprops.  It remains
3614  * to be seen how successful this strategy will be...
3615  */
3616
3617 int
3618 Perl_madlex(pTHX)
3619 {
3620     int optype;
3621     char *s = PL_bufptr;
3622
3623     /* make sure PL_thiswhite is initialized */
3624     PL_thiswhite = 0;
3625     PL_thismad = 0;
3626
3627     /* just do what yylex would do on pending identifier; leave PL_thiswhite alone */
3628     if (PL_pending_ident)
3629         return S_pending_ident(aTHX);
3630
3631     /* previous token ate up our whitespace? */
3632     if (!PL_lasttoke && PL_nextwhite) {
3633         PL_thiswhite = PL_nextwhite;
3634         PL_nextwhite = 0;
3635     }
3636
3637     /* isolate the token, and figure out where it is without whitespace */
3638     PL_realtokenstart = -1;
3639     PL_thistoken = 0;
3640     optype = yylex();
3641     s = PL_bufptr;
3642     assert(PL_curforce < 0);
3643
3644     if (!PL_thismad || PL_thismad->mad_key == '^') {    /* not forced already? */
3645         if (!PL_thistoken) {
3646             if (PL_realtokenstart < 0 || !CopLINE(PL_curcop))
3647                 PL_thistoken = newSVpvs("");
3648             else {
3649                 char * const tstart = SvPVX(PL_linestr) + PL_realtokenstart;
3650                 PL_thistoken = newSVpvn(tstart, s - tstart);
3651             }
3652         }
3653         if (PL_thismad) /* install head */
3654             CURMAD('X', PL_thistoken);
3655     }
3656
3657     /* last whitespace of a sublex? */
3658     if (optype == ')' && PL_endwhite) {
3659         CURMAD('X', PL_endwhite);
3660     }
3661
3662     if (!PL_thismad) {
3663
3664         /* if no whitespace and we're at EOF, bail.  Otherwise fake EOF below. */
3665         if (!PL_thiswhite && !PL_endwhite && !optype) {
3666             sv_free(PL_thistoken);
3667             PL_thistoken = 0;
3668             return 0;
3669         }
3670
3671         /* put off final whitespace till peg */
3672         if (optype == ';' && !PL_rsfp) {
3673             PL_nextwhite = PL_thiswhite;
3674             PL_thiswhite = 0;
3675         }
3676         else if (PL_thisopen) {
3677             CURMAD('q', PL_thisopen);
3678             if (PL_thistoken)
3679                 sv_free(PL_thistoken);
3680             PL_thistoken = 0;
3681         }
3682         else {
3683             /* Store actual token text as madprop X */
3684             CURMAD('X', PL_thistoken);
3685         }
3686
3687         if (PL_thiswhite) {
3688             /* add preceding whitespace as madprop _ */
3689             CURMAD('_', PL_thiswhite);
3690         }
3691
3692         if (PL_thisstuff) {
3693             /* add quoted material as madprop = */
3694             CURMAD('=', PL_thisstuff);
3695         }
3696
3697         if (PL_thisclose) {
3698             /* add terminating quote as madprop Q */
3699             CURMAD('Q', PL_thisclose);
3700         }
3701     }
3702
3703     /* special processing based on optype */
3704
3705     switch (optype) {
3706
3707     /* opval doesn't need a TOKEN since it can already store mp */
3708     case WORD:
3709     case METHOD:
3710     case FUNCMETH:
3711     case THING:
3712     case PMFUNC:
3713     case PRIVATEREF:
3714     case FUNC0SUB:
3715     case UNIOPSUB:
3716     case LSTOPSUB:
3717         if (pl_yylval.opval)
3718             append_madprops(PL_thismad, pl_yylval.opval, 0);
3719         PL_thismad = 0;
3720         return optype;
3721
3722     /* fake EOF */
3723     case 0:
3724         optype = PEG;
3725         if (PL_endwhite) {
3726             addmad(newMADsv('p', PL_endwhite), &PL_thismad, 0);
3727             PL_endwhite = 0;
3728         }
3729         break;
3730
3731     case ']':
3732     case '}':
3733         if (PL_faketokens)
3734             break;
3735         /* remember any fake bracket that lexer is about to discard */ 
3736         if (PL_lex_brackets == 1 &&
3737             ((expectation)PL_lex_brackstack[0] & XFAKEBRACK))
3738         {
3739             s = PL_bufptr;
3740             while (s < PL_bufend && (*s == ' ' || *s == '\t'))
3741                 s++;
3742             if (*s == '}') {
3743                 PL_thiswhite = newSVpvn(PL_bufptr, ++s - PL_bufptr);
3744                 addmad(newMADsv('#', PL_thiswhite), &PL_thismad, 0);
3745                 PL_thiswhite = 0;
3746                 PL_bufptr = s - 1;
3747                 break;  /* don't bother looking for trailing comment */
3748             }
3749             else
3750                 s = PL_bufptr;
3751         }
3752         if (optype == ']')
3753             break;
3754         /* FALLTHROUGH */
3755
3756     /* attach a trailing comment to its statement instead of next token */
3757     case ';':
3758         if (PL_faketokens)
3759             break;
3760         if (PL_bufptr > PL_oldbufptr && PL_bufptr[-1] == optype) {
3761             s = PL_bufptr;
3762             while (s < PL_bufend && (*s == ' ' || *s == '\t'))
3763                 s++;
3764             if (*s == '\n' || *s == '#') {
3765                 while (s < PL_bufend && *s != '\n')
3766                     s++;
3767                 if (s < PL_bufend)
3768                     s++;
3769                 PL_thiswhite = newSVpvn(PL_bufptr, s - PL_bufptr);
3770                 addmad(newMADsv('#', PL_thiswhite), &PL_thismad, 0);
3771                 PL_thiswhite = 0;
3772                 PL_bufptr = s;
3773             }
3774         }
3775         break;
3776
3777     /* pval */
3778     case LABEL:
3779         break;
3780
3781     /* ival */
3782     default:
3783         break;
3784
3785     }
3786
3787     /* Create new token struct.  Note: opvals return early above. */
3788     pl_yylval.tkval = newTOKEN(optype, pl_yylval, PL_thismad);
3789     PL_thismad = 0;
3790     return optype;
3791 }
3792 #endif
3793
3794 STATIC char *
3795 S_tokenize_use(pTHX_ int is_use, char *s) {
3796     dVAR;
3797
3798     PERL_ARGS_ASSERT_TOKENIZE_USE;
3799
3800     if (PL_expect != XSTATE)
3801         yyerror(Perl_form(aTHX_ "\"%s\" not allowed in expression",
3802                     is_use ? "use" : "no"));
3803     s = SKIPSPACE1(s);
3804     if (isDIGIT(*s) || (*s == 'v' && isDIGIT(s[1]))) {
3805         s = force_version(s, TRUE);
3806         if (*s == ';' || *s == '}'
3807                 || (s = SKIPSPACE1(s), (*s == ';' || *s == '}'))) {
3808             start_force(PL_curforce);
3809             NEXTVAL_NEXTTOKE.opval = NULL;
3810             force_next(WORD);
3811         }
3812         else if (*s == 'v') {
3813             s = force_word(s,WORD,FALSE,TRUE,FALSE);
3814             s = force_version(s, FALSE);
3815         }
3816     }
3817     else {
3818         s = force_word(s,WORD,FALSE,TRUE,FALSE);
3819         s = force_version(s, FALSE);
3820     }
3821     pl_yylval.ival = is_use;
3822     return s;
3823 }
3824 #ifdef DEBUGGING
3825     static const char* const exp_name[] =
3826         { "OPERATOR", "TERM", "REF", "STATE", "BLOCK", "ATTRBLOCK",
3827           "ATTRTERM", "TERMBLOCK", "TERMORDORDOR"
3828         };
3829 #endif
3830
3831 /*
3832   yylex
3833
3834   Works out what to call the token just pulled out of the input
3835   stream.  The yacc parser takes care of taking the ops we return and
3836   stitching them into a tree.
3837
3838   Returns:
3839     PRIVATEREF
3840
3841   Structure:
3842       if read an identifier
3843           if we're in a my declaration
3844               croak if they tried to say my($foo::bar)
3845               build the ops for a my() declaration
3846           if it's an access to a my() variable
3847               are we in a sort block?
3848                   croak if my($a); $a <=> $b
3849               build ops for access to a my() variable
3850           if in a dq string, and they've said @foo and we can't find @foo
3851               croak
3852           build ops for a bareword
3853       if we already built the token before, use it.
3854 */
3855
3856
3857 #ifdef __SC__
3858 #pragma segment Perl_yylex
3859 #endif
3860 int
3861 Perl_yylex(pTHX)
3862 {
3863     dVAR;
3864     register char *s = PL_bufptr;
3865     register char *d;
3866     STRLEN len;
3867     bool bof = FALSE;
3868     U32 fake_eof = 0;
3869
3870     /* orig_keyword, gvp, and gv are initialized here because
3871      * jump to the label just_a_word_zero can bypass their
3872      * initialization later. */
3873     I32 orig_keyword = 0;
3874     GV *gv = NULL;
3875     GV **gvp = NULL;
3876
3877     DEBUG_T( {
3878         SV* tmp = newSVpvs("");
3879         PerlIO_printf(Perl_debug_log, "### %"IVdf":LEX_%s/X%s %s\n",
3880             (IV)CopLINE(PL_curcop),
3881             lex_state_names[PL_lex_state],
3882             exp_name[PL_expect],
3883             pv_display(tmp, s, strlen(s), 0, 60));
3884         SvREFCNT_dec(tmp);
3885     } );
3886     /* check if there's an identifier for us to look at */
3887     if (PL_pending_ident)
3888         return REPORT(S_pending_ident(aTHX));
3889
3890     /* no identifier pending identification */
3891
3892     switch (PL_lex_state) {
3893 #ifdef COMMENTARY
3894     case LEX_NORMAL:            /* Some compilers will produce faster */
3895     case LEX_INTERPNORMAL:      /* code if we comment these out. */
3896         break;
3897 #endif
3898
3899     /* when we've already built the next token, just pull it out of the queue */
3900     case LEX_KNOWNEXT:
3901 #ifdef PERL_MAD
3902         PL_lasttoke--;
3903         pl_yylval = PL_nexttoke[PL_lasttoke].next_val;
3904         if (PL_madskills) {
3905             PL_thismad = PL_nexttoke[PL_lasttoke].next_mad;
3906             PL_nexttoke[PL_lasttoke].next_mad = 0;
3907             if (PL_thismad && PL_thismad->mad_key == '_') {
3908                 PL_thiswhite = MUTABLE_SV(PL_thismad->mad_val);
3909                 PL_thismad->mad_val = 0;
3910                 mad_free(PL_thismad);
3911                 PL_thismad = 0;
3912             }
3913         }
3914         if (!PL_lasttoke) {
3915             PL_lex_state = PL_lex_defer;
3916             PL_expect = PL_lex_expect;
3917             PL_lex_defer = LEX_NORMAL;
3918             if (!PL_nexttoke[PL_lasttoke].next_type)
3919                 return yylex();
3920         }
3921 #else
3922         PL_nexttoke--;
3923         pl_yylval = PL_nextval[PL_nexttoke];
3924         if (!PL_nexttoke) {
3925             PL_lex_state = PL_lex_defer;
3926             PL_expect = PL_lex_expect;
3927             PL_lex_defer = LEX_NORMAL;
3928         }
3929 #endif
3930 #ifdef PERL_MAD
3931         /* FIXME - can these be merged?  */
3932         return(PL_nexttoke[PL_lasttoke].next_type);
3933 #else
3934         return REPORT(PL_nexttype[PL_nexttoke]);
3935 #endif
3936
3937     /* interpolated case modifiers like \L \U, including \Q and \E.
3938        when we get here, PL_bufptr is at the \
3939     */
3940     case LEX_INTERPCASEMOD:
3941 #ifdef DEBUGGING
3942         if (PL_bufptr != PL_bufend && *PL_bufptr != '\\')
3943             Perl_croak(aTHX_ "panic: INTERPCASEMOD");
3944 #endif
3945         /* handle \E or end of string */
3946         if (PL_bufptr == PL_bufend || PL_bufptr[1] == 'E') {
3947             /* if at a \E */
3948             if (PL_lex_casemods) {
3949                 const char oldmod = PL_lex_casestack[--PL_lex_casemods];
3950                 PL_lex_casestack[PL_lex_casemods] = '\0';
3951
3952                 if (PL_bufptr != PL_bufend
3953                     && (oldmod == 'L' || oldmod == 'U' || oldmod == 'Q')) {
3954                     PL_bufptr += 2;
3955                     PL_lex_state = LEX_INTERPCONCAT;
3956 #ifdef PERL_MAD
3957                     if (PL_madskills)
3958                         PL_thistoken = newSVpvs("\\E");
3959 #endif
3960                 }
3961                 return REPORT(')');
3962             }
3963 #ifdef PERL_MAD
3964             while (PL_bufptr != PL_bufend &&
3965               PL_bufptr[0] == '\\' && PL_bufptr[1] == 'E') {
3966                 if (!PL_thiswhite)
3967                     PL_thiswhite = newSVpvs("");
3968                 sv_catpvn(PL_thiswhite, PL_bufptr, 2);
3969                 PL_bufptr += 2;
3970             }
3971 #else
3972             if (PL_bufptr != PL_bufend)
3973                 PL_bufptr += 2;
3974 #endif
3975             PL_lex_state = LEX_INTERPCONCAT;
3976             return yylex();
3977         }
3978         else {
3979             DEBUG_T({ PerlIO_printf(Perl_debug_log,
3980               "### Saw case modifier\n"); });
3981             s = PL_bufptr + 1;
3982             if (s[1] == '\\' && s[2] == 'E') {
3983 #ifdef PERL_MAD
3984                 if (!PL_thiswhite)
3985                     PL_thiswhite = newSVpvs("");
3986                 sv_catpvn(PL_thiswhite, PL_bufptr, 4);
3987 #endif
3988                 PL_bufptr = s + 3;
3989                 PL_lex_state = LEX_INTERPCONCAT;
3990                 return yylex();
3991             }
3992             else {
3993                 I32 tmp;
3994                 if (!PL_madskills) /* when just compiling don't need correct */
3995                     if (strnEQ(s, "L\\u", 3) || strnEQ(s, "U\\l", 3))
3996                         tmp = *s, *s = s[2], s[2] = (char)tmp;  /* misordered... */
3997                 if ((*s == 'L' || *s == 'U') &&
3998                     (strchr(PL_lex_casestack, 'L') || strchr(PL_lex_casestack, 'U'))) {
3999                     PL_lex_casestack[--PL_lex_casemods] = '\0';
4000                     return REPORT(')');
4001                 }
4002                 if (PL_lex_casemods > 10)
4003                     Renew(PL_lex_casestack, PL_lex_casemods + 2, char);
4004                 PL_lex_casestack[PL_lex_casemods++] = *s;
4005                 PL_lex_casestack[PL_lex_casemods] = '\0';
4006                 PL_lex_state = LEX_INTERPCONCAT;
4007                 start_force(PL_curforce);
4008                 NEXTVAL_NEXTTOKE.ival = 0;
4009                 force_next('(');
4010                 start_force(PL_curforce);
4011                 if (*s == 'l')
4012                     NEXTVAL_NEXTTOKE.ival = OP_LCFIRST;
4013                 else if (*s == 'u')
4014                     NEXTVAL_NEXTTOKE.ival = OP_UCFIRST;
4015                 else if (*s == 'L')
4016                     NEXTVAL_NEXTTOKE.ival = OP_LC;
4017                 else if (*s == 'U')
4018                     NEXTVAL_NEXTTOKE.ival = OP_UC;
4019                 else if (*s == 'Q')
4020                     NEXTVAL_NEXTTOKE.ival = OP_QUOTEMETA;
4021                 else
4022                     Perl_croak(aTHX_ "panic: yylex");
4023                 if (PL_madskills) {
4024                     SV* const tmpsv = newSVpvs("\\ ");
4025                     /* replace the space with the character we want to escape
4026                      */
4027                     SvPVX(tmpsv)[1] = *s;
4028                     curmad('_', tmpsv);
4029                 }
4030                 PL_bufptr = s + 1;
4031             }
4032             force_next(FUNC);
4033             if (PL_lex_starts) {
4034                 s = PL_bufptr;
4035                 PL_lex_starts = 0;
4036 #ifdef PERL_MAD
4037                 if (PL_madskills) {
4038                     if (PL_thistoken)
4039                         sv_free(PL_thistoken);
4040                     PL_thistoken = newSVpvs("");
4041                 }
4042 #endif
4043                 /* commas only at base level: /$a\Ub$c/ => ($a,uc(b.$c)) */
4044                 if (PL_lex_casemods == 1 && PL_lex_inpat)
4045                     OPERATOR(',');
4046                 else
4047                     Aop(OP_CONCAT);
4048             }
4049             else
4050                 return yylex();
4051         }
4052
4053     case LEX_INTERPPUSH:
4054         return REPORT(sublex_push());
4055
4056     case LEX_INTERPSTART:
4057         if (PL_bufptr == PL_bufend)
4058             return REPORT(sublex_done());
4059         DEBUG_T({ PerlIO_printf(Perl_debug_log,
4060               "### Interpolated variable\n"); });
4061         PL_expect = XTERM;
4062         PL_lex_dojoin = (*PL_bufptr == '@');
4063         PL_lex_state = LEX_INTERPNORMAL;
4064         if (PL_lex_dojoin) {
4065             start_force(PL_curforce);
4066             NEXTVAL_NEXTTOKE.ival = 0;
4067             force_next(',');
4068             start_force(PL_curforce);
4069             force_ident("\"", '$');
4070             start_force(PL_curforce);
4071             NEXTVAL_NEXTTOKE.ival = 0;
4072             force_next('$');
4073             start_force(PL_curforce);
4074             NEXTVAL_NEXTTOKE.ival = 0;
4075             force_next('(');
4076             start_force(PL_curforce);
4077             NEXTVAL_NEXTTOKE.ival = OP_JOIN;    /* emulate join($", ...) */
4078             force_next(FUNC);
4079         }
4080         if (PL_lex_starts++) {
4081             s = PL_bufptr;
4082 #ifdef PERL_MAD
4083             if (PL_madskills) {
4084                 if (PL_thistoken)
4085                     sv_free(PL_thistoken);
4086                 PL_thistoken = newSVpvs("");
4087             }
4088 #endif
4089             /* commas only at base level: /$a\Ub$c/ => ($a,uc(b.$c)) */
4090             if (!PL_lex_casemods && PL_lex_inpat)
4091                 OPERATOR(',');
4092             else
4093                 Aop(OP_CONCAT);
4094         }
4095         return yylex();
4096
4097     case LEX_INTERPENDMAYBE:
4098         if (intuit_more(PL_bufptr)) {
4099             PL_lex_state = LEX_INTERPNORMAL;    /* false alarm, more expr */
4100             break;
4101         }
4102         /* FALL THROUGH */
4103
4104     case LEX_INTERPEND:
4105         if (PL_lex_dojoin) {
4106             PL_lex_dojoin = FALSE;
4107             PL_lex_state = LEX_INTERPCONCAT;
4108 #ifdef PERL_MAD
4109             if (PL_madskills) {
4110                 if (PL_thistoken)
4111                     sv_free(PL_thistoken);
4112                 PL_thistoken = newSVpvs("");
4113             }
4114 #endif
4115             return REPORT(')');
4116         }
4117         if (PL_lex_inwhat == OP_SUBST && PL_linestr == PL_lex_repl
4118             && SvEVALED(PL_lex_repl))
4119         {
4120             if (PL_bufptr != PL_bufend)
4121                 Perl_croak(aTHX_ "Bad evalled substitution pattern");
4122             PL_lex_repl = NULL;
4123         }
4124         /* FALLTHROUGH */
4125     case LEX_INTERPCONCAT:
4126 #ifdef DEBUGGING
4127         if (PL_lex_brackets)
4128             Perl_croak(aTHX_ "panic: INTERPCONCAT");
4129 #endif
4130         if (PL_bufptr == PL_bufend)
4131             return REPORT(sublex_done());
4132
4133         if (SvIVX(PL_linestr) == '\'') {
4134             SV *sv = newSVsv(PL_linestr);
4135             if (!PL_lex_inpat)
4136                 sv = tokeq(sv);
4137             else if ( PL_hints & HINT_NEW_RE )
4138                 sv = new_constant(NULL, 0, "qr", sv, sv, "q", 1);
4139             pl_yylval.opval = (OP*)newSVOP(OP_CONST, 0, sv);
4140             s = PL_bufend;
4141         }
4142         else {
4143             s = scan_const(PL_bufptr);
4144             if (*s == '\\')
4145                 PL_lex_state = LEX_INTERPCASEMOD;
4146             else
4147                 PL_lex_state = LEX_INTERPSTART;
4148         }
4149
4150         if (s != PL_bufptr) {
4151             start_force(PL_curforce);
4152             if (PL_madskills) {
4153                 curmad('X', newSVpvn(PL_bufptr,s-PL_bufptr));
4154             }
4155             NEXTVAL_NEXTTOKE = pl_yylval;
4156             PL_expect = XTERM;
4157             force_next(THING);
4158             if (PL_lex_starts++) {
4159 #ifdef PERL_MAD
4160                 if (PL_madskills) {
4161                     if (PL_thistoken)
4162                         sv_free(PL_thistoken);
4163                     PL_thistoken = newSVpvs("");
4164                 }
4165 #endif
4166                 /* commas only at base level: /$a\Ub$c/ => ($a,uc(b.$c)) */
4167                 if (!PL_lex_casemods && PL_lex_inpat)
4168                     OPERATOR(',');
4169                 else
4170                     Aop(OP_CONCAT);
4171             }
4172             else {
4173                 PL_bufptr = s;
4174                 return yylex();
4175             }
4176         }
4177
4178         return yylex();
4179     case LEX_FORMLINE:
4180         PL_lex_state = LEX_NORMAL;
4181         s = scan_formline(PL_bufptr);
4182         if (!PL_lex_formbrack)
4183             goto rightbracket;
4184         OPERATOR(';');
4185     }
4186
4187     s = PL_bufptr;
4188     PL_oldoldbufptr = PL_oldbufptr;
4189     PL_oldbufptr = s;
4190
4191   retry:
4192 #ifdef PERL_MAD
4193     if (PL_thistoken) {
4194         sv_free(PL_thistoken);
4195         PL_thistoken = 0;
4196     }
4197     PL_realtokenstart = s - SvPVX(PL_linestr);  /* assume but undo on ws */
4198 #endif
4199     switch (*s) {
4200     default:
4201         if (isIDFIRST_lazy_if(s,UTF))
4202             goto keylookup;
4203         {
4204         unsigned char c = *s;
4205         len = UTF ? Perl_utf8_length(aTHX_ (U8 *) PL_linestart, (U8 *) s) : (STRLEN) (s - PL_linestart);
4206         if (len > UNRECOGNIZED_PRECEDE_COUNT) {
4207             d = UTF ? (char *) Perl_utf8_hop(aTHX_ (U8 *) s, -UNRECOGNIZED_PRECEDE_COUNT) : s - UNRECOGNIZED_PRECEDE_COUNT;
4208         } else {
4209             d = PL_linestart;
4210         }       
4211         *s = '\0';
4212         Perl_croak(aTHX_ "Unrecognized character \\x%02X; marked by <-- HERE after %s<-- HERE near column %d", c, d, (int) len + 1);
4213     }
4214     case 4:
4215     case 26:
4216         goto fake_eof;                  /* emulate EOF on ^D or ^Z */
4217     case 0:
4218 #ifdef PERL_MAD
4219         if (PL_madskills)
4220             PL_faketokens = 0;
4221 #endif
4222         if (!PL_rsfp) {
4223             PL_last_uni = 0;
4224             PL_last_lop = 0;
4225             if (PL_lex_brackets) {
4226                 yyerror((const char *)
4227                         (PL_lex_formbrack
4228                          ? "Format not terminated"
4229                          : "Missing right curly or square bracket"));
4230             }
4231             DEBUG_T( { PerlIO_printf(Perl_debug_log,
4232                         "### Tokener got EOF\n");
4233             } );
4234             TOKEN(0);
4235         }
4236         if (s++ < PL_bufend)
4237             goto retry;                 /* ignore stray nulls */
4238         PL_last_uni = 0;
4239         PL_last_lop = 0;
4240         if (!PL_in_eval && !PL_preambled) {
4241             PL_preambled = TRUE;
4242 #ifdef PERL_MAD
4243             if (PL_madskills)
4244                 PL_faketokens = 1;
4245 #endif
4246             if (PL_perldb) {
4247                 /* Generate a string of Perl code to load the debugger.
4248                  * If PERL5DB is set, it will return the contents of that,
4249                  * otherwise a compile-time require of perl5db.pl.  */
4250
4251                 const char * const pdb = PerlEnv_getenv("PERL5DB");
4252
4253                 if (pdb) {
4254                     sv_setpv(PL_linestr, pdb);
4255                     sv_catpvs(PL_linestr,";");
4256                 } else {
4257                     SETERRNO(0,SS_NORMAL);
4258                     sv_setpvs(PL_linestr, "BEGIN { require 'perl5db.pl' };");
4259                 }
4260             } else
4261                 sv_setpvs(PL_linestr,"");
4262             if (PL_preambleav) {
4263                 SV **svp = AvARRAY(PL_preambleav);
4264                 SV **const end = svp + AvFILLp(PL_preambleav);
4265                 while(svp <= end) {
4266                     sv_catsv(PL_linestr, *svp);
4267                     ++svp;
4268                     sv_catpvs(PL_linestr, ";");
4269                 }
4270                 sv_free(MUTABLE_SV(PL_preambleav));
4271                 PL_preambleav = NULL;
4272             }
4273             if (PL_minus_E)
4274                 sv_catpvs(PL_linestr,
4275                           "use feature ':5." STRINGIFY(PERL_VERSION) "';");
4276             if (PL_minus_n || PL_minus_p) {
4277                 sv_catpvs(PL_linestr, "LINE: while (<>) {"/*}*/);
4278                 if (PL_minus_l)
4279                     sv_catpvs(PL_linestr,"chomp;");
4280                 if (PL_minus_a) {
4281                     if (PL_minus_F) {
4282                         if ((*PL_splitstr == '/' || *PL_splitstr == '\''
4283                              || *PL_splitstr == '"')
4284                               && strchr(PL_splitstr + 1, *PL_splitstr))
4285                             Perl_sv_catpvf(aTHX_ PL_linestr, "our @F=split(%s);", PL_splitstr);
4286                         else {
4287                             /* "q\0${splitstr}\0" is legal perl. Yes, even NUL
4288                                bytes can be used as quoting characters.  :-) */
4289                             const char *splits = PL_splitstr;
4290                             sv_catpvs(PL_linestr, "our @F=split(q\0");
4291                             do {
4292                                 /* Need to \ \s  */
4293                                 if (*splits == '\\')
4294                                     sv_catpvn(PL_linestr, splits, 1);
4295                                 sv_catpvn(PL_linestr, splits, 1);
4296                             } while (*splits++);
4297                             /* This loop will embed the trailing NUL of
4298                                PL_linestr as the last thing it does before
4299                                terminating.  */
4300                             sv_catpvs(PL_linestr, ");");
4301                         }
4302                     }
4303                     else
4304                         sv_catpvs(PL_linestr,"our @F=split(' ');");
4305                 }
4306             }
4307             sv_catpvs(PL_linestr, "\n");
4308             PL_oldoldbufptr = PL_oldbufptr = s = PL_linestart = SvPVX(PL_linestr);
4309             PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
4310             PL_last_lop = PL_last_uni = NULL;
4311             if ((PERLDB_LINE || PERLDB_SAVESRC) && PL_curstash != PL_debstash)
4312                 update_debugger_info(PL_linestr, NULL, 0);
4313             goto retry;
4314         }
4315         do {
4316             fake_eof = 0;
4317             bof = PL_rsfp ? TRUE : FALSE;
4318             if (0) {
4319               fake_eof:
4320                 fake_eof = LEX_FAKE_EOF;
4321             }
4322             PL_bufptr = PL_bufend;
4323             CopLINE_inc(PL_curcop);
4324             if (!lex_next_chunk(fake_eof)) {
4325                 CopLINE_dec(PL_curcop);
4326                 s = PL_bufptr;
4327                 TOKEN(';');     /* not infinite loop because rsfp is NULL now */
4328             }
4329             CopLINE_dec(PL_curcop);
4330 #ifdef PERL_MAD
4331             if (!PL_rsfp)
4332                 PL_realtokenstart = -1;
4333 #endif
4334             s = PL_bufptr;
4335             /* If it looks like the start of a BOM or raw UTF-16,
4336              * check if it in fact is. */
4337             if (bof && PL_rsfp &&
4338                      (*s == 0 ||
4339                       *(U8*)s == 0xEF ||
4340                       *(U8*)s >= 0xFE ||
4341                       s[1] == 0)) {
4342                 bof = PerlIO_tell(PL_rsfp) == (Off_t)SvCUR(PL_linestr);
4343                 if (bof) {
4344                     PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
4345                     s = swallow_bom((U8*)s);
4346                 }
4347             }
4348             if (PL_doextract) {
4349                 /* Incest with pod. */
4350 #ifdef PERL_MAD
4351                 if (PL_madskills)
4352                     sv_catsv(PL_thiswhite, PL_linestr);
4353 #endif
4354                 if (*s == '=' && strnEQ(s, "=cut", 4) && !isALPHA(s[4])) {
4355                     sv_setpvs(PL_linestr, "");
4356                     PL_oldoldbufptr = PL_oldbufptr = s = PL_linestart = SvPVX(PL_linestr);
4357                     PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
4358                     PL_last_lop = PL_last_uni = NULL;
4359                     PL_doextract = FALSE;
4360                 }
4361             }
4362             if (PL_rsfp)
4363                 incline(s);
4364         } while (PL_doextract);
4365         PL_oldoldbufptr = PL_oldbufptr = PL_bufptr = PL_linestart = s;
4366         PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
4367         PL_last_lop = PL_last_uni = NULL;
4368         if (CopLINE(PL_curcop) == 1) {
4369             while (s < PL_bufend && isSPACE(*s))
4370                 s++;
4371             if (*s == ':' && s[1] != ':') /* for csh execing sh scripts */
4372                 s++;
4373 #ifdef PERL_MAD
4374             if (PL_madskills)
4375                 PL_thiswhite = newSVpvn(PL_linestart, s - PL_linestart);
4376 #endif
4377             d = NULL;
4378             if (!PL_in_eval) {
4379                 if (*s == '#' && *(s+1) == '!')
4380                     d = s + 2;
4381 #ifdef ALTERNATE_SHEBANG
4382                 else {
4383                     static char const as[] = ALTERNATE_SHEBANG;
4384                     if (*s == as[0] && strnEQ(s, as, sizeof(as) - 1))
4385                         d = s + (sizeof(as) - 1);
4386                 }
4387 #endif /* ALTERNATE_SHEBANG */
4388             }
4389             if (d) {
4390                 char *ipath;
4391                 char *ipathend;
4392
4393                 while (isSPACE(*d))
4394                     d++;
4395                 ipath = d;
4396                 while (*d && !isSPACE(*d))
4397                     d++;
4398                 ipathend = d;
4399
4400 #ifdef ARG_ZERO_IS_SCRIPT
4401                 if (ipathend > ipath) {
4402                     /*
4403                      * HP-UX (at least) sets argv[0] to the script name,
4404                      * which makes $^X incorrect.  And Digital UNIX and Linux,
4405                      * at least, set argv[0] to the basename of the Perl
4406                      * interpreter. So, having found "#!", we'll set it right.
4407                      */
4408                     SV * const x = GvSV(gv_fetchpvs("\030", GV_ADD|GV_NOTQUAL,
4409                                                     SVt_PV)); /* $^X */
4410                     assert(SvPOK(x) || SvGMAGICAL(x));
4411                     if (sv_eq(x, CopFILESV(PL_curcop))) {
4412                         sv_setpvn(x, ipath, ipathend - ipath);
4413                         SvSETMAGIC(x);
4414                     }
4415                     else {
4416                         STRLEN blen;
4417                         STRLEN llen;
4418                         const char *bstart = SvPV_const(CopFILESV(PL_curcop),blen);
4419                         const char * const lstart = SvPV_const(x,llen);
4420                         if (llen < blen) {
4421                             bstart += blen - llen;
4422                             if (strnEQ(bstart, lstart, llen) && bstart[-1] == '/') {
4423                                 sv_setpvn(x, ipath, ipathend - ipath);
4424                                 SvSETMAGIC(x);
4425                             }
4426                         }
4427                     }
4428                     TAINT_NOT;  /* $^X is always tainted, but that's OK */
4429                 }
4430 #endif /* ARG_ZERO_IS_SCRIPT */
4431
4432                 /*
4433                  * Look for options.
4434                  */
4435                 d = instr(s,"perl -");
4436                 if (!d) {
4437                     d = instr(s,"perl");
4438 #if defined(DOSISH)
4439                     /* avoid getting into infinite loops when shebang
4440                      * line contains "Perl" rather than "perl" */
4441                     if (!d) {
4442                         for (d = ipathend-4; d >= ipath; --d) {
4443                             if ((*d == 'p' || *d == 'P')
4444                                 && !ibcmp(d, "perl", 4))
4445                             {
4446                                 break;
4447                             }
4448                         }
4449                         if (d < ipath)
4450                             d = NULL;
4451                     }
4452 #endif
4453                 }
4454 #ifdef ALTERNATE_SHEBANG
4455                 /*
4456                  * If the ALTERNATE_SHEBANG on this system starts with a
4457                  * character that can be part of a Perl expression, then if
4458                  * we see it but not "perl", we're probably looking at the
4459                  * start of Perl code, not a request to hand off to some
4460                  * other interpreter.  Similarly, if "perl" is there, but
4461                  * not in the first 'word' of the line, we assume the line
4462                  * contains the start of the Perl program.
4463                  */
4464                 if (d && *s != '#') {
4465                     const char *c = ipath;
4466                     while (*c && !strchr("; \t\r\n\f\v#", *c))
4467                         c++;
4468                     if (c < d)
4469                         d = NULL;       /* "perl" not in first word; ignore */
4470                     else
4471                         *s = '#';       /* Don't try to parse shebang line */
4472                 }
4473 #endif /* ALTERNATE_SHEBANG */
4474                 if (!d &&
4475                     *s == '#' &&
4476                     ipathend > ipath &&
4477                     !PL_minus_c &&
4478                     !instr(s,"indir") &&
4479                     instr(PL_origargv[0],"perl"))
4480                 {
4481                     dVAR;
4482                     char **newargv;
4483
4484                     *ipathend = '\0';
4485                     s = ipathend + 1;
4486                     while (s < PL_bufend && isSPACE(*s))
4487                         s++;
4488                     if (s < PL_bufend) {
4489                         Newx(newargv,PL_origargc+3,char*);
4490                         newargv[1] = s;
4491                         while (s < PL_bufend && !isSPACE(*s))
4492                             s++;
4493                         *s = '\0';
4494                         Copy(PL_origargv+1, newargv+2, PL_origargc+1, char*);
4495                     }
4496                     else
4497                         newargv = PL_origargv;
4498                     newargv[0] = ipath;
4499                     PERL_FPU_PRE_EXEC
4500                     PerlProc_execv(ipath, EXEC_ARGV_CAST(newargv));
4501                     PERL_FPU_POST_EXEC
4502                     Perl_croak(aTHX_ "Can't exec %s", ipath);
4503                 }
4504                 if (d) {
4505                     while (*d && !isSPACE(*d))
4506                         d++;
4507                     while (SPACE_OR_TAB(*d))
4508                         d++;
4509
4510                     if (*d++ == '-') {
4511                         const bool switches_done = PL_doswitches;
4512                         const U32 oldpdb = PL_perldb;
4513                         const bool oldn = PL_minus_n;
4514                         const bool oldp = PL_minus_p;
4515                         const char *d1 = d;
4516
4517                         do {
4518                             bool baduni = FALSE;
4519                             if (*d1 == 'C') {
4520                                 const char *d2 = d1 + 1;
4521                                 if (parse_unicode_opts((const char **)&d2)
4522                                     != PL_unicode)
4523                                     baduni = TRUE;
4524                             }
4525                             if (baduni || *d1 == 'M' || *d1 == 'm') {
4526                                 const char * const m = d1;
4527                                 while (*d1 && !isSPACE(*d1))
4528                                     d1++;
4529                                 Perl_croak(aTHX_ "Too late for \"-%.*s\" option",
4530                                       (int)(d1 - m), m);
4531                             }
4532                             d1 = moreswitches(d1);
4533                         } while (d1);
4534                         if (PL_doswitches && !switches_done) {
4535                             int argc = PL_origargc;
4536                             char **argv = PL_origargv;