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
43 #define new_constant(a,b,c,d,e,f,g) \
44 S_new_constant(aTHX_ a,b,STR_WITH_LEN(c),d,e,f, g)
46 #define pl_yylval (PL_parser->yylval)
48 /* YYINITDEPTH -- initial size of the parser's stacks. */
49 #define YYINITDEPTH 200
51 /* XXX temporary backwards compatibility */
52 #define PL_lex_brackets (PL_parser->lex_brackets)
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 XFAKEBRACK 128
130 #define XENUMMASK 127
132 #ifdef USE_UTF8_SCRIPTS
133 # define UTF (!IN_BYTES)
135 # define UTF ((PL_linestr && DO_UTF8(PL_linestr)) || (PL_hints & HINT_UTF8))
138 /* The maximum number of characters preceding the unrecognized one to display */
139 #define UNRECOGNIZED_PRECEDE_COUNT 10
141 /* In variables named $^X, these are the legal values for X.
142 * 1999-02-27 mjd-perl-patch@plover.com */
143 #define isCONTROLVAR(x) (isUPPER(x) || strchr("[\\]^_?", (x)))
145 #define SPACE_OR_TAB(c) ((c)==' '||(c)=='\t')
147 /* LEX_* are values for PL_lex_state, the state of the lexer.
148 * They are arranged oddly so that the guard on the switch statement
149 * can get by with a single comparison (if the compiler is smart enough).
152 /* #define LEX_NOTPARSING 11 is done in perl.h. */
154 #define LEX_NORMAL 10 /* normal code (ie not within "...") */
155 #define LEX_INTERPNORMAL 9 /* code within a string, eg "$foo[$x+1]" */
156 #define LEX_INTERPCASEMOD 8 /* expecting a \U, \Q or \E etc */
157 #define LEX_INTERPPUSH 7 /* starting a new sublex parse level */
158 #define LEX_INTERPSTART 6 /* expecting the start of a $var */
160 /* at end of code, eg "$x" followed by: */
161 #define LEX_INTERPEND 5 /* ... eg not one of [, { or -> */
162 #define LEX_INTERPENDMAYBE 4 /* ... eg one of [, { or -> */
164 #define LEX_INTERPCONCAT 3 /* expecting anything, eg at start of
165 string or after \E, $foo, etc */
166 #define LEX_INTERPCONST 2 /* NOT USED */
167 #define LEX_FORMLINE 1 /* expecting a format line */
168 #define LEX_KNOWNEXT 0 /* next token known; just return it */
172 static const char* const lex_state_names[] = {
191 #include "keywords.h"
193 /* CLINE is a macro that ensures PL_copline has a sane value */
198 #define CLINE (PL_copline = (CopLINE(PL_curcop) < PL_copline ? CopLINE(PL_curcop) : PL_copline))
201 # define SKIPSPACE0(s) skipspace0(s)
202 # define SKIPSPACE1(s) skipspace1(s)
203 # define SKIPSPACE2(s,tsv) skipspace2(s,&tsv)
204 # define PEEKSPACE(s) skipspace2(s,0)
206 # define SKIPSPACE0(s) skipspace(s)
207 # define SKIPSPACE1(s) skipspace(s)
208 # define SKIPSPACE2(s,tsv) skipspace(s)
209 # define PEEKSPACE(s) skipspace(s)
213 * Convenience functions to return different tokens and prime the
214 * lexer for the next token. They all take an argument.
216 * TOKEN : generic token (used for '(', DOLSHARP, etc)
217 * OPERATOR : generic operator
218 * AOPERATOR : assignment operator
219 * PREBLOCK : beginning the block after an if, while, foreach, ...
220 * PRETERMBLOCK : beginning a non-code-defining {} block (eg, hash ref)
221 * PREREF : *EXPR where EXPR is not a simple identifier
222 * TERM : expression term
223 * LOOPX : loop exiting command (goto, last, dump, etc)
224 * FTST : file test operator
225 * FUN0 : zero-argument function
226 * FUN1 : not used, except for not, which isn't a UNIOP
227 * BOop : bitwise or or xor
229 * SHop : shift operator
230 * PWop : power operator
231 * PMop : pattern-matching operator
232 * Aop : addition-level operator
233 * Mop : multiplication-level operator
234 * Eop : equality-testing operator
235 * Rop : relational operator <= != gt
237 * Also see LOP and lop() below.
240 #ifdef DEBUGGING /* Serve -DT. */
241 # define REPORT(retval) tokereport((I32)retval, &pl_yylval)
243 # define REPORT(retval) (retval)
246 #define TOKEN(retval) return ( PL_bufptr = s, REPORT(retval))
247 #define OPERATOR(retval) return (PL_expect = XTERM, PL_bufptr = s, REPORT(retval))
248 #define AOPERATOR(retval) return ao((PL_expect = XTERM, PL_bufptr = s, REPORT(retval)))
249 #define PREBLOCK(retval) return (PL_expect = XBLOCK,PL_bufptr = s, REPORT(retval))
250 #define PRETERMBLOCK(retval) return (PL_expect = XTERMBLOCK,PL_bufptr = s, REPORT(retval))
251 #define PREREF(retval) return (PL_expect = XREF,PL_bufptr = s, REPORT(retval))
252 #define TERM(retval) return (CLINE, PL_expect = XOPERATOR, PL_bufptr = s, REPORT(retval))
253 #define LOOPX(f) return (pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)LOOPEX))
254 #define FTST(f) return (pl_yylval.ival=f, PL_expect=XTERMORDORDOR, PL_bufptr=s, REPORT((int)UNIOP))
255 #define FUN0(f) return (pl_yylval.ival=f, PL_expect=XOPERATOR, PL_bufptr=s, REPORT((int)FUNC0))
256 #define FUN1(f) return (pl_yylval.ival=f, PL_expect=XOPERATOR, PL_bufptr=s, REPORT((int)FUNC1))
257 #define BOop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)BITOROP)))
258 #define BAop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)BITANDOP)))
259 #define SHop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)SHIFTOP)))
260 #define PWop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)POWOP)))
261 #define PMop(f) return(pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)MATCHOP))
262 #define Aop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)ADDOP)))
263 #define Mop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)MULOP)))
264 #define Eop(f) return (pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)EQOP))
265 #define Rop(f) return (pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)RELOP))
267 /* This bit of chicanery makes a unary function followed by
268 * a parenthesis into a function with one argument, highest precedence.
269 * The UNIDOR macro is for unary functions that can be followed by the //
270 * operator (such as C<shift // 0>).
272 #define UNI2(f,x) { \
273 pl_yylval.ival = f; \
276 PL_last_uni = PL_oldbufptr; \
277 PL_last_lop_op = f; \
279 return REPORT( (int)FUNC1 ); \
281 return REPORT( *s=='(' ? (int)FUNC1 : (int)UNIOP ); \
283 #define UNI(f) UNI2(f,XTERM)
284 #define UNIDOR(f) UNI2(f,XTERMORDORDOR)
286 #define UNIBRACK(f) { \
287 pl_yylval.ival = f; \
289 PL_last_uni = PL_oldbufptr; \
291 return REPORT( (int)FUNC1 ); \
293 return REPORT( (*s == '(') ? (int)FUNC1 : (int)UNIOP ); \
296 /* grandfather return to old style */
297 #define OLDLOP(f) return(pl_yylval.ival=f,PL_expect = XTERM,PL_bufptr = s,(int)LSTOP)
301 /* how to interpret the pl_yylval associated with the token */
305 TOKENTYPE_OPNUM, /* pl_yylval.ival contains an opcode number */
311 static struct debug_tokens {
313 enum token_type type;
315 } const debug_tokens[] =
317 { ADDOP, TOKENTYPE_OPNUM, "ADDOP" },
318 { ANDAND, TOKENTYPE_NONE, "ANDAND" },
319 { ANDOP, TOKENTYPE_NONE, "ANDOP" },
320 { ANONSUB, TOKENTYPE_IVAL, "ANONSUB" },
321 { ARROW, TOKENTYPE_NONE, "ARROW" },
322 { ASSIGNOP, TOKENTYPE_OPNUM, "ASSIGNOP" },
323 { BITANDOP, TOKENTYPE_OPNUM, "BITANDOP" },
324 { BITOROP, TOKENTYPE_OPNUM, "BITOROP" },
325 { COLONATTR, TOKENTYPE_NONE, "COLONATTR" },
326 { CONTINUE, TOKENTYPE_NONE, "CONTINUE" },
327 { DEFAULT, TOKENTYPE_NONE, "DEFAULT" },
328 { DO, TOKENTYPE_NONE, "DO" },
329 { DOLSHARP, TOKENTYPE_NONE, "DOLSHARP" },
330 { DORDOR, TOKENTYPE_NONE, "DORDOR" },
331 { DOROP, TOKENTYPE_OPNUM, "DOROP" },
332 { DOTDOT, TOKENTYPE_IVAL, "DOTDOT" },
333 { ELSE, TOKENTYPE_NONE, "ELSE" },
334 { ELSIF, TOKENTYPE_IVAL, "ELSIF" },
335 { EQOP, TOKENTYPE_OPNUM, "EQOP" },
336 { FOR, TOKENTYPE_IVAL, "FOR" },
337 { FORMAT, TOKENTYPE_NONE, "FORMAT" },
338 { FUNC, TOKENTYPE_OPNUM, "FUNC" },
339 { FUNC0, TOKENTYPE_OPNUM, "FUNC0" },
340 { FUNC0SUB, TOKENTYPE_OPVAL, "FUNC0SUB" },
341 { FUNC1, TOKENTYPE_OPNUM, "FUNC1" },
342 { FUNCMETH, TOKENTYPE_OPVAL, "FUNCMETH" },
343 { GIVEN, TOKENTYPE_IVAL, "GIVEN" },
344 { HASHBRACK, TOKENTYPE_NONE, "HASHBRACK" },
345 { IF, TOKENTYPE_IVAL, "IF" },
346 { LABEL, TOKENTYPE_PVAL, "LABEL" },
347 { LOCAL, TOKENTYPE_IVAL, "LOCAL" },
348 { LOOPEX, TOKENTYPE_OPNUM, "LOOPEX" },
349 { LSTOP, TOKENTYPE_OPNUM, "LSTOP" },
350 { LSTOPSUB, TOKENTYPE_OPVAL, "LSTOPSUB" },
351 { MATCHOP, TOKENTYPE_OPNUM, "MATCHOP" },
352 { METHOD, TOKENTYPE_OPVAL, "METHOD" },
353 { MULOP, TOKENTYPE_OPNUM, "MULOP" },
354 { MY, TOKENTYPE_IVAL, "MY" },
355 { MYSUB, TOKENTYPE_NONE, "MYSUB" },
356 { NOAMP, TOKENTYPE_NONE, "NOAMP" },
357 { NOTOP, TOKENTYPE_NONE, "NOTOP" },
358 { OROP, TOKENTYPE_IVAL, "OROP" },
359 { OROR, TOKENTYPE_NONE, "OROR" },
360 { PACKAGE, TOKENTYPE_NONE, "PACKAGE" },
361 { PLUGEXPR, TOKENTYPE_OPVAL, "PLUGEXPR" },
362 { PLUGSTMT, TOKENTYPE_OPVAL, "PLUGSTMT" },
363 { PMFUNC, TOKENTYPE_OPVAL, "PMFUNC" },
364 { POSTDEC, TOKENTYPE_NONE, "POSTDEC" },
365 { POSTINC, TOKENTYPE_NONE, "POSTINC" },
366 { POWOP, TOKENTYPE_OPNUM, "POWOP" },
367 { PREDEC, TOKENTYPE_NONE, "PREDEC" },
368 { PREINC, TOKENTYPE_NONE, "PREINC" },
369 { PRIVATEREF, TOKENTYPE_OPVAL, "PRIVATEREF" },
370 { REFGEN, TOKENTYPE_NONE, "REFGEN" },
371 { RELOP, TOKENTYPE_OPNUM, "RELOP" },
372 { SHIFTOP, TOKENTYPE_OPNUM, "SHIFTOP" },
373 { SUB, TOKENTYPE_NONE, "SUB" },
374 { THING, TOKENTYPE_OPVAL, "THING" },
375 { UMINUS, TOKENTYPE_NONE, "UMINUS" },
376 { UNIOP, TOKENTYPE_OPNUM, "UNIOP" },
377 { UNIOPSUB, TOKENTYPE_OPVAL, "UNIOPSUB" },
378 { UNLESS, TOKENTYPE_IVAL, "UNLESS" },
379 { UNTIL, TOKENTYPE_IVAL, "UNTIL" },
380 { USE, TOKENTYPE_IVAL, "USE" },
381 { WHEN, TOKENTYPE_IVAL, "WHEN" },
382 { WHILE, TOKENTYPE_IVAL, "WHILE" },
383 { WORD, TOKENTYPE_OPVAL, "WORD" },
384 { YADAYADA, TOKENTYPE_IVAL, "YADAYADA" },
385 { 0, TOKENTYPE_NONE, NULL }
388 /* dump the returned token in rv, plus any optional arg in pl_yylval */
391 S_tokereport(pTHX_ I32 rv, const YYSTYPE* lvalp)
395 PERL_ARGS_ASSERT_TOKEREPORT;
398 const char *name = NULL;
399 enum token_type type = TOKENTYPE_NONE;
400 const struct debug_tokens *p;
401 SV* const report = newSVpvs("<== ");
403 for (p = debug_tokens; p->token; p++) {
404 if (p->token == (int)rv) {
411 Perl_sv_catpv(aTHX_ report, name);
412 else if ((char)rv > ' ' && (char)rv < '~')
413 Perl_sv_catpvf(aTHX_ report, "'%c'", (char)rv);
415 sv_catpvs(report, "EOF");
417 Perl_sv_catpvf(aTHX_ report, "?? %"IVdf, (IV)rv);
420 case TOKENTYPE_GVVAL: /* doesn't appear to be used */
423 Perl_sv_catpvf(aTHX_ report, "(ival=%"IVdf")", (IV)lvalp->ival);
425 case TOKENTYPE_OPNUM:
426 Perl_sv_catpvf(aTHX_ report, "(ival=op_%s)",
427 PL_op_name[lvalp->ival]);
430 Perl_sv_catpvf(aTHX_ report, "(pval=\"%s\")", lvalp->pval);
432 case TOKENTYPE_OPVAL:
434 Perl_sv_catpvf(aTHX_ report, "(opval=op_%s)",
435 PL_op_name[lvalp->opval->op_type]);
436 if (lvalp->opval->op_type == OP_CONST) {
437 Perl_sv_catpvf(aTHX_ report, " %s",
438 SvPEEK(cSVOPx_sv(lvalp->opval)));
443 sv_catpvs(report, "(opval=null)");
446 PerlIO_printf(Perl_debug_log, "### %s\n\n", SvPV_nolen_const(report));
452 /* print the buffer with suitable escapes */
455 S_printbuf(pTHX_ const char *const fmt, const char *const s)
457 SV* const tmp = newSVpvs("");
459 PERL_ARGS_ASSERT_PRINTBUF;
461 PerlIO_printf(Perl_debug_log, fmt, pv_display(tmp, s, strlen(s), 0, 60));
468 S_deprecate_commaless_var_list(pTHX) {
470 deprecate("comma-less variable list");
471 return REPORT(','); /* grandfather non-comma-format format */
477 * This subroutine detects &&=, ||=, and //= and turns an ANDAND, OROR or DORDOR
478 * into an OP_ANDASSIGN, OP_ORASSIGN, or OP_DORASSIGN
482 S_ao(pTHX_ int toketype)
485 if (*PL_bufptr == '=') {
487 if (toketype == ANDAND)
488 pl_yylval.ival = OP_ANDASSIGN;
489 else if (toketype == OROR)
490 pl_yylval.ival = OP_ORASSIGN;
491 else if (toketype == DORDOR)
492 pl_yylval.ival = OP_DORASSIGN;
500 * When Perl expects an operator and finds something else, no_op
501 * prints the warning. It always prints "<something> found where
502 * operator expected. It prints "Missing semicolon on previous line?"
503 * if the surprise occurs at the start of the line. "do you need to
504 * predeclare ..." is printed out for code like "sub bar; foo bar $x"
505 * where the compiler doesn't know if foo is a method call or a function.
506 * It prints "Missing operator before end of line" if there's nothing
507 * after the missing operator, or "... before <...>" if there is something
508 * after the missing operator.
512 S_no_op(pTHX_ const char *const what, char *s)
515 char * const oldbp = PL_bufptr;
516 const bool is_first = (PL_oldbufptr == PL_linestart);
518 PERL_ARGS_ASSERT_NO_OP;
524 yywarn(Perl_form(aTHX_ "%s found where operator expected", what));
525 if (ckWARN_d(WARN_SYNTAX)) {
527 Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
528 "\t(Missing semicolon on previous line?)\n");
529 else if (PL_oldoldbufptr && isIDFIRST_lazy_if(PL_oldoldbufptr,UTF)) {
531 for (t = PL_oldoldbufptr; (isALNUM_lazy_if(t,UTF) || *t == ':'); t++)
533 if (t < PL_bufptr && isSPACE(*t))
534 Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
535 "\t(Do you need to predeclare %.*s?)\n",
536 (int)(t - PL_oldoldbufptr), PL_oldoldbufptr);
540 Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
541 "\t(Missing operator before %.*s?)\n", (int)(s - oldbp), oldbp);
549 * Complain about missing quote/regexp/heredoc terminator.
550 * If it's called with NULL then it cauterizes the line buffer.
551 * If we're in a delimited string and the delimiter is a control
552 * character, it's reformatted into a two-char sequence like ^C.
557 S_missingterm(pTHX_ char *s)
563 char * const nl = strrchr(s,'\n');
567 else if (isCNTRL(PL_multi_close)) {
569 tmpbuf[1] = (char)toCTRL(PL_multi_close);
574 *tmpbuf = (char)PL_multi_close;
578 q = strchr(s,'"') ? '\'' : '"';
579 Perl_croak(aTHX_ "Can't find string terminator %c%s%c anywhere before EOF",q,s,q);
582 #define FEATURE_IS_ENABLED(name) \
583 ((0 != (PL_hints & HINT_LOCALIZE_HH)) \
584 && S_feature_is_enabled(aTHX_ STR_WITH_LEN(name)))
585 /* The longest string we pass in. */
586 #define MAX_FEATURE_LEN (sizeof("unicode_strings")-1)
589 * S_feature_is_enabled
590 * Check whether the named feature is enabled.
593 S_feature_is_enabled(pTHX_ const char *const name, STRLEN namelen)
596 HV * const hinthv = GvHV(PL_hintgv);
597 char he_name[8 + MAX_FEATURE_LEN] = "feature_";
599 PERL_ARGS_ASSERT_FEATURE_IS_ENABLED;
601 assert(namelen <= MAX_FEATURE_LEN);
602 memcpy(&he_name[8], name, namelen);
604 return (hinthv && hv_exists(hinthv, he_name, 8 + namelen));
608 * experimental text filters for win32 carriage-returns, utf16-to-utf8 and
609 * utf16-to-utf8-reversed.
612 #ifdef PERL_CR_FILTER
616 register const char *s = SvPVX_const(sv);
617 register const char * const e = s + SvCUR(sv);
619 PERL_ARGS_ASSERT_STRIP_RETURN;
621 /* outer loop optimized to do nothing if there are no CR-LFs */
623 if (*s++ == '\r' && *s == '\n') {
624 /* hit a CR-LF, need to copy the rest */
625 register char *d = s - 1;
628 if (*s == '\r' && s[1] == '\n')
639 S_cr_textfilter(pTHX_ int idx, SV *sv, int maxlen)
641 const I32 count = FILTER_READ(idx+1, sv, maxlen);
642 if (count > 0 && !maxlen)
653 * Create a parser object and initialise its parser and lexer fields
655 * rsfp is the opened file handle to read from (if any),
657 * line holds any initial content already read from the file (or in
658 * the case of no file, such as an eval, the whole contents);
660 * new_filter indicates that this is a new file and it shouldn't inherit
661 * the filters from the current parser (ie require).
665 Perl_lex_start(pTHX_ SV *line, PerlIO *rsfp, bool new_filter)
668 const char *s = NULL;
670 yy_parser *parser, *oparser;
672 /* create and initialise a parser */
674 Newxz(parser, 1, yy_parser);
675 parser->old_parser = oparser = PL_parser;
678 Newx(parser->stack, YYINITDEPTH, yy_stack_frame);
679 parser->ps = parser->stack;
680 parser->stack_size = YYINITDEPTH;
682 parser->stack->state = 0;
683 parser->yyerrstatus = 0;
684 parser->yychar = YYEMPTY; /* Cause a token to be read. */
686 /* on scope exit, free this parser and restore any outer one */
688 parser->saved_curcop = PL_curcop;
690 /* initialise lexer state */
693 parser->curforce = -1;
695 parser->nexttoke = 0;
697 parser->error_count = oparser ? oparser->error_count : 0;
698 parser->copline = NOLINE;
699 parser->lex_state = LEX_NORMAL;
700 parser->expect = XSTATE;
702 parser->rsfp_filters = (new_filter || !oparser) ? newAV()
703 : MUTABLE_AV(SvREFCNT_inc(oparser->rsfp_filters));
705 Newx(parser->lex_brackstack, 120, char);
706 Newx(parser->lex_casestack, 12, char);
707 *parser->lex_casestack = '\0';
710 s = SvPV_const(line, len);
716 parser->linestr = newSVpvs("\n;");
717 } else if (SvREADONLY(line) || s[len-1] != ';') {
718 parser->linestr = newSVsv(line);
720 sv_catpvs(parser->linestr, "\n;");
723 SvREFCNT_inc_simple_void_NN(line);
724 parser->linestr = line;
726 parser->oldoldbufptr =
729 parser->linestart = SvPVX(parser->linestr);
730 parser->bufend = parser->bufptr + SvCUR(parser->linestr);
731 parser->last_lop = parser->last_uni = NULL;
735 /* delete a parser object */
738 Perl_parser_free(pTHX_ const yy_parser *parser)
740 PERL_ARGS_ASSERT_PARSER_FREE;
742 PL_curcop = parser->saved_curcop;
743 SvREFCNT_dec(parser->linestr);
745 if (parser->rsfp == PerlIO_stdin())
746 PerlIO_clearerr(parser->rsfp);
747 else if (parser->rsfp && (!parser->old_parser ||
748 (parser->old_parser && parser->rsfp != parser->old_parser->rsfp)))
749 PerlIO_close(parser->rsfp);
750 SvREFCNT_dec(parser->rsfp_filters);
752 Safefree(parser->stack);
753 Safefree(parser->lex_brackstack);
754 Safefree(parser->lex_casestack);
755 PL_parser = parser->old_parser;
762 * Finalizer for lexing operations. Must be called when the parser is
763 * done with the lexer.
770 PL_doextract = FALSE;
774 =for apidoc AmxU|SV *|PL_parser-E<gt>linestr
776 Buffer scalar containing the chunk currently under consideration of the
777 text currently being lexed. This is always a plain string scalar (for
778 which C<SvPOK> is true). It is not intended to be used as a scalar by
779 normal scalar means; instead refer to the buffer directly by the pointer
780 variables described below.
782 The lexer maintains various C<char*> pointers to things in the
783 C<PL_parser-E<gt>linestr> buffer. If C<PL_parser-E<gt>linestr> is ever
784 reallocated, all of these pointers must be updated. Don't attempt to
785 do this manually, but rather use L</lex_grow_linestr> if you need to
786 reallocate the buffer.
788 The content of the text chunk in the buffer is commonly exactly one
789 complete line of input, up to and including a newline terminator,
790 but there are situations where it is otherwise. The octets of the
791 buffer may be intended to be interpreted as either UTF-8 or Latin-1.
792 The function L</lex_bufutf8> tells you which. Do not use the C<SvUTF8>
793 flag on this scalar, which may disagree with it.
795 For direct examination of the buffer, the variable
796 L</PL_parser-E<gt>bufend> points to the end of the buffer. The current
797 lexing position is pointed to by L</PL_parser-E<gt>bufptr>. Direct use
798 of these pointers is usually preferable to examination of the scalar
799 through normal scalar means.
801 =for apidoc AmxU|char *|PL_parser-E<gt>bufend
803 Direct pointer to the end of the chunk of text currently being lexed, the
804 end of the lexer buffer. This is equal to C<SvPVX(PL_parser-E<gt>linestr)
805 + SvCUR(PL_parser-E<gt>linestr)>. A NUL character (zero octet) is
806 always located at the end of the buffer, and does not count as part of
807 the buffer's contents.
809 =for apidoc AmxU|char *|PL_parser-E<gt>bufptr
811 Points to the current position of lexing inside the lexer buffer.
812 Characters around this point may be freely examined, within
813 the range delimited by C<SvPVX(L</PL_parser-E<gt>linestr>)> and
814 L</PL_parser-E<gt>bufend>. The octets of the buffer may be intended to be
815 interpreted as either UTF-8 or Latin-1, as indicated by L</lex_bufutf8>.
817 Lexing code (whether in the Perl core or not) moves this pointer past
818 the characters that it consumes. It is also expected to perform some
819 bookkeeping whenever a newline character is consumed. This movement
820 can be more conveniently performed by the function L</lex_read_to>,
821 which handles newlines appropriately.
823 Interpretation of the buffer's octets can be abstracted out by
824 using the slightly higher-level functions L</lex_peek_unichar> and
825 L</lex_read_unichar>.
827 =for apidoc AmxU|char *|PL_parser-E<gt>linestart
829 Points to the start of the current line inside the lexer buffer.
830 This is useful for indicating at which column an error occurred, and
831 not much else. This must be updated by any lexing code that consumes
832 a newline; the function L</lex_read_to> handles this detail.
838 =for apidoc Amx|bool|lex_bufutf8
840 Indicates whether the octets in the lexer buffer
841 (L</PL_parser-E<gt>linestr>) should be interpreted as the UTF-8 encoding
842 of Unicode characters. If not, they should be interpreted as Latin-1
843 characters. This is analogous to the C<SvUTF8> flag for scalars.
845 In UTF-8 mode, it is not guaranteed that the lexer buffer actually
846 contains valid UTF-8. Lexing code must be robust in the face of invalid
849 The actual C<SvUTF8> flag of the L</PL_parser-E<gt>linestr> scalar
850 is significant, but not the whole story regarding the input character
851 encoding. Normally, when a file is being read, the scalar contains octets
852 and its C<SvUTF8> flag is off, but the octets should be interpreted as
853 UTF-8 if the C<use utf8> pragma is in effect. During a string eval,
854 however, the scalar may have the C<SvUTF8> flag on, and in this case its
855 octets should be interpreted as UTF-8 unless the C<use bytes> pragma
856 is in effect. This logic may change in the future; use this function
857 instead of implementing the logic yourself.
863 Perl_lex_bufutf8(pTHX)
869 =for apidoc Amx|char *|lex_grow_linestr|STRLEN len
871 Reallocates the lexer buffer (L</PL_parser-E<gt>linestr>) to accommodate
872 at least I<len> octets (including terminating NUL). Returns a
873 pointer to the reallocated buffer. This is necessary before making
874 any direct modification of the buffer that would increase its length.
875 L</lex_stuff_pvn> provides a more convenient way to insert text into
878 Do not use C<SvGROW> or C<sv_grow> directly on C<PL_parser-E<gt>linestr>;
879 this function updates all of the lexer's variables that point directly
886 Perl_lex_grow_linestr(pTHX_ STRLEN len)
890 STRLEN bufend_pos, bufptr_pos, oldbufptr_pos, oldoldbufptr_pos;
891 STRLEN linestart_pos, last_uni_pos, last_lop_pos;
892 linestr = PL_parser->linestr;
893 buf = SvPVX(linestr);
894 if (len <= SvLEN(linestr))
896 bufend_pos = PL_parser->bufend - buf;
897 bufptr_pos = PL_parser->bufptr - buf;
898 oldbufptr_pos = PL_parser->oldbufptr - buf;
899 oldoldbufptr_pos = PL_parser->oldoldbufptr - buf;
900 linestart_pos = PL_parser->linestart - buf;
901 last_uni_pos = PL_parser->last_uni ? PL_parser->last_uni - buf : 0;
902 last_lop_pos = PL_parser->last_lop ? PL_parser->last_lop - buf : 0;
903 buf = sv_grow(linestr, len);
904 PL_parser->bufend = buf + bufend_pos;
905 PL_parser->bufptr = buf + bufptr_pos;
906 PL_parser->oldbufptr = buf + oldbufptr_pos;
907 PL_parser->oldoldbufptr = buf + oldoldbufptr_pos;
908 PL_parser->linestart = buf + linestart_pos;
909 if (PL_parser->last_uni)
910 PL_parser->last_uni = buf + last_uni_pos;
911 if (PL_parser->last_lop)
912 PL_parser->last_lop = buf + last_lop_pos;
917 =for apidoc Amx|void|lex_stuff_pvn|char *pv|STRLEN len|U32 flags
919 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
920 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
921 reallocating the buffer if necessary. This means that lexing code that
922 runs later will see the characters as if they had appeared in the input.
923 It is not recommended to do this as part of normal parsing, and most
924 uses of this facility run the risk of the inserted characters being
925 interpreted in an unintended manner.
927 The string to be inserted is represented by I<len> octets starting
928 at I<pv>. These octets are interpreted as either UTF-8 or Latin-1,
929 according to whether the C<LEX_STUFF_UTF8> flag is set in I<flags>.
930 The characters are recoded for the lexer buffer, according to how the
931 buffer is currently being interpreted (L</lex_bufutf8>). If a string
932 to be interpreted is available as a Perl scalar, the L</lex_stuff_sv>
933 function is more convenient.
939 Perl_lex_stuff_pvn(pTHX_ char *pv, STRLEN len, U32 flags)
943 PERL_ARGS_ASSERT_LEX_STUFF_PVN;
944 if (flags & ~(LEX_STUFF_UTF8))
945 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_stuff_pvn");
947 if (flags & LEX_STUFF_UTF8) {
951 char *p, *e = pv+len;
952 for (p = pv; p != e; p++)
953 highhalf += !!(((U8)*p) & 0x80);
956 lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len+highhalf);
957 bufptr = PL_parser->bufptr;
958 Move(bufptr, bufptr+len+highhalf, PL_parser->bufend+1-bufptr, char);
959 SvCUR_set(PL_parser->linestr,
960 SvCUR(PL_parser->linestr) + len+highhalf);
961 PL_parser->bufend += len+highhalf;
962 for (p = pv; p != e; p++) {
965 *bufptr++ = (char)(0xc0 | (c >> 6));
966 *bufptr++ = (char)(0x80 | (c & 0x3f));
973 if (flags & LEX_STUFF_UTF8) {
975 char *p, *e = pv+len;
976 for (p = pv; p != e; p++) {
979 Perl_croak(aTHX_ "Lexing code attempted to stuff "
980 "non-Latin-1 character into Latin-1 input");
981 } else if (c >= 0xc2 && p+1 != e &&
982 (((U8)p[1]) & 0xc0) == 0x80) {
985 } else if (c >= 0x80) {
986 /* malformed UTF-8 */
988 SAVESPTR(PL_warnhook);
989 PL_warnhook = PERL_WARNHOOK_FATAL;
990 utf8n_to_uvuni((U8*)p, e-p, NULL, 0);
996 lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len-highhalf);
997 bufptr = PL_parser->bufptr;
998 Move(bufptr, bufptr+len-highhalf, PL_parser->bufend+1-bufptr, char);
999 SvCUR_set(PL_parser->linestr,
1000 SvCUR(PL_parser->linestr) + len-highhalf);
1001 PL_parser->bufend += len-highhalf;
1002 for (p = pv; p != e; p++) {
1005 *bufptr++ = (char)(((c & 0x3) << 6) | (p[1] & 0x3f));
1008 *bufptr++ = (char)c;
1013 lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len);
1014 bufptr = PL_parser->bufptr;
1015 Move(bufptr, bufptr+len, PL_parser->bufend+1-bufptr, char);
1016 SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) + len);
1017 PL_parser->bufend += len;
1018 Copy(pv, bufptr, len, char);
1024 =for apidoc Amx|void|lex_stuff_sv|SV *sv|U32 flags
1026 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
1027 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
1028 reallocating the buffer if necessary. This means that lexing code that
1029 runs later will see the characters as if they had appeared in the input.
1030 It is not recommended to do this as part of normal parsing, and most
1031 uses of this facility run the risk of the inserted characters being
1032 interpreted in an unintended manner.
1034 The string to be inserted is the string value of I<sv>. The characters
1035 are recoded for the lexer buffer, according to how the buffer is currently
1036 being interpreted (L</lex_bufutf8>). If a string to be interpreted is
1037 not already a Perl scalar, the L</lex_stuff_pvn> function avoids the
1038 need to construct a scalar.
1044 Perl_lex_stuff_sv(pTHX_ SV *sv, U32 flags)
1048 PERL_ARGS_ASSERT_LEX_STUFF_SV;
1050 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_stuff_sv");
1052 lex_stuff_pvn(pv, len, flags | (SvUTF8(sv) ? LEX_STUFF_UTF8 : 0));
1056 =for apidoc Amx|void|lex_unstuff|char *ptr
1058 Discards text about to be lexed, from L</PL_parser-E<gt>bufptr> up to
1059 I<ptr>. Text following I<ptr> will be moved, and the buffer shortened.
1060 This hides the discarded text from any lexing code that runs later,
1061 as if the text had never appeared.
1063 This is not the normal way to consume lexed text. For that, use
1070 Perl_lex_unstuff(pTHX_ char *ptr)
1074 PERL_ARGS_ASSERT_LEX_UNSTUFF;
1075 buf = PL_parser->bufptr;
1077 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_unstuff");
1080 bufend = PL_parser->bufend;
1082 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_unstuff");
1083 unstuff_len = ptr - buf;
1084 Move(ptr, buf, bufend+1-ptr, char);
1085 SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) - unstuff_len);
1086 PL_parser->bufend = bufend - unstuff_len;
1090 =for apidoc Amx|void|lex_read_to|char *ptr
1092 Consume text in the lexer buffer, from L</PL_parser-E<gt>bufptr> up
1093 to I<ptr>. This advances L</PL_parser-E<gt>bufptr> to match I<ptr>,
1094 performing the correct bookkeeping whenever a newline character is passed.
1095 This is the normal way to consume lexed text.
1097 Interpretation of the buffer's octets can be abstracted out by
1098 using the slightly higher-level functions L</lex_peek_unichar> and
1099 L</lex_read_unichar>.
1105 Perl_lex_read_to(pTHX_ char *ptr)
1108 PERL_ARGS_ASSERT_LEX_READ_TO;
1109 s = PL_parser->bufptr;
1110 if (ptr < s || ptr > PL_parser->bufend)
1111 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_to");
1112 for (; s != ptr; s++)
1114 CopLINE_inc(PL_curcop);
1115 PL_parser->linestart = s+1;
1117 PL_parser->bufptr = ptr;
1121 =for apidoc Amx|void|lex_discard_to|char *ptr
1123 Discards the first part of the L</PL_parser-E<gt>linestr> buffer,
1124 up to I<ptr>. The remaining content of the buffer will be moved, and
1125 all pointers into the buffer updated appropriately. I<ptr> must not
1126 be later in the buffer than the position of L</PL_parser-E<gt>bufptr>:
1127 it is not permitted to discard text that has yet to be lexed.
1129 Normally it is not necessarily to do this directly, because it suffices to
1130 use the implicit discarding behaviour of L</lex_next_chunk> and things
1131 based on it. However, if a token stretches across multiple lines,
1132 and the lexing code has kept multiple lines of text in the buffer for
1133 that purpose, then after completion of the token it would be wise to
1134 explicitly discard the now-unneeded earlier lines, to avoid future
1135 multi-line tokens growing the buffer without bound.
1141 Perl_lex_discard_to(pTHX_ char *ptr)
1145 PERL_ARGS_ASSERT_LEX_DISCARD_TO;
1146 buf = SvPVX(PL_parser->linestr);
1148 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_discard_to");
1151 if (ptr > PL_parser->bufptr)
1152 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_discard_to");
1153 discard_len = ptr - buf;
1154 if (PL_parser->oldbufptr < ptr)
1155 PL_parser->oldbufptr = ptr;
1156 if (PL_parser->oldoldbufptr < ptr)
1157 PL_parser->oldoldbufptr = ptr;
1158 if (PL_parser->last_uni && PL_parser->last_uni < ptr)
1159 PL_parser->last_uni = NULL;
1160 if (PL_parser->last_lop && PL_parser->last_lop < ptr)
1161 PL_parser->last_lop = NULL;
1162 Move(ptr, buf, PL_parser->bufend+1-ptr, char);
1163 SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) - discard_len);
1164 PL_parser->bufend -= discard_len;
1165 PL_parser->bufptr -= discard_len;
1166 PL_parser->oldbufptr -= discard_len;
1167 PL_parser->oldoldbufptr -= discard_len;
1168 if (PL_parser->last_uni)
1169 PL_parser->last_uni -= discard_len;
1170 if (PL_parser->last_lop)
1171 PL_parser->last_lop -= discard_len;
1175 =for apidoc Amx|bool|lex_next_chunk|U32 flags
1177 Reads in the next chunk of text to be lexed, appending it to
1178 L</PL_parser-E<gt>linestr>. This should be called when lexing code has
1179 looked to the end of the current chunk and wants to know more. It is
1180 usual, but not necessary, for lexing to have consumed the entirety of
1181 the current chunk at this time.
1183 If L</PL_parser-E<gt>bufptr> is pointing to the very end of the current
1184 chunk (i.e., the current chunk has been entirely consumed), normally the
1185 current chunk will be discarded at the same time that the new chunk is
1186 read in. If I<flags> includes C<LEX_KEEP_PREVIOUS>, the current chunk
1187 will not be discarded. If the current chunk has not been entirely
1188 consumed, then it will not be discarded regardless of the flag.
1190 Returns true if some new text was added to the buffer, or false if the
1191 buffer has reached the end of the input text.
1196 #define LEX_FAKE_EOF 0x80000000
1199 Perl_lex_next_chunk(pTHX_ U32 flags)
1203 STRLEN old_bufend_pos, new_bufend_pos;
1204 STRLEN bufptr_pos, oldbufptr_pos, oldoldbufptr_pos;
1205 STRLEN linestart_pos, last_uni_pos, last_lop_pos;
1206 bool got_some_for_debugger = 0;
1208 if (flags & ~(LEX_KEEP_PREVIOUS|LEX_FAKE_EOF))
1209 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_next_chunk");
1210 linestr = PL_parser->linestr;
1211 buf = SvPVX(linestr);
1212 if (!(flags & LEX_KEEP_PREVIOUS) &&
1213 PL_parser->bufptr == PL_parser->bufend) {
1214 old_bufend_pos = bufptr_pos = oldbufptr_pos = oldoldbufptr_pos = 0;
1216 if (PL_parser->last_uni != PL_parser->bufend)
1217 PL_parser->last_uni = NULL;
1218 if (PL_parser->last_lop != PL_parser->bufend)
1219 PL_parser->last_lop = NULL;
1220 last_uni_pos = last_lop_pos = 0;
1224 old_bufend_pos = PL_parser->bufend - buf;
1225 bufptr_pos = PL_parser->bufptr - buf;
1226 oldbufptr_pos = PL_parser->oldbufptr - buf;
1227 oldoldbufptr_pos = PL_parser->oldoldbufptr - buf;
1228 linestart_pos = PL_parser->linestart - buf;
1229 last_uni_pos = PL_parser->last_uni ? PL_parser->last_uni - buf : 0;
1230 last_lop_pos = PL_parser->last_lop ? PL_parser->last_lop - buf : 0;
1232 if (flags & LEX_FAKE_EOF) {
1234 } else if (!PL_parser->rsfp) {
1236 } else if (filter_gets(linestr, old_bufend_pos)) {
1238 got_some_for_debugger = 1;
1240 if (!SvPOK(linestr)) /* can get undefined by filter_gets */
1241 sv_setpvs(linestr, "");
1243 /* End of real input. Close filehandle (unless it was STDIN),
1244 * then add implicit termination.
1246 if ((PerlIO*)PL_parser->rsfp == PerlIO_stdin())
1247 PerlIO_clearerr(PL_parser->rsfp);
1248 else if (PL_parser->rsfp)
1249 (void)PerlIO_close(PL_parser->rsfp);
1250 PL_parser->rsfp = NULL;
1251 PL_doextract = FALSE;
1253 if (PL_madskills && !PL_in_eval && (PL_minus_p || PL_minus_n))
1256 if (!PL_in_eval && PL_minus_p) {
1258 /*{*/";}continue{print or die qq(-p destination: $!\\n);}");
1259 PL_minus_n = PL_minus_p = 0;
1260 } else if (!PL_in_eval && PL_minus_n) {
1261 sv_catpvs(linestr, /*{*/";}");
1264 sv_catpvs(linestr, ";");
1267 buf = SvPVX(linestr);
1268 new_bufend_pos = SvCUR(linestr);
1269 PL_parser->bufend = buf + new_bufend_pos;
1270 PL_parser->bufptr = buf + bufptr_pos;
1271 PL_parser->oldbufptr = buf + oldbufptr_pos;
1272 PL_parser->oldoldbufptr = buf + oldoldbufptr_pos;
1273 PL_parser->linestart = buf + linestart_pos;
1274 if (PL_parser->last_uni)
1275 PL_parser->last_uni = buf + last_uni_pos;
1276 if (PL_parser->last_lop)
1277 PL_parser->last_lop = buf + last_lop_pos;
1278 if (got_some_for_debugger && (PERLDB_LINE || PERLDB_SAVESRC) &&
1279 PL_curstash != PL_debstash) {
1280 /* debugger active and we're not compiling the debugger code,
1281 * so store the line into the debugger's array of lines
1283 update_debugger_info(NULL, buf+old_bufend_pos,
1284 new_bufend_pos-old_bufend_pos);
1290 =for apidoc Amx|I32|lex_peek_unichar|U32 flags
1292 Looks ahead one (Unicode) character in the text currently being lexed.
1293 Returns the codepoint (unsigned integer value) of the next character,
1294 or -1 if lexing has reached the end of the input text. To consume the
1295 peeked character, use L</lex_read_unichar>.
1297 If the next character is in (or extends into) the next chunk of input
1298 text, the next chunk will be read in. Normally the current chunk will be
1299 discarded at the same time, but if I<flags> includes C<LEX_KEEP_PREVIOUS>
1300 then the current chunk will not be discarded.
1302 If the input is being interpreted as UTF-8 and a UTF-8 encoding error
1303 is encountered, an exception is generated.
1309 Perl_lex_peek_unichar(pTHX_ U32 flags)
1313 if (flags & ~(LEX_KEEP_PREVIOUS))
1314 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_peek_unichar");
1315 s = PL_parser->bufptr;
1316 bufend = PL_parser->bufend;
1322 if (!lex_next_chunk(flags))
1324 s = PL_parser->bufptr;
1325 bufend = PL_parser->bufend;
1331 len = PL_utf8skip[head];
1332 while ((STRLEN)(bufend-s) < len) {
1333 if (!lex_next_chunk(flags | LEX_KEEP_PREVIOUS))
1335 s = PL_parser->bufptr;
1336 bufend = PL_parser->bufend;
1339 unichar = utf8n_to_uvuni((U8*)s, bufend-s, &retlen, UTF8_CHECK_ONLY);
1340 if (retlen == (STRLEN)-1) {
1341 /* malformed UTF-8 */
1343 SAVESPTR(PL_warnhook);
1344 PL_warnhook = PERL_WARNHOOK_FATAL;
1345 utf8n_to_uvuni((U8*)s, bufend-s, NULL, 0);
1351 if (!lex_next_chunk(flags))
1353 s = PL_parser->bufptr;
1360 =for apidoc Amx|I32|lex_read_unichar|U32 flags
1362 Reads the next (Unicode) character in the text currently being lexed.
1363 Returns the codepoint (unsigned integer value) of the character read,
1364 and moves L</PL_parser-E<gt>bufptr> past the character, or returns -1
1365 if lexing has reached the end of the input text. To non-destructively
1366 examine the next character, use L</lex_peek_unichar> instead.
1368 If the next character is in (or extends into) the next chunk of input
1369 text, the next chunk will be read in. Normally the current chunk will be
1370 discarded at the same time, but if I<flags> includes C<LEX_KEEP_PREVIOUS>
1371 then the current chunk will not be discarded.
1373 If the input is being interpreted as UTF-8 and a UTF-8 encoding error
1374 is encountered, an exception is generated.
1380 Perl_lex_read_unichar(pTHX_ U32 flags)
1383 if (flags & ~(LEX_KEEP_PREVIOUS))
1384 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_unichar");
1385 c = lex_peek_unichar(flags);
1388 CopLINE_inc(PL_curcop);
1389 PL_parser->bufptr += UTF8SKIP(PL_parser->bufptr);
1395 =for apidoc Amx|void|lex_read_space|U32 flags
1397 Reads optional spaces, in Perl style, in the text currently being
1398 lexed. The spaces may include ordinary whitespace characters and
1399 Perl-style comments. C<#line> directives are processed if encountered.
1400 L</PL_parser-E<gt>bufptr> is moved past the spaces, so that it points
1401 at a non-space character (or the end of the input text).
1403 If spaces extend into the next chunk of input text, the next chunk will
1404 be read in. Normally the current chunk will be discarded at the same
1405 time, but if I<flags> includes C<LEX_KEEP_PREVIOUS> then the current
1406 chunk will not be discarded.
1411 #define LEX_NO_NEXT_CHUNK 0x80000000
1414 Perl_lex_read_space(pTHX_ U32 flags)
1417 bool need_incline = 0;
1418 if (flags & ~(LEX_KEEP_PREVIOUS|LEX_NO_NEXT_CHUNK))
1419 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_space");
1422 sv_free(PL_skipwhite);
1423 PL_skipwhite = NULL;
1426 PL_skipwhite = newSVpvs("");
1427 #endif /* PERL_MAD */
1428 s = PL_parser->bufptr;
1429 bufend = PL_parser->bufend;
1435 } while (!(c == '\n' || (c == 0 && s == bufend)));
1436 } else if (c == '\n') {
1438 PL_parser->linestart = s;
1443 } else if (isSPACE(c)) {
1445 } else if (c == 0 && s == bufend) {
1449 sv_catpvn(PL_skipwhite, PL_parser->bufptr, s-PL_parser->bufptr);
1450 #endif /* PERL_MAD */
1451 if (flags & LEX_NO_NEXT_CHUNK)
1453 PL_parser->bufptr = s;
1454 CopLINE_inc(PL_curcop);
1455 got_more = lex_next_chunk(flags);
1456 CopLINE_dec(PL_curcop);
1457 s = PL_parser->bufptr;
1458 bufend = PL_parser->bufend;
1461 if (need_incline && PL_parser->rsfp) {
1471 sv_catpvn(PL_skipwhite, PL_parser->bufptr, s-PL_parser->bufptr);
1472 #endif /* PERL_MAD */
1473 PL_parser->bufptr = s;
1478 * This subroutine has nothing to do with tilting, whether at windmills
1479 * or pinball tables. Its name is short for "increment line". It
1480 * increments the current line number in CopLINE(PL_curcop) and checks
1481 * to see whether the line starts with a comment of the form
1482 * # line 500 "foo.pm"
1483 * If so, it sets the current line number and file to the values in the comment.
1487 S_incline(pTHX_ const char *s)
1494 PERL_ARGS_ASSERT_INCLINE;
1496 CopLINE_inc(PL_curcop);
1499 while (SPACE_OR_TAB(*s))
1501 if (strnEQ(s, "line", 4))
1505 if (SPACE_OR_TAB(*s))
1509 while (SPACE_OR_TAB(*s))
1517 if (!SPACE_OR_TAB(*s) && *s != '\r' && *s != '\n' && *s != '\0')
1519 while (SPACE_OR_TAB(*s))
1521 if (*s == '"' && (t = strchr(s+1, '"'))) {
1527 while (!isSPACE(*t))
1531 while (SPACE_OR_TAB(*e) || *e == '\r' || *e == '\f')
1533 if (*e != '\n' && *e != '\0')
1534 return; /* false alarm */
1537 const STRLEN len = t - s;
1538 #ifndef USE_ITHREADS
1539 SV *const temp_sv = CopFILESV(PL_curcop);
1544 cf = SvPVX(temp_sv);
1545 tmplen = SvCUR(temp_sv);
1551 if (tmplen > 7 && strnEQ(cf, "(eval ", 6)) {
1552 /* must copy *{"::_<(eval N)[oldfilename:L]"}
1553 * to *{"::_<newfilename"} */
1554 /* However, the long form of evals is only turned on by the
1555 debugger - usually they're "(eval %lu)" */
1559 STRLEN tmplen2 = len;
1560 if (tmplen + 2 <= sizeof smallbuf)
1563 Newx(tmpbuf, tmplen + 2, char);
1566 memcpy(tmpbuf + 2, cf, tmplen);
1568 gvp = (GV**)hv_fetch(PL_defstash, tmpbuf, tmplen, FALSE);
1573 if (tmplen2 + 2 <= sizeof smallbuf)
1576 Newx(tmpbuf2, tmplen2 + 2, char);
1578 if (tmpbuf2 != smallbuf || tmpbuf != smallbuf) {
1579 /* Either they malloc'd it, or we malloc'd it,
1580 so no prefix is present in ours. */
1585 memcpy(tmpbuf2 + 2, s, tmplen2);
1588 gv2 = *(GV**)hv_fetch(PL_defstash, tmpbuf2, tmplen2, TRUE);
1590 gv_init(gv2, PL_defstash, tmpbuf2, tmplen2, FALSE);
1591 /* adjust ${"::_<newfilename"} to store the new file name */
1592 GvSV(gv2) = newSVpvn(tmpbuf2 + 2, tmplen2 - 2);
1593 GvHV(gv2) = MUTABLE_HV(SvREFCNT_inc(GvHV(*gvp)));
1594 GvAV(gv2) = MUTABLE_AV(SvREFCNT_inc(GvAV(*gvp)));
1597 if (tmpbuf2 != smallbuf) Safefree(tmpbuf2);
1599 if (tmpbuf != smallbuf) Safefree(tmpbuf);
1602 CopFILE_free(PL_curcop);
1603 CopFILE_setn(PL_curcop, s, len);
1605 CopLINE_set(PL_curcop, atoi(n)-1);
1609 /* skip space before PL_thistoken */
1612 S_skipspace0(pTHX_ register char *s)
1614 PERL_ARGS_ASSERT_SKIPSPACE0;
1621 PL_thiswhite = newSVpvs("");
1622 sv_catsv(PL_thiswhite, PL_skipwhite);
1623 sv_free(PL_skipwhite);
1626 PL_realtokenstart = s - SvPVX(PL_linestr);
1630 /* skip space after PL_thistoken */
1633 S_skipspace1(pTHX_ register char *s)
1635 const char *start = s;
1636 I32 startoff = start - SvPVX(PL_linestr);
1638 PERL_ARGS_ASSERT_SKIPSPACE1;
1643 start = SvPVX(PL_linestr) + startoff;
1644 if (!PL_thistoken && PL_realtokenstart >= 0) {
1645 const char * const tstart = SvPVX(PL_linestr) + PL_realtokenstart;
1646 PL_thistoken = newSVpvn(tstart, start - tstart);
1648 PL_realtokenstart = -1;
1651 PL_nextwhite = newSVpvs("");
1652 sv_catsv(PL_nextwhite, PL_skipwhite);
1653 sv_free(PL_skipwhite);
1660 S_skipspace2(pTHX_ register char *s, SV **svp)
1663 const I32 bufptroff = PL_bufptr - SvPVX(PL_linestr);
1664 const I32 startoff = s - SvPVX(PL_linestr);
1666 PERL_ARGS_ASSERT_SKIPSPACE2;
1669 PL_bufptr = SvPVX(PL_linestr) + bufptroff;
1670 if (!PL_madskills || !svp)
1672 start = SvPVX(PL_linestr) + startoff;
1673 if (!PL_thistoken && PL_realtokenstart >= 0) {
1674 char * const tstart = SvPVX(PL_linestr) + PL_realtokenstart;
1675 PL_thistoken = newSVpvn(tstart, start - tstart);
1676 PL_realtokenstart = -1;
1680 *svp = newSVpvs("");
1681 sv_setsv(*svp, PL_skipwhite);
1682 sv_free(PL_skipwhite);
1691 S_update_debugger_info(pTHX_ SV *orig_sv, const char *const buf, STRLEN len)
1693 AV *av = CopFILEAVx(PL_curcop);
1695 SV * const sv = newSV_type(SVt_PVMG);
1697 sv_setsv(sv, orig_sv);
1699 sv_setpvn(sv, buf, len);
1702 av_store(av, (I32)CopLINE(PL_curcop), sv);
1708 * Called to gobble the appropriate amount and type of whitespace.
1709 * Skips comments as well.
1713 S_skipspace(pTHX_ register char *s)
1717 #endif /* PERL_MAD */
1718 PERL_ARGS_ASSERT_SKIPSPACE;
1721 sv_free(PL_skipwhite);
1722 PL_skipwhite = NULL;
1724 #endif /* PERL_MAD */
1725 if (PL_lex_formbrack && PL_lex_brackets <= PL_lex_formbrack) {
1726 while (s < PL_bufend && SPACE_OR_TAB(*s))
1729 STRLEN bufptr_pos = PL_bufptr - SvPVX(PL_linestr);
1731 lex_read_space(LEX_KEEP_PREVIOUS |
1732 (PL_sublex_info.sub_inwhat || PL_lex_state == LEX_FORMLINE ?
1733 LEX_NO_NEXT_CHUNK : 0));
1735 PL_bufptr = SvPVX(PL_linestr) + bufptr_pos;
1736 if (PL_linestart > PL_bufptr)
1737 PL_bufptr = PL_linestart;
1742 PL_skipwhite = newSVpvn(start, s-start);
1743 #endif /* PERL_MAD */
1749 * Check the unary operators to ensure there's no ambiguity in how they're
1750 * used. An ambiguous piece of code would be:
1752 * This doesn't mean rand() + 5. Because rand() is a unary operator,
1753 * the +5 is its argument.
1763 if (PL_oldoldbufptr != PL_last_uni)
1765 while (isSPACE(*PL_last_uni))
1768 while (isALNUM_lazy_if(s,UTF) || *s == '-')
1770 if ((t = strchr(s, '(')) && t < PL_bufptr)
1773 Perl_ck_warner_d(aTHX_ packWARN(WARN_AMBIGUOUS),
1774 "Warning: Use of \"%.*s\" without parentheses is ambiguous",
1775 (int)(s - PL_last_uni), PL_last_uni);
1779 * LOP : macro to build a list operator. Its behaviour has been replaced
1780 * with a subroutine, S_lop() for which LOP is just another name.
1783 #define LOP(f,x) return lop(f,x,s)
1787 * Build a list operator (or something that might be one). The rules:
1788 * - if we have a next token, then it's a list operator [why?]
1789 * - if the next thing is an opening paren, then it's a function
1790 * - else it's a list operator
1794 S_lop(pTHX_ I32 f, int x, char *s)
1798 PERL_ARGS_ASSERT_LOP;
1804 PL_last_lop = PL_oldbufptr;
1805 PL_last_lop_op = (OPCODE)f;
1808 return REPORT(LSTOP);
1811 return REPORT(LSTOP);
1814 return REPORT(FUNC);
1817 return REPORT(FUNC);
1819 return REPORT(LSTOP);
1825 * Sets up for an eventual force_next(). start_force(0) basically does
1826 * an unshift, while start_force(-1) does a push. yylex removes items
1831 S_start_force(pTHX_ int where)
1835 if (where < 0) /* so people can duplicate start_force(PL_curforce) */
1836 where = PL_lasttoke;
1837 assert(PL_curforce < 0 || PL_curforce == where);
1838 if (PL_curforce != where) {
1839 for (i = PL_lasttoke; i > where; --i) {
1840 PL_nexttoke[i] = PL_nexttoke[i-1];
1844 if (PL_curforce < 0) /* in case of duplicate start_force() */
1845 Zero(&PL_nexttoke[where], 1, NEXTTOKE);
1846 PL_curforce = where;
1849 curmad('^', newSVpvs(""));
1850 CURMAD('_', PL_nextwhite);
1855 S_curmad(pTHX_ char slot, SV *sv)
1861 if (PL_curforce < 0)
1862 where = &PL_thismad;
1864 where = &PL_nexttoke[PL_curforce].next_mad;
1870 if (UTF && is_utf8_string((U8*)SvPVX(sv), SvCUR(sv)))
1872 else if (PL_encoding) {
1873 sv_recode_to_utf8(sv, PL_encoding);
1878 /* keep a slot open for the head of the list? */
1879 if (slot != '_' && *where && (*where)->mad_key == '^') {
1880 (*where)->mad_key = slot;
1881 sv_free(MUTABLE_SV(((*where)->mad_val)));
1882 (*where)->mad_val = (void*)sv;
1885 addmad(newMADsv(slot, sv), where, 0);
1888 # define start_force(where) NOOP
1889 # define curmad(slot, sv) NOOP
1894 * When the lexer realizes it knows the next token (for instance,
1895 * it is reordering tokens for the parser) then it can call S_force_next
1896 * to know what token to return the next time the lexer is called. Caller
1897 * will need to set PL_nextval[] (or PL_nexttoke[].next_val with PERL_MAD),
1898 * and possibly PL_expect to ensure the lexer handles the token correctly.
1902 S_force_next(pTHX_ I32 type)
1907 PerlIO_printf(Perl_debug_log, "### forced token:\n");
1908 tokereport(type, &NEXTVAL_NEXTTOKE);
1912 if (PL_curforce < 0)
1913 start_force(PL_lasttoke);
1914 PL_nexttoke[PL_curforce].next_type = type;
1915 if (PL_lex_state != LEX_KNOWNEXT)
1916 PL_lex_defer = PL_lex_state;
1917 PL_lex_state = LEX_KNOWNEXT;
1918 PL_lex_expect = PL_expect;
1921 PL_nexttype[PL_nexttoke] = type;
1923 if (PL_lex_state != LEX_KNOWNEXT) {
1924 PL_lex_defer = PL_lex_state;
1925 PL_lex_expect = PL_expect;
1926 PL_lex_state = LEX_KNOWNEXT;
1932 S_newSV_maybe_utf8(pTHX_ const char *const start, STRLEN len)
1935 SV * const sv = newSVpvn_utf8(start, len,
1938 && !is_ascii_string((const U8*)start, len)
1939 && is_utf8_string((const U8*)start, len));
1945 * When the lexer knows the next thing is a word (for instance, it has
1946 * just seen -> and it knows that the next char is a word char, then
1947 * it calls S_force_word to stick the next word into the PL_nexttoke/val
1951 * char *start : buffer position (must be within PL_linestr)
1952 * int token : PL_next* will be this type of bare word (e.g., METHOD,WORD)
1953 * int check_keyword : if true, Perl checks to make sure the word isn't
1954 * a keyword (do this if the word is a label, e.g. goto FOO)
1955 * int allow_pack : if true, : characters will also be allowed (require,
1956 * use, etc. do this)
1957 * int allow_initial_tick : used by the "sub" lexer only.
1961 S_force_word(pTHX_ register char *start, int token, int check_keyword, int allow_pack, int allow_initial_tick)
1967 PERL_ARGS_ASSERT_FORCE_WORD;
1969 start = SKIPSPACE1(start);
1971 if (isIDFIRST_lazy_if(s,UTF) ||
1972 (allow_pack && *s == ':') ||
1973 (allow_initial_tick && *s == '\'') )
1975 s = scan_word(s, PL_tokenbuf, sizeof PL_tokenbuf, allow_pack, &len);
1976 if (check_keyword && keyword(PL_tokenbuf, len, 0))
1978 start_force(PL_curforce);
1980 curmad('X', newSVpvn(start,s-start));
1981 if (token == METHOD) {
1986 PL_expect = XOPERATOR;
1990 curmad('g', newSVpvs( "forced" ));
1991 NEXTVAL_NEXTTOKE.opval
1992 = (OP*)newSVOP(OP_CONST,0,
1993 S_newSV_maybe_utf8(aTHX_ PL_tokenbuf, len));
1994 NEXTVAL_NEXTTOKE.opval->op_private |= OPpCONST_BARE;
2002 * Called when the lexer wants $foo *foo &foo etc, but the program
2003 * text only contains the "foo" portion. The first argument is a pointer
2004 * to the "foo", and the second argument is the type symbol to prefix.
2005 * Forces the next token to be a "WORD".
2006 * Creates the symbol if it didn't already exist (via gv_fetchpv()).
2010 S_force_ident(pTHX_ register const char *s, int kind)
2014 PERL_ARGS_ASSERT_FORCE_IDENT;
2017 const STRLEN len = strlen(s);
2018 OP* const o = (OP*)newSVOP(OP_CONST, 0, newSVpvn(s, len));
2019 start_force(PL_curforce);
2020 NEXTVAL_NEXTTOKE.opval = o;
2023 o->op_private = OPpCONST_ENTERED;
2024 /* XXX see note in pp_entereval() for why we forgo typo
2025 warnings if the symbol must be introduced in an eval.
2027 gv_fetchpvn_flags(s, len,
2028 PL_in_eval ? (GV_ADDMULTI | GV_ADDINEVAL)
2030 kind == '$' ? SVt_PV :
2031 kind == '@' ? SVt_PVAV :
2032 kind == '%' ? SVt_PVHV :
2040 Perl_str_to_version(pTHX_ SV *sv)
2045 const char *start = SvPV_const(sv,len);
2046 const char * const end = start + len;
2047 const bool utf = SvUTF8(sv) ? TRUE : FALSE;
2049 PERL_ARGS_ASSERT_STR_TO_VERSION;
2051 while (start < end) {
2055 n = utf8n_to_uvchr((U8*)start, len, &skip, 0);
2060 retval += ((NV)n)/nshift;
2069 * Forces the next token to be a version number.
2070 * If the next token appears to be an invalid version number, (e.g. "v2b"),
2071 * and if "guessing" is TRUE, then no new token is created (and the caller
2072 * must use an alternative parsing method).
2076 S_force_version(pTHX_ char *s, int guessing)
2082 I32 startoff = s - SvPVX(PL_linestr);
2085 PERL_ARGS_ASSERT_FORCE_VERSION;
2093 while (isDIGIT(*d) || *d == '_' || *d == '.')
2097 start_force(PL_curforce);
2098 curmad('X', newSVpvn(s,d-s));
2101 if (*d == ';' || isSPACE(*d) || *d == '}' || !*d) {
2103 #ifdef USE_LOCALE_NUMERIC
2104 char *loc = setlocale(LC_NUMERIC, "C");
2106 s = scan_num(s, &pl_yylval);
2107 #ifdef USE_LOCALE_NUMERIC
2108 setlocale(LC_NUMERIC, loc);
2110 version = pl_yylval.opval;
2111 ver = cSVOPx(version)->op_sv;
2112 if (SvPOK(ver) && !SvNIOK(ver)) {
2113 SvUPGRADE(ver, SVt_PVNV);
2114 SvNV_set(ver, str_to_version(ver));
2115 SvNOK_on(ver); /* hint that it is a version */
2118 else if (guessing) {
2121 sv_free(PL_nextwhite); /* let next token collect whitespace */
2123 s = SvPVX(PL_linestr) + startoff;
2131 if (PL_madskills && !version) {
2132 sv_free(PL_nextwhite); /* let next token collect whitespace */
2134 s = SvPVX(PL_linestr) + startoff;
2137 /* NOTE: The parser sees the package name and the VERSION swapped */
2138 start_force(PL_curforce);
2139 NEXTVAL_NEXTTOKE.opval = version;
2146 * S_force_strict_version
2147 * Forces the next token to be a version number using strict syntax rules.
2151 S_force_strict_version(pTHX_ char *s)
2156 I32 startoff = s - SvPVX(PL_linestr);
2158 const char *errstr = NULL;
2160 PERL_ARGS_ASSERT_FORCE_STRICT_VERSION;
2162 while (isSPACE(*s)) /* leading whitespace */
2165 if (is_STRICT_VERSION(s,&errstr)) {
2167 s = (char *)scan_version(s, ver, 0);
2168 version = newSVOP(OP_CONST, 0, ver);
2170 else if ( (*s != ';' && *s != '}' ) && (s = SKIPSPACE1(s), (*s != ';' && *s !='}' ))) {
2173 yyerror(errstr); /* version required */
2178 if (PL_madskills && !version) {
2179 sv_free(PL_nextwhite); /* let next token collect whitespace */
2181 s = SvPVX(PL_linestr) + startoff;
2184 /* NOTE: The parser sees the package name and the VERSION swapped */
2185 start_force(PL_curforce);
2186 NEXTVAL_NEXTTOKE.opval = version;
2194 * Tokenize a quoted string passed in as an SV. It finds the next
2195 * chunk, up to end of string or a backslash. It may make a new
2196 * SV containing that chunk (if HINT_NEW_STRING is on). It also
2201 S_tokeq(pTHX_ SV *sv)
2205 register char *send;
2210 PERL_ARGS_ASSERT_TOKEQ;
2215 s = SvPV_force(sv, len);
2216 if (SvTYPE(sv) >= SVt_PVIV && SvIVX(sv) == -1)
2219 while (s < send && *s != '\\')
2224 if ( PL_hints & HINT_NEW_STRING ) {
2225 pv = newSVpvn_flags(SvPVX_const(pv), len, SVs_TEMP | SvUTF8(sv));
2229 if (s + 1 < send && (s[1] == '\\'))
2230 s++; /* all that, just for this */
2235 SvCUR_set(sv, d - SvPVX_const(sv));
2237 if ( PL_hints & HINT_NEW_STRING )
2238 return new_constant(NULL, 0, "q", sv, pv, "q", 1);
2243 * Now come three functions related to double-quote context,
2244 * S_sublex_start, S_sublex_push, and S_sublex_done. They're used when
2245 * converting things like "\u\Lgnat" into ucfirst(lc("gnat")). They
2246 * interact with PL_lex_state, and create fake ( ... ) argument lists
2247 * to handle functions and concatenation.
2248 * They assume that whoever calls them will be setting up a fake
2249 * join call, because each subthing puts a ',' after it. This lets
2252 * join($, , 'lower ', lcfirst( 'uPpEr', ) ,)
2254 * (I'm not sure whether the spurious commas at the end of lcfirst's
2255 * arguments and join's arguments are created or not).
2260 * Assumes that pl_yylval.ival is the op we're creating (e.g. OP_LCFIRST).
2262 * Pattern matching will set PL_lex_op to the pattern-matching op to
2263 * make (we return THING if pl_yylval.ival is OP_NULL, PMFUNC otherwise).
2265 * OP_CONST and OP_READLINE are easy--just make the new op and return.
2267 * Everything else becomes a FUNC.
2269 * Sets PL_lex_state to LEX_INTERPPUSH unless (ival was OP_NULL or we
2270 * had an OP_CONST or OP_READLINE). This just sets us up for a
2271 * call to S_sublex_push().
2275 S_sublex_start(pTHX)
2278 register const I32 op_type = pl_yylval.ival;
2280 if (op_type == OP_NULL) {
2281 pl_yylval.opval = PL_lex_op;
2285 if (op_type == OP_CONST || op_type == OP_READLINE) {
2286 SV *sv = tokeq(PL_lex_stuff);
2288 if (SvTYPE(sv) == SVt_PVIV) {
2289 /* Overloaded constants, nothing fancy: Convert to SVt_PV: */
2291 const char * const p = SvPV_const(sv, len);
2292 SV * const nsv = newSVpvn_flags(p, len, SvUTF8(sv));
2296 pl_yylval.opval = (OP*)newSVOP(op_type, 0, sv);
2297 PL_lex_stuff = NULL;
2298 /* Allow <FH> // "foo" */
2299 if (op_type == OP_READLINE)
2300 PL_expect = XTERMORDORDOR;
2303 else if (op_type == OP_BACKTICK && PL_lex_op) {
2304 /* readpipe() vas overriden */
2305 cSVOPx(cLISTOPx(cUNOPx(PL_lex_op)->op_first)->op_first->op_sibling)->op_sv = tokeq(PL_lex_stuff);
2306 pl_yylval.opval = PL_lex_op;
2308 PL_lex_stuff = NULL;
2312 PL_sublex_info.super_state = PL_lex_state;
2313 PL_sublex_info.sub_inwhat = (U16)op_type;
2314 PL_sublex_info.sub_op = PL_lex_op;
2315 PL_lex_state = LEX_INTERPPUSH;
2319 pl_yylval.opval = PL_lex_op;
2329 * Create a new scope to save the lexing state. The scope will be
2330 * ended in S_sublex_done. Returns a '(', starting the function arguments
2331 * to the uc, lc, etc. found before.
2332 * Sets PL_lex_state to LEX_INTERPCONCAT.
2341 PL_lex_state = PL_sublex_info.super_state;
2342 SAVEBOOL(PL_lex_dojoin);
2343 SAVEI32(PL_lex_brackets);
2344 SAVEI32(PL_lex_casemods);
2345 SAVEI32(PL_lex_starts);
2346 SAVEI8(PL_lex_state);
2347 SAVEVPTR(PL_lex_inpat);
2348 SAVEI16(PL_lex_inwhat);
2349 SAVECOPLINE(PL_curcop);
2350 SAVEPPTR(PL_bufptr);
2351 SAVEPPTR(PL_bufend);
2352 SAVEPPTR(PL_oldbufptr);
2353 SAVEPPTR(PL_oldoldbufptr);
2354 SAVEPPTR(PL_last_lop);
2355 SAVEPPTR(PL_last_uni);
2356 SAVEPPTR(PL_linestart);
2357 SAVESPTR(PL_linestr);
2358 SAVEGENERICPV(PL_lex_brackstack);
2359 SAVEGENERICPV(PL_lex_casestack);
2361 PL_linestr = PL_lex_stuff;
2362 PL_lex_stuff = NULL;
2364 PL_bufend = PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart
2365 = SvPVX(PL_linestr);
2366 PL_bufend += SvCUR(PL_linestr);
2367 PL_last_lop = PL_last_uni = NULL;
2368 SAVEFREESV(PL_linestr);
2370 PL_lex_dojoin = FALSE;
2371 PL_lex_brackets = 0;
2372 Newx(PL_lex_brackstack, 120, char);
2373 Newx(PL_lex_casestack, 12, char);
2374 PL_lex_casemods = 0;
2375 *PL_lex_casestack = '\0';
2377 PL_lex_state = LEX_INTERPCONCAT;
2378 CopLINE_set(PL_curcop, (line_t)PL_multi_start);
2380 PL_lex_inwhat = PL_sublex_info.sub_inwhat;
2381 if (PL_lex_inwhat == OP_MATCH || PL_lex_inwhat == OP_QR || PL_lex_inwhat == OP_SUBST)
2382 PL_lex_inpat = PL_sublex_info.sub_op;
2384 PL_lex_inpat = NULL;
2391 * Restores lexer state after a S_sublex_push.
2398 if (!PL_lex_starts++) {
2399 SV * const sv = newSVpvs("");
2400 if (SvUTF8(PL_linestr))
2402 PL_expect = XOPERATOR;
2403 pl_yylval.opval = (OP*)newSVOP(OP_CONST, 0, sv);
2407 if (PL_lex_casemods) { /* oops, we've got some unbalanced parens */
2408 PL_lex_state = LEX_INTERPCASEMOD;
2412 /* Is there a right-hand side to take care of? (s//RHS/ or tr//RHS/) */
2413 if (PL_lex_repl && (PL_lex_inwhat == OP_SUBST || PL_lex_inwhat == OP_TRANS)) {
2414 PL_linestr = PL_lex_repl;
2416 PL_bufend = PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
2417 PL_bufend += SvCUR(PL_linestr);
2418 PL_last_lop = PL_last_uni = NULL;
2419 SAVEFREESV(PL_linestr);
2420 PL_lex_dojoin = FALSE;
2421 PL_lex_brackets = 0;
2422 PL_lex_casemods = 0;
2423 *PL_lex_casestack = '\0';
2425 if (SvEVALED(PL_lex_repl)) {
2426 PL_lex_state = LEX_INTERPNORMAL;
2428 /* we don't clear PL_lex_repl here, so that we can check later
2429 whether this is an evalled subst; that means we rely on the
2430 logic to ensure sublex_done() is called again only via the
2431 branch (in yylex()) that clears PL_lex_repl, else we'll loop */
2434 PL_lex_state = LEX_INTERPCONCAT;
2444 PL_endwhite = newSVpvs("");
2445 sv_catsv(PL_endwhite, PL_thiswhite);
2449 sv_setpvs(PL_thistoken,"");
2451 PL_realtokenstart = -1;
2455 PL_bufend = SvPVX(PL_linestr);
2456 PL_bufend += SvCUR(PL_linestr);
2457 PL_expect = XOPERATOR;
2458 PL_sublex_info.sub_inwhat = 0;
2466 Extracts a pattern, double-quoted string, or transliteration. This
2469 It looks at PL_lex_inwhat and PL_lex_inpat to find out whether it's
2470 processing a pattern (PL_lex_inpat is true), a transliteration
2471 (PL_lex_inwhat == OP_TRANS is true), or a double-quoted string.
2473 Returns a pointer to the character scanned up to. If this is
2474 advanced from the start pointer supplied (i.e. if anything was
2475 successfully parsed), will leave an OP for the substring scanned
2476 in pl_yylval. Caller must intuit reason for not parsing further
2477 by looking at the next characters herself.
2481 constants: \N{NAME} only
2482 case and quoting: \U \Q \E
2483 stops on @ and $, but not for $ as tail anchor
2485 In transliterations:
2486 characters are VERY literal, except for - not at the start or end
2487 of the string, which indicates a range. If the range is in bytes,
2488 scan_const expands the range to the full set of intermediate
2489 characters. If the range is in utf8, the hyphen is replaced with
2490 a certain range mark which will be handled by pmtrans() in op.c.
2492 In double-quoted strings:
2494 double-quoted style: \r and \n
2495 constants: \x31, etc.
2496 deprecated backrefs: \1 (in substitution replacements)
2497 case and quoting: \U \Q \E
2500 scan_const does *not* construct ops to handle interpolated strings.
2501 It stops processing as soon as it finds an embedded $ or @ variable
2502 and leaves it to the caller to work out what's going on.
2504 embedded arrays (whether in pattern or not) could be:
2505 @foo, @::foo, @'foo, @{foo}, @$foo, @+, @-.
2507 $ in double-quoted strings must be the symbol of an embedded scalar.
2509 $ in pattern could be $foo or could be tail anchor. Assumption:
2510 it's a tail anchor if $ is the last thing in the string, or if it's
2511 followed by one of "()| \r\n\t"
2513 \1 (backreferences) are turned into $1
2515 The structure of the code is
2516 while (there's a character to process) {
2517 handle transliteration ranges
2518 skip regexp comments /(?#comment)/ and codes /(?{code})/
2519 skip #-initiated comments in //x patterns
2520 check for embedded arrays
2521 check for embedded scalars
2523 deprecate \1 in substitution replacements
2524 handle string-changing backslashes \l \U \Q \E, etc.
2525 switch (what was escaped) {
2526 handle \- in a transliteration (becomes a literal -)
2527 if a pattern and not \N{, go treat as regular character
2528 handle \132 (octal characters)
2529 handle \x15 and \x{1234} (hex characters)
2530 handle \N{name} (named characters, also \N{3,5} in a pattern)
2531 handle \cV (control characters)
2532 handle printf-style backslashes (\f, \r, \n, etc)
2535 } (end if backslash)
2536 handle regular character
2537 } (end while character to read)
2542 S_scan_const(pTHX_ char *start)
2545 register char *send = PL_bufend; /* end of the constant */
2546 SV *sv = newSV(send - start); /* sv for the constant. See
2547 note below on sizing. */
2548 register char *s = start; /* start of the constant */
2549 register char *d = SvPVX(sv); /* destination for copies */
2550 bool dorange = FALSE; /* are we in a translit range? */
2551 bool didrange = FALSE; /* did we just finish a range? */
2552 I32 has_utf8 = FALSE; /* Output constant is UTF8 */
2553 I32 this_utf8 = UTF; /* Is the source string assumed
2554 to be UTF8? But, this can
2555 show as true when the source
2556 isn't utf8, as for example
2557 when it is entirely composed
2560 /* Note on sizing: The scanned constant is placed into sv, which is
2561 * initialized by newSV() assuming one byte of output for every byte of
2562 * input. This routine expects newSV() to allocate an extra byte for a
2563 * trailing NUL, which this routine will append if it gets to the end of
2564 * the input. There may be more bytes of input than output (eg., \N{LATIN
2565 * CAPITAL LETTER A}), or more output than input if the constant ends up
2566 * recoded to utf8, but each time a construct is found that might increase
2567 * the needed size, SvGROW() is called. Its size parameter each time is
2568 * based on the best guess estimate at the time, namely the length used so
2569 * far, plus the length the current construct will occupy, plus room for
2570 * the trailing NUL, plus one byte for every input byte still unscanned */
2574 UV literal_endpoint = 0;
2575 bool native_range = TRUE; /* turned to FALSE if the first endpoint is Unicode. */
2578 PERL_ARGS_ASSERT_SCAN_CONST;
2580 if (PL_lex_inwhat == OP_TRANS && PL_sublex_info.sub_op) {
2581 /* If we are doing a trans and we know we want UTF8 set expectation */
2582 has_utf8 = PL_sublex_info.sub_op->op_private & (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF);
2583 this_utf8 = PL_sublex_info.sub_op->op_private & (PL_lex_repl ? OPpTRANS_FROM_UTF : OPpTRANS_TO_UTF);
2587 while (s < send || dorange) {
2589 /* get transliterations out of the way (they're most literal) */
2590 if (PL_lex_inwhat == OP_TRANS) {
2591 /* expand a range A-Z to the full set of characters. AIE! */
2593 I32 i; /* current expanded character */
2594 I32 min; /* first character in range */
2595 I32 max; /* last character in range */
2606 char * const c = (char*)utf8_hop((U8*)d, -1);
2610 *c = (char)UTF_TO_NATIVE(0xff);
2611 /* mark the range as done, and continue */
2617 i = d - SvPVX_const(sv); /* remember current offset */
2620 SvLEN(sv) + (has_utf8 ?
2621 (512 - UTF_CONTINUATION_MARK +
2624 /* How many two-byte within 0..255: 128 in UTF-8,
2625 * 96 in UTF-8-mod. */
2627 SvGROW(sv, SvLEN(sv) + 256); /* never more than 256 chars in a range */
2629 d = SvPVX(sv) + i; /* refresh d after realloc */
2633 for (j = 0; j <= 1; j++) {
2634 char * const c = (char*)utf8_hop((U8*)d, -1);
2635 const UV uv = utf8n_to_uvchr((U8*)c, d - c, NULL, 0);
2641 max = (U8)0xff; /* only to \xff */
2642 uvmax = uv; /* \x{100} to uvmax */
2644 d = c; /* eat endpoint chars */
2649 d -= 2; /* eat the first char and the - */
2650 min = (U8)*d; /* first char in range */
2651 max = (U8)d[1]; /* last char in range */
2658 "Invalid range \"%c-%c\" in transliteration operator",
2659 (char)min, (char)max);
2663 if (literal_endpoint == 2 &&
2664 ((isLOWER(min) && isLOWER(max)) ||
2665 (isUPPER(min) && isUPPER(max)))) {
2667 for (i = min; i <= max; i++)
2669 *d++ = NATIVE_TO_NEED(has_utf8,i);
2671 for (i = min; i <= max; i++)
2673 *d++ = NATIVE_TO_NEED(has_utf8,i);
2678 for (i = min; i <= max; i++)
2681 const U8 ch = (U8)NATIVE_TO_UTF(i);
2682 if (UNI_IS_INVARIANT(ch))
2685 *d++ = (U8)UTF8_EIGHT_BIT_HI(ch);
2686 *d++ = (U8)UTF8_EIGHT_BIT_LO(ch);
2695 d = (char*)uvchr_to_utf8((U8*)d, 0x100);
2697 *d++ = (char)UTF_TO_NATIVE(0xff);
2699 d = (char*)uvchr_to_utf8((U8*)d, uvmax);
2703 /* mark the range as done, and continue */
2707 literal_endpoint = 0;
2712 /* range begins (ignore - as first or last char) */
2713 else if (*s == '-' && s+1 < send && s != start) {
2715 Perl_croak(aTHX_ "Ambiguous range in transliteration operator");
2722 *d++ = (char)UTF_TO_NATIVE(0xff); /* use illegal utf8 byte--see pmtrans */
2732 literal_endpoint = 0;
2733 native_range = TRUE;
2738 /* if we get here, we're not doing a transliteration */
2740 /* skip for regexp comments /(?#comment)/ and code /(?{code})/,
2741 except for the last char, which will be done separately. */
2742 else if (*s == '(' && PL_lex_inpat && s[1] == '?') {
2744 while (s+1 < send && *s != ')')
2745 *d++ = NATIVE_TO_NEED(has_utf8,*s++);
2747 else if (s[2] == '{' /* This should match regcomp.c */
2748 || (s[2] == '?' && s[3] == '{'))
2751 char *regparse = s + (s[2] == '{' ? 3 : 4);
2754 while (count && (c = *regparse)) {
2755 if (c == '\\' && regparse[1])
2763 if (*regparse != ')')
2764 regparse--; /* Leave one char for continuation. */
2765 while (s < regparse)
2766 *d++ = NATIVE_TO_NEED(has_utf8,*s++);
2770 /* likewise skip #-initiated comments in //x patterns */
2771 else if (*s == '#' && PL_lex_inpat &&
2772 ((PMOP*)PL_lex_inpat)->op_pmflags & PMf_EXTENDED) {
2773 while (s+1 < send && *s != '\n')
2774 *d++ = NATIVE_TO_NEED(has_utf8,*s++);
2777 /* check for embedded arrays
2778 (@foo, @::foo, @'foo, @{foo}, @$foo, @+, @-)
2780 else if (*s == '@' && s[1]) {
2781 if (isALNUM_lazy_if(s+1,UTF))
2783 if (strchr(":'{$", s[1]))
2785 if (!PL_lex_inpat && (s[1] == '+' || s[1] == '-'))
2786 break; /* in regexp, neither @+ nor @- are interpolated */
2789 /* check for embedded scalars. only stop if we're sure it's a
2792 else if (*s == '$') {
2793 if (!PL_lex_inpat) /* not a regexp, so $ must be var */
2795 if (s + 1 < send && !strchr("()| \r\n\t", s[1])) {
2797 Perl_ck_warner(aTHX_ packWARN(WARN_AMBIGUOUS),
2798 "Possible unintended interpolation of $\\ in regex");
2800 break; /* in regexp, $ might be tail anchor */
2804 /* End of else if chain - OP_TRANS rejoin rest */
2807 if (*s == '\\' && s+1 < send) {
2808 char* e; /* Can be used for ending '}', etc. */
2812 /* deprecate \1 in strings and substitution replacements */
2813 if (PL_lex_inwhat == OP_SUBST && !PL_lex_inpat &&
2814 isDIGIT(*s) && *s != '0' && !isDIGIT(s[1]))
2816 Perl_ck_warner(aTHX_ packWARN(WARN_SYNTAX), "\\%c better written as $%c", *s, *s);
2821 /* string-change backslash escapes */
2822 if (PL_lex_inwhat != OP_TRANS && *s && strchr("lLuUEQ", *s)) {
2826 /* In a pattern, process \N, but skip any other backslash escapes.
2827 * This is because we don't want to translate an escape sequence
2828 * into a meta symbol and have the regex compiler use the meta
2829 * symbol meaning, e.g. \x{2E} would be confused with a dot. But
2830 * in spite of this, we do have to process \N here while the proper
2831 * charnames handler is in scope. See bugs #56444 and #62056.
2832 * There is a complication because \N in a pattern may also stand
2833 * for 'match a non-nl', and not mean a charname, in which case its
2834 * processing should be deferred to the regex compiler. To be a
2835 * charname it must be followed immediately by a '{', and not look
2836 * like \N followed by a curly quantifier, i.e., not something like
2837 * \N{3,}. regcurly returns a boolean indicating if it is a legal
2839 else if (PL_lex_inpat
2842 || regcurly(s + 1)))
2844 *d++ = NATIVE_TO_NEED(has_utf8,'\\');
2845 goto default_action;
2850 /* quoted - in transliterations */
2852 if (PL_lex_inwhat == OP_TRANS) {
2859 if ((isALPHA(*s) || isDIGIT(*s)))
2860 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
2861 "Unrecognized escape \\%c passed through",
2863 /* default action is to copy the quoted character */
2864 goto default_action;
2867 /* eg. \132 indicates the octal constant 0x132 */
2868 case '0': case '1': case '2': case '3':
2869 case '4': case '5': case '6': case '7':
2873 uv = NATIVE_TO_UNI(grok_oct(s, &len, &flags, NULL));
2876 goto NUM_ESCAPE_INSERT;
2878 /* eg. \x24 indicates the hex constant 0x24 */
2882 char* const e = strchr(s, '}');
2883 I32 flags = PERL_SCAN_ALLOW_UNDERSCORES |
2884 PERL_SCAN_DISALLOW_PREFIX;
2889 yyerror("Missing right brace on \\x{}");
2893 uv = NATIVE_TO_UNI(grok_hex(s, &len, &flags, NULL));
2899 I32 flags = PERL_SCAN_DISALLOW_PREFIX;
2900 uv = NATIVE_TO_UNI(grok_hex(s, &len, &flags, NULL));
2906 /* Insert oct or hex escaped character. There will always be
2907 * enough room in sv since such escapes will be longer than any
2908 * UTF-8 sequence they can end up as, except if they force us
2909 * to recode the rest of the string into utf8 */
2911 /* Here uv is the ordinal of the next character being added in
2912 * unicode (converted from native). */
2913 if (!UNI_IS_INVARIANT(uv)) {
2914 if (!has_utf8 && uv > 255) {
2915 /* Might need to recode whatever we have accumulated so
2916 * far if it contains any chars variant in utf8 or
2919 SvCUR_set(sv, d - SvPVX_const(sv));
2922 /* See Note on sizing above. */
2923 sv_utf8_upgrade_flags_grow(sv,
2924 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
2925 UNISKIP(uv) + (STRLEN)(send - s) + 1);
2926 d = SvPVX(sv) + SvCUR(sv);
2931 d = (char*)uvuni_to_utf8((U8*)d, uv);
2932 if (PL_lex_inwhat == OP_TRANS &&
2933 PL_sublex_info.sub_op) {
2934 PL_sublex_info.sub_op->op_private |=
2935 (PL_lex_repl ? OPpTRANS_FROM_UTF
2939 if (uv > 255 && !dorange)
2940 native_range = FALSE;
2953 /* In a non-pattern \N must be a named character, like \N{LATIN
2954 * SMALL LETTER A} or \N{U+0041}. For patterns, it also can
2955 * mean to match a non-newline. For non-patterns, named
2956 * characters are converted to their string equivalents. In
2957 * patterns, named characters are not converted to their
2958 * ultimate forms for the same reasons that other escapes
2959 * aren't. Instead, they are converted to the \N{U+...} form
2960 * to get the value from the charnames that is in effect right
2961 * now, while preserving the fact that it was a named character
2962 * so that the regex compiler knows this */
2964 /* This section of code doesn't generally use the
2965 * NATIVE_TO_NEED() macro to transform the input. I (khw) did
2966 * a close examination of this macro and determined it is a
2967 * no-op except on utfebcdic variant characters. Every
2968 * character generated by this that would normally need to be
2969 * enclosed by this macro is invariant, so the macro is not
2970 * needed, and would complicate use of copy(). There are other
2971 * parts of this file where the macro is used inconsistently,
2972 * but are saved by it being a no-op */
2974 /* The structure of this section of code (besides checking for
2975 * errors and upgrading to utf8) is:
2976 * Further disambiguate between the two meanings of \N, and if
2977 * not a charname, go process it elsewhere
2978 * If of form \N{U+...}, pass it through if a pattern;
2979 * otherwise convert to utf8
2980 * Otherwise must be \N{NAME}: convert to \N{U+c1.c2...} if a
2981 * pattern; otherwise convert to utf8 */
2983 /* Here, s points to the 'N'; the test below is guaranteed to
2984 * succeed if we are being called on a pattern as we already
2985 * know from a test above that the next character is a '{'.
2986 * On a non-pattern \N must mean 'named sequence, which
2987 * requires braces */
2990 yyerror("Missing braces on \\N{}");
2995 /* If there is no matching '}', it is an error. */
2996 if (! (e = strchr(s, '}'))) {
2997 if (! PL_lex_inpat) {
2998 yyerror("Missing right brace on \\N{}");
3000 yyerror("Missing right brace on \\N{} or unescaped left brace after \\N.");
3005 /* Here it looks like a named character */
3009 /* XXX This block is temporary code. \N{} implies that the
3010 * pattern is to have Unicode semantics, and therefore
3011 * currently has to be encoded in utf8. By putting it in
3012 * utf8 now, we save a whole pass in the regular expression
3013 * compiler. Once that code is changed so Unicode
3014 * semantics doesn't necessarily have to be in utf8, this
3015 * block should be removed */
3017 SvCUR_set(sv, d - SvPVX_const(sv));
3020 /* See Note on sizing above. */
3021 sv_utf8_upgrade_flags_grow(sv,
3022 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3023 /* 5 = '\N{' + cur char + NUL */
3024 (STRLEN)(send - s) + 5);
3025 d = SvPVX(sv) + SvCUR(sv);
3030 if (*s == 'U' && s[1] == '+') { /* \N{U+...} */
3031 I32 flags = PERL_SCAN_ALLOW_UNDERSCORES
3032 | PERL_SCAN_DISALLOW_PREFIX;
3035 /* For \N{U+...}, the '...' is a unicode value even on
3036 * EBCDIC machines */
3037 s += 2; /* Skip to next char after the 'U+' */
3039 uv = grok_hex(s, &len, &flags, NULL);
3040 if (len == 0 || len != (STRLEN)(e - s)) {
3041 yyerror("Invalid hexadecimal number in \\N{U+...}");
3048 /* Pass through to the regex compiler unchanged. The
3049 * reason we evaluated the number above is to make sure
3050 * there wasn't a syntax error. */
3051 s -= 5; /* Include the '\N{U+' */
3052 Copy(s, d, e - s + 1, char); /* 1 = include the } */
3055 else { /* Not a pattern: convert the hex to string */
3057 /* If destination is not in utf8, unconditionally
3058 * recode it to be so. This is because \N{} implies
3059 * Unicode semantics, and scalars have to be in utf8
3060 * to guarantee those semantics */
3062 SvCUR_set(sv, d - SvPVX_const(sv));
3065 /* See Note on sizing above. */
3066 sv_utf8_upgrade_flags_grow(
3068 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3069 UNISKIP(uv) + (STRLEN)(send - e) + 1);
3070 d = SvPVX(sv) + SvCUR(sv);
3074 /* Add the string to the output */
3075 if (UNI_IS_INVARIANT(uv)) {
3078 else d = (char*)uvuni_to_utf8((U8*)d, uv);
3081 else { /* Here is \N{NAME} but not \N{U+...}. */
3083 SV *res; /* result from charnames */
3084 const char *str; /* the string in 'res' */
3085 STRLEN len; /* its length */
3087 /* Get the value for NAME */
3088 res = newSVpvn(s, e - s);
3089 res = new_constant( NULL, 0, "charnames",
3090 /* includes all of: \N{...} */
3091 res, NULL, s - 3, e - s + 4 );
3093 /* Most likely res will be in utf8 already since the
3094 * standard charnames uses pack U, but a custom translator
3095 * can leave it otherwise, so make sure. XXX This can be
3096 * revisited to not have charnames use utf8 for characters
3097 * that don't need it when regexes don't have to be in utf8
3098 * for Unicode semantics. If doing so, remember EBCDIC */
3099 sv_utf8_upgrade(res);
3100 str = SvPV_const(res, len);
3102 /* Don't accept malformed input */
3103 if (! is_utf8_string((U8 *) str, len)) {
3104 yyerror("Malformed UTF-8 returned by \\N");
3106 else if (PL_lex_inpat) {
3108 if (! len) { /* The name resolved to an empty string */
3109 Copy("\\N{}", d, 4, char);
3113 /* In order to not lose information for the regex
3114 * compiler, pass the result in the specially made
3115 * syntax: \N{U+c1.c2.c3...}, where c1 etc. are
3116 * the code points in hex of each character
3117 * returned by charnames */
3119 const char *str_end = str + len;
3120 STRLEN char_length; /* cur char's byte length */
3121 STRLEN output_length; /* and the number of bytes
3122 after this is translated
3124 const STRLEN off = d - SvPVX_const(sv);
3126 /* 2 hex per byte; 2 chars for '\N'; 2 chars for
3127 * max('U+', '.'); and 1 for NUL */
3128 char hex_string[2 * UTF8_MAXBYTES + 5];
3130 /* Get the first character of the result. */
3131 U32 uv = utf8n_to_uvuni((U8 *) str,
3136 /* The call to is_utf8_string() above hopefully
3137 * guarantees that there won't be an error. But
3138 * it's easy here to make sure. The function just
3139 * above warns and returns 0 if invalid utf8, but
3140 * it can also return 0 if the input is validly a
3141 * NUL. Disambiguate */
3142 if (uv == 0 && NATIVE_TO_ASCII(*str) != '\0') {
3143 uv = UNICODE_REPLACEMENT;
3146 /* Convert first code point to hex, including the
3147 * boiler plate before it */
3148 sprintf(hex_string, "\\N{U+%X", (unsigned int) uv);
3149 output_length = strlen(hex_string);
3151 /* Make sure there is enough space to hold it */
3152 d = off + SvGROW(sv, off
3154 + (STRLEN)(send - e)
3155 + 2); /* '}' + NUL */
3157 Copy(hex_string, d, output_length, char);
3160 /* For each subsequent character, append dot and
3161 * its ordinal in hex */
3162 while ((str += char_length) < str_end) {
3163 const STRLEN off = d - SvPVX_const(sv);
3164 U32 uv = utf8n_to_uvuni((U8 *) str,
3168 if (uv == 0 && NATIVE_TO_ASCII(*str) != '\0') {
3169 uv = UNICODE_REPLACEMENT;
3172 sprintf(hex_string, ".%X", (unsigned int) uv);
3173 output_length = strlen(hex_string);
3175 d = off + SvGROW(sv, off
3177 + (STRLEN)(send - e)
3178 + 2); /* '}' + NUL */
3179 Copy(hex_string, d, output_length, char);
3183 *d++ = '}'; /* Done. Add the trailing brace */
3186 else { /* Here, not in a pattern. Convert the name to a
3189 /* If destination is not in utf8, unconditionally
3190 * recode it to be so. This is because \N{} implies
3191 * Unicode semantics, and scalars have to be in utf8
3192 * to guarantee those semantics */
3194 SvCUR_set(sv, d - SvPVX_const(sv));
3197 /* See Note on sizing above. */
3198 sv_utf8_upgrade_flags_grow(sv,
3199 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3200 len + (STRLEN)(send - s) + 1);
3201 d = SvPVX(sv) + SvCUR(sv);
3203 } else if (len > (STRLEN)(e - s + 4)) { /* I _guess_ 4 is \N{} --jhi */
3205 /* See Note on sizing above. (NOTE: SvCUR() is not
3206 * set correctly here). */
3207 const STRLEN off = d - SvPVX_const(sv);
3208 d = off + SvGROW(sv, off + len + (STRLEN)(send - s) + 1);
3210 Copy(str, d, len, char);
3215 /* Deprecate non-approved name syntax */
3216 if (ckWARN_d(WARN_DEPRECATED)) {
3217 bool problematic = FALSE;
3220 /* For non-ut8 input, look to see that the first
3221 * character is an alpha, then loop through the rest
3222 * checking that each is a continuation */
3224 if (! isALPHAU(*i)) problematic = TRUE;
3225 else for (i = s + 1; i < e; i++) {
3226 if (isCHARNAME_CONT(*i)) continue;
3232 /* Similarly for utf8. For invariants can check
3233 * directly. We accept anything above the latin1
3234 * range because it is immaterial to Perl if it is
3235 * correct or not, and is expensive to check. But
3236 * it is fairly easy in the latin1 range to convert
3237 * the variants into a single character and check
3239 if (UTF8_IS_INVARIANT(*i)) {
3240 if (! isALPHAU(*i)) problematic = TRUE;
3241 } else if (UTF8_IS_DOWNGRADEABLE_START(*i)) {
3242 if (! isALPHAU(UNI_TO_NATIVE(UTF8_ACCUMULATE(*i,
3248 if (! problematic) for (i = s + UTF8SKIP(s);
3252 if (UTF8_IS_INVARIANT(*i)) {
3253 if (isCHARNAME_CONT(*i)) continue;
3254 } else if (! UTF8_IS_DOWNGRADEABLE_START(*i)) {
3256 } else if (isCHARNAME_CONT(
3258 UTF8_ACCUMULATE(*i, *(i+1)))))
3268 Newx(string, e - i + 1, char);
3269 Copy(i, string, e - i, char);
3270 string[e - i] = '\0';
3271 Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),
3272 "Deprecated character(s) in \\N{...} starting at '%s'",
3277 } /* End \N{NAME} */
3280 native_range = FALSE; /* \N{} is defined to be Unicode */
3282 s = e + 1; /* Point to just after the '}' */
3285 /* \c is a control character */
3294 *d++ = NATIVE_TO_NEED(has_utf8,toCTRL(c));
3297 yyerror("Missing control char name in \\c");
3301 /* printf-style backslashes, formfeeds, newlines, etc */
3303 *d++ = NATIVE_TO_NEED(has_utf8,'\b');
3306 *d++ = NATIVE_TO_NEED(has_utf8,'\n');
3309 *d++ = NATIVE_TO_NEED(has_utf8,'\r');
3312 *d++ = NATIVE_TO_NEED(has_utf8,'\f');
3315 *d++ = NATIVE_TO_NEED(has_utf8,'\t');
3318 *d++ = ASCII_TO_NEED(has_utf8,'\033');
3321 *d++ = ASCII_TO_NEED(has_utf8,'\007');
3327 } /* end if (backslash) */
3334 /* If we started with encoded form, or already know we want it,
3335 then encode the next character */
3336 if (! NATIVE_IS_INVARIANT((U8)(*s)) && (this_utf8 || has_utf8)) {
3340 /* One might think that it is wasted effort in the case of the
3341 * source being utf8 (this_utf8 == TRUE) to take the next character
3342 * in the source, convert it to an unsigned value, and then convert
3343 * it back again. But the source has not been validated here. The
3344 * routine that does the conversion checks for errors like
3347 const UV nextuv = (this_utf8) ? utf8n_to_uvchr((U8*)s, send - s, &len, 0) : (UV) ((U8) *s);
3348 const STRLEN need = UNISKIP(NATIVE_TO_UNI(nextuv));
3350 SvCUR_set(sv, d - SvPVX_const(sv));
3353 /* See Note on sizing above. */
3354 sv_utf8_upgrade_flags_grow(sv,
3355 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3356 need + (STRLEN)(send - s) + 1);
3357 d = SvPVX(sv) + SvCUR(sv);
3359 } else if (need > len) {
3360 /* encoded value larger than old, may need extra space (NOTE:
3361 * SvCUR() is not set correctly here). See Note on sizing
3363 const STRLEN off = d - SvPVX_const(sv);
3364 d = SvGROW(sv, off + need + (STRLEN)(send - s) + 1) + off;
3368 d = (char*)uvchr_to_utf8((U8*)d, nextuv);
3370 if (uv > 255 && !dorange)
3371 native_range = FALSE;
3375 *d++ = NATIVE_TO_NEED(has_utf8,*s++);
3377 } /* while loop to process each character */
3379 /* terminate the string and set up the sv */
3381 SvCUR_set(sv, d - SvPVX_const(sv));
3382 if (SvCUR(sv) >= SvLEN(sv))
3383 Perl_croak(aTHX_ "panic: constant overflowed allocated space");
3386 if (PL_encoding && !has_utf8) {
3387 sv_recode_to_utf8(sv, PL_encoding);
3393 if (PL_lex_inwhat == OP_TRANS && PL_sublex_info.sub_op) {
3394 PL_sublex_info.sub_op->op_private |=
3395 (PL_lex_repl ? OPpTRANS_FROM_UTF : OPpTRANS_TO_UTF);
3399 /* shrink the sv if we allocated more than we used */
3400 if (SvCUR(sv) + 5 < SvLEN(sv)) {
3401 SvPV_shrink_to_cur(sv);
3404 /* return the substring (via pl_yylval) only if we parsed anything */
3405 if (s > PL_bufptr) {
3406 if ( PL_hints & ( PL_lex_inpat ? HINT_NEW_RE : HINT_NEW_STRING ) ) {
3407 const char *const key = PL_lex_inpat ? "qr" : "q";
3408 const STRLEN keylen = PL_lex_inpat ? 2 : 1;
3412 if (PL_lex_inwhat == OP_TRANS) {
3415 } else if (PL_lex_inwhat == OP_SUBST && !PL_lex_inpat) {
3423 sv = S_new_constant(aTHX_ start, s - start, key, keylen, sv, NULL,
3426 pl_yylval.opval = (OP*)newSVOP(OP_CONST, 0, sv);
3433 * Returns TRUE if there's more to the expression (e.g., a subscript),
3436 * It deals with "$foo[3]" and /$foo[3]/ and /$foo[0123456789$]+/
3438 * ->[ and ->{ return TRUE
3439 * { and [ outside a pattern are always subscripts, so return TRUE
3440 * if we're outside a pattern and it's not { or [, then return FALSE
3441 * if we're in a pattern and the first char is a {
3442 * {4,5} (any digits around the comma) returns FALSE
3443 * if we're in a pattern and the first char is a [
3445 * [SOMETHING] has a funky algorithm to decide whether it's a
3446 * character class or not. It has to deal with things like
3447 * /$foo[-3]/ and /$foo[$bar]/ as well as /$foo[$\d]+/
3448 * anything else returns TRUE
3451 /* This is the one truly awful dwimmer necessary to conflate C and sed. */
3454 S_intuit_more(pTHX_ register char *s)
3458 PERL_ARGS_ASSERT_INTUIT_MORE;
3460 if (PL_lex_brackets)
3462 if (*s == '-' && s[1] == '>' && (s[2] == '[' || s[2] == '{'))
3464 if (*s != '{' && *s != '[')
3469 /* In a pattern, so maybe we have {n,m}. */
3486 /* On the other hand, maybe we have a character class */
3489 if (*s == ']' || *s == '^')
3492 /* this is terrifying, and it works */
3493 int weight = 2; /* let's weigh the evidence */
3495 unsigned char un_char = 255, last_un_char;
3496 const char * const send = strchr(s,']');
3497 char tmpbuf[sizeof PL_tokenbuf * 4];
3499 if (!send) /* has to be an expression */
3502 Zero(seen,256,char);
3505 else if (isDIGIT(*s)) {
3507 if (isDIGIT(s[1]) && s[2] == ']')
3513 for (; s < send; s++) {
3514 last_un_char = un_char;
3515 un_char = (unsigned char)*s;
3520 weight -= seen[un_char] * 10;
3521 if (isALNUM_lazy_if(s+1,UTF)) {
3523 scan_ident(s, send, tmpbuf, sizeof tmpbuf, FALSE);
3524 len = (int)strlen(tmpbuf);
3525 if (len > 1 && gv_fetchpvn_flags(tmpbuf, len, 0, SVt_PV))
3530 else if (*s == '$' && s[1] &&
3531 strchr("[#!%*<>()-=",s[1])) {
3532 if (/*{*/ strchr("])} =",s[2]))
3541 if (strchr("wds]",s[1]))
3543 else if (seen[(U8)'\''] || seen[(U8)'"'])
3545 else if (strchr("rnftbxcav",s[1]))
3547 else if (isDIGIT(s[1])) {
3549 while (s[1] && isDIGIT(s[1]))
3559 if (strchr("aA01! ",last_un_char))
3561 if (strchr("zZ79~",s[1]))
3563 if (last_un_char == 255 && (isDIGIT(s[1]) || s[1] == '$'))
3564 weight -= 5; /* cope with negative subscript */
3567 if (!isALNUM(last_un_char)
3568 && !(last_un_char == '$' || last_un_char == '@'
3569 || last_un_char == '&')
3570 && isALPHA(*s) && s[1] && isALPHA(s[1])) {
3575 if (keyword(tmpbuf, d - tmpbuf, 0))
3578 if (un_char == last_un_char + 1)
3580 weight -= seen[un_char];
3585 if (weight >= 0) /* probably a character class */
3595 * Does all the checking to disambiguate
3597 * between foo(bar) and bar->foo. Returns 0 if not a method, otherwise
3598 * FUNCMETH (bar->foo(args)) or METHOD (bar->foo args).
3600 * First argument is the stuff after the first token, e.g. "bar".
3602 * Not a method if bar is a filehandle.
3603 * Not a method if foo is a subroutine prototyped to take a filehandle.
3604 * Not a method if it's really "Foo $bar"
3605 * Method if it's "foo $bar"
3606 * Not a method if it's really "print foo $bar"
3607 * Method if it's really "foo package::" (interpreted as package->foo)
3608 * Not a method if bar is known to be a subroutine ("sub bar; foo bar")
3609 * Not a method if bar is a filehandle or package, but is quoted with
3614 S_intuit_method(pTHX_ char *start, GV *gv, CV *cv)
3617 char *s = start + (*start == '$');
3618 char tmpbuf[sizeof PL_tokenbuf];
3625 PERL_ARGS_ASSERT_INTUIT_METHOD;
3628 if (SvTYPE(gv) == SVt_PVGV && GvIO(gv))
3632 const char *proto = SvPVX_const(cv);
3643 s = scan_word(s, tmpbuf, sizeof tmpbuf, TRUE, &len);
3644 /* start is the beginning of the possible filehandle/object,
3645 * and s is the end of it
3646 * tmpbuf is a copy of it
3649 if (*start == '$') {
3650 if (gv || PL_last_lop_op == OP_PRINT || PL_last_lop_op == OP_SAY ||
3651 isUPPER(*PL_tokenbuf))
3654 len = start - SvPVX(PL_linestr);
3658 start = SvPVX(PL_linestr) + len;
3662 return *s == '(' ? FUNCMETH : METHOD;
3664 if (!keyword(tmpbuf, len, 0)) {
3665 if (len > 2 && tmpbuf[len - 2] == ':' && tmpbuf[len - 1] == ':') {
3669 soff = s - SvPVX(PL_linestr);
3673 indirgv = gv_fetchpvn_flags(tmpbuf, len, 0, SVt_PVCV);
3674 if (indirgv && GvCVu(indirgv))
3676 /* filehandle or package name makes it a method */
3677 if (!gv || GvIO(indirgv) || gv_stashpvn(tmpbuf, len, 0)) {
3679 soff = s - SvPVX(PL_linestr);
3682 if ((PL_bufend - s) >= 2 && *s == '=' && *(s+1) == '>')
3683 return 0; /* no assumptions -- "=>" quotes bearword */
3685 start_force(PL_curforce);
3686 NEXTVAL_NEXTTOKE.opval = (OP*)newSVOP(OP_CONST, 0,
3687 S_newSV_maybe_utf8(aTHX_ tmpbuf, len));
3688 NEXTVAL_NEXTTOKE.opval->op_private = OPpCONST_BARE;
3690 curmad('X', newSVpvn(start,SvPVX(PL_linestr) + soff - start));
3695 PL_bufptr = SvPVX(PL_linestr) + soff; /* restart before space */
3697 return *s == '(' ? FUNCMETH : METHOD;
3703 /* Encoded script support. filter_add() effectively inserts a
3704 * 'pre-processing' function into the current source input stream.
3705 * Note that the filter function only applies to the current source file
3706 * (e.g., it will not affect files 'require'd or 'use'd by this one).
3708 * The datasv parameter (which may be NULL) can be used to pass
3709 * private data to this instance of the filter. The filter function
3710 * can recover the SV using the FILTER_DATA macro and use it to
3711 * store private buffers and state information.
3713 * The supplied datasv parameter is upgraded to a PVIO type
3714 * and the IoDIRP/IoANY field is used to store the function pointer,
3715 * and IOf_FAKE_DIRP is enabled on datasv to mark this as such.
3716 * Note that IoTOP_NAME, IoFMT_NAME, IoBOTTOM_NAME, if set for
3717 * private use must be set using malloc'd pointers.
3721 Perl_filter_add(pTHX_ filter_t funcp, SV *datasv)
3730 if (!PL_rsfp_filters)
3731 PL_rsfp_filters = newAV();
3734 SvUPGRADE(datasv, SVt_PVIO);
3735 IoANY(datasv) = FPTR2DPTR(void *, funcp); /* stash funcp into spare field */
3736 IoFLAGS(datasv) |= IOf_FAKE_DIRP;
3737 DEBUG_P(PerlIO_printf(Perl_debug_log, "filter_add func %p (%s)\n",
3738 FPTR2DPTR(void *, IoANY(datasv)),
3739 SvPV_nolen(datasv)));
3740 av_unshift(PL_rsfp_filters, 1);
3741 av_store(PL_rsfp_filters, 0, datasv) ;
3746 /* Delete most recently added instance of this filter function. */
3748 Perl_filter_del(pTHX_ filter_t funcp)
3753 PERL_ARGS_ASSERT_FILTER_DEL;
3756 DEBUG_P(PerlIO_printf(Perl_debug_log, "filter_del func %p",
3757 FPTR2DPTR(void*, funcp)));
3759 if (!PL_parser || !PL_rsfp_filters || AvFILLp(PL_rsfp_filters)<0)
3761 /* if filter is on top of stack (usual case) just pop it off */
3762 datasv = FILTER_DATA(AvFILLp(PL_rsfp_filters));
3763 if (IoANY(datasv) == FPTR2DPTR(void *, funcp)) {
3764 IoFLAGS(datasv) &= ~IOf_FAKE_DIRP;
3765 IoANY(datasv) = (void *)NULL;
3766 sv_free(av_pop(PL_rsfp_filters));
3770 /* we need to search for the correct entry and clear it */
3771 Perl_die(aTHX_ "filter_del can only delete in reverse order (currently)");
3775 /* Invoke the idxth filter function for the current rsfp. */
3776 /* maxlen 0 = read one text line */
3778 Perl_filter_read(pTHX_ int idx, SV *buf_sv, int maxlen)
3783 /* This API is bad. It should have been using unsigned int for maxlen.
3784 Not sure if we want to change the API, but if not we should sanity
3785 check the value here. */
3786 const unsigned int correct_length
3795 PERL_ARGS_ASSERT_FILTER_READ;
3797 if (!PL_parser || !PL_rsfp_filters)
3799 if (idx > AvFILLp(PL_rsfp_filters)) { /* Any more filters? */
3800 /* Provide a default input filter to make life easy. */
3801 /* Note that we append to the line. This is handy. */
3802 DEBUG_P(PerlIO_printf(Perl_debug_log,
3803 "filter_read %d: from rsfp\n", idx));
3804 if (correct_length) {
3807 const int old_len = SvCUR(buf_sv);
3809 /* ensure buf_sv is large enough */
3810 SvGROW(buf_sv, (STRLEN)(old_len + correct_length + 1)) ;
3811 if ((len = PerlIO_read(PL_rsfp, SvPVX(buf_sv) + old_len,
3812 correct_length)) <= 0) {
3813 if (PerlIO_error(PL_rsfp))
3814 return -1; /* error */
3816 return 0 ; /* end of file */
3818 SvCUR_set(buf_sv, old_len + len) ;
3819 SvPVX(buf_sv)[old_len + len] = '\0';
3822 if (sv_gets(buf_sv, PL_rsfp, SvCUR(buf_sv)) == NULL) {
3823 if (PerlIO_error(PL_rsfp))
3824 return -1; /* error */
3826 return 0 ; /* end of file */
3829 return SvCUR(buf_sv);
3831 /* Skip this filter slot if filter has been deleted */
3832 if ( (datasv = FILTER_DATA(idx)) == &PL_sv_undef) {
3833 DEBUG_P(PerlIO_printf(Perl_debug_log,
3834 "filter_read %d: skipped (filter deleted)\n",
3836 return FILTER_READ(idx+1, buf_sv, correct_length); /* recurse */
3838 /* Get function pointer hidden within datasv */
3839 funcp = DPTR2FPTR(filter_t, IoANY(datasv));
3840 DEBUG_P(PerlIO_printf(Perl_debug_log,
3841 "filter_read %d: via function %p (%s)\n",
3842 idx, (void*)datasv, SvPV_nolen_const(datasv)));
3843 /* Call function. The function is expected to */
3844 /* call "FILTER_READ(idx+1, buf_sv)" first. */
3845 /* Return: <0:error, =0:eof, >0:not eof */
3846 return (*funcp)(aTHX_ idx, buf_sv, correct_length);
3850 S_filter_gets(pTHX_ register SV *sv, STRLEN append)
3854 PERL_ARGS_ASSERT_FILTER_GETS;
3856 #ifdef PERL_CR_FILTER
3857 if (!PL_rsfp_filters) {
3858 filter_add(S_cr_textfilter,NULL);
3861 if (PL_rsfp_filters) {
3863 SvCUR_set(sv, 0); /* start with empty line */
3864 if (FILTER_READ(0, sv, 0) > 0)
3865 return ( SvPVX(sv) ) ;
3870 return (sv_gets(sv, PL_rsfp, append));
3874 S_find_in_my_stash(pTHX_ const char *pkgname, STRLEN len)
3879 PERL_ARGS_ASSERT_FIND_IN_MY_STASH;
3881 if (len == 11 && *pkgname == '_' && strEQ(pkgname, "__PACKAGE__"))
3885 (pkgname[len - 2] == ':' && pkgname[len - 1] == ':') &&
3886 (gv = gv_fetchpvn_flags(pkgname, len, 0, SVt_PVHV)))
3888 return GvHV(gv); /* Foo:: */
3891 /* use constant CLASS => 'MyClass' */
3892 gv = gv_fetchpvn_flags(pkgname, len, 0, SVt_PVCV);
3893 if (gv && GvCV(gv)) {
3894 SV * const sv = cv_const_sv(GvCV(gv));
3896 pkgname = SvPV_const(sv, len);
3899 return gv_stashpvn(pkgname, len, 0);
3903 * S_readpipe_override
3904 * Check whether readpipe() is overriden, and generates the appropriate
3905 * optree, provided sublex_start() is called afterwards.
3908 S_readpipe_override(pTHX)
3911 GV *gv_readpipe = gv_fetchpvs("readpipe", GV_NOTQUAL, SVt_PVCV);
3912 pl_yylval.ival = OP_BACKTICK;
3914 && GvCVu(gv_readpipe) && GvIMPORTED_CV(gv_readpipe))
3916 ((gvp = (GV**)hv_fetchs(PL_globalstash, "readpipe", FALSE))
3917 && (gv_readpipe = *gvp) && isGV_with_GP(gv_readpipe)
3918 && GvCVu(gv_readpipe) && GvIMPORTED_CV(gv_readpipe)))
3920 PL_lex_op = (OP*)newUNOP(OP_ENTERSUB, OPf_STACKED,
3921 append_elem(OP_LIST,
3922 newSVOP(OP_CONST, 0, &PL_sv_undef), /* value will be read later */
3923 newCVREF(0, newGVOP(OP_GV, 0, gv_readpipe))));
3930 * The intent of this yylex wrapper is to minimize the changes to the
3931 * tokener when we aren't interested in collecting madprops. It remains
3932 * to be seen how successful this strategy will be...
3939 char *s = PL_bufptr;
3941 /* make sure PL_thiswhite is initialized */
3945 /* just do what yylex would do on pending identifier; leave PL_thiswhite alone */
3946 if (PL_pending_ident)
3947 return S_pending_ident(aTHX);
3949 /* previous token ate up our whitespace? */
3950 if (!PL_lasttoke && PL_nextwhite) {
3951 PL_thiswhite = PL_nextwhite;
3955 /* isolate the token, and figure out where it is without whitespace */
3956 PL_realtokenstart = -1;
3960 assert(PL_curforce < 0);
3962 if (!PL_thismad || PL_thismad->mad_key == '^') { /* not forced already? */
3963 if (!PL_thistoken) {
3964 if (PL_realtokenstart < 0 || !CopLINE(PL_curcop))
3965 PL_thistoken = newSVpvs("");
3967 char * const tstart = SvPVX(PL_linestr) + PL_realtokenstart;
3968 PL_thistoken = newSVpvn(tstart, s - tstart);
3971 if (PL_thismad) /* install head */
3972 CURMAD('X', PL_thistoken);
3975 /* last whitespace of a sublex? */
3976 if (optype == ')' && PL_endwhite) {
3977 CURMAD('X', PL_endwhite);
3982 /* if no whitespace and we're at EOF, bail. Otherwise fake EOF below. */
3983 if (!PL_thiswhite && !PL_endwhite && !optype) {
3984 sv_free(PL_thistoken);
3989 /* put off final whitespace till peg */
3990 if (optype == ';' && !PL_rsfp) {
3991 PL_nextwhite = PL_thiswhite;
3994 else if (PL_thisopen) {
3995 CURMAD('q', PL_thisopen);
3997 sv_free(PL_thistoken);
4001 /* Store actual token text as madprop X */
4002 CURMAD('X', PL_thistoken);
4006 /* add preceding whitespace as madprop _ */
4007 CURMAD('_', PL_thiswhite);
4011 /* add quoted material as madprop = */
4012 CURMAD('=', PL_thisstuff);
4016 /* add terminating quote as madprop Q */
4017 CURMAD('Q', PL_thisclose);
4021 /* special processing based on optype */
4025 /* opval doesn't need a TOKEN since it can already store mp */
4035 if (pl_yylval.opval)
4036 append_madprops(PL_thismad, pl_yylval.opval, 0);
4044 addmad(newMADsv('p', PL_endwhite), &PL_thismad, 0);
4053 /* remember any fake bracket that lexer is about to discard */
4054 if (PL_lex_brackets == 1 &&
4055 ((expectation)PL_lex_brackstack[0] & XFAKEBRACK))
4058 while (s < PL_bufend && (*s == ' ' || *s == '\t'))
4061 PL_thiswhite = newSVpvn(PL_bufptr, ++s - PL_bufptr);
4062 addmad(newMADsv('#', PL_thiswhite), &PL_thismad, 0);
4065 break; /* don't bother looking for trailing comment */
4074 /* attach a trailing comment to its statement instead of next token */
4078 if (PL_bufptr > PL_oldbufptr && PL_bufptr[-1] == optype) {
4080 while (s < PL_bufend && (*s == ' ' || *s == '\t'))
4082 if (*s == '\n' || *s == '#') {
4083 while (s < PL_bufend && *s != '\n')
4087 PL_thiswhite = newSVpvn(PL_bufptr, s - PL_bufptr);
4088 addmad(newMADsv('#', PL_thiswhite), &PL_thismad, 0);
4105 /* Create new token struct. Note: opvals return early above. */
4106 pl_yylval.tkval = newTOKEN(optype, pl_yylval, PL_thismad);
4113 S_tokenize_use(pTHX_ int is_use, char *s) {
4116 PERL_ARGS_ASSERT_TOKENIZE_USE;
4118 if (PL_expect != XSTATE)
4119 yyerror(Perl_form(aTHX_ "\"%s\" not allowed in expression",
4120 is_use ? "use" : "no"));
4122 if (isDIGIT(*s) || (*s == 'v' && isDIGIT(s[1]))) {
4123 s = force_version(s, TRUE);
4124 if (*s == ';' || *s == '}'
4125 || (s = SKIPSPACE1(s), (*s == ';' || *s == '}'))) {
4126 start_force(PL_curforce);
4127 NEXTVAL_NEXTTOKE.opval = NULL;
4130 else if (*s == 'v') {
4131 s = force_word(s,WORD,FALSE,TRUE,FALSE);
4132 s = force_version(s, FALSE);
4136 s = force_word(s,WORD,FALSE,TRUE,FALSE);
4137 s = force_version(s, FALSE);
4139 pl_yylval.ival = is_use;
4143 static const char* const exp_name[] =
4144 { "OPERATOR", "TERM", "REF", "STATE", "BLOCK", "ATTRBLOCK",
4145 "ATTRTERM", "TERMBLOCK", "TERMORDORDOR"
4152 Works out what to call the token just pulled out of the input
4153 stream. The yacc parser takes care of taking the ops we return and
4154 stitching them into a tree.
4160 if read an identifier
4161 if we're in a my declaration
4162 croak if they tried to say my($foo::bar)
4163 build the ops for a my() declaration
4164 if it's an access to a my() variable
4165 are we in a sort block?
4166 croak if my($a); $a <=> $b
4167 build ops for access to a my() variable
4168 if in a dq string, and they've said @foo and we can't find @foo
4170 build ops for a bareword
4171 if we already built the token before, use it.
4176 #pragma segment Perl_yylex
4182 register char *s = PL_bufptr;
4188 /* orig_keyword, gvp, and gv are initialized here because
4189 * jump to the label just_a_word_zero can bypass their
4190 * initialization later. */
4191 I32 orig_keyword = 0;
4196 SV* tmp = newSVpvs("");
4197 PerlIO_printf(Perl_debug_log, "### %"IVdf":LEX_%s/X%s %s\n",
4198 (IV)CopLINE(PL_curcop),
4199 lex_state_names[PL_lex_state],
4200 exp_name[PL_expect],
4201 pv_display(tmp, s, strlen(s), 0, 60));
4204 /* check if there's an identifier for us to look at */
4205 if (PL_pending_ident)
4206 return REPORT(S_pending_ident(aTHX));
4208 /* no identifier pending identification */
4210 switch (PL_lex_state) {
4212 case LEX_NORMAL: /* Some compilers will produce faster */
4213 case LEX_INTERPNORMAL: /* code if we comment these out. */
4217 /* when we've already built the next token, just pull it out of the queue */
4221 pl_yylval = PL_nexttoke[PL_lasttoke].next_val;
4223 PL_thismad = PL_nexttoke[PL_lasttoke].next_mad;
4224 PL_nexttoke[PL_lasttoke].next_mad = 0;
4225 if (PL_thismad && PL_thismad->mad_key == '_') {
4226 PL_thiswhite = MUTABLE_SV(PL_thismad->mad_val);
4227 PL_thismad->mad_val = 0;
4228 mad_free(PL_thismad);
4233 PL_lex_state = PL_lex_defer;
4234 PL_expect = PL_lex_expect;
4235 PL_lex_defer = LEX_NORMAL;
4236 if (!PL_nexttoke[PL_lasttoke].next_type)
4241 pl_yylval = PL_nextval[PL_nexttoke];
4243 PL_lex_state = PL_lex_defer;
4244 PL_expect = PL_lex_expect;
4245 PL_lex_defer = LEX_NORMAL;
4249 /* FIXME - can these be merged? */
4250 return(PL_nexttoke[PL_lasttoke].next_type);
4252 return REPORT(PL_nexttype[PL_nexttoke]);
4255 /* interpolated case modifiers like \L \U, including \Q and \E.
4256 when we get here, PL_bufptr is at the \
4258 case LEX_INTERPCASEMOD:
4260 if (PL_bufptr != PL_bufend && *PL_bufptr != '\\')
4261 Perl_croak(aTHX_ "panic: INTERPCASEMOD");
4263 /* handle \E or end of string */
4264 if (PL_bufptr == PL_bufend || PL_bufptr[1] == 'E') {
4266 if (PL_lex_casemods) {
4267 const char oldmod = PL_lex_casestack[--PL_lex_casemods];
4268 PL_lex_casestack[PL_lex_casemods] = '\0';
4270 if (PL_bufptr != PL_bufend
4271 && (oldmod == 'L' || oldmod == 'U' || oldmod == 'Q')) {
4273 PL_lex_state = LEX_INTERPCONCAT;
4276 PL_thistoken = newSVpvs("\\E");
4282 while (PL_bufptr != PL_bufend &&
4283 PL_bufptr[0] == '\\' && PL_bufptr[1] == 'E') {
4285 PL_thiswhite = newSVpvs("");
4286 sv_catpvn(PL_thiswhite, PL_bufptr, 2);
4290 if (PL_bufptr != PL_bufend)
4293 PL_lex_state = LEX_INTERPCONCAT;
4297 DEBUG_T({ PerlIO_printf(Perl_debug_log,
4298 "### Saw case modifier\n"); });
4300 if (s[1] == '\\' && s[2] == 'E') {
4303 PL_thiswhite = newSVpvs("");
4304 sv_catpvn(PL_thiswhite, PL_bufptr, 4);
4307 PL_lex_state = LEX_INTERPCONCAT;
4312 if (!PL_madskills) /* when just compiling don't need correct */
4313 if (strnEQ(s, "L\\u", 3) || strnEQ(s, "U\\l", 3))
4314 tmp = *s, *s = s[2], s[2] = (char)tmp; /* misordered... */
4315 if ((*s == 'L' || *s == 'U') &&
4316 (strchr(PL_lex_casestack, 'L') || strchr(PL_lex_casestack, 'U'))) {
4317 PL_lex_casestack[--PL_lex_casemods] = '\0';
4320 if (PL_lex_casemods > 10)
4321 Renew(PL_lex_casestack, PL_lex_casemods + 2, char);
4322 PL_lex_casestack[PL_lex_casemods++] = *s;
4323 PL_lex_casestack[PL_lex_casemods] = '\0';
4324 PL_lex_state = LEX_INTERPCONCAT;
4325 start_force(PL_curforce);
4326 NEXTVAL_NEXTTOKE.ival = 0;
4328 start_force(PL_curforce);
4330 NEXTVAL_NEXTTOKE.ival = OP_LCFIRST;
4332 NEXTVAL_NEXTTOKE.ival = OP_UCFIRST;
4334 NEXTVAL_NEXTTOKE.ival = OP_LC;
4336 NEXTVAL_NEXTTOKE.ival = OP_UC;
4338 NEXTVAL_NEXTTOKE.ival = OP_QUOTEMETA;
4340 Perl_croak(aTHX_ "panic: yylex");
4342 SV* const tmpsv = newSVpvs("\\ ");
4343 /* replace the space with the character we want to escape
4345 SvPVX(tmpsv)[1] = *s;
4351 if (PL_lex_starts) {
4357 sv_free(PL_thistoken);
4358 PL_thistoken = newSVpvs("");
4361 /* commas only at base level: /$a\Ub$c/ => ($a,uc(b.$c)) */
4362 if (PL_lex_casemods == 1 && PL_lex_inpat)
4371 case LEX_INTERPPUSH:
4372 return REPORT(sublex_push());
4374 case LEX_INTERPSTART:
4375 if (PL_bufptr == PL_bufend)
4376 return REPORT(sublex_done());
4377 DEBUG_T({ PerlIO_printf(Perl_debug_log,
4378 "### Interpolated variable\n"); });
4380 PL_lex_dojoin = (*PL_bufptr == '@');
4381 PL_lex_state = LEX_INTERPNORMAL;
4382 if (PL_lex_dojoin) {
4383 start_force(PL_curforce);
4384 NEXTVAL_NEXTTOKE.ival = 0;
4386 start_force(PL_curforce);
4387 force_ident("\"", '$');
4388 start_force(PL_curforce);
4389 NEXTVAL_NEXTTOKE.ival = 0;
4391 start_force(PL_curforce);
4392 NEXTVAL_NEXTTOKE.ival = 0;
4394 start_force(PL_curforce);
4395 NEXTVAL_NEXTTOKE.ival = OP_JOIN; /* emulate join($", ...) */
4398 if (PL_lex_starts++) {
4403 sv_free(PL_thistoken);
4404 PL_thistoken = newSVpvs("");
4407 /* commas only at base level: /$a\Ub$c/ => ($a,uc(b.$c)) */
4408 if (!PL_lex_casemods && PL_lex_inpat)
4415 case LEX_INTERPENDMAYBE:
4416 if (intuit_more(PL_bufptr)) {
4417 PL_lex_state = LEX_INTERPNORMAL; /* false alarm, more expr */
4423 if (PL_lex_dojoin) {
4424 PL_lex_dojoin = FALSE;
4425 PL_lex_state = LEX_INTERPCONCAT;
4429 sv_free(PL_thistoken);
4430 PL_thistoken = newSVpvs("");
4435 if (PL_lex_inwhat == OP_SUBST && PL_linestr == PL_lex_repl
4436 && SvEVALED(PL_lex_repl))
4438 if (PL_bufptr != PL_bufend)
4439 Perl_croak(aTHX_ "Bad evalled substitution pattern");
4443 case LEX_INTERPCONCAT:
4445 if (PL_lex_brackets)
4446 Perl_croak(aTHX_ "panic: INTERPCONCAT");
4448 if (PL_bufptr == PL_bufend)
4449 return REPORT(sublex_done());
4451 if (SvIVX(PL_linestr) == '\'') {
4452 SV *sv = newSVsv(PL_linestr);
4455 else if ( PL_hints & HINT_NEW_RE )
4456 sv = new_constant(NULL, 0, "qr", sv, sv, "q", 1);
4457 pl_yylval.opval = (OP*)newSVOP(OP_CONST, 0, sv);
4461 s = scan_const(PL_bufptr);
4463 PL_lex_state = LEX_INTERPCASEMOD;
4465 PL_lex_state = LEX_INTERPSTART;
4468 if (s != PL_bufptr) {
4469 start_force(PL_curforce);
4471 curmad('X', newSVpvn(PL_bufptr,s-PL_bufptr));
4473 NEXTVAL_NEXTTOKE = pl_yylval;
4476 if (PL_lex_starts++) {
4480 sv_free(PL_thistoken);
4481 PL_thistoken = newSVpvs("");
4484 /* commas only at base level: /$a\Ub$c/ => ($a,uc(b.$c)) */
4485 if (!PL_lex_casemods && PL_lex_inpat)