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