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