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