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