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
26 This is the lower layer of the Perl parser, managing characters and tokens.
28 =for apidoc AmU|yy_parser *|PL_parser
30 Pointer to a structure encapsulating the state of the parsing operation
31 currently in progress. The pointer can be locally changed to perform
32 a nested parse without interfering with the state of an outer parse.
33 Individual members of C<PL_parser> have their own documentation.
39 #define PERL_IN_TOKE_C
41 #include "dquote_static.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 /* XXX temporary backwards compatibility */
49 #define PL_lex_brackets (PL_parser->lex_brackets)
50 #define PL_lex_allbrackets (PL_parser->lex_allbrackets)
51 #define PL_lex_fakeeof (PL_parser->lex_fakeeof)
52 #define PL_lex_brackstack (PL_parser->lex_brackstack)
53 #define PL_lex_casemods (PL_parser->lex_casemods)
54 #define PL_lex_casestack (PL_parser->lex_casestack)
55 #define PL_lex_defer (PL_parser->lex_defer)
56 #define PL_lex_dojoin (PL_parser->lex_dojoin)
57 #define PL_lex_expect (PL_parser->lex_expect)
58 #define PL_lex_formbrack (PL_parser->lex_formbrack)
59 #define PL_lex_inpat (PL_parser->lex_inpat)
60 #define PL_lex_inwhat (PL_parser->lex_inwhat)
61 #define PL_lex_op (PL_parser->lex_op)
62 #define PL_lex_repl (PL_parser->lex_repl)
63 #define PL_lex_starts (PL_parser->lex_starts)
64 #define PL_lex_stuff (PL_parser->lex_stuff)
65 #define PL_multi_start (PL_parser->multi_start)
66 #define PL_multi_open (PL_parser->multi_open)
67 #define PL_multi_close (PL_parser->multi_close)
68 #define PL_preambled (PL_parser->preambled)
69 #define PL_sublex_info (PL_parser->sublex_info)
70 #define PL_linestr (PL_parser->linestr)
71 #define PL_expect (PL_parser->expect)
72 #define PL_copline (PL_parser->copline)
73 #define PL_bufptr (PL_parser->bufptr)
74 #define PL_oldbufptr (PL_parser->oldbufptr)
75 #define PL_oldoldbufptr (PL_parser->oldoldbufptr)
76 #define PL_linestart (PL_parser->linestart)
77 #define PL_bufend (PL_parser->bufend)
78 #define PL_last_uni (PL_parser->last_uni)
79 #define PL_last_lop (PL_parser->last_lop)
80 #define PL_last_lop_op (PL_parser->last_lop_op)
81 #define PL_lex_state (PL_parser->lex_state)
82 #define PL_rsfp (PL_parser->rsfp)
83 #define PL_rsfp_filters (PL_parser->rsfp_filters)
84 #define PL_in_my (PL_parser->in_my)
85 #define PL_in_my_stash (PL_parser->in_my_stash)
86 #define PL_tokenbuf (PL_parser->tokenbuf)
87 #define PL_multi_end (PL_parser->multi_end)
88 #define PL_error_count (PL_parser->error_count)
90 # define PL_nexttoke (PL_parser->nexttoke)
91 # define PL_nexttype (PL_parser->nexttype)
92 # define PL_nextval (PL_parser->nextval)
94 static const char* const ident_too_long = "Identifier too long";
96 # define NEXTVAL_NEXTTOKE PL_nextval[PL_nexttoke]
98 #define XENUMMASK 0x3f
100 #define XFAKEBRACK 0x80
102 #ifdef USE_UTF8_SCRIPTS
103 # define UTF (!IN_BYTES)
105 # define UTF ((PL_linestr && DO_UTF8(PL_linestr)) || ( !(PL_parser->lex_flags & LEX_IGNORE_UTF8_HINTS) && (PL_hints & HINT_UTF8)))
108 /* The maximum number of characters preceding the unrecognized one to display */
109 #define UNRECOGNIZED_PRECEDE_COUNT 10
111 /* In variables named $^X, these are the legal values for X.
112 * 1999-02-27 mjd-perl-patch@plover.com */
113 #define isCONTROLVAR(x) (isUPPER(x) || strchr("[\\]^_?", (x)))
115 #define SPACE_OR_TAB(c) isBLANK_A(c)
117 /* LEX_* are values for PL_lex_state, the state of the lexer.
118 * They are arranged oddly so that the guard on the switch statement
119 * can get by with a single comparison (if the compiler is smart enough).
121 * These values refer to the various states within a sublex parse,
122 * i.e. within a double quotish string
125 /* #define LEX_NOTPARSING 11 is done in perl.h. */
127 #define LEX_NORMAL 10 /* normal code (ie not within "...") */
128 #define LEX_INTERPNORMAL 9 /* code within a string, eg "$foo[$x+1]" */
129 #define LEX_INTERPCASEMOD 8 /* expecting a \U, \Q or \E etc */
130 #define LEX_INTERPPUSH 7 /* starting a new sublex parse level */
131 #define LEX_INTERPSTART 6 /* expecting the start of a $var */
133 /* at end of code, eg "$x" followed by: */
134 #define LEX_INTERPEND 5 /* ... eg not one of [, { or -> */
135 #define LEX_INTERPENDMAYBE 4 /* ... eg one of [, { or -> */
137 #define LEX_INTERPCONCAT 3 /* expecting anything, eg at start of
138 string or after \E, $foo, etc */
139 #define LEX_INTERPCONST 2 /* NOT USED */
140 #define LEX_FORMLINE 1 /* expecting a format line */
141 #define LEX_KNOWNEXT 0 /* next token known; just return it */
145 static const char* const lex_state_names[] = {
160 #include "keywords.h"
162 /* CLINE is a macro that ensures PL_copline has a sane value */
164 #define CLINE (PL_copline = (CopLINE(PL_curcop) < PL_copline ? CopLINE(PL_curcop) : PL_copline))
166 # define SKIPSPACE0(s) skipspace(s)
167 # define SKIPSPACE1(s) skipspace(s)
168 # define SKIPSPACE2(s,tsv) skipspace(s)
169 # define PEEKSPACE(s) skipspace(s)
172 * Convenience functions to return different tokens and prime the
173 * lexer for the next token. They all take an argument.
175 * TOKEN : generic token (used for '(', DOLSHARP, etc)
176 * OPERATOR : generic operator
177 * AOPERATOR : assignment operator
178 * PREBLOCK : beginning the block after an if, while, foreach, ...
179 * PRETERMBLOCK : beginning a non-code-defining {} block (eg, hash ref)
180 * PREREF : *EXPR where EXPR is not a simple identifier
181 * TERM : expression term
182 * POSTDEREF : postfix dereference (->$* ->@[...] etc.)
183 * LOOPX : loop exiting command (goto, last, dump, etc)
184 * FTST : file test operator
185 * FUN0 : zero-argument function
186 * FUN0OP : zero-argument function, with its op created in this file
187 * FUN1 : not used, except for not, which isn't a UNIOP
188 * BOop : bitwise or or xor
190 * SHop : shift operator
191 * PWop : power operator
192 * PMop : pattern-matching operator
193 * Aop : addition-level operator
194 * Mop : multiplication-level operator
195 * Eop : equality-testing operator
196 * Rop : relational operator <= != gt
198 * Also see LOP and lop() below.
201 #ifdef DEBUGGING /* Serve -DT. */
202 # define REPORT(retval) tokereport((I32)retval, &pl_yylval)
204 # define REPORT(retval) (retval)
207 #define TOKEN(retval) return ( PL_bufptr = s, REPORT(retval))
208 #define OPERATOR(retval) return (PL_expect = XTERM, PL_bufptr = s, REPORT(retval))
209 #define AOPERATOR(retval) return ao((PL_expect = XTERM, PL_bufptr = s, REPORT(retval)))
210 #define PREBLOCK(retval) return (PL_expect = XBLOCK,PL_bufptr = s, REPORT(retval))
211 #define PRETERMBLOCK(retval) return (PL_expect = XTERMBLOCK,PL_bufptr = s, REPORT(retval))
212 #define PREREF(retval) return (PL_expect = XREF,PL_bufptr = s, REPORT(retval))
213 #define TERM(retval) return (CLINE, PL_expect = XOPERATOR, PL_bufptr = s, REPORT(retval))
214 #define POSTDEREF(f) return (PL_bufptr = s, S_postderef(aTHX_ REPORT(f),s[1]))
215 #define LOOPX(f) return (pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)LOOPEX))
216 #define FTST(f) return (pl_yylval.ival=f, PL_expect=XTERMORDORDOR, PL_bufptr=s, REPORT((int)UNIOP))
217 #define FUN0(f) return (pl_yylval.ival=f, PL_expect=XOPERATOR, PL_bufptr=s, REPORT((int)FUNC0))
218 #define FUN0OP(f) return (pl_yylval.opval=f, CLINE, PL_expect=XOPERATOR, PL_bufptr=s, REPORT((int)FUNC0OP))
219 #define FUN1(f) return (pl_yylval.ival=f, PL_expect=XOPERATOR, PL_bufptr=s, REPORT((int)FUNC1))
220 #define BOop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)BITOROP)))
221 #define BAop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)BITANDOP)))
222 #define SHop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)SHIFTOP)))
223 #define PWop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)POWOP)))
224 #define PMop(f) return(pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)MATCHOP))
225 #define Aop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)ADDOP)))
226 #define Mop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)MULOP)))
227 #define Eop(f) return (pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)EQOP))
228 #define Rop(f) return (pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)RELOP))
230 /* This bit of chicanery makes a unary function followed by
231 * a parenthesis into a function with one argument, highest precedence.
232 * The UNIDOR macro is for unary functions that can be followed by the //
233 * operator (such as C<shift // 0>).
235 #define UNI3(f,x,have_x) { \
236 pl_yylval.ival = f; \
237 if (have_x) PL_expect = x; \
239 PL_last_uni = PL_oldbufptr; \
240 PL_last_lop_op = f; \
242 return REPORT( (int)FUNC1 ); \
244 return REPORT( *s=='(' ? (int)FUNC1 : (int)UNIOP ); \
246 #define UNI(f) UNI3(f,XTERM,1)
247 #define UNIDOR(f) UNI3(f,XTERMORDORDOR,1)
248 #define UNIPROTO(f,optional) { \
249 if (optional) PL_last_uni = PL_oldbufptr; \
253 #define UNIBRACK(f) UNI3(f,0,0)
255 /* grandfather return to old style */
258 if (!PL_lex_allbrackets && PL_lex_fakeeof > LEX_FAKEEOF_LOWLOGIC) \
259 PL_lex_fakeeof = LEX_FAKEEOF_LOWLOGIC; \
260 pl_yylval.ival = (f); \
266 #define COPLINE_INC_WITH_HERELINES \
268 CopLINE_inc(PL_curcop); \
269 if (PL_parser->herelines) \
270 CopLINE(PL_curcop) += PL_parser->herelines, \
271 PL_parser->herelines = 0; \
273 /* Called after scan_str to update CopLINE(PL_curcop), but only when there
274 * is no sublex_push to follow. */
275 #define COPLINE_SET_FROM_MULTI_END \
277 CopLINE_set(PL_curcop, PL_multi_end); \
278 if (PL_multi_end != PL_multi_start) \
279 PL_parser->herelines = 0; \
285 /* how to interpret the pl_yylval associated with the token */
289 TOKENTYPE_OPNUM, /* pl_yylval.ival contains an opcode number */
294 static struct debug_tokens {
296 enum token_type type;
298 } const debug_tokens[] =
300 { ADDOP, TOKENTYPE_OPNUM, "ADDOP" },
301 { ANDAND, TOKENTYPE_NONE, "ANDAND" },
302 { ANDOP, TOKENTYPE_NONE, "ANDOP" },
303 { ANONSUB, TOKENTYPE_IVAL, "ANONSUB" },
304 { ARROW, TOKENTYPE_NONE, "ARROW" },
305 { ASSIGNOP, TOKENTYPE_OPNUM, "ASSIGNOP" },
306 { BITANDOP, TOKENTYPE_OPNUM, "BITANDOP" },
307 { BITOROP, TOKENTYPE_OPNUM, "BITOROP" },
308 { COLONATTR, TOKENTYPE_NONE, "COLONATTR" },
309 { CONTINUE, TOKENTYPE_NONE, "CONTINUE" },
310 { DEFAULT, TOKENTYPE_NONE, "DEFAULT" },
311 { DO, TOKENTYPE_NONE, "DO" },
312 { DOLSHARP, TOKENTYPE_NONE, "DOLSHARP" },
313 { DORDOR, TOKENTYPE_NONE, "DORDOR" },
314 { DOROP, TOKENTYPE_OPNUM, "DOROP" },
315 { DOTDOT, TOKENTYPE_IVAL, "DOTDOT" },
316 { ELSE, TOKENTYPE_NONE, "ELSE" },
317 { ELSIF, TOKENTYPE_IVAL, "ELSIF" },
318 { EQOP, TOKENTYPE_OPNUM, "EQOP" },
319 { FOR, TOKENTYPE_IVAL, "FOR" },
320 { FORMAT, TOKENTYPE_NONE, "FORMAT" },
321 { FORMLBRACK, TOKENTYPE_NONE, "FORMLBRACK" },
322 { FORMRBRACK, TOKENTYPE_NONE, "FORMRBRACK" },
323 { FUNC, TOKENTYPE_OPNUM, "FUNC" },
324 { FUNC0, TOKENTYPE_OPNUM, "FUNC0" },
325 { FUNC0OP, TOKENTYPE_OPVAL, "FUNC0OP" },
326 { FUNC0SUB, TOKENTYPE_OPVAL, "FUNC0SUB" },
327 { FUNC1, TOKENTYPE_OPNUM, "FUNC1" },
328 { FUNCMETH, TOKENTYPE_OPVAL, "FUNCMETH" },
329 { GIVEN, TOKENTYPE_IVAL, "GIVEN" },
330 { HASHBRACK, TOKENTYPE_NONE, "HASHBRACK" },
331 { IF, TOKENTYPE_IVAL, "IF" },
332 { LABEL, TOKENTYPE_PVAL, "LABEL" },
333 { LOCAL, TOKENTYPE_IVAL, "LOCAL" },
334 { LOOPEX, TOKENTYPE_OPNUM, "LOOPEX" },
335 { LSTOP, TOKENTYPE_OPNUM, "LSTOP" },
336 { LSTOPSUB, TOKENTYPE_OPVAL, "LSTOPSUB" },
337 { MATCHOP, TOKENTYPE_OPNUM, "MATCHOP" },
338 { METHOD, TOKENTYPE_OPVAL, "METHOD" },
339 { MULOP, TOKENTYPE_OPNUM, "MULOP" },
340 { MY, TOKENTYPE_IVAL, "MY" },
341 { NOAMP, TOKENTYPE_NONE, "NOAMP" },
342 { NOTOP, TOKENTYPE_NONE, "NOTOP" },
343 { OROP, TOKENTYPE_IVAL, "OROP" },
344 { OROR, TOKENTYPE_NONE, "OROR" },
345 { PACKAGE, TOKENTYPE_NONE, "PACKAGE" },
346 { PLUGEXPR, TOKENTYPE_OPVAL, "PLUGEXPR" },
347 { PLUGSTMT, TOKENTYPE_OPVAL, "PLUGSTMT" },
348 { PMFUNC, TOKENTYPE_OPVAL, "PMFUNC" },
349 { POSTJOIN, TOKENTYPE_NONE, "POSTJOIN" },
350 { POSTDEC, TOKENTYPE_NONE, "POSTDEC" },
351 { POSTINC, TOKENTYPE_NONE, "POSTINC" },
352 { POWOP, TOKENTYPE_OPNUM, "POWOP" },
353 { PREDEC, TOKENTYPE_NONE, "PREDEC" },
354 { PREINC, TOKENTYPE_NONE, "PREINC" },
355 { PRIVATEREF, TOKENTYPE_OPVAL, "PRIVATEREF" },
356 { QWLIST, TOKENTYPE_OPVAL, "QWLIST" },
357 { REFGEN, TOKENTYPE_NONE, "REFGEN" },
358 { RELOP, TOKENTYPE_OPNUM, "RELOP" },
359 { REQUIRE, TOKENTYPE_NONE, "REQUIRE" },
360 { SHIFTOP, TOKENTYPE_OPNUM, "SHIFTOP" },
361 { SUB, TOKENTYPE_NONE, "SUB" },
362 { THING, TOKENTYPE_OPVAL, "THING" },
363 { UMINUS, TOKENTYPE_NONE, "UMINUS" },
364 { UNIOP, TOKENTYPE_OPNUM, "UNIOP" },
365 { UNIOPSUB, TOKENTYPE_OPVAL, "UNIOPSUB" },
366 { UNLESS, TOKENTYPE_IVAL, "UNLESS" },
367 { UNTIL, TOKENTYPE_IVAL, "UNTIL" },
368 { USE, TOKENTYPE_IVAL, "USE" },
369 { WHEN, TOKENTYPE_IVAL, "WHEN" },
370 { WHILE, TOKENTYPE_IVAL, "WHILE" },
371 { WORD, TOKENTYPE_OPVAL, "WORD" },
372 { YADAYADA, TOKENTYPE_IVAL, "YADAYADA" },
373 { 0, TOKENTYPE_NONE, NULL }
376 /* dump the returned token in rv, plus any optional arg in pl_yylval */
379 S_tokereport(pTHX_ I32 rv, const YYSTYPE* lvalp)
383 PERL_ARGS_ASSERT_TOKEREPORT;
386 const char *name = NULL;
387 enum token_type type = TOKENTYPE_NONE;
388 const struct debug_tokens *p;
389 SV* const report = newSVpvs("<== ");
391 for (p = debug_tokens; p->token; p++) {
392 if (p->token == (int)rv) {
399 Perl_sv_catpv(aTHX_ report, name);
400 else if ((char)rv > ' ' && (char)rv <= '~')
402 Perl_sv_catpvf(aTHX_ report, "'%c'", (char)rv);
404 sv_catpvs(report, " (pending identifier)");
407 sv_catpvs(report, "EOF");
409 Perl_sv_catpvf(aTHX_ report, "?? %"IVdf, (IV)rv);
414 Perl_sv_catpvf(aTHX_ report, "(ival=%"IVdf")", (IV)lvalp->ival);
416 case TOKENTYPE_OPNUM:
417 Perl_sv_catpvf(aTHX_ report, "(ival=op_%s)",
418 PL_op_name[lvalp->ival]);
421 Perl_sv_catpvf(aTHX_ report, "(pval=\"%s\")", lvalp->pval);
423 case TOKENTYPE_OPVAL:
425 Perl_sv_catpvf(aTHX_ report, "(opval=op_%s)",
426 PL_op_name[lvalp->opval->op_type]);
427 if (lvalp->opval->op_type == OP_CONST) {
428 Perl_sv_catpvf(aTHX_ report, " %s",
429 SvPEEK(cSVOPx_sv(lvalp->opval)));
434 sv_catpvs(report, "(opval=null)");
437 PerlIO_printf(Perl_debug_log, "### %s\n\n", SvPV_nolen_const(report));
443 /* print the buffer with suitable escapes */
446 S_printbuf(pTHX_ const char *const fmt, const char *const s)
448 SV* const tmp = newSVpvs("");
450 PERL_ARGS_ASSERT_PRINTBUF;
452 GCC_DIAG_IGNORE(-Wformat-nonliteral); /* fmt checked by caller */
453 PerlIO_printf(Perl_debug_log, fmt, pv_display(tmp, s, strlen(s), 0, 60));
461 S_deprecate_commaless_var_list(pTHX) {
463 deprecate("comma-less variable list");
464 return REPORT(','); /* grandfather non-comma-format format */
470 * This subroutine detects &&=, ||=, and //= and turns an ANDAND, OROR or DORDOR
471 * into an OP_ANDASSIGN, OP_ORASSIGN, or OP_DORASSIGN
475 S_ao(pTHX_ int toketype)
478 if (*PL_bufptr == '=') {
480 if (toketype == ANDAND)
481 pl_yylval.ival = OP_ANDASSIGN;
482 else if (toketype == OROR)
483 pl_yylval.ival = OP_ORASSIGN;
484 else if (toketype == DORDOR)
485 pl_yylval.ival = OP_DORASSIGN;
493 * When Perl expects an operator and finds something else, no_op
494 * prints the warning. It always prints "<something> found where
495 * operator expected. It prints "Missing semicolon on previous line?"
496 * if the surprise occurs at the start of the line. "do you need to
497 * predeclare ..." is printed out for code like "sub bar; foo bar $x"
498 * where the compiler doesn't know if foo is a method call or a function.
499 * It prints "Missing operator before end of line" if there's nothing
500 * after the missing operator, or "... before <...>" if there is something
501 * after the missing operator.
505 S_no_op(pTHX_ const char *const what, char *s)
508 char * const oldbp = PL_bufptr;
509 const bool is_first = (PL_oldbufptr == PL_linestart);
511 PERL_ARGS_ASSERT_NO_OP;
517 yywarn(Perl_form(aTHX_ "%s found where operator expected", what), UTF ? SVf_UTF8 : 0);
518 if (ckWARN_d(WARN_SYNTAX)) {
520 Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
521 "\t(Missing semicolon on previous line?)\n");
522 else if (PL_oldoldbufptr && isIDFIRST_lazy_if(PL_oldoldbufptr,UTF)) {
524 for (t = PL_oldoldbufptr; (isWORDCHAR_lazy_if(t,UTF) || *t == ':');
525 t += UTF ? UTF8SKIP(t) : 1)
527 if (t < PL_bufptr && isSPACE(*t))
528 Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
529 "\t(Do you need to predeclare %"UTF8f"?)\n",
530 UTF8fARG(UTF, t - PL_oldoldbufptr, PL_oldoldbufptr));
534 Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
535 "\t(Missing operator before %"UTF8f"?)\n",
536 UTF8fARG(UTF, s - oldbp, oldbp));
544 * Complain about missing quote/regexp/heredoc terminator.
545 * If it's called with NULL then it cauterizes the line buffer.
546 * If we're in a delimited string and the delimiter is a control
547 * character, it's reformatted into a two-char sequence like ^C.
552 S_missingterm(pTHX_ char *s)
558 char * const nl = strrchr(s,'\n');
562 else if ((U8) PL_multi_close < 32) {
564 tmpbuf[1] = (char)toCTRL(PL_multi_close);
569 *tmpbuf = (char)PL_multi_close;
573 q = strchr(s,'"') ? '\'' : '"';
574 Perl_croak(aTHX_ "Can't find string terminator %c%s%c anywhere before EOF",q,s,q);
580 * Check whether the named feature is enabled.
583 Perl_feature_is_enabled(pTHX_ const char *const name, STRLEN namelen)
586 char he_name[8 + MAX_FEATURE_LEN] = "feature_";
588 PERL_ARGS_ASSERT_FEATURE_IS_ENABLED;
590 assert(CURRENT_FEATURE_BUNDLE == FEATURE_BUNDLE_CUSTOM);
592 if (namelen > MAX_FEATURE_LEN)
594 memcpy(&he_name[8], name, namelen);
596 return cBOOL(cop_hints_fetch_pvn(PL_curcop, he_name, 8 + namelen, 0,
597 REFCOUNTED_HE_EXISTS));
601 * experimental text filters for win32 carriage-returns, utf16-to-utf8 and
602 * utf16-to-utf8-reversed.
605 #ifdef PERL_CR_FILTER
609 const char *s = SvPVX_const(sv);
610 const char * const e = s + SvCUR(sv);
612 PERL_ARGS_ASSERT_STRIP_RETURN;
614 /* outer loop optimized to do nothing if there are no CR-LFs */
616 if (*s++ == '\r' && *s == '\n') {
617 /* hit a CR-LF, need to copy the rest */
621 if (*s == '\r' && s[1] == '\n')
632 S_cr_textfilter(pTHX_ int idx, SV *sv, int maxlen)
634 const I32 count = FILTER_READ(idx+1, sv, maxlen);
635 if (count > 0 && !maxlen)
642 =for apidoc Amx|void|lex_start|SV *line|PerlIO *rsfp|U32 flags
644 Creates and initialises a new lexer/parser state object, supplying
645 a context in which to lex and parse from a new source of Perl code.
646 A pointer to the new state object is placed in L</PL_parser>. An entry
647 is made on the save stack so that upon unwinding the new state object
648 will be destroyed and the former value of L</PL_parser> will be restored.
649 Nothing else need be done to clean up the parsing context.
651 The code to be parsed comes from I<line> and I<rsfp>. I<line>, if
652 non-null, provides a string (in SV form) containing code to be parsed.
653 A copy of the string is made, so subsequent modification of I<line>
654 does not affect parsing. I<rsfp>, if non-null, provides an input stream
655 from which code will be read to be parsed. If both are non-null, the
656 code in I<line> comes first and must consist of complete lines of input,
657 and I<rsfp> supplies the remainder of the source.
659 The I<flags> parameter is reserved for future use. Currently it is only
660 used by perl internally, so extensions should always pass zero.
665 /* LEX_START_SAME_FILTER indicates that this is not a new file, so it
666 can share filters with the current parser.
667 LEX_START_DONT_CLOSE indicates that the file handle wasn't opened by the
668 caller, hence isn't owned by the parser, so shouldn't be closed on parser
669 destruction. This is used to handle the case of defaulting to reading the
670 script from the standard input because no filename was given on the command
671 line (without getting confused by situation where STDIN has been closed, so
672 the script handle is opened on fd 0) */
675 Perl_lex_start(pTHX_ SV *line, PerlIO *rsfp, U32 flags)
678 const char *s = NULL;
679 yy_parser *parser, *oparser;
680 if (flags && flags & ~LEX_START_FLAGS)
681 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_start");
683 /* create and initialise a parser */
685 Newxz(parser, 1, yy_parser);
686 parser->old_parser = oparser = PL_parser;
689 parser->stack = NULL;
691 parser->stack_size = 0;
693 /* on scope exit, free this parser and restore any outer one */
695 parser->saved_curcop = PL_curcop;
697 /* initialise lexer state */
699 parser->nexttoke = 0;
700 parser->error_count = oparser ? oparser->error_count : 0;
701 parser->copline = parser->preambling = NOLINE;
702 parser->lex_state = LEX_NORMAL;
703 parser->expect = XSTATE;
705 parser->rsfp_filters =
706 !(flags & LEX_START_SAME_FILTER) || !oparser
708 : MUTABLE_AV(SvREFCNT_inc(
709 oparser->rsfp_filters
710 ? oparser->rsfp_filters
711 : (oparser->rsfp_filters = newAV())
714 Newx(parser->lex_brackstack, 120, char);
715 Newx(parser->lex_casestack, 12, char);
716 *parser->lex_casestack = '\0';
717 Newxz(parser->lex_shared, 1, LEXSHARED);
721 s = SvPV_const(line, len);
722 parser->linestr = flags & LEX_START_COPIED
723 ? SvREFCNT_inc_simple_NN(line)
724 : newSVpvn_flags(s, len, SvUTF8(line));
725 sv_catpvn(parser->linestr, "\n;", rsfp ? 1 : 2);
727 parser->linestr = newSVpvn("\n;", rsfp ? 1 : 2);
729 parser->oldoldbufptr =
732 parser->linestart = SvPVX(parser->linestr);
733 parser->bufend = parser->bufptr + SvCUR(parser->linestr);
734 parser->last_lop = parser->last_uni = NULL;
736 assert(FITS_IN_8_BITS(LEX_IGNORE_UTF8_HINTS|LEX_EVALBYTES
737 |LEX_DONT_CLOSE_RSFP));
738 parser->lex_flags = (U8) (flags & (LEX_IGNORE_UTF8_HINTS|LEX_EVALBYTES
739 |LEX_DONT_CLOSE_RSFP));
741 parser->in_pod = parser->filtered = 0;
745 /* delete a parser object */
748 Perl_parser_free(pTHX_ const yy_parser *parser)
750 PERL_ARGS_ASSERT_PARSER_FREE;
752 PL_curcop = parser->saved_curcop;
753 SvREFCNT_dec(parser->linestr);
755 if (PL_parser->lex_flags & LEX_DONT_CLOSE_RSFP)
756 PerlIO_clearerr(parser->rsfp);
757 else if (parser->rsfp && (!parser->old_parser ||
758 (parser->old_parser && parser->rsfp != parser->old_parser->rsfp)))
759 PerlIO_close(parser->rsfp);
760 SvREFCNT_dec(parser->rsfp_filters);
761 SvREFCNT_dec(parser->lex_stuff);
762 SvREFCNT_dec(parser->sublex_info.repl);
764 Safefree(parser->lex_brackstack);
765 Safefree(parser->lex_casestack);
766 Safefree(parser->lex_shared);
767 PL_parser = parser->old_parser;
772 Perl_parser_free_nexttoke_ops(pTHX_ yy_parser *parser, OPSLAB *slab)
774 I32 nexttoke = parser->nexttoke;
775 PERL_ARGS_ASSERT_PARSER_FREE_NEXTTOKE_OPS;
777 if (S_is_opval_token(parser->nexttype[nexttoke] & 0xffff)
778 && parser->nextval[nexttoke].opval
779 && parser->nextval[nexttoke].opval->op_slabbed
780 && OpSLAB(parser->nextval[nexttoke].opval) == slab) {
781 op_free(parser->nextval[nexttoke].opval);
782 parser->nextval[nexttoke].opval = NULL;
789 =for apidoc AmxU|SV *|PL_parser-E<gt>linestr
791 Buffer scalar containing the chunk currently under consideration of the
792 text currently being lexed. This is always a plain string scalar (for
793 which C<SvPOK> is true). It is not intended to be used as a scalar by
794 normal scalar means; instead refer to the buffer directly by the pointer
795 variables described below.
797 The lexer maintains various C<char*> pointers to things in the
798 C<PL_parser-E<gt>linestr> buffer. If C<PL_parser-E<gt>linestr> is ever
799 reallocated, all of these pointers must be updated. Don't attempt to
800 do this manually, but rather use L</lex_grow_linestr> if you need to
801 reallocate the buffer.
803 The content of the text chunk in the buffer is commonly exactly one
804 complete line of input, up to and including a newline terminator,
805 but there are situations where it is otherwise. The octets of the
806 buffer may be intended to be interpreted as either UTF-8 or Latin-1.
807 The function L</lex_bufutf8> tells you which. Do not use the C<SvUTF8>
808 flag on this scalar, which may disagree with it.
810 For direct examination of the buffer, the variable
811 L</PL_parser-E<gt>bufend> points to the end of the buffer. The current
812 lexing position is pointed to by L</PL_parser-E<gt>bufptr>. Direct use
813 of these pointers is usually preferable to examination of the scalar
814 through normal scalar means.
816 =for apidoc AmxU|char *|PL_parser-E<gt>bufend
818 Direct pointer to the end of the chunk of text currently being lexed, the
819 end of the lexer buffer. This is equal to C<SvPVX(PL_parser-E<gt>linestr)
820 + SvCUR(PL_parser-E<gt>linestr)>. A C<NUL> character (zero octet) is
821 always located at the end of the buffer, and does not count as part of
822 the buffer's contents.
824 =for apidoc AmxU|char *|PL_parser-E<gt>bufptr
826 Points to the current position of lexing inside the lexer buffer.
827 Characters around this point may be freely examined, within
828 the range delimited by C<SvPVX(L</PL_parser-E<gt>linestr>)> and
829 L</PL_parser-E<gt>bufend>. The octets of the buffer may be intended to be
830 interpreted as either UTF-8 or Latin-1, as indicated by L</lex_bufutf8>.
832 Lexing code (whether in the Perl core or not) moves this pointer past
833 the characters that it consumes. It is also expected to perform some
834 bookkeeping whenever a newline character is consumed. This movement
835 can be more conveniently performed by the function L</lex_read_to>,
836 which handles newlines appropriately.
838 Interpretation of the buffer's octets can be abstracted out by
839 using the slightly higher-level functions L</lex_peek_unichar> and
840 L</lex_read_unichar>.
842 =for apidoc AmxU|char *|PL_parser-E<gt>linestart
844 Points to the start of the current line inside the lexer buffer.
845 This is useful for indicating at which column an error occurred, and
846 not much else. This must be updated by any lexing code that consumes
847 a newline; the function L</lex_read_to> handles this detail.
853 =for apidoc Amx|bool|lex_bufutf8
855 Indicates whether the octets in the lexer buffer
856 (L</PL_parser-E<gt>linestr>) should be interpreted as the UTF-8 encoding
857 of Unicode characters. If not, they should be interpreted as Latin-1
858 characters. This is analogous to the C<SvUTF8> flag for scalars.
860 In UTF-8 mode, it is not guaranteed that the lexer buffer actually
861 contains valid UTF-8. Lexing code must be robust in the face of invalid
864 The actual C<SvUTF8> flag of the L</PL_parser-E<gt>linestr> scalar
865 is significant, but not the whole story regarding the input character
866 encoding. Normally, when a file is being read, the scalar contains octets
867 and its C<SvUTF8> flag is off, but the octets should be interpreted as
868 UTF-8 if the C<use utf8> pragma is in effect. During a string eval,
869 however, the scalar may have the C<SvUTF8> flag on, and in this case its
870 octets should be interpreted as UTF-8 unless the C<use bytes> pragma
871 is in effect. This logic may change in the future; use this function
872 instead of implementing the logic yourself.
878 Perl_lex_bufutf8(pTHX)
884 =for apidoc Amx|char *|lex_grow_linestr|STRLEN len
886 Reallocates the lexer buffer (L</PL_parser-E<gt>linestr>) to accommodate
887 at least I<len> octets (including terminating C<NUL>). Returns a
888 pointer to the reallocated buffer. This is necessary before making
889 any direct modification of the buffer that would increase its length.
890 L</lex_stuff_pvn> provides a more convenient way to insert text into
893 Do not use C<SvGROW> or C<sv_grow> directly on C<PL_parser-E<gt>linestr>;
894 this function updates all of the lexer's variables that point directly
901 Perl_lex_grow_linestr(pTHX_ STRLEN len)
905 STRLEN bufend_pos, bufptr_pos, oldbufptr_pos, oldoldbufptr_pos;
906 STRLEN linestart_pos, last_uni_pos, last_lop_pos, re_eval_start_pos;
907 linestr = PL_parser->linestr;
908 buf = SvPVX(linestr);
909 if (len <= SvLEN(linestr))
911 bufend_pos = PL_parser->bufend - buf;
912 bufptr_pos = PL_parser->bufptr - buf;
913 oldbufptr_pos = PL_parser->oldbufptr - buf;
914 oldoldbufptr_pos = PL_parser->oldoldbufptr - buf;
915 linestart_pos = PL_parser->linestart - buf;
916 last_uni_pos = PL_parser->last_uni ? PL_parser->last_uni - buf : 0;
917 last_lop_pos = PL_parser->last_lop ? PL_parser->last_lop - buf : 0;
918 re_eval_start_pos = PL_parser->lex_shared->re_eval_start ?
919 PL_parser->lex_shared->re_eval_start - buf : 0;
921 buf = sv_grow(linestr, len);
923 PL_parser->bufend = buf + bufend_pos;
924 PL_parser->bufptr = buf + bufptr_pos;
925 PL_parser->oldbufptr = buf + oldbufptr_pos;
926 PL_parser->oldoldbufptr = buf + oldoldbufptr_pos;
927 PL_parser->linestart = buf + linestart_pos;
928 if (PL_parser->last_uni)
929 PL_parser->last_uni = buf + last_uni_pos;
930 if (PL_parser->last_lop)
931 PL_parser->last_lop = buf + last_lop_pos;
932 if (PL_parser->lex_shared->re_eval_start)
933 PL_parser->lex_shared->re_eval_start = buf + re_eval_start_pos;
938 =for apidoc Amx|void|lex_stuff_pvn|const char *pv|STRLEN len|U32 flags
940 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
941 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
942 reallocating the buffer if necessary. This means that lexing code that
943 runs later will see the characters as if they had appeared in the input.
944 It is not recommended to do this as part of normal parsing, and most
945 uses of this facility run the risk of the inserted characters being
946 interpreted in an unintended manner.
948 The string to be inserted is represented by I<len> octets starting
949 at I<pv>. These octets are interpreted as either UTF-8 or Latin-1,
950 according to whether the C<LEX_STUFF_UTF8> flag is set in I<flags>.
951 The characters are recoded for the lexer buffer, according to how the
952 buffer is currently being interpreted (L</lex_bufutf8>). If a string
953 to be inserted is available as a Perl scalar, the L</lex_stuff_sv>
954 function is more convenient.
960 Perl_lex_stuff_pvn(pTHX_ const char *pv, STRLEN len, U32 flags)
964 PERL_ARGS_ASSERT_LEX_STUFF_PVN;
965 if (flags & ~(LEX_STUFF_UTF8))
966 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_stuff_pvn");
968 if (flags & LEX_STUFF_UTF8) {
971 STRLEN highhalf = 0; /* Count of variants */
972 const char *p, *e = pv+len;
973 for (p = pv; p != e; p++) {
974 if (! UTF8_IS_INVARIANT(*p)) {
980 lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len+highhalf);
981 bufptr = PL_parser->bufptr;
982 Move(bufptr, bufptr+len+highhalf, PL_parser->bufend+1-bufptr, char);
983 SvCUR_set(PL_parser->linestr,
984 SvCUR(PL_parser->linestr) + len+highhalf);
985 PL_parser->bufend += len+highhalf;
986 for (p = pv; p != e; p++) {
988 if (! UTF8_IS_INVARIANT(c)) {
989 *bufptr++ = UTF8_TWO_BYTE_HI(c);
990 *bufptr++ = UTF8_TWO_BYTE_LO(c);
997 if (flags & LEX_STUFF_UTF8) {
999 const char *p, *e = pv+len;
1000 for (p = pv; p != e; p++) {
1002 if (UTF8_IS_ABOVE_LATIN1(c)) {
1003 Perl_croak(aTHX_ "Lexing code attempted to stuff "
1004 "non-Latin-1 character into Latin-1 input");
1005 } else if (UTF8_IS_NEXT_CHAR_DOWNGRADEABLE(p, e)) {
1008 } else if (! UTF8_IS_INVARIANT(c)) {
1009 /* malformed UTF-8 */
1011 SAVESPTR(PL_warnhook);
1012 PL_warnhook = PERL_WARNHOOK_FATAL;
1013 utf8n_to_uvchr((U8*)p, e-p, NULL, 0);
1019 lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len-highhalf);
1020 bufptr = PL_parser->bufptr;
1021 Move(bufptr, bufptr+len-highhalf, PL_parser->bufend+1-bufptr, char);
1022 SvCUR_set(PL_parser->linestr,
1023 SvCUR(PL_parser->linestr) + len-highhalf);
1024 PL_parser->bufend += len-highhalf;
1027 if (UTF8_IS_INVARIANT(*p)) {
1033 *bufptr++ = TWO_BYTE_UTF8_TO_NATIVE(*p, *(p+1));
1039 lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len);
1040 bufptr = PL_parser->bufptr;
1041 Move(bufptr, bufptr+len, PL_parser->bufend+1-bufptr, char);
1042 SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) + len);
1043 PL_parser->bufend += len;
1044 Copy(pv, bufptr, len, char);
1050 =for apidoc Amx|void|lex_stuff_pv|const char *pv|U32 flags
1052 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
1053 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
1054 reallocating the buffer if necessary. This means that lexing code that
1055 runs later will see the characters as if they had appeared in the input.
1056 It is not recommended to do this as part of normal parsing, and most
1057 uses of this facility run the risk of the inserted characters being
1058 interpreted in an unintended manner.
1060 The string to be inserted is represented by octets starting at I<pv>
1061 and continuing to the first nul. These octets are interpreted as either
1062 UTF-8 or Latin-1, according to whether the C<LEX_STUFF_UTF8> flag is set
1063 in I<flags>. The characters are recoded for the lexer buffer, according
1064 to how the buffer is currently being interpreted (L</lex_bufutf8>).
1065 If it is not convenient to nul-terminate a string to be inserted, the
1066 L</lex_stuff_pvn> function is more appropriate.
1072 Perl_lex_stuff_pv(pTHX_ const char *pv, U32 flags)
1074 PERL_ARGS_ASSERT_LEX_STUFF_PV;
1075 lex_stuff_pvn(pv, strlen(pv), flags);
1079 =for apidoc Amx|void|lex_stuff_sv|SV *sv|U32 flags
1081 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
1082 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
1083 reallocating the buffer if necessary. This means that lexing code that
1084 runs later will see the characters as if they had appeared in the input.
1085 It is not recommended to do this as part of normal parsing, and most
1086 uses of this facility run the risk of the inserted characters being
1087 interpreted in an unintended manner.
1089 The string to be inserted is the string value of I<sv>. The characters
1090 are recoded for the lexer buffer, according to how the buffer is currently
1091 being interpreted (L</lex_bufutf8>). If a string to be inserted is
1092 not already a Perl scalar, the L</lex_stuff_pvn> function avoids the
1093 need to construct a scalar.
1099 Perl_lex_stuff_sv(pTHX_ SV *sv, U32 flags)
1103 PERL_ARGS_ASSERT_LEX_STUFF_SV;
1105 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_stuff_sv");
1107 lex_stuff_pvn(pv, len, flags | (SvUTF8(sv) ? LEX_STUFF_UTF8 : 0));
1111 =for apidoc Amx|void|lex_unstuff|char *ptr
1113 Discards text about to be lexed, from L</PL_parser-E<gt>bufptr> up to
1114 I<ptr>. Text following I<ptr> will be moved, and the buffer shortened.
1115 This hides the discarded text from any lexing code that runs later,
1116 as if the text had never appeared.
1118 This is not the normal way to consume lexed text. For that, use
1125 Perl_lex_unstuff(pTHX_ char *ptr)
1129 PERL_ARGS_ASSERT_LEX_UNSTUFF;
1130 buf = PL_parser->bufptr;
1132 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_unstuff");
1135 bufend = PL_parser->bufend;
1137 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_unstuff");
1138 unstuff_len = ptr - buf;
1139 Move(ptr, buf, bufend+1-ptr, char);
1140 SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) - unstuff_len);
1141 PL_parser->bufend = bufend - unstuff_len;
1145 =for apidoc Amx|void|lex_read_to|char *ptr
1147 Consume text in the lexer buffer, from L</PL_parser-E<gt>bufptr> up
1148 to I<ptr>. This advances L</PL_parser-E<gt>bufptr> to match I<ptr>,
1149 performing the correct bookkeeping whenever a newline character is passed.
1150 This is the normal way to consume lexed text.
1152 Interpretation of the buffer's octets can be abstracted out by
1153 using the slightly higher-level functions L</lex_peek_unichar> and
1154 L</lex_read_unichar>.
1160 Perl_lex_read_to(pTHX_ char *ptr)
1163 PERL_ARGS_ASSERT_LEX_READ_TO;
1164 s = PL_parser->bufptr;
1165 if (ptr < s || ptr > PL_parser->bufend)
1166 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_to");
1167 for (; s != ptr; s++)
1169 COPLINE_INC_WITH_HERELINES;
1170 PL_parser->linestart = s+1;
1172 PL_parser->bufptr = ptr;
1176 =for apidoc Amx|void|lex_discard_to|char *ptr
1178 Discards the first part of the L</PL_parser-E<gt>linestr> buffer,
1179 up to I<ptr>. The remaining content of the buffer will be moved, and
1180 all pointers into the buffer updated appropriately. I<ptr> must not
1181 be later in the buffer than the position of L</PL_parser-E<gt>bufptr>:
1182 it is not permitted to discard text that has yet to be lexed.
1184 Normally it is not necessarily to do this directly, because it suffices to
1185 use the implicit discarding behaviour of L</lex_next_chunk> and things
1186 based on it. However, if a token stretches across multiple lines,
1187 and the lexing code has kept multiple lines of text in the buffer for
1188 that purpose, then after completion of the token it would be wise to
1189 explicitly discard the now-unneeded earlier lines, to avoid future
1190 multi-line tokens growing the buffer without bound.
1196 Perl_lex_discard_to(pTHX_ char *ptr)
1200 PERL_ARGS_ASSERT_LEX_DISCARD_TO;
1201 buf = SvPVX(PL_parser->linestr);
1203 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_discard_to");
1206 if (ptr > PL_parser->bufptr)
1207 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_discard_to");
1208 discard_len = ptr - buf;
1209 if (PL_parser->oldbufptr < ptr)
1210 PL_parser->oldbufptr = ptr;
1211 if (PL_parser->oldoldbufptr < ptr)
1212 PL_parser->oldoldbufptr = ptr;
1213 if (PL_parser->last_uni && PL_parser->last_uni < ptr)
1214 PL_parser->last_uni = NULL;
1215 if (PL_parser->last_lop && PL_parser->last_lop < ptr)
1216 PL_parser->last_lop = NULL;
1217 Move(ptr, buf, PL_parser->bufend+1-ptr, char);
1218 SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) - discard_len);
1219 PL_parser->bufend -= discard_len;
1220 PL_parser->bufptr -= discard_len;
1221 PL_parser->oldbufptr -= discard_len;
1222 PL_parser->oldoldbufptr -= discard_len;
1223 if (PL_parser->last_uni)
1224 PL_parser->last_uni -= discard_len;
1225 if (PL_parser->last_lop)
1226 PL_parser->last_lop -= discard_len;
1230 =for apidoc Amx|bool|lex_next_chunk|U32 flags
1232 Reads in the next chunk of text to be lexed, appending it to
1233 L</PL_parser-E<gt>linestr>. This should be called when lexing code has
1234 looked to the end of the current chunk and wants to know more. It is
1235 usual, but not necessary, for lexing to have consumed the entirety of
1236 the current chunk at this time.
1238 If L</PL_parser-E<gt>bufptr> is pointing to the very end of the current
1239 chunk (i.e., the current chunk has been entirely consumed), normally the
1240 current chunk will be discarded at the same time that the new chunk is
1241 read in. If I<flags> includes C<LEX_KEEP_PREVIOUS>, the current chunk
1242 will not be discarded. If the current chunk has not been entirely
1243 consumed, then it will not be discarded regardless of the flag.
1245 Returns true if some new text was added to the buffer, or false if the
1246 buffer has reached the end of the input text.
1251 #define LEX_FAKE_EOF 0x80000000
1252 #define LEX_NO_TERM 0x40000000
1255 Perl_lex_next_chunk(pTHX_ U32 flags)
1259 STRLEN old_bufend_pos, new_bufend_pos;
1260 STRLEN bufptr_pos, oldbufptr_pos, oldoldbufptr_pos;
1261 STRLEN linestart_pos, last_uni_pos, last_lop_pos;
1262 bool got_some_for_debugger = 0;
1264 if (flags & ~(LEX_KEEP_PREVIOUS|LEX_FAKE_EOF|LEX_NO_TERM))
1265 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_next_chunk");
1266 linestr = PL_parser->linestr;
1267 buf = SvPVX(linestr);
1268 if (!(flags & LEX_KEEP_PREVIOUS) &&
1269 PL_parser->bufptr == PL_parser->bufend) {
1270 old_bufend_pos = bufptr_pos = oldbufptr_pos = oldoldbufptr_pos = 0;
1272 if (PL_parser->last_uni != PL_parser->bufend)
1273 PL_parser->last_uni = NULL;
1274 if (PL_parser->last_lop != PL_parser->bufend)
1275 PL_parser->last_lop = NULL;
1276 last_uni_pos = last_lop_pos = 0;
1280 old_bufend_pos = PL_parser->bufend - buf;
1281 bufptr_pos = PL_parser->bufptr - buf;
1282 oldbufptr_pos = PL_parser->oldbufptr - buf;
1283 oldoldbufptr_pos = PL_parser->oldoldbufptr - buf;
1284 linestart_pos = PL_parser->linestart - buf;
1285 last_uni_pos = PL_parser->last_uni ? PL_parser->last_uni - buf : 0;
1286 last_lop_pos = PL_parser->last_lop ? PL_parser->last_lop - buf : 0;
1288 if (flags & LEX_FAKE_EOF) {
1290 } else if (!PL_parser->rsfp && !PL_parser->filtered) {
1292 } else if (filter_gets(linestr, old_bufend_pos)) {
1294 got_some_for_debugger = 1;
1295 } else if (flags & LEX_NO_TERM) {
1298 if (!SvPOK(linestr)) /* can get undefined by filter_gets */
1299 sv_setpvs(linestr, "");
1301 /* End of real input. Close filehandle (unless it was STDIN),
1302 * then add implicit termination.
1304 if (PL_parser->lex_flags & LEX_DONT_CLOSE_RSFP)
1305 PerlIO_clearerr(PL_parser->rsfp);
1306 else if (PL_parser->rsfp)
1307 (void)PerlIO_close(PL_parser->rsfp);
1308 PL_parser->rsfp = NULL;
1309 PL_parser->in_pod = PL_parser->filtered = 0;
1310 if (!PL_in_eval && PL_minus_p) {
1312 /*{*/";}continue{print or die qq(-p destination: $!\\n);}");
1313 PL_minus_n = PL_minus_p = 0;
1314 } else if (!PL_in_eval && PL_minus_n) {
1315 sv_catpvs(linestr, /*{*/";}");
1318 sv_catpvs(linestr, ";");
1321 buf = SvPVX(linestr);
1322 new_bufend_pos = SvCUR(linestr);
1323 PL_parser->bufend = buf + new_bufend_pos;
1324 PL_parser->bufptr = buf + bufptr_pos;
1325 PL_parser->oldbufptr = buf + oldbufptr_pos;
1326 PL_parser->oldoldbufptr = buf + oldoldbufptr_pos;
1327 PL_parser->linestart = buf + linestart_pos;
1328 if (PL_parser->last_uni)
1329 PL_parser->last_uni = buf + last_uni_pos;
1330 if (PL_parser->last_lop)
1331 PL_parser->last_lop = buf + last_lop_pos;
1332 if (PL_parser->preambling != NOLINE) {
1333 CopLINE_set(PL_curcop, PL_parser->preambling + 1);
1334 PL_parser->preambling = NOLINE;
1336 if (got_some_for_debugger && (PERLDB_LINE || PERLDB_SAVESRC) &&
1337 PL_curstash != PL_debstash) {
1338 /* debugger active and we're not compiling the debugger code,
1339 * so store the line into the debugger's array of lines
1341 update_debugger_info(NULL, buf+old_bufend_pos,
1342 new_bufend_pos-old_bufend_pos);
1348 =for apidoc Amx|I32|lex_peek_unichar|U32 flags
1350 Looks ahead one (Unicode) character in the text currently being lexed.
1351 Returns the codepoint (unsigned integer value) of the next character,
1352 or -1 if lexing has reached the end of the input text. To consume the
1353 peeked character, use L</lex_read_unichar>.
1355 If the next character is in (or extends into) the next chunk of input
1356 text, the next chunk will be read in. Normally the current chunk will be
1357 discarded at the same time, but if I<flags> includes C<LEX_KEEP_PREVIOUS>
1358 then the current chunk will not be discarded.
1360 If the input is being interpreted as UTF-8 and a UTF-8 encoding error
1361 is encountered, an exception is generated.
1367 Perl_lex_peek_unichar(pTHX_ U32 flags)
1371 if (flags & ~(LEX_KEEP_PREVIOUS))
1372 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_peek_unichar");
1373 s = PL_parser->bufptr;
1374 bufend = PL_parser->bufend;
1380 if (!lex_next_chunk(flags))
1382 s = PL_parser->bufptr;
1383 bufend = PL_parser->bufend;
1386 if (UTF8_IS_INVARIANT(head))
1388 if (UTF8_IS_START(head)) {
1389 len = UTF8SKIP(&head);
1390 while ((STRLEN)(bufend-s) < len) {
1391 if (!lex_next_chunk(flags | LEX_KEEP_PREVIOUS))
1393 s = PL_parser->bufptr;
1394 bufend = PL_parser->bufend;
1397 unichar = utf8n_to_uvchr((U8*)s, bufend-s, &retlen, UTF8_CHECK_ONLY);
1398 if (retlen == (STRLEN)-1) {
1399 /* malformed UTF-8 */
1401 SAVESPTR(PL_warnhook);
1402 PL_warnhook = PERL_WARNHOOK_FATAL;
1403 utf8n_to_uvchr((U8*)s, bufend-s, NULL, 0);
1409 if (!lex_next_chunk(flags))
1411 s = PL_parser->bufptr;
1418 =for apidoc Amx|I32|lex_read_unichar|U32 flags
1420 Reads the next (Unicode) character in the text currently being lexed.
1421 Returns the codepoint (unsigned integer value) of the character read,
1422 and moves L</PL_parser-E<gt>bufptr> past the character, or returns -1
1423 if lexing has reached the end of the input text. To non-destructively
1424 examine the next character, use L</lex_peek_unichar> instead.
1426 If the next character is in (or extends into) the next chunk of input
1427 text, the next chunk will be read in. Normally the current chunk will be
1428 discarded at the same time, but if I<flags> includes C<LEX_KEEP_PREVIOUS>
1429 then the current chunk will not be discarded.
1431 If the input is being interpreted as UTF-8 and a UTF-8 encoding error
1432 is encountered, an exception is generated.
1438 Perl_lex_read_unichar(pTHX_ U32 flags)
1441 if (flags & ~(LEX_KEEP_PREVIOUS))
1442 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_unichar");
1443 c = lex_peek_unichar(flags);
1446 COPLINE_INC_WITH_HERELINES;
1448 PL_parser->bufptr += UTF8SKIP(PL_parser->bufptr);
1450 ++(PL_parser->bufptr);
1456 =for apidoc Amx|void|lex_read_space|U32 flags
1458 Reads optional spaces, in Perl style, in the text currently being
1459 lexed. The spaces may include ordinary whitespace characters and
1460 Perl-style comments. C<#line> directives are processed if encountered.
1461 L</PL_parser-E<gt>bufptr> is moved past the spaces, so that it points
1462 at a non-space character (or the end of the input text).
1464 If spaces extend into the next chunk of input text, the next chunk will
1465 be read in. Normally the current chunk will be discarded at the same
1466 time, but if I<flags> includes C<LEX_KEEP_PREVIOUS> then the current
1467 chunk will not be discarded.
1472 #define LEX_NO_INCLINE 0x40000000
1473 #define LEX_NO_NEXT_CHUNK 0x80000000
1476 Perl_lex_read_space(pTHX_ U32 flags)
1479 const bool can_incline = !(flags & LEX_NO_INCLINE);
1480 bool need_incline = 0;
1481 if (flags & ~(LEX_KEEP_PREVIOUS|LEX_NO_NEXT_CHUNK|LEX_NO_INCLINE))
1482 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_space");
1483 s = PL_parser->bufptr;
1484 bufend = PL_parser->bufend;
1490 } while (!(c == '\n' || (c == 0 && s == bufend)));
1491 } else if (c == '\n') {
1494 PL_parser->linestart = s;
1500 } else if (isSPACE(c)) {
1502 } else if (c == 0 && s == bufend) {
1505 if (flags & LEX_NO_NEXT_CHUNK)
1507 PL_parser->bufptr = s;
1508 l = CopLINE(PL_curcop);
1509 CopLINE(PL_curcop) += PL_parser->herelines + 1;
1510 got_more = lex_next_chunk(flags);
1511 CopLINE_set(PL_curcop, l);
1512 s = PL_parser->bufptr;
1513 bufend = PL_parser->bufend;
1516 if (can_incline && need_incline && PL_parser->rsfp) {
1524 PL_parser->bufptr = s;
1529 =for apidoc EXMp|bool|validate_proto|SV *name|SV *proto|bool warn
1531 This function performs syntax checking on a prototype, C<proto>.
1532 If C<warn> is true, any illegal characters or mismatched brackets
1533 will trigger illegalproto warnings, declaring that they were
1534 detected in the prototype for C<name>.
1536 The return value is C<true> if this is a valid prototype, and
1537 C<false> if it is not, regardless of whether C<warn> was C<true> or
1540 Note that C<NULL> is a valid C<proto> and will always return C<true>.
1547 Perl_validate_proto(pTHX_ SV *name, SV *proto, bool warn)
1549 STRLEN len, origlen;
1550 char *p = proto ? SvPV(proto, len) : NULL;
1551 bool bad_proto = FALSE;
1552 bool in_brackets = FALSE;
1553 bool after_slash = FALSE;
1554 char greedy_proto = ' ';
1555 bool proto_after_greedy_proto = FALSE;
1556 bool must_be_last = FALSE;
1557 bool underscore = FALSE;
1558 bool bad_proto_after_underscore = FALSE;
1560 PERL_ARGS_ASSERT_VALIDATE_PROTO;
1566 for (; len--; p++) {
1569 proto_after_greedy_proto = TRUE;
1571 if (!strchr(";@%", *p))
1572 bad_proto_after_underscore = TRUE;
1575 if (!strchr("$@%*;[]&\\_+", *p) || *p == '\0') {
1582 in_brackets = FALSE;
1583 else if ((*p == '@' || *p == '%') &&
1586 must_be_last = TRUE;
1595 after_slash = FALSE;
1600 SV *tmpsv = newSVpvs_flags("", SVs_TEMP);
1603 ? sv_uni_display(tmpsv, newSVpvn_flags(p, origlen, SVs_TEMP | SVf_UTF8),
1604 origlen, UNI_DISPLAY_ISPRINT)
1605 : pv_pretty(tmpsv, p, origlen, 60, NULL, NULL, PERL_PV_ESCAPE_NONASCII);
1607 if (proto_after_greedy_proto)
1608 Perl_warner(aTHX_ packWARN(WARN_ILLEGALPROTO),
1609 "Prototype after '%c' for %"SVf" : %s",
1610 greedy_proto, SVfARG(name), p);
1612 Perl_warner(aTHX_ packWARN(WARN_ILLEGALPROTO),
1613 "Missing ']' in prototype for %"SVf" : %s",
1616 Perl_warner(aTHX_ packWARN(WARN_ILLEGALPROTO),
1617 "Illegal character in prototype for %"SVf" : %s",
1619 if (bad_proto_after_underscore)
1620 Perl_warner(aTHX_ packWARN(WARN_ILLEGALPROTO),
1621 "Illegal character after '_' in prototype for %"SVf" : %s",
1625 return (! (proto_after_greedy_proto || bad_proto) );
1630 * This subroutine has nothing to do with tilting, whether at windmills
1631 * or pinball tables. Its name is short for "increment line". It
1632 * increments the current line number in CopLINE(PL_curcop) and checks
1633 * to see whether the line starts with a comment of the form
1634 * # line 500 "foo.pm"
1635 * If so, it sets the current line number and file to the values in the comment.
1639 S_incline(pTHX_ const char *s)
1647 PERL_ARGS_ASSERT_INCLINE;
1649 COPLINE_INC_WITH_HERELINES;
1650 if (!PL_rsfp && !PL_parser->filtered && PL_lex_state == LEX_NORMAL
1651 && s+1 == PL_bufend && *s == ';') {
1652 /* fake newline in string eval */
1653 CopLINE_dec(PL_curcop);
1658 while (SPACE_OR_TAB(*s))
1660 if (strnEQ(s, "line", 4))
1664 if (SPACE_OR_TAB(*s))
1668 while (SPACE_OR_TAB(*s))
1676 if (!SPACE_OR_TAB(*s) && *s != '\r' && *s != '\n' && *s != '\0')
1678 while (SPACE_OR_TAB(*s))
1680 if (*s == '"' && (t = strchr(s+1, '"'))) {
1686 while (!isSPACE(*t))
1690 while (SPACE_OR_TAB(*e) || *e == '\r' || *e == '\f')
1692 if (*e != '\n' && *e != '\0')
1693 return; /* false alarm */
1695 line_num = atoi(n)-1;
1698 const STRLEN len = t - s;
1700 if (!PL_rsfp && !PL_parser->filtered) {
1701 /* must copy *{"::_<(eval N)[oldfilename:L]"}
1702 * to *{"::_<newfilename"} */
1703 /* However, the long form of evals is only turned on by the
1704 debugger - usually they're "(eval %lu)" */
1705 GV * const cfgv = CopFILEGV(PL_curcop);
1708 STRLEN tmplen2 = len;
1712 if (tmplen2 + 2 <= sizeof smallbuf)
1715 Newx(tmpbuf2, tmplen2 + 2, char);
1720 memcpy(tmpbuf2 + 2, s, tmplen2);
1723 gv2 = *(GV**)hv_fetch(PL_defstash, tmpbuf2, tmplen2, TRUE);
1725 gv_init(gv2, PL_defstash, tmpbuf2, tmplen2, FALSE);
1726 /* adjust ${"::_<newfilename"} to store the new file name */
1727 GvSV(gv2) = newSVpvn(tmpbuf2 + 2, tmplen2 - 2);
1728 /* The line number may differ. If that is the case,
1729 alias the saved lines that are in the array.
1730 Otherwise alias the whole array. */
1731 if (CopLINE(PL_curcop) == line_num) {
1732 GvHV(gv2) = MUTABLE_HV(SvREFCNT_inc(GvHV(cfgv)));
1733 GvAV(gv2) = MUTABLE_AV(SvREFCNT_inc(GvAV(cfgv)));
1735 else if (GvAV(cfgv)) {
1736 AV * const av = GvAV(cfgv);
1737 const I32 start = CopLINE(PL_curcop)+1;
1738 I32 items = AvFILLp(av) - start;
1740 AV * const av2 = GvAVn(gv2);
1741 SV **svp = AvARRAY(av) + start;
1742 I32 l = (I32)line_num+1;
1744 av_store(av2, l++, SvREFCNT_inc(*svp++));
1749 if (tmpbuf2 != smallbuf) Safefree(tmpbuf2);
1752 CopFILE_free(PL_curcop);
1753 CopFILE_setn(PL_curcop, s, len);
1755 CopLINE_set(PL_curcop, line_num);
1758 #define skipspace(s) skipspace_flags(s, 0)
1762 S_update_debugger_info(pTHX_ SV *orig_sv, const char *const buf, STRLEN len)
1764 AV *av = CopFILEAVx(PL_curcop);
1767 if (PL_parser->preambling == NOLINE) sv = newSV_type(SVt_PVMG);
1769 sv = *av_fetch(av, 0, 1);
1770 SvUPGRADE(sv, SVt_PVMG);
1772 if (!SvPOK(sv)) sv_setpvs(sv,"");
1774 sv_catsv(sv, orig_sv);
1776 sv_catpvn(sv, buf, len);
1781 if (PL_parser->preambling == NOLINE)
1782 av_store(av, CopLINE(PL_curcop), sv);
1788 * Called to gobble the appropriate amount and type of whitespace.
1789 * Skips comments as well.
1793 S_skipspace_flags(pTHX_ char *s, U32 flags)
1795 PERL_ARGS_ASSERT_SKIPSPACE_FLAGS;
1796 if (PL_lex_formbrack && PL_lex_brackets <= PL_lex_formbrack) {
1797 while (s < PL_bufend && SPACE_OR_TAB(*s))
1800 STRLEN bufptr_pos = PL_bufptr - SvPVX(PL_linestr);
1802 lex_read_space(flags | LEX_KEEP_PREVIOUS |
1803 (PL_sublex_info.sub_inwhat || PL_lex_state == LEX_FORMLINE ?
1804 LEX_NO_NEXT_CHUNK : 0));
1806 PL_bufptr = SvPVX(PL_linestr) + bufptr_pos;
1807 if (PL_linestart > PL_bufptr)
1808 PL_bufptr = PL_linestart;
1816 * Check the unary operators to ensure there's no ambiguity in how they're
1817 * used. An ambiguous piece of code would be:
1819 * This doesn't mean rand() + 5. Because rand() is a unary operator,
1820 * the +5 is its argument.
1830 if (PL_oldoldbufptr != PL_last_uni)
1832 while (isSPACE(*PL_last_uni))
1835 while (isWORDCHAR_lazy_if(s,UTF) || *s == '-')
1837 if ((t = strchr(s, '(')) && t < PL_bufptr)
1840 Perl_ck_warner_d(aTHX_ packWARN(WARN_AMBIGUOUS),
1841 "Warning: Use of \"%.*s\" without parentheses is ambiguous",
1842 (int)(s - PL_last_uni), PL_last_uni);
1846 * LOP : macro to build a list operator. Its behaviour has been replaced
1847 * with a subroutine, S_lop() for which LOP is just another name.
1850 #define LOP(f,x) return lop(f,x,s)
1854 * Build a list operator (or something that might be one). The rules:
1855 * - if we have a next token, then it's a list operator [why?]
1856 * - if the next thing is an opening paren, then it's a function
1857 * - else it's a list operator
1861 S_lop(pTHX_ I32 f, int x, char *s)
1865 PERL_ARGS_ASSERT_LOP;
1871 PL_last_lop = PL_oldbufptr;
1872 PL_last_lop_op = (OPCODE)f;
1876 return REPORT(FUNC);
1879 return REPORT(FUNC);
1882 if (!PL_lex_allbrackets && PL_lex_fakeeof > LEX_FAKEEOF_LOWLOGIC)
1883 PL_lex_fakeeof = LEX_FAKEEOF_LOWLOGIC;
1884 return REPORT(LSTOP);
1890 * When the lexer realizes it knows the next token (for instance,
1891 * it is reordering tokens for the parser) then it can call S_force_next
1892 * to know what token to return the next time the lexer is called. Caller
1893 * will need to set PL_nextval[] and possibly PL_expect to ensure
1894 * the lexer handles the token correctly.
1898 S_force_next(pTHX_ I32 type)
1903 PerlIO_printf(Perl_debug_log, "### forced token:\n");
1904 tokereport(type, &NEXTVAL_NEXTTOKE);
1907 PL_nexttype[PL_nexttoke] = type;
1909 if (PL_lex_state != LEX_KNOWNEXT) {
1910 PL_lex_defer = PL_lex_state;
1911 PL_lex_expect = PL_expect;
1912 PL_lex_state = LEX_KNOWNEXT;
1919 * This subroutine handles postfix deref syntax after the arrow has already
1920 * been emitted. @* $* etc. are emitted as two separate token right here.
1921 * @[ @{ %[ %{ *{ are emitted also as two tokens, but this function emits
1922 * only the first, leaving yylex to find the next.
1926 S_postderef(pTHX_ int const funny, char const next)
1929 assert(funny == DOLSHARP || strchr("$@%&*", funny));
1930 assert(strchr("*[{", next));
1932 PL_expect = XOPERATOR;
1933 if (PL_lex_state == LEX_INTERPNORMAL && !PL_lex_brackets) {
1934 assert('@' == funny || '$' == funny || DOLSHARP == funny);
1935 PL_lex_state = LEX_INTERPEND;
1936 force_next(POSTJOIN);
1942 if ('@' == funny && PL_lex_state == LEX_INTERPNORMAL
1943 && !PL_lex_brackets)
1945 PL_expect = XOPERATOR;
1954 int yyc = PL_parser->yychar;
1955 if (yyc != YYEMPTY) {
1957 NEXTVAL_NEXTTOKE = PL_parser->yylval;
1958 if (yyc == '{'/*}*/ || yyc == HASHBRACK || yyc == '['/*]*/) {
1959 PL_lex_allbrackets--;
1961 yyc |= (3<<24) | (PL_lex_brackstack[PL_lex_brackets] << 16);
1962 } else if (yyc == '('/*)*/) {
1963 PL_lex_allbrackets--;
1968 PL_parser->yychar = YYEMPTY;
1973 S_newSV_maybe_utf8(pTHX_ const char *const start, STRLEN len)
1976 SV * const sv = newSVpvn_utf8(start, len,
1979 && !is_ascii_string((const U8*)start, len)
1980 && is_utf8_string((const U8*)start, len));
1986 * When the lexer knows the next thing is a word (for instance, it has
1987 * just seen -> and it knows that the next char is a word char, then
1988 * it calls S_force_word to stick the next word into the PL_nexttoke/val
1992 * char *start : buffer position (must be within PL_linestr)
1993 * int token : PL_next* will be this type of bare word (e.g., METHOD,WORD)
1994 * int check_keyword : if true, Perl checks to make sure the word isn't
1995 * a keyword (do this if the word is a label, e.g. goto FOO)
1996 * int allow_pack : if true, : characters will also be allowed (require,
1997 * use, etc. do this)
1998 * int allow_initial_tick : used by the "sub" lexer only.
2002 S_force_word(pTHX_ char *start, int token, int check_keyword, int allow_pack)
2008 PERL_ARGS_ASSERT_FORCE_WORD;
2010 start = SKIPSPACE1(start);
2012 if (isIDFIRST_lazy_if(s,UTF) ||
2013 (allow_pack && *s == ':') )
2015 s = scan_word(s, PL_tokenbuf, sizeof PL_tokenbuf, allow_pack, &len);
2016 if (check_keyword) {
2017 char *s2 = PL_tokenbuf;
2018 if (allow_pack && len > 6 && strnEQ(s2, "CORE::", 6))
2020 if (keyword(s2, len, 0))
2023 if (token == METHOD) {
2028 PL_expect = XOPERATOR;
2031 NEXTVAL_NEXTTOKE.opval
2032 = (OP*)newSVOP(OP_CONST,0,
2033 S_newSV_maybe_utf8(aTHX_ PL_tokenbuf, len));
2034 NEXTVAL_NEXTTOKE.opval->op_private |= OPpCONST_BARE;
2042 * Called when the lexer wants $foo *foo &foo etc, but the program
2043 * text only contains the "foo" portion. The first argument is a pointer
2044 * to the "foo", and the second argument is the type symbol to prefix.
2045 * Forces the next token to be a "WORD".
2046 * Creates the symbol if it didn't already exist (via gv_fetchpv()).
2050 S_force_ident(pTHX_ const char *s, int kind)
2054 PERL_ARGS_ASSERT_FORCE_IDENT;
2057 const STRLEN len = s[1] ? strlen(s) : 1; /* s = "\"" see yylex */
2058 OP* const o = (OP*)newSVOP(OP_CONST, 0, newSVpvn_flags(s, len,
2059 UTF ? SVf_UTF8 : 0));
2060 NEXTVAL_NEXTTOKE.opval = o;
2063 o->op_private = OPpCONST_ENTERED;
2064 /* XXX see note in pp_entereval() for why we forgo typo
2065 warnings if the symbol must be introduced in an eval.
2067 gv_fetchpvn_flags(s, len,
2068 (PL_in_eval ? (GV_ADDMULTI | GV_ADDINEVAL)
2069 : GV_ADD) | ( UTF ? SVf_UTF8 : 0 ),
2070 kind == '$' ? SVt_PV :
2071 kind == '@' ? SVt_PVAV :
2072 kind == '%' ? SVt_PVHV :
2080 S_force_ident_maybe_lex(pTHX_ char pit)
2082 NEXTVAL_NEXTTOKE.ival = pit;
2087 Perl_str_to_version(pTHX_ SV *sv)
2092 const char *start = SvPV_const(sv,len);
2093 const char * const end = start + len;
2094 const bool utf = SvUTF8(sv) ? TRUE : FALSE;
2096 PERL_ARGS_ASSERT_STR_TO_VERSION;
2098 while (start < end) {
2102 n = utf8n_to_uvchr((U8*)start, len, &skip, 0);
2107 retval += ((NV)n)/nshift;
2116 * Forces the next token to be a version number.
2117 * If the next token appears to be an invalid version number, (e.g. "v2b"),
2118 * and if "guessing" is TRUE, then no new token is created (and the caller
2119 * must use an alternative parsing method).
2123 S_force_version(pTHX_ char *s, int guessing)
2129 PERL_ARGS_ASSERT_FORCE_VERSION;
2137 while (isDIGIT(*d) || *d == '_' || *d == '.')
2139 if (*d == ';' || isSPACE(*d) || *d == '{' || *d == '}' || !*d) {
2141 s = scan_num(s, &pl_yylval);
2142 version = pl_yylval.opval;
2143 ver = cSVOPx(version)->op_sv;
2144 if (SvPOK(ver) && !SvNIOK(ver)) {
2145 SvUPGRADE(ver, SVt_PVNV);
2146 SvNV_set(ver, str_to_version(ver));
2147 SvNOK_on(ver); /* hint that it is a version */
2150 else if (guessing) {
2155 /* NOTE: The parser sees the package name and the VERSION swapped */
2156 NEXTVAL_NEXTTOKE.opval = version;
2163 * S_force_strict_version
2164 * Forces the next token to be a version number using strict syntax rules.
2168 S_force_strict_version(pTHX_ char *s)
2172 const char *errstr = NULL;
2174 PERL_ARGS_ASSERT_FORCE_STRICT_VERSION;
2176 while (isSPACE(*s)) /* leading whitespace */
2179 if (is_STRICT_VERSION(s,&errstr)) {
2181 s = (char *)scan_version(s, ver, 0);
2182 version = newSVOP(OP_CONST, 0, ver);
2184 else if ( (*s != ';' && *s != '{' && *s != '}' ) &&
2185 (s = SKIPSPACE1(s), (*s != ';' && *s != '{' && *s != '}' )))
2189 yyerror(errstr); /* version required */
2193 /* NOTE: The parser sees the package name and the VERSION swapped */
2194 NEXTVAL_NEXTTOKE.opval = version;
2202 * Tokenize a quoted string passed in as an SV. It finds the next
2203 * chunk, up to end of string or a backslash. It may make a new
2204 * SV containing that chunk (if HINT_NEW_STRING is on). It also
2209 S_tokeq(pTHX_ SV *sv)
2217 PERL_ARGS_ASSERT_TOKEQ;
2221 assert (!SvIsCOW(sv));
2222 if (SvTYPE(sv) >= SVt_PVIV && SvIVX(sv) == -1) /* <<'heredoc' */
2226 /* This is relying on the SV being "well formed" with a trailing '\0' */
2227 while (s < send && !(*s == '\\' && s[1] == '\\'))
2232 if ( PL_hints & HINT_NEW_STRING ) {
2233 pv = newSVpvn_flags(SvPVX_const(pv), SvCUR(sv),
2234 SVs_TEMP | SvUTF8(sv));
2238 if (s + 1 < send && (s[1] == '\\'))
2239 s++; /* all that, just for this */
2244 SvCUR_set(sv, d - SvPVX_const(sv));
2246 if ( PL_hints & HINT_NEW_STRING )
2247 return new_constant(NULL, 0, "q", sv, pv, "q", 1);
2252 * Now come three functions related to double-quote context,
2253 * S_sublex_start, S_sublex_push, and S_sublex_done. They're used when
2254 * converting things like "\u\Lgnat" into ucfirst(lc("gnat")). They
2255 * interact with PL_lex_state, and create fake ( ... ) argument lists
2256 * to handle functions and concatenation.
2260 * stringify ( const[foo] concat lcfirst ( const[bar] ) )
2265 * Assumes that pl_yylval.ival is the op we're creating (e.g. OP_LCFIRST).
2267 * Pattern matching will set PL_lex_op to the pattern-matching op to
2268 * make (we return THING if pl_yylval.ival is OP_NULL, PMFUNC otherwise).
2270 * OP_CONST and OP_READLINE are easy--just make the new op and return.
2272 * Everything else becomes a FUNC.
2274 * Sets PL_lex_state to LEX_INTERPPUSH unless (ival was OP_NULL or we
2275 * had an OP_CONST or OP_READLINE). This just sets us up for a
2276 * call to S_sublex_push().
2280 S_sublex_start(pTHX)
2283 const I32 op_type = pl_yylval.ival;
2285 if (op_type == OP_NULL) {
2286 pl_yylval.opval = PL_lex_op;
2290 if (op_type == OP_CONST) {
2291 SV *sv = tokeq(PL_lex_stuff);
2293 if (SvTYPE(sv) == SVt_PVIV) {
2294 /* Overloaded constants, nothing fancy: Convert to SVt_PV: */
2296 const char * const p = SvPV_const(sv, len);
2297 SV * const nsv = newSVpvn_flags(p, len, SvUTF8(sv));
2301 pl_yylval.opval = (OP*)newSVOP(op_type, 0, sv);
2302 PL_lex_stuff = NULL;
2306 PL_sublex_info.super_state = PL_lex_state;
2307 PL_sublex_info.sub_inwhat = (U16)op_type;
2308 PL_sublex_info.sub_op = PL_lex_op;
2309 PL_lex_state = LEX_INTERPPUSH;
2313 pl_yylval.opval = PL_lex_op;
2323 * Create a new scope to save the lexing state. The scope will be
2324 * ended in S_sublex_done. Returns a '(', starting the function arguments
2325 * to the uc, lc, etc. found before.
2326 * Sets PL_lex_state to LEX_INTERPCONCAT.
2334 const bool is_heredoc = PL_multi_close == '<';
2337 PL_lex_state = PL_sublex_info.super_state;
2338 SAVEI8(PL_lex_dojoin);
2339 SAVEI32(PL_lex_brackets);
2340 SAVEI32(PL_lex_allbrackets);
2341 SAVEI32(PL_lex_formbrack);
2342 SAVEI8(PL_lex_fakeeof);
2343 SAVEI32(PL_lex_casemods);
2344 SAVEI32(PL_lex_starts);
2345 SAVEI8(PL_lex_state);
2346 SAVESPTR(PL_lex_repl);
2347 SAVEVPTR(PL_lex_inpat);
2348 SAVEI16(PL_lex_inwhat);
2351 SAVECOPLINE(PL_curcop);
2352 SAVEI32(PL_multi_end);
2353 SAVEI32(PL_parser->herelines);
2354 PL_parser->herelines = 0;
2356 SAVEI8(PL_multi_close);
2357 SAVEPPTR(PL_bufptr);
2358 SAVEPPTR(PL_bufend);
2359 SAVEPPTR(PL_oldbufptr);
2360 SAVEPPTR(PL_oldoldbufptr);
2361 SAVEPPTR(PL_last_lop);
2362 SAVEPPTR(PL_last_uni);
2363 SAVEPPTR(PL_linestart);
2364 SAVESPTR(PL_linestr);
2365 SAVEGENERICPV(PL_lex_brackstack);
2366 SAVEGENERICPV(PL_lex_casestack);
2367 SAVEGENERICPV(PL_parser->lex_shared);
2368 SAVEBOOL(PL_parser->lex_re_reparsing);
2369 SAVEI32(PL_copline);
2371 /* The here-doc parser needs to be able to peek into outer lexing
2372 scopes to find the body of the here-doc. So we put PL_linestr and
2373 PL_bufptr into lex_shared, to ‘share’ those values.
2375 PL_parser->lex_shared->ls_linestr = PL_linestr;
2376 PL_parser->lex_shared->ls_bufptr = PL_bufptr;
2378 PL_linestr = PL_lex_stuff;
2379 PL_lex_repl = PL_sublex_info.repl;
2380 PL_lex_stuff = NULL;
2381 PL_sublex_info.repl = NULL;
2383 PL_bufend = PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart
2384 = SvPVX(PL_linestr);
2385 PL_bufend += SvCUR(PL_linestr);
2386 PL_last_lop = PL_last_uni = NULL;
2387 SAVEFREESV(PL_linestr);
2388 if (PL_lex_repl) SAVEFREESV(PL_lex_repl);
2390 PL_lex_dojoin = FALSE;
2391 PL_lex_brackets = PL_lex_formbrack = 0;
2392 PL_lex_allbrackets = 0;
2393 PL_lex_fakeeof = LEX_FAKEEOF_NEVER;
2394 Newx(PL_lex_brackstack, 120, char);
2395 Newx(PL_lex_casestack, 12, char);
2396 PL_lex_casemods = 0;
2397 *PL_lex_casestack = '\0';
2399 PL_lex_state = LEX_INTERPCONCAT;
2401 CopLINE_set(PL_curcop, (line_t)PL_multi_start);
2402 PL_copline = NOLINE;
2404 Newxz(shared, 1, LEXSHARED);
2405 shared->ls_prev = PL_parser->lex_shared;
2406 PL_parser->lex_shared = shared;
2408 PL_lex_inwhat = PL_sublex_info.sub_inwhat;
2409 if (PL_lex_inwhat == OP_TRANSR) PL_lex_inwhat = OP_TRANS;
2410 if (PL_lex_inwhat == OP_MATCH || PL_lex_inwhat == OP_QR || PL_lex_inwhat == OP_SUBST)
2411 PL_lex_inpat = PL_sublex_info.sub_op;
2413 PL_lex_inpat = NULL;
2415 PL_parser->lex_re_reparsing = cBOOL(PL_in_eval & EVAL_RE_REPARSING);
2416 PL_in_eval &= ~EVAL_RE_REPARSING;
2423 * Restores lexer state after a S_sublex_push.
2430 if (!PL_lex_starts++) {
2431 SV * const sv = newSVpvs("");
2432 if (SvUTF8(PL_linestr))
2434 PL_expect = XOPERATOR;
2435 pl_yylval.opval = (OP*)newSVOP(OP_CONST, 0, sv);
2439 if (PL_lex_casemods) { /* oops, we've got some unbalanced parens */
2440 PL_lex_state = LEX_INTERPCASEMOD;
2444 /* Is there a right-hand side to take care of? (s//RHS/ or tr//RHS/) */
2445 assert(PL_lex_inwhat != OP_TRANSR);
2447 assert (PL_lex_inwhat == OP_SUBST || PL_lex_inwhat == OP_TRANS);
2448 PL_linestr = PL_lex_repl;
2450 PL_bufend = PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
2451 PL_bufend += SvCUR(PL_linestr);
2452 PL_last_lop = PL_last_uni = NULL;
2453 PL_lex_dojoin = FALSE;
2454 PL_lex_brackets = 0;
2455 PL_lex_allbrackets = 0;
2456 PL_lex_fakeeof = LEX_FAKEEOF_NEVER;
2457 PL_lex_casemods = 0;
2458 *PL_lex_casestack = '\0';
2460 if (SvEVALED(PL_lex_repl)) {
2461 PL_lex_state = LEX_INTERPNORMAL;
2463 /* we don't clear PL_lex_repl here, so that we can check later
2464 whether this is an evalled subst; that means we rely on the
2465 logic to ensure sublex_done() is called again only via the
2466 branch (in yylex()) that clears PL_lex_repl, else we'll loop */
2469 PL_lex_state = LEX_INTERPCONCAT;
2472 if (SvTYPE(PL_linestr) >= SVt_PVNV) {
2473 CopLINE(PL_curcop) +=
2474 ((XPVNV*)SvANY(PL_linestr))->xnv_u.xpad_cop_seq.xlow
2475 + PL_parser->herelines;
2476 PL_parser->herelines = 0;
2481 const line_t l = CopLINE(PL_curcop);
2483 if (PL_multi_close == '<')
2484 PL_parser->herelines += l - PL_multi_end;
2485 PL_bufend = SvPVX(PL_linestr);
2486 PL_bufend += SvCUR(PL_linestr);
2487 PL_expect = XOPERATOR;
2488 PL_sublex_info.sub_inwhat = 0;
2493 PERL_STATIC_INLINE SV*
2494 S_get_and_check_backslash_N_name(pTHX_ const char* s, const char* const e)
2496 /* <s> points to first character of interior of \N{}, <e> to one beyond the
2497 * interior, hence to the "}". Finds what the name resolves to, returning
2498 * an SV* containing it; NULL if no valid one found */
2500 SV* res = newSVpvn_flags(s, e - s, UTF ? SVf_UTF8 : 0);
2507 const U8* first_bad_char_loc;
2508 const char* backslash_ptr = s - 3; /* Points to the <\> of \N{... */
2510 PERL_ARGS_ASSERT_GET_AND_CHECK_BACKSLASH_N_NAME;
2512 if (UTF && ! is_utf8_string_loc((U8 *) backslash_ptr,
2514 &first_bad_char_loc))
2516 /* If warnings are on, this will print a more detailed analysis of what
2517 * is wrong than the error message below */
2518 utf8n_to_uvchr(first_bad_char_loc,
2519 e - ((char *) first_bad_char_loc),
2522 /* We deliberately don't try to print the malformed character, which
2523 * might not print very well; it also may be just the first of many
2524 * malformations, so don't print what comes after it */
2525 yyerror(Perl_form(aTHX_
2526 "Malformed UTF-8 character immediately after '%.*s'",
2527 (int) (first_bad_char_loc - (U8 *) backslash_ptr), backslash_ptr));
2531 res = new_constant( NULL, 0, "charnames", res, NULL, backslash_ptr,
2532 /* include the <}> */
2533 e - backslash_ptr + 1);
2535 SvREFCNT_dec_NN(res);
2539 /* See if the charnames handler is the Perl core's, and if so, we can skip
2540 * the validation needed for a user-supplied one, as Perl's does its own
2542 table = GvHV(PL_hintgv); /* ^H */
2543 cvp = hv_fetchs(table, "charnames", FALSE);
2544 if (cvp && (cv = *cvp) && SvROK(cv) && (rv = SvRV(cv),
2545 SvTYPE(rv) == SVt_PVCV) && ((stash = CvSTASH(rv)) != NULL))
2547 const char * const name = HvNAME(stash);
2548 if (HvNAMELEN(stash) == sizeof("_charnames")-1
2549 && strEQ(name, "_charnames")) {
2554 /* Here, it isn't Perl's charname handler. We can't rely on a
2555 * user-supplied handler to validate the input name. For non-ut8 input,
2556 * look to see that the first character is legal. Then loop through the
2557 * rest checking that each is a continuation */
2559 /* This code makes the reasonable assumption that the only Latin1-range
2560 * characters that begin a character name alias are alphabetic, otherwise
2561 * would have to create a isCHARNAME_BEGIN macro */
2564 if (! isALPHAU(*s)) {
2569 if (! isCHARNAME_CONT(*s)) {
2572 if (*s == ' ' && *(s-1) == ' ') {
2575 if ((U8) *s == NBSP_NATIVE && ckWARN_d(WARN_DEPRECATED)) {
2576 Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),
2577 "NO-BREAK SPACE in a charnames "
2578 "alias definition is deprecated");
2584 /* Similarly for utf8. For invariants can check directly; for other
2585 * Latin1, can calculate their code point and check; otherwise use a
2587 if (UTF8_IS_INVARIANT(*s)) {
2588 if (! isALPHAU(*s)) {
2592 } else if (UTF8_IS_DOWNGRADEABLE_START(*s)) {
2593 if (! isALPHAU(TWO_BYTE_UTF8_TO_NATIVE(*s, *(s+1)))) {
2599 if (! PL_utf8_charname_begin) {
2600 U8 flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
2601 PL_utf8_charname_begin = _core_swash_init("utf8",
2602 "_Perl_Charname_Begin",
2604 1, 0, NULL, &flags);
2606 if (! swash_fetch(PL_utf8_charname_begin, (U8 *) s, TRUE)) {
2613 if (UTF8_IS_INVARIANT(*s)) {
2614 if (! isCHARNAME_CONT(*s)) {
2617 if (*s == ' ' && *(s-1) == ' ') {
2622 else if (UTF8_IS_DOWNGRADEABLE_START(*s)) {
2623 if (! isCHARNAME_CONT(TWO_BYTE_UTF8_TO_NATIVE(*s, *(s+1))))
2627 if (*s == *NBSP_UTF8
2628 && *(s+1) == *(NBSP_UTF8+1)
2629 && ckWARN_d(WARN_DEPRECATED))
2631 Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),
2632 "NO-BREAK SPACE in a charnames "
2633 "alias definition is deprecated");
2638 if (! PL_utf8_charname_continue) {
2639 U8 flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
2640 PL_utf8_charname_continue = _core_swash_init("utf8",
2641 "_Perl_Charname_Continue",
2643 1, 0, NULL, &flags);
2645 if (! swash_fetch(PL_utf8_charname_continue, (U8 *) s, TRUE)) {
2652 if (*(s-1) == ' ') {
2655 "charnames alias definitions may not contain trailing "
2656 "white-space; marked by <-- HERE in %.*s<-- HERE %.*s",
2657 (int)(s - backslash_ptr + 1), backslash_ptr,
2658 (int)(e - s + 1), s + 1
2660 UTF ? SVf_UTF8 : 0);
2664 if (SvUTF8(res)) { /* Don't accept malformed input */
2665 const U8* first_bad_char_loc;
2667 const char* const str = SvPV_const(res, len);
2668 if (! is_utf8_string_loc((U8 *) str, len, &first_bad_char_loc)) {
2669 /* If warnings are on, this will print a more detailed analysis of
2670 * what is wrong than the error message below */
2671 utf8n_to_uvchr(first_bad_char_loc,
2672 (char *) first_bad_char_loc - str,
2675 /* We deliberately don't try to print the malformed character,
2676 * which might not print very well; it also may be just the first
2677 * of many malformations, so don't print what comes after it */
2680 "Malformed UTF-8 returned by %.*s immediately after '%.*s'",
2681 (int) (e - backslash_ptr + 1), backslash_ptr,
2682 (int) ((char *) first_bad_char_loc - str), str
2693 /* The final %.*s makes sure that should the trailing NUL be missing
2694 * that this print won't run off the end of the string */
2697 "Invalid character in \\N{...}; marked by <-- HERE in %.*s<-- HERE %.*s",
2698 (int)(s - backslash_ptr + 1), backslash_ptr,
2699 (int)(e - s + 1), s + 1
2701 UTF ? SVf_UTF8 : 0);
2708 "charnames alias definitions may not contain a sequence of "
2709 "multiple spaces; marked by <-- HERE in %.*s<-- HERE %.*s",
2710 (int)(s - backslash_ptr + 1), backslash_ptr,
2711 (int)(e - s + 1), s + 1
2713 UTF ? SVf_UTF8 : 0);
2720 Extracts the next constant part of a pattern, double-quoted string,
2721 or transliteration. This is terrifying code.
2723 For example, in parsing the double-quoted string "ab\x63$d", it would
2724 stop at the '$' and return an OP_CONST containing 'abc'.
2726 It looks at PL_lex_inwhat and PL_lex_inpat to find out whether it's
2727 processing a pattern (PL_lex_inpat is true), a transliteration
2728 (PL_lex_inwhat == OP_TRANS is true), or a double-quoted string.
2730 Returns a pointer to the character scanned up to. If this is
2731 advanced from the start pointer supplied (i.e. if anything was
2732 successfully parsed), will leave an OP_CONST for the substring scanned
2733 in pl_yylval. Caller must intuit reason for not parsing further
2734 by looking at the next characters herself.
2738 \N{FOO} => \N{U+hex_for_character_FOO}
2739 (if FOO expands to multiple characters, expands to \N{U+xx.XX.yy ...})
2742 all other \-char, including \N and \N{ apart from \N{ABC}
2745 @ and $ where it appears to be a var, but not for $ as tail anchor
2750 In transliterations:
2751 characters are VERY literal, except for - not at the start or end
2752 of the string, which indicates a range. If the range is in bytes,
2753 scan_const expands the range to the full set of intermediate
2754 characters. If the range is in utf8, the hyphen is replaced with
2755 a certain range mark which will be handled by pmtrans() in op.c.
2757 In double-quoted strings:
2759 double-quoted style: \r and \n
2760 constants: \x31, etc.
2761 deprecated backrefs: \1 (in substitution replacements)
2762 case and quoting: \U \Q \E
2765 scan_const does *not* construct ops to handle interpolated strings.
2766 It stops processing as soon as it finds an embedded $ or @ variable
2767 and leaves it to the caller to work out what's going on.
2769 embedded arrays (whether in pattern or not) could be:
2770 @foo, @::foo, @'foo, @{foo}, @$foo, @+, @-.
2772 $ in double-quoted strings must be the symbol of an embedded scalar.
2774 $ in pattern could be $foo or could be tail anchor. Assumption:
2775 it's a tail anchor if $ is the last thing in the string, or if it's
2776 followed by one of "()| \r\n\t"
2778 \1 (backreferences) are turned into $1 in substitutions
2780 The structure of the code is
2781 while (there's a character to process) {
2782 handle transliteration ranges
2783 skip regexp comments /(?#comment)/ and codes /(?{code})/
2784 skip #-initiated comments in //x patterns
2785 check for embedded arrays
2786 check for embedded scalars
2788 deprecate \1 in substitution replacements
2789 handle string-changing backslashes \l \U \Q \E, etc.
2790 switch (what was escaped) {
2791 handle \- in a transliteration (becomes a literal -)
2792 if a pattern and not \N{, go treat as regular character
2793 handle \132 (octal characters)
2794 handle \x15 and \x{1234} (hex characters)
2795 handle \N{name} (named characters, also \N{3,5} in a pattern)
2796 handle \cV (control characters)
2797 handle printf-style backslashes (\f, \r, \n, etc)
2800 } (end if backslash)
2801 handle regular character
2802 } (end while character to read)
2807 S_scan_const(pTHX_ char *start)
2810 char *send = PL_bufend; /* end of the constant */
2811 SV *sv = newSV(send - start); /* sv for the constant. See
2812 note below on sizing. */
2813 char *s = start; /* start of the constant */
2814 char *d = SvPVX(sv); /* destination for copies */
2815 bool dorange = FALSE; /* are we in a translit range? */
2816 bool didrange = FALSE; /* did we just finish a range? */
2817 bool in_charclass = FALSE; /* within /[...]/ */
2818 bool has_utf8 = FALSE; /* Output constant is UTF8 */
2819 bool this_utf8 = cBOOL(UTF); /* Is the source string assumed
2820 to be UTF8? But, this can
2821 show as true when the source
2822 isn't utf8, as for example
2823 when it is entirely composed
2825 SV *res; /* result from charnames */
2827 /* Note on sizing: The scanned constant is placed into sv, which is
2828 * initialized by newSV() assuming one byte of output for every byte of
2829 * input. This routine expects newSV() to allocate an extra byte for a
2830 * trailing NUL, which this routine will append if it gets to the end of
2831 * the input. There may be more bytes of input than output (eg., \N{LATIN
2832 * CAPITAL LETTER A}), or more output than input if the constant ends up
2833 * recoded to utf8, but each time a construct is found that might increase
2834 * the needed size, SvGROW() is called. Its size parameter each time is
2835 * based on the best guess estimate at the time, namely the length used so
2836 * far, plus the length the current construct will occupy, plus room for
2837 * the trailing NUL, plus one byte for every input byte still unscanned */
2839 UV uv = UV_MAX; /* Initialize to weird value to try to catch any uses
2842 UV literal_endpoint = 0;
2843 bool native_range = TRUE; /* turned to FALSE if the first endpoint is Unicode. */
2846 PERL_ARGS_ASSERT_SCAN_CONST;
2848 assert(PL_lex_inwhat != OP_TRANSR);
2849 if (PL_lex_inwhat == OP_TRANS && PL_sublex_info.sub_op) {
2850 /* If we are doing a trans and we know we want UTF8 set expectation */
2851 has_utf8 = PL_sublex_info.sub_op->op_private & (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF);
2852 this_utf8 = PL_sublex_info.sub_op->op_private & (PL_lex_repl ? OPpTRANS_FROM_UTF : OPpTRANS_TO_UTF);
2855 /* Protect sv from errors and fatal warnings. */
2856 ENTER_with_name("scan_const");
2859 while (s < send || dorange) {
2861 /* get transliterations out of the way (they're most literal) */
2862 if (PL_lex_inwhat == OP_TRANS) {
2863 /* expand a range A-Z to the full set of characters. AIE! */
2865 I32 i; /* current expanded character */
2866 I32 min; /* first character in range */
2867 I32 max; /* last character in range */
2878 char * const c = (char*)utf8_hop((U8*)d, -1);
2882 *c = (char) ILLEGAL_UTF8_BYTE;
2883 /* mark the range as done, and continue */
2889 i = d - SvPVX_const(sv); /* remember current offset */
2892 SvLEN(sv) + (has_utf8 ?
2893 (512 - UTF_CONTINUATION_MARK +
2896 /* How many two-byte within 0..255: 128 in UTF-8,
2897 * 96 in UTF-8-mod. */
2899 SvGROW(sv, SvLEN(sv) + 256); /* never more than 256 chars in a range */
2901 d = SvPVX(sv) + i; /* refresh d after realloc */
2905 for (j = 0; j <= 1; j++) {
2906 char * const c = (char*)utf8_hop((U8*)d, -1);
2907 const UV uv = utf8n_to_uvchr((U8*)c, d - c, NULL, 0);
2913 max = (U8)0xff; /* only to \xff */
2914 uvmax = uv; /* \x{100} to uvmax */
2916 d = c; /* eat endpoint chars */
2921 d -= 2; /* eat the first char and the - */
2922 min = (U8)*d; /* first char in range */
2923 max = (U8)d[1]; /* last char in range */
2930 "Invalid range \"%c-%c\" in transliteration operator",
2931 (char)min, (char)max);
2935 if (literal_endpoint == 2 &&
2936 ((isLOWER_A(min) && isLOWER_A(max)) ||
2937 (isUPPER_A(min) && isUPPER_A(max))))
2939 for (i = min; i <= max; i++) {
2946 for (i = min; i <= max; i++)
2949 append_utf8_from_native_byte(i, &d);
2957 d = (char*)uvchr_to_utf8((U8*)d, 0x100);
2959 *d++ = (char) ILLEGAL_UTF8_BYTE;
2961 d = (char*)uvchr_to_utf8((U8*)d, uvmax);
2965 /* mark the range as done, and continue */
2969 literal_endpoint = 0;
2974 /* range begins (ignore - as first or last char) */
2975 else if (*s == '-' && s+1 < send && s != start) {
2977 Perl_croak(aTHX_ "Ambiguous range in transliteration operator");
2984 *d++ = (char) ILLEGAL_UTF8_BYTE; /* use illegal utf8 byte--see pmtrans */
2994 literal_endpoint = 0;
2995 native_range = TRUE;
3000 /* if we get here, we're not doing a transliteration */
3002 else if (*s == '[' && PL_lex_inpat && !in_charclass) {
3005 while (s1 >= start && *s1-- == '\\')
3008 in_charclass = TRUE;
3011 else if (*s == ']' && PL_lex_inpat && in_charclass) {
3014 while (s1 >= start && *s1-- == '\\')
3017 in_charclass = FALSE;
3020 /* skip for regexp comments /(?#comment)/, except for the last
3021 * char, which will be done separately.
3022 * Stop on (?{..}) and friends */
3024 else if (*s == '(' && PL_lex_inpat && s[1] == '?' && !in_charclass) {
3026 while (s+1 < send && *s != ')')
3029 else if (!PL_lex_casemods &&
3030 ( s[2] == '{' /* This should match regcomp.c */
3031 || (s[2] == '?' && s[3] == '{')))
3037 /* likewise skip #-initiated comments in //x patterns */
3038 else if (*s == '#' && PL_lex_inpat && !in_charclass &&
3039 ((PMOP*)PL_lex_inpat)->op_pmflags & RXf_PMf_EXTENDED) {
3040 while (s+1 < send && *s != '\n')
3044 /* no further processing of single-quoted regex */
3045 else if (PL_lex_inpat && SvIVX(PL_linestr) == '\'')
3046 goto default_action;
3048 /* check for embedded arrays
3049 (@foo, @::foo, @'foo, @{foo}, @$foo, @+, @-)
3051 else if (*s == '@' && s[1]) {
3052 if (isWORDCHAR_lazy_if(s+1,UTF))
3054 if (strchr(":'{$", s[1]))
3056 if (!PL_lex_inpat && (s[1] == '+' || s[1] == '-'))
3057 break; /* in regexp, neither @+ nor @- are interpolated */
3060 /* check for embedded scalars. only stop if we're sure it's a
3063 else if (*s == '$') {
3064 if (!PL_lex_inpat) /* not a regexp, so $ must be var */
3066 if (s + 1 < send && !strchr("()| \r\n\t", s[1])) {
3068 Perl_ck_warner(aTHX_ packWARN(WARN_AMBIGUOUS),
3069 "Possible unintended interpolation of $\\ in regex");
3071 break; /* in regexp, $ might be tail anchor */
3075 /* End of else if chain - OP_TRANS rejoin rest */
3078 if (*s == '\\' && s+1 < send) {
3079 char* e; /* Can be used for ending '}', etc. */
3083 /* warn on \1 - \9 in substitution replacements, but note that \11
3084 * is an octal; and \19 is \1 followed by '9' */
3085 if (PL_lex_inwhat == OP_SUBST && !PL_lex_inpat &&
3086 isDIGIT(*s) && *s != '0' && !isDIGIT(s[1]))
3088 /* diag_listed_as: \%d better written as $%d */
3089 Perl_ck_warner(aTHX_ packWARN(WARN_SYNTAX), "\\%c better written as $%c", *s, *s);
3094 /* string-change backslash escapes */
3095 if (PL_lex_inwhat != OP_TRANS && *s && strchr("lLuUEQF", *s)) {
3099 /* In a pattern, process \N, but skip any other backslash escapes.
3100 * This is because we don't want to translate an escape sequence
3101 * into a meta symbol and have the regex compiler use the meta
3102 * symbol meaning, e.g. \x{2E} would be confused with a dot. But
3103 * in spite of this, we do have to process \N here while the proper
3104 * charnames handler is in scope. See bugs #56444 and #62056.
3105 * There is a complication because \N in a pattern may also stand
3106 * for 'match a non-nl', and not mean a charname, in which case its
3107 * processing should be deferred to the regex compiler. To be a
3108 * charname it must be followed immediately by a '{', and not look
3109 * like \N followed by a curly quantifier, i.e., not something like
3110 * \N{3,}. regcurly returns a boolean indicating if it is a legal
3112 else if (PL_lex_inpat
3115 || regcurly(s + 1)))
3118 goto default_action;
3123 /* quoted - in transliterations */
3125 if (PL_lex_inwhat == OP_TRANS) {
3132 if ((isALPHANUMERIC(*s)))
3133 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
3134 "Unrecognized escape \\%c passed through",
3136 /* default action is to copy the quoted character */
3137 goto default_action;
3140 /* eg. \132 indicates the octal constant 0132 */
3141 case '0': case '1': case '2': case '3':
3142 case '4': case '5': case '6': case '7':
3144 I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
3146 uv = grok_oct(s, &len, &flags, NULL);
3148 if (len < 3 && s < send && isDIGIT(*s)
3149 && ckWARN(WARN_MISC))
3151 Perl_warner(aTHX_ packWARN(WARN_MISC),
3152 "%s", form_short_octal_warning(s, len));
3155 goto NUM_ESCAPE_INSERT;
3157 /* eg. \o{24} indicates the octal constant \024 */
3162 bool valid = grok_bslash_o(&s, &uv, &error,
3163 TRUE, /* Output warning */
3164 FALSE, /* Not strict */
3165 TRUE, /* Output warnings for
3172 goto NUM_ESCAPE_INSERT;
3175 /* eg. \x24 indicates the hex constant 0x24 */
3180 bool valid = grok_bslash_x(&s, &uv, &error,
3181 TRUE, /* Output warning */
3182 FALSE, /* Not strict */
3183 TRUE, /* Output warnings for
3193 /* Insert oct or hex escaped character. There will always be
3194 * enough room in sv since such escapes will be longer than any
3195 * UTF-8 sequence they can end up as, except if they force us
3196 * to recode the rest of the string into utf8 */
3198 /* Here uv is the ordinal of the next character being added */
3199 if (!UVCHR_IS_INVARIANT(uv)) {
3200 if (!has_utf8 && uv > 255) {
3201 /* Might need to recode whatever we have accumulated so
3202 * far if it contains any chars variant in utf8 or
3205 SvCUR_set(sv, d - SvPVX_const(sv));
3208 /* See Note on sizing above. */
3209 sv_utf8_upgrade_flags_grow(sv,
3210 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3211 UNISKIP(uv) + (STRLEN)(send - s) + 1);
3212 d = SvPVX(sv) + SvCUR(sv);
3217 d = (char*)uvchr_to_utf8((U8*)d, uv);
3218 if (PL_lex_inwhat == OP_TRANS &&
3219 PL_sublex_info.sub_op) {
3220 PL_sublex_info.sub_op->op_private |=
3221 (PL_lex_repl ? OPpTRANS_FROM_UTF
3225 if (uv > 255 && !dorange)
3226 native_range = FALSE;
3239 /* In a non-pattern \N must be a named character, like \N{LATIN
3240 * SMALL LETTER A} or \N{U+0041}. For patterns, it also can
3241 * mean to match a non-newline. For non-patterns, named
3242 * characters are converted to their string equivalents. In
3243 * patterns, named characters are not converted to their
3244 * ultimate forms for the same reasons that other escapes
3245 * aren't. Instead, they are converted to the \N{U+...} form
3246 * to get the value from the charnames that is in effect right
3247 * now, while preserving the fact that it was a named character
3248 * so that the regex compiler knows this */
3250 /* The structure of this section of code (besides checking for
3251 * errors and upgrading to utf8) is:
3252 * Further disambiguate between the two meanings of \N, and if
3253 * not a charname, go process it elsewhere
3254 * If of form \N{U+...}, pass it through if a pattern;
3255 * otherwise convert to utf8
3256 * Otherwise must be \N{NAME}: convert to \N{U+c1.c2...} if a
3257 * pattern; otherwise convert to utf8 */
3259 /* Here, s points to the 'N'; the test below is guaranteed to
3260 * succeed if we are being called on a pattern as we already
3261 * know from a test above that the next character is a '{'.
3262 * On a non-pattern \N must mean 'named sequence, which
3263 * requires braces */
3266 yyerror("Missing braces on \\N{}");
3271 /* If there is no matching '}', it is an error. */
3272 if (! (e = strchr(s, '}'))) {
3273 if (! PL_lex_inpat) {
3274 yyerror("Missing right brace on \\N{}");
3276 yyerror("Missing right brace on \\N{} or unescaped left brace after \\N");
3281 /* Here it looks like a named character */
3283 if (*s == 'U' && s[1] == '+') { /* \N{U+...} */
3284 I32 flags = PERL_SCAN_ALLOW_UNDERSCORES
3285 | PERL_SCAN_DISALLOW_PREFIX;
3288 /* For \N{U+...}, the '...' is a unicode value even on
3289 * EBCDIC machines */
3290 s += 2; /* Skip to next char after the 'U+' */
3292 uv = grok_hex(s, &len, &flags, NULL);
3293 if (len == 0 || len != (STRLEN)(e - s)) {
3294 yyerror("Invalid hexadecimal number in \\N{U+...}");
3301 /* On non-EBCDIC platforms, pass through to the regex
3302 * compiler unchanged. The reason we evaluated the
3303 * number above is to make sure there wasn't a syntax
3304 * error. But on EBCDIC we convert to native so
3305 * downstream code can continue to assume it's native
3307 s -= 5; /* Include the '\N{U+' */
3309 d += my_snprintf(d, e - s + 1 + 1, /* includes the }
3312 (unsigned int) UNI_TO_NATIVE(uv));
3314 Copy(s, d, e - s + 1, char); /* 1 = include the } */
3318 else { /* Not a pattern: convert the hex to string */
3320 /* If destination is not in utf8, unconditionally
3321 * recode it to be so. This is because \N{} implies
3322 * Unicode semantics, and scalars have to be in utf8
3323 * to guarantee those semantics */
3325 SvCUR_set(sv, d - SvPVX_const(sv));
3328 /* See Note on sizing above. */
3329 sv_utf8_upgrade_flags_grow(
3331 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3332 UNISKIP(uv) + (STRLEN)(send - e) + 1);
3333 d = SvPVX(sv) + SvCUR(sv);
3337 /* Add the (Unicode) code point to the output. */
3338 if (UNI_IS_INVARIANT(uv)) {
3339 *d++ = (char) LATIN1_TO_NATIVE(uv);
3342 d = (char*) uvoffuni_to_utf8_flags((U8*)d, uv, 0);
3346 else /* Here is \N{NAME} but not \N{U+...}. */
3347 if ((res = get_and_check_backslash_N_name(s, e)))
3350 const char *str = SvPV_const(res, len);
3353 if (! len) { /* The name resolved to an empty string */
3354 Copy("\\N{}", d, 4, char);
3358 /* In order to not lose information for the regex
3359 * compiler, pass the result in the specially made
3360 * syntax: \N{U+c1.c2.c3...}, where c1 etc. are
3361 * the code points in hex of each character
3362 * returned by charnames */
3364 const char *str_end = str + len;
3365 const STRLEN off = d - SvPVX_const(sv);
3367 if (! SvUTF8(res)) {
3368 /* For the non-UTF-8 case, we can determine the
3369 * exact length needed without having to parse
3370 * through the string. Each character takes up
3371 * 2 hex digits plus either a trailing dot or
3373 d = off + SvGROW(sv, off
3375 + 6 /* For the "\N{U+", and
3377 + (STRLEN)(send - e));
3378 Copy("\\N{U+", d, 5, char);
3380 while (str < str_end) {
3383 my_snprintf(hex_string,
3385 "%02X.", (U8) *str));
3386 Copy(hex_string, d, 3, char);
3390 d--; /* We will overwrite below the final
3391 dot with a right brace */
3394 STRLEN char_length; /* cur char's byte length */
3396 /* and the number of bytes after this is
3397 * translated into hex digits */
3398 STRLEN output_length;
3400 /* 2 hex per byte; 2 chars for '\N'; 2 chars
3401 * for max('U+', '.'); and 1 for NUL */
3402 char hex_string[2 * UTF8_MAXBYTES + 5];
3404 /* Get the first character of the result. */
3405 U32 uv = utf8n_to_uvchr((U8 *) str,
3409 /* Convert first code point to hex, including
3410 * the boiler plate before it. */
3412 my_snprintf(hex_string, sizeof(hex_string),
3416 /* Make sure there is enough space to hold it */
3417 d = off + SvGROW(sv, off
3419 + (STRLEN)(send - e)
3420 + 2); /* '}' + NUL */
3422 Copy(hex_string, d, output_length, char);
3425 /* For each subsequent character, append dot and
3426 * its ordinal in hex */
3427 while ((str += char_length) < str_end) {
3428 const STRLEN off = d - SvPVX_const(sv);
3429 U32 uv = utf8n_to_uvchr((U8 *) str,
3434 my_snprintf(hex_string,
3439 d = off + SvGROW(sv, off
3441 + (STRLEN)(send - e)
3442 + 2); /* '}' + NUL */
3443 Copy(hex_string, d, output_length, char);
3448 *d++ = '}'; /* Done. Add the trailing brace */
3451 else { /* Here, not in a pattern. Convert the name to a
3454 /* If destination is not in utf8, unconditionally
3455 * recode it to be so. This is because \N{} implies
3456 * Unicode semantics, and scalars have to be in utf8
3457 * to guarantee those semantics */
3459 SvCUR_set(sv, d - SvPVX_const(sv));
3462 /* See Note on sizing above. */
3463 sv_utf8_upgrade_flags_grow(sv,
3464 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3465 len + (STRLEN)(send - s) + 1);
3466 d = SvPVX(sv) + SvCUR(sv);
3468 } else if (len > (STRLEN)(e - s + 4)) { /* I _guess_ 4 is \N{} --jhi */
3470 /* See Note on sizing above. (NOTE: SvCUR() is not
3471 * set correctly here). */
3472 const STRLEN off = d - SvPVX_const(sv);
3473 d = off + SvGROW(sv, off + len + (STRLEN)(send - s) + 1);
3475 if (! SvUTF8(res)) { /* Make sure is \N{} return is UTF-8 */
3476 sv_utf8_upgrade(res);
3477 str = SvPV_const(res, len);
3479 Copy(str, d, len, char);
3485 } /* End \N{NAME} */
3488 native_range = FALSE; /* \N{} is defined to be Unicode */
3490 s = e + 1; /* Point to just after the '}' */
3493 /* \c is a control character */
3497 *d++ = grok_bslash_c(*s++, 1);
3500 yyerror("Missing control char name in \\c");
3504 /* printf-style backslashes, formfeeds, newlines, etc */
3521 *d++ = ASCII_TO_NATIVE('\033');
3530 } /* end if (backslash) */
3537 /* If we started with encoded form, or already know we want it,
3538 then encode the next character */
3539 if (! NATIVE_BYTE_IS_INVARIANT((U8)(*s)) && (this_utf8 || has_utf8)) {
3543 /* One might think that it is wasted effort in the case of the
3544 * source being utf8 (this_utf8 == TRUE) to take the next character
3545 * in the source, convert it to an unsigned value, and then convert
3546 * it back again. But the source has not been validated here. The
3547 * routine that does the conversion checks for errors like
3550 const UV nextuv = (this_utf8)
3551 ? utf8n_to_uvchr((U8*)s, send - s, &len, 0)
3553 const STRLEN need = UNISKIP(nextuv);
3555 SvCUR_set(sv, d - SvPVX_const(sv));
3558 /* See Note on sizing above. */
3559 sv_utf8_upgrade_flags_grow(sv,
3560 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3561 need + (STRLEN)(send - s) + 1);
3562 d = SvPVX(sv) + SvCUR(sv);
3564 } else if (need > len) {
3565 /* encoded value larger than old, may need extra space (NOTE:
3566 * SvCUR() is not set correctly here). See Note on sizing
3568 const STRLEN off = d - SvPVX_const(sv);
3569 d = SvGROW(sv, off + need + (STRLEN)(send - s) + 1) + off;
3573 d = (char*)uvchr_to_utf8((U8*)d, nextuv);
3575 if (uv > 255 && !dorange)
3576 native_range = FALSE;
3582 } /* while loop to process each character */
3584 /* terminate the string and set up the sv */
3586 SvCUR_set(sv, d - SvPVX_const(sv));
3587 if (SvCUR(sv) >= SvLEN(sv))
3588 Perl_croak(aTHX_ "panic: constant overflowed allocated space, %"UVuf
3589 " >= %"UVuf, (UV)SvCUR(sv), (UV)SvLEN(sv));
3592 if (PL_encoding && !has_utf8) {
3593 sv_recode_to_utf8(sv, PL_encoding);
3599 if (PL_lex_inwhat == OP_TRANS && PL_sublex_info.sub_op) {
3600 PL_sublex_info.sub_op->op_private |=
3601 (PL_lex_repl ? OPpTRANS_FROM_UTF : OPpTRANS_TO_UTF);
3605 /* shrink the sv if we allocated more than we used */
3606 if (SvCUR(sv) + 5 < SvLEN(sv)) {
3607 SvPV_shrink_to_cur(sv);
3610 /* return the substring (via pl_yylval) only if we parsed anything */
3613 for (; s2 < s; s2++) {
3615 COPLINE_INC_WITH_HERELINES;
3617 SvREFCNT_inc_simple_void_NN(sv);
3618 if ( (PL_hints & ( PL_lex_inpat ? HINT_NEW_RE : HINT_NEW_STRING ))
3619 && ! PL_parser->lex_re_reparsing)
3621 const char *const key = PL_lex_inpat ? "qr" : "q";
3622 const STRLEN keylen = PL_lex_inpat ? 2 : 1;
3626 if (PL_lex_inwhat == OP_TRANS) {
3629 } else if (PL_lex_inwhat == OP_SUBST && !PL_lex_inpat) {
3632 } else if (PL_lex_inpat && SvIVX(PL_linestr) == '\'') {
3640 sv = S_new_constant(aTHX_ start, s - start, key, keylen, sv, NULL,
3643 pl_yylval.opval = (OP*)newSVOP(OP_CONST, 0, sv);
3645 LEAVE_with_name("scan_const");
3650 * Returns TRUE if there's more to the expression (e.g., a subscript),
3653 * It deals with "$foo[3]" and /$foo[3]/ and /$foo[0123456789$]+/
3655 * ->[ and ->{ return TRUE
3656 * ->$* ->$#* ->@* ->@[ ->@{ return TRUE if postderef_qq is enabled
3657 * { and [ outside a pattern are always subscripts, so return TRUE
3658 * if we're outside a pattern and it's not { or [, then return FALSE
3659 * if we're in a pattern and the first char is a {
3660 * {4,5} (any digits around the comma) returns FALSE
3661 * if we're in a pattern and the first char is a [
3663 * [SOMETHING] has a funky algorithm to decide whether it's a
3664 * character class or not. It has to deal with things like
3665 * /$foo[-3]/ and /$foo[$bar]/ as well as /$foo[$\d]+/
3666 * anything else returns TRUE
3669 /* This is the one truly awful dwimmer necessary to conflate C and sed. */
3672 S_intuit_more(pTHX_ char *s)
3676 PERL_ARGS_ASSERT_INTUIT_MORE;
3678 if (PL_lex_brackets)
3680 if (*s == '-' && s[1] == '>' && (s[2] == '[' || s[2] == '{'))
3682 if (*s == '-' && s[1] == '>'
3683 && FEATURE_POSTDEREF_QQ_IS_ENABLED
3684 && ( (s[2] == '$' && (s[3] == '*' || (s[3] == '#' && s[4] == '*')))
3685 ||(s[2] == '@' && strchr("*[{",s[3])) ))
3687 if (*s != '{' && *s != '[')
3692 /* In a pattern, so maybe we have {n,m}. */
3700 /* On the other hand, maybe we have a character class */
3703 if (*s == ']' || *s == '^')
3706 /* this is terrifying, and it works */
3709 const char * const send = strchr(s,']');
3710 unsigned char un_char, last_un_char;
3711 char tmpbuf[sizeof PL_tokenbuf * 4];
3713 if (!send) /* has to be an expression */
3715 weight = 2; /* let's weigh the evidence */
3719 else if (isDIGIT(*s)) {
3721 if (isDIGIT(s[1]) && s[2] == ']')
3727 Zero(seen,256,char);
3729 for (; s < send; s++) {
3730 last_un_char = un_char;
3731 un_char = (unsigned char)*s;
3736 weight -= seen[un_char] * 10;
3737 if (isWORDCHAR_lazy_if(s+1,UTF)) {
3739 char *tmp = PL_bufend;
3740 PL_bufend = (char*)send;
3741 scan_ident(s, tmpbuf, sizeof tmpbuf, FALSE);
3743 len = (int)strlen(tmpbuf);
3744 if (len > 1 && gv_fetchpvn_flags(tmpbuf, len,
3745 UTF ? SVf_UTF8 : 0, SVt_PV))
3750 else if (*s == '$' && s[1] &&
3751 strchr("[#!%*<>()-=",s[1])) {
3752 if (/*{*/ strchr("])} =",s[2]))
3761 if (strchr("wds]",s[1]))
3763 else if (seen[(U8)'\''] || seen[(U8)'"'])
3765 else if (strchr("rnftbxcav",s[1]))
3767 else if (isDIGIT(s[1])) {
3769 while (s[1] && isDIGIT(s[1]))
3779 if (strchr("aA01! ",last_un_char))
3781 if (strchr("zZ79~",s[1]))
3783 if (last_un_char == 255 && (isDIGIT(s[1]) || s[1] == '$'))
3784 weight -= 5; /* cope with negative subscript */
3787 if (!isWORDCHAR(last_un_char)
3788 && !(last_un_char == '$' || last_un_char == '@'
3789 || last_un_char == '&')
3790 && isALPHA(*s) && s[1] && isALPHA(s[1])) {
3795 if (keyword(tmpbuf, d - tmpbuf, 0))
3798 if (un_char == last_un_char + 1)
3800 weight -= seen[un_char];
3805 if (weight >= 0) /* probably a character class */
3815 * Does all the checking to disambiguate
3817 * between foo(bar) and bar->foo. Returns 0 if not a method, otherwise
3818 * FUNCMETH (bar->foo(args)) or METHOD (bar->foo args).
3820 * First argument is the stuff after the first token, e.g. "bar".
3822 * Not a method if foo is a filehandle.
3823 * Not a method if foo is a subroutine prototyped to take a filehandle.
3824 * Not a method if it's really "Foo $bar"
3825 * Method if it's "foo $bar"
3826 * Not a method if it's really "print foo $bar"
3827 * Method if it's really "foo package::" (interpreted as package->foo)
3828 * Not a method if bar is known to be a subroutine ("sub bar; foo bar")
3829 * Not a method if bar is a filehandle or package, but is quoted with
3834 S_intuit_method(pTHX_ char *start, GV *gv, CV *cv)
3837 char *s = start + (*start == '$');
3838 char tmpbuf[sizeof PL_tokenbuf];
3842 PERL_ARGS_ASSERT_INTUIT_METHOD;
3844 if (gv && SvTYPE(gv) == SVt_PVGV && GvIO(gv))
3846 if (cv && SvPOK(cv)) {
3847 const char *proto = CvPROTO(cv);
3849 while (*proto && (isSPACE(*proto) || *proto == ';'))
3856 if (*start == '$') {
3857 if (cv || PL_last_lop_op == OP_PRINT || PL_last_lop_op == OP_SAY ||
3858 isUPPER(*PL_tokenbuf))
3863 return *s == '(' ? FUNCMETH : METHOD;
3866 s = scan_word(s, tmpbuf, sizeof tmpbuf, TRUE, &len);
3867 /* start is the beginning of the possible filehandle/object,
3868 * and s is the end of it
3869 * tmpbuf is a copy of it (but with single quotes as double colons)
3872 if (!keyword(tmpbuf, len, 0)) {
3873 if (len > 2 && tmpbuf[len - 2] == ':' && tmpbuf[len - 1] == ':') {
3878 indirgv = gv_fetchpvn_flags(tmpbuf, len, ( UTF ? SVf_UTF8 : 0 ), SVt_PVCV);
3879 if (indirgv && GvCVu(indirgv))
3881 /* filehandle or package name makes it a method */
3882 if (!cv || GvIO(indirgv) || gv_stashpvn(tmpbuf, len, UTF ? SVf_UTF8 : 0)) {
3884 if ((PL_bufend - s) >= 2 && *s == '=' && *(s+1) == '>')
3885 return 0; /* no assumptions -- "=>" quotes bareword */
3887 NEXTVAL_NEXTTOKE.opval = (OP*)newSVOP(OP_CONST, 0,
3888 S_newSV_maybe_utf8(aTHX_ tmpbuf, len));
3889 NEXTVAL_NEXTTOKE.opval->op_private = OPpCONST_BARE;
3893 return *s == '(' ? FUNCMETH : METHOD;
3899 /* Encoded script support. filter_add() effectively inserts a
3900 * 'pre-processing' function into the current source input stream.
3901 * Note that the filter function only applies to the current source file
3902 * (e.g., it will not affect files 'require'd or 'use'd by this one).
3904 * The datasv parameter (which may be NULL) can be used to pass
3905 * private data to this instance of the filter. The filter function
3906 * can recover the SV using the FILTER_DATA macro and use it to
3907 * store private buffers and state information.
3909 * The supplied datasv parameter is upgraded to a PVIO type
3910 * and the IoDIRP/IoANY field is used to store the function pointer,
3911 * and IOf_FAKE_DIRP is enabled on datasv to mark this as such.
3912 * Note that IoTOP_NAME, IoFMT_NAME, IoBOTTOM_NAME, if set for
3913 * private use must be set using malloc'd pointers.
3917 Perl_filter_add(pTHX_ filter_t funcp, SV *datasv)
3926 if (PL_parser->lex_flags & LEX_IGNORE_UTF8_HINTS)
3927 Perl_croak(aTHX_ "Source filters apply only to byte streams");
3929 if (!PL_rsfp_filters)
3930 PL_rsfp_filters = newAV();
3933 SvUPGRADE(datasv, SVt_PVIO);
3934 IoANY(datasv) = FPTR2DPTR(void *, funcp); /* stash funcp into spare field */
3935 IoFLAGS(datasv) |= IOf_FAKE_DIRP;
3936 DEBUG_P(PerlIO_printf(Perl_debug_log, "filter_add func %p (%s)\n",
3937 FPTR2DPTR(void *, IoANY(datasv)),
3938 SvPV_nolen(datasv)));
3939 av_unshift(PL_rsfp_filters, 1);
3940 av_store(PL_rsfp_filters, 0, datasv) ;
3942 !PL_parser->filtered
3943 && PL_parser->lex_flags & LEX_EVALBYTES
3944 && PL_bufptr < PL_bufend
3946 const char *s = PL_bufptr;
3947 while (s < PL_bufend) {
3949 SV *linestr = PL_parser->linestr;
3950 char *buf = SvPVX(linestr);
3951 STRLEN const bufptr_pos = PL_parser->bufptr - buf;
3952 STRLEN const oldbufptr_pos = PL_parser->oldbufptr - buf;
3953 STRLEN const oldoldbufptr_pos=PL_parser->oldoldbufptr-buf;
3954 STRLEN const linestart_pos = PL_parser->linestart - buf;
3955 STRLEN const last_uni_pos =
3956 PL_parser->last_uni ? PL_parser->last_uni - buf : 0;
3957 STRLEN const last_lop_pos =
3958 PL_parser->last_lop ? PL_parser->last_lop - buf : 0;
3959 av_push(PL_rsfp_filters, linestr);
3960 PL_parser->linestr =
3961 newSVpvn(SvPVX(linestr), ++s-SvPVX(linestr));
3962 buf = SvPVX(PL_parser->linestr);
3963 PL_parser->bufend = buf + SvCUR(PL_parser->linestr);
3964 PL_parser->bufptr = buf + bufptr_pos;
3965 PL_parser->oldbufptr = buf + oldbufptr_pos;
3966 PL_parser->oldoldbufptr = buf + oldoldbufptr_pos;
3967 PL_parser->linestart = buf + linestart_pos;
3968 if (PL_parser->last_uni)
3969 PL_parser->last_uni = buf + last_uni_pos;
3970 if (PL_parser->last_lop)
3971 PL_parser->last_lop = buf + last_lop_pos;
3972 SvLEN(linestr) = SvCUR(linestr);
3973 SvCUR(linestr) = s-SvPVX(linestr);
3974 PL_parser->filtered = 1;
3984 /* Delete most recently added instance of this filter function. */
3986 Perl_filter_del(pTHX_ filter_t funcp)
3991 PERL_ARGS_ASSERT_FILTER_DEL;
3994 DEBUG_P(PerlIO_printf(Perl_debug_log, "filter_del func %p",
3995 FPTR2DPTR(void*, funcp)));
3997 if (!PL_parser || !PL_rsfp_filters || AvFILLp(PL_rsfp_filters)<0)
3999 /* if filter is on top of stack (usual case) just pop it off */
4000 datasv = FILTER_DATA(AvFILLp(PL_rsfp_filters));
4001 if (IoANY(datasv) == FPTR2DPTR(void *, funcp)) {
4002 sv_free(av_pop(PL_rsfp_filters));
4006 /* we need to search for the correct entry and clear it */
4007 Perl_die(aTHX_ "filter_del can only delete in reverse order (currently)");
4011 /* Invoke the idxth filter function for the current rsfp. */
4012 /* maxlen 0 = read one text line */
4014 Perl_filter_read(pTHX_ int idx, SV *buf_sv, int maxlen)
4019 /* This API is bad. It should have been using unsigned int for maxlen.
4020 Not sure if we want to change the API, but if not we should sanity
4021 check the value here. */
4022 unsigned int correct_length = maxlen < 0 ? PERL_INT_MAX : maxlen;
4024 PERL_ARGS_ASSERT_FILTER_READ;
4026 if (!PL_parser || !PL_rsfp_filters)
4028 if (idx > AvFILLp(PL_rsfp_filters)) { /* Any more filters? */
4029 /* Provide a default input filter to make life easy. */
4030 /* Note that we append to the line. This is handy. */
4031 DEBUG_P(PerlIO_printf(Perl_debug_log,
4032 "filter_read %d: from rsfp\n", idx));
4033 if (correct_length) {
4036 const int old_len = SvCUR(buf_sv);
4038 /* ensure buf_sv is large enough */
4039 SvGROW(buf_sv, (STRLEN)(old_len + correct_length + 1)) ;
4040 if ((len = PerlIO_read(PL_rsfp, SvPVX(buf_sv) + old_len,
4041 correct_length)) <= 0) {
4042 if (PerlIO_error(PL_rsfp))
4043 return -1; /* error */
4045 return 0 ; /* end of file */
4047 SvCUR_set(buf_sv, old_len + len) ;
4048 SvPVX(buf_sv)[old_len + len] = '\0';
4051 if (sv_gets(buf_sv, PL_rsfp, SvCUR(buf_sv)) == NULL) {
4052 if (PerlIO_error(PL_rsfp))
4053 return -1; /* error */
4055 return 0 ; /* end of file */
4058 return SvCUR(buf_sv);
4060 /* Skip this filter slot if filter has been deleted */
4061 if ( (datasv = FILTER_DATA(idx)) == &PL_sv_undef) {
4062 DEBUG_P(PerlIO_printf(Perl_debug_log,
4063 "filter_read %d: skipped (filter deleted)\n",
4065 return FILTER_READ(idx+1, buf_sv, correct_length); /* recurse */
4067 if (SvTYPE(datasv) != SVt_PVIO) {
4068 if (correct_length) {
4070 const STRLEN remainder = SvLEN(datasv) - SvCUR(datasv);
4071 if (!remainder) return 0; /* eof */
4072 if (correct_length > remainder) correct_length = remainder;
4073 sv_catpvn(buf_sv, SvEND(datasv), correct_length);
4074 SvCUR_set(datasv, SvCUR(datasv) + correct_length);
4077 const char *s = SvEND(datasv);
4078 const char *send = SvPVX(datasv) + SvLEN(datasv);
4086 if (s == send) return 0; /* eof */
4087 sv_catpvn(buf_sv, SvEND(datasv), s-SvEND(datasv));
4088 SvCUR_set(datasv, s-SvPVX(datasv));
4090 return SvCUR(buf_sv);
4092 /* Get function pointer hidden within datasv */
4093 funcp = DPTR2FPTR(filter_t, IoANY(datasv));
4094 DEBUG_P(PerlIO_printf(Perl_debug_log,
4095 "filter_read %d: via function %p (%s)\n",
4096 idx, (void*)datasv, SvPV_nolen_const(datasv)));
4097 /* Call function. The function is expected to */
4098 /* call "FILTER_READ(idx+1, buf_sv)" first. */
4099 /* Return: <0:error, =0:eof, >0:not eof */
4100 return (*funcp)(aTHX_ idx, buf_sv, correct_length);
4104 S_filter_gets(pTHX_ SV *sv, STRLEN append)
4108 PERL_ARGS_ASSERT_FILTER_GETS;
4110 #ifdef PERL_CR_FILTER
4111 if (!PL_rsfp_filters) {
4112 filter_add(S_cr_textfilter,NULL);
4115 if (PL_rsfp_filters) {
4117 SvCUR_set(sv, 0); /* start with empty line */
4118 if (FILTER_READ(0, sv, 0) > 0)
4119 return ( SvPVX(sv) ) ;
4124 return (sv_gets(sv, PL_rsfp, append));
4128 S_find_in_my_stash(pTHX_ const char *pkgname, STRLEN len)
4133 PERL_ARGS_ASSERT_FIND_IN_MY_STASH;
4135 if (len == 11 && *pkgname == '_' && strEQ(pkgname, "__PACKAGE__"))
4139 (pkgname[len - 2] == ':' && pkgname[len - 1] == ':') &&
4140 (gv = gv_fetchpvn_flags(pkgname, len, ( UTF ? SVf_UTF8 : 0 ), SVt_PVHV)))
4142 return GvHV(gv); /* Foo:: */
4145 /* use constant CLASS => 'MyClass' */
4146 gv = gv_fetchpvn_flags(pkgname, len, UTF ? SVf_UTF8 : 0, SVt_PVCV);
4147 if (gv && GvCV(gv)) {
4148 SV * const sv = cv_const_sv(GvCV(gv));
4150 pkgname = SvPV_const(sv, len);
4153 return gv_stashpvn(pkgname, len, UTF ? SVf_UTF8 : 0);
4158 S_tokenize_use(pTHX_ int is_use, char *s) {
4161 PERL_ARGS_ASSERT_TOKENIZE_USE;
4163 if (PL_expect != XSTATE)
4164 yyerror(Perl_form(aTHX_ "\"%s\" not allowed in expression",
4165 is_use ? "use" : "no"));
4168 if (isDIGIT(*s) || (*s == 'v' && isDIGIT(s[1]))) {
4169 s = force_version(s, TRUE);
4170 if (*s == ';' || *s == '}'
4171 || (s = SKIPSPACE1(s), (*s == ';' || *s == '}'))) {
4172 NEXTVAL_NEXTTOKE.opval = NULL;
4175 else if (*s == 'v') {
4176 s = force_word(s,WORD,FALSE,TRUE);
4177 s = force_version(s, FALSE);
4181 s = force_word(s,WORD,FALSE,TRUE);
4182 s = force_version(s, FALSE);
4184 pl_yylval.ival = is_use;
4188 static const char* const exp_name[] =
4189 { "OPERATOR", "TERM", "REF", "STATE", "BLOCK", "ATTRBLOCK",
4190 "ATTRTERM", "TERMBLOCK", "POSTDEREF", "TERMORDORDOR"
4194 #define word_takes_any_delimeter(p,l) S_word_takes_any_delimeter(p,l)
4196 S_word_takes_any_delimeter(char *p, STRLEN len)
4198 return (len == 1 && strchr("msyq", p[0])) ||
4200 (p[0] == 't' && p[1] == 'r') ||
4201 (p[0] == 'q' && strchr("qwxr", p[1]))));
4205 S_check_scalar_slice(pTHX_ char *s)
4208 while (*s == ' ' || *s == '\t') s++;
4209 if (*s == 'q' && s[1] == 'w'
4210 && !isWORDCHAR_lazy_if(s+2,UTF))
4212 while (*s && (isWORDCHAR_lazy_if(s,UTF) || strchr(" \t$#+-'\"", *s)))
4213 s += UTF ? UTF8SKIP(s) : 1;
4214 if (*s == '}' || *s == ']')
4215 pl_yylval.ival = OPpSLICEWARNING;
4221 Works out what to call the token just pulled out of the input
4222 stream. The yacc parser takes care of taking the ops we return and
4223 stitching them into a tree.
4226 The type of the next token
4229 Switch based on the current state:
4230 - if we already built the token before, use it
4231 - if we have a case modifier in a string, deal with that
4232 - handle other cases of interpolation inside a string
4233 - scan the next line if we are inside a format
4234 In the normal state switch on the next character:
4236 if alphabetic, go to key lookup
4237 unrecoginized character - croak
4238 - 0/4/26: handle end-of-line or EOF
4239 - cases for whitespace
4240 - \n and #: handle comments and line numbers
4241 - various operators, brackets and sigils
4244 - 'v': vstrings (or go to key lookup)
4245 - 'x' repetition operator (or go to key lookup)
4246 - other ASCII alphanumerics (key lookup begins here):
4249 scan built-in keyword (but do nothing with it yet)
4250 check for statement label
4251 check for lexical subs
4252 goto just_a_word if there is one
4253 see whether built-in keyword is overridden
4254 switch on keyword number:
4255 - default: just_a_word:
4256 not a built-in keyword; handle bareword lookup
4257 disambiguate between method and sub call
4258 fall back to bareword
4259 - cases for built-in keywords
4267 char *s = PL_bufptr;
4271 const bool saw_infix_sigil = cBOOL(PL_parser->saw_infix_sigil);
4275 /* orig_keyword, gvp, and gv are initialized here because
4276 * jump to the label just_a_word_zero can bypass their
4277 * initialization later. */
4278 I32 orig_keyword = 0;
4283 SV* tmp = newSVpvs("");
4284 PerlIO_printf(Perl_debug_log, "### %"IVdf":LEX_%s/X%s %s\n",
4285 (IV)CopLINE(PL_curcop),
4286 lex_state_names[PL_lex_state],
4287 exp_name[PL_expect],
4288 pv_display(tmp, s, strlen(s), 0, 60));
4292 switch (PL_lex_state) {
4294 case LEX_INTERPNORMAL:
4297 /* when we've already built the next token, just pull it out of the queue */
4300 pl_yylval = PL_nextval[PL_nexttoke];
4302 PL_lex_state = PL_lex_defer;
4303 PL_expect = PL_lex_expect;
4304 PL_lex_defer = LEX_NORMAL;
4308 next_type = PL_nexttype[PL_nexttoke];
4309 if (next_type & (7<<24)) {
4310 if (next_type & (1<<24)) {
4311 if (PL_lex_brackets > 100)
4312 Renew(PL_lex_brackstack, PL_lex_brackets + 10, char);
4313 PL_lex_brackstack[PL_lex_brackets++] =
4314 (char) ((next_type >> 16) & 0xff);
4316 if (next_type & (2<<24))
4317 PL_lex_allbrackets++;
4318 if (next_type & (4<<24))
4319 PL_lex_allbrackets--;
4320 next_type &= 0xffff;
4322 return REPORT(next_type == 'p' ? pending_ident() : next_type);
4325 /* interpolated case modifiers like \L \U, including \Q and \E.
4326 when we get here, PL_bufptr is at the \
4328 case LEX_INTERPCASEMOD:
4330 if (PL_bufptr != PL_bufend && *PL_bufptr != '\\')
4332 "panic: INTERPCASEMOD bufptr=%p, bufend=%p, *bufptr=%u",
4333 PL_bufptr, PL_bufend, *PL_bufptr);
4335 /* handle \E or end of string */
4336 if (PL_bufptr == PL_bufend || PL_bufptr[1] == 'E') {
4338 if (PL_lex_casemods) {
4339 const char oldmod = PL_lex_casestack[--PL_lex_casemods];
4340 PL_lex_casestack[PL_lex_casemods] = '\0';
4342 if (PL_bufptr != PL_bufend
4343 && (oldmod == 'L' || oldmod == 'U' || oldmod == 'Q'
4344 || oldmod == 'F')) {
4346 PL_lex_state = LEX_INTERPCONCAT;
4348 PL_lex_allbrackets--;
4351 else if ( PL_bufptr != PL_bufend && PL_bufptr[1] == 'E' ) {
4352 /* Got an unpaired \E */
4353 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
4354 "Useless use of \\E");
4356 if (PL_bufptr != PL_bufend)
4358 PL_lex_state = LEX_INTERPCONCAT;
4362 DEBUG_T({ PerlIO_printf(Perl_debug_log,
4363 "### Saw case modifier\n"); });
4365 if (s[1] == '\\' && s[2] == 'E') {
4367 PL_lex_state = LEX_INTERPCONCAT;
4372 if (strnEQ(s, "L\\u", 3) || strnEQ(s, "U\\l", 3))
4373 tmp = *s, *s = s[2], s[2] = (char)tmp; /* misordered... */
4374 if ((*s == 'L' || *s == 'U' || *s == 'F') &&
4375 (strchr(PL_lex_casestack, 'L')
4376 || strchr(PL_lex_casestack, 'U')
4377 || strchr(PL_lex_casestack, 'F'))) {
4378 PL_lex_casestack[--PL_lex_casemods] = '\0';
4379 PL_lex_allbrackets--;
4382 if (PL_lex_casemods > 10)
4383 Renew(PL_lex_casestack, PL_lex_casemods + 2, char);
4384 PL_lex_casestack[PL_lex_casemods++] = *s;
4385 PL_lex_casestack[PL_lex_casemods] = '\0';
4386 PL_lex_state = LEX_INTERPCONCAT;
4387 NEXTVAL_NEXTTOKE.ival = 0;
4388 force_next((2<<24)|'(');
4390 NEXTVAL_NEXTTOKE.ival = OP_LCFIRST;
4392 NEXTVAL_NEXTTOKE.ival = OP_UCFIRST;
4394 NEXTVAL_NEXTTOKE.ival = OP_LC;
4396 NEXTVAL_NEXTTOKE.ival = OP_UC;
4398 NEXTVAL_NEXTTOKE.ival = OP_QUOTEMETA;
4400 NEXTVAL_NEXTTOKE.ival = OP_FC;
4402 Perl_croak(aTHX_ "panic: yylex, *s=%u", *s);
4406 if (PL_lex_starts) {
4409 /* commas only at base level: /$a\Ub$c/ => ($a,uc(b.$c)) */
4410 if (PL_lex_casemods == 1 && PL_lex_inpat)