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_defer (PL_parser->lex_defer)
56 #define PL_lex_dojoin (PL_parser->lex_dojoin)
57 #define PL_lex_formbrack (PL_parser->lex_formbrack)
58 #define PL_lex_inpat (PL_parser->lex_inpat)
59 #define PL_lex_inwhat (PL_parser->lex_inwhat)
60 #define PL_lex_op (PL_parser->lex_op)
61 #define PL_lex_repl (PL_parser->lex_repl)
62 #define PL_lex_starts (PL_parser->lex_starts)
63 #define PL_lex_stuff (PL_parser->lex_stuff)
64 #define PL_multi_start (PL_parser->multi_start)
65 #define PL_multi_open (PL_parser->multi_open)
66 #define PL_multi_close (PL_parser->multi_close)
67 #define PL_preambled (PL_parser->preambled)
68 #define PL_sublex_info (PL_parser->sublex_info)
69 #define PL_linestr (PL_parser->linestr)
70 #define PL_expect (PL_parser->expect)
71 #define PL_copline (PL_parser->copline)
72 #define PL_bufptr (PL_parser->bufptr)
73 #define PL_oldbufptr (PL_parser->oldbufptr)
74 #define PL_oldoldbufptr (PL_parser->oldoldbufptr)
75 #define PL_linestart (PL_parser->linestart)
76 #define PL_bufend (PL_parser->bufend)
77 #define PL_last_uni (PL_parser->last_uni)
78 #define PL_last_lop (PL_parser->last_lop)
79 #define PL_last_lop_op (PL_parser->last_lop_op)
80 #define PL_lex_state (PL_parser->lex_state)
81 #define PL_rsfp (PL_parser->rsfp)
82 #define PL_rsfp_filters (PL_parser->rsfp_filters)
83 #define PL_in_my (PL_parser->in_my)
84 #define PL_in_my_stash (PL_parser->in_my_stash)
85 #define PL_tokenbuf (PL_parser->tokenbuf)
86 #define PL_multi_end (PL_parser->multi_end)
87 #define PL_error_count (PL_parser->error_count)
89 # define PL_nexttoke (PL_parser->nexttoke)
90 # define PL_nexttype (PL_parser->nexttype)
91 # define PL_nextval (PL_parser->nextval)
93 static const char* const ident_too_long = "Identifier too long";
95 # define NEXTVAL_NEXTTOKE PL_nextval[PL_nexttoke]
97 #define XENUMMASK 0x3f
99 #define XFAKEBRACK 0x80
101 #ifdef USE_UTF8_SCRIPTS
102 # define UTF cBOOL(!IN_BYTES)
104 # define UTF cBOOL((PL_linestr && DO_UTF8(PL_linestr)) || ( !(PL_parser->lex_flags & LEX_IGNORE_UTF8_HINTS) && (PL_hints & HINT_UTF8)))
107 /* The maximum number of characters preceding the unrecognized one to display */
108 #define UNRECOGNIZED_PRECEDE_COUNT 10
110 /* In variables named $^X, these are the legal values for X.
111 * 1999-02-27 mjd-perl-patch@plover.com */
112 #define isCONTROLVAR(x) (isUPPER(x) || strchr("[\\]^_?", (x)))
114 #define SPACE_OR_TAB(c) isBLANK_A(c)
116 #define HEXFP_PEEK(s) \
118 (isXDIGIT(s[1]) || isALPHA_FOLD_EQ(s[1], 'p'))) || \
119 isALPHA_FOLD_EQ(s[0], 'p'))
121 /* LEX_* are values for PL_lex_state, the state of the lexer.
122 * They are arranged oddly so that the guard on the switch statement
123 * can get by with a single comparison (if the compiler is smart enough).
125 * These values refer to the various states within a sublex parse,
126 * i.e. within a double quotish string
129 /* #define LEX_NOTPARSING 11 is done in perl.h. */
131 #define LEX_NORMAL 10 /* normal code (ie not within "...") */
132 #define LEX_INTERPNORMAL 9 /* code within a string, eg "$foo[$x+1]" */
133 #define LEX_INTERPCASEMOD 8 /* expecting a \U, \Q or \E etc */
134 #define LEX_INTERPPUSH 7 /* starting a new sublex parse level */
135 #define LEX_INTERPSTART 6 /* expecting the start of a $var */
137 /* at end of code, eg "$x" followed by: */
138 #define LEX_INTERPEND 5 /* ... eg not one of [, { or -> */
139 #define LEX_INTERPENDMAYBE 4 /* ... eg one of [, { or -> */
141 #define LEX_INTERPCONCAT 3 /* expecting anything, eg at start of
142 string or after \E, $foo, etc */
143 #define LEX_INTERPCONST 2 /* NOT USED */
144 #define LEX_FORMLINE 1 /* expecting a format line */
145 #define LEX_KNOWNEXT 0 /* next token known; just return it */
149 static const char* const lex_state_names[] = {
164 #include "keywords.h"
166 /* CLINE is a macro that ensures PL_copline has a sane value */
168 #define CLINE (PL_copline = (CopLINE(PL_curcop) < PL_copline ? CopLINE(PL_curcop) : PL_copline))
171 * Convenience functions to return different tokens and prime the
172 * lexer for the next token. They all take an argument.
174 * TOKEN : generic token (used for '(', DOLSHARP, etc)
175 * OPERATOR : generic operator
176 * AOPERATOR : assignment operator
177 * PREBLOCK : beginning the block after an if, while, foreach, ...
178 * PRETERMBLOCK : beginning a non-code-defining {} block (eg, hash ref)
179 * PREREF : *EXPR where EXPR is not a simple identifier
180 * TERM : expression term
181 * POSTDEREF : postfix dereference (->$* ->@[...] etc.)
182 * LOOPX : loop exiting command (goto, last, dump, etc)
183 * FTST : file test operator
184 * FUN0 : zero-argument function
185 * FUN0OP : zero-argument function, with its op created in this file
186 * FUN1 : not used, except for not, which isn't a UNIOP
187 * BOop : bitwise or or xor
189 * BCop : bitwise complement
190 * SHop : shift operator
191 * PWop : power operator
192 * PMop : pattern-matching operator
193 * Aop : addition-level operator
194 * AopNOASSIGN : addition-level operator that is never part of .=
195 * Mop : multiplication-level operator
196 * Eop : equality-testing operator
197 * Rop : relational operator <= != gt
199 * Also see LOP and lop() below.
202 #ifdef DEBUGGING /* Serve -DT. */
203 # define REPORT(retval) tokereport((I32)retval, &pl_yylval)
205 # define REPORT(retval) (retval)
208 #define TOKEN(retval) return ( PL_bufptr = s, REPORT(retval))
209 #define OPERATOR(retval) return (PL_expect = XTERM, PL_bufptr = s, REPORT(retval))
210 #define AOPERATOR(retval) return ao((PL_expect = XTERM, PL_bufptr = s, retval))
211 #define PREBLOCK(retval) return (PL_expect = XBLOCK,PL_bufptr = s, REPORT(retval))
212 #define PRETERMBLOCK(retval) return (PL_expect = XTERMBLOCK,PL_bufptr = s, REPORT(retval))
213 #define PREREF(retval) return (PL_expect = XREF,PL_bufptr = s, REPORT(retval))
214 #define TERM(retval) return (CLINE, PL_expect = XOPERATOR, PL_bufptr = s, REPORT(retval))
215 #define POSTDEREF(f) return (PL_bufptr = s, S_postderef(aTHX_ REPORT(f),s[1]))
216 #define LOOPX(f) return (PL_bufptr = force_word(s,WORD,TRUE,FALSE), \
218 PL_expect = PL_nexttoke ? XOPERATOR : XTERM, \
220 #define FTST(f) return (pl_yylval.ival=f, PL_expect=XTERMORDORDOR, PL_bufptr=s, REPORT((int)UNIOP))
221 #define FUN0(f) return (pl_yylval.ival=f, PL_expect=XOPERATOR, PL_bufptr=s, REPORT((int)FUNC0))
222 #define FUN0OP(f) return (pl_yylval.opval=f, CLINE, PL_expect=XOPERATOR, PL_bufptr=s, REPORT((int)FUNC0OP))
223 #define FUN1(f) return (pl_yylval.ival=f, PL_expect=XOPERATOR, PL_bufptr=s, REPORT((int)FUNC1))
224 #define BOop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, (int)BITOROP))
225 #define BAop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, (int)BITANDOP))
226 #define BCop(f) return pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr = s, \
228 #define SHop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, (int)SHIFTOP))
229 #define PWop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, (int)POWOP))
230 #define PMop(f) return(pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)MATCHOP))
231 #define Aop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, (int)ADDOP))
232 #define AopNOASSIGN(f) return (pl_yylval.ival=f, PL_bufptr=s, REPORT((int)ADDOP))
233 #define Mop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, (int)MULOP))
234 #define Eop(f) return (pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)EQOP))
235 #define Rop(f) return (pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)RELOP))
237 /* This bit of chicanery makes a unary function followed by
238 * a parenthesis into a function with one argument, highest precedence.
239 * The UNIDOR macro is for unary functions that can be followed by the //
240 * operator (such as C<shift // 0>).
242 #define UNI3(f,x,have_x) { \
243 pl_yylval.ival = f; \
244 if (have_x) PL_expect = x; \
246 PL_last_uni = PL_oldbufptr; \
247 PL_last_lop_op = f; \
249 return REPORT( (int)FUNC1 ); \
251 return REPORT( *s=='(' ? (int)FUNC1 : (int)UNIOP ); \
253 #define UNI(f) UNI3(f,XTERM,1)
254 #define UNIDOR(f) UNI3(f,XTERMORDORDOR,1)
255 #define UNIPROTO(f,optional) { \
256 if (optional) PL_last_uni = PL_oldbufptr; \
260 #define UNIBRACK(f) UNI3(f,0,0)
262 /* grandfather return to old style */
265 if (!PL_lex_allbrackets && PL_lex_fakeeof > LEX_FAKEEOF_LOWLOGIC) \
266 PL_lex_fakeeof = LEX_FAKEEOF_LOWLOGIC; \
267 pl_yylval.ival = (f); \
273 #define COPLINE_INC_WITH_HERELINES \
275 CopLINE_inc(PL_curcop); \
276 if (PL_parser->herelines) \
277 CopLINE(PL_curcop) += PL_parser->herelines, \
278 PL_parser->herelines = 0; \
280 /* Called after scan_str to update CopLINE(PL_curcop), but only when there
281 * is no sublex_push to follow. */
282 #define COPLINE_SET_FROM_MULTI_END \
284 CopLINE_set(PL_curcop, PL_multi_end); \
285 if (PL_multi_end != PL_multi_start) \
286 PL_parser->herelines = 0; \
292 /* how to interpret the pl_yylval associated with the token */
296 TOKENTYPE_OPNUM, /* pl_yylval.ival contains an opcode number */
301 static struct debug_tokens {
303 enum token_type type;
305 } const debug_tokens[] =
307 { ADDOP, TOKENTYPE_OPNUM, "ADDOP" },
308 { ANDAND, TOKENTYPE_NONE, "ANDAND" },
309 { ANDOP, TOKENTYPE_NONE, "ANDOP" },
310 { ANONSUB, TOKENTYPE_IVAL, "ANONSUB" },
311 { ARROW, TOKENTYPE_NONE, "ARROW" },
312 { ASSIGNOP, TOKENTYPE_OPNUM, "ASSIGNOP" },
313 { BITANDOP, TOKENTYPE_OPNUM, "BITANDOP" },
314 { BITOROP, TOKENTYPE_OPNUM, "BITOROP" },
315 { COLONATTR, TOKENTYPE_NONE, "COLONATTR" },
316 { CONTINUE, TOKENTYPE_NONE, "CONTINUE" },
317 { DEFAULT, TOKENTYPE_NONE, "DEFAULT" },
318 { DO, TOKENTYPE_NONE, "DO" },
319 { DOLSHARP, TOKENTYPE_NONE, "DOLSHARP" },
320 { DORDOR, TOKENTYPE_NONE, "DORDOR" },
321 { DOROP, TOKENTYPE_OPNUM, "DOROP" },
322 { DOTDOT, TOKENTYPE_IVAL, "DOTDOT" },
323 { ELSE, TOKENTYPE_NONE, "ELSE" },
324 { ELSIF, TOKENTYPE_IVAL, "ELSIF" },
325 { EQOP, TOKENTYPE_OPNUM, "EQOP" },
326 { FOR, TOKENTYPE_IVAL, "FOR" },
327 { FORMAT, TOKENTYPE_NONE, "FORMAT" },
328 { FORMLBRACK, TOKENTYPE_NONE, "FORMLBRACK" },
329 { FORMRBRACK, TOKENTYPE_NONE, "FORMRBRACK" },
330 { FUNC, TOKENTYPE_OPNUM, "FUNC" },
331 { FUNC0, TOKENTYPE_OPNUM, "FUNC0" },
332 { FUNC0OP, TOKENTYPE_OPVAL, "FUNC0OP" },
333 { FUNC0SUB, TOKENTYPE_OPVAL, "FUNC0SUB" },
334 { FUNC1, TOKENTYPE_OPNUM, "FUNC1" },
335 { FUNCMETH, TOKENTYPE_OPVAL, "FUNCMETH" },
336 { GIVEN, TOKENTYPE_IVAL, "GIVEN" },
337 { HASHBRACK, TOKENTYPE_NONE, "HASHBRACK" },
338 { IF, TOKENTYPE_IVAL, "IF" },
339 { LABEL, TOKENTYPE_PVAL, "LABEL" },
340 { LOCAL, TOKENTYPE_IVAL, "LOCAL" },
341 { LOOPEX, TOKENTYPE_OPNUM, "LOOPEX" },
342 { LSTOP, TOKENTYPE_OPNUM, "LSTOP" },
343 { LSTOPSUB, TOKENTYPE_OPVAL, "LSTOPSUB" },
344 { MATCHOP, TOKENTYPE_OPNUM, "MATCHOP" },
345 { METHOD, TOKENTYPE_OPVAL, "METHOD" },
346 { MULOP, TOKENTYPE_OPNUM, "MULOP" },
347 { MY, TOKENTYPE_IVAL, "MY" },
348 { NOAMP, TOKENTYPE_NONE, "NOAMP" },
349 { NOTOP, TOKENTYPE_NONE, "NOTOP" },
350 { OROP, TOKENTYPE_IVAL, "OROP" },
351 { OROR, TOKENTYPE_NONE, "OROR" },
352 { PACKAGE, TOKENTYPE_NONE, "PACKAGE" },
353 { PLUGEXPR, TOKENTYPE_OPVAL, "PLUGEXPR" },
354 { PLUGSTMT, TOKENTYPE_OPVAL, "PLUGSTMT" },
355 { PMFUNC, TOKENTYPE_OPVAL, "PMFUNC" },
356 { POSTJOIN, TOKENTYPE_NONE, "POSTJOIN" },
357 { POSTDEC, TOKENTYPE_NONE, "POSTDEC" },
358 { POSTINC, TOKENTYPE_NONE, "POSTINC" },
359 { POWOP, TOKENTYPE_OPNUM, "POWOP" },
360 { PREDEC, TOKENTYPE_NONE, "PREDEC" },
361 { PREINC, TOKENTYPE_NONE, "PREINC" },
362 { PRIVATEREF, TOKENTYPE_OPVAL, "PRIVATEREF" },
363 { QWLIST, TOKENTYPE_OPVAL, "QWLIST" },
364 { REFGEN, TOKENTYPE_NONE, "REFGEN" },
365 { RELOP, TOKENTYPE_OPNUM, "RELOP" },
366 { REQUIRE, TOKENTYPE_NONE, "REQUIRE" },
367 { SHIFTOP, TOKENTYPE_OPNUM, "SHIFTOP" },
368 { SUB, TOKENTYPE_NONE, "SUB" },
369 { THING, TOKENTYPE_OPVAL, "THING" },
370 { UMINUS, TOKENTYPE_NONE, "UMINUS" },
371 { UNIOP, TOKENTYPE_OPNUM, "UNIOP" },
372 { UNIOPSUB, TOKENTYPE_OPVAL, "UNIOPSUB" },
373 { UNLESS, TOKENTYPE_IVAL, "UNLESS" },
374 { UNTIL, TOKENTYPE_IVAL, "UNTIL" },
375 { USE, TOKENTYPE_IVAL, "USE" },
376 { WHEN, TOKENTYPE_IVAL, "WHEN" },
377 { WHILE, TOKENTYPE_IVAL, "WHILE" },
378 { WORD, TOKENTYPE_OPVAL, "WORD" },
379 { YADAYADA, TOKENTYPE_IVAL, "YADAYADA" },
380 { 0, TOKENTYPE_NONE, NULL }
383 /* dump the returned token in rv, plus any optional arg in pl_yylval */
386 S_tokereport(pTHX_ I32 rv, const YYSTYPE* lvalp)
388 PERL_ARGS_ASSERT_TOKEREPORT;
391 const char *name = NULL;
392 enum token_type type = TOKENTYPE_NONE;
393 const struct debug_tokens *p;
394 SV* const report = newSVpvs("<== ");
396 for (p = debug_tokens; p->token; p++) {
397 if (p->token == (int)rv) {
404 Perl_sv_catpv(aTHX_ report, name);
405 else if (isGRAPH(rv))
407 Perl_sv_catpvf(aTHX_ report, "'%c'", (char)rv);
409 sv_catpvs(report, " (pending identifier)");
412 sv_catpvs(report, "EOF");
414 Perl_sv_catpvf(aTHX_ report, "?? %"IVdf, (IV)rv);
419 Perl_sv_catpvf(aTHX_ report, "(ival=%"IVdf")", (IV)lvalp->ival);
421 case TOKENTYPE_OPNUM:
422 Perl_sv_catpvf(aTHX_ report, "(ival=op_%s)",
423 PL_op_name[lvalp->ival]);
426 Perl_sv_catpvf(aTHX_ report, "(pval=\"%s\")", lvalp->pval);
428 case TOKENTYPE_OPVAL:
430 Perl_sv_catpvf(aTHX_ report, "(opval=op_%s)",
431 PL_op_name[lvalp->opval->op_type]);
432 if (lvalp->opval->op_type == OP_CONST) {
433 Perl_sv_catpvf(aTHX_ report, " %s",
434 SvPEEK(cSVOPx_sv(lvalp->opval)));
439 sv_catpvs(report, "(opval=null)");
442 PerlIO_printf(Perl_debug_log, "### %s\n\n", SvPV_nolen_const(report));
448 /* print the buffer with suitable escapes */
451 S_printbuf(pTHX_ const char *const fmt, const char *const s)
453 SV* const tmp = newSVpvs("");
455 PERL_ARGS_ASSERT_PRINTBUF;
457 GCC_DIAG_IGNORE(-Wformat-nonliteral); /* fmt checked by caller */
458 PerlIO_printf(Perl_debug_log, fmt, pv_display(tmp, s, strlen(s), 0, 60));
466 S_deprecate_commaless_var_list(pTHX) {
468 deprecate("comma-less variable list");
469 return REPORT(','); /* grandfather non-comma-format format */
475 * This subroutine looks for an '=' next to the operator that has just been
476 * parsed and turns it into an ASSIGNOP if it finds one.
480 S_ao(pTHX_ int toketype)
482 if (*PL_bufptr == '=') {
484 if (toketype == ANDAND)
485 pl_yylval.ival = OP_ANDASSIGN;
486 else if (toketype == OROR)
487 pl_yylval.ival = OP_ORASSIGN;
488 else if (toketype == DORDOR)
489 pl_yylval.ival = OP_DORASSIGN;
492 return REPORT(toketype);
497 * When Perl expects an operator and finds something else, no_op
498 * prints the warning. It always prints "<something> found where
499 * operator expected. It prints "Missing semicolon on previous line?"
500 * if the surprise occurs at the start of the line. "do you need to
501 * predeclare ..." is printed out for code like "sub bar; foo bar $x"
502 * where the compiler doesn't know if foo is a method call or a function.
503 * It prints "Missing operator before end of line" if there's nothing
504 * after the missing operator, or "... before <...>" if there is something
505 * after the missing operator.
507 * PL_bufptr is expected to point to the start of the thing that was found,
508 * and s after the next token or partial token.
512 S_no_op(pTHX_ const char *const what, char *s)
514 char * const oldbp = PL_bufptr;
515 const bool is_first = (PL_oldbufptr == PL_linestart);
517 PERL_ARGS_ASSERT_NO_OP;
523 yywarn(Perl_form(aTHX_ "%s found where operator expected", what), UTF ? SVf_UTF8 : 0);
524 if (ckWARN_d(WARN_SYNTAX)) {
526 Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
527 "\t(Missing semicolon on previous line?)\n");
528 else if (PL_oldoldbufptr && isIDFIRST_lazy_if(PL_oldoldbufptr,UTF)) {
530 for (t = PL_oldoldbufptr; (isWORDCHAR_lazy_if(t,UTF) || *t == ':');
531 t += UTF ? UTF8SKIP(t) : 1)
533 if (t < PL_bufptr && isSPACE(*t))
534 Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
535 "\t(Do you need to predeclare %"UTF8f"?)\n",
536 UTF8fARG(UTF, t - PL_oldoldbufptr, PL_oldoldbufptr));
540 Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
541 "\t(Missing operator before %"UTF8f"?)\n",
542 UTF8fARG(UTF, s - oldbp, oldbp));
550 * Complain about missing quote/regexp/heredoc terminator.
551 * If it's called with NULL then it cauterizes the line buffer.
552 * If we're in a delimited string and the delimiter is a control
553 * character, it's reformatted into a two-char sequence like ^C.
558 S_missingterm(pTHX_ char *s)
563 char * const nl = strrchr(s,'\n');
567 else if ((U8) PL_multi_close < 32) {
569 tmpbuf[1] = (char)toCTRL(PL_multi_close);
574 *tmpbuf = (char)PL_multi_close;
578 q = strchr(s,'"') ? '\'' : '"';
579 Perl_croak(aTHX_ "Can't find string terminator %c%s%c anywhere before EOF",q,s,q);
585 * Check whether the named feature is enabled.
588 Perl_feature_is_enabled(pTHX_ const char *const name, STRLEN namelen)
590 char he_name[8 + MAX_FEATURE_LEN] = "feature_";
592 PERL_ARGS_ASSERT_FEATURE_IS_ENABLED;
594 assert(CURRENT_FEATURE_BUNDLE == FEATURE_BUNDLE_CUSTOM);
596 if (namelen > MAX_FEATURE_LEN)
598 memcpy(&he_name[8], name, namelen);
600 return cBOOL(cop_hints_fetch_pvn(PL_curcop, he_name, 8 + namelen, 0,
601 REFCOUNTED_HE_EXISTS));
605 * experimental text filters for win32 carriage-returns, utf16-to-utf8 and
606 * utf16-to-utf8-reversed.
609 #ifdef PERL_CR_FILTER
613 const char *s = SvPVX_const(sv);
614 const char * const e = s + SvCUR(sv);
616 PERL_ARGS_ASSERT_STRIP_RETURN;
618 /* outer loop optimized to do nothing if there are no CR-LFs */
620 if (*s++ == '\r' && *s == '\n') {
621 /* hit a CR-LF, need to copy the rest */
625 if (*s == '\r' && s[1] == '\n')
636 S_cr_textfilter(pTHX_ int idx, SV *sv, int maxlen)
638 const I32 count = FILTER_READ(idx+1, sv, maxlen);
639 if (count > 0 && !maxlen)
646 =for apidoc Amx|void|lex_start|SV *line|PerlIO *rsfp|U32 flags
648 Creates and initialises a new lexer/parser state object, supplying
649 a context in which to lex and parse from a new source of Perl code.
650 A pointer to the new state object is placed in L</PL_parser>. An entry
651 is made on the save stack so that upon unwinding the new state object
652 will be destroyed and the former value of L</PL_parser> will be restored.
653 Nothing else need be done to clean up the parsing context.
655 The code to be parsed comes from C<line> and C<rsfp>. C<line>, if
656 non-null, provides a string (in SV form) containing code to be parsed.
657 A copy of the string is made, so subsequent modification of C<line>
658 does not affect parsing. C<rsfp>, if non-null, provides an input stream
659 from which code will be read to be parsed. If both are non-null, the
660 code in C<line> comes first and must consist of complete lines of input,
661 and C<rsfp> supplies the remainder of the source.
663 The C<flags> parameter is reserved for future use. Currently it is only
664 used by perl internally, so extensions should always pass zero.
669 /* LEX_START_SAME_FILTER indicates that this is not a new file, so it
670 can share filters with the current parser.
671 LEX_START_DONT_CLOSE indicates that the file handle wasn't opened by the
672 caller, hence isn't owned by the parser, so shouldn't be closed on parser
673 destruction. This is used to handle the case of defaulting to reading the
674 script from the standard input because no filename was given on the command
675 line (without getting confused by situation where STDIN has been closed, so
676 the script handle is opened on fd 0) */
679 Perl_lex_start(pTHX_ SV *line, PerlIO *rsfp, U32 flags)
681 const char *s = NULL;
682 yy_parser *parser, *oparser;
683 if (flags && flags & ~LEX_START_FLAGS)
684 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_start");
686 /* create and initialise a parser */
688 Newxz(parser, 1, yy_parser);
689 parser->old_parser = oparser = PL_parser;
692 parser->stack = NULL;
694 parser->stack_size = 0;
696 /* on scope exit, free this parser and restore any outer one */
698 parser->saved_curcop = PL_curcop;
700 /* initialise lexer state */
702 parser->nexttoke = 0;
703 parser->error_count = oparser ? oparser->error_count : 0;
704 parser->copline = parser->preambling = NOLINE;
705 parser->lex_state = LEX_NORMAL;
706 parser->expect = XSTATE;
708 parser->rsfp_filters =
709 !(flags & LEX_START_SAME_FILTER) || !oparser
711 : MUTABLE_AV(SvREFCNT_inc(
712 oparser->rsfp_filters
713 ? oparser->rsfp_filters
714 : (oparser->rsfp_filters = newAV())
717 Newx(parser->lex_brackstack, 120, char);
718 Newx(parser->lex_casestack, 12, char);
719 *parser->lex_casestack = '\0';
720 Newxz(parser->lex_shared, 1, LEXSHARED);
724 s = SvPV_const(line, len);
725 parser->linestr = flags & LEX_START_COPIED
726 ? SvREFCNT_inc_simple_NN(line)
727 : newSVpvn_flags(s, len, SvUTF8(line));
728 sv_catpvn(parser->linestr, "\n;", rsfp ? 1 : 2);
730 parser->linestr = newSVpvn("\n;", rsfp ? 1 : 2);
732 parser->oldoldbufptr =
735 parser->linestart = SvPVX(parser->linestr);
736 parser->bufend = parser->bufptr + SvCUR(parser->linestr);
737 parser->last_lop = parser->last_uni = NULL;
739 STATIC_ASSERT_STMT(FITS_IN_8_BITS(LEX_IGNORE_UTF8_HINTS|LEX_EVALBYTES
740 |LEX_DONT_CLOSE_RSFP));
741 parser->lex_flags = (U8) (flags & (LEX_IGNORE_UTF8_HINTS|LEX_EVALBYTES
742 |LEX_DONT_CLOSE_RSFP));
744 parser->in_pod = parser->filtered = 0;
748 /* delete a parser object */
751 Perl_parser_free(pTHX_ const yy_parser *parser)
753 PERL_ARGS_ASSERT_PARSER_FREE;
755 PL_curcop = parser->saved_curcop;
756 SvREFCNT_dec(parser->linestr);
758 if (PL_parser->lex_flags & LEX_DONT_CLOSE_RSFP)
759 PerlIO_clearerr(parser->rsfp);
760 else if (parser->rsfp && (!parser->old_parser
761 || (parser->old_parser && parser->rsfp != parser->old_parser->rsfp)))
762 PerlIO_close(parser->rsfp);
763 SvREFCNT_dec(parser->rsfp_filters);
764 SvREFCNT_dec(parser->lex_stuff);
765 SvREFCNT_dec(parser->sublex_info.repl);
767 Safefree(parser->lex_brackstack);
768 Safefree(parser->lex_casestack);
769 Safefree(parser->lex_shared);
770 PL_parser = parser->old_parser;
775 Perl_parser_free_nexttoke_ops(pTHX_ yy_parser *parser, OPSLAB *slab)
777 I32 nexttoke = parser->nexttoke;
778 PERL_ARGS_ASSERT_PARSER_FREE_NEXTTOKE_OPS;
780 if (S_is_opval_token(parser->nexttype[nexttoke] & 0xffff)
781 && parser->nextval[nexttoke].opval
782 && parser->nextval[nexttoke].opval->op_slabbed
783 && OpSLAB(parser->nextval[nexttoke].opval) == slab) {
784 op_free(parser->nextval[nexttoke].opval);
785 parser->nextval[nexttoke].opval = NULL;
792 =for apidoc AmxU|SV *|PL_parser-E<gt>linestr
794 Buffer scalar containing the chunk currently under consideration of the
795 text currently being lexed. This is always a plain string scalar (for
796 which C<SvPOK> is true). It is not intended to be used as a scalar by
797 normal scalar means; instead refer to the buffer directly by the pointer
798 variables described below.
800 The lexer maintains various C<char*> pointers to things in the
801 C<PL_parser-E<gt>linestr> buffer. If C<PL_parser-E<gt>linestr> is ever
802 reallocated, all of these pointers must be updated. Don't attempt to
803 do this manually, but rather use L</lex_grow_linestr> if you need to
804 reallocate the buffer.
806 The content of the text chunk in the buffer is commonly exactly one
807 complete line of input, up to and including a newline terminator,
808 but there are situations where it is otherwise. The octets of the
809 buffer may be intended to be interpreted as either UTF-8 or Latin-1.
810 The function L</lex_bufutf8> tells you which. Do not use the C<SvUTF8>
811 flag on this scalar, which may disagree with it.
813 For direct examination of the buffer, the variable
814 L</PL_parser-E<gt>bufend> points to the end of the buffer. The current
815 lexing position is pointed to by L</PL_parser-E<gt>bufptr>. Direct use
816 of these pointers is usually preferable to examination of the scalar
817 through normal scalar means.
819 =for apidoc AmxU|char *|PL_parser-E<gt>bufend
821 Direct pointer to the end of the chunk of text currently being lexed, the
822 end of the lexer buffer. This is equal to C<SvPVX(PL_parser-E<gt>linestr)
823 + SvCUR(PL_parser-E<gt>linestr)>. A C<NUL> character (zero octet) is
824 always located at the end of the buffer, and does not count as part of
825 the buffer's contents.
827 =for apidoc AmxU|char *|PL_parser-E<gt>bufptr
829 Points to the current position of lexing inside the lexer buffer.
830 Characters around this point may be freely examined, within
831 the range delimited by C<SvPVX(L</PL_parser-E<gt>linestr>)> and
832 L</PL_parser-E<gt>bufend>. The octets of the buffer may be intended to be
833 interpreted as either UTF-8 or Latin-1, as indicated by L</lex_bufutf8>.
835 Lexing code (whether in the Perl core or not) moves this pointer past
836 the characters that it consumes. It is also expected to perform some
837 bookkeeping whenever a newline character is consumed. This movement
838 can be more conveniently performed by the function L</lex_read_to>,
839 which handles newlines appropriately.
841 Interpretation of the buffer's octets can be abstracted out by
842 using the slightly higher-level functions L</lex_peek_unichar> and
843 L</lex_read_unichar>.
845 =for apidoc AmxU|char *|PL_parser-E<gt>linestart
847 Points to the start of the current line inside the lexer buffer.
848 This is useful for indicating at which column an error occurred, and
849 not much else. This must be updated by any lexing code that consumes
850 a newline; the function L</lex_read_to> handles this detail.
856 =for apidoc Amx|bool|lex_bufutf8
858 Indicates whether the octets in the lexer buffer
859 (L</PL_parser-E<gt>linestr>) should be interpreted as the UTF-8 encoding
860 of Unicode characters. If not, they should be interpreted as Latin-1
861 characters. This is analogous to the C<SvUTF8> flag for scalars.
863 In UTF-8 mode, it is not guaranteed that the lexer buffer actually
864 contains valid UTF-8. Lexing code must be robust in the face of invalid
867 The actual C<SvUTF8> flag of the L</PL_parser-E<gt>linestr> scalar
868 is significant, but not the whole story regarding the input character
869 encoding. Normally, when a file is being read, the scalar contains octets
870 and its C<SvUTF8> flag is off, but the octets should be interpreted as
871 UTF-8 if the C<use utf8> pragma is in effect. During a string eval,
872 however, the scalar may have the C<SvUTF8> flag on, and in this case its
873 octets should be interpreted as UTF-8 unless the C<use bytes> pragma
874 is in effect. This logic may change in the future; use this function
875 instead of implementing the logic yourself.
881 Perl_lex_bufutf8(pTHX)
887 =for apidoc Amx|char *|lex_grow_linestr|STRLEN len
889 Reallocates the lexer buffer (L</PL_parser-E<gt>linestr>) to accommodate
890 at least C<len> octets (including terminating C<NUL>). Returns a
891 pointer to the reallocated buffer. This is necessary before making
892 any direct modification of the buffer that would increase its length.
893 L</lex_stuff_pvn> provides a more convenient way to insert text into
896 Do not use C<SvGROW> or C<sv_grow> directly on C<PL_parser-E<gt>linestr>;
897 this function updates all of the lexer's variables that point directly
904 Perl_lex_grow_linestr(pTHX_ STRLEN len)
908 STRLEN bufend_pos, bufptr_pos, oldbufptr_pos, oldoldbufptr_pos;
909 STRLEN linestart_pos, last_uni_pos, last_lop_pos, re_eval_start_pos;
910 linestr = PL_parser->linestr;
911 buf = SvPVX(linestr);
912 if (len <= SvLEN(linestr))
914 bufend_pos = PL_parser->bufend - buf;
915 bufptr_pos = PL_parser->bufptr - buf;
916 oldbufptr_pos = PL_parser->oldbufptr - buf;
917 oldoldbufptr_pos = PL_parser->oldoldbufptr - buf;
918 linestart_pos = PL_parser->linestart - buf;
919 last_uni_pos = PL_parser->last_uni ? PL_parser->last_uni - buf : 0;
920 last_lop_pos = PL_parser->last_lop ? PL_parser->last_lop - buf : 0;
921 re_eval_start_pos = PL_parser->lex_shared->re_eval_start ?
922 PL_parser->lex_shared->re_eval_start - buf : 0;
924 buf = sv_grow(linestr, len);
926 PL_parser->bufend = buf + bufend_pos;
927 PL_parser->bufptr = buf + bufptr_pos;
928 PL_parser->oldbufptr = buf + oldbufptr_pos;
929 PL_parser->oldoldbufptr = buf + oldoldbufptr_pos;
930 PL_parser->linestart = buf + linestart_pos;
931 if (PL_parser->last_uni)
932 PL_parser->last_uni = buf + last_uni_pos;
933 if (PL_parser->last_lop)
934 PL_parser->last_lop = buf + last_lop_pos;
935 if (PL_parser->lex_shared->re_eval_start)
936 PL_parser->lex_shared->re_eval_start = buf + re_eval_start_pos;
941 =for apidoc Amx|void|lex_stuff_pvn|const char *pv|STRLEN len|U32 flags
943 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
944 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
945 reallocating the buffer if necessary. This means that lexing code that
946 runs later will see the characters as if they had appeared in the input.
947 It is not recommended to do this as part of normal parsing, and most
948 uses of this facility run the risk of the inserted characters being
949 interpreted in an unintended manner.
951 The string to be inserted is represented by C<len> octets starting
952 at C<pv>. These octets are interpreted as either UTF-8 or Latin-1,
953 according to whether the C<LEX_STUFF_UTF8> flag is set in C<flags>.
954 The characters are recoded for the lexer buffer, according to how the
955 buffer is currently being interpreted (L</lex_bufutf8>). If a string
956 to be inserted is available as a Perl scalar, the L</lex_stuff_sv>
957 function is more convenient.
963 Perl_lex_stuff_pvn(pTHX_ const char *pv, STRLEN len, U32 flags)
967 PERL_ARGS_ASSERT_LEX_STUFF_PVN;
968 if (flags & ~(LEX_STUFF_UTF8))
969 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_stuff_pvn");
971 if (flags & LEX_STUFF_UTF8) {
974 STRLEN highhalf = 0; /* Count of variants */
975 const char *p, *e = pv+len;
976 for (p = pv; p != e; p++) {
977 if (! UTF8_IS_INVARIANT(*p)) {
983 lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len+highhalf);
984 bufptr = PL_parser->bufptr;
985 Move(bufptr, bufptr+len+highhalf, PL_parser->bufend+1-bufptr, char);
986 SvCUR_set(PL_parser->linestr,
987 SvCUR(PL_parser->linestr) + len+highhalf);
988 PL_parser->bufend += len+highhalf;
989 for (p = pv; p != e; p++) {
991 if (! UTF8_IS_INVARIANT(c)) {
992 *bufptr++ = UTF8_TWO_BYTE_HI(c);
993 *bufptr++ = UTF8_TWO_BYTE_LO(c);
1000 if (flags & LEX_STUFF_UTF8) {
1001 STRLEN highhalf = 0;
1002 const char *p, *e = pv+len;
1003 for (p = pv; p != e; p++) {
1005 if (UTF8_IS_ABOVE_LATIN1(c)) {
1006 Perl_croak(aTHX_ "Lexing code attempted to stuff "
1007 "non-Latin-1 character into Latin-1 input");
1008 } else if (UTF8_IS_NEXT_CHAR_DOWNGRADEABLE(p, e)) {
1011 } else if (! UTF8_IS_INVARIANT(c)) {
1012 /* malformed UTF-8 */
1014 SAVESPTR(PL_warnhook);
1015 PL_warnhook = PERL_WARNHOOK_FATAL;
1016 utf8n_to_uvchr((U8*)p, e-p, NULL, 0);
1022 lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len-highhalf);
1023 bufptr = PL_parser->bufptr;
1024 Move(bufptr, bufptr+len-highhalf, PL_parser->bufend+1-bufptr, char);
1025 SvCUR_set(PL_parser->linestr,
1026 SvCUR(PL_parser->linestr) + len-highhalf);
1027 PL_parser->bufend += len-highhalf;
1030 if (UTF8_IS_INVARIANT(*p)) {
1036 *bufptr++ = EIGHT_BIT_UTF8_TO_NATIVE(*p, *(p+1));
1042 lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len);
1043 bufptr = PL_parser->bufptr;
1044 Move(bufptr, bufptr+len, PL_parser->bufend+1-bufptr, char);
1045 SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) + len);
1046 PL_parser->bufend += len;
1047 Copy(pv, bufptr, len, char);
1053 =for apidoc Amx|void|lex_stuff_pv|const char *pv|U32 flags
1055 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
1056 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
1057 reallocating the buffer if necessary. This means that lexing code that
1058 runs later will see the characters as if they had appeared in the input.
1059 It is not recommended to do this as part of normal parsing, and most
1060 uses of this facility run the risk of the inserted characters being
1061 interpreted in an unintended manner.
1063 The string to be inserted is represented by octets starting at C<pv>
1064 and continuing to the first nul. These octets are interpreted as either
1065 UTF-8 or Latin-1, according to whether the C<LEX_STUFF_UTF8> flag is set
1066 in C<flags>. The characters are recoded for the lexer buffer, according
1067 to how the buffer is currently being interpreted (L</lex_bufutf8>).
1068 If it is not convenient to nul-terminate a string to be inserted, the
1069 L</lex_stuff_pvn> function is more appropriate.
1075 Perl_lex_stuff_pv(pTHX_ const char *pv, U32 flags)
1077 PERL_ARGS_ASSERT_LEX_STUFF_PV;
1078 lex_stuff_pvn(pv, strlen(pv), flags);
1082 =for apidoc Amx|void|lex_stuff_sv|SV *sv|U32 flags
1084 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
1085 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
1086 reallocating the buffer if necessary. This means that lexing code that
1087 runs later will see the characters as if they had appeared in the input.
1088 It is not recommended to do this as part of normal parsing, and most
1089 uses of this facility run the risk of the inserted characters being
1090 interpreted in an unintended manner.
1092 The string to be inserted is the string value of C<sv>. The characters
1093 are recoded for the lexer buffer, according to how the buffer is currently
1094 being interpreted (L</lex_bufutf8>). If a string to be inserted is
1095 not already a Perl scalar, the L</lex_stuff_pvn> function avoids the
1096 need to construct a scalar.
1102 Perl_lex_stuff_sv(pTHX_ SV *sv, U32 flags)
1106 PERL_ARGS_ASSERT_LEX_STUFF_SV;
1108 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_stuff_sv");
1110 lex_stuff_pvn(pv, len, flags | (SvUTF8(sv) ? LEX_STUFF_UTF8 : 0));
1114 =for apidoc Amx|void|lex_unstuff|char *ptr
1116 Discards text about to be lexed, from L</PL_parser-E<gt>bufptr> up to
1117 C<ptr>. Text following C<ptr> will be moved, and the buffer shortened.
1118 This hides the discarded text from any lexing code that runs later,
1119 as if the text had never appeared.
1121 This is not the normal way to consume lexed text. For that, use
1128 Perl_lex_unstuff(pTHX_ char *ptr)
1132 PERL_ARGS_ASSERT_LEX_UNSTUFF;
1133 buf = PL_parser->bufptr;
1135 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_unstuff");
1138 bufend = PL_parser->bufend;
1140 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_unstuff");
1141 unstuff_len = ptr - buf;
1142 Move(ptr, buf, bufend+1-ptr, char);
1143 SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) - unstuff_len);
1144 PL_parser->bufend = bufend - unstuff_len;
1148 =for apidoc Amx|void|lex_read_to|char *ptr
1150 Consume text in the lexer buffer, from L</PL_parser-E<gt>bufptr> up
1151 to C<ptr>. This advances L</PL_parser-E<gt>bufptr> to match C<ptr>,
1152 performing the correct bookkeeping whenever a newline character is passed.
1153 This is the normal way to consume lexed text.
1155 Interpretation of the buffer's octets can be abstracted out by
1156 using the slightly higher-level functions L</lex_peek_unichar> and
1157 L</lex_read_unichar>.
1163 Perl_lex_read_to(pTHX_ char *ptr)
1166 PERL_ARGS_ASSERT_LEX_READ_TO;
1167 s = PL_parser->bufptr;
1168 if (ptr < s || ptr > PL_parser->bufend)
1169 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_to");
1170 for (; s != ptr; s++)
1172 COPLINE_INC_WITH_HERELINES;
1173 PL_parser->linestart = s+1;
1175 PL_parser->bufptr = ptr;
1179 =for apidoc Amx|void|lex_discard_to|char *ptr
1181 Discards the first part of the L</PL_parser-E<gt>linestr> buffer,
1182 up to C<ptr>. The remaining content of the buffer will be moved, and
1183 all pointers into the buffer updated appropriately. C<ptr> must not
1184 be later in the buffer than the position of L</PL_parser-E<gt>bufptr>:
1185 it is not permitted to discard text that has yet to be lexed.
1187 Normally it is not necessarily to do this directly, because it suffices to
1188 use the implicit discarding behaviour of L</lex_next_chunk> and things
1189 based on it. However, if a token stretches across multiple lines,
1190 and the lexing code has kept multiple lines of text in the buffer for
1191 that purpose, then after completion of the token it would be wise to
1192 explicitly discard the now-unneeded earlier lines, to avoid future
1193 multi-line tokens growing the buffer without bound.
1199 Perl_lex_discard_to(pTHX_ char *ptr)
1203 PERL_ARGS_ASSERT_LEX_DISCARD_TO;
1204 buf = SvPVX(PL_parser->linestr);
1206 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_discard_to");
1209 if (ptr > PL_parser->bufptr)
1210 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_discard_to");
1211 discard_len = ptr - buf;
1212 if (PL_parser->oldbufptr < ptr)
1213 PL_parser->oldbufptr = ptr;
1214 if (PL_parser->oldoldbufptr < ptr)
1215 PL_parser->oldoldbufptr = ptr;
1216 if (PL_parser->last_uni && PL_parser->last_uni < ptr)
1217 PL_parser->last_uni = NULL;
1218 if (PL_parser->last_lop && PL_parser->last_lop < ptr)
1219 PL_parser->last_lop = NULL;
1220 Move(ptr, buf, PL_parser->bufend+1-ptr, char);
1221 SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) - discard_len);
1222 PL_parser->bufend -= discard_len;
1223 PL_parser->bufptr -= discard_len;
1224 PL_parser->oldbufptr -= discard_len;
1225 PL_parser->oldoldbufptr -= discard_len;
1226 if (PL_parser->last_uni)
1227 PL_parser->last_uni -= discard_len;
1228 if (PL_parser->last_lop)
1229 PL_parser->last_lop -= discard_len;
1233 =for apidoc Amx|bool|lex_next_chunk|U32 flags
1235 Reads in the next chunk of text to be lexed, appending it to
1236 L</PL_parser-E<gt>linestr>. This should be called when lexing code has
1237 looked to the end of the current chunk and wants to know more. It is
1238 usual, but not necessary, for lexing to have consumed the entirety of
1239 the current chunk at this time.
1241 If L</PL_parser-E<gt>bufptr> is pointing to the very end of the current
1242 chunk (i.e., the current chunk has been entirely consumed), normally the
1243 current chunk will be discarded at the same time that the new chunk is
1244 read in. If C<flags> has the C<LEX_KEEP_PREVIOUS> bit set, the current chunk
1245 will not be discarded. If the current chunk has not been entirely
1246 consumed, then it will not be discarded regardless of the flag.
1248 Returns true if some new text was added to the buffer, or false if the
1249 buffer has reached the end of the input text.
1254 #define LEX_FAKE_EOF 0x80000000
1255 #define LEX_NO_TERM 0x40000000 /* here-doc */
1258 Perl_lex_next_chunk(pTHX_ U32 flags)
1262 STRLEN old_bufend_pos, new_bufend_pos;
1263 STRLEN bufptr_pos, oldbufptr_pos, oldoldbufptr_pos;
1264 STRLEN linestart_pos, last_uni_pos, last_lop_pos;
1265 bool got_some_for_debugger = 0;
1267 if (flags & ~(LEX_KEEP_PREVIOUS|LEX_FAKE_EOF|LEX_NO_TERM))
1268 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_next_chunk");
1269 if (!(flags & LEX_NO_TERM) && PL_lex_inwhat)
1271 linestr = PL_parser->linestr;
1272 buf = SvPVX(linestr);
1273 if (!(flags & LEX_KEEP_PREVIOUS)
1274 && PL_parser->bufptr == PL_parser->bufend)
1276 old_bufend_pos = bufptr_pos = oldbufptr_pos = oldoldbufptr_pos = 0;
1278 if (PL_parser->last_uni != PL_parser->bufend)
1279 PL_parser->last_uni = NULL;
1280 if (PL_parser->last_lop != PL_parser->bufend)
1281 PL_parser->last_lop = NULL;
1282 last_uni_pos = last_lop_pos = 0;
1286 old_bufend_pos = PL_parser->bufend - buf;
1287 bufptr_pos = PL_parser->bufptr - buf;
1288 oldbufptr_pos = PL_parser->oldbufptr - buf;
1289 oldoldbufptr_pos = PL_parser->oldoldbufptr - buf;
1290 linestart_pos = PL_parser->linestart - buf;
1291 last_uni_pos = PL_parser->last_uni ? PL_parser->last_uni - buf : 0;
1292 last_lop_pos = PL_parser->last_lop ? PL_parser->last_lop - buf : 0;
1294 if (flags & LEX_FAKE_EOF) {
1296 } else if (!PL_parser->rsfp && !PL_parser->filtered) {
1298 } else if (filter_gets(linestr, old_bufend_pos)) {
1300 got_some_for_debugger = 1;
1301 } else if (flags & LEX_NO_TERM) {
1304 if (!SvPOK(linestr)) /* can get undefined by filter_gets */
1305 sv_setpvs(linestr, "");
1307 /* End of real input. Close filehandle (unless it was STDIN),
1308 * then add implicit termination.
1310 if (PL_parser->lex_flags & LEX_DONT_CLOSE_RSFP)
1311 PerlIO_clearerr(PL_parser->rsfp);
1312 else if (PL_parser->rsfp)
1313 (void)PerlIO_close(PL_parser->rsfp);
1314 PL_parser->rsfp = NULL;
1315 PL_parser->in_pod = PL_parser->filtered = 0;
1316 if (!PL_in_eval && PL_minus_p) {
1318 /*{*/";}continue{print or die qq(-p destination: $!\\n);}");
1319 PL_minus_n = PL_minus_p = 0;
1320 } else if (!PL_in_eval && PL_minus_n) {
1321 sv_catpvs(linestr, /*{*/";}");
1324 sv_catpvs(linestr, ";");
1327 buf = SvPVX(linestr);
1328 new_bufend_pos = SvCUR(linestr);
1329 PL_parser->bufend = buf + new_bufend_pos;
1330 PL_parser->bufptr = buf + bufptr_pos;
1331 PL_parser->oldbufptr = buf + oldbufptr_pos;
1332 PL_parser->oldoldbufptr = buf + oldoldbufptr_pos;
1333 PL_parser->linestart = buf + linestart_pos;
1334 if (PL_parser->last_uni)
1335 PL_parser->last_uni = buf + last_uni_pos;
1336 if (PL_parser->last_lop)
1337 PL_parser->last_lop = buf + last_lop_pos;
1338 if (PL_parser->preambling != NOLINE) {
1339 CopLINE_set(PL_curcop, PL_parser->preambling + 1);
1340 PL_parser->preambling = NOLINE;
1342 if ( got_some_for_debugger
1343 && PERLDB_LINE_OR_SAVESRC
1344 && PL_curstash != PL_debstash)
1346 /* debugger active and we're not compiling the debugger code,
1347 * so store the line into the debugger's array of lines
1349 update_debugger_info(NULL, buf+old_bufend_pos,
1350 new_bufend_pos-old_bufend_pos);
1356 =for apidoc Amx|I32|lex_peek_unichar|U32 flags
1358 Looks ahead one (Unicode) character in the text currently being lexed.
1359 Returns the codepoint (unsigned integer value) of the next character,
1360 or -1 if lexing has reached the end of the input text. To consume the
1361 peeked character, use L</lex_read_unichar>.
1363 If the next character is in (or extends into) the next chunk of input
1364 text, the next chunk will be read in. Normally the current chunk will be
1365 discarded at the same time, but if C<flags> has the C<LEX_KEEP_PREVIOUS>
1366 bit set, then the current chunk will not be discarded.
1368 If the input is being interpreted as UTF-8 and a UTF-8 encoding error
1369 is encountered, an exception is generated.
1375 Perl_lex_peek_unichar(pTHX_ U32 flags)
1379 if (flags & ~(LEX_KEEP_PREVIOUS))
1380 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_peek_unichar");
1381 s = PL_parser->bufptr;
1382 bufend = PL_parser->bufend;
1388 if (!lex_next_chunk(flags))
1390 s = PL_parser->bufptr;
1391 bufend = PL_parser->bufend;
1394 if (UTF8_IS_INVARIANT(head))
1396 if (UTF8_IS_START(head)) {
1397 len = UTF8SKIP(&head);
1398 while ((STRLEN)(bufend-s) < len) {
1399 if (!lex_next_chunk(flags | LEX_KEEP_PREVIOUS))
1401 s = PL_parser->bufptr;
1402 bufend = PL_parser->bufend;
1405 unichar = utf8n_to_uvchr((U8*)s, bufend-s, &retlen, UTF8_CHECK_ONLY);
1406 if (retlen == (STRLEN)-1) {
1407 /* malformed UTF-8 */
1409 SAVESPTR(PL_warnhook);
1410 PL_warnhook = PERL_WARNHOOK_FATAL;
1411 utf8n_to_uvchr((U8*)s, bufend-s, NULL, 0);
1417 if (!lex_next_chunk(flags))
1419 s = PL_parser->bufptr;
1426 =for apidoc Amx|I32|lex_read_unichar|U32 flags
1428 Reads the next (Unicode) character in the text currently being lexed.
1429 Returns the codepoint (unsigned integer value) of the character read,
1430 and moves L</PL_parser-E<gt>bufptr> past the character, or returns -1
1431 if lexing has reached the end of the input text. To non-destructively
1432 examine the next character, use L</lex_peek_unichar> instead.
1434 If the next character is in (or extends into) the next chunk of input
1435 text, the next chunk will be read in. Normally the current chunk will be
1436 discarded at the same time, but if C<flags> has the C<LEX_KEEP_PREVIOUS>
1437 bit set, then the current chunk will not be discarded.
1439 If the input is being interpreted as UTF-8 and a UTF-8 encoding error
1440 is encountered, an exception is generated.
1446 Perl_lex_read_unichar(pTHX_ U32 flags)
1449 if (flags & ~(LEX_KEEP_PREVIOUS))
1450 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_unichar");
1451 c = lex_peek_unichar(flags);
1454 COPLINE_INC_WITH_HERELINES;
1456 PL_parser->bufptr += UTF8SKIP(PL_parser->bufptr);
1458 ++(PL_parser->bufptr);
1464 =for apidoc Amx|void|lex_read_space|U32 flags
1466 Reads optional spaces, in Perl style, in the text currently being
1467 lexed. The spaces may include ordinary whitespace characters and
1468 Perl-style comments. C<#line> directives are processed if encountered.
1469 L</PL_parser-E<gt>bufptr> is moved past the spaces, so that it points
1470 at a non-space character (or the end of the input text).
1472 If spaces extend into the next chunk of input text, the next chunk will
1473 be read in. Normally the current chunk will be discarded at the same
1474 time, but if C<flags> has the C<LEX_KEEP_PREVIOUS> bit set, then the current
1475 chunk will not be discarded.
1480 #define LEX_NO_INCLINE 0x40000000
1481 #define LEX_NO_NEXT_CHUNK 0x80000000
1484 Perl_lex_read_space(pTHX_ U32 flags)
1487 const bool can_incline = !(flags & LEX_NO_INCLINE);
1488 bool need_incline = 0;
1489 if (flags & ~(LEX_KEEP_PREVIOUS|LEX_NO_NEXT_CHUNK|LEX_NO_INCLINE))
1490 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_space");
1491 s = PL_parser->bufptr;
1492 bufend = PL_parser->bufend;
1498 } while (!(c == '\n' || (c == 0 && s == bufend)));
1499 } else if (c == '\n') {
1502 PL_parser->linestart = s;
1508 } else if (isSPACE(c)) {
1510 } else if (c == 0 && s == bufend) {
1513 if (flags & LEX_NO_NEXT_CHUNK)
1515 PL_parser->bufptr = s;
1516 l = CopLINE(PL_curcop);
1517 CopLINE(PL_curcop) += PL_parser->herelines + 1;
1518 got_more = lex_next_chunk(flags);
1519 CopLINE_set(PL_curcop, l);
1520 s = PL_parser->bufptr;
1521 bufend = PL_parser->bufend;
1524 if (can_incline && need_incline && PL_parser->rsfp) {
1534 PL_parser->bufptr = s;
1539 =for apidoc EXMp|bool|validate_proto|SV *name|SV *proto|bool warn
1541 This function performs syntax checking on a prototype, C<proto>.
1542 If C<warn> is true, any illegal characters or mismatched brackets
1543 will trigger illegalproto warnings, declaring that they were
1544 detected in the prototype for C<name>.
1546 The return value is C<true> if this is a valid prototype, and
1547 C<false> if it is not, regardless of whether C<warn> was C<true> or
1550 Note that C<NULL> is a valid C<proto> and will always return C<true>.
1557 Perl_validate_proto(pTHX_ SV *name, SV *proto, bool warn)
1559 STRLEN len, origlen;
1560 char *p = proto ? SvPV(proto, len) : NULL;
1561 bool bad_proto = FALSE;
1562 bool in_brackets = FALSE;
1563 bool after_slash = FALSE;
1564 char greedy_proto = ' ';
1565 bool proto_after_greedy_proto = FALSE;
1566 bool must_be_last = FALSE;
1567 bool underscore = FALSE;
1568 bool bad_proto_after_underscore = FALSE;
1570 PERL_ARGS_ASSERT_VALIDATE_PROTO;
1576 for (; len--; p++) {
1579 proto_after_greedy_proto = TRUE;
1581 if (!strchr(";@%", *p))
1582 bad_proto_after_underscore = TRUE;
1585 if (!strchr("$@%*;[]&\\_+", *p) || *p == '\0') {
1592 in_brackets = FALSE;
1593 else if ((*p == '@' || *p == '%')
1597 must_be_last = TRUE;
1606 after_slash = FALSE;
1611 SV *tmpsv = newSVpvs_flags("", SVs_TEMP);
1614 ? sv_uni_display(tmpsv, newSVpvn_flags(p, origlen, SVs_TEMP | SVf_UTF8),
1615 origlen, UNI_DISPLAY_ISPRINT)
1616 : pv_pretty(tmpsv, p, origlen, 60, NULL, NULL, PERL_PV_ESCAPE_NONASCII);
1618 if (proto_after_greedy_proto)
1619 Perl_warner(aTHX_ packWARN(WARN_ILLEGALPROTO),
1620 "Prototype after '%c' for %"SVf" : %s",
1621 greedy_proto, SVfARG(name), p);
1623 Perl_warner(aTHX_ packWARN(WARN_ILLEGALPROTO),
1624 "Missing ']' in prototype for %"SVf" : %s",
1627 Perl_warner(aTHX_ packWARN(WARN_ILLEGALPROTO),
1628 "Illegal character in prototype for %"SVf" : %s",
1630 if (bad_proto_after_underscore)
1631 Perl_warner(aTHX_ packWARN(WARN_ILLEGALPROTO),
1632 "Illegal character after '_' in prototype for %"SVf" : %s",
1636 return (! (proto_after_greedy_proto || bad_proto) );
1641 * This subroutine has nothing to do with tilting, whether at windmills
1642 * or pinball tables. Its name is short for "increment line". It
1643 * increments the current line number in CopLINE(PL_curcop) and checks
1644 * to see whether the line starts with a comment of the form
1645 * # line 500 "foo.pm"
1646 * If so, it sets the current line number and file to the values in the comment.
1650 S_incline(pTHX_ const char *s)
1658 PERL_ARGS_ASSERT_INCLINE;
1660 COPLINE_INC_WITH_HERELINES;
1661 if (!PL_rsfp && !PL_parser->filtered && PL_lex_state == LEX_NORMAL
1662 && s+1 == PL_bufend && *s == ';') {
1663 /* fake newline in string eval */
1664 CopLINE_dec(PL_curcop);
1669 while (SPACE_OR_TAB(*s))
1671 if (strnEQ(s, "line", 4))
1675 if (SPACE_OR_TAB(*s))
1679 while (SPACE_OR_TAB(*s))
1687 if (!SPACE_OR_TAB(*s) && *s != '\r' && *s != '\n' && *s != '\0')
1689 while (SPACE_OR_TAB(*s))
1691 if (*s == '"' && (t = strchr(s+1, '"'))) {
1697 while (!isSPACE(*t))
1701 while (SPACE_OR_TAB(*e) || *e == '\r' || *e == '\f')
1703 if (*e != '\n' && *e != '\0')
1704 return; /* false alarm */
1706 if (!grok_atoUV(n, &uv, &e))
1708 line_num = ((line_t)uv) - 1;
1711 const STRLEN len = t - s;
1713 if (!PL_rsfp && !PL_parser->filtered) {
1714 /* must copy *{"::_<(eval N)[oldfilename:L]"}
1715 * to *{"::_<newfilename"} */
1716 /* However, the long form of evals is only turned on by the
1717 debugger - usually they're "(eval %lu)" */
1718 GV * const cfgv = CopFILEGV(PL_curcop);
1721 STRLEN tmplen2 = len;
1725 if (tmplen2 + 2 <= sizeof smallbuf)
1728 Newx(tmpbuf2, tmplen2 + 2, char);
1733 memcpy(tmpbuf2 + 2, s, tmplen2);
1736 gv2 = *(GV**)hv_fetch(PL_defstash, tmpbuf2, tmplen2, TRUE);
1738 gv_init(gv2, PL_defstash, tmpbuf2, tmplen2, FALSE);
1739 /* adjust ${"::_<newfilename"} to store the new file name */
1740 GvSV(gv2) = newSVpvn(tmpbuf2 + 2, tmplen2 - 2);
1741 /* The line number may differ. If that is the case,
1742 alias the saved lines that are in the array.
1743 Otherwise alias the whole array. */
1744 if (CopLINE(PL_curcop) == line_num) {
1745 GvHV(gv2) = MUTABLE_HV(SvREFCNT_inc(GvHV(cfgv)));
1746 GvAV(gv2) = MUTABLE_AV(SvREFCNT_inc(GvAV(cfgv)));
1748 else if (GvAV(cfgv)) {
1749 AV * const av = GvAV(cfgv);
1750 const I32 start = CopLINE(PL_curcop)+1;
1751 I32 items = AvFILLp(av) - start;
1753 AV * const av2 = GvAVn(gv2);
1754 SV **svp = AvARRAY(av) + start;
1755 I32 l = (I32)line_num+1;
1757 av_store(av2, l++, SvREFCNT_inc(*svp++));
1762 if (tmpbuf2 != smallbuf) Safefree(tmpbuf2);
1765 CopFILE_free(PL_curcop);
1766 CopFILE_setn(PL_curcop, s, len);
1768 CopLINE_set(PL_curcop, line_num);
1771 #define skipspace(s) skipspace_flags(s, 0)
1775 S_update_debugger_info(pTHX_ SV *orig_sv, const char *const buf, STRLEN len)
1777 AV *av = CopFILEAVx(PL_curcop);
1780 if (PL_parser->preambling == NOLINE) sv = newSV_type(SVt_PVMG);
1782 sv = *av_fetch(av, 0, 1);
1783 SvUPGRADE(sv, SVt_PVMG);
1785 if (!SvPOK(sv)) sv_setpvs(sv,"");
1787 sv_catsv(sv, orig_sv);
1789 sv_catpvn(sv, buf, len);
1794 if (PL_parser->preambling == NOLINE)
1795 av_store(av, CopLINE(PL_curcop), sv);
1801 * Called to gobble the appropriate amount and type of whitespace.
1802 * Skips comments as well.
1806 S_skipspace_flags(pTHX_ char *s, U32 flags)
1808 PERL_ARGS_ASSERT_SKIPSPACE_FLAGS;
1809 if (PL_lex_formbrack && PL_lex_brackets <= PL_lex_formbrack) {
1810 while (s < PL_bufend && (SPACE_OR_TAB(*s) || !*s))
1813 STRLEN bufptr_pos = PL_bufptr - SvPVX(PL_linestr);
1815 lex_read_space(flags | LEX_KEEP_PREVIOUS |
1816 (PL_lex_inwhat || PL_lex_state == LEX_FORMLINE ?
1817 LEX_NO_NEXT_CHUNK : 0));
1819 PL_bufptr = SvPVX(PL_linestr) + bufptr_pos;
1820 if (PL_linestart > PL_bufptr)
1821 PL_bufptr = PL_linestart;
1829 * Check the unary operators to ensure there's no ambiguity in how they're
1830 * used. An ambiguous piece of code would be:
1832 * This doesn't mean rand() + 5. Because rand() is a unary operator,
1833 * the +5 is its argument.
1842 if (PL_oldoldbufptr != PL_last_uni)
1844 while (isSPACE(*PL_last_uni))
1847 while (isWORDCHAR_lazy_if(s,UTF) || *s == '-')
1848 s += UTF ? UTF8SKIP(s) : 1;
1849 if ((t = strchr(s, '(')) && t < PL_bufptr)
1852 Perl_ck_warner_d(aTHX_ packWARN(WARN_AMBIGUOUS),
1853 "Warning: Use of \"%"UTF8f"\" without parentheses is ambiguous",
1854 UTF8fARG(UTF, (int)(s - PL_last_uni), PL_last_uni));
1858 * LOP : macro to build a list operator. Its behaviour has been replaced
1859 * with a subroutine, S_lop() for which LOP is just another name.
1862 #define LOP(f,x) return lop(f,x,s)
1866 * Build a list operator (or something that might be one). The rules:
1867 * - if we have a next token, then it's a list operator (no parens) for
1868 * which the next token has already been parsed; e.g.,
1871 * - if the next thing is an opening paren, then it's a function
1872 * - else it's a list operator
1876 S_lop(pTHX_ I32 f, int x, char *s)
1878 PERL_ARGS_ASSERT_LOP;
1883 PL_last_lop = PL_oldbufptr;
1884 PL_last_lop_op = (OPCODE)f;
1889 return REPORT(FUNC);
1892 return REPORT(FUNC);
1895 if (!PL_lex_allbrackets && PL_lex_fakeeof > LEX_FAKEEOF_LOWLOGIC)
1896 PL_lex_fakeeof = LEX_FAKEEOF_LOWLOGIC;
1897 return REPORT(LSTOP);
1903 * When the lexer realizes it knows the next token (for instance,
1904 * it is reordering tokens for the parser) then it can call S_force_next
1905 * to know what token to return the next time the lexer is called. Caller
1906 * will need to set PL_nextval[] and possibly PL_expect to ensure
1907 * the lexer handles the token correctly.
1911 S_force_next(pTHX_ I32 type)
1915 PerlIO_printf(Perl_debug_log, "### forced token:\n");
1916 tokereport(type, &NEXTVAL_NEXTTOKE);
1919 assert(PL_nexttoke < C_ARRAY_LENGTH(PL_nexttype));
1920 PL_nexttype[PL_nexttoke] = type;
1922 if (PL_lex_state != LEX_KNOWNEXT) {
1923 PL_lex_defer = PL_lex_state;
1924 PL_lex_state = LEX_KNOWNEXT;
1931 * This subroutine handles postfix deref syntax after the arrow has already
1932 * been emitted. @* $* etc. are emitted as two separate token right here.
1933 * @[ @{ %[ %{ *{ are emitted also as two tokens, but this function emits
1934 * only the first, leaving yylex to find the next.
1938 S_postderef(pTHX_ int const funny, char const next)
1940 assert(funny == DOLSHARP || strchr("$@%&*", funny));
1941 assert(strchr("*[{", next));
1943 PL_expect = XOPERATOR;
1944 if (PL_lex_state == LEX_INTERPNORMAL && !PL_lex_brackets) {
1945 assert('@' == funny || '$' == funny || DOLSHARP == funny);
1946 PL_lex_state = LEX_INTERPEND;
1947 force_next(POSTJOIN);
1953 if ('@' == funny && PL_lex_state == LEX_INTERPNORMAL
1954 && !PL_lex_brackets)
1956 PL_expect = XOPERATOR;
1965 int yyc = PL_parser->yychar;
1966 if (yyc != YYEMPTY) {
1968 NEXTVAL_NEXTTOKE = PL_parser->yylval;
1969 if (yyc == '{'/*}*/ || yyc == HASHBRACK || yyc == '['/*]*/) {
1970 PL_lex_allbrackets--;
1972 yyc |= (3<<24) | (PL_lex_brackstack[PL_lex_brackets] << 16);
1973 } else if (yyc == '('/*)*/) {
1974 PL_lex_allbrackets--;
1979 PL_parser->yychar = YYEMPTY;
1984 S_newSV_maybe_utf8(pTHX_ const char *const start, STRLEN len)
1986 SV * const sv = newSVpvn_utf8(start, len,
1989 && !is_invariant_string((const U8*)start, len)
1990 && is_utf8_string((const U8*)start, len));
1996 * When the lexer knows the next thing is a word (for instance, it has
1997 * just seen -> and it knows that the next char is a word char, then
1998 * it calls S_force_word to stick the next word into the PL_nexttoke/val
2002 * char *start : buffer position (must be within PL_linestr)
2003 * int token : PL_next* will be this type of bare word (e.g., METHOD,WORD)
2004 * int check_keyword : if true, Perl checks to make sure the word isn't
2005 * a keyword (do this if the word is a label, e.g. goto FOO)
2006 * int allow_pack : if true, : characters will also be allowed (require,
2007 * use, etc. do this)
2011 S_force_word(pTHX_ char *start, int token, int check_keyword, int allow_pack)
2016 PERL_ARGS_ASSERT_FORCE_WORD;
2018 start = skipspace(start);
2020 if (isIDFIRST_lazy_if(s,UTF)
2021 || (allow_pack && *s == ':') )
2023 s = scan_word(s, PL_tokenbuf, sizeof PL_tokenbuf, allow_pack, &len);
2024 if (check_keyword) {
2025 char *s2 = PL_tokenbuf;
2027 if (allow_pack && len > 6 && strnEQ(s2, "CORE::", 6))
2029 if (keyword(s2, len2, 0))
2032 if (token == METHOD) {
2037 PL_expect = XOPERATOR;
2040 NEXTVAL_NEXTTOKE.opval
2041 = (OP*)newSVOP(OP_CONST,0,
2042 S_newSV_maybe_utf8(aTHX_ PL_tokenbuf, len));
2043 NEXTVAL_NEXTTOKE.opval->op_private |= OPpCONST_BARE;
2051 * Called when the lexer wants $foo *foo &foo etc, but the program
2052 * text only contains the "foo" portion. The first argument is a pointer
2053 * to the "foo", and the second argument is the type symbol to prefix.
2054 * Forces the next token to be a "WORD".
2055 * Creates the symbol if it didn't already exist (via gv_fetchpv()).
2059 S_force_ident(pTHX_ const char *s, int kind)
2061 PERL_ARGS_ASSERT_FORCE_IDENT;
2064 const STRLEN len = s[1] ? strlen(s) : 1; /* s = "\"" see yylex */
2065 OP* const o = (OP*)newSVOP(OP_CONST, 0, newSVpvn_flags(s, len,
2066 UTF ? SVf_UTF8 : 0));
2067 NEXTVAL_NEXTTOKE.opval = o;
2070 o->op_private = OPpCONST_ENTERED;
2071 /* XXX see note in pp_entereval() for why we forgo typo
2072 warnings if the symbol must be introduced in an eval.
2074 gv_fetchpvn_flags(s, len,
2075 (PL_in_eval ? GV_ADDMULTI
2076 : GV_ADD) | ( UTF ? SVf_UTF8 : 0 ),
2077 kind == '$' ? SVt_PV :
2078 kind == '@' ? SVt_PVAV :
2079 kind == '%' ? SVt_PVHV :
2087 S_force_ident_maybe_lex(pTHX_ char pit)
2089 NEXTVAL_NEXTTOKE.ival = pit;
2094 Perl_str_to_version(pTHX_ SV *sv)
2099 const char *start = SvPV_const(sv,len);
2100 const char * const end = start + len;
2101 const bool utf = SvUTF8(sv) ? TRUE : FALSE;
2103 PERL_ARGS_ASSERT_STR_TO_VERSION;
2105 while (start < end) {
2109 n = utf8n_to_uvchr((U8*)start, len, &skip, 0);
2114 retval += ((NV)n)/nshift;
2123 * Forces the next token to be a version number.
2124 * If the next token appears to be an invalid version number, (e.g. "v2b"),
2125 * and if "guessing" is TRUE, then no new token is created (and the caller
2126 * must use an alternative parsing method).
2130 S_force_version(pTHX_ char *s, int guessing)
2135 PERL_ARGS_ASSERT_FORCE_VERSION;
2143 while (isDIGIT(*d) || *d == '_' || *d == '.')
2145 if (*d == ';' || isSPACE(*d) || *d == '{' || *d == '}' || !*d) {
2147 s = scan_num(s, &pl_yylval);
2148 version = pl_yylval.opval;
2149 ver = cSVOPx(version)->op_sv;
2150 if (SvPOK(ver) && !SvNIOK(ver)) {
2151 SvUPGRADE(ver, SVt_PVNV);
2152 SvNV_set(ver, str_to_version(ver));
2153 SvNOK_on(ver); /* hint that it is a version */
2156 else if (guessing) {
2161 /* NOTE: The parser sees the package name and the VERSION swapped */
2162 NEXTVAL_NEXTTOKE.opval = version;
2169 * S_force_strict_version
2170 * Forces the next token to be a version number using strict syntax rules.
2174 S_force_strict_version(pTHX_ char *s)
2177 const char *errstr = NULL;
2179 PERL_ARGS_ASSERT_FORCE_STRICT_VERSION;
2181 while (isSPACE(*s)) /* leading whitespace */
2184 if (is_STRICT_VERSION(s,&errstr)) {
2186 s = (char *)scan_version(s, ver, 0);
2187 version = newSVOP(OP_CONST, 0, ver);
2189 else if ((*s != ';' && *s != '{' && *s != '}' )
2190 && (s = skipspace(s), (*s != ';' && *s != '{' && *s != '}' )))
2194 yyerror(errstr); /* version required */
2198 /* NOTE: The parser sees the package name and the VERSION swapped */
2199 NEXTVAL_NEXTTOKE.opval = version;
2207 * Tokenize a quoted string passed in as an SV. It finds the next
2208 * chunk, up to end of string or a backslash. It may make a new
2209 * SV containing that chunk (if HINT_NEW_STRING is on). It also
2214 S_tokeq(pTHX_ SV *sv)
2221 PERL_ARGS_ASSERT_TOKEQ;
2225 assert (!SvIsCOW(sv));
2226 if (SvTYPE(sv) >= SVt_PVIV && SvIVX(sv) == -1) /* <<'heredoc' */
2230 /* This is relying on the SV being "well formed" with a trailing '\0' */
2231 while (s < send && !(*s == '\\' && s[1] == '\\'))
2236 if ( PL_hints & HINT_NEW_STRING ) {
2237 pv = newSVpvn_flags(SvPVX_const(pv), SvCUR(sv),
2238 SVs_TEMP | SvUTF8(sv));
2242 if (s + 1 < send && (s[1] == '\\'))
2243 s++; /* all that, just for this */
2248 SvCUR_set(sv, d - SvPVX_const(sv));
2250 if ( PL_hints & HINT_NEW_STRING )
2251 return new_constant(NULL, 0, "q", sv, pv, "q", 1);
2256 * Now come three functions related to double-quote context,
2257 * S_sublex_start, S_sublex_push, and S_sublex_done. They're used when
2258 * converting things like "\u\Lgnat" into ucfirst(lc("gnat")). They
2259 * interact with PL_lex_state, and create fake ( ... ) argument lists
2260 * to handle functions and concatenation.
2264 * stringify ( const[foo] concat lcfirst ( const[bar] ) )
2269 * Assumes that pl_yylval.ival is the op we're creating (e.g. OP_LCFIRST).
2271 * Pattern matching will set PL_lex_op to the pattern-matching op to
2272 * make (we return THING if pl_yylval.ival is OP_NULL, PMFUNC otherwise).
2274 * OP_CONST and OP_READLINE are easy--just make the new op and return.
2276 * Everything else becomes a FUNC.
2278 * Sets PL_lex_state to LEX_INTERPPUSH unless (ival was OP_NULL or we
2279 * had an OP_CONST or OP_READLINE). This just sets us up for a
2280 * call to S_sublex_push().
2284 S_sublex_start(pTHX)
2286 const I32 op_type = pl_yylval.ival;
2288 if (op_type == OP_NULL) {
2289 pl_yylval.opval = PL_lex_op;
2293 if (op_type == OP_CONST) {
2294 SV *sv = PL_lex_stuff;
2295 PL_lex_stuff = NULL;
2298 if (SvTYPE(sv) == SVt_PVIV) {
2299 /* Overloaded constants, nothing fancy: Convert to SVt_PV: */
2301 const char * const p = SvPV_const(sv, len);
2302 SV * const nsv = newSVpvn_flags(p, len, SvUTF8(sv));
2306 pl_yylval.opval = (OP*)newSVOP(op_type, 0, sv);
2310 PL_sublex_info.super_state = PL_lex_state;
2311 PL_sublex_info.sub_inwhat = (U16)op_type;
2312 PL_sublex_info.sub_op = PL_lex_op;
2313 PL_lex_state = LEX_INTERPPUSH;
2317 pl_yylval.opval = PL_lex_op;
2327 * Create a new scope to save the lexing state. The scope will be
2328 * ended in S_sublex_done. Returns a '(', starting the function arguments
2329 * to the uc, lc, etc. found before.
2330 * Sets PL_lex_state to LEX_INTERPCONCAT.
2337 const bool is_heredoc = PL_multi_close == '<';
2340 PL_lex_state = PL_sublex_info.super_state;
2341 SAVEI8(PL_lex_dojoin);
2342 SAVEI32(PL_lex_brackets);
2343 SAVEI32(PL_lex_allbrackets);
2344 SAVEI32(PL_lex_formbrack);
2345 SAVEI8(PL_lex_fakeeof);
2346 SAVEI32(PL_lex_casemods);
2347 SAVEI32(PL_lex_starts);
2348 SAVEI8(PL_lex_state);
2349 SAVEI8(PL_lex_defer);
2350 SAVESPTR(PL_lex_repl);
2351 SAVEVPTR(PL_lex_inpat);
2352 SAVEI16(PL_lex_inwhat);
2355 SAVECOPLINE(PL_curcop);
2356 SAVEI32(PL_multi_end);
2357 SAVEI32(PL_parser->herelines);
2358 PL_parser->herelines = 0;
2360 SAVEI8(PL_multi_close);
2361 SAVEPPTR(PL_bufptr);
2362 SAVEPPTR(PL_bufend);
2363 SAVEPPTR(PL_oldbufptr);
2364 SAVEPPTR(PL_oldoldbufptr);
2365 SAVEPPTR(PL_last_lop);
2366 SAVEPPTR(PL_last_uni);
2367 SAVEPPTR(PL_linestart);
2368 SAVESPTR(PL_linestr);
2369 SAVEGENERICPV(PL_lex_brackstack);
2370 SAVEGENERICPV(PL_lex_casestack);
2371 SAVEGENERICPV(PL_parser->lex_shared);
2372 SAVEBOOL(PL_parser->lex_re_reparsing);
2373 SAVEI32(PL_copline);
2375 /* The here-doc parser needs to be able to peek into outer lexing
2376 scopes to find the body of the here-doc. So we put PL_linestr and
2377 PL_bufptr into lex_shared, to ‘share’ those values.
2379 PL_parser->lex_shared->ls_linestr = PL_linestr;
2380 PL_parser->lex_shared->ls_bufptr = PL_bufptr;
2382 PL_linestr = PL_lex_stuff;
2383 PL_lex_repl = PL_sublex_info.repl;
2384 PL_lex_stuff = NULL;
2385 PL_sublex_info.repl = NULL;
2387 /* Arrange for PL_lex_stuff to be freed on scope exit, in case it gets
2388 set for an inner quote-like operator and then an error causes scope-
2389 popping. We must not have a PL_lex_stuff value left dangling, as
2390 that breaks assumptions elsewhere. See bug #123617. */
2391 SAVEGENERICSV(PL_lex_stuff);
2392 SAVEGENERICSV(PL_sublex_info.repl);
2394 PL_bufend = PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart
2395 = SvPVX(PL_linestr);
2396 PL_bufend += SvCUR(PL_linestr);
2397 PL_last_lop = PL_last_uni = NULL;
2398 SAVEFREESV(PL_linestr);
2399 if (PL_lex_repl) SAVEFREESV(PL_lex_repl);
2401 PL_lex_dojoin = FALSE;
2402 PL_lex_brackets = PL_lex_formbrack = 0;
2403 PL_lex_allbrackets = 0;
2404 PL_lex_fakeeof = LEX_FAKEEOF_NEVER;
2405 Newx(PL_lex_brackstack, 120, char);
2406 Newx(PL_lex_casestack, 12, char);
2407 PL_lex_casemods = 0;
2408 *PL_lex_casestack = '\0';
2410 PL_lex_state = LEX_INTERPCONCAT;
2412 CopLINE_set(PL_curcop, (line_t)PL_multi_start);
2413 PL_copline = NOLINE;
2415 Newxz(shared, 1, LEXSHARED);
2416 shared->ls_prev = PL_parser->lex_shared;
2417 PL_parser->lex_shared = shared;
2419 PL_lex_inwhat = PL_sublex_info.sub_inwhat;
2420 if (PL_lex_inwhat == OP_TRANSR) PL_lex_inwhat = OP_TRANS;
2421 if (PL_lex_inwhat == OP_MATCH || PL_lex_inwhat == OP_QR || PL_lex_inwhat == OP_SUBST)
2422 PL_lex_inpat = PL_sublex_info.sub_op;
2424 PL_lex_inpat = NULL;
2426 PL_parser->lex_re_reparsing = cBOOL(PL_in_eval & EVAL_RE_REPARSING);
2427 PL_in_eval &= ~EVAL_RE_REPARSING;
2434 * Restores lexer state after a S_sublex_push.
2440 if (!PL_lex_starts++) {
2441 SV * const sv = newSVpvs("");
2442 if (SvUTF8(PL_linestr))
2444 PL_expect = XOPERATOR;
2445 pl_yylval.opval = (OP*)newSVOP(OP_CONST, 0, sv);
2449 if (PL_lex_casemods) { /* oops, we've got some unbalanced parens */
2450 PL_lex_state = LEX_INTERPCASEMOD;
2454 /* Is there a right-hand side to take care of? (s//RHS/ or tr//RHS/) */
2455 assert(PL_lex_inwhat != OP_TRANSR);
2457 assert (PL_lex_inwhat == OP_SUBST || PL_lex_inwhat == OP_TRANS);
2458 PL_linestr = PL_lex_repl;
2460 PL_bufend = PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
2461 PL_bufend += SvCUR(PL_linestr);
2462 PL_last_lop = PL_last_uni = NULL;
2463 PL_lex_dojoin = FALSE;
2464 PL_lex_brackets = 0;
2465 PL_lex_allbrackets = 0;
2466 PL_lex_fakeeof = LEX_FAKEEOF_NEVER;
2467 PL_lex_casemods = 0;
2468 *PL_lex_casestack = '\0';
2470 if (SvEVALED(PL_lex_repl)) {
2471 PL_lex_state = LEX_INTERPNORMAL;
2473 /* we don't clear PL_lex_repl here, so that we can check later
2474 whether this is an evalled subst; that means we rely on the
2475 logic to ensure sublex_done() is called again only via the
2476 branch (in yylex()) that clears PL_lex_repl, else we'll loop */
2479 PL_lex_state = LEX_INTERPCONCAT;
2482 if (SvTYPE(PL_linestr) >= SVt_PVNV) {
2483 CopLINE(PL_curcop) +=
2484 ((XPVNV*)SvANY(PL_linestr))->xnv_u.xpad_cop_seq.xlow
2485 + PL_parser->herelines;
2486 PL_parser->herelines = 0;
2491 const line_t l = CopLINE(PL_curcop);
2493 if (PL_multi_close == '<')
2494 PL_parser->herelines += l - PL_multi_end;
2495 PL_bufend = SvPVX(PL_linestr);
2496 PL_bufend += SvCUR(PL_linestr);
2497 PL_expect = XOPERATOR;
2502 PERL_STATIC_INLINE SV*
2503 S_get_and_check_backslash_N_name(pTHX_ const char* s, const char* const e)
2505 /* <s> points to first character of interior of \N{}, <e> to one beyond the
2506 * interior, hence to the "}". Finds what the name resolves to, returning
2507 * an SV* containing it; NULL if no valid one found */
2509 SV* res = newSVpvn_flags(s, e - s, UTF ? SVf_UTF8 : 0);
2516 const U8* first_bad_char_loc;
2517 const char* backslash_ptr = s - 3; /* Points to the <\> of \N{... */
2519 PERL_ARGS_ASSERT_GET_AND_CHECK_BACKSLASH_N_NAME;
2524 if (UTF && ! is_utf8_string_loc((U8 *) backslash_ptr,
2526 &first_bad_char_loc))
2528 /* If warnings are on, this will print a more detailed analysis of what
2529 * is wrong than the error message below */
2530 utf8n_to_uvchr(first_bad_char_loc,
2531 e - ((char *) first_bad_char_loc),
2534 /* We deliberately don't try to print the malformed character, which
2535 * might not print very well; it also may be just the first of many
2536 * malformations, so don't print what comes after it */
2537 yyerror_pv(Perl_form(aTHX_
2538 "Malformed UTF-8 character immediately after '%.*s'",
2539 (int) (first_bad_char_loc - (U8 *) backslash_ptr), backslash_ptr),
2544 res = new_constant( NULL, 0, "charnames", res, NULL, backslash_ptr,
2545 /* include the <}> */
2546 e - backslash_ptr + 1);
2548 SvREFCNT_dec_NN(res);
2552 /* See if the charnames handler is the Perl core's, and if so, we can skip
2553 * the validation needed for a user-supplied one, as Perl's does its own
2555 table = GvHV(PL_hintgv); /* ^H */
2556 cvp = hv_fetchs(table, "charnames", FALSE);
2557 if (cvp && (cv = *cvp) && SvROK(cv) && (rv = SvRV(cv),
2558 SvTYPE(rv) == SVt_PVCV) && ((stash = CvSTASH(rv)) != NULL))
2560 const char * const name = HvNAME(stash);
2561 if (HvNAMELEN(stash) == sizeof("_charnames")-1
2562 && strEQ(name, "_charnames")) {
2567 /* Here, it isn't Perl's charname handler. We can't rely on a
2568 * user-supplied handler to validate the input name. For non-ut8 input,
2569 * look to see that the first character is legal. Then loop through the
2570 * rest checking that each is a continuation */
2572 /* This code makes the reasonable assumption that the only Latin1-range
2573 * characters that begin a character name alias are alphabetic, otherwise
2574 * would have to create a isCHARNAME_BEGIN macro */
2577 if (! isALPHAU(*s)) {
2582 if (! isCHARNAME_CONT(*s)) {
2585 if (*s == ' ' && *(s-1) == ' ') {
2588 if ((U8) *s == NBSP_NATIVE && ckWARN_d(WARN_DEPRECATED)) {
2589 Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),
2590 "NO-BREAK SPACE in a charnames "
2591 "alias definition is deprecated");
2597 /* Similarly for utf8. For invariants can check directly; for other
2598 * Latin1, can calculate their code point and check; otherwise use a
2600 if (UTF8_IS_INVARIANT(*s)) {
2601 if (! isALPHAU(*s)) {
2605 } else if (UTF8_IS_DOWNGRADEABLE_START(*s)) {
2606 if (! isALPHAU(EIGHT_BIT_UTF8_TO_NATIVE(*s, *(s+1)))) {
2612 if (! PL_utf8_charname_begin) {
2613 U8 flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
2614 PL_utf8_charname_begin = _core_swash_init("utf8",
2615 "_Perl_Charname_Begin",
2617 1, 0, NULL, &flags);
2619 if (! swash_fetch(PL_utf8_charname_begin, (U8 *) s, TRUE)) {
2626 if (UTF8_IS_INVARIANT(*s)) {
2627 if (! isCHARNAME_CONT(*s)) {
2630 if (*s == ' ' && *(s-1) == ' ') {
2635 else if (UTF8_IS_DOWNGRADEABLE_START(*s)) {
2636 if (! isCHARNAME_CONT(EIGHT_BIT_UTF8_TO_NATIVE(*s, *(s+1))))
2640 if (*s == *NBSP_UTF8
2641 && *(s+1) == *(NBSP_UTF8+1)
2642 && ckWARN_d(WARN_DEPRECATED))
2644 Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),
2645 "NO-BREAK SPACE in a charnames "
2646 "alias definition is deprecated");
2651 if (! PL_utf8_charname_continue) {
2652 U8 flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
2653 PL_utf8_charname_continue = _core_swash_init("utf8",
2654 "_Perl_Charname_Continue",
2656 1, 0, NULL, &flags);
2658 if (! swash_fetch(PL_utf8_charname_continue, (U8 *) s, TRUE)) {
2665 if (*(s-1) == ' ') {
2668 "charnames alias definitions may not contain trailing "
2669 "white-space; marked by <-- HERE in %.*s<-- HERE %.*s",
2670 (int)(s - backslash_ptr + 1), backslash_ptr,
2671 (int)(e - s + 1), s + 1
2673 UTF ? SVf_UTF8 : 0);
2677 if (SvUTF8(res)) { /* Don't accept malformed input */
2678 const U8* first_bad_char_loc;
2680 const char* const str = SvPV_const(res, len);
2681 if (! is_utf8_string_loc((U8 *) str, len, &first_bad_char_loc)) {
2682 /* If warnings are on, this will print a more detailed analysis of
2683 * what is wrong than the error message below */
2684 utf8n_to_uvchr(first_bad_char_loc,
2685 (char *) first_bad_char_loc - str,
2688 /* We deliberately don't try to print the malformed character,
2689 * which might not print very well; it also may be just the first
2690 * of many malformations, so don't print what comes after it */
2693 "Malformed UTF-8 returned by %.*s immediately after '%.*s'",
2694 (int) (e - backslash_ptr + 1), backslash_ptr,
2695 (int) ((char *) first_bad_char_loc - str), str
2706 /* The final %.*s makes sure that should the trailing NUL be missing
2707 * that this print won't run off the end of the string */
2710 "Invalid character in \\N{...}; marked by <-- HERE in %.*s<-- HERE %.*s",
2711 (int)(s - backslash_ptr + 1), backslash_ptr,
2712 (int)(e - s + 1), s + 1
2714 UTF ? SVf_UTF8 : 0);
2721 "charnames alias definitions may not contain a sequence of "
2722 "multiple spaces; marked by <-- HERE in %.*s<-- HERE %.*s",
2723 (int)(s - backslash_ptr + 1), backslash_ptr,
2724 (int)(e - s + 1), s + 1
2726 UTF ? SVf_UTF8 : 0);
2733 Extracts the next constant part of a pattern, double-quoted string,
2734 or transliteration. This is terrifying code.
2736 For example, in parsing the double-quoted string "ab\x63$d", it would
2737 stop at the '$' and return an OP_CONST containing 'abc'.
2739 It looks at PL_lex_inwhat and PL_lex_inpat to find out whether it's
2740 processing a pattern (PL_lex_inpat is true), a transliteration
2741 (PL_lex_inwhat == OP_TRANS is true), or a double-quoted string.
2743 Returns a pointer to the character scanned up to. If this is
2744 advanced from the start pointer supplied (i.e. if anything was
2745 successfully parsed), will leave an OP_CONST for the substring scanned
2746 in pl_yylval. Caller must intuit reason for not parsing further
2747 by looking at the next characters herself.
2751 \N{FOO} => \N{U+hex_for_character_FOO}
2752 (if FOO expands to multiple characters, expands to \N{U+xx.XX.yy ...})
2755 all other \-char, including \N and \N{ apart from \N{ABC}
2758 @ and $ where it appears to be a var, but not for $ as tail anchor
2762 In transliterations:
2763 characters are VERY literal, except for - not at the start or end
2764 of the string, which indicates a range. If the range is in bytes,
2765 scan_const expands the range to the full set of intermediate
2766 characters. If the range is in utf8, the hyphen is replaced with
2767 a certain range mark which will be handled by pmtrans() in op.c.
2769 In double-quoted strings:
2771 double-quoted style: \r and \n
2772 constants: \x31, etc.
2773 deprecated backrefs: \1 (in substitution replacements)
2774 case and quoting: \U \Q \E
2777 scan_const does *not* construct ops to handle interpolated strings.
2778 It stops processing as soon as it finds an embedded $ or @ variable
2779 and leaves it to the caller to work out what's going on.
2781 embedded arrays (whether in pattern or not) could be:
2782 @foo, @::foo, @'foo, @{foo}, @$foo, @+, @-.
2784 $ in double-quoted strings must be the symbol of an embedded scalar.
2786 $ in pattern could be $foo or could be tail anchor. Assumption:
2787 it's a tail anchor if $ is the last thing in the string, or if it's
2788 followed by one of "()| \r\n\t"
2790 \1 (backreferences) are turned into $1 in substitutions
2792 The structure of the code is
2793 while (there's a character to process) {
2794 handle transliteration ranges
2795 skip regexp comments /(?#comment)/ and codes /(?{code})/
2796 skip #-initiated comments in //x patterns
2797 check for embedded arrays
2798 check for embedded scalars
2800 deprecate \1 in substitution replacements
2801 handle string-changing backslashes \l \U \Q \E, etc.
2802 switch (what was escaped) {
2803 handle \- in a transliteration (becomes a literal -)
2804 if a pattern and not \N{, go treat as regular character
2805 handle \132 (octal characters)
2806 handle \x15 and \x{1234} (hex characters)
2807 handle \N{name} (named characters, also \N{3,5} in a pattern)
2808 handle \cV (control characters)
2809 handle printf-style backslashes (\f, \r, \n, etc)
2812 } (end if backslash)
2813 handle regular character
2814 } (end while character to read)
2819 S_scan_const(pTHX_ char *start)
2821 char *send = PL_bufend; /* end of the constant */
2822 SV *sv = newSV(send - start); /* sv for the constant. See note below
2824 char *s = start; /* start of the constant */
2825 char *d = SvPVX(sv); /* destination for copies */
2826 bool dorange = FALSE; /* are we in a translit range? */
2827 bool didrange = FALSE; /* did we just finish a range? */
2828 bool in_charclass = FALSE; /* within /[...]/ */
2829 bool has_utf8 = FALSE; /* Output constant is UTF8 */
2830 bool this_utf8 = cBOOL(UTF); /* Is the source string assumed to be
2831 UTF8? But, this can show as true
2832 when the source isn't utf8, as for
2833 example when it is entirely composed
2835 SV *res; /* result from charnames */
2836 STRLEN offset_to_max; /* The offset in the output to where the range
2837 high-end character is temporarily placed */
2839 /* Note on sizing: The scanned constant is placed into sv, which is
2840 * initialized by newSV() assuming one byte of output for every byte of
2841 * input. This routine expects newSV() to allocate an extra byte for a
2842 * trailing NUL, which this routine will append if it gets to the end of
2843 * the input. There may be more bytes of input than output (eg., \N{LATIN
2844 * CAPITAL LETTER A}), or more output than input if the constant ends up
2845 * recoded to utf8, but each time a construct is found that might increase
2846 * the needed size, SvGROW() is called. Its size parameter each time is
2847 * based on the best guess estimate at the time, namely the length used so
2848 * far, plus the length the current construct will occupy, plus room for
2849 * the trailing NUL, plus one byte for every input byte still unscanned */
2851 UV uv = UV_MAX; /* Initialize to weird value to try to catch any uses
2854 int backslash_N = 0; /* ? was the character from \N{} */
2855 int non_portable_endpoint = 0; /* ? In a range is an endpoint
2856 platform-specific like \x65 */
2859 PERL_ARGS_ASSERT_SCAN_CONST;
2861 assert(PL_lex_inwhat != OP_TRANSR);
2862 if (PL_lex_inwhat == OP_TRANS && PL_sublex_info.sub_op) {
2863 /* If we are doing a trans and we know we want UTF8 set expectation */
2864 has_utf8 = PL_sublex_info.sub_op->op_private & (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF);
2865 this_utf8 = PL_sublex_info.sub_op->op_private & (PL_lex_repl ? OPpTRANS_FROM_UTF : OPpTRANS_TO_UTF);
2868 /* Protect sv from errors and fatal warnings. */
2869 ENTER_with_name("scan_const");
2873 || dorange /* Handle tr/// range at right edge of input */
2876 /* get transliterations out of the way (they're most literal) */
2877 if (PL_lex_inwhat == OP_TRANS) {
2879 /* But there isn't any special handling necessary unless there is a
2880 * range, so for most cases we just drop down and handle the value
2881 * as any other. There are two exceptions.
2883 * 1. A minus sign indicates that we are actually going to have
2884 * a range. In this case, skip the '-', set a flag, then drop
2885 * down to handle what should be the end range value.
2886 * 2. After we've handled that value, the next time through, that
2887 * flag is set and we fix up the range.
2889 * Ranges entirely within Latin1 are expanded out entirely, in
2890 * order to avoid the significant overhead of making a swash.
2891 * Ranges that extend above Latin1 have to have a swash, so there
2892 * is no advantage to abbreviate them here, so they are stored here
2893 * as Min, ILLEGAL_UTF8_BYTE, Max. The illegal byte signifies a
2894 * hyphen without any possible ambiguity. On EBCDIC machines, if
2895 * the range is expressed as Unicode, the Latin1 portion is
2896 * expanded out even if the entire range extends above Latin1.
2897 * This is because each code point in it has to be processed here
2898 * individually to get its native translation */
2902 /* Here, we don't think we're in a range. If we've processed
2903 * at least one character, then see if this next one is a '-',
2904 * indicating the previous one was the start of a range. But
2905 * don't bother if we're too close to the end for the minus to
2907 if (*s != '-' || s >= send - 1 || s == start) {
2909 /* A regular character. Process like any other, but first
2910 * clear any flags */
2914 non_portable_endpoint = 0;
2917 /* Drops down to generic code to process current byte */
2920 if (didrange) { /* Something like y/A-C-Z// */
2921 Perl_croak(aTHX_ "Ambiguous range in transliteration operator");
2926 s++; /* Skip past the minus */
2928 /* d now points to where the end-range character will be
2929 * placed. Save it so won't have to go finding it later,
2930 * and drop down to get that character. (Actually we
2931 * instead save the offset, to handle the case where a
2932 * realloc in the meantime could change the actual
2933 * pointer). We'll finish processing the range the next
2934 * time through the loop */
2935 offset_to_max = d - SvPVX_const(sv);
2937 } /* End of not a range */
2939 /* Here we have parsed a range. Now must handle it. At this
2941 * 'sv' is a SV* that contains the output string we are
2942 * constructing. The final two characters in that string
2943 * are the range start and range end, in order.
2944 * 'd' points to just beyond the range end in the 'sv' string,
2945 * where we would next place something
2946 * 'offset_to_max' is the offset in 'sv' at which the character
2947 * before 'd' begins.
2949 const char * max_ptr = SvPVX_const(sv) + offset_to_max;
2950 const char * min_ptr;
2952 IV range_max; /* last character in range */
2955 #ifndef EBCDIC /* Not meaningful except in EBCDIC, so initialize to false */
2956 const bool convert_unicode = FALSE;
2957 const IV real_range_max = 0;
2959 bool convert_unicode;
2960 IV real_range_max = 0;
2963 /* Get the range-ends code point values. */
2965 /* We know the utf8 is valid, because we just constructed
2966 * it ourselves in previous loop iterations */
2967 min_ptr = (char*) utf8_hop( (U8*) max_ptr, -1);
2968 range_min = valid_utf8_to_uvchr( (U8*) min_ptr, NULL);
2969 range_max = valid_utf8_to_uvchr( (U8*) max_ptr, NULL);
2972 min_ptr = max_ptr - 1;
2973 range_min = * (U8*) min_ptr;
2974 range_max = * (U8*) max_ptr;
2978 /* On EBCDIC platforms, we may have to deal with portable
2979 * ranges. These happen if at least one range endpoint is a
2980 * Unicode value (\N{...}), or if the range is a subset of
2981 * [A-Z] or [a-z], and both ends are literal characters,
2982 * like 'A', and not like \x{C1} */
2983 if ((convert_unicode
2984 = cBOOL(backslash_N) /* \N{} forces Unicode, hence
2986 || ( ! non_portable_endpoint
2987 && (( isLOWER_A(range_min) && isLOWER_A(range_max))
2988 || (isUPPER_A(range_min) && isUPPER_A(range_max))))
2991 /* Special handling is needed for these portable ranges.
2992 * They are defined to all be in Unicode terms, which
2993 * include all Unicode code points between the end points.
2994 * Convert to Unicode to get the Unicode range. Later we
2995 * will convert each code point in the range back to
2997 range_min = NATIVE_TO_UNI(range_min);
2998 range_max = NATIVE_TO_UNI(range_max);
3002 if (range_min > range_max) {
3003 if (convert_unicode) {
3004 /* Need to convert back to native for meaningful
3005 * messages for this platform */
3006 range_min = UNI_TO_NATIVE(range_min);
3007 range_max = UNI_TO_NATIVE(range_max);
3010 /* Use the characters themselves for the error message if
3011 * ASCII printables; otherwise some visible representation
3013 if (isPRINT_A(range_min) && isPRINT_A(range_max)) {
3015 "Invalid range \"%c-%c\" in transliteration operator",
3016 (char)range_min, (char)range_max);
3018 else if (convert_unicode) {
3019 /* diag_listed_as: Invalid range "%s" in transliteration operator */
3021 "Invalid range \"\\N{U+%04"UVXf"}-\\N{U+%04"UVXf"}\""
3022 " in transliteration operator",
3023 range_min, range_max);
3026 /* diag_listed_as: Invalid range "%s" in transliteration operator */
3028 "Invalid range \"\\x{%04"UVXf"}-\\x{%04"UVXf"}\""
3029 " in transliteration operator",
3030 range_min, range_max);
3036 /* We try to avoid creating a swash. If the upper end of
3037 * this range is below 256, this range won't force a swash;
3038 * otherwise it does force a swash, and as long as we have
3039 * to have one, we might as well not expand things out.
3040 * But if it's EBCDIC, we may have to look at each
3041 * character below 256 if we have to convert to/from
3045 && (range_min > 255 || ! convert_unicode)
3048 /* Move the high character one byte to the right; then
3049 * insert between it and the range begin, an illegal
3050 * byte which serves to indicate this is a range (using
3051 * a '-' could be ambiguous). */
3053 while (e-- > max_ptr) {
3056 *(e + 1) = (char) ILLEGAL_UTF8_BYTE;
3060 /* Here, we're going to expand out the range. For EBCDIC
3061 * the range can extend above 255 (not so in ASCII), so
3062 * for EBCDIC, split it into the parts above and below
3065 if (range_max > 255) {
3066 real_range_max = range_max;
3072 /* Here we need to expand out the string to contain each
3073 * character in the range. Grow the output to handle this */
3075 save_offset = min_ptr - SvPVX_const(sv);
3077 /* The base growth is the number of code points in the range */
3078 grow = range_max - range_min + 1;
3081 /* But if the output is UTF-8, some of those characters may
3082 * need two bytes (since the maximum range value here is
3083 * 255, the max bytes per character is two). On ASCII
3084 * platforms, it's not much trouble to get an accurate
3085 * count of what's needed. But on EBCDIC, the ones that
3086 * need 2 bytes are scattered around, so just use a worst
3087 * case value instead of calculating for that platform. */
3091 /* Only those above 127 require 2 bytes. This may be
3092 * everything in the range, or not */
3093 if (range_min > 127) {
3096 else if (range_max > 127) {
3097 grow += range_max - 127;
3102 /* Subtract 3 for the bytes that were already accounted for
3103 * (min, max, and the hyphen) */
3104 SvGROW(sv, SvLEN(sv) + grow - 3);
3105 d = SvPVX(sv) + save_offset; /* refresh d after realloc */
3107 /* Here, we expand out the range. On ASCII platforms, the
3108 * compiler should optimize out the 'convert_unicode==TRUE'
3109 * portion of this */
3110 if (convert_unicode) {
3113 /* Recall that the min and max are now in Unicode terms, so
3114 * we have to convert each character to its native
3117 for (i = range_min; i <= range_max; i++) {
3118 append_utf8_from_native_byte(LATIN1_TO_NATIVE((U8) i),
3123 for (i = range_min; i <= range_max; i++) {
3124 *d++ = (char)LATIN1_TO_NATIVE((U8) i);
3131 /* Here, no conversions are necessary, which means that the
3132 * first character in the range is already in 'd' and
3133 * valid, so we can skip overwriting it */
3136 for (i = range_min + 1; i <= range_max; i++) {
3137 append_utf8_from_native_byte((U8) i, (U8 **) &d);
3142 for (i = range_min + 1; i <= range_max; i++) {
3148 /* (Compilers should optimize this out for non-EBCDIC). If the
3149 * original range extended above 255, add in that portion */
3150 if (real_range_max) {
3151 *d++ = (char) UTF8_TWO_BYTE_HI(0x100);
3152 *d++ = (char) UTF8_TWO_BYTE_LO(0x100);
3153 if (real_range_max > 0x101)
3154 *d++ = (char) ILLEGAL_UTF8_BYTE;
3155 if (real_range_max > 0x100)
3156 d = (char*)uvchr_to_utf8((U8*)d, real_range_max);
3160 /* mark the range as done, and continue */
3164 non_portable_endpoint = 0;
3168 } /* End of is a range */
3169 } /* End of transliteration. Joins main code after these else's */
3170 else if (*s == '[' && PL_lex_inpat && !in_charclass) {
3173 while (s1 >= start && *s1-- == '\\')
3176 in_charclass = TRUE;
3179 else if (*s == ']' && PL_lex_inpat && in_charclass) {
3182 while (s1 >= start && *s1-- == '\\')
3185 in_charclass = FALSE;
3188 /* skip for regexp comments /(?#comment)/, except for the last
3189 * char, which will be done separately.
3190 * Stop on (?{..}) and friends */
3192 else if (*s == '(' && PL_lex_inpat && s[1] == '?' && !in_charclass) {
3194 while (s+1 < send && *s != ')')
3197 else if (!PL_lex_casemods
3198 && ( s[2] == '{' /* This should match regcomp.c */
3199 || (s[2] == '?' && s[3] == '{')))
3205 /* likewise skip #-initiated comments in //x patterns */
3209 && ((PMOP*)PL_lex_inpat)->op_pmflags & RXf_PMf_EXTENDED)
3211 while (s+1 < send && *s != '\n')
3215 /* no further processing of single-quoted regex */
3216 else if (PL_lex_inpat && SvIVX(PL_linestr) == '\'')
3217 goto default_action;
3219 /* check for embedded arrays
3220 (@foo, @::foo, @'foo, @{foo}, @$foo, @+, @-)
3222 else if (*s == '@' && s[1]) {
3223 if (UTF ? isIDFIRST_utf8((U8*)s+1) : isWORDCHAR_A(s[1]))
3225 if (strchr(":'{$", s[1]))
3227 if (!PL_lex_inpat && (s[1] == '+' || s[1] == '-'))
3228 break; /* in regexp, neither @+ nor @- are interpolated */
3231 /* check for embedded scalars. only stop if we're sure it's a
3234 else if (*s == '$') {
3235 if (!PL_lex_inpat) /* not a regexp, so $ must be var */
3237 if (s + 1 < send && !strchr("()| \r\n\t", s[1])) {
3239 Perl_ck_warner(aTHX_ packWARN(WARN_AMBIGUOUS),
3240 "Possible unintended interpolation of $\\ in regex");
3242 break; /* in regexp, $ might be tail anchor */
3246 /* End of else if chain - OP_TRANS rejoin rest */
3249 if (*s == '\\' && s+1 < send) {
3250 char* e; /* Can be used for ending '}', etc. */
3254 /* warn on \1 - \9 in substitution replacements, but note that \11
3255 * is an octal; and \19 is \1 followed by '9' */
3256 if (PL_lex_inwhat == OP_SUBST
3262 /* diag_listed_as: \%d better written as $%d */
3263 Perl_ck_warner(aTHX_ packWARN(WARN_SYNTAX), "\\%c better written as $%c", *s, *s);
3268 /* string-change backslash escapes */
3269 if (PL_lex_inwhat != OP_TRANS && *s && strchr("lLuUEQF", *s)) {
3273 /* In a pattern, process \N, but skip any other backslash escapes.
3274 * This is because we don't want to translate an escape sequence
3275 * into a meta symbol and have the regex compiler use the meta
3276 * symbol meaning, e.g. \x{2E} would be confused with a dot. But
3277 * in spite of this, we do have to process \N here while the proper
3278 * charnames handler is in scope. See bugs #56444 and #62056.
3280 * There is a complication because \N in a pattern may also stand
3281 * for 'match a non-nl', and not mean a charname, in which case its
3282 * processing should be deferred to the regex compiler. To be a
3283 * charname it must be followed immediately by a '{', and not look
3284 * like \N followed by a curly quantifier, i.e., not something like
3285 * \N{3,}. regcurly returns a boolean indicating if it is a legal
3287 else if (PL_lex_inpat
3290 || regcurly(s + 1)))
3293 goto default_action;
3299 if ((isALPHANUMERIC(*s)))
3300 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
3301 "Unrecognized escape \\%c passed through",
3303 /* default action is to copy the quoted character */
3304 goto default_action;
3307 /* eg. \132 indicates the octal constant 0132 */
3308 case '0': case '1': case '2': case '3':
3309 case '4': case '5': case '6': case '7':
3311 I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
3313 uv = grok_oct(s, &len, &flags, NULL);
3315 if (len < 3 && s < send && isDIGIT(*s)
3316 && ckWARN(WARN_MISC))
3318 Perl_warner(aTHX_ packWARN(WARN_MISC),
3319 "%s", form_short_octal_warning(s, len));
3322 goto NUM_ESCAPE_INSERT;
3324 /* eg. \o{24} indicates the octal constant \024 */
3329 bool valid = grok_bslash_o(&s, &uv, &error,
3330 TRUE, /* Output warning */
3331 FALSE, /* Not strict */
3332 TRUE, /* Output warnings for
3339 goto NUM_ESCAPE_INSERT;
3342 /* eg. \x24 indicates the hex constant 0x24 */
3347 bool valid = grok_bslash_x(&s, &uv, &error,
3348 TRUE, /* Output warning */
3349 FALSE, /* Not strict */
3350 TRUE, /* Output warnings for
3360 /* Insert oct or hex escaped character. There will always be
3361 * enough room in sv since such escapes will be longer than any
3362 * UTF-8 sequence they can end up as, except if they force us
3363 * to recode the rest of the string into utf8 */
3365 /* Here uv is the ordinal of the next character being added */
3366 if (UVCHR_IS_INVARIANT(uv)) {
3370 if (!has_utf8 && uv > 255) {
3371 /* Might need to recode whatever we have accumulated so
3372 * far if it contains any chars variant in utf8 or
3375 SvCUR_set(sv, d - SvPVX_const(sv));
3378 /* See Note on sizing above. */
3379 sv_utf8_upgrade_flags_grow(
3381 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE
3382 /* Above-latin1 in string
3383 * implies no encoding */
3384 |SV_UTF8_NO_ENCODING,
3385 UVCHR_SKIP(uv) + (STRLEN)(send - s) + 1);
3386 d = SvPVX(sv) + SvCUR(sv);
3391 d = (char*)uvchr_to_utf8((U8*)d, uv);
3392 if (PL_lex_inwhat == OP_TRANS
3393 && PL_sublex_info.sub_op)
3395 PL_sublex_info.sub_op->op_private |=
3396 (PL_lex_repl ? OPpTRANS_FROM_UTF
3405 non_portable_endpoint++;
3410 /* In a non-pattern \N must be like \N{U+0041}, or it can be a
3411 * named character, like \N{LATIN SMALL LETTER A}, or a named
3412 * sequence, like \N{LATIN CAPITAL LETTER A WITH MACRON AND
3413 * GRAVE} (except y/// can't handle the latter, croaking). For
3414 * convenience all three forms are referred to as "named
3415 * characters" below.
3417 * For patterns, \N also can mean to match a non-newline. Code
3418 * before this 'switch' statement should already have handled
3419 * this situation, and hence this code only has to deal with
3420 * the named character cases.
3422 * For non-patterns, the named characters are converted to
3423 * their string equivalents. In patterns, named characters are
3424 * not converted to their ultimate forms for the same reasons
3425 * that other escapes aren't. Instead, they are converted to
3426 * the \N{U+...} form to get the value from the charnames that
3427 * is in effect right now, while preserving the fact that it
3428 * was a named character, so that the regex compiler knows
3431 * The structure of this section of code (besides checking for
3432 * errors and upgrading to utf8) is:
3433 * If the named character is of the form \N{U+...}, pass it
3434 * through if a pattern; otherwise convert the code point
3436 * Otherwise must be some \N{NAME}: convert to
3437 * \N{U+c1.c2...} if a pattern; otherwise convert to utf8
3439 * Transliteration is an exception. The conversion to utf8 is
3440 * only done if the code point requires it to be representable.
3442 * Here, 's' points to the 'N'; the test below is guaranteed to
3443 * succeed if we are being called on a pattern, as we already
3444 * know from a test above that the next character is a '{'. A
3445 * non-pattern \N must mean 'named character', which requires
3449 yyerror("Missing braces on \\N{}");
3454 /* If there is no matching '}', it is an error. */
3455 if (! (e = strchr(s, '}'))) {
3456 if (! PL_lex_inpat) {
3457 yyerror("Missing right brace on \\N{}");
3459 yyerror("Missing right brace on \\N{} or unescaped left brace after \\N");
3464 /* Here it looks like a named character */
3466 if (*s == 'U' && s[1] == '+') { /* \N{U+...} */
3467 s += 2; /* Skip to next char after the 'U+' */
3470 /* In patterns, we can have \N{U+xxxx.yyyy.zzzz...} */
3471 /* Check the syntax. */
3474 if (!isXDIGIT(*s)) {
3477 "Invalid hexadecimal number in \\N{U+...}"
3485 else if ((*s == '.' || *s == '_')
3491 /* Pass everything through unchanged.
3492 * +1 is for the '}' */
3493 Copy(orig_s, d, e - orig_s + 1, char);
3494 d += e - orig_s + 1;
3496 else { /* Not a pattern: convert the hex to string */
3497 I32 flags = PERL_SCAN_ALLOW_UNDERSCORES
3498 | PERL_SCAN_SILENT_ILLDIGIT
3499 | PERL_SCAN_DISALLOW_PREFIX;
3501 uv = grok_hex(s, &len, &flags, NULL);
3502 if (len == 0 || (len != (STRLEN)(e - s)))
3505 /* For non-tr///, if the destination is not in utf8,
3506 * unconditionally recode it to be so. This is
3507 * because \N{} implies Unicode semantics, and scalars
3508 * have to be in utf8 to guarantee those semantics.
3509 * tr/// doesn't care about Unicode rules, so no need
3510 * there to upgrade to UTF-8 for small enough code
3512 if (! has_utf8 && ( uv > 0xFF
3513 || PL_lex_inwhat != OP_TRANS))
3515 SvCUR_set(sv, d - SvPVX_const(sv));
3518 /* See Note on sizing above. */
3519 sv_utf8_upgrade_flags_grow(
3521 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3522 UVCHR_SKIP(uv) + (STRLEN)(send - e) + 1);
3523 d = SvPVX(sv) + SvCUR(sv);
3527 /* Add the (Unicode) code point to the output. */
3528 if (OFFUNI_IS_INVARIANT(uv)) {
3529 *d++ = (char) LATIN1_TO_NATIVE(uv);
3532 d = (char*) uvoffuni_to_utf8_flags((U8*)d, uv, 0);
3536 else /* Here is \N{NAME} but not \N{U+...}. */
3537 if ((res = get_and_check_backslash_N_name(s, e)))
3540 const char *str = SvPV_const(res, len);
3543 if (! len) { /* The name resolved to an empty string */
3544 Copy("\\N{}", d, 4, char);
3548 /* In order to not lose information for the regex
3549 * compiler, pass the result in the specially made
3550 * syntax: \N{U+c1.c2.c3...}, where c1 etc. are
3551 * the code points in hex of each character
3552 * returned by charnames */
3554 const char *str_end = str + len;
3555 const STRLEN off = d - SvPVX_const(sv);
3557 if (! SvUTF8(res)) {
3558 /* For the non-UTF-8 case, we can determine the
3559 * exact length needed without having to parse
3560 * through the string. Each character takes up
3561 * 2 hex digits plus either a trailing dot or
3563 const char initial_text[] = "\\N{U+";
3564 const STRLEN initial_len = sizeof(initial_text)
3566 d = off + SvGROW(sv, off
3569 /* +1 for trailing NUL */
3572 + (STRLEN)(send - e));
3573 Copy(initial_text, d, initial_len, char);
3575 while (str < str_end) {
3578 my_snprintf(hex_string,
3582 /* The regex compiler is
3583 * expecting Unicode, not
3585 (U8) NATIVE_TO_LATIN1(*str));
3586 PERL_MY_SNPRINTF_POST_GUARD(len,
3587 sizeof(hex_string));
3588 Copy(hex_string, d, 3, char);
3592 d--; /* Below, we will overwrite the final
3593 dot with a right brace */
3596 STRLEN char_length; /* cur char's byte length */
3598 /* and the number of bytes after this is
3599 * translated into hex digits */
3600 STRLEN output_length;
3602 /* 2 hex per byte; 2 chars for '\N'; 2 chars
3603 * for max('U+', '.'); and 1 for NUL */
3604 char hex_string[2 * UTF8_MAXBYTES + 5];
3606 /* Get the first character of the result. */
3607 U32 uv = utf8n_to_uvchr((U8 *) str,
3611 /* Convert first code point to Unicode hex,
3612 * including the boiler plate before it. */
3614 my_snprintf(hex_string, sizeof(hex_string),
3616 (unsigned int) NATIVE_TO_UNI(uv));
3618 /* Make sure there is enough space to hold it */
3619 d = off + SvGROW(sv, off
3621 + (STRLEN)(send - e)
3622 + 2); /* '}' + NUL */
3624 Copy(hex_string, d, output_length, char);
3627 /* For each subsequent character, append dot and
3628 * its Unicode code point in hex */
3629 while ((str += char_length) < str_end) {
3630 const STRLEN off = d - SvPVX_const(sv);
3631 U32 uv = utf8n_to_uvchr((U8 *) str,
3636 my_snprintf(hex_string,
3639 (unsigned int) NATIVE_TO_UNI(uv));
3641 d = off + SvGROW(sv, off
3643 + (STRLEN)(send - e)
3644 + 2); /* '}' + NUL */
3645 Copy(hex_string, d, output_length, char);
3650 *d++ = '}'; /* Done. Add the trailing brace */
3653 else { /* Here, not in a pattern. Convert the name to a
3656 if (PL_lex_inwhat == OP_TRANS) {
3657 str = SvPV_const(res, len);
3658 if (len > ((SvUTF8(res))
3662 yyerror(Perl_form(aTHX_
3663 "%.*s must not be a named sequence"
3664 " in transliteration operator",
3665 /* +1 to include the "}" */
3666 (int) (e + 1 - start), start));
3667 goto end_backslash_N;
3670 else if (! SvUTF8(res)) {
3671 /* Make sure \N{} return is UTF-8. This is because
3672 * \N{} implies Unicode semantics, and scalars have to
3673 * be in utf8 to guarantee those semantics; but not
3674 * needed in tr/// */
3675 sv_utf8_upgrade_flags(res, SV_UTF8_NO_ENCODING);
3676 str = SvPV_const(res, len);
3679 /* Upgrade destination to be utf8 if this new
3681 if (! has_utf8 && SvUTF8(res)) {
3682 SvCUR_set(sv, d - SvPVX_const(sv));
3685 /* See Note on sizing above. */
3686 sv_utf8_upgrade_flags_grow(sv,
3687 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3688 len + (STRLEN)(send - s) + 1);
3689 d = SvPVX(sv) + SvCUR(sv);
3691 } else if (len > (STRLEN)(e - s + 4)) { /* I _guess_ 4 is \N{} --jhi */
3693 /* See Note on sizing above. (NOTE: SvCUR() is not
3694 * set correctly here). */
3695 const STRLEN off = d - SvPVX_const(sv);
3696 d = off + SvGROW(sv, off + len + (STRLEN)(send - s) + 1);
3698 Copy(str, d, len, char);
3704 } /* End \N{NAME} */
3708 backslash_N++; /* \N{} is defined to be Unicode */
3710 s = e + 1; /* Point to just after the '}' */
3713 /* \c is a control character */
3717 *d++ = grok_bslash_c(*s++, 1);
3720 yyerror("Missing control char name in \\c");
3723 non_portable_endpoint++;
3727 /* printf-style backslashes, formfeeds, newlines, etc */
3753 } /* end if (backslash) */
3756 /* If we started with encoded form, or already know we want it,
3757 then encode the next character */
3758 if (! NATIVE_BYTE_IS_INVARIANT((U8)(*s)) && (this_utf8 || has_utf8)) {
3761 /* One might think that it is wasted effort in the case of the
3762 * source being utf8 (this_utf8 == TRUE) to take the next character
3763 * in the source, convert it to an unsigned value, and then convert
3764 * it back again. But the source has not been validated here. The
3765 * routine that does the conversion checks for errors like
3768 const UV nextuv = (this_utf8)
3769 ? utf8n_to_uvchr((U8*)s, send - s, &len, 0)
3771 const STRLEN need = UVCHR_SKIP(nextuv);
3773 SvCUR_set(sv, d - SvPVX_const(sv));
3776 /* See Note on sizing above. */
3777 sv_utf8_upgrade_flags_grow(sv,
3778 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3779 need + (STRLEN)(send - s) + 1);
3780 d = SvPVX(sv) + SvCUR(sv);
3782 } else if (need > len) {
3783 /* encoded value larger than old, may need extra space (NOTE:
3784 * SvCUR() is not set correctly here). See Note on sizing
3786 const STRLEN off = d - SvPVX_const(sv);
3787 d = SvGROW(sv, off + need + (STRLEN)(send - s) + 1) + off;
3791 d = (char*)uvchr_to_utf8((U8*)d, nextuv);
3796 } /* while loop to process each character */
3798 /* terminate the string and set up the sv */
3800 SvCUR_set(sv, d - SvPVX_const(sv));
3801 if (SvCUR(sv) >= SvLEN(sv))
3802 Perl_croak(aTHX_ "panic: constant overflowed allocated space, %"UVuf
3803 " >= %"UVuf, (UV)SvCUR(sv), (UV)SvLEN(sv));
3806 if (IN_ENCODING && !has_utf8) {
3807 sv_recode_to_utf8(sv, _get_encoding());
3813 if (PL_lex_inwhat == OP_TRANS && PL_sublex_info.sub_op) {
3814 PL_sublex_info.sub_op->op_private |=
3815 (PL_lex_repl ? OPpTRANS_FROM_UTF : OPpTRANS_TO_UTF);
3819 /* shrink the sv if we allocated more than we used */
3820 if (SvCUR(sv) + 5 < SvLEN(sv)) {
3821 SvPV_shrink_to_cur(sv);
3824 /* return the substring (via pl_yylval) only if we parsed anything */
3827 for (; s2 < s; s2++) {
3829 COPLINE_INC_WITH_HERELINES;
3831 SvREFCNT_inc_simple_void_NN(sv);
3832 if ( (PL_hints & ( PL_lex_inpat ? HINT_NEW_RE : HINT_NEW_STRING ))
3833 && ! PL_parser->lex_re_reparsing)
3835 const char *const key = PL_lex_inpat ? "qr" : "q";
3836 const STRLEN keylen = PL_lex_inpat ? 2 : 1;
3840 if (PL_lex_inwhat == OP_TRANS) {
3843 } else if (PL_lex_inwhat == OP_SUBST && !PL_lex_inpat) {
3846 } else if (PL_lex_inpat && SvIVX(PL_linestr) == '\'') {
3854 sv = S_new_constant(aTHX_ start, s - start, key, keylen, sv, NULL,
3857 pl_yylval.opval = (OP*)newSVOP(OP_CONST, 0, sv);
3859 LEAVE_with_name("scan_const");
3864 * Returns TRUE if there's more to the expression (e.g., a subscript),
3867 * It deals with "$foo[3]" and /$foo[3]/ and /$foo[0123456789$]+/
3869 * ->[ and ->{ return TRUE
3870 * ->$* ->$#* ->@* ->@[ ->@{ return TRUE if postderef_qq is enabled
3871 * { and [ outside a pattern are always subscripts, so return TRUE
3872 * if we're outside a pattern and it's not { or [, then return FALSE
3873 * if we're in a pattern and the first char is a {
3874 * {4,5} (any digits around the comma) returns FALSE
3875 * if we're in a pattern and the first char is a [
3877 * [SOMETHING] has a funky algorithm to decide whether it's a
3878 * character class or not. It has to deal with things like
3879 * /$foo[-3]/ and /$foo[$bar]/ as well as /$foo[$\d]+/
3880 * anything else returns TRUE
3883 /* This is the one truly awful dwimmer necessary to conflate C and sed. */
3886 S_intuit_more(pTHX_ char *s)
3888 PERL_ARGS_ASSERT_INTUIT_MORE;
3890 if (PL_lex_brackets)
3892 if (*s == '-' && s[1] == '>' && (s[2] == '[' || s[2] == '{'))
3894 if (*s == '-' && s[1] == '>'
3895 && FEATURE_POSTDEREF_QQ_IS_ENABLED
3896 && ( (s[2] == '$' && (s[3] == '*' || (s[3] == '#' && s[4] == '*')))
3897 ||(s[2] == '@' && strchr("*[{",s[3])) ))
3899 if (*s != '{' && *s != '[')
3904 /* In a pattern, so maybe we have {n,m}. */
3912 /* On the other hand, maybe we have a character class */
3915 if (*s == ']' || *s == '^')
3918 /* this is terrifying, and it works */
3921 const char * const send = strchr(s,']');
3922 unsigned char un_char, last_un_char;
3923 char tmpbuf[sizeof PL_tokenbuf * 4];
3925 if (!send) /* has to be an expression */
3927 weight = 2; /* let's weigh the evidence */
3931 else if (isDIGIT(*s)) {
3933 if (isDIGIT(s[1]) && s[2] == ']')
3939 Zero(seen,256,char);
3941 for (; s < send; s++) {
3942 last_un_char = un_char;
3943 un_char = (unsigned char)*s;
3948 weight -= seen[un_char] * 10;
3949 if (isWORDCHAR_lazy_if(s+1,UTF)) {
3951 char *tmp = PL_bufend;
3952 PL_bufend = (char*)send;
3953 scan_ident(s, tmpbuf, sizeof tmpbuf, FALSE);
3955 len = (int)strlen(tmpbuf);
3956 if (len > 1 && gv_fetchpvn_flags(tmpbuf, len,
3957 UTF ? SVf_UTF8 : 0, SVt_PV))
3964 && strchr("[#!%*<>()-=",s[1]))
3966 if (/*{*/ strchr("])} =",s[2]))
3975 if (strchr("wds]",s[1]))
3977 else if (seen[(U8)'\''] || seen[(U8)'"'])
3979 else if (strchr("rnftbxcav",s[1]))
3981 else if (isDIGIT(s[1])) {
3983 while (s[1] && isDIGIT(s[1]))
3993 if (strchr("aA01! ",last_un_char))
3995 if (strchr("zZ79~",s[1]))
3997 if (last_un_char == 255 && (isDIGIT(s[1]) || s[1] == '$'))
3998 weight -= 5; /* cope with negative subscript */
4001 if (!isWORDCHAR(last_un_char)
4002 && !(last_un_char == '$' || last_un_char == '@'
4003 || last_un_char == '&')
4004 && isALPHA(*s) && s[1] && isALPHA(s[1])) {
4008 if (keyword(d, s - d, 0))
4011 if (un_char == last_un_char + 1)
4013 weight -= seen[un_char];
4018 if (weight >= 0) /* probably a character class */
4028 * Does all the checking to disambiguate
4030 * between foo(bar) and bar->foo. Returns 0 if not a method, otherwise
4031 * FUNCMETH (bar->foo(args)) or METHOD (bar->foo args).
4033 * First argument is the stuff after the first token, e.g. "bar".
4035 * Not a method if foo is a filehandle.
4036 * Not a method if foo is a subroutine prototyped to take a filehandle.
4037 * Not a method if it's really "Foo $bar"
4038 * Method if it's "foo $bar"
4039 * Not a method if it's really "print foo $bar"
4040 * Method if it's really "foo package::" (interpreted as package->foo)
4041 * Not a method if bar is known to be a subroutine ("sub bar; foo bar")
4042 * Not a method if bar is a filehandle or package, but is quoted with
4047 S_intuit_method(pTHX_ char *start, SV *ioname, CV *cv)
4049 char *s = start + (*start == '$');
4050 char tmpbuf[sizeof PL_tokenbuf];
4053 /* Mustn't actually add anything to a symbol table.
4054 But also don't want to "initialise" any placeholder
4055 constants that might already be there into full
4056 blown PVGVs with attached PVCV. */
4058 ioname ? gv_fetchsv(ioname, GV_NOADD_NOINIT, SVt_PVCV) : NULL;
4060 PERL_ARGS_ASSERT_INTUIT_METHOD;
4062 if (gv && SvTYPE(gv) == SVt_PVGV && GvIO(gv))
4064 if (cv && SvPOK(cv)) {
4065 const char *proto = CvPROTO(cv);
4067 while (*proto && (isSPACE(*proto) || *proto == ';'))
4074 if (*start == '$') {
4075 if (cv || PL_last_lop_op == OP_PRINT || PL_last_lop_op == OP_SAY
4076 || isUPPER(*PL_tokenbuf))
4081 return *s == '(' ? FUNCMETH : METHOD;
4084 s = scan_word(s, tmpbuf, sizeof tmpbuf, TRUE, &len);
4085 /* start is the beginning of the possible filehandle/object,
4086 * and s is the end of it
4087 * tmpbuf is a copy of it (but with single quotes as double colons)
4090 if (!keyword(tmpbuf, len, 0)) {
4091 if (len > 2 && tmpbuf[len - 2] == ':' && tmpbuf[len - 1] == ':') {
4096 indirgv = gv_fetchpvn_flags(tmpbuf, len, ( UTF ? SVf_UTF8 : 0 ), SVt_PVCV);
4097 if (indirgv && GvCVu(indirgv))
4099 /* filehandle or package name makes it a method */
4100 if (!cv || GvIO(indirgv) || gv_stashpvn(tmpbuf, len, UTF ? SVf_UTF8 : 0)) {
4102 if ((PL_bufend - s) >= 2 && *s == '=' && *(s+1) == '>')
4103 return 0; /* no assumptions -- "=>" quotes bareword */
4105 NEXTVAL_NEXTTOKE.opval = (OP*)newSVOP(OP_CONST, 0,
4106 S_newSV_maybe_utf8(aTHX_ tmpbuf, len));
4107 NEXTVAL_NEXTTOKE.opval->op_private = OPpCONST_BARE;
4111 return *s == '(' ? FUNCMETH : METHOD;
4117 /* Encoded script support. filter_add() effectively inserts a
4118 * 'pre-processing' function into the current source input stream.
4119 * Note that the filter function only applies to the current source file
4120 * (e.g., it will not affect files 'require'd or 'use'd by this one).
4122 * The datasv parameter (which may be NULL) can be used to pass
4123 * private data to this instance of the filter. The filter function
4124 * can recover the SV using the FILTER_DATA macro and use it to
4125 * store private buffers and state information.
4127 * The supplied datasv parameter is upgraded to a PVIO type
4128 * and the IoDIRP/IoANY field is used to store the function pointer,
4129 * and IOf_FAKE_DIRP is enabled on datasv to mark this as such.
4130 * Note that IoTOP_NAME, IoFMT_NAME, IoBOTTOM_NAME, if set for
4131 * private use must be set using malloc'd pointers.
4135 Perl_filter_add(pTHX_ filter_t funcp, SV *datasv)
4143 if (PL_parser->lex_flags & LEX_IGNORE_UTF8_HINTS)
4144 Perl_croak(aTHX_ "Source filters apply only to byte streams");
4146 if (!PL_rsfp_filters)
4147 PL_rsfp_filters = newAV();
4150 SvUPGRADE(datasv, SVt_PVIO);
4151 IoANY(datasv) = FPTR2DPTR(void *, funcp); /* stash funcp into spare field */
4152 IoFLAGS(datasv) |= IOf_FAKE_DIRP;
4153 DEBUG_P(PerlIO_printf(Perl_debug_log, "filter_add func %p (%s)\n",
4154 FPTR2DPTR(void *, IoANY(datasv)),
4155 SvPV_nolen(datasv)));
4156 av_unshift(PL_rsfp_filters, 1);
4157 av_store(PL_rsfp_filters, 0, datasv) ;
4159 !PL_parser->filtered
4160 && PL_parser->lex_flags & LEX_EVALBYTES
4161 && PL_bufptr < PL_bufend
4163 const char *s = PL_bufptr;
4164 while (s < PL_bufend) {
4166 SV *linestr = PL_parser->linestr;
4167 char *buf = SvPVX(linestr);
4168 STRLEN const bufptr_pos = PL_parser->bufptr - buf;
4169 STRLEN const oldbufptr_pos = PL_parser->oldbufptr - buf;
4170 STRLEN const oldoldbufptr_pos=PL_parser->oldoldbufptr-buf;
4171 STRLEN const linestart_pos = PL_parser->linestart - buf;
4172 STRLEN const last_uni_pos =
4173 PL_parser->last_uni ? PL_parser->last_uni - buf : 0;
4174 STRLEN const last_lop_pos =
4175 PL_parser->last_lop ? PL_parser->last_lop - buf : 0;
4176 av_push(PL_rsfp_filters, linestr);
4177 PL_parser->linestr =
4178 newSVpvn(SvPVX(linestr), ++s-SvPVX(linestr));
4179 buf = SvPVX(PL_parser->linestr);
4180 PL_parser->bufend = buf + SvCUR(PL_parser->linestr);
4181 PL_parser->bufptr = buf + bufptr_pos;
4182 PL_parser->oldbufptr = buf + oldbufptr_pos;
4183 PL_parser->oldoldbufptr = buf + oldoldbufptr_pos;
4184 PL_parser->linestart = buf + linestart_pos;
4185 if (PL_parser->last_uni)
4186 PL_parser->last_uni = buf + last_uni_pos;
4187 if (PL_parser->last_lop)
4188 PL_parser->last_lop = buf + last_lop_pos;
4189 SvLEN(linestr) = SvCUR(linestr);
4190 SvCUR(linestr) = s-SvPVX(linestr);
4191 PL_parser->filtered = 1;
4201 /* Delete most recently added instance of this filter function. */
4203 Perl_filter_del(pTHX_ filter_t funcp)
4207 PERL_ARGS_ASSERT_FILTER_DEL;
4210 DEBUG_P(PerlIO_printf(Perl_debug_log, "filter_del func %p",
4211 FPTR2DPTR(void*, funcp)));
4213 if (!PL_parser || !PL_rsfp_filters || AvFILLp(PL_rsfp_filters)<0)
4215 /* if filter is on top of stack (usual case) just pop it off */
4216 datasv = FILTER_DATA(AvFILLp(PL_rsfp_filters));
4217 if (IoANY(datasv) == FPTR2DPTR(void *, funcp)) {
4218 sv_free(av_pop(PL_rsfp_filters));
4222 /* we need to search for the correct entry and clear it */
4223 Perl_die(aTHX_ "filter_del can only delete in reverse order (currently)");
4227 /* Invoke the idxth filter function for the current rsfp. */
4228 /* maxlen 0 = read one text line */
4230 Perl_filter_read(pTHX_ int idx, SV *buf_sv, int maxlen)
4234 /* This API is bad. It should have been using unsigned int for maxlen.
4235 Not sure if we want to change the API, but if not we should sanity
4236 check the value here. */
4237 unsigned int correct_length = maxlen < 0 ? PERL_INT_MAX : maxlen;
4239 PERL_ARGS_ASSERT_FILTER_READ;
4241 if (!PL_parser || !PL_rsfp_filters)
4243 if (idx > AvFILLp(PL_rsfp_filters)) { /* Any more filters? */
4244 /* Provide a default input filter to make life easy. */
4245 /* Note that we append to the line. This is handy. */
4246 DEBUG_P(PerlIO_printf(Perl_debug_log,
4247 "filter_read %d: from rsfp\n", idx));
4248 if (correct_length) {
4251 const int old_len = SvCUR(buf_sv);
4253 /* ensure buf_sv is large enough */
4254 SvGROW(buf_sv, (STRLEN)(old_len + correct_length + 1)) ;
4255 if ((len = PerlIO_read(PL_rsfp, SvPVX(buf_sv) + old_len,
4256 correct_length)) <= 0) {
4257 if (PerlIO_error(PL_rsfp))
4258 return -1; /* error */
4260 return 0 ; /* end of file */
4262 SvCUR_set(buf_sv, old_len + len) ;
4263 SvPVX(buf_sv)[old_len + len] = '\0';
4266 if (sv_gets(buf_sv, PL_rsfp, SvCUR(buf_sv)) == NULL) {
4267 if (PerlIO_error(PL_rsfp))
4268 return -1; /* error */
4270 return 0 ; /* end of file */
4273 return SvCUR(buf_sv);
4275 /* Skip this filter slot if filter has been deleted */
4276 if ( (datasv = FILTER_DATA(idx)) == &PL_sv_undef) {
4277 DEBUG_P(PerlIO_printf(Perl_debug_log,
4278 "filter_read %d: skipped (filter deleted)\n",
4280 return FILTER_READ(idx+1, buf_sv, correct_length); /* recurse */
4282 if (SvTYPE(datasv) != SVt_PVIO) {
4283 if (correct_length) {
4285 const STRLEN remainder = SvLEN(datasv) - SvCUR(datasv);
4286 if (!remainder) return 0; /* eof */
4287 if (correct_length > remainder) correct_length = remainder;
4288 sv_catpvn(buf_sv, SvEND(datasv), correct_length);
4289 SvCUR_set(datasv, SvCUR(datasv) + correct_length);
4292 const char *s = SvEND(datasv);
4293 const char *send = SvPVX(datasv) + SvLEN(datasv);
4301 if (s == send) return 0; /* eof */
4302 sv_catpvn(buf_sv, SvEND(datasv), s-SvEND(datasv));
4303 SvCUR_set(datasv, s-SvPVX(datasv));
4305 return SvCUR(buf_sv);
4307 /* Get function pointer hidden within datasv */
4308 funcp = DPTR2FPTR(filter_t, IoANY(datasv));
4309 DEBUG_P(PerlIO_printf(Perl_debug_log,
4310 "filter_read %d: via function %p (%s)\n",
4311 idx, (void*)datasv, SvPV_nolen_const(datasv)));
4312 /* Call function. The function is expected to */
4313 /* call "FILTER_READ(idx+1, buf_sv)" first. */