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