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_inline.h"
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_dojoin (PL_parser->lex_dojoin)
56 #define PL_lex_formbrack (PL_parser->lex_formbrack)
57 #define PL_lex_inpat (PL_parser->lex_inpat)
58 #define PL_lex_inwhat (PL_parser->lex_inwhat)
59 #define PL_lex_op (PL_parser->lex_op)
60 #define PL_lex_repl (PL_parser->lex_repl)
61 #define PL_lex_starts (PL_parser->lex_starts)
62 #define PL_lex_stuff (PL_parser->lex_stuff)
63 #define PL_multi_start (PL_parser->multi_start)
64 #define PL_multi_open (PL_parser->multi_open)
65 #define PL_multi_close (PL_parser->multi_close)
66 #define PL_preambled (PL_parser->preambled)
67 #define PL_sublex_info (PL_parser->sublex_info)
68 #define PL_linestr (PL_parser->linestr)
69 #define PL_expect (PL_parser->expect)
70 #define PL_copline (PL_parser->copline)
71 #define PL_bufptr (PL_parser->bufptr)
72 #define PL_oldbufptr (PL_parser->oldbufptr)
73 #define PL_oldoldbufptr (PL_parser->oldoldbufptr)
74 #define PL_linestart (PL_parser->linestart)
75 #define PL_bufend (PL_parser->bufend)
76 #define PL_last_uni (PL_parser->last_uni)
77 #define PL_last_lop (PL_parser->last_lop)
78 #define PL_last_lop_op (PL_parser->last_lop_op)
79 #define PL_lex_state (PL_parser->lex_state)
80 #define PL_rsfp (PL_parser->rsfp)
81 #define PL_rsfp_filters (PL_parser->rsfp_filters)
82 #define PL_in_my (PL_parser->in_my)
83 #define PL_in_my_stash (PL_parser->in_my_stash)
84 #define PL_tokenbuf (PL_parser->tokenbuf)
85 #define PL_multi_end (PL_parser->multi_end)
86 #define PL_error_count (PL_parser->error_count)
88 # define PL_nexttoke (PL_parser->nexttoke)
89 # define PL_nexttype (PL_parser->nexttype)
90 # define PL_nextval (PL_parser->nextval)
92 static const char* const ident_too_long = "Identifier too long";
94 # define NEXTVAL_NEXTTOKE PL_nextval[PL_nexttoke]
96 #define XENUMMASK 0x3f
98 #define XFAKEBRACK 0x80
100 #ifdef USE_UTF8_SCRIPTS
101 # define UTF cBOOL(!IN_BYTES)
103 # define UTF cBOOL((PL_linestr && DO_UTF8(PL_linestr)) || ( !(PL_parser->lex_flags & LEX_IGNORE_UTF8_HINTS) && (PL_hints & HINT_UTF8)))
106 /* The maximum number of characters preceding the unrecognized one to display */
107 #define UNRECOGNIZED_PRECEDE_COUNT 10
109 /* In variables named $^X, these are the legal values for X.
110 * 1999-02-27 mjd-perl-patch@plover.com */
111 #define isCONTROLVAR(x) (isUPPER(x) || strchr("[\\]^_?", (x)))
113 #define SPACE_OR_TAB(c) isBLANK_A(c)
115 #define HEXFP_PEEK(s) \
117 (isXDIGIT(s[1]) || isALPHA_FOLD_EQ(s[1], 'p'))) || \
118 isALPHA_FOLD_EQ(s[0], 'p'))
120 /* LEX_* are values for PL_lex_state, the state of the lexer.
121 * They are arranged oddly so that the guard on the switch statement
122 * can get by with a single comparison (if the compiler is smart enough).
124 * These values refer to the various states within a sublex parse,
125 * i.e. within a double quotish string
128 /* #define LEX_NOTPARSING 11 is done in perl.h. */
130 #define LEX_NORMAL 10 /* normal code (ie not within "...") */
131 #define LEX_INTERPNORMAL 9 /* code within a string, eg "$foo[$x+1]" */
132 #define LEX_INTERPCASEMOD 8 /* expecting a \U, \Q or \E etc */
133 #define LEX_INTERPPUSH 7 /* starting a new sublex parse level */
134 #define LEX_INTERPSTART 6 /* expecting the start of a $var */
136 /* at end of code, eg "$x" followed by: */
137 #define LEX_INTERPEND 5 /* ... eg not one of [, { or -> */
138 #define LEX_INTERPENDMAYBE 4 /* ... eg one of [, { or -> */
140 #define LEX_INTERPCONCAT 3 /* expecting anything, eg at start of
141 string or after \E, $foo, etc */
142 #define LEX_INTERPCONST 2 /* NOT USED */
143 #define LEX_FORMLINE 1 /* expecting a format line */
147 static const char* const lex_state_names[] = {
162 #include "keywords.h"
164 /* CLINE is a macro that ensures PL_copline has a sane value */
166 #define CLINE (PL_copline = (CopLINE(PL_curcop) < PL_copline ? CopLINE(PL_curcop) : PL_copline))
169 * Convenience functions to return different tokens and prime the
170 * lexer for the next token. They all take an argument.
172 * TOKEN : generic token (used for '(', DOLSHARP, etc)
173 * OPERATOR : generic operator
174 * AOPERATOR : assignment operator
175 * PREBLOCK : beginning the block after an if, while, foreach, ...
176 * PRETERMBLOCK : beginning a non-code-defining {} block (eg, hash ref)
177 * PREREF : *EXPR where EXPR is not a simple identifier
178 * TERM : expression term
179 * POSTDEREF : postfix dereference (->$* ->@[...] etc.)
180 * LOOPX : loop exiting command (goto, last, dump, etc)
181 * FTST : file test operator
182 * FUN0 : zero-argument function
183 * FUN0OP : zero-argument function, with its op created in this file
184 * FUN1 : not used, except for not, which isn't a UNIOP
185 * BOop : bitwise or or xor
187 * BCop : bitwise complement
188 * SHop : shift operator
189 * PWop : power operator
190 * PMop : pattern-matching operator
191 * Aop : addition-level operator
192 * AopNOASSIGN : addition-level operator that is never part of .=
193 * Mop : multiplication-level operator
194 * Eop : equality-testing operator
195 * Rop : relational operator <= != gt
197 * Also see LOP and lop() below.
200 #ifdef DEBUGGING /* Serve -DT. */
201 # define REPORT(retval) tokereport((I32)retval, &pl_yylval)
203 # define REPORT(retval) (retval)
206 #define TOKEN(retval) return ( PL_bufptr = s, REPORT(retval))
207 #define OPERATOR(retval) return (PL_expect = XTERM, PL_bufptr = s, REPORT(retval))
208 #define AOPERATOR(retval) return ao((PL_expect = XTERM, PL_bufptr = s, retval))
209 #define PREBLOCK(retval) return (PL_expect = XBLOCK,PL_bufptr = s, REPORT(retval))
210 #define PRETERMBLOCK(retval) return (PL_expect = XTERMBLOCK,PL_bufptr = s, REPORT(retval))
211 #define PREREF(retval) return (PL_expect = XREF,PL_bufptr = s, REPORT(retval))
212 #define TERM(retval) return (CLINE, PL_expect = XOPERATOR, PL_bufptr = s, REPORT(retval))
213 #define POSTDEREF(f) return (PL_bufptr = s, S_postderef(aTHX_ REPORT(f),s[1]))
214 #define LOOPX(f) return (PL_bufptr = force_word(s,WORD,TRUE,FALSE), \
216 PL_expect = PL_nexttoke ? XOPERATOR : XTERM, \
218 #define FTST(f) return (pl_yylval.ival=f, PL_expect=XTERMORDORDOR, PL_bufptr=s, REPORT((int)UNIOP))
219 #define FUN0(f) return (pl_yylval.ival=f, PL_expect=XOPERATOR, PL_bufptr=s, REPORT((int)FUNC0))
220 #define FUN0OP(f) return (pl_yylval.opval=f, CLINE, PL_expect=XOPERATOR, PL_bufptr=s, REPORT((int)FUNC0OP))
221 #define FUN1(f) return (pl_yylval.ival=f, PL_expect=XOPERATOR, PL_bufptr=s, REPORT((int)FUNC1))
222 #define BOop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, (int)BITOROP))
223 #define BAop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, (int)BITANDOP))
224 #define BCop(f) return pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr = s, \
226 #define SHop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, (int)SHIFTOP))
227 #define PWop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, (int)POWOP))
228 #define PMop(f) return(pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)MATCHOP))
229 #define Aop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, (int)ADDOP))
230 #define AopNOASSIGN(f) return (pl_yylval.ival=f, PL_bufptr=s, REPORT((int)ADDOP))
231 #define Mop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, (int)MULOP))
232 #define Eop(f) return (pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)EQOP))
233 #define Rop(f) return (pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)RELOP))
235 /* This bit of chicanery makes a unary function followed by
236 * a parenthesis into a function with one argument, highest precedence.
237 * The UNIDOR macro is for unary functions that can be followed by the //
238 * operator (such as C<shift // 0>).
240 #define UNI3(f,x,have_x) { \
241 pl_yylval.ival = f; \
242 if (have_x) PL_expect = x; \
244 PL_last_uni = PL_oldbufptr; \
245 PL_last_lop_op = f; \
247 return REPORT( (int)FUNC1 ); \
249 return REPORT( *s=='(' ? (int)FUNC1 : (int)UNIOP ); \
251 #define UNI(f) UNI3(f,XTERM,1)
252 #define UNIDOR(f) UNI3(f,XTERMORDORDOR,1)
253 #define UNIPROTO(f,optional) { \
254 if (optional) PL_last_uni = PL_oldbufptr; \
258 #define UNIBRACK(f) UNI3(f,0,0)
260 /* grandfather return to old style */
263 if (!PL_lex_allbrackets && PL_lex_fakeeof > LEX_FAKEEOF_LOWLOGIC) \
264 PL_lex_fakeeof = LEX_FAKEEOF_LOWLOGIC; \
265 pl_yylval.ival = (f); \
271 #define COPLINE_INC_WITH_HERELINES \
273 CopLINE_inc(PL_curcop); \
274 if (PL_parser->herelines) \
275 CopLINE(PL_curcop) += PL_parser->herelines, \
276 PL_parser->herelines = 0; \
278 /* Called after scan_str to update CopLINE(PL_curcop), but only when there
279 * is no sublex_push to follow. */
280 #define COPLINE_SET_FROM_MULTI_END \
282 CopLINE_set(PL_curcop, PL_multi_end); \
283 if (PL_multi_end != PL_multi_start) \
284 PL_parser->herelines = 0; \
290 /* how to interpret the pl_yylval associated with the token */
294 TOKENTYPE_OPNUM, /* pl_yylval.ival contains an opcode number */
299 static struct debug_tokens {
301 enum token_type type;
303 } const debug_tokens[] =
305 { ADDOP, TOKENTYPE_OPNUM, "ADDOP" },
306 { ANDAND, TOKENTYPE_NONE, "ANDAND" },
307 { ANDOP, TOKENTYPE_NONE, "ANDOP" },
308 { ANONSUB, TOKENTYPE_IVAL, "ANONSUB" },
309 { ARROW, TOKENTYPE_NONE, "ARROW" },
310 { ASSIGNOP, TOKENTYPE_OPNUM, "ASSIGNOP" },
311 { BITANDOP, TOKENTYPE_OPNUM, "BITANDOP" },
312 { BITOROP, TOKENTYPE_OPNUM, "BITOROP" },
313 { COLONATTR, TOKENTYPE_NONE, "COLONATTR" },
314 { CONTINUE, TOKENTYPE_NONE, "CONTINUE" },
315 { DEFAULT, TOKENTYPE_NONE, "DEFAULT" },
316 { DO, TOKENTYPE_NONE, "DO" },
317 { DOLSHARP, TOKENTYPE_NONE, "DOLSHARP" },
318 { DORDOR, TOKENTYPE_NONE, "DORDOR" },
319 { DOROP, TOKENTYPE_OPNUM, "DOROP" },
320 { DOTDOT, TOKENTYPE_IVAL, "DOTDOT" },
321 { ELSE, TOKENTYPE_NONE, "ELSE" },
322 { ELSIF, TOKENTYPE_IVAL, "ELSIF" },
323 { EQOP, TOKENTYPE_OPNUM, "EQOP" },
324 { FOR, TOKENTYPE_IVAL, "FOR" },
325 { FORMAT, TOKENTYPE_NONE, "FORMAT" },
326 { FORMLBRACK, TOKENTYPE_NONE, "FORMLBRACK" },
327 { FORMRBRACK, TOKENTYPE_NONE, "FORMRBRACK" },
328 { FUNC, TOKENTYPE_OPNUM, "FUNC" },
329 { FUNC0, TOKENTYPE_OPNUM, "FUNC0" },
330 { FUNC0OP, TOKENTYPE_OPVAL, "FUNC0OP" },
331 { FUNC0SUB, TOKENTYPE_OPVAL, "FUNC0SUB" },
332 { FUNC1, TOKENTYPE_OPNUM, "FUNC1" },
333 { FUNCMETH, TOKENTYPE_OPVAL, "FUNCMETH" },
334 { GIVEN, TOKENTYPE_IVAL, "GIVEN" },
335 { HASHBRACK, TOKENTYPE_NONE, "HASHBRACK" },
336 { IF, TOKENTYPE_IVAL, "IF" },
337 { LABEL, TOKENTYPE_PVAL, "LABEL" },
338 { LOCAL, TOKENTYPE_IVAL, "LOCAL" },
339 { LOOPEX, TOKENTYPE_OPNUM, "LOOPEX" },
340 { LSTOP, TOKENTYPE_OPNUM, "LSTOP" },
341 { LSTOPSUB, TOKENTYPE_OPVAL, "LSTOPSUB" },
342 { MATCHOP, TOKENTYPE_OPNUM, "MATCHOP" },
343 { METHOD, TOKENTYPE_OPVAL, "METHOD" },
344 { MULOP, TOKENTYPE_OPNUM, "MULOP" },
345 { MY, TOKENTYPE_IVAL, "MY" },
346 { NOAMP, TOKENTYPE_NONE, "NOAMP" },
347 { NOTOP, TOKENTYPE_NONE, "NOTOP" },
348 { OROP, TOKENTYPE_IVAL, "OROP" },
349 { OROR, TOKENTYPE_NONE, "OROR" },
350 { PACKAGE, TOKENTYPE_NONE, "PACKAGE" },
351 { PLUGEXPR, TOKENTYPE_OPVAL, "PLUGEXPR" },
352 { PLUGSTMT, TOKENTYPE_OPVAL, "PLUGSTMT" },
353 { PMFUNC, TOKENTYPE_OPVAL, "PMFUNC" },
354 { POSTJOIN, TOKENTYPE_NONE, "POSTJOIN" },
355 { POSTDEC, TOKENTYPE_NONE, "POSTDEC" },
356 { POSTINC, TOKENTYPE_NONE, "POSTINC" },
357 { POWOP, TOKENTYPE_OPNUM, "POWOP" },
358 { PREDEC, TOKENTYPE_NONE, "PREDEC" },
359 { PREINC, TOKENTYPE_NONE, "PREINC" },
360 { PRIVATEREF, TOKENTYPE_OPVAL, "PRIVATEREF" },
361 { QWLIST, TOKENTYPE_OPVAL, "QWLIST" },
362 { REFGEN, TOKENTYPE_NONE, "REFGEN" },
363 { RELOP, TOKENTYPE_OPNUM, "RELOP" },
364 { REQUIRE, TOKENTYPE_NONE, "REQUIRE" },
365 { SHIFTOP, TOKENTYPE_OPNUM, "SHIFTOP" },
366 { SUB, TOKENTYPE_NONE, "SUB" },
367 { THING, TOKENTYPE_OPVAL, "THING" },
368 { UMINUS, TOKENTYPE_NONE, "UMINUS" },
369 { UNIOP, TOKENTYPE_OPNUM, "UNIOP" },
370 { UNIOPSUB, TOKENTYPE_OPVAL, "UNIOPSUB" },
371 { UNLESS, TOKENTYPE_IVAL, "UNLESS" },
372 { UNTIL, TOKENTYPE_IVAL, "UNTIL" },
373 { USE, TOKENTYPE_IVAL, "USE" },
374 { WHEN, TOKENTYPE_IVAL, "WHEN" },
375 { WHILE, TOKENTYPE_IVAL, "WHILE" },
376 { WORD, TOKENTYPE_OPVAL, "WORD" },
377 { YADAYADA, TOKENTYPE_IVAL, "YADAYADA" },
378 { 0, TOKENTYPE_NONE, NULL }
381 /* dump the returned token in rv, plus any optional arg in pl_yylval */
384 S_tokereport(pTHX_ I32 rv, const YYSTYPE* lvalp)
386 PERL_ARGS_ASSERT_TOKEREPORT;
389 const char *name = NULL;
390 enum token_type type = TOKENTYPE_NONE;
391 const struct debug_tokens *p;
392 SV* const report = newSVpvs("<== ");
394 for (p = debug_tokens; p->token; p++) {
395 if (p->token == (int)rv) {
402 Perl_sv_catpv(aTHX_ report, name);
403 else if (isGRAPH(rv))
405 Perl_sv_catpvf(aTHX_ report, "'%c'", (char)rv);
407 sv_catpvs(report, " (pending identifier)");
410 sv_catpvs(report, "EOF");
412 Perl_sv_catpvf(aTHX_ report, "?? %"IVdf, (IV)rv);
417 Perl_sv_catpvf(aTHX_ report, "(ival=%"IVdf")", (IV)lvalp->ival);
419 case TOKENTYPE_OPNUM:
420 Perl_sv_catpvf(aTHX_ report, "(ival=op_%s)",
421 PL_op_name[lvalp->ival]);
424 Perl_sv_catpvf(aTHX_ report, "(pval=\"%s\")", lvalp->pval);
426 case TOKENTYPE_OPVAL:
428 Perl_sv_catpvf(aTHX_ report, "(opval=op_%s)",
429 PL_op_name[lvalp->opval->op_type]);
430 if (lvalp->opval->op_type == OP_CONST) {
431 Perl_sv_catpvf(aTHX_ report, " %s",
432 SvPEEK(cSVOPx_sv(lvalp->opval)));
437 sv_catpvs(report, "(opval=null)");
440 PerlIO_printf(Perl_debug_log, "### %s\n\n", SvPV_nolen_const(report));
446 /* print the buffer with suitable escapes */
449 S_printbuf(pTHX_ const char *const fmt, const char *const s)
451 SV* const tmp = newSVpvs("");
453 PERL_ARGS_ASSERT_PRINTBUF;
455 GCC_DIAG_IGNORE(-Wformat-nonliteral); /* fmt checked by caller */
456 PerlIO_printf(Perl_debug_log, fmt, pv_display(tmp, s, strlen(s), 0, 60));
464 S_deprecate_commaless_var_list(pTHX) {
466 deprecate("comma-less variable list");
467 return REPORT(','); /* grandfather non-comma-format format */
473 * This subroutine looks for an '=' next to the operator that has just been
474 * parsed and turns it into an ASSIGNOP if it finds one.
478 S_ao(pTHX_ int toketype)
480 if (*PL_bufptr == '=') {
482 if (toketype == ANDAND)
483 pl_yylval.ival = OP_ANDASSIGN;
484 else if (toketype == OROR)
485 pl_yylval.ival = OP_ORASSIGN;
486 else if (toketype == DORDOR)
487 pl_yylval.ival = OP_DORASSIGN;
490 return REPORT(toketype);
495 * When Perl expects an operator and finds something else, no_op
496 * prints the warning. It always prints "<something> found where
497 * operator expected. It prints "Missing semicolon on previous line?"
498 * if the surprise occurs at the start of the line. "do you need to
499 * predeclare ..." is printed out for code like "sub bar; foo bar $x"
500 * where the compiler doesn't know if foo is a method call or a function.
501 * It prints "Missing operator before end of line" if there's nothing
502 * after the missing operator, or "... before <...>" if there is something
503 * after the missing operator.
505 * PL_bufptr is expected to point to the start of the thing that was found,
506 * and s after the next token or partial token.
510 S_no_op(pTHX_ const char *const what, char *s)
512 char * const oldbp = PL_bufptr;
513 const bool is_first = (PL_oldbufptr == PL_linestart);
515 PERL_ARGS_ASSERT_NO_OP;
521 yywarn(Perl_form(aTHX_ "%s found where operator expected", what), UTF ? SVf_UTF8 : 0);
522 if (ckWARN_d(WARN_SYNTAX)) {
524 Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
525 "\t(Missing semicolon on previous line?)\n");
526 else if (PL_oldoldbufptr && isIDFIRST_lazy_if(PL_oldoldbufptr,UTF)) {
528 for (t = PL_oldoldbufptr; (isWORDCHAR_lazy_if(t,UTF) || *t == ':');
529 t += UTF ? UTF8SKIP(t) : 1)
531 if (t < PL_bufptr && isSPACE(*t))
532 Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
533 "\t(Do you need to predeclare %"UTF8f"?)\n",
534 UTF8fARG(UTF, t - PL_oldoldbufptr, PL_oldoldbufptr));
538 Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
539 "\t(Missing operator before %"UTF8f"?)\n",
540 UTF8fARG(UTF, s - oldbp, oldbp));
548 * Complain about missing quote/regexp/heredoc terminator.
549 * If it's called with NULL then it cauterizes the line buffer.
550 * If we're in a delimited string and the delimiter is a control
551 * character, it's reformatted into a two-char sequence like ^C.
556 S_missingterm(pTHX_ char *s)
561 char * const nl = strrchr(s,'\n');
565 else if ((U8) PL_multi_close < 32) {
567 tmpbuf[1] = (char)toCTRL(PL_multi_close);
572 *tmpbuf = (char)PL_multi_close;
576 q = strchr(s,'"') ? '\'' : '"';
577 Perl_croak(aTHX_ "Can't find string terminator %c%s%c anywhere before EOF",q,s,q);
583 * Check whether the named feature is enabled.
586 Perl_feature_is_enabled(pTHX_ const char *const name, STRLEN namelen)
588 char he_name[8 + MAX_FEATURE_LEN] = "feature_";
590 PERL_ARGS_ASSERT_FEATURE_IS_ENABLED;
592 assert(CURRENT_FEATURE_BUNDLE == FEATURE_BUNDLE_CUSTOM);
594 if (namelen > MAX_FEATURE_LEN)
596 memcpy(&he_name[8], name, namelen);
598 return cBOOL(cop_hints_fetch_pvn(PL_curcop, he_name, 8 + namelen, 0,
599 REFCOUNTED_HE_EXISTS));
603 * experimental text filters for win32 carriage-returns, utf16-to-utf8 and
604 * utf16-to-utf8-reversed.
607 #ifdef PERL_CR_FILTER
611 const char *s = SvPVX_const(sv);
612 const char * const e = s + SvCUR(sv);
614 PERL_ARGS_ASSERT_STRIP_RETURN;
616 /* outer loop optimized to do nothing if there are no CR-LFs */
618 if (*s++ == '\r' && *s == '\n') {
619 /* hit a CR-LF, need to copy the rest */
623 if (*s == '\r' && s[1] == '\n')
634 S_cr_textfilter(pTHX_ int idx, SV *sv, int maxlen)
636 const I32 count = FILTER_READ(idx+1, sv, maxlen);
637 if (count > 0 && !maxlen)
644 =for apidoc Amx|void|lex_start|SV *line|PerlIO *rsfp|U32 flags
646 Creates and initialises a new lexer/parser state object, supplying
647 a context in which to lex and parse from a new source of Perl code.
648 A pointer to the new state object is placed in L</PL_parser>. An entry
649 is made on the save stack so that upon unwinding the new state object
650 will be destroyed and the former value of L</PL_parser> will be restored.
651 Nothing else need be done to clean up the parsing context.
653 The code to be parsed comes from C<line> and C<rsfp>. C<line>, if
654 non-null, provides a string (in SV form) containing code to be parsed.
655 A copy of the string is made, so subsequent modification of C<line>
656 does not affect parsing. C<rsfp>, if non-null, provides an input stream
657 from which code will be read to be parsed. If both are non-null, the
658 code in C<line> comes first and must consist of complete lines of input,
659 and C<rsfp> supplies the remainder of the source.
661 The C<flags> parameter is reserved for future use. Currently it is only
662 used by perl internally, so extensions should always pass zero.
667 /* LEX_START_SAME_FILTER indicates that this is not a new file, so it
668 can share filters with the current parser.
669 LEX_START_DONT_CLOSE indicates that the file handle wasn't opened by the
670 caller, hence isn't owned by the parser, so shouldn't be closed on parser
671 destruction. This is used to handle the case of defaulting to reading the
672 script from the standard input because no filename was given on the command
673 line (without getting confused by situation where STDIN has been closed, so
674 the script handle is opened on fd 0) */
677 Perl_lex_start(pTHX_ SV *line, PerlIO *rsfp, U32 flags)
679 const char *s = NULL;
680 yy_parser *parser, *oparser;
681 if (flags && flags & ~LEX_START_FLAGS)
682 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_start");
684 /* create and initialise a parser */
686 Newxz(parser, 1, yy_parser);
687 parser->old_parser = oparser = PL_parser;
690 parser->stack = NULL;
692 parser->stack_size = 0;
694 /* on scope exit, free this parser and restore any outer one */
696 parser->saved_curcop = PL_curcop;
698 /* initialise lexer state */
700 parser->nexttoke = 0;
701 parser->error_count = oparser ? oparser->error_count : 0;
702 parser->copline = parser->preambling = NOLINE;
703 parser->lex_state = LEX_NORMAL;
704 parser->expect = XSTATE;
706 parser->rsfp_filters =
707 !(flags & LEX_START_SAME_FILTER) || !oparser
709 : MUTABLE_AV(SvREFCNT_inc(
710 oparser->rsfp_filters
711 ? oparser->rsfp_filters
712 : (oparser->rsfp_filters = newAV())
715 Newx(parser->lex_brackstack, 120, char);
716 Newx(parser->lex_casestack, 12, char);
717 *parser->lex_casestack = '\0';
718 Newxz(parser->lex_shared, 1, LEXSHARED);
722 s = SvPV_const(line, len);
723 parser->linestr = flags & LEX_START_COPIED
724 ? SvREFCNT_inc_simple_NN(line)
725 : newSVpvn_flags(s, len, SvUTF8(line));
726 sv_catpvn(parser->linestr, "\n;", rsfp ? 1 : 2);
728 parser->linestr = newSVpvn("\n;", rsfp ? 1 : 2);
730 parser->oldoldbufptr =
733 parser->linestart = SvPVX(parser->linestr);
734 parser->bufend = parser->bufptr + SvCUR(parser->linestr);
735 parser->last_lop = parser->last_uni = NULL;
737 STATIC_ASSERT_STMT(FITS_IN_8_BITS(LEX_IGNORE_UTF8_HINTS|LEX_EVALBYTES
738 |LEX_DONT_CLOSE_RSFP));
739 parser->lex_flags = (U8) (flags & (LEX_IGNORE_UTF8_HINTS|LEX_EVALBYTES
740 |LEX_DONT_CLOSE_RSFP));
742 parser->in_pod = parser->filtered = 0;
746 /* delete a parser object */
749 Perl_parser_free(pTHX_ const yy_parser *parser)
751 PERL_ARGS_ASSERT_PARSER_FREE;
753 PL_curcop = parser->saved_curcop;
754 SvREFCNT_dec(parser->linestr);
756 if (PL_parser->lex_flags & LEX_DONT_CLOSE_RSFP)
757 PerlIO_clearerr(parser->rsfp);
758 else if (parser->rsfp && (!parser->old_parser
759 || (parser->old_parser && parser->rsfp != parser->old_parser->rsfp)))
760 PerlIO_close(parser->rsfp);
761 SvREFCNT_dec(parser->rsfp_filters);
762 SvREFCNT_dec(parser->lex_stuff);
763 SvREFCNT_dec(parser->sublex_info.repl);
765 Safefree(parser->lex_brackstack);
766 Safefree(parser->lex_casestack);
767 Safefree(parser->lex_shared);
768 PL_parser = parser->old_parser;
773 Perl_parser_free_nexttoke_ops(pTHX_ yy_parser *parser, OPSLAB *slab)
775 I32 nexttoke = parser->nexttoke;
776 PERL_ARGS_ASSERT_PARSER_FREE_NEXTTOKE_OPS;
778 if (S_is_opval_token(parser->nexttype[nexttoke] & 0xffff)
779 && parser->nextval[nexttoke].opval
780 && parser->nextval[nexttoke].opval->op_slabbed
781 && OpSLAB(parser->nextval[nexttoke].opval) == slab) {
782 op_free(parser->nextval[nexttoke].opval);
783 parser->nextval[nexttoke].opval = NULL;
790 =for apidoc AmxU|SV *|PL_parser-E<gt>linestr
792 Buffer scalar containing the chunk currently under consideration of the
793 text currently being lexed. This is always a plain string scalar (for
794 which C<SvPOK> is true). It is not intended to be used as a scalar by
795 normal scalar means; instead refer to the buffer directly by the pointer
796 variables described below.
798 The lexer maintains various C<char*> pointers to things in the
799 C<PL_parser-E<gt>linestr> buffer. If C<PL_parser-E<gt>linestr> is ever
800 reallocated, all of these pointers must be updated. Don't attempt to
801 do this manually, but rather use L</lex_grow_linestr> if you need to
802 reallocate the buffer.
804 The content of the text chunk in the buffer is commonly exactly one
805 complete line of input, up to and including a newline terminator,
806 but there are situations where it is otherwise. The octets of the
807 buffer may be intended to be interpreted as either UTF-8 or Latin-1.
808 The function L</lex_bufutf8> tells you which. Do not use the C<SvUTF8>
809 flag on this scalar, which may disagree with it.
811 For direct examination of the buffer, the variable
812 L</PL_parser-E<gt>bufend> points to the end of the buffer. The current
813 lexing position is pointed to by L</PL_parser-E<gt>bufptr>. Direct use
814 of these pointers is usually preferable to examination of the scalar
815 through normal scalar means.
817 =for apidoc AmxU|char *|PL_parser-E<gt>bufend
819 Direct pointer to the end of the chunk of text currently being lexed, the
820 end of the lexer buffer. This is equal to C<SvPVX(PL_parser-E<gt>linestr)
821 + SvCUR(PL_parser-E<gt>linestr)>. A C<NUL> character (zero octet) is
822 always located at the end of the buffer, and does not count as part of
823 the buffer's contents.
825 =for apidoc AmxU|char *|PL_parser-E<gt>bufptr
827 Points to the current position of lexing inside the lexer buffer.
828 Characters around this point may be freely examined, within
829 the range delimited by C<SvPVX(L</PL_parser-E<gt>linestr>)> and
830 L</PL_parser-E<gt>bufend>. The octets of the buffer may be intended to be
831 interpreted as either UTF-8 or Latin-1, as indicated by L</lex_bufutf8>.
833 Lexing code (whether in the Perl core or not) moves this pointer past
834 the characters that it consumes. It is also expected to perform some
835 bookkeeping whenever a newline character is consumed. This movement
836 can be more conveniently performed by the function L</lex_read_to>,
837 which handles newlines appropriately.
839 Interpretation of the buffer's octets can be abstracted out by
840 using the slightly higher-level functions L</lex_peek_unichar> and
841 L</lex_read_unichar>.
843 =for apidoc AmxU|char *|PL_parser-E<gt>linestart
845 Points to the start of the current line inside the lexer buffer.
846 This is useful for indicating at which column an error occurred, and
847 not much else. This must be updated by any lexing code that consumes
848 a newline; the function L</lex_read_to> handles this detail.
854 =for apidoc Amx|bool|lex_bufutf8
856 Indicates whether the octets in the lexer buffer
857 (L</PL_parser-E<gt>linestr>) should be interpreted as the UTF-8 encoding
858 of Unicode characters. If not, they should be interpreted as Latin-1
859 characters. This is analogous to the C<SvUTF8> flag for scalars.
861 In UTF-8 mode, it is not guaranteed that the lexer buffer actually
862 contains valid UTF-8. Lexing code must be robust in the face of invalid
865 The actual C<SvUTF8> flag of the L</PL_parser-E<gt>linestr> scalar
866 is significant, but not the whole story regarding the input character
867 encoding. Normally, when a file is being read, the scalar contains octets
868 and its C<SvUTF8> flag is off, but the octets should be interpreted as
869 UTF-8 if the C<use utf8> pragma is in effect. During a string eval,
870 however, the scalar may have the C<SvUTF8> flag on, and in this case its
871 octets should be interpreted as UTF-8 unless the C<use bytes> pragma
872 is in effect. This logic may change in the future; use this function
873 instead of implementing the logic yourself.
879 Perl_lex_bufutf8(pTHX)
885 =for apidoc Amx|char *|lex_grow_linestr|STRLEN len
887 Reallocates the lexer buffer (L</PL_parser-E<gt>linestr>) to accommodate
888 at least C<len> octets (including terminating C<NUL>). Returns a
889 pointer to the reallocated buffer. This is necessary before making
890 any direct modification of the buffer that would increase its length.
891 L</lex_stuff_pvn> provides a more convenient way to insert text into
894 Do not use C<SvGROW> or C<sv_grow> directly on C<PL_parser-E<gt>linestr>;
895 this function updates all of the lexer's variables that point directly
902 Perl_lex_grow_linestr(pTHX_ STRLEN len)
906 STRLEN bufend_pos, bufptr_pos, oldbufptr_pos, oldoldbufptr_pos;
907 STRLEN linestart_pos, last_uni_pos, last_lop_pos, re_eval_start_pos;
908 linestr = PL_parser->linestr;
909 buf = SvPVX(linestr);
910 if (len <= SvLEN(linestr))
912 bufend_pos = PL_parser->bufend - buf;
913 bufptr_pos = PL_parser->bufptr - buf;
914 oldbufptr_pos = PL_parser->oldbufptr - buf;
915 oldoldbufptr_pos = PL_parser->oldoldbufptr - buf;
916 linestart_pos = PL_parser->linestart - buf;
917 last_uni_pos = PL_parser->last_uni ? PL_parser->last_uni - buf : 0;
918 last_lop_pos = PL_parser->last_lop ? PL_parser->last_lop - buf : 0;
919 re_eval_start_pos = PL_parser->lex_shared->re_eval_start ?
920 PL_parser->lex_shared->re_eval_start - buf : 0;
922 buf = sv_grow(linestr, len);
924 PL_parser->bufend = buf + bufend_pos;
925 PL_parser->bufptr = buf + bufptr_pos;
926 PL_parser->oldbufptr = buf + oldbufptr_pos;
927 PL_parser->oldoldbufptr = buf + oldoldbufptr_pos;
928 PL_parser->linestart = buf + linestart_pos;
929 if (PL_parser->last_uni)
930 PL_parser->last_uni = buf + last_uni_pos;
931 if (PL_parser->last_lop)
932 PL_parser->last_lop = buf + last_lop_pos;
933 if (PL_parser->lex_shared->re_eval_start)
934 PL_parser->lex_shared->re_eval_start = buf + re_eval_start_pos;
939 =for apidoc Amx|void|lex_stuff_pvn|const char *pv|STRLEN len|U32 flags
941 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
942 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
943 reallocating the buffer if necessary. This means that lexing code that
944 runs later will see the characters as if they had appeared in the input.
945 It is not recommended to do this as part of normal parsing, and most
946 uses of this facility run the risk of the inserted characters being
947 interpreted in an unintended manner.
949 The string to be inserted is represented by C<len> octets starting
950 at C<pv>. These octets are interpreted as either UTF-8 or Latin-1,
951 according to whether the C<LEX_STUFF_UTF8> flag is set in C<flags>.
952 The characters are recoded for the lexer buffer, according to how the
953 buffer is currently being interpreted (L</lex_bufutf8>). If a string
954 to be inserted is available as a Perl scalar, the L</lex_stuff_sv>
955 function is more convenient.
961 Perl_lex_stuff_pvn(pTHX_ const char *pv, STRLEN len, U32 flags)
965 PERL_ARGS_ASSERT_LEX_STUFF_PVN;
966 if (flags & ~(LEX_STUFF_UTF8))
967 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_stuff_pvn");
969 if (flags & LEX_STUFF_UTF8) {
972 STRLEN highhalf = 0; /* Count of variants */
973 const char *p, *e = pv+len;
974 for (p = pv; p != e; p++) {
975 if (! UTF8_IS_INVARIANT(*p)) {
981 lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len+highhalf);
982 bufptr = PL_parser->bufptr;
983 Move(bufptr, bufptr+len+highhalf, PL_parser->bufend+1-bufptr, char);
984 SvCUR_set(PL_parser->linestr,
985 SvCUR(PL_parser->linestr) + len+highhalf);
986 PL_parser->bufend += len+highhalf;
987 for (p = pv; p != e; p++) {
989 if (! UTF8_IS_INVARIANT(c)) {
990 *bufptr++ = UTF8_TWO_BYTE_HI(c);
991 *bufptr++ = UTF8_TWO_BYTE_LO(c);
998 if (flags & LEX_STUFF_UTF8) {
1000 const char *p, *e = pv+len;
1001 for (p = pv; p != e; p++) {
1003 if (UTF8_IS_ABOVE_LATIN1(c)) {
1004 Perl_croak(aTHX_ "Lexing code attempted to stuff "
1005 "non-Latin-1 character into Latin-1 input");
1006 } else if (UTF8_IS_NEXT_CHAR_DOWNGRADEABLE(p, e)) {
1009 } else if (! UTF8_IS_INVARIANT(c)) {
1010 /* malformed UTF-8 */
1012 SAVESPTR(PL_warnhook);
1013 PL_warnhook = PERL_WARNHOOK_FATAL;
1014 utf8n_to_uvchr((U8*)p, e-p, NULL, 0);
1020 lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len-highhalf);
1021 bufptr = PL_parser->bufptr;
1022 Move(bufptr, bufptr+len-highhalf, PL_parser->bufend+1-bufptr, char);
1023 SvCUR_set(PL_parser->linestr,
1024 SvCUR(PL_parser->linestr) + len-highhalf);
1025 PL_parser->bufend += len-highhalf;
1028 if (UTF8_IS_INVARIANT(*p)) {
1034 *bufptr++ = EIGHT_BIT_UTF8_TO_NATIVE(*p, *(p+1));
1040 lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len);
1041 bufptr = PL_parser->bufptr;
1042 Move(bufptr, bufptr+len, PL_parser->bufend+1-bufptr, char);
1043 SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) + len);
1044 PL_parser->bufend += len;
1045 Copy(pv, bufptr, len, char);
1051 =for apidoc Amx|void|lex_stuff_pv|const char *pv|U32 flags
1053 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
1054 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
1055 reallocating the buffer if necessary. This means that lexing code that
1056 runs later will see the characters as if they had appeared in the input.
1057 It is not recommended to do this as part of normal parsing, and most
1058 uses of this facility run the risk of the inserted characters being
1059 interpreted in an unintended manner.
1061 The string to be inserted is represented by octets starting at C<pv>
1062 and continuing to the first nul. These octets are interpreted as either
1063 UTF-8 or Latin-1, according to whether the C<LEX_STUFF_UTF8> flag is set
1064 in C<flags>. The characters are recoded for the lexer buffer, according
1065 to how the buffer is currently being interpreted (L</lex_bufutf8>).
1066 If it is not convenient to nul-terminate a string to be inserted, the
1067 L</lex_stuff_pvn> function is more appropriate.
1073 Perl_lex_stuff_pv(pTHX_ const char *pv, U32 flags)
1075 PERL_ARGS_ASSERT_LEX_STUFF_PV;
1076 lex_stuff_pvn(pv, strlen(pv), flags);
1080 =for apidoc Amx|void|lex_stuff_sv|SV *sv|U32 flags
1082 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
1083 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
1084 reallocating the buffer if necessary. This means that lexing code that
1085 runs later will see the characters as if they had appeared in the input.
1086 It is not recommended to do this as part of normal parsing, and most
1087 uses of this facility run the risk of the inserted characters being
1088 interpreted in an unintended manner.
1090 The string to be inserted is the string value of C<sv>. The characters
1091 are recoded for the lexer buffer, according to how the buffer is currently
1092 being interpreted (L</lex_bufutf8>). If a string to be inserted is
1093 not already a Perl scalar, the L</lex_stuff_pvn> function avoids the
1094 need to construct a scalar.
1100 Perl_lex_stuff_sv(pTHX_ SV *sv, U32 flags)
1104 PERL_ARGS_ASSERT_LEX_STUFF_SV;
1106 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_stuff_sv");
1108 lex_stuff_pvn(pv, len, flags | (SvUTF8(sv) ? LEX_STUFF_UTF8 : 0));
1112 =for apidoc Amx|void|lex_unstuff|char *ptr
1114 Discards text about to be lexed, from L</PL_parser-E<gt>bufptr> up to
1115 C<ptr>. Text following C<ptr> will be moved, and the buffer shortened.
1116 This hides the discarded text from any lexing code that runs later,
1117 as if the text had never appeared.
1119 This is not the normal way to consume lexed text. For that, use
1126 Perl_lex_unstuff(pTHX_ char *ptr)
1130 PERL_ARGS_ASSERT_LEX_UNSTUFF;
1131 buf = PL_parser->bufptr;
1133 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_unstuff");
1136 bufend = PL_parser->bufend;
1138 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_unstuff");
1139 unstuff_len = ptr - buf;
1140 Move(ptr, buf, bufend+1-ptr, char);
1141 SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) - unstuff_len);
1142 PL_parser->bufend = bufend - unstuff_len;
1146 =for apidoc Amx|void|lex_read_to|char *ptr
1148 Consume text in the lexer buffer, from L</PL_parser-E<gt>bufptr> up
1149 to C<ptr>. This advances L</PL_parser-E<gt>bufptr> to match C<ptr>,
1150 performing the correct bookkeeping whenever a newline character is passed.
1151 This is the normal way to consume lexed text.
1153 Interpretation of the buffer's octets can be abstracted out by
1154 using the slightly higher-level functions L</lex_peek_unichar> and
1155 L</lex_read_unichar>.
1161 Perl_lex_read_to(pTHX_ char *ptr)
1164 PERL_ARGS_ASSERT_LEX_READ_TO;
1165 s = PL_parser->bufptr;
1166 if (ptr < s || ptr > PL_parser->bufend)
1167 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_to");
1168 for (; s != ptr; s++)
1170 COPLINE_INC_WITH_HERELINES;
1171 PL_parser->linestart = s+1;
1173 PL_parser->bufptr = ptr;
1177 =for apidoc Amx|void|lex_discard_to|char *ptr
1179 Discards the first part of the L</PL_parser-E<gt>linestr> buffer,
1180 up to C<ptr>. The remaining content of the buffer will be moved, and
1181 all pointers into the buffer updated appropriately. C<ptr> must not
1182 be later in the buffer than the position of L</PL_parser-E<gt>bufptr>:
1183 it is not permitted to discard text that has yet to be lexed.
1185 Normally it is not necessarily to do this directly, because it suffices to
1186 use the implicit discarding behaviour of L</lex_next_chunk> and things
1187 based on it. However, if a token stretches across multiple lines,
1188 and the lexing code has kept multiple lines of text in the buffer for
1189 that purpose, then after completion of the token it would be wise to
1190 explicitly discard the now-unneeded earlier lines, to avoid future
1191 multi-line tokens growing the buffer without bound.
1197 Perl_lex_discard_to(pTHX_ char *ptr)
1201 PERL_ARGS_ASSERT_LEX_DISCARD_TO;
1202 buf = SvPVX(PL_parser->linestr);
1204 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_discard_to");
1207 if (ptr > PL_parser->bufptr)
1208 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_discard_to");
1209 discard_len = ptr - buf;
1210 if (PL_parser->oldbufptr < ptr)
1211 PL_parser->oldbufptr = ptr;
1212 if (PL_parser->oldoldbufptr < ptr)
1213 PL_parser->oldoldbufptr = ptr;
1214 if (PL_parser->last_uni && PL_parser->last_uni < ptr)
1215 PL_parser->last_uni = NULL;
1216 if (PL_parser->last_lop && PL_parser->last_lop < ptr)
1217 PL_parser->last_lop = NULL;
1218 Move(ptr, buf, PL_parser->bufend+1-ptr, char);
1219 SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) - discard_len);
1220 PL_parser->bufend -= discard_len;
1221 PL_parser->bufptr -= discard_len;
1222 PL_parser->oldbufptr -= discard_len;
1223 PL_parser->oldoldbufptr -= discard_len;
1224 if (PL_parser->last_uni)
1225 PL_parser->last_uni -= discard_len;
1226 if (PL_parser->last_lop)
1227 PL_parser->last_lop -= discard_len;
1231 =for apidoc Amx|bool|lex_next_chunk|U32 flags
1233 Reads in the next chunk of text to be lexed, appending it to
1234 L</PL_parser-E<gt>linestr>. This should be called when lexing code has
1235 looked to the end of the current chunk and wants to know more. It is
1236 usual, but not necessary, for lexing to have consumed the entirety of
1237 the current chunk at this time.
1239 If L</PL_parser-E<gt>bufptr> is pointing to the very end of the current
1240 chunk (i.e., the current chunk has been entirely consumed), normally the
1241 current chunk will be discarded at the same time that the new chunk is
1242 read in. If C<flags> has the C<LEX_KEEP_PREVIOUS> bit set, the current chunk
1243 will not be discarded. If the current chunk has not been entirely
1244 consumed, then it will not be discarded regardless of the flag.
1246 Returns true if some new text was added to the buffer, or false if the
1247 buffer has reached the end of the input text.
1252 #define LEX_FAKE_EOF 0x80000000
1253 #define LEX_NO_TERM 0x40000000 /* here-doc */
1256 Perl_lex_next_chunk(pTHX_ U32 flags)
1260 STRLEN old_bufend_pos, new_bufend_pos;
1261 STRLEN bufptr_pos, oldbufptr_pos, oldoldbufptr_pos;
1262 STRLEN linestart_pos, last_uni_pos, last_lop_pos;
1263 bool got_some_for_debugger = 0;
1265 if (flags & ~(LEX_KEEP_PREVIOUS|LEX_FAKE_EOF|LEX_NO_TERM))
1266 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_next_chunk");
1267 if (!(flags & LEX_NO_TERM) && PL_lex_inwhat)
1269 linestr = PL_parser->linestr;
1270 buf = SvPVX(linestr);
1271 if (!(flags & LEX_KEEP_PREVIOUS)
1272 && PL_parser->bufptr == PL_parser->bufend)
1274 old_bufend_pos = bufptr_pos = oldbufptr_pos = oldoldbufptr_pos = 0;
1276 if (PL_parser->last_uni != PL_parser->bufend)
1277 PL_parser->last_uni = NULL;
1278 if (PL_parser->last_lop != PL_parser->bufend)
1279 PL_parser->last_lop = NULL;
1280 last_uni_pos = last_lop_pos = 0;
1284 old_bufend_pos = PL_parser->bufend - buf;
1285 bufptr_pos = PL_parser->bufptr - buf;
1286 oldbufptr_pos = PL_parser->oldbufptr - buf;
1287 oldoldbufptr_pos = PL_parser->oldoldbufptr - buf;
1288 linestart_pos = PL_parser->linestart - buf;
1289 last_uni_pos = PL_parser->last_uni ? PL_parser->last_uni - buf : 0;
1290 last_lop_pos = PL_parser->last_lop ? PL_parser->last_lop - buf : 0;
1292 if (flags & LEX_FAKE_EOF) {
1294 } else if (!PL_parser->rsfp && !PL_parser->filtered) {
1296 } else if (filter_gets(linestr, old_bufend_pos)) {
1298 got_some_for_debugger = 1;
1299 } else if (flags & LEX_NO_TERM) {
1302 if (!SvPOK(linestr)) /* can get undefined by filter_gets */
1303 sv_setpvs(linestr, "");
1305 /* End of real input. Close filehandle (unless it was STDIN),
1306 * then add implicit termination.
1308 if (PL_parser->lex_flags & LEX_DONT_CLOSE_RSFP)
1309 PerlIO_clearerr(PL_parser->rsfp);
1310 else if (PL_parser->rsfp)
1311 (void)PerlIO_close(PL_parser->rsfp);
1312 PL_parser->rsfp = NULL;
1313 PL_parser->in_pod = PL_parser->filtered = 0;
1314 if (!PL_in_eval && PL_minus_p) {
1316 /*{*/";}continue{print or die qq(-p destination: $!\\n);}");
1317 PL_minus_n = PL_minus_p = 0;
1318 } else if (!PL_in_eval && PL_minus_n) {
1319 sv_catpvs(linestr, /*{*/";}");
1322 sv_catpvs(linestr, ";");
1325 buf = SvPVX(linestr);
1326 new_bufend_pos = SvCUR(linestr);
1327 PL_parser->bufend = buf + new_bufend_pos;
1328 PL_parser->bufptr = buf + bufptr_pos;
1329 PL_parser->oldbufptr = buf + oldbufptr_pos;
1330 PL_parser->oldoldbufptr = buf + oldoldbufptr_pos;
1331 PL_parser->linestart = buf + linestart_pos;
1332 if (PL_parser->last_uni)
1333 PL_parser->last_uni = buf + last_uni_pos;
1334 if (PL_parser->last_lop)
1335 PL_parser->last_lop = buf + last_lop_pos;
1336 if (PL_parser->preambling != NOLINE) {
1337 CopLINE_set(PL_curcop, PL_parser->preambling + 1);
1338 PL_parser->preambling = NOLINE;
1340 if ( got_some_for_debugger
1341 && PERLDB_LINE_OR_SAVESRC
1342 && PL_curstash != PL_debstash)
1344 /* debugger active and we're not compiling the debugger code,
1345 * so store the line into the debugger's array of lines
1347 update_debugger_info(NULL, buf+old_bufend_pos,
1348 new_bufend_pos-old_bufend_pos);
1354 =for apidoc Amx|I32|lex_peek_unichar|U32 flags
1356 Looks ahead one (Unicode) character in the text currently being lexed.
1357 Returns the codepoint (unsigned integer value) of the next character,
1358 or -1 if lexing has reached the end of the input text. To consume the
1359 peeked character, use L</lex_read_unichar>.
1361 If the next character is in (or extends into) the next chunk of input
1362 text, the next chunk will be read in. Normally the current chunk will be
1363 discarded at the same time, but if C<flags> has the C<LEX_KEEP_PREVIOUS>
1364 bit set, then the current chunk will not be discarded.
1366 If the input is being interpreted as UTF-8 and a UTF-8 encoding error
1367 is encountered, an exception is generated.
1373 Perl_lex_peek_unichar(pTHX_ U32 flags)
1377 if (flags & ~(LEX_KEEP_PREVIOUS))
1378 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_peek_unichar");
1379 s = PL_parser->bufptr;
1380 bufend = PL_parser->bufend;
1386 if (!lex_next_chunk(flags))
1388 s = PL_parser->bufptr;
1389 bufend = PL_parser->bufend;
1392 if (UTF8_IS_INVARIANT(head))
1394 if (UTF8_IS_START(head)) {
1395 len = UTF8SKIP(&head);
1396 while ((STRLEN)(bufend-s) < len) {
1397 if (!lex_next_chunk(flags | LEX_KEEP_PREVIOUS))
1399 s = PL_parser->bufptr;
1400 bufend = PL_parser->bufend;
1403 unichar = utf8n_to_uvchr((U8*)s, bufend-s, &retlen, UTF8_CHECK_ONLY);
1404 if (retlen == (STRLEN)-1) {
1405 /* malformed UTF-8 */
1407 SAVESPTR(PL_warnhook);
1408 PL_warnhook = PERL_WARNHOOK_FATAL;
1409 utf8n_to_uvchr((U8*)s, bufend-s, NULL, 0);
1415 if (!lex_next_chunk(flags))
1417 s = PL_parser->bufptr;
1424 =for apidoc Amx|I32|lex_read_unichar|U32 flags
1426 Reads the next (Unicode) character in the text currently being lexed.
1427 Returns the codepoint (unsigned integer value) of the character read,
1428 and moves L</PL_parser-E<gt>bufptr> past the character, or returns -1
1429 if lexing has reached the end of the input text. To non-destructively
1430 examine the next character, use L</lex_peek_unichar> instead.
1432 If the next character is in (or extends into) the next chunk of input
1433 text, the next chunk will be read in. Normally the current chunk will be
1434 discarded at the same time, but if C<flags> has the C<LEX_KEEP_PREVIOUS>
1435 bit set, then the current chunk will not be discarded.
1437 If the input is being interpreted as UTF-8 and a UTF-8 encoding error
1438 is encountered, an exception is generated.
1444 Perl_lex_read_unichar(pTHX_ U32 flags)
1447 if (flags & ~(LEX_KEEP_PREVIOUS))
1448 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_unichar");
1449 c = lex_peek_unichar(flags);
1452 COPLINE_INC_WITH_HERELINES;
1454 PL_parser->bufptr += UTF8SKIP(PL_parser->bufptr);
1456 ++(PL_parser->bufptr);
1462 =for apidoc Amx|void|lex_read_space|U32 flags
1464 Reads optional spaces, in Perl style, in the text currently being
1465 lexed. The spaces may include ordinary whitespace characters and
1466 Perl-style comments. C<#line> directives are processed if encountered.
1467 L</PL_parser-E<gt>bufptr> is moved past the spaces, so that it points
1468 at a non-space character (or the end of the input text).
1470 If spaces extend into the next chunk of input text, the next chunk will
1471 be read in. Normally the current chunk will be discarded at the same
1472 time, but if C<flags> has the C<LEX_KEEP_PREVIOUS> bit set, then the current
1473 chunk will not be discarded.
1478 #define LEX_NO_INCLINE 0x40000000
1479 #define LEX_NO_NEXT_CHUNK 0x80000000
1482 Perl_lex_read_space(pTHX_ U32 flags)
1485 const bool can_incline = !(flags & LEX_NO_INCLINE);
1486 bool need_incline = 0;
1487 if (flags & ~(LEX_KEEP_PREVIOUS|LEX_NO_NEXT_CHUNK|LEX_NO_INCLINE))
1488 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_space");
1489 s = PL_parser->bufptr;
1490 bufend = PL_parser->bufend;
1496 } while (!(c == '\n' || (c == 0 && s == bufend)));
1497 } else if (c == '\n') {
1500 PL_parser->linestart = s;
1506 } else if (isSPACE(c)) {
1508 } else if (c == 0 && s == bufend) {
1511 if (flags & LEX_NO_NEXT_CHUNK)
1513 PL_parser->bufptr = s;
1514 l = CopLINE(PL_curcop);
1515 CopLINE(PL_curcop) += PL_parser->herelines + 1;
1516 got_more = lex_next_chunk(flags);
1517 CopLINE_set(PL_curcop, l);
1518 s = PL_parser->bufptr;
1519 bufend = PL_parser->bufend;
1522 if (can_incline && need_incline && PL_parser->rsfp) {
1532 PL_parser->bufptr = s;
1537 =for apidoc EXMp|bool|validate_proto|SV *name|SV *proto|bool warn
1539 This function performs syntax checking on a prototype, C<proto>.
1540 If C<warn> is true, any illegal characters or mismatched brackets
1541 will trigger illegalproto warnings, declaring that they were
1542 detected in the prototype for C<name>.
1544 The return value is C<true> if this is a valid prototype, and
1545 C<false> if it is not, regardless of whether C<warn> was C<true> or
1548 Note that C<NULL> is a valid C<proto> and will always return C<true>.
1555 Perl_validate_proto(pTHX_ SV *name, SV *proto, bool warn)
1557 STRLEN len, origlen;
1558 char *p = proto ? SvPV(proto, len) : NULL;
1559 bool bad_proto = FALSE;
1560 bool in_brackets = FALSE;
1561 bool after_slash = FALSE;
1562 char greedy_proto = ' ';
1563 bool proto_after_greedy_proto = FALSE;
1564 bool must_be_last = FALSE;
1565 bool underscore = FALSE;
1566 bool bad_proto_after_underscore = FALSE;
1568 PERL_ARGS_ASSERT_VALIDATE_PROTO;
1574 for (; len--; p++) {
1577 proto_after_greedy_proto = TRUE;
1579 if (!strchr(";@%", *p))
1580 bad_proto_after_underscore = TRUE;
1583 if (!strchr("$@%*;[]&\\_+", *p) || *p == '\0') {
1590 in_brackets = FALSE;
1591 else if ((*p == '@' || *p == '%')
1595 must_be_last = TRUE;
1604 after_slash = FALSE;
1609 SV *tmpsv = newSVpvs_flags("", SVs_TEMP);
1612 ? sv_uni_display(tmpsv, newSVpvn_flags(p, origlen, SVs_TEMP | SVf_UTF8),
1613 origlen, UNI_DISPLAY_ISPRINT)
1614 : pv_pretty(tmpsv, p, origlen, 60, NULL, NULL, PERL_PV_ESCAPE_NONASCII);
1616 if (proto_after_greedy_proto)
1617 Perl_warner(aTHX_ packWARN(WARN_ILLEGALPROTO),
1618 "Prototype after '%c' for %"SVf" : %s",
1619 greedy_proto, SVfARG(name), p);
1621 Perl_warner(aTHX_ packWARN(WARN_ILLEGALPROTO),
1622 "Missing ']' in prototype for %"SVf" : %s",
1625 Perl_warner(aTHX_ packWARN(WARN_ILLEGALPROTO),
1626 "Illegal character in prototype for %"SVf" : %s",
1628 if (bad_proto_after_underscore)
1629 Perl_warner(aTHX_ packWARN(WARN_ILLEGALPROTO),
1630 "Illegal character after '_' in prototype for %"SVf" : %s",
1634 return (! (proto_after_greedy_proto || bad_proto) );
1639 * This subroutine has nothing to do with tilting, whether at windmills
1640 * or pinball tables. Its name is short for "increment line". It
1641 * increments the current line number in CopLINE(PL_curcop) and checks
1642 * to see whether the line starts with a comment of the form
1643 * # line 500 "foo.pm"
1644 * If so, it sets the current line number and file to the values in the comment.
1648 S_incline(pTHX_ const char *s)
1656 PERL_ARGS_ASSERT_INCLINE;
1658 COPLINE_INC_WITH_HERELINES;
1659 if (!PL_rsfp && !PL_parser->filtered && PL_lex_state == LEX_NORMAL
1660 && s+1 == PL_bufend && *s == ';') {
1661 /* fake newline in string eval */
1662 CopLINE_dec(PL_curcop);
1667 while (SPACE_OR_TAB(*s))
1669 if (strnEQ(s, "line", 4))
1673 if (SPACE_OR_TAB(*s))
1677 while (SPACE_OR_TAB(*s))
1685 if (!SPACE_OR_TAB(*s) && *s != '\r' && *s != '\n' && *s != '\0')
1687 while (SPACE_OR_TAB(*s))
1689 if (*s == '"' && (t = strchr(s+1, '"'))) {
1695 while (*t && !isSPACE(*t))
1699 while (SPACE_OR_TAB(*e) || *e == '\r' || *e == '\f')
1701 if (*e != '\n' && *e != '\0')
1702 return; /* false alarm */
1704 if (!grok_atoUV(n, &uv, &e))
1706 line_num = ((line_t)uv) - 1;
1709 const STRLEN len = t - s;
1711 if (!PL_rsfp && !PL_parser->filtered) {
1712 /* must copy *{"::_<(eval N)[oldfilename:L]"}
1713 * to *{"::_<newfilename"} */
1714 /* However, the long form of evals is only turned on by the
1715 debugger - usually they're "(eval %lu)" */
1716 GV * const cfgv = CopFILEGV(PL_curcop);
1719 STRLEN tmplen2 = len;
1723 if (tmplen2 + 2 <= sizeof smallbuf)
1726 Newx(tmpbuf2, tmplen2 + 2, char);
1731 memcpy(tmpbuf2 + 2, s, tmplen2);
1734 gv2 = *(GV**)hv_fetch(PL_defstash, tmpbuf2, tmplen2, TRUE);
1736 gv_init(gv2, PL_defstash, tmpbuf2, tmplen2, FALSE);
1737 /* adjust ${"::_<newfilename"} to store the new file name */
1738 GvSV(gv2) = newSVpvn(tmpbuf2 + 2, tmplen2 - 2);
1739 /* The line number may differ. If that is the case,
1740 alias the saved lines that are in the array.
1741 Otherwise alias the whole array. */
1742 if (CopLINE(PL_curcop) == line_num) {
1743 GvHV(gv2) = MUTABLE_HV(SvREFCNT_inc(GvHV(cfgv)));
1744 GvAV(gv2) = MUTABLE_AV(SvREFCNT_inc(GvAV(cfgv)));
1746 else if (GvAV(cfgv)) {
1747 AV * const av = GvAV(cfgv);
1748 const I32 start = CopLINE(PL_curcop)+1;
1749 I32 items = AvFILLp(av) - start;
1751 AV * const av2 = GvAVn(gv2);
1752 SV **svp = AvARRAY(av) + start;
1753 I32 l = (I32)line_num+1;
1755 av_store(av2, l++, SvREFCNT_inc(*svp++));
1760 if (tmpbuf2 != smallbuf) Safefree(tmpbuf2);
1763 CopFILE_free(PL_curcop);
1764 CopFILE_setn(PL_curcop, s, len);
1766 CopLINE_set(PL_curcop, line_num);
1769 #define skipspace(s) skipspace_flags(s, 0)
1773 S_update_debugger_info(pTHX_ SV *orig_sv, const char *const buf, STRLEN len)
1775 AV *av = CopFILEAVx(PL_curcop);
1778 if (PL_parser->preambling == NOLINE) sv = newSV_type(SVt_PVMG);
1780 sv = *av_fetch(av, 0, 1);
1781 SvUPGRADE(sv, SVt_PVMG);
1783 if (!SvPOK(sv)) sv_setpvs(sv,"");
1785 sv_catsv(sv, orig_sv);
1787 sv_catpvn(sv, buf, len);
1792 if (PL_parser->preambling == NOLINE)
1793 av_store(av, CopLINE(PL_curcop), sv);
1799 * Called to gobble the appropriate amount and type of whitespace.
1800 * Skips comments as well.
1804 S_skipspace_flags(pTHX_ char *s, U32 flags)
1806 PERL_ARGS_ASSERT_SKIPSPACE_FLAGS;
1807 if (PL_lex_formbrack && PL_lex_brackets <= PL_lex_formbrack) {
1808 while (s < PL_bufend && (SPACE_OR_TAB(*s) || !*s))
1811 STRLEN bufptr_pos = PL_bufptr - SvPVX(PL_linestr);
1813 lex_read_space(flags | LEX_KEEP_PREVIOUS |
1814 (PL_lex_inwhat || PL_lex_state == LEX_FORMLINE ?
1815 LEX_NO_NEXT_CHUNK : 0));
1817 PL_bufptr = SvPVX(PL_linestr) + bufptr_pos;
1818 if (PL_linestart > PL_bufptr)
1819 PL_bufptr = PL_linestart;
1827 * Check the unary operators to ensure there's no ambiguity in how they're
1828 * used. An ambiguous piece of code would be:
1830 * This doesn't mean rand() + 5. Because rand() is a unary operator,
1831 * the +5 is its argument.
1840 if (PL_oldoldbufptr != PL_last_uni)
1842 while (isSPACE(*PL_last_uni))
1845 while (isWORDCHAR_lazy_if(s,UTF) || *s == '-')
1846 s += UTF ? UTF8SKIP(s) : 1;
1847 if ((t = strchr(s, '(')) && t < PL_bufptr)
1850 Perl_ck_warner_d(aTHX_ packWARN(WARN_AMBIGUOUS),
1851 "Warning: Use of \"%"UTF8f"\" without parentheses is ambiguous",
1852 UTF8fARG(UTF, (int)(s - PL_last_uni), PL_last_uni));
1856 * LOP : macro to build a list operator. Its behaviour has been replaced
1857 * with a subroutine, S_lop() for which LOP is just another name.
1860 #define LOP(f,x) return lop(f,x,s)
1864 * Build a list operator (or something that might be one). The rules:
1865 * - if we have a next token, then it's a list operator (no parens) for
1866 * which the next token has already been parsed; e.g.,
1869 * - if the next thing is an opening paren, then it's a function
1870 * - else it's a list operator
1874 S_lop(pTHX_ I32 f, int x, char *s)
1876 PERL_ARGS_ASSERT_LOP;
1881 PL_last_lop = PL_oldbufptr;
1882 PL_last_lop_op = (OPCODE)f;
1887 return REPORT(FUNC);
1890 return REPORT(FUNC);
1893 if (!PL_lex_allbrackets && PL_lex_fakeeof > LEX_FAKEEOF_LOWLOGIC)
1894 PL_lex_fakeeof = LEX_FAKEEOF_LOWLOGIC;
1895 return REPORT(LSTOP);
1901 * When the lexer realizes it knows the next token (for instance,
1902 * it is reordering tokens for the parser) then it can call S_force_next
1903 * to know what token to return the next time the lexer is called. Caller
1904 * will need to set PL_nextval[] and possibly PL_expect to ensure
1905 * the lexer handles the token correctly.
1909 S_force_next(pTHX_ I32 type)
1913 PerlIO_printf(Perl_debug_log, "### forced token:\n");
1914 tokereport(type, &NEXTVAL_NEXTTOKE);
1917 assert(PL_nexttoke < C_ARRAY_LENGTH(PL_nexttype));
1918 PL_nexttype[PL_nexttoke] = type;
1925 * This subroutine handles postfix deref syntax after the arrow has already
1926 * been emitted. @* $* etc. are emitted as two separate token right here.
1927 * @[ @{ %[ %{ *{ are emitted also as two tokens, but this function emits
1928 * only the first, leaving yylex to find the next.
1932 S_postderef(pTHX_ int const funny, char const next)
1934 assert(funny == DOLSHARP || strchr("$@%&*", funny));
1936 PL_expect = XOPERATOR;
1937 if (PL_lex_state == LEX_INTERPNORMAL && !PL_lex_brackets) {
1938 assert('@' == funny || '$' == funny || DOLSHARP == funny);
1939 PL_lex_state = LEX_INTERPEND;
1941 force_next(POSTJOIN);
1947 if ('@' == funny && PL_lex_state == LEX_INTERPNORMAL
1948 && !PL_lex_brackets)
1950 PL_expect = XOPERATOR;
1959 int yyc = PL_parser->yychar;
1960 if (yyc != YYEMPTY) {
1962 NEXTVAL_NEXTTOKE = PL_parser->yylval;
1963 if (yyc == '{'/*}*/ || yyc == HASHBRACK || yyc == '['/*]*/) {
1964 PL_lex_allbrackets--;
1966 yyc |= (3<<24) | (PL_lex_brackstack[PL_lex_brackets] << 16);
1967 } else if (yyc == '('/*)*/) {
1968 PL_lex_allbrackets--;
1973 PL_parser->yychar = YYEMPTY;
1978 S_newSV_maybe_utf8(pTHX_ const char *const start, STRLEN len)
1980 SV * const sv = newSVpvn_utf8(start, len,
1983 && !is_invariant_string((const U8*)start, len)
1984 && is_utf8_string((const U8*)start, len));
1990 * When the lexer knows the next thing is a word (for instance, it has
1991 * just seen -> and it knows that the next char is a word char, then
1992 * it calls S_force_word to stick the next word into the PL_nexttoke/val
1996 * char *start : buffer position (must be within PL_linestr)
1997 * int token : PL_next* will be this type of bare word (e.g., METHOD,WORD)
1998 * int check_keyword : if true, Perl checks to make sure the word isn't
1999 * a keyword (do this if the word is a label, e.g. goto FOO)
2000 * int allow_pack : if true, : characters will also be allowed (require,
2001 * use, etc. do this)
2005 S_force_word(pTHX_ char *start, int token, int check_keyword, int allow_pack)
2010 PERL_ARGS_ASSERT_FORCE_WORD;
2012 start = skipspace(start);
2014 if (isIDFIRST_lazy_if(s,UTF)
2015 || (allow_pack && *s == ':') )
2017 s = scan_word(s, PL_tokenbuf, sizeof PL_tokenbuf, allow_pack, &len);
2018 if (check_keyword) {
2019 char *s2 = PL_tokenbuf;
2021 if (allow_pack && len > 6 && strnEQ(s2, "CORE::", 6))
2023 if (keyword(s2, len2, 0))
2026 if (token == METHOD) {
2031 PL_expect = XOPERATOR;
2034 NEXTVAL_NEXTTOKE.opval
2035 = (OP*)newSVOP(OP_CONST,0,
2036 S_newSV_maybe_utf8(aTHX_ PL_tokenbuf, len));
2037 NEXTVAL_NEXTTOKE.opval->op_private |= OPpCONST_BARE;
2045 * Called when the lexer wants $foo *foo &foo etc, but the program
2046 * text only contains the "foo" portion. The first argument is a pointer
2047 * to the "foo", and the second argument is the type symbol to prefix.
2048 * Forces the next token to be a "WORD".
2049 * Creates the symbol if it didn't already exist (via gv_fetchpv()).
2053 S_force_ident(pTHX_ const char *s, int kind)
2055 PERL_ARGS_ASSERT_FORCE_IDENT;
2058 const STRLEN len = s[1] ? strlen(s) : 1; /* s = "\"" see yylex */
2059 OP* const o = (OP*)newSVOP(OP_CONST, 0, newSVpvn_flags(s, len,
2060 UTF ? SVf_UTF8 : 0));
2061 NEXTVAL_NEXTTOKE.opval = o;
2064 o->op_private = OPpCONST_ENTERED;
2065 /* XXX see note in pp_entereval() for why we forgo typo
2066 warnings if the symbol must be introduced in an eval.
2068 gv_fetchpvn_flags(s, len,
2069 (PL_in_eval ? GV_ADDMULTI
2070 : GV_ADD) | ( UTF ? SVf_UTF8 : 0 ),
2071 kind == '$' ? SVt_PV :
2072 kind == '@' ? SVt_PVAV :
2073 kind == '%' ? SVt_PVHV :
2081 S_force_ident_maybe_lex(pTHX_ char pit)
2083 NEXTVAL_NEXTTOKE.ival = pit;
2088 Perl_str_to_version(pTHX_ SV *sv)
2093 const char *start = SvPV_const(sv,len);
2094 const char * const end = start + len;
2095 const bool utf = SvUTF8(sv) ? TRUE : FALSE;
2097 PERL_ARGS_ASSERT_STR_TO_VERSION;
2099 while (start < end) {
2103 n = utf8n_to_uvchr((U8*)start, len, &skip, 0);
2108 retval += ((NV)n)/nshift;
2117 * Forces the next token to be a version number.
2118 * If the next token appears to be an invalid version number, (e.g. "v2b"),
2119 * and if "guessing" is TRUE, then no new token is created (and the caller
2120 * must use an alternative parsing method).
2124 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)
2171 const char *errstr = NULL;
2173 PERL_ARGS_ASSERT_FORCE_STRICT_VERSION;
2175 while (isSPACE(*s)) /* leading whitespace */
2178 if (is_STRICT_VERSION(s,&errstr)) {
2180 s = (char *)scan_version(s, ver, 0);
2181 version = newSVOP(OP_CONST, 0, ver);
2183 else if ((*s != ';' && *s != '{' && *s != '}' )
2184 && (s = skipspace(s), (*s != ';' && *s != '{' && *s != '}' )))
2188 yyerror(errstr); /* version required */
2192 /* NOTE: The parser sees the package name and the VERSION swapped */
2193 NEXTVAL_NEXTTOKE.opval = version;
2201 * Tokenize a quoted string passed in as an SV. It finds the next
2202 * chunk, up to end of string or a backslash. It may make a new
2203 * SV containing that chunk (if HINT_NEW_STRING is on). It also
2208 S_tokeq(pTHX_ SV *sv)
2215 PERL_ARGS_ASSERT_TOKEQ;
2219 assert (!SvIsCOW(sv));
2220 if (SvTYPE(sv) >= SVt_PVIV && SvIVX(sv) == -1) /* <<'heredoc' */
2224 /* This is relying on the SV being "well formed" with a trailing '\0' */
2225 while (s < send && !(*s == '\\' && s[1] == '\\'))
2230 if ( PL_hints & HINT_NEW_STRING ) {
2231 pv = newSVpvn_flags(SvPVX_const(pv), SvCUR(sv),
2232 SVs_TEMP | SvUTF8(sv));
2236 if (s + 1 < send && (s[1] == '\\'))
2237 s++; /* all that, just for this */
2242 SvCUR_set(sv, d - SvPVX_const(sv));
2244 if ( PL_hints & HINT_NEW_STRING )
2245 return new_constant(NULL, 0, "q", sv, pv, "q", 1);
2250 * Now come three functions related to double-quote context,
2251 * S_sublex_start, S_sublex_push, and S_sublex_done. They're used when
2252 * converting things like "\u\Lgnat" into ucfirst(lc("gnat")). They
2253 * interact with PL_lex_state, and create fake ( ... ) argument lists
2254 * to handle functions and concatenation.
2258 * stringify ( const[foo] concat lcfirst ( const[bar] ) )
2263 * Assumes that pl_yylval.ival is the op we're creating (e.g. OP_LCFIRST).
2265 * Pattern matching will set PL_lex_op to the pattern-matching op to
2266 * make (we return THING if pl_yylval.ival is OP_NULL, PMFUNC otherwise).
2268 * OP_CONST and OP_READLINE are easy--just make the new op and return.
2270 * Everything else becomes a FUNC.
2272 * Sets PL_lex_state to LEX_INTERPPUSH unless (ival was OP_NULL or we
2273 * had an OP_CONST or OP_READLINE). This just sets us up for a
2274 * call to S_sublex_push().
2278 S_sublex_start(pTHX)
2280 const I32 op_type = pl_yylval.ival;
2282 if (op_type == OP_NULL) {
2283 pl_yylval.opval = PL_lex_op;
2287 if (op_type == OP_CONST) {
2288 SV *sv = PL_lex_stuff;
2289 PL_lex_stuff = NULL;
2292 if (SvTYPE(sv) == SVt_PVIV) {
2293 /* Overloaded constants, nothing fancy: Convert to SVt_PV: */
2295 const char * const p = SvPV_const(sv, len);
2296 SV * const nsv = newSVpvn_flags(p, len, SvUTF8(sv));
2300 pl_yylval.opval = (OP*)newSVOP(op_type, 0, sv);
2304 PL_sublex_info.super_state = PL_lex_state;
2305 PL_sublex_info.sub_inwhat = (U16)op_type;
2306 PL_sublex_info.sub_op = PL_lex_op;
2307 PL_lex_state = LEX_INTERPPUSH;
2311 pl_yylval.opval = PL_lex_op;
2321 * Create a new scope to save the lexing state. The scope will be
2322 * ended in S_sublex_done. Returns a '(', starting the function arguments
2323 * to the uc, lc, etc. found before.
2324 * Sets PL_lex_state to LEX_INTERPCONCAT.
2331 const bool is_heredoc = PL_multi_close == '<';
2334 PL_lex_state = PL_sublex_info.super_state;
2335 SAVEI8(PL_lex_dojoin);
2336 SAVEI32(PL_lex_brackets);
2337 SAVEI32(PL_lex_allbrackets);
2338 SAVEI32(PL_lex_formbrack);
2339 SAVEI8(PL_lex_fakeeof);
2340 SAVEI32(PL_lex_casemods);
2341 SAVEI32(PL_lex_starts);
2342 SAVEI8(PL_lex_state);
2343 SAVESPTR(PL_lex_repl);
2344 SAVEVPTR(PL_lex_inpat);
2345 SAVEI16(PL_lex_inwhat);
2348 SAVECOPLINE(PL_curcop);
2349 SAVEI32(PL_multi_end);
2350 SAVEI32(PL_parser->herelines);
2351 PL_parser->herelines = 0;
2353 SAVEI8(PL_multi_close);
2354 SAVEPPTR(PL_bufptr);
2355 SAVEPPTR(PL_bufend);
2356 SAVEPPTR(PL_oldbufptr);
2357 SAVEPPTR(PL_oldoldbufptr);
2358 SAVEPPTR(PL_last_lop);
2359 SAVEPPTR(PL_last_uni);
2360 SAVEPPTR(PL_linestart);
2361 SAVESPTR(PL_linestr);
2362 SAVEGENERICPV(PL_lex_brackstack);
2363 SAVEGENERICPV(PL_lex_casestack);
2364 SAVEGENERICPV(PL_parser->lex_shared);
2365 SAVEBOOL(PL_parser->lex_re_reparsing);
2366 SAVEI32(PL_copline);
2368 /* The here-doc parser needs to be able to peek into outer lexing
2369 scopes to find the body of the here-doc. So we put PL_linestr and
2370 PL_bufptr into lex_shared, to ‘share’ those values.
2372 PL_parser->lex_shared->ls_linestr = PL_linestr;
2373 PL_parser->lex_shared->ls_bufptr = PL_bufptr;
2375 PL_linestr = PL_lex_stuff;
2376 PL_lex_repl = PL_sublex_info.repl;
2377 PL_lex_stuff = NULL;
2378 PL_sublex_info.repl = NULL;
2380 /* Arrange for PL_lex_stuff to be freed on scope exit, in case it gets
2381 set for an inner quote-like operator and then an error causes scope-
2382 popping. We must not have a PL_lex_stuff value left dangling, as
2383 that breaks assumptions elsewhere. See bug #123617. */
2384 SAVEGENERICSV(PL_lex_stuff);
2385 SAVEGENERICSV(PL_sublex_info.repl);
2387 PL_bufend = PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart
2388 = SvPVX(PL_linestr);
2389 PL_bufend += SvCUR(PL_linestr);
2390 PL_last_lop = PL_last_uni = NULL;
2391 SAVEFREESV(PL_linestr);
2392 if (PL_lex_repl) SAVEFREESV(PL_lex_repl);
2394 PL_lex_dojoin = FALSE;
2395 PL_lex_brackets = PL_lex_formbrack = 0;
2396 PL_lex_allbrackets = 0;
2397 PL_lex_fakeeof = LEX_FAKEEOF_NEVER;
2398 Newx(PL_lex_brackstack, 120, char);
2399 Newx(PL_lex_casestack, 12, char);
2400 PL_lex_casemods = 0;
2401 *PL_lex_casestack = '\0';
2403 PL_lex_state = LEX_INTERPCONCAT;
2405 CopLINE_set(PL_curcop, (line_t)PL_multi_start);
2406 PL_copline = NOLINE;
2408 Newxz(shared, 1, LEXSHARED);
2409 shared->ls_prev = PL_parser->lex_shared;
2410 PL_parser->lex_shared = shared;
2412 PL_lex_inwhat = PL_sublex_info.sub_inwhat;
2413 if (PL_lex_inwhat == OP_TRANSR) PL_lex_inwhat = OP_TRANS;
2414 if (PL_lex_inwhat == OP_MATCH || PL_lex_inwhat == OP_QR || PL_lex_inwhat == OP_SUBST)
2415 PL_lex_inpat = PL_sublex_info.sub_op;
2417 PL_lex_inpat = NULL;
2419 PL_parser->lex_re_reparsing = cBOOL(PL_in_eval & EVAL_RE_REPARSING);
2420 PL_in_eval &= ~EVAL_RE_REPARSING;
2427 * Restores lexer state after a S_sublex_push.
2433 if (!PL_lex_starts++) {
2434 SV * const sv = newSVpvs("");
2435 if (SvUTF8(PL_linestr))
2437 PL_expect = XOPERATOR;
2438 pl_yylval.opval = (OP*)newSVOP(OP_CONST, 0, sv);
2442 if (PL_lex_casemods) { /* oops, we've got some unbalanced parens */
2443 PL_lex_state = LEX_INTERPCASEMOD;
2447 /* Is there a right-hand side to take care of? (s//RHS/ or tr//RHS/) */
2448 assert(PL_lex_inwhat != OP_TRANSR);
2450 assert (PL_lex_inwhat == OP_SUBST || PL_lex_inwhat == OP_TRANS);
2451 PL_linestr = PL_lex_repl;
2453 PL_bufend = PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
2454 PL_bufend += SvCUR(PL_linestr);
2455 PL_last_lop = PL_last_uni = NULL;
2456 PL_lex_dojoin = FALSE;
2457 PL_lex_brackets = 0;
2458 PL_lex_allbrackets = 0;
2459 PL_lex_fakeeof = LEX_FAKEEOF_NEVER;
2460 PL_lex_casemods = 0;
2461 *PL_lex_casestack = '\0';
2463 if (SvEVALED(PL_lex_repl)) {
2464 PL_lex_state = LEX_INTERPNORMAL;
2466 /* we don't clear PL_lex_repl here, so that we can check later
2467 whether this is an evalled subst; that means we rely on the
2468 logic to ensure sublex_done() is called again only via the
2469 branch (in yylex()) that clears PL_lex_repl, else we'll loop */
2472 PL_lex_state = LEX_INTERPCONCAT;
2475 if (SvTYPE(PL_linestr) >= SVt_PVNV) {
2476 CopLINE(PL_curcop) +=
2477 ((XPVNV*)SvANY(PL_linestr))->xnv_u.xpad_cop_seq.xlow
2478 + PL_parser->herelines;
2479 PL_parser->herelines = 0;
2484 const line_t l = CopLINE(PL_curcop);
2486 if (PL_multi_close == '<')
2487 PL_parser->herelines += l - PL_multi_end;
2488 PL_bufend = SvPVX(PL_linestr);
2489 PL_bufend += SvCUR(PL_linestr);
2490 PL_expect = XOPERATOR;
2495 PERL_STATIC_INLINE SV*
2496 S_get_and_check_backslash_N_name(pTHX_ const char* s, const char* const e)
2498 /* <s> points to first character of interior of \N{}, <e> to one beyond the
2499 * interior, hence to the "}". Finds what the name resolves to, returning
2500 * an SV* containing it; NULL if no valid one found */
2502 SV* res = newSVpvn_flags(s, e - s, UTF ? SVf_UTF8 : 0);
2509 const U8* first_bad_char_loc;
2510 const char* backslash_ptr = s - 3; /* Points to the <\> of \N{... */
2512 PERL_ARGS_ASSERT_GET_AND_CHECK_BACKSLASH_N_NAME;
2515 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED),
2516 "Unknown charname '' is deprecated");
2520 if (UTF && ! is_utf8_string_loc((U8 *) backslash_ptr,
2522 &first_bad_char_loc))
2524 /* If warnings are on, this will print a more detailed analysis of what
2525 * is wrong than the error message below */
2526 utf8n_to_uvchr(first_bad_char_loc,
2527 e - ((char *) first_bad_char_loc),
2530 /* We deliberately don't try to print the malformed character, which
2531 * might not print very well; it also may be just the first of many
2532 * malformations, so don't print what comes after it */
2533 yyerror_pv(Perl_form(aTHX_
2534 "Malformed UTF-8 character immediately after '%.*s'",
2535 (int) (first_bad_char_loc - (U8 *) backslash_ptr), backslash_ptr),
2540 res = new_constant( NULL, 0, "charnames", res, NULL, backslash_ptr,
2541 /* include the <}> */
2542 e - backslash_ptr + 1);
2544 SvREFCNT_dec_NN(res);
2548 /* See if the charnames handler is the Perl core's, and if so, we can skip
2549 * the validation needed for a user-supplied one, as Perl's does its own
2551 table = GvHV(PL_hintgv); /* ^H */
2552 cvp = hv_fetchs(table, "charnames", FALSE);
2553 if (cvp && (cv = *cvp) && SvROK(cv) && (rv = SvRV(cv),
2554 SvTYPE(rv) == SVt_PVCV) && ((stash = CvSTASH(rv)) != NULL))
2556 const char * const name = HvNAME(stash);
2557 if (HvNAMELEN(stash) == sizeof("_charnames")-1
2558 && strEQ(name, "_charnames")) {
2563 /* Here, it isn't Perl's charname handler. We can't rely on a
2564 * user-supplied handler to validate the input name. For non-ut8 input,
2565 * look to see that the first character is legal. Then loop through the
2566 * rest checking that each is a continuation */
2568 /* This code makes the reasonable assumption that the only Latin1-range
2569 * characters that begin a character name alias are alphabetic, otherwise
2570 * would have to create a isCHARNAME_BEGIN macro */
2573 if (! isALPHAU(*s)) {
2578 if (! isCHARNAME_CONT(*s)) {
2581 if (*s == ' ' && *(s-1) == ' ') {
2588 /* Similarly for utf8. For invariants can check directly; for other
2589 * Latin1, can calculate their code point and check; otherwise use a
2591 if (UTF8_IS_INVARIANT(*s)) {
2592 if (! isALPHAU(*s)) {
2596 } else if (UTF8_IS_DOWNGRADEABLE_START(*s)) {
2597 if (! isALPHAU(EIGHT_BIT_UTF8_TO_NATIVE(*s, *(s+1)))) {
2603 if (! PL_utf8_charname_begin) {
2604 U8 flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
2605 PL_utf8_charname_begin = _core_swash_init("utf8",
2606 "_Perl_Charname_Begin",
2608 1, 0, NULL, &flags);
2610 if (! swash_fetch(PL_utf8_charname_begin, (U8 *) s, TRUE)) {
2617 if (UTF8_IS_INVARIANT(*s)) {
2618 if (! isCHARNAME_CONT(*s)) {
2621 if (*s == ' ' && *(s-1) == ' ') {
2626 else if (UTF8_IS_DOWNGRADEABLE_START(*s)) {
2627 if (! isCHARNAME_CONT(EIGHT_BIT_UTF8_TO_NATIVE(*s, *(s+1))))
2634 if (! PL_utf8_charname_continue) {
2635 U8 flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
2636 PL_utf8_charname_continue = _core_swash_init("utf8",
2637 "_Perl_Charname_Continue",
2639 1, 0, NULL, &flags);
2641 if (! swash_fetch(PL_utf8_charname_continue, (U8 *) s, TRUE)) {
2648 if (*(s-1) == ' ') {
2651 "charnames alias definitions may not contain trailing "
2652 "white-space; marked by <-- HERE in %.*s<-- HERE %.*s",
2653 (int)(s - backslash_ptr + 1), backslash_ptr,
2654 (int)(e - s + 1), s + 1
2656 UTF ? SVf_UTF8 : 0);
2660 if (SvUTF8(res)) { /* Don't accept malformed input */
2661 const U8* first_bad_char_loc;
2663 const char* const str = SvPV_const(res, len);
2664 if (! is_utf8_string_loc((U8 *) str, len, &first_bad_char_loc)) {
2665 /* If warnings are on, this will print a more detailed analysis of
2666 * what is wrong than the error message below */
2667 utf8n_to_uvchr(first_bad_char_loc,
2668 (char *) first_bad_char_loc - str,
2671 /* We deliberately don't try to print the malformed character,
2672 * which might not print very well; it also may be just the first
2673 * of many malformations, so don't print what comes after it */
2676 "Malformed UTF-8 returned by %.*s immediately after '%.*s'",
2677 (int) (e - backslash_ptr + 1), backslash_ptr,
2678 (int) ((char *) first_bad_char_loc - str), str
2689 /* The final %.*s makes sure that should the trailing NUL be missing
2690 * that this print won't run off the end of the string */
2693 "Invalid character in \\N{...}; marked by <-- HERE in %.*s<-- HERE %.*s",
2694 (int)(s - backslash_ptr + 1), backslash_ptr,
2695 (int)(e - s + 1), s + 1
2697 UTF ? SVf_UTF8 : 0);
2704 "charnames alias definitions may not contain a sequence of "
2705 "multiple spaces; marked by <-- HERE in %.*s<-- HERE %.*s",
2706 (int)(s - backslash_ptr + 1), backslash_ptr,
2707 (int)(e - s + 1), s + 1
2709 UTF ? SVf_UTF8 : 0);
2716 Extracts the next constant part of a pattern, double-quoted string,
2717 or transliteration. This is terrifying code.
2719 For example, in parsing the double-quoted string "ab\x63$d", it would
2720 stop at the '$' and return an OP_CONST containing 'abc'.
2722 It looks at PL_lex_inwhat and PL_lex_inpat to find out whether it's
2723 processing a pattern (PL_lex_inpat is true), a transliteration
2724 (PL_lex_inwhat == OP_TRANS is true), or a double-quoted string.
2726 Returns a pointer to the character scanned up to. If this is
2727 advanced from the start pointer supplied (i.e. if anything was
2728 successfully parsed), will leave an OP_CONST for the substring scanned
2729 in pl_yylval. Caller must intuit reason for not parsing further
2730 by looking at the next characters herself.
2734 \N{FOO} => \N{U+hex_for_character_FOO}
2735 (if FOO expands to multiple characters, expands to \N{U+xx.XX.yy ...})
2738 all other \-char, including \N and \N{ apart from \N{ABC}
2741 @ and $ where it appears to be a var, but not for $ as tail anchor
2745 In transliterations:
2746 characters are VERY literal, except for - not at the start or end
2747 of the string, which indicates a range. If the range is in bytes,
2748 scan_const expands the range to the full set of intermediate
2749 characters. If the range is in utf8, the hyphen is replaced with
2750 a certain range mark which will be handled by pmtrans() in op.c.
2752 In double-quoted strings:
2754 double-quoted style: \r and \n
2755 constants: \x31, etc.
2756 deprecated backrefs: \1 (in substitution replacements)
2757 case and quoting: \U \Q \E
2760 scan_const does *not* construct ops to handle interpolated strings.
2761 It stops processing as soon as it finds an embedded $ or @ variable
2762 and leaves it to the caller to work out what's going on.
2764 embedded arrays (whether in pattern or not) could be:
2765 @foo, @::foo, @'foo, @{foo}, @$foo, @+, @-.
2767 $ in double-quoted strings must be the symbol of an embedded scalar.
2769 $ in pattern could be $foo or could be tail anchor. Assumption:
2770 it's a tail anchor if $ is the last thing in the string, or if it's
2771 followed by one of "()| \r\n\t"
2773 \1 (backreferences) are turned into $1 in substitutions
2775 The structure of the code is
2776 while (there's a character to process) {
2777 handle transliteration ranges
2778 skip regexp comments /(?#comment)/ and codes /(?{code})/
2779 skip #-initiated comments in //x patterns
2780 check for embedded arrays
2781 check for embedded scalars
2783 deprecate \1 in substitution replacements
2784 handle string-changing backslashes \l \U \Q \E, etc.
2785 switch (what was escaped) {
2786 handle \- in a transliteration (becomes a literal -)
2787 if a pattern and not \N{, go treat as regular character
2788 handle \132 (octal characters)
2789 handle \x15 and \x{1234} (hex characters)
2790 handle \N{name} (named characters, also \N{3,5} in a pattern)
2791 handle \cV (control characters)
2792 handle printf-style backslashes (\f, \r, \n, etc)
2795 } (end if backslash)
2796 handle regular character
2797 } (end while character to read)
2802 S_scan_const(pTHX_ char *start)
2804 char *send = PL_bufend; /* end of the constant */
2805 SV *sv = newSV(send - start); /* sv for the constant. See note below
2807 char *s = start; /* start of the constant */
2808 char *d = SvPVX(sv); /* destination for copies */
2809 bool dorange = FALSE; /* are we in a translit range? */
2810 bool didrange = FALSE; /* did we just finish a range? */
2811 bool in_charclass = FALSE; /* within /[...]/ */
2812 bool has_utf8 = FALSE; /* Output constant is UTF8 */
2813 bool this_utf8 = cBOOL(UTF); /* Is the source string assumed to be
2814 UTF8? But, this can show as true
2815 when the source isn't utf8, as for
2816 example when it is entirely composed
2818 SV *res; /* result from charnames */
2819 STRLEN offset_to_max; /* The offset in the output to where the range
2820 high-end character is temporarily placed */
2822 /* Note on sizing: The scanned constant is placed into sv, which is
2823 * initialized by newSV() assuming one byte of output for every byte of
2824 * input. This routine expects newSV() to allocate an extra byte for a
2825 * trailing NUL, which this routine will append if it gets to the end of
2826 * the input. There may be more bytes of input than output (eg., \N{LATIN
2827 * CAPITAL LETTER A}), or more output than input if the constant ends up
2828 * recoded to utf8, but each time a construct is found that might increase
2829 * the needed size, SvGROW() is called. Its size parameter each time is
2830 * based on the best guess estimate at the time, namely the length used so
2831 * far, plus the length the current construct will occupy, plus room for
2832 * the trailing NUL, plus one byte for every input byte still unscanned */
2834 UV uv = UV_MAX; /* Initialize to weird value to try to catch any uses
2837 int backslash_N = 0; /* ? was the character from \N{} */
2838 int non_portable_endpoint = 0; /* ? In a range is an endpoint
2839 platform-specific like \x65 */
2842 PERL_ARGS_ASSERT_SCAN_CONST;
2844 assert(PL_lex_inwhat != OP_TRANSR);
2845 if (PL_lex_inwhat == OP_TRANS && PL_sublex_info.sub_op) {
2846 /* If we are doing a trans and we know we want UTF8 set expectation */
2847 has_utf8 = PL_sublex_info.sub_op->op_private & (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF);
2848 this_utf8 = PL_sublex_info.sub_op->op_private & (PL_lex_repl ? OPpTRANS_FROM_UTF : OPpTRANS_TO_UTF);
2851 /* Protect sv from errors and fatal warnings. */
2852 ENTER_with_name("scan_const");
2856 || dorange /* Handle tr/// range at right edge of input */
2859 /* get transliterations out of the way (they're most literal) */
2860 if (PL_lex_inwhat == OP_TRANS) {
2862 /* But there isn't any special handling necessary unless there is a
2863 * range, so for most cases we just drop down and handle the value
2864 * as any other. There are two exceptions.
2866 * 1. A minus sign indicates that we are actually going to have
2867 * a range. In this case, skip the '-', set a flag, then drop
2868 * down to handle what should be the end range value.
2869 * 2. After we've handled that value, the next time through, that
2870 * flag is set and we fix up the range.
2872 * Ranges entirely within Latin1 are expanded out entirely, in
2873 * order to avoid the significant overhead of making a swash.
2874 * Ranges that extend above Latin1 have to have a swash, so there
2875 * is no advantage to abbreviate them here, so they are stored here
2876 * as Min, ILLEGAL_UTF8_BYTE, Max. The illegal byte signifies a
2877 * hyphen without any possible ambiguity. On EBCDIC machines, if
2878 * the range is expressed as Unicode, the Latin1 portion is
2879 * expanded out even if the entire range extends above Latin1.
2880 * This is because each code point in it has to be processed here
2881 * individually to get its native translation */
2885 /* Here, we don't think we're in a range. If we've processed
2886 * at least one character, then see if this next one is a '-',
2887 * indicating the previous one was the start of a range. But
2888 * don't bother if we're too close to the end for the minus to
2890 if (*s != '-' || s >= send - 1 || s == start) {
2892 /* A regular character. Process like any other, but first
2893 * clear any flags */
2897 non_portable_endpoint = 0;
2900 /* Drops down to generic code to process current byte */
2903 if (didrange) { /* Something like y/A-C-Z// */
2904 Perl_croak(aTHX_ "Ambiguous range in transliteration operator");
2909 s++; /* Skip past the minus */
2911 /* d now points to where the end-range character will be
2912 * placed. Save it so won't have to go finding it later,
2913 * and drop down to get that character. (Actually we
2914 * instead save the offset, to handle the case where a
2915 * realloc in the meantime could change the actual
2916 * pointer). We'll finish processing the range the next
2917 * time through the loop */
2918 offset_to_max = d - SvPVX_const(sv);
2920 } /* End of not a range */
2922 /* Here we have parsed a range. Now must handle it. At this
2924 * 'sv' is a SV* that contains the output string we are
2925 * constructing. The final two characters in that string
2926 * are the range start and range end, in order.
2927 * 'd' points to just beyond the range end in the 'sv' string,
2928 * where we would next place something
2929 * 'offset_to_max' is the offset in 'sv' at which the character
2930 * before 'd' begins.
2932 const char * max_ptr = SvPVX_const(sv) + offset_to_max;
2933 const char * min_ptr;
2935 IV range_max; /* last character in range */
2938 #ifndef EBCDIC /* Not meaningful except in EBCDIC, so initialize to false */
2939 const bool convert_unicode = FALSE;
2940 const IV real_range_max = 0;
2942 bool convert_unicode;
2943 IV real_range_max = 0;
2946 /* Get the range-ends code point values. */
2948 /* We know the utf8 is valid, because we just constructed
2949 * it ourselves in previous loop iterations */
2950 min_ptr = (char*) utf8_hop( (U8*) max_ptr, -1);
2951 range_min = valid_utf8_to_uvchr( (U8*) min_ptr, NULL);
2952 range_max = valid_utf8_to_uvchr( (U8*) max_ptr, NULL);
2955 min_ptr = max_ptr - 1;
2956 range_min = * (U8*) min_ptr;
2957 range_max = * (U8*) max_ptr;
2961 /* On EBCDIC platforms, we may have to deal with portable
2962 * ranges. These happen if at least one range endpoint is a
2963 * Unicode value (\N{...}), or if the range is a subset of
2964 * [A-Z] or [a-z], and both ends are literal characters,
2965 * like 'A', and not like \x{C1} */
2966 if ((convert_unicode
2967 = cBOOL(backslash_N) /* \N{} forces Unicode, hence
2969 || ( ! non_portable_endpoint
2970 && (( isLOWER_A(range_min) && isLOWER_A(range_max))
2971 || (isUPPER_A(range_min) && isUPPER_A(range_max))))
2974 /* Special handling is needed for these portable ranges.
2975 * They are defined to all be in Unicode terms, which
2976 * include all Unicode code points between the end points.
2977 * Convert to Unicode to get the Unicode range. Later we
2978 * will convert each code point in the range back to
2980 range_min = NATIVE_TO_UNI(range_min);
2981 range_max = NATIVE_TO_UNI(range_max);
2985 if (range_min > range_max) {
2986 if (convert_unicode) {
2987 /* Need to convert back to native for meaningful
2988 * messages for this platform */
2989 range_min = UNI_TO_NATIVE(range_min);
2990 range_max = UNI_TO_NATIVE(range_max);
2993 /* Use the characters themselves for the error message if
2994 * ASCII printables; otherwise some visible representation
2996 if (isPRINT_A(range_min) && isPRINT_A(range_max)) {
2998 "Invalid range \"%c-%c\" in transliteration operator",
2999 (char)range_min, (char)range_max);
3001 else if (convert_unicode) {
3002 /* diag_listed_as: Invalid range "%s" in transliteration operator */
3004 "Invalid range \"\\N{U+%04"UVXf"}-\\N{U+%04"UVXf"}\""
3005 " in transliteration operator",
3006 range_min, range_max);
3009 /* diag_listed_as: Invalid range "%s" in transliteration operator */
3011 "Invalid range \"\\x{%04"UVXf"}-\\x{%04"UVXf"}\""
3012 " in transliteration operator",
3013 range_min, range_max);
3019 /* We try to avoid creating a swash. If the upper end of
3020 * this range is below 256, this range won't force a swash;
3021 * otherwise it does force a swash, and as long as we have
3022 * to have one, we might as well not expand things out.
3023 * But if it's EBCDIC, we may have to look at each
3024 * character below 256 if we have to convert to/from
3028 && (range_min > 255 || ! convert_unicode)
3031 /* Move the high character one byte to the right; then
3032 * insert between it and the range begin, an illegal
3033 * byte which serves to indicate this is a range (using
3034 * a '-' could be ambiguous). */
3036 while (e-- > max_ptr) {
3039 *(e + 1) = (char) ILLEGAL_UTF8_BYTE;
3043 /* Here, we're going to expand out the range. For EBCDIC
3044 * the range can extend above 255 (not so in ASCII), so
3045 * for EBCDIC, split it into the parts above and below
3048 if (range_max > 255) {
3049 real_range_max = range_max;
3055 /* Here we need to expand out the string to contain each
3056 * character in the range. Grow the output to handle this */
3058 save_offset = min_ptr - SvPVX_const(sv);
3060 /* The base growth is the number of code points in the range */
3061 grow = range_max - range_min + 1;
3064 /* But if the output is UTF-8, some of those characters may
3065 * need two bytes (since the maximum range value here is
3066 * 255, the max bytes per character is two). On ASCII
3067 * platforms, it's not much trouble to get an accurate
3068 * count of what's needed. But on EBCDIC, the ones that
3069 * need 2 bytes are scattered around, so just use a worst
3070 * case value instead of calculating for that platform. */
3074 /* Only those above 127 require 2 bytes. This may be
3075 * everything in the range, or not */
3076 if (range_min > 127) {
3079 else if (range_max > 127) {
3080 grow += range_max - 127;
3085 /* Subtract 3 for the bytes that were already accounted for
3086 * (min, max, and the hyphen) */
3087 SvGROW(sv, SvLEN(sv) + grow - 3);
3088 d = SvPVX(sv) + save_offset; /* refresh d after realloc */
3090 /* Here, we expand out the range. On ASCII platforms, the
3091 * compiler should optimize out the 'convert_unicode==TRUE'
3092 * portion of this */
3093 if (convert_unicode) {
3096 /* Recall that the min and max are now in Unicode terms, so
3097 * we have to convert each character to its native
3100 for (i = range_min; i <= range_max; i++) {
3101 append_utf8_from_native_byte(LATIN1_TO_NATIVE((U8) i),
3106 for (i = range_min; i <= range_max; i++) {
3107 *d++ = (char)LATIN1_TO_NATIVE((U8) i);
3114 /* Here, no conversions are necessary, which means that the
3115 * first character in the range is already in 'd' and
3116 * valid, so we can skip overwriting it */
3119 for (i = range_min + 1; i <= range_max; i++) {
3120 append_utf8_from_native_byte((U8) i, (U8 **) &d);
3125 for (i = range_min + 1; i <= range_max; i++) {
3131 /* (Compilers should optimize this out for non-EBCDIC). If the
3132 * original range extended above 255, add in that portion */
3133 if (real_range_max) {
3134 *d++ = (char) UTF8_TWO_BYTE_HI(0x100);
3135 *d++ = (char) UTF8_TWO_BYTE_LO(0x100);
3136 if (real_range_max > 0x101)
3137 *d++ = (char) ILLEGAL_UTF8_BYTE;
3138 if (real_range_max > 0x100)
3139 d = (char*)uvchr_to_utf8((U8*)d, real_range_max);
3143 /* mark the range as done, and continue */
3147 non_portable_endpoint = 0;
3151 } /* End of is a range */
3152 } /* End of transliteration. Joins main code after these else's */
3153 else if (*s == '[' && PL_lex_inpat && !in_charclass) {
3156 while (s1 >= start && *s1-- == '\\')
3159 in_charclass = TRUE;
3162 else if (*s == ']' && PL_lex_inpat && in_charclass) {
3165 while (s1 >= start && *s1-- == '\\')
3168 in_charclass = FALSE;
3171 /* skip for regexp comments /(?#comment)/, except for the last
3172 * char, which will be done separately.
3173 * Stop on (?{..}) and friends */
3175 else if (*s == '(' && PL_lex_inpat && s[1] == '?' && !in_charclass) {
3177 while (s+1 < send && *s != ')')
3180 else if (!PL_lex_casemods
3181 && ( s[2] == '{' /* This should match regcomp.c */
3182 || (s[2] == '?' && s[3] == '{')))
3188 /* likewise skip #-initiated comments in //x patterns */
3192 && ((PMOP*)PL_lex_inpat)->op_pmflags & RXf_PMf_EXTENDED)
3194 while (s+1 < send && *s != '\n')
3198 /* no further processing of single-quoted regex */
3199 else if (PL_lex_inpat && SvIVX(PL_linestr) == '\'')
3200 goto default_action;
3202 /* check for embedded arrays
3203 (@foo, @::foo, @'foo, @{foo}, @$foo, @+, @-)
3205 else if (*s == '@' && s[1]) {
3206 if (UTF ? isIDFIRST_utf8((U8*)s+1) : isWORDCHAR_A(s[1]))
3208 if (strchr(":'{$", s[1]))
3210 if (!PL_lex_inpat && (s[1] == '+' || s[1] == '-'))
3211 break; /* in regexp, neither @+ nor @- are interpolated */
3214 /* check for embedded scalars. only stop if we're sure it's a
3217 else if (*s == '$') {
3218 if (!PL_lex_inpat) /* not a regexp, so $ must be var */
3220 if (s + 1 < send && !strchr("()| \r\n\t", s[1])) {
3222 Perl_ck_warner(aTHX_ packWARN(WARN_AMBIGUOUS),
3223 "Possible unintended interpolation of $\\ in regex");
3225 break; /* in regexp, $ might be tail anchor */
3229 /* End of else if chain - OP_TRANS rejoin rest */
3232 if (*s == '\\' && s+1 < send) {
3233 char* e; /* Can be used for ending '}', etc. */
3237 /* warn on \1 - \9 in substitution replacements, but note that \11
3238 * is an octal; and \19 is \1 followed by '9' */
3239 if (PL_lex_inwhat == OP_SUBST
3245 /* diag_listed_as: \%d better written as $%d */
3246 Perl_ck_warner(aTHX_ packWARN(WARN_SYNTAX), "\\%c better written as $%c", *s, *s);
3251 /* string-change backslash escapes */
3252 if (PL_lex_inwhat != OP_TRANS && *s && strchr("lLuUEQF", *s)) {
3256 /* In a pattern, process \N, but skip any other backslash escapes.
3257 * This is because we don't want to translate an escape sequence
3258 * into a meta symbol and have the regex compiler use the meta
3259 * symbol meaning, e.g. \x{2E} would be confused with a dot. But
3260 * in spite of this, we do have to process \N here while the proper
3261 * charnames handler is in scope. See bugs #56444 and #62056.
3263 * There is a complication because \N in a pattern may also stand
3264 * for 'match a non-nl', and not mean a charname, in which case its
3265 * processing should be deferred to the regex compiler. To be a
3266 * charname it must be followed immediately by a '{', and not look
3267 * like \N followed by a curly quantifier, i.e., not something like
3268 * \N{3,}. regcurly returns a boolean indicating if it is a legal
3270 else if (PL_lex_inpat
3273 || regcurly(s + 1)))
3276 goto default_action;
3282 if ((isALPHANUMERIC(*s)))
3283 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
3284 "Unrecognized escape \\%c passed through",
3286 /* default action is to copy the quoted character */
3287 goto default_action;
3290 /* eg. \132 indicates the octal constant 0132 */
3291 case '0': case '1': case '2': case '3':
3292 case '4': case '5': case '6': case '7':
3294 I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
3296 uv = grok_oct(s, &len, &flags, NULL);
3298 if (len < 3 && s < send && isDIGIT(*s)
3299 && ckWARN(WARN_MISC))
3301 Perl_warner(aTHX_ packWARN(WARN_MISC),
3302 "%s", form_short_octal_warning(s, len));
3305 goto NUM_ESCAPE_INSERT;
3307 /* eg. \o{24} indicates the octal constant \024 */
3312 bool valid = grok_bslash_o(&s, &uv, &error,
3313 TRUE, /* Output warning */
3314 FALSE, /* Not strict */
3315 TRUE, /* Output warnings for
3322 goto NUM_ESCAPE_INSERT;
3325 /* eg. \x24 indicates the hex constant 0x24 */
3330 bool valid = grok_bslash_x(&s, &uv, &error,
3331 TRUE, /* Output warning */
3332 FALSE, /* Not strict */
3333 TRUE, /* Output warnings for
3343 /* Insert oct or hex escaped character. */
3345 /* Here uv is the ordinal of the next character being added */
3346 if (UVCHR_IS_INVARIANT(uv)) {
3350 if (!has_utf8 && uv > 255) {
3351 /* Might need to recode whatever we have accumulated so
3352 * far if it contains any chars variant in utf8 or
3355 SvCUR_set(sv, d - SvPVX_const(sv));
3358 /* See Note on sizing above. */
3359 sv_utf8_upgrade_flags_grow(
3361 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE
3362 /* Above-latin1 in string
3363 * implies no encoding */
3364 |SV_UTF8_NO_ENCODING,
3365 UVCHR_SKIP(uv) + (STRLEN)(send - s) + 1);
3366 d = SvPVX(sv) + SvCUR(sv);
3371 /* Usually, there will already be enough room in 'sv'
3372 * since such escapes are likely longer than any UTF-8
3373 * sequence they can end up as. This isn't the case on
3374 * EBCDIC where \x{40000000} contains 12 bytes, and the
3375 * UTF-8 for it contains 14. And, we have to allow for
3376 * a trailing NUL. It probably can't happen on ASCII
3377 * platforms, but be safe */
3378 const STRLEN needed = d - SvPVX(sv) + UVCHR_SKIP(uv)
3380 if (UNLIKELY(needed > SvLEN(sv))) {
3381 SvCUR_set(sv, d - SvPVX_const(sv));
3382 d = sv_grow(sv, needed) + SvCUR(sv);
3385 d = (char*)uvchr_to_utf8((U8*)d, uv);
3386 if (PL_lex_inwhat == OP_TRANS
3387 && PL_sublex_info.sub_op)
3389 PL_sublex_info.sub_op->op_private |=
3390 (PL_lex_repl ? OPpTRANS_FROM_UTF
3399 non_portable_endpoint++;
3404 /* In a non-pattern \N must be like \N{U+0041}, or it can be a
3405 * named character, like \N{LATIN SMALL LETTER A}, or a named
3406 * sequence, like \N{LATIN CAPITAL LETTER A WITH MACRON AND
3407 * GRAVE} (except y/// can't handle the latter, croaking). For
3408 * convenience all three forms are referred to as "named
3409 * characters" below.
3411 * For patterns, \N also can mean to match a non-newline. Code
3412 * before this 'switch' statement should already have handled
3413 * this situation, and hence this code only has to deal with
3414 * the named character cases.
3416 * For non-patterns, the named characters are converted to
3417 * their string equivalents. In patterns, named characters are
3418 * not converted to their ultimate forms for the same reasons
3419 * that other escapes aren't. Instead, they are converted to
3420 * the \N{U+...} form to get the value from the charnames that
3421 * is in effect right now, while preserving the fact that it
3422 * was a named character, so that the regex compiler knows
3425 * The structure of this section of code (besides checking for
3426 * errors and upgrading to utf8) is:
3427 * If the named character is of the form \N{U+...}, pass it
3428 * through if a pattern; otherwise convert the code point
3430 * Otherwise must be some \N{NAME}: convert to
3431 * \N{U+c1.c2...} if a pattern; otherwise convert to utf8
3433 * Transliteration is an exception. The conversion to utf8 is
3434 * only done if the code point requires it to be representable.
3436 * Here, 's' points to the 'N'; the test below is guaranteed to
3437 * succeed if we are being called on a pattern, as we already
3438 * know from a test above that the next character is a '{'. A
3439 * non-pattern \N must mean 'named character', which requires
3443 yyerror("Missing braces on \\N{}");
3448 /* If there is no matching '}', it is an error. */
3449 if (! (e = strchr(s, '}'))) {
3450 if (! PL_lex_inpat) {
3451 yyerror("Missing right brace on \\N{}");
3453 yyerror("Missing right brace on \\N{} or unescaped left brace after \\N");
3458 /* Here it looks like a named character */
3460 if (*s == 'U' && s[1] == '+') { /* \N{U+...} */
3461 s += 2; /* Skip to next char after the 'U+' */
3464 /* In patterns, we can have \N{U+xxxx.yyyy.zzzz...} */
3465 /* Check the syntax. */
3468 if (!isXDIGIT(*s)) {
3471 "Invalid hexadecimal number in \\N{U+...}"
3479 else if ((*s == '.' || *s == '_')
3485 /* Pass everything through unchanged.
3486 * +1 is for the '}' */
3487 Copy(orig_s, d, e - orig_s + 1, char);
3488 d += e - orig_s + 1;
3490 else { /* Not a pattern: convert the hex to string */
3491 I32 flags = PERL_SCAN_ALLOW_UNDERSCORES
3492 | PERL_SCAN_SILENT_ILLDIGIT
3493 | PERL_SCAN_DISALLOW_PREFIX;
3495 uv = grok_hex(s, &len, &flags, NULL);
3496 if (len == 0 || (len != (STRLEN)(e - s)))
3499 /* For non-tr///, if the destination is not in utf8,
3500 * unconditionally recode it to be so. This is
3501 * because \N{} implies Unicode semantics, and scalars
3502 * have to be in utf8 to guarantee those semantics.
3503 * tr/// doesn't care about Unicode rules, so no need
3504 * there to upgrade to UTF-8 for small enough code
3506 if (! has_utf8 && ( uv > 0xFF
3507 || PL_lex_inwhat != OP_TRANS))
3509 SvCUR_set(sv, d - SvPVX_const(sv));
3512 /* See Note on sizing above. */
3513 sv_utf8_upgrade_flags_grow(
3515 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3516 UVCHR_SKIP(uv) + (STRLEN)(send - e) + 1);
3517 d = SvPVX(sv) + SvCUR(sv);
3521 /* Add the (Unicode) code point to the output. */
3522 if (OFFUNI_IS_INVARIANT(uv)) {
3523 *d++ = (char) LATIN1_TO_NATIVE(uv);
3526 d = (char*) uvoffuni_to_utf8_flags((U8*)d, uv, 0);
3530 else /* Here is \N{NAME} but not \N{U+...}. */
3531 if ((res = get_and_check_backslash_N_name(s, e)))
3534 const char *str = SvPV_const(res, len);
3537 if (! len) { /* The name resolved to an empty string */
3538 Copy("\\N{}", d, 4, char);
3542 /* In order to not lose information for the regex
3543 * compiler, pass the result in the specially made
3544 * syntax: \N{U+c1.c2.c3...}, where c1 etc. are
3545 * the code points in hex of each character
3546 * returned by charnames */
3548 const char *str_end = str + len;
3549 const STRLEN off = d - SvPVX_const(sv);
3551 if (! SvUTF8(res)) {
3552 /* For the non-UTF-8 case, we can determine the
3553 * exact length needed without having to parse
3554 * through the string. Each character takes up
3555 * 2 hex digits plus either a trailing dot or
3557 const char initial_text[] = "\\N{U+";
3558 const STRLEN initial_len = sizeof(initial_text)
3560 d = off + SvGROW(sv, off
3563 /* +1 for trailing NUL */
3566 + (STRLEN)(send - e));
3567 Copy(initial_text, d, initial_len, char);
3569 while (str < str_end) {
3572 my_snprintf(hex_string,
3576 /* The regex compiler is
3577 * expecting Unicode, not
3579 NATIVE_TO_LATIN1(*str));
3580 PERL_MY_SNPRINTF_POST_GUARD(len,
3581 sizeof(hex_string));
3582 Copy(hex_string, d, 3, char);
3586 d--; /* Below, we will overwrite the final
3587 dot with a right brace */
3590 STRLEN char_length; /* cur char's byte length */
3592 /* and the number of bytes after this is
3593 * translated into hex digits */
3594 STRLEN output_length;
3596 /* 2 hex per byte; 2 chars for '\N'; 2 chars
3597 * for max('U+', '.'); and 1 for NUL */
3598 char hex_string[2 * UTF8_MAXBYTES + 5];
3600 /* Get the first character of the result. */
3601 U32 uv = utf8n_to_uvchr((U8 *) str,
3605 /* Convert first code point to Unicode hex,
3606 * including the boiler plate before it. */
3608 my_snprintf(hex_string, sizeof(hex_string),
3610 (unsigned int) NATIVE_TO_UNI(uv));
3612 /* Make sure there is enough space to hold it */
3613 d = off + SvGROW(sv, off
3615 + (STRLEN)(send - e)
3616 + 2); /* '}' + NUL */
3618 Copy(hex_string, d, output_length, char);
3621 /* For each subsequent character, append dot and
3622 * its Unicode code point in hex */
3623 while ((str += char_length) < str_end) {
3624 const STRLEN off = d - SvPVX_const(sv);
3625 U32 uv = utf8n_to_uvchr((U8 *) str,
3630 my_snprintf(hex_string,
3633 (unsigned int) NATIVE_TO_UNI(uv));
3635 d = off + SvGROW(sv, off
3637 + (STRLEN)(send - e)
3638 + 2); /* '}' + NUL */
3639 Copy(hex_string, d, output_length, char);
3644 *d++ = '}'; /* Done. Add the trailing brace */
3647 else { /* Here, not in a pattern. Convert the name to a
3650 if (PL_lex_inwhat == OP_TRANS) {
3651 str = SvPV_const(res, len);
3652 if (len > ((SvUTF8(res))
3656 yyerror(Perl_form(aTHX_
3657 "%.*s must not be a named sequence"
3658 " in transliteration operator",
3659 /* +1 to include the "}" */
3660 (int) (e + 1 - start), start));
3661 goto end_backslash_N;
3664 else if (! SvUTF8(res)) {
3665 /* Make sure \N{} return is UTF-8. This is because
3666 * \N{} implies Unicode semantics, and scalars have to
3667 * be in utf8 to guarantee those semantics; but not
3668 * needed in tr/// */
3669 sv_utf8_upgrade_flags(res, SV_UTF8_NO_ENCODING);
3670 str = SvPV_const(res, len);
3673 /* Upgrade destination to be utf8 if this new
3675 if (! has_utf8 && SvUTF8(res)) {
3676 SvCUR_set(sv, d - SvPVX_const(sv));
3679 /* See Note on sizing above. */
3680 sv_utf8_upgrade_flags_grow(sv,
3681 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3682 len + (STRLEN)(send - s) + 1);
3683 d = SvPVX(sv) + SvCUR(sv);
3685 } else if (len > (STRLEN)(e - s + 4)) { /* I _guess_ 4 is \N{} --jhi */
3687 /* See Note on sizing above. (NOTE: SvCUR() is not
3688 * set correctly here). */
3689 const STRLEN off = d - SvPVX_const(sv);
3690 d = off + SvGROW(sv, off + len + (STRLEN)(send - s) + 1);
3692 Copy(str, d, len, char);
3698 } /* End \N{NAME} */
3702 backslash_N++; /* \N{} is defined to be Unicode */
3704 s = e + 1; /* Point to just after the '}' */
3707 /* \c is a control character */
3711 *d++ = grok_bslash_c(*s++, 1);
3714 yyerror("Missing control char name in \\c");
3717 non_portable_endpoint++;
3721 /* printf-style backslashes, formfeeds, newlines, etc */
3747 } /* end if (backslash) */
3750 /* If we started with encoded form, or already know we want it,
3751 then encode the next character */
3752 if (! NATIVE_BYTE_IS_INVARIANT((U8)(*s)) && (this_utf8 || has_utf8)) {
3755 /* One might think that it is wasted effort in the case of the
3756 * source being utf8 (this_utf8 == TRUE) to take the next character
3757 * in the source, convert it to an unsigned value, and then convert
3758 * it back again. But the source has not been validated here. The
3759 * routine that does the conversion checks for errors like
3762 const UV nextuv = (this_utf8)
3763 ? utf8n_to_uvchr((U8*)s, send - s, &len, 0)
3765 const STRLEN need = UVCHR_SKIP(nextuv);
3767 SvCUR_set(sv, d - SvPVX_const(sv));
3770 /* See Note on sizing above. */
3771 sv_utf8_upgrade_flags_grow(sv,
3772 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3773 need + (STRLEN)(send - s) + 1);
3774 d = SvPVX(sv) + SvCUR(sv);
3776 } else if (need > len) {
3777 /* encoded value larger than old, may need extra space (NOTE:
3778 * SvCUR() is not set correctly here). See Note on sizing
3780 const STRLEN off = d - SvPVX_const(sv);
3781 d = SvGROW(sv, off + need + (STRLEN)(send - s) + 1) + off;
3785 d = (char*)uvchr_to_utf8((U8*)d, nextuv);
3790 } /* while loop to process each character */
3792 /* terminate the string and set up the sv */
3794 SvCUR_set(sv, d - SvPVX_const(sv));
3795 if (SvCUR(sv) >= SvLEN(sv))
3796 Perl_croak(aTHX_ "panic: constant overflowed allocated space, %"UVuf
3797 " >= %"UVuf, (UV)SvCUR(sv), (UV)SvLEN(sv));
3800 if (IN_ENCODING && !has_utf8) {
3801 sv_recode_to_utf8(sv, _get_encoding());
3807 if (PL_lex_inwhat == OP_TRANS && PL_sublex_info.sub_op) {
3808 PL_sublex_info.sub_op->op_private |=
3809 (PL_lex_repl ? OPpTRANS_FROM_UTF : OPpTRANS_TO_UTF);
3813 /* shrink the sv if we allocated more than we used */
3814 if (SvCUR(sv) + 5 < SvLEN(sv)) {
3815 SvPV_shrink_to_cur(sv);
3818 /* return the substring (via pl_yylval) only if we parsed anything */
3821 for (; s2 < s; s2++) {
3823 COPLINE_INC_WITH_HERELINES;
3825 SvREFCNT_inc_simple_void_NN(sv);
3826 if ( (PL_hints & ( PL_lex_inpat ? HINT_NEW_RE : HINT_NEW_STRING ))
3827 && ! PL_parser->lex_re_reparsing)
3829 const char *const key = PL_lex_inpat ? "qr" : "q";
3830 const STRLEN keylen = PL_lex_inpat ? 2 : 1;
3834 if (PL_lex_inwhat == OP_TRANS) {
3837 } else if (PL_lex_inwhat == OP_SUBST && !PL_lex_inpat) {
3840 } else if (PL_lex_inpat && SvIVX(PL_linestr) == '\'') {
3848 sv = S_new_constant(aTHX_ start, s - start, key, keylen, sv, NULL,
3851 pl_yylval.opval = (OP*)newSVOP(OP_CONST, 0, sv);
3853 LEAVE_with_name("scan_const");
3858 * Returns TRUE if there's more to the expression (e.g., a subscript),
3861 * It deals with "$foo[3]" and /$foo[3]/ and /$foo[0123456789$]+/
3863 * ->[ and ->{ return TRUE
3864 * ->$* ->$#* ->@* ->@[ ->@{ return TRUE if postderef_qq is enabled
3865 * { and [ outside a pattern are always subscripts, so return TRUE
3866 * if we're outside a pattern and it's not { or [, then return FALSE
3867 * if we're in a pattern and the first char is a {
3868 * {4,5} (any digits around the comma) returns FALSE
3869 * if we're in a pattern and the first char is a [
3871 * [SOMETHING] has a funky algorithm to decide whether it's a
3872 * character class or not. It has to deal with things like
3873 * /$foo[-3]/ and /$foo[$bar]/ as well as /$foo[$\d]+/
3874 * anything else returns TRUE
3877 /* This is the one truly awful dwimmer necessary to conflate C and sed. */
3880 S_intuit_more(pTHX_ char *s)
3882 PERL_ARGS_ASSERT_INTUIT_MORE;
3884 if (PL_lex_brackets)
3886 if (*s == '-' && s[1] == '>' && (s[2] == '[' || s[2] == '{'))
3888 if (*s == '-' && s[1] == '>'
3889 && FEATURE_POSTDEREF_QQ_IS_ENABLED
3890 && ( (s[2] == '$' && (s[3] == '*' || (s[3] == '#' && s[4] == '*')))
3891 ||(s[2] == '@' && strchr("*[{",s[3])) ))
3893 if (*s != '{' && *s != '[')
3898 /* In a pattern, so maybe we have {n,m}. */
3906 /* On the other hand, maybe we have a character class */
3909 if (*s == ']' || *s == '^')
3912 /* this is terrifying, and it works */
3915 const char * const send = strchr(s,']');
3916 unsigned char un_char, last_un_char;
3917 char tmpbuf[sizeof PL_tokenbuf * 4];
3919 if (!send) /* has to be an expression */
3921 weight = 2; /* let's weigh the evidence */
3925 else if (isDIGIT(*s)) {
3927 if (isDIGIT(s[1]) && s[2] == ']')
3933 Zero(seen,256,char);
3935 for (; s < send; s++) {
3936 last_un_char = un_char;
3937 un_char = (unsigned char)*s;
3942 weight -= seen[un_char] * 10;
3943 if (isWORDCHAR_lazy_if(s+1,UTF)) {
3945 char *tmp = PL_bufend;
3946 PL_bufend = (char*)send;
3947 scan_ident(s, tmpbuf, sizeof tmpbuf, FALSE);
3949 len = (int)strlen(tmpbuf);
3950 if (len > 1 && gv_fetchpvn_flags(tmpbuf, len,
3951 UTF ? SVf_UTF8 : 0, SVt_PV))
3958 && strchr("[#!%*<>()-=",s[1]))
3960 if (/*{*/ strchr("])} =",s[2]))
3969 if (strchr("wds]",s[1]))
3971 else if (seen[(U8)'\''] || seen[(U8)'"'])
3973 else if (strchr("rnftbxcav",s[1]))
3975 else if (isDIGIT(s[1])) {
3977 while (s[1] && isDIGIT(s[1]))
3987 if (strchr("aA01! ",last_un_char))
3989 if (strchr("zZ79~",s[1]))
3991 if (last_un_char == 255 && (isDIGIT(s[1]) || s[1] == '$'))
3992 weight -= 5; /* cope with negative subscript */
3995 if (!isWORDCHAR(last_un_char)
3996 && !(last_un_char == '$' || last_un_char == '@'
3997 || last_un_char == '&')
3998 && isALPHA(*s) && s[1] && isALPHA(s[1])) {
4002 if (keyword(d, s - d, 0))
4005 if (un_char == last_un_char + 1)
4007 weight -= seen[un_char];
4012 if (weight >= 0) /* probably a character class */
4022 * Does all the checking to disambiguate
4024 * between foo(bar) and bar->foo. Returns 0 if not a method, otherwise
4025 * FUNCMETH (bar->foo(args)) or METHOD (bar->foo args).
4027 * First argument is the stuff after the first token, e.g. "bar".
4029 * Not a method if foo is a filehandle.
4030 * Not a method if foo is a subroutine prototyped to take a filehandle.
4031 * Not a method if it's really "Foo $bar"
4032 * Method if it's "foo $bar"
4033 * Not a method if it's really "print foo $bar"
4034 * Method if it's really "foo package::" (interpreted as package->foo)
4035 * Not a method if bar is known to be a subroutine ("sub bar; foo bar")
4036 * Not a method if bar is a filehandle or package, but is quoted with
4041 S_intuit_method(pTHX_ char *start, SV *ioname, CV *cv)
4043 char *s = start + (*start == '$');
4044 char tmpbuf[sizeof PL_tokenbuf];
4047 /* Mustn't actually add anything to a symbol table.
4048 But also don't want to "initialise" any placeholder
4049 constants that might already be there into full
4050 blown PVGVs with attached PVCV. */
4052 ioname ? gv_fetchsv(ioname, GV_NOADD_NOINIT, SVt_PVCV) : NULL;
4054 PERL_ARGS_ASSERT_INTUIT_METHOD;
4056 if (gv && SvTYPE(gv) == SVt_PVGV && GvIO(gv))
4058 if (cv && SvPOK(cv)) {
4059 const char *proto = CvPROTO(cv);
4061 while (*proto && (isSPACE(*proto) || *proto == ';'))
4068 if (*start == '$') {
4069 if (cv || PL_last_lop_op == OP_PRINT || PL_last_lop_op == OP_SAY
4070 || isUPPER(*PL_tokenbuf))
4075 return *s == '(' ? FUNCMETH : METHOD;
4078 s = scan_word(s, tmpbuf, sizeof tmpbuf, TRUE, &len);
4079 /* start is the beginning of the possible filehandle/object,
4080 * and s is the end of it
4081 * tmpbuf is a copy of it (but with single quotes as double colons)
4084 if (!keyword(tmpbuf, len, 0)) {
4085 if (len > 2 && tmpbuf[len - 2] == ':' && tmpbuf[len - 1] == ':') {
4090 indirgv = gv_fetchpvn_flags(tmpbuf, len, ( UTF ? SVf_UTF8 : 0 ), SVt_PVCV);
4091 if (indirgv && GvCVu(indirgv))
4093 /* filehandle or package name makes it a method */
4094 if (!cv || GvIO(indirgv) || gv_stashpvn(tmpbuf, len, UTF ? SVf_UTF8 : 0)) {
4096 if ((PL_bufend - s) >= 2 && *s == '=' && *(s+1) == '>')
4097 return 0; /* no assumptions -- "=>" quotes bareword */
4099 NEXTVAL_NEXTTOKE.opval = (OP*)newSVOP(OP_CONST, 0,
4100 S_newSV_maybe_utf8(aTHX_ tmpbuf, len));
4101 NEXTVAL_NEXTTOKE.opval->op_private = OPpCONST_BARE;
4105 return *s == '(' ? FUNCMETH : METHOD;
4111 /* Encoded script support. filter_add() effectively inserts a
4112 * 'pre-processing' function into the current source input stream.
4113 * Note that the filter function only applies to the current source file
4114 * (e.g., it will not affect files 'require'd or 'use'd by this one).
4116 * The datasv parameter (which may be NULL) can be used to pass
4117 * private data to this instance of the filter. The filter function
4118 * can recover the SV using the FILTER_DATA macro and use it to
4119 * store private buffers and state information.
4121 * The supplied datasv parameter is upgraded to a PVIO type
4122 * and the IoDIRP/IoANY field is used to store the function pointer,
4123 * and IOf_FAKE_DIRP is enabled on datasv to mark this as such.
4124 * Note that IoTOP_NAME, IoFMT_NAME, IoBOTTOM_NAME, if set for
4125 * private use must be set using malloc'd pointers.
4129 Perl_filter_add(pTHX_ filter_t funcp, SV *datasv)
4137 if (PL_parser->lex_flags & LEX_IGNORE_UTF8_HINTS)
4138 Perl_croak(aTHX_ "Source filters apply only to byte streams");
4140 if (!PL_rsfp_filters)
4141 PL_rsfp_filters = newAV();
4144 SvUPGRADE(datasv, SVt_PVIO);
4145 IoANY(datasv) = FPTR2DPTR(void *, funcp); /* stash funcp into spare field */
4146 IoFLAGS(datasv) |= IOf_FAKE_DIRP;
4147 DEBUG_P(PerlIO_printf(Perl_debug_log, "filter_add func %p (%s)\n",
4148 FPTR2DPTR(void *, IoANY(datasv)),
4149 SvPV_nolen(datasv)));
4150 av_unshift(PL_rsfp_filters, 1);
4151 av_store(PL_rsfp_filters, 0, datasv) ;
4153 !PL_parser->filtered
4154 && PL_parser->lex_flags & LEX_EVALBYTES
4155 && PL_bufptr < PL_bufend
4157 const char *s = PL_bufptr;
4158 while (s < PL_bufend) {
4160 SV *linestr = PL_parser->linestr;
4161 char *buf = SvPVX(linestr);
4162 STRLEN const bufptr_pos = PL_parser->bufptr - buf;
4163 STRLEN const oldbufptr_pos = PL_parser->oldbufptr - buf;
4164 STRLEN const oldoldbufptr_pos=PL_parser->oldoldbufptr-buf;
4165 STRLEN const linestart_pos = PL_parser->linestart - buf;
4166 STRLEN const last_uni_pos =
4167 PL_parser->last_uni ? PL_parser->last_uni - buf : 0;
4168 STRLEN const last_lop_pos =
4169 PL_parser->last_lop ? PL_parser->last_lop - buf : 0;
4170 av_push(PL_rsfp_filters, linestr);
4171 PL_parser->linestr =
4172 newSVpvn(SvPVX(linestr), ++s-SvPVX(linestr));
4173 buf = SvPVX(PL_parser->linestr);
4174 PL_parser->bufend = buf + SvCUR(PL_parser->linestr);
4175 PL_parser->bufptr = buf + bufptr_pos;
4176 PL_parser->oldbufptr = buf + oldbufptr_pos;
4177 PL_parser->oldoldbufptr = buf + oldoldbufptr_pos;
4178 PL_parser->linestart = buf + linestart_pos;
4179 if (PL_parser->last_uni)
4180 PL_parser->last_uni = buf + last_uni_pos;
4181 if (PL_parser->last_lop)
4182 PL_parser->last_lop = buf + last_lop_pos;
4183 SvLEN(linestr) = SvCUR(linestr);
4184 SvCUR(linestr) = s-SvPVX(linestr);
4185 PL_parser->filtered = 1;
4195 /* Delete most recently added instance of this filter function. */
4197 Perl_filter_del(pTHX_ filter_t funcp)
4201 PERL_ARGS_ASSERT_FILTER_DEL;
4204 DEBUG_P(PerlIO_printf(Perl_debug_log, "filter_del func %p",
4205 FPTR2DPTR(void*, funcp)));
4207 if (!PL_parser || !PL_rsfp_filters || AvFILLp(PL_rsfp_filters)<0)
4209 /* if filter is on top of stack (usual case) just pop it off */
4210 datasv = FILTER_DATA(AvFILLp(PL_rsfp_filters));
4211 if (IoANY(datasv) == FPTR2DPTR(void *, funcp)) {
4212 sv_free(av_pop(PL_rsfp_filters));
4216 /* we need to search for the correct entry and clear it */
4217 Perl_die(aTHX_ "filter_del can only delete in reverse order (currently)");
4221 /* Invoke the idxth filter function for the current rsfp. */
4222 /* maxlen 0 = read one text line */
4224 Perl_filter_read(pTHX_ int idx, SV *buf_sv, int maxlen)
4228 /* This API is bad. It should have been using unsigned int for maxlen.
4229 Not sure if we want to change the API, but if not we should sanity
4230 check the value here. */
4231 unsigned int correct_length = maxlen < 0 ? PERL_INT_MAX : maxlen;
4233 PERL_ARGS_ASSERT_FILTER_READ;
4235 if (!PL_parser || !PL_rsfp_filters)
4237 if (idx > AvFILLp(PL_rsfp_filters)) { /* Any more filters? */
4238 /* Provide a default input filter to make life easy. */
4239 /* Note that we append to the line. This is handy. */
4240 DEBUG_P(PerlIO_printf(Perl_debug_log,
4241 "filter_read %d: from rsfp\n", idx));
4242 if (correct_length) {
4245 const int old_len = SvCUR(buf_sv);
4247 /* ensure buf_sv is large enough */
4248 SvGROW(buf_sv, (STRLEN)(old_len + correct_length + 1)) ;
4249 if ((len = PerlIO_read(PL_rsfp, SvPVX(buf_sv) + old_len,
4250 correct_length)) <= 0) {
4251 if (PerlIO_error(PL_rsfp))
4252 return -1; /* error */
4254 return 0 ; /* end of file */
4256 SvCUR_set(buf_sv, old_len + len) ;
4257 SvPVX(buf_sv)[old_len + len] = '\0';
4260 if (sv_gets(buf_sv, PL_rsfp, SvCUR(buf_sv)) == NULL) {
4261 if (PerlIO_error(PL_rsfp))
4262 return -1; /* error */
4264 return 0 ; /* end of file */
4267 return SvCUR(buf_sv);
4269 /* Skip this filter slot if filter has been deleted */
4270 if ( (datasv = FILTER_DATA(idx)) == &PL_sv_undef) {
4271 DEBUG_P(PerlIO_printf(Perl_debug_log,
4272 "filter_read %d: skipped (filter deleted)\n",
4274 return FILTER_READ(idx+1, buf_sv, correct_length); /* recurse */
4276 if (SvTYPE(datasv) != SVt_PVIO) {
4277 if (correct_length) {
4279 const STRLEN remainder = SvLEN(datasv) - SvCUR(datasv);
4280 if (!remainder) return 0; /* eof */
4281 if (correct_length > remainder) correct_length = remainder;
4282 sv_catpvn(buf_sv, SvEND(datasv), correct_length);
4283 SvCUR_set(datasv, SvCUR(datasv) + correct_length);
4286 const char *s = SvEND(datasv);
4287 const char *send = SvPVX(datasv) + SvLEN(datasv);
4295 if (s == send) return 0; /* eof */
4296 sv_catpvn(buf_sv, SvEND(datasv), s-SvEND(datasv));
4297 SvCUR_set(datasv, s-SvPVX(datasv));
4299 return SvCUR(buf_sv);
4301 /* Get function pointer hidden within datasv */
4302 funcp = DPTR2FPTR(filter_t, IoANY(datasv));
4303 DEBUG_P(PerlIO_printf(Perl_debug_log,
4304 "filter_read %d: via function %p (%s)\n",
4305 idx, (void*)datasv, SvPV_nolen_const(datasv)));
4306 /* Call function. The function is expected to */
4307 /* call "FILTER_READ(idx+1, buf_sv)" first. */
4308 /* Return: <0:error, =0:eof, >0:not eof */
4309 return (*funcp)(aTHX_ idx, buf_sv, correct_length);