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