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