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