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)
942 PERL_ARGS_ASSERT_LEX_STUFF_PVN;
943 if (flags & ~(LEX_STUFF_UTF8))
944 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_stuff_pvn");
946 if (flags & LEX_STUFF_UTF8) {
950 char *p, *e = pv+len;
951 for (p = pv; p != e; p++)
952 highhalf += !!(((U8)*p) & 0x80);
955 lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len+highhalf);
956 bufptr = PL_parser->bufptr;
957 Move(bufptr, bufptr+len+highhalf, PL_parser->bufend+1-bufptr, char);
958 PL_parser->bufend += len+highhalf;
959 for (p = pv; p != e; p++) {
962 *bufptr++ = (char)(0xc0 | (c >> 6));
963 *bufptr++ = (char)(0x80 | (c & 0x3f));
970 if (flags & LEX_STUFF_UTF8) {
972 char *p, *e = pv+len;
973 for (p = pv; p != e; p++) {
976 Perl_croak(aTHX_ "Lexing code attempted to stuff "
977 "non-Latin-1 character into Latin-1 input");
978 } else if (c >= 0xc2 && p+1 != e &&
979 (((U8)p[1]) & 0xc0) == 0x80) {
982 } else if (c >= 0x80) {
983 /* malformed UTF-8 */
985 SAVESPTR(PL_warnhook);
986 PL_warnhook = PERL_WARNHOOK_FATAL;
987 utf8n_to_uvuni((U8*)p, e-p, NULL, 0);
993 lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len-highhalf);
994 bufptr = PL_parser->bufptr;
995 Move(bufptr, bufptr+len-highhalf, PL_parser->bufend+1-bufptr, char);
996 PL_parser->bufend += len-highhalf;
997 for (p = pv; p != e; p++) {
1000 *bufptr++ = (char)(((c & 0x3) << 6) | (p[1] & 0x3f));
1003 *bufptr++ = (char)c;
1008 lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len);
1009 bufptr = PL_parser->bufptr;
1010 Move(bufptr, bufptr+len, PL_parser->bufend+1-bufptr, char);
1011 PL_parser->bufend += len;
1012 Copy(pv, bufptr, len, char);
1018 =for apidoc Amx|void|lex_stuff_sv|SV *sv|U32 flags
1020 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
1021 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
1022 reallocating the buffer if necessary. This means that lexing code that
1023 runs later will see the characters as if they had appeared in the input.
1024 It is not recommended to do this as part of normal parsing, and most
1025 uses of this facility run the risk of the inserted characters being
1026 interpreted in an unintended manner.
1028 The string to be inserted is the string value of I<sv>. The characters
1029 are recoded for the lexer buffer, according to how the buffer is currently
1030 being interpreted (L</lex_bufutf8>). If a string to be interpreted is
1031 not already a Perl scalar, the L</lex_stuff_pvn> function avoids the
1032 need to construct a scalar.
1038 Perl_lex_stuff_sv(pTHX_ SV *sv, U32 flags)
1042 PERL_ARGS_ASSERT_LEX_STUFF_SV;
1044 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_stuff_sv");
1046 lex_stuff_pvn(pv, len, flags | (SvUTF8(sv) ? LEX_STUFF_UTF8 : 0));
1050 =for apidoc Amx|void|lex_unstuff|char *ptr
1052 Discards text about to be lexed, from L</PL_parser-E<gt>bufptr> up to
1053 I<ptr>. Text following I<ptr> will be moved, and the buffer shortened.
1054 This hides the discarded text from any lexing code that runs later,
1055 as if the text had never appeared.
1057 This is not the normal way to consume lexed text. For that, use
1064 Perl_lex_unstuff(pTHX_ char *ptr)
1068 PERL_ARGS_ASSERT_LEX_UNSTUFF;
1069 buf = PL_parser->bufptr;
1071 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_unstuff");
1074 bufend = PL_parser->bufend;
1076 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_unstuff");
1077 unstuff_len = ptr - buf;
1078 Move(ptr, buf, bufend+1-ptr, char);
1079 SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) - unstuff_len);
1080 PL_parser->bufend = bufend - unstuff_len;
1084 =for apidoc Amx|void|lex_read_to|char *ptr
1086 Consume text in the lexer buffer, from L</PL_parser-E<gt>bufptr> up
1087 to I<ptr>. This advances L</PL_parser-E<gt>bufptr> to match I<ptr>,
1088 performing the correct bookkeeping whenever a newline character is passed.
1089 This is the normal way to consume lexed text.
1091 Interpretation of the buffer's octets can be abstracted out by
1092 using the slightly higher-level functions L</lex_peek_unichar> and
1093 L</lex_read_unichar>.
1099 Perl_lex_read_to(pTHX_ char *ptr)
1102 PERL_ARGS_ASSERT_LEX_READ_TO;
1103 s = PL_parser->bufptr;
1104 if (ptr < s || ptr > PL_parser->bufend)
1105 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_to");
1106 for (; s != ptr; s++)
1108 CopLINE_inc(PL_curcop);
1109 PL_parser->linestart = s+1;
1111 PL_parser->bufptr = ptr;
1115 =for apidoc Amx|void|lex_discard_to|char *ptr
1117 Discards the first part of the L</PL_parser-E<gt>linestr> buffer,
1118 up to I<ptr>. The remaining content of the buffer will be moved, and
1119 all pointers into the buffer updated appropriately. I<ptr> must not
1120 be later in the buffer than the position of L</PL_parser-E<gt>bufptr>:
1121 it is not permitted to discard text that has yet to be lexed.
1123 Normally it is not necessarily to do this directly, because it suffices to
1124 use the implicit discarding behaviour of L</lex_next_chunk> and things
1125 based on it. However, if a token stretches across multiple lines,
1126 and the lexing code has kept multiple lines of text in the buffer fof
1127 that purpose, then after completion of the token it would be wise to
1128 explicitly discard the now-unneeded earlier lines, to avoid future
1129 multi-line tokens growing the buffer without bound.
1135 Perl_lex_discard_to(pTHX_ char *ptr)
1139 PERL_ARGS_ASSERT_LEX_DISCARD_TO;
1140 buf = SvPVX(PL_parser->linestr);
1142 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_discard_to");
1145 if (ptr > PL_parser->bufptr)
1146 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_discard_to");
1147 discard_len = ptr - buf;
1148 if (PL_parser->oldbufptr < ptr)
1149 PL_parser->oldbufptr = ptr;
1150 if (PL_parser->oldoldbufptr < ptr)
1151 PL_parser->oldoldbufptr = ptr;
1152 if (PL_parser->last_uni && PL_parser->last_uni < ptr)
1153 PL_parser->last_uni = NULL;
1154 if (PL_parser->last_lop && PL_parser->last_lop < ptr)
1155 PL_parser->last_lop = NULL;
1156 Move(ptr, buf, PL_parser->bufend+1-ptr, char);
1157 SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) - discard_len);
1158 PL_parser->bufend -= discard_len;
1159 PL_parser->bufptr -= discard_len;
1160 PL_parser->oldbufptr -= discard_len;
1161 PL_parser->oldoldbufptr -= discard_len;
1162 if (PL_parser->last_uni)
1163 PL_parser->last_uni -= discard_len;
1164 if (PL_parser->last_lop)
1165 PL_parser->last_lop -= discard_len;
1169 =for apidoc Amx|bool|lex_next_chunk|U32 flags
1171 Reads in the next chunk of text to be lexed, appending it to
1172 L</PL_parser-E<gt>linestr>. This should be called when lexing code has
1173 looked to the end of the current chunk and wants to know more. It is
1174 usual, but not necessary, for lexing to have consumed the entirety of
1175 the current chunk at this time.
1177 If L</PL_parser-E<gt>bufptr> is pointing to the very end of the current
1178 chunk (i.e., the current chunk has been entirely consumed), normally the
1179 current chunk will be discarded at the same time that the new chunk is
1180 read in. If I<flags> includes C<LEX_KEEP_PREVIOUS>, the current chunk
1181 will not be discarded. If the current chunk has not been entirely
1182 consumed, then it will not be discarded regardless of the flag.
1184 Returns true if some new text was added to the buffer, or false if the
1185 buffer has reached the end of the input text.
1190 #define LEX_FAKE_EOF 0x80000000
1193 Perl_lex_next_chunk(pTHX_ U32 flags)
1197 STRLEN old_bufend_pos, new_bufend_pos;
1198 STRLEN bufptr_pos, oldbufptr_pos, oldoldbufptr_pos;
1199 STRLEN linestart_pos, last_uni_pos, last_lop_pos;
1200 bool got_some_for_debugger = 0;
1202 if (flags & ~(LEX_KEEP_PREVIOUS|LEX_FAKE_EOF))
1203 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_next_chunk");
1204 linestr = PL_parser->linestr;
1205 buf = SvPVX(linestr);
1206 if (!(flags & LEX_KEEP_PREVIOUS) &&
1207 PL_parser->bufptr == PL_parser->bufend) {
1208 old_bufend_pos = bufptr_pos = oldbufptr_pos = oldoldbufptr_pos = 0;
1210 if (PL_parser->last_uni != PL_parser->bufend)
1211 PL_parser->last_uni = NULL;
1212 if (PL_parser->last_lop != PL_parser->bufend)
1213 PL_parser->last_lop = NULL;
1214 last_uni_pos = last_lop_pos = 0;
1218 old_bufend_pos = PL_parser->bufend - buf;
1219 bufptr_pos = PL_parser->bufptr - buf;
1220 oldbufptr_pos = PL_parser->oldbufptr - buf;
1221 oldoldbufptr_pos = PL_parser->oldoldbufptr - buf;
1222 linestart_pos = PL_parser->linestart - buf;
1223 last_uni_pos = PL_parser->last_uni ? PL_parser->last_uni - buf : 0;
1224 last_lop_pos = PL_parser->last_lop ? PL_parser->last_lop - buf : 0;
1226 if (flags & LEX_FAKE_EOF) {
1228 } else if (!PL_parser->rsfp) {
1230 } else if (filter_gets(linestr, old_bufend_pos)) {
1232 got_some_for_debugger = 1;
1234 if (!SvPOK(linestr)) /* can get undefined by filter_gets */
1235 sv_setpvs(linestr, "");
1237 /* End of real input. Close filehandle (unless it was STDIN),
1238 * then add implicit termination.
1240 if ((PerlIO*)PL_parser->rsfp == PerlIO_stdin())
1241 PerlIO_clearerr(PL_parser->rsfp);
1242 else if (PL_parser->rsfp)
1243 (void)PerlIO_close(PL_parser->rsfp);
1244 PL_parser->rsfp = NULL;
1245 PL_doextract = FALSE;
1247 if (PL_madskills && !PL_in_eval && (PL_minus_p || PL_minus_n))
1250 if (!PL_in_eval && PL_minus_p) {
1252 /*{*/";}continue{print or die qq(-p destination: $!\\n);}");
1253 PL_minus_n = PL_minus_p = 0;
1254 } else if (!PL_in_eval && PL_minus_n) {
1255 sv_catpvs(linestr, /*{*/";}");
1258 sv_catpvs(linestr, ";");
1261 buf = SvPVX(linestr);
1262 new_bufend_pos = SvCUR(linestr);
1263 PL_parser->bufend = buf + new_bufend_pos;
1264 PL_parser->bufptr = buf + bufptr_pos;
1265 PL_parser->oldbufptr = buf + oldbufptr_pos;
1266 PL_parser->oldoldbufptr = buf + oldoldbufptr_pos;
1267 PL_parser->linestart = buf + linestart_pos;
1268 if (PL_parser->last_uni)
1269 PL_parser->last_uni = buf + last_uni_pos;
1270 if (PL_parser->last_lop)
1271 PL_parser->last_lop = buf + last_lop_pos;
1272 if (got_some_for_debugger && (PERLDB_LINE || PERLDB_SAVESRC) &&
1273 PL_curstash != PL_debstash) {
1274 /* debugger active and we're not compiling the debugger code,
1275 * so store the line into the debugger's array of lines
1277 update_debugger_info(NULL, buf+old_bufend_pos,
1278 new_bufend_pos-old_bufend_pos);
1284 =for apidoc Amx|I32|lex_peek_unichar|U32 flags
1286 Looks ahead one (Unicode) character in the text currently being lexed.
1287 Returns the codepoint (unsigned integer value) of the next character,
1288 or -1 if lexing has reached the end of the input text. To consume the
1289 peeked character, use L</lex_read_unichar>.
1291 If the next character is in (or extends into) the next chunk of input
1292 text, the next chunk will be read in. Normally the current chunk will be
1293 discarded at the same time, but if I<flags> includes C<LEX_KEEP_PREVIOUS>
1294 then the current chunk will not be discarded.
1296 If the input is being interpreted as UTF-8 and a UTF-8 encoding error
1297 is encountered, an exception is generated.
1303 Perl_lex_peek_unichar(pTHX_ U32 flags)
1306 if (flags & ~(LEX_KEEP_PREVIOUS))
1307 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_peek_unichar");
1308 s = PL_parser->bufptr;
1309 bufend = PL_parser->bufend;
1315 if (!lex_next_chunk(flags))
1317 s = PL_parser->bufptr;
1318 bufend = PL_parser->bufend;
1324 len = PL_utf8skip[head];
1325 while ((STRLEN)(bufend-s) < len) {
1326 if (!lex_next_chunk(flags | LEX_KEEP_PREVIOUS))
1328 s = PL_parser->bufptr;
1329 bufend = PL_parser->bufend;
1332 unichar = utf8n_to_uvuni((U8*)s, bufend-s, &retlen, UTF8_CHECK_ONLY);
1333 if (retlen == (STRLEN)-1) {
1334 /* malformed UTF-8 */
1336 SAVESPTR(PL_warnhook);
1337 PL_warnhook = PERL_WARNHOOK_FATAL;
1338 utf8n_to_uvuni((U8*)s, bufend-s, NULL, 0);
1344 if (!lex_next_chunk(flags))
1346 s = PL_parser->bufptr;
1353 =for apidoc Amx|I32|lex_read_unichar|U32 flags
1355 Reads the next (Unicode) character in the text currently being lexed.
1356 Returns the codepoint (unsigned integer value) of the character read,
1357 and moves L</PL_parser-E<gt>bufptr> past the character, or returns -1
1358 if lexing has reached the end of the input text. To non-destructively
1359 examine the next character, use L</lex_peek_unichar> instead.
1361 If the next character is in (or extends into) the next chunk of input
1362 text, the next chunk will be read in. Normally the current chunk will be
1363 discarded at the same time, but if I<flags> includes C<LEX_KEEP_PREVIOUS>
1364 then the current chunk will not be discarded.
1366 If the input is being interpreted as UTF-8 and a UTF-8 encoding error
1367 is encountered, an exception is generated.
1373 Perl_lex_read_unichar(pTHX_ U32 flags)
1376 if (flags & ~(LEX_KEEP_PREVIOUS))
1377 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_unichar");
1378 c = lex_peek_unichar(flags);
1381 CopLINE_inc(PL_curcop);
1382 PL_parser->bufptr += UTF8SKIP(PL_parser->bufptr);
1388 =for apidoc Amx|void|lex_read_space|U32 flags
1390 Reads optional spaces, in Perl style, in the text currently being
1391 lexed. The spaces may include ordinary whitespace characters and
1392 Perl-style comments. C<#line> directives are processed if encountered.
1393 L</PL_parser-E<gt>bufptr> is moved past the spaces, so that it points
1394 at a non-space character (or the end of the input text).
1396 If spaces extend into the next chunk of input text, the next chunk will
1397 be read in. Normally the current chunk will be discarded at the same
1398 time, but if I<flags> includes C<LEX_KEEP_PREVIOUS> then the current
1399 chunk will not be discarded.
1404 #define LEX_NO_NEXT_CHUNK 0x80000000
1407 Perl_lex_read_space(pTHX_ U32 flags)
1410 bool need_incline = 0;
1411 if (flags & ~(LEX_KEEP_PREVIOUS|LEX_NO_NEXT_CHUNK))
1412 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_space");
1415 sv_free(PL_skipwhite);
1416 PL_skipwhite = NULL;
1419 PL_skipwhite = newSVpvs("");
1420 #endif /* PERL_MAD */
1421 s = PL_parser->bufptr;
1422 bufend = PL_parser->bufend;
1428 } while (!(c == '\n' || (c == 0 && s == bufend)));
1429 } else if (c == '\n') {
1431 PL_parser->linestart = s;
1436 } else if (isSPACE(c)) {
1438 } else if (c == 0 && s == bufend) {
1442 sv_catpvn(PL_skipwhite, PL_parser->bufptr, s-PL_parser->bufptr);
1443 #endif /* PERL_MAD */
1444 if (flags & LEX_NO_NEXT_CHUNK)
1446 PL_parser->bufptr = s;
1447 CopLINE_inc(PL_curcop);
1448 got_more = lex_next_chunk(flags);
1449 CopLINE_dec(PL_curcop);
1450 s = PL_parser->bufptr;
1451 bufend = PL_parser->bufend;
1454 if (need_incline && PL_parser->rsfp) {
1464 sv_catpvn(PL_skipwhite, PL_parser->bufptr, s-PL_parser->bufptr);
1465 #endif /* PERL_MAD */
1466 PL_parser->bufptr = s;
1471 * This subroutine has nothing to do with tilting, whether at windmills
1472 * or pinball tables. Its name is short for "increment line". It
1473 * increments the current line number in CopLINE(PL_curcop) and checks
1474 * to see whether the line starts with a comment of the form
1475 * # line 500 "foo.pm"
1476 * If so, it sets the current line number and file to the values in the comment.
1480 S_incline(pTHX_ const char *s)
1487 PERL_ARGS_ASSERT_INCLINE;
1489 CopLINE_inc(PL_curcop);
1492 while (SPACE_OR_TAB(*s))
1494 if (strnEQ(s, "line", 4))
1498 if (SPACE_OR_TAB(*s))
1502 while (SPACE_OR_TAB(*s))
1510 if (!SPACE_OR_TAB(*s) && *s != '\r' && *s != '\n' && *s != '\0')
1512 while (SPACE_OR_TAB(*s))
1514 if (*s == '"' && (t = strchr(s+1, '"'))) {
1520 while (!isSPACE(*t))
1524 while (SPACE_OR_TAB(*e) || *e == '\r' || *e == '\f')
1526 if (*e != '\n' && *e != '\0')
1527 return; /* false alarm */
1530 const STRLEN len = t - s;
1531 #ifndef USE_ITHREADS
1532 SV *const temp_sv = CopFILESV(PL_curcop);
1537 cf = SvPVX(temp_sv);
1538 tmplen = SvCUR(temp_sv);
1544 if (tmplen > 7 && strnEQ(cf, "(eval ", 6)) {
1545 /* must copy *{"::_<(eval N)[oldfilename:L]"}
1546 * to *{"::_<newfilename"} */
1547 /* However, the long form of evals is only turned on by the
1548 debugger - usually they're "(eval %lu)" */
1552 STRLEN tmplen2 = len;
1553 if (tmplen + 2 <= sizeof smallbuf)
1556 Newx(tmpbuf, tmplen + 2, char);
1559 memcpy(tmpbuf + 2, cf, tmplen);
1561 gvp = (GV**)hv_fetch(PL_defstash, tmpbuf, tmplen, FALSE);
1566 if (tmplen2 + 2 <= sizeof smallbuf)
1569 Newx(tmpbuf2, tmplen2 + 2, char);
1571 if (tmpbuf2 != smallbuf || tmpbuf != smallbuf) {
1572 /* Either they malloc'd it, or we malloc'd it,
1573 so no prefix is present in ours. */
1578 memcpy(tmpbuf2 + 2, s, tmplen2);
1581 gv2 = *(GV**)hv_fetch(PL_defstash, tmpbuf2, tmplen2, TRUE);
1583 gv_init(gv2, PL_defstash, tmpbuf2, tmplen2, FALSE);
1584 /* adjust ${"::_<newfilename"} to store the new file name */
1585 GvSV(gv2) = newSVpvn(tmpbuf2 + 2, tmplen2 - 2);
1586 GvHV(gv2) = MUTABLE_HV(SvREFCNT_inc(GvHV(*gvp)));
1587 GvAV(gv2) = MUTABLE_AV(SvREFCNT_inc(GvAV(*gvp)));
1590 if (tmpbuf2 != smallbuf) Safefree(tmpbuf2);
1592 if (tmpbuf != smallbuf) Safefree(tmpbuf);
1595 CopFILE_free(PL_curcop);
1596 CopFILE_setn(PL_curcop, s, len);
1598 CopLINE_set(PL_curcop, atoi(n)-1);
1602 /* skip space before PL_thistoken */
1605 S_skipspace0(pTHX_ register char *s)
1607 PERL_ARGS_ASSERT_SKIPSPACE0;
1614 PL_thiswhite = newSVpvs("");
1615 sv_catsv(PL_thiswhite, PL_skipwhite);
1616 sv_free(PL_skipwhite);
1619 PL_realtokenstart = s - SvPVX(PL_linestr);
1623 /* skip space after PL_thistoken */
1626 S_skipspace1(pTHX_ register char *s)
1628 const char *start = s;
1629 I32 startoff = start - SvPVX(PL_linestr);
1631 PERL_ARGS_ASSERT_SKIPSPACE1;
1636 start = SvPVX(PL_linestr) + startoff;
1637 if (!PL_thistoken && PL_realtokenstart >= 0) {
1638 const char * const tstart = SvPVX(PL_linestr) + PL_realtokenstart;
1639 PL_thistoken = newSVpvn(tstart, start - tstart);
1641 PL_realtokenstart = -1;
1644 PL_nextwhite = newSVpvs("");
1645 sv_catsv(PL_nextwhite, PL_skipwhite);
1646 sv_free(PL_skipwhite);
1653 S_skipspace2(pTHX_ register char *s, SV **svp)
1656 const I32 bufptroff = PL_bufptr - SvPVX(PL_linestr);
1657 const I32 startoff = s - SvPVX(PL_linestr);
1659 PERL_ARGS_ASSERT_SKIPSPACE2;
1662 PL_bufptr = SvPVX(PL_linestr) + bufptroff;
1663 if (!PL_madskills || !svp)
1665 start = SvPVX(PL_linestr) + startoff;
1666 if (!PL_thistoken && PL_realtokenstart >= 0) {
1667 char * const tstart = SvPVX(PL_linestr) + PL_realtokenstart;
1668 PL_thistoken = newSVpvn(tstart, start - tstart);
1669 PL_realtokenstart = -1;
1673 *svp = newSVpvs("");
1674 sv_setsv(*svp, PL_skipwhite);
1675 sv_free(PL_skipwhite);
1684 S_update_debugger_info(pTHX_ SV *orig_sv, const char *const buf, STRLEN len)
1686 AV *av = CopFILEAVx(PL_curcop);
1688 SV * const sv = newSV_type(SVt_PVMG);
1690 sv_setsv(sv, orig_sv);
1692 sv_setpvn(sv, buf, len);
1695 av_store(av, (I32)CopLINE(PL_curcop), sv);
1701 * Called to gobble the appropriate amount and type of whitespace.
1702 * Skips comments as well.
1706 S_skipspace(pTHX_ register char *s)
1710 #endif /* PERL_MAD */
1711 PERL_ARGS_ASSERT_SKIPSPACE;
1714 sv_free(PL_skipwhite);
1715 PL_skipwhite = NULL;
1717 #endif /* PERL_MAD */
1718 if (PL_lex_formbrack && PL_lex_brackets <= PL_lex_formbrack) {
1719 while (s < PL_bufend && SPACE_OR_TAB(*s))
1722 STRLEN bufptr_pos = PL_bufptr - SvPVX(PL_linestr);
1724 lex_read_space(LEX_KEEP_PREVIOUS |
1725 (PL_sublex_info.sub_inwhat || PL_lex_state == LEX_FORMLINE ?
1726 LEX_NO_NEXT_CHUNK : 0));
1728 PL_bufptr = SvPVX(PL_linestr) + bufptr_pos;
1729 if (PL_linestart > PL_bufptr)
1730 PL_bufptr = PL_linestart;
1735 PL_skipwhite = newSVpvn(start, s-start);
1736 #endif /* PERL_MAD */
1742 * Check the unary operators to ensure there's no ambiguity in how they're
1743 * used. An ambiguous piece of code would be:
1745 * This doesn't mean rand() + 5. Because rand() is a unary operator,
1746 * the +5 is its argument.
1756 if (PL_oldoldbufptr != PL_last_uni)
1758 while (isSPACE(*PL_last_uni))
1761 while (isALNUM_lazy_if(s,UTF) || *s == '-')
1763 if ((t = strchr(s, '(')) && t < PL_bufptr)
1766 Perl_ck_warner_d(aTHX_ packWARN(WARN_AMBIGUOUS),
1767 "Warning: Use of \"%.*s\" without parentheses is ambiguous",
1768 (int)(s - PL_last_uni), PL_last_uni);
1772 * LOP : macro to build a list operator. Its behaviour has been replaced
1773 * with a subroutine, S_lop() for which LOP is just another name.
1776 #define LOP(f,x) return lop(f,x,s)
1780 * Build a list operator (or something that might be one). The rules:
1781 * - if we have a next token, then it's a list operator [why?]
1782 * - if the next thing is an opening paren, then it's a function
1783 * - else it's a list operator
1787 S_lop(pTHX_ I32 f, int x, char *s)
1791 PERL_ARGS_ASSERT_LOP;
1797 PL_last_lop = PL_oldbufptr;
1798 PL_last_lop_op = (OPCODE)f;
1801 return REPORT(LSTOP);
1804 return REPORT(LSTOP);
1807 return REPORT(FUNC);
1810 return REPORT(FUNC);
1812 return REPORT(LSTOP);
1818 * Sets up for an eventual force_next(). start_force(0) basically does
1819 * an unshift, while start_force(-1) does a push. yylex removes items
1824 S_start_force(pTHX_ int where)
1828 if (where < 0) /* so people can duplicate start_force(PL_curforce) */
1829 where = PL_lasttoke;
1830 assert(PL_curforce < 0 || PL_curforce == where);
1831 if (PL_curforce != where) {
1832 for (i = PL_lasttoke; i > where; --i) {
1833 PL_nexttoke[i] = PL_nexttoke[i-1];
1837 if (PL_curforce < 0) /* in case of duplicate start_force() */
1838 Zero(&PL_nexttoke[where], 1, NEXTTOKE);
1839 PL_curforce = where;
1842 curmad('^', newSVpvs(""));
1843 CURMAD('_', PL_nextwhite);
1848 S_curmad(pTHX_ char slot, SV *sv)
1854 if (PL_curforce < 0)
1855 where = &PL_thismad;
1857 where = &PL_nexttoke[PL_curforce].next_mad;
1863 if (UTF && is_utf8_string((U8*)SvPVX(sv), SvCUR(sv)))
1865 else if (PL_encoding) {
1866 sv_recode_to_utf8(sv, PL_encoding);
1871 /* keep a slot open for the head of the list? */
1872 if (slot != '_' && *where && (*where)->mad_key == '^') {
1873 (*where)->mad_key = slot;
1874 sv_free(MUTABLE_SV(((*where)->mad_val)));
1875 (*where)->mad_val = (void*)sv;
1878 addmad(newMADsv(slot, sv), where, 0);
1881 # define start_force(where) NOOP
1882 # define curmad(slot, sv) NOOP
1887 * When the lexer realizes it knows the next token (for instance,
1888 * it is reordering tokens for the parser) then it can call S_force_next
1889 * to know what token to return the next time the lexer is called. Caller
1890 * will need to set PL_nextval[] (or PL_nexttoke[].next_val with PERL_MAD),
1891 * and possibly PL_expect to ensure the lexer handles the token correctly.
1895 S_force_next(pTHX_ I32 type)
1900 PerlIO_printf(Perl_debug_log, "### forced token:\n");
1901 tokereport(type, &NEXTVAL_NEXTTOKE);
1905 if (PL_curforce < 0)
1906 start_force(PL_lasttoke);
1907 PL_nexttoke[PL_curforce].next_type = type;
1908 if (PL_lex_state != LEX_KNOWNEXT)
1909 PL_lex_defer = PL_lex_state;
1910 PL_lex_state = LEX_KNOWNEXT;
1911 PL_lex_expect = PL_expect;
1914 PL_nexttype[PL_nexttoke] = type;
1916 if (PL_lex_state != LEX_KNOWNEXT) {
1917 PL_lex_defer = PL_lex_state;
1918 PL_lex_expect = PL_expect;
1919 PL_lex_state = LEX_KNOWNEXT;
1925 S_newSV_maybe_utf8(pTHX_ const char *const start, STRLEN len)
1928 SV * const sv = newSVpvn_utf8(start, len,
1931 && !is_ascii_string((const U8*)start, len)
1932 && is_utf8_string((const U8*)start, len));
1938 * When the lexer knows the next thing is a word (for instance, it has
1939 * just seen -> and it knows that the next char is a word char, then
1940 * it calls S_force_word to stick the next word into the PL_nexttoke/val
1944 * char *start : buffer position (must be within PL_linestr)
1945 * int token : PL_next* will be this type of bare word (e.g., METHOD,WORD)
1946 * int check_keyword : if true, Perl checks to make sure the word isn't
1947 * a keyword (do this if the word is a label, e.g. goto FOO)
1948 * int allow_pack : if true, : characters will also be allowed (require,
1949 * use, etc. do this)
1950 * int allow_initial_tick : used by the "sub" lexer only.
1954 S_force_word(pTHX_ register char *start, int token, int check_keyword, int allow_pack, int allow_initial_tick)
1960 PERL_ARGS_ASSERT_FORCE_WORD;
1962 start = SKIPSPACE1(start);
1964 if (isIDFIRST_lazy_if(s,UTF) ||
1965 (allow_pack && *s == ':') ||
1966 (allow_initial_tick && *s == '\'') )
1968 s = scan_word(s, PL_tokenbuf, sizeof PL_tokenbuf, allow_pack, &len);
1969 if (check_keyword && keyword(PL_tokenbuf, len, 0))
1971 start_force(PL_curforce);
1973 curmad('X', newSVpvn(start,s-start));
1974 if (token == METHOD) {
1979 PL_expect = XOPERATOR;
1983 curmad('g', newSVpvs( "forced" ));
1984 NEXTVAL_NEXTTOKE.opval
1985 = (OP*)newSVOP(OP_CONST,0,
1986 S_newSV_maybe_utf8(aTHX_ PL_tokenbuf, len));
1987 NEXTVAL_NEXTTOKE.opval->op_private |= OPpCONST_BARE;
1995 * Called when the lexer wants $foo *foo &foo etc, but the program
1996 * text only contains the "foo" portion. The first argument is a pointer
1997 * to the "foo", and the second argument is the type symbol to prefix.
1998 * Forces the next token to be a "WORD".
1999 * Creates the symbol if it didn't already exist (via gv_fetchpv()).
2003 S_force_ident(pTHX_ register const char *s, int kind)
2007 PERL_ARGS_ASSERT_FORCE_IDENT;
2010 const STRLEN len = strlen(s);
2011 OP* const o = (OP*)newSVOP(OP_CONST, 0, newSVpvn(s, len));
2012 start_force(PL_curforce);
2013 NEXTVAL_NEXTTOKE.opval = o;
2016 o->op_private = OPpCONST_ENTERED;
2017 /* XXX see note in pp_entereval() for why we forgo typo
2018 warnings if the symbol must be introduced in an eval.
2020 gv_fetchpvn_flags(s, len,
2021 PL_in_eval ? (GV_ADDMULTI | GV_ADDINEVAL)
2023 kind == '$' ? SVt_PV :
2024 kind == '@' ? SVt_PVAV :
2025 kind == '%' ? SVt_PVHV :
2033 Perl_str_to_version(pTHX_ SV *sv)
2038 const char *start = SvPV_const(sv,len);
2039 const char * const end = start + len;
2040 const bool utf = SvUTF8(sv) ? TRUE : FALSE;
2042 PERL_ARGS_ASSERT_STR_TO_VERSION;
2044 while (start < end) {
2048 n = utf8n_to_uvchr((U8*)start, len, &skip, 0);
2053 retval += ((NV)n)/nshift;
2062 * Forces the next token to be a version number.
2063 * If the next token appears to be an invalid version number, (e.g. "v2b"),
2064 * and if "guessing" is TRUE, then no new token is created (and the caller
2065 * must use an alternative parsing method).
2069 S_force_version(pTHX_ char *s, int guessing)
2075 I32 startoff = s - SvPVX(PL_linestr);
2078 PERL_ARGS_ASSERT_FORCE_VERSION;
2086 while (isDIGIT(*d) || *d == '_' || *d == '.')
2090 start_force(PL_curforce);
2091 curmad('X', newSVpvn(s,d-s));
2094 if (*d == ';' || isSPACE(*d) || *d == '}' || !*d) {
2096 #ifdef USE_LOCALE_NUMERIC
2097 char *loc = setlocale(LC_NUMERIC, "C");
2099 s = scan_num(s, &pl_yylval);
2100 #ifdef USE_LOCALE_NUMERIC
2101 setlocale(LC_NUMERIC, loc);
2103 version = pl_yylval.opval;
2104 ver = cSVOPx(version)->op_sv;
2105 if (SvPOK(ver) && !SvNIOK(ver)) {
2106 SvUPGRADE(ver, SVt_PVNV);
2107 SvNV_set(ver, str_to_version(ver));
2108 SvNOK_on(ver); /* hint that it is a version */
2111 else if (guessing) {
2114 sv_free(PL_nextwhite); /* let next token collect whitespace */
2116 s = SvPVX(PL_linestr) + startoff;
2124 if (PL_madskills && !version) {
2125 sv_free(PL_nextwhite); /* let next token collect whitespace */
2127 s = SvPVX(PL_linestr) + startoff;
2130 /* NOTE: The parser sees the package name and the VERSION swapped */
2131 start_force(PL_curforce);
2132 NEXTVAL_NEXTTOKE.opval = version;
2139 * S_force_strict_version
2140 * Forces the next token to be a version number using strict syntax rules.
2144 S_force_strict_version(pTHX_ char *s)
2149 I32 startoff = s - SvPVX(PL_linestr);
2151 const char *errstr = NULL;
2153 PERL_ARGS_ASSERT_FORCE_STRICT_VERSION;
2155 while (isSPACE(*s)) /* leading whitespace */
2158 if (is_STRICT_VERSION(s,&errstr)) {
2160 s = (char *)scan_version(s, ver, 0);
2161 version = newSVOP(OP_CONST, 0, ver);
2163 else if ( (*s != ';' && *s != '}' ) && (s = SKIPSPACE1(s), (*s != ';' && *s !='}' ))) {
2166 yyerror(errstr); /* version required */
2171 if (PL_madskills && !version) {
2172 sv_free(PL_nextwhite); /* let next token collect whitespace */
2174 s = SvPVX(PL_linestr) + startoff;
2177 /* NOTE: The parser sees the package name and the VERSION swapped */
2178 start_force(PL_curforce);
2179 NEXTVAL_NEXTTOKE.opval = version;
2187 * Tokenize a quoted string passed in as an SV. It finds the next
2188 * chunk, up to end of string or a backslash. It may make a new
2189 * SV containing that chunk (if HINT_NEW_STRING is on). It also
2194 S_tokeq(pTHX_ SV *sv)
2198 register char *send;
2203 PERL_ARGS_ASSERT_TOKEQ;
2208 s = SvPV_force(sv, len);
2209 if (SvTYPE(sv) >= SVt_PVIV && SvIVX(sv) == -1)
2212 while (s < send && *s != '\\')
2217 if ( PL_hints & HINT_NEW_STRING ) {
2218 pv = newSVpvn_flags(SvPVX_const(pv), len, SVs_TEMP | SvUTF8(sv));
2222 if (s + 1 < send && (s[1] == '\\'))
2223 s++; /* all that, just for this */
2228 SvCUR_set(sv, d - SvPVX_const(sv));
2230 if ( PL_hints & HINT_NEW_STRING )
2231 return new_constant(NULL, 0, "q", sv, pv, "q", 1);
2236 * Now come three functions related to double-quote context,
2237 * S_sublex_start, S_sublex_push, and S_sublex_done. They're used when
2238 * converting things like "\u\Lgnat" into ucfirst(lc("gnat")). They
2239 * interact with PL_lex_state, and create fake ( ... ) argument lists
2240 * to handle functions and concatenation.
2241 * They assume that whoever calls them will be setting up a fake
2242 * join call, because each subthing puts a ',' after it. This lets
2245 * join($, , 'lower ', lcfirst( 'uPpEr', ) ,)
2247 * (I'm not sure whether the spurious commas at the end of lcfirst's
2248 * arguments and join's arguments are created or not).
2253 * Assumes that pl_yylval.ival is the op we're creating (e.g. OP_LCFIRST).
2255 * Pattern matching will set PL_lex_op to the pattern-matching op to
2256 * make (we return THING if pl_yylval.ival is OP_NULL, PMFUNC otherwise).
2258 * OP_CONST and OP_READLINE are easy--just make the new op and return.
2260 * Everything else becomes a FUNC.
2262 * Sets PL_lex_state to LEX_INTERPPUSH unless (ival was OP_NULL or we
2263 * had an OP_CONST or OP_READLINE). This just sets us up for a
2264 * call to S_sublex_push().
2268 S_sublex_start(pTHX)
2271 register const I32 op_type = pl_yylval.ival;
2273 if (op_type == OP_NULL) {
2274 pl_yylval.opval = PL_lex_op;
2278 if (op_type == OP_CONST || op_type == OP_READLINE) {
2279 SV *sv = tokeq(PL_lex_stuff);
2281 if (SvTYPE(sv) == SVt_PVIV) {
2282 /* Overloaded constants, nothing fancy: Convert to SVt_PV: */
2284 const char * const p = SvPV_const(sv, len);
2285 SV * const nsv = newSVpvn_flags(p, len, SvUTF8(sv));
2289 pl_yylval.opval = (OP*)newSVOP(op_type, 0, sv);
2290 PL_lex_stuff = NULL;
2291 /* Allow <FH> // "foo" */
2292 if (op_type == OP_READLINE)
2293 PL_expect = XTERMORDORDOR;
2296 else if (op_type == OP_BACKTICK && PL_lex_op) {
2297 /* readpipe() vas overriden */
2298 cSVOPx(cLISTOPx(cUNOPx(PL_lex_op)->op_first)->op_first->op_sibling)->op_sv = tokeq(PL_lex_stuff);
2299 pl_yylval.opval = PL_lex_op;
2301 PL_lex_stuff = NULL;
2305 PL_sublex_info.super_state = PL_lex_state;
2306 PL_sublex_info.sub_inwhat = (U16)op_type;
2307 PL_sublex_info.sub_op = PL_lex_op;
2308 PL_lex_state = LEX_INTERPPUSH;
2312 pl_yylval.opval = PL_lex_op;
2322 * Create a new scope to save the lexing state. The scope will be
2323 * ended in S_sublex_done. Returns a '(', starting the function arguments
2324 * to the uc, lc, etc. found before.
2325 * Sets PL_lex_state to LEX_INTERPCONCAT.
2334 PL_lex_state = PL_sublex_info.super_state;
2335 SAVEBOOL(PL_lex_dojoin);
2336 SAVEI32(PL_lex_brackets);
2337 SAVEI32(PL_lex_casemods);
2338 SAVEI32(PL_lex_starts);
2339 SAVEI8(PL_lex_state);
2340 SAVEVPTR(PL_lex_inpat);
2341 SAVEI16(PL_lex_inwhat);
2342 SAVECOPLINE(PL_curcop);
2343 SAVEPPTR(PL_bufptr);
2344 SAVEPPTR(PL_bufend);
2345 SAVEPPTR(PL_oldbufptr);
2346 SAVEPPTR(PL_oldoldbufptr);
2347 SAVEPPTR(PL_last_lop);
2348 SAVEPPTR(PL_last_uni);
2349 SAVEPPTR(PL_linestart);
2350 SAVESPTR(PL_linestr);
2351 SAVEGENERICPV(PL_lex_brackstack);
2352 SAVEGENERICPV(PL_lex_casestack);
2354 PL_linestr = PL_lex_stuff;
2355 PL_lex_stuff = NULL;
2357 PL_bufend = PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart
2358 = SvPVX(PL_linestr);
2359 PL_bufend += SvCUR(PL_linestr);
2360 PL_last_lop = PL_last_uni = NULL;
2361 SAVEFREESV(PL_linestr);
2363 PL_lex_dojoin = FALSE;
2364 PL_lex_brackets = 0;
2365 Newx(PL_lex_brackstack, 120, char);
2366 Newx(PL_lex_casestack, 12, char);
2367 PL_lex_casemods = 0;
2368 *PL_lex_casestack = '\0';
2370 PL_lex_state = LEX_INTERPCONCAT;
2371 CopLINE_set(PL_curcop, (line_t)PL_multi_start);
2373 PL_lex_inwhat = PL_sublex_info.sub_inwhat;
2374 if (PL_lex_inwhat == OP_MATCH || PL_lex_inwhat == OP_QR || PL_lex_inwhat == OP_SUBST)
2375 PL_lex_inpat = PL_sublex_info.sub_op;
2377 PL_lex_inpat = NULL;
2384 * Restores lexer state after a S_sublex_push.
2391 if (!PL_lex_starts++) {
2392 SV * const sv = newSVpvs("");
2393 if (SvUTF8(PL_linestr))
2395 PL_expect = XOPERATOR;
2396 pl_yylval.opval = (OP*)newSVOP(OP_CONST, 0, sv);
2400 if (PL_lex_casemods) { /* oops, we've got some unbalanced parens */
2401 PL_lex_state = LEX_INTERPCASEMOD;
2405 /* Is there a right-hand side to take care of? (s//RHS/ or tr//RHS/) */
2406 if (PL_lex_repl && (PL_lex_inwhat == OP_SUBST || PL_lex_inwhat == OP_TRANS)) {
2407 PL_linestr = PL_lex_repl;
2409 PL_bufend = PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
2410 PL_bufend += SvCUR(PL_linestr);
2411 PL_last_lop = PL_last_uni = NULL;
2412 SAVEFREESV(PL_linestr);
2413 PL_lex_dojoin = FALSE;
2414 PL_lex_brackets = 0;
2415 PL_lex_casemods = 0;
2416 *PL_lex_casestack = '\0';
2418 if (SvEVALED(PL_lex_repl)) {
2419 PL_lex_state = LEX_INTERPNORMAL;
2421 /* we don't clear PL_lex_repl here, so that we can check later
2422 whether this is an evalled subst; that means we rely on the
2423 logic to ensure sublex_done() is called again only via the
2424 branch (in yylex()) that clears PL_lex_repl, else we'll loop */
2427 PL_lex_state = LEX_INTERPCONCAT;
2437 PL_endwhite = newSVpvs("");
2438 sv_catsv(PL_endwhite, PL_thiswhite);
2442 sv_setpvs(PL_thistoken,"");
2444 PL_realtokenstart = -1;
2448 PL_bufend = SvPVX(PL_linestr);
2449 PL_bufend += SvCUR(PL_linestr);
2450 PL_expect = XOPERATOR;
2451 PL_sublex_info.sub_inwhat = 0;
2459 Extracts a pattern, double-quoted string, or transliteration. This
2462 It looks at PL_lex_inwhat and PL_lex_inpat to find out whether it's
2463 processing a pattern (PL_lex_inpat is true), a transliteration
2464 (PL_lex_inwhat == OP_TRANS is true), or a double-quoted string.
2466 Returns a pointer to the character scanned up to. If this is
2467 advanced from the start pointer supplied (i.e. if anything was
2468 successfully parsed), will leave an OP for the substring scanned
2469 in pl_yylval. Caller must intuit reason for not parsing further
2470 by looking at the next characters herself.
2474 constants: \N{NAME} only
2475 case and quoting: \U \Q \E
2476 stops on @ and $, but not for $ as tail anchor
2478 In transliterations:
2479 characters are VERY literal, except for - not at the start or end
2480 of the string, which indicates a range. If the range is in bytes,
2481 scan_const expands the range to the full set of intermediate
2482 characters. If the range is in utf8, the hyphen is replaced with
2483 a certain range mark which will be handled by pmtrans() in op.c.
2485 In double-quoted strings:
2487 double-quoted style: \r and \n
2488 constants: \x31, etc.
2489 deprecated backrefs: \1 (in substitution replacements)
2490 case and quoting: \U \Q \E
2493 scan_const does *not* construct ops to handle interpolated strings.
2494 It stops processing as soon as it finds an embedded $ or @ variable
2495 and leaves it to the caller to work out what's going on.
2497 embedded arrays (whether in pattern or not) could be:
2498 @foo, @::foo, @'foo, @{foo}, @$foo, @+, @-.
2500 $ in double-quoted strings must be the symbol of an embedded scalar.
2502 $ in pattern could be $foo or could be tail anchor. Assumption:
2503 it's a tail anchor if $ is the last thing in the string, or if it's
2504 followed by one of "()| \r\n\t"
2506 \1 (backreferences) are turned into $1
2508 The structure of the code is
2509 while (there's a character to process) {
2510 handle transliteration ranges
2511 skip regexp comments /(?#comment)/ and codes /(?{code})/
2512 skip #-initiated comments in //x patterns
2513 check for embedded arrays
2514 check for embedded scalars
2516 deprecate \1 in substitution replacements
2517 handle string-changing backslashes \l \U \Q \E, etc.
2518 switch (what was escaped) {
2519 handle \- in a transliteration (becomes a literal -)
2520 if a pattern and not \N{, go treat as regular character
2521 handle \132 (octal characters)
2522 handle \x15 and \x{1234} (hex characters)
2523 handle \N{name} (named characters, also \N{3,5} in a pattern)
2524 handle \cV (control characters)
2525 handle printf-style backslashes (\f, \r, \n, etc)
2528 } (end if backslash)
2529 handle regular character
2530 } (end while character to read)
2535 S_scan_const(pTHX_ char *start)
2538 register char *send = PL_bufend; /* end of the constant */
2539 SV *sv = newSV(send - start); /* sv for the constant. See
2540 note below on sizing. */
2541 register char *s = start; /* start of the constant */
2542 register char *d = SvPVX(sv); /* destination for copies */
2543 bool dorange = FALSE; /* are we in a translit range? */
2544 bool didrange = FALSE; /* did we just finish a range? */
2545 I32 has_utf8 = FALSE; /* Output constant is UTF8 */
2546 I32 this_utf8 = UTF; /* Is the source string assumed
2547 to be UTF8? But, this can
2548 show as true when the source
2549 isn't utf8, as for example
2550 when it is entirely composed
2553 /* Note on sizing: The scanned constant is placed into sv, which is
2554 * initialized by newSV() assuming one byte of output for every byte of
2555 * input. This routine expects newSV() to allocate an extra byte for a
2556 * trailing NUL, which this routine will append if it gets to the end of
2557 * the input. There may be more bytes of input than output (eg., \N{LATIN
2558 * CAPITAL LETTER A}), or more output than input if the constant ends up
2559 * recoded to utf8, but each time a construct is found that might increase
2560 * the needed size, SvGROW() is called. Its size parameter each time is
2561 * based on the best guess estimate at the time, namely the length used so
2562 * far, plus the length the current construct will occupy, plus room for
2563 * the trailing NUL, plus one byte for every input byte still unscanned */
2567 UV literal_endpoint = 0;
2568 bool native_range = TRUE; /* turned to FALSE if the first endpoint is Unicode. */
2571 PERL_ARGS_ASSERT_SCAN_CONST;
2573 if (PL_lex_inwhat == OP_TRANS && PL_sublex_info.sub_op) {
2574 /* If we are doing a trans and we know we want UTF8 set expectation */
2575 has_utf8 = PL_sublex_info.sub_op->op_private & (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF);
2576 this_utf8 = PL_sublex_info.sub_op->op_private & (PL_lex_repl ? OPpTRANS_FROM_UTF : OPpTRANS_TO_UTF);
2580 while (s < send || dorange) {
2582 /* get transliterations out of the way (they're most literal) */
2583 if (PL_lex_inwhat == OP_TRANS) {
2584 /* expand a range A-Z to the full set of characters. AIE! */
2586 I32 i; /* current expanded character */
2587 I32 min; /* first character in range */
2588 I32 max; /* last character in range */
2599 char * const c = (char*)utf8_hop((U8*)d, -1);
2603 *c = (char)UTF_TO_NATIVE(0xff);
2604 /* mark the range as done, and continue */
2610 i = d - SvPVX_const(sv); /* remember current offset */
2613 SvLEN(sv) + (has_utf8 ?
2614 (512 - UTF_CONTINUATION_MARK +
2617 /* How many two-byte within 0..255: 128 in UTF-8,
2618 * 96 in UTF-8-mod. */
2620 SvGROW(sv, SvLEN(sv) + 256); /* never more than 256 chars in a range */
2622 d = SvPVX(sv) + i; /* refresh d after realloc */
2626 for (j = 0; j <= 1; j++) {
2627 char * const c = (char*)utf8_hop((U8*)d, -1);
2628 const UV uv = utf8n_to_uvchr((U8*)c, d - c, NULL, 0);
2634 max = (U8)0xff; /* only to \xff */
2635 uvmax = uv; /* \x{100} to uvmax */
2637 d = c; /* eat endpoint chars */
2642 d -= 2; /* eat the first char and the - */
2643 min = (U8)*d; /* first char in range */
2644 max = (U8)d[1]; /* last char in range */
2651 "Invalid range \"%c-%c\" in transliteration operator",
2652 (char)min, (char)max);
2656 if (literal_endpoint == 2 &&
2657 ((isLOWER(min) && isLOWER(max)) ||
2658 (isUPPER(min) && isUPPER(max)))) {
2660 for (i = min; i <= max; i++)
2662 *d++ = NATIVE_TO_NEED(has_utf8,i);
2664 for (i = min; i <= max; i++)
2666 *d++ = NATIVE_TO_NEED(has_utf8,i);
2671 for (i = min; i <= max; i++)
2674 const U8 ch = (U8)NATIVE_TO_UTF(i);
2675 if (UNI_IS_INVARIANT(ch))
2678 *d++ = (U8)UTF8_EIGHT_BIT_HI(ch);
2679 *d++ = (U8)UTF8_EIGHT_BIT_LO(ch);
2688 d = (char*)uvchr_to_utf8((U8*)d, 0x100);
2690 *d++ = (char)UTF_TO_NATIVE(0xff);
2692 d = (char*)uvchr_to_utf8((U8*)d, uvmax);
2696 /* mark the range as done, and continue */
2700 literal_endpoint = 0;
2705 /* range begins (ignore - as first or last char) */
2706 else if (*s == '-' && s+1 < send && s != start) {
2708 Perl_croak(aTHX_ "Ambiguous range in transliteration operator");
2715 *d++ = (char)UTF_TO_NATIVE(0xff); /* use illegal utf8 byte--see pmtrans */
2725 literal_endpoint = 0;
2726 native_range = TRUE;
2731 /* if we get here, we're not doing a transliteration */
2733 /* skip for regexp comments /(?#comment)/ and code /(?{code})/,
2734 except for the last char, which will be done separately. */
2735 else if (*s == '(' && PL_lex_inpat && s[1] == '?') {
2737 while (s+1 < send && *s != ')')
2738 *d++ = NATIVE_TO_NEED(has_utf8,*s++);
2740 else if (s[2] == '{' /* This should match regcomp.c */
2741 || (s[2] == '?' && s[3] == '{'))
2744 char *regparse = s + (s[2] == '{' ? 3 : 4);
2747 while (count && (c = *regparse)) {
2748 if (c == '\\' && regparse[1])
2756 if (*regparse != ')')
2757 regparse--; /* Leave one char for continuation. */
2758 while (s < regparse)
2759 *d++ = NATIVE_TO_NEED(has_utf8,*s++);
2763 /* likewise skip #-initiated comments in //x patterns */
2764 else if (*s == '#' && PL_lex_inpat &&
2765 ((PMOP*)PL_lex_inpat)->op_pmflags & PMf_EXTENDED) {
2766 while (s+1 < send && *s != '\n')
2767 *d++ = NATIVE_TO_NEED(has_utf8,*s++);
2770 /* check for embedded arrays
2771 (@foo, @::foo, @'foo, @{foo}, @$foo, @+, @-)
2773 else if (*s == '@' && s[1]) {
2774 if (isALNUM_lazy_if(s+1,UTF))
2776 if (strchr(":'{$", s[1]))
2778 if (!PL_lex_inpat && (s[1] == '+' || s[1] == '-'))
2779 break; /* in regexp, neither @+ nor @- are interpolated */
2782 /* check for embedded scalars. only stop if we're sure it's a
2785 else if (*s == '$') {
2786 if (!PL_lex_inpat) /* not a regexp, so $ must be var */
2788 if (s + 1 < send && !strchr("()| \r\n\t", s[1])) {
2790 Perl_ck_warner(aTHX_ packWARN(WARN_AMBIGUOUS),
2791 "Possible unintended interpolation of $\\ in regex");
2793 break; /* in regexp, $ might be tail anchor */
2797 /* End of else if chain - OP_TRANS rejoin rest */
2800 if (*s == '\\' && s+1 < send) {
2801 char* e; /* Can be used for ending '}', etc. */
2805 /* deprecate \1 in strings and substitution replacements */
2806 if (PL_lex_inwhat == OP_SUBST && !PL_lex_inpat &&
2807 isDIGIT(*s) && *s != '0' && !isDIGIT(s[1]))
2809 Perl_ck_warner(aTHX_ packWARN(WARN_SYNTAX), "\\%c better written as $%c", *s, *s);
2814 /* string-change backslash escapes */
2815 if (PL_lex_inwhat != OP_TRANS && *s && strchr("lLuUEQ", *s)) {
2819 /* In a pattern, process \N, but skip any other backslash escapes.
2820 * This is because we don't want to translate an escape sequence
2821 * into a meta symbol and have the regex compiler use the meta
2822 * symbol meaning, e.g. \x{2E} would be confused with a dot. But
2823 * in spite of this, we do have to process \N here while the proper
2824 * charnames handler is in scope. See bugs #56444 and #62056.
2825 * There is a complication because \N in a pattern may also stand
2826 * for 'match a non-nl', and not mean a charname, in which case its
2827 * processing should be deferred to the regex compiler. To be a
2828 * charname it must be followed immediately by a '{', and not look
2829 * like \N followed by a curly quantifier, i.e., not something like
2830 * \N{3,}. regcurly returns a boolean indicating if it is a legal
2832 else if (PL_lex_inpat
2835 || regcurly(s + 1)))
2837 *d++ = NATIVE_TO_NEED(has_utf8,'\\');
2838 goto default_action;
2843 /* quoted - in transliterations */
2845 if (PL_lex_inwhat == OP_TRANS) {
2852 if ((isALPHA(*s) || isDIGIT(*s)))
2853 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
2854 "Unrecognized escape \\%c passed through",
2856 /* default action is to copy the quoted character */
2857 goto default_action;
2860 /* eg. \132 indicates the octal constant 0x132 */
2861 case '0': case '1': case '2': case '3':
2862 case '4': case '5': case '6': case '7':
2866 uv = NATIVE_TO_UNI(grok_oct(s, &len, &flags, NULL));
2869 goto NUM_ESCAPE_INSERT;
2871 /* eg. \x24 indicates the hex constant 0x24 */
2875 char* const e = strchr(s, '}');
2876 I32 flags = PERL_SCAN_ALLOW_UNDERSCORES |
2877 PERL_SCAN_DISALLOW_PREFIX;
2882 yyerror("Missing right brace on \\x{}");
2886 uv = NATIVE_TO_UNI(grok_hex(s, &len, &flags, NULL));
2892 I32 flags = PERL_SCAN_DISALLOW_PREFIX;
2893 uv = NATIVE_TO_UNI(grok_hex(s, &len, &flags, NULL));
2899 /* Insert oct or hex escaped character. There will always be
2900 * enough room in sv since such escapes will be longer than any
2901 * UTF-8 sequence they can end up as, except if they force us
2902 * to recode the rest of the string into utf8 */
2904 /* Here uv is the ordinal of the next character being added in
2905 * unicode (converted from native). */
2906 if (!UNI_IS_INVARIANT(uv)) {
2907 if (!has_utf8 && uv > 255) {
2908 /* Might need to recode whatever we have accumulated so
2909 * far if it contains any chars variant in utf8 or
2912 SvCUR_set(sv, d - SvPVX_const(sv));
2915 /* See Note on sizing above. */
2916 sv_utf8_upgrade_flags_grow(sv,
2917 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
2918 UNISKIP(uv) + (STRLEN)(send - s) + 1);
2919 d = SvPVX(sv) + SvCUR(sv);
2924 d = (char*)uvuni_to_utf8((U8*)d, uv);
2925 if (PL_lex_inwhat == OP_TRANS &&
2926 PL_sublex_info.sub_op) {
2927 PL_sublex_info.sub_op->op_private |=
2928 (PL_lex_repl ? OPpTRANS_FROM_UTF
2932 if (uv > 255 && !dorange)
2933 native_range = FALSE;
2946 /* In a non-pattern \N must be a named character, like \N{LATIN
2947 * SMALL LETTER A} or \N{U+0041}. For patterns, it also can
2948 * mean to match a non-newline. For non-patterns, named
2949 * characters are converted to their string equivalents. In
2950 * patterns, named characters are not converted to their
2951 * ultimate forms for the same reasons that other escapes
2952 * aren't. Instead, they are converted to the \N{U+...} form
2953 * to get the value from the charnames that is in effect right
2954 * now, while preserving the fact that it was a named character
2955 * so that the regex compiler knows this */
2957 /* This section of code doesn't generally use the
2958 * NATIVE_TO_NEED() macro to transform the input. I (khw) did
2959 * a close examination of this macro and determined it is a
2960 * no-op except on utfebcdic variant characters. Every
2961 * character generated by this that would normally need to be
2962 * enclosed by this macro is invariant, so the macro is not
2963 * needed, and would complicate use of copy(). There are other
2964 * parts of this file where the macro is used inconsistently,
2965 * but are saved by it being a no-op */
2967 /* The structure of this section of code (besides checking for
2968 * errors and upgrading to utf8) is:
2969 * Further disambiguate between the two meanings of \N, and if
2970 * not a charname, go process it elsewhere
2971 * If of form \N{U+...}, pass it through if a pattern;
2972 * otherwise convert to utf8
2973 * Otherwise must be \N{NAME}: convert to \N{U+c1.c2...} if a
2974 * pattern; otherwise convert to utf8 */
2976 /* Here, s points to the 'N'; the test below is guaranteed to
2977 * succeed if we are being called on a pattern as we already
2978 * know from a test above that the next character is a '{'.
2979 * On a non-pattern \N must mean 'named sequence, which
2980 * requires braces */
2983 yyerror("Missing braces on \\N{}");
2988 /* If there is no matching '}', it is an error. */
2989 if (! (e = strchr(s, '}'))) {
2990 if (! PL_lex_inpat) {
2991 yyerror("Missing right brace on \\N{}");
2993 yyerror("Missing right brace on \\N{} or unescaped left brace after \\N.");
2998 /* Here it looks like a named character */
3002 /* XXX This block is temporary code. \N{} implies that the
3003 * pattern is to have Unicode semantics, and therefore
3004 * currently has to be encoded in utf8. By putting it in
3005 * utf8 now, we save a whole pass in the regular expression
3006 * compiler. Once that code is changed so Unicode
3007 * semantics doesn't necessarily have to be in utf8, this
3008 * block should be removed */
3010 SvCUR_set(sv, d - SvPVX_const(sv));
3013 /* See Note on sizing above. */
3014 sv_utf8_upgrade_flags_grow(sv,
3015 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3016 /* 5 = '\N{' + cur char + NUL */
3017 (STRLEN)(send - s) + 5);
3018 d = SvPVX(sv) + SvCUR(sv);
3023 if (*s == 'U' && s[1] == '+') { /* \N{U+...} */
3024 I32 flags = PERL_SCAN_ALLOW_UNDERSCORES
3025 | PERL_SCAN_DISALLOW_PREFIX;
3028 /* For \N{U+...}, the '...' is a unicode value even on
3029 * EBCDIC machines */
3030 s += 2; /* Skip to next char after the 'U+' */
3032 uv = grok_hex(s, &len, &flags, NULL);
3033 if (len == 0 || len != (STRLEN)(e - s)) {
3034 yyerror("Invalid hexadecimal number in \\N{U+...}");
3041 /* Pass through to the regex compiler unchanged. The
3042 * reason we evaluated the number above is to make sure
3043 * there wasn't a syntax error. */
3044 s -= 5; /* Include the '\N{U+' */
3045 Copy(s, d, e - s + 1, char); /* 1 = include the } */
3048 else { /* Not a pattern: convert the hex to string */
3050 /* If destination is not in utf8, unconditionally
3051 * recode it to be so. This is because \N{} implies
3052 * Unicode semantics, and scalars have to be in utf8
3053 * to guarantee those semantics */
3055 SvCUR_set(sv, d - SvPVX_const(sv));
3058 /* See Note on sizing above. */
3059 sv_utf8_upgrade_flags_grow(
3061 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3062 UNISKIP(uv) + (STRLEN)(send - e) + 1);
3063 d = SvPVX(sv) + SvCUR(sv);
3067 /* Add the string to the output */
3068 if (UNI_IS_INVARIANT(uv)) {
3071 else d = (char*)uvuni_to_utf8((U8*)d, uv);
3074 else { /* Here is \N{NAME} but not \N{U+...}. */
3076 SV *res; /* result from charnames */
3077 const char *str; /* the string in 'res' */
3078 STRLEN len; /* its length */
3080 /* Get the value for NAME */
3081 res = newSVpvn(s, e - s);
3082 res = new_constant( NULL, 0, "charnames",
3083 /* includes all of: \N{...} */
3084 res, NULL, s - 3, e - s + 4 );
3086 /* Most likely res will be in utf8 already since the
3087 * standard charnames uses pack U, but a custom translator
3088 * can leave it otherwise, so make sure. XXX This can be
3089 * revisited to not have charnames use utf8 for characters
3090 * that don't need it when regexes don't have to be in utf8
3091 * for Unicode semantics. If doing so, remember EBCDIC */
3092 sv_utf8_upgrade(res);
3093 str = SvPV_const(res, len);
3095 /* Don't accept malformed input */
3096 if (! is_utf8_string((U8 *) str, len)) {
3097 yyerror("Malformed UTF-8 returned by \\N");
3099 else if (PL_lex_inpat) {
3101 if (! len) { /* The name resolved to an empty string */
3102 Copy("\\N{}", d, 4, char);
3106 /* In order to not lose information for the regex
3107 * compiler, pass the result in the specially made
3108 * syntax: \N{U+c1.c2.c3...}, where c1 etc. are
3109 * the code points in hex of each character
3110 * returned by charnames */
3112 const char *str_end = str + len;
3113 STRLEN char_length; /* cur char's byte length */
3114 STRLEN output_length; /* and the number of bytes
3115 after this is translated
3117 const STRLEN off = d - SvPVX_const(sv);
3119 /* 2 hex per byte; 2 chars for '\N'; 2 chars for
3120 * max('U+', '.'); and 1 for NUL */
3121 char hex_string[2 * UTF8_MAXBYTES + 5];
3123 /* Get the first character of the result. */
3124 U32 uv = utf8n_to_uvuni((U8 *) str,
3129 /* The call to is_utf8_string() above hopefully
3130 * guarantees that there won't be an error. But
3131 * it's easy here to make sure. The function just
3132 * above warns and returns 0 if invalid utf8, but
3133 * it can also return 0 if the input is validly a
3134 * NUL. Disambiguate */
3135 if (uv == 0 && NATIVE_TO_ASCII(*str) != '\0') {
3136 uv = UNICODE_REPLACEMENT;
3139 /* Convert first code point to hex, including the
3140 * boiler plate before it */
3141 sprintf(hex_string, "\\N{U+%X", (unsigned int) uv);
3142 output_length = strlen(hex_string);
3144 /* Make sure there is enough space to hold it */
3145 d = off + SvGROW(sv, off
3147 + (STRLEN)(send - e)
3148 + 2); /* '}' + NUL */
3150 Copy(hex_string, d, output_length, char);
3153 /* For each subsequent character, append dot and
3154 * its ordinal in hex */
3155 while ((str += char_length) < str_end) {
3156 const STRLEN off = d - SvPVX_const(sv);
3157 U32 uv = utf8n_to_uvuni((U8 *) str,
3161 if (uv == 0 && NATIVE_TO_ASCII(*str) != '\0') {
3162 uv = UNICODE_REPLACEMENT;
3165 sprintf(hex_string, ".%X", (unsigned int) uv);
3166 output_length = strlen(hex_string);
3168 d = off + SvGROW(sv, off
3170 + (STRLEN)(send - e)
3171 + 2); /* '}' + NUL */
3172 Copy(hex_string, d, output_length, char);
3176 *d++ = '}'; /* Done. Add the trailing brace */
3179 else { /* Here, not in a pattern. Convert the name to a
3182 /* If destination is not in utf8, unconditionally
3183 * recode it to be so. This is because \N{} implies
3184 * Unicode semantics, and scalars have to be in utf8
3185 * to guarantee those semantics */
3187 SvCUR_set(sv, d - SvPVX_const(sv));
3190 /* See Note on sizing above. */
3191 sv_utf8_upgrade_flags_grow(sv,
3192 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3193 len + (STRLEN)(send - s) + 1);
3194 d = SvPVX(sv) + SvCUR(sv);
3196 } else if (len > (STRLEN)(e - s + 4)) { /* I _guess_ 4 is \N{} --jhi */
3198 /* See Note on sizing above. (NOTE: SvCUR() is not
3199 * set correctly here). */
3200 const STRLEN off = d - SvPVX_const(sv);
3201 d = off + SvGROW(sv, off + len + (STRLEN)(send - s) + 1);
3203 Copy(str, d, len, char);
3210 native_range = FALSE; /* \N{} is defined to be Unicode */
3212 s = e + 1; /* Point to just after the '}' */
3215 /* \c is a control character */
3224 *d++ = NATIVE_TO_NEED(has_utf8,toCTRL(c));
3227 yyerror("Missing control char name in \\c");
3231 /* printf-style backslashes, formfeeds, newlines, etc */
3233 *d++ = NATIVE_TO_NEED(has_utf8,'\b');
3236 *d++ = NATIVE_TO_NEED(has_utf8,'\n');
3239 *d++ = NATIVE_TO_NEED(has_utf8,'\r');
3242 *d++ = NATIVE_TO_NEED(has_utf8,'\f');
3245 *d++ = NATIVE_TO_NEED(has_utf8,'\t');
3248 *d++ = ASCII_TO_NEED(has_utf8,'\033');
3251 *d++ = ASCII_TO_NEED(has_utf8,'\007');
3257 } /* end if (backslash) */
3264 /* If we started with encoded form, or already know we want it,
3265 then encode the next character */
3266 if (! NATIVE_IS_INVARIANT((U8)(*s)) && (this_utf8 || has_utf8)) {
3270 /* One might think that it is wasted effort in the case of the
3271 * source being utf8 (this_utf8 == TRUE) to take the next character
3272 * in the source, convert it to an unsigned value, and then convert
3273 * it back again. But the source has not been validated here. The
3274 * routine that does the conversion checks for errors like
3277 const UV nextuv = (this_utf8) ? utf8n_to_uvchr((U8*)s, send - s, &len, 0) : (UV) ((U8) *s);
3278 const STRLEN need = UNISKIP(NATIVE_TO_UNI(nextuv));
3280 SvCUR_set(sv, d - SvPVX_const(sv));
3283 /* See Note on sizing above. */
3284 sv_utf8_upgrade_flags_grow(sv,
3285 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3286 need + (STRLEN)(send - s) + 1);
3287 d = SvPVX(sv) + SvCUR(sv);
3289 } else if (need > len) {
3290 /* encoded value larger than old, may need extra space (NOTE:
3291 * SvCUR() is not set correctly here). See Note on sizing
3293 const STRLEN off = d - SvPVX_const(sv);
3294 d = SvGROW(sv, off + need + (STRLEN)(send - s) + 1) + off;
3298 d = (char*)uvchr_to_utf8((U8*)d, nextuv);
3300 if (uv > 255 && !dorange)
3301 native_range = FALSE;
3305 *d++ = NATIVE_TO_NEED(has_utf8,*s++);
3307 } /* while loop to process each character */
3309 /* terminate the string and set up the sv */
3311 SvCUR_set(sv, d - SvPVX_const(sv));
3312 if (SvCUR(sv) >= SvLEN(sv))
3313 Perl_croak(aTHX_ "panic: constant overflowed allocated space");
3316 if (PL_encoding && !has_utf8) {
3317 sv_recode_to_utf8(sv, PL_encoding);
3323 if (PL_lex_inwhat == OP_TRANS && PL_sublex_info.sub_op) {
3324 PL_sublex_info.sub_op->op_private |=
3325 (PL_lex_repl ? OPpTRANS_FROM_UTF : OPpTRANS_TO_UTF);
3329 /* shrink the sv if we allocated more than we used */
3330 if (SvCUR(sv) + 5 < SvLEN(sv)) {
3331 SvPV_shrink_to_cur(sv);
3334 /* return the substring (via pl_yylval) only if we parsed anything */
3335 if (s > PL_bufptr) {
3336 if ( PL_hints & ( PL_lex_inpat ? HINT_NEW_RE : HINT_NEW_STRING ) ) {
3337 const char *const key = PL_lex_inpat ? "qr" : "q";
3338 const STRLEN keylen = PL_lex_inpat ? 2 : 1;
3342 if (PL_lex_inwhat == OP_TRANS) {
3345 } else if (PL_lex_inwhat == OP_SUBST && !PL_lex_inpat) {
3353 sv = S_new_constant(aTHX_ start, s - start, key, keylen, sv, NULL,
3356 pl_yylval.opval = (OP*)newSVOP(OP_CONST, 0, sv);
3363 * Returns TRUE if there's more to the expression (e.g., a subscript),
3366 * It deals with "$foo[3]" and /$foo[3]/ and /$foo[0123456789$]+/
3368 * ->[ and ->{ return TRUE
3369 * { and [ outside a pattern are always subscripts, so return TRUE
3370 * if we're outside a pattern and it's not { or [, then return FALSE
3371 * if we're in a pattern and the first char is a {
3372 * {4,5} (any digits around the comma) returns FALSE
3373 * if we're in a pattern and the first char is a [
3375 * [SOMETHING] has a funky algorithm to decide whether it's a
3376 * character class or not. It has to deal with things like
3377 * /$foo[-3]/ and /$foo[$bar]/ as well as /$foo[$\d]+/
3378 * anything else returns TRUE
3381 /* This is the one truly awful dwimmer necessary to conflate C and sed. */
3384 S_intuit_more(pTHX_ register char *s)
3388 PERL_ARGS_ASSERT_INTUIT_MORE;
3390 if (PL_lex_brackets)
3392 if (*s == '-' && s[1] == '>' && (s[2] == '[' || s[2] == '{'))
3394 if (*s != '{' && *s != '[')
3399 /* In a pattern, so maybe we have {n,m}. */
3416 /* On the other hand, maybe we have a character class */
3419 if (*s == ']' || *s == '^')
3422 /* this is terrifying, and it works */
3423 int weight = 2; /* let's weigh the evidence */
3425 unsigned char un_char = 255, last_un_char;
3426 const char * const send = strchr(s,']');
3427 char tmpbuf[sizeof PL_tokenbuf * 4];
3429 if (!send) /* has to be an expression */
3432 Zero(seen,256,char);
3435 else if (isDIGIT(*s)) {
3437 if (isDIGIT(s[1]) && s[2] == ']')
3443 for (; s < send; s++) {
3444 last_un_char = un_char;
3445 un_char = (unsigned char)*s;
3450 weight -= seen[un_char] * 10;
3451 if (isALNUM_lazy_if(s+1,UTF)) {
3453 scan_ident(s, send, tmpbuf, sizeof tmpbuf, FALSE);
3454 len = (int)strlen(tmpbuf);
3455 if (len > 1 && gv_fetchpvn_flags(tmpbuf, len, 0, SVt_PV))
3460 else if (*s == '$' && s[1] &&
3461 strchr("[#!%*<>()-=",s[1])) {
3462 if (/*{*/ strchr("])} =",s[2]))
3471 if (strchr("wds]",s[1]))
3473 else if (seen[(U8)'\''] || seen[(U8)'"'])
3475 else if (strchr("rnftbxcav",s[1]))
3477 else if (isDIGIT(s[1])) {
3479 while (s[1] && isDIGIT(s[1]))
3489 if (strchr("aA01! ",last_un_char))
3491 if (strchr("zZ79~",s[1]))
3493 if (last_un_char == 255 && (isDIGIT(s[1]) || s[1] == '$'))
3494 weight -= 5; /* cope with negative subscript */
3497 if (!isALNUM(last_un_char)
3498 && !(last_un_char == '$' || last_un_char == '@'
3499 || last_un_char == '&')
3500 && isALPHA(*s) && s[1] && isALPHA(s[1])) {
3505 if (keyword(tmpbuf, d - tmpbuf, 0))
3508 if (un_char == last_un_char + 1)
3510 weight -= seen[un_char];
3515 if (weight >= 0) /* probably a character class */
3525 * Does all the checking to disambiguate
3527 * between foo(bar) and bar->foo. Returns 0 if not a method, otherwise
3528 * FUNCMETH (bar->foo(args)) or METHOD (bar->foo args).
3530 * First argument is the stuff after the first token, e.g. "bar".
3532 * Not a method if bar is a filehandle.
3533 * Not a method if foo is a subroutine prototyped to take a filehandle.
3534 * Not a method if it's really "Foo $bar"
3535 * Method if it's "foo $bar"
3536 * Not a method if it's really "print foo $bar"
3537 * Method if it's really "foo package::" (interpreted as package->foo)
3538 * Not a method if bar is known to be a subroutine ("sub bar; foo bar")
3539 * Not a method if bar is a filehandle or package, but is quoted with
3544 S_intuit_method(pTHX_ char *start, GV *gv, CV *cv)
3547 char *s = start + (*start == '$');
3548 char tmpbuf[sizeof PL_tokenbuf];
3555 PERL_ARGS_ASSERT_INTUIT_METHOD;
3558 if (SvTYPE(gv) == SVt_PVGV && GvIO(gv))
3562 const char *proto = SvPVX_const(cv);
3573 s = scan_word(s, tmpbuf, sizeof tmpbuf, TRUE, &len);
3574 /* start is the beginning of the possible filehandle/object,
3575 * and s is the end of it
3576 * tmpbuf is a copy of it
3579 if (*start == '$') {
3580 if (gv || PL_last_lop_op == OP_PRINT || PL_last_lop_op == OP_SAY ||
3581 isUPPER(*PL_tokenbuf))
3584 len = start - SvPVX(PL_linestr);
3588 start = SvPVX(PL_linestr) + len;
3592 return *s == '(' ? FUNCMETH : METHOD;
3594 if (!keyword(tmpbuf, len, 0)) {
3595 if (len > 2 && tmpbuf[len - 2] == ':' && tmpbuf[len - 1] == ':') {
3599 soff = s - SvPVX(PL_linestr);
3603 indirgv = gv_fetchpvn_flags(tmpbuf, len, 0, SVt_PVCV);
3604 if (indirgv && GvCVu(indirgv))
3606 /* filehandle or package name makes it a method */
3607 if (!gv || GvIO(indirgv) || gv_stashpvn(tmpbuf, len, 0)) {
3609 soff = s - SvPVX(PL_linestr);
3612 if ((PL_bufend - s) >= 2 && *s == '=' && *(s+1) == '>')
3613 return 0; /* no assumptions -- "=>" quotes bearword */
3615 start_force(PL_curforce);
3616 NEXTVAL_NEXTTOKE.opval = (OP*)newSVOP(OP_CONST, 0,
3617 S_newSV_maybe_utf8(aTHX_ tmpbuf, len));
3618 NEXTVAL_NEXTTOKE.opval->op_private = OPpCONST_BARE;
3620 curmad('X', newSVpvn(start,SvPVX(PL_linestr) + soff - start));
3625 PL_bufptr = SvPVX(PL_linestr) + soff; /* restart before space */
3627 return *s == '(' ? FUNCMETH : METHOD;
3633 /* Encoded script support. filter_add() effectively inserts a
3634 * 'pre-processing' function into the current source input stream.
3635 * Note that the filter function only applies to the current source file
3636 * (e.g., it will not affect files 'require'd or 'use'd by this one).
3638 * The datasv parameter (which may be NULL) can be used to pass
3639 * private data to this instance of the filter. The filter function
3640 * can recover the SV using the FILTER_DATA macro and use it to
3641 * store private buffers and state information.
3643 * The supplied datasv parameter is upgraded to a PVIO type
3644 * and the IoDIRP/IoANY field is used to store the function pointer,
3645 * and IOf_FAKE_DIRP is enabled on datasv to mark this as such.
3646 * Note that IoTOP_NAME, IoFMT_NAME, IoBOTTOM_NAME, if set for
3647 * private use must be set using malloc'd pointers.
3651 Perl_filter_add(pTHX_ filter_t funcp, SV *datasv)
3660 if (!PL_rsfp_filters)
3661 PL_rsfp_filters = newAV();
3664 SvUPGRADE(datasv, SVt_PVIO);
3665 IoANY(datasv) = FPTR2DPTR(void *, funcp); /* stash funcp into spare field */
3666 IoFLAGS(datasv) |= IOf_FAKE_DIRP;
3667 DEBUG_P(PerlIO_printf(Perl_debug_log, "filter_add func %p (%s)\n",
3668 FPTR2DPTR(void *, IoANY(datasv)),
3669 SvPV_nolen(datasv)));
3670 av_unshift(PL_rsfp_filters, 1);
3671 av_store(PL_rsfp_filters, 0, datasv) ;
3676 /* Delete most recently added instance of this filter function. */
3678 Perl_filter_del(pTHX_ filter_t funcp)
3683 PERL_ARGS_ASSERT_FILTER_DEL;
3686 DEBUG_P(PerlIO_printf(Perl_debug_log, "filter_del func %p",
3687 FPTR2DPTR(void*, funcp)));
3689 if (!PL_parser || !PL_rsfp_filters || AvFILLp(PL_rsfp_filters)<0)
3691 /* if filter is on top of stack (usual case) just pop it off */
3692 datasv = FILTER_DATA(AvFILLp(PL_rsfp_filters));
3693 if (IoANY(datasv) == FPTR2DPTR(void *, funcp)) {
3694 IoFLAGS(datasv) &= ~IOf_FAKE_DIRP;
3695 IoANY(datasv) = (void *)NULL;
3696 sv_free(av_pop(PL_rsfp_filters));
3700 /* we need to search for the correct entry and clear it */
3701 Perl_die(aTHX_ "filter_del can only delete in reverse order (currently)");
3705 /* Invoke the idxth filter function for the current rsfp. */
3706 /* maxlen 0 = read one text line */
3708 Perl_filter_read(pTHX_ int idx, SV *buf_sv, int maxlen)
3713 /* This API is bad. It should have been using unsigned int for maxlen.
3714 Not sure if we want to change the API, but if not we should sanity
3715 check the value here. */
3716 const unsigned int correct_length
3725 PERL_ARGS_ASSERT_FILTER_READ;
3727 if (!PL_parser || !PL_rsfp_filters)
3729 if (idx > AvFILLp(PL_rsfp_filters)) { /* Any more filters? */
3730 /* Provide a default input filter to make life easy. */
3731 /* Note that we append to the line. This is handy. */
3732 DEBUG_P(PerlIO_printf(Perl_debug_log,
3733 "filter_read %d: from rsfp\n", idx));
3734 if (correct_length) {
3737 const int old_len = SvCUR(buf_sv);
3739 /* ensure buf_sv is large enough */
3740 SvGROW(buf_sv, (STRLEN)(old_len + correct_length + 1)) ;
3741 if ((len = PerlIO_read(PL_rsfp, SvPVX(buf_sv) + old_len,
3742 correct_length)) <= 0) {
3743 if (PerlIO_error(PL_rsfp))
3744 return -1; /* error */
3746 return 0 ; /* end of file */
3748 SvCUR_set(buf_sv, old_len + len) ;
3749 SvPVX(buf_sv)[old_len + len] = '\0';
3752 if (sv_gets(buf_sv, PL_rsfp, SvCUR(buf_sv)) == NULL) {
3753 if (PerlIO_error(PL_rsfp))
3754 return -1; /* error */
3756 return 0 ; /* end of file */
3759 return SvCUR(buf_sv);
3761 /* Skip this filter slot if filter has been deleted */
3762 if ( (datasv = FILTER_DATA(idx)) == &PL_sv_undef) {
3763 DEBUG_P(PerlIO_printf(Perl_debug_log,
3764 "filter_read %d: skipped (filter deleted)\n",
3766 return FILTER_READ(idx+1, buf_sv, correct_length); /* recurse */
3768 /* Get function pointer hidden within datasv */
3769 funcp = DPTR2FPTR(filter_t, IoANY(datasv));
3770 DEBUG_P(PerlIO_printf(Perl_debug_log,
3771 "filter_read %d: via function %p (%s)\n",
3772 idx, (void*)datasv, SvPV_nolen_const(datasv)));
3773 /* Call function. The function is expected to */
3774 /* call "FILTER_READ(idx+1, buf_sv)" first. */
3775 /* Return: <0:error, =0:eof, >0:not eof */
3776 return (*funcp)(aTHX_ idx, buf_sv, correct_length);
3780 S_filter_gets(pTHX_ register SV *sv, STRLEN append)
3784 PERL_ARGS_ASSERT_FILTER_GETS;
3786 #ifdef PERL_CR_FILTER
3787 if (!PL_rsfp_filters) {
3788 filter_add(S_cr_textfilter,NULL);
3791 if (PL_rsfp_filters) {
3793 SvCUR_set(sv, 0); /* start with empty line */
3794 if (FILTER_READ(0, sv, 0) > 0)
3795 return ( SvPVX(sv) ) ;
3800 return (sv_gets(sv, PL_rsfp, append));
3804 S_find_in_my_stash(pTHX_ const char *pkgname, STRLEN len)
3809 PERL_ARGS_ASSERT_FIND_IN_MY_STASH;
3811 if (len == 11 && *pkgname == '_' && strEQ(pkgname, "__PACKAGE__"))
3815 (pkgname[len - 2] == ':' && pkgname[len - 1] == ':') &&
3816 (gv = gv_fetchpvn_flags(pkgname, len, 0, SVt_PVHV)))
3818 return GvHV(gv); /* Foo:: */
3821 /* use constant CLASS => 'MyClass' */
3822 gv = gv_fetchpvn_flags(pkgname, len, 0, SVt_PVCV);
3823 if (gv && GvCV(gv)) {
3824 SV * const sv = cv_const_sv(GvCV(gv));
3826 pkgname = SvPV_const(sv, len);
3829 return gv_stashpvn(pkgname, len, 0);
3833 * S_readpipe_override
3834 * Check whether readpipe() is overriden, and generates the appropriate
3835 * optree, provided sublex_start() is called afterwards.
3838 S_readpipe_override(pTHX)
3841 GV *gv_readpipe = gv_fetchpvs("readpipe", GV_NOTQUAL, SVt_PVCV);
3842 pl_yylval.ival = OP_BACKTICK;
3844 && GvCVu(gv_readpipe) && GvIMPORTED_CV(gv_readpipe))
3846 ((gvp = (GV**)hv_fetchs(PL_globalstash, "readpipe", FALSE))
3847 && (gv_readpipe = *gvp) && isGV_with_GP(gv_readpipe)
3848 && GvCVu(gv_readpipe) && GvIMPORTED_CV(gv_readpipe)))
3850 PL_lex_op = (OP*)newUNOP(OP_ENTERSUB, OPf_STACKED,
3851 append_elem(OP_LIST,
3852 newSVOP(OP_CONST, 0, &PL_sv_undef), /* value will be read later */
3853 newCVREF(0, newGVOP(OP_GV, 0, gv_readpipe))));
3860 * The intent of this yylex wrapper is to minimize the changes to the
3861 * tokener when we aren't interested in collecting madprops. It remains
3862 * to be seen how successful this strategy will be...
3869 char *s = PL_bufptr;
3871 /* make sure PL_thiswhite is initialized */
3875 /* just do what yylex would do on pending identifier; leave PL_thiswhite alone */
3876 if (PL_pending_ident)
3877 return S_pending_ident(aTHX);
3879 /* previous token ate up our whitespace? */
3880 if (!PL_lasttoke && PL_nextwhite) {
3881 PL_thiswhite = PL_nextwhite;
3885 /* isolate the token, and figure out where it is without whitespace */
3886 PL_realtokenstart = -1;
3890 assert(PL_curforce < 0);
3892 if (!PL_thismad || PL_thismad->mad_key == '^') { /* not forced already? */
3893 if (!PL_thistoken) {
3894 if (PL_realtokenstart < 0 || !CopLINE(PL_curcop))
3895 PL_thistoken = newSVpvs("");
3897 char * const tstart = SvPVX(PL_linestr) + PL_realtokenstart;
3898 PL_thistoken = newSVpvn(tstart, s - tstart);
3901 if (PL_thismad) /* install head */
3902 CURMAD('X', PL_thistoken);
3905 /* last whitespace of a sublex? */
3906 if (optype == ')' && PL_endwhite) {
3907 CURMAD('X', PL_endwhite);
3912 /* if no whitespace and we're at EOF, bail. Otherwise fake EOF below. */
3913 if (!PL_thiswhite && !PL_endwhite && !optype) {
3914 sv_free(PL_thistoken);
3919 /* put off final whitespace till peg */
3920 if (optype == ';' && !PL_rsfp) {
3921 PL_nextwhite = PL_thiswhite;
3924 else if (PL_thisopen) {
3925 CURMAD('q', PL_thisopen);
3927 sv_free(PL_thistoken);
3931 /* Store actual token text as madprop X */
3932 CURMAD('X', PL_thistoken);
3936 /* add preceding whitespace as madprop _ */
3937 CURMAD('_', PL_thiswhite);
3941 /* add quoted material as madprop = */
3942 CURMAD('=', PL_thisstuff);
3946 /* add terminating quote as madprop Q */
3947 CURMAD('Q', PL_thisclose);
3951 /* special processing based on optype */
3955 /* opval doesn't need a TOKEN since it can already store mp */
3965 if (pl_yylval.opval)
3966 append_madprops(PL_thismad, pl_yylval.opval, 0);
3974 addmad(newMADsv('p', PL_endwhite), &PL_thismad, 0);
3983 /* remember any fake bracket that lexer is about to discard */
3984 if (PL_lex_brackets == 1 &&
3985 ((expectation)PL_lex_brackstack[0] & XFAKEBRACK))
3988 while (s < PL_bufend && (*s == ' ' || *s == '\t'))
3991 PL_thiswhite = newSVpvn(PL_bufptr, ++s - PL_bufptr);
3992 addmad(newMADsv('#', PL_thiswhite), &PL_thismad, 0);
3995 break; /* don't bother looking for trailing comment */
4004 /* attach a trailing comment to its statement instead of next token */
4008 if (PL_bufptr > PL_oldbufptr && PL_bufptr[-1] == optype) {
4010 while (s < PL_bufend && (*s == ' ' || *s == '\t'))
4012 if (*s == '\n' || *s == '#') {
4013 while (s < PL_bufend && *s != '\n')
4017 PL_thiswhite = newSVpvn(PL_bufptr, s - PL_bufptr);
4018 addmad(newMADsv('#', PL_thiswhite), &PL_thismad, 0);
4035 /* Create new token struct. Note: opvals return early above. */
4036 pl_yylval.tkval = newTOKEN(optype, pl_yylval, PL_thismad);
4043 S_tokenize_use(pTHX_ int is_use, char *s) {
4046 PERL_ARGS_ASSERT_TOKENIZE_USE;
4048 if (PL_expect != XSTATE)
4049 yyerror(Perl_form(aTHX_ "\"%s\" not allowed in expression",
4050 is_use ? "use" : "no"));
4052 if (isDIGIT(*s) || (*s == 'v' && isDIGIT(s[1]))) {
4053 s = force_version(s, TRUE);
4054 if (*s == ';' || *s == '}'
4055 || (s = SKIPSPACE1(s), (*s == ';' || *s == '}'))) {
4056 start_force(PL_curforce);
4057 NEXTVAL_NEXTTOKE.opval = NULL;
4060 else if (*s == 'v') {
4061 s = force_word(s,WORD,FALSE,TRUE,FALSE);
4062 s = force_version(s, FALSE);
4066 s = force_word(s,WORD,FALSE,TRUE,FALSE);
4067 s = force_version(s, FALSE);
4069 pl_yylval.ival = is_use;
4073 static const char* const exp_name[] =
4074 { "OPERATOR", "TERM", "REF", "STATE", "BLOCK", "ATTRBLOCK",
4075 "ATTRTERM", "TERMBLOCK", "TERMORDORDOR"
4082 Works out what to call the token just pulled out of the input
4083 stream. The yacc parser takes care of taking the ops we return and
4084 stitching them into a tree.
4090 if read an identifier
4091 if we're in a my declaration
4092 croak if they tried to say my($foo::bar)
4093 build the ops for a my() declaration
4094 if it's an access to a my() variable
4095 are we in a sort block?
4096 croak if my($a); $a <=> $b
4097 build ops for access to a my() variable
4098 if in a dq string, and they've said @foo and we can't find @foo
4100 build ops for a bareword
4101 if we already built the token before, use it.
4106 #pragma segment Perl_yylex
4112 register char *s = PL_bufptr;
4118 /* orig_keyword, gvp, and gv are initialized here because
4119 * jump to the label just_a_word_zero can bypass their
4120 * initialization later. */
4121 I32 orig_keyword = 0;
4126 SV* tmp = newSVpvs("");
4127 PerlIO_printf(Perl_debug_log, "### %"IVdf":LEX_%s/X%s %s\n",
4128 (IV)CopLINE(PL_curcop),
4129 lex_state_names[PL_lex_state],
4130 exp_name[PL_expect],
4131 pv_display(tmp, s, strlen(s), 0, 60));
4134 /* check if there's an identifier for us to look at */
4135 if (PL_pending_ident)
4136 return REPORT(S_pending_ident(aTHX));
4138 /* no identifier pending identification */
4140 switch (PL_lex_state) {
4142 case LEX_NORMAL: /* Some compilers will produce faster */
4143 case LEX_INTERPNORMAL: /* code if we comment these out. */
4147 /* when we've already built the next token, just pull it out of the queue */
4151 pl_yylval = PL_nexttoke[PL_lasttoke].next_val;
4153 PL_thismad = PL_nexttoke[PL_lasttoke].next_mad;
4154 PL_nexttoke[PL_lasttoke].next_mad = 0;
4155 if (PL_thismad && PL_thismad->mad_key == '_') {
4156 PL_thiswhite = MUTABLE_SV(PL_thismad->mad_val);
4157 PL_thismad->mad_val = 0;
4158 mad_free(PL_thismad);
4163 PL_lex_state = PL_lex_defer;
4164 PL_expect = PL_lex_expect;
4165 PL_lex_defer = LEX_NORMAL;
4166 if (!PL_nexttoke[PL_lasttoke].next_type)
4171 pl_yylval = PL_nextval[PL_nexttoke];
4173 PL_lex_state = PL_lex_defer;
4174 PL_expect = PL_lex_expect;
4175 PL_lex_defer = LEX_NORMAL;
4179 /* FIXME - can these be merged? */
4180 return(PL_nexttoke[PL_lasttoke].next_type);
4182 return REPORT(PL_nexttype[PL_nexttoke]);
4185 /* interpolated case modifiers like \L \U, including \Q and \E.
4186 when we get here, PL_bufptr is at the \
4188 case LEX_INTERPCASEMOD:
4190 if (PL_bufptr != PL_bufend && *PL_bufptr != '\\')
4191 Perl_croak(aTHX_ "panic: INTERPCASEMOD");
4193 /* handle \E or end of string */
4194 if (PL_bufptr == PL_bufend || PL_bufptr[1] == 'E') {
4196 if (PL_lex_casemods) {
4197 const char oldmod = PL_lex_casestack[--PL_lex_casemods];
4198 PL_lex_casestack[PL_lex_casemods] = '\0';
4200 if (PL_bufptr != PL_bufend
4201 && (oldmod == 'L' || oldmod == 'U' || oldmod == 'Q')) {
4203 PL_lex_state = LEX_INTERPCONCAT;
4206 PL_thistoken = newSVpvs("\\E");
4212 while (PL_bufptr != PL_bufend &&
4213 PL_bufptr[0] == '\\' && PL_bufptr[1] == 'E') {
4215 PL_thiswhite = newSVpvs("");
4216 sv_catpvn(PL_thiswhite, PL_bufptr, 2);
4220 if (PL_bufptr != PL_bufend)
4223 PL_lex_state = LEX_INTERPCONCAT;
4227 DEBUG_T({ PerlIO_printf(Perl_debug_log,
4228 "### Saw case modifier\n"); });
4230 if (s[1] == '\\' && s[2] == 'E') {
4233 PL_thiswhite = newSVpvs("");
4234 sv_catpvn(PL_thiswhite, PL_bufptr, 4);
4237 PL_lex_state = LEX_INTERPCONCAT;
4242 if (!PL_madskills) /* when just compiling don't need correct */
4243 if (strnEQ(s, "L\\u", 3) || strnEQ(s, "U\\l", 3))
4244 tmp = *s, *s = s[2], s[2] = (char)tmp; /* misordered... */
4245 if ((*s == 'L' || *s == 'U') &&
4246 (strchr(PL_lex_casestack, 'L') || strchr(PL_lex_casestack, 'U'))) {
4247 PL_lex_casestack[--PL_lex_casemods] = '\0';
4250 if (PL_lex_casemods > 10)
4251 Renew(PL_lex_casestack, PL_lex_casemods + 2, char);
4252 PL_lex_casestack[PL_lex_casemods++] = *s;
4253 PL_lex_casestack[PL_lex_casemods] = '\0';
4254 PL_lex_state = LEX_INTERPCONCAT;
4255 start_force(PL_curforce);
4256 NEXTVAL_NEXTTOKE.ival = 0;
4258 start_force(PL_curforce);
4260 NEXTVAL_NEXTTOKE.ival = OP_LCFIRST;
4262 NEXTVAL_NEXTTOKE.ival = OP_UCFIRST;
4264 NEXTVAL_NEXTTOKE.ival = OP_LC;
4266 NEXTVAL_NEXTTOKE.ival = OP_UC;
4268 NEXTVAL_NEXTTOKE.ival = OP_QUOTEMETA;
4270 Perl_croak(aTHX_ "panic: yylex");
4272 SV* const tmpsv = newSVpvs("\\ ");
4273 /* replace the space with the character we want to escape
4275 SvPVX(tmpsv)[1] = *s;
4281 if (PL_lex_starts) {
4287 sv_free(PL_thistoken);
4288 PL_thistoken = newSVpvs("");
4291 /* commas only at base level: /$a\Ub$c/ => ($a,uc(b.$c)) */
4292 if (PL_lex_casemods == 1 && PL_lex_inpat)
4301 case LEX_INTERPPUSH:
4302 return REPORT(sublex_push());
4304 case LEX_INTERPSTART:
4305 if (PL_bufptr == PL_bufend)
4306 return REPORT(sublex_done());
4307 DEBUG_T({ PerlIO_printf(Perl_debug_log,
4308 "### Interpolated variable\n"); });
4310 PL_lex_dojoin = (*PL_bufptr == '@');
4311 PL_lex_state = LEX_INTERPNORMAL;
4312 if (PL_lex_dojoin) {
4313 start_force(PL_curforce);
4314 NEXTVAL_NEXTTOKE.ival = 0;
4316 start_force(PL_curforce);
4317 force_ident("\"", '$');
4318 start_force(PL_curforce);
4319 NEXTVAL_NEXTTOKE.ival = 0;
4321 start_force(PL_curforce);
4322 NEXTVAL_NEXTTOKE.ival = 0;
4324 start_force(PL_curforce);
4325 NEXTVAL_NEXTTOKE.ival = OP_JOIN; /* emulate join($", ...) */
4328 if (PL_lex_starts++) {
4333 sv_free(PL_thistoken);
4334 PL_thistoken = newSVpvs("");
4337 /* commas only at base level: /$a\Ub$c/ => ($a,uc(b.$c)) */
4338 if (!PL_lex_casemods && PL_lex_inpat)
4345 case LEX_INTERPENDMAYBE:
4346 if (intuit_more(PL_bufptr)) {
4347 PL_lex_state = LEX_INTERPNORMAL; /* false alarm, more expr */
4353 if (PL_lex_dojoin) {
4354 PL_lex_dojoin = FALSE;
4355 PL_lex_state = LEX_INTERPCONCAT;
4359 sv_free(PL_thistoken);
4360 PL_thistoken = newSVpvs("");
4365 if (PL_lex_inwhat == OP_SUBST && PL_linestr == PL_lex_repl
4366 && SvEVALED(PL_lex_repl))
4368 if (PL_bufptr != PL_bufend)
4369 Perl_croak(aTHX_ "Bad evalled substitution pattern");
4373 case LEX_INTERPCONCAT:
4375 if (PL_lex_brackets)
4376 Perl_croak(aTHX_ "panic: INTERPCONCAT");
4378 if (PL_bufptr == PL_bufend)
4379 return REPORT(sublex_done());
4381 if (SvIVX(PL_linestr) == '\'') {
4382 SV *sv = newSVsv(PL_linestr);
4385 else if ( PL_hints & HINT_NEW_RE )
4386 sv = new_constant(NULL, 0, "qr", sv, sv, "q", 1);
4387 pl_yylval.opval = (OP*)newSVOP(OP_CONST, 0, sv);
4391 s = scan_const(PL_bufptr);
4393 PL_lex_state = LEX_INTERPCASEMOD;
4395 PL_lex_state = LEX_INTERPSTART;
4398 if (s != PL_bufptr) {
4399 start_force(PL_curforce);
4401 curmad('X', newSVpvn(PL_bufptr,s-PL_bufptr));
4403 NEXTVAL_NEXTTOKE = pl_yylval;
4406 if (PL_lex_starts++) {
4410 sv_free(PL_thistoken);
4411 PL_thistoken = newSVpvs("");
4414 /* commas only at base level: /$a\Ub$c/ => ($a,uc(b.$c)) */
4415 if (!PL_lex_casemods && PL_lex_inpat)
4428 PL_lex_state = LEX_NORMAL;
4429 s = scan_formline(PL_bufptr);
4430 if (!PL_lex_formbrack)
4436 PL_oldoldbufptr = PL_oldbufptr;
4442 sv_free(PL_thistoken);
4445 PL_realtokenstart = s - SvPVX(PL_linestr); /* assume but undo on ws */
4449 if (isIDFIRST_lazy_if(s,UTF))
4452 unsigned char c = *s;
4453 len = UTF ? Perl_utf8_length(aTHX_ (U8 *) PL_linestart, (U8 *) s) : (STRLEN) (s - PL_linestart);
4454 if (len > UNRECOGNIZED_PRECEDE_COUNT) {
4455 d = UTF ? (char *) Perl_utf8_hop(aTHX_ (U8 *) s, -UNRECOGNIZED_PRECEDE_COUNT) : s - UNRECOGNIZED_PRECEDE_COUNT;
4460 Perl_croak(aTHX_ "Unrecognized character \\x%02X; marked by <-- HERE after %s<-- HERE near column %d", c, d, (int) len + 1);
4464 goto fake_eof; /* emulate EOF on ^D or ^Z */
4473 if (PL_lex_brackets) {
4474 yyerror((const char *)
4476 ? "Format not terminated"
4477 : "Missing right curly or square bracket"));
4479 DEBUG_T( { PerlIO_printf(Perl_debug_log,
4480 "### Tokener got EOF\n");
4484 if (s++ < PL_bufend)
4485 goto retry; /* ignore stray nulls */
4488 if (!PL_in_eval && !PL_preambled) {
4489 PL_preambled = TRUE;
4495 /* Generate a string of Perl code to load the debugger.
4496 * If PERL5DB is set, it will return the contents of that,
4497 * otherwise a compile-time require of perl5db.pl. */
4499 const char * const pdb = PerlEnv_getenv("PERL5DB");
4502 sv_setpv(PL_linestr, pdb);
4503 sv_catpvs(PL_linestr,";");
4505 SETERRNO(0,SS_NORMAL);
4506 sv_setpvs(PL_linestr, "BEGIN { require 'perl5db.pl' };");
4509 sv_setpvs(PL_linestr,"");
4510 if (PL_preambleav) {
4511 SV **svp = AvARRAY(PL_preambleav);
4512 SV **const end = svp + AvFILLp(PL_preambleav);
4514 sv_catsv(PL_linestr, *svp);
4516 sv_catpvs(PL_linestr, ";");
4518 sv_free(MUTABLE_SV(PL_preambleav));
4519 PL_preambleav = NULL;
4522 sv_catpvs(PL_linestr,
4523 "use feature ':5." STRINGIFY(PERL_VERSION) &qu