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_pending_ident (PL_parser->pending_ident)
70 #define PL_preambled (PL_parser->preambled)
71 #define PL_sublex_info (PL_parser->sublex_info)
72 #define PL_linestr (PL_parser->linestr)
73 #define PL_expect (PL_parser->expect)
74 #define PL_copline (PL_parser->copline)
75 #define PL_bufptr (PL_parser->bufptr)
76 #define PL_oldbufptr (PL_parser->oldbufptr)
77 #define PL_oldoldbufptr (PL_parser->oldoldbufptr)
78 #define PL_linestart (PL_parser->linestart)
79 #define PL_bufend (PL_parser->bufend)
80 #define PL_last_uni (PL_parser->last_uni)
81 #define PL_last_lop (PL_parser->last_lop)
82 #define PL_last_lop_op (PL_parser->last_lop_op)
83 #define PL_lex_state (PL_parser->lex_state)
84 #define PL_rsfp (PL_parser->rsfp)
85 #define PL_rsfp_filters (PL_parser->rsfp_filters)
86 #define PL_in_my (PL_parser->in_my)
87 #define PL_in_my_stash (PL_parser->in_my_stash)
88 #define PL_tokenbuf (PL_parser->tokenbuf)
89 #define PL_multi_end (PL_parser->multi_end)
90 #define PL_error_count (PL_parser->error_count)
93 # define PL_endwhite (PL_parser->endwhite)
94 # define PL_faketokens (PL_parser->faketokens)
95 # define PL_lasttoke (PL_parser->lasttoke)
96 # define PL_nextwhite (PL_parser->nextwhite)
97 # define PL_realtokenstart (PL_parser->realtokenstart)
98 # define PL_skipwhite (PL_parser->skipwhite)
99 # define PL_thisclose (PL_parser->thisclose)
100 # define PL_thismad (PL_parser->thismad)
101 # define PL_thisopen (PL_parser->thisopen)
102 # define PL_thisstuff (PL_parser->thisstuff)
103 # define PL_thistoken (PL_parser->thistoken)
104 # define PL_thiswhite (PL_parser->thiswhite)
105 # define PL_thiswhite (PL_parser->thiswhite)
106 # define PL_nexttoke (PL_parser->nexttoke)
107 # define PL_curforce (PL_parser->curforce)
109 # define PL_nexttoke (PL_parser->nexttoke)
110 # define PL_nexttype (PL_parser->nexttype)
111 # define PL_nextval (PL_parser->nextval)
114 /* This can't be done with embed.fnc, because struct yy_parser contains a
115 member named pending_ident, which clashes with the generated #define */
117 S_pending_ident(pTHX);
119 static const char ident_too_long[] = "Identifier too long";
122 # define CURMAD(slot,sv) if (PL_madskills) { curmad(slot,sv); sv = 0; }
123 # define NEXTVAL_NEXTTOKE PL_nexttoke[PL_curforce].next_val
125 # define CURMAD(slot,sv)
126 # define NEXTVAL_NEXTTOKE PL_nextval[PL_nexttoke]
129 #define XENUMMASK 0x3f
130 #define XFAKEEOF 0x40
131 #define XFAKEBRACK 0x80
133 #ifdef USE_UTF8_SCRIPTS
134 # define UTF (!IN_BYTES)
136 # define UTF ((PL_linestr && DO_UTF8(PL_linestr)) || ( !(PL_parser->lex_flags & LEX_IGNORE_UTF8_HINTS) && (PL_hints & HINT_UTF8)))
139 /* The maximum number of characters preceding the unrecognized one to display */
140 #define UNRECOGNIZED_PRECEDE_COUNT 10
142 /* In variables named $^X, these are the legal values for X.
143 * 1999-02-27 mjd-perl-patch@plover.com */
144 #define isCONTROLVAR(x) (isUPPER(x) || strchr("[\\]^_?", (x)))
146 #define SPACE_OR_TAB(c) ((c)==' '||(c)=='\t')
148 /* LEX_* are values for PL_lex_state, the state of the lexer.
149 * They are arranged oddly so that the guard on the switch statement
150 * can get by with a single comparison (if the compiler is smart enough).
152 * These values refer to the various states within a sublex parse,
153 * i.e. within a double quotish string
156 /* #define LEX_NOTPARSING 11 is done in perl.h. */
158 #define LEX_NORMAL 10 /* normal code (ie not within "...") */
159 #define LEX_INTERPNORMAL 9 /* code within a string, eg "$foo[$x+1]" */
160 #define LEX_INTERPCASEMOD 8 /* expecting a \U, \Q or \E etc */
161 #define LEX_INTERPPUSH 7 /* starting a new sublex parse level */
162 #define LEX_INTERPSTART 6 /* expecting the start of a $var */
164 /* at end of code, eg "$x" followed by: */
165 #define LEX_INTERPEND 5 /* ... eg not one of [, { or -> */
166 #define LEX_INTERPENDMAYBE 4 /* ... eg one of [, { or -> */
168 #define LEX_INTERPCONCAT 3 /* expecting anything, eg at start of
169 string or after \E, $foo, etc */
170 #define LEX_INTERPCONST 2 /* NOT USED */
171 #define LEX_FORMLINE 1 /* expecting a format line */
172 #define LEX_KNOWNEXT 0 /* next token known; just return it */
176 static const char* const lex_state_names[] = {
195 #include "keywords.h"
197 /* CLINE is a macro that ensures PL_copline has a sane value */
202 #define CLINE (PL_copline = (CopLINE(PL_curcop) < PL_copline ? CopLINE(PL_curcop) : PL_copline))
205 # define SKIPSPACE0(s) skipspace0(s)
206 # define SKIPSPACE1(s) skipspace1(s)
207 # define SKIPSPACE2(s,tsv) skipspace2(s,&tsv)
208 # define PEEKSPACE(s) skipspace2(s,0)
210 # define SKIPSPACE0(s) skipspace(s)
211 # define SKIPSPACE1(s) skipspace(s)
212 # define SKIPSPACE2(s,tsv) skipspace(s)
213 # define PEEKSPACE(s) skipspace(s)
217 * Convenience functions to return different tokens and prime the
218 * lexer for the next token. They all take an argument.
220 * TOKEN : generic token (used for '(', DOLSHARP, etc)
221 * OPERATOR : generic operator
222 * AOPERATOR : assignment operator
223 * PREBLOCK : beginning the block after an if, while, foreach, ...
224 * PRETERMBLOCK : beginning a non-code-defining {} block (eg, hash ref)
225 * PREREF : *EXPR where EXPR is not a simple identifier
226 * TERM : expression term
227 * LOOPX : loop exiting command (goto, last, dump, etc)
228 * FTST : file test operator
229 * FUN0 : zero-argument function
230 * FUN0OP : zero-argument function, with its op created in this file
231 * FUN1 : not used, except for not, which isn't a UNIOP
232 * BOop : bitwise or or xor
234 * SHop : shift operator
235 * PWop : power operator
236 * PMop : pattern-matching operator
237 * Aop : addition-level operator
238 * Mop : multiplication-level operator
239 * Eop : equality-testing operator
240 * Rop : relational operator <= != gt
242 * Also see LOP and lop() below.
245 #ifdef DEBUGGING /* Serve -DT. */
246 # define REPORT(retval) tokereport((I32)retval, &pl_yylval)
248 # define REPORT(retval) (retval)
251 #define TOKEN(retval) return ( PL_bufptr = s, REPORT(retval))
252 #define OPERATOR(retval) return (PL_expect = XTERM, PL_bufptr = s, REPORT(retval))
253 #define AOPERATOR(retval) return ao((PL_expect = XTERM, PL_bufptr = s, REPORT(retval)))
254 #define PREBLOCK(retval) return (PL_expect = XBLOCK,PL_bufptr = s, REPORT(retval))
255 #define PRETERMBLOCK(retval) return (PL_expect = XTERMBLOCK,PL_bufptr = s, REPORT(retval))
256 #define PREREF(retval) return (PL_expect = XREF,PL_bufptr = s, REPORT(retval))
257 #define TERM(retval) return (CLINE, PL_expect = XOPERATOR, PL_bufptr = s, REPORT(retval))
258 #define LOOPX(f) return (pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)LOOPEX))
259 #define FTST(f) return (pl_yylval.ival=f, PL_expect=XTERMORDORDOR, PL_bufptr=s, REPORT((int)UNIOP))
260 #define FUN0(f) return (pl_yylval.ival=f, PL_expect=XOPERATOR, PL_bufptr=s, REPORT((int)FUNC0))
261 #define FUN0OP(f) return (pl_yylval.opval=f, CLINE, PL_expect=XOPERATOR, PL_bufptr=s, REPORT((int)FUNC0OP))
262 #define FUN1(f) return (pl_yylval.ival=f, PL_expect=XOPERATOR, PL_bufptr=s, REPORT((int)FUNC1))
263 #define BOop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)BITOROP)))
264 #define BAop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)BITANDOP)))
265 #define SHop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)SHIFTOP)))
266 #define PWop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)POWOP)))
267 #define PMop(f) return(pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)MATCHOP))
268 #define Aop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)ADDOP)))
269 #define Mop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)MULOP)))
270 #define Eop(f) return (pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)EQOP))
271 #define Rop(f) return (pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)RELOP))
273 /* This bit of chicanery makes a unary function followed by
274 * a parenthesis into a function with one argument, highest precedence.
275 * The UNIDOR macro is for unary functions that can be followed by the //
276 * operator (such as C<shift // 0>).
278 #define UNI3(f,x,have_x) { \
279 pl_yylval.ival = f; \
280 if (have_x) PL_expect = x; \
282 PL_last_uni = PL_oldbufptr; \
283 PL_last_lop_op = f; \
285 return REPORT( (int)FUNC1 ); \
287 return REPORT( *s=='(' ? (int)FUNC1 : (int)UNIOP ); \
289 #define UNI(f) UNI3(f,XTERM,1)
290 #define UNIDOR(f) UNI3(f,XTERMORDORDOR,1)
291 #define UNIPROTO(f,optional) { \
292 if (optional) PL_last_uni = PL_oldbufptr; \
296 #define UNIBRACK(f) UNI3(f,0,0)
298 /* grandfather return to old style */
301 if (!PL_lex_allbrackets && PL_lex_fakeeof > LEX_FAKEEOF_LOWLOGIC) \
302 PL_lex_fakeeof = LEX_FAKEEOF_LOWLOGIC; \
303 pl_yylval.ival = (f); \
309 #define COPLINE_INC_WITH_HERELINES \
311 CopLINE_inc(PL_curcop); \
312 if (PL_parser->lex_shared->herelines) \
313 CopLINE(PL_curcop) += PL_parser->lex_shared->herelines, \
314 PL_parser->lex_shared->herelines = 0; \
320 /* how to interpret the pl_yylval associated with the token */
324 TOKENTYPE_OPNUM, /* pl_yylval.ival contains an opcode number */
329 static struct debug_tokens {
331 enum token_type type;
333 } const debug_tokens[] =
335 { ADDOP, TOKENTYPE_OPNUM, "ADDOP" },
336 { ANDAND, TOKENTYPE_NONE, "ANDAND" },
337 { ANDOP, TOKENTYPE_NONE, "ANDOP" },
338 { ANONSUB, TOKENTYPE_IVAL, "ANONSUB" },
339 { ARROW, TOKENTYPE_NONE, "ARROW" },
340 { ASSIGNOP, TOKENTYPE_OPNUM, "ASSIGNOP" },
341 { BITANDOP, TOKENTYPE_OPNUM, "BITANDOP" },
342 { BITOROP, TOKENTYPE_OPNUM, "BITOROP" },
343 { COLONATTR, TOKENTYPE_NONE, "COLONATTR" },
344 { CONTINUE, TOKENTYPE_NONE, "CONTINUE" },
345 { DEFAULT, TOKENTYPE_NONE, "DEFAULT" },
346 { DO, TOKENTYPE_NONE, "DO" },
347 { DOLSHARP, TOKENTYPE_NONE, "DOLSHARP" },
348 { DORDOR, TOKENTYPE_NONE, "DORDOR" },
349 { DOROP, TOKENTYPE_OPNUM, "DOROP" },
350 { DOTDOT, TOKENTYPE_IVAL, "DOTDOT" },
351 { ELSE, TOKENTYPE_NONE, "ELSE" },
352 { ELSIF, TOKENTYPE_IVAL, "ELSIF" },
353 { EQOP, TOKENTYPE_OPNUM, "EQOP" },
354 { FOR, TOKENTYPE_IVAL, "FOR" },
355 { FORMAT, TOKENTYPE_NONE, "FORMAT" },
356 { FORMLBRACK, TOKENTYPE_NONE, "FORMLBRACK" },
357 { FORMRBRACK, TOKENTYPE_NONE, "FORMRBRACK" },
358 { FUNC, TOKENTYPE_OPNUM, "FUNC" },
359 { FUNC0, TOKENTYPE_OPNUM, "FUNC0" },
360 { FUNC0OP, TOKENTYPE_OPVAL, "FUNC0OP" },
361 { FUNC0SUB, TOKENTYPE_OPVAL, "FUNC0SUB" },
362 { FUNC1, TOKENTYPE_OPNUM, "FUNC1" },
363 { FUNCMETH, TOKENTYPE_OPVAL, "FUNCMETH" },
364 { GIVEN, TOKENTYPE_IVAL, "GIVEN" },
365 { HASHBRACK, TOKENTYPE_NONE, "HASHBRACK" },
366 { IF, TOKENTYPE_IVAL, "IF" },
367 { LABEL, TOKENTYPE_OPVAL, "LABEL" },
368 { LOCAL, TOKENTYPE_IVAL, "LOCAL" },
369 { LOOPEX, TOKENTYPE_OPNUM, "LOOPEX" },
370 { LSTOP, TOKENTYPE_OPNUM, "LSTOP" },
371 { LSTOPSUB, TOKENTYPE_OPVAL, "LSTOPSUB" },
372 { MATCHOP, TOKENTYPE_OPNUM, "MATCHOP" },
373 { METHOD, TOKENTYPE_OPVAL, "METHOD" },
374 { MULOP, TOKENTYPE_OPNUM, "MULOP" },
375 { MY, TOKENTYPE_IVAL, "MY" },
376 { MYSUB, TOKENTYPE_NONE, "MYSUB" },
377 { NOAMP, TOKENTYPE_NONE, "NOAMP" },
378 { NOTOP, TOKENTYPE_NONE, "NOTOP" },
379 { OROP, TOKENTYPE_IVAL, "OROP" },
380 { OROR, TOKENTYPE_NONE, "OROR" },
381 { PACKAGE, TOKENTYPE_NONE, "PACKAGE" },
382 { PEG, TOKENTYPE_NONE, "PEG" },
383 { PLUGEXPR, TOKENTYPE_OPVAL, "PLUGEXPR" },
384 { PLUGSTMT, TOKENTYPE_OPVAL, "PLUGSTMT" },
385 { PMFUNC, TOKENTYPE_OPVAL, "PMFUNC" },
386 { POSTDEC, TOKENTYPE_NONE, "POSTDEC" },
387 { POSTINC, TOKENTYPE_NONE, "POSTINC" },
388 { POWOP, TOKENTYPE_OPNUM, "POWOP" },
389 { PREDEC, TOKENTYPE_NONE, "PREDEC" },
390 { PREINC, TOKENTYPE_NONE, "PREINC" },
391 { PRIVATEREF, TOKENTYPE_OPVAL, "PRIVATEREF" },
392 { QWLIST, TOKENTYPE_OPVAL, "QWLIST" },
393 { REFGEN, TOKENTYPE_NONE, "REFGEN" },
394 { RELOP, TOKENTYPE_OPNUM, "RELOP" },
395 { REQUIRE, TOKENTYPE_NONE, "REQUIRE" },
396 { SHIFTOP, TOKENTYPE_OPNUM, "SHIFTOP" },
397 { SUB, TOKENTYPE_NONE, "SUB" },
398 { THING, TOKENTYPE_OPVAL, "THING" },
399 { UMINUS, TOKENTYPE_NONE, "UMINUS" },
400 { UNIOP, TOKENTYPE_OPNUM, "UNIOP" },
401 { UNIOPSUB, TOKENTYPE_OPVAL, "UNIOPSUB" },
402 { UNLESS, TOKENTYPE_IVAL, "UNLESS" },
403 { UNTIL, TOKENTYPE_IVAL, "UNTIL" },
404 { USE, TOKENTYPE_IVAL, "USE" },
405 { WHEN, TOKENTYPE_IVAL, "WHEN" },
406 { WHILE, TOKENTYPE_IVAL, "WHILE" },
407 { WORD, TOKENTYPE_OPVAL, "WORD" },
408 { YADAYADA, TOKENTYPE_IVAL, "YADAYADA" },
409 { 0, TOKENTYPE_NONE, NULL }
412 /* dump the returned token in rv, plus any optional arg in pl_yylval */
415 S_tokereport(pTHX_ I32 rv, const YYSTYPE* lvalp)
419 PERL_ARGS_ASSERT_TOKEREPORT;
422 const char *name = NULL;
423 enum token_type type = TOKENTYPE_NONE;
424 const struct debug_tokens *p;
425 SV* const report = newSVpvs("<== ");
427 for (p = debug_tokens; p->token; p++) {
428 if (p->token == (int)rv) {
435 Perl_sv_catpv(aTHX_ report, name);
436 else if ((char)rv > ' ' && (char)rv < '~')
437 Perl_sv_catpvf(aTHX_ report, "'%c'", (char)rv);
439 sv_catpvs(report, "EOF");
441 Perl_sv_catpvf(aTHX_ report, "?? %"IVdf, (IV)rv);
446 Perl_sv_catpvf(aTHX_ report, "(ival=%"IVdf")", (IV)lvalp->ival);
448 case TOKENTYPE_OPNUM:
449 Perl_sv_catpvf(aTHX_ report, "(ival=op_%s)",
450 PL_op_name[lvalp->ival]);
453 Perl_sv_catpvf(aTHX_ report, "(pval=\"%s\")", lvalp->pval);
455 case TOKENTYPE_OPVAL:
457 Perl_sv_catpvf(aTHX_ report, "(opval=op_%s)",
458 PL_op_name[lvalp->opval->op_type]);
459 if (lvalp->opval->op_type == OP_CONST) {
460 Perl_sv_catpvf(aTHX_ report, " %s",
461 SvPEEK(cSVOPx_sv(lvalp->opval)));
466 sv_catpvs(report, "(opval=null)");
469 PerlIO_printf(Perl_debug_log, "### %s\n\n", SvPV_nolen_const(report));
475 /* print the buffer with suitable escapes */
478 S_printbuf(pTHX_ const char *const fmt, const char *const s)
480 SV* const tmp = newSVpvs("");
482 PERL_ARGS_ASSERT_PRINTBUF;
484 PerlIO_printf(Perl_debug_log, fmt, pv_display(tmp, s, strlen(s), 0, 60));
491 S_deprecate_commaless_var_list(pTHX) {
493 deprecate("comma-less variable list");
494 return REPORT(','); /* grandfather non-comma-format format */
500 * This subroutine detects &&=, ||=, and //= and turns an ANDAND, OROR or DORDOR
501 * into an OP_ANDASSIGN, OP_ORASSIGN, or OP_DORASSIGN
505 S_ao(pTHX_ int toketype)
508 if (*PL_bufptr == '=') {
510 if (toketype == ANDAND)
511 pl_yylval.ival = OP_ANDASSIGN;
512 else if (toketype == OROR)
513 pl_yylval.ival = OP_ORASSIGN;
514 else if (toketype == DORDOR)
515 pl_yylval.ival = OP_DORASSIGN;
523 * When Perl expects an operator and finds something else, no_op
524 * prints the warning. It always prints "<something> found where
525 * operator expected. It prints "Missing semicolon on previous line?"
526 * if the surprise occurs at the start of the line. "do you need to
527 * predeclare ..." is printed out for code like "sub bar; foo bar $x"
528 * where the compiler doesn't know if foo is a method call or a function.
529 * It prints "Missing operator before end of line" if there's nothing
530 * after the missing operator, or "... before <...>" if there is something
531 * after the missing operator.
535 S_no_op(pTHX_ const char *const what, char *s)
538 char * const oldbp = PL_bufptr;
539 const bool is_first = (PL_oldbufptr == PL_linestart);
541 PERL_ARGS_ASSERT_NO_OP;
547 yywarn(Perl_form(aTHX_ "%s found where operator expected", what), UTF ? SVf_UTF8 : 0);
548 if (ckWARN_d(WARN_SYNTAX)) {
550 Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
551 "\t(Missing semicolon on previous line?)\n");
552 else if (PL_oldoldbufptr && isIDFIRST_lazy_if(PL_oldoldbufptr,UTF)) {
554 for (t = PL_oldoldbufptr; (isALNUM_lazy_if(t,UTF) || *t == ':');
555 t += UTF ? UTF8SKIP(t) : 1)
557 if (t < PL_bufptr && isSPACE(*t))
558 Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
559 "\t(Do you need to predeclare %"SVf"?)\n",
560 SVfARG(newSVpvn_flags(PL_oldoldbufptr, (STRLEN)(t - PL_oldoldbufptr),
561 SVs_TEMP | (UTF ? SVf_UTF8 : 0))));
565 Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
566 "\t(Missing operator before %"SVf"?)\n",
567 SVfARG(newSVpvn_flags(oldbp, (STRLEN)(s - oldbp),
568 SVs_TEMP | (UTF ? SVf_UTF8 : 0))));
576 * Complain about missing quote/regexp/heredoc terminator.
577 * If it's called with NULL then it cauterizes the line buffer.
578 * If we're in a delimited string and the delimiter is a control
579 * character, it's reformatted into a two-char sequence like ^C.
584 S_missingterm(pTHX_ char *s)
590 char * const nl = strrchr(s,'\n');
594 else if (isCNTRL(PL_multi_close)) {
596 tmpbuf[1] = (char)toCTRL(PL_multi_close);
601 *tmpbuf = (char)PL_multi_close;
605 q = strchr(s,'"') ? '\'' : '"';
606 Perl_croak(aTHX_ "Can't find string terminator %c%s%c anywhere before EOF",q,s,q);
612 * Check whether the named feature is enabled.
615 Perl_feature_is_enabled(pTHX_ const char *const name, STRLEN namelen)
618 char he_name[8 + MAX_FEATURE_LEN] = "feature_";
620 PERL_ARGS_ASSERT_FEATURE_IS_ENABLED;
622 assert(CURRENT_FEATURE_BUNDLE == FEATURE_BUNDLE_CUSTOM);
624 if (namelen > MAX_FEATURE_LEN)
626 memcpy(&he_name[8], name, namelen);
628 return cBOOL(cop_hints_fetch_pvn(PL_curcop, he_name, 8 + namelen, 0,
629 REFCOUNTED_HE_EXISTS));
633 * experimental text filters for win32 carriage-returns, utf16-to-utf8 and
634 * utf16-to-utf8-reversed.
637 #ifdef PERL_CR_FILTER
641 const char *s = SvPVX_const(sv);
642 const char * const e = s + SvCUR(sv);
644 PERL_ARGS_ASSERT_STRIP_RETURN;
646 /* outer loop optimized to do nothing if there are no CR-LFs */
648 if (*s++ == '\r' && *s == '\n') {
649 /* hit a CR-LF, need to copy the rest */
653 if (*s == '\r' && s[1] == '\n')
664 S_cr_textfilter(pTHX_ int idx, SV *sv, int maxlen)
666 const I32 count = FILTER_READ(idx+1, sv, maxlen);
667 if (count > 0 && !maxlen)
674 =for apidoc Amx|void|lex_start|SV *line|PerlIO *rsfp|U32 flags
676 Creates and initialises a new lexer/parser state object, supplying
677 a context in which to lex and parse from a new source of Perl code.
678 A pointer to the new state object is placed in L</PL_parser>. An entry
679 is made on the save stack so that upon unwinding the new state object
680 will be destroyed and the former value of L</PL_parser> will be restored.
681 Nothing else need be done to clean up the parsing context.
683 The code to be parsed comes from I<line> and I<rsfp>. I<line>, if
684 non-null, provides a string (in SV form) containing code to be parsed.
685 A copy of the string is made, so subsequent modification of I<line>
686 does not affect parsing. I<rsfp>, if non-null, provides an input stream
687 from which code will be read to be parsed. If both are non-null, the
688 code in I<line> comes first and must consist of complete lines of input,
689 and I<rsfp> supplies the remainder of the source.
691 The I<flags> parameter is reserved for future use. Currently it is only
692 used by perl internally, so extensions should always pass zero.
697 /* LEX_START_SAME_FILTER indicates that this is not a new file, so it
698 can share filters with the current parser.
699 LEX_START_DONT_CLOSE indicates that the file handle wasn't opened by the
700 caller, hence isn't owned by the parser, so shouldn't be closed on parser
701 destruction. This is used to handle the case of defaulting to reading the
702 script from the standard input because no filename was given on the command
703 line (without getting confused by situation where STDIN has been closed, so
704 the script handle is opened on fd 0) */
707 Perl_lex_start(pTHX_ SV *line, PerlIO *rsfp, U32 flags)
710 const char *s = NULL;
711 yy_parser *parser, *oparser;
712 if (flags && flags & ~LEX_START_FLAGS)
713 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_start");
715 /* create and initialise a parser */
717 Newxz(parser, 1, yy_parser);
718 parser->old_parser = oparser = PL_parser;
721 parser->stack = NULL;
723 parser->stack_size = 0;
725 /* on scope exit, free this parser and restore any outer one */
727 parser->saved_curcop = PL_curcop;
729 /* initialise lexer state */
732 parser->curforce = -1;
734 parser->nexttoke = 0;
736 parser->error_count = oparser ? oparser->error_count : 0;
737 parser->copline = NOLINE;
738 parser->lex_state = LEX_NORMAL;
739 parser->expect = XSTATE;
741 parser->rsfp_filters =
742 !(flags & LEX_START_SAME_FILTER) || !oparser
744 : MUTABLE_AV(SvREFCNT_inc(
745 oparser->rsfp_filters
746 ? oparser->rsfp_filters
747 : (oparser->rsfp_filters = newAV())
750 Newx(parser->lex_brackstack, 120, char);
751 Newx(parser->lex_casestack, 12, char);
752 *parser->lex_casestack = '\0';
753 Newxz(parser->lex_shared, 1, LEXSHARED);
757 s = SvPV_const(line, len);
758 parser->linestr = flags & LEX_START_COPIED
759 ? SvREFCNT_inc_simple_NN(line)
760 : newSVpvn_flags(s, len, SvUTF8(line));
761 sv_catpvs(parser->linestr, "\n;");
763 parser->linestr = newSVpvs("\n;");
765 parser->oldoldbufptr =
768 parser->linestart = SvPVX(parser->linestr);
769 parser->bufend = parser->bufptr + SvCUR(parser->linestr);
770 parser->last_lop = parser->last_uni = NULL;
771 parser->lex_flags = flags & (LEX_IGNORE_UTF8_HINTS|LEX_EVALBYTES
772 |LEX_DONT_CLOSE_RSFP);
774 parser->in_pod = parser->filtered = 0;
778 /* delete a parser object */
781 Perl_parser_free(pTHX_ const yy_parser *parser)
783 PERL_ARGS_ASSERT_PARSER_FREE;
785 PL_curcop = parser->saved_curcop;
786 SvREFCNT_dec(parser->linestr);
788 if (PL_parser->lex_flags & LEX_DONT_CLOSE_RSFP)
789 PerlIO_clearerr(parser->rsfp);
790 else if (parser->rsfp && (!parser->old_parser ||
791 (parser->old_parser && parser->rsfp != parser->old_parser->rsfp)))
792 PerlIO_close(parser->rsfp);
793 SvREFCNT_dec(parser->rsfp_filters);
795 Safefree(parser->lex_brackstack);
796 Safefree(parser->lex_casestack);
797 Safefree(parser->lex_shared);
798 PL_parser = parser->old_parser;
804 =for apidoc AmxU|SV *|PL_parser-E<gt>linestr
806 Buffer scalar containing the chunk currently under consideration of the
807 text currently being lexed. This is always a plain string scalar (for
808 which C<SvPOK> is true). It is not intended to be used as a scalar by
809 normal scalar means; instead refer to the buffer directly by the pointer
810 variables described below.
812 The lexer maintains various C<char*> pointers to things in the
813 C<PL_parser-E<gt>linestr> buffer. If C<PL_parser-E<gt>linestr> is ever
814 reallocated, all of these pointers must be updated. Don't attempt to
815 do this manually, but rather use L</lex_grow_linestr> if you need to
816 reallocate the buffer.
818 The content of the text chunk in the buffer is commonly exactly one
819 complete line of input, up to and including a newline terminator,
820 but there are situations where it is otherwise. The octets of the
821 buffer may be intended to be interpreted as either UTF-8 or Latin-1.
822 The function L</lex_bufutf8> tells you which. Do not use the C<SvUTF8>
823 flag on this scalar, which may disagree with it.
825 For direct examination of the buffer, the variable
826 L</PL_parser-E<gt>bufend> points to the end of the buffer. The current
827 lexing position is pointed to by L</PL_parser-E<gt>bufptr>. Direct use
828 of these pointers is usually preferable to examination of the scalar
829 through normal scalar means.
831 =for apidoc AmxU|char *|PL_parser-E<gt>bufend
833 Direct pointer to the end of the chunk of text currently being lexed, the
834 end of the lexer buffer. This is equal to C<SvPVX(PL_parser-E<gt>linestr)
835 + SvCUR(PL_parser-E<gt>linestr)>. A NUL character (zero octet) is
836 always located at the end of the buffer, and does not count as part of
837 the buffer's contents.
839 =for apidoc AmxU|char *|PL_parser-E<gt>bufptr
841 Points to the current position of lexing inside the lexer buffer.
842 Characters around this point may be freely examined, within
843 the range delimited by C<SvPVX(L</PL_parser-E<gt>linestr>)> and
844 L</PL_parser-E<gt>bufend>. The octets of the buffer may be intended to be
845 interpreted as either UTF-8 or Latin-1, as indicated by L</lex_bufutf8>.
847 Lexing code (whether in the Perl core or not) moves this pointer past
848 the characters that it consumes. It is also expected to perform some
849 bookkeeping whenever a newline character is consumed. This movement
850 can be more conveniently performed by the function L</lex_read_to>,
851 which handles newlines appropriately.
853 Interpretation of the buffer's octets can be abstracted out by
854 using the slightly higher-level functions L</lex_peek_unichar> and
855 L</lex_read_unichar>.
857 =for apidoc AmxU|char *|PL_parser-E<gt>linestart
859 Points to the start of the current line inside the lexer buffer.
860 This is useful for indicating at which column an error occurred, and
861 not much else. This must be updated by any lexing code that consumes
862 a newline; the function L</lex_read_to> handles this detail.
868 =for apidoc Amx|bool|lex_bufutf8
870 Indicates whether the octets in the lexer buffer
871 (L</PL_parser-E<gt>linestr>) should be interpreted as the UTF-8 encoding
872 of Unicode characters. If not, they should be interpreted as Latin-1
873 characters. This is analogous to the C<SvUTF8> flag for scalars.
875 In UTF-8 mode, it is not guaranteed that the lexer buffer actually
876 contains valid UTF-8. Lexing code must be robust in the face of invalid
879 The actual C<SvUTF8> flag of the L</PL_parser-E<gt>linestr> scalar
880 is significant, but not the whole story regarding the input character
881 encoding. Normally, when a file is being read, the scalar contains octets
882 and its C<SvUTF8> flag is off, but the octets should be interpreted as
883 UTF-8 if the C<use utf8> pragma is in effect. During a string eval,
884 however, the scalar may have the C<SvUTF8> flag on, and in this case its
885 octets should be interpreted as UTF-8 unless the C<use bytes> pragma
886 is in effect. This logic may change in the future; use this function
887 instead of implementing the logic yourself.
893 Perl_lex_bufutf8(pTHX)
899 =for apidoc Amx|char *|lex_grow_linestr|STRLEN len
901 Reallocates the lexer buffer (L</PL_parser-E<gt>linestr>) to accommodate
902 at least I<len> octets (including terminating NUL). Returns a
903 pointer to the reallocated buffer. This is necessary before making
904 any direct modification of the buffer that would increase its length.
905 L</lex_stuff_pvn> provides a more convenient way to insert text into
908 Do not use C<SvGROW> or C<sv_grow> directly on C<PL_parser-E<gt>linestr>;
909 this function updates all of the lexer's variables that point directly
916 Perl_lex_grow_linestr(pTHX_ STRLEN len)
920 STRLEN bufend_pos, bufptr_pos, oldbufptr_pos, oldoldbufptr_pos;
921 STRLEN linestart_pos, last_uni_pos, last_lop_pos, re_eval_start_pos;
922 linestr = PL_parser->linestr;
923 buf = SvPVX(linestr);
924 if (len <= SvLEN(linestr))
926 bufend_pos = PL_parser->bufend - buf;
927 bufptr_pos = PL_parser->bufptr - buf;
928 oldbufptr_pos = PL_parser->oldbufptr - buf;
929 oldoldbufptr_pos = PL_parser->oldoldbufptr - buf;
930 linestart_pos = PL_parser->linestart - buf;
931 last_uni_pos = PL_parser->last_uni ? PL_parser->last_uni - buf : 0;
932 last_lop_pos = PL_parser->last_lop ? PL_parser->last_lop - buf : 0;
933 re_eval_start_pos = PL_sublex_info.re_eval_start ?
934 PL_sublex_info.re_eval_start - buf : 0;
936 buf = sv_grow(linestr, len);
938 PL_parser->bufend = buf + bufend_pos;
939 PL_parser->bufptr = buf + bufptr_pos;
940 PL_parser->oldbufptr = buf + oldbufptr_pos;
941 PL_parser->oldoldbufptr = buf + oldoldbufptr_pos;
942 PL_parser->linestart = buf + linestart_pos;
943 if (PL_parser->last_uni)
944 PL_parser->last_uni = buf + last_uni_pos;
945 if (PL_parser->last_lop)
946 PL_parser->last_lop = buf + last_lop_pos;
947 if (PL_sublex_info.re_eval_start)
948 PL_sublex_info.re_eval_start = buf + re_eval_start_pos;
953 =for apidoc Amx|void|lex_stuff_pvn|const char *pv|STRLEN len|U32 flags
955 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
956 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
957 reallocating the buffer if necessary. This means that lexing code that
958 runs later will see the characters as if they had appeared in the input.
959 It is not recommended to do this as part of normal parsing, and most
960 uses of this facility run the risk of the inserted characters being
961 interpreted in an unintended manner.
963 The string to be inserted is represented by I<len> octets starting
964 at I<pv>. These octets are interpreted as either UTF-8 or Latin-1,
965 according to whether the C<LEX_STUFF_UTF8> flag is set in I<flags>.
966 The characters are recoded for the lexer buffer, according to how the
967 buffer is currently being interpreted (L</lex_bufutf8>). If a string
968 to be inserted is available as a Perl scalar, the L</lex_stuff_sv>
969 function is more convenient.
975 Perl_lex_stuff_pvn(pTHX_ const char *pv, STRLEN len, U32 flags)
979 PERL_ARGS_ASSERT_LEX_STUFF_PVN;
980 if (flags & ~(LEX_STUFF_UTF8))
981 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_stuff_pvn");
983 if (flags & LEX_STUFF_UTF8) {
987 const char *p, *e = pv+len;
988 for (p = pv; p != e; p++)
989 highhalf += !!(((U8)*p) & 0x80);
992 lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len+highhalf);
993 bufptr = PL_parser->bufptr;
994 Move(bufptr, bufptr+len+highhalf, PL_parser->bufend+1-bufptr, char);
995 SvCUR_set(PL_parser->linestr,
996 SvCUR(PL_parser->linestr) + len+highhalf);
997 PL_parser->bufend += len+highhalf;
998 for (p = pv; p != e; p++) {
1001 *bufptr++ = (char)(0xc0 | (c >> 6));
1002 *bufptr++ = (char)(0x80 | (c & 0x3f));
1004 *bufptr++ = (char)c;
1009 if (flags & LEX_STUFF_UTF8) {
1010 STRLEN highhalf = 0;
1011 const char *p, *e = pv+len;
1012 for (p = pv; p != e; p++) {
1015 Perl_croak(aTHX_ "Lexing code attempted to stuff "
1016 "non-Latin-1 character into Latin-1 input");
1017 } else if (c >= 0xc2 && p+1 != e &&
1018 (((U8)p[1]) & 0xc0) == 0x80) {
1021 } else if (c >= 0x80) {
1022 /* malformed UTF-8 */
1024 SAVESPTR(PL_warnhook);
1025 PL_warnhook = PERL_WARNHOOK_FATAL;
1026 utf8n_to_uvuni((U8*)p, e-p, NULL, 0);
1032 lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len-highhalf);
1033 bufptr = PL_parser->bufptr;
1034 Move(bufptr, bufptr+len-highhalf, PL_parser->bufend+1-bufptr, char);
1035 SvCUR_set(PL_parser->linestr,
1036 SvCUR(PL_parser->linestr) + len-highhalf);
1037 PL_parser->bufend += len-highhalf;
1038 for (p = pv; p != e; p++) {
1041 *bufptr++ = (char)(((c & 0x3) << 6) | (p[1] & 0x3f));
1044 *bufptr++ = (char)c;
1049 lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len);
1050 bufptr = PL_parser->bufptr;
1051 Move(bufptr, bufptr+len, PL_parser->bufend+1-bufptr, char);
1052 SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) + len);
1053 PL_parser->bufend += len;
1054 Copy(pv, bufptr, len, char);
1060 =for apidoc Amx|void|lex_stuff_pv|const char *pv|U32 flags
1062 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
1063 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
1064 reallocating the buffer if necessary. This means that lexing code that
1065 runs later will see the characters as if they had appeared in the input.
1066 It is not recommended to do this as part of normal parsing, and most
1067 uses of this facility run the risk of the inserted characters being
1068 interpreted in an unintended manner.
1070 The string to be inserted is represented by octets starting at I<pv>
1071 and continuing to the first nul. These octets are interpreted as either
1072 UTF-8 or Latin-1, according to whether the C<LEX_STUFF_UTF8> flag is set
1073 in I<flags>. The characters are recoded for the lexer buffer, according
1074 to how the buffer is currently being interpreted (L</lex_bufutf8>).
1075 If it is not convenient to nul-terminate a string to be inserted, the
1076 L</lex_stuff_pvn> function is more appropriate.
1082 Perl_lex_stuff_pv(pTHX_ const char *pv, U32 flags)
1084 PERL_ARGS_ASSERT_LEX_STUFF_PV;
1085 lex_stuff_pvn(pv, strlen(pv), flags);
1089 =for apidoc Amx|void|lex_stuff_sv|SV *sv|U32 flags
1091 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
1092 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
1093 reallocating the buffer if necessary. This means that lexing code that
1094 runs later will see the characters as if they had appeared in the input.
1095 It is not recommended to do this as part of normal parsing, and most
1096 uses of this facility run the risk of the inserted characters being
1097 interpreted in an unintended manner.
1099 The string to be inserted is the string value of I<sv>. The characters
1100 are recoded for the lexer buffer, according to how the buffer is currently
1101 being interpreted (L</lex_bufutf8>). If a string to be inserted is
1102 not already a Perl scalar, the L</lex_stuff_pvn> function avoids the
1103 need to construct a scalar.
1109 Perl_lex_stuff_sv(pTHX_ SV *sv, U32 flags)
1113 PERL_ARGS_ASSERT_LEX_STUFF_SV;
1115 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_stuff_sv");
1117 lex_stuff_pvn(pv, len, flags | (SvUTF8(sv) ? LEX_STUFF_UTF8 : 0));
1121 =for apidoc Amx|void|lex_unstuff|char *ptr
1123 Discards text about to be lexed, from L</PL_parser-E<gt>bufptr> up to
1124 I<ptr>. Text following I<ptr> will be moved, and the buffer shortened.
1125 This hides the discarded text from any lexing code that runs later,
1126 as if the text had never appeared.
1128 This is not the normal way to consume lexed text. For that, use
1135 Perl_lex_unstuff(pTHX_ char *ptr)
1139 PERL_ARGS_ASSERT_LEX_UNSTUFF;
1140 buf = PL_parser->bufptr;
1142 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_unstuff");
1145 bufend = PL_parser->bufend;
1147 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_unstuff");
1148 unstuff_len = ptr - buf;
1149 Move(ptr, buf, bufend+1-ptr, char);
1150 SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) - unstuff_len);
1151 PL_parser->bufend = bufend - unstuff_len;
1155 =for apidoc Amx|void|lex_read_to|char *ptr
1157 Consume text in the lexer buffer, from L</PL_parser-E<gt>bufptr> up
1158 to I<ptr>. This advances L</PL_parser-E<gt>bufptr> to match I<ptr>,
1159 performing the correct bookkeeping whenever a newline character is passed.
1160 This is the normal way to consume lexed text.
1162 Interpretation of the buffer's octets can be abstracted out by
1163 using the slightly higher-level functions L</lex_peek_unichar> and
1164 L</lex_read_unichar>.
1170 Perl_lex_read_to(pTHX_ char *ptr)
1173 PERL_ARGS_ASSERT_LEX_READ_TO;
1174 s = PL_parser->bufptr;
1175 if (ptr < s || ptr > PL_parser->bufend)
1176 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_to");
1177 for (; s != ptr; s++)
1179 COPLINE_INC_WITH_HERELINES;
1180 PL_parser->linestart = s+1;
1182 PL_parser->bufptr = ptr;
1186 =for apidoc Amx|void|lex_discard_to|char *ptr
1188 Discards the first part of the L</PL_parser-E<gt>linestr> buffer,
1189 up to I<ptr>. The remaining content of the buffer will be moved, and
1190 all pointers into the buffer updated appropriately. I<ptr> must not
1191 be later in the buffer than the position of L</PL_parser-E<gt>bufptr>:
1192 it is not permitted to discard text that has yet to be lexed.
1194 Normally it is not necessarily to do this directly, because it suffices to
1195 use the implicit discarding behaviour of L</lex_next_chunk> and things
1196 based on it. However, if a token stretches across multiple lines,
1197 and the lexing code has kept multiple lines of text in the buffer for
1198 that purpose, then after completion of the token it would be wise to
1199 explicitly discard the now-unneeded earlier lines, to avoid future
1200 multi-line tokens growing the buffer without bound.
1206 Perl_lex_discard_to(pTHX_ char *ptr)
1210 PERL_ARGS_ASSERT_LEX_DISCARD_TO;
1211 buf = SvPVX(PL_parser->linestr);
1213 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_discard_to");
1216 if (ptr > PL_parser->bufptr)
1217 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_discard_to");
1218 discard_len = ptr - buf;
1219 if (PL_parser->oldbufptr < ptr)
1220 PL_parser->oldbufptr = ptr;
1221 if (PL_parser->oldoldbufptr < ptr)
1222 PL_parser->oldoldbufptr = ptr;
1223 if (PL_parser->last_uni && PL_parser->last_uni < ptr)
1224 PL_parser->last_uni = NULL;
1225 if (PL_parser->last_lop && PL_parser->last_lop < ptr)
1226 PL_parser->last_lop = NULL;
1227 Move(ptr, buf, PL_parser->bufend+1-ptr, char);
1228 SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) - discard_len);
1229 PL_parser->bufend -= discard_len;
1230 PL_parser->bufptr -= discard_len;
1231 PL_parser->oldbufptr -= discard_len;
1232 PL_parser->oldoldbufptr -= discard_len;
1233 if (PL_parser->last_uni)
1234 PL_parser->last_uni -= discard_len;
1235 if (PL_parser->last_lop)
1236 PL_parser->last_lop -= discard_len;
1240 =for apidoc Amx|bool|lex_next_chunk|U32 flags
1242 Reads in the next chunk of text to be lexed, appending it to
1243 L</PL_parser-E<gt>linestr>. This should be called when lexing code has
1244 looked to the end of the current chunk and wants to know more. It is
1245 usual, but not necessary, for lexing to have consumed the entirety of
1246 the current chunk at this time.
1248 If L</PL_parser-E<gt>bufptr> is pointing to the very end of the current
1249 chunk (i.e., the current chunk has been entirely consumed), normally the
1250 current chunk will be discarded at the same time that the new chunk is
1251 read in. If I<flags> includes C<LEX_KEEP_PREVIOUS>, the current chunk
1252 will not be discarded. If the current chunk has not been entirely
1253 consumed, then it will not be discarded regardless of the flag.
1255 Returns true if some new text was added to the buffer, or false if the
1256 buffer has reached the end of the input text.
1261 #define LEX_FAKE_EOF 0x80000000
1262 #define LEX_NO_TERM 0x40000000
1265 Perl_lex_next_chunk(pTHX_ U32 flags)
1269 STRLEN old_bufend_pos, new_bufend_pos;
1270 STRLEN bufptr_pos, oldbufptr_pos, oldoldbufptr_pos;
1271 STRLEN linestart_pos, last_uni_pos, last_lop_pos;
1272 bool got_some_for_debugger = 0;
1274 if (flags & ~(LEX_KEEP_PREVIOUS|LEX_FAKE_EOF|LEX_NO_TERM))
1275 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_next_chunk");
1276 linestr = PL_parser->linestr;
1277 buf = SvPVX(linestr);
1278 if (!(flags & LEX_KEEP_PREVIOUS) &&
1279 PL_parser->bufptr == PL_parser->bufend) {
1280 old_bufend_pos = bufptr_pos = oldbufptr_pos = oldoldbufptr_pos = 0;
1282 if (PL_parser->last_uni != PL_parser->bufend)
1283 PL_parser->last_uni = NULL;
1284 if (PL_parser->last_lop != PL_parser->bufend)
1285 PL_parser->last_lop = NULL;
1286 last_uni_pos = last_lop_pos = 0;
1290 old_bufend_pos = PL_parser->bufend - buf;
1291 bufptr_pos = PL_parser->bufptr - buf;
1292 oldbufptr_pos = PL_parser->oldbufptr - buf;
1293 oldoldbufptr_pos = PL_parser->oldoldbufptr - buf;
1294 linestart_pos = PL_parser->linestart - buf;
1295 last_uni_pos = PL_parser->last_uni ? PL_parser->last_uni - buf : 0;
1296 last_lop_pos = PL_parser->last_lop ? PL_parser->last_lop - buf : 0;
1298 if (flags & LEX_FAKE_EOF) {
1300 } else if (!PL_parser->rsfp && !PL_parser->filtered) {
1302 } else if (filter_gets(linestr, old_bufend_pos)) {
1304 got_some_for_debugger = 1;
1305 } else if (flags & LEX_NO_TERM) {
1308 if (!SvPOK(linestr)) /* can get undefined by filter_gets */
1309 sv_setpvs(linestr, "");
1311 /* End of real input. Close filehandle (unless it was STDIN),
1312 * then add implicit termination.
1314 if (PL_parser->lex_flags & LEX_DONT_CLOSE_RSFP)
1315 PerlIO_clearerr(PL_parser->rsfp);
1316 else if (PL_parser->rsfp)
1317 (void)PerlIO_close(PL_parser->rsfp);
1318 PL_parser->rsfp = NULL;
1319 PL_parser->in_pod = PL_parser->filtered = 0;
1321 if (PL_madskills && !PL_in_eval && (PL_minus_p || PL_minus_n))
1324 if (!PL_in_eval && PL_minus_p) {
1326 /*{*/";}continue{print or die qq(-p destination: $!\\n);}");
1327 PL_minus_n = PL_minus_p = 0;
1328 } else if (!PL_in_eval && PL_minus_n) {
1329 sv_catpvs(linestr, /*{*/";}");
1332 sv_catpvs(linestr, ";");
1335 buf = SvPVX(linestr);
1336 new_bufend_pos = SvCUR(linestr);
1337 PL_parser->bufend = buf + new_bufend_pos;
1338 PL_parser->bufptr = buf + bufptr_pos;
1339 PL_parser->oldbufptr = buf + oldbufptr_pos;
1340 PL_parser->oldoldbufptr = buf + oldoldbufptr_pos;
1341 PL_parser->linestart = buf + linestart_pos;
1342 if (PL_parser->last_uni)
1343 PL_parser->last_uni = buf + last_uni_pos;
1344 if (PL_parser->last_lop)
1345 PL_parser->last_lop = buf + last_lop_pos;
1346 if (got_some_for_debugger && (PERLDB_LINE || PERLDB_SAVESRC) &&
1347 PL_curstash != PL_debstash) {
1348 /* debugger active and we're not compiling the debugger code,
1349 * so store the line into the debugger's array of lines
1351 update_debugger_info(NULL, buf+old_bufend_pos,
1352 new_bufend_pos-old_bufend_pos);
1358 =for apidoc Amx|I32|lex_peek_unichar|U32 flags
1360 Looks ahead one (Unicode) character in the text currently being lexed.
1361 Returns the codepoint (unsigned integer value) of the next character,
1362 or -1 if lexing has reached the end of the input text. To consume the
1363 peeked character, use L</lex_read_unichar>.
1365 If the next character is in (or extends into) the next chunk of input
1366 text, the next chunk will be read in. Normally the current chunk will be
1367 discarded at the same time, but if I<flags> includes C<LEX_KEEP_PREVIOUS>
1368 then the current chunk will not be discarded.
1370 If the input is being interpreted as UTF-8 and a UTF-8 encoding error
1371 is encountered, an exception is generated.
1377 Perl_lex_peek_unichar(pTHX_ U32 flags)
1381 if (flags & ~(LEX_KEEP_PREVIOUS))
1382 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_peek_unichar");
1383 s = PL_parser->bufptr;
1384 bufend = PL_parser->bufend;
1390 if (!lex_next_chunk(flags))
1392 s = PL_parser->bufptr;
1393 bufend = PL_parser->bufend;
1399 len = PL_utf8skip[head];
1400 while ((STRLEN)(bufend-s) < len) {
1401 if (!lex_next_chunk(flags | LEX_KEEP_PREVIOUS))
1403 s = PL_parser->bufptr;
1404 bufend = PL_parser->bufend;
1407 unichar = utf8n_to_uvuni((U8*)s, bufend-s, &retlen, UTF8_CHECK_ONLY);
1408 if (retlen == (STRLEN)-1) {
1409 /* malformed UTF-8 */
1411 SAVESPTR(PL_warnhook);
1412 PL_warnhook = PERL_WARNHOOK_FATAL;
1413 utf8n_to_uvuni((U8*)s, bufend-s, NULL, 0);
1419 if (!lex_next_chunk(flags))
1421 s = PL_parser->bufptr;
1428 =for apidoc Amx|I32|lex_read_unichar|U32 flags
1430 Reads the next (Unicode) character in the text currently being lexed.
1431 Returns the codepoint (unsigned integer value) of the character read,
1432 and moves L</PL_parser-E<gt>bufptr> past the character, or returns -1
1433 if lexing has reached the end of the input text. To non-destructively
1434 examine the next character, use L</lex_peek_unichar> instead.
1436 If the next character is in (or extends into) the next chunk of input
1437 text, the next chunk will be read in. Normally the current chunk will be
1438 discarded at the same time, but if I<flags> includes C<LEX_KEEP_PREVIOUS>
1439 then the current chunk will not be discarded.
1441 If the input is being interpreted as UTF-8 and a UTF-8 encoding error
1442 is encountered, an exception is generated.
1448 Perl_lex_read_unichar(pTHX_ U32 flags)
1451 if (flags & ~(LEX_KEEP_PREVIOUS))
1452 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_unichar");
1453 c = lex_peek_unichar(flags);
1456 COPLINE_INC_WITH_HERELINES;
1458 PL_parser->bufptr += UTF8SKIP(PL_parser->bufptr);
1460 ++(PL_parser->bufptr);
1466 =for apidoc Amx|void|lex_read_space|U32 flags
1468 Reads optional spaces, in Perl style, in the text currently being
1469 lexed. The spaces may include ordinary whitespace characters and
1470 Perl-style comments. C<#line> directives are processed if encountered.
1471 L</PL_parser-E<gt>bufptr> is moved past the spaces, so that it points
1472 at a non-space character (or the end of the input text).
1474 If spaces extend into the next chunk of input text, the next chunk will
1475 be read in. Normally the current chunk will be discarded at the same
1476 time, but if I<flags> includes C<LEX_KEEP_PREVIOUS> then the current
1477 chunk will not be discarded.
1482 #define LEX_NO_NEXT_CHUNK 0x80000000
1485 Perl_lex_read_space(pTHX_ U32 flags)
1488 bool need_incline = 0;
1489 if (flags & ~(LEX_KEEP_PREVIOUS|LEX_NO_NEXT_CHUNK))
1490 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_space");
1493 sv_free(PL_skipwhite);
1494 PL_skipwhite = NULL;
1497 PL_skipwhite = newSVpvs("");
1498 #endif /* PERL_MAD */
1499 s = PL_parser->bufptr;
1500 bufend = PL_parser->bufend;
1506 } while (!(c == '\n' || (c == 0 && s == bufend)));
1507 } else if (c == '\n') {
1509 PL_parser->linestart = s;
1514 } else if (isSPACE(c)) {
1516 } else if (c == 0 && s == bufend) {
1520 sv_catpvn(PL_skipwhite, PL_parser->bufptr, s-PL_parser->bufptr);
1521 #endif /* PERL_MAD */
1522 if (flags & LEX_NO_NEXT_CHUNK)
1524 PL_parser->bufptr = s;
1525 COPLINE_INC_WITH_HERELINES;
1526 got_more = lex_next_chunk(flags);
1527 CopLINE_dec(PL_curcop);
1528 s = PL_parser->bufptr;
1529 bufend = PL_parser->bufend;
1532 if (need_incline && PL_parser->rsfp) {
1542 sv_catpvn(PL_skipwhite, PL_parser->bufptr, s-PL_parser->bufptr);
1543 #endif /* PERL_MAD */
1544 PL_parser->bufptr = s;
1549 * This subroutine has nothing to do with tilting, whether at windmills
1550 * or pinball tables. Its name is short for "increment line". It
1551 * increments the current line number in CopLINE(PL_curcop) and checks
1552 * to see whether the line starts with a comment of the form
1553 * # line 500 "foo.pm"
1554 * If so, it sets the current line number and file to the values in the comment.
1558 S_incline(pTHX_ const char *s)
1566 PERL_ARGS_ASSERT_INCLINE;
1568 COPLINE_INC_WITH_HERELINES;
1571 while (SPACE_OR_TAB(*s))
1573 if (strnEQ(s, "line", 4))
1577 if (SPACE_OR_TAB(*s))
1581 while (SPACE_OR_TAB(*s))
1589 if (!SPACE_OR_TAB(*s) && *s != '\r' && *s != '\n' && *s != '\0')
1591 while (SPACE_OR_TAB(*s))
1593 if (*s == '"' && (t = strchr(s+1, '"'))) {
1599 while (!isSPACE(*t))
1603 while (SPACE_OR_TAB(*e) || *e == '\r' || *e == '\f')
1605 if (*e != '\n' && *e != '\0')
1606 return; /* false alarm */
1608 line_num = atoi(n)-1;
1611 const STRLEN len = t - s;
1612 SV *const temp_sv = CopFILESV(PL_curcop);
1617 cf = SvPVX(temp_sv);
1618 tmplen = SvCUR(temp_sv);
1624 if (!PL_rsfp && !PL_parser->filtered) {
1625 /* must copy *{"::_<(eval N)[oldfilename:L]"}
1626 * to *{"::_<newfilename"} */
1627 /* However, the long form of evals is only turned on by the
1628 debugger - usually they're "(eval %lu)" */
1632 STRLEN tmplen2 = len;
1633 if (tmplen + 2 <= sizeof smallbuf)
1636 Newx(tmpbuf, tmplen + 2, char);
1639 memcpy(tmpbuf + 2, cf, tmplen);
1641 gvp = (GV**)hv_fetch(PL_defstash, tmpbuf, tmplen, FALSE);
1646 if (tmplen2 + 2 <= sizeof smallbuf)
1649 Newx(tmpbuf2, tmplen2 + 2, char);
1651 if (tmpbuf2 != smallbuf || tmpbuf != smallbuf) {
1652 /* Either they malloc'd it, or we malloc'd it,
1653 so no prefix is present in ours. */
1658 memcpy(tmpbuf2 + 2, s, tmplen2);
1661 gv2 = *(GV**)hv_fetch(PL_defstash, tmpbuf2, tmplen2, TRUE);
1663 gv_init(gv2, PL_defstash, tmpbuf2, tmplen2, FALSE);
1664 /* adjust ${"::_<newfilename"} to store the new file name */
1665 GvSV(gv2) = newSVpvn(tmpbuf2 + 2, tmplen2 - 2);
1666 /* The line number may differ. If that is the case,
1667 alias the saved lines that are in the array.
1668 Otherwise alias the whole array. */
1669 if (CopLINE(PL_curcop) == line_num) {
1670 GvHV(gv2) = MUTABLE_HV(SvREFCNT_inc(GvHV(*gvp)));
1671 GvAV(gv2) = MUTABLE_AV(SvREFCNT_inc(GvAV(*gvp)));
1673 else if (GvAV(*gvp)) {
1674 AV * const av = GvAV(*gvp);
1675 const I32 start = CopLINE(PL_curcop)+1;
1676 I32 items = AvFILLp(av) - start;
1678 AV * const av2 = GvAVn(gv2);
1679 SV **svp = AvARRAY(av) + start;
1680 I32 l = (I32)line_num+1;
1682 av_store(av2, l++, SvREFCNT_inc(*svp++));
1687 if (tmpbuf2 != smallbuf) Safefree(tmpbuf2);
1689 if (tmpbuf != smallbuf) Safefree(tmpbuf);
1691 CopFILE_free(PL_curcop);
1692 CopFILE_setn(PL_curcop, s, len);
1694 CopLINE_set(PL_curcop, line_num);
1698 /* skip space before PL_thistoken */
1701 S_skipspace0(pTHX_ register char *s)
1703 PERL_ARGS_ASSERT_SKIPSPACE0;
1710 PL_thiswhite = newSVpvs("");
1711 sv_catsv(PL_thiswhite, PL_skipwhite);
1712 sv_free(PL_skipwhite);
1715 PL_realtokenstart = s - SvPVX(PL_linestr);
1719 /* skip space after PL_thistoken */
1722 S_skipspace1(pTHX_ register char *s)
1724 const char *start = s;
1725 I32 startoff = start - SvPVX(PL_linestr);
1727 PERL_ARGS_ASSERT_SKIPSPACE1;
1732 start = SvPVX(PL_linestr) + startoff;
1733 if (!PL_thistoken && PL_realtokenstart >= 0) {
1734 const char * const tstart = SvPVX(PL_linestr) + PL_realtokenstart;
1735 PL_thistoken = newSVpvn(tstart, start - tstart);
1737 PL_realtokenstart = -1;
1740 PL_nextwhite = newSVpvs("");
1741 sv_catsv(PL_nextwhite, PL_skipwhite);
1742 sv_free(PL_skipwhite);
1749 S_skipspace2(pTHX_ register char *s, SV **svp)
1752 const I32 bufptroff = PL_bufptr - SvPVX(PL_linestr);
1753 const I32 startoff = s - SvPVX(PL_linestr);
1755 PERL_ARGS_ASSERT_SKIPSPACE2;
1758 PL_bufptr = SvPVX(PL_linestr) + bufptroff;
1759 if (!PL_madskills || !svp)
1761 start = SvPVX(PL_linestr) + startoff;
1762 if (!PL_thistoken && PL_realtokenstart >= 0) {
1763 char * const tstart = SvPVX(PL_linestr) + PL_realtokenstart;
1764 PL_thistoken = newSVpvn(tstart, start - tstart);
1765 PL_realtokenstart = -1;
1769 *svp = newSVpvs("");
1770 sv_setsv(*svp, PL_skipwhite);
1771 sv_free(PL_skipwhite);
1780 S_update_debugger_info(pTHX_ SV *orig_sv, const char *const buf, STRLEN len)
1782 AV *av = CopFILEAVx(PL_curcop);
1784 SV * const sv = newSV_type(SVt_PVMG);
1786 sv_setsv(sv, orig_sv);
1788 sv_setpvn(sv, buf, len);
1791 av_store(av, (I32)CopLINE(PL_curcop), sv);
1797 * Called to gobble the appropriate amount and type of whitespace.
1798 * Skips comments as well.
1802 S_skipspace(pTHX_ register char *s)
1806 #endif /* PERL_MAD */
1807 PERL_ARGS_ASSERT_SKIPSPACE;
1810 sv_free(PL_skipwhite);
1811 PL_skipwhite = NULL;
1813 #endif /* PERL_MAD */
1814 if (PL_lex_formbrack && PL_lex_brackets <= PL_lex_formbrack) {
1815 while (s < PL_bufend && SPACE_OR_TAB(*s))
1818 STRLEN bufptr_pos = PL_bufptr - SvPVX(PL_linestr);
1820 lex_read_space(LEX_KEEP_PREVIOUS |
1821 (PL_sublex_info.sub_inwhat || PL_lex_state == LEX_FORMLINE ?
1822 LEX_NO_NEXT_CHUNK : 0));
1824 PL_bufptr = SvPVX(PL_linestr) + bufptr_pos;
1825 if (PL_linestart > PL_bufptr)
1826 PL_bufptr = PL_linestart;
1831 PL_skipwhite = newSVpvn(start, s-start);
1832 #endif /* PERL_MAD */
1838 * Check the unary operators to ensure there's no ambiguity in how they're
1839 * used. An ambiguous piece of code would be:
1841 * This doesn't mean rand() + 5. Because rand() is a unary operator,
1842 * the +5 is its argument.
1852 if (PL_oldoldbufptr != PL_last_uni)
1854 while (isSPACE(*PL_last_uni))
1857 while (isALNUM_lazy_if(s,UTF) || *s == '-')
1859 if ((t = strchr(s, '(')) && t < PL_bufptr)
1862 Perl_ck_warner_d(aTHX_ packWARN(WARN_AMBIGUOUS),
1863 "Warning: Use of \"%.*s\" without parentheses is ambiguous",
1864 (int)(s - PL_last_uni), PL_last_uni);
1868 * LOP : macro to build a list operator. Its behaviour has been replaced
1869 * with a subroutine, S_lop() for which LOP is just another name.
1872 #define LOP(f,x) return lop(f,x,s)
1876 * Build a list operator (or something that might be one). The rules:
1877 * - if we have a next token, then it's a list operator [why?]
1878 * - if the next thing is an opening paren, then it's a function
1879 * - else it's a list operator
1883 S_lop(pTHX_ I32 f, int x, char *s)
1887 PERL_ARGS_ASSERT_LOP;
1893 PL_last_lop = PL_oldbufptr;
1894 PL_last_lop_op = (OPCODE)f;
1903 return REPORT(FUNC);
1906 return REPORT(FUNC);
1909 if (!PL_lex_allbrackets && PL_lex_fakeeof > LEX_FAKEEOF_LOWLOGIC)
1910 PL_lex_fakeeof = LEX_FAKEEOF_LOWLOGIC;
1911 return REPORT(LSTOP);
1918 * Sets up for an eventual force_next(). start_force(0) basically does
1919 * an unshift, while start_force(-1) does a push. yylex removes items
1924 S_start_force(pTHX_ int where)
1928 if (where < 0) /* so people can duplicate start_force(PL_curforce) */
1929 where = PL_lasttoke;
1930 assert(PL_curforce < 0 || PL_curforce == where);
1931 if (PL_curforce != where) {
1932 for (i = PL_lasttoke; i > where; --i) {
1933 PL_nexttoke[i] = PL_nexttoke[i-1];
1937 if (PL_curforce < 0) /* in case of duplicate start_force() */
1938 Zero(&PL_nexttoke[where], 1, NEXTTOKE);
1939 PL_curforce = where;
1942 curmad('^', newSVpvs(""));
1943 CURMAD('_', PL_nextwhite);
1948 S_curmad(pTHX_ char slot, SV *sv)
1954 if (PL_curforce < 0)
1955 where = &PL_thismad;
1957 where = &PL_nexttoke[PL_curforce].next_mad;
1963 if (UTF && is_utf8_string((U8*)SvPVX(sv), SvCUR(sv)))
1965 else if (PL_encoding) {
1966 sv_recode_to_utf8(sv, PL_encoding);
1971 /* keep a slot open for the head of the list? */
1972 if (slot != '_' && *where && (*where)->mad_key == '^') {
1973 (*where)->mad_key = slot;
1974 sv_free(MUTABLE_SV(((*where)->mad_val)));
1975 (*where)->mad_val = (void*)sv;
1978 addmad(newMADsv(slot, sv), where, 0);
1981 # define start_force(where) NOOP
1982 # define curmad(slot, sv) NOOP
1987 * When the lexer realizes it knows the next token (for instance,
1988 * it is reordering tokens for the parser) then it can call S_force_next
1989 * to know what token to return the next time the lexer is called. Caller
1990 * will need to set PL_nextval[] (or PL_nexttoke[].next_val with PERL_MAD),
1991 * and possibly PL_expect to ensure the lexer handles the token correctly.
1995 S_force_next(pTHX_ I32 type)
2000 PerlIO_printf(Perl_debug_log, "### forced token:\n");
2001 tokereport(type, &NEXTVAL_NEXTTOKE);
2004 /* Don’t let opslab_force_free snatch it */
2005 if (S_is_opval_token(type & 0xffff) && NEXTVAL_NEXTTOKE.opval) {
2006 assert(!NEXTVAL_NEXTTOKE.opval->op_savefree);
2007 NEXTVAL_NEXTTOKE.opval->op_savefree = 1;
2010 if (PL_curforce < 0)
2011 start_force(PL_lasttoke);
2012 PL_nexttoke[PL_curforce].next_type = type;
2013 if (PL_lex_state != LEX_KNOWNEXT)
2014 PL_lex_defer = PL_lex_state;
2015 PL_lex_state = LEX_KNOWNEXT;
2016 PL_lex_expect = PL_expect;
2019 PL_nexttype[PL_nexttoke] = type;
2021 if (PL_lex_state != LEX_KNOWNEXT) {
2022 PL_lex_defer = PL_lex_state;
2023 PL_lex_expect = PL_expect;
2024 PL_lex_state = LEX_KNOWNEXT;
2032 int yyc = PL_parser->yychar;
2033 if (yyc != YYEMPTY) {
2036 NEXTVAL_NEXTTOKE = PL_parser->yylval;
2037 if (yyc == '{'/*}*/ || yyc == HASHBRACK || yyc == '['/*]*/) {
2038 PL_lex_allbrackets--;
2040 yyc |= (3<<24) | (PL_lex_brackstack[PL_lex_brackets] << 16);
2041 } else if (yyc == '('/*)*/) {
2042 PL_lex_allbrackets--;
2047 PL_parser->yychar = YYEMPTY;
2052 S_newSV_maybe_utf8(pTHX_ const char *const start, STRLEN len)
2055 SV * const sv = newSVpvn_utf8(start, len,
2058 && !is_ascii_string((const U8*)start, len)
2059 && is_utf8_string((const U8*)start, len));
2065 * When the lexer knows the next thing is a word (for instance, it has
2066 * just seen -> and it knows that the next char is a word char, then
2067 * it calls S_force_word to stick the next word into the PL_nexttoke/val
2071 * char *start : buffer position (must be within PL_linestr)
2072 * int token : PL_next* will be this type of bare word (e.g., METHOD,WORD)
2073 * int check_keyword : if true, Perl checks to make sure the word isn't
2074 * a keyword (do this if the word is a label, e.g. goto FOO)
2075 * int allow_pack : if true, : characters will also be allowed (require,
2076 * use, etc. do this)
2077 * int allow_initial_tick : used by the "sub" lexer only.
2081 S_force_word(pTHX_ register char *start, int token, int check_keyword, int allow_pack, int allow_initial_tick)
2087 PERL_ARGS_ASSERT_FORCE_WORD;
2089 start = SKIPSPACE1(start);
2091 if (isIDFIRST_lazy_if(s,UTF) ||
2092 (allow_pack && *s == ':') ||
2093 (allow_initial_tick && *s == '\'') )
2095 s = scan_word(s, PL_tokenbuf, sizeof PL_tokenbuf, allow_pack, &len);
2096 if (check_keyword && keyword(PL_tokenbuf, len, 0))
2098 start_force(PL_curforce);
2100 curmad('X', newSVpvn(start,s-start));
2101 if (token == METHOD) {
2106 PL_expect = XOPERATOR;
2110 curmad('g', newSVpvs( "forced" ));
2111 NEXTVAL_NEXTTOKE.opval
2112 = (OP*)newSVOP(OP_CONST,0,
2113 S_newSV_maybe_utf8(aTHX_ PL_tokenbuf, len));
2114 NEXTVAL_NEXTTOKE.opval->op_private |= OPpCONST_BARE;
2122 * Called when the lexer wants $foo *foo &foo etc, but the program
2123 * text only contains the "foo" portion. The first argument is a pointer
2124 * to the "foo", and the second argument is the type symbol to prefix.
2125 * Forces the next token to be a "WORD".
2126 * Creates the symbol if it didn't already exist (via gv_fetchpv()).
2130 S_force_ident(pTHX_ register const char *s, int kind)
2134 PERL_ARGS_ASSERT_FORCE_IDENT;
2137 const STRLEN len = strlen(s);
2138 OP* const o = (OP*)newSVOP(OP_CONST, 0, newSVpvn_flags(s, len,
2139 UTF ? SVf_UTF8 : 0));
2140 start_force(PL_curforce);
2141 NEXTVAL_NEXTTOKE.opval = o;
2144 o->op_private = OPpCONST_ENTERED;
2145 /* XXX see note in pp_entereval() for why we forgo typo
2146 warnings if the symbol must be introduced in an eval.
2148 gv_fetchpvn_flags(s, len,
2149 (PL_in_eval ? (GV_ADDMULTI | GV_ADDINEVAL)
2150 : GV_ADD) | ( UTF ? SVf_UTF8 : 0 ),
2151 kind == '$' ? SVt_PV :
2152 kind == '@' ? SVt_PVAV :
2153 kind == '%' ? SVt_PVHV :
2161 Perl_str_to_version(pTHX_ SV *sv)
2166 const char *start = SvPV_const(sv,len);
2167 const char * const end = start + len;
2168 const bool utf = SvUTF8(sv) ? TRUE : FALSE;
2170 PERL_ARGS_ASSERT_STR_TO_VERSION;
2172 while (start < end) {
2176 n = utf8n_to_uvchr((U8*)start, len, &skip, 0);
2181 retval += ((NV)n)/nshift;
2190 * Forces the next token to be a version number.
2191 * If the next token appears to be an invalid version number, (e.g. "v2b"),
2192 * and if "guessing" is TRUE, then no new token is created (and the caller
2193 * must use an alternative parsing method).
2197 S_force_version(pTHX_ char *s, int guessing)
2203 I32 startoff = s - SvPVX(PL_linestr);
2206 PERL_ARGS_ASSERT_FORCE_VERSION;
2214 while (isDIGIT(*d) || *d == '_' || *d == '.')
2218 start_force(PL_curforce);
2219 curmad('X', newSVpvn(s,d-s));
2222 if (*d == ';' || isSPACE(*d) || *d == '{' || *d == '}' || !*d) {
2224 #ifdef USE_LOCALE_NUMERIC
2225 char *loc = savepv(setlocale(LC_NUMERIC, NULL));
2226 setlocale(LC_NUMERIC, "C");
2228 s = scan_num(s, &pl_yylval);
2229 #ifdef USE_LOCALE_NUMERIC
2230 setlocale(LC_NUMERIC, loc);
2233 version = pl_yylval.opval;
2234 ver = cSVOPx(version)->op_sv;
2235 if (SvPOK(ver) && !SvNIOK(ver)) {
2236 SvUPGRADE(ver, SVt_PVNV);
2237 SvNV_set(ver, str_to_version(ver));
2238 SvNOK_on(ver); /* hint that it is a version */
2241 else if (guessing) {
2244 sv_free(PL_nextwhite); /* let next token collect whitespace */
2246 s = SvPVX(PL_linestr) + startoff;
2254 if (PL_madskills && !version) {
2255 sv_free(PL_nextwhite); /* let next token collect whitespace */
2257 s = SvPVX(PL_linestr) + startoff;
2260 /* NOTE: The parser sees the package name and the VERSION swapped */
2261 start_force(PL_curforce);
2262 NEXTVAL_NEXTTOKE.opval = version;
2269 * S_force_strict_version
2270 * Forces the next token to be a version number using strict syntax rules.
2274 S_force_strict_version(pTHX_ char *s)
2279 I32 startoff = s - SvPVX(PL_linestr);
2281 const char *errstr = NULL;
2283 PERL_ARGS_ASSERT_FORCE_STRICT_VERSION;
2285 while (isSPACE(*s)) /* leading whitespace */
2288 if (is_STRICT_VERSION(s,&errstr)) {
2290 s = (char *)scan_version(s, ver, 0);
2291 version = newSVOP(OP_CONST, 0, ver);
2293 else if ( (*s != ';' && *s != '{' && *s != '}' ) &&
2294 (s = SKIPSPACE1(s), (*s != ';' && *s != '{' && *s != '}' )))
2298 yyerror(errstr); /* version required */
2303 if (PL_madskills && !version) {
2304 sv_free(PL_nextwhite); /* let next token collect whitespace */
2306 s = SvPVX(PL_linestr) + startoff;
2309 /* NOTE: The parser sees the package name and the VERSION swapped */
2310 start_force(PL_curforce);
2311 NEXTVAL_NEXTTOKE.opval = version;
2319 * Tokenize a quoted string passed in as an SV. It finds the next
2320 * chunk, up to end of string or a backslash. It may make a new
2321 * SV containing that chunk (if HINT_NEW_STRING is on). It also
2326 S_tokeq(pTHX_ SV *sv)
2335 PERL_ARGS_ASSERT_TOKEQ;
2340 s = SvPV_force(sv, len);
2341 if (SvTYPE(sv) >= SVt_PVIV && SvIVX(sv) == -1)
2344 /* This is relying on the SV being "well formed" with a trailing '\0' */
2345 while (s < send && !(*s == '\\' && s[1] == '\\'))
2350 if ( PL_hints & HINT_NEW_STRING ) {
2351 pv = newSVpvn_flags(SvPVX_const(pv), len, SVs_TEMP | SvUTF8(sv));
2355 if (s + 1 < send && (s[1] == '\\'))
2356 s++; /* all that, just for this */
2361 SvCUR_set(sv, d - SvPVX_const(sv));
2363 if ( PL_hints & HINT_NEW_STRING )
2364 return new_constant(NULL, 0, "q", sv, pv, "q", 1);
2369 * Now come three functions related to double-quote context,
2370 * S_sublex_start, S_sublex_push, and S_sublex_done. They're used when
2371 * converting things like "\u\Lgnat" into ucfirst(lc("gnat")). They
2372 * interact with PL_lex_state, and create fake ( ... ) argument lists
2373 * to handle functions and concatenation.
2377 * stringify ( const[foo] concat lcfirst ( const[bar] ) )
2382 * Assumes that pl_yylval.ival is the op we're creating (e.g. OP_LCFIRST).
2384 * Pattern matching will set PL_lex_op to the pattern-matching op to
2385 * make (we return THING if pl_yylval.ival is OP_NULL, PMFUNC otherwise).
2387 * OP_CONST and OP_READLINE are easy--just make the new op and return.
2389 * Everything else becomes a FUNC.
2391 * Sets PL_lex_state to LEX_INTERPPUSH unless (ival was OP_NULL or we
2392 * had an OP_CONST or OP_READLINE). This just sets us up for a
2393 * call to S_sublex_push().
2397 S_sublex_start(pTHX)
2400 const I32 op_type = pl_yylval.ival;
2402 if (op_type == OP_NULL) {
2403 pl_yylval.opval = PL_lex_op;
2407 if (op_type == OP_CONST || op_type == OP_READLINE) {
2408 SV *sv = tokeq(PL_lex_stuff);
2410 if (SvTYPE(sv) == SVt_PVIV) {
2411 /* Overloaded constants, nothing fancy: Convert to SVt_PV: */
2413 const char * const p = SvPV_const(sv, len);
2414 SV * const nsv = newSVpvn_flags(p, len, SvUTF8(sv));
2418 pl_yylval.opval = (OP*)newSVOP(op_type, 0, sv);
2419 PL_lex_stuff = NULL;
2420 /* Allow <FH> // "foo" */
2421 if (op_type == OP_READLINE)
2422 PL_expect = XTERMORDORDOR;
2425 else if (op_type == OP_BACKTICK && PL_lex_op) {
2426 /* readpipe() vas overriden */
2427 cSVOPx(cLISTOPx(cUNOPx(PL_lex_op)->op_first)->op_first->op_sibling)->op_sv = tokeq(PL_lex_stuff);
2428 pl_yylval.opval = PL_lex_op;
2430 PL_lex_stuff = NULL;
2434 PL_sublex_info.super_state = PL_lex_state;
2435 PL_sublex_info.sub_inwhat = (U16)op_type;
2436 PL_sublex_info.sub_op = PL_lex_op;
2437 PL_lex_state = LEX_INTERPPUSH;
2441 pl_yylval.opval = PL_lex_op;
2451 * Create a new scope to save the lexing state. The scope will be
2452 * ended in S_sublex_done. Returns a '(', starting the function arguments
2453 * to the uc, lc, etc. found before.
2454 * Sets PL_lex_state to LEX_INTERPCONCAT.
2464 PL_lex_state = PL_sublex_info.super_state;
2465 SAVEBOOL(PL_lex_dojoin);
2466 SAVEI32(PL_lex_brackets);
2467 SAVEI32(PL_lex_allbrackets);
2468 SAVEI32(PL_lex_formbrack);
2469 SAVEI8(PL_lex_fakeeof);
2470 SAVEI32(PL_lex_casemods);
2471 SAVEI32(PL_lex_starts);
2472 SAVEI8(PL_lex_state);
2473 SAVESPTR(PL_lex_repl);
2474 SAVEPPTR(PL_sublex_info.re_eval_start);
2475 SAVESPTR(PL_sublex_info.re_eval_str);
2476 SAVEPPTR(PL_sublex_info.super_bufptr);
2477 SAVEVPTR(PL_lex_inpat);
2478 SAVEI16(PL_lex_inwhat);
2479 SAVECOPLINE(PL_curcop);
2480 SAVEPPTR(PL_bufptr);
2481 SAVEPPTR(PL_bufend);
2482 SAVEPPTR(PL_oldbufptr);
2483 SAVEPPTR(PL_oldoldbufptr);
2484 SAVEPPTR(PL_last_lop);
2485 SAVEPPTR(PL_last_uni);
2486 SAVEPPTR(PL_linestart);
2487 SAVESPTR(PL_linestr);
2488 SAVEGENERICPV(PL_lex_brackstack);
2489 SAVEGENERICPV(PL_lex_casestack);
2490 SAVEGENERICPV(PL_parser->lex_shared);
2492 /* The here-doc parser needs to be able to peek into outer lexing
2493 scopes to find the body of the here-doc. We use SvIVX(PL_linestr)
2494 to store the outer PL_bufptr and SvNVX to store the outer
2495 PL_linestr. Since SvIVX already means something else, we use
2496 PL_sublex_info.super_bufptr for the innermost scope (the one we are
2497 now entering), and a localised SvIVX for outer scopes.
2499 SvUPGRADE(PL_linestr, SVt_PVIV);
2500 /* A null super_bufptr means the outer lexing scope is not peekable,
2501 because it is a single line from an input stream. */
2502 SAVEIV(SvIVX(PL_linestr));
2503 SvIVX(PL_linestr) = PTR2IV(PL_sublex_info.super_bufptr);
2504 PL_sublex_info.super_bufptr =
2505 (SvTYPE(PL_linestr) < SVt_PVNV || !SvNVX(PL_linestr))
2506 && (PL_rsfp || PL_parser->filtered)
2509 SvUPGRADE(PL_lex_stuff, SVt_PVNV);
2510 SvNVX(PL_lex_stuff) = PTR2NV(PL_linestr);
2512 PL_linestr = PL_lex_stuff;
2513 PL_lex_repl = PL_sublex_info.repl;
2514 PL_lex_stuff = NULL;
2515 PL_sublex_info.repl = NULL;
2516 PL_sublex_info.re_eval_start = NULL;
2517 PL_sublex_info.re_eval_str = NULL;
2519 PL_bufend = PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart
2520 = SvPVX(PL_linestr);
2521 PL_bufend += SvCUR(PL_linestr);
2522 PL_last_lop = PL_last_uni = NULL;
2523 SAVEFREESV(PL_linestr);
2524 if (PL_lex_repl) SAVEFREESV(PL_lex_repl);
2526 PL_lex_dojoin = FALSE;
2527 PL_lex_brackets = PL_lex_formbrack = 0;
2528 PL_lex_allbrackets = 0;
2529 PL_lex_fakeeof = LEX_FAKEEOF_NEVER;
2530 Newx(PL_lex_brackstack, 120, char);
2531 Newx(PL_lex_casestack, 12, char);
2532 PL_lex_casemods = 0;
2533 *PL_lex_casestack = '\0';
2535 PL_lex_state = LEX_INTERPCONCAT;
2536 CopLINE_set(PL_curcop, (line_t)PL_multi_start);
2538 Newxz(shared, 1, LEXSHARED);
2539 shared->ls_prev = PL_parser->lex_shared;
2540 PL_parser->lex_shared = shared;
2542 PL_lex_inwhat = PL_sublex_info.sub_inwhat;
2543 if (PL_lex_inwhat == OP_TRANSR) PL_lex_inwhat = OP_TRANS;
2544 if (PL_lex_inwhat == OP_MATCH || PL_lex_inwhat == OP_QR || PL_lex_inwhat == OP_SUBST)
2545 PL_lex_inpat = PL_sublex_info.sub_op;
2547 PL_lex_inpat = NULL;
2554 * Restores lexer state after a S_sublex_push.
2561 if (!PL_lex_starts++) {
2562 SV * const sv = newSVpvs("");
2563 if (SvUTF8(PL_linestr))
2565 PL_expect = XOPERATOR;
2566 pl_yylval.opval = (OP*)newSVOP(OP_CONST, 0, sv);
2570 if (PL_lex_casemods) { /* oops, we've got some unbalanced parens */
2571 PL_lex_state = LEX_INTERPCASEMOD;
2575 /* Is there a right-hand side to take care of? (s//RHS/ or tr//RHS/) */
2576 assert(PL_lex_inwhat != OP_TRANSR);
2577 if (PL_lex_repl && (PL_lex_inwhat == OP_SUBST || PL_lex_inwhat == OP_TRANS)) {
2578 SvUPGRADE(PL_lex_repl, SVt_PVNV);
2579 SvNVX(PL_lex_repl) = SvNVX(PL_linestr);
2580 PL_linestr = PL_lex_repl;
2582 PL_bufend = PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
2583 PL_bufend += SvCUR(PL_linestr);
2584 PL_last_lop = PL_last_uni = NULL;
2585 PL_lex_dojoin = FALSE;
2586 PL_lex_brackets = 0;
2587 PL_lex_allbrackets = 0;
2588 PL_lex_fakeeof = LEX_FAKEEOF_NEVER;
2589 PL_lex_casemods = 0;
2590 *PL_lex_casestack = '\0';
2592 if (SvEVALED(PL_lex_repl)) {
2593 PL_lex_state = LEX_INTERPNORMAL;
2595 /* we don't clear PL_lex_repl here, so that we can check later
2596 whether this is an evalled subst; that means we rely on the
2597 logic to ensure sublex_done() is called again only via the
2598 branch (in yylex()) that clears PL_lex_repl, else we'll loop */
2601 PL_lex_state = LEX_INTERPCONCAT;
2611 PL_endwhite = newSVpvs("");
2612 sv_catsv(PL_endwhite, PL_thiswhite);
2616 sv_setpvs(PL_thistoken,"");
2618 PL_realtokenstart = -1;
2622 PL_bufend = SvPVX(PL_linestr);
2623 PL_bufend += SvCUR(PL_linestr);
2624 PL_expect = XOPERATOR;
2625 PL_sublex_info.sub_inwhat = 0;
2633 Extracts the next constant part of a pattern, double-quoted string,
2634 or transliteration. This is terrifying code.
2636 For example, in parsing the double-quoted string "ab\x63$d", it would
2637 stop at the '$' and return an OP_CONST containing 'abc'.
2639 It looks at PL_lex_inwhat and PL_lex_inpat to find out whether it's
2640 processing a pattern (PL_lex_inpat is true), a transliteration
2641 (PL_lex_inwhat == OP_TRANS is true), or a double-quoted string.
2643 Returns a pointer to the character scanned up to. If this is
2644 advanced from the start pointer supplied (i.e. if anything was
2645 successfully parsed), will leave an OP_CONST for the substring scanned
2646 in pl_yylval. Caller must intuit reason for not parsing further
2647 by looking at the next characters herself.
2651 \N{ABC} => \N{U+41.42.43}
2654 all other \-char, including \N and \N{ apart from \N{ABC}
2657 @ and $ where it appears to be a var, but not for $ as tail anchor
2662 In transliterations:
2663 characters are VERY literal, except for - not at the start or end
2664 of the string, which indicates a range. If the range is in bytes,
2665 scan_const expands the range to the full set of intermediate
2666 characters. If the range is in utf8, the hyphen is replaced with
2667 a certain range mark which will be handled by pmtrans() in op.c.
2669 In double-quoted strings:
2671 double-quoted style: \r and \n
2672 constants: \x31, etc.
2673 deprecated backrefs: \1 (in substitution replacements)
2674 case and quoting: \U \Q \E
2677 scan_const does *not* construct ops to handle interpolated strings.
2678 It stops processing as soon as it finds an embedded $ or @ variable
2679 and leaves it to the caller to work out what's going on.
2681 embedded arrays (whether in pattern or not) could be:
2682 @foo, @::foo, @'foo, @{foo}, @$foo, @+, @-.
2684 $ in double-quoted strings must be the symbol of an embedded scalar.
2686 $ in pattern could be $foo or could be tail anchor. Assumption:
2687 it's a tail anchor if $ is the last thing in the string, or if it's
2688 followed by one of "()| \r\n\t"
2690 \1 (backreferences) are turned into $1 in substitutions
2692 The structure of the code is
2693 while (there's a character to process) {
2694 handle transliteration ranges
2695 skip regexp comments /(?#comment)/ and codes /(?{code})/
2696 skip #-initiated comments in //x patterns
2697 check for embedded arrays
2698 check for embedded scalars
2700 deprecate \1 in substitution replacements
2701 handle string-changing backslashes \l \U \Q \E, etc.
2702 switch (what was escaped) {
2703 handle \- in a transliteration (becomes a literal -)
2704 if a pattern and not \N{, go treat as regular character
2705 handle \132 (octal characters)
2706 handle \x15 and \x{1234} (hex characters)
2707 handle \N{name} (named characters, also \N{3,5} in a pattern)
2708 handle \cV (control characters)
2709 handle printf-style backslashes (\f, \r, \n, etc)
2712 } (end if backslash)
2713 handle regular character
2714 } (end while character to read)
2719 S_scan_const(pTHX_ char *start)
2722 char *send = PL_bufend; /* end of the constant */
2723 SV *sv = newSV(send - start); /* sv for the constant. See
2724 note below on sizing. */
2725 char *s = start; /* start of the constant */
2726 char *d = SvPVX(sv); /* destination for copies */
2727 bool dorange = FALSE; /* are we in a translit range? */
2728 bool didrange = FALSE; /* did we just finish a range? */
2729 bool in_charclass = FALSE; /* within /[...]/ */
2730 bool has_utf8 = FALSE; /* Output constant is UTF8 */
2731 bool this_utf8 = cBOOL(UTF); /* Is the source string assumed
2732 to be UTF8? But, this can
2733 show as true when the source
2734 isn't utf8, as for example
2735 when it is entirely composed
2738 /* Note on sizing: The scanned constant is placed into sv, which is
2739 * initialized by newSV() assuming one byte of output for every byte of
2740 * input. This routine expects newSV() to allocate an extra byte for a
2741 * trailing NUL, which this routine will append if it gets to the end of
2742 * the input. There may be more bytes of input than output (eg., \N{LATIN
2743 * CAPITAL LETTER A}), or more output than input if the constant ends up
2744 * recoded to utf8, but each time a construct is found that might increase
2745 * the needed size, SvGROW() is called. Its size parameter each time is
2746 * based on the best guess estimate at the time, namely the length used so
2747 * far, plus the length the current construct will occupy, plus room for
2748 * the trailing NUL, plus one byte for every input byte still unscanned */
2752 UV literal_endpoint = 0;
2753 bool native_range = TRUE; /* turned to FALSE if the first endpoint is Unicode. */
2756 PERL_ARGS_ASSERT_SCAN_CONST;
2758 assert(PL_lex_inwhat != OP_TRANSR);
2759 if (PL_lex_inwhat == OP_TRANS && PL_sublex_info.sub_op) {
2760 /* If we are doing a trans and we know we want UTF8 set expectation */
2761 has_utf8 = PL_sublex_info.sub_op->op_private & (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF);
2762 this_utf8 = PL_sublex_info.sub_op->op_private & (PL_lex_repl ? OPpTRANS_FROM_UTF : OPpTRANS_TO_UTF);
2766 while (s < send || dorange) {
2768 /* get transliterations out of the way (they're most literal) */
2769 if (PL_lex_inwhat == OP_TRANS) {
2770 /* expand a range A-Z to the full set of characters. AIE! */
2772 I32 i; /* current expanded character */
2773 I32 min; /* first character in range */
2774 I32 max; /* last character in range */
2785 char * const c = (char*)utf8_hop((U8*)d, -1);
2789 *c = (char)UTF_TO_NATIVE(0xff);
2790 /* mark the range as done, and continue */
2796 i = d - SvPVX_const(sv); /* remember current offset */
2799 SvLEN(sv) + (has_utf8 ?
2800 (512 - UTF_CONTINUATION_MARK +
2803 /* How many two-byte within 0..255: 128 in UTF-8,
2804 * 96 in UTF-8-mod. */
2806 SvGROW(sv, SvLEN(sv) + 256); /* never more than 256 chars in a range */
2808 d = SvPVX(sv) + i; /* refresh d after realloc */
2812 for (j = 0; j <= 1; j++) {
2813 char * const c = (char*)utf8_hop((U8*)d, -1);
2814 const UV uv = utf8n_to_uvchr((U8*)c, d - c, NULL, 0);
2820 max = (U8)0xff; /* only to \xff */
2821 uvmax = uv; /* \x{100} to uvmax */
2823 d = c; /* eat endpoint chars */
2828 d -= 2; /* eat the first char and the - */
2829 min = (U8)*d; /* first char in range */
2830 max = (U8)d[1]; /* last char in range */
2838 "Invalid range \"%c-%c\" in transliteration operator",
2839 (char)min, (char)max);
2843 if (literal_endpoint == 2 &&
2844 ((isLOWER(min) && isLOWER(max)) ||
2845 (isUPPER(min) && isUPPER(max)))) {
2847 for (i = min; i <= max; i++)
2849 *d++ = NATIVE_TO_NEED(has_utf8,i);
2851 for (i = min; i <= max; i++)
2853 *d++ = NATIVE_TO_NEED(has_utf8,i);
2858 for (i = min; i <= max; i++)
2861 const U8 ch = (U8)NATIVE_TO_UTF(i);
2862 if (UNI_IS_INVARIANT(ch))
2865 *d++ = (U8)UTF8_EIGHT_BIT_HI(ch);
2866 *d++ = (U8)UTF8_EIGHT_BIT_LO(ch);
2875 d = (char*)uvchr_to_utf8((U8*)d, 0x100);
2877 *d++ = (char)UTF_TO_NATIVE(0xff);
2879 d = (char*)uvchr_to_utf8((U8*)d, uvmax);
2883 /* mark the range as done, and continue */
2887 literal_endpoint = 0;
2892 /* range begins (ignore - as first or last char) */
2893 else if (*s == '-' && s+1 < send && s != start) {
2896 Perl_croak(aTHX_ "Ambiguous range in transliteration operator");
2903 *d++ = (char)UTF_TO_NATIVE(0xff); /* use illegal utf8 byte--see pmtrans */
2913 literal_endpoint = 0;
2914 native_range = TRUE;
2919 /* if we get here, we're not doing a transliteration */
2921 else if (*s == '[' && PL_lex_inpat && !in_charclass) {
2924 while (s1 >= start && *s1-- == '\\')
2927 in_charclass = TRUE;
2930 else if (*s == ']' && PL_lex_inpat && in_charclass) {
2933 while (s1 >= start && *s1-- == '\\')
2936 in_charclass = FALSE;
2939 /* skip for regexp comments /(?#comment)/, except for the last
2940 * char, which will be done separately.
2941 * Stop on (?{..}) and friends */
2943 else if (*s == '(' && PL_lex_inpat && s[1] == '?') {
2945 while (s+1 < send && *s != ')')
2946 *d++ = NATIVE_TO_NEED(has_utf8,*s++);
2948 else if (!PL_lex_casemods && !in_charclass &&
2949 ( s[2] == '{' /* This should match regcomp.c */
2950 || (s[2] == '?' && s[3] == '{')))
2956 /* likewise skip #-initiated comments in //x patterns */
2957 else if (*s == '#' && PL_lex_inpat &&
2958 ((PMOP*)PL_lex_inpat)->op_pmflags & RXf_PMf_EXTENDED) {
2959 while (s+1 < send && *s != '\n')
2960 *d++ = NATIVE_TO_NEED(has_utf8,*s++);
2963 /* no further processing of single-quoted regex */
2964 else if (PL_lex_inpat && SvIVX(PL_linestr) == '\'')
2965 goto default_action;
2967 /* check for embedded arrays
2968 (@foo, @::foo, @'foo, @{foo}, @$foo, @+, @-)
2970 else if (*s == '@' && s[1]) {
2971 if (isALNUM_lazy_if(s+1,UTF))
2973 if (strchr(":'{$", s[1]))
2975 if (!PL_lex_inpat && (s[1] == '+' || s[1] == '-'))
2976 break; /* in regexp, neither @+ nor @- are interpolated */
2979 /* check for embedded scalars. only stop if we're sure it's a
2982 else if (*s == '$') {
2983 if (!PL_lex_inpat) /* not a regexp, so $ must be var */
2985 if (s + 1 < send && !strchr("()| \r\n\t", s[1])) {
2987 Perl_ck_warner(aTHX_ packWARN(WARN_AMBIGUOUS),
2988 "Possible unintended interpolation of $\\ in regex");
2990 break; /* in regexp, $ might be tail anchor */
2994 /* End of else if chain - OP_TRANS rejoin rest */
2997 if (*s == '\\' && s+1 < send) {
2998 char* e; /* Can be used for ending '}', etc. */
3002 /* warn on \1 - \9 in substitution replacements, but note that \11
3003 * is an octal; and \19 is \1 followed by '9' */
3004 if (PL_lex_inwhat == OP_SUBST && !PL_lex_inpat &&
3005 isDIGIT(*s) && *s != '0' && !isDIGIT(s[1]))
3007 Perl_ck_warner(aTHX_ packWARN(WARN_SYNTAX), "\\%c better written as $%c", *s, *s);
3012 /* string-change backslash escapes */
3013 if (PL_lex_inwhat != OP_TRANS && *s && strchr("lLuUEQF", *s)) {
3017 /* In a pattern, process \N, but skip any other backslash escapes.
3018 * This is because we don't want to translate an escape sequence
3019 * into a meta symbol and have the regex compiler use the meta
3020 * symbol meaning, e.g. \x{2E} would be confused with a dot. But
3021 * in spite of this, we do have to process \N here while the proper
3022 * charnames handler is in scope. See bugs #56444 and #62056.
3023 * There is a complication because \N in a pattern may also stand
3024 * for 'match a non-nl', and not mean a charname, in which case its
3025 * processing should be deferred to the regex compiler. To be a
3026 * charname it must be followed immediately by a '{', and not look
3027 * like \N followed by a curly quantifier, i.e., not something like
3028 * \N{3,}. regcurly returns a boolean indicating if it is a legal
3030 else if (PL_lex_inpat
3033 || regcurly(s + 1)))
3035 *d++ = NATIVE_TO_NEED(has_utf8,'\\');
3036 goto default_action;
3041 /* quoted - in transliterations */
3043 if (PL_lex_inwhat == OP_TRANS) {
3051 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
3052 "Unrecognized escape \\%c passed through",
3054 /* default action is to copy the quoted character */
3055 goto default_action;
3058 /* eg. \132 indicates the octal constant 0132 */
3059 case '0': case '1': case '2': case '3':
3060 case '4': case '5': case '6': case '7':
3064 uv = NATIVE_TO_UNI(grok_oct(s, &len, &flags, NULL));
3067 goto NUM_ESCAPE_INSERT;
3069 /* eg. \o{24} indicates the octal constant \024 */
3075 bool valid = grok_bslash_o(s, &uv, &len, &error, 1);
3081 goto NUM_ESCAPE_INSERT;
3084 /* eg. \x24 indicates the hex constant 0x24 */
3090 bool valid = grok_bslash_x(s, &uv, &len, &error, 1);
3099 /* Insert oct or hex escaped character. There will always be
3100 * enough room in sv since such escapes will be longer than any
3101 * UTF-8 sequence they can end up as, except if they force us
3102 * to recode the rest of the string into utf8 */
3104 /* Here uv is the ordinal of the next character being added in
3105 * unicode (converted from native). */
3106 if (!UNI_IS_INVARIANT(uv)) {
3107 if (!has_utf8 && uv > 255) {
3108 /* Might need to recode whatever we have accumulated so
3109 * far if it contains any chars variant in utf8 or
3112 SvCUR_set(sv, d - SvPVX_const(sv));
3115 /* See Note on sizing above. */
3116 sv_utf8_upgrade_flags_grow(sv,
3117 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3118 UNISKIP(uv) + (STRLEN)(send - s) + 1);
3119 d = SvPVX(sv) + SvCUR(sv);
3124 d = (char*)uvuni_to_utf8((U8*)d, uv);
3125 if (PL_lex_inwhat == OP_TRANS &&
3126 PL_sublex_info.sub_op) {
3127 PL_sublex_info.sub_op->op_private |=
3128 (PL_lex_repl ? OPpTRANS_FROM_UTF
3132 if (uv > 255 && !dorange)
3133 native_range = FALSE;
3146 /* In a non-pattern \N must be a named character, like \N{LATIN
3147 * SMALL LETTER A} or \N{U+0041}. For patterns, it also can
3148 * mean to match a non-newline. For non-patterns, named
3149 * characters are converted to their string equivalents. In
3150 * patterns, named characters are not converted to their
3151 * ultimate forms for the same reasons that other escapes
3152 * aren't. Instead, they are converted to the \N{U+...} form
3153 * to get the value from the charnames that is in effect right
3154 * now, while preserving the fact that it was a named character
3155 * so that the regex compiler knows this */
3157 /* This section of code doesn't generally use the
3158 * NATIVE_TO_NEED() macro to transform the input. I (khw) did
3159 * a close examination of this macro and determined it is a
3160 * no-op except on utfebcdic variant characters. Every
3161 * character generated by this that would normally need to be
3162 * enclosed by this macro is invariant, so the macro is not
3163 * needed, and would complicate use of copy(). XXX There are
3164 * other parts of this file where the macro is used
3165 * inconsistently, but are saved by it being a no-op */
3167 /* The structure of this section of code (besides checking for
3168 * errors and upgrading to utf8) is:
3169 * Further disambiguate between the two meanings of \N, and if
3170 * not a charname, go process it elsewhere
3171 * If of form \N{U+...}, pass it through if a pattern;
3172 * otherwise convert to utf8
3173 * Otherwise must be \N{NAME}: convert to \N{U+c1.c2...} if a
3174 * pattern; otherwise convert to utf8 */
3176 /* Here, s points to the 'N'; the test below is guaranteed to
3177 * succeed if we are being called on a pattern as we already
3178 * know from a test above that the next character is a '{'.
3179 * On a non-pattern \N must mean 'named sequence, which
3180 * requires braces */
3183 yyerror("Missing braces on \\N{}");
3188 /* If there is no matching '}', it is an error. */
3189 if (! (e = strchr(s, '}'))) {
3190 if (! PL_lex_inpat) {
3191 yyerror("Missing right brace on \\N{}");
3193 yyerror("Missing right brace on \\N{} or unescaped left brace after \\N.");
3198 /* Here it looks like a named character */
3202 /* XXX This block is temporary code. \N{} implies that the
3203 * pattern is to have Unicode semantics, and therefore
3204 * currently has to be encoded in utf8. By putting it in
3205 * utf8 now, we save a whole pass in the regular expression
3206 * compiler. Once that code is changed so Unicode
3207 * semantics doesn't necessarily have to be in utf8, this
3208 * block should be removed. However, the code that parses
3209 * the output of this would have to be changed to not
3210 * necessarily expect utf8 */
3212 SvCUR_set(sv, d - SvPVX_const(sv));
3215 /* See Note on sizing above. */
3216 sv_utf8_upgrade_flags_grow(sv,
3217 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3218 /* 5 = '\N{' + cur char + NUL */
3219 (STRLEN)(send - s) + 5);
3220 d = SvPVX(sv) + SvCUR(sv);
3225 if (*s == 'U' && s[1] == '+') { /* \N{U+...} */
3226 I32 flags = PERL_SCAN_ALLOW_UNDERSCORES
3227 | PERL_SCAN_DISALLOW_PREFIX;
3230 /* For \N{U+...}, the '...' is a unicode value even on
3231 * EBCDIC machines */
3232 s += 2; /* Skip to next char after the 'U+' */
3234 uv = grok_hex(s, &len, &flags, NULL);
3235 if (len == 0 || len != (STRLEN)(e - s)) {
3236 yyerror("Invalid hexadecimal number in \\N{U+...}");
3243 /* On non-EBCDIC platforms, pass through to the regex
3244 * compiler unchanged. The reason we evaluated the
3245 * number above is to make sure there wasn't a syntax
3246 * error. But on EBCDIC we convert to native so
3247 * downstream code can continue to assume it's native
3249 s -= 5; /* Include the '\N{U+' */
3251 d += my_snprintf(d, e - s + 1 + 1, /* includes the }
3254 (unsigned int) UNI_TO_NATIVE(uv));
3256 Copy(s, d, e - s + 1, char); /* 1 = include the } */
3260 else { /* Not a pattern: convert the hex to string */
3262 /* If destination is not in utf8, unconditionally
3263 * recode it to be so. This is because \N{} implies
3264 * Unicode semantics, and scalars have to be in utf8
3265 * to guarantee those semantics */
3267 SvCUR_set(sv, d - SvPVX_const(sv));
3270 /* See Note on sizing above. */
3271 sv_utf8_upgrade_flags_grow(
3273 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3274 UNISKIP(uv) + (STRLEN)(send - e) + 1);
3275 d = SvPVX(sv) + SvCUR(sv);
3279 /* Add the string to the output */
3280 if (UNI_IS_INVARIANT(uv)) {
3283 else d = (char*)uvuni_to_utf8((U8*)d, uv);
3286 else { /* Here is \N{NAME} but not \N{U+...}. */
3288 SV *res; /* result from charnames */
3289 const char *str; /* the string in 'res' */
3290 STRLEN len; /* its length */
3292 /* Get the value for NAME */
3293 res = newSVpvn(s, e - s);
3294 res = new_constant( NULL, 0, "charnames",
3295 /* includes all of: \N{...} */
3296 res, NULL, s - 3, e - s + 4 );
3298 /* Most likely res will be in utf8 already since the
3299 * standard charnames uses pack U, but a custom translator
3300 * can leave it otherwise, so make sure. XXX This can be
3301 * revisited to not have charnames use utf8 for characters
3302 * that don't need it when regexes don't have to be in utf8
3303 * for Unicode semantics. If doing so, remember EBCDIC */
3304 sv_utf8_upgrade(res);
3305 str = SvPV_const(res, len);
3307 /* Don't accept malformed input */
3308 if (! is_utf8_string((U8 *) str, len)) {
3309 yyerror("Malformed UTF-8 returned by \\N");
3311 else if (PL_lex_inpat) {
3313 if (! len) { /* The name resolved to an empty string */
3314 Copy("\\N{}", d, 4, char);
3318 /* In order to not lose information for the regex
3319 * compiler, pass the result in the specially made
3320 * syntax: \N{U+c1.c2.c3...}, where c1 etc. are
3321 * the code points in hex of each character
3322 * returned by charnames */
3324 const char *str_end = str + len;
3325 STRLEN char_length; /* cur char's byte length */
3326 STRLEN output_length; /* and the number of bytes
3327 after this is translated
3329 const STRLEN off = d - SvPVX_const(sv);
3331 /* 2 hex per byte; 2 chars for '\N'; 2 chars for
3332 * max('U+', '.'); and 1 for NUL */
3333 char hex_string[2 * UTF8_MAXBYTES + 5];
3335 /* Get the first character of the result. */
3336 U32 uv = utf8n_to_uvuni((U8 *) str,
3341 /* The call to is_utf8_string() above hopefully
3342 * guarantees that there won't be an error. But
3343 * it's easy here to make sure. The function just
3344 * above warns and returns 0 if invalid utf8, but
3345 * it can also return 0 if the input is validly a
3346 * NUL. Disambiguate */
3347 if (uv == 0 && NATIVE_TO_ASCII(*str) != '\0') {
3348 uv = UNICODE_REPLACEMENT;
3351 /* Convert first code point to hex, including the
3352 * boiler plate before it. For all these, we
3353 * convert to native format so that downstream code
3354 * can continue to assume the input is native */
3356 my_snprintf(hex_string, sizeof(hex_string),
3358 (unsigned int) UNI_TO_NATIVE(uv));
3360 /* Make sure there is enough space to hold it */
3361 d = off + SvGROW(sv, off
3363 + (STRLEN)(send - e)
3364 + 2); /* '}' + NUL */
3366 Copy(hex_string, d, output_length, char);
3369 /* For each subsequent character, append dot and
3370 * its ordinal in hex */
3371 while ((str += char_length) < str_end) {
3372 const STRLEN off = d - SvPVX_const(sv);
3373 U32 uv = utf8n_to_uvuni((U8 *) str,
3377 if (uv == 0 && NATIVE_TO_ASCII(*str) != '\0') {
3378 uv = UNICODE_REPLACEMENT;
3382 my_snprintf(hex_string, sizeof(hex_string),
3384 (unsigned int) UNI_TO_NATIVE(uv));
3386 d = off + SvGROW(sv, off
3388 + (STRLEN)(send - e)
3389 + 2); /* '}' + NUL */
3390 Copy(hex_string, d, output_length, char);
3394 *d++ = '}'; /* Done. Add the trailing brace */
3397 else { /* Here, not in a pattern. Convert the name to a
3400 /* If destination is not in utf8, unconditionally
3401 * recode it to be so. This is because \N{} implies
3402 * Unicode semantics, and scalars have to be in utf8
3403 * to guarantee those semantics */
3405 SvCUR_set(sv, d - SvPVX_const(sv));
3408 /* See Note on sizing above. */
3409 sv_utf8_upgrade_flags_grow(sv,
3410 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3411 len + (STRLEN)(send - s) + 1);
3412 d = SvPVX(sv) + SvCUR(sv);
3414 } else if (len > (STRLEN)(e - s + 4)) { /* I _guess_ 4 is \N{} --jhi */
3416 /* See Note on sizing above. (NOTE: SvCUR() is not
3417 * set correctly here). */
3418 const STRLEN off = d - SvPVX_const(sv);
3419 d = off + SvGROW(sv, off + len + (STRLEN)(send - s) + 1);
3421 Copy(str, d, len, char);
3426 /* Deprecate non-approved name syntax */
3427 if (ckWARN_d(WARN_DEPRECATED)) {
3428 bool problematic = FALSE;
3431 /* For non-ut8 input, look to see that the first
3432 * character is an alpha, then loop through the rest
3433 * checking that each is a continuation */
3435 if (! isALPHAU(*i)) problematic = TRUE;
3436 else for (i = s + 1; i < e; i++) {
3437 if (isCHARNAME_CONT(*i)) continue;
3443 /* Similarly for utf8. For invariants can check
3444 * directly. We accept anything above the latin1
3445 * range because it is immaterial to Perl if it is
3446 * correct or not, and is expensive to check. But
3447 * it is fairly easy in the latin1 range to convert
3448 * the variants into a single character and check
3450 if (UTF8_IS_INVARIANT(*i)) {
3451 if (! isALPHAU(*i)) problematic = TRUE;
3452 } else if (UTF8_IS_DOWNGRADEABLE_START(*i)) {
3453 if (! isALPHAU(UNI_TO_NATIVE(TWO_BYTE_UTF8_TO_UNI(*i,
3459 if (! problematic) for (i = s + UTF8SKIP(s);
3463 if (UTF8_IS_INVARIANT(*i)) {
3464 if (isCHARNAME_CONT(*i)) continue;
3465 } else if (! UTF8_IS_DOWNGRADEABLE_START(*i)) {
3467 } else if (isCHARNAME_CONT(
3469 TWO_BYTE_UTF8_TO_UNI(*i, *(i+1)))))
3478 /* The e-i passed to the final %.*s makes sure that
3479 * should the trailing NUL be missing that this
3480 * print won't run off the end of the string */
3481 Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),
3482 "Deprecated character in \\N{...}; marked by <-- HERE in \\N{%.*s<-- HERE %.*s",
3483 (int)(i - s + 1), s, (int)(e - i), i + 1);
3486 } /* End \N{NAME} */
3489 native_range = FALSE; /* \N{} is defined to be Unicode */
3491 s = e + 1; /* Point to just after the '}' */
3494 /* \c is a control character */
3498 *d++ = grok_bslash_c(*s++, has_utf8, 1);
3501 yyerror("Missing control char name in \\c");
3505 /* printf-style backslashes, formfeeds, newlines, etc */
3507 *d++ = NATIVE_TO_NEED(has_utf8,'\b');
3510 *d++ = NATIVE_TO_NEED(has_utf8,'\n');
3513 *d++ = NATIVE_TO_NEED(has_utf8,'\r');
3516 *d++ = NATIVE_TO_NEED(has_utf8,'\f');
3519 *d++ = NATIVE_TO_NEED(has_utf8,'\t');
3522 *d++ = ASCII_TO_NEED(has_utf8,'\033');
3525 *d++ = ASCII_TO_NEED(has_utf8,'\007');
3531 } /* end if (backslash) */
3538 /* If we started with encoded form, or already know we want it,
3539 then encode the next character */
3540 if (! NATIVE_IS_INVARIANT((U8)(*s)) && (this_utf8 || has_utf8)) {
3544 /* One might think that it is wasted effort in the case of the
3545 * source being utf8 (this_utf8 == TRUE) to take the next character
3546 * in the source, convert it to an unsigned value, and then convert
3547 * it back again. But the source has not been validated here. The
3548 * routine that does the conversion checks for errors like
3551 const UV nextuv = (this_utf8) ? utf8n_to_uvchr((U8*)s, send - s, &len, 0) : (UV) ((U8) *s);
3552 const STRLEN need = UNISKIP(NATIVE_TO_UNI(nextuv));
3554 SvCUR_set(sv, d - SvPVX_const(sv));
3557 /* See Note on sizing above. */
3558 sv_utf8_upgrade_flags_grow(sv,
3559 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3560 need + (STRLEN)(send - s) + 1);
3561 d = SvPVX(sv) + SvCUR(sv);
3563 } else if (need > len) {
3564 /* encoded value larger than old, may need extra space (NOTE:
3565 * SvCUR() is not set correctly here). See Note on sizing
3567 const STRLEN off = d - SvPVX_const(sv);
3568 d = SvGROW(sv, off + need + (STRLEN)(send - s) + 1) + off;
3572 d = (char*)uvchr_to_utf8((U8*)d, nextuv);
3574 if (uv > 255 && !dorange)
3575 native_range = FALSE;
3579 *d++ = NATIVE_TO_NEED(has_utf8,*s++);
3581 } /* while loop to process each character */
3583 /* terminate the string and set up the sv */
3585 SvCUR_set(sv, d - SvPVX_const(sv));
3586 if (SvCUR(sv) >= SvLEN(sv))
3587 Perl_croak(aTHX_ "panic: constant overflowed allocated space, %"UVuf
3588 " >= %"UVuf, (UV)SvCUR(sv), (UV)SvLEN(sv));
3591 if (PL_encoding && !has_utf8) {
3592 sv_recode_to_utf8(sv, PL_encoding);
3598 if (PL_lex_inwhat == OP_TRANS && PL_sublex_info.sub_op) {
3599 PL_sublex_info.sub_op->op_private |=
3600 (PL_lex_repl ? OPpTRANS_FROM_UTF : OPpTRANS_TO_UTF);
3604 /* shrink the sv if we allocated more than we used */
3605 if (SvCUR(sv) + 5 < SvLEN(sv)) {
3606 SvPV_shrink_to_cur(sv);
3609 /* return the substring (via pl_yylval) only if we parsed anything */
3610 if (s > PL_bufptr) {
3611 if ( PL_hints & ( PL_lex_inpat ? HINT_NEW_RE : HINT_NEW_STRING ) ) {
3612 const char *const key = PL_lex_inpat ? "qr" : "q";
3613 const STRLEN keylen = PL_lex_inpat ? 2 : 1;
3617 if (PL_lex_inwhat == OP_TRANS) {
3620 } else if (PL_lex_inwhat == OP_SUBST && !PL_lex_inpat) {
3623 } else if (PL_lex_inpat && SvIVX(PL_linestr) == '\'') {
3631 sv = S_new_constant(aTHX_ start, s - start, key, keylen, sv, NULL,
3634 pl_yylval.opval = (OP*)newSVOP(OP_CONST, 0, sv);
3641 * Returns TRUE if there's more to the expression (e.g., a subscript),
3644 * It deals with "$foo[3]" and /$foo[3]/ and /$foo[0123456789$]+/
3646 * ->[ and ->{ return TRUE
3647 * { and [ outside a pattern are always subscripts, so return TRUE
3648 * if we're outside a pattern and it's not { or [, then return FALSE
3649 * if we're in a pattern and the first char is a {
3650 * {4,5} (any digits around the comma) returns FALSE
3651 * if we're in a pattern and the first char is a [
3653 * [SOMETHING] has a funky algorithm to decide whether it's a
3654 * character class or not. It has to deal with things like
3655 * /$foo[-3]/ and /$foo[$bar]/ as well as /$foo[$\d]+/
3656 * anything else returns TRUE
3659 /* This is the one truly awful dwimmer necessary to conflate C and sed. */
3662 S_intuit_more(pTHX_ register char *s)
3666 PERL_ARGS_ASSERT_INTUIT_MORE;
3668 if (PL_lex_brackets)
3670 if (*s == '-' && s[1] == '>' && (s[2] == '[' || s[2] == '{'))
3672 if (*s != '{' && *s != '[')
3677 /* In a pattern, so maybe we have {n,m}. */
3685 /* On the other hand, maybe we have a character class */
3688 if (*s == ']' || *s == '^')
3691 /* this is terrifying, and it works */
3692 int weight = 2; /* let's weigh the evidence */
3694 unsigned char un_char = 255, last_un_char;
3695 const char * const send = strchr(s,']');
3696 char tmpbuf[sizeof PL_tokenbuf * 4];
3698 if (!send) /* has to be an expression */
3701 Zero(seen,256,char);
3704 else if (isDIGIT(*s)) {
3706 if (isDIGIT(s[1]) && s[2] == ']')
3712 for (; s < send; s++) {
3713 last_un_char = un_char;
3714 un_char = (unsigned char)*s;
3719 weight -= seen[un_char] * 10;
3720 if (isALNUM_lazy_if(s+1,UTF)) {
3722 scan_ident(s, send, tmpbuf, sizeof tmpbuf, FALSE);
3723 len = (int)strlen(tmpbuf);
3724 if (len > 1 && gv_fetchpvn_flags(tmpbuf, len,
3725 UTF ? SVf_UTF8 : 0, SVt_PV))
3730 else if (*s == '$' && s[1] &&
3731 strchr("[#!%*<>()-=",s[1])) {
3732 if (/*{*/ strchr("])} =",s[2]))
3741 if (strchr("wds]",s[1]))
3743 else if (seen[(U8)'\''] || seen[(U8)'"'])
3745 else if (strchr("rnftbxcav",s[1]))
3747 else if (isDIGIT(s[1])) {
3749 while (s[1] && isDIGIT(s[1]))
3759 if (strchr("aA01! ",last_un_char))
3761 if (strchr("zZ79~",s[1]))
3763 if (last_un_char == 255 && (isDIGIT(s[1]) || s[1] == '$'))
3764 weight -= 5; /* cope with negative subscript */
3767 if (!isALNUM(last_un_char)
3768 && !(last_un_char == '$' || last_un_char == '@'
3769 || last_un_char == '&')
3770 && isALPHA(*s) && s[1] && isALPHA(s[1])) {
3775 if (keyword(tmpbuf, d - tmpbuf, 0))
3778 if (un_char == last_un_char + 1)
3780 weight -= seen[un_char];
3785 if (weight >= 0) /* probably a character class */
3795 * Does all the checking to disambiguate
3797 * between foo(bar) and bar->foo. Returns 0 if not a method, otherwise
3798 * FUNCMETH (bar->foo(args)) or METHOD (bar->foo args).
3800 * First argument is the stuff after the first token, e.g. "bar".
3802 * Not a method if foo is a filehandle.
3803 * Not a method if foo is a subroutine prototyped to take a filehandle.
3804 * Not a method if it's really "Foo $bar"
3805 * Method if it's "foo $bar"
3806 * Not a method if it's really "print foo $bar"
3807 * Method if it's really "foo package::" (interpreted as package->foo)
3808 * Not a method if bar is known to be a subroutine ("sub bar; foo bar")
3809 * Not a method if bar is a filehandle or package, but is quoted with
3814 S_intuit_method(pTHX_ char *start, GV *gv, CV *cv)
3817 char *s = start + (*start == '$');
3818 char tmpbuf[sizeof PL_tokenbuf];
3825 PERL_ARGS_ASSERT_INTUIT_METHOD;
3827 if (gv && SvTYPE(gv) == SVt_PVGV && GvIO(gv))
3829 if (cv && SvPOK(cv)) {
3830 const char *proto = CvPROTO(cv);
3838 s = scan_word(s, tmpbuf, sizeof tmpbuf, TRUE, &len);
3839 /* start is the beginning of the possible filehandle/object,
3840 * and s is the end of it
3841 * tmpbuf is a copy of it
3844 if (*start == '$') {
3845 if (cv || PL_last_lop_op == OP_PRINT || PL_last_lop_op == OP_SAY ||
3846 isUPPER(*PL_tokenbuf))
3849 len = start - SvPVX(PL_linestr);
3853 start = SvPVX(PL_linestr) + len;
3857 return *s == '(' ? FUNCMETH : METHOD;
3859 if (!keyword(tmpbuf, len, 0)) {
3860 if (len > 2 && tmpbuf[len - 2] == ':' && tmpbuf[len - 1] == ':') {
3864 soff = s - SvPVX(PL_linestr);
3868 indirgv = gv_fetchpvn_flags(tmpbuf, len, ( UTF ? SVf_UTF8 : 0 ), SVt_PVCV);
3869 if (indirgv && GvCVu(indirgv))
3871 /* filehandle or package name makes it a method */
3872 if (!cv || GvIO(indirgv) || gv_stashpvn(tmpbuf, len, UTF ? SVf_UTF8 : 0)) {
3874 soff = s - SvPVX(PL_linestr);
3877 if ((PL_bufend - s) >= 2 && *s == '=' && *(s+1) == '>')
3878 return 0; /* no assumptions -- "=>" quotes bareword */
3880 start_force(PL_curforce);
3881 NEXTVAL_NEXTTOKE.opval = (OP*)newSVOP(OP_CONST, 0,
3882 S_newSV_maybe_utf8(aTHX_ tmpbuf, len));
3883 NEXTVAL_NEXTTOKE.opval->op_private = OPpCONST_BARE;
3885 curmad('X', newSVpvn_flags(start,SvPVX(PL_linestr) + soff - start,
3886 ( UTF ? SVf_UTF8 : 0 )));
3891 PL_bufptr = SvPVX(PL_linestr) + soff; /* restart before space */
3893 return *s == '(' ? FUNCMETH : METHOD;
3899 /* Encoded script support. filter_add() effectively inserts a
3900 * 'pre-processing' function into the current source input stream.
3901 * Note that the filter function only applies to the current source file
3902 * (e.g., it will not affect files 'require'd or 'use'd by this one).
3904 * The datasv parameter (which may be NULL) can be used to pass
3905 * private data to this instance of the filter. The filter function
3906 * can recover the SV using the FILTER_DATA macro and use it to
3907 * store private buffers and state information.
3909 * The supplied datasv parameter is upgraded to a PVIO type
3910 * and the IoDIRP/IoANY field is used to store the function pointer,
3911 * and IOf_FAKE_DIRP is enabled on datasv to mark this as such.
3912 * Note that IoTOP_NAME, IoFMT_NAME, IoBOTTOM_NAME, if set for
3913 * private use must be set using malloc'd pointers.
3917 Perl_filter_add(pTHX_ filter_t funcp, SV *datasv)
3926 if (PL_parser->lex_flags & LEX_IGNORE_UTF8_HINTS)
3927 Perl_croak(aTHX_ "Source filters apply only to byte streams");
3929 if (!PL_rsfp_filters)
3930 PL_rsfp_filters = newAV();
3933 SvUPGRADE(datasv, SVt_PVIO);
3934 IoANY(datasv) = FPTR2DPTR(void *, funcp); /* stash funcp into spare field */
3935 IoFLAGS(datasv) |= IOf_FAKE_DIRP;
3936 DEBUG_P(PerlIO_printf(Perl_debug_log, "filter_add func %p (%s)\n",
3937 FPTR2DPTR(void *, IoANY(datasv)),
3938 SvPV_nolen(datasv)));
3939 av_unshift(PL_rsfp_filters, 1);
3940 av_store(PL_rsfp_filters, 0, datasv) ;
3942 !PL_parser->filtered
3943 && PL_parser->lex_flags & LEX_EVALBYTES
3944 && PL_bufptr < PL_bufend
3946 const char *s = PL_bufptr;
3947 while (s < PL_bufend) {
3949 SV *linestr = PL_parser->linestr;
3950 char *buf = SvPVX(linestr);
3951 STRLEN const bufptr_pos = PL_parser->bufptr - buf;
3952 STRLEN const oldbufptr_pos = PL_parser->oldbufptr - buf;
3953 STRLEN const oldoldbufptr_pos=PL_parser->oldoldbufptr-buf;
3954 STRLEN const linestart_pos = PL_parser->linestart - buf;
3955 STRLEN const last_uni_pos =
3956 PL_parser->last_uni ? PL_parser->last_uni - buf : 0;
3957 STRLEN const last_lop_pos =
3958 PL_parser->last_lop ? PL_parser->last_lop - buf : 0;
3959 av_push(PL_rsfp_filters, linestr);
3960 PL_parser->linestr =
3961 newSVpvn(SvPVX(linestr), ++s-SvPVX(linestr));
3962 buf = SvPVX(PL_parser->linestr);
3963 PL_parser->bufend = buf + SvCUR(PL_parser->linestr);
3964 PL_parser->bufptr = buf + bufptr_pos;
3965 PL_parser->oldbufptr = buf + oldbufptr_pos;
3966 PL_parser->oldoldbufptr = buf + oldoldbufptr_pos;
3967 PL_parser->linestart = buf + linestart_pos;
3968 if (PL_parser->last_uni)
3969 PL_parser->last_uni = buf + last_uni_pos;
3970 if (PL_parser->last_lop)
3971 PL_parser->last_lop = buf + last_lop_pos;
3972 SvLEN(linestr) = SvCUR(linestr);
3973 SvCUR(linestr) = s-SvPVX(linestr);
3974 PL_parser->filtered = 1;
3984 /* Delete most recently added instance of this filter function. */
3986 Perl_filter_del(pTHX_ filter_t funcp)
3991 PERL_ARGS_ASSERT_FILTER_DEL;
3994 DEBUG_P(PerlIO_printf(Perl_debug_log, "filter_del func %p",
3995 FPTR2DPTR(void*, funcp)));
3997 if (!PL_parser || !PL_rsfp_filters || AvFILLp(PL_rsfp_filters)<0)
3999 /* if filter is on top of stack (usual case) just pop it off */
4000 datasv = FILTER_DATA(AvFILLp(PL_rsfp_filters));
4001 if (IoANY(datasv) == FPTR2DPTR(void *, funcp)) {
4002 sv_free(av_pop(PL_rsfp_filters));
4006 /* we need to search for the correct entry and clear it */
4007 Perl_die(aTHX_ "filter_del can only delete in reverse order (currently)");
4011 /* Invoke the idxth filter function for the current rsfp. */
4012 /* maxlen 0 = read one text line */
4014 Perl_filter_read(pTHX_ int idx, SV *buf_sv, int maxlen)
4019 /* This API is bad. It should have been using unsigned int for maxlen.
4020 Not sure if we want to change the API, but if not we should sanity
4021 check the value here. */
4022 unsigned int correct_length
4031 PERL_ARGS_ASSERT_FILTER_READ;
4033 if (!PL_parser || !PL_rsfp_filters)
4035 if (idx > AvFILLp(PL_rsfp_filters)) { /* Any more filters? */
4036 /* Provide a default input filter to make life easy. */
4037 /* Note that we append to the line. This is handy. */
4038 DEBUG_P(PerlIO_printf(Perl_debug_log,
4039 "filter_read %d: from rsfp\n", idx));
4040 if (correct_length) {
4043 const int old_len = SvCUR(buf_sv);
4045 /* ensure buf_sv is large enough */
4046 SvGROW(buf_sv, (STRLEN)(old_len + correct_length + 1)) ;
4047 if ((len = PerlIO_read(PL_rsfp, SvPVX(buf_sv) + old_len,
4048 correct_length)) <= 0) {
4049 if (PerlIO_error(PL_rsfp))
4050 return -1; /* error */
4052 return 0 ; /* end of file */
4054 SvCUR_set(buf_sv, old_len + len) ;
4055 SvPVX(buf_sv)[old_len + len] = '\0';
4058 if (sv_gets(buf_sv, PL_rsfp, SvCUR(buf_sv)) == NULL) {
4059 if (PerlIO_error(PL_rsfp))
4060 return -1; /* error */
4062 return 0 ; /* end of file */
4065 return SvCUR(buf_sv);
4067 /* Skip this filter slot if filter has been deleted */
4068 if ( (datasv = FILTER_DATA(idx)) == &PL_sv_undef) {
4069 DEBUG_P(PerlIO_printf(Perl_debug_log,
4070 "filter_read %d: skipped (filter deleted)\n",
4072 return FILTER_READ(idx+1, buf_sv, correct_length); /* recurse */
4074 if (SvTYPE(datasv) != SVt_PVIO) {
4075 if (correct_length) {
4077 const STRLEN remainder = SvLEN(datasv) - SvCUR(datasv);
4078 if (!remainder) return 0; /* eof */
4079 if (correct_length > remainder) correct_length = remainder;
4080 sv_catpvn(buf_sv, SvEND(datasv), correct_length);
4081 SvCUR_set(datasv, SvCUR(datasv) + correct_length);
4084 const char *s = SvEND(datasv);
4085 const char *send = SvPVX(datasv) + SvLEN(datasv);
4093 if (s == send) return 0; /* eof */
4094 sv_catpvn(buf_sv, SvEND(datasv), s-SvEND(datasv));
4095 SvCUR_set(datasv, s-SvPVX(datasv));
4097 return SvCUR(buf_sv);
4099 /* Get function pointer hidden within datasv */
4100 funcp = DPTR2FPTR(filter_t, IoANY(datasv));
4101 DEBUG_P(PerlIO_printf(Perl_debug_log,
4102 "filter_read %d: via function %p (%s)\n",
4103 idx, (void*)datasv, SvPV_nolen_const(datasv)));
4104 /* Call function. The function is expected to */
4105 /* call "FILTER_READ(idx+1, buf_sv)" first. */
4106 /* Return: <0:error, =0:eof, >0:not eof */
4107 return (*funcp)(aTHX_ idx, buf_sv, correct_length);
4111 S_filter_gets(pTHX_ register SV *sv, STRLEN append)
4115 PERL_ARGS_ASSERT_FILTER_GETS;
4117 #ifdef PERL_CR_FILTER
4118 if (!PL_rsfp_filters) {
4119 filter_add(S_cr_textfilter,NULL);
4122 if (PL_rsfp_filters) {
4124 SvCUR_set(sv, 0); /* start with empty line */
4125 if (FILTER_READ(0, sv, 0) > 0)
4126 return ( SvPVX(sv) ) ;
4131 return (sv_gets(sv, PL_rsfp, append));
4135 S_find_in_my_stash(pTHX_ const char *pkgname, STRLEN len)
4140 PERL_ARGS_ASSERT_FIND_IN_MY_STASH;
4142 if (len == 11 && *pkgname == '_' && strEQ(pkgname, "__PACKAGE__"))
4146 (pkgname[len - 2] == ':' && pkgname[len - 1] == ':') &&
4147 (gv = gv_fetchpvn_flags(pkgname, len, ( UTF ? SVf_UTF8 : 0 ), SVt_PVHV)))
4149 return GvHV(gv); /* Foo:: */
4152 /* use constant CLASS => 'MyClass' */
4153 gv = gv_fetchpvn_flags(pkgname, len, UTF ? SVf_UTF8 : 0, SVt_PVCV);
4154 if (gv && GvCV(gv)) {
4155 SV * const sv = cv_const_sv(GvCV(gv));
4157 pkgname = SvPV_const(sv, len);
4160 return gv_stashpvn(pkgname, len, UTF ? SVf_UTF8 : 0);
4164 * S_readpipe_override
4165 * Check whether readpipe() is overridden, and generates the appropriate
4166 * optree, provided sublex_start() is called afterwards.
4169 S_readpipe_override(pTHX)
4172 GV *gv_readpipe = gv_fetchpvs("readpipe", GV_NOTQUAL, SVt_PVCV);
4173 pl_yylval.ival = OP_BACKTICK;
4175 && GvCVu(gv_readpipe) && GvIMPORTED_CV(gv_readpipe))
4177 ((gvp = (GV**)hv_fetchs(PL_globalstash, "readpipe", FALSE))
4178 && (gv_readpipe = *gvp) && isGV_with_GP(gv_readpipe)
4179 && GvCVu(gv_readpipe) && GvIMPORTED_CV(gv_readpipe)))
4181 PL_lex_op = (OP*)newUNOP(OP_ENTERSUB, OPf_STACKED,
4182 op_append_elem(OP_LIST,
4183 newSVOP(OP_CONST, 0, &PL_sv_undef), /* value will be read later */
4184 newCVREF(0, newGVOP(OP_GV, 0, gv_readpipe))));
4191 * The intent of this yylex wrapper is to minimize the changes to the
4192 * tokener when we aren't interested in collecting madprops. It remains
4193 * to be seen how successful this strategy will be...
4200 char *s = PL_bufptr;
4202 /* make sure PL_thiswhite is initialized */
4206 /* just do what yylex would do on pending identifier; leave PL_thiswhite alone */
4207 if (PL_lex_state != LEX_KNOWNEXT && PL_pending_ident)
4208 return S_pending_ident(aTHX);
4210 /* previous token ate up our whitespace? */
4211 if (!PL_lasttoke && PL_nextwhite) {
4212 PL_thiswhite = PL_nextwhite;
4216 /* isolate the token, and figure out where it is without whitespace */
4217 PL_realtokenstart = -1;
4221 assert(PL_curforce < 0);
4223 if (!PL_thismad || PL_thismad->mad_key == '^') { /* not forced already? */
4224 if (!PL_thistoken) {
4225 if (PL_realtokenstart < 0 || !CopLINE(PL_curcop))
4226 PL_thistoken = newSVpvs("");
4228 char * const tstart = SvPVX(PL_linestr) + PL_realtokenstart;
4229 PL_thistoken = newSVpvn(tstart, s - tstart);
4232 if (PL_thismad) /* install head */
4233 CURMAD('X', PL_thistoken);
4236 /* last whitespace of a sublex? */
4237 if (optype == ')' && PL_endwhite) {
4238 CURMAD('X', PL_endwhite);
4243 /* if no whitespace and we're at EOF, bail. Otherwise fake EOF below. */
4244 if (!PL_thiswhite && !PL_endwhite && !optype) {
4245 sv_free(PL_thistoken);
4250 /* put off final whitespace till peg */
4251 if (optype == ';' && !PL_rsfp && !PL_parser->filtered) {
4252 PL_nextwhite = PL_thiswhite;
4255 else if (PL_thisopen) {
4256 CURMAD('q', PL_thisopen);
4258 sv_free(PL_thistoken);
4262 /* Store actual token text as madprop X */
4263 CURMAD('X', PL_thistoken);
4267 /* add preceding whitespace as madprop _ */
4268 CURMAD('_', PL_thiswhite);
4272 /* add quoted material as madprop = */
4273 CURMAD('=', PL_thisstuff);
4277 /* add terminating quote as madprop Q */
4278 CURMAD('Q', PL_thisclose);
4282 /* special processing based on optype */
4286 /* opval doesn't need a TOKEN since it can already store mp */
4297 if (pl_yylval.opval)
4298 append_madprops(PL_thismad, pl_yylval.opval, 0);
4306 addmad(newMADsv('p', PL_endwhite), &PL_thismad, 0);
4315 /* remember any fake bracket that lexer is about to discard */
4316 if (PL_lex_brackets == 1 &&
4317 ((expectation)PL_lex_brackstack[0] & XFAKEBRACK))
4320 while (s < PL_bufend && (*s == ' ' || *s == '\t'))
4323 PL_thiswhite = newSVpvn(PL_bufptr, ++s - PL_bufptr);
4324 addmad(newMADsv('#', PL_thiswhite), &PL_thismad, 0);
4327 break; /* don't bother looking for trailing comment */
4336 /* attach a trailing comment to its statement instead of next token */
4340 if (PL_bufptr > PL_oldbufptr && PL_bufptr[-1] == optype) {
4342 while (s < PL_bufend && (*s == ' ' || *s == '\t'))
4344 if (*s == '\n' || *s == '#') {
4345 while (s < PL_bufend && *s != '\n')
4349 PL_thiswhite = newSVpvn(PL_bufptr, s - PL_bufptr);
4350 addmad(newMADsv('#', PL_thiswhite), &PL_thismad, 0);
4363 /* Create new token struct. Note: opvals return early above. */
4364 pl_yylval.tkval = newTOKEN(optype, pl_yylval, PL_thismad);
4371 S_tokenize_use(pTHX_ int is_use, char *s) {
4374 PERL_ARGS_ASSERT_TOKENIZE_USE;
4376 if (PL_expect != XSTATE)
4377 yyerror(Perl_form(aTHX_ "\"%s\" not allowed in expression",
4378 is_use ? "use" : "no"));
4381 if (isDIGIT(*s) || (*s == 'v' && isDIGIT(s[1]))) {
4382 s = force_version(s, TRUE);
4383 if (*s == ';' || *s == '}'
4384 || (s = SKIPSPACE1(s), (*s == ';' || *s == '}'))) {
4385 start_force(PL_curforce);
4386 NEXTVAL_NEXTTOKE.opval = NULL;
4389 else if (*s == 'v') {
4390 s = force_word(s,WORD,FALSE,TRUE,FALSE);
4391 s = force_version(s, FALSE);
4395 s = force_word(s,WORD,FALSE,TRUE,FALSE);
4396 s = force_version(s, FALSE);
4398 pl_yylval.ival = is_use;
4402 static const char* const exp_name[] =
4403 { "OPERATOR", "TERM", "REF", "STATE", "BLOCK", "ATTRBLOCK",
4404 "ATTRTERM", "TERMBLOCK", "TERMORDORDOR"
4408 #define word_takes_any_delimeter(p,l) S_word_takes_any_delimeter(p,l)
4410 S_word_takes_any_delimeter(char *p, STRLEN len)
4412 return (len == 1 && strchr("msyq", p[0])) ||
4414 (p[0] == 't' && p[1] == 'r') ||
4415 (p[0] == 'q' && strchr("qwxr", p[1]))));
4421 Works out what to call the token just pulled out of the input
4422 stream. The yacc parser takes care of taking the ops we return and
4423 stitching them into a tree.
4429 if read an identifier
4430 if we're in a my declaration
4431 croak if they tried to say my($foo::bar)
4432 build the ops for a my() declaration
4433 if it's an access to a my() variable
4434 are we in a sort block?
4435 croak if my($a); $a <=> $b
4436 build ops for access to a my() variable
4437 if in a dq string, and they've said @foo and we can't find @foo
4439 build ops for a bareword
4440 if we already built the token before, use it.
4445 #pragma segment Perl_yylex
4451 char *s = PL_bufptr;
4458 /* orig_keyword, gvp, and gv are initialized here because
4459 * jump to the label just_a_word_zero can bypass their
4460 * initialization later. */
4461 I32 orig_keyword = 0;