3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 * 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
12 * 'It all comes from here, the stench and the peril.' --Frodo
14 * [p.719 of _The Lord of the Rings_, IV/ix: "Shelob's Lair"]
18 * This file is the lexer for Perl. It's closely linked to the
21 * The main routine is yylex(), which returns the next token.
25 =head1 Lexer interface
27 This is the lower layer of the Perl parser, managing characters and tokens.
29 =for apidoc AmU|yy_parser *|PL_parser
31 Pointer to a structure encapsulating the state of the parsing operation
32 currently in progress. The pointer can be locally changed to perform
33 a nested parse without interfering with the state of an outer parse.
34 Individual members of C<PL_parser> have their own documentation.
40 #define PERL_IN_TOKE_C
42 #include "dquote_static.c"
44 #define new_constant(a,b,c,d,e,f,g) \
45 S_new_constant(aTHX_ a,b,STR_WITH_LEN(c),d,e,f, g)
47 #define pl_yylval (PL_parser->yylval)
49 /* XXX temporary backwards compatibility */
50 #define PL_lex_brackets (PL_parser->lex_brackets)
51 #define PL_lex_allbrackets (PL_parser->lex_allbrackets)
52 #define PL_lex_fakeeof (PL_parser->lex_fakeeof)
53 #define PL_lex_brackstack (PL_parser->lex_brackstack)
54 #define PL_lex_casemods (PL_parser->lex_casemods)
55 #define PL_lex_casestack (PL_parser->lex_casestack)
56 #define PL_lex_defer (PL_parser->lex_defer)
57 #define PL_lex_dojoin (PL_parser->lex_dojoin)
58 #define PL_lex_expect (PL_parser->lex_expect)
59 #define PL_lex_formbrack (PL_parser->lex_formbrack)
60 #define PL_lex_inpat (PL_parser->lex_inpat)
61 #define PL_lex_inwhat (PL_parser->lex_inwhat)
62 #define PL_lex_op (PL_parser->lex_op)
63 #define PL_lex_repl (PL_parser->lex_repl)
64 #define PL_lex_starts (PL_parser->lex_starts)
65 #define PL_lex_stuff (PL_parser->lex_stuff)
66 #define PL_multi_start (PL_parser->multi_start)
67 #define PL_multi_open (PL_parser->multi_open)
68 #define PL_multi_close (PL_parser->multi_close)
69 #define PL_preambled (PL_parser->preambled)
70 #define PL_sublex_info (PL_parser->sublex_info)
71 #define PL_linestr (PL_parser->linestr)
72 #define PL_expect (PL_parser->expect)
73 #define PL_copline (PL_parser->copline)
74 #define PL_bufptr (PL_parser->bufptr)
75 #define PL_oldbufptr (PL_parser->oldbufptr)
76 #define PL_oldoldbufptr (PL_parser->oldoldbufptr)
77 #define PL_linestart (PL_parser->linestart)
78 #define PL_bufend (PL_parser->bufend)
79 #define PL_last_uni (PL_parser->last_uni)
80 #define PL_last_lop (PL_parser->last_lop)
81 #define PL_last_lop_op (PL_parser->last_lop_op)
82 #define PL_lex_state (PL_parser->lex_state)
83 #define PL_rsfp (PL_parser->rsfp)
84 #define PL_rsfp_filters (PL_parser->rsfp_filters)
85 #define PL_in_my (PL_parser->in_my)
86 #define PL_in_my_stash (PL_parser->in_my_stash)
87 #define PL_tokenbuf (PL_parser->tokenbuf)
88 #define PL_multi_end (PL_parser->multi_end)
89 #define PL_error_count (PL_parser->error_count)
92 # define PL_endwhite (PL_parser->endwhite)
93 # define PL_faketokens (PL_parser->faketokens)
94 # define PL_lasttoke (PL_parser->lasttoke)
95 # define PL_nextwhite (PL_parser->nextwhite)
96 # define PL_realtokenstart (PL_parser->realtokenstart)
97 # define PL_skipwhite (PL_parser->skipwhite)
98 # define PL_thisclose (PL_parser->thisclose)
99 # define PL_thismad (PL_parser->thismad)
100 # define PL_thisopen (PL_parser->thisopen)
101 # define PL_thisstuff (PL_parser->thisstuff)
102 # define PL_thistoken (PL_parser->thistoken)
103 # define PL_thiswhite (PL_parser->thiswhite)
104 # define PL_thiswhite (PL_parser->thiswhite)
105 # define PL_nexttoke (PL_parser->nexttoke)
106 # define PL_curforce (PL_parser->curforce)
108 # define PL_nexttoke (PL_parser->nexttoke)
109 # define PL_nexttype (PL_parser->nexttype)
110 # define PL_nextval (PL_parser->nextval)
113 static const char* const ident_too_long = "Identifier too long";
116 # define CURMAD(slot,sv) if (PL_madskills) { curmad(slot,sv); sv = 0; }
117 # define NEXTVAL_NEXTTOKE PL_nexttoke[PL_curforce].next_val
119 # define CURMAD(slot,sv)
120 # define NEXTVAL_NEXTTOKE PL_nextval[PL_nexttoke]
123 #define XENUMMASK 0x3f
124 #define XFAKEEOF 0x40
125 #define XFAKEBRACK 0x80
127 #ifdef USE_UTF8_SCRIPTS
128 # define UTF (!IN_BYTES)
130 # define UTF ((PL_linestr && DO_UTF8(PL_linestr)) || ( !(PL_parser->lex_flags & LEX_IGNORE_UTF8_HINTS) && (PL_hints & HINT_UTF8)))
133 /* The maximum number of characters preceding the unrecognized one to display */
134 #define UNRECOGNIZED_PRECEDE_COUNT 10
136 /* In variables named $^X, these are the legal values for X.
137 * 1999-02-27 mjd-perl-patch@plover.com */
138 #define isCONTROLVAR(x) (isUPPER(x) || strchr("[\\]^_?", (x)))
140 #define SPACE_OR_TAB(c) isBLANK_A(c)
142 /* LEX_* are values for PL_lex_state, the state of the lexer.
143 * They are arranged oddly so that the guard on the switch statement
144 * can get by with a single comparison (if the compiler is smart enough).
146 * These values refer to the various states within a sublex parse,
147 * i.e. within a double quotish string
150 /* #define LEX_NOTPARSING 11 is done in perl.h. */
152 #define LEX_NORMAL 10 /* normal code (ie not within "...") */
153 #define LEX_INTERPNORMAL 9 /* code within a string, eg "$foo[$x+1]" */
154 #define LEX_INTERPCASEMOD 8 /* expecting a \U, \Q or \E etc */
155 #define LEX_INTERPPUSH 7 /* starting a new sublex parse level */
156 #define LEX_INTERPSTART 6 /* expecting the start of a $var */
158 /* at end of code, eg "$x" followed by: */
159 #define LEX_INTERPEND 5 /* ... eg not one of [, { or -> */
160 #define LEX_INTERPENDMAYBE 4 /* ... eg one of [, { or -> */
162 #define LEX_INTERPCONCAT 3 /* expecting anything, eg at start of
163 string or after \E, $foo, etc */
164 #define LEX_INTERPCONST 2 /* NOT USED */
165 #define LEX_FORMLINE 1 /* expecting a format line */
166 #define LEX_KNOWNEXT 0 /* next token known; just return it */
170 static const char* const lex_state_names[] = {
185 #include "keywords.h"
187 /* CLINE is a macro that ensures PL_copline has a sane value */
189 #define CLINE (PL_copline = (CopLINE(PL_curcop) < PL_copline ? CopLINE(PL_curcop) : PL_copline))
192 # define SKIPSPACE0(s) skipspace0(s)
193 # define SKIPSPACE1(s) skipspace1(s)
194 # define SKIPSPACE2(s,tsv) skipspace2(s,&tsv)
195 # define PEEKSPACE(s) skipspace2(s,0)
197 # define SKIPSPACE0(s) skipspace(s)
198 # define SKIPSPACE1(s) skipspace(s)
199 # define SKIPSPACE2(s,tsv) skipspace(s)
200 # define PEEKSPACE(s) skipspace(s)
204 * Convenience functions to return different tokens and prime the
205 * lexer for the next token. They all take an argument.
207 * TOKEN : generic token (used for '(', DOLSHARP, etc)
208 * OPERATOR : generic operator
209 * AOPERATOR : assignment operator
210 * PREBLOCK : beginning the block after an if, while, foreach, ...
211 * PRETERMBLOCK : beginning a non-code-defining {} block (eg, hash ref)
212 * PREREF : *EXPR where EXPR is not a simple identifier
213 * TERM : expression term
214 * POSTDEREF : postfix dereference (->$* ->@[...] etc.)
215 * LOOPX : loop exiting command (goto, last, dump, etc)
216 * FTST : file test operator
217 * FUN0 : zero-argument function
218 * FUN0OP : zero-argument function, with its op created in this file
219 * FUN1 : not used, except for not, which isn't a UNIOP
220 * BOop : bitwise or or xor
222 * SHop : shift operator
223 * PWop : power operator
224 * PMop : pattern-matching operator
225 * Aop : addition-level operator
226 * Mop : multiplication-level operator
227 * Eop : equality-testing operator
228 * Rop : relational operator <= != gt
230 * Also see LOP and lop() below.
233 #ifdef DEBUGGING /* Serve -DT. */
234 # define REPORT(retval) tokereport((I32)retval, &pl_yylval)
236 # define REPORT(retval) (retval)
239 #define TOKEN(retval) return ( PL_bufptr = s, REPORT(retval))
240 #define OPERATOR(retval) return (PL_expect = XTERM, PL_bufptr = s, REPORT(retval))
241 #define AOPERATOR(retval) return ao((PL_expect = XTERM, PL_bufptr = s, REPORT(retval)))
242 #define PREBLOCK(retval) return (PL_expect = XBLOCK,PL_bufptr = s, REPORT(retval))
243 #define PRETERMBLOCK(retval) return (PL_expect = XTERMBLOCK,PL_bufptr = s, REPORT(retval))
244 #define PREREF(retval) return (PL_expect = XREF,PL_bufptr = s, REPORT(retval))
245 #define TERM(retval) return (CLINE, PL_expect = XOPERATOR, PL_bufptr = s, REPORT(retval))
246 #define POSTDEREF(f) return (PL_bufptr = s, S_postderef(aTHX_ REPORT(f),s[1]))
247 #define LOOPX(f) return (pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)LOOPEX))
248 #define FTST(f) return (pl_yylval.ival=f, PL_expect=XTERMORDORDOR, PL_bufptr=s, REPORT((int)UNIOP))
249 #define FUN0(f) return (pl_yylval.ival=f, PL_expect=XOPERATOR, PL_bufptr=s, REPORT((int)FUNC0))
250 #define FUN0OP(f) return (pl_yylval.opval=f, CLINE, PL_expect=XOPERATOR, PL_bufptr=s, REPORT((int)FUNC0OP))
251 #define FUN1(f) return (pl_yylval.ival=f, PL_expect=XOPERATOR, PL_bufptr=s, REPORT((int)FUNC1))
252 #define BOop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)BITOROP)))
253 #define BAop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)BITANDOP)))
254 #define SHop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)SHIFTOP)))
255 #define PWop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)POWOP)))
256 #define PMop(f) return(pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)MATCHOP))
257 #define Aop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)ADDOP)))
258 #define Mop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)MULOP)))
259 #define Eop(f) return (pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)EQOP))
260 #define Rop(f) return (pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)RELOP))
262 /* This bit of chicanery makes a unary function followed by
263 * a parenthesis into a function with one argument, highest precedence.
264 * The UNIDOR macro is for unary functions that can be followed by the //
265 * operator (such as C<shift // 0>).
267 #define UNI3(f,x,have_x) { \
268 pl_yylval.ival = f; \
269 if (have_x) PL_expect = x; \
271 PL_last_uni = PL_oldbufptr; \
272 PL_last_lop_op = f; \
274 return REPORT( (int)FUNC1 ); \
276 return REPORT( *s=='(' ? (int)FUNC1 : (int)UNIOP ); \
278 #define UNI(f) UNI3(f,XTERM,1)
279 #define UNIDOR(f) UNI3(f,XTERMORDORDOR,1)
280 #define UNIPROTO(f,optional) { \
281 if (optional) PL_last_uni = PL_oldbufptr; \
285 #define UNIBRACK(f) UNI3(f,0,0)
287 /* grandfather return to old style */
290 if (!PL_lex_allbrackets && PL_lex_fakeeof > LEX_FAKEEOF_LOWLOGIC) \
291 PL_lex_fakeeof = LEX_FAKEEOF_LOWLOGIC; \
292 pl_yylval.ival = (f); \
298 #define COPLINE_INC_WITH_HERELINES \
300 CopLINE_inc(PL_curcop); \
301 if (PL_parser->herelines) \
302 CopLINE(PL_curcop) += PL_parser->herelines, \
303 PL_parser->herelines = 0; \
305 /* Called after scan_str to update CopLINE(PL_curcop), but only when there
306 * is no sublex_push to follow. */
307 #define COPLINE_SET_FROM_MULTI_END \
309 CopLINE_set(PL_curcop, PL_multi_end); \
310 if (PL_multi_end != PL_multi_start) \
311 PL_parser->herelines = 0; \
317 /* how to interpret the pl_yylval associated with the token */
321 TOKENTYPE_OPNUM, /* pl_yylval.ival contains an opcode number */
326 static struct debug_tokens {
328 enum token_type type;
330 } const debug_tokens[] =
332 { ADDOP, TOKENTYPE_OPNUM, "ADDOP" },
333 { ANDAND, TOKENTYPE_NONE, "ANDAND" },
334 { ANDOP, TOKENTYPE_NONE, "ANDOP" },
335 { ANONSUB, TOKENTYPE_IVAL, "ANONSUB" },
336 { ARROW, TOKENTYPE_NONE, "ARROW" },
337 { ASSIGNOP, TOKENTYPE_OPNUM, "ASSIGNOP" },
338 { BITANDOP, TOKENTYPE_OPNUM, "BITANDOP" },
339 { BITOROP, TOKENTYPE_OPNUM, "BITOROP" },
340 { COLONATTR, TOKENTYPE_NONE, "COLONATTR" },
341 { CONTINUE, TOKENTYPE_NONE, "CONTINUE" },
342 { DEFAULT, TOKENTYPE_NONE, "DEFAULT" },
343 { DO, TOKENTYPE_NONE, "DO" },
344 { DOLSHARP, TOKENTYPE_NONE, "DOLSHARP" },
345 { DORDOR, TOKENTYPE_NONE, "DORDOR" },
346 { DOROP, TOKENTYPE_OPNUM, "DOROP" },
347 { DOTDOT, TOKENTYPE_IVAL, "DOTDOT" },
348 { ELSE, TOKENTYPE_NONE, "ELSE" },
349 { ELSIF, TOKENTYPE_IVAL, "ELSIF" },
350 { EQOP, TOKENTYPE_OPNUM, "EQOP" },
351 { FOR, TOKENTYPE_IVAL, "FOR" },
352 { FORMAT, TOKENTYPE_NONE, "FORMAT" },
353 { FORMLBRACK, TOKENTYPE_NONE, "FORMLBRACK" },
354 { FORMRBRACK, TOKENTYPE_NONE, "FORMRBRACK" },
355 { FUNC, TOKENTYPE_OPNUM, "FUNC" },
356 { FUNC0, TOKENTYPE_OPNUM, "FUNC0" },
357 { FUNC0OP, TOKENTYPE_OPVAL, "FUNC0OP" },
358 { FUNC0SUB, TOKENTYPE_OPVAL, "FUNC0SUB" },
359 { FUNC1, TOKENTYPE_OPNUM, "FUNC1" },
360 { FUNCMETH, TOKENTYPE_OPVAL, "FUNCMETH" },
361 { GIVEN, TOKENTYPE_IVAL, "GIVEN" },
362 { HASHBRACK, TOKENTYPE_NONE, "HASHBRACK" },
363 { IF, TOKENTYPE_IVAL, "IF" },
364 { LABEL, TOKENTYPE_PVAL, "LABEL" },
365 { LOCAL, TOKENTYPE_IVAL, "LOCAL" },
366 { LOOPEX, TOKENTYPE_OPNUM, "LOOPEX" },
367 { LSTOP, TOKENTYPE_OPNUM, "LSTOP" },
368 { LSTOPSUB, TOKENTYPE_OPVAL, "LSTOPSUB" },
369 { MATCHOP, TOKENTYPE_OPNUM, "MATCHOP" },
370 { METHOD, TOKENTYPE_OPVAL, "METHOD" },
371 { MULOP, TOKENTYPE_OPNUM, "MULOP" },
372 { MY, TOKENTYPE_IVAL, "MY" },
373 { NOAMP, TOKENTYPE_NONE, "NOAMP" },
374 { NOTOP, TOKENTYPE_NONE, "NOTOP" },
375 { OROP, TOKENTYPE_IVAL, "OROP" },
376 { OROR, TOKENTYPE_NONE, "OROR" },
377 { PACKAGE, TOKENTYPE_NONE, "PACKAGE" },
378 { PEG, TOKENTYPE_NONE, "PEG" },
379 { PLUGEXPR, TOKENTYPE_OPVAL, "PLUGEXPR" },
380 { PLUGSTMT, TOKENTYPE_OPVAL, "PLUGSTMT" },
381 { PMFUNC, TOKENTYPE_OPVAL, "PMFUNC" },
382 { POSTJOIN, TOKENTYPE_NONE, "POSTJOIN" },
383 { POSTDEC, TOKENTYPE_NONE, "POSTDEC" },
384 { POSTINC, TOKENTYPE_NONE, "POSTINC" },
385 { POWOP, TOKENTYPE_OPNUM, "POWOP" },
386 { PREDEC, TOKENTYPE_NONE, "PREDEC" },
387 { PREINC, TOKENTYPE_NONE, "PREINC" },
388 { PRIVATEREF, TOKENTYPE_OPVAL, "PRIVATEREF" },
389 { QWLIST, TOKENTYPE_OPVAL, "QWLIST" },
390 { REFGEN, TOKENTYPE_NONE, "REFGEN" },
391 { RELOP, TOKENTYPE_OPNUM, "RELOP" },
392 { REQUIRE, TOKENTYPE_NONE, "REQUIRE" },
393 { SHIFTOP, TOKENTYPE_OPNUM, "SHIFTOP" },
394 { SUB, TOKENTYPE_NONE, "SUB" },
395 { THING, TOKENTYPE_OPVAL, "THING" },
396 { UMINUS, TOKENTYPE_NONE, "UMINUS" },
397 { UNIOP, TOKENTYPE_OPNUM, "UNIOP" },
398 { UNIOPSUB, TOKENTYPE_OPVAL, "UNIOPSUB" },
399 { UNLESS, TOKENTYPE_IVAL, "UNLESS" },
400 { UNTIL, TOKENTYPE_IVAL, "UNTIL" },
401 { USE, TOKENTYPE_IVAL, "USE" },
402 { WHEN, TOKENTYPE_IVAL, "WHEN" },
403 { WHILE, TOKENTYPE_IVAL, "WHILE" },
404 { WORD, TOKENTYPE_OPVAL, "WORD" },
405 { YADAYADA, TOKENTYPE_IVAL, "YADAYADA" },
406 { 0, TOKENTYPE_NONE, NULL }
409 /* dump the returned token in rv, plus any optional arg in pl_yylval */
412 S_tokereport(pTHX_ I32 rv, const YYSTYPE* lvalp)
416 PERL_ARGS_ASSERT_TOKEREPORT;
419 const char *name = NULL;
420 enum token_type type = TOKENTYPE_NONE;
421 const struct debug_tokens *p;
422 SV* const report = newSVpvs("<== ");
424 for (p = debug_tokens; p->token; p++) {
425 if (p->token == (int)rv) {
432 Perl_sv_catpv(aTHX_ report, name);
433 else if ((char)rv > ' ' && (char)rv <= '~')
435 Perl_sv_catpvf(aTHX_ report, "'%c'", (char)rv);
437 sv_catpvs(report, " (pending identifier)");
440 sv_catpvs(report, "EOF");
442 Perl_sv_catpvf(aTHX_ report, "?? %"IVdf, (IV)rv);
447 Perl_sv_catpvf(aTHX_ report, "(ival=%"IVdf")", (IV)lvalp->ival);
449 case TOKENTYPE_OPNUM:
450 Perl_sv_catpvf(aTHX_ report, "(ival=op_%s)",
451 PL_op_name[lvalp->ival]);
454 Perl_sv_catpvf(aTHX_ report, "(pval=\"%s\")", lvalp->pval);
456 case TOKENTYPE_OPVAL:
458 Perl_sv_catpvf(aTHX_ report, "(opval=op_%s)",
459 PL_op_name[lvalp->opval->op_type]);
460 if (lvalp->opval->op_type == OP_CONST) {
461 Perl_sv_catpvf(aTHX_ report, " %s",
462 SvPEEK(cSVOPx_sv(lvalp->opval)));
467 sv_catpvs(report, "(opval=null)");
470 PerlIO_printf(Perl_debug_log, "### %s\n\n", SvPV_nolen_const(report));
476 /* print the buffer with suitable escapes */
479 S_printbuf(pTHX_ const char *const fmt, const char *const s)
481 SV* const tmp = newSVpvs("");
483 PERL_ARGS_ASSERT_PRINTBUF;
485 GCC_DIAG_IGNORE(-Wformat-nonliteral); /* fmt checked by caller */
486 PerlIO_printf(Perl_debug_log, fmt, pv_display(tmp, s, strlen(s), 0, 60));
494 S_deprecate_commaless_var_list(pTHX) {
496 deprecate("comma-less variable list");
497 return REPORT(','); /* grandfather non-comma-format format */
503 * This subroutine detects &&=, ||=, and //= and turns an ANDAND, OROR or DORDOR
504 * into an OP_ANDASSIGN, OP_ORASSIGN, or OP_DORASSIGN
508 S_ao(pTHX_ int toketype)
511 if (*PL_bufptr == '=') {
513 if (toketype == ANDAND)
514 pl_yylval.ival = OP_ANDASSIGN;
515 else if (toketype == OROR)
516 pl_yylval.ival = OP_ORASSIGN;
517 else if (toketype == DORDOR)
518 pl_yylval.ival = OP_DORASSIGN;
526 * When Perl expects an operator and finds something else, no_op
527 * prints the warning. It always prints "<something> found where
528 * operator expected. It prints "Missing semicolon on previous line?"
529 * if the surprise occurs at the start of the line. "do you need to
530 * predeclare ..." is printed out for code like "sub bar; foo bar $x"
531 * where the compiler doesn't know if foo is a method call or a function.
532 * It prints "Missing operator before end of line" if there's nothing
533 * after the missing operator, or "... before <...>" if there is something
534 * after the missing operator.
538 S_no_op(pTHX_ const char *const what, char *s)
541 char * const oldbp = PL_bufptr;
542 const bool is_first = (PL_oldbufptr == PL_linestart);
544 PERL_ARGS_ASSERT_NO_OP;
550 yywarn(Perl_form(aTHX_ "%s found where operator expected", what), UTF ? SVf_UTF8 : 0);
551 if (ckWARN_d(WARN_SYNTAX)) {
553 Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
554 "\t(Missing semicolon on previous line?)\n");
555 else if (PL_oldoldbufptr && isIDFIRST_lazy_if(PL_oldoldbufptr,UTF)) {
557 for (t = PL_oldoldbufptr; (isWORDCHAR_lazy_if(t,UTF) || *t == ':');
558 t += UTF ? UTF8SKIP(t) : 1)
560 if (t < PL_bufptr && isSPACE(*t))
561 Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
562 "\t(Do you need to predeclare %"UTF8f"?)\n",
563 UTF8fARG(UTF, t - PL_oldoldbufptr, PL_oldoldbufptr));
567 Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
568 "\t(Missing operator before %"UTF8f"?)\n",
569 UTF8fARG(UTF, s - oldbp, oldbp));
577 * Complain about missing quote/regexp/heredoc terminator.
578 * If it's called with NULL then it cauterizes the line buffer.
579 * If we're in a delimited string and the delimiter is a control
580 * character, it's reformatted into a two-char sequence like ^C.
585 S_missingterm(pTHX_ char *s)
591 char * const nl = strrchr(s,'\n');
595 else if ((U8) PL_multi_close < 32) {
597 tmpbuf[1] = (char)toCTRL(PL_multi_close);
602 *tmpbuf = (char)PL_multi_close;
606 q = strchr(s,'"') ? '\'' : '"';
607 Perl_croak(aTHX_ "Can't find string terminator %c%s%c anywhere before EOF",q,s,q);
613 * Check whether the named feature is enabled.
616 Perl_feature_is_enabled(pTHX_ const char *const name, STRLEN namelen)
619 char he_name[8 + MAX_FEATURE_LEN] = "feature_";
621 PERL_ARGS_ASSERT_FEATURE_IS_ENABLED;
623 assert(CURRENT_FEATURE_BUNDLE == FEATURE_BUNDLE_CUSTOM);
625 if (namelen > MAX_FEATURE_LEN)
627 memcpy(&he_name[8], name, namelen);
629 return cBOOL(cop_hints_fetch_pvn(PL_curcop, he_name, 8 + namelen, 0,
630 REFCOUNTED_HE_EXISTS));
634 * experimental text filters for win32 carriage-returns, utf16-to-utf8 and
635 * utf16-to-utf8-reversed.
638 #ifdef PERL_CR_FILTER
642 const char *s = SvPVX_const(sv);
643 const char * const e = s + SvCUR(sv);
645 PERL_ARGS_ASSERT_STRIP_RETURN;
647 /* outer loop optimized to do nothing if there are no CR-LFs */
649 if (*s++ == '\r' && *s == '\n') {
650 /* hit a CR-LF, need to copy the rest */
654 if (*s == '\r' && s[1] == '\n')
665 S_cr_textfilter(pTHX_ int idx, SV *sv, int maxlen)
667 const I32 count = FILTER_READ(idx+1, sv, maxlen);
668 if (count > 0 && !maxlen)
675 =for apidoc Amx|void|lex_start|SV *line|PerlIO *rsfp|U32 flags
677 Creates and initialises a new lexer/parser state object, supplying
678 a context in which to lex and parse from a new source of Perl code.
679 A pointer to the new state object is placed in L</PL_parser>. An entry
680 is made on the save stack so that upon unwinding the new state object
681 will be destroyed and the former value of L</PL_parser> will be restored.
682 Nothing else need be done to clean up the parsing context.
684 The code to be parsed comes from I<line> and I<rsfp>. I<line>, if
685 non-null, provides a string (in SV form) containing code to be parsed.
686 A copy of the string is made, so subsequent modification of I<line>
687 does not affect parsing. I<rsfp>, if non-null, provides an input stream
688 from which code will be read to be parsed. If both are non-null, the
689 code in I<line> comes first and must consist of complete lines of input,
690 and I<rsfp> supplies the remainder of the source.
692 The I<flags> parameter is reserved for future use. Currently it is only
693 used by perl internally, so extensions should always pass zero.
698 /* LEX_START_SAME_FILTER indicates that this is not a new file, so it
699 can share filters with the current parser.
700 LEX_START_DONT_CLOSE indicates that the file handle wasn't opened by the
701 caller, hence isn't owned by the parser, so shouldn't be closed on parser
702 destruction. This is used to handle the case of defaulting to reading the
703 script from the standard input because no filename was given on the command
704 line (without getting confused by situation where STDIN has been closed, so
705 the script handle is opened on fd 0) */
708 Perl_lex_start(pTHX_ SV *line, PerlIO *rsfp, U32 flags)
711 const char *s = NULL;
712 yy_parser *parser, *oparser;
713 if (flags && flags & ~LEX_START_FLAGS)
714 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_start");
716 /* create and initialise a parser */
718 Newxz(parser, 1, yy_parser);
719 parser->old_parser = oparser = PL_parser;
722 parser->stack = NULL;
724 parser->stack_size = 0;
726 /* on scope exit, free this parser and restore any outer one */
728 parser->saved_curcop = PL_curcop;
730 /* initialise lexer state */
733 parser->curforce = -1;
735 parser->nexttoke = 0;
737 parser->error_count = oparser ? oparser->error_count : 0;
738 parser->copline = parser->preambling = NOLINE;
739 parser->lex_state = LEX_NORMAL;
740 parser->expect = XSTATE;
742 parser->rsfp_filters =
743 !(flags & LEX_START_SAME_FILTER) || !oparser
745 : MUTABLE_AV(SvREFCNT_inc(
746 oparser->rsfp_filters
747 ? oparser->rsfp_filters
748 : (oparser->rsfp_filters = newAV())
751 Newx(parser->lex_brackstack, 120, char);
752 Newx(parser->lex_casestack, 12, char);
753 *parser->lex_casestack = '\0';
754 Newxz(parser->lex_shared, 1, LEXSHARED);
758 s = SvPV_const(line, len);
759 parser->linestr = flags & LEX_START_COPIED
760 ? SvREFCNT_inc_simple_NN(line)
761 : newSVpvn_flags(s, len, SvUTF8(line));
762 sv_catpvn(parser->linestr, "\n;", rsfp ? 1 : 2);
764 parser->linestr = newSVpvn("\n;", rsfp ? 1 : 2);
766 parser->oldoldbufptr =
769 parser->linestart = SvPVX(parser->linestr);
770 parser->bufend = parser->bufptr + SvCUR(parser->linestr);
771 parser->last_lop = parser->last_uni = NULL;
773 assert(FITS_IN_8_BITS(LEX_IGNORE_UTF8_HINTS|LEX_EVALBYTES
774 |LEX_DONT_CLOSE_RSFP));
775 parser->lex_flags = (U8) (flags & (LEX_IGNORE_UTF8_HINTS|LEX_EVALBYTES
776 |LEX_DONT_CLOSE_RSFP));
778 parser->in_pod = parser->filtered = 0;
782 /* delete a parser object */
785 Perl_parser_free(pTHX_ const yy_parser *parser)
787 PERL_ARGS_ASSERT_PARSER_FREE;
789 PL_curcop = parser->saved_curcop;
790 SvREFCNT_dec(parser->linestr);
792 if (PL_parser->lex_flags & LEX_DONT_CLOSE_RSFP)
793 PerlIO_clearerr(parser->rsfp);
794 else if (parser->rsfp && (!parser->old_parser ||
795 (parser->old_parser && parser->rsfp != parser->old_parser->rsfp)))
796 PerlIO_close(parser->rsfp);
797 SvREFCNT_dec(parser->rsfp_filters);
798 SvREFCNT_dec(parser->lex_stuff);
799 SvREFCNT_dec(parser->sublex_info.repl);
801 Safefree(parser->lex_brackstack);
802 Safefree(parser->lex_casestack);
803 Safefree(parser->lex_shared);
804 PL_parser = parser->old_parser;
809 Perl_parser_free_nexttoke_ops(pTHX_ yy_parser *parser, OPSLAB *slab)
812 I32 nexttoke = parser->lasttoke;
814 I32 nexttoke = parser->nexttoke;
816 PERL_ARGS_ASSERT_PARSER_FREE_NEXTTOKE_OPS;
819 if (S_is_opval_token(parser->nexttoke[nexttoke].next_type
821 && parser->nexttoke[nexttoke].next_val.opval
822 && parser->nexttoke[nexttoke].next_val.opval->op_slabbed
823 && OpSLAB(parser->nexttoke[nexttoke].next_val.opval) == slab) {
824 op_free(parser->nexttoke[nexttoke].next_val.opval);
825 parser->nexttoke[nexttoke].next_val.opval = NULL;
828 if (S_is_opval_token(parser->nexttype[nexttoke] & 0xffff)
829 && parser->nextval[nexttoke].opval
830 && parser->nextval[nexttoke].opval->op_slabbed
831 && OpSLAB(parser->nextval[nexttoke].opval) == slab) {
832 op_free(parser->nextval[nexttoke].opval);
833 parser->nextval[nexttoke].opval = NULL;
841 =for apidoc AmxU|SV *|PL_parser-E<gt>linestr
843 Buffer scalar containing the chunk currently under consideration of the
844 text currently being lexed. This is always a plain string scalar (for
845 which C<SvPOK> is true). It is not intended to be used as a scalar by
846 normal scalar means; instead refer to the buffer directly by the pointer
847 variables described below.
849 The lexer maintains various C<char*> pointers to things in the
850 C<PL_parser-E<gt>linestr> buffer. If C<PL_parser-E<gt>linestr> is ever
851 reallocated, all of these pointers must be updated. Don't attempt to
852 do this manually, but rather use L</lex_grow_linestr> if you need to
853 reallocate the buffer.
855 The content of the text chunk in the buffer is commonly exactly one
856 complete line of input, up to and including a newline terminator,
857 but there are situations where it is otherwise. The octets of the
858 buffer may be intended to be interpreted as either UTF-8 or Latin-1.
859 The function L</lex_bufutf8> tells you which. Do not use the C<SvUTF8>
860 flag on this scalar, which may disagree with it.
862 For direct examination of the buffer, the variable
863 L</PL_parser-E<gt>bufend> points to the end of the buffer. The current
864 lexing position is pointed to by L</PL_parser-E<gt>bufptr>. Direct use
865 of these pointers is usually preferable to examination of the scalar
866 through normal scalar means.
868 =for apidoc AmxU|char *|PL_parser-E<gt>bufend
870 Direct pointer to the end of the chunk of text currently being lexed, the
871 end of the lexer buffer. This is equal to C<SvPVX(PL_parser-E<gt>linestr)
872 + SvCUR(PL_parser-E<gt>linestr)>. A NUL character (zero octet) is
873 always located at the end of the buffer, and does not count as part of
874 the buffer's contents.
876 =for apidoc AmxU|char *|PL_parser-E<gt>bufptr
878 Points to the current position of lexing inside the lexer buffer.
879 Characters around this point may be freely examined, within
880 the range delimited by C<SvPVX(L</PL_parser-E<gt>linestr>)> and
881 L</PL_parser-E<gt>bufend>. The octets of the buffer may be intended to be
882 interpreted as either UTF-8 or Latin-1, as indicated by L</lex_bufutf8>.
884 Lexing code (whether in the Perl core or not) moves this pointer past
885 the characters that it consumes. It is also expected to perform some
886 bookkeeping whenever a newline character is consumed. This movement
887 can be more conveniently performed by the function L</lex_read_to>,
888 which handles newlines appropriately.
890 Interpretation of the buffer's octets can be abstracted out by
891 using the slightly higher-level functions L</lex_peek_unichar> and
892 L</lex_read_unichar>.
894 =for apidoc AmxU|char *|PL_parser-E<gt>linestart
896 Points to the start of the current line inside the lexer buffer.
897 This is useful for indicating at which column an error occurred, and
898 not much else. This must be updated by any lexing code that consumes
899 a newline; the function L</lex_read_to> handles this detail.
905 =for apidoc Amx|bool|lex_bufutf8
907 Indicates whether the octets in the lexer buffer
908 (L</PL_parser-E<gt>linestr>) should be interpreted as the UTF-8 encoding
909 of Unicode characters. If not, they should be interpreted as Latin-1
910 characters. This is analogous to the C<SvUTF8> flag for scalars.
912 In UTF-8 mode, it is not guaranteed that the lexer buffer actually
913 contains valid UTF-8. Lexing code must be robust in the face of invalid
916 The actual C<SvUTF8> flag of the L</PL_parser-E<gt>linestr> scalar
917 is significant, but not the whole story regarding the input character
918 encoding. Normally, when a file is being read, the scalar contains octets
919 and its C<SvUTF8> flag is off, but the octets should be interpreted as
920 UTF-8 if the C<use utf8> pragma is in effect. During a string eval,
921 however, the scalar may have the C<SvUTF8> flag on, and in this case its
922 octets should be interpreted as UTF-8 unless the C<use bytes> pragma
923 is in effect. This logic may change in the future; use this function
924 instead of implementing the logic yourself.
930 Perl_lex_bufutf8(pTHX)
936 =for apidoc Amx|char *|lex_grow_linestr|STRLEN len
938 Reallocates the lexer buffer (L</PL_parser-E<gt>linestr>) to accommodate
939 at least I<len> octets (including terminating NUL). Returns a
940 pointer to the reallocated buffer. This is necessary before making
941 any direct modification of the buffer that would increase its length.
942 L</lex_stuff_pvn> provides a more convenient way to insert text into
945 Do not use C<SvGROW> or C<sv_grow> directly on C<PL_parser-E<gt>linestr>;
946 this function updates all of the lexer's variables that point directly
953 Perl_lex_grow_linestr(pTHX_ STRLEN len)
957 STRLEN bufend_pos, bufptr_pos, oldbufptr_pos, oldoldbufptr_pos;
958 STRLEN linestart_pos, last_uni_pos, last_lop_pos, re_eval_start_pos;
959 linestr = PL_parser->linestr;
960 buf = SvPVX(linestr);
961 if (len <= SvLEN(linestr))
963 bufend_pos = PL_parser->bufend - buf;
964 bufptr_pos = PL_parser->bufptr - buf;
965 oldbufptr_pos = PL_parser->oldbufptr - buf;
966 oldoldbufptr_pos = PL_parser->oldoldbufptr - buf;
967 linestart_pos = PL_parser->linestart - buf;
968 last_uni_pos = PL_parser->last_uni ? PL_parser->last_uni - buf : 0;
969 last_lop_pos = PL_parser->last_lop ? PL_parser->last_lop - buf : 0;
970 re_eval_start_pos = PL_parser->lex_shared->re_eval_start ?
971 PL_parser->lex_shared->re_eval_start - buf : 0;
973 buf = sv_grow(linestr, len);
975 PL_parser->bufend = buf + bufend_pos;
976 PL_parser->bufptr = buf + bufptr_pos;
977 PL_parser->oldbufptr = buf + oldbufptr_pos;
978 PL_parser->oldoldbufptr = buf + oldoldbufptr_pos;
979 PL_parser->linestart = buf + linestart_pos;
980 if (PL_parser->last_uni)
981 PL_parser->last_uni = buf + last_uni_pos;
982 if (PL_parser->last_lop)
983 PL_parser->last_lop = buf + last_lop_pos;
984 if (PL_parser->lex_shared->re_eval_start)
985 PL_parser->lex_shared->re_eval_start = buf + re_eval_start_pos;
990 =for apidoc Amx|void|lex_stuff_pvn|const char *pv|STRLEN len|U32 flags
992 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
993 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
994 reallocating the buffer if necessary. This means that lexing code that
995 runs later will see the characters as if they had appeared in the input.
996 It is not recommended to do this as part of normal parsing, and most
997 uses of this facility run the risk of the inserted characters being
998 interpreted in an unintended manner.
1000 The string to be inserted is represented by I<len> octets starting
1001 at I<pv>. These octets are interpreted as either UTF-8 or Latin-1,
1002 according to whether the C<LEX_STUFF_UTF8> flag is set in I<flags>.
1003 The characters are recoded for the lexer buffer, according to how the
1004 buffer is currently being interpreted (L</lex_bufutf8>). If a string
1005 to be inserted is available as a Perl scalar, the L</lex_stuff_sv>
1006 function is more convenient.
1012 Perl_lex_stuff_pvn(pTHX_ const char *pv, STRLEN len, U32 flags)
1016 PERL_ARGS_ASSERT_LEX_STUFF_PVN;
1017 if (flags & ~(LEX_STUFF_UTF8))
1018 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_stuff_pvn");
1020 if (flags & LEX_STUFF_UTF8) {
1023 STRLEN highhalf = 0; /* Count of variants */
1024 const char *p, *e = pv+len;
1025 for (p = pv; p != e; p++) {
1026 if (! UTF8_IS_INVARIANT(*p)) {
1032 lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len+highhalf);
1033 bufptr = PL_parser->bufptr;
1034 Move(bufptr, bufptr+len+highhalf, PL_parser->bufend+1-bufptr, char);
1035 SvCUR_set(PL_parser->linestr,
1036 SvCUR(PL_parser->linestr) + len+highhalf);
1037 PL_parser->bufend += len+highhalf;
1038 for (p = pv; p != e; p++) {
1040 if (! UTF8_IS_INVARIANT(c)) {
1041 *bufptr++ = UTF8_TWO_BYTE_HI(c);
1042 *bufptr++ = UTF8_TWO_BYTE_LO(c);
1044 *bufptr++ = (char)c;
1049 if (flags & LEX_STUFF_UTF8) {
1050 STRLEN highhalf = 0;
1051 const char *p, *e = pv+len;
1052 for (p = pv; p != e; p++) {
1054 if (UTF8_IS_ABOVE_LATIN1(c)) {
1055 Perl_croak(aTHX_ "Lexing code attempted to stuff "
1056 "non-Latin-1 character into Latin-1 input");
1057 } else if (UTF8_IS_NEXT_CHAR_DOWNGRADEABLE(p, e)) {
1060 } else if (! UTF8_IS_INVARIANT(c)) {
1061 /* malformed UTF-8 */
1063 SAVESPTR(PL_warnhook);
1064 PL_warnhook = PERL_WARNHOOK_FATAL;
1065 utf8n_to_uvchr((U8*)p, e-p, NULL, 0);
1071 lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len-highhalf);
1072 bufptr = PL_parser->bufptr;
1073 Move(bufptr, bufptr+len-highhalf, PL_parser->bufend+1-bufptr, char);
1074 SvCUR_set(PL_parser->linestr,
1075 SvCUR(PL_parser->linestr) + len-highhalf);
1076 PL_parser->bufend += len-highhalf;
1079 if (UTF8_IS_INVARIANT(*p)) {
1085 *bufptr++ = TWO_BYTE_UTF8_TO_NATIVE(*p, *(p+1));
1091 lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len);
1092 bufptr = PL_parser->bufptr;
1093 Move(bufptr, bufptr+len, PL_parser->bufend+1-bufptr, char);
1094 SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) + len);
1095 PL_parser->bufend += len;
1096 Copy(pv, bufptr, len, char);
1102 =for apidoc Amx|void|lex_stuff_pv|const char *pv|U32 flags
1104 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
1105 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
1106 reallocating the buffer if necessary. This means that lexing code that
1107 runs later will see the characters as if they had appeared in the input.
1108 It is not recommended to do this as part of normal parsing, and most
1109 uses of this facility run the risk of the inserted characters being
1110 interpreted in an unintended manner.
1112 The string to be inserted is represented by octets starting at I<pv>
1113 and continuing to the first nul. These octets are interpreted as either
1114 UTF-8 or Latin-1, according to whether the C<LEX_STUFF_UTF8> flag is set
1115 in I<flags>. The characters are recoded for the lexer buffer, according
1116 to how the buffer is currently being interpreted (L</lex_bufutf8>).
1117 If it is not convenient to nul-terminate a string to be inserted, the
1118 L</lex_stuff_pvn> function is more appropriate.
1124 Perl_lex_stuff_pv(pTHX_ const char *pv, U32 flags)
1126 PERL_ARGS_ASSERT_LEX_STUFF_PV;
1127 lex_stuff_pvn(pv, strlen(pv), flags);
1131 =for apidoc Amx|void|lex_stuff_sv|SV *sv|U32 flags
1133 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
1134 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
1135 reallocating the buffer if necessary. This means that lexing code that
1136 runs later will see the characters as if they had appeared in the input.
1137 It is not recommended to do this as part of normal parsing, and most
1138 uses of this facility run the risk of the inserted characters being
1139 interpreted in an unintended manner.
1141 The string to be inserted is the string value of I<sv>. The characters
1142 are recoded for the lexer buffer, according to how the buffer is currently
1143 being interpreted (L</lex_bufutf8>). If a string to be inserted is
1144 not already a Perl scalar, the L</lex_stuff_pvn> function avoids the
1145 need to construct a scalar.
1151 Perl_lex_stuff_sv(pTHX_ SV *sv, U32 flags)
1155 PERL_ARGS_ASSERT_LEX_STUFF_SV;
1157 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_stuff_sv");
1159 lex_stuff_pvn(pv, len, flags | (SvUTF8(sv) ? LEX_STUFF_UTF8 : 0));
1163 =for apidoc Amx|void|lex_unstuff|char *ptr
1165 Discards text about to be lexed, from L</PL_parser-E<gt>bufptr> up to
1166 I<ptr>. Text following I<ptr> will be moved, and the buffer shortened.
1167 This hides the discarded text from any lexing code that runs later,
1168 as if the text had never appeared.
1170 This is not the normal way to consume lexed text. For that, use
1177 Perl_lex_unstuff(pTHX_ char *ptr)
1181 PERL_ARGS_ASSERT_LEX_UNSTUFF;
1182 buf = PL_parser->bufptr;
1184 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_unstuff");
1187 bufend = PL_parser->bufend;
1189 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_unstuff");
1190 unstuff_len = ptr - buf;
1191 Move(ptr, buf, bufend+1-ptr, char);
1192 SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) - unstuff_len);
1193 PL_parser->bufend = bufend - unstuff_len;
1197 =for apidoc Amx|void|lex_read_to|char *ptr
1199 Consume text in the lexer buffer, from L</PL_parser-E<gt>bufptr> up
1200 to I<ptr>. This advances L</PL_parser-E<gt>bufptr> to match I<ptr>,
1201 performing the correct bookkeeping whenever a newline character is passed.
1202 This is the normal way to consume lexed text.
1204 Interpretation of the buffer's octets can be abstracted out by
1205 using the slightly higher-level functions L</lex_peek_unichar> and
1206 L</lex_read_unichar>.
1212 Perl_lex_read_to(pTHX_ char *ptr)
1215 PERL_ARGS_ASSERT_LEX_READ_TO;
1216 s = PL_parser->bufptr;
1217 if (ptr < s || ptr > PL_parser->bufend)
1218 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_to");
1219 for (; s != ptr; s++)
1221 COPLINE_INC_WITH_HERELINES;
1222 PL_parser->linestart = s+1;
1224 PL_parser->bufptr = ptr;
1228 =for apidoc Amx|void|lex_discard_to|char *ptr
1230 Discards the first part of the L</PL_parser-E<gt>linestr> buffer,
1231 up to I<ptr>. The remaining content of the buffer will be moved, and
1232 all pointers into the buffer updated appropriately. I<ptr> must not
1233 be later in the buffer than the position of L</PL_parser-E<gt>bufptr>:
1234 it is not permitted to discard text that has yet to be lexed.
1236 Normally it is not necessarily to do this directly, because it suffices to
1237 use the implicit discarding behaviour of L</lex_next_chunk> and things
1238 based on it. However, if a token stretches across multiple lines,
1239 and the lexing code has kept multiple lines of text in the buffer for
1240 that purpose, then after completion of the token it would be wise to
1241 explicitly discard the now-unneeded earlier lines, to avoid future
1242 multi-line tokens growing the buffer without bound.
1248 Perl_lex_discard_to(pTHX_ char *ptr)
1252 PERL_ARGS_ASSERT_LEX_DISCARD_TO;
1253 buf = SvPVX(PL_parser->linestr);
1255 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_discard_to");
1258 if (ptr > PL_parser->bufptr)
1259 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_discard_to");
1260 discard_len = ptr - buf;
1261 if (PL_parser->oldbufptr < ptr)
1262 PL_parser->oldbufptr = ptr;
1263 if (PL_parser->oldoldbufptr < ptr)
1264 PL_parser->oldoldbufptr = ptr;
1265 if (PL_parser->last_uni && PL_parser->last_uni < ptr)
1266 PL_parser->last_uni = NULL;
1267 if (PL_parser->last_lop && PL_parser->last_lop < ptr)
1268 PL_parser->last_lop = NULL;
1269 Move(ptr, buf, PL_parser->bufend+1-ptr, char);
1270 SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) - discard_len);
1271 PL_parser->bufend -= discard_len;
1272 PL_parser->bufptr -= discard_len;
1273 PL_parser->oldbufptr -= discard_len;
1274 PL_parser->oldoldbufptr -= discard_len;
1275 if (PL_parser->last_uni)
1276 PL_parser->last_uni -= discard_len;
1277 if (PL_parser->last_lop)
1278 PL_parser->last_lop -= discard_len;
1282 =for apidoc Amx|bool|lex_next_chunk|U32 flags
1284 Reads in the next chunk of text to be lexed, appending it to
1285 L</PL_parser-E<gt>linestr>. This should be called when lexing code has
1286 looked to the end of the current chunk and wants to know more. It is
1287 usual, but not necessary, for lexing to have consumed the entirety of
1288 the current chunk at this time.
1290 If L</PL_parser-E<gt>bufptr> is pointing to the very end of the current
1291 chunk (i.e., the current chunk has been entirely consumed), normally the
1292 current chunk will be discarded at the same time that the new chunk is
1293 read in. If I<flags> includes C<LEX_KEEP_PREVIOUS>, the current chunk
1294 will not be discarded. If the current chunk has not been entirely
1295 consumed, then it will not be discarded regardless of the flag.
1297 Returns true if some new text was added to the buffer, or false if the
1298 buffer has reached the end of the input text.
1303 #define LEX_FAKE_EOF 0x80000000
1304 #define LEX_NO_TERM 0x40000000
1307 Perl_lex_next_chunk(pTHX_ U32 flags)
1311 STRLEN old_bufend_pos, new_bufend_pos;
1312 STRLEN bufptr_pos, oldbufptr_pos, oldoldbufptr_pos;
1313 STRLEN linestart_pos, last_uni_pos, last_lop_pos;
1314 bool got_some_for_debugger = 0;
1316 if (flags & ~(LEX_KEEP_PREVIOUS|LEX_FAKE_EOF|LEX_NO_TERM))
1317 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_next_chunk");
1318 linestr = PL_parser->linestr;
1319 buf = SvPVX(linestr);
1320 if (!(flags & LEX_KEEP_PREVIOUS) &&
1321 PL_parser->bufptr == PL_parser->bufend) {
1322 old_bufend_pos = bufptr_pos = oldbufptr_pos = oldoldbufptr_pos = 0;
1324 if (PL_parser->last_uni != PL_parser->bufend)
1325 PL_parser->last_uni = NULL;
1326 if (PL_parser->last_lop != PL_parser->bufend)
1327 PL_parser->last_lop = NULL;
1328 last_uni_pos = last_lop_pos = 0;
1332 old_bufend_pos = PL_parser->bufend - buf;
1333 bufptr_pos = PL_parser->bufptr - buf;
1334 oldbufptr_pos = PL_parser->oldbufptr - buf;
1335 oldoldbufptr_pos = PL_parser->oldoldbufptr - buf;
1336 linestart_pos = PL_parser->linestart - buf;
1337 last_uni_pos = PL_parser->last_uni ? PL_parser->last_uni - buf : 0;
1338 last_lop_pos = PL_parser->last_lop ? PL_parser->last_lop - buf : 0;
1340 if (flags & LEX_FAKE_EOF) {
1342 } else if (!PL_parser->rsfp && !PL_parser->filtered) {
1344 } else if (filter_gets(linestr, old_bufend_pos)) {
1346 got_some_for_debugger = 1;
1347 } else if (flags & LEX_NO_TERM) {
1350 if (!SvPOK(linestr)) /* can get undefined by filter_gets */
1351 sv_setpvs(linestr, "");
1353 /* End of real input. Close filehandle (unless it was STDIN),
1354 * then add implicit termination.
1356 if (PL_parser->lex_flags & LEX_DONT_CLOSE_RSFP)
1357 PerlIO_clearerr(PL_parser->rsfp);
1358 else if (PL_parser->rsfp)
1359 (void)PerlIO_close(PL_parser->rsfp);
1360 PL_parser->rsfp = NULL;
1361 PL_parser->in_pod = PL_parser->filtered = 0;
1363 if (PL_madskills && !PL_in_eval && (PL_minus_p || PL_minus_n))
1366 if (!PL_in_eval && PL_minus_p) {
1368 /*{*/";}continue{print or die qq(-p destination: $!\\n);}");
1369 PL_minus_n = PL_minus_p = 0;
1370 } else if (!PL_in_eval && PL_minus_n) {
1371 sv_catpvs(linestr, /*{*/";}");
1374 sv_catpvs(linestr, ";");
1377 buf = SvPVX(linestr);
1378 new_bufend_pos = SvCUR(linestr);
1379 PL_parser->bufend = buf + new_bufend_pos;
1380 PL_parser->bufptr = buf + bufptr_pos;
1381 PL_parser->oldbufptr = buf + oldbufptr_pos;
1382 PL_parser->oldoldbufptr = buf + oldoldbufptr_pos;
1383 PL_parser->linestart = buf + linestart_pos;
1384 if (PL_parser->last_uni)
1385 PL_parser->last_uni = buf + last_uni_pos;
1386 if (PL_parser->last_lop)
1387 PL_parser->last_lop = buf + last_lop_pos;
1388 if (PL_parser->preambling != NOLINE) {
1389 CopLINE_set(PL_curcop, PL_parser->preambling + 1);
1390 PL_parser->preambling = NOLINE;
1392 if (got_some_for_debugger && (PERLDB_LINE || PERLDB_SAVESRC) &&
1393 PL_curstash != PL_debstash) {
1394 /* debugger active and we're not compiling the debugger code,
1395 * so store the line into the debugger's array of lines
1397 update_debugger_info(NULL, buf+old_bufend_pos,
1398 new_bufend_pos-old_bufend_pos);
1404 =for apidoc Amx|I32|lex_peek_unichar|U32 flags
1406 Looks ahead one (Unicode) character in the text currently being lexed.
1407 Returns the codepoint (unsigned integer value) of the next character,
1408 or -1 if lexing has reached the end of the input text. To consume the
1409 peeked character, use L</lex_read_unichar>.
1411 If the next character is in (or extends into) the next chunk of input
1412 text, the next chunk will be read in. Normally the current chunk will be
1413 discarded at the same time, but if I<flags> includes C<LEX_KEEP_PREVIOUS>
1414 then the current chunk will not be discarded.
1416 If the input is being interpreted as UTF-8 and a UTF-8 encoding error
1417 is encountered, an exception is generated.
1423 Perl_lex_peek_unichar(pTHX_ U32 flags)
1427 if (flags & ~(LEX_KEEP_PREVIOUS))
1428 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_peek_unichar");
1429 s = PL_parser->bufptr;
1430 bufend = PL_parser->bufend;
1436 if (!lex_next_chunk(flags))
1438 s = PL_parser->bufptr;
1439 bufend = PL_parser->bufend;
1442 if (UTF8_IS_INVARIANT(head))
1444 if (UTF8_IS_START(head)) {
1445 len = UTF8SKIP(&head);
1446 while ((STRLEN)(bufend-s) < len) {
1447 if (!lex_next_chunk(flags | LEX_KEEP_PREVIOUS))
1449 s = PL_parser->bufptr;
1450 bufend = PL_parser->bufend;
1453 unichar = utf8n_to_uvchr((U8*)s, bufend-s, &retlen, UTF8_CHECK_ONLY);
1454 if (retlen == (STRLEN)-1) {
1455 /* malformed UTF-8 */
1457 SAVESPTR(PL_warnhook);
1458 PL_warnhook = PERL_WARNHOOK_FATAL;
1459 utf8n_to_uvchr((U8*)s, bufend-s, NULL, 0);
1465 if (!lex_next_chunk(flags))
1467 s = PL_parser->bufptr;
1474 =for apidoc Amx|I32|lex_read_unichar|U32 flags
1476 Reads the next (Unicode) character in the text currently being lexed.
1477 Returns the codepoint (unsigned integer value) of the character read,
1478 and moves L</PL_parser-E<gt>bufptr> past the character, or returns -1
1479 if lexing has reached the end of the input text. To non-destructively
1480 examine the next character, use L</lex_peek_unichar> instead.
1482 If the next character is in (or extends into) the next chunk of input
1483 text, the next chunk will be read in. Normally the current chunk will be
1484 discarded at the same time, but if I<flags> includes C<LEX_KEEP_PREVIOUS>
1485 then the current chunk will not be discarded.
1487 If the input is being interpreted as UTF-8 and a UTF-8 encoding error
1488 is encountered, an exception is generated.
1494 Perl_lex_read_unichar(pTHX_ U32 flags)
1497 if (flags & ~(LEX_KEEP_PREVIOUS))
1498 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_unichar");
1499 c = lex_peek_unichar(flags);
1502 COPLINE_INC_WITH_HERELINES;
1504 PL_parser->bufptr += UTF8SKIP(PL_parser->bufptr);
1506 ++(PL_parser->bufptr);
1512 =for apidoc Amx|void|lex_read_space|U32 flags
1514 Reads optional spaces, in Perl style, in the text currently being
1515 lexed. The spaces may include ordinary whitespace characters and
1516 Perl-style comments. C<#line> directives are processed if encountered.
1517 L</PL_parser-E<gt>bufptr> is moved past the spaces, so that it points
1518 at a non-space character (or the end of the input text).
1520 If spaces extend into the next chunk of input text, the next chunk will
1521 be read in. Normally the current chunk will be discarded at the same
1522 time, but if I<flags> includes C<LEX_KEEP_PREVIOUS> then the current
1523 chunk will not be discarded.
1528 #define LEX_NO_INCLINE 0x40000000
1529 #define LEX_NO_NEXT_CHUNK 0x80000000
1532 Perl_lex_read_space(pTHX_ U32 flags)
1535 const bool can_incline = !(flags & LEX_NO_INCLINE);
1536 bool need_incline = 0;
1537 if (flags & ~(LEX_KEEP_PREVIOUS|LEX_NO_NEXT_CHUNK|LEX_NO_INCLINE))
1538 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_space");
1541 sv_free(PL_skipwhite);
1542 PL_skipwhite = NULL;
1545 PL_skipwhite = newSVpvs("");
1546 #endif /* PERL_MAD */
1547 s = PL_parser->bufptr;
1548 bufend = PL_parser->bufend;
1554 } while (!(c == '\n' || (c == 0 && s == bufend)));
1555 } else if (c == '\n') {
1558 PL_parser->linestart = s;
1564 } else if (isSPACE(c)) {
1566 } else if (c == 0 && s == bufend) {
1571 sv_catpvn(PL_skipwhite, PL_parser->bufptr, s-PL_parser->bufptr);
1572 #endif /* PERL_MAD */
1573 if (flags & LEX_NO_NEXT_CHUNK)
1575 PL_parser->bufptr = s;
1576 l = CopLINE(PL_curcop);
1577 CopLINE(PL_curcop) += PL_parser->herelines + 1;
1578 got_more = lex_next_chunk(flags);
1579 CopLINE_set(PL_curcop, l);
1580 s = PL_parser->bufptr;
1581 bufend = PL_parser->bufend;
1584 if (can_incline && need_incline && PL_parser->rsfp) {
1594 sv_catpvn(PL_skipwhite, PL_parser->bufptr, s-PL_parser->bufptr);
1595 #endif /* PERL_MAD */
1596 PL_parser->bufptr = s;
1601 =for apidoc EXMp|bool|validate_proto|SV *name|SV *proto|bool warn
1603 This function performs syntax checking on a prototype, C<proto>.
1604 If C<warn> is true, any illegal characters or mismatched brackets
1605 will trigger illegalproto warnings, declaring that they were
1606 detected in the prototype for C<name>.
1608 The return value is C<true> if this is a valid prototype, and
1609 C<false> if it is not, regardless of whether C<warn> was C<true> or
1612 Note that C<NULL> is a valid C<proto> and will always return C<true>.
1619 Perl_validate_proto(pTHX_ SV *name, SV *proto, bool warn)
1621 STRLEN len, origlen;
1622 char *p = proto ? SvPV(proto, len) : NULL;
1623 bool bad_proto = FALSE;
1624 bool in_brackets = FALSE;
1625 bool after_slash = FALSE;
1626 char greedy_proto = ' ';
1627 bool proto_after_greedy_proto = FALSE;
1628 bool must_be_last = FALSE;
1629 bool underscore = FALSE;
1630 bool bad_proto_after_underscore = FALSE;
1632 PERL_ARGS_ASSERT_VALIDATE_PROTO;
1638 for (; len--; p++) {
1641 proto_after_greedy_proto = TRUE;
1643 if (!strchr(";@%", *p))
1644 bad_proto_after_underscore = TRUE;
1647 if (!strchr("$@%*;[]&\\_+", *p) || *p == '\0') {
1654 in_brackets = FALSE;
1655 else if ((*p == '@' || *p == '%') &&
1658 must_be_last = TRUE;
1667 after_slash = FALSE;
1672 SV *tmpsv = newSVpvs_flags("", SVs_TEMP);
1675 ? sv_uni_display(tmpsv, newSVpvn_flags(p, origlen, SVs_TEMP | SVf_UTF8),
1676 origlen, UNI_DISPLAY_ISPRINT)
1677 : pv_pretty(tmpsv, p, origlen, 60, NULL, NULL, PERL_PV_ESCAPE_NONASCII);
1679 if (proto_after_greedy_proto)
1680 Perl_warner(aTHX_ packWARN(WARN_ILLEGALPROTO),
1681 "Prototype after '%c' for %"SVf" : %s",
1682 greedy_proto, SVfARG(name), p);
1684 Perl_warner(aTHX_ packWARN(WARN_ILLEGALPROTO),
1685 "Missing ']' in prototype for %"SVf" : %s",
1688 Perl_warner(aTHX_ packWARN(WARN_ILLEGALPROTO),
1689 "Illegal character in prototype for %"SVf" : %s",
1691 if (bad_proto_after_underscore)
1692 Perl_warner(aTHX_ packWARN(WARN_ILLEGALPROTO),
1693 "Illegal character after '_' in prototype for %"SVf" : %s",
1697 return (! (proto_after_greedy_proto || bad_proto) );
1702 * This subroutine has nothing to do with tilting, whether at windmills
1703 * or pinball tables. Its name is short for "increment line". It
1704 * increments the current line number in CopLINE(PL_curcop) and checks
1705 * to see whether the line starts with a comment of the form
1706 * # line 500 "foo.pm"
1707 * If so, it sets the current line number and file to the values in the comment.
1711 S_incline(pTHX_ const char *s)
1719 PERL_ARGS_ASSERT_INCLINE;
1721 COPLINE_INC_WITH_HERELINES;
1722 if (!PL_rsfp && !PL_parser->filtered && PL_lex_state == LEX_NORMAL
1723 && s+1 == PL_bufend && *s == ';') {
1724 /* fake newline in string eval */
1725 CopLINE_dec(PL_curcop);
1730 while (SPACE_OR_TAB(*s))
1732 if (strnEQ(s, "line", 4))
1736 if (SPACE_OR_TAB(*s))
1740 while (SPACE_OR_TAB(*s))
1748 if (!SPACE_OR_TAB(*s) && *s != '\r' && *s != '\n' && *s != '\0')
1750 while (SPACE_OR_TAB(*s))
1752 if (*s == '"' && (t = strchr(s+1, '"'))) {
1758 while (!isSPACE(*t))
1762 while (SPACE_OR_TAB(*e) || *e == '\r' || *e == '\f')
1764 if (*e != '\n' && *e != '\0')
1765 return; /* false alarm */
1767 line_num = atoi(n)-1;
1770 const STRLEN len = t - s;
1772 if (!PL_rsfp && !PL_parser->filtered) {
1773 /* must copy *{"::_<(eval N)[oldfilename:L]"}
1774 * to *{"::_<newfilename"} */
1775 /* However, the long form of evals is only turned on by the
1776 debugger - usually they're "(eval %lu)" */
1777 GV * const cfgv = CopFILEGV(PL_curcop);
1780 STRLEN tmplen2 = len;
1784 if (tmplen2 + 2 <= sizeof smallbuf)
1787 Newx(tmpbuf2, tmplen2 + 2, char);
1792 memcpy(tmpbuf2 + 2, s, tmplen2);
1795 gv2 = *(GV**)hv_fetch(PL_defstash, tmpbuf2, tmplen2, TRUE);
1797 gv_init(gv2, PL_defstash, tmpbuf2, tmplen2, FALSE);
1798 /* adjust ${"::_<newfilename"} to store the new file name */
1799 GvSV(gv2) = newSVpvn(tmpbuf2 + 2, tmplen2 - 2);
1800 /* The line number may differ. If that is the case,
1801 alias the saved lines that are in the array.
1802 Otherwise alias the whole array. */
1803 if (CopLINE(PL_curcop) == line_num) {
1804 GvHV(gv2) = MUTABLE_HV(SvREFCNT_inc(GvHV(cfgv)));
1805 GvAV(gv2) = MUTABLE_AV(SvREFCNT_inc(GvAV(cfgv)));
1807 else if (GvAV(cfgv)) {
1808 AV * const av = GvAV(cfgv);
1809 const I32 start = CopLINE(PL_curcop)+1;
1810 I32 items = AvFILLp(av) - start;
1812 AV * const av2 = GvAVn(gv2);
1813 SV **svp = AvARRAY(av) + start;
1814 I32 l = (I32)line_num+1;
1816 av_store(av2, l++, SvREFCNT_inc(*svp++));
1821 if (tmpbuf2 != smallbuf) Safefree(tmpbuf2);
1824 CopFILE_free(PL_curcop);
1825 CopFILE_setn(PL_curcop, s, len);
1827 CopLINE_set(PL_curcop, line_num);
1830 #define skipspace(s) skipspace_flags(s, 0)
1833 /* skip space before PL_thistoken */
1836 S_skipspace0(pTHX_ char *s)
1838 PERL_ARGS_ASSERT_SKIPSPACE0;
1845 PL_thiswhite = newSVpvs("");
1846 sv_catsv(PL_thiswhite, PL_skipwhite);
1847 sv_free(PL_skipwhite);
1850 PL_realtokenstart = s - SvPVX(PL_linestr);
1854 /* skip space after PL_thistoken */
1857 S_skipspace1(pTHX_ char *s)
1859 const char *start = s;
1860 I32 startoff = start - SvPVX(PL_linestr);
1862 PERL_ARGS_ASSERT_SKIPSPACE1;
1867 start = SvPVX(PL_linestr) + startoff;
1868 if (!PL_thistoken && PL_realtokenstart >= 0) {
1869 const char * const tstart = SvPVX(PL_linestr) + PL_realtokenstart;
1870 PL_thistoken = newSVpvn(tstart, start - tstart);
1872 PL_realtokenstart = -1;
1875 PL_nextwhite = newSVpvs("");
1876 sv_catsv(PL_nextwhite, PL_skipwhite);
1877 sv_free(PL_skipwhite);
1884 S_skipspace2(pTHX_ char *s, SV **svp)
1887 const I32 startoff = s - SvPVX(PL_linestr);
1889 PERL_ARGS_ASSERT_SKIPSPACE2;
1892 if (!PL_madskills || !svp)
1894 start = SvPVX(PL_linestr) + startoff;
1895 if (!PL_thistoken && PL_realtokenstart >= 0) {
1896 char * const tstart = SvPVX(PL_linestr) + PL_realtokenstart;
1897 PL_thistoken = newSVpvn(tstart, start - tstart);
1898 PL_realtokenstart = -1;
1902 *svp = newSVpvs("");
1903 sv_setsv(*svp, PL_skipwhite);
1904 sv_free(PL_skipwhite);
1913 S_update_debugger_info(pTHX_ SV *orig_sv, const char *const buf, STRLEN len)
1915 AV *av = CopFILEAVx(PL_curcop);
1918 if (PL_parser->preambling == NOLINE) sv = newSV_type(SVt_PVMG);
1920 sv = *av_fetch(av, 0, 1);
1921 SvUPGRADE(sv, SVt_PVMG);
1923 if (!SvPOK(sv)) sv_setpvs(sv,"");
1925 sv_catsv(sv, orig_sv);
1927 sv_catpvn(sv, buf, len);
1932 if (PL_parser->preambling == NOLINE)
1933 av_store(av, CopLINE(PL_curcop), sv);
1939 * Called to gobble the appropriate amount and type of whitespace.
1940 * Skips comments as well.
1944 S_skipspace_flags(pTHX_ char *s, U32 flags)
1948 #endif /* PERL_MAD */
1949 PERL_ARGS_ASSERT_SKIPSPACE_FLAGS;
1952 sv_free(PL_skipwhite);
1953 PL_skipwhite = NULL;
1955 #endif /* PERL_MAD */
1956 if (PL_lex_formbrack && PL_lex_brackets <= PL_lex_formbrack) {
1957 while (s < PL_bufend && SPACE_OR_TAB(*s))
1960 STRLEN bufptr_pos = PL_bufptr - SvPVX(PL_linestr);
1962 lex_read_space(flags | LEX_KEEP_PREVIOUS |
1963 (PL_sublex_info.sub_inwhat || PL_lex_state == LEX_FORMLINE ?
1964 LEX_NO_NEXT_CHUNK : 0));
1966 PL_bufptr = SvPVX(PL_linestr) + bufptr_pos;
1967 if (PL_linestart > PL_bufptr)
1968 PL_bufptr = PL_linestart;
1973 PL_skipwhite = newSVpvn(start, s-start);
1974 #endif /* PERL_MAD */
1980 * Check the unary operators to ensure there's no ambiguity in how they're
1981 * used. An ambiguous piece of code would be:
1983 * This doesn't mean rand() + 5. Because rand() is a unary operator,
1984 * the +5 is its argument.
1994 if (PL_oldoldbufptr != PL_last_uni)
1996 while (isSPACE(*PL_last_uni))
1999 while (isWORDCHAR_lazy_if(s,UTF) || *s == '-')
2001 if ((t = strchr(s, '(')) && t < PL_bufptr)
2004 Perl_ck_warner_d(aTHX_ packWARN(WARN_AMBIGUOUS),
2005 "Warning: Use of \"%.*s\" without parentheses is ambiguous",
2006 (int)(s - PL_last_uni), PL_last_uni);
2010 * LOP : macro to build a list operator. Its behaviour has been replaced
2011 * with a subroutine, S_lop() for which LOP is just another name.
2014 #define LOP(f,x) return lop(f,x,s)
2018 * Build a list operator (or something that might be one). The rules:
2019 * - if we have a next token, then it's a list operator [why?]
2020 * - if the next thing is an opening paren, then it's a function
2021 * - else it's a list operator
2025 S_lop(pTHX_ I32 f, int x, char *s)
2029 PERL_ARGS_ASSERT_LOP;
2035 PL_last_lop = PL_oldbufptr;
2036 PL_last_lop_op = (OPCODE)f;
2045 return REPORT(FUNC);
2048 return REPORT(FUNC);
2051 if (!PL_lex_allbrackets && PL_lex_fakeeof > LEX_FAKEEOF_LOWLOGIC)
2052 PL_lex_fakeeof = LEX_FAKEEOF_LOWLOGIC;
2053 return REPORT(LSTOP);
2060 * Sets up for an eventual force_next(). start_force(0) basically does
2061 * an unshift, while start_force(-1) does a push. yylex removes items
2066 S_start_force(pTHX_ int where)
2070 if (where < 0) /* so people can duplicate start_force(PL_curforce) */
2071 where = PL_lasttoke;
2072 assert(PL_curforce < 0 || PL_curforce == where);
2073 if (PL_curforce != where) {
2074 for (i = PL_lasttoke; i > where; --i) {
2075 PL_nexttoke[i] = PL_nexttoke[i-1];
2079 if (PL_curforce < 0) /* in case of duplicate start_force() */
2080 Zero(&PL_nexttoke[where], 1, NEXTTOKE);
2081 PL_curforce = where;
2084 curmad('^', newSVpvs(""));
2085 CURMAD('_', PL_nextwhite);
2090 S_curmad(pTHX_ char slot, SV *sv)
2096 if (PL_curforce < 0)
2097 where = &PL_thismad;
2099 where = &PL_nexttoke[PL_curforce].next_mad;
2105 if (UTF && is_utf8_string((U8*)SvPVX(sv), SvCUR(sv)))
2107 else if (PL_encoding) {
2108 sv_recode_to_utf8(sv, PL_encoding);
2113 /* keep a slot open for the head of the list? */
2114 if (slot != '_' && *where && (*where)->mad_key == '^') {
2115 (*where)->mad_key = slot;
2116 sv_free(MUTABLE_SV(((*where)->mad_val)));
2117 (*where)->mad_val = (void*)sv;
2120 addmad(newMADsv(slot, sv), where, 0);
2123 # define start_force(where) NOOP
2124 # define curmad(slot, sv) NOOP
2129 * When the lexer realizes it knows the next token (for instance,
2130 * it is reordering tokens for the parser) then it can call S_force_next
2131 * to know what token to return the next time the lexer is called. Caller
2132 * will need to set PL_nextval[] (or PL_nexttoke[].next_val with PERL_MAD),
2133 * and possibly PL_expect to ensure the lexer handles the token correctly.
2137 S_force_next(pTHX_ I32 type)
2142 PerlIO_printf(Perl_debug_log, "### forced token:\n");
2143 tokereport(type, &NEXTVAL_NEXTTOKE);
2147 if (PL_curforce < 0)
2148 start_force(PL_lasttoke);
2149 PL_nexttoke[PL_curforce].next_type = type;
2150 if (PL_lex_state != LEX_KNOWNEXT)
2151 PL_lex_defer = PL_lex_state;
2152 PL_lex_state = LEX_KNOWNEXT;
2153 PL_lex_expect = PL_expect;
2156 PL_nexttype[PL_nexttoke] = type;
2158 if (PL_lex_state != LEX_KNOWNEXT) {
2159 PL_lex_defer = PL_lex_state;
2160 PL_lex_expect = PL_expect;
2161 PL_lex_state = LEX_KNOWNEXT;
2169 * This subroutine handles postfix deref syntax after the arrow has already
2170 * been emitted. @* $* etc. are emitted as two separate token right here.
2171 * @[ @{ %[ %{ *{ are emitted also as two tokens, but this function emits
2172 * only the first, leaving yylex to find the next.
2176 S_postderef(pTHX_ int const funny, char const next)
2179 assert(funny == DOLSHARP || strchr("$@%&*", funny));
2180 assert(strchr("*[{", next));
2182 PL_expect = XOPERATOR;
2183 if (PL_lex_state == LEX_INTERPNORMAL && !PL_lex_brackets) {
2184 assert('@' == funny || '$' == funny || DOLSHARP == funny);
2185 PL_lex_state = LEX_INTERPEND;
2186 start_force(PL_curforce);
2187 force_next(POSTJOIN);
2189 start_force(PL_curforce);
2194 if ('@' == funny && PL_lex_state == LEX_INTERPNORMAL
2195 && !PL_lex_brackets)
2197 PL_expect = XOPERATOR;
2206 int yyc = PL_parser->yychar;
2207 if (yyc != YYEMPTY) {
2210 NEXTVAL_NEXTTOKE = PL_parser->yylval;
2211 if (yyc == '{'/*}*/ || yyc == HASHBRACK || yyc == '['/*]*/) {
2212 PL_lex_allbrackets--;
2214 yyc |= (3<<24) | (PL_lex_brackstack[PL_lex_brackets] << 16);
2215 } else if (yyc == '('/*)*/) {
2216 PL_lex_allbrackets--;
2221 PL_parser->yychar = YYEMPTY;
2226 S_newSV_maybe_utf8(pTHX_ const char *const start, STRLEN len)
2229 SV * const sv = newSVpvn_utf8(start, len,
2232 && !is_ascii_string((const U8*)start, len)
2233 && is_utf8_string((const U8*)start, len));
2239 * When the lexer knows the next thing is a word (for instance, it has
2240 * just seen -> and it knows that the next char is a word char, then
2241 * it calls S_force_word to stick the next word into the PL_nexttoke/val
2245 * char *start : buffer position (must be within PL_linestr)
2246 * int token : PL_next* will be this type of bare word (e.g., METHOD,WORD)
2247 * int check_keyword : if true, Perl checks to make sure the word isn't
2248 * a keyword (do this if the word is a label, e.g. goto FOO)
2249 * int allow_pack : if true, : characters will also be allowed (require,
2250 * use, etc. do this)
2251 * int allow_initial_tick : used by the "sub" lexer only.
2255 S_force_word(pTHX_ char *start, int token, int check_keyword, int allow_pack)
2261 PERL_ARGS_ASSERT_FORCE_WORD;
2263 start = SKIPSPACE1(start);
2265 if (isIDFIRST_lazy_if(s,UTF) ||
2266 (allow_pack && *s == ':') )
2268 s = scan_word(s, PL_tokenbuf, sizeof PL_tokenbuf, allow_pack, &len);
2269 if (check_keyword) {
2270 char *s2 = PL_tokenbuf;
2271 if (allow_pack && len > 6 && strnEQ(s2, "CORE::", 6))
2273 if (keyword(s2, len, 0))
2276 start_force(PL_curforce);
2278 curmad('X', newSVpvn(start,s-start));
2279 if (token == METHOD) {
2284 PL_expect = XOPERATOR;
2288 curmad('g', newSVpvs( "forced" ));
2289 NEXTVAL_NEXTTOKE.opval
2290 = (OP*)newSVOP(OP_CONST,0,
2291 S_newSV_maybe_utf8(aTHX_ PL_tokenbuf, len));
2292 NEXTVAL_NEXTTOKE.opval->op_private |= OPpCONST_BARE;
2300 * Called when the lexer wants $foo *foo &foo etc, but the program
2301 * text only contains the "foo" portion. The first argument is a pointer
2302 * to the "foo", and the second argument is the type symbol to prefix.
2303 * Forces the next token to be a "WORD".
2304 * Creates the symbol if it didn't already exist (via gv_fetchpv()).
2308 S_force_ident(pTHX_ const char *s, int kind)
2312 PERL_ARGS_ASSERT_FORCE_IDENT;
2315 const STRLEN len = s[1] ? strlen(s) : 1; /* s = "\"" see yylex */
2316 OP* const o = (OP*)newSVOP(OP_CONST, 0, newSVpvn_flags(s, len,
2317 UTF ? SVf_UTF8 : 0));
2318 start_force(PL_curforce);
2319 NEXTVAL_NEXTTOKE.opval = o;
2322 o->op_private = OPpCONST_ENTERED;
2323 /* XXX see note in pp_entereval() for why we forgo typo
2324 warnings if the symbol must be introduced in an eval.
2326 gv_fetchpvn_flags(s, len,
2327 (PL_in_eval ? (GV_ADDMULTI | GV_ADDINEVAL)
2328 : GV_ADD) | ( UTF ? SVf_UTF8 : 0 ),
2329 kind == '$' ? SVt_PV :
2330 kind == '@' ? SVt_PVAV :
2331 kind == '%' ? SVt_PVHV :
2339 S_force_ident_maybe_lex(pTHX_ char pit)
2341 start_force(PL_curforce);
2342 NEXTVAL_NEXTTOKE.ival = pit;
2347 Perl_str_to_version(pTHX_ SV *sv)
2352 const char *start = SvPV_const(sv,len);
2353 const char * const end = start + len;
2354 const bool utf = SvUTF8(sv) ? TRUE : FALSE;
2356 PERL_ARGS_ASSERT_STR_TO_VERSION;
2358 while (start < end) {
2362 n = utf8n_to_uvchr((U8*)start, len, &skip, 0);
2367 retval += ((NV)n)/nshift;
2376 * Forces the next token to be a version number.
2377 * If the next token appears to be an invalid version number, (e.g. "v2b"),
2378 * and if "guessing" is TRUE, then no new token is created (and the caller
2379 * must use an alternative parsing method).
2383 S_force_version(pTHX_ char *s, int guessing)
2389 I32 startoff = s - SvPVX(PL_linestr);
2392 PERL_ARGS_ASSERT_FORCE_VERSION;
2400 while (isDIGIT(*d) || *d == '_' || *d == '.')
2404 start_force(PL_curforce);
2405 curmad('X', newSVpvn(s,d-s));
2408 if (*d == ';' || isSPACE(*d) || *d == '{' || *d == '}' || !*d) {
2410 #ifdef USE_LOCALE_NUMERIC
2411 char *loc = savepv(setlocale(LC_NUMERIC, NULL));
2412 setlocale(LC_NUMERIC, "C");
2414 s = scan_num(s, &pl_yylval);
2415 #ifdef USE_LOCALE_NUMERIC
2416 setlocale(LC_NUMERIC, loc);
2419 version = pl_yylval.opval;
2420 ver = cSVOPx(version)->op_sv;
2421 if (SvPOK(ver) && !SvNIOK(ver)) {
2422 SvUPGRADE(ver, SVt_PVNV);
2423 SvNV_set(ver, str_to_version(ver));
2424 SvNOK_on(ver); /* hint that it is a version */
2427 else if (guessing) {
2430 sv_free(PL_nextwhite); /* let next token collect whitespace */
2432 s = SvPVX(PL_linestr) + startoff;
2440 if (PL_madskills && !version) {
2441 sv_free(PL_nextwhite); /* let next token collect whitespace */
2443 s = SvPVX(PL_linestr) + startoff;
2446 /* NOTE: The parser sees the package name and the VERSION swapped */
2447 start_force(PL_curforce);
2448 NEXTVAL_NEXTTOKE.opval = version;
2455 * S_force_strict_version
2456 * Forces the next token to be a version number using strict syntax rules.
2460 S_force_strict_version(pTHX_ char *s)
2465 I32 startoff = s - SvPVX(PL_linestr);
2467 const char *errstr = NULL;
2469 PERL_ARGS_ASSERT_FORCE_STRICT_VERSION;
2471 while (isSPACE(*s)) /* leading whitespace */
2474 if (is_STRICT_VERSION(s,&errstr)) {
2476 s = (char *)scan_version(s, ver, 0);
2477 version = newSVOP(OP_CONST, 0, ver);
2479 else if ( (*s != ';' && *s != '{' && *s != '}' ) &&
2480 (s = SKIPSPACE1(s), (*s != ';' && *s != '{' && *s != '}' )))
2484 yyerror(errstr); /* version required */
2489 if (PL_madskills && !version) {
2490 sv_free(PL_nextwhite); /* let next token collect whitespace */
2492 s = SvPVX(PL_linestr) + startoff;
2495 /* NOTE: The parser sees the package name and the VERSION swapped */
2496 start_force(PL_curforce);
2497 NEXTVAL_NEXTTOKE.opval = version;
2505 * Tokenize a quoted string passed in as an SV. It finds the next
2506 * chunk, up to end of string or a backslash. It may make a new
2507 * SV containing that chunk (if HINT_NEW_STRING is on). It also
2512 S_tokeq(pTHX_ SV *sv)
2520 PERL_ARGS_ASSERT_TOKEQ;
2524 assert (!SvIsCOW(sv));
2525 if (SvTYPE(sv) >= SVt_PVIV && SvIVX(sv) == -1) /* <<'heredoc' */
2529 /* This is relying on the SV being "well formed" with a trailing '\0' */
2530 while (s < send && !(*s == '\\' && s[1] == '\\'))
2535 if ( PL_hints & HINT_NEW_STRING ) {
2536 pv = newSVpvn_flags(SvPVX_const(pv), SvCUR(sv),
2537 SVs_TEMP | SvUTF8(sv));
2541 if (s + 1 < send && (s[1] == '\\'))
2542 s++; /* all that, just for this */
2547 SvCUR_set(sv, d - SvPVX_const(sv));
2549 if ( PL_hints & HINT_NEW_STRING )
2550 return new_constant(NULL, 0, "q", sv, pv, "q", 1);
2555 * Now come three functions related to double-quote context,
2556 * S_sublex_start, S_sublex_push, and S_sublex_done. They're used when
2557 * converting things like "\u\Lgnat" into ucfirst(lc("gnat")). They
2558 * interact with PL_lex_state, and create fake ( ... ) argument lists
2559 * to handle functions and concatenation.
2563 * stringify ( const[foo] concat lcfirst ( const[bar] ) )
2568 * Assumes that pl_yylval.ival is the op we're creating (e.g. OP_LCFIRST).
2570 * Pattern matching will set PL_lex_op to the pattern-matching op to
2571 * make (we return THING if pl_yylval.ival is OP_NULL, PMFUNC otherwise).
2573 * OP_CONST and OP_READLINE are easy--just make the new op and return.
2575 * Everything else becomes a FUNC.
2577 * Sets PL_lex_state to LEX_INTERPPUSH unless (ival was OP_NULL or we
2578 * had an OP_CONST or OP_READLINE). This just sets us up for a
2579 * call to S_sublex_push().
2583 S_sublex_start(pTHX)
2586 const I32 op_type = pl_yylval.ival;
2588 if (op_type == OP_NULL) {
2589 pl_yylval.opval = PL_lex_op;
2593 if (op_type == OP_CONST) {
2594 SV *sv = tokeq(PL_lex_stuff);
2596 if (SvTYPE(sv) == SVt_PVIV) {
2597 /* Overloaded constants, nothing fancy: Convert to SVt_PV: */
2599 const char * const p = SvPV_const(sv, len);
2600 SV * const nsv = newSVpvn_flags(p, len, SvUTF8(sv));
2604 pl_yylval.opval = (OP*)newSVOP(op_type, 0, sv);
2605 PL_lex_stuff = NULL;
2609 PL_sublex_info.super_state = PL_lex_state;
2610 PL_sublex_info.sub_inwhat = (U16)op_type;
2611 PL_sublex_info.sub_op = PL_lex_op;
2612 PL_lex_state = LEX_INTERPPUSH;
2616 pl_yylval.opval = PL_lex_op;
2626 * Create a new scope to save the lexing state. The scope will be
2627 * ended in S_sublex_done. Returns a '(', starting the function arguments
2628 * to the uc, lc, etc. found before.
2629 * Sets PL_lex_state to LEX_INTERPCONCAT.
2637 const bool is_heredoc = PL_multi_close == '<';
2640 PL_lex_state = PL_sublex_info.super_state;
2641 SAVEI8(PL_lex_dojoin);
2642 SAVEI32(PL_lex_brackets);
2643 SAVEI32(PL_lex_allbrackets);
2644 SAVEI32(PL_lex_formbrack);
2645 SAVEI8(PL_lex_fakeeof);
2646 SAVEI32(PL_lex_casemods);
2647 SAVEI32(PL_lex_starts);
2648 SAVEI8(PL_lex_state);
2649 SAVESPTR(PL_lex_repl);
2650 SAVEVPTR(PL_lex_inpat);
2651 SAVEI16(PL_lex_inwhat);
2654 SAVECOPLINE(PL_curcop);
2655 SAVEI32(PL_multi_end);
2656 SAVEI32(PL_parser->herelines);
2657 PL_parser->herelines = 0;
2659 SAVEI8(PL_multi_close);
2660 SAVEPPTR(PL_bufptr);
2661 SAVEPPTR(PL_bufend);
2662 SAVEPPTR(PL_oldbufptr);
2663 SAVEPPTR(PL_oldoldbufptr);
2664 SAVEPPTR(PL_last_lop);
2665 SAVEPPTR(PL_last_uni);
2666 SAVEPPTR(PL_linestart);
2667 SAVESPTR(PL_linestr);
2668 SAVEGENERICPV(PL_lex_brackstack);
2669 SAVEGENERICPV(PL_lex_casestack);
2670 SAVEGENERICPV(PL_parser->lex_shared);
2671 SAVEBOOL(PL_parser->lex_re_reparsing);
2672 SAVEI32(PL_copline);
2674 /* The here-doc parser needs to be able to peek into outer lexing
2675 scopes to find the body of the here-doc. So we put PL_linestr and
2676 PL_bufptr into lex_shared, to ‘share’ those values.
2678 PL_parser->lex_shared->ls_linestr = PL_linestr;
2679 PL_parser->lex_shared->ls_bufptr = PL_bufptr;
2681 PL_linestr = PL_lex_stuff;
2682 PL_lex_repl = PL_sublex_info.repl;
2683 PL_lex_stuff = NULL;
2684 PL_sublex_info.repl = NULL;
2686 PL_bufend = PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart
2687 = SvPVX(PL_linestr);
2688 PL_bufend += SvCUR(PL_linestr);
2689 PL_last_lop = PL_last_uni = NULL;
2690 SAVEFREESV(PL_linestr);
2691 if (PL_lex_repl) SAVEFREESV(PL_lex_repl);
2693 PL_lex_dojoin = FALSE;
2694 PL_lex_brackets = PL_lex_formbrack = 0;
2695 PL_lex_allbrackets = 0;
2696 PL_lex_fakeeof = LEX_FAKEEOF_NEVER;
2697 Newx(PL_lex_brackstack, 120, char);
2698 Newx(PL_lex_casestack, 12, char);
2699 PL_lex_casemods = 0;
2700 *PL_lex_casestack = '\0';
2702 PL_lex_state = LEX_INTERPCONCAT;
2704 CopLINE_set(PL_curcop, (line_t)PL_multi_start);
2705 PL_copline = NOLINE;
2707 Newxz(shared, 1, LEXSHARED);
2708 shared->ls_prev = PL_parser->lex_shared;
2709 PL_parser->lex_shared = shared;
2711 PL_lex_inwhat = PL_sublex_info.sub_inwhat;
2712 if (PL_lex_inwhat == OP_TRANSR) PL_lex_inwhat = OP_TRANS;
2713 if (PL_lex_inwhat == OP_MATCH || PL_lex_inwhat == OP_QR || PL_lex_inwhat == OP_SUBST)
2714 PL_lex_inpat = PL_sublex_info.sub_op;
2716 PL_lex_inpat = NULL;
2718 PL_parser->lex_re_reparsing = cBOOL(PL_in_eval & EVAL_RE_REPARSING);
2719 PL_in_eval &= ~EVAL_RE_REPARSING;
2726 * Restores lexer state after a S_sublex_push.
2733 if (!PL_lex_starts++) {
2734 SV * const sv = newSVpvs("");
2735 if (SvUTF8(PL_linestr))
2737 PL_expect = XOPERATOR;
2738 pl_yylval.opval = (OP*)newSVOP(OP_CONST, 0, sv);
2742 if (PL_lex_casemods) { /* oops, we've got some unbalanced parens */
2743 PL_lex_state = LEX_INTERPCASEMOD;
2747 /* Is there a right-hand side to take care of? (s//RHS/ or tr//RHS/) */
2748 assert(PL_lex_inwhat != OP_TRANSR);
2749 if (PL_lex_repl && (PL_lex_inwhat == OP_SUBST || PL_lex_inwhat == OP_TRANS)) {
2750 PL_linestr = PL_lex_repl;
2752 PL_bufend = PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
2753 PL_bufend += SvCUR(PL_linestr);
2754 PL_last_lop = PL_last_uni = NULL;
2755 PL_lex_dojoin = FALSE;
2756 PL_lex_brackets = 0;
2757 PL_lex_allbrackets = 0;
2758 PL_lex_fakeeof = LEX_FAKEEOF_NEVER;
2759 PL_lex_casemods = 0;
2760 *PL_lex_casestack = '\0';
2762 if (SvEVALED(PL_lex_repl)) {
2763 PL_lex_state = LEX_INTERPNORMAL;
2765 /* we don't clear PL_lex_repl here, so that we can check later
2766 whether this is an evalled subst; that means we rely on the
2767 logic to ensure sublex_done() is called again only via the
2768 branch (in yylex()) that clears PL_lex_repl, else we'll loop */
2771 PL_lex_state = LEX_INTERPCONCAT;
2774 if (SvTYPE(PL_linestr) >= SVt_PVNV) {
2775 CopLINE(PL_curcop) +=
2776 ((XPVNV*)SvANY(PL_linestr))->xnv_u.xpad_cop_seq.xlow
2777 + PL_parser->herelines;
2778 PL_parser->herelines = 0;
2783 const line_t l = CopLINE(PL_curcop);
2788 PL_endwhite = newSVpvs("");
2789 sv_catsv(PL_endwhite, PL_thiswhite);
2793 sv_setpvs(PL_thistoken,"");
2795 PL_realtokenstart = -1;
2799 if (PL_multi_close == '<')
2800 PL_parser->herelines += l - PL_multi_end;
2801 PL_bufend = SvPVX(PL_linestr);
2802 PL_bufend += SvCUR(PL_linestr);
2803 PL_expect = XOPERATOR;
2804 PL_sublex_info.sub_inwhat = 0;
2809 PERL_STATIC_INLINE SV*
2810 S_get_and_check_backslash_N_name(pTHX_ const char* s, const char* const e)
2812 /* <s> points to first character of interior of \N{}, <e> to one beyond the
2813 * interior, hence to the "}". Finds what the name resolves to, returning
2814 * an SV* containing it; NULL if no valid one found */
2816 SV* res = newSVpvn_flags(s, e - s, UTF ? SVf_UTF8 : 0);
2823 const U8* first_bad_char_loc;
2824 const char* backslash_ptr = s - 3; /* Points to the <\> of \N{... */
2826 PERL_ARGS_ASSERT_GET_AND_CHECK_BACKSLASH_N_NAME;
2828 if (UTF && ! is_utf8_string_loc((U8 *) backslash_ptr,
2830 &first_bad_char_loc))
2832 /* If warnings are on, this will print a more detailed analysis of what
2833 * is wrong than the error message below */
2834 utf8n_to_uvchr(first_bad_char_loc,
2835 e - ((char *) first_bad_char_loc),
2838 /* We deliberately don't try to print the malformed character, which
2839 * might not print very well; it also may be just the first of many
2840 * malformations, so don't print what comes after it */
2841 yyerror(Perl_form(aTHX_
2842 "Malformed UTF-8 character immediately after '%.*s'",
2843 (int) (first_bad_char_loc - (U8 *) backslash_ptr), backslash_ptr));
2847 res = new_constant( NULL, 0, "charnames", res, NULL, backslash_ptr,
2848 /* include the <}> */
2849 e - backslash_ptr + 1);
2851 SvREFCNT_dec_NN(res);
2855 /* See if the charnames handler is the Perl core's, and if so, we can skip
2856 * the validation needed for a user-supplied one, as Perl's does its own
2858 table = GvHV(PL_hintgv); /* ^H */
2859 cvp = hv_fetchs(table, "charnames", FALSE);
2860 if (cvp && (cv = *cvp) && SvROK(cv) && (rv = SvRV(cv),
2861 SvTYPE(rv) == SVt_PVCV) && ((stash = CvSTASH(rv)) != NULL))
2863 const char * const name = HvNAME(stash);
2864 if (HvNAMELEN(stash) == sizeof("_charnames")-1
2865 && strEQ(name, "_charnames")) {
2870 /* Here, it isn't Perl's charname handler. We can't rely on a
2871 * user-supplied handler to validate the input name. For non-ut8 input,
2872 * look to see that the first character is legal. Then loop through the
2873 * rest checking that each is a continuation */
2875 /* This code needs to be sync'ed with a regex in _charnames.pm which does
2879 if (! isALPHAU(*s)) {
2884 if (! isCHARNAME_CONT(*s)) {
2887 if (*s == ' ' && *(s-1) == ' ' && ckWARN_d(WARN_DEPRECATED)) {
2888 Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),
2889 "A sequence of multiple spaces in a charnames "
2890 "alias definition is deprecated");
2894 if (*(s-1) == ' ' && ckWARN_d(WARN_DEPRECATED)) {
2895 Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),
2896 "Trailing white-space in a charnames alias "
2897 "definition is deprecated");
2901 /* Similarly for utf8. For invariants can check directly; for other
2902 * Latin1, can calculate their code point and check; otherwise use a
2904 if (UTF8_IS_INVARIANT(*s)) {
2905 if (! isALPHAU(*s)) {
2909 } else if (UTF8_IS_DOWNGRADEABLE_START(*s)) {
2910 if (! isALPHAU(TWO_BYTE_UTF8_TO_NATIVE(*s, *(s+1)))) {
2916 if (! PL_utf8_charname_begin) {
2917 U8 flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
2918 PL_utf8_charname_begin = _core_swash_init("utf8",
2919 "_Perl_Charname_Begin",
2921 1, 0, NULL, &flags);
2923 if (! swash_fetch(PL_utf8_charname_begin, (U8 *) s, TRUE)) {
2930 if (UTF8_IS_INVARIANT(*s)) {
2931 if (! isCHARNAME_CONT(*s)) {
2934 if (*s == ' ' && *(s-1) == ' '
2935 && ckWARN_d(WARN_DEPRECATED)) {
2936 Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),
2937 "A sequence of multiple spaces in a charnam"
2938 "es alias definition is deprecated");
2942 else if (UTF8_IS_DOWNGRADEABLE_START(*s)) {
2943 if (! isCHARNAME_CONT(TWO_BYTE_UTF8_TO_NATIVE(*s, *(s+1))))
2950 if (! PL_utf8_charname_continue) {
2951 U8 flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
2952 PL_utf8_charname_continue = _core_swash_init("utf8",
2953 "_Perl_Charname_Continue",
2955 1, 0, NULL, &flags);
2957 if (! swash_fetch(PL_utf8_charname_continue, (U8 *) s, TRUE)) {
2963 if (*(s-1) == ' ' && ckWARN_d(WARN_DEPRECATED)) {
2964 Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),
2965 "Trailing white-space in a charnames alias "
2966 "definition is deprecated");
2970 if (SvUTF8(res)) { /* Don't accept malformed input */
2971 const U8* first_bad_char_loc;
2973 const char* const str = SvPV_const(res, len);
2974 if (! is_utf8_string_loc((U8 *) str, len, &first_bad_char_loc)) {
2975 /* If warnings are on, this will print a more detailed analysis of
2976 * what is wrong than the error message below */
2977 utf8n_to_uvchr(first_bad_char_loc,
2978 (char *) first_bad_char_loc - str,
2981 /* We deliberately don't try to print the malformed character,
2982 * which might not print very well; it also may be just the first
2983 * of many malformations, so don't print what comes after it */
2986 "Malformed UTF-8 returned by %.*s immediately after '%.*s'",
2987 (int) (e - backslash_ptr + 1), backslash_ptr,
2988 (int) ((char *) first_bad_char_loc - str), str
2998 int bad_char_size = ((UTF) ? UTF8SKIP(s) : 1);
3000 /* The final %.*s makes sure that should the trailing NUL be missing
3001 * that this print won't run off the end of the string */
3004 "Invalid character in \\N{...}; marked by <-- HERE in %.*s<-- HERE %.*s",
3005 (int)(s - backslash_ptr + bad_char_size), backslash_ptr,
3006 (int)(e - s + bad_char_size), s + bad_char_size
3008 UTF ? SVf_UTF8 : 0);
3016 Extracts the next constant part of a pattern, double-quoted string,
3017 or transliteration. This is terrifying code.
3019 For example, in parsing the double-quoted string "ab\x63$d", it would
3020 stop at the '$' and return an OP_CONST containing 'abc'.
3022 It looks at PL_lex_inwhat and PL_lex_inpat to find out whether it's
3023 processing a pattern (PL_lex_inpat is true), a transliteration
3024 (PL_lex_inwhat == OP_TRANS is true), or a double-quoted string.
3026 Returns a pointer to the character scanned up to. If this is
3027 advanced from the start pointer supplied (i.e. if anything was
3028 successfully parsed), will leave an OP_CONST for the substring scanned
3029 in pl_yylval. Caller must intuit reason for not parsing further
3030 by looking at the next characters herself.
3034 \N{FOO} => \N{U+hex_for_character_FOO}
3035 (if FOO expands to multiple characters, expands to \N{U+xx.XX.yy ...})
3038 all other \-char, including \N and \N{ apart from \N{ABC}
3041 @ and $ where it appears to be a var, but not for $ as tail anchor
3046 In transliterations:
3047 characters are VERY literal, except for - not at the start or end
3048 of the string, which indicates a range. If the range is in bytes,
3049 scan_const expands the range to the full set of intermediate
3050 characters. If the range is in utf8, the hyphen is replaced with
3051 a certain range mark which will be handled by pmtrans() in op.c.
3053 In double-quoted strings:
3055 double-quoted style: \r and \n
3056 constants: \x31, etc.
3057 deprecated backrefs: \1 (in substitution replacements)
3058 case and quoting: \U \Q \E
3061 scan_const does *not* construct ops to handle interpolated strings.
3062 It stops processing as soon as it finds an embedded $ or @ variable
3063 and leaves it to the caller to work out what's going on.
3065 embedded arrays (whether in pattern or not) could be:
3066 @foo, @::foo, @'foo, @{foo}, @$foo, @+, @-.
3068 $ in double-quoted strings must be the symbol of an embedded scalar.
3070 $ in pattern could be $foo or could be tail anchor. Assumption:
3071 it's a tail anchor if $ is the last thing in the string, or if it's
3072 followed by one of "()| \r\n\t"
3074 \1 (backreferences) are turned into $1 in substitutions
3076 The structure of the code is
3077 while (there's a character to process) {
3078 handle transliteration ranges
3079 skip regexp comments /(?#comment)/ and codes /(?{code})/
3080 skip #-initiated comments in //x patterns
3081 check for embedded arrays
3082 check for embedded scalars
3084 deprecate \1 in substitution replacements
3085 handle string-changing backslashes \l \U \Q \E, etc.
3086 switch (what was escaped) {
3087 handle \- in a transliteration (becomes a literal -)
3088 if a pattern and not \N{, go treat as regular character
3089 handle \132 (octal characters)
3090 handle \x15 and \x{1234} (hex characters)
3091 handle \N{name} (named characters, also \N{3,5} in a pattern)
3092 handle \cV (control characters)
3093 handle printf-style backslashes (\f, \r, \n, etc)
3096 } (end if backslash)
3097 handle regular character
3098 } (end while character to read)
3103 S_scan_const(pTHX_ char *start)
3106 char *send = PL_bufend; /* end of the constant */
3107 SV *sv = newSV(send - start); /* sv for the constant. See
3108 note below on sizing. */
3109 char *s = start; /* start of the constant */
3110 char *d = SvPVX(sv); /* destination for copies */
3111 bool dorange = FALSE; /* are we in a translit range? */
3112 bool didrange = FALSE; /* did we just finish a range? */
3113 bool in_charclass = FALSE; /* within /[...]/ */
3114 bool has_utf8 = FALSE; /* Output constant is UTF8 */
3115 bool this_utf8 = cBOOL(UTF); /* Is the source string assumed
3116 to be UTF8? But, this can
3117 show as true when the source
3118 isn't utf8, as for example
3119 when it is entirely composed
3121 SV *res; /* result from charnames */
3123 /* Note on sizing: The scanned constant is placed into sv, which is
3124 * initialized by newSV() assuming one byte of output for every byte of
3125 * input. This routine expects newSV() to allocate an extra byte for a
3126 * trailing NUL, which this routine will append if it gets to the end of
3127 * the input. There may be more bytes of input than output (eg., \N{LATIN
3128 * CAPITAL LETTER A}), or more output than input if the constant ends up
3129 * recoded to utf8, but each time a construct is found that might increase
3130 * the needed size, SvGROW() is called. Its size parameter each time is
3131 * based on the best guess estimate at the time, namely the length used so
3132 * far, plus the length the current construct will occupy, plus room for
3133 * the trailing NUL, plus one byte for every input byte still unscanned */
3135 UV uv = UV_MAX; /* Initialize to weird value to try to catch any uses
3138 UV literal_endpoint = 0;
3139 bool native_range = TRUE; /* turned to FALSE if the first endpoint is Unicode. */
3142 PERL_ARGS_ASSERT_SCAN_CONST;
3144 assert(PL_lex_inwhat != OP_TRANSR);
3145 if (PL_lex_inwhat == OP_TRANS && PL_sublex_info.sub_op) {
3146 /* If we are doing a trans and we know we want UTF8 set expectation */
3147 has_utf8 = PL_sublex_info.sub_op->op_private & (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF);
3148 this_utf8 = PL_sublex_info.sub_op->op_private & (PL_lex_repl ? OPpTRANS_FROM_UTF : OPpTRANS_TO_UTF);
3151 /* Protect sv from errors and fatal warnings. */
3152 ENTER_with_name("scan_const");
3155 while (s < send || dorange) {
3157 /* get transliterations out of the way (they're most literal) */
3158 if (PL_lex_inwhat == OP_TRANS) {
3159 /* expand a range A-Z to the full set of characters. AIE! */
3161 I32 i; /* current expanded character */
3162 I32 min; /* first character in range */
3163 I32 max; /* last character in range */
3174 char * const c = (char*)utf8_hop((U8*)d, -1);
3178 *c = (char) ILLEGAL_UTF8_BYTE;
3179 /* mark the range as done, and continue */
3185 i = d - SvPVX_const(sv); /* remember current offset */
3188 SvLEN(sv) + (has_utf8 ?
3189 (512 - UTF_CONTINUATION_MARK +
3192 /* How many two-byte within 0..255: 128 in UTF-8,
3193 * 96 in UTF-8-mod. */
3195 SvGROW(sv, SvLEN(sv) + 256); /* never more than 256 chars in a range */
3197 d = SvPVX(sv) + i; /* refresh d after realloc */
3201 for (j = 0; j <= 1; j++) {
3202 char * const c = (char*)utf8_hop((U8*)d, -1);
3203 const UV uv = utf8n_to_uvchr((U8*)c, d - c, NULL, 0);
3209 max = (U8)0xff; /* only to \xff */
3210 uvmax = uv; /* \x{100} to uvmax */
3212 d = c; /* eat endpoint chars */
3217 d -= 2; /* eat the first char and the - */
3218 min = (U8)*d; /* first char in range */
3219 max = (U8)d[1]; /* last char in range */
3226 "Invalid range \"%c-%c\" in transliteration operator",
3227 (char)min, (char)max);
3231 if (literal_endpoint == 2 &&
3232 ((isLOWER_A(min) && isLOWER_A(max)) ||
3233 (isUPPER_A(min) && isUPPER_A(max))))
3235 for (i = min; i <= max; i++) {
3242 for (i = min; i <= max; i++)
3245 append_utf8_from_native_byte(i, &d);
3253 d = (char*)uvchr_to_utf8((U8*)d, 0x100);
3255 *d++ = (char) ILLEGAL_UTF8_BYTE;
3257 d = (char*)uvchr_to_utf8((U8*)d, uvmax);
3261 /* mark the range as done, and continue */
3265 literal_endpoint = 0;
3270 /* range begins (ignore - as first or last char) */
3271 else if (*s == '-' && s+1 < send && s != start) {
3273 Perl_croak(aTHX_ "Ambiguous range in transliteration operator");
3280 *d++ = (char) ILLEGAL_UTF8_BYTE; /* use illegal utf8 byte--see pmtrans */
3290 literal_endpoint = 0;
3291 native_range = TRUE;
3296 /* if we get here, we're not doing a transliteration */
3298 else if (*s == '[' && PL_lex_inpat && !in_charclass) {
3301 while (s1 >= start && *s1-- == '\\')
3304 in_charclass = TRUE;
3307 else if (*s == ']' && PL_lex_inpat && in_charclass) {
3310 while (s1 >= start && *s1-- == '\\')
3313 in_charclass = FALSE;
3316 /* skip for regexp comments /(?#comment)/, except for the last
3317 * char, which will be done separately.
3318 * Stop on (?{..}) and friends */
3320 else if (*s == '(' && PL_lex_inpat && s[1] == '?' && !in_charclass) {
3322 while (s+1 < send && *s != ')')
3325 else if (!PL_lex_casemods &&
3326 ( s[2] == '{' /* This should match regcomp.c */
3327 || (s[2] == '?' && s[3] == '{')))
3333 /* likewise skip #-initiated comments in //x patterns */
3334 else if (*s == '#' && PL_lex_inpat && !in_charclass &&
3335 ((PMOP*)PL_lex_inpat)->op_pmflags & RXf_PMf_EXTENDED) {
3336 while (s+1 < send && *s != '\n')
3340 /* no further processing of single-quoted regex */
3341 else if (PL_lex_inpat && SvIVX(PL_linestr) == '\'')
3342 goto default_action;
3344 /* check for embedded arrays
3345 (@foo, @::foo, @'foo, @{foo}, @$foo, @+, @-)
3347 else if (*s == '@' && s[1]) {
3348 if (isWORDCHAR_lazy_if(s+1,UTF))
3350 if (strchr(":'{$", s[1]))
3352 if (!PL_lex_inpat && (s[1] == '+' || s[1] == '-'))
3353 break; /* in regexp, neither @+ nor @- are interpolated */
3356 /* check for embedded scalars. only stop if we're sure it's a
3359 else if (*s == '$') {
3360 if (!PL_lex_inpat) /* not a regexp, so $ must be var */
3362 if (s + 1 < send && !strchr("()| \r\n\t", s[1])) {
3364 Perl_ck_warner(aTHX_ packWARN(WARN_AMBIGUOUS),
3365 "Possible unintended interpolation of $\\ in regex");
3367 break; /* in regexp, $ might be tail anchor */
3371 /* End of else if chain - OP_TRANS rejoin rest */
3374 if (*s == '\\' && s+1 < send) {
3375 char* e; /* Can be used for ending '}', etc. */
3379 /* warn on \1 - \9 in substitution replacements, but note that \11
3380 * is an octal; and \19 is \1 followed by '9' */
3381 if (PL_lex_inwhat == OP_SUBST && !PL_lex_inpat &&
3382 isDIGIT(*s) && *s != '0' && !isDIGIT(s[1]))
3384 /* diag_listed_as: \%d better written as $%d */
3385 Perl_ck_warner(aTHX_ packWARN(WARN_SYNTAX), "\\%c better written as $%c", *s, *s);
3390 /* string-change backslash escapes */
3391 if (PL_lex_inwhat != OP_TRANS && *s && strchr("lLuUEQF", *s)) {
3395 /* In a pattern, process \N, but skip any other backslash escapes.
3396 * This is because we don't want to translate an escape sequence
3397 * into a meta symbol and have the regex compiler use the meta
3398 * symbol meaning, e.g. \x{2E} would be confused with a dot. But
3399 * in spite of this, we do have to process \N here while the proper
3400 * charnames handler is in scope. See bugs #56444 and #62056.
3401 * There is a complication because \N in a pattern may also stand
3402 * for 'match a non-nl', and not mean a charname, in which case its
3403 * processing should be deferred to the regex compiler. To be a
3404 * charname it must be followed immediately by a '{', and not look
3405 * like \N followed by a curly quantifier, i.e., not something like
3406 * \N{3,}. regcurly returns a boolean indicating if it is a legal
3408 else if (PL_lex_inpat
3411 || regcurly(s + 1, FALSE)))
3414 goto default_action;
3419 /* quoted - in transliterations */
3421 if (PL_lex_inwhat == OP_TRANS) {
3428 if ((isALPHANUMERIC(*s)))
3429 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
3430 "Unrecognized escape \\%c passed through",
3432 /* default action is to copy the quoted character */
3433 goto default_action;
3436 /* eg. \132 indicates the octal constant 0132 */
3437 case '0': case '1': case '2': case '3':
3438 case '4': case '5': case '6': case '7':
3440 I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
3442 uv = grok_oct(s, &len, &flags, NULL);
3444 if (len < 3 && s < send && isDIGIT(*s)
3445 && ckWARN(WARN_MISC))
3447 Perl_warner(aTHX_ packWARN(WARN_MISC),
3448 "%s", form_short_octal_warning(s, len));
3451 goto NUM_ESCAPE_INSERT;
3453 /* eg. \o{24} indicates the octal constant \024 */
3458 bool valid = grok_bslash_o(&s, &uv, &error,
3459 TRUE, /* Output warning */
3460 FALSE, /* Not strict */
3461 TRUE, /* Output warnings for
3468 goto NUM_ESCAPE_INSERT;
3471 /* eg. \x24 indicates the hex constant 0x24 */
3476 bool valid = grok_bslash_x(&s, &uv, &error,
3477 TRUE, /* Output warning */
3478 FALSE, /* Not strict */
3479 TRUE, /* Output warnings for
3489 /* Insert oct or hex escaped character. There will always be
3490 * enough room in sv since such escapes will be longer than any
3491 * UTF-8 sequence they can end up as, except if they force us
3492 * to recode the rest of the string into utf8 */
3494 /* Here uv is the ordinal of the next character being added */
3495 if (!UVCHR_IS_INVARIANT(uv)) {
3496 if (!has_utf8 && uv > 255) {
3497 /* Might need to recode whatever we have accumulated so
3498 * far if it contains any chars variant in utf8 or
3501 SvCUR_set(sv, d - SvPVX_const(sv));
3504 /* See Note on sizing above. */
3505 sv_utf8_upgrade_flags_grow(sv,
3506 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3507 UNISKIP(uv) + (STRLEN)(send - s) + 1);
3508 d = SvPVX(sv) + SvCUR(sv);
3513 d = (char*)uvchr_to_utf8((U8*)d, uv);
3514 if (PL_lex_inwhat == OP_TRANS &&
3515 PL_sublex_info.sub_op) {
3516 PL_sublex_info.sub_op->op_private |=
3517 (PL_lex_repl ? OPpTRANS_FROM_UTF
3521 if (uv > 255 && !dorange)
3522 native_range = FALSE;
3535 /* In a non-pattern \N must be a named character, like \N{LATIN
3536 * SMALL LETTER A} or \N{U+0041}. For patterns, it also can
3537 * mean to match a non-newline. For non-patterns, named
3538 * characters are converted to their string equivalents. In
3539 * patterns, named characters are not converted to their
3540 * ultimate forms for the same reasons that other escapes
3541 * aren't. Instead, they are converted to the \N{U+...} form
3542 * to get the value from the charnames that is in effect right
3543 * now, while preserving the fact that it was a named character
3544 * so that the regex compiler knows this */
3546 /* The structure of this section of code (besides checking for
3547 * errors and upgrading to utf8) is:
3548 * Further disambiguate between the two meanings of \N, and if
3549 * not a charname, go process it elsewhere
3550 * If of form \N{U+...}, pass it through if a pattern;
3551 * otherwise convert to utf8
3552 * Otherwise must be \N{NAME}: convert to \N{U+c1.c2...} if a
3553 * pattern; otherwise convert to utf8 */
3555 /* Here, s points to the 'N'; the test below is guaranteed to
3556 * succeed if we are being called on a pattern as we already
3557 * know from a test above that the next character is a '{'.
3558 * On a non-pattern \N must mean 'named sequence, which
3559 * requires braces */
3562 yyerror("Missing braces on \\N{}");
3567 /* If there is no matching '}', it is an error. */
3568 if (! (e = strchr(s, '}'))) {
3569 if (! PL_lex_inpat) {
3570 yyerror("Missing right brace on \\N{}");
3572 yyerror("Missing right brace on \\N{} or unescaped left brace after \\N");
3577 /* Here it looks like a named character */
3579 if (*s == 'U' && s[1] == '+') { /* \N{U+...} */
3580 I32 flags = PERL_SCAN_ALLOW_UNDERSCORES
3581 | PERL_SCAN_DISALLOW_PREFIX;
3584 /* For \N{U+...}, the '...' is a unicode value even on
3585 * EBCDIC machines */
3586 s += 2; /* Skip to next char after the 'U+' */
3588 uv = grok_hex(s, &len, &flags, NULL);
3589 if (len == 0 || len != (STRLEN)(e - s)) {
3590 yyerror("Invalid hexadecimal number in \\N{U+...}");
3597 /* On non-EBCDIC platforms, pass through to the regex
3598 * compiler unchanged. The reason we evaluated the
3599 * number above is to make sure there wasn't a syntax
3600 * error. But on EBCDIC we convert to native so
3601 * downstream code can continue to assume it's native
3603 s -= 5; /* Include the '\N{U+' */
3605 d += my_snprintf(d, e - s + 1 + 1, /* includes the }
3608 (unsigned int) UNI_TO_NATIVE(uv));
3610 Copy(s, d, e - s + 1, char); /* 1 = include the } */
3614 else { /* Not a pattern: convert the hex to string */
3616 /* If destination is not in utf8, unconditionally
3617 * recode it to be so. This is because \N{} implies
3618 * Unicode semantics, and scalars have to be in utf8
3619 * to guarantee those semantics */
3621 SvCUR_set(sv, d - SvPVX_const(sv));
3624 /* See Note on sizing above. */
3625 sv_utf8_upgrade_flags_grow(
3627 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3628 UNISKIP(uv) + (STRLEN)(send - e) + 1);
3629 d = SvPVX(sv) + SvCUR(sv);
3633 /* Add the (Unicode) code point to the output. */
3634 if (UNI_IS_INVARIANT(uv)) {
3635 *d++ = (char) LATIN1_TO_NATIVE(uv);
3638 d = (char*) uvoffuni_to_utf8_flags((U8*)d, uv, 0);
3642 else /* Here is \N{NAME} but not \N{U+...}. */
3643 if ((res = get_and_check_backslash_N_name(s, e)))
3646 const char *str = SvPV_const(res, len);
3649 if (! len) { /* The name resolved to an empty string */
3650 Copy("\\N{}", d, 4, char);
3654 /* In order to not lose information for the regex
3655 * compiler, pass the result in the specially made
3656 * syntax: \N{U+c1.c2.c3...}, where c1 etc. are
3657 * the code points in hex of each character
3658 * returned by charnames */
3660 const char *str_end = str + len;
3661 const STRLEN off = d - SvPVX_const(sv);
3663 if (! SvUTF8(res)) {
3664 /* For the non-UTF-8 case, we can determine the
3665 * exact length needed without having to parse
3666 * through the string. Each character takes up
3667 * 2 hex digits plus either a trailing dot or
3669 d = off + SvGROW(sv, off
3671 + 6 /* For the "\N{U+", and
3673 + (STRLEN)(send - e));
3674 Copy("\\N{U+", d, 5, char);
3676 while (str < str_end) {
3678 my_snprintf(hex_string, sizeof(hex_string),
3679 "%02X.", (U8) *str);
3680 Copy(hex_string, d, 3, char);
3684 d--; /* We will overwrite below the final
3685 dot with a right brace */
3688 STRLEN char_length; /* cur char's byte length */
3690 /* and the number of bytes after this is
3691 * translated into hex digits */
3692 STRLEN output_length;
3694 /* 2 hex per byte; 2 chars for '\N'; 2 chars
3695 * for max('U+', '.'); and 1 for NUL */
3696 char hex_string[2 * UTF8_MAXBYTES + 5];
3698 /* Get the first character of the result. */
3699 U32 uv = utf8n_to_uvchr((U8 *) str,
3703 /* Convert first code point to hex, including
3704 * the boiler plate before it. */
3706 my_snprintf(hex_string, sizeof(hex_string),
3710 /* Make sure there is enough space to hold it */
3711 d = off + SvGROW(sv, off
3713 + (STRLEN)(send - e)
3714 + 2); /* '}' + NUL */
3716 Copy(hex_string, d, output_length, char);
3719 /* For each subsequent character, append dot and
3720 * its ordinal in hex */
3721 while ((str += char_length) < str_end) {
3722 const STRLEN off = d - SvPVX_const(sv);
3723 U32 uv = utf8n_to_uvchr((U8 *) str,
3728 my_snprintf(hex_string,
3733 d = off + SvGROW(sv, off
3735 + (STRLEN)(send - e)
3736 + 2); /* '}' + NUL */
3737 Copy(hex_string, d, output_length, char);
3742 *d++ = '}'; /* Done. Add the trailing brace */
3745 else { /* Here, not in a pattern. Convert the name to a
3748 /* If destination is not in utf8, unconditionally
3749 * recode it to be so. This is because \N{} implies
3750 * Unicode semantics, and scalars have to be in utf8
3751 * to guarantee those semantics */
3753 SvCUR_set(sv, d - SvPVX_const(sv));
3756 /* See Note on sizing above. */
3757 sv_utf8_upgrade_flags_grow(sv,
3758 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3759 len + (STRLEN)(send - s) + 1);
3760 d = SvPVX(sv) + SvCUR(sv);
3762 } else if (len > (STRLEN)(e - s + 4)) { /* I _guess_ 4 is \N{} --jhi */
3764 /* See Note on sizing above. (NOTE: SvCUR() is not
3765 * set correctly here). */
3766 const STRLEN off = d - SvPVX_const(sv);
3767 d = off + SvGROW(sv, off + len + (STRLEN)(send - s) + 1);
3769 Copy(str, d, len, char);
3775 } /* End \N{NAME} */
3778 native_range = FALSE; /* \N{} is defined to be Unicode */
3780 s = e + 1; /* Point to just after the '}' */
3783 /* \c is a control character */
3787 *d++ = grok_bslash_c(*s++, has_utf8, 1);
3790 yyerror("Missing control char name in \\c");
3794 /* printf-style backslashes, formfeeds, newlines, etc */
3811 *d++ = ASCII_TO_NATIVE('\033');
3820 } /* end if (backslash) */
3827 /* If we started with encoded form, or already know we want it,
3828 then encode the next character */
3829 if (! NATIVE_BYTE_IS_INVARIANT((U8)(*s)) && (this_utf8 || has_utf8)) {
3833 /* One might think that it is wasted effort in the case of the
3834 * source being utf8 (this_utf8 == TRUE) to take the next character
3835 * in the source, convert it to an unsigned value, and then convert
3836 * it back again. But the source has not been validated here. The
3837 * routine that does the conversion checks for errors like
3840 const UV nextuv = (this_utf8)
3841 ? utf8n_to_uvchr((U8*)s, send - s, &len, 0)
3843 const STRLEN need = UNISKIP(nextuv);
3845 SvCUR_set(sv, d - SvPVX_const(sv));
3848 /* See Note on sizing above. */
3849 sv_utf8_upgrade_flags_grow(sv,
3850 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3851 need + (STRLEN)(send - s) + 1);
3852 d = SvPVX(sv) + SvCUR(sv);
3854 } else if (need > len) {
3855 /* encoded value larger than old, may need extra space (NOTE:
3856 * SvCUR() is not set correctly here). See Note on sizing
3858 const STRLEN off = d - SvPVX_const(sv);
3859 d = SvGROW(sv, off + need + (STRLEN)(send - s) + 1) + off;
3863 d = (char*)uvchr_to_utf8((U8*)d, nextuv);
3865 if (uv > 255 && !dorange)
3866 native_range = FALSE;
3872 } /* while loop to process each character */
3874 /* terminate the string and set up the sv */
3876 SvCUR_set(sv, d - SvPVX_const(sv));
3877 if (SvCUR(sv) >= SvLEN(sv))
3878 Perl_croak(aTHX_ "panic: constant overflowed allocated space, %"UVuf
3879 " >= %"UVuf, (UV)SvCUR(sv), (UV)SvLEN(sv));
3882 if (PL_encoding && !has_utf8) {
3883 sv_recode_to_utf8(sv, PL_encoding);
3889 if (PL_lex_inwhat == OP_TRANS && PL_sublex_info.sub_op) {
3890 PL_sublex_info.sub_op->op_private |=
3891 (PL_lex_repl ? OPpTRANS_FROM_UTF : OPpTRANS_TO_UTF);
3895 /* shrink the sv if we allocated more than we used */
3896 if (SvCUR(sv) + 5 < SvLEN(sv)) {
3897 SvPV_shrink_to_cur(sv);
3900 /* return the substring (via pl_yylval) only if we parsed anything */
3903 for (; s2 < s; s2++) {
3905 COPLINE_INC_WITH_HERELINES;
3907 SvREFCNT_inc_simple_void_NN(sv);
3908 if ( (PL_hints & ( PL_lex_inpat ? HINT_NEW_RE : HINT_NEW_STRING ))
3909 && ! PL_parser->lex_re_reparsing)
3911 const char *const key = PL_lex_inpat ? "qr" : "q";
3912 const STRLEN keylen = PL_lex_inpat ? 2 : 1;
3916 if (PL_lex_inwhat == OP_TRANS) {
3919 } else if (PL_lex_inwhat == OP_SUBST && !PL_lex_inpat) {
3922 } else if (PL_lex_inpat && SvIVX(PL_linestr) == '\'') {
3930 sv = S_new_constant(aTHX_ start, s - start, key, keylen, sv, NULL,
3933 pl_yylval.opval = (OP*)newSVOP(OP_CONST, 0, sv);
3935 LEAVE_with_name("scan_const");
3940 * Returns TRUE if there's more to the expression (e.g., a subscript),
3943 * It deals with "$foo[3]" and /$foo[3]/ and /$foo[0123456789$]+/
3945 * ->[ and ->{ return TRUE
3946 * ->$* ->$#* ->@* ->@[ ->@{ return TRUE if postderef_qq is enabled
3947 * { and [ outside a pattern are always subscripts, so return TRUE
3948 * if we're outside a pattern and it's not { or [, then return FALSE
3949 * if we're in a pattern and the first char is a {
3950 * {4,5} (any digits around the comma) returns FALSE
3951 * if we're in a pattern and the first char is a [
3953 * [SOMETHING] has a funky algorithm to decide whether it's a
3954 * character class or not. It has to deal with things like
3955 * /$foo[-3]/ and /$foo[$bar]/ as well as /$foo[$\d]+/
3956 * anything else returns TRUE
3959 /* This is the one truly awful dwimmer necessary to conflate C and sed. */
3962 S_intuit_more(pTHX_ char *s)
3966 PERL_ARGS_ASSERT_INTUIT_MORE;
3968 if (PL_lex_brackets)
3970 if (*s == '-' && s[1] == '>' && (s[2] == '[' || s[2] == '{'))
3972 if (*s == '-' && s[1] == '>'
3973 && FEATURE_POSTDEREF_QQ_IS_ENABLED
3974 && ( (s[2] == '$' && (s[3] == '*' || (s[3] == '#' && s[4] == '*')))
3975 ||(s[2] == '@' && strchr("*[{",s[3])) ))
3977 if (*s != '{' && *s != '[')
3982 /* In a pattern, so maybe we have {n,m}. */
3984 if (regcurly(s, FALSE)) {
3990 /* On the other hand, maybe we have a character class */
3993 if (*s == ']' || *s == '^')
3996 /* this is terrifying, and it works */
3999 const char * const send = strchr(s,']');
4000 unsigned char un_char, last_un_char;
4001 char tmpbuf[sizeof PL_tokenbuf * 4];
4003 if (!send) /* has to be an expression */
4005 weight = 2; /* let's weigh the evidence */
4009 else if (isDIGIT(*s)) {
4011 if (isDIGIT(s[1]) && s[2] == ']')
4017 Zero(seen,256,char);
4019 for (; s < send; s++) {
4020 last_un_char = un_char;
4021 un_char = (unsigned char)*s;
4026 weight -= seen[un_char] * 10;
4027 if (isWORDCHAR_lazy_if(s+1,UTF)) {
4029 char *tmp = PL_bufend;
4030 PL_bufend = (char*)send;
4031 scan_ident(s, tmpbuf, sizeof tmpbuf, FALSE);
4033 len = (int)strlen(tmpbuf);
4034 if (len > 1 && gv_fetchpvn_flags(tmpbuf, len,
4035 UTF ? SVf_UTF8 : 0, SVt_PV))
4040 else if (*s == '$' && s[1] &&
4041 strchr("[#!%*<>()-=",s[1])) {
4042 if (/*{*/ strchr("])} =",s[2]))
4051 if (strchr("wds]",s[1]))
4053 else if (seen[(U8)'\''] || seen[(U8)'"'])
4055 else if (strchr("rnftbxcav",s[1]))
4057 else if (isDIGIT(s[1])) {
4059 while (s[1] && isDIGIT(s[1]))
4069 if (strchr("aA01! ",last_un_char))
4071 if (strchr("zZ79~",s[1]))
4073 if (last_un_char == 255 && (isDIGIT(s[1]) || s[1] == '$'))
4074 weight -= 5; /* cope with negative subscript */
4077 if (!isWORDCHAR(last_un_char)
4078 && !(last_un_char == '$' || last_un_char == '@'
4079 || last_un_char == '&')
4080 && isALPHA(*s) && s[1] && isALPHA(s[1])) {
4085 if (keyword(tmpbuf, d - tmpbuf, 0))
4088 if (un_char == last_un_char + 1)
4090 weight -= seen[un_char];
4095 if (weight >= 0) /* probably a character class */
4105 * Does all the checking to disambiguate
4107 * between foo(bar) and bar->foo. Returns 0 if not a method, otherwise
4108 * FUNCMETH (bar->foo(args)) or METHOD (bar->foo args).
4110 * First argument is the stuff after the first token, e.g. "bar".
4112 * Not a method if foo is a filehandle.
4113 * Not a method if foo is a subroutine prototyped to take a filehandle.
4114 * Not a method if it's really "Foo $bar"
4115 * Method if it's "foo $bar"
4116 * Not a method if it's really "print foo $bar"
4117 * Method if it's really "foo package::" (interpreted as package->foo)
4118 * Not a method if bar is known to be a subroutine ("sub bar; foo bar")
4119 * Not a method if bar is a filehandle or package, but is quoted with
4124 S_intuit_method(pTHX_ char *start, GV *gv, CV *cv)
4127 char *s = start + (*start == '$');
4128 char tmpbuf[sizeof PL_tokenbuf];
4135 PERL_ARGS_ASSERT_INTUIT_METHOD;
4137 if (gv && SvTYPE(gv) == SVt_PVGV && GvIO(gv))
4139 if (cv && SvPOK(cv)) {
4140 const char *proto = CvPROTO(cv);
4142 while (*proto && (isSPACE(*proto) || *proto == ';'))
4149 if (*start == '$') {
4150 if (cv || PL_last_lop_op == OP_PRINT || PL_last_lop_op == OP_SAY ||
4151 isUPPER(*PL_tokenbuf))
4154 len = start - SvPVX(PL_linestr);
4158 start = SvPVX(PL_linestr) + len;
4162 return *s == '(' ? FUNCMETH : METHOD;
4165 s = scan_word(s, tmpbuf, sizeof tmpbuf, TRUE, &len);
4166 /* start is the beginning of the possible filehandle/object,
4167 * and s is the end of it
4168 * tmpbuf is a copy of it (but with single quotes as double colons)
4171 if (!keyword(tmpbuf, len, 0)) {
4172 if (len > 2 && tmpbuf[len - 2] == ':' && tmpbuf[len - 1] == ':') {
4176 soff = s - SvPVX(PL_linestr);
4180 indirgv = gv_fetchpvn_flags(tmpbuf, len, ( UTF ? SVf_UTF8 : 0 ), SVt_PVCV);
4181 if (indirgv && GvCVu(indirgv))
4183 /* filehandle or package name makes it a method */
4184 if (!cv || GvIO(indirgv) || gv_stashpvn(tmpbuf, len, UTF ? SVf_UTF8 : 0)) {
4186 soff = s - SvPVX(PL_linestr);
4189 if ((PL_bufend - s) >= 2 && *s == '=' && *(s+1) == '>')
4190 return 0; /* no assumptions -- "=>" quotes bareword */
4192 start_force(PL_curforce);
4193 NEXTVAL_NEXTTOKE.opval = (OP*)newSVOP(OP_CONST, 0,
4194 S_newSV_maybe_utf8(aTHX_ tmpbuf, len));
4195 NEXTVAL_NEXTTOKE.opval->op_private = OPpCONST_BARE;
4197 curmad('X', newSVpvn_flags(start,SvPVX(PL_linestr) + soff - start,
4198 ( UTF ? SVf_UTF8 : 0 )));
4203 PL_bufptr = SvPVX(PL_linestr) + soff; /* restart before space */
4205 return *s == '(' ? FUNCMETH : METHOD;
4211 /* Encoded script support. filter_add() effectively inserts a
4212 * 'pre-processing' function into the current source input stream.
4213 * Note that the filter function only applies to the current source file
4214 * (e.g., it will not affect files 'require'd or 'use'd by this one).
4216 * The datasv parameter (which may be NULL) can be used to pass
4217 * private data to this instance of the filter. The filter function
4218 * can recover the SV using the FILTER_DATA macro and use it to
4219 * store private buffers and state information.
4221 * The supplied datasv parameter is upgraded to a PVIO type
4222 * and the IoDIRP/IoANY field is used to store the function pointer,
4223 * and IOf_FAKE_DIRP is enabled on datasv to mark this as such.
4224 * Note that IoTOP_NAME, IoFMT_NAME, IoBOTTOM_NAME, if set for
4225 * private use must be set using malloc'd pointers.
4229 Perl_filter_add(pTHX_ filter_t funcp, SV *datasv)
4238 if (PL_parser->lex_flags & LEX_IGNORE_UTF8_HINTS)
4239 Perl_croak(aTHX_ "Source filters apply only to byte streams");
4241 if (!PL_rsfp_filters)
4242 PL_rsfp_filters = newAV();
4245 SvUPGRADE(datasv, SVt_PVIO);
4246 IoANY(datasv) = FPTR2DPTR(void *, funcp); /* stash funcp into spare field */
4247 IoFLAGS(datasv) |= IOf_FAKE_DIRP;
4248 DEBUG_P(PerlIO_printf(Perl_debug_log, "filter_add func %p (%s)\n",
4249 FPTR2DPTR(void *, IoANY(datasv)),
4250 SvPV_nolen(datasv)));
4251 av_unshift(PL_rsfp_filters, 1);
4252 av_store(PL_rsfp_filters, 0, datasv) ;
4254 !PL_parser->filtered
4255 && PL_parser->lex_flags & LEX_EVALBYTES
4256 && PL_bufptr < PL_bufend
4258 const char *s = PL_bufptr;
4259 while (s < PL_bufend) {
4261 SV *linestr = PL_parser->linestr;
4262 char *buf = SvPVX(linestr);
4263 STRLEN const bufptr_pos = PL_parser->bufptr - buf;
4264 STRLEN const oldbufptr_pos = PL_parser->oldbufptr - buf;
4265 STRLEN const oldoldbufptr_pos=PL_parser->oldoldbufptr-buf;
4266 STRLEN const linestart_pos = PL_parser->linestart - buf;
4267 STRLEN const last_uni_pos =
4268 PL_parser->last_uni ? PL_parser->last_uni - buf : 0;
4269 STRLEN const last_lop_pos =
4270 PL_parser->last_lop ? PL_parser->last_lop - buf : 0;
4271 av_push(PL_rsfp_filters, linestr);
4272 PL_parser->linestr =
4273 newSVpvn(SvPVX(linestr), ++s-SvPVX(linestr));
4274 buf = SvPVX(PL_parser->linestr);
4275 PL_parser->bufend = buf + SvCUR(PL_parser->linestr);
4276 PL_parser->bufptr = buf + bufptr_pos;
4277 PL_parser->oldbufptr = buf + oldbufptr_pos;
4278 PL_parser->oldoldbufptr = buf + oldoldbufptr_pos;
4279 PL_parser->linestart = buf + linestart_pos;
4280 if (PL_parser->last_uni)
4281 PL_parser->last_uni = buf + last_uni_pos;
4282 if (PL_parser->last_lop)
4283 PL_parser->last_lop = buf + last_lop_pos;
4284 SvLEN(linestr) = SvCUR(linestr);
4285 SvCUR(linestr) = s-SvPVX(linestr);
4286 PL_parser->filtered = 1;
4296 /* Delete most recently added instance of this filter function. */
4298 Perl_filter_del(pTHX_ filter_t funcp)
4303 PERL_ARGS_ASSERT_FILTER_DEL;
4306 DEBUG_P(PerlIO_printf(Perl_debug_log, "filter_del func %p",
4307 FPTR2DPTR(void*, funcp)));
4309 if (!PL_parser || !PL_rsfp_filters || AvFILLp(PL_rsfp_filters)<0)
4311 /* if filter is on top of stack (usual case) just pop it off */
4312 datasv = FILTER_DATA(AvFILLp(PL_rsfp_filters));
4313 if (IoANY(datasv) == FPTR2DPTR(void *, funcp)) {
4314 sv_free(av_pop(PL_rsfp_filters));
4318 /* we need to search for the correct entry and clear it */
4319 Perl_die(aTHX_ "filter_del can only delete in reverse order (currently)");
4323 /* Invoke the idxth filter function for the current rsfp. */
4324 /* maxlen 0 = read one text line */
4326 Perl_filter_read(pTHX_ int idx, SV *buf_sv, int maxlen)
4331 /* This API is bad. It should have been using unsigned int for maxlen.
4332 Not sure if we want to change the API, but if not we should sanity
4333 check the value here. */
4334 unsigned int correct_length = maxlen < 0 ? PERL_INT_MAX : maxlen;
4336 PERL_ARGS_ASSERT_FILTER_READ;
4338 if (!PL_parser || !PL_rsfp_filters)
4340 if (idx > AvFILLp(PL_rsfp_filters)) { /* Any more filters? */
4341 /* Provide a default input filter to make life easy. */
4342 /* Note that we append to the line. This is handy. */
4343 DEBUG_P(PerlIO_printf(Perl_debug_log,
4344 "filter_read %d: from rsfp\n", idx));
4345 if (correct_length) {
4348 const int old_len = SvCUR(buf_sv);
4350 /* ensure buf_sv is large enough */
4351 SvGROW(buf_sv, (STRLEN)(old_len + correct_length + 1)) ;
4352 if ((len = PerlIO_read(PL_rsfp, SvPVX(buf_sv) + old_len,
4353 correct_length)) <= 0) {
4354 if (PerlIO_error(PL_rsfp))
4355 return -1; /* error */
4357 return 0 ; /* end of file */
4359 SvCUR_set(buf_sv, old_len + len) ;
4360 SvPVX(buf_sv)[old_len + len] = '\0';
4363 if (sv_gets(buf_sv, PL_rsfp, SvCUR(buf_sv)) == NULL) {
4364 if (PerlIO_error(PL_rsfp))
4365 return -1; /* error */
4367 return 0 ; /* end of file */
4370 return SvCUR(buf_sv);
4372 /* Skip this filter slot if filter has been deleted */
4373 if ( (datasv = FILTER_DATA(idx)) == &PL_sv_undef) {
4374 DEBUG_P(PerlIO_printf(Perl_debug_log,
4375 "filter_read %d: skipped (filter deleted)\n",
4377 return FILTER_READ(idx+1, buf_sv, correct_length); /* recurse */
4379 if (SvTYPE(datasv) != SVt_PVIO) {
4380 if (correct_length) {
4382 const STRLEN remainder = SvLEN(datasv) - SvCUR(datasv);
4383 if (!remainder) return 0; /* eof */
4384 if (correct_length > remainder) correct_length = remainder;
4385 sv_catpvn(buf_sv, SvEND(datasv), correct_length);
4386 SvCUR_set(datasv, SvCUR(datasv) + correct_length);
4389 const char *s = SvEND(datasv);
4390 const char *send = SvPVX(datasv) + SvLEN(datasv);
4398 if (s == send) return 0; /* eof */
4399 sv_catpvn(buf_sv, SvEND(datasv), s-SvEND(datasv));
4400 SvCUR_set(datasv, s-SvPVX(datasv));
4402 return SvCUR(buf_sv);
4404 /* Get function pointer hidden within datasv */
4405 funcp = DPTR2FPTR(filter_t, IoANY(datasv));
4406 DEBUG_P(PerlIO_printf(Perl_debug_log,
4407 "filter_read %d: via function %p (%s)\n",
4408 idx, (void*)datasv, SvPV_nolen_const(datasv)));
4409 /* Call function. The function is expected to */
4410 /* call "FILTER_READ(idx+1, buf_sv)" first. */
4411 /* Return: <0:error, =0:eof, >0:not eof */
4412 return (*funcp)(aTHX_ idx, buf_sv, correct_length);
4416 S_filter_gets(pTHX_ SV *sv, STRLEN append)
4420 PERL_ARGS_ASSERT_FILTER_GETS;
4422 #ifdef PERL_CR_FILTER
4423 if (!PL_rsfp_filters) {
4424 filter_add(S_cr_textfilter,NULL);
4427 if (PL_rsfp_filters) {
4429 SvCUR_set(sv, 0); /* start with empty line */
4430 if (FILTER_READ(0, sv, 0) > 0)
4431 return ( SvPVX(sv) ) ;
4436 return (sv_gets(sv, PL_rsfp, append));
4440 S_find_in_my_stash(pTHX_ const char *pkgname, STRLEN len)
4445 PERL_ARGS_ASSERT_FIND_IN_MY_STASH;
4447 if (len == 11 && *pkgname == '_' && strEQ(pkgname, "__PACKAGE__"))