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->herelines) \
313 CopLINE(PL_curcop) += PL_parser->herelines, \
314 PL_parser->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';
756 s = SvPV_const(line, len);
757 parser->linestr = flags & LEX_START_COPIED
758 ? SvREFCNT_inc_simple_NN(line)
759 : newSVpvn_flags(s, len, SvUTF8(line));
760 if (!len || s[len-1] != ';')
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 PL_parser = parser->old_parser;
803 =for apidoc AmxU|SV *|PL_parser-E<gt>linestr
805 Buffer scalar containing the chunk currently under consideration of the
806 text currently being lexed. This is always a plain string scalar (for
807 which C<SvPOK> is true). It is not intended to be used as a scalar by
808 normal scalar means; instead refer to the buffer directly by the pointer
809 variables described below.
811 The lexer maintains various C<char*> pointers to things in the
812 C<PL_parser-E<gt>linestr> buffer. If C<PL_parser-E<gt>linestr> is ever
813 reallocated, all of these pointers must be updated. Don't attempt to
814 do this manually, but rather use L</lex_grow_linestr> if you need to
815 reallocate the buffer.
817 The content of the text chunk in the buffer is commonly exactly one
818 complete line of input, up to and including a newline terminator,
819 but there are situations where it is otherwise. The octets of the
820 buffer may be intended to be interpreted as either UTF-8 or Latin-1.
821 The function L</lex_bufutf8> tells you which. Do not use the C<SvUTF8>
822 flag on this scalar, which may disagree with it.
824 For direct examination of the buffer, the variable
825 L</PL_parser-E<gt>bufend> points to the end of the buffer. The current
826 lexing position is pointed to by L</PL_parser-E<gt>bufptr>. Direct use
827 of these pointers is usually preferable to examination of the scalar
828 through normal scalar means.
830 =for apidoc AmxU|char *|PL_parser-E<gt>bufend
832 Direct pointer to the end of the chunk of text currently being lexed, the
833 end of the lexer buffer. This is equal to C<SvPVX(PL_parser-E<gt>linestr)
834 + SvCUR(PL_parser-E<gt>linestr)>. A NUL character (zero octet) is
835 always located at the end of the buffer, and does not count as part of
836 the buffer's contents.
838 =for apidoc AmxU|char *|PL_parser-E<gt>bufptr
840 Points to the current position of lexing inside the lexer buffer.
841 Characters around this point may be freely examined, within
842 the range delimited by C<SvPVX(L</PL_parser-E<gt>linestr>)> and
843 L</PL_parser-E<gt>bufend>. The octets of the buffer may be intended to be
844 interpreted as either UTF-8 or Latin-1, as indicated by L</lex_bufutf8>.
846 Lexing code (whether in the Perl core or not) moves this pointer past
847 the characters that it consumes. It is also expected to perform some
848 bookkeeping whenever a newline character is consumed. This movement
849 can be more conveniently performed by the function L</lex_read_to>,
850 which handles newlines appropriately.
852 Interpretation of the buffer's octets can be abstracted out by
853 using the slightly higher-level functions L</lex_peek_unichar> and
854 L</lex_read_unichar>.
856 =for apidoc AmxU|char *|PL_parser-E<gt>linestart
858 Points to the start of the current line inside the lexer buffer.
859 This is useful for indicating at which column an error occurred, and
860 not much else. This must be updated by any lexing code that consumes
861 a newline; the function L</lex_read_to> handles this detail.
867 =for apidoc Amx|bool|lex_bufutf8
869 Indicates whether the octets in the lexer buffer
870 (L</PL_parser-E<gt>linestr>) should be interpreted as the UTF-8 encoding
871 of Unicode characters. If not, they should be interpreted as Latin-1
872 characters. This is analogous to the C<SvUTF8> flag for scalars.
874 In UTF-8 mode, it is not guaranteed that the lexer buffer actually
875 contains valid UTF-8. Lexing code must be robust in the face of invalid
878 The actual C<SvUTF8> flag of the L</PL_parser-E<gt>linestr> scalar
879 is significant, but not the whole story regarding the input character
880 encoding. Normally, when a file is being read, the scalar contains octets
881 and its C<SvUTF8> flag is off, but the octets should be interpreted as
882 UTF-8 if the C<use utf8> pragma is in effect. During a string eval,
883 however, the scalar may have the C<SvUTF8> flag on, and in this case its
884 octets should be interpreted as UTF-8 unless the C<use bytes> pragma
885 is in effect. This logic may change in the future; use this function
886 instead of implementing the logic yourself.
892 Perl_lex_bufutf8(pTHX)
898 =for apidoc Amx|char *|lex_grow_linestr|STRLEN len
900 Reallocates the lexer buffer (L</PL_parser-E<gt>linestr>) to accommodate
901 at least I<len> octets (including terminating NUL). Returns a
902 pointer to the reallocated buffer. This is necessary before making
903 any direct modification of the buffer that would increase its length.
904 L</lex_stuff_pvn> provides a more convenient way to insert text into
907 Do not use C<SvGROW> or C<sv_grow> directly on C<PL_parser-E<gt>linestr>;
908 this function updates all of the lexer's variables that point directly
915 Perl_lex_grow_linestr(pTHX_ STRLEN len)
919 STRLEN bufend_pos, bufptr_pos, oldbufptr_pos, oldoldbufptr_pos;
920 STRLEN linestart_pos, last_uni_pos, last_lop_pos, re_eval_start_pos;
921 linestr = PL_parser->linestr;
922 buf = SvPVX(linestr);
923 if (len <= SvLEN(linestr))
925 bufend_pos = PL_parser->bufend - buf;
926 bufptr_pos = PL_parser->bufptr - buf;
927 oldbufptr_pos = PL_parser->oldbufptr - buf;
928 oldoldbufptr_pos = PL_parser->oldoldbufptr - buf;
929 linestart_pos = PL_parser->linestart - buf;
930 last_uni_pos = PL_parser->last_uni ? PL_parser->last_uni - buf : 0;
931 last_lop_pos = PL_parser->last_lop ? PL_parser->last_lop - buf : 0;
932 re_eval_start_pos = PL_sublex_info.re_eval_start ?
933 PL_sublex_info.re_eval_start - buf : 0;
935 buf = sv_grow(linestr, len);
937 PL_parser->bufend = buf + bufend_pos;
938 PL_parser->bufptr = buf + bufptr_pos;
939 PL_parser->oldbufptr = buf + oldbufptr_pos;
940 PL_parser->oldoldbufptr = buf + oldoldbufptr_pos;
941 PL_parser->linestart = buf + linestart_pos;
942 if (PL_parser->last_uni)
943 PL_parser->last_uni = buf + last_uni_pos;
944 if (PL_parser->last_lop)
945 PL_parser->last_lop = buf + last_lop_pos;
946 if (PL_sublex_info.re_eval_start)
947 PL_sublex_info.re_eval_start = buf + re_eval_start_pos;
952 =for apidoc Amx|void|lex_stuff_pvn|const char *pv|STRLEN len|U32 flags
954 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
955 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
956 reallocating the buffer if necessary. This means that lexing code that
957 runs later will see the characters as if they had appeared in the input.
958 It is not recommended to do this as part of normal parsing, and most
959 uses of this facility run the risk of the inserted characters being
960 interpreted in an unintended manner.
962 The string to be inserted is represented by I<len> octets starting
963 at I<pv>. These octets are interpreted as either UTF-8 or Latin-1,
964 according to whether the C<LEX_STUFF_UTF8> flag is set in I<flags>.
965 The characters are recoded for the lexer buffer, according to how the
966 buffer is currently being interpreted (L</lex_bufutf8>). If a string
967 to be inserted is available as a Perl scalar, the L</lex_stuff_sv>
968 function is more convenient.
974 Perl_lex_stuff_pvn(pTHX_ const char *pv, STRLEN len, U32 flags)
978 PERL_ARGS_ASSERT_LEX_STUFF_PVN;
979 if (flags & ~(LEX_STUFF_UTF8))
980 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_stuff_pvn");
982 if (flags & LEX_STUFF_UTF8) {
986 const char *p, *e = pv+len;
987 for (p = pv; p != e; p++)
988 highhalf += !!(((U8)*p) & 0x80);
991 lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len+highhalf);
992 bufptr = PL_parser->bufptr;
993 Move(bufptr, bufptr+len+highhalf, PL_parser->bufend+1-bufptr, char);
994 SvCUR_set(PL_parser->linestr,
995 SvCUR(PL_parser->linestr) + len+highhalf);
996 PL_parser->bufend += len+highhalf;
997 for (p = pv; p != e; p++) {
1000 *bufptr++ = (char)(0xc0 | (c >> 6));
1001 *bufptr++ = (char)(0x80 | (c & 0x3f));
1003 *bufptr++ = (char)c;
1008 if (flags & LEX_STUFF_UTF8) {
1009 STRLEN highhalf = 0;
1010 const char *p, *e = pv+len;
1011 for (p = pv; p != e; p++) {
1014 Perl_croak(aTHX_ "Lexing code attempted to stuff "
1015 "non-Latin-1 character into Latin-1 input");
1016 } else if (c >= 0xc2 && p+1 != e &&
1017 (((U8)p[1]) & 0xc0) == 0x80) {
1020 } else if (c >= 0x80) {
1021 /* malformed UTF-8 */
1023 SAVESPTR(PL_warnhook);
1024 PL_warnhook = PERL_WARNHOOK_FATAL;
1025 utf8n_to_uvuni((U8*)p, e-p, NULL, 0);
1031 lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len-highhalf);
1032 bufptr = PL_parser->bufptr;
1033 Move(bufptr, bufptr+len-highhalf, PL_parser->bufend+1-bufptr, char);
1034 SvCUR_set(PL_parser->linestr,
1035 SvCUR(PL_parser->linestr) + len-highhalf);
1036 PL_parser->bufend += len-highhalf;
1037 for (p = pv; p != e; p++) {
1040 *bufptr++ = (char)(((c & 0x3) << 6) | (p[1] & 0x3f));
1043 *bufptr++ = (char)c;
1048 lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len);
1049 bufptr = PL_parser->bufptr;
1050 Move(bufptr, bufptr+len, PL_parser->bufend+1-bufptr, char);
1051 SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) + len);
1052 PL_parser->bufend += len;
1053 Copy(pv, bufptr, len, char);
1059 =for apidoc Amx|void|lex_stuff_pv|const char *pv|U32 flags
1061 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
1062 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
1063 reallocating the buffer if necessary. This means that lexing code that
1064 runs later will see the characters as if they had appeared in the input.
1065 It is not recommended to do this as part of normal parsing, and most
1066 uses of this facility run the risk of the inserted characters being
1067 interpreted in an unintended manner.
1069 The string to be inserted is represented by octets starting at I<pv>
1070 and continuing to the first nul. These octets are interpreted as either
1071 UTF-8 or Latin-1, according to whether the C<LEX_STUFF_UTF8> flag is set
1072 in I<flags>. The characters are recoded for the lexer buffer, according
1073 to how the buffer is currently being interpreted (L</lex_bufutf8>).
1074 If it is not convenient to nul-terminate a string to be inserted, the
1075 L</lex_stuff_pvn> function is more appropriate.
1081 Perl_lex_stuff_pv(pTHX_ const char *pv, U32 flags)
1083 PERL_ARGS_ASSERT_LEX_STUFF_PV;
1084 lex_stuff_pvn(pv, strlen(pv), flags);
1088 =for apidoc Amx|void|lex_stuff_sv|SV *sv|U32 flags
1090 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
1091 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
1092 reallocating the buffer if necessary. This means that lexing code that
1093 runs later will see the characters as if they had appeared in the input.
1094 It is not recommended to do this as part of normal parsing, and most
1095 uses of this facility run the risk of the inserted characters being
1096 interpreted in an unintended manner.
1098 The string to be inserted is the string value of I<sv>. The characters
1099 are recoded for the lexer buffer, according to how the buffer is currently
1100 being interpreted (L</lex_bufutf8>). If a string to be inserted is
1101 not already a Perl scalar, the L</lex_stuff_pvn> function avoids the
1102 need to construct a scalar.
1108 Perl_lex_stuff_sv(pTHX_ SV *sv, U32 flags)
1112 PERL_ARGS_ASSERT_LEX_STUFF_SV;
1114 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_stuff_sv");
1116 lex_stuff_pvn(pv, len, flags | (SvUTF8(sv) ? LEX_STUFF_UTF8 : 0));
1120 =for apidoc Amx|void|lex_unstuff|char *ptr
1122 Discards text about to be lexed, from L</PL_parser-E<gt>bufptr> up to
1123 I<ptr>. Text following I<ptr> will be moved, and the buffer shortened.
1124 This hides the discarded text from any lexing code that runs later,
1125 as if the text had never appeared.
1127 This is not the normal way to consume lexed text. For that, use
1134 Perl_lex_unstuff(pTHX_ char *ptr)
1138 PERL_ARGS_ASSERT_LEX_UNSTUFF;
1139 buf = PL_parser->bufptr;
1141 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_unstuff");
1144 bufend = PL_parser->bufend;
1146 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_unstuff");
1147 unstuff_len = ptr - buf;
1148 Move(ptr, buf, bufend+1-ptr, char);
1149 SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) - unstuff_len);
1150 PL_parser->bufend = bufend - unstuff_len;
1154 =for apidoc Amx|void|lex_read_to|char *ptr
1156 Consume text in the lexer buffer, from L</PL_parser-E<gt>bufptr> up
1157 to I<ptr>. This advances L</PL_parser-E<gt>bufptr> to match I<ptr>,
1158 performing the correct bookkeeping whenever a newline character is passed.
1159 This is the normal way to consume lexed text.
1161 Interpretation of the buffer's octets can be abstracted out by
1162 using the slightly higher-level functions L</lex_peek_unichar> and
1163 L</lex_read_unichar>.
1169 Perl_lex_read_to(pTHX_ char *ptr)
1172 PERL_ARGS_ASSERT_LEX_READ_TO;
1173 s = PL_parser->bufptr;
1174 if (ptr < s || ptr > PL_parser->bufend)
1175 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_to");
1176 for (; s != ptr; s++)
1178 COPLINE_INC_WITH_HERELINES;
1179 PL_parser->linestart = s+1;
1181 PL_parser->bufptr = ptr;
1185 =for apidoc Amx|void|lex_discard_to|char *ptr
1187 Discards the first part of the L</PL_parser-E<gt>linestr> buffer,
1188 up to I<ptr>. The remaining content of the buffer will be moved, and
1189 all pointers into the buffer updated appropriately. I<ptr> must not
1190 be later in the buffer than the position of L</PL_parser-E<gt>bufptr>:
1191 it is not permitted to discard text that has yet to be lexed.
1193 Normally it is not necessarily to do this directly, because it suffices to
1194 use the implicit discarding behaviour of L</lex_next_chunk> and things
1195 based on it. However, if a token stretches across multiple lines,
1196 and the lexing code has kept multiple lines of text in the buffer for
1197 that purpose, then after completion of the token it would be wise to
1198 explicitly discard the now-unneeded earlier lines, to avoid future
1199 multi-line tokens growing the buffer without bound.
1205 Perl_lex_discard_to(pTHX_ char *ptr)
1209 PERL_ARGS_ASSERT_LEX_DISCARD_TO;
1210 buf = SvPVX(PL_parser->linestr);
1212 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_discard_to");
1215 if (ptr > PL_parser->bufptr)
1216 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_discard_to");
1217 discard_len = ptr - buf;
1218 if (PL_parser->oldbufptr < ptr)
1219 PL_parser->oldbufptr = ptr;
1220 if (PL_parser->oldoldbufptr < ptr)
1221 PL_parser->oldoldbufptr = ptr;
1222 if (PL_parser->last_uni && PL_parser->last_uni < ptr)
1223 PL_parser->last_uni = NULL;
1224 if (PL_parser->last_lop && PL_parser->last_lop < ptr)
1225 PL_parser->last_lop = NULL;
1226 Move(ptr, buf, PL_parser->bufend+1-ptr, char);
1227 SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) - discard_len);
1228 PL_parser->bufend -= discard_len;
1229 PL_parser->bufptr -= discard_len;
1230 PL_parser->oldbufptr -= discard_len;
1231 PL_parser->oldoldbufptr -= discard_len;
1232 if (PL_parser->last_uni)
1233 PL_parser->last_uni -= discard_len;
1234 if (PL_parser->last_lop)
1235 PL_parser->last_lop -= discard_len;
1239 =for apidoc Amx|bool|lex_next_chunk|U32 flags
1241 Reads in the next chunk of text to be lexed, appending it to
1242 L</PL_parser-E<gt>linestr>. This should be called when lexing code has
1243 looked to the end of the current chunk and wants to know more. It is
1244 usual, but not necessary, for lexing to have consumed the entirety of
1245 the current chunk at this time.
1247 If L</PL_parser-E<gt>bufptr> is pointing to the very end of the current
1248 chunk (i.e., the current chunk has been entirely consumed), normally the
1249 current chunk will be discarded at the same time that the new chunk is
1250 read in. If I<flags> includes C<LEX_KEEP_PREVIOUS>, the current chunk
1251 will not be discarded. If the current chunk has not been entirely
1252 consumed, then it will not be discarded regardless of the flag.
1254 Returns true if some new text was added to the buffer, or false if the
1255 buffer has reached the end of the input text.
1260 #define LEX_FAKE_EOF 0x80000000
1261 #define LEX_NO_TERM 0x40000000
1264 Perl_lex_next_chunk(pTHX_ U32 flags)
1268 STRLEN old_bufend_pos, new_bufend_pos;
1269 STRLEN bufptr_pos, oldbufptr_pos, oldoldbufptr_pos;
1270 STRLEN linestart_pos, last_uni_pos, last_lop_pos;
1271 bool got_some_for_debugger = 0;
1273 if (flags & ~(LEX_KEEP_PREVIOUS|LEX_FAKE_EOF|LEX_NO_TERM))
1274 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_next_chunk");
1275 linestr = PL_parser->linestr;
1276 buf = SvPVX(linestr);
1277 if (!(flags & LEX_KEEP_PREVIOUS) &&
1278 PL_parser->bufptr == PL_parser->bufend) {
1279 old_bufend_pos = bufptr_pos = oldbufptr_pos = oldoldbufptr_pos = 0;
1281 if (PL_parser->last_uni != PL_parser->bufend)
1282 PL_parser->last_uni = NULL;
1283 if (PL_parser->last_lop != PL_parser->bufend)
1284 PL_parser->last_lop = NULL;
1285 last_uni_pos = last_lop_pos = 0;
1289 old_bufend_pos = PL_parser->bufend - buf;
1290 bufptr_pos = PL_parser->bufptr - buf;
1291 oldbufptr_pos = PL_parser->oldbufptr - buf;
1292 oldoldbufptr_pos = PL_parser->oldoldbufptr - buf;
1293 linestart_pos = PL_parser->linestart - buf;
1294 last_uni_pos = PL_parser->last_uni ? PL_parser->last_uni - buf : 0;
1295 last_lop_pos = PL_parser->last_lop ? PL_parser->last_lop - buf : 0;
1297 if (flags & LEX_FAKE_EOF) {
1299 } else if (!PL_parser->rsfp && !PL_parser->filtered) {
1301 } else if (filter_gets(linestr, old_bufend_pos)) {
1303 got_some_for_debugger = 1;
1304 } else if (flags & LEX_NO_TERM) {
1307 if (!SvPOK(linestr)) /* can get undefined by filter_gets */
1308 sv_setpvs(linestr, "");
1310 /* End of real input. Close filehandle (unless it was STDIN),
1311 * then add implicit termination.
1313 if (PL_parser->lex_flags & LEX_DONT_CLOSE_RSFP)
1314 PerlIO_clearerr(PL_parser->rsfp);
1315 else if (PL_parser->rsfp)
1316 (void)PerlIO_close(PL_parser->rsfp);
1317 PL_parser->rsfp = NULL;
1318 PL_parser->in_pod = PL_parser->filtered = 0;
1320 if (PL_madskills && !PL_in_eval && (PL_minus_p || PL_minus_n))
1323 if (!PL_in_eval && PL_minus_p) {
1325 /*{*/";}continue{print or die qq(-p destination: $!\\n);}");
1326 PL_minus_n = PL_minus_p = 0;
1327 } else if (!PL_in_eval && PL_minus_n) {
1328 sv_catpvs(linestr, /*{*/";}");
1331 sv_catpvs(linestr, ";");
1334 buf = SvPVX(linestr);
1335 new_bufend_pos = SvCUR(linestr);
1336 PL_parser->bufend = buf + new_bufend_pos;
1337 PL_parser->bufptr = buf + bufptr_pos;
1338 PL_parser->oldbufptr = buf + oldbufptr_pos;
1339 PL_parser->oldoldbufptr = buf + oldoldbufptr_pos;
1340 PL_parser->linestart = buf + linestart_pos;
1341 if (PL_parser->last_uni)
1342 PL_parser->last_uni = buf + last_uni_pos;
1343 if (PL_parser->last_lop)
1344 PL_parser->last_lop = buf + last_lop_pos;
1345 if (got_some_for_debugger && (PERLDB_LINE || PERLDB_SAVESRC) &&
1346 PL_curstash != PL_debstash) {
1347 /* debugger active and we're not compiling the debugger code,
1348 * so store the line into the debugger's array of lines
1350 update_debugger_info(NULL, buf+old_bufend_pos,
1351 new_bufend_pos-old_bufend_pos);
1357 =for apidoc Amx|I32|lex_peek_unichar|U32 flags
1359 Looks ahead one (Unicode) character in the text currently being lexed.
1360 Returns the codepoint (unsigned integer value) of the next character,
1361 or -1 if lexing has reached the end of the input text. To consume the
1362 peeked character, use L</lex_read_unichar>.
1364 If the next character is in (or extends into) the next chunk of input
1365 text, the next chunk will be read in. Normally the current chunk will be
1366 discarded at the same time, but if I<flags> includes C<LEX_KEEP_PREVIOUS>
1367 then the current chunk will not be discarded.
1369 If the input is being interpreted as UTF-8 and a UTF-8 encoding error
1370 is encountered, an exception is generated.
1376 Perl_lex_peek_unichar(pTHX_ U32 flags)
1380 if (flags & ~(LEX_KEEP_PREVIOUS))
1381 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_peek_unichar");
1382 s = PL_parser->bufptr;
1383 bufend = PL_parser->bufend;
1389 if (!lex_next_chunk(flags))
1391 s = PL_parser->bufptr;
1392 bufend = PL_parser->bufend;
1398 len = PL_utf8skip[head];
1399 while ((STRLEN)(bufend-s) < len) {
1400 if (!lex_next_chunk(flags | LEX_KEEP_PREVIOUS))
1402 s = PL_parser->bufptr;
1403 bufend = PL_parser->bufend;
1406 unichar = utf8n_to_uvuni((U8*)s, bufend-s, &retlen, UTF8_CHECK_ONLY);
1407 if (retlen == (STRLEN)-1) {
1408 /* malformed UTF-8 */
1410 SAVESPTR(PL_warnhook);
1411 PL_warnhook = PERL_WARNHOOK_FATAL;
1412 utf8n_to_uvuni((U8*)s, bufend-s, NULL, 0);
1418 if (!lex_next_chunk(flags))
1420 s = PL_parser->bufptr;
1427 =for apidoc Amx|I32|lex_read_unichar|U32 flags
1429 Reads the next (Unicode) character in the text currently being lexed.
1430 Returns the codepoint (unsigned integer value) of the character read,
1431 and moves L</PL_parser-E<gt>bufptr> past the character, or returns -1
1432 if lexing has reached the end of the input text. To non-destructively
1433 examine the next character, use L</lex_peek_unichar> instead.
1435 If the next character is in (or extends into) the next chunk of input
1436 text, the next chunk will be read in. Normally the current chunk will be
1437 discarded at the same time, but if I<flags> includes C<LEX_KEEP_PREVIOUS>
1438 then the current chunk will not be discarded.
1440 If the input is being interpreted as UTF-8 and a UTF-8 encoding error
1441 is encountered, an exception is generated.
1447 Perl_lex_read_unichar(pTHX_ U32 flags)
1450 if (flags & ~(LEX_KEEP_PREVIOUS))
1451 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_unichar");
1452 c = lex_peek_unichar(flags);
1455 COPLINE_INC_WITH_HERELINES;
1457 PL_parser->bufptr += UTF8SKIP(PL_parser->bufptr);
1459 ++(PL_parser->bufptr);
1465 =for apidoc Amx|void|lex_read_space|U32 flags
1467 Reads optional spaces, in Perl style, in the text currently being
1468 lexed. The spaces may include ordinary whitespace characters and
1469 Perl-style comments. C<#line> directives are processed if encountered.
1470 L</PL_parser-E<gt>bufptr> is moved past the spaces, so that it points
1471 at a non-space character (or the end of the input text).
1473 If spaces extend into the next chunk of input text, the next chunk will
1474 be read in. Normally the current chunk will be discarded at the same
1475 time, but if I<flags> includes C<LEX_KEEP_PREVIOUS> then the current
1476 chunk will not be discarded.
1481 #define LEX_NO_NEXT_CHUNK 0x80000000
1484 Perl_lex_read_space(pTHX_ U32 flags)
1487 bool need_incline = 0;
1488 if (flags & ~(LEX_KEEP_PREVIOUS|LEX_NO_NEXT_CHUNK))
1489 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_space");
1492 sv_free(PL_skipwhite);
1493 PL_skipwhite = NULL;
1496 PL_skipwhite = newSVpvs("");
1497 #endif /* PERL_MAD */
1498 s = PL_parser->bufptr;
1499 bufend = PL_parser->bufend;
1505 } while (!(c == '\n' || (c == 0 && s == bufend)));
1506 } else if (c == '\n') {
1508 PL_parser->linestart = s;
1513 } else if (isSPACE(c)) {
1515 } else if (c == 0 && s == bufend) {
1519 sv_catpvn(PL_skipwhite, PL_parser->bufptr, s-PL_parser->bufptr);
1520 #endif /* PERL_MAD */
1521 if (flags & LEX_NO_NEXT_CHUNK)
1523 PL_parser->bufptr = s;
1524 COPLINE_INC_WITH_HERELINES;
1525 got_more = lex_next_chunk(flags);
1526 CopLINE_dec(PL_curcop);
1527 s = PL_parser->bufptr;
1528 bufend = PL_parser->bufend;
1531 if (need_incline && PL_parser->rsfp) {
1541 sv_catpvn(PL_skipwhite, PL_parser->bufptr, s-PL_parser->bufptr);
1542 #endif /* PERL_MAD */
1543 PL_parser->bufptr = s;
1548 * This subroutine has nothing to do with tilting, whether at windmills
1549 * or pinball tables. Its name is short for "increment line". It
1550 * increments the current line number in CopLINE(PL_curcop) and checks
1551 * to see whether the line starts with a comment of the form
1552 * # line 500 "foo.pm"
1553 * If so, it sets the current line number and file to the values in the comment.
1557 S_incline(pTHX_ const char *s)
1565 PERL_ARGS_ASSERT_INCLINE;
1567 COPLINE_INC_WITH_HERELINES;
1570 while (SPACE_OR_TAB(*s))
1572 if (strnEQ(s, "line", 4))
1576 if (SPACE_OR_TAB(*s))
1580 while (SPACE_OR_TAB(*s))
1588 if (!SPACE_OR_TAB(*s) && *s != '\r' && *s != '\n' && *s != '\0')
1590 while (SPACE_OR_TAB(*s))
1592 if (*s == '"' && (t = strchr(s+1, '"'))) {
1598 while (!isSPACE(*t))
1602 while (SPACE_OR_TAB(*e) || *e == '\r' || *e == '\f')
1604 if (*e != '\n' && *e != '\0')
1605 return; /* false alarm */
1607 line_num = atoi(n)-1;
1610 const STRLEN len = t - s;
1611 SV *const temp_sv = CopFILESV(PL_curcop);
1616 cf = SvPVX(temp_sv);
1617 tmplen = SvCUR(temp_sv);
1623 if (!PL_rsfp && !PL_parser->filtered) {
1624 /* must copy *{"::_<(eval N)[oldfilename:L]"}
1625 * to *{"::_<newfilename"} */
1626 /* However, the long form of evals is only turned on by the
1627 debugger - usually they're "(eval %lu)" */
1631 STRLEN tmplen2 = len;
1632 if (tmplen + 2 <= sizeof smallbuf)
1635 Newx(tmpbuf, tmplen + 2, char);
1638 memcpy(tmpbuf + 2, cf, tmplen);
1640 gvp = (GV**)hv_fetch(PL_defstash, tmpbuf, tmplen, FALSE);
1645 if (tmplen2 + 2 <= sizeof smallbuf)
1648 Newx(tmpbuf2, tmplen2 + 2, char);
1650 if (tmpbuf2 != smallbuf || tmpbuf != smallbuf) {
1651 /* Either they malloc'd it, or we malloc'd it,
1652 so no prefix is present in ours. */
1657 memcpy(tmpbuf2 + 2, s, tmplen2);
1660 gv2 = *(GV**)hv_fetch(PL_defstash, tmpbuf2, tmplen2, TRUE);
1662 gv_init(gv2, PL_defstash, tmpbuf2, tmplen2, FALSE);
1663 /* adjust ${"::_<newfilename"} to store the new file name */
1664 GvSV(gv2) = newSVpvn(tmpbuf2 + 2, tmplen2 - 2);
1665 /* The line number may differ. If that is the case,
1666 alias the saved lines that are in the array.
1667 Otherwise alias the whole array. */
1668 if (CopLINE(PL_curcop) == line_num) {
1669 GvHV(gv2) = MUTABLE_HV(SvREFCNT_inc(GvHV(*gvp)));
1670 GvAV(gv2) = MUTABLE_AV(SvREFCNT_inc(GvAV(*gvp)));
1672 else if (GvAV(*gvp)) {
1673 AV * const av = GvAV(*gvp);
1674 const I32 start = CopLINE(PL_curcop)+1;
1675 I32 items = AvFILLp(av) - start;
1677 AV * const av2 = GvAVn(gv2);
1678 SV **svp = AvARRAY(av) + start;
1679 I32 l = (I32)line_num+1;
1681 av_store(av2, l++, SvREFCNT_inc(*svp++));
1686 if (tmpbuf2 != smallbuf) Safefree(tmpbuf2);
1688 if (tmpbuf != smallbuf) Safefree(tmpbuf);
1690 CopFILE_free(PL_curcop);
1691 CopFILE_setn(PL_curcop, s, len);
1693 CopLINE_set(PL_curcop, line_num);
1697 /* skip space before PL_thistoken */
1700 S_skipspace0(pTHX_ register char *s)
1702 PERL_ARGS_ASSERT_SKIPSPACE0;
1709 PL_thiswhite = newSVpvs("");
1710 sv_catsv(PL_thiswhite, PL_skipwhite);
1711 sv_free(PL_skipwhite);
1714 PL_realtokenstart = s - SvPVX(PL_linestr);
1718 /* skip space after PL_thistoken */
1721 S_skipspace1(pTHX_ register char *s)
1723 const char *start = s;
1724 I32 startoff = start - SvPVX(PL_linestr);
1726 PERL_ARGS_ASSERT_SKIPSPACE1;
1731 start = SvPVX(PL_linestr) + startoff;
1732 if (!PL_thistoken && PL_realtokenstart >= 0) {
1733 const char * const tstart = SvPVX(PL_linestr) + PL_realtokenstart;
1734 PL_thistoken = newSVpvn(tstart, start - tstart);
1736 PL_realtokenstart = -1;
1739 PL_nextwhite = newSVpvs("");
1740 sv_catsv(PL_nextwhite, PL_skipwhite);
1741 sv_free(PL_skipwhite);
1748 S_skipspace2(pTHX_ register char *s, SV **svp)
1751 const I32 bufptroff = PL_bufptr - SvPVX(PL_linestr);
1752 const I32 startoff = s - SvPVX(PL_linestr);
1754 PERL_ARGS_ASSERT_SKIPSPACE2;
1757 PL_bufptr = SvPVX(PL_linestr) + bufptroff;
1758 if (!PL_madskills || !svp)
1760 start = SvPVX(PL_linestr) + startoff;
1761 if (!PL_thistoken && PL_realtokenstart >= 0) {
1762 char * const tstart = SvPVX(PL_linestr) + PL_realtokenstart;
1763 PL_thistoken = newSVpvn(tstart, start - tstart);
1764 PL_realtokenstart = -1;
1768 *svp = newSVpvs("");
1769 sv_setsv(*svp, PL_skipwhite);
1770 sv_free(PL_skipwhite);
1779 S_update_debugger_info(pTHX_ SV *orig_sv, const char *const buf, STRLEN len)
1781 AV *av = CopFILEAVx(PL_curcop);
1783 SV * const sv = newSV_type(SVt_PVMG);
1785 sv_setsv(sv, orig_sv);
1787 sv_setpvn(sv, buf, len);
1790 av_store(av, (I32)CopLINE(PL_curcop), sv);
1796 * Called to gobble the appropriate amount and type of whitespace.
1797 * Skips comments as well.
1801 S_skipspace(pTHX_ register char *s)
1805 #endif /* PERL_MAD */
1806 PERL_ARGS_ASSERT_SKIPSPACE;
1809 sv_free(PL_skipwhite);
1810 PL_skipwhite = NULL;
1812 #endif /* PERL_MAD */
1813 if (PL_lex_formbrack && PL_lex_brackets <= PL_lex_formbrack) {
1814 while (s < PL_bufend && SPACE_OR_TAB(*s))
1817 STRLEN bufptr_pos = PL_bufptr - SvPVX(PL_linestr);
1819 lex_read_space(LEX_KEEP_PREVIOUS |
1820 (PL_sublex_info.sub_inwhat || PL_lex_state == LEX_FORMLINE ?
1821 LEX_NO_NEXT_CHUNK : 0));
1823 PL_bufptr = SvPVX(PL_linestr) + bufptr_pos;
1824 if (PL_linestart > PL_bufptr)
1825 PL_bufptr = PL_linestart;
1830 PL_skipwhite = newSVpvn(start, s-start);
1831 #endif /* PERL_MAD */
1837 * Check the unary operators to ensure there's no ambiguity in how they're
1838 * used. An ambiguous piece of code would be:
1840 * This doesn't mean rand() + 5. Because rand() is a unary operator,
1841 * the +5 is its argument.
1851 if (PL_oldoldbufptr != PL_last_uni)
1853 while (isSPACE(*PL_last_uni))
1856 while (isALNUM_lazy_if(s,UTF) || *s == '-')
1858 if ((t = strchr(s, '(')) && t < PL_bufptr)
1861 Perl_ck_warner_d(aTHX_ packWARN(WARN_AMBIGUOUS),
1862 "Warning: Use of \"%.*s\" without parentheses is ambiguous",
1863 (int)(s - PL_last_uni), PL_last_uni);
1867 * LOP : macro to build a list operator. Its behaviour has been replaced
1868 * with a subroutine, S_lop() for which LOP is just another name.
1871 #define LOP(f,x) return lop(f,x,s)
1875 * Build a list operator (or something that might be one). The rules:
1876 * - if we have a next token, then it's a list operator [why?]
1877 * - if the next thing is an opening paren, then it's a function
1878 * - else it's a list operator
1882 S_lop(pTHX_ I32 f, int x, char *s)
1886 PERL_ARGS_ASSERT_LOP;
1892 PL_last_lop = PL_oldbufptr;
1893 PL_last_lop_op = (OPCODE)f;
1902 return REPORT(FUNC);
1905 return REPORT(FUNC);
1908 if (!PL_lex_allbrackets && PL_lex_fakeeof > LEX_FAKEEOF_LOWLOGIC)
1909 PL_lex_fakeeof = LEX_FAKEEOF_LOWLOGIC;
1910 return REPORT(LSTOP);
1917 * Sets up for an eventual force_next(). start_force(0) basically does
1918 * an unshift, while start_force(-1) does a push. yylex removes items
1923 S_start_force(pTHX_ int where)
1927 if (where < 0) /* so people can duplicate start_force(PL_curforce) */
1928 where = PL_lasttoke;
1929 assert(PL_curforce < 0 || PL_curforce == where);
1930 if (PL_curforce != where) {
1931 for (i = PL_lasttoke; i > where; --i) {
1932 PL_nexttoke[i] = PL_nexttoke[i-1];
1936 if (PL_curforce < 0) /* in case of duplicate start_force() */
1937 Zero(&PL_nexttoke[where], 1, NEXTTOKE);
1938 PL_curforce = where;
1941 curmad('^', newSVpvs(""));
1942 CURMAD('_', PL_nextwhite);
1947 S_curmad(pTHX_ char slot, SV *sv)
1953 if (PL_curforce < 0)
1954 where = &PL_thismad;
1956 where = &PL_nexttoke[PL_curforce].next_mad;
1962 if (UTF && is_utf8_string((U8*)SvPVX(sv), SvCUR(sv)))
1964 else if (PL_encoding) {
1965 sv_recode_to_utf8(sv, PL_encoding);
1970 /* keep a slot open for the head of the list? */
1971 if (slot != '_' && *where && (*where)->mad_key == '^') {
1972 (*where)->mad_key = slot;
1973 sv_free(MUTABLE_SV(((*where)->mad_val)));
1974 (*where)->mad_val = (void*)sv;
1977 addmad(newMADsv(slot, sv), where, 0);
1980 # define start_force(where) NOOP
1981 # define curmad(slot, sv) NOOP
1986 * When the lexer realizes it knows the next token (for instance,
1987 * it is reordering tokens for the parser) then it can call S_force_next
1988 * to know what token to return the next time the lexer is called. Caller
1989 * will need to set PL_nextval[] (or PL_nexttoke[].next_val with PERL_MAD),
1990 * and possibly PL_expect to ensure the lexer handles the token correctly.
1994 S_force_next(pTHX_ I32 type)
1999 PerlIO_printf(Perl_debug_log, "### forced token:\n");
2000 tokereport(type, &NEXTVAL_NEXTTOKE);
2003 /* Don’t let opslab_force_free snatch it */
2004 if (S_is_opval_token(type & 0xffff) && NEXTVAL_NEXTTOKE.opval) {
2005 assert(!NEXTVAL_NEXTTOKE.opval->op_savefree);
2006 NEXTVAL_NEXTTOKE.opval->op_savefree = 1;
2009 if (PL_curforce < 0)
2010 start_force(PL_lasttoke);
2011 PL_nexttoke[PL_curforce].next_type = type;
2012 if (PL_lex_state != LEX_KNOWNEXT)
2013 PL_lex_defer = PL_lex_state;
2014 PL_lex_state = LEX_KNOWNEXT;
2015 PL_lex_expect = PL_expect;
2018 PL_nexttype[PL_nexttoke] = type;
2020 if (PL_lex_state != LEX_KNOWNEXT) {
2021 PL_lex_defer = PL_lex_state;
2022 PL_lex_expect = PL_expect;
2023 PL_lex_state = LEX_KNOWNEXT;
2031 int yyc = PL_parser->yychar;
2032 if (yyc != YYEMPTY) {
2035 NEXTVAL_NEXTTOKE = PL_parser->yylval;
2036 if (yyc == '{'/*}*/ || yyc == HASHBRACK || yyc == '['/*]*/) {
2037 PL_lex_allbrackets--;
2039 yyc |= (3<<24) | (PL_lex_brackstack[PL_lex_brackets] << 16);
2040 } else if (yyc == '('/*)*/) {
2041 PL_lex_allbrackets--;
2046 PL_parser->yychar = YYEMPTY;
2051 S_newSV_maybe_utf8(pTHX_ const char *const start, STRLEN len)
2054 SV * const sv = newSVpvn_utf8(start, len,
2057 && !is_ascii_string((const U8*)start, len)
2058 && is_utf8_string((const U8*)start, len));
2064 * When the lexer knows the next thing is a word (for instance, it has
2065 * just seen -> and it knows that the next char is a word char, then
2066 * it calls S_force_word to stick the next word into the PL_nexttoke/val
2070 * char *start : buffer position (must be within PL_linestr)
2071 * int token : PL_next* will be this type of bare word (e.g., METHOD,WORD)
2072 * int check_keyword : if true, Perl checks to make sure the word isn't
2073 * a keyword (do this if the word is a label, e.g. goto FOO)
2074 * int allow_pack : if true, : characters will also be allowed (require,
2075 * use, etc. do this)
2076 * int allow_initial_tick : used by the "sub" lexer only.
2080 S_force_word(pTHX_ register char *start, int token, int check_keyword, int allow_pack, int allow_initial_tick)
2086 PERL_ARGS_ASSERT_FORCE_WORD;
2088 start = SKIPSPACE1(start);
2090 if (isIDFIRST_lazy_if(s,UTF) ||
2091 (allow_pack && *s == ':') ||
2092 (allow_initial_tick && *s == '\'') )
2094 s = scan_word(s, PL_tokenbuf, sizeof PL_tokenbuf, allow_pack, &len);
2095 if (check_keyword && keyword(PL_tokenbuf, len, 0))
2097 start_force(PL_curforce);
2099 curmad('X', newSVpvn(start,s-start));
2100 if (token == METHOD) {
2105 PL_expect = XOPERATOR;
2109 curmad('g', newSVpvs( "forced" ));
2110 NEXTVAL_NEXTTOKE.opval
2111 = (OP*)newSVOP(OP_CONST,0,
2112 S_newSV_maybe_utf8(aTHX_ PL_tokenbuf, len));
2113 NEXTVAL_NEXTTOKE.opval->op_private |= OPpCONST_BARE;
2121 * Called when the lexer wants $foo *foo &foo etc, but the program
2122 * text only contains the "foo" portion. The first argument is a pointer
2123 * to the "foo", and the second argument is the type symbol to prefix.
2124 * Forces the next token to be a "WORD".
2125 * Creates the symbol if it didn't already exist (via gv_fetchpv()).
2129 S_force_ident(pTHX_ register const char *s, int kind)
2133 PERL_ARGS_ASSERT_FORCE_IDENT;
2136 const STRLEN len = strlen(s);
2137 OP* const o = (OP*)newSVOP(OP_CONST, 0, newSVpvn_flags(s, len,
2138 UTF ? SVf_UTF8 : 0));
2139 start_force(PL_curforce);
2140 NEXTVAL_NEXTTOKE.opval = o;
2143 o->op_private = OPpCONST_ENTERED;
2144 /* XXX see note in pp_entereval() for why we forgo typo
2145 warnings if the symbol must be introduced in an eval.
2147 gv_fetchpvn_flags(s, len,
2148 (PL_in_eval ? (GV_ADDMULTI | GV_ADDINEVAL)
2149 : GV_ADD) | ( UTF ? SVf_UTF8 : 0 ),
2150 kind == '$' ? SVt_PV :
2151 kind == '@' ? SVt_PVAV :
2152 kind == '%' ? SVt_PVHV :
2160 Perl_str_to_version(pTHX_ SV *sv)
2165 const char *start = SvPV_const(sv,len);
2166 const char * const end = start + len;
2167 const bool utf = SvUTF8(sv) ? TRUE : FALSE;
2169 PERL_ARGS_ASSERT_STR_TO_VERSION;
2171 while (start < end) {
2175 n = utf8n_to_uvchr((U8*)start, len, &skip, 0);
2180 retval += ((NV)n)/nshift;
2189 * Forces the next token to be a version number.
2190 * If the next token appears to be an invalid version number, (e.g. "v2b"),
2191 * and if "guessing" is TRUE, then no new token is created (and the caller
2192 * must use an alternative parsing method).
2196 S_force_version(pTHX_ char *s, int guessing)
2202 I32 startoff = s - SvPVX(PL_linestr);
2205 PERL_ARGS_ASSERT_FORCE_VERSION;
2213 while (isDIGIT(*d) || *d == '_' || *d == '.')
2217 start_force(PL_curforce);
2218 curmad('X', newSVpvn(s,d-s));
2221 if (*d == ';' || isSPACE(*d) || *d == '{' || *d == '}' || !*d) {
2223 #ifdef USE_LOCALE_NUMERIC
2224 char *loc = savepv(setlocale(LC_NUMERIC, NULL));
2225 setlocale(LC_NUMERIC, "C");
2227 s = scan_num(s, &pl_yylval);
2228 #ifdef USE_LOCALE_NUMERIC
2229 setlocale(LC_NUMERIC, loc);
2232 version = pl_yylval.opval;
2233 ver = cSVOPx(version)->op_sv;
2234 if (SvPOK(ver) && !SvNIOK(ver)) {
2235 SvUPGRADE(ver, SVt_PVNV);
2236 SvNV_set(ver, str_to_version(ver));
2237 SvNOK_on(ver); /* hint that it is a version */
2240 else if (guessing) {
2243 sv_free(PL_nextwhite); /* let next token collect whitespace */
2245 s = SvPVX(PL_linestr) + startoff;
2253 if (PL_madskills && !version) {
2254 sv_free(PL_nextwhite); /* let next token collect whitespace */
2256 s = SvPVX(PL_linestr) + startoff;
2259 /* NOTE: The parser sees the package name and the VERSION swapped */
2260 start_force(PL_curforce);
2261 NEXTVAL_NEXTTOKE.opval = version;
2268 * S_force_strict_version
2269 * Forces the next token to be a version number using strict syntax rules.
2273 S_force_strict_version(pTHX_ char *s)
2278 I32 startoff = s - SvPVX(PL_linestr);
2280 const char *errstr = NULL;
2282 PERL_ARGS_ASSERT_FORCE_STRICT_VERSION;
2284 while (isSPACE(*s)) /* leading whitespace */
2287 if (is_STRICT_VERSION(s,&errstr)) {
2289 s = (char *)scan_version(s, ver, 0);
2290 version = newSVOP(OP_CONST, 0, ver);
2292 else if ( (*s != ';' && *s != '{' && *s != '}' ) &&
2293 (s = SKIPSPACE1(s), (*s != ';' && *s != '{' && *s != '}' )))
2297 yyerror(errstr); /* version required */
2302 if (PL_madskills && !version) {
2303 sv_free(PL_nextwhite); /* let next token collect whitespace */
2305 s = SvPVX(PL_linestr) + startoff;
2308 /* NOTE: The parser sees the package name and the VERSION swapped */
2309 start_force(PL_curforce);
2310 NEXTVAL_NEXTTOKE.opval = version;
2318 * Tokenize a quoted string passed in as an SV. It finds the next
2319 * chunk, up to end of string or a backslash. It may make a new
2320 * SV containing that chunk (if HINT_NEW_STRING is on). It also
2325 S_tokeq(pTHX_ SV *sv)
2334 PERL_ARGS_ASSERT_TOKEQ;
2339 s = SvPV_force(sv, len);
2340 if (SvTYPE(sv) >= SVt_PVIV && SvIVX(sv) == -1)
2343 /* This is relying on the SV being "well formed" with a trailing '\0' */
2344 while (s < send && !(*s == '\\' && s[1] == '\\'))
2349 if ( PL_hints & HINT_NEW_STRING ) {
2350 pv = newSVpvn_flags(SvPVX_const(pv), len, SVs_TEMP | SvUTF8(sv));
2354 if (s + 1 < send && (s[1] == '\\'))
2355 s++; /* all that, just for this */
2360 SvCUR_set(sv, d - SvPVX_const(sv));
2362 if ( PL_hints & HINT_NEW_STRING )
2363 return new_constant(NULL, 0, "q", sv, pv, "q", 1);
2368 * Now come three functions related to double-quote context,
2369 * S_sublex_start, S_sublex_push, and S_sublex_done. They're used when
2370 * converting things like "\u\Lgnat" into ucfirst(lc("gnat")). They
2371 * interact with PL_lex_state, and create fake ( ... ) argument lists
2372 * to handle functions and concatenation.
2376 * stringify ( const[foo] concat lcfirst ( const[bar] ) )
2381 * Assumes that pl_yylval.ival is the op we're creating (e.g. OP_LCFIRST).
2383 * Pattern matching will set PL_lex_op to the pattern-matching op to
2384 * make (we return THING if pl_yylval.ival is OP_NULL, PMFUNC otherwise).
2386 * OP_CONST and OP_READLINE are easy--just make the new op and return.
2388 * Everything else becomes a FUNC.
2390 * Sets PL_lex_state to LEX_INTERPPUSH unless (ival was OP_NULL or we
2391 * had an OP_CONST or OP_READLINE). This just sets us up for a
2392 * call to S_sublex_push().
2396 S_sublex_start(pTHX)
2399 const I32 op_type = pl_yylval.ival;
2401 if (op_type == OP_NULL) {
2402 pl_yylval.opval = PL_lex_op;
2406 if (op_type == OP_CONST || op_type == OP_READLINE) {
2407 SV *sv = tokeq(PL_lex_stuff);
2409 if (SvTYPE(sv) == SVt_PVIV) {
2410 /* Overloaded constants, nothing fancy: Convert to SVt_PV: */
2412 const char * const p = SvPV_const(sv, len);
2413 SV * const nsv = newSVpvn_flags(p, len, SvUTF8(sv));
2417 pl_yylval.opval = (OP*)newSVOP(op_type, 0, sv);
2418 PL_lex_stuff = NULL;
2419 /* Allow <FH> // "foo" */
2420 if (op_type == OP_READLINE)
2421 PL_expect = XTERMORDORDOR;
2424 else if (op_type == OP_BACKTICK && PL_lex_op) {
2425 /* readpipe() vas overriden */
2426 cSVOPx(cLISTOPx(cUNOPx(PL_lex_op)->op_first)->op_first->op_sibling)->op_sv = tokeq(PL_lex_stuff);
2427 pl_yylval.opval = PL_lex_op;
2429 PL_lex_stuff = NULL;
2433 PL_sublex_info.super_state = PL_lex_state;
2434 PL_sublex_info.sub_inwhat = (U16)op_type;
2435 PL_sublex_info.sub_op = PL_lex_op;
2436 PL_lex_state = LEX_INTERPPUSH;
2440 pl_yylval.opval = PL_lex_op;
2450 * Create a new scope to save the lexing state. The scope will be
2451 * ended in S_sublex_done. Returns a '(', starting the function arguments
2452 * to the uc, lc, etc. found before.
2453 * Sets PL_lex_state to LEX_INTERPCONCAT.
2462 PL_lex_state = PL_sublex_info.super_state;
2463 SAVEBOOL(PL_lex_dojoin);
2464 SAVEI32(PL_lex_brackets);
2465 SAVEI32(PL_lex_allbrackets);
2466 SAVEI32(PL_lex_formbrack);
2467 SAVEI8(PL_lex_fakeeof);
2468 SAVEI32(PL_lex_casemods);
2469 SAVEI32(PL_lex_starts);
2470 SAVEI8(PL_lex_state);
2471 SAVESPTR(PL_lex_repl);
2472 SAVEPPTR(PL_sublex_info.re_eval_start);
2473 SAVESPTR(PL_sublex_info.re_eval_str);
2474 SAVEPPTR(PL_sublex_info.super_bufptr);
2475 SAVEVPTR(PL_lex_inpat);
2476 SAVEI16(PL_lex_inwhat);
2477 SAVECOPLINE(PL_curcop);
2478 SAVEPPTR(PL_bufptr);
2479 SAVEPPTR(PL_bufend);
2480 SAVEPPTR(PL_oldbufptr);
2481 SAVEPPTR(PL_oldoldbufptr);
2482 SAVEPPTR(PL_last_lop);
2483 SAVEPPTR(PL_last_uni);
2484 SAVEPPTR(PL_linestart);
2485 SAVESPTR(PL_linestr);
2486 SAVEGENERICPV(PL_lex_brackstack);
2487 SAVEGENERICPV(PL_lex_casestack);
2489 /* The here-doc parser needs to be able to peek into outer lexing
2490 scopes to find the body of the here-doc. We use SvIVX(PL_linestr)
2491 to store the outer PL_bufptr and SvNVX to store the outer
2492 PL_linestr. Since SvIVX already means something else, we use
2493 PL_sublex_info.super_bufptr for the innermost scope (the one we are
2494 now entering), and a localised SvIVX for outer scopes.
2496 SvUPGRADE(PL_linestr, SVt_PVIV);
2497 /* A null super_bufptr means the outer lexing scope is not peekable,
2498 because it is a single line from an input stream. */
2499 SAVEIV(SvIVX(PL_linestr));
2500 SvIVX(PL_linestr) = PTR2IV(PL_sublex_info.super_bufptr);
2501 PL_sublex_info.super_bufptr =
2502 (SvTYPE(PL_linestr) < SVt_PVNV || !SvNVX(PL_linestr))
2503 && (PL_rsfp || PL_parser->filtered)
2506 SvUPGRADE(PL_lex_stuff, SVt_PVNV);
2507 SvNVX(PL_lex_stuff) = PTR2NV(PL_linestr);
2509 PL_linestr = PL_lex_stuff;
2510 PL_lex_repl = PL_sublex_info.repl;
2511 PL_lex_stuff = NULL;
2512 PL_sublex_info.repl = NULL;
2513 PL_sublex_info.re_eval_start = NULL;
2514 PL_sublex_info.re_eval_str = NULL;
2516 PL_bufend = PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart
2517 = SvPVX(PL_linestr);
2518 PL_bufend += SvCUR(PL_linestr);
2519 PL_last_lop = PL_last_uni = NULL;
2520 SAVEFREESV(PL_linestr);
2522 PL_lex_dojoin = FALSE;
2523 PL_lex_brackets = PL_lex_formbrack = 0;
2524 PL_lex_allbrackets = 0;
2525 PL_lex_fakeeof = LEX_FAKEEOF_NEVER;
2526 Newx(PL_lex_brackstack, 120, char);
2527 Newx(PL_lex_casestack, 12, char);
2528 PL_lex_casemods = 0;
2529 *PL_lex_casestack = '\0';
2531 PL_lex_state = LEX_INTERPCONCAT;
2532 CopLINE_set(PL_curcop, (line_t)PL_multi_start);
2534 PL_lex_inwhat = PL_sublex_info.sub_inwhat;
2535 if (PL_lex_inwhat == OP_TRANSR) PL_lex_inwhat = OP_TRANS;
2536 if (PL_lex_inwhat == OP_MATCH || PL_lex_inwhat == OP_QR || PL_lex_inwhat == OP_SUBST)
2537 PL_lex_inpat = PL_sublex_info.sub_op;
2539 PL_lex_inpat = NULL;
2546 * Restores lexer state after a S_sublex_push.
2553 if (!PL_lex_starts++) {
2554 SV * const sv = newSVpvs("");
2555 if (SvUTF8(PL_linestr))
2557 PL_expect = XOPERATOR;
2558 pl_yylval.opval = (OP*)newSVOP(OP_CONST, 0, sv);
2562 if (PL_lex_casemods) { /* oops, we've got some unbalanced parens */
2563 PL_lex_state = LEX_INTERPCASEMOD;
2567 /* Is there a right-hand side to take care of? (s//RHS/ or tr//RHS/) */
2568 assert(PL_lex_inwhat != OP_TRANSR);
2569 if (PL_lex_repl && (PL_lex_inwhat == OP_SUBST || PL_lex_inwhat == OP_TRANS)) {
2570 SvUPGRADE(PL_lex_repl, SVt_PVNV);
2571 SvNVX(PL_lex_repl) = SvNVX(PL_linestr);
2572 PL_linestr = PL_lex_repl;
2574 PL_bufend = PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
2575 PL_bufend += SvCUR(PL_linestr);
2576 PL_last_lop = PL_last_uni = NULL;
2577 SAVEFREESV(PL_linestr);
2578 PL_lex_dojoin = FALSE;
2579 PL_lex_brackets = 0;
2580 PL_lex_allbrackets = 0;
2581 PL_lex_fakeeof = LEX_FAKEEOF_NEVER;
2582 PL_lex_casemods = 0;
2583 *PL_lex_casestack = '\0';
2585 if (SvEVALED(PL_lex_repl)) {
2586 PL_lex_state = LEX_INTERPNORMAL;
2588 /* we don't clear PL_lex_repl here, so that we can check later
2589 whether this is an evalled subst; that means we rely on the
2590 logic to ensure sublex_done() is called again only via the
2591 branch (in yylex()) that clears PL_lex_repl, else we'll loop */
2594 PL_lex_state = LEX_INTERPCONCAT;
2604 PL_endwhite = newSVpvs("");
2605 sv_catsv(PL_endwhite, PL_thiswhite);
2609 sv_setpvs(PL_thistoken,"");
2611 PL_realtokenstart = -1;
2615 PL_bufend = SvPVX(PL_linestr);
2616 PL_bufend += SvCUR(PL_linestr);
2617 PL_expect = XOPERATOR;
2618 PL_sublex_info.sub_inwhat = 0;
2626 Extracts the next constant part of a pattern, double-quoted string,
2627 or transliteration. This is terrifying code.
2629 For example, in parsing the double-quoted string "ab\x63$d", it would
2630 stop at the '$' and return an OP_CONST containing 'abc'.
2632 It looks at PL_lex_inwhat and PL_lex_inpat to find out whether it's
2633 processing a pattern (PL_lex_inpat is true), a transliteration
2634 (PL_lex_inwhat == OP_TRANS is true), or a double-quoted string.
2636 Returns a pointer to the character scanned up to. If this is
2637 advanced from the start pointer supplied (i.e. if anything was
2638 successfully parsed), will leave an OP_CONST for the substring scanned
2639 in pl_yylval. Caller must intuit reason for not parsing further
2640 by looking at the next characters herself.
2644 \N{ABC} => \N{U+41.42.43}
2647 all other \-char, including \N and \N{ apart from \N{ABC}
2650 @ and $ where it appears to be a var, but not for $ as tail anchor
2655 In transliterations:
2656 characters are VERY literal, except for - not at the start or end
2657 of the string, which indicates a range. If the range is in bytes,
2658 scan_const expands the range to the full set of intermediate
2659 characters. If the range is in utf8, the hyphen is replaced with
2660 a certain range mark which will be handled by pmtrans() in op.c.
2662 In double-quoted strings:
2664 double-quoted style: \r and \n
2665 constants: \x31, etc.
2666 deprecated backrefs: \1 (in substitution replacements)
2667 case and quoting: \U \Q \E
2670 scan_const does *not* construct ops to handle interpolated strings.
2671 It stops processing as soon as it finds an embedded $ or @ variable
2672 and leaves it to the caller to work out what's going on.
2674 embedded arrays (whether in pattern or not) could be:
2675 @foo, @::foo, @'foo, @{foo}, @$foo, @+, @-.
2677 $ in double-quoted strings must be the symbol of an embedded scalar.
2679 $ in pattern could be $foo or could be tail anchor. Assumption:
2680 it's a tail anchor if $ is the last thing in the string, or if it's
2681 followed by one of "()| \r\n\t"
2683 \1 (backreferences) are turned into $1 in substitutions
2685 The structure of the code is
2686 while (there's a character to process) {
2687 handle transliteration ranges
2688 skip regexp comments /(?#comment)/ and codes /(?{code})/
2689 skip #-initiated comments in //x patterns
2690 check for embedded arrays
2691 check for embedded scalars
2693 deprecate \1 in substitution replacements
2694 handle string-changing backslashes \l \U \Q \E, etc.
2695 switch (what was escaped) {
2696 handle \- in a transliteration (becomes a literal -)
2697 if a pattern and not \N{, go treat as regular character
2698 handle \132 (octal characters)
2699 handle \x15 and \x{1234} (hex characters)
2700 handle \N{name} (named characters, also \N{3,5} in a pattern)
2701 handle \cV (control characters)
2702 handle printf-style backslashes (\f, \r, \n, etc)
2705 } (end if backslash)
2706 handle regular character
2707 } (end while character to read)
2712 S_scan_const(pTHX_ char *start)
2715 char *send = PL_bufend; /* end of the constant */
2716 SV *sv = newSV(send - start); /* sv for the constant. See
2717 note below on sizing. */
2718 char *s = start; /* start of the constant */
2719 char *d = SvPVX(sv); /* destination for copies */
2720 bool dorange = FALSE; /* are we in a translit range? */
2721 bool didrange = FALSE; /* did we just finish a range? */
2722 bool in_charclass = FALSE; /* within /[...]/ */
2723 bool has_utf8 = FALSE; /* Output constant is UTF8 */
2724 bool this_utf8 = cBOOL(UTF); /* Is the source string assumed
2725 to be UTF8? But, this can
2726 show as true when the source
2727 isn't utf8, as for example
2728 when it is entirely composed
2731 /* Note on sizing: The scanned constant is placed into sv, which is
2732 * initialized by newSV() assuming one byte of output for every byte of
2733 * input. This routine expects newSV() to allocate an extra byte for a
2734 * trailing NUL, which this routine will append if it gets to the end of
2735 * the input. There may be more bytes of input than output (eg., \N{LATIN
2736 * CAPITAL LETTER A}), or more output than input if the constant ends up
2737 * recoded to utf8, but each time a construct is found that might increase
2738 * the needed size, SvGROW() is called. Its size parameter each time is
2739 * based on the best guess estimate at the time, namely the length used so
2740 * far, plus the length the current construct will occupy, plus room for
2741 * the trailing NUL, plus one byte for every input byte still unscanned */
2745 UV literal_endpoint = 0;
2746 bool native_range = TRUE; /* turned to FALSE if the first endpoint is Unicode. */
2749 PERL_ARGS_ASSERT_SCAN_CONST;
2751 assert(PL_lex_inwhat != OP_TRANSR);
2752 if (PL_lex_inwhat == OP_TRANS && PL_sublex_info.sub_op) {
2753 /* If we are doing a trans and we know we want UTF8 set expectation */
2754 has_utf8 = PL_sublex_info.sub_op->op_private & (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF);
2755 this_utf8 = PL_sublex_info.sub_op->op_private & (PL_lex_repl ? OPpTRANS_FROM_UTF : OPpTRANS_TO_UTF);
2759 while (s < send || dorange) {
2761 /* get transliterations out of the way (they're most literal) */
2762 if (PL_lex_inwhat == OP_TRANS) {
2763 /* expand a range A-Z to the full set of characters. AIE! */
2765 I32 i; /* current expanded character */
2766 I32 min; /* first character in range */
2767 I32 max; /* last character in range */
2778 char * const c = (char*)utf8_hop((U8*)d, -1);
2782 *c = (char)UTF_TO_NATIVE(0xff);
2783 /* mark the range as done, and continue */
2789 i = d - SvPVX_const(sv); /* remember current offset */
2792 SvLEN(sv) + (has_utf8 ?
2793 (512 - UTF_CONTINUATION_MARK +
2796 /* How many two-byte within 0..255: 128 in UTF-8,
2797 * 96 in UTF-8-mod. */
2799 SvGROW(sv, SvLEN(sv) + 256); /* never more than 256 chars in a range */
2801 d = SvPVX(sv) + i; /* refresh d after realloc */
2805 for (j = 0; j <= 1; j++) {
2806 char * const c = (char*)utf8_hop((U8*)d, -1);
2807 const UV uv = utf8n_to_uvchr((U8*)c, d - c, NULL, 0);
2813 max = (U8)0xff; /* only to \xff */
2814 uvmax = uv; /* \x{100} to uvmax */
2816 d = c; /* eat endpoint chars */
2821 d -= 2; /* eat the first char and the - */
2822 min = (U8)*d; /* first char in range */
2823 max = (U8)d[1]; /* last char in range */
2830 "Invalid range \"%c-%c\" in transliteration operator",
2831 (char)min, (char)max);
2835 if (literal_endpoint == 2 &&
2836 ((isLOWER(min) && isLOWER(max)) ||
2837 (isUPPER(min) && isUPPER(max)))) {
2839 for (i = min; i <= max; i++)
2841 *d++ = NATIVE_TO_NEED(has_utf8,i);
2843 for (i = min; i <= max; i++)
2845 *d++ = NATIVE_TO_NEED(has_utf8,i);
2850 for (i = min; i <= max; i++)
2853 const U8 ch = (U8)NATIVE_TO_UTF(i);
2854 if (UNI_IS_INVARIANT(ch))
2857 *d++ = (U8)UTF8_EIGHT_BIT_HI(ch);
2858 *d++ = (U8)UTF8_EIGHT_BIT_LO(ch);
2867 d = (char*)uvchr_to_utf8((U8*)d, 0x100);
2869 *d++ = (char)UTF_TO_NATIVE(0xff);
2871 d = (char*)uvchr_to_utf8((U8*)d, uvmax);
2875 /* mark the range as done, and continue */
2879 literal_endpoint = 0;
2884 /* range begins (ignore - as first or last char) */
2885 else if (*s == '-' && s+1 < send && s != start) {
2887 Perl_croak(aTHX_ "Ambiguous range in transliteration operator");
2894 *d++ = (char)UTF_TO_NATIVE(0xff); /* use illegal utf8 byte--see pmtrans */
2904 literal_endpoint = 0;
2905 native_range = TRUE;
2910 /* if we get here, we're not doing a transliteration */
2912 else if (*s == '[' && PL_lex_inpat && !in_charclass) {
2915 while (s1 >= start && *s1-- == '\\')
2918 in_charclass = TRUE;
2921 else if (*s == ']' && PL_lex_inpat && in_charclass) {
2924 while (s1 >= start && *s1-- == '\\')
2927 in_charclass = FALSE;
2930 /* skip for regexp comments /(?#comment)/, except for the last
2931 * char, which will be done separately.
2932 * Stop on (?{..}) and friends */
2934 else if (*s == '(' && PL_lex_inpat && s[1] == '?') {
2936 while (s+1 < send && *s != ')')
2937 *d++ = NATIVE_TO_NEED(has_utf8,*s++);
2939 else if (!PL_lex_casemods && !in_charclass &&
2940 ( s[2] == '{' /* This should match regcomp.c */
2941 || (s[2] == '?' && s[3] == '{')))
2947 /* likewise skip #-initiated comments in //x patterns */
2948 else if (*s == '#' && PL_lex_inpat &&
2949 ((PMOP*)PL_lex_inpat)->op_pmflags & RXf_PMf_EXTENDED) {
2950 while (s+1 < send && *s != '\n')
2951 *d++ = NATIVE_TO_NEED(has_utf8,*s++);
2954 /* no further processing of single-quoted regex */
2955 else if (PL_lex_inpat && SvIVX(PL_linestr) == '\'')
2956 goto default_action;
2958 /* check for embedded arrays
2959 (@foo, @::foo, @'foo, @{foo}, @$foo, @+, @-)
2961 else if (*s == '@' && s[1]) {
2962 if (isALNUM_lazy_if(s+1,UTF))
2964 if (strchr(":'{$", s[1]))
2966 if (!PL_lex_inpat && (s[1] == '+' || s[1] == '-'))
2967 break; /* in regexp, neither @+ nor @- are interpolated */
2970 /* check for embedded scalars. only stop if we're sure it's a
2973 else if (*s == '$') {
2974 if (!PL_lex_inpat) /* not a regexp, so $ must be var */
2976 if (s + 1 < send && !strchr("()| \r\n\t", s[1])) {
2978 Perl_ck_warner(aTHX_ packWARN(WARN_AMBIGUOUS),
2979 "Possible unintended interpolation of $\\ in regex");
2981 break; /* in regexp, $ might be tail anchor */
2985 /* End of else if chain - OP_TRANS rejoin rest */
2988 if (*s == '\\' && s+1 < send) {
2989 char* e; /* Can be used for ending '}', etc. */
2993 /* warn on \1 - \9 in substitution replacements, but note that \11
2994 * is an octal; and \19 is \1 followed by '9' */
2995 if (PL_lex_inwhat == OP_SUBST && !PL_lex_inpat &&
2996 isDIGIT(*s) && *s != '0' && !isDIGIT(s[1]))
2998 Perl_ck_warner(aTHX_ packWARN(WARN_SYNTAX), "\\%c better written as $%c", *s, *s);
3003 /* string-change backslash escapes */
3004 if (PL_lex_inwhat != OP_TRANS && *s && strchr("lLuUEQF", *s)) {
3008 /* In a pattern, process \N, but skip any other backslash escapes.
3009 * This is because we don't want to translate an escape sequence
3010 * into a meta symbol and have the regex compiler use the meta
3011 * symbol meaning, e.g. \x{2E} would be confused with a dot. But
3012 * in spite of this, we do have to process \N here while the proper
3013 * charnames handler is in scope. See bugs #56444 and #62056.
3014 * There is a complication because \N in a pattern may also stand
3015 * for 'match a non-nl', and not mean a charname, in which case its
3016 * processing should be deferred to the regex compiler. To be a
3017 * charname it must be followed immediately by a '{', and not look
3018 * like \N followed by a curly quantifier, i.e., not something like
3019 * \N{3,}. regcurly returns a boolean indicating if it is a legal
3021 else if (PL_lex_inpat
3024 || regcurly(s + 1)))
3026 *d++ = NATIVE_TO_NEED(has_utf8,'\\');
3027 goto default_action;
3032 /* quoted - in transliterations */
3034 if (PL_lex_inwhat == OP_TRANS) {
3042 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
3043 "Unrecognized escape \\%c passed through",
3045 /* default action is to copy the quoted character */
3046 goto default_action;
3049 /* eg. \132 indicates the octal constant 0132 */
3050 case '0': case '1': case '2': case '3':
3051 case '4': case '5': case '6': case '7':
3055 uv = NATIVE_TO_UNI(grok_oct(s, &len, &flags, NULL));
3058 goto NUM_ESCAPE_INSERT;
3060 /* eg. \o{24} indicates the octal constant \024 */
3066 bool valid = grok_bslash_o(s, &uv, &len, &error, 1);
3072 goto NUM_ESCAPE_INSERT;
3075 /* eg. \x24 indicates the hex constant 0x24 */
3081 bool valid = grok_bslash_x(s, &uv, &len, &error, 1);
3090 /* Insert oct or hex escaped character. There will always be
3091 * enough room in sv since such escapes will be longer than any
3092 * UTF-8 sequence they can end up as, except if they force us
3093 * to recode the rest of the string into utf8 */
3095 /* Here uv is the ordinal of the next character being added in
3096 * unicode (converted from native). */
3097 if (!UNI_IS_INVARIANT(uv)) {
3098 if (!has_utf8 && uv > 255) {
3099 /* Might need to recode whatever we have accumulated so
3100 * far if it contains any chars variant in utf8 or
3103 SvCUR_set(sv, d - SvPVX_const(sv));
3106 /* See Note on sizing above. */
3107 sv_utf8_upgrade_flags_grow(sv,
3108 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3109 UNISKIP(uv) + (STRLEN)(send - s) + 1);
3110 d = SvPVX(sv) + SvCUR(sv);
3115 d = (char*)uvuni_to_utf8((U8*)d, uv);
3116 if (PL_lex_inwhat == OP_TRANS &&
3117 PL_sublex_info.sub_op) {
3118 PL_sublex_info.sub_op->op_private |=
3119 (PL_lex_repl ? OPpTRANS_FROM_UTF
3123 if (uv > 255 && !dorange)
3124 native_range = FALSE;
3137 /* In a non-pattern \N must be a named character, like \N{LATIN
3138 * SMALL LETTER A} or \N{U+0041}. For patterns, it also can
3139 * mean to match a non-newline. For non-patterns, named
3140 * characters are converted to their string equivalents. In
3141 * patterns, named characters are not converted to their
3142 * ultimate forms for the same reasons that other escapes
3143 * aren't. Instead, they are converted to the \N{U+...} form
3144 * to get the value from the charnames that is in effect right
3145 * now, while preserving the fact that it was a named character
3146 * so that the regex compiler knows this */
3148 /* This section of code doesn't generally use the
3149 * NATIVE_TO_NEED() macro to transform the input. I (khw) did
3150 * a close examination of this macro and determined it is a
3151 * no-op except on utfebcdic variant characters. Every
3152 * character generated by this that would normally need to be
3153 * enclosed by this macro is invariant, so the macro is not
3154 * needed, and would complicate use of copy(). XXX There are
3155 * other parts of this file where the macro is used
3156 * inconsistently, but are saved by it being a no-op */
3158 /* The structure of this section of code (besides checking for
3159 * errors and upgrading to utf8) is:
3160 * Further disambiguate between the two meanings of \N, and if
3161 * not a charname, go process it elsewhere
3162 * If of form \N{U+...}, pass it through if a pattern;
3163 * otherwise convert to utf8
3164 * Otherwise must be \N{NAME}: convert to \N{U+c1.c2...} if a
3165 * pattern; otherwise convert to utf8 */
3167 /* Here, s points to the 'N'; the test below is guaranteed to
3168 * succeed if we are being called on a pattern as we already
3169 * know from a test above that the next character is a '{'.
3170 * On a non-pattern \N must mean 'named sequence, which
3171 * requires braces */
3174 yyerror("Missing braces on \\N{}");
3179 /* If there is no matching '}', it is an error. */
3180 if (! (e = strchr(s, '}'))) {
3181 if (! PL_lex_inpat) {
3182 yyerror("Missing right brace on \\N{}");
3184 yyerror("Missing right brace on \\N{} or unescaped left brace after \\N.");
3189 /* Here it looks like a named character */
3193 /* XXX This block is temporary code. \N{} implies that the
3194 * pattern is to have Unicode semantics, and therefore
3195 * currently has to be encoded in utf8. By putting it in
3196 * utf8 now, we save a whole pass in the regular expression
3197 * compiler. Once that code is changed so Unicode
3198 * semantics doesn't necessarily have to be in utf8, this
3199 * block should be removed. However, the code that parses
3200 * the output of this would have to be changed to not
3201 * necessarily expect utf8 */
3203 SvCUR_set(sv, d - SvPVX_const(sv));
3206 /* See Note on sizing above. */
3207 sv_utf8_upgrade_flags_grow(sv,
3208 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3209 /* 5 = '\N{' + cur char + NUL */
3210 (STRLEN)(send - s) + 5);
3211 d = SvPVX(sv) + SvCUR(sv);
3216 if (*s == 'U' && s[1] == '+') { /* \N{U+...} */
3217 I32 flags = PERL_SCAN_ALLOW_UNDERSCORES
3218 | PERL_SCAN_DISALLOW_PREFIX;
3221 /* For \N{U+...}, the '...' is a unicode value even on
3222 * EBCDIC machines */
3223 s += 2; /* Skip to next char after the 'U+' */
3225 uv = grok_hex(s, &len, &flags, NULL);
3226 if (len == 0 || len != (STRLEN)(e - s)) {
3227 yyerror("Invalid hexadecimal number in \\N{U+...}");
3234 /* On non-EBCDIC platforms, pass through to the regex
3235 * compiler unchanged. The reason we evaluated the
3236 * number above is to make sure there wasn't a syntax
3237 * error. But on EBCDIC we convert to native so
3238 * downstream code can continue to assume it's native
3240 s -= 5; /* Include the '\N{U+' */
3242 d += my_snprintf(d, e - s + 1 + 1, /* includes the }
3245 (unsigned int) UNI_TO_NATIVE(uv));
3247 Copy(s, d, e - s + 1, char); /* 1 = include the } */
3251 else { /* Not a pattern: convert the hex to string */
3253 /* If destination is not in utf8, unconditionally
3254 * recode it to be so. This is because \N{} implies
3255 * Unicode semantics, and scalars have to be in utf8
3256 * to guarantee those semantics */
3258 SvCUR_set(sv, d - SvPVX_const(sv));
3261 /* See Note on sizing above. */
3262 sv_utf8_upgrade_flags_grow(
3264 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3265 UNISKIP(uv) + (STRLEN)(send - e) + 1);
3266 d = SvPVX(sv) + SvCUR(sv);
3270 /* Add the string to the output */
3271 if (UNI_IS_INVARIANT(uv)) {
3274 else d = (char*)uvuni_to_utf8((U8*)d, uv);
3277 else { /* Here is \N{NAME} but not \N{U+...}. */
3279 SV *res; /* result from charnames */
3280 const char *str; /* the string in 'res' */
3281 STRLEN len; /* its length */
3283 /* Get the value for NAME */
3284 res = newSVpvn(s, e - s);
3285 res = new_constant( NULL, 0, "charnames",
3286 /* includes all of: \N{...} */
3287 res, NULL, s - 3, e - s + 4 );
3289 /* Most likely res will be in utf8 already since the
3290 * standard charnames uses pack U, but a custom translator
3291 * can leave it otherwise, so make sure. XXX This can be
3292 * revisited to not have charnames use utf8 for characters
3293 * that don't need it when regexes don't have to be in utf8
3294 * for Unicode semantics. If doing so, remember EBCDIC */
3295 sv_utf8_upgrade(res);
3296 str = SvPV_const(res, len);
3298 /* Don't accept malformed input */
3299 if (! is_utf8_string((U8 *) str, len)) {
3300 yyerror("Malformed UTF-8 returned by \\N");
3302 else if (PL_lex_inpat) {
3304 if (! len) { /* The name resolved to an empty string */
3305 Copy("\\N{}", d, 4, char);
3309 /* In order to not lose information for the regex
3310 * compiler, pass the result in the specially made
3311 * syntax: \N{U+c1.c2.c3...}, where c1 etc. are
3312 * the code points in hex of each character
3313 * returned by charnames */
3315 const char *str_end = str + len;
3316 STRLEN char_length; /* cur char's byte length */
3317 STRLEN output_length; /* and the number of bytes
3318 after this is translated
3320 const STRLEN off = d - SvPVX_const(sv);
3322 /* 2 hex per byte; 2 chars for '\N'; 2 chars for
3323 * max('U+', '.'); and 1 for NUL */
3324 char hex_string[2 * UTF8_MAXBYTES + 5];
3326 /* Get the first character of the result. */
3327 U32 uv = utf8n_to_uvuni((U8 *) str,
3332 /* The call to is_utf8_string() above hopefully
3333 * guarantees that there won't be an error. But
3334 * it's easy here to make sure. The function just
3335 * above warns and returns 0 if invalid utf8, but
3336 * it can also return 0 if the input is validly a
3337 * NUL. Disambiguate */
3338 if (uv == 0 && NATIVE_TO_ASCII(*str) != '\0') {
3339 uv = UNICODE_REPLACEMENT;
3342 /* Convert first code point to hex, including the
3343 * boiler plate before it. For all these, we
3344 * convert to native format so that downstream code
3345 * can continue to assume the input is native */
3347 my_snprintf(hex_string, sizeof(hex_string),
3349 (unsigned int) UNI_TO_NATIVE(uv));
3351 /* Make sure there is enough space to hold it */
3352 d = off + SvGROW(sv, off
3354 + (STRLEN)(send - e)
3355 + 2); /* '}' + NUL */
3357 Copy(hex_string, d, output_length, char);
3360 /* For each subsequent character, append dot and
3361 * its ordinal in hex */
3362 while ((str += char_length) < str_end) {
3363 const STRLEN off = d - SvPVX_const(sv);
3364 U32 uv = utf8n_to_uvuni((U8 *) str,
3368 if (uv == 0 && NATIVE_TO_ASCII(*str) != '\0') {
3369 uv = UNICODE_REPLACEMENT;
3373 my_snprintf(hex_string, sizeof(hex_string),
3375 (unsigned int) UNI_TO_NATIVE(uv));
3377 d = off + SvGROW(sv, off
3379 + (STRLEN)(send - e)
3380 + 2); /* '}' + NUL */
3381 Copy(hex_string, d, output_length, char);
3385 *d++ = '}'; /* Done. Add the trailing brace */
3388 else { /* Here, not in a pattern. Convert the name to a
3391 /* If destination is not in utf8, unconditionally
3392 * recode it to be so. This is because \N{} implies
3393 * Unicode semantics, and scalars have to be in utf8
3394 * to guarantee those semantics */
3396 SvCUR_set(sv, d - SvPVX_const(sv));
3399 /* See Note on sizing above. */
3400 sv_utf8_upgrade_flags_grow(sv,
3401 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3402 len + (STRLEN)(send - s) + 1);
3403 d = SvPVX(sv) + SvCUR(sv);
3405 } else if (len > (STRLEN)(e - s + 4)) { /* I _guess_ 4 is \N{} --jhi */
3407 /* See Note on sizing above. (NOTE: SvCUR() is not
3408 * set correctly here). */
3409 const STRLEN off = d - SvPVX_const(sv);
3410 d = off + SvGROW(sv, off + len + (STRLEN)(send - s) + 1);
3412 Copy(str, d, len, char);
3417 /* Deprecate non-approved name syntax */
3418 if (ckWARN_d(WARN_DEPRECATED)) {
3419 bool problematic = FALSE;
3422 /* For non-ut8 input, look to see that the first
3423 * character is an alpha, then loop through the rest
3424 * checking that each is a continuation */
3426 if (! isALPHAU(*i)) problematic = TRUE;
3427 else for (i = s + 1; i < e; i++) {
3428 if (isCHARNAME_CONT(*i)) continue;
3434 /* Similarly for utf8. For invariants can check
3435 * directly. We accept anything above the latin1
3436 * range because it is immaterial to Perl if it is
3437 * correct or not, and is expensive to check. But
3438 * it is fairly easy in the latin1 range to convert
3439 * the variants into a single character and check
3441 if (UTF8_IS_INVARIANT(*i)) {
3442 if (! isALPHAU(*i)) problematic = TRUE;
3443 } else if (UTF8_IS_DOWNGRADEABLE_START(*i)) {
3444 if (! isALPHAU(UNI_TO_NATIVE(TWO_BYTE_UTF8_TO_UNI(*i,
3450 if (! problematic) for (i = s + UTF8SKIP(s);
3454 if (UTF8_IS_INVARIANT(*i)) {
3455 if (isCHARNAME_CONT(*i)) continue;
3456 } else if (! UTF8_IS_DOWNGRADEABLE_START(*i)) {
3458 } else if (isCHARNAME_CONT(
3460 TWO_BYTE_UTF8_TO_UNI(*i, *(i+1)))))
3469 /* The e-i passed to the final %.*s makes sure that
3470 * should the trailing NUL be missing that this
3471 * print won't run off the end of the string */
3472 Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),
3473 "Deprecated character in \\N{...}; marked by <-- HERE in \\N{%.*s<-- HERE %.*s",
3474 (int)(i - s + 1), s, (int)(e - i), i + 1);
3477 } /* End \N{NAME} */
3480 native_range = FALSE; /* \N{} is defined to be Unicode */
3482 s = e + 1; /* Point to just after the '}' */
3485 /* \c is a control character */
3489 *d++ = grok_bslash_c(*s++, has_utf8, 1);
3492 yyerror("Missing control char name in \\c");
3496 /* printf-style backslashes, formfeeds, newlines, etc */
3498 *d++ = NATIVE_TO_NEED(has_utf8,'\b');
3501 *d++ = NATIVE_TO_NEED(has_utf8,'\n');
3504 *d++ = NATIVE_TO_NEED(has_utf8,'\r');
3507 *d++ = NATIVE_TO_NEED(has_utf8,'\f');
3510 *d++ = NATIVE_TO_NEED(has_utf8,'\t');
3513 *d++ = ASCII_TO_NEED(has_utf8,'\033');
3516 *d++ = ASCII_TO_NEED(has_utf8,'\007');
3522 } /* end if (backslash) */
3529 /* If we started with encoded form, or already know we want it,
3530 then encode the next character */
3531 if (! NATIVE_IS_INVARIANT((U8)(*s)) && (this_utf8 || has_utf8)) {
3535 /* One might think that it is wasted effort in the case of the
3536 * source being utf8 (this_utf8 == TRUE) to take the next character
3537 * in the source, convert it to an unsigned value, and then convert
3538 * it back again. But the source has not been validated here. The
3539 * routine that does the conversion checks for errors like
3542 const UV nextuv = (this_utf8) ? utf8n_to_uvchr((U8*)s, send - s, &len, 0) : (UV) ((U8) *s);
3543 const STRLEN need = UNISKIP(NATIVE_TO_UNI(nextuv));
3545 SvCUR_set(sv, d - SvPVX_const(sv));
3548 /* See Note on sizing above. */
3549 sv_utf8_upgrade_flags_grow(sv,
3550 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3551 need + (STRLEN)(send - s) + 1);
3552 d = SvPVX(sv) + SvCUR(sv);
3554 } else if (need > len) {
3555 /* encoded value larger than old, may need extra space (NOTE:
3556 * SvCUR() is not set correctly here). See Note on sizing
3558 const STRLEN off = d - SvPVX_const(sv);
3559 d = SvGROW(sv, off + need + (STRLEN)(send - s) + 1) + off;
3563 d = (char*)uvchr_to_utf8((U8*)d, nextuv);
3565 if (uv > 255 && !dorange)
3566 native_range = FALSE;
3570 *d++ = NATIVE_TO_NEED(has_utf8,*s++);
3572 } /* while loop to process each character */
3574 /* terminate the string and set up the sv */
3576 SvCUR_set(sv, d - SvPVX_const(sv));
3577 if (SvCUR(sv) >= SvLEN(sv))
3578 Perl_croak(aTHX_ "panic: constant overflowed allocated space, %"UVuf
3579 " >= %"UVuf, (UV)SvCUR(sv), (UV)SvLEN(sv));
3582 if (PL_encoding && !has_utf8) {
3583 sv_recode_to_utf8(sv, PL_encoding);
3589 if (PL_lex_inwhat == OP_TRANS && PL_sublex_info.sub_op) {
3590 PL_sublex_info.sub_op->op_private |=
3591 (PL_lex_repl ? OPpTRANS_FROM_UTF : OPpTRANS_TO_UTF);
3595 /* shrink the sv if we allocated more than we used */
3596 if (SvCUR(sv) + 5 < SvLEN(sv)) {
3597 SvPV_shrink_to_cur(sv);
3600 /* return the substring (via pl_yylval) only if we parsed anything */
3601 if (s > PL_bufptr) {
3602 if ( PL_hints & ( PL_lex_inpat ? HINT_NEW_RE : HINT_NEW_STRING ) ) {
3603 const char *const key = PL_lex_inpat ? "qr" : "q";
3604 const STRLEN keylen = PL_lex_inpat ? 2 : 1;
3608 if (PL_lex_inwhat == OP_TRANS) {
3611 } else if (PL_lex_inwhat == OP_SUBST && !PL_lex_inpat) {
3614 } else if (PL_lex_inpat && SvIVX(PL_linestr) == '\'') {
3622 sv = S_new_constant(aTHX_ start, s - start, key, keylen, sv, NULL,
3625 pl_yylval.opval = (OP*)newSVOP(OP_CONST, 0, sv);
3632 * Returns TRUE if there's more to the expression (e.g., a subscript),
3635 * It deals with "$foo[3]" and /$foo[3]/ and /$foo[0123456789$]+/
3637 * ->[ and ->{ return TRUE
3638 * { and [ outside a pattern are always subscripts, so return TRUE
3639 * if we're outside a pattern and it's not { or [, then return FALSE
3640 * if we're in a pattern and the first char is a {
3641 * {4,5} (any digits around the comma) returns FALSE
3642 * if we're in a pattern and the first char is a [
3644 * [SOMETHING] has a funky algorithm to decide whether it's a
3645 * character class or not. It has to deal with things like
3646 * /$foo[-3]/ and /$foo[$bar]/ as well as /$foo[$\d]+/
3647 * anything else returns TRUE
3650 /* This is the one truly awful dwimmer necessary to conflate C and sed. */
3653 S_intuit_more(pTHX_ register char *s)
3657 PERL_ARGS_ASSERT_INTUIT_MORE;
3659 if (PL_lex_brackets)
3661 if (*s == '-' && s[1] == '>' && (s[2] == '[' || s[2] == '{'))
3663 if (*s != '{' && *s != '[')
3668 /* In a pattern, so maybe we have {n,m}. */
3676 /* On the other hand, maybe we have a character class */
3679 if (*s == ']' || *s == '^')
3682 /* this is terrifying, and it works */
3683 int weight = 2; /* let's weigh the evidence */
3685 unsigned char un_char = 255, last_un_char;
3686 const char * const send = strchr(s,']');
3687 char tmpbuf[sizeof PL_tokenbuf * 4];
3689 if (!send) /* has to be an expression */
3692 Zero(seen,256,char);
3695 else if (isDIGIT(*s)) {
3697 if (isDIGIT(s[1]) && s[2] == ']')
3703 for (; s < send; s++) {
3704 last_un_char = un_char;
3705 un_char = (unsigned char)*s;
3710 weight -= seen[un_char] * 10;
3711 if (isALNUM_lazy_if(s+1,UTF)) {
3713 scan_ident(s, send, tmpbuf, sizeof tmpbuf, FALSE);
3714 len = (int)strlen(tmpbuf);
3715 if (len > 1 && gv_fetchpvn_flags(tmpbuf, len,
3716 UTF ? SVf_UTF8 : 0, SVt_PV))
3721 else if (*s == '$' && s[1] &&
3722 strchr("[#!%*<>()-=",s[1])) {
3723 if (/*{*/ strchr("])} =",s[2]))
3732 if (strchr("wds]",s[1]))
3734 else if (seen[(U8)'\''] || seen[(U8)'"'])
3736 else if (strchr("rnftbxcav",s[1]))
3738 else if (isDIGIT(s[1])) {
3740 while (s[1] && isDIGIT(s[1]))
3750 if (strchr("aA01! ",last_un_char))
3752 if (strchr("zZ79~",s[1]))
3754 if (last_un_char == 255 && (isDIGIT(s[1]) || s[1] == '$'))
3755 weight -= 5; /* cope with negative subscript */
3758 if (!isALNUM(last_un_char)
3759 && !(last_un_char == '$' || last_un_char == '@'
3760 || last_un_char == '&')
3761 && isALPHA(*s) && s[1] && isALPHA(s[1])) {
3766 if (keyword(tmpbuf, d - tmpbuf, 0))
3769 if (un_char == last_un_char + 1)
3771 weight -= seen[un_char];
3776 if (weight >= 0) /* probably a character class */
3786 * Does all the checking to disambiguate
3788 * between foo(bar) and bar->foo. Returns 0 if not a method, otherwise
3789 * FUNCMETH (bar->foo(args)) or METHOD (bar->foo args).
3791 * First argument is the stuff after the first token, e.g. "bar".
3793 * Not a method if foo is a filehandle.
3794 * Not a method if foo is a subroutine prototyped to take a filehandle.
3795 * Not a method if it's really "Foo $bar"
3796 * Method if it's "foo $bar"
3797 * Not a method if it's really "print foo $bar"
3798 * Method if it's really "foo package::" (interpreted as package->foo)
3799 * Not a method if bar is known to be a subroutine ("sub bar; foo bar")
3800 * Not a method if bar is a filehandle or package, but is quoted with
3805 S_intuit_method(pTHX_ char *start, GV *gv, CV *cv)
3808 char *s = start + (*start == '$');
3809 char tmpbuf[sizeof PL_tokenbuf];
3816 PERL_ARGS_ASSERT_INTUIT_METHOD;
3818 if (gv && SvTYPE(gv) == SVt_PVGV && GvIO(gv))
3820 if (cv && SvPOK(cv)) {
3821 const char *proto = CvPROTO(cv);
3829 s = scan_word(s, tmpbuf, sizeof tmpbuf, TRUE, &len);
3830 /* start is the beginning of the possible filehandle/object,
3831 * and s is the end of it
3832 * tmpbuf is a copy of it
3835 if (*start == '$') {
3836 if (cv || PL_last_lop_op == OP_PRINT || PL_last_lop_op == OP_SAY ||
3837 isUPPER(*PL_tokenbuf))
3840 len = start - SvPVX(PL_linestr);
3844 start = SvPVX(PL_linestr) + len;
3848 return *s == '(' ? FUNCMETH : METHOD;
3850 if (!keyword(tmpbuf, len, 0)) {
3851 if (len > 2 && tmpbuf[len - 2] == ':' && tmpbuf[len - 1] == ':') {
3855 soff = s - SvPVX(PL_linestr);
3859 indirgv = gv_fetchpvn_flags(tmpbuf, len, ( UTF ? SVf_UTF8 : 0 ), SVt_PVCV);
3860 if (indirgv && GvCVu(indirgv))
3862 /* filehandle or package name makes it a method */
3863 if (!cv || GvIO(indirgv) || gv_stashpvn(tmpbuf, len, UTF ? SVf_UTF8 : 0)) {
3865 soff = s - SvPVX(PL_linestr);
3868 if ((PL_bufend - s) >= 2 && *s == '=' && *(s+1) == '>')
3869 return 0; /* no assumptions -- "=>" quotes bareword */
3871 start_force(PL_curforce);
3872 NEXTVAL_NEXTTOKE.opval = (OP*)newSVOP(OP_CONST, 0,
3873 S_newSV_maybe_utf8(aTHX_ tmpbuf, len));
3874 NEXTVAL_NEXTTOKE.opval->op_private = OPpCONST_BARE;
3876 curmad('X', newSVpvn_flags(start,SvPVX(PL_linestr) + soff - start,
3877 ( UTF ? SVf_UTF8 : 0 )));
3882 PL_bufptr = SvPVX(PL_linestr) + soff; /* restart before space */
3884 return *s == '(' ? FUNCMETH : METHOD;
3890 /* Encoded script support. filter_add() effectively inserts a
3891 * 'pre-processing' function into the current source input stream.
3892 * Note that the filter function only applies to the current source file
3893 * (e.g., it will not affect files 'require'd or 'use'd by this one).
3895 * The datasv parameter (which may be NULL) can be used to pass
3896 * private data to this instance of the filter. The filter function
3897 * can recover the SV using the FILTER_DATA macro and use it to
3898 * store private buffers and state information.
3900 * The supplied datasv parameter is upgraded to a PVIO type
3901 * and the IoDIRP/IoANY field is used to store the function pointer,
3902 * and IOf_FAKE_DIRP is enabled on datasv to mark this as such.
3903 * Note that IoTOP_NAME, IoFMT_NAME, IoBOTTOM_NAME, if set for
3904 * private use must be set using malloc'd pointers.
3908 Perl_filter_add(pTHX_ filter_t funcp, SV *datasv)
3917 if (PL_parser->lex_flags & LEX_IGNORE_UTF8_HINTS)
3918 Perl_croak(aTHX_ "Source filters apply only to byte streams");
3920 if (!PL_rsfp_filters)
3921 PL_rsfp_filters = newAV();
3924 SvUPGRADE(datasv, SVt_PVIO);
3925 IoANY(datasv) = FPTR2DPTR(void *, funcp); /* stash funcp into spare field */
3926 IoFLAGS(datasv) |= IOf_FAKE_DIRP;
3927 DEBUG_P(PerlIO_printf(Perl_debug_log, "filter_add func %p (%s)\n",
3928 FPTR2DPTR(void *, IoANY(datasv)),
3929 SvPV_nolen(datasv)));
3930 av_unshift(PL_rsfp_filters, 1);
3931 av_store(PL_rsfp_filters, 0, datasv) ;
3933 !PL_parser->filtered
3934 && PL_parser->lex_flags & LEX_EVALBYTES
3935 && PL_bufptr < PL_bufend
3937 const char *s = PL_bufptr;
3938 while (s < PL_bufend) {
3940 SV *linestr = PL_parser->linestr;
3941 char *buf = SvPVX(linestr);
3942 STRLEN const bufptr_pos = PL_parser->bufptr - buf;
3943 STRLEN const oldbufptr_pos = PL_parser->oldbufptr - buf;
3944 STRLEN const oldoldbufptr_pos=PL_parser->oldoldbufptr-buf;
3945 STRLEN const linestart_pos = PL_parser->linestart - buf;
3946 STRLEN const last_uni_pos =
3947 PL_parser->last_uni ? PL_parser->last_uni - buf : 0;
3948 STRLEN const last_lop_pos =
3949 PL_parser->last_lop ? PL_parser->last_lop - buf : 0;
3950 av_push(PL_rsfp_filters, linestr);
3951 PL_parser->linestr =
3952 newSVpvn(SvPVX(linestr), ++s-SvPVX(linestr));
3953 buf = SvPVX(PL_parser->linestr);
3954 PL_parser->bufend = buf + SvCUR(PL_parser->linestr);
3955 PL_parser->bufptr = buf + bufptr_pos;
3956 PL_parser->oldbufptr = buf + oldbufptr_pos;
3957 PL_parser->oldoldbufptr = buf + oldoldbufptr_pos;
3958 PL_parser->linestart = buf + linestart_pos;
3959 if (PL_parser->last_uni)
3960 PL_parser->last_uni = buf + last_uni_pos;
3961 if (PL_parser->last_lop)
3962 PL_parser->last_lop = buf + last_lop_pos;
3963 SvLEN(linestr) = SvCUR(linestr);
3964 SvCUR(linestr) = s-SvPVX(linestr);
3965 PL_parser->filtered = 1;
3975 /* Delete most recently added instance of this filter function. */
3977 Perl_filter_del(pTHX_ filter_t funcp)
3982 PERL_ARGS_ASSERT_FILTER_DEL;
3985 DEBUG_P(PerlIO_printf(Perl_debug_log, "filter_del func %p",
3986 FPTR2DPTR(void*, funcp)));
3988 if (!PL_parser || !PL_rsfp_filters || AvFILLp(PL_rsfp_filters)<0)
3990 /* if filter is on top of stack (usual case) just pop it off */
3991 datasv = FILTER_DATA(AvFILLp(PL_rsfp_filters));
3992 if (IoANY(datasv) == FPTR2DPTR(void *, funcp)) {
3993 sv_free(av_pop(PL_rsfp_filters));
3997 /* we need to search for the correct entry and clear it */
3998 Perl_die(aTHX_ "filter_del can only delete in reverse order (currently)");
4002 /* Invoke the idxth filter function for the current rsfp. */
4003 /* maxlen 0 = read one text line */
4005 Perl_filter_read(pTHX_ int idx, SV *buf_sv, int maxlen)
4010 /* This API is bad. It should have been using unsigned int for maxlen.
4011 Not sure if we want to change the API, but if not we should sanity
4012 check the value here. */
4013 unsigned int correct_length
4022 PERL_ARGS_ASSERT_FILTER_READ;
4024 if (!PL_parser || !PL_rsfp_filters)
4026 if (idx > AvFILLp(PL_rsfp_filters)) { /* Any more filters? */
4027 /* Provide a default input filter to make life easy. */
4028 /* Note that we append to the line. This is handy. */
4029 DEBUG_P(PerlIO_printf(Perl_debug_log,
4030 "filter_read %d: from rsfp\n", idx));
4031 if (correct_length) {
4034 const int old_len = SvCUR(buf_sv);
4036 /* ensure buf_sv is large enough */
4037 SvGROW(buf_sv, (STRLEN)(old_len + correct_length + 1)) ;
4038 if ((len = PerlIO_read(PL_rsfp, SvPVX(buf_sv) + old_len,
4039 correct_length)) <= 0) {
4040 if (PerlIO_error(PL_rsfp))
4041 return -1; /* error */
4043 return 0 ; /* end of file */
4045 SvCUR_set(buf_sv, old_len + len) ;
4046 SvPVX(buf_sv)[old_len + len] = '\0';
4049 if (sv_gets(buf_sv, PL_rsfp, SvCUR(buf_sv)) == NULL) {
4050 if (PerlIO_error(PL_rsfp))
4051 return -1; /* error */
4053 return 0 ; /* end of file */
4056 return SvCUR(buf_sv);
4058 /* Skip this filter slot if filter has been deleted */
4059 if ( (datasv = FILTER_DATA(idx)) == &PL_sv_undef) {
4060 DEBUG_P(PerlIO_printf(Perl_debug_log,
4061 "filter_read %d: skipped (filter deleted)\n",
4063 return FILTER_READ(idx+1, buf_sv, correct_length); /* recurse */
4065 if (SvTYPE(datasv) != SVt_PVIO) {
4066 if (correct_length) {
4068 const STRLEN remainder = SvLEN(datasv) - SvCUR(datasv);
4069 if (!remainder) return 0; /* eof */
4070 if (correct_length > remainder) correct_length = remainder;
4071 sv_catpvn(buf_sv, SvEND(datasv), correct_length);
4072 SvCUR_set(datasv, SvCUR(datasv) + correct_length);
4075 const char *s = SvEND(datasv);
4076 const char *send = SvPVX(datasv) + SvLEN(datasv);
4084 if (s == send) return 0; /* eof */
4085 sv_catpvn(buf_sv, SvEND(datasv), s-SvEND(datasv));
4086 SvCUR_set(datasv, s-SvPVX(datasv));
4088 return SvCUR(buf_sv);
4090 /* Get function pointer hidden within datasv */
4091 funcp = DPTR2FPTR(filter_t, IoANY(datasv));
4092 DEBUG_P(PerlIO_printf(Perl_debug_log,
4093 "filter_read %d: via function %p (%s)\n",
4094 idx, (void*)datasv, SvPV_nolen_const(datasv)));
4095 /* Call function. The function is expected to */
4096 /* call "FILTER_READ(idx+1, buf_sv)" first. */
4097 /* Return: <0:error, =0:eof, >0:not eof */
4098 return (*funcp)(aTHX_ idx, buf_sv, correct_length);
4102 S_filter_gets(pTHX_ register SV *sv, STRLEN append)
4106 PERL_ARGS_ASSERT_FILTER_GETS;
4108 #ifdef PERL_CR_FILTER
4109 if (!PL_rsfp_filters) {
4110 filter_add(S_cr_textfilter,NULL);
4113 if (PL_rsfp_filters) {
4115 SvCUR_set(sv, 0); /* start with empty line */
4116 if (FILTER_READ(0, sv, 0) > 0)
4117 return ( SvPVX(sv) ) ;
4122 return (sv_gets(sv, PL_rsfp, append));
4126 S_find_in_my_stash(pTHX_ const char *pkgname, STRLEN len)
4131 PERL_ARGS_ASSERT_FIND_IN_MY_STASH;
4133 if (len == 11 && *pkgname == '_' && strEQ(pkgname, "__PACKAGE__"))
4137 (pkgname[len - 2] == ':' && pkgname[len - 1] == ':') &&
4138 (gv = gv_fetchpvn_flags(pkgname, len, ( UTF ? SVf_UTF8 : 0 ), SVt_PVHV)))
4140 return GvHV(gv); /* Foo:: */
4143 /* use constant CLASS => 'MyClass' */
4144 gv = gv_fetchpvn_flags(pkgname, len, UTF ? SVf_UTF8 : 0, SVt_PVCV);
4145 if (gv && GvCV(gv)) {
4146 SV * const sv = cv_const_sv(GvCV(gv));
4148 pkgname = SvPV_const(sv, len);
4151 return gv_stashpvn(pkgname, len, UTF ? SVf_UTF8 : 0);
4155 * S_readpipe_override
4156 * Check whether readpipe() is overridden, and generates the appropriate
4157 * optree, provided sublex_start() is called afterwards.
4160 S_readpipe_override(pTHX)
4163 GV *gv_readpipe = gv_fetchpvs("readpipe", GV_NOTQUAL, SVt_PVCV);
4164 pl_yylval.ival = OP_BACKTICK;
4166 && GvCVu(gv_readpipe) && GvIMPORTED_CV(gv_readpipe))
4168 ((gvp = (GV**)hv_fetchs(PL_globalstash, "readpipe", FALSE))
4169 && (gv_readpipe = *gvp) && isGV_with_GP(gv_readpipe)
4170 && GvCVu(gv_readpipe) && GvIMPORTED_CV(gv_readpipe)))
4172 PL_lex_op = (OP*)newUNOP(OP_ENTERSUB, OPf_STACKED,
4173 op_append_elem(OP_LIST,
4174 newSVOP(OP_CONST, 0, &PL_sv_undef), /* value will be read later */
4175 newCVREF(0, newGVOP(OP_GV, 0, gv_readpipe))));
4182 * The intent of this yylex wrapper is to minimize the changes to the
4183 * tokener when we aren't interested in collecting madprops. It remains
4184 * to be seen how successful this strategy will be...
4191 char *s = PL_bufptr;
4193 /* make sure PL_thiswhite is initialized */
4197 /* just do what yylex would do on pending identifier; leave PL_thiswhite alone */
4198 if (PL_lex_state != LEX_KNOWNEXT && PL_pending_ident)
4199 return S_pending_ident(aTHX);
4201 /* previous token ate up our whitespace? */
4202 if (!PL_lasttoke && PL_nextwhite) {
4203 PL_thiswhite = PL_nextwhite;
4207 /* isolate the token, and figure out where it is without whitespace */
4208 PL_realtokenstart = -1;
4212 assert(PL_curforce < 0);
4214 if (!PL_thismad || PL_thismad->mad_key == '^') { /* not forced already? */
4215 if (!PL_thistoken) {
4216 if (PL_realtokenstart < 0 || !CopLINE(PL_curcop))
4217 PL_thistoken = newSVpvs("");
4219 char * const tstart = SvPVX(PL_linestr) + PL_realtokenstart;
4220 PL_thistoken = newSVpvn(tstart, s - tstart);
4223 if (PL_thismad) /* install head */
4224 CURMAD('X', PL_thistoken);
4227 /* last whitespace of a sublex? */
4228 if (optype == ')' && PL_endwhite) {
4229 CURMAD('X', PL_endwhite);
4234 /* if no whitespace and we're at EOF, bail. Otherwise fake EOF below. */
4235 if (!PL_thiswhite && !PL_endwhite && !optype) {
4236 sv_free(PL_thistoken);
4241 /* put off final whitespace till peg */
4242 if (optype == ';' && !PL_rsfp && !PL_parser->filtered) {
4243 PL_nextwhite = PL_thiswhite;
4246 else if (PL_thisopen) {
4247 CURMAD('q', PL_thisopen);
4249 sv_free(PL_thistoken);
4253 /* Store actual token text as madprop X */
4254 CURMAD('X', PL_thistoken);
4258 /* add preceding whitespace as madprop _ */
4259 CURMAD('_', PL_thiswhite);
4263 /* add quoted material as madprop = */
4264 CURMAD('=', PL_thisstuff);
4268 /* add terminating quote as madprop Q */
4269 CURMAD('Q', PL_thisclose);
4273 /* special processing based on optype */
4277 /* opval doesn't need a TOKEN since it can already store mp */
4288 if (pl_yylval.opval)
4289 append_madprops(PL_thismad, pl_yylval.opval, 0);
4297 addmad(newMADsv('p', PL_endwhite), &PL_thismad, 0);
4306 /* remember any fake bracket that lexer is about to discard */
4307 if (PL_lex_brackets == 1 &&
4308 ((expectation)PL_lex_brackstack[0] & XFAKEBRACK))
4311 while (s < PL_bufend && (*s == ' ' || *s == '\t'))
4314 PL_thiswhite = newSVpvn(PL_bufptr, ++s - PL_bufptr);
4315 addmad(newMADsv('#', PL_thiswhite), &PL_thismad, 0);
4318 break; /* don't bother looking for trailing comment */
4327 /* attach a trailing comment to its statement instead of next token */
4331 if (PL_bufptr > PL_oldbufptr && PL_bufptr[-1] == optype) {
4333 while (s < PL_bufend && (*s == ' ' || *s == '\t'))
4335 if (*s == '\n' || *s == '#') {
4336 while (s < PL_bufend && *s != '\n')
4340 PL_thiswhite = newSVpvn(PL_bufptr, s - PL_bufptr);
4341 addmad(newMADsv('#', PL_thiswhite), &PL_thismad, 0);
4354 /* Create new token struct. Note: opvals return early above. */
4355 pl_yylval.tkval = newTOKEN(optype, pl_yylval, PL_thismad);
4362 S_tokenize_use(pTHX_ int is_use, char *s) {
4365 PERL_ARGS_ASSERT_TOKENIZE_USE;
4367 if (PL_expect != XSTATE)
4368 yyerror(Perl_form(aTHX_ "\"%s\" not allowed in expression",
4369 is_use ? "use" : "no"));
4372 if (isDIGIT(*s) || (*s == 'v' && isDIGIT(s[1]))) {
4373 s = force_version(s, TRUE);
4374 if (*s == ';' || *s == '}'
4375 || (s = SKIPSPACE1(s), (*s == ';' || *s == '}'))) {
4376 start_force(PL_curforce);
4377 NEXTVAL_NEXTTOKE.opval = NULL;
4380 else if (*s == 'v') {
4381 s = force_word(s,WORD,FALSE,TRUE,FALSE);
4382 s = force_version(s, FALSE);
4386 s = force_word(s,WORD,FALSE,TRUE,FALSE);
4387 s = force_version(s, FALSE);
4389 pl_yylval.ival = is_use;
4393 static const char* const exp_name[] =
4394 { "OPERATOR", "TERM", "REF", "STATE", "BLOCK", "ATTRBLOCK",
4395 "ATTRTERM", "TERMBLOCK", "TERMORDORDOR"
4399 #define word_takes_any_delimeter(p,l) S_word_takes_any_delimeter(p,l)
4401 S_word_takes_any_delimeter(char *p, STRLEN len)
4403 return (len == 1 && strchr("msyq", p[0])) ||
4405 (p[0] == 't' && p[1] == 'r') ||
4406 (p[0] == 'q' && strchr("qwxr", p[1]))));
4412 Works out what to call the token just pulled out of the input
4413 stream. The yacc parser takes care of taking the ops we return and
4414 stitching them into a tree.
4420 if read an identifier
4421 if we're in a my declaration
4422 croak if they tried to say my($foo::bar)
4423 build the ops for a my() declaration
4424 if it's an access to a my() variable
4425 are we in a sort block?
4426 croak if my($a); $a <=> $b
4427 build ops for access to a my() variable
4428 if in a dq string, and they've said @foo and we can't find @foo
4430 build ops for a bareword
4431 if we already built the token before, use it.
4436 #pragma segment Perl_yylex
4442 char *s = PL_bufptr;
4449 /* orig_keyword, gvp, and gv are initialized here because
4450 * jump to the label just_a_word_zero can bypass their
4451 * initialization later. */
4452 I32 orig_keyword = 0;
4457 SV* tmp = newSVpvs("");
4458 PerlIO_printf(Perl_debug_log, "### %"IVdf":LEX_%s/X%s %s\n",
4459 (IV)CopLINE(PL_curcop),
4460 lex_state_names[PL_lex_state],
4461 exp_name[PL_expect],
4462 pv_display(tmp, s, strlen(s), 0, 60));