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