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
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.
12 * 'It all comes from here, the stench and the peril.' --Frodo
14 * [p.719 of _The Lord of the Rings_, IV/ix: "Shelob's Lair"]
18 * This file is the lexer for Perl. It's closely linked to the
21 * The main routine is yylex(), which returns the next token.
25 =head1 Lexer interface
27 This is the lower layer of the Perl parser, managing characters and tokens.
29 =for apidoc AmU|yy_parser *|PL_parser
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.
40 #define PERL_IN_TOKE_C
42 #include "dquote_static.c"
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)
47 #define pl_yylval (PL_parser->yylval)
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_preambled (PL_parser->preambled)
70 #define PL_sublex_info (PL_parser->sublex_info)
71 #define PL_linestr (PL_parser->linestr)
72 #define PL_expect (PL_parser->expect)
73 #define PL_copline (PL_parser->copline)
74 #define PL_bufptr (PL_parser->bufptr)
75 #define PL_oldbufptr (PL_parser->oldbufptr)
76 #define PL_oldoldbufptr (PL_parser->oldoldbufptr)
77 #define PL_linestart (PL_parser->linestart)
78 #define PL_bufend (PL_parser->bufend)
79 #define PL_last_uni (PL_parser->last_uni)
80 #define PL_last_lop (PL_parser->last_lop)
81 #define PL_last_lop_op (PL_parser->last_lop_op)
82 #define PL_lex_state (PL_parser->lex_state)
83 #define PL_rsfp (PL_parser->rsfp)
84 #define PL_rsfp_filters (PL_parser->rsfp_filters)
85 #define PL_in_my (PL_parser->in_my)
86 #define PL_in_my_stash (PL_parser->in_my_stash)
87 #define PL_tokenbuf (PL_parser->tokenbuf)
88 #define PL_multi_end (PL_parser->multi_end)
89 #define PL_error_count (PL_parser->error_count)
92 # define PL_endwhite (PL_parser->endwhite)
93 # define PL_faketokens (PL_parser->faketokens)
94 # define PL_lasttoke (PL_parser->lasttoke)
95 # define PL_nextwhite (PL_parser->nextwhite)
96 # define PL_realtokenstart (PL_parser->realtokenstart)
97 # define PL_skipwhite (PL_parser->skipwhite)
98 # define PL_thisclose (PL_parser->thisclose)
99 # define PL_thismad (PL_parser->thismad)
100 # define PL_thisopen (PL_parser->thisopen)
101 # define PL_thisstuff (PL_parser->thisstuff)
102 # define PL_thistoken (PL_parser->thistoken)
103 # define PL_thiswhite (PL_parser->thiswhite)
104 # define PL_thiswhite (PL_parser->thiswhite)
105 # define PL_nexttoke (PL_parser->nexttoke)
106 # define PL_curforce (PL_parser->curforce)
108 # define PL_nexttoke (PL_parser->nexttoke)
109 # define PL_nexttype (PL_parser->nexttype)
110 # define PL_nextval (PL_parser->nextval)
113 static const char* const ident_too_long = "Identifier too long";
116 # define CURMAD(slot,sv) if (PL_madskills) { curmad(slot,sv); sv = 0; }
117 # define NEXTVAL_NEXTTOKE PL_nexttoke[PL_curforce].next_val
119 # define CURMAD(slot,sv)
120 # define NEXTVAL_NEXTTOKE PL_nextval[PL_nexttoke]
123 #define XENUMMASK 0x3f
124 #define XFAKEEOF 0x40
125 #define XFAKEBRACK 0x80
127 #ifdef USE_UTF8_SCRIPTS
128 # define UTF (!IN_BYTES)
130 # define UTF ((PL_linestr && DO_UTF8(PL_linestr)) || ( !(PL_parser->lex_flags & LEX_IGNORE_UTF8_HINTS) && (PL_hints & HINT_UTF8)))
133 /* The maximum number of characters preceding the unrecognized one to display */
134 #define UNRECOGNIZED_PRECEDE_COUNT 10
136 /* In variables named $^X, these are the legal values for X.
137 * 1999-02-27 mjd-perl-patch@plover.com */
138 #define isCONTROLVAR(x) (isUPPER(x) || strchr("[\\]^_?", (x)))
140 #define SPACE_OR_TAB(c) isBLANK_A(c)
142 /* LEX_* are values for PL_lex_state, the state of the lexer.
143 * They are arranged oddly so that the guard on the switch statement
144 * can get by with a single comparison (if the compiler is smart enough).
146 * These values refer to the various states within a sublex parse,
147 * i.e. within a double quotish string
150 /* #define LEX_NOTPARSING 11 is done in perl.h. */
152 #define LEX_NORMAL 10 /* normal code (ie not within "...") */
153 #define LEX_INTERPNORMAL 9 /* code within a string, eg "$foo[$x+1]" */
154 #define LEX_INTERPCASEMOD 8 /* expecting a \U, \Q or \E etc */
155 #define LEX_INTERPPUSH 7 /* starting a new sublex parse level */
156 #define LEX_INTERPSTART 6 /* expecting the start of a $var */
158 /* at end of code, eg "$x" followed by: */
159 #define LEX_INTERPEND 5 /* ... eg not one of [, { or -> */
160 #define LEX_INTERPENDMAYBE 4 /* ... eg one of [, { or -> */
162 #define LEX_INTERPCONCAT 3 /* expecting anything, eg at start of
163 string or after \E, $foo, etc */
164 #define LEX_INTERPCONST 2 /* NOT USED */
165 #define LEX_FORMLINE 1 /* expecting a format line */
166 #define LEX_KNOWNEXT 0 /* next token known; just return it */
170 static const char* const lex_state_names[] = {
189 #include "keywords.h"
191 /* CLINE is a macro that ensures PL_copline has a sane value */
196 #define CLINE (PL_copline = (CopLINE(PL_curcop) < PL_copline ? CopLINE(PL_curcop) : PL_copline))
199 # define SKIPSPACE0(s) skipspace0(s)
200 # define SKIPSPACE1(s) skipspace1(s)
201 # define SKIPSPACE2(s,tsv) skipspace2(s,&tsv)
202 # define PEEKSPACE(s) skipspace2(s,0)
204 # define SKIPSPACE0(s) skipspace(s)
205 # define SKIPSPACE1(s) skipspace(s)
206 # define SKIPSPACE2(s,tsv) skipspace(s)
207 # define PEEKSPACE(s) skipspace(s)
211 * Convenience functions to return different tokens and prime the
212 * lexer for the next token. They all take an argument.
214 * TOKEN : generic token (used for '(', DOLSHARP, etc)
215 * OPERATOR : generic operator
216 * AOPERATOR : assignment operator
217 * PREBLOCK : beginning the block after an if, while, foreach, ...
218 * PRETERMBLOCK : beginning a non-code-defining {} block (eg, hash ref)
219 * PREREF : *EXPR where EXPR is not a simple identifier
220 * TERM : expression term
221 * LOOPX : loop exiting command (goto, last, dump, etc)
222 * FTST : file test operator
223 * FUN0 : zero-argument function
224 * FUN0OP : zero-argument function, with its op created in this file
225 * FUN1 : not used, except for not, which isn't a UNIOP
226 * BOop : bitwise or or xor
228 * SHop : shift operator
229 * PWop : power operator
230 * PMop : pattern-matching operator
231 * Aop : addition-level operator
232 * Mop : multiplication-level operator
233 * Eop : equality-testing operator
234 * Rop : relational operator <= != gt
236 * Also see LOP and lop() below.
239 #ifdef DEBUGGING /* Serve -DT. */
240 # define REPORT(retval) tokereport((I32)retval, &pl_yylval)
242 # define REPORT(retval) (retval)
245 #define TOKEN(retval) return ( PL_bufptr = s, REPORT(retval))
246 #define OPERATOR(retval) return (PL_expect = XTERM, PL_bufptr = s, REPORT(retval))
247 #define AOPERATOR(retval) return ao((PL_expect = XTERM, PL_bufptr = s, REPORT(retval)))
248 #define PREBLOCK(retval) return (PL_expect = XBLOCK,PL_bufptr = s, REPORT(retval))
249 #define PRETERMBLOCK(retval) return (PL_expect = XTERMBLOCK,PL_bufptr = s, REPORT(retval))
250 #define PREREF(retval) return (PL_expect = XREF,PL_bufptr = s, REPORT(retval))
251 #define TERM(retval) return (CLINE, PL_expect = XOPERATOR, PL_bufptr = s, REPORT(retval))
252 #define LOOPX(f) return (pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)LOOPEX))
253 #define FTST(f) return (pl_yylval.ival=f, PL_expect=XTERMORDORDOR, PL_bufptr=s, REPORT((int)UNIOP))
254 #define FUN0(f) return (pl_yylval.ival=f, PL_expect=XOPERATOR, PL_bufptr=s, REPORT((int)FUNC0))
255 #define FUN0OP(f) return (pl_yylval.opval=f, CLINE, PL_expect=XOPERATOR, PL_bufptr=s, REPORT((int)FUNC0OP))
256 #define FUN1(f) return (pl_yylval.ival=f, PL_expect=XOPERATOR, PL_bufptr=s, REPORT((int)FUNC1))
257 #define BOop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)BITOROP)))
258 #define BAop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)BITANDOP)))
259 #define SHop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)SHIFTOP)))
260 #define PWop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)POWOP)))
261 #define PMop(f) return(pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)MATCHOP))
262 #define Aop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)ADDOP)))
263 #define Mop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)MULOP)))
264 #define Eop(f) return (pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)EQOP))
265 #define Rop(f) return (pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)RELOP))
267 /* This bit of chicanery makes a unary function followed by
268 * a parenthesis into a function with one argument, highest precedence.
269 * The UNIDOR macro is for unary functions that can be followed by the //
270 * operator (such as C<shift // 0>).
272 #define UNI3(f,x,have_x) { \
273 pl_yylval.ival = f; \
274 if (have_x) PL_expect = x; \
276 PL_last_uni = PL_oldbufptr; \
277 PL_last_lop_op = f; \
279 return REPORT( (int)FUNC1 ); \
281 return REPORT( *s=='(' ? (int)FUNC1 : (int)UNIOP ); \
283 #define UNI(f) UNI3(f,XTERM,1)
284 #define UNIDOR(f) UNI3(f,XTERMORDORDOR,1)
285 #define UNIPROTO(f,optional) { \
286 if (optional) PL_last_uni = PL_oldbufptr; \
290 #define UNIBRACK(f) UNI3(f,0,0)
292 /* grandfather return to old style */
295 if (!PL_lex_allbrackets && PL_lex_fakeeof > LEX_FAKEEOF_LOWLOGIC) \
296 PL_lex_fakeeof = LEX_FAKEEOF_LOWLOGIC; \
297 pl_yylval.ival = (f); \
303 #define COPLINE_INC_WITH_HERELINES \
305 CopLINE_inc(PL_curcop); \
306 if (PL_parser->lex_shared->herelines) \
307 CopLINE(PL_curcop) += PL_parser->lex_shared->herelines, \
308 PL_parser->lex_shared->herelines = 0; \
310 /* Called after scan_str to update CopLINE(PL_curcop), but only when there
311 * is no sublex_push to follow. */
312 #define COPLINE_SET_FROM_MULTI_END \
314 CopLINE_set(PL_curcop, PL_multi_end); \
315 if (PL_multi_end != PL_multi_start) \
316 PL_parser->lex_shared->herelines = 0; \
322 /* how to interpret the pl_yylval associated with the token */
326 TOKENTYPE_OPNUM, /* pl_yylval.ival contains an opcode number */
331 static struct debug_tokens {
333 enum token_type type;
335 } const debug_tokens[] =
337 { ADDOP, TOKENTYPE_OPNUM, "ADDOP" },
338 { ANDAND, TOKENTYPE_NONE, "ANDAND" },
339 { ANDOP, TOKENTYPE_NONE, "ANDOP" },
340 { ANONSUB, TOKENTYPE_IVAL, "ANONSUB" },
341 { ARROW, TOKENTYPE_NONE, "ARROW" },
342 { ASSIGNOP, TOKENTYPE_OPNUM, "ASSIGNOP" },
343 { BITANDOP, TOKENTYPE_OPNUM, "BITANDOP" },
344 { BITOROP, TOKENTYPE_OPNUM, "BITOROP" },
345 { COLONATTR, TOKENTYPE_NONE, "COLONATTR" },
346 { CONTINUE, TOKENTYPE_NONE, "CONTINUE" },
347 { DEFAULT, TOKENTYPE_NONE, "DEFAULT" },
348 { DO, TOKENTYPE_NONE, "DO" },
349 { DOLSHARP, TOKENTYPE_NONE, "DOLSHARP" },
350 { DORDOR, TOKENTYPE_NONE, "DORDOR" },
351 { DOROP, TOKENTYPE_OPNUM, "DOROP" },
352 { DOTDOT, TOKENTYPE_IVAL, "DOTDOT" },
353 { ELSE, TOKENTYPE_NONE, "ELSE" },
354 { ELSIF, TOKENTYPE_IVAL, "ELSIF" },
355 { EQOP, TOKENTYPE_OPNUM, "EQOP" },
356 { FOR, TOKENTYPE_IVAL, "FOR" },
357 { FORMAT, TOKENTYPE_NONE, "FORMAT" },
358 { FORMLBRACK, TOKENTYPE_NONE, "FORMLBRACK" },
359 { FORMRBRACK, TOKENTYPE_NONE, "FORMRBRACK" },
360 { FUNC, TOKENTYPE_OPNUM, "FUNC" },
361 { FUNC0, TOKENTYPE_OPNUM, "FUNC0" },
362 { FUNC0OP, TOKENTYPE_OPVAL, "FUNC0OP" },
363 { FUNC0SUB, TOKENTYPE_OPVAL, "FUNC0SUB" },
364 { FUNC1, TOKENTYPE_OPNUM, "FUNC1" },
365 { FUNCMETH, TOKENTYPE_OPVAL, "FUNCMETH" },
366 { GIVEN, TOKENTYPE_IVAL, "GIVEN" },
367 { HASHBRACK, TOKENTYPE_NONE, "HASHBRACK" },
368 { IF, TOKENTYPE_IVAL, "IF" },
369 { LABEL, TOKENTYPE_PVAL, "LABEL" },
370 { LOCAL, TOKENTYPE_IVAL, "LOCAL" },
371 { LOOPEX, TOKENTYPE_OPNUM, "LOOPEX" },
372 { LSTOP, TOKENTYPE_OPNUM, "LSTOP" },
373 { LSTOPSUB, TOKENTYPE_OPVAL, "LSTOPSUB" },
374 { MATCHOP, TOKENTYPE_OPNUM, "MATCHOP" },
375 { METHOD, TOKENTYPE_OPVAL, "METHOD" },
376 { MULOP, TOKENTYPE_OPNUM, "MULOP" },
377 { MY, TOKENTYPE_IVAL, "MY" },
378 { NOAMP, TOKENTYPE_NONE, "NOAMP" },
379 { NOTOP, TOKENTYPE_NONE, "NOTOP" },
380 { OROP, TOKENTYPE_IVAL, "OROP" },
381 { OROR, TOKENTYPE_NONE, "OROR" },
382 { PACKAGE, TOKENTYPE_NONE, "PACKAGE" },
383 { PEG, TOKENTYPE_NONE, "PEG" },
384 { PLUGEXPR, TOKENTYPE_OPVAL, "PLUGEXPR" },
385 { PLUGSTMT, TOKENTYPE_OPVAL, "PLUGSTMT" },
386 { PMFUNC, TOKENTYPE_OPVAL, "PMFUNC" },
387 { POSTDEC, TOKENTYPE_NONE, "POSTDEC" },
388 { POSTINC, TOKENTYPE_NONE, "POSTINC" },
389 { POWOP, TOKENTYPE_OPNUM, "POWOP" },
390 { PREDEC, TOKENTYPE_NONE, "PREDEC" },
391 { PREINC, TOKENTYPE_NONE, "PREINC" },
392 { PRIVATEREF, TOKENTYPE_OPVAL, "PRIVATEREF" },
393 { QWLIST, TOKENTYPE_OPVAL, "QWLIST" },
394 { REFGEN, TOKENTYPE_NONE, "REFGEN" },
395 { RELOP, TOKENTYPE_OPNUM, "RELOP" },
396 { REQUIRE, TOKENTYPE_NONE, "REQUIRE" },
397 { SHIFTOP, TOKENTYPE_OPNUM, "SHIFTOP" },
398 { SUB, TOKENTYPE_NONE, "SUB" },
399 { THING, TOKENTYPE_OPVAL, "THING" },
400 { UMINUS, TOKENTYPE_NONE, "UMINUS" },
401 { UNIOP, TOKENTYPE_OPNUM, "UNIOP" },
402 { UNIOPSUB, TOKENTYPE_OPVAL, "UNIOPSUB" },
403 { UNLESS, TOKENTYPE_IVAL, "UNLESS" },
404 { UNTIL, TOKENTYPE_IVAL, "UNTIL" },
405 { USE, TOKENTYPE_IVAL, "USE" },
406 { WHEN, TOKENTYPE_IVAL, "WHEN" },
407 { WHILE, TOKENTYPE_IVAL, "WHILE" },
408 { WORD, TOKENTYPE_OPVAL, "WORD" },
409 { YADAYADA, TOKENTYPE_IVAL, "YADAYADA" },
410 { 0, TOKENTYPE_NONE, NULL }
413 /* dump the returned token in rv, plus any optional arg in pl_yylval */
416 S_tokereport(pTHX_ I32 rv, const YYSTYPE* lvalp)
420 PERL_ARGS_ASSERT_TOKEREPORT;
423 const char *name = NULL;
424 enum token_type type = TOKENTYPE_NONE;
425 const struct debug_tokens *p;
426 SV* const report = newSVpvs("<== ");
428 for (p = debug_tokens; p->token; p++) {
429 if (p->token == (int)rv) {
436 Perl_sv_catpv(aTHX_ report, name);
437 else if ((char)rv > ' ' && (char)rv <= '~')
439 Perl_sv_catpvf(aTHX_ report, "'%c'", (char)rv);
441 sv_catpvs(report, " (pending identifier)");
444 sv_catpvs(report, "EOF");
446 Perl_sv_catpvf(aTHX_ report, "?? %"IVdf, (IV)rv);
451 Perl_sv_catpvf(aTHX_ report, "(ival=%"IVdf")", (IV)lvalp->ival);
453 case TOKENTYPE_OPNUM:
454 Perl_sv_catpvf(aTHX_ report, "(ival=op_%s)",
455 PL_op_name[lvalp->ival]);
458 Perl_sv_catpvf(aTHX_ report, "(pval=\"%s\")", lvalp->pval);
460 case TOKENTYPE_OPVAL:
462 Perl_sv_catpvf(aTHX_ report, "(opval=op_%s)",
463 PL_op_name[lvalp->opval->op_type]);
464 if (lvalp->opval->op_type == OP_CONST) {
465 Perl_sv_catpvf(aTHX_ report, " %s",
466 SvPEEK(cSVOPx_sv(lvalp->opval)));
471 sv_catpvs(report, "(opval=null)");
474 PerlIO_printf(Perl_debug_log, "### %s\n\n", SvPV_nolen_const(report));
480 /* print the buffer with suitable escapes */
483 S_printbuf(pTHX_ const char *const fmt, const char *const s)
485 SV* const tmp = newSVpvs("");
487 PERL_ARGS_ASSERT_PRINTBUF;
489 PerlIO_printf(Perl_debug_log, fmt, pv_display(tmp, s, strlen(s), 0, 60));
496 S_deprecate_commaless_var_list(pTHX) {
498 deprecate("comma-less variable list");
499 return REPORT(','); /* grandfather non-comma-format format */
505 * This subroutine detects &&=, ||=, and //= and turns an ANDAND, OROR or DORDOR
506 * into an OP_ANDASSIGN, OP_ORASSIGN, or OP_DORASSIGN
510 S_ao(pTHX_ int toketype)
513 if (*PL_bufptr == '=') {
515 if (toketype == ANDAND)
516 pl_yylval.ival = OP_ANDASSIGN;
517 else if (toketype == OROR)
518 pl_yylval.ival = OP_ORASSIGN;
519 else if (toketype == DORDOR)
520 pl_yylval.ival = OP_DORASSIGN;
528 * When Perl expects an operator and finds something else, no_op
529 * prints the warning. It always prints "<something> found where
530 * operator expected. It prints "Missing semicolon on previous line?"
531 * if the surprise occurs at the start of the line. "do you need to
532 * predeclare ..." is printed out for code like "sub bar; foo bar $x"
533 * where the compiler doesn't know if foo is a method call or a function.
534 * It prints "Missing operator before end of line" if there's nothing
535 * after the missing operator, or "... before <...>" if there is something
536 * after the missing operator.
540 S_no_op(pTHX_ const char *const what, char *s)
543 char * const oldbp = PL_bufptr;
544 const bool is_first = (PL_oldbufptr == PL_linestart);
546 PERL_ARGS_ASSERT_NO_OP;
552 yywarn(Perl_form(aTHX_ "%s found where operator expected", what), UTF ? SVf_UTF8 : 0);
553 if (ckWARN_d(WARN_SYNTAX)) {
555 Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
556 "\t(Missing semicolon on previous line?)\n");
557 else if (PL_oldoldbufptr && isIDFIRST_lazy_if(PL_oldoldbufptr,UTF)) {
559 for (t = PL_oldoldbufptr; (isWORDCHAR_lazy_if(t,UTF) || *t == ':');
560 t += UTF ? UTF8SKIP(t) : 1)
562 if (t < PL_bufptr && isSPACE(*t))
563 Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
564 "\t(Do you need to predeclare %"UTF8f"?)\n",
565 UTF8fARG(UTF, t - PL_oldoldbufptr, PL_oldoldbufptr));
569 Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
570 "\t(Missing operator before %"UTF8f"?)\n",
571 UTF8fARG(UTF, s - oldbp, oldbp));
579 * Complain about missing quote/regexp/heredoc terminator.
580 * If it's called with NULL then it cauterizes the line buffer.
581 * If we're in a delimited string and the delimiter is a control
582 * character, it's reformatted into a two-char sequence like ^C.
587 S_missingterm(pTHX_ char *s)
593 char * const nl = strrchr(s,'\n');
597 else if ((U8) PL_multi_close < 32) {
599 tmpbuf[1] = (char)toCTRL(PL_multi_close);
604 *tmpbuf = (char)PL_multi_close;
608 q = strchr(s,'"') ? '\'' : '"';
609 Perl_croak(aTHX_ "Can't find string terminator %c%s%c anywhere before EOF",q,s,q);
615 * Check whether the named feature is enabled.
618 Perl_feature_is_enabled(pTHX_ const char *const name, STRLEN namelen)
621 char he_name[8 + MAX_FEATURE_LEN] = "feature_";
623 PERL_ARGS_ASSERT_FEATURE_IS_ENABLED;
625 assert(CURRENT_FEATURE_BUNDLE == FEATURE_BUNDLE_CUSTOM);
627 if (namelen > MAX_FEATURE_LEN)
629 memcpy(&he_name[8], name, namelen);
631 return cBOOL(cop_hints_fetch_pvn(PL_curcop, he_name, 8 + namelen, 0,
632 REFCOUNTED_HE_EXISTS));
636 * experimental text filters for win32 carriage-returns, utf16-to-utf8 and
637 * utf16-to-utf8-reversed.
640 #ifdef PERL_CR_FILTER
644 const char *s = SvPVX_const(sv);
645 const char * const e = s + SvCUR(sv);
647 PERL_ARGS_ASSERT_STRIP_RETURN;
649 /* outer loop optimized to do nothing if there are no CR-LFs */
651 if (*s++ == '\r' && *s == '\n') {
652 /* hit a CR-LF, need to copy the rest */
656 if (*s == '\r' && s[1] == '\n')
667 S_cr_textfilter(pTHX_ int idx, SV *sv, int maxlen)
669 const I32 count = FILTER_READ(idx+1, sv, maxlen);
670 if (count > 0 && !maxlen)
677 =for apidoc Amx|void|lex_start|SV *line|PerlIO *rsfp|U32 flags
679 Creates and initialises a new lexer/parser state object, supplying
680 a context in which to lex and parse from a new source of Perl code.
681 A pointer to the new state object is placed in L</PL_parser>. An entry
682 is made on the save stack so that upon unwinding the new state object
683 will be destroyed and the former value of L</PL_parser> will be restored.
684 Nothing else need be done to clean up the parsing context.
686 The code to be parsed comes from I<line> and I<rsfp>. I<line>, if
687 non-null, provides a string (in SV form) containing code to be parsed.
688 A copy of the string is made, so subsequent modification of I<line>
689 does not affect parsing. I<rsfp>, if non-null, provides an input stream
690 from which code will be read to be parsed. If both are non-null, the
691 code in I<line> comes first and must consist of complete lines of input,
692 and I<rsfp> supplies the remainder of the source.
694 The I<flags> parameter is reserved for future use. Currently it is only
695 used by perl internally, so extensions should always pass zero.
700 /* LEX_START_SAME_FILTER indicates that this is not a new file, so it
701 can share filters with the current parser.
702 LEX_START_DONT_CLOSE indicates that the file handle wasn't opened by the
703 caller, hence isn't owned by the parser, so shouldn't be closed on parser
704 destruction. This is used to handle the case of defaulting to reading the
705 script from the standard input because no filename was given on the command
706 line (without getting confused by situation where STDIN has been closed, so
707 the script handle is opened on fd 0) */
710 Perl_lex_start(pTHX_ SV *line, PerlIO *rsfp, U32 flags)
713 const char *s = NULL;
714 yy_parser *parser, *oparser;
715 if (flags && flags & ~LEX_START_FLAGS)
716 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_start");
718 /* create and initialise a parser */
720 Newxz(parser, 1, yy_parser);
721 parser->old_parser = oparser = PL_parser;
724 parser->stack = NULL;
726 parser->stack_size = 0;
728 /* on scope exit, free this parser and restore any outer one */
730 parser->saved_curcop = PL_curcop;
732 /* initialise lexer state */
735 parser->curforce = -1;
737 parser->nexttoke = 0;
739 parser->error_count = oparser ? oparser->error_count : 0;
740 parser->copline = NOLINE;
741 parser->lex_state = LEX_NORMAL;
742 parser->expect = XSTATE;
744 parser->rsfp_filters =
745 !(flags & LEX_START_SAME_FILTER) || !oparser
747 : MUTABLE_AV(SvREFCNT_inc(
748 oparser->rsfp_filters
749 ? oparser->rsfp_filters
750 : (oparser->rsfp_filters = newAV())
753 Newx(parser->lex_brackstack, 120, char);
754 Newx(parser->lex_casestack, 12, char);
755 *parser->lex_casestack = '\0';
756 Newxz(parser->lex_shared, 1, LEXSHARED);
760 s = SvPV_const(line, len);
761 parser->linestr = flags & LEX_START_COPIED
762 ? SvREFCNT_inc_simple_NN(line)
763 : newSVpvn_flags(s, len, SvUTF8(line));
764 sv_catpvn(parser->linestr, "\n;", rsfp ? 1 : 2);
766 parser->linestr = newSVpvn("\n;", rsfp ? 1 : 2);
768 parser->oldoldbufptr =
771 parser->linestart = SvPVX(parser->linestr);
772 parser->bufend = parser->bufptr + SvCUR(parser->linestr);
773 parser->last_lop = parser->last_uni = NULL;
774 parser->lex_flags = flags & (LEX_IGNORE_UTF8_HINTS|LEX_EVALBYTES
775 |LEX_DONT_CLOSE_RSFP);
777 parser->in_pod = parser->filtered = 0;
781 /* delete a parser object */
784 Perl_parser_free(pTHX_ const yy_parser *parser)
786 PERL_ARGS_ASSERT_PARSER_FREE;
788 PL_curcop = parser->saved_curcop;
789 SvREFCNT_dec(parser->linestr);
791 if (PL_parser->lex_flags & LEX_DONT_CLOSE_RSFP)
792 PerlIO_clearerr(parser->rsfp);
793 else if (parser->rsfp && (!parser->old_parser ||
794 (parser->old_parser && parser->rsfp != parser->old_parser->rsfp)))
795 PerlIO_close(parser->rsfp);
796 SvREFCNT_dec(parser->rsfp_filters);
797 SvREFCNT_dec(parser->lex_stuff);
798 SvREFCNT_dec(parser->sublex_info.repl);
800 Safefree(parser->lex_brackstack);
801 Safefree(parser->lex_casestack);
802 Safefree(parser->lex_shared);
803 PL_parser = parser->old_parser;
808 Perl_parser_free_nexttoke_ops(pTHX_ yy_parser *parser, OPSLAB *slab)
811 I32 nexttoke = parser->lasttoke;
813 I32 nexttoke = parser->nexttoke;
815 PERL_ARGS_ASSERT_PARSER_FREE_NEXTTOKE_OPS;
818 if (S_is_opval_token(parser->nexttoke[nexttoke].next_type
820 && parser->nexttoke[nexttoke].next_val.opval
821 && parser->nexttoke[nexttoke].next_val.opval->op_slabbed
822 && OpSLAB(parser->nexttoke[nexttoke].next_val.opval) == slab) {
823 op_free(parser->nexttoke[nexttoke].next_val.opval);
824 parser->nexttoke[nexttoke].next_val.opval = NULL;
827 if (S_is_opval_token(parser->nexttype[nexttoke] & 0xffff)
828 && parser->nextval[nexttoke].opval
829 && parser->nextval[nexttoke].opval->op_slabbed
830 && OpSLAB(parser->nextval[nexttoke].opval) == slab) {
831 op_free(parser->nextval[nexttoke].opval);
832 parser->nextval[nexttoke].opval = NULL;
840 =for apidoc AmxU|SV *|PL_parser-E<gt>linestr
842 Buffer scalar containing the chunk currently under consideration of the
843 text currently being lexed. This is always a plain string scalar (for
844 which C<SvPOK> is true). It is not intended to be used as a scalar by
845 normal scalar means; instead refer to the buffer directly by the pointer
846 variables described below.
848 The lexer maintains various C<char*> pointers to things in the
849 C<PL_parser-E<gt>linestr> buffer. If C<PL_parser-E<gt>linestr> is ever
850 reallocated, all of these pointers must be updated. Don't attempt to
851 do this manually, but rather use L</lex_grow_linestr> if you need to
852 reallocate the buffer.
854 The content of the text chunk in the buffer is commonly exactly one
855 complete line of input, up to and including a newline terminator,
856 but there are situations where it is otherwise. The octets of the
857 buffer may be intended to be interpreted as either UTF-8 or Latin-1.
858 The function L</lex_bufutf8> tells you which. Do not use the C<SvUTF8>
859 flag on this scalar, which may disagree with it.
861 For direct examination of the buffer, the variable
862 L</PL_parser-E<gt>bufend> points to the end of the buffer. The current
863 lexing position is pointed to by L</PL_parser-E<gt>bufptr>. Direct use
864 of these pointers is usually preferable to examination of the scalar
865 through normal scalar means.
867 =for apidoc AmxU|char *|PL_parser-E<gt>bufend
869 Direct pointer to the end of the chunk of text currently being lexed, the
870 end of the lexer buffer. This is equal to C<SvPVX(PL_parser-E<gt>linestr)
871 + SvCUR(PL_parser-E<gt>linestr)>. A NUL character (zero octet) is
872 always located at the end of the buffer, and does not count as part of
873 the buffer's contents.
875 =for apidoc AmxU|char *|PL_parser-E<gt>bufptr
877 Points to the current position of lexing inside the lexer buffer.
878 Characters around this point may be freely examined, within
879 the range delimited by C<SvPVX(L</PL_parser-E<gt>linestr>)> and
880 L</PL_parser-E<gt>bufend>. The octets of the buffer may be intended to be
881 interpreted as either UTF-8 or Latin-1, as indicated by L</lex_bufutf8>.
883 Lexing code (whether in the Perl core or not) moves this pointer past
884 the characters that it consumes. It is also expected to perform some
885 bookkeeping whenever a newline character is consumed. This movement
886 can be more conveniently performed by the function L</lex_read_to>,
887 which handles newlines appropriately.
889 Interpretation of the buffer's octets can be abstracted out by
890 using the slightly higher-level functions L</lex_peek_unichar> and
891 L</lex_read_unichar>.
893 =for apidoc AmxU|char *|PL_parser-E<gt>linestart
895 Points to the start of the current line inside the lexer buffer.
896 This is useful for indicating at which column an error occurred, and
897 not much else. This must be updated by any lexing code that consumes
898 a newline; the function L</lex_read_to> handles this detail.
904 =for apidoc Amx|bool|lex_bufutf8
906 Indicates whether the octets in the lexer buffer
907 (L</PL_parser-E<gt>linestr>) should be interpreted as the UTF-8 encoding
908 of Unicode characters. If not, they should be interpreted as Latin-1
909 characters. This is analogous to the C<SvUTF8> flag for scalars.
911 In UTF-8 mode, it is not guaranteed that the lexer buffer actually
912 contains valid UTF-8. Lexing code must be robust in the face of invalid
915 The actual C<SvUTF8> flag of the L</PL_parser-E<gt>linestr> scalar
916 is significant, but not the whole story regarding the input character
917 encoding. Normally, when a file is being read, the scalar contains octets
918 and its C<SvUTF8> flag is off, but the octets should be interpreted as
919 UTF-8 if the C<use utf8> pragma is in effect. During a string eval,
920 however, the scalar may have the C<SvUTF8> flag on, and in this case its
921 octets should be interpreted as UTF-8 unless the C<use bytes> pragma
922 is in effect. This logic may change in the future; use this function
923 instead of implementing the logic yourself.
929 Perl_lex_bufutf8(pTHX)
935 =for apidoc Amx|char *|lex_grow_linestr|STRLEN len
937 Reallocates the lexer buffer (L</PL_parser-E<gt>linestr>) to accommodate
938 at least I<len> octets (including terminating NUL). Returns a
939 pointer to the reallocated buffer. This is necessary before making
940 any direct modification of the buffer that would increase its length.
941 L</lex_stuff_pvn> provides a more convenient way to insert text into
944 Do not use C<SvGROW> or C<sv_grow> directly on C<PL_parser-E<gt>linestr>;
945 this function updates all of the lexer's variables that point directly
952 Perl_lex_grow_linestr(pTHX_ STRLEN len)
956 STRLEN bufend_pos, bufptr_pos, oldbufptr_pos, oldoldbufptr_pos;
957 STRLEN linestart_pos, last_uni_pos, last_lop_pos, re_eval_start_pos;
958 linestr = PL_parser->linestr;
959 buf = SvPVX(linestr);
960 if (len <= SvLEN(linestr))
962 bufend_pos = PL_parser->bufend - buf;
963 bufptr_pos = PL_parser->bufptr - buf;
964 oldbufptr_pos = PL_parser->oldbufptr - buf;
965 oldoldbufptr_pos = PL_parser->oldoldbufptr - buf;
966 linestart_pos = PL_parser->linestart - buf;
967 last_uni_pos = PL_parser->last_uni ? PL_parser->last_uni - buf : 0;
968 last_lop_pos = PL_parser->last_lop ? PL_parser->last_lop - buf : 0;
969 re_eval_start_pos = PL_parser->lex_shared->re_eval_start ?
970 PL_parser->lex_shared->re_eval_start - buf : 0;
972 buf = sv_grow(linestr, len);
974 PL_parser->bufend = buf + bufend_pos;
975 PL_parser->bufptr = buf + bufptr_pos;
976 PL_parser->oldbufptr = buf + oldbufptr_pos;
977 PL_parser->oldoldbufptr = buf + oldoldbufptr_pos;
978 PL_parser->linestart = buf + linestart_pos;
979 if (PL_parser->last_uni)
980 PL_parser->last_uni = buf + last_uni_pos;
981 if (PL_parser->last_lop)
982 PL_parser->last_lop = buf + last_lop_pos;
983 if (PL_parser->lex_shared->re_eval_start)
984 PL_parser->lex_shared->re_eval_start = buf + re_eval_start_pos;
989 =for apidoc Amx|void|lex_stuff_pvn|const char *pv|STRLEN len|U32 flags
991 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
992 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
993 reallocating the buffer if necessary. This means that lexing code that
994 runs later will see the characters as if they had appeared in the input.
995 It is not recommended to do this as part of normal parsing, and most
996 uses of this facility run the risk of the inserted characters being
997 interpreted in an unintended manner.
999 The string to be inserted is represented by I<len> octets starting
1000 at I<pv>. These octets are interpreted as either UTF-8 or Latin-1,
1001 according to whether the C<LEX_STUFF_UTF8> flag is set in I<flags>.
1002 The characters are recoded for the lexer buffer, according to how the
1003 buffer is currently being interpreted (L</lex_bufutf8>). If a string
1004 to be inserted is available as a Perl scalar, the L</lex_stuff_sv>
1005 function is more convenient.
1011 Perl_lex_stuff_pvn(pTHX_ const char *pv, STRLEN len, U32 flags)
1015 PERL_ARGS_ASSERT_LEX_STUFF_PVN;
1016 if (flags & ~(LEX_STUFF_UTF8))
1017 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_stuff_pvn");
1019 if (flags & LEX_STUFF_UTF8) {
1022 STRLEN highhalf = 0; /* Count of variants */
1023 const char *p, *e = pv+len;
1024 for (p = pv; p != e; p++) {
1025 if (! UTF8_IS_INVARIANT(*p)) {
1031 lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len+highhalf);
1032 bufptr = PL_parser->bufptr;
1033 Move(bufptr, bufptr+len+highhalf, PL_parser->bufend+1-bufptr, char);
1034 SvCUR_set(PL_parser->linestr,
1035 SvCUR(PL_parser->linestr) + len+highhalf);
1036 PL_parser->bufend += len+highhalf;
1037 for (p = pv; p != e; p++) {
1039 if (! UTF8_IS_INVARIANT(c)) {
1040 *bufptr++ = UTF8_TWO_BYTE_HI(c);
1041 *bufptr++ = UTF8_TWO_BYTE_LO(c);
1043 *bufptr++ = (char)c;
1048 if (flags & LEX_STUFF_UTF8) {
1049 STRLEN highhalf = 0;
1050 const char *p, *e = pv+len;
1051 for (p = pv; p != e; p++) {
1053 if (UTF8_IS_ABOVE_LATIN1(c)) {
1054 Perl_croak(aTHX_ "Lexing code attempted to stuff "
1055 "non-Latin-1 character into Latin-1 input");
1056 } else if (UTF8_IS_NEXT_CHAR_DOWNGRADEABLE(p, e)) {
1059 } else if (! UTF8_IS_INVARIANT(c)) {
1060 /* malformed UTF-8 */
1062 SAVESPTR(PL_warnhook);
1063 PL_warnhook = PERL_WARNHOOK_FATAL;
1064 utf8n_to_uvchr((U8*)p, e-p, NULL, 0);
1070 lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len-highhalf);
1071 bufptr = PL_parser->bufptr;
1072 Move(bufptr, bufptr+len-highhalf, PL_parser->bufend+1-bufptr, char);
1073 SvCUR_set(PL_parser->linestr,
1074 SvCUR(PL_parser->linestr) + len-highhalf);
1075 PL_parser->bufend += len-highhalf;
1078 if (UTF8_IS_INVARIANT(*p)) {
1084 *bufptr++ = TWO_BYTE_UTF8_TO_NATIVE(*p, *(p+1));
1090 lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len);
1091 bufptr = PL_parser->bufptr;
1092 Move(bufptr, bufptr+len, PL_parser->bufend+1-bufptr, char);
1093 SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) + len);
1094 PL_parser->bufend += len;
1095 Copy(pv, bufptr, len, char);
1101 =for apidoc Amx|void|lex_stuff_pv|const char *pv|U32 flags
1103 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
1104 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
1105 reallocating the buffer if necessary. This means that lexing code that
1106 runs later will see the characters as if they had appeared in the input.
1107 It is not recommended to do this as part of normal parsing, and most
1108 uses of this facility run the risk of the inserted characters being
1109 interpreted in an unintended manner.
1111 The string to be inserted is represented by octets starting at I<pv>
1112 and continuing to the first nul. These octets are interpreted as either
1113 UTF-8 or Latin-1, according to whether the C<LEX_STUFF_UTF8> flag is set
1114 in I<flags>. The characters are recoded for the lexer buffer, according
1115 to how the buffer is currently being interpreted (L</lex_bufutf8>).
1116 If it is not convenient to nul-terminate a string to be inserted, the
1117 L</lex_stuff_pvn> function is more appropriate.
1123 Perl_lex_stuff_pv(pTHX_ const char *pv, U32 flags)
1125 PERL_ARGS_ASSERT_LEX_STUFF_PV;
1126 lex_stuff_pvn(pv, strlen(pv), flags);
1130 =for apidoc Amx|void|lex_stuff_sv|SV *sv|U32 flags
1132 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
1133 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
1134 reallocating the buffer if necessary. This means that lexing code that
1135 runs later will see the characters as if they had appeared in the input.
1136 It is not recommended to do this as part of normal parsing, and most
1137 uses of this facility run the risk of the inserted characters being
1138 interpreted in an unintended manner.
1140 The string to be inserted is the string value of I<sv>. The characters
1141 are recoded for the lexer buffer, according to how the buffer is currently
1142 being interpreted (L</lex_bufutf8>). If a string to be inserted is
1143 not already a Perl scalar, the L</lex_stuff_pvn> function avoids the
1144 need to construct a scalar.
1150 Perl_lex_stuff_sv(pTHX_ SV *sv, U32 flags)
1154 PERL_ARGS_ASSERT_LEX_STUFF_SV;
1156 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_stuff_sv");
1158 lex_stuff_pvn(pv, len, flags | (SvUTF8(sv) ? LEX_STUFF_UTF8 : 0));
1162 =for apidoc Amx|void|lex_unstuff|char *ptr
1164 Discards text about to be lexed, from L</PL_parser-E<gt>bufptr> up to
1165 I<ptr>. Text following I<ptr> will be moved, and the buffer shortened.
1166 This hides the discarded text from any lexing code that runs later,
1167 as if the text had never appeared.
1169 This is not the normal way to consume lexed text. For that, use
1176 Perl_lex_unstuff(pTHX_ char *ptr)
1180 PERL_ARGS_ASSERT_LEX_UNSTUFF;
1181 buf = PL_parser->bufptr;
1183 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_unstuff");
1186 bufend = PL_parser->bufend;
1188 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_unstuff");
1189 unstuff_len = ptr - buf;
1190 Move(ptr, buf, bufend+1-ptr, char);
1191 SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) - unstuff_len);
1192 PL_parser->bufend = bufend - unstuff_len;
1196 =for apidoc Amx|void|lex_read_to|char *ptr
1198 Consume text in the lexer buffer, from L</PL_parser-E<gt>bufptr> up
1199 to I<ptr>. This advances L</PL_parser-E<gt>bufptr> to match I<ptr>,
1200 performing the correct bookkeeping whenever a newline character is passed.
1201 This is the normal way to consume lexed text.
1203 Interpretation of the buffer's octets can be abstracted out by
1204 using the slightly higher-level functions L</lex_peek_unichar> and
1205 L</lex_read_unichar>.
1211 Perl_lex_read_to(pTHX_ char *ptr)
1214 PERL_ARGS_ASSERT_LEX_READ_TO;
1215 s = PL_parser->bufptr;
1216 if (ptr < s || ptr > PL_parser->bufend)
1217 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_to");
1218 for (; s != ptr; s++)
1220 COPLINE_INC_WITH_HERELINES;
1221 PL_parser->linestart = s+1;
1223 PL_parser->bufptr = ptr;
1227 =for apidoc Amx|void|lex_discard_to|char *ptr
1229 Discards the first part of the L</PL_parser-E<gt>linestr> buffer,
1230 up to I<ptr>. The remaining content of the buffer will be moved, and
1231 all pointers into the buffer updated appropriately. I<ptr> must not
1232 be later in the buffer than the position of L</PL_parser-E<gt>bufptr>:
1233 it is not permitted to discard text that has yet to be lexed.
1235 Normally it is not necessarily to do this directly, because it suffices to
1236 use the implicit discarding behaviour of L</lex_next_chunk> and things
1237 based on it. However, if a token stretches across multiple lines,
1238 and the lexing code has kept multiple lines of text in the buffer for
1239 that purpose, then after completion of the token it would be wise to
1240 explicitly discard the now-unneeded earlier lines, to avoid future
1241 multi-line tokens growing the buffer without bound.
1247 Perl_lex_discard_to(pTHX_ char *ptr)
1251 PERL_ARGS_ASSERT_LEX_DISCARD_TO;
1252 buf = SvPVX(PL_parser->linestr);
1254 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_discard_to");
1257 if (ptr > PL_parser->bufptr)
1258 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_discard_to");
1259 discard_len = ptr - buf;
1260 if (PL_parser->oldbufptr < ptr)
1261 PL_parser->oldbufptr = ptr;
1262 if (PL_parser->oldoldbufptr < ptr)
1263 PL_parser->oldoldbufptr = ptr;
1264 if (PL_parser->last_uni && PL_parser->last_uni < ptr)
1265 PL_parser->last_uni = NULL;
1266 if (PL_parser->last_lop && PL_parser->last_lop < ptr)
1267 PL_parser->last_lop = NULL;
1268 Move(ptr, buf, PL_parser->bufend+1-ptr, char);
1269 SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) - discard_len);
1270 PL_parser->bufend -= discard_len;
1271 PL_parser->bufptr -= discard_len;
1272 PL_parser->oldbufptr -= discard_len;
1273 PL_parser->oldoldbufptr -= discard_len;
1274 if (PL_parser->last_uni)
1275 PL_parser->last_uni -= discard_len;
1276 if (PL_parser->last_lop)
1277 PL_parser->last_lop -= discard_len;
1281 =for apidoc Amx|bool|lex_next_chunk|U32 flags
1283 Reads in the next chunk of text to be lexed, appending it to
1284 L</PL_parser-E<gt>linestr>. This should be called when lexing code has
1285 looked to the end of the current chunk and wants to know more. It is
1286 usual, but not necessary, for lexing to have consumed the entirety of
1287 the current chunk at this time.
1289 If L</PL_parser-E<gt>bufptr> is pointing to the very end of the current
1290 chunk (i.e., the current chunk has been entirely consumed), normally the
1291 current chunk will be discarded at the same time that the new chunk is
1292 read in. If I<flags> includes C<LEX_KEEP_PREVIOUS>, the current chunk
1293 will not be discarded. If the current chunk has not been entirely
1294 consumed, then it will not be discarded regardless of the flag.
1296 Returns true if some new text was added to the buffer, or false if the
1297 buffer has reached the end of the input text.
1302 #define LEX_FAKE_EOF 0x80000000
1303 #define LEX_NO_TERM 0x40000000
1306 Perl_lex_next_chunk(pTHX_ U32 flags)
1310 STRLEN old_bufend_pos, new_bufend_pos;
1311 STRLEN bufptr_pos, oldbufptr_pos, oldoldbufptr_pos;
1312 STRLEN linestart_pos, last_uni_pos, last_lop_pos;
1313 bool got_some_for_debugger = 0;
1315 if (flags & ~(LEX_KEEP_PREVIOUS|LEX_FAKE_EOF|LEX_NO_TERM))
1316 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_next_chunk");
1317 linestr = PL_parser->linestr;
1318 buf = SvPVX(linestr);
1319 if (!(flags & LEX_KEEP_PREVIOUS) &&
1320 PL_parser->bufptr == PL_parser->bufend) {
1321 old_bufend_pos = bufptr_pos = oldbufptr_pos = oldoldbufptr_pos = 0;
1323 if (PL_parser->last_uni != PL_parser->bufend)
1324 PL_parser->last_uni = NULL;
1325 if (PL_parser->last_lop != PL_parser->bufend)
1326 PL_parser->last_lop = NULL;
1327 last_uni_pos = last_lop_pos = 0;
1331 old_bufend_pos = PL_parser->bufend - buf;
1332 bufptr_pos = PL_parser->bufptr - buf;
1333 oldbufptr_pos = PL_parser->oldbufptr - buf;
1334 oldoldbufptr_pos = PL_parser->oldoldbufptr - buf;
1335 linestart_pos = PL_parser->linestart - buf;
1336 last_uni_pos = PL_parser->last_uni ? PL_parser->last_uni - buf : 0;
1337 last_lop_pos = PL_parser->last_lop ? PL_parser->last_lop - buf : 0;
1339 if (flags & LEX_FAKE_EOF) {
1341 } else if (!PL_parser->rsfp && !PL_parser->filtered) {
1343 } else if (filter_gets(linestr, old_bufend_pos)) {
1345 got_some_for_debugger = 1;
1346 } else if (flags & LEX_NO_TERM) {
1349 if (!SvPOK(linestr)) /* can get undefined by filter_gets */
1350 sv_setpvs(linestr, "");
1352 /* End of real input. Close filehandle (unless it was STDIN),
1353 * then add implicit termination.
1355 if (PL_parser->lex_flags & LEX_DONT_CLOSE_RSFP)
1356 PerlIO_clearerr(PL_parser->rsfp);
1357 else if (PL_parser->rsfp)
1358 (void)PerlIO_close(PL_parser->rsfp);
1359 PL_parser->rsfp = NULL;
1360 PL_parser->in_pod = PL_parser->filtered = 0;
1362 if (PL_madskills && !PL_in_eval && (PL_minus_p || PL_minus_n))
1365 if (!PL_in_eval && PL_minus_p) {
1367 /*{*/";}continue{print or die qq(-p destination: $!\\n);}");
1368 PL_minus_n = PL_minus_p = 0;
1369 } else if (!PL_in_eval && PL_minus_n) {
1370 sv_catpvs(linestr, /*{*/";}");
1373 sv_catpvs(linestr, ";");
1376 buf = SvPVX(linestr);
1377 new_bufend_pos = SvCUR(linestr);
1378 PL_parser->bufend = buf + new_bufend_pos;
1379 PL_parser->bufptr = buf + bufptr_pos;
1380 PL_parser->oldbufptr = buf + oldbufptr_pos;
1381 PL_parser->oldoldbufptr = buf + oldoldbufptr_pos;
1382 PL_parser->linestart = buf + linestart_pos;
1383 if (PL_parser->last_uni)
1384 PL_parser->last_uni = buf + last_uni_pos;
1385 if (PL_parser->last_lop)
1386 PL_parser->last_lop = buf + last_lop_pos;
1387 if (got_some_for_debugger && (PERLDB_LINE || PERLDB_SAVESRC) &&
1388 PL_curstash != PL_debstash) {
1389 /* debugger active and we're not compiling the debugger code,
1390 * so store the line into the debugger's array of lines
1392 update_debugger_info(NULL, buf+old_bufend_pos,
1393 new_bufend_pos-old_bufend_pos);
1399 =for apidoc Amx|I32|lex_peek_unichar|U32 flags
1401 Looks ahead one (Unicode) character in the text currently being lexed.
1402 Returns the codepoint (unsigned integer value) of the next character,
1403 or -1 if lexing has reached the end of the input text. To consume the
1404 peeked character, use L</lex_read_unichar>.
1406 If the next character is in (or extends into) the next chunk of input
1407 text, the next chunk will be read in. Normally the current chunk will be
1408 discarded at the same time, but if I<flags> includes C<LEX_KEEP_PREVIOUS>
1409 then the current chunk will not be discarded.
1411 If the input is being interpreted as UTF-8 and a UTF-8 encoding error
1412 is encountered, an exception is generated.
1418 Perl_lex_peek_unichar(pTHX_ U32 flags)
1422 if (flags & ~(LEX_KEEP_PREVIOUS))
1423 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_peek_unichar");
1424 s = PL_parser->bufptr;
1425 bufend = PL_parser->bufend;
1431 if (!lex_next_chunk(flags))
1433 s = PL_parser->bufptr;
1434 bufend = PL_parser->bufend;
1437 if (UTF8_IS_INVARIANT(head))
1439 if (UTF8_IS_START(head)) {
1440 len = UTF8SKIP(&head);
1441 while ((STRLEN)(bufend-s) < len) {
1442 if (!lex_next_chunk(flags | LEX_KEEP_PREVIOUS))
1444 s = PL_parser->bufptr;
1445 bufend = PL_parser->bufend;
1448 unichar = utf8n_to_uvchr((U8*)s, bufend-s, &retlen, UTF8_CHECK_ONLY);
1449 if (retlen == (STRLEN)-1) {
1450 /* malformed UTF-8 */
1452 SAVESPTR(PL_warnhook);
1453 PL_warnhook = PERL_WARNHOOK_FATAL;
1454 utf8n_to_uvchr((U8*)s, bufend-s, NULL, 0);
1460 if (!lex_next_chunk(flags))
1462 s = PL_parser->bufptr;
1469 =for apidoc Amx|I32|lex_read_unichar|U32 flags
1471 Reads the next (Unicode) character in the text currently being lexed.
1472 Returns the codepoint (unsigned integer value) of the character read,
1473 and moves L</PL_parser-E<gt>bufptr> past the character, or returns -1
1474 if lexing has reached the end of the input text. To non-destructively
1475 examine the next character, use L</lex_peek_unichar> instead.
1477 If the next character is in (or extends into) the next chunk of input
1478 text, the next chunk will be read in. Normally the current chunk will be
1479 discarded at the same time, but if I<flags> includes C<LEX_KEEP_PREVIOUS>
1480 then the current chunk will not be discarded.
1482 If the input is being interpreted as UTF-8 and a UTF-8 encoding error
1483 is encountered, an exception is generated.
1489 Perl_lex_read_unichar(pTHX_ U32 flags)
1492 if (flags & ~(LEX_KEEP_PREVIOUS))
1493 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_unichar");
1494 c = lex_peek_unichar(flags);
1497 COPLINE_INC_WITH_HERELINES;
1499 PL_parser->bufptr += UTF8SKIP(PL_parser->bufptr);
1501 ++(PL_parser->bufptr);
1507 =for apidoc Amx|void|lex_read_space|U32 flags
1509 Reads optional spaces, in Perl style, in the text currently being
1510 lexed. The spaces may include ordinary whitespace characters and
1511 Perl-style comments. C<#line> directives are processed if encountered.
1512 L</PL_parser-E<gt>bufptr> is moved past the spaces, so that it points
1513 at a non-space character (or the end of the input text).
1515 If spaces extend into the next chunk of input text, the next chunk will
1516 be read in. Normally the current chunk will be discarded at the same
1517 time, but if I<flags> includes C<LEX_KEEP_PREVIOUS> then the current
1518 chunk will not be discarded.
1523 #define LEX_NO_INCLINE 0x40000000
1524 #define LEX_NO_NEXT_CHUNK 0x80000000
1527 Perl_lex_read_space(pTHX_ U32 flags)
1530 const bool can_incline = !(flags & LEX_NO_INCLINE);
1531 bool need_incline = 0;
1532 if (flags & ~(LEX_KEEP_PREVIOUS|LEX_NO_NEXT_CHUNK|LEX_NO_INCLINE))
1533 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_space");
1536 sv_free(PL_skipwhite);
1537 PL_skipwhite = NULL;
1540 PL_skipwhite = newSVpvs("");
1541 #endif /* PERL_MAD */
1542 s = PL_parser->bufptr;
1543 bufend = PL_parser->bufend;
1549 } while (!(c == '\n' || (c == 0 && s == bufend)));
1550 } else if (c == '\n') {
1553 PL_parser->linestart = s;
1559 } else if (isSPACE(c)) {
1561 } else if (c == 0 && s == bufend) {
1565 sv_catpvn(PL_skipwhite, PL_parser->bufptr, s-PL_parser->bufptr);
1566 #endif /* PERL_MAD */
1567 if (flags & LEX_NO_NEXT_CHUNK)
1569 PL_parser->bufptr = s;
1570 if (can_incline) COPLINE_INC_WITH_HERELINES;
1571 got_more = lex_next_chunk(flags);
1572 if (can_incline) CopLINE_dec(PL_curcop);
1573 s = PL_parser->bufptr;
1574 bufend = PL_parser->bufend;
1577 if (can_incline && need_incline && PL_parser->rsfp) {
1587 sv_catpvn(PL_skipwhite, PL_parser->bufptr, s-PL_parser->bufptr);
1588 #endif /* PERL_MAD */
1589 PL_parser->bufptr = s;
1594 =for apidoc EXMp|bool|validate_proto|SV *name|SV *proto|bool warn
1596 This function performs syntax checking on a prototype, C<proto>.
1597 If C<warn> is true, any illegal characters or mismatched brackets
1598 will trigger illegalproto warnings, declaring that they were
1599 detected in the prototype for C<name>.
1601 The return value is C<true> if this is a valid prototype, and
1602 C<false> if it is not, regardless of whether C<warn> was C<true> or
1605 Note that C<NULL> is a valid C<proto> and will always return C<true>.
1612 Perl_validate_proto(pTHX_ SV *name, SV *proto, bool warn)
1614 STRLEN len, origlen;
1615 char *p = proto ? SvPV(proto, len) : NULL;
1616 bool bad_proto = FALSE;
1617 bool in_brackets = FALSE;
1618 bool after_slash = FALSE;
1619 char greedy_proto = ' ';
1620 bool proto_after_greedy_proto = FALSE;
1621 bool must_be_last = FALSE;
1622 bool underscore = FALSE;
1623 bool bad_proto_after_underscore = FALSE;
1625 PERL_ARGS_ASSERT_VALIDATE_PROTO;
1631 for (; len--; p++) {
1634 proto_after_greedy_proto = TRUE;
1636 if (!strchr(";@%", *p))
1637 bad_proto_after_underscore = TRUE;
1640 if (!strchr("$@%*;[]&\\_+", *p) || *p == '\0') {
1647 in_brackets = FALSE;
1648 else if ((*p == '@' || *p == '%') &&
1651 must_be_last = TRUE;
1660 after_slash = FALSE;
1665 SV *tmpsv = newSVpvs_flags("", SVs_TEMP);
1668 ? sv_uni_display(tmpsv, newSVpvn_flags(p, origlen, SVs_TEMP | SVf_UTF8),
1669 origlen, UNI_DISPLAY_ISPRINT)
1670 : pv_pretty(tmpsv, p, origlen, 60, NULL, NULL, PERL_PV_ESCAPE_NONASCII);
1672 if (proto_after_greedy_proto)
1673 Perl_warner(aTHX_ packWARN(WARN_ILLEGALPROTO),
1674 "Prototype after '%c' for %"SVf" : %s",
1675 greedy_proto, SVfARG(name), p);
1677 Perl_warner(aTHX_ packWARN(WARN_ILLEGALPROTO),
1678 "Missing ']' in prototype for %"SVf" : %s",
1681 Perl_warner(aTHX_ packWARN(WARN_ILLEGALPROTO),
1682 "Illegal character in prototype for %"SVf" : %s",
1684 if (bad_proto_after_underscore)
1685 Perl_warner(aTHX_ packWARN(WARN_ILLEGALPROTO),
1686 "Illegal character after '_' in prototype for %"SVf" : %s",
1690 return (! (proto_after_greedy_proto || bad_proto) );
1695 * This subroutine has nothing to do with tilting, whether at windmills
1696 * or pinball tables. Its name is short for "increment line". It
1697 * increments the current line number in CopLINE(PL_curcop) and checks
1698 * to see whether the line starts with a comment of the form
1699 * # line 500 "foo.pm"
1700 * If so, it sets the current line number and file to the values in the comment.
1704 S_incline(pTHX_ const char *s)
1712 PERL_ARGS_ASSERT_INCLINE;
1714 COPLINE_INC_WITH_HERELINES;
1715 if (!PL_rsfp && !PL_parser->filtered && PL_lex_state == LEX_NORMAL
1716 && s+1 == PL_bufend && *s == ';') {
1717 /* fake newline in string eval */
1718 CopLINE_dec(PL_curcop);
1723 while (SPACE_OR_TAB(*s))
1725 if (strnEQ(s, "line", 4))
1729 if (SPACE_OR_TAB(*s))
1733 while (SPACE_OR_TAB(*s))
1741 if (!SPACE_OR_TAB(*s) && *s != '\r' && *s != '\n' && *s != '\0')
1743 while (SPACE_OR_TAB(*s))
1745 if (*s == '"' && (t = strchr(s+1, '"'))) {
1751 while (!isSPACE(*t))
1755 while (SPACE_OR_TAB(*e) || *e == '\r' || *e == '\f')
1757 if (*e != '\n' && *e != '\0')
1758 return; /* false alarm */
1760 line_num = atoi(n)-1;
1763 const STRLEN len = t - s;
1765 if (!PL_rsfp && !PL_parser->filtered) {
1766 /* must copy *{"::_<(eval N)[oldfilename:L]"}
1767 * to *{"::_<newfilename"} */
1768 /* However, the long form of evals is only turned on by the
1769 debugger - usually they're "(eval %lu)" */
1770 GV * const cfgv = CopFILEGV(PL_curcop);
1773 STRLEN tmplen2 = len;
1777 if (tmplen2 + 2 <= sizeof smallbuf)
1780 Newx(tmpbuf2, tmplen2 + 2, char);
1785 memcpy(tmpbuf2 + 2, s, tmplen2);
1788 gv2 = *(GV**)hv_fetch(PL_defstash, tmpbuf2, tmplen2, TRUE);
1790 gv_init(gv2, PL_defstash, tmpbuf2, tmplen2, FALSE);
1791 /* adjust ${"::_<newfilename"} to store the new file name */
1792 GvSV(gv2) = newSVpvn(tmpbuf2 + 2, tmplen2 - 2);
1793 /* The line number may differ. If that is the case,
1794 alias the saved lines that are in the array.
1795 Otherwise alias the whole array. */
1796 if (CopLINE(PL_curcop) == line_num) {
1797 GvHV(gv2) = MUTABLE_HV(SvREFCNT_inc(GvHV(cfgv)));
1798 GvAV(gv2) = MUTABLE_AV(SvREFCNT_inc(GvAV(cfgv)));
1800 else if (GvAV(cfgv)) {
1801 AV * const av = GvAV(cfgv);
1802 const I32 start = CopLINE(PL_curcop)+1;
1803 I32 items = AvFILLp(av) - start;
1805 AV * const av2 = GvAVn(gv2);
1806 SV **svp = AvARRAY(av) + start;
1807 I32 l = (I32)line_num+1;
1809 av_store(av2, l++, SvREFCNT_inc(*svp++));
1814 if (tmpbuf2 != smallbuf) Safefree(tmpbuf2);
1817 CopFILE_free(PL_curcop);
1818 CopFILE_setn(PL_curcop, s, len);
1820 CopLINE_set(PL_curcop, line_num);
1823 #define skipspace(s) skipspace_flags(s, 0)
1826 /* skip space before PL_thistoken */
1829 S_skipspace0(pTHX_ char *s)
1831 PERL_ARGS_ASSERT_SKIPSPACE0;
1838 PL_thiswhite = newSVpvs("");
1839 sv_catsv(PL_thiswhite, PL_skipwhite);
1840 sv_free(PL_skipwhite);
1843 PL_realtokenstart = s - SvPVX(PL_linestr);
1847 /* skip space after PL_thistoken */
1850 S_skipspace1(pTHX_ char *s)
1852 const char *start = s;
1853 I32 startoff = start - SvPVX(PL_linestr);
1855 PERL_ARGS_ASSERT_SKIPSPACE1;
1860 start = SvPVX(PL_linestr) + startoff;
1861 if (!PL_thistoken && PL_realtokenstart >= 0) {
1862 const char * const tstart = SvPVX(PL_linestr) + PL_realtokenstart;
1863 PL_thistoken = newSVpvn(tstart, start - tstart);
1865 PL_realtokenstart = -1;
1868 PL_nextwhite = newSVpvs("");
1869 sv_catsv(PL_nextwhite, PL_skipwhite);
1870 sv_free(PL_skipwhite);
1877 S_skipspace2(pTHX_ char *s, SV **svp)
1880 const I32 startoff = s - SvPVX(PL_linestr);
1882 PERL_ARGS_ASSERT_SKIPSPACE2;
1885 if (!PL_madskills || !svp)
1887 start = SvPVX(PL_linestr) + startoff;
1888 if (!PL_thistoken && PL_realtokenstart >= 0) {
1889 char * const tstart = SvPVX(PL_linestr) + PL_realtokenstart;
1890 PL_thistoken = newSVpvn(tstart, start - tstart);
1891 PL_realtokenstart = -1;
1895 *svp = newSVpvs("");
1896 sv_setsv(*svp, PL_skipwhite);
1897 sv_free(PL_skipwhite);
1906 S_update_debugger_info(pTHX_ SV *orig_sv, const char *const buf, STRLEN len)
1908 AV *av = CopFILEAVx(PL_curcop);
1910 SV * const sv = newSV_type(SVt_PVMG);
1912 sv_setsv_flags(sv, orig_sv, 0); /* no cow */
1914 sv_setpvn(sv, buf, len);
1917 av_store(av, CopLINE(PL_curcop), sv);
1923 * Called to gobble the appropriate amount and type of whitespace.
1924 * Skips comments as well.
1928 S_skipspace_flags(pTHX_ char *s, U32 flags)
1932 #endif /* PERL_MAD */
1933 PERL_ARGS_ASSERT_SKIPSPACE_FLAGS;
1936 sv_free(PL_skipwhite);
1937 PL_skipwhite = NULL;
1939 #endif /* PERL_MAD */
1940 if (PL_lex_formbrack && PL_lex_brackets <= PL_lex_formbrack) {
1941 while (s < PL_bufend && SPACE_OR_TAB(*s))
1944 STRLEN bufptr_pos = PL_bufptr - SvPVX(PL_linestr);
1946 lex_read_space(flags | LEX_KEEP_PREVIOUS |
1947 (PL_sublex_info.sub_inwhat || PL_lex_state == LEX_FORMLINE ?
1948 LEX_NO_NEXT_CHUNK : 0));
1950 PL_bufptr = SvPVX(PL_linestr) + bufptr_pos;
1951 if (PL_linestart > PL_bufptr)
1952 PL_bufptr = PL_linestart;
1957 PL_skipwhite = newSVpvn(start, s-start);
1958 #endif /* PERL_MAD */
1964 * Check the unary operators to ensure there's no ambiguity in how they're
1965 * used. An ambiguous piece of code would be:
1967 * This doesn't mean rand() + 5. Because rand() is a unary operator,
1968 * the +5 is its argument.
1978 if (PL_oldoldbufptr != PL_last_uni)
1980 while (isSPACE(*PL_last_uni))
1983 while (isWORDCHAR_lazy_if(s,UTF) || *s == '-')
1985 if ((t = strchr(s, '(')) && t < PL_bufptr)
1988 Perl_ck_warner_d(aTHX_ packWARN(WARN_AMBIGUOUS),
1989 "Warning: Use of \"%.*s\" without parentheses is ambiguous",
1990 (int)(s - PL_last_uni), PL_last_uni);
1994 * LOP : macro to build a list operator. Its behaviour has been replaced
1995 * with a subroutine, S_lop() for which LOP is just another name.
1998 #define LOP(f,x) return lop(f,x,s)
2002 * Build a list operator (or something that might be one). The rules:
2003 * - if we have a next token, then it's a list operator [why?]
2004 * - if the next thing is an opening paren, then it's a function
2005 * - else it's a list operator
2009 S_lop(pTHX_ I32 f, int x, char *s)
2013 PERL_ARGS_ASSERT_LOP;
2019 PL_last_lop = PL_oldbufptr;
2020 PL_last_lop_op = (OPCODE)f;
2029 return REPORT(FUNC);
2032 return REPORT(FUNC);
2035 if (!PL_lex_allbrackets && PL_lex_fakeeof > LEX_FAKEEOF_LOWLOGIC)
2036 PL_lex_fakeeof = LEX_FAKEEOF_LOWLOGIC;
2037 return REPORT(LSTOP);
2044 * Sets up for an eventual force_next(). start_force(0) basically does
2045 * an unshift, while start_force(-1) does a push. yylex removes items
2050 S_start_force(pTHX_ int where)
2054 if (where < 0) /* so people can duplicate start_force(PL_curforce) */
2055 where = PL_lasttoke;
2056 assert(PL_curforce < 0 || PL_curforce == where);
2057 if (PL_curforce != where) {
2058 for (i = PL_lasttoke; i > where; --i) {
2059 PL_nexttoke[i] = PL_nexttoke[i-1];
2063 if (PL_curforce < 0) /* in case of duplicate start_force() */
2064 Zero(&PL_nexttoke[where], 1, NEXTTOKE);
2065 PL_curforce = where;
2068 curmad('^', newSVpvs(""));
2069 CURMAD('_', PL_nextwhite);
2074 S_curmad(pTHX_ char slot, SV *sv)
2080 if (PL_curforce < 0)
2081 where = &PL_thismad;
2083 where = &PL_nexttoke[PL_curforce].next_mad;
2089 if (UTF && is_utf8_string((U8*)SvPVX(sv), SvCUR(sv)))
2091 else if (PL_encoding) {
2092 sv_recode_to_utf8(sv, PL_encoding);
2097 /* keep a slot open for the head of the list? */
2098 if (slot != '_' && *where && (*where)->mad_key == '^') {
2099 (*where)->mad_key = slot;
2100 sv_free(MUTABLE_SV(((*where)->mad_val)));
2101 (*where)->mad_val = (void*)sv;
2104 addmad(newMADsv(slot, sv), where, 0);
2107 # define start_force(where) NOOP
2108 # define curmad(slot, sv) NOOP
2113 * When the lexer realizes it knows the next token (for instance,
2114 * it is reordering tokens for the parser) then it can call S_force_next
2115 * to know what token to return the next time the lexer is called. Caller
2116 * will need to set PL_nextval[] (or PL_nexttoke[].next_val with PERL_MAD),
2117 * and possibly PL_expect to ensure the lexer handles the token correctly.
2121 S_force_next(pTHX_ I32 type)
2126 PerlIO_printf(Perl_debug_log, "### forced token:\n");
2127 tokereport(type, &NEXTVAL_NEXTTOKE);
2131 if (PL_curforce < 0)
2132 start_force(PL_lasttoke);
2133 PL_nexttoke[PL_curforce].next_type = type;
2134 if (PL_lex_state != LEX_KNOWNEXT)
2135 PL_lex_defer = PL_lex_state;
2136 PL_lex_state = LEX_KNOWNEXT;
2137 PL_lex_expect = PL_expect;
2140 PL_nexttype[PL_nexttoke] = type;
2142 if (PL_lex_state != LEX_KNOWNEXT) {
2143 PL_lex_defer = PL_lex_state;
2144 PL_lex_expect = PL_expect;
2145 PL_lex_state = LEX_KNOWNEXT;
2153 int yyc = PL_parser->yychar;
2154 if (yyc != YYEMPTY) {
2157 NEXTVAL_NEXTTOKE = PL_parser->yylval;
2158 if (yyc == '{'/*}*/ || yyc == HASHBRACK || yyc == '['/*]*/) {
2159 PL_lex_allbrackets--;
2161 yyc |= (3<<24) | (PL_lex_brackstack[PL_lex_brackets] << 16);
2162 } else if (yyc == '('/*)*/) {
2163 PL_lex_allbrackets--;
2168 PL_parser->yychar = YYEMPTY;
2173 S_newSV_maybe_utf8(pTHX_ const char *const start, STRLEN len)
2176 SV * const sv = newSVpvn_utf8(start, len,
2179 && !is_ascii_string((const U8*)start, len)
2180 && is_utf8_string((const U8*)start, len));
2186 * When the lexer knows the next thing is a word (for instance, it has
2187 * just seen -> and it knows that the next char is a word char, then
2188 * it calls S_force_word to stick the next word into the PL_nexttoke/val
2192 * char *start : buffer position (must be within PL_linestr)
2193 * int token : PL_next* will be this type of bare word (e.g., METHOD,WORD)
2194 * int check_keyword : if true, Perl checks to make sure the word isn't
2195 * a keyword (do this if the word is a label, e.g. goto FOO)
2196 * int allow_pack : if true, : characters will also be allowed (require,
2197 * use, etc. do this)
2198 * int allow_initial_tick : used by the "sub" lexer only.
2202 S_force_word(pTHX_ char *start, int token, int check_keyword, int allow_pack)
2208 PERL_ARGS_ASSERT_FORCE_WORD;
2210 start = SKIPSPACE1(start);
2212 if (isIDFIRST_lazy_if(s,UTF) ||
2213 (allow_pack && *s == ':') )
2215 s = scan_word(s, PL_tokenbuf, sizeof PL_tokenbuf, allow_pack, &len);
2216 if (check_keyword) {
2217 char *s2 = PL_tokenbuf;
2218 if (allow_pack && len > 6 && strnEQ(s2, "CORE::", 6))
2220 if (keyword(s2, len, 0))
2223 start_force(PL_curforce);
2225 curmad('X', newSVpvn(start,s-start));
2226 if (token == METHOD) {
2231 PL_expect = XOPERATOR;
2235 curmad('g', newSVpvs( "forced" ));
2236 NEXTVAL_NEXTTOKE.opval
2237 = (OP*)newSVOP(OP_CONST,0,
2238 S_newSV_maybe_utf8(aTHX_ PL_tokenbuf, len));
2239 NEXTVAL_NEXTTOKE.opval->op_private |= OPpCONST_BARE;
2247 * Called when the lexer wants $foo *foo &foo etc, but the program
2248 * text only contains the "foo" portion. The first argument is a pointer
2249 * to the "foo", and the second argument is the type symbol to prefix.
2250 * Forces the next token to be a "WORD".
2251 * Creates the symbol if it didn't already exist (via gv_fetchpv()).
2255 S_force_ident(pTHX_ const char *s, int kind)
2259 PERL_ARGS_ASSERT_FORCE_IDENT;
2262 const STRLEN len = s[1] ? strlen(s) : 1; /* s = "\"" see yylex */
2263 OP* const o = (OP*)newSVOP(OP_CONST, 0, newSVpvn_flags(s, len,
2264 UTF ? SVf_UTF8 : 0));
2265 start_force(PL_curforce);
2266 NEXTVAL_NEXTTOKE.opval = o;
2269 o->op_private = OPpCONST_ENTERED;
2270 /* XXX see note in pp_entereval() for why we forgo typo
2271 warnings if the symbol must be introduced in an eval.
2273 gv_fetchpvn_flags(s, len,
2274 (PL_in_eval ? (GV_ADDMULTI | GV_ADDINEVAL)
2275 : GV_ADD) | ( UTF ? SVf_UTF8 : 0 ),
2276 kind == '$' ? SVt_PV :
2277 kind == '@' ? SVt_PVAV :
2278 kind == '%' ? SVt_PVHV :
2286 S_force_ident_maybe_lex(pTHX_ char pit)
2288 start_force(PL_curforce);
2289 NEXTVAL_NEXTTOKE.ival = pit;
2294 Perl_str_to_version(pTHX_ SV *sv)
2299 const char *start = SvPV_const(sv,len);
2300 const char * const end = start + len;
2301 const bool utf = SvUTF8(sv) ? TRUE : FALSE;
2303 PERL_ARGS_ASSERT_STR_TO_VERSION;
2305 while (start < end) {
2309 n = utf8n_to_uvchr((U8*)start, len, &skip, 0);
2314 retval += ((NV)n)/nshift;
2323 * Forces the next token to be a version number.
2324 * If the next token appears to be an invalid version number, (e.g. "v2b"),
2325 * and if "guessing" is TRUE, then no new token is created (and the caller
2326 * must use an alternative parsing method).
2330 S_force_version(pTHX_ char *s, int guessing)
2336 I32 startoff = s - SvPVX(PL_linestr);
2339 PERL_ARGS_ASSERT_FORCE_VERSION;
2347 while (isDIGIT(*d) || *d == '_' || *d == '.')
2351 start_force(PL_curforce);
2352 curmad('X', newSVpvn(s,d-s));
2355 if (*d == ';' || isSPACE(*d) || *d == '{' || *d == '}' || !*d) {
2357 #ifdef USE_LOCALE_NUMERIC
2358 char *loc = savepv(setlocale(LC_NUMERIC, NULL));
2359 setlocale(LC_NUMERIC, "C");
2361 s = scan_num(s, &pl_yylval);
2362 #ifdef USE_LOCALE_NUMERIC
2363 setlocale(LC_NUMERIC, loc);
2366 version = pl_yylval.opval;
2367 ver = cSVOPx(version)->op_sv;
2368 if (SvPOK(ver) && !SvNIOK(ver)) {
2369 SvUPGRADE(ver, SVt_PVNV);
2370 SvNV_set(ver, str_to_version(ver));
2371 SvNOK_on(ver); /* hint that it is a version */
2374 else if (guessing) {
2377 sv_free(PL_nextwhite); /* let next token collect whitespace */
2379 s = SvPVX(PL_linestr) + startoff;
2387 if (PL_madskills && !version) {
2388 sv_free(PL_nextwhite); /* let next token collect whitespace */
2390 s = SvPVX(PL_linestr) + startoff;
2393 /* NOTE: The parser sees the package name and the VERSION swapped */
2394 start_force(PL_curforce);
2395 NEXTVAL_NEXTTOKE.opval = version;
2402 * S_force_strict_version
2403 * Forces the next token to be a version number using strict syntax rules.
2407 S_force_strict_version(pTHX_ char *s)
2412 I32 startoff = s - SvPVX(PL_linestr);
2414 const char *errstr = NULL;
2416 PERL_ARGS_ASSERT_FORCE_STRICT_VERSION;
2418 while (isSPACE(*s)) /* leading whitespace */
2421 if (is_STRICT_VERSION(s,&errstr)) {
2423 s = (char *)scan_version(s, ver, 0);
2424 version = newSVOP(OP_CONST, 0, ver);
2426 else if ( (*s != ';' && *s != '{' && *s != '}' ) &&
2427 (s = SKIPSPACE1(s), (*s != ';' && *s != '{' && *s != '}' )))
2431 yyerror(errstr); /* version required */
2436 if (PL_madskills && !version) {
2437 sv_free(PL_nextwhite); /* let next token collect whitespace */
2439 s = SvPVX(PL_linestr) + startoff;
2442 /* NOTE: The parser sees the package name and the VERSION swapped */
2443 start_force(PL_curforce);
2444 NEXTVAL_NEXTTOKE.opval = version;
2452 * Tokenize a quoted string passed in as an SV. It finds the next
2453 * chunk, up to end of string or a backslash. It may make a new
2454 * SV containing that chunk (if HINT_NEW_STRING is on). It also
2459 S_tokeq(pTHX_ SV *sv)
2468 PERL_ARGS_ASSERT_TOKEQ;
2473 s = SvPV_force(sv, len);
2474 if (SvTYPE(sv) >= SVt_PVIV && SvIVX(sv) == -1)
2477 /* This is relying on the SV being "well formed" with a trailing '\0' */
2478 while (s < send && !(*s == '\\' && s[1] == '\\'))
2483 if ( PL_hints & HINT_NEW_STRING ) {
2484 pv = newSVpvn_flags(SvPVX_const(pv), len, SVs_TEMP | SvUTF8(sv));
2488 if (s + 1 < send && (s[1] == '\\'))
2489 s++; /* all that, just for this */
2494 SvCUR_set(sv, d - SvPVX_const(sv));
2496 if ( PL_hints & HINT_NEW_STRING )
2497 return new_constant(NULL, 0, "q", sv, pv, "q", 1);
2502 * Now come three functions related to double-quote context,
2503 * S_sublex_start, S_sublex_push, and S_sublex_done. They're used when
2504 * converting things like "\u\Lgnat" into ucfirst(lc("gnat")). They
2505 * interact with PL_lex_state, and create fake ( ... ) argument lists
2506 * to handle functions and concatenation.
2510 * stringify ( const[foo] concat lcfirst ( const[bar] ) )
2515 * Assumes that pl_yylval.ival is the op we're creating (e.g. OP_LCFIRST).
2517 * Pattern matching will set PL_lex_op to the pattern-matching op to
2518 * make (we return THING if pl_yylval.ival is OP_NULL, PMFUNC otherwise).
2520 * OP_CONST and OP_READLINE are easy--just make the new op and return.
2522 * Everything else becomes a FUNC.
2524 * Sets PL_lex_state to LEX_INTERPPUSH unless (ival was OP_NULL or we
2525 * had an OP_CONST or OP_READLINE). This just sets us up for a
2526 * call to S_sublex_push().
2530 S_sublex_start(pTHX)
2533 const I32 op_type = pl_yylval.ival;
2535 if (op_type == OP_NULL) {
2536 pl_yylval.opval = PL_lex_op;
2540 if (op_type == OP_CONST || op_type == OP_READLINE) {
2541 SV *sv = tokeq(PL_lex_stuff);
2543 if (SvTYPE(sv) == SVt_PVIV) {
2544 /* Overloaded constants, nothing fancy: Convert to SVt_PV: */
2546 const char * const p = SvPV_const(sv, len);
2547 SV * const nsv = newSVpvn_flags(p, len, SvUTF8(sv));
2551 pl_yylval.opval = (OP*)newSVOP(op_type, 0, sv);
2552 PL_lex_stuff = NULL;
2553 /* Allow <FH> // "foo" */
2554 if (op_type == OP_READLINE)
2555 PL_expect = XTERMORDORDOR;
2558 else if (op_type == OP_BACKTICK && PL_lex_op) {
2559 /* readpipe() was overridden */
2560 cSVOPx(cLISTOPx(cUNOPx(PL_lex_op)->op_first)->op_first->op_sibling)->op_sv = tokeq(PL_lex_stuff);
2561 pl_yylval.opval = PL_lex_op;
2563 PL_lex_stuff = NULL;
2567 PL_sublex_info.super_state = PL_lex_state;
2568 PL_sublex_info.sub_inwhat = (U16)op_type;
2569 PL_sublex_info.sub_op = PL_lex_op;
2570 PL_lex_state = LEX_INTERPPUSH;
2574 pl_yylval.opval = PL_lex_op;
2584 * Create a new scope to save the lexing state. The scope will be
2585 * ended in S_sublex_done. Returns a '(', starting the function arguments
2586 * to the uc, lc, etc. found before.
2587 * Sets PL_lex_state to LEX_INTERPCONCAT.
2595 const bool is_heredoc =
2596 CopLINE(PL_curcop) == (line_t)PL_multi_start - 1;
2599 assert(CopLINE(PL_curcop) == (line_t)PL_multi_start
2600 || CopLINE(PL_curcop) == (line_t)PL_multi_start - 1);
2602 PL_lex_state = PL_sublex_info.super_state;
2603 SAVEBOOL(PL_lex_dojoin);
2604 SAVEI32(PL_lex_brackets);
2605 SAVEI32(PL_lex_allbrackets);
2606 SAVEI32(PL_lex_formbrack);
2607 SAVEI8(PL_lex_fakeeof);
2608 SAVEI32(PL_lex_casemods);
2609 SAVEI32(PL_lex_starts);
2610 SAVEI8(PL_lex_state);
2611 SAVESPTR(PL_lex_repl);
2612 SAVEVPTR(PL_lex_inpat);
2613 SAVEI16(PL_lex_inwhat);
2615 SAVECOPLINE(PL_curcop);
2616 SAVEPPTR(PL_bufptr);
2617 SAVEPPTR(PL_bufend);
2618 SAVEPPTR(PL_oldbufptr);
2619 SAVEPPTR(PL_oldoldbufptr);
2620 SAVEPPTR(PL_last_lop);
2621 SAVEPPTR(PL_last_uni);
2622 SAVEPPTR(PL_linestart);
2623 SAVESPTR(PL_linestr);
2624 SAVEGENERICPV(PL_lex_brackstack);
2625 SAVEGENERICPV(PL_lex_casestack);
2626 SAVEGENERICPV(PL_parser->lex_shared);
2627 SAVEBOOL(PL_parser->lex_re_reparsing);
2628 SAVEI32(PL_copline);
2630 /* The here-doc parser needs to be able to peek into outer lexing
2631 scopes to find the body of the here-doc. So we put PL_linestr and
2632 PL_bufptr into lex_shared, to ‘share’ those values.
2634 PL_parser->lex_shared->ls_linestr = PL_linestr;
2635 PL_parser->lex_shared->ls_bufptr = PL_bufptr;
2637 PL_linestr = PL_lex_stuff;
2638 PL_lex_repl = PL_sublex_info.repl;
2639 PL_lex_stuff = NULL;
2640 PL_sublex_info.repl = NULL;
2642 PL_bufend = PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart
2643 = SvPVX(PL_linestr);
2644 PL_bufend += SvCUR(PL_linestr);
2645 PL_last_lop = PL_last_uni = NULL;
2646 SAVEFREESV(PL_linestr);
2647 if (PL_lex_repl) SAVEFREESV(PL_lex_repl);
2649 PL_lex_dojoin = FALSE;
2650 PL_lex_brackets = PL_lex_formbrack = 0;
2651 PL_lex_allbrackets = 0;
2652 PL_lex_fakeeof = LEX_FAKEEOF_NEVER;
2653 Newx(PL_lex_brackstack, 120, char);
2654 Newx(PL_lex_casestack, 12, char);
2655 PL_lex_casemods = 0;
2656 *PL_lex_casestack = '\0';
2658 PL_lex_state = LEX_INTERPCONCAT;
2660 CopLINE_inc(PL_curcop);
2661 PL_copline = NOLINE;
2663 Newxz(shared, 1, LEXSHARED);
2664 shared->ls_prev = PL_parser->lex_shared;
2665 PL_parser->lex_shared = shared;
2666 if (!is_heredoc && PL_multi_start != PL_multi_end) {
2667 shared->herelines = shared->ls_prev->herelines;
2668 shared->ls_prev->herelines = 0;
2671 PL_lex_inwhat = PL_sublex_info.sub_inwhat;
2672 if (PL_lex_inwhat == OP_TRANSR) PL_lex_inwhat = OP_TRANS;
2673 if (PL_lex_inwhat == OP_MATCH || PL_lex_inwhat == OP_QR || PL_lex_inwhat == OP_SUBST)
2674 PL_lex_inpat = PL_sublex_info.sub_op;
2676 PL_lex_inpat = NULL;
2678 PL_parser->lex_re_reparsing = cBOOL(PL_in_eval & EVAL_RE_REPARSING);
2679 PL_in_eval &= ~EVAL_RE_REPARSING;
2686 * Restores lexer state after a S_sublex_push.
2693 if (!PL_lex_starts++) {
2694 SV * const sv = newSVpvs("");
2695 if (SvUTF8(PL_linestr))
2697 PL_expect = XOPERATOR;
2698 pl_yylval.opval = (OP*)newSVOP(OP_CONST, 0, sv);
2702 if (PL_lex_casemods) { /* oops, we've got some unbalanced parens */
2703 PL_lex_state = LEX_INTERPCASEMOD;
2707 /* Is there a right-hand side to take care of? (s//RHS/ or tr//RHS/) */
2708 assert(PL_lex_inwhat != OP_TRANSR);
2709 if (PL_lex_repl && (PL_lex_inwhat == OP_SUBST || PL_lex_inwhat == OP_TRANS)) {
2710 PL_linestr = PL_lex_repl;
2712 PL_bufend = PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
2713 PL_bufend += SvCUR(PL_linestr);
2714 PL_last_lop = PL_last_uni = NULL;
2715 PL_lex_dojoin = FALSE;
2716 PL_lex_brackets = 0;
2717 PL_lex_allbrackets = 0;
2718 PL_lex_fakeeof = LEX_FAKEEOF_NEVER;
2719 PL_lex_casemods = 0;
2720 *PL_lex_casestack = '\0';
2722 if (SvEVALED(PL_lex_repl)) {
2723 PL_lex_state = LEX_INTERPNORMAL;
2725 /* we don't clear PL_lex_repl here, so that we can check later
2726 whether this is an evalled subst; that means we rely on the
2727 logic to ensure sublex_done() is called again only via the
2728 branch (in yylex()) that clears PL_lex_repl, else we'll loop */
2731 PL_lex_state = LEX_INTERPCONCAT;
2734 if (SvTYPE(PL_linestr) >= SVt_PVNV) {
2735 CopLINE(PL_curcop) +=
2736 ((XPVNV*)SvANY(PL_linestr))->xnv_u.xpad_cop_seq.xlow
2737 + PL_parser->lex_shared->herelines;
2738 PL_parser->lex_shared->herelines = 0;
2747 PL_endwhite = newSVpvs("");
2748 sv_catsv(PL_endwhite, PL_thiswhite);
2752 sv_setpvs(PL_thistoken,"");
2754 PL_realtokenstart = -1;
2758 PL_bufend = SvPVX(PL_linestr);
2759 PL_bufend += SvCUR(PL_linestr);
2760 PL_expect = XOPERATOR;
2761 PL_sublex_info.sub_inwhat = 0;
2766 PERL_STATIC_INLINE SV*
2767 S_get_and_check_backslash_N_name(pTHX_ const char* s, const char* const e)
2769 /* <s> points to first character of interior of \N{}, <e> to one beyond the
2770 * interior, hence to the "}". Finds what the name resolves to, returning
2771 * an SV* containing it; NULL if no valid one found */
2773 SV* res = newSVpvn_flags(s, e - s, UTF ? SVf_UTF8 : 0);
2780 const U8* first_bad_char_loc;
2781 const char* backslash_ptr = s - 3; /* Points to the <\> of \N{... */
2783 PERL_ARGS_ASSERT_GET_AND_CHECK_BACKSLASH_N_NAME;
2785 if (UTF && ! is_utf8_string_loc((U8 *) backslash_ptr,
2787 &first_bad_char_loc))
2789 /* If warnings are on, this will print a more detailed analysis of what
2790 * is wrong than the error message below */
2791 utf8n_to_uvchr(first_bad_char_loc,
2792 e - ((char *) first_bad_char_loc),
2795 /* We deliberately don't try to print the malformed character, which
2796 * might not print very well; it also may be just the first of many
2797 * malformations, so don't print what comes after it */
2798 yyerror(Perl_form(aTHX_
2799 "Malformed UTF-8 character immediately after '%.*s'",
2800 (int) (first_bad_char_loc - (U8 *) backslash_ptr), backslash_ptr));
2804 res = new_constant( NULL, 0, "charnames", res, NULL, backslash_ptr,
2805 /* include the <}> */
2806 e - backslash_ptr + 1);
2808 SvREFCNT_dec_NN(res);
2812 /* See if the charnames handler is the Perl core's, and if so, we can skip
2813 * the validation needed for a user-supplied one, as Perl's does its own
2815 table = GvHV(PL_hintgv); /* ^H */
2816 cvp = hv_fetchs(table, "charnames", FALSE);
2817 if (cvp && (cv = *cvp) && SvROK(cv) && ((rv = SvRV(cv)) != NULL)
2818 && SvTYPE(rv) == SVt_PVCV && ((stash = CvSTASH(rv)) != NULL))
2820 const char * const name = HvNAME(stash);
2821 if strEQ(name, "_charnames") {
2826 /* Here, it isn't Perl's charname handler. We can't rely on a
2827 * user-supplied handler to validate the input name. For non-ut8 input,
2828 * look to see that the first character is legal. Then loop through the
2829 * rest checking that each is a continuation */
2831 /* This code needs to be sync'ed with a regex in _charnames.pm which does
2835 if (! isALPHAU(*s)) {
2840 if (! isCHARNAME_CONT(*s)) {
2843 if (*s == ' ' && *(s-1) == ' ' && ckWARN_d(WARN_DEPRECATED)) {
2844 Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),
2845 "A sequence of multiple spaces in a charnames "
2846 "alias definition is deprecated");
2850 if (*(s-1) == ' ' && ckWARN_d(WARN_DEPRECATED)) {
2851 Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),
2852 "Trailing white-space in a charnames alias "
2853 "definition is deprecated");
2857 /* Similarly for utf8. For invariants can check directly; for other
2858 * Latin1, can calculate their code point and check; otherwise use a
2860 if (UTF8_IS_INVARIANT(*s)) {
2861 if (! isALPHAU(*s)) {
2865 } else if (UTF8_IS_DOWNGRADEABLE_START(*s)) {
2866 if (! isALPHAU(TWO_BYTE_UTF8_TO_NATIVE(*s, *(s+1)))) {
2872 if (! PL_utf8_charname_begin) {
2873 U8 flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
2874 PL_utf8_charname_begin = _core_swash_init("utf8",
2875 "_Perl_Charname_Begin",
2877 1, 0, NULL, &flags);
2879 if (! swash_fetch(PL_utf8_charname_begin, (U8 *) s, TRUE)) {
2886 if (UTF8_IS_INVARIANT(*s)) {
2887 if (! isCHARNAME_CONT(*s)) {
2890 if (*s == ' ' && *(s-1) == ' '
2891 && ckWARN_d(WARN_DEPRECATED)) {
2892 Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),
2893 "A sequence of multiple spaces in a charnam"
2894 "es alias definition is deprecated");
2898 else if (UTF8_IS_DOWNGRADEABLE_START(*s)) {
2899 if (! isCHARNAME_CONT(TWO_BYTE_UTF8_TO_NATIVE(*s, *(s+1))))
2906 if (! PL_utf8_charname_continue) {
2907 U8 flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
2908 PL_utf8_charname_continue = _core_swash_init("utf8",
2909 "_Perl_Charname_Continue",
2911 1, 0, NULL, &flags);
2913 if (! swash_fetch(PL_utf8_charname_continue, (U8 *) s, TRUE)) {
2919 if (*(s-1) == ' ' && ckWARN_d(WARN_DEPRECATED)) {
2920 Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),
2921 "Trailing white-space in a charnames alias "
2922 "definition is deprecated");
2926 if (SvUTF8(res)) { /* Don't accept malformed input */
2927 const U8* first_bad_char_loc;
2929 const char* const str = SvPV_const(res, len);
2930 if (! is_utf8_string_loc((U8 *) str, len, &first_bad_char_loc)) {
2931 /* If warnings are on, this will print a more detailed analysis of
2932 * what is wrong than the error message below */
2933 utf8n_to_uvchr(first_bad_char_loc,
2934 (char *) first_bad_char_loc - str,
2937 /* We deliberately don't try to print the malformed character,
2938 * which might not print very well; it also may be just the first
2939 * of many malformations, so don't print what comes after it */
2942 "Malformed UTF-8 returned by %.*s immediately after '%.*s'",
2943 (int) (e - backslash_ptr + 1), backslash_ptr,
2944 (int) ((char *) first_bad_char_loc - str), str
2954 int bad_char_size = ((UTF) ? UTF8SKIP(s) : 1);
2956 /* The final %.*s makes sure that should the trailing NUL be missing
2957 * that this print won't run off the end of the string */
2960 "Invalid character in \\N{...}; marked by <-- HERE in %.*s<-- HERE %.*s",
2961 (int)(s - backslash_ptr + bad_char_size), backslash_ptr,
2962 (int)(e - s + bad_char_size), s + bad_char_size
2964 UTF ? SVf_UTF8 : 0);
2972 Extracts the next constant part of a pattern, double-quoted string,
2973 or transliteration. This is terrifying code.
2975 For example, in parsing the double-quoted string "ab\x63$d", it would
2976 stop at the '$' and return an OP_CONST containing 'abc'.
2978 It looks at PL_lex_inwhat and PL_lex_inpat to find out whether it's
2979 processing a pattern (PL_lex_inpat is true), a transliteration
2980 (PL_lex_inwhat == OP_TRANS is true), or a double-quoted string.
2982 Returns a pointer to the character scanned up to. If this is
2983 advanced from the start pointer supplied (i.e. if anything was
2984 successfully parsed), will leave an OP_CONST for the substring scanned
2985 in pl_yylval. Caller must intuit reason for not parsing further
2986 by looking at the next characters herself.
2990 \N{FOO} => \N{U+hex_for_character_FOO}
2991 (if FOO expands to multiple characters, expands to \N{U+xx.XX.yy ...})
2994 all other \-char, including \N and \N{ apart from \N{ABC}
2997 @ and $ where it appears to be a var, but not for $ as tail anchor
3002 In transliterations:
3003 characters are VERY literal, except for - not at the start or end
3004 of the string, which indicates a range. If the range is in bytes,
3005 scan_const expands the range to the full set of intermediate
3006 characters. If the range is in utf8, the hyphen is replaced with
3007 a certain range mark which will be handled by pmtrans() in op.c.
3009 In double-quoted strings:
3011 double-quoted style: \r and \n
3012 constants: \x31, etc.
3013 deprecated backrefs: \1 (in substitution replacements)
3014 case and quoting: \U \Q \E
3017 scan_const does *not* construct ops to handle interpolated strings.
3018 It stops processing as soon as it finds an embedded $ or @ variable
3019 and leaves it to the caller to work out what's going on.
3021 embedded arrays (whether in pattern or not) could be:
3022 @foo, @::foo, @'foo, @{foo}, @$foo, @+, @-.
3024 $ in double-quoted strings must be the symbol of an embedded scalar.
3026 $ in pattern could be $foo or could be tail anchor. Assumption:
3027 it's a tail anchor if $ is the last thing in the string, or if it's
3028 followed by one of "()| \r\n\t"
3030 \1 (backreferences) are turned into $1 in substitutions
3032 The structure of the code is
3033 while (there's a character to process) {
3034 handle transliteration ranges
3035 skip regexp comments /(?#comment)/ and codes /(?{code})/
3036 skip #-initiated comments in //x patterns
3037 check for embedded arrays
3038 check for embedded scalars
3040 deprecate \1 in substitution replacements
3041 handle string-changing backslashes \l \U \Q \E, etc.
3042 switch (what was escaped) {
3043 handle \- in a transliteration (becomes a literal -)
3044 if a pattern and not \N{, go treat as regular character
3045 handle \132 (octal characters)
3046 handle \x15 and \x{1234} (hex characters)
3047 handle \N{name} (named characters, also \N{3,5} in a pattern)
3048 handle \cV (control characters)
3049 handle printf-style backslashes (\f, \r, \n, etc)
3052 } (end if backslash)
3053 handle regular character
3054 } (end while character to read)
3059 S_scan_const(pTHX_ char *start)
3062 char *send = PL_bufend; /* end of the constant */
3063 SV *sv = newSV(send - start); /* sv for the constant. See
3064 note below on sizing. */
3065 char *s = start; /* start of the constant */
3066 char *d = SvPVX(sv); /* destination for copies */
3067 bool dorange = FALSE; /* are we in a translit range? */
3068 bool didrange = FALSE; /* did we just finish a range? */
3069 bool in_charclass = FALSE; /* within /[...]/ */
3070 bool has_utf8 = FALSE; /* Output constant is UTF8 */
3071 bool this_utf8 = cBOOL(UTF); /* Is the source string assumed
3072 to be UTF8? But, this can
3073 show as true when the source
3074 isn't utf8, as for example
3075 when it is entirely composed
3077 SV *res; /* result from charnames */
3079 /* Note on sizing: The scanned constant is placed into sv, which is
3080 * initialized by newSV() assuming one byte of output for every byte of
3081 * input. This routine expects newSV() to allocate an extra byte for a
3082 * trailing NUL, which this routine will append if it gets to the end of
3083 * the input. There may be more bytes of input than output (eg., \N{LATIN
3084 * CAPITAL LETTER A}), or more output than input if the constant ends up
3085 * recoded to utf8, but each time a construct is found that might increase
3086 * the needed size, SvGROW() is called. Its size parameter each time is
3087 * based on the best guess estimate at the time, namely the length used so
3088 * far, plus the length the current construct will occupy, plus room for
3089 * the trailing NUL, plus one byte for every input byte still unscanned */
3091 UV uv = UV_MAX; /* Initialize to weird value to try to catch any uses
3094 UV literal_endpoint = 0;
3095 bool native_range = TRUE; /* turned to FALSE if the first endpoint is Unicode. */
3098 PERL_ARGS_ASSERT_SCAN_CONST;
3100 assert(PL_lex_inwhat != OP_TRANSR);
3101 if (PL_lex_inwhat == OP_TRANS && PL_sublex_info.sub_op) {
3102 /* If we are doing a trans and we know we want UTF8 set expectation */
3103 has_utf8 = PL_sublex_info.sub_op->op_private & (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF);
3104 this_utf8 = PL_sublex_info.sub_op->op_private & (PL_lex_repl ? OPpTRANS_FROM_UTF : OPpTRANS_TO_UTF);
3107 /* Protect sv from errors and fatal warnings. */
3108 ENTER_with_name("scan_const");
3111 while (s < send || dorange) {
3113 /* get transliterations out of the way (they're most literal) */
3114 if (PL_lex_inwhat == OP_TRANS) {
3115 /* expand a range A-Z to the full set of characters. AIE! */
3117 I32 i; /* current expanded character */
3118 I32 min; /* first character in range */
3119 I32 max; /* last character in range */
3130 char * const c = (char*)utf8_hop((U8*)d, -1);
3134 *c = (char) ILLEGAL_UTF8_BYTE;
3135 /* mark the range as done, and continue */
3141 i = d - SvPVX_const(sv); /* remember current offset */
3144 SvLEN(sv) + (has_utf8 ?
3145 (512 - UTF_CONTINUATION_MARK +
3148 /* How many two-byte within 0..255: 128 in UTF-8,
3149 * 96 in UTF-8-mod. */
3151 SvGROW(sv, SvLEN(sv) + 256); /* never more than 256 chars in a range */
3153 d = SvPVX(sv) + i; /* refresh d after realloc */
3157 for (j = 0; j <= 1; j++) {
3158 char * const c = (char*)utf8_hop((U8*)d, -1);
3159 const UV uv = utf8n_to_uvchr((U8*)c, d - c, NULL, 0);
3165 max = (U8)0xff; /* only to \xff */
3166 uvmax = uv; /* \x{100} to uvmax */
3168 d = c; /* eat endpoint chars */
3173 d -= 2; /* eat the first char and the - */
3174 min = (U8)*d; /* first char in range */
3175 max = (U8)d[1]; /* last char in range */
3182 "Invalid range \"%c-%c\" in transliteration operator",
3183 (char)min, (char)max);
3187 if (literal_endpoint == 2 &&
3188 ((isLOWER_A(min) && isLOWER_A(max)) ||
3189 (isUPPER_A(min) && isUPPER_A(max))))
3191 for (i = min; i <= max; i++) {
3198 for (i = min; i <= max; i++)
3201 append_utf8_from_native_byte(i, &d);
3209 d = (char*)uvchr_to_utf8((U8*)d, 0x100);
3211 *d++ = (char) ILLEGAL_UTF8_BYTE;
3213 d = (char*)uvchr_to_utf8((U8*)d, uvmax);
3217 /* mark the range as done, and continue */
3221 literal_endpoint = 0;
3226 /* range begins (ignore - as first or last char) */
3227 else if (*s == '-' && s+1 < send && s != start) {
3229 Perl_croak(aTHX_ "Ambiguous range in transliteration operator");
3236 *d++ = (char) ILLEGAL_UTF8_BYTE; /* use illegal utf8 byte--see pmtrans */
3246 literal_endpoint = 0;
3247 native_range = TRUE;
3252 /* if we get here, we're not doing a transliteration */
3254 else if (*s == '[' && PL_lex_inpat && !in_charclass) {
3257 while (s1 >= start && *s1-- == '\\')
3260 in_charclass = TRUE;
3263 else if (*s == ']' && PL_lex_inpat && in_charclass) {
3266 while (s1 >= start && *s1-- == '\\')
3269 in_charclass = FALSE;
3272 /* skip for regexp comments /(?#comment)/, except for the last
3273 * char, which will be done separately.
3274 * Stop on (?{..}) and friends */
3276 else if (*s == '(' && PL_lex_inpat && s[1] == '?' && !in_charclass) {
3278 while (s+1 < send && *s != ')')
3281 else if (!PL_lex_casemods &&
3282 ( s[2] == '{' /* This should match regcomp.c */
3283 || (s[2] == '?' && s[3] == '{')))
3289 /* likewise skip #-initiated comments in //x patterns */
3290 else if (*s == '#' && PL_lex_inpat && !in_charclass &&
3291 ((PMOP*)PL_lex_inpat)->op_pmflags & RXf_PMf_EXTENDED) {
3292 while (s+1 < send && *s != '\n')
3296 /* no further processing of single-quoted regex */
3297 else if (PL_lex_inpat && SvIVX(PL_linestr) == '\'')
3298 goto default_action;
3300 /* check for embedded arrays
3301 (@foo, @::foo, @'foo, @{foo}, @$foo, @+, @-)
3303 else if (*s == '@' && s[1]) {
3304 if (isWORDCHAR_lazy_if(s+1,UTF))
3306 if (strchr(":'{$", s[1]))
3308 if (!PL_lex_inpat && (s[1] == '+' || s[1] == '-'))
3309 break; /* in regexp, neither @+ nor @- are interpolated */
3312 /* check for embedded scalars. only stop if we're sure it's a
3315 else if (*s == '$') {
3316 if (!PL_lex_inpat) /* not a regexp, so $ must be var */
3318 if (s + 1 < send && !strchr("()| \r\n\t", s[1])) {
3320 Perl_ck_warner(aTHX_ packWARN(WARN_AMBIGUOUS),
3321 "Possible unintended interpolation of $\\ in regex");
3323 break; /* in regexp, $ might be tail anchor */
3327 /* End of else if chain - OP_TRANS rejoin rest */
3330 if (*s == '\\' && s+1 < send) {
3331 char* e; /* Can be used for ending '}', etc. */
3335 /* warn on \1 - \9 in substitution replacements, but note that \11
3336 * is an octal; and \19 is \1 followed by '9' */
3337 if (PL_lex_inwhat == OP_SUBST && !PL_lex_inpat &&
3338 isDIGIT(*s) && *s != '0' && !isDIGIT(s[1]))
3340 Perl_ck_warner(aTHX_ packWARN(WARN_SYNTAX), "\\%c better written as $%c", *s, *s);
3345 /* string-change backslash escapes */
3346 if (PL_lex_inwhat != OP_TRANS && *s && strchr("lLuUEQF", *s)) {
3350 /* In a pattern, process \N, but skip any other backslash escapes.
3351 * This is because we don't want to translate an escape sequence
3352 * into a meta symbol and have the regex compiler use the meta
3353 * symbol meaning, e.g. \x{2E} would be confused with a dot. But
3354 * in spite of this, we do have to process \N here while the proper
3355 * charnames handler is in scope. See bugs #56444 and #62056.
3356 * There is a complication because \N in a pattern may also stand
3357 * for 'match a non-nl', and not mean a charname, in which case its
3358 * processing should be deferred to the regex compiler. To be a
3359 * charname it must be followed immediately by a '{', and not look
3360 * like \N followed by a curly quantifier, i.e., not something like
3361 * \N{3,}. regcurly returns a boolean indicating if it is a legal
3363 else if (PL_lex_inpat
3366 || regcurly(s + 1, FALSE)))
3369 goto default_action;
3374 /* quoted - in transliterations */
3376 if (PL_lex_inwhat == OP_TRANS) {
3383 if ((isALPHANUMERIC(*s)))
3384 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
3385 "Unrecognized escape \\%c passed through",
3387 /* default action is to copy the quoted character */
3388 goto default_action;
3391 /* eg. \132 indicates the octal constant 0132 */
3392 case '0': case '1': case '2': case '3':
3393 case '4': case '5': case '6': case '7':
3395 I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
3397 uv = grok_oct(s, &len, &flags, NULL);
3399 if (len < 3 && s < send && isDIGIT(*s)
3400 && ckWARN(WARN_MISC))
3402 Perl_warner(aTHX_ packWARN(WARN_MISC),
3403 "%s", form_short_octal_warning(s, len));
3406 goto NUM_ESCAPE_INSERT;
3408 /* eg. \o{24} indicates the octal constant \024 */
3413 bool valid = grok_bslash_o(&s, &uv, &error,
3414 TRUE, /* Output warning */
3415 FALSE, /* Not strict */
3416 TRUE, /* Output warnings for
3423 goto NUM_ESCAPE_INSERT;
3426 /* eg. \x24 indicates the hex constant 0x24 */
3431 bool valid = grok_bslash_x(&s, &uv, &error,
3432 TRUE, /* Output warning */
3433 FALSE, /* Not strict */
3434 TRUE, /* Output warnings for
3444 /* Insert oct or hex escaped character. There will always be
3445 * enough room in sv since such escapes will be longer than any
3446 * UTF-8 sequence they can end up as, except if they force us
3447 * to recode the rest of the string into utf8 */
3449 /* Here uv is the ordinal of the next character being added */
3450 if (!NATIVE_IS_INVARIANT(uv)) {
3451 if (!has_utf8 && uv > 255) {
3452 /* Might need to recode whatever we have accumulated so
3453 * far if it contains any chars variant in utf8 or
3456 SvCUR_set(sv, d - SvPVX_const(sv));
3459 /* See Note on sizing above. */
3460 sv_utf8_upgrade_flags_grow(sv,
3461 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3462 UNISKIP(uv) + (STRLEN)(send - s) + 1);
3463 d = SvPVX(sv) + SvCUR(sv);
3468 d = (char*)uvchr_to_utf8((U8*)d, uv);
3469 if (PL_lex_inwhat == OP_TRANS &&
3470 PL_sublex_info.sub_op) {
3471 PL_sublex_info.sub_op->op_private |=
3472 (PL_lex_repl ? OPpTRANS_FROM_UTF
3476 if (uv > 255 && !dorange)
3477 native_range = FALSE;
3490 /* In a non-pattern \N must be a named character, like \N{LATIN
3491 * SMALL LETTER A} or \N{U+0041}. For patterns, it also can
3492 * mean to match a non-newline. For non-patterns, named
3493 * characters are converted to their string equivalents. In
3494 * patterns, named characters are not converted to their
3495 * ultimate forms for the same reasons that other escapes
3496 * aren't. Instead, they are converted to the \N{U+...} form
3497 * to get the value from the charnames that is in effect right
3498 * now, while preserving the fact that it was a named character
3499 * so that the regex compiler knows this */
3501 /* The structure of this section of code (besides checking for
3502 * errors and upgrading to utf8) is:
3503 * Further disambiguate between the two meanings of \N, and if
3504 * not a charname, go process it elsewhere
3505 * If of form \N{U+...}, pass it through if a pattern;
3506 * otherwise convert to utf8
3507 * Otherwise must be \N{NAME}: convert to \N{U+c1.c2...} if a
3508 * pattern; otherwise convert to utf8 */
3510 /* Here, s points to the 'N'; the test below is guaranteed to
3511 * succeed if we are being called on a pattern as we already
3512 * know from a test above that the next character is a '{'.
3513 * On a non-pattern \N must mean 'named sequence, which
3514 * requires braces */
3517 yyerror("Missing braces on \\N{}");
3522 /* If there is no matching '}', it is an error. */
3523 if (! (e = strchr(s, '}'))) {
3524 if (! PL_lex_inpat) {
3525 yyerror("Missing right brace on \\N{}");
3527 yyerror("Missing right brace on \\N{} or unescaped left brace after \\N.");
3532 /* Here it looks like a named character */
3534 if (*s == 'U' && s[1] == '+') { /* \N{U+...} */
3535 I32 flags = PERL_SCAN_ALLOW_UNDERSCORES
3536 | PERL_SCAN_DISALLOW_PREFIX;
3539 /* For \N{U+...}, the '...' is a unicode value even on
3540 * EBCDIC machines */
3541 s += 2; /* Skip to next char after the 'U+' */
3543 uv = grok_hex(s, &len, &flags, NULL);
3544 if (len == 0 || len != (STRLEN)(e - s)) {
3545 yyerror("Invalid hexadecimal number in \\N{U+...}");
3552 /* On non-EBCDIC platforms, pass through to the regex
3553 * compiler unchanged. The reason we evaluated the
3554 * number above is to make sure there wasn't a syntax
3555 * error. But on EBCDIC we convert to native so
3556 * downstream code can continue to assume it's native
3558 s -= 5; /* Include the '\N{U+' */
3560 d += my_snprintf(d, e - s + 1 + 1, /* includes the }
3563 (unsigned int) UNI_TO_NATIVE(uv));
3565 Copy(s, d, e - s + 1, char); /* 1 = include the } */
3569 else { /* Not a pattern: convert the hex to string */
3571 /* If destination is not in utf8, unconditionally
3572 * recode it to be so. This is because \N{} implies
3573 * Unicode semantics, and scalars have to be in utf8
3574 * to guarantee those semantics */
3576 SvCUR_set(sv, d - SvPVX_const(sv));
3579 /* See Note on sizing above. */
3580 sv_utf8_upgrade_flags_grow(
3582 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3583 UNISKIP(uv) + (STRLEN)(send - e) + 1);
3584 d = SvPVX(sv) + SvCUR(sv);
3588 /* Add the (Unicode) code point to the output. */
3589 if (UNI_IS_INVARIANT(uv)) {
3590 *d++ = (char) LATIN1_TO_NATIVE(uv);
3593 d = (char*) uvoffuni_to_utf8_flags((U8*)d, uv, 0);
3597 else /* Here is \N{NAME} but not \N{U+...}. */
3598 if ((res = get_and_check_backslash_N_name(s, e)))
3601 const char *str = SvPV_const(res, len);
3604 if (! len) { /* The name resolved to an empty string */
3605 Copy("\\N{}", d, 4, char);
3609 /* In order to not lose information for the regex
3610 * compiler, pass the result in the specially made
3611 * syntax: \N{U+c1.c2.c3...}, where c1 etc. are
3612 * the code points in hex of each character
3613 * returned by charnames */
3615 const char *str_end = str + len;
3616 const STRLEN off = d - SvPVX_const(sv);
3618 if (! SvUTF8(res)) {
3619 /* For the non-UTF-8 case, we can determine the
3620 * exact length needed without having to parse
3621 * through the string. Each character takes up
3622 * 2 hex digits plus either a trailing dot or
3624 d = off + SvGROW(sv, off
3626 + 6 /* For the "\N{U+", and
3628 + (STRLEN)(send - e));
3629 Copy("\\N{U+", d, 5, char);
3631 while (str < str_end) {
3633 my_snprintf(hex_string, sizeof(hex_string),
3634 "%02X.", (U8) *str);
3635 Copy(hex_string, d, 3, char);
3639 d--; /* We will overwrite below the final
3640 dot with a right brace */
3643 STRLEN char_length; /* cur char's byte length */
3645 /* and the number of bytes after this is
3646 * translated into hex digits */
3647 STRLEN output_length;
3649 /* 2 hex per byte; 2 chars for '\N'; 2 chars
3650 * for max('U+', '.'); and 1 for NUL */
3651 char hex_string[2 * UTF8_MAXBYTES + 5];
3653 /* Get the first character of the result. */
3654 U32 uv = utf8n_to_uvchr((U8 *) str,
3658 /* Convert first code point to hex, including
3659 * the boiler plate before it. */
3661 my_snprintf(hex_string, sizeof(hex_string),
3665 /* Make sure there is enough space to hold it */
3666 d = off + SvGROW(sv, off
3668 + (STRLEN)(send - e)
3669 + 2); /* '}' + NUL */
3671 Copy(hex_string, d, output_length, char);
3674 /* For each subsequent character, append dot and
3675 * its ordinal in hex */
3676 while ((str += char_length) < str_end) {
3677 const STRLEN off = d - SvPVX_const(sv);
3678 U32 uv = utf8n_to_uvchr((U8 *) str,
3683 my_snprintf(hex_string,
3688 d = off + SvGROW(sv, off
3690 + (STRLEN)(send - e)
3691 + 2); /* '}' + NUL */
3692 Copy(hex_string, d, output_length, char);
3697 *d++ = '}'; /* Done. Add the trailing brace */
3700 else { /* Here, not in a pattern. Convert the name to a
3703 /* If destination is not in utf8, unconditionally
3704 * recode it to be so. This is because \N{} implies
3705 * Unicode semantics, and scalars have to be in utf8
3706 * to guarantee those semantics */
3708 SvCUR_set(sv, d - SvPVX_const(sv));
3711 /* See Note on sizing above. */
3712 sv_utf8_upgrade_flags_grow(sv,
3713 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3714 len + (STRLEN)(send - s) + 1);
3715 d = SvPVX(sv) + SvCUR(sv);
3717 } else if (len > (STRLEN)(e - s + 4)) { /* I _guess_ 4 is \N{} --jhi */
3719 /* See Note on sizing above. (NOTE: SvCUR() is not
3720 * set correctly here). */
3721 const STRLEN off = d - SvPVX_const(sv);
3722 d = off + SvGROW(sv, off + len + (STRLEN)(send - s) + 1);
3724 Copy(str, d, len, char);
3730 } /* End \N{NAME} */
3733 native_range = FALSE; /* \N{} is defined to be Unicode */
3735 s = e + 1; /* Point to just after the '}' */
3738 /* \c is a control character */
3742 *d++ = grok_bslash_c(*s++, has_utf8, 1);
3745 yyerror("Missing control char name in \\c");
3749 /* printf-style backslashes, formfeeds, newlines, etc */
3766 *d++ = ASCII_TO_NATIVE('\033');
3775 } /* end if (backslash) */
3782 /* If we started with encoded form, or already know we want it,
3783 then encode the next character */
3784 if (! NATIVE_IS_INVARIANT((U8)(*s)) && (this_utf8 || has_utf8)) {
3788 /* One might think that it is wasted effort in the case of the
3789 * source being utf8 (this_utf8 == TRUE) to take the next character
3790 * in the source, convert it to an unsigned value, and then convert
3791 * it back again. But the source has not been validated here. The
3792 * routine that does the conversion checks for errors like
3795 const UV nextuv = (this_utf8)
3796 ? utf8n_to_uvchr((U8*)s, send - s, &len, 0)
3798 const STRLEN need = UNISKIP(nextuv);
3800 SvCUR_set(sv, d - SvPVX_const(sv));
3803 /* See Note on sizing above. */
3804 sv_utf8_upgrade_flags_grow(sv,
3805 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3806 need + (STRLEN)(send - s) + 1);
3807 d = SvPVX(sv) + SvCUR(sv);
3809 } else if (need > len) {
3810 /* encoded value larger than old, may need extra space (NOTE:
3811 * SvCUR() is not set correctly here). See Note on sizing
3813 const STRLEN off = d - SvPVX_const(sv);
3814 d = SvGROW(sv, off + need + (STRLEN)(send - s) + 1) + off;
3818 d = (char*)uvchr_to_utf8((U8*)d, nextuv);
3820 if (uv > 255 && !dorange)
3821 native_range = FALSE;
3827 } /* while loop to process each character */
3829 /* terminate the string and set up the sv */
3831 SvCUR_set(sv, d - SvPVX_const(sv));
3832 if (SvCUR(sv) >= SvLEN(sv))
3833 Perl_croak(aTHX_ "panic: constant overflowed allocated space, %"UVuf
3834 " >= %"UVuf, (UV)SvCUR(sv), (UV)SvLEN(sv));
3837 if (PL_encoding && !has_utf8) {
3838 sv_recode_to_utf8(sv, PL_encoding);
3844 if (PL_lex_inwhat == OP_TRANS && PL_sublex_info.sub_op) {
3845 PL_sublex_info.sub_op->op_private |=
3846 (PL_lex_repl ? OPpTRANS_FROM_UTF : OPpTRANS_TO_UTF);
3850 /* shrink the sv if we allocated more than we used */
3851 if (SvCUR(sv) + 5 < SvLEN(sv)) {
3852 SvPV_shrink_to_cur(sv);
3855 /* return the substring (via pl_yylval) only if we parsed anything */
3856 if (s > PL_bufptr) {
3857 char *s2 = PL_bufptr;
3858 for (; s2 < s; s2++) {
3860 COPLINE_INC_WITH_HERELINES;
3862 SvREFCNT_inc_simple_void_NN(sv);
3863 if ( (PL_hints & ( PL_lex_inpat ? HINT_NEW_RE : HINT_NEW_STRING ))
3864 && ! PL_parser->lex_re_reparsing)
3866 const char *const key = PL_lex_inpat ? "qr" : "q";
3867 const STRLEN keylen = PL_lex_inpat ? 2 : 1;
3871 if (PL_lex_inwhat == OP_TRANS) {
3874 } else if (PL_lex_inwhat == OP_SUBST && !PL_lex_inpat) {
3877 } else if (PL_lex_inpat && SvIVX(PL_linestr) == '\'') {
3885 sv = S_new_constant(aTHX_ start, s - start, key, keylen, sv, NULL,
3888 pl_yylval.opval = (OP*)newSVOP(OP_CONST, 0, sv);
3890 LEAVE_with_name("scan_const");
3895 * Returns TRUE if there's more to the expression (e.g., a subscript),
3898 * It deals with "$foo[3]" and /$foo[3]/ and /$foo[0123456789$]+/
3900 * ->[ and ->{ return TRUE
3901 * { and [ outside a pattern are always subscripts, so return TRUE
3902 * if we're outside a pattern and it's not { or [, then return FALSE
3903 * if we're in a pattern and the first char is a {
3904 * {4,5} (any digits around the comma) returns FALSE
3905 * if we're in a pattern and the first char is a [
3907 * [SOMETHING] has a funky algorithm to decide whether it's a
3908 * character class or not. It has to deal with things like
3909 * /$foo[-3]/ and /$foo[$bar]/ as well as /$foo[$\d]+/
3910 * anything else returns TRUE
3913 /* This is the one truly awful dwimmer necessary to conflate C and sed. */
3916 S_intuit_more(pTHX_ char *s)
3920 PERL_ARGS_ASSERT_INTUIT_MORE;
3922 if (PL_lex_brackets)
3924 if (*s == '-' && s[1] == '>' && (s[2] == '[' || s[2] == '{'))
3926 if (*s != '{' && *s != '[')
3931 /* In a pattern, so maybe we have {n,m}. */
3933 if (regcurly(s, FALSE)) {
3939 /* On the other hand, maybe we have a character class */
3942 if (*s == ']' || *s == '^')
3945 /* this is terrifying, and it works */
3948 const char * const send = strchr(s,']');
3949 unsigned char un_char, last_un_char;
3950 char tmpbuf[sizeof PL_tokenbuf * 4];
3952 if (!send) /* has to be an expression */
3954 weight = 2; /* let's weigh the evidence */
3958 else if (isDIGIT(*s)) {
3960 if (isDIGIT(s[1]) && s[2] == ']')
3966 Zero(seen,256,char);
3968 for (; s < send; s++) {
3969 last_un_char = un_char;
3970 un_char = (unsigned char)*s;
3975 weight -= seen[un_char] * 10;
3976 if (isWORDCHAR_lazy_if(s+1,UTF)) {
3978 scan_ident(s, send, tmpbuf, sizeof tmpbuf, FALSE);
3979 len = (int)strlen(tmpbuf);
3980 if (len > 1 && gv_fetchpvn_flags(tmpbuf, len,
3981 UTF ? SVf_UTF8 : 0, SVt_PV))
3986 else if (*s == '$' && s[1] &&
3987 strchr("[#!%*<>()-=",s[1])) {
3988 if (/*{*/ strchr("])} =",s[2]))
3997 if (strchr("wds]",s[1]))
3999 else if (seen[(U8)'\''] || seen[(U8)'"'])
4001 else if (strchr("rnftbxcav",s[1]))
4003 else if (isDIGIT(s[1])) {
4005 while (s[1] && isDIGIT(s[1]))
4015 if (strchr("aA01! ",last_un_char))
4017 if (strchr("zZ79~",s[1]))
4019 if (last_un_char == 255 && (isDIGIT(s[1]) || s[1] == '$'))
4020 weight -= 5; /* cope with negative subscript */
4023 if (!isWORDCHAR(last_un_char)
4024 && !(last_un_char == '$' || last_un_char == '@'
4025 || last_un_char == '&')
4026 && isALPHA(*s) && s[1] && isALPHA(s[1])) {
4031 if (keyword(tmpbuf, d - tmpbuf, 0))
4034 if (un_char == last_un_char + 1)
4036 weight -= seen[un_char];
4041 if (weight >= 0) /* probably a character class */
4051 * Does all the checking to disambiguate
4053 * between foo(bar) and bar->foo. Returns 0 if not a method, otherwise
4054 * FUNCMETH (bar->foo(args)) or METHOD (bar->foo args).
4056 * First argument is the stuff after the first token, e.g. "bar".
4058 * Not a method if foo is a filehandle.
4059 * Not a method if foo is a subroutine prototyped to take a filehandle.
4060 * Not a method if it's really "Foo $bar"
4061 * Method if it's "foo $bar"
4062 * Not a method if it's really "print foo $bar"
4063 * Method if it's really "foo package::" (interpreted as package->foo)
4064 * Not a method if bar is known to be a subroutine ("sub bar; foo bar")
4065 * Not a method if bar is a filehandle or package, but is quoted with
4070 S_intuit_method(pTHX_ char *start, GV *gv, CV *cv)
4073 char *s = start + (*start == '$');
4074 char tmpbuf[sizeof PL_tokenbuf];
4081 PERL_ARGS_ASSERT_INTUIT_METHOD;
4083 if (gv && SvTYPE(gv) == SVt_PVGV && GvIO(gv))
4085 if (cv && SvPOK(cv)) {
4086 const char *proto = CvPROTO(cv);
4088 while (*proto && (isSPACE(*proto) || *proto == ';'))
4095 if (*start == '$') {
4096 if (cv || PL_last_lop_op == OP_PRINT || PL_last_lop_op == OP_SAY ||
4097 isUPPER(*PL_tokenbuf))
4100 len = start - SvPVX(PL_linestr);
4104 start = SvPVX(PL_linestr) + len;
4108 return *s == '(' ? FUNCMETH : METHOD;
4111 s = scan_word(s, tmpbuf, sizeof tmpbuf, TRUE, &len);
4112 /* start is the beginning of the possible filehandle/object,
4113 * and s is the end of it
4114 * tmpbuf is a copy of it (but with single quotes as double colons)
4117 if (!keyword(tmpbuf, len, 0)) {
4118 if (len > 2 && tmpbuf[len - 2] == ':' && tmpbuf[len - 1] == ':') {
4122 soff = s - SvPVX(PL_linestr);
4126 indirgv = gv_fetchpvn_flags(tmpbuf, len, ( UTF ? SVf_UTF8 : 0 ), SVt_PVCV);
4127 if (indirgv && GvCVu(indirgv))
4129 /* filehandle or package name makes it a method */
4130 if (!cv || GvIO(indirgv) || gv_stashpvn(tmpbuf, len, UTF ? SVf_UTF8 : 0)) {
4132 soff = s - SvPVX(PL_linestr);
4135 if ((PL_bufend - s) >= 2 && *s == '=' && *(s+1) == '>')
4136 return 0; /* no assumptions -- "=>" quotes bareword */
4138 start_force(PL_curforce);
4139 NEXTVAL_NEXTTOKE.opval = (OP*)newSVOP(OP_CONST, 0,
4140 S_newSV_maybe_utf8(aTHX_ tmpbuf, len));
4141 NEXTVAL_NEXTTOKE.opval->op_private = OPpCONST_BARE;
4143 curmad('X', newSVpvn_flags(start,SvPVX(PL_linestr) + soff - start,
4144 ( UTF ? SVf_UTF8 : 0 )));
4149 PL_bufptr = SvPVX(PL_linestr) + soff; /* restart before space */
4151 return *s == '(' ? FUNCMETH : METHOD;
4157 /* Encoded script support. filter_add() effectively inserts a
4158 * 'pre-processing' function into the current source input stream.
4159 * Note that the filter function only applies to the current source file
4160 * (e.g., it will not affect files 'require'd or 'use'd by this one).
4162 * The datasv parameter (which may be NULL) can be used to pass
4163 * private data to this instance of the filter. The filter function
4164 * can recover the SV using the FILTER_DATA macro and use it to
4165 * store private buffers and state information.
4167 * The supplied datasv parameter is upgraded to a PVIO type
4168 * and the IoDIRP/IoANY field is used to store the function pointer,
4169 * and IOf_FAKE_DIRP is enabled on datasv to mark this as such.
4170 * Note that IoTOP_NAME, IoFMT_NAME, IoBOTTOM_NAME, if set for
4171 * private use must be set using malloc'd pointers.
4175 Perl_filter_add(pTHX_ filter_t funcp, SV *datasv)
4184 if (PL_parser->lex_flags & LEX_IGNORE_UTF8_HINTS)
4185 Perl_croak(aTHX_ "Source filters apply only to byte streams");
4187 if (!PL_rsfp_filters)
4188 PL_rsfp_filters = newAV();
4191 SvUPGRADE(datasv, SVt_PVIO);
4192 IoANY(datasv) = FPTR2DPTR(void *, funcp); /* stash funcp into spare field */
4193 IoFLAGS(datasv) |= IOf_FAKE_DIRP;
4194 DEBUG_P(PerlIO_printf(Perl_debug_log, "filter_add func %p (%s)\n",
4195 FPTR2DPTR(void *, IoANY(datasv)),
4196 SvPV_nolen(datasv)));
4197 av_unshift(PL_rsfp_filters, 1);
4198 av_store(PL_rsfp_filters, 0, datasv) ;
4200 !PL_parser->filtered
4201 && PL_parser->lex_flags & LEX_EVALBYTES
4202 && PL_bufptr < PL_bufend
4204 const char *s = PL_bufptr;
4205 while (s < PL_bufend) {
4207 SV *linestr = PL_parser->linestr;
4208 char *buf = SvPVX(linestr);
4209 STRLEN const bufptr_pos = PL_parser->bufptr - buf;
4210 STRLEN const oldbufptr_pos = PL_parser->oldbufptr - buf;
4211 STRLEN const oldoldbufptr_pos=PL_parser->oldoldbufptr-buf;
4212 STRLEN const linestart_pos = PL_parser->linestart - buf;
4213 STRLEN const last_uni_pos =
4214 PL_parser->last_uni ? PL_parser->last_uni - buf : 0;
4215 STRLEN const last_lop_pos =
4216 PL_parser->last_lop ? PL_parser->last_lop - buf : 0;
4217 av_push(PL_rsfp_filters, linestr);
4218 PL_parser->linestr =
4219 newSVpvn(SvPVX(linestr), ++s-SvPVX(linestr));
4220 buf = SvPVX(PL_parser->linestr);
4221 PL_parser->bufend = buf + SvCUR(PL_parser->linestr);
4222 PL_parser->bufptr = buf + bufptr_pos;
4223 PL_parser->oldbufptr = buf + oldbufptr_pos;
4224 PL_parser->oldoldbufptr = buf + oldoldbufptr_pos;
4225 PL_parser->linestart = buf + linestart_pos;
4226 if (PL_parser->last_uni)
4227 PL_parser->last_uni = buf + last_uni_pos;
4228 if (PL_parser->last_lop)
4229 PL_parser->last_lop = buf + last_lop_pos;
4230 SvLEN(linestr) = SvCUR(linestr);
4231 SvCUR(linestr) = s-SvPVX(linestr);
4232 PL_parser->filtered = 1;
4242 /* Delete most recently added instance of this filter function. */
4244 Perl_filter_del(pTHX_ filter_t funcp)
4249 PERL_ARGS_ASSERT_FILTER_DEL;
4252 DEBUG_P(PerlIO_printf(Perl_debug_log, "filter_del func %p",
4253 FPTR2DPTR(void*, funcp)));
4255 if (!PL_parser || !PL_rsfp_filters || AvFILLp(PL_rsfp_filters)<0)
4257 /* if filter is on top of stack (usual case) just pop it off */
4258 datasv = FILTER_DATA(AvFILLp(PL_rsfp_filters));
4259 if (IoANY(datasv) == FPTR2DPTR(void *, funcp)) {
4260 sv_free(av_pop(PL_rsfp_filters));
4264 /* we need to search for the correct entry and clear it */
4265 Perl_die(aTHX_ "filter_del can only delete in reverse order (currently)");
4269 /* Invoke the idxth filter function for the current rsfp. */
4270 /* maxlen 0 = read one text line */
4272 Perl_filter_read(pTHX_ int idx, SV *buf_sv, int maxlen)
4277 /* This API is bad. It should have been using unsigned int for maxlen.
4278 Not sure if we want to change the API, but if not we should sanity
4279 check the value here. */
4280 unsigned int correct_length
4289 PERL_ARGS_ASSERT_FILTER_READ;
4291 if (!PL_parser || !PL_rsfp_filters)
4293 if (idx > AvFILLp(PL_rsfp_filters)) { /* Any more filters? */
4294 /* Provide a default input filter to make life easy. */
4295 /* Note that we append to the line. This is handy. */
4296 DEBUG_P(PerlIO_printf(Perl_debug_log,
4297 "filter_read %d: from rsfp\n", idx));
4298 if (correct_length) {
4301 const int old_len = SvCUR(buf_sv);
4303 /* ensure buf_sv is large enough */
4304 SvGROW(buf_sv, (STRLEN)(old_len + correct_length + 1)) ;
4305 if ((len = PerlIO_read(PL_rsfp, SvPVX(buf_sv) + old_len,
4306 correct_length)) <= 0) {
4307 if (PerlIO_error(PL_rsfp))
4308 return -1; /* error */
4310 return 0 ; /* end of file */
4312 SvCUR_set(buf_sv, old_len + len) ;
4313 SvPVX(buf_sv)[old_len + len] = '\0';
4316 if (sv_gets(buf_sv, PL_rsfp, SvCUR(buf_sv)) == NULL) {
4317 if (PerlIO_error(PL_rsfp))
4318 return -1; /* error */
4320 return 0 ; /* end of file */
4323 return SvCUR(buf_sv);
4325 /* Skip this filter slot if filter has been deleted */
4326 if ( (datasv = FILTER_DATA(idx)) == &PL_sv_undef) {
4327 DEBUG_P(PerlIO_printf(Perl_debug_log,
4328 "filter_read %d: skipped (filter deleted)\n",
4330 return FILTER_READ(idx+1, buf_sv, correct_length); /* recurse */
4332 if (SvTYPE(datasv) != SVt_PVIO) {
4333 if (correct_length) {
4335 const STRLEN remainder = SvLEN(datasv) - SvCUR(datasv);
4336 if (!remainder) return 0; /* eof */
4337 if (correct_length > remainder) correct_length = remainder;
4338 sv_catpvn(buf_sv, SvEND(datasv), correct_length);
4339 SvCUR_set(datasv, SvCUR(datasv) + correct_length);
4342 const char *s = SvEND(datasv);
4343 const char *send = SvPVX(datasv) + SvLEN(datasv);
4351 if (s == send) return 0; /* eof */
4352 sv_catpvn(buf_sv, SvEND(datasv), s-SvEND(datasv));
4353 SvCUR_set(datasv, s-SvPVX(datasv));
4355 return SvCUR(buf_sv);
4357 /* Get function pointer hidden within datasv */
4358 funcp = DPTR2FPTR(filter_t, IoANY(datasv));
4359 DEBUG_P(PerlIO_printf(Perl_debug_log,
4360 "filter_read %d: via function %p (%s)\n",
4361 idx, (void*)datasv, SvPV_nolen_const(datasv)));
4362 /* Call function. The function is expected to */
4363 /* call "FILTER_READ(idx+1, buf_sv)" first. */
4364 /* Return: <0:error, =0:eof, >0:not eof */
4365 return (*funcp)(aTHX_ idx, buf_sv, correct_length);
4369 S_filter_gets(pTHX_ SV *sv, STRLEN append)
4373 PERL_ARGS_ASSERT_FILTER_GETS;
4375 #ifdef PERL_CR_FILTER
4376 if (!PL_rsfp_filters) {
4377 filter_add(S_cr_textfilter,NULL);
4380 if (PL_rsfp_filters) {
4382 SvCUR_set(sv, 0); /* start with empty line */
4383 if (FILTER_READ(0, sv, 0) > 0)
4384 return ( SvPVX(sv) ) ;
4389 return (sv_gets(sv, PL_rsfp, append));
4393 S_find_in_my_stash(pTHX_ const char *pkgname, STRLEN len)
4398 PERL_ARGS_ASSERT_FIND_IN_MY_STASH;
4400 if (len == 11 && *pkgname == '_' && strEQ(pkgname, "__PACKAGE__"))
4404 (pkgname[len - 2] == ':' && pkgname[len - 1] == ':') &&
4405 (gv = gv_fetchpvn_flags(pkgname, len, ( UTF ? SVf_UTF8 : 0 ), SVt_PVHV)))
4407 return GvHV(gv); /* Foo:: */
4410 /* use constant CLASS => 'MyClass' */
4411 gv = gv_fetchpvn_flags(pkgname, len, UTF ? SVf_UTF8 : 0, SVt_PVCV);
4412 if (gv && GvCV(gv)) {
4413 SV * const sv = cv_const_sv(GvCV(gv));
4415 pkgname = SvPV_const(sv, len);
4418 return gv_stashpvn(pkgname, len, UTF ? SVf_UTF8 : 0);
4422 * S_readpipe_override
4423 * Check whether readpipe() is overridden, and generates the appropriate
4424 * optree, provided sublex_start() is called afterwards.
4427 S_readpipe_override(pTHX)
4430 GV *gv_readpipe = gv_fetchpvs("readpipe", GV_NOTQUAL, SVt_PVCV);
4431 pl_yylval.ival = OP_BACKTICK;
4433 && GvCVu(gv_readpipe) && GvIMPORTED_CV(gv_readpipe))
4435 ((gvp = (GV**)hv_fetchs(PL_globalstash, "readpipe", FALSE))
4436 && (gv_readpipe = *gvp) && isGV_with_GP(gv_readpipe)
4437 && GvCVu(gv_readpipe) && GvIMPORTED_CV(gv_readpipe)))
4439 COPLINE_SET_FROM_MULTI_END;
4440 PL_lex_op = (OP*)newUNOP(OP_ENTERSUB, OPf_STACKED,
4441 op_append_elem(OP_LIST,
4442 newSVOP(OP_CONST, 0, &PL_sv_undef), /* value will be read later */
4443 newCVREF(0, newGVOP(OP_GV, 0, gv_readpipe))));
4450 * The intent of this yylex wrapper is to minimize the changes to the
4451 * tokener when we aren't interested in collecting madprops. It remains
4452 * to be seen how successful this strategy will be...