3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 * 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
12 * 'It all comes from here, the stench and the peril.' --Frodo
14 * [p.719 of _The Lord of the Rings_, IV/ix: "Shelob's Lair"]
18 * This file is the lexer for Perl. It's closely linked to the
21 * The main routine is yylex(), which returns the next token.
25 =head1 Lexer interface
26 This is the lower layer of the Perl parser, managing characters and tokens.
28 =for apidoc AmnU|yy_parser *|PL_parser
30 Pointer to a structure encapsulating the state of the parsing operation
31 currently in progress. The pointer can be locally changed to perform
32 a nested parse without interfering with the state of an outer parse.
33 Individual members of C<PL_parser> have their own documentation.
39 #define PERL_IN_TOKE_C
41 #include "dquote_inline.h"
42 #include "invlist_inline.h"
44 #define new_constant(a,b,c,d,e,f,g, h) \
45 S_new_constant(aTHX_ a,b,STR_WITH_LEN(c),d,e,f, g, h)
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_dojoin (PL_parser->lex_dojoin)
57 #define PL_lex_formbrack (PL_parser->lex_formbrack)
58 #define PL_lex_inpat (PL_parser->lex_inpat)
59 #define PL_lex_inwhat (PL_parser->lex_inwhat)
60 #define PL_lex_op (PL_parser->lex_op)
61 #define PL_lex_repl (PL_parser->lex_repl)
62 #define PL_lex_starts (PL_parser->lex_starts)
63 #define PL_lex_stuff (PL_parser->lex_stuff)
64 #define PL_multi_start (PL_parser->multi_start)
65 #define PL_multi_open (PL_parser->multi_open)
66 #define PL_multi_close (PL_parser->multi_close)
67 #define PL_preambled (PL_parser->preambled)
68 #define PL_linestr (PL_parser->linestr)
69 #define PL_expect (PL_parser->expect)
70 #define PL_copline (PL_parser->copline)
71 #define PL_bufptr (PL_parser->bufptr)
72 #define PL_oldbufptr (PL_parser->oldbufptr)
73 #define PL_oldoldbufptr (PL_parser->oldoldbufptr)
74 #define PL_linestart (PL_parser->linestart)
75 #define PL_bufend (PL_parser->bufend)
76 #define PL_last_uni (PL_parser->last_uni)
77 #define PL_last_lop (PL_parser->last_lop)
78 #define PL_last_lop_op (PL_parser->last_lop_op)
79 #define PL_lex_state (PL_parser->lex_state)
80 #define PL_rsfp (PL_parser->rsfp)
81 #define PL_rsfp_filters (PL_parser->rsfp_filters)
82 #define PL_in_my (PL_parser->in_my)
83 #define PL_in_my_stash (PL_parser->in_my_stash)
84 #define PL_tokenbuf (PL_parser->tokenbuf)
85 #define PL_multi_end (PL_parser->multi_end)
86 #define PL_error_count (PL_parser->error_count)
88 # define PL_nexttoke (PL_parser->nexttoke)
89 # define PL_nexttype (PL_parser->nexttype)
90 # define PL_nextval (PL_parser->nextval)
93 #define SvEVALED(sv) \
94 (SvTYPE(sv) >= SVt_PVNV \
95 && ((XPVIV*)SvANY(sv))->xiv_u.xivu_eval_seen)
97 static const char* const ident_too_long = "Identifier too long";
99 # define NEXTVAL_NEXTTOKE PL_nextval[PL_nexttoke]
101 #define XENUMMASK 0x3f
102 #define XFAKEEOF 0x40
103 #define XFAKEBRACK 0x80
105 #ifdef USE_UTF8_SCRIPTS
106 # define UTF cBOOL(!IN_BYTES)
108 # define UTF cBOOL((PL_linestr && DO_UTF8(PL_linestr)) || ( !(PL_parser->lex_flags & LEX_IGNORE_UTF8_HINTS) && (PL_hints & HINT_UTF8)))
111 /* The maximum number of characters preceding the unrecognized one to display */
112 #define UNRECOGNIZED_PRECEDE_COUNT 10
114 /* In variables named $^X, these are the legal values for X.
115 * 1999-02-27 mjd-perl-patch@plover.com */
116 #define isCONTROLVAR(x) (isUPPER(x) || memCHRs("[\\]^_?", (x)))
118 #define SPACE_OR_TAB(c) isBLANK_A(c)
120 #define HEXFP_PEEK(s) \
122 (isXDIGIT(s[1]) || isALPHA_FOLD_EQ(s[1], 'p'))) || \
123 isALPHA_FOLD_EQ(s[0], 'p'))
125 /* LEX_* are values for PL_lex_state, the state of the lexer.
126 * They are arranged oddly so that the guard on the switch statement
127 * can get by with a single comparison (if the compiler is smart enough).
129 * These values refer to the various states within a sublex parse,
130 * i.e. within a double quotish string
133 /* #define LEX_NOTPARSING 11 is done in perl.h. */
135 #define LEX_NORMAL 10 /* normal code (ie not within "...") */
136 #define LEX_INTERPNORMAL 9 /* code within a string, eg "$foo[$x+1]" */
137 #define LEX_INTERPCASEMOD 8 /* expecting a \U, \Q or \E etc */
138 #define LEX_INTERPPUSH 7 /* starting a new sublex parse level */
139 #define LEX_INTERPSTART 6 /* expecting the start of a $var */
141 /* at end of code, eg "$x" followed by: */
142 #define LEX_INTERPEND 5 /* ... eg not one of [, { or -> */
143 #define LEX_INTERPENDMAYBE 4 /* ... eg one of [, { or -> */
145 #define LEX_INTERPCONCAT 3 /* expecting anything, eg at start of
146 string or after \E, $foo, etc */
147 #define LEX_INTERPCONST 2 /* NOT USED */
148 #define LEX_FORMLINE 1 /* expecting a format line */
152 static const char* const lex_state_names[] = {
167 #include "keywords.h"
169 /* CLINE is a macro that ensures PL_copline has a sane value */
171 #define CLINE (PL_copline = (CopLINE(PL_curcop) < PL_copline ? CopLINE(PL_curcop) : PL_copline))
174 * Convenience functions to return different tokens and prime the
175 * lexer for the next token. They all take an argument.
177 * TOKEN : generic token (used for '(', DOLSHARP, etc)
178 * OPERATOR : generic operator
179 * AOPERATOR : assignment operator
180 * PREBLOCK : beginning the block after an if, while, foreach, ...
181 * PRETERMBLOCK : beginning a non-code-defining {} block (eg, hash ref)
182 * PREREF : *EXPR where EXPR is not a simple identifier
183 * TERM : expression term
184 * POSTDEREF : postfix dereference (->$* ->@[...] etc.)
185 * LOOPX : loop exiting command (goto, last, dump, etc)
186 * FTST : file test operator
187 * FUN0 : zero-argument function
188 * FUN0OP : zero-argument function, with its op created in this file
189 * FUN1 : not used, except for not, which isn't a UNIOP
190 * BOop : bitwise or or xor
192 * BCop : bitwise complement
193 * SHop : shift operator
194 * PWop : power operator
195 * PMop : pattern-matching operator
196 * Aop : addition-level operator
197 * AopNOASSIGN : addition-level operator that is never part of .=
198 * Mop : multiplication-level operator
199 * Eop : equality-testing operator
200 * Rop : relational operator <= != gt
202 * Also see LOP and lop() below.
205 #ifdef DEBUGGING /* Serve -DT. */
206 # define REPORT(retval) tokereport((I32)retval, &pl_yylval)
208 # define REPORT(retval) (retval)
211 #define TOKEN(retval) return ( PL_bufptr = s, REPORT(retval))
212 #define OPERATOR(retval) return (PL_expect = XTERM, PL_bufptr = s, REPORT(retval))
213 #define AOPERATOR(retval) return ao((PL_expect = XTERM, PL_bufptr = s, retval))
214 #define PREBLOCK(retval) return (PL_expect = XBLOCK,PL_bufptr = s, REPORT(retval))
215 #define PRETERMBLOCK(retval) return (PL_expect = XTERMBLOCK,PL_bufptr = s, REPORT(retval))
216 #define PREREF(retval) return (PL_expect = XREF,PL_bufptr = s, REPORT(retval))
217 #define TERM(retval) return (CLINE, PL_expect = XOPERATOR, PL_bufptr = s, REPORT(retval))
218 #define POSTDEREF(f) return (PL_bufptr = s, S_postderef(aTHX_ REPORT(f),s[1]))
219 #define LOOPX(f) return (PL_bufptr = force_word(s,BAREWORD,TRUE,FALSE), \
221 PL_expect = PL_nexttoke ? XOPERATOR : XTERM, \
223 #define FTST(f) return (pl_yylval.ival=f, PL_expect=XTERMORDORDOR, PL_bufptr=s, REPORT((int)UNIOP))
224 #define FUN0(f) return (pl_yylval.ival=f, PL_expect=XOPERATOR, PL_bufptr=s, REPORT((int)FUNC0))
225 #define FUN0OP(f) return (pl_yylval.opval=f, CLINE, PL_expect=XOPERATOR, PL_bufptr=s, REPORT((int)FUNC0OP))
226 #define FUN1(f) return (pl_yylval.ival=f, PL_expect=XOPERATOR, PL_bufptr=s, REPORT((int)FUNC1))
227 #define BOop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, (int)BITOROP))
228 #define BAop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, (int)BITANDOP))
229 #define BCop(f) return pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr = s, \
231 #define SHop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, (int)SHIFTOP))
232 #define PWop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, (int)POWOP))
233 #define PMop(f) return(pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)MATCHOP))
234 #define Aop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, (int)ADDOP))
235 #define AopNOASSIGN(f) return (pl_yylval.ival=f, PL_bufptr=s, REPORT((int)ADDOP))
236 #define Mop(f) return ao((pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, (int)MULOP))
237 #define Eop(f) return (pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)EQOP))
238 #define Rop(f) return (pl_yylval.ival=f, PL_expect=XTERM, PL_bufptr=s, REPORT((int)RELOP))
240 /* This bit of chicanery makes a unary function followed by
241 * a parenthesis into a function with one argument, highest precedence.
242 * The UNIDOR macro is for unary functions that can be followed by the //
243 * operator (such as C<shift // 0>).
245 #define UNI3(f,x,have_x) { \
246 pl_yylval.ival = f; \
247 if (have_x) PL_expect = x; \
249 PL_last_uni = PL_oldbufptr; \
250 PL_last_lop_op = (f) < 0 ? -(f) : (f); \
252 return REPORT( (int)FUNC1 ); \
254 return REPORT( *s=='(' ? (int)FUNC1 : (int)UNIOP ); \
256 #define UNI(f) UNI3(f,XTERM,1)
257 #define UNIDOR(f) UNI3(f,XTERMORDORDOR,1)
258 #define UNIPROTO(f,optional) { \
259 if (optional) PL_last_uni = PL_oldbufptr; \
263 #define UNIBRACK(f) UNI3(f,0,0)
265 /* grandfather return to old style */
268 if (!PL_lex_allbrackets && PL_lex_fakeeof > LEX_FAKEEOF_LOWLOGIC) \
269 PL_lex_fakeeof = LEX_FAKEEOF_LOWLOGIC; \
270 pl_yylval.ival = (f); \
276 #define COPLINE_INC_WITH_HERELINES \
278 CopLINE_inc(PL_curcop); \
279 if (PL_parser->herelines) \
280 CopLINE(PL_curcop) += PL_parser->herelines, \
281 PL_parser->herelines = 0; \
283 /* Called after scan_str to update CopLINE(PL_curcop), but only when there
284 * is no sublex_push to follow. */
285 #define COPLINE_SET_FROM_MULTI_END \
287 CopLINE_set(PL_curcop, PL_multi_end); \
288 if (PL_multi_end != PL_multi_start) \
289 PL_parser->herelines = 0; \
293 /* A file-local structure for passing around information about subroutines and
294 * related definable words */
304 static const struct code no_code = { NULL, NULL, NULL, NULL, NULL, 0, FALSE };
309 /* how to interpret the pl_yylval associated with the token */
313 TOKENTYPE_OPNUM, /* pl_yylval.ival contains an opcode number */
318 static struct debug_tokens {
320 enum token_type type;
322 } const debug_tokens[] =
324 { ADDOP, TOKENTYPE_OPNUM, "ADDOP" },
325 { ANDAND, TOKENTYPE_NONE, "ANDAND" },
326 { ANDOP, TOKENTYPE_NONE, "ANDOP" },
327 { ANONSUB, TOKENTYPE_IVAL, "ANONSUB" },
328 { ANON_SIGSUB, TOKENTYPE_IVAL, "ANON_SIGSUB" },
329 { ARROW, TOKENTYPE_NONE, "ARROW" },
330 { ASSIGNOP, TOKENTYPE_OPNUM, "ASSIGNOP" },
331 { BITANDOP, TOKENTYPE_OPNUM, "BITANDOP" },
332 { BITOROP, TOKENTYPE_OPNUM, "BITOROP" },
333 { COLONATTR, TOKENTYPE_NONE, "COLONATTR" },
334 { CONTINUE, TOKENTYPE_NONE, "CONTINUE" },
335 { DEFAULT, TOKENTYPE_NONE, "DEFAULT" },
336 { DO, TOKENTYPE_NONE, "DO" },
337 { DOLSHARP, TOKENTYPE_NONE, "DOLSHARP" },
338 { DORDOR, TOKENTYPE_NONE, "DORDOR" },
339 { DOROP, TOKENTYPE_OPNUM, "DOROP" },
340 { DOTDOT, TOKENTYPE_IVAL, "DOTDOT" },
341 { ELSE, TOKENTYPE_NONE, "ELSE" },
342 { ELSIF, TOKENTYPE_IVAL, "ELSIF" },
343 { EQOP, TOKENTYPE_OPNUM, "EQOP" },
344 { FOR, TOKENTYPE_IVAL, "FOR" },
345 { FORMAT, TOKENTYPE_NONE, "FORMAT" },
346 { FORMLBRACK, TOKENTYPE_NONE, "FORMLBRACK" },
347 { FORMRBRACK, TOKENTYPE_NONE, "FORMRBRACK" },
348 { FUNC, TOKENTYPE_OPNUM, "FUNC" },
349 { FUNC0, TOKENTYPE_OPNUM, "FUNC0" },
350 { FUNC0OP, TOKENTYPE_OPVAL, "FUNC0OP" },
351 { FUNC0SUB, TOKENTYPE_OPVAL, "FUNC0SUB" },
352 { FUNC1, TOKENTYPE_OPNUM, "FUNC1" },
353 { FUNCMETH, TOKENTYPE_OPVAL, "FUNCMETH" },
354 { GIVEN, TOKENTYPE_IVAL, "GIVEN" },
355 { HASHBRACK, TOKENTYPE_NONE, "HASHBRACK" },
356 { IF, TOKENTYPE_IVAL, "IF" },
357 { LABEL, TOKENTYPE_OPVAL, "LABEL" },
358 { LOCAL, TOKENTYPE_IVAL, "LOCAL" },
359 { LOOPEX, TOKENTYPE_OPNUM, "LOOPEX" },
360 { LSTOP, TOKENTYPE_OPNUM, "LSTOP" },
361 { LSTOPSUB, TOKENTYPE_OPVAL, "LSTOPSUB" },
362 { MATCHOP, TOKENTYPE_OPNUM, "MATCHOP" },
363 { METHOD, TOKENTYPE_OPVAL, "METHOD" },
364 { MULOP, TOKENTYPE_OPNUM, "MULOP" },
365 { MY, TOKENTYPE_IVAL, "MY" },
366 { NOAMP, TOKENTYPE_NONE, "NOAMP" },
367 { NOTOP, TOKENTYPE_NONE, "NOTOP" },
368 { OROP, TOKENTYPE_IVAL, "OROP" },
369 { OROR, TOKENTYPE_NONE, "OROR" },
370 { PACKAGE, TOKENTYPE_NONE, "PACKAGE" },
371 { PLUGEXPR, TOKENTYPE_OPVAL, "PLUGEXPR" },
372 { PLUGSTMT, TOKENTYPE_OPVAL, "PLUGSTMT" },
373 { PMFUNC, TOKENTYPE_OPVAL, "PMFUNC" },
374 { POSTJOIN, TOKENTYPE_NONE, "POSTJOIN" },
375 { POSTDEC, TOKENTYPE_NONE, "POSTDEC" },
376 { POSTINC, TOKENTYPE_NONE, "POSTINC" },
377 { POWOP, TOKENTYPE_OPNUM, "POWOP" },
378 { PREDEC, TOKENTYPE_NONE, "PREDEC" },
379 { PREINC, TOKENTYPE_NONE, "PREINC" },
380 { PRIVATEREF, TOKENTYPE_OPVAL, "PRIVATEREF" },
381 { QWLIST, TOKENTYPE_OPVAL, "QWLIST" },
382 { REFGEN, TOKENTYPE_NONE, "REFGEN" },
383 { RELOP, TOKENTYPE_OPNUM, "RELOP" },
384 { REQUIRE, TOKENTYPE_NONE, "REQUIRE" },
385 { SHIFTOP, TOKENTYPE_OPNUM, "SHIFTOP" },
386 { SIGSUB, TOKENTYPE_NONE, "SIGSUB" },
387 { SUB, TOKENTYPE_NONE, "SUB" },
388 { SUBLEXEND, TOKENTYPE_NONE, "SUBLEXEND" },
389 { SUBLEXSTART, TOKENTYPE_NONE, "SUBLEXSTART" },
390 { THING, TOKENTYPE_OPVAL, "THING" },
391 { UMINUS, TOKENTYPE_NONE, "UMINUS" },
392 { UNIOP, TOKENTYPE_OPNUM, "UNIOP" },
393 { UNIOPSUB, TOKENTYPE_OPVAL, "UNIOPSUB" },
394 { UNLESS, TOKENTYPE_IVAL, "UNLESS" },
395 { UNTIL, TOKENTYPE_IVAL, "UNTIL" },
396 { USE, TOKENTYPE_IVAL, "USE" },
397 { WHEN, TOKENTYPE_IVAL, "WHEN" },
398 { WHILE, TOKENTYPE_IVAL, "WHILE" },
399 { BAREWORD, TOKENTYPE_OPVAL, "BAREWORD" },
400 { YADAYADA, TOKENTYPE_IVAL, "YADAYADA" },
401 { 0, TOKENTYPE_NONE, NULL }
404 /* dump the returned token in rv, plus any optional arg in pl_yylval */
407 S_tokereport(pTHX_ I32 rv, const YYSTYPE* lvalp)
409 PERL_ARGS_ASSERT_TOKEREPORT;
412 const char *name = NULL;
413 enum token_type type = TOKENTYPE_NONE;
414 const struct debug_tokens *p;
415 SV* const report = newSVpvs("<== ");
417 for (p = debug_tokens; p->token; p++) {
418 if (p->token == (int)rv) {
425 Perl_sv_catpv(aTHX_ report, name);
426 else if (isGRAPH(rv))
428 Perl_sv_catpvf(aTHX_ report, "'%c'", (char)rv);
430 sv_catpvs(report, " (pending identifier)");
433 sv_catpvs(report, "EOF");
435 Perl_sv_catpvf(aTHX_ report, "?? %" IVdf, (IV)rv);
440 Perl_sv_catpvf(aTHX_ report, "(ival=%" IVdf ")", (IV)lvalp->ival);
442 case TOKENTYPE_OPNUM:
443 Perl_sv_catpvf(aTHX_ report, "(ival=op_%s)",
444 PL_op_name[lvalp->ival]);
447 Perl_sv_catpvf(aTHX_ report, "(pval=\"%s\")", lvalp->pval);
449 case TOKENTYPE_OPVAL:
451 Perl_sv_catpvf(aTHX_ report, "(opval=op_%s)",
452 PL_op_name[lvalp->opval->op_type]);
453 if (lvalp->opval->op_type == OP_CONST) {
454 Perl_sv_catpvf(aTHX_ report, " %s",
455 SvPEEK(cSVOPx_sv(lvalp->opval)));
460 sv_catpvs(report, "(opval=null)");
463 PerlIO_printf(Perl_debug_log, "### %s\n\n", SvPV_nolen_const(report));
469 /* print the buffer with suitable escapes */
472 S_printbuf(pTHX_ const char *const fmt, const char *const s)
474 SV* const tmp = newSVpvs("");
476 PERL_ARGS_ASSERT_PRINTBUF;
478 GCC_DIAG_IGNORE_STMT(-Wformat-nonliteral); /* fmt checked by caller */
479 PerlIO_printf(Perl_debug_log, fmt, pv_display(tmp, s, strlen(s), 0, 60));
480 GCC_DIAG_RESTORE_STMT;
489 * This subroutine looks for an '=' next to the operator that has just been
490 * parsed and turns it into an ASSIGNOP if it finds one.
494 S_ao(pTHX_ int toketype)
496 if (*PL_bufptr == '=') {
498 if (toketype == ANDAND)
499 pl_yylval.ival = OP_ANDASSIGN;
500 else if (toketype == OROR)
501 pl_yylval.ival = OP_ORASSIGN;
502 else if (toketype == DORDOR)
503 pl_yylval.ival = OP_DORASSIGN;
506 return REPORT(toketype);
511 * When Perl expects an operator and finds something else, no_op
512 * prints the warning. It always prints "<something> found where
513 * operator expected. It prints "Missing semicolon on previous line?"
514 * if the surprise occurs at the start of the line. "do you need to
515 * predeclare ..." is printed out for code like "sub bar; foo bar $x"
516 * where the compiler doesn't know if foo is a method call or a function.
517 * It prints "Missing operator before end of line" if there's nothing
518 * after the missing operator, or "... before <...>" if there is something
519 * after the missing operator.
521 * PL_bufptr is expected to point to the start of the thing that was found,
522 * and s after the next token or partial token.
526 S_no_op(pTHX_ const char *const what, char *s)
528 char * const oldbp = PL_bufptr;
529 const bool is_first = (PL_oldbufptr == PL_linestart);
531 PERL_ARGS_ASSERT_NO_OP;
537 yywarn(Perl_form(aTHX_ "%s found where operator expected", what), UTF ? SVf_UTF8 : 0);
538 if (ckWARN_d(WARN_SYNTAX)) {
540 Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
541 "\t(Missing semicolon on previous line?)\n");
542 else if (PL_oldoldbufptr && isIDFIRST_lazy_if_safe(PL_oldoldbufptr,
547 for (t = PL_oldoldbufptr;
548 (isWORDCHAR_lazy_if_safe(t, PL_bufend, UTF) || *t == ':');
549 t += UTF ? UTF8SKIP(t) : 1)
553 if (t < PL_bufptr && isSPACE(*t))
554 Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
555 "\t(Do you need to predeclare %" UTF8f "?)\n",
556 UTF8fARG(UTF, t - PL_oldoldbufptr, PL_oldoldbufptr));
560 Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
561 "\t(Missing operator before %" UTF8f "?)\n",
562 UTF8fARG(UTF, s - oldbp, oldbp));
570 * Complain about missing quote/regexp/heredoc terminator.
571 * If it's called with NULL then it cauterizes the line buffer.
572 * If we're in a delimited string and the delimiter is a control
573 * character, it's reformatted into a two-char sequence like ^C.
578 S_missingterm(pTHX_ char *s, STRLEN len)
580 char tmpbuf[UTF8_MAXBYTES + 1];
585 char * const nl = (char *) my_memrchr(s, '\n', len);
592 else if (PL_multi_close < 32) {
594 tmpbuf[1] = (char)toCTRL(PL_multi_close);
600 if (LIKELY(PL_multi_close < 256)) {
601 *tmpbuf = (char)PL_multi_close;
606 char *end = (char *)uvchr_to_utf8((U8 *)tmpbuf, PL_multi_close);
613 q = memchr(s, '"', len) ? '\'' : '"';
614 sv = sv_2mortal(newSVpvn(s, len));
617 Perl_croak(aTHX_ "Can't find string terminator %c%" SVf "%c"
618 " anywhere before EOF", q, SVfARG(sv), q);
624 * experimental text filters for win32 carriage-returns, utf16-to-utf8 and
625 * utf16-to-utf8-reversed.
628 #ifdef PERL_CR_FILTER
632 const char *s = SvPVX_const(sv);
633 const char * const e = s + SvCUR(sv);
635 PERL_ARGS_ASSERT_STRIP_RETURN;
637 /* outer loop optimized to do nothing if there are no CR-LFs */
639 if (*s++ == '\r' && *s == '\n') {
640 /* hit a CR-LF, need to copy the rest */
644 if (*s == '\r' && s[1] == '\n')
655 S_cr_textfilter(pTHX_ int idx, SV *sv, int maxlen)
657 const I32 count = FILTER_READ(idx+1, sv, maxlen);
658 if (count > 0 && !maxlen)
665 =for apidoc lex_start
667 Creates and initialises a new lexer/parser state object, supplying
668 a context in which to lex and parse from a new source of Perl code.
669 A pointer to the new state object is placed in L</PL_parser>. An entry
670 is made on the save stack so that upon unwinding, the new state object
671 will be destroyed and the former value of L</PL_parser> will be restored.
672 Nothing else need be done to clean up the parsing context.
674 The code to be parsed comes from C<line> and C<rsfp>. C<line>, if
675 non-null, provides a string (in SV form) containing code to be parsed.
676 A copy of the string is made, so subsequent modification of C<line>
677 does not affect parsing. C<rsfp>, if non-null, provides an input stream
678 from which code will be read to be parsed. If both are non-null, the
679 code in C<line> comes first and must consist of complete lines of input,
680 and C<rsfp> supplies the remainder of the source.
682 The C<flags> parameter is reserved for future use. Currently it is only
683 used by perl internally, so extensions should always pass zero.
688 /* LEX_START_SAME_FILTER indicates that this is not a new file, so it
689 can share filters with the current parser.
690 LEX_START_DONT_CLOSE indicates that the file handle wasn't opened by the
691 caller, hence isn't owned by the parser, so shouldn't be closed on parser
692 destruction. This is used to handle the case of defaulting to reading the
693 script from the standard input because no filename was given on the command
694 line (without getting confused by situation where STDIN has been closed, so
695 the script handle is opened on fd 0) */
698 Perl_lex_start(pTHX_ SV *line, PerlIO *rsfp, U32 flags)
700 const char *s = NULL;
701 yy_parser *parser, *oparser;
703 if (flags && flags & ~LEX_START_FLAGS)
704 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_start");
706 /* create and initialise a parser */
708 Newxz(parser, 1, yy_parser);
709 parser->old_parser = oparser = PL_parser;
712 parser->stack = NULL;
713 parser->stack_max1 = NULL;
716 /* on scope exit, free this parser and restore any outer one */
718 parser->saved_curcop = PL_curcop;
720 /* initialise lexer state */
722 parser->nexttoke = 0;
723 parser->error_count = oparser ? oparser->error_count : 0;
724 parser->copline = parser->preambling = NOLINE;
725 parser->lex_state = LEX_NORMAL;
726 parser->expect = XSTATE;
728 parser->recheck_utf8_validity = TRUE;
729 parser->rsfp_filters =
730 !(flags & LEX_START_SAME_FILTER) || !oparser
732 : MUTABLE_AV(SvREFCNT_inc(
733 oparser->rsfp_filters
734 ? oparser->rsfp_filters
735 : (oparser->rsfp_filters = newAV())
738 Newx(parser->lex_brackstack, 120, char);
739 Newx(parser->lex_casestack, 12, char);
740 *parser->lex_casestack = '\0';
741 Newxz(parser->lex_shared, 1, LEXSHARED);
745 const U8* first_bad_char_loc;
747 s = SvPV_const(line, len);
750 && UNLIKELY(! is_utf8_string_loc((U8 *) s,
752 &first_bad_char_loc)))
754 _force_out_malformed_utf8_message(first_bad_char_loc,
755 (U8 *) s + SvCUR(line),
757 1 /* 1 means die */ );
758 NOT_REACHED; /* NOTREACHED */
761 parser->linestr = flags & LEX_START_COPIED
762 ? SvREFCNT_inc_simple_NN(line)
763 : newSVpvn_flags(s, len, SvUTF8(line));
765 sv_catpvs(parser->linestr, "\n;");
767 parser->linestr = newSVpvn("\n;", rsfp ? 1 : 2);
770 parser->oldoldbufptr =
773 parser->linestart = SvPVX(parser->linestr);
774 parser->bufend = parser->bufptr + SvCUR(parser->linestr);
775 parser->last_lop = parser->last_uni = NULL;
777 STATIC_ASSERT_STMT(FITS_IN_8_BITS(LEX_IGNORE_UTF8_HINTS|LEX_EVALBYTES
778 |LEX_DONT_CLOSE_RSFP));
779 parser->lex_flags = (U8) (flags & (LEX_IGNORE_UTF8_HINTS|LEX_EVALBYTES
780 |LEX_DONT_CLOSE_RSFP));
782 parser->in_pod = parser->filtered = 0;
786 /* delete a parser object */
789 Perl_parser_free(pTHX_ const yy_parser *parser)
791 PERL_ARGS_ASSERT_PARSER_FREE;
793 PL_curcop = parser->saved_curcop;
794 SvREFCNT_dec(parser->linestr);
796 if (PL_parser->lex_flags & LEX_DONT_CLOSE_RSFP)
797 PerlIO_clearerr(parser->rsfp);
798 else if (parser->rsfp && (!parser->old_parser
799 || (parser->old_parser && parser->rsfp != parser->old_parser->rsfp)))
800 PerlIO_close(parser->rsfp);
801 SvREFCNT_dec(parser->rsfp_filters);
802 SvREFCNT_dec(parser->lex_stuff);
803 SvREFCNT_dec(parser->lex_sub_repl);
805 Safefree(parser->lex_brackstack);
806 Safefree(parser->lex_casestack);
807 Safefree(parser->lex_shared);
808 PL_parser = parser->old_parser;
813 Perl_parser_free_nexttoke_ops(pTHX_ yy_parser *parser, OPSLAB *slab)
815 I32 nexttoke = parser->nexttoke;
816 PERL_ARGS_ASSERT_PARSER_FREE_NEXTTOKE_OPS;
818 if (S_is_opval_token(parser->nexttype[nexttoke] & 0xffff)
819 && parser->nextval[nexttoke].opval
820 && parser->nextval[nexttoke].opval->op_slabbed
821 && OpSLAB(parser->nextval[nexttoke].opval) == slab) {
822 op_free(parser->nextval[nexttoke].opval);
823 parser->nextval[nexttoke].opval = NULL;
830 =for apidoc AmnxUN|SV *|PL_parser-E<gt>linestr
832 Buffer scalar containing the chunk currently under consideration of the
833 text currently being lexed. This is always a plain string scalar (for
834 which C<SvPOK> is true). It is not intended to be used as a scalar by
835 normal scalar means; instead refer to the buffer directly by the pointer
836 variables described below.
838 The lexer maintains various C<char*> pointers to things in the
839 C<PL_parser-E<gt>linestr> buffer. If C<PL_parser-E<gt>linestr> is ever
840 reallocated, all of these pointers must be updated. Don't attempt to
841 do this manually, but rather use L</lex_grow_linestr> if you need to
842 reallocate the buffer.
844 The content of the text chunk in the buffer is commonly exactly one
845 complete line of input, up to and including a newline terminator,
846 but there are situations where it is otherwise. The octets of the
847 buffer may be intended to be interpreted as either UTF-8 or Latin-1.
848 The function L</lex_bufutf8> tells you which. Do not use the C<SvUTF8>
849 flag on this scalar, which may disagree with it.
851 For direct examination of the buffer, the variable
852 L</PL_parser-E<gt>bufend> points to the end of the buffer. The current
853 lexing position is pointed to by L</PL_parser-E<gt>bufptr>. Direct use
854 of these pointers is usually preferable to examination of the scalar
855 through normal scalar means.
857 =for apidoc AmnxUN|char *|PL_parser-E<gt>bufend
859 Direct pointer to the end of the chunk of text currently being lexed, the
860 end of the lexer buffer. This is equal to C<SvPVX(PL_parser-E<gt>linestr)
861 + SvCUR(PL_parser-E<gt>linestr)>. A C<NUL> character (zero octet) is
862 always located at the end of the buffer, and does not count as part of
863 the buffer's contents.
865 =for apidoc AmnxUN|char *|PL_parser-E<gt>bufptr
867 Points to the current position of lexing inside the lexer buffer.
868 Characters around this point may be freely examined, within
869 the range delimited by C<SvPVX(L</PL_parser-E<gt>linestr>)> and
870 L</PL_parser-E<gt>bufend>. The octets of the buffer may be intended to be
871 interpreted as either UTF-8 or Latin-1, as indicated by L</lex_bufutf8>.
873 Lexing code (whether in the Perl core or not) moves this pointer past
874 the characters that it consumes. It is also expected to perform some
875 bookkeeping whenever a newline character is consumed. This movement
876 can be more conveniently performed by the function L</lex_read_to>,
877 which handles newlines appropriately.
879 Interpretation of the buffer's octets can be abstracted out by
880 using the slightly higher-level functions L</lex_peek_unichar> and
881 L</lex_read_unichar>.
883 =for apidoc AmnxUN|char *|PL_parser-E<gt>linestart
885 Points to the start of the current line inside the lexer buffer.
886 This is useful for indicating at which column an error occurred, and
887 not much else. This must be updated by any lexing code that consumes
888 a newline; the function L</lex_read_to> handles this detail.
894 =for apidoc lex_bufutf8
896 Indicates whether the octets in the lexer buffer
897 (L</PL_parser-E<gt>linestr>) should be interpreted as the UTF-8 encoding
898 of Unicode characters. If not, they should be interpreted as Latin-1
899 characters. This is analogous to the C<SvUTF8> flag for scalars.
901 In UTF-8 mode, it is not guaranteed that the lexer buffer actually
902 contains valid UTF-8. Lexing code must be robust in the face of invalid
905 The actual C<SvUTF8> flag of the L</PL_parser-E<gt>linestr> scalar
906 is significant, but not the whole story regarding the input character
907 encoding. Normally, when a file is being read, the scalar contains octets
908 and its C<SvUTF8> flag is off, but the octets should be interpreted as
909 UTF-8 if the C<use utf8> pragma is in effect. During a string eval,
910 however, the scalar may have the C<SvUTF8> flag on, and in this case its
911 octets should be interpreted as UTF-8 unless the C<use bytes> pragma
912 is in effect. This logic may change in the future; use this function
913 instead of implementing the logic yourself.
919 Perl_lex_bufutf8(pTHX)
925 =for apidoc lex_grow_linestr
927 Reallocates the lexer buffer (L</PL_parser-E<gt>linestr>) to accommodate
928 at least C<len> octets (including terminating C<NUL>). Returns a
929 pointer to the reallocated buffer. This is necessary before making
930 any direct modification of the buffer that would increase its length.
931 L</lex_stuff_pvn> provides a more convenient way to insert text into
934 Do not use C<SvGROW> or C<sv_grow> directly on C<PL_parser-E<gt>linestr>;
935 this function updates all of the lexer's variables that point directly
942 Perl_lex_grow_linestr(pTHX_ STRLEN len)
946 STRLEN bufend_pos, bufptr_pos, oldbufptr_pos, oldoldbufptr_pos;
947 STRLEN linestart_pos, last_uni_pos, last_lop_pos, re_eval_start_pos;
950 linestr = PL_parser->linestr;
951 buf = SvPVX(linestr);
952 if (len <= SvLEN(linestr))
955 /* Is the lex_shared linestr SV the same as the current linestr SV?
956 * Only in this case does re_eval_start need adjusting, since it
957 * points within lex_shared->ls_linestr's buffer */
958 current = ( !PL_parser->lex_shared->ls_linestr
959 || linestr == PL_parser->lex_shared->ls_linestr);
961 bufend_pos = PL_parser->bufend - buf;
962 bufptr_pos = PL_parser->bufptr - buf;
963 oldbufptr_pos = PL_parser->oldbufptr - buf;
964 oldoldbufptr_pos = PL_parser->oldoldbufptr - buf;
965 linestart_pos = PL_parser->linestart - buf;
966 last_uni_pos = PL_parser->last_uni ? PL_parser->last_uni - buf : 0;
967 last_lop_pos = PL_parser->last_lop ? PL_parser->last_lop - buf : 0;
968 re_eval_start_pos = (current && PL_parser->lex_shared->re_eval_start) ?
969 PL_parser->lex_shared->re_eval_start - buf : 0;
971 buf = sv_grow(linestr, len);
973 PL_parser->bufend = buf + bufend_pos;
974 PL_parser->bufptr = buf + bufptr_pos;
975 PL_parser->oldbufptr = buf + oldbufptr_pos;
976 PL_parser->oldoldbufptr = buf + oldoldbufptr_pos;
977 PL_parser->linestart = buf + linestart_pos;
978 if (PL_parser->last_uni)
979 PL_parser->last_uni = buf + last_uni_pos;
980 if (PL_parser->last_lop)
981 PL_parser->last_lop = buf + last_lop_pos;
982 if (current && PL_parser->lex_shared->re_eval_start)
983 PL_parser->lex_shared->re_eval_start = buf + re_eval_start_pos;
988 =for apidoc lex_stuff_pvn
990 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
991 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
992 reallocating the buffer if necessary. This means that lexing code that
993 runs later will see the characters as if they had appeared in the input.
994 It is not recommended to do this as part of normal parsing, and most
995 uses of this facility run the risk of the inserted characters being
996 interpreted in an unintended manner.
998 The string to be inserted is represented by C<len> octets starting
999 at C<pv>. These octets are interpreted as either UTF-8 or Latin-1,
1000 according to whether the C<LEX_STUFF_UTF8> flag is set in C<flags>.
1001 The characters are recoded for the lexer buffer, according to how the
1002 buffer is currently being interpreted (L</lex_bufutf8>). If a string
1003 to be inserted is available as a Perl scalar, the L</lex_stuff_sv>
1004 function is more convenient.
1006 =for apidoc Amnh||LEX_STUFF_UTF8
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 = variant_under_utf8_count((U8 *) pv,
1025 const char *p, *e = pv+len;;
1028 lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len+highhalf);
1029 bufptr = PL_parser->bufptr;
1030 Move(bufptr, bufptr+len+highhalf, PL_parser->bufend+1-bufptr, char);
1031 SvCUR_set(PL_parser->linestr,
1032 SvCUR(PL_parser->linestr) + len+highhalf);
1033 PL_parser->bufend += len+highhalf;
1034 for (p = pv; p != e; p++) {
1035 append_utf8_from_native_byte(*p, (U8 **) &bufptr);
1039 if (flags & LEX_STUFF_UTF8) {
1040 STRLEN highhalf = 0;
1041 const char *p, *e = pv+len;
1042 for (p = pv; p != e; p++) {
1044 if (UTF8_IS_ABOVE_LATIN1(c)) {
1045 Perl_croak(aTHX_ "Lexing code attempted to stuff "
1046 "non-Latin-1 character into Latin-1 input");
1047 } else if (UTF8_IS_NEXT_CHAR_DOWNGRADEABLE(p, e)) {
1050 } else assert(UTF8_IS_INVARIANT(c));
1054 lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len-highhalf);
1055 bufptr = PL_parser->bufptr;
1056 Move(bufptr, bufptr+len-highhalf, PL_parser->bufend+1-bufptr, char);
1057 SvCUR_set(PL_parser->linestr,
1058 SvCUR(PL_parser->linestr) + len-highhalf);
1059 PL_parser->bufend += len-highhalf;
1062 if (UTF8_IS_INVARIANT(*p)) {
1068 *bufptr++ = EIGHT_BIT_UTF8_TO_NATIVE(*p, *(p+1));
1074 lex_grow_linestr(SvCUR(PL_parser->linestr)+1+len);
1075 bufptr = PL_parser->bufptr;
1076 Move(bufptr, bufptr+len, PL_parser->bufend+1-bufptr, char);
1077 SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) + len);
1078 PL_parser->bufend += len;
1079 Copy(pv, bufptr, len, char);
1085 =for apidoc lex_stuff_pv
1087 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
1088 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
1089 reallocating the buffer if necessary. This means that lexing code that
1090 runs later will see the characters as if they had appeared in the input.
1091 It is not recommended to do this as part of normal parsing, and most
1092 uses of this facility run the risk of the inserted characters being
1093 interpreted in an unintended manner.
1095 The string to be inserted is represented by octets starting at C<pv>
1096 and continuing to the first nul. These octets are interpreted as either
1097 UTF-8 or Latin-1, according to whether the C<LEX_STUFF_UTF8> flag is set
1098 in C<flags>. The characters are recoded for the lexer buffer, according
1099 to how the buffer is currently being interpreted (L</lex_bufutf8>).
1100 If it is not convenient to nul-terminate a string to be inserted, the
1101 L</lex_stuff_pvn> function is more appropriate.
1107 Perl_lex_stuff_pv(pTHX_ const char *pv, U32 flags)
1109 PERL_ARGS_ASSERT_LEX_STUFF_PV;
1110 lex_stuff_pvn(pv, strlen(pv), flags);
1114 =for apidoc lex_stuff_sv
1116 Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
1117 immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
1118 reallocating the buffer if necessary. This means that lexing code that
1119 runs later will see the characters as if they had appeared in the input.
1120 It is not recommended to do this as part of normal parsing, and most
1121 uses of this facility run the risk of the inserted characters being
1122 interpreted in an unintended manner.
1124 The string to be inserted is the string value of C<sv>. The characters
1125 are recoded for the lexer buffer, according to how the buffer is currently
1126 being interpreted (L</lex_bufutf8>). If a string to be inserted is
1127 not already a Perl scalar, the L</lex_stuff_pvn> function avoids the
1128 need to construct a scalar.
1134 Perl_lex_stuff_sv(pTHX_ SV *sv, U32 flags)
1138 PERL_ARGS_ASSERT_LEX_STUFF_SV;
1140 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_stuff_sv");
1142 lex_stuff_pvn(pv, len, flags | (SvUTF8(sv) ? LEX_STUFF_UTF8 : 0));
1146 =for apidoc lex_unstuff
1148 Discards text about to be lexed, from L</PL_parser-E<gt>bufptr> up to
1149 C<ptr>. Text following C<ptr> will be moved, and the buffer shortened.
1150 This hides the discarded text from any lexing code that runs later,
1151 as if the text had never appeared.
1153 This is not the normal way to consume lexed text. For that, use
1160 Perl_lex_unstuff(pTHX_ char *ptr)
1164 PERL_ARGS_ASSERT_LEX_UNSTUFF;
1165 buf = PL_parser->bufptr;
1167 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_unstuff");
1170 bufend = PL_parser->bufend;
1172 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_unstuff");
1173 unstuff_len = ptr - buf;
1174 Move(ptr, buf, bufend+1-ptr, char);
1175 SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) - unstuff_len);
1176 PL_parser->bufend = bufend - unstuff_len;
1180 =for apidoc lex_read_to
1182 Consume text in the lexer buffer, from L</PL_parser-E<gt>bufptr> up
1183 to C<ptr>. This advances L</PL_parser-E<gt>bufptr> to match C<ptr>,
1184 performing the correct bookkeeping whenever a newline character is passed.
1185 This is the normal way to consume lexed text.
1187 Interpretation of the buffer's octets can be abstracted out by
1188 using the slightly higher-level functions L</lex_peek_unichar> and
1189 L</lex_read_unichar>.
1195 Perl_lex_read_to(pTHX_ char *ptr)
1198 PERL_ARGS_ASSERT_LEX_READ_TO;
1199 s = PL_parser->bufptr;
1200 if (ptr < s || ptr > PL_parser->bufend)
1201 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_to");
1202 for (; s != ptr; s++)
1204 COPLINE_INC_WITH_HERELINES;
1205 PL_parser->linestart = s+1;
1207 PL_parser->bufptr = ptr;
1211 =for apidoc lex_discard_to
1213 Discards the first part of the L</PL_parser-E<gt>linestr> buffer,
1214 up to C<ptr>. The remaining content of the buffer will be moved, and
1215 all pointers into the buffer updated appropriately. C<ptr> must not
1216 be later in the buffer than the position of L</PL_parser-E<gt>bufptr>:
1217 it is not permitted to discard text that has yet to be lexed.
1219 Normally it is not necessarily to do this directly, because it suffices to
1220 use the implicit discarding behaviour of L</lex_next_chunk> and things
1221 based on it. However, if a token stretches across multiple lines,
1222 and the lexing code has kept multiple lines of text in the buffer for
1223 that purpose, then after completion of the token it would be wise to
1224 explicitly discard the now-unneeded earlier lines, to avoid future
1225 multi-line tokens growing the buffer without bound.
1231 Perl_lex_discard_to(pTHX_ char *ptr)
1235 PERL_ARGS_ASSERT_LEX_DISCARD_TO;
1236 buf = SvPVX(PL_parser->linestr);
1238 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_discard_to");
1241 if (ptr > PL_parser->bufptr)
1242 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_discard_to");
1243 discard_len = ptr - buf;
1244 if (PL_parser->oldbufptr < ptr)
1245 PL_parser->oldbufptr = ptr;
1246 if (PL_parser->oldoldbufptr < ptr)
1247 PL_parser->oldoldbufptr = ptr;
1248 if (PL_parser->last_uni && PL_parser->last_uni < ptr)
1249 PL_parser->last_uni = NULL;
1250 if (PL_parser->last_lop && PL_parser->last_lop < ptr)
1251 PL_parser->last_lop = NULL;
1252 Move(ptr, buf, PL_parser->bufend+1-ptr, char);
1253 SvCUR_set(PL_parser->linestr, SvCUR(PL_parser->linestr) - discard_len);
1254 PL_parser->bufend -= discard_len;
1255 PL_parser->bufptr -= discard_len;
1256 PL_parser->oldbufptr -= discard_len;
1257 PL_parser->oldoldbufptr -= discard_len;
1258 if (PL_parser->last_uni)
1259 PL_parser->last_uni -= discard_len;
1260 if (PL_parser->last_lop)
1261 PL_parser->last_lop -= discard_len;
1265 Perl_notify_parser_that_changed_to_utf8(pTHX)
1267 /* Called when $^H is changed to indicate that HINT_UTF8 has changed from
1268 * off to on. At compile time, this has the effect of entering a 'use
1269 * utf8' section. This means that any input was not previously checked for
1270 * UTF-8 (because it was off), but now we do need to check it, or our
1271 * assumptions about the input being sane could be wrong, and we could
1272 * segfault. This routine just sets a flag so that the next time we look
1273 * at the input we do the well-formed UTF-8 check. If we aren't in the
1274 * proper phase, there may not be a parser object, but if there is, setting
1275 * the flag is harmless */
1278 PL_parser->recheck_utf8_validity = TRUE;
1283 =for apidoc lex_next_chunk
1285 Reads in the next chunk of text to be lexed, appending it to
1286 L</PL_parser-E<gt>linestr>. This should be called when lexing code has
1287 looked to the end of the current chunk and wants to know more. It is
1288 usual, but not necessary, for lexing to have consumed the entirety of
1289 the current chunk at this time.
1291 If L</PL_parser-E<gt>bufptr> is pointing to the very end of the current
1292 chunk (i.e., the current chunk has been entirely consumed), normally the
1293 current chunk will be discarded at the same time that the new chunk is
1294 read in. If C<flags> has the C<LEX_KEEP_PREVIOUS> bit set, the current chunk
1295 will not be discarded. If the current chunk has not been entirely
1296 consumed, then it will not be discarded regardless of the flag.
1298 Returns true if some new text was added to the buffer, or false if the
1299 buffer has reached the end of the input text.
1301 =for apidoc Amnh||LEX_KEEP_PREVIOUS
1306 #define LEX_FAKE_EOF 0x80000000
1307 #define LEX_NO_TERM 0x40000000 /* here-doc */
1310 Perl_lex_next_chunk(pTHX_ U32 flags)
1314 STRLEN old_bufend_pos, new_bufend_pos;
1315 STRLEN bufptr_pos, oldbufptr_pos, oldoldbufptr_pos;
1316 STRLEN linestart_pos, last_uni_pos, last_lop_pos;
1317 bool got_some_for_debugger = 0;
1320 if (flags & ~(LEX_KEEP_PREVIOUS|LEX_FAKE_EOF|LEX_NO_TERM))
1321 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_next_chunk");
1322 if (!(flags & LEX_NO_TERM) && PL_lex_inwhat)
1324 linestr = PL_parser->linestr;
1325 buf = SvPVX(linestr);
1326 if (!(flags & LEX_KEEP_PREVIOUS)
1327 && PL_parser->bufptr == PL_parser->bufend)
1329 old_bufend_pos = bufptr_pos = oldbufptr_pos = oldoldbufptr_pos = 0;
1331 if (PL_parser->last_uni != PL_parser->bufend)
1332 PL_parser->last_uni = NULL;
1333 if (PL_parser->last_lop != PL_parser->bufend)
1334 PL_parser->last_lop = NULL;
1335 last_uni_pos = last_lop_pos = 0;
1337 SvCUR_set(linestr, 0);
1339 old_bufend_pos = PL_parser->bufend - buf;
1340 bufptr_pos = PL_parser->bufptr - buf;
1341 oldbufptr_pos = PL_parser->oldbufptr - buf;
1342 oldoldbufptr_pos = PL_parser->oldoldbufptr - buf;
1343 linestart_pos = PL_parser->linestart - buf;
1344 last_uni_pos = PL_parser->last_uni ? PL_parser->last_uni - buf : 0;
1345 last_lop_pos = PL_parser->last_lop ? PL_parser->last_lop - buf : 0;
1347 if (flags & LEX_FAKE_EOF) {
1349 } else if (!PL_parser->rsfp && !PL_parser->filtered) {
1351 } else if (filter_gets(linestr, old_bufend_pos)) {
1353 got_some_for_debugger = 1;
1354 } else if (flags & LEX_NO_TERM) {
1357 if (!SvPOK(linestr)) /* can get undefined by filter_gets */
1360 /* End of real input. Close filehandle (unless it was STDIN),
1361 * then add implicit termination.
1363 if (PL_parser->lex_flags & LEX_DONT_CLOSE_RSFP)
1364 PerlIO_clearerr(PL_parser->rsfp);
1365 else if (PL_parser->rsfp)
1366 (void)PerlIO_close(PL_parser->rsfp);
1367 PL_parser->rsfp = NULL;
1368 PL_parser->in_pod = PL_parser->filtered = 0;
1369 if (!PL_in_eval && PL_minus_p) {
1371 /*{*/";}continue{print or die qq(-p destination: $!\\n);}");
1372 PL_minus_n = PL_minus_p = 0;
1373 } else if (!PL_in_eval && PL_minus_n) {
1374 sv_catpvs(linestr, /*{*/";}");
1377 sv_catpvs(linestr, ";");
1380 buf = SvPVX(linestr);
1381 new_bufend_pos = SvCUR(linestr);
1382 PL_parser->bufend = buf + new_bufend_pos;
1383 PL_parser->bufptr = buf + bufptr_pos;
1386 const U8* first_bad_char_loc;
1387 if (UNLIKELY(! is_utf8_string_loc(
1388 (U8 *) PL_parser->bufptr,
1389 PL_parser->bufend - PL_parser->bufptr,
1390 &first_bad_char_loc)))
1392 _force_out_malformed_utf8_message(first_bad_char_loc,
1393 (U8 *) PL_parser->bufend,
1395 1 /* 1 means die */ );
1396 NOT_REACHED; /* NOTREACHED */
1400 PL_parser->oldbufptr = buf + oldbufptr_pos;
1401 PL_parser->oldoldbufptr = buf + oldoldbufptr_pos;
1402 PL_parser->linestart = buf + linestart_pos;
1403 if (PL_parser->last_uni)
1404 PL_parser->last_uni = buf + last_uni_pos;
1405 if (PL_parser->last_lop)
1406 PL_parser->last_lop = buf + last_lop_pos;
1407 if (PL_parser->preambling != NOLINE) {
1408 CopLINE_set(PL_curcop, PL_parser->preambling + 1);
1409 PL_parser->preambling = NOLINE;
1411 if ( got_some_for_debugger
1412 && PERLDB_LINE_OR_SAVESRC
1413 && PL_curstash != PL_debstash)
1415 /* debugger active and we're not compiling the debugger code,
1416 * so store the line into the debugger's array of lines
1418 update_debugger_info(NULL, buf+old_bufend_pos,
1419 new_bufend_pos-old_bufend_pos);
1425 =for apidoc lex_peek_unichar
1427 Looks ahead one (Unicode) character in the text currently being lexed.
1428 Returns the codepoint (unsigned integer value) of the next character,
1429 or -1 if lexing has reached the end of the input text. To consume the
1430 peeked character, use L</lex_read_unichar>.
1432 If the next character is in (or extends into) the next chunk of input
1433 text, the next chunk will be read in. Normally the current chunk will be
1434 discarded at the same time, but if C<flags> has the C<LEX_KEEP_PREVIOUS>
1435 bit set, then the current chunk will not be discarded.
1437 If the input is being interpreted as UTF-8 and a UTF-8 encoding error
1438 is encountered, an exception is generated.
1444 Perl_lex_peek_unichar(pTHX_ U32 flags)
1448 if (flags & ~(LEX_KEEP_PREVIOUS))
1449 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_peek_unichar");
1450 s = PL_parser->bufptr;
1451 bufend = PL_parser->bufend;
1457 if (!lex_next_chunk(flags))
1459 s = PL_parser->bufptr;
1460 bufend = PL_parser->bufend;
1463 if (UTF8_IS_INVARIANT(head))
1465 if (UTF8_IS_START(head)) {
1466 len = UTF8SKIP(&head);
1467 while ((STRLEN)(bufend-s) < len) {
1468 if (!lex_next_chunk(flags | LEX_KEEP_PREVIOUS))
1470 s = PL_parser->bufptr;
1471 bufend = PL_parser->bufend;
1474 unichar = utf8n_to_uvchr((U8*)s, bufend-s, &retlen, UTF8_CHECK_ONLY);
1475 if (retlen == (STRLEN)-1) {
1476 _force_out_malformed_utf8_message((U8 *) s,
1479 1 /* 1 means die */ );
1480 NOT_REACHED; /* NOTREACHED */
1485 if (!lex_next_chunk(flags))
1487 s = PL_parser->bufptr;
1494 =for apidoc lex_read_unichar
1496 Reads the next (Unicode) character in the text currently being lexed.
1497 Returns the codepoint (unsigned integer value) of the character read,
1498 and moves L</PL_parser-E<gt>bufptr> past the character, or returns -1
1499 if lexing has reached the end of the input text. To non-destructively
1500 examine the next character, use L</lex_peek_unichar> instead.
1502 If the next character is in (or extends into) the next chunk of input
1503 text, the next chunk will be read in. Normally the current chunk will be
1504 discarded at the same time, but if C<flags> has the C<LEX_KEEP_PREVIOUS>
1505 bit set, then the current chunk will not be discarded.
1507 If the input is being interpreted as UTF-8 and a UTF-8 encoding error
1508 is encountered, an exception is generated.
1514 Perl_lex_read_unichar(pTHX_ U32 flags)
1517 if (flags & ~(LEX_KEEP_PREVIOUS))
1518 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_unichar");
1519 c = lex_peek_unichar(flags);
1522 COPLINE_INC_WITH_HERELINES;
1524 PL_parser->bufptr += UTF8SKIP(PL_parser->bufptr);
1526 ++(PL_parser->bufptr);
1532 =for apidoc lex_read_space
1534 Reads optional spaces, in Perl style, in the text currently being
1535 lexed. The spaces may include ordinary whitespace characters and
1536 Perl-style comments. C<#line> directives are processed if encountered.
1537 L</PL_parser-E<gt>bufptr> is moved past the spaces, so that it points
1538 at a non-space character (or the end of the input text).
1540 If spaces extend into the next chunk of input text, the next chunk will
1541 be read in. Normally the current chunk will be discarded at the same
1542 time, but if C<flags> has the C<LEX_KEEP_PREVIOUS> bit set, then the current
1543 chunk will not be discarded.
1548 #define LEX_NO_INCLINE 0x40000000
1549 #define LEX_NO_NEXT_CHUNK 0x80000000
1552 Perl_lex_read_space(pTHX_ U32 flags)
1555 const bool can_incline = !(flags & LEX_NO_INCLINE);
1556 bool need_incline = 0;
1557 if (flags & ~(LEX_KEEP_PREVIOUS|LEX_NO_NEXT_CHUNK|LEX_NO_INCLINE))
1558 Perl_croak(aTHX_ "Lexing code internal error (%s)", "lex_read_space");
1559 s = PL_parser->bufptr;
1560 bufend = PL_parser->bufend;
1566 } while (!(c == '\n' || (c == 0 && s == bufend)));
1567 } else if (c == '\n') {
1570 PL_parser->linestart = s;
1576 } else if (isSPACE(c)) {
1578 } else if (c == 0 && s == bufend) {
1581 if (flags & LEX_NO_NEXT_CHUNK)
1583 PL_parser->bufptr = s;
1584 l = CopLINE(PL_curcop);
1585 CopLINE(PL_curcop) += PL_parser->herelines + 1;
1586 got_more = lex_next_chunk(flags);
1587 CopLINE_set(PL_curcop, l);
1588 s = PL_parser->bufptr;
1589 bufend = PL_parser->bufend;
1592 if (can_incline && need_incline && PL_parser->rsfp) {
1602 PL_parser->bufptr = s;
1607 =for apidoc validate_proto
1609 This function performs syntax checking on a prototype, C<proto>.
1610 If C<warn> is true, any illegal characters or mismatched brackets
1611 will trigger illegalproto warnings, declaring that they were
1612 detected in the prototype for C<name>.
1614 The return value is C<true> if this is a valid prototype, and
1615 C<false> if it is not, regardless of whether C<warn> was C<true> or
1618 Note that C<NULL> is a valid C<proto> and will always return C<true>.
1625 Perl_validate_proto(pTHX_ SV *name, SV *proto, bool warn, bool curstash)
1627 STRLEN len, origlen;
1629 bool bad_proto = FALSE;
1630 bool in_brackets = FALSE;
1631 bool after_slash = FALSE;
1632 char greedy_proto = ' ';
1633 bool proto_after_greedy_proto = FALSE;
1634 bool must_be_last = FALSE;
1635 bool underscore = FALSE;
1636 bool bad_proto_after_underscore = FALSE;
1638 PERL_ARGS_ASSERT_VALIDATE_PROTO;
1643 p = SvPV(proto, len);
1645 for (; len--; p++) {
1648 proto_after_greedy_proto = TRUE;
1650 if (!memCHRs(";@%", *p))
1651 bad_proto_after_underscore = TRUE;
1654 if (!memCHRs("$@%*;[]&\\_+", *p) || *p == '\0') {
1661 in_brackets = FALSE;
1662 else if ((*p == '@' || *p == '%')
1666 must_be_last = TRUE;
1675 after_slash = FALSE;
1680 SV *tmpsv = newSVpvs_flags("", SVs_TEMP);
1683 ? sv_uni_display(tmpsv, newSVpvn_flags(p, origlen, SVs_TEMP | SVf_UTF8),
1684 origlen, UNI_DISPLAY_ISPRINT)
1685 : pv_pretty(tmpsv, p, origlen, 60, NULL, NULL, PERL_PV_ESCAPE_NONASCII);
1687 if (curstash && !memchr(SvPVX(name), ':', SvCUR(name))) {
1688 SV *name2 = sv_2mortal(newSVsv(PL_curstname));
1689 sv_catpvs(name2, "::");
1690 sv_catsv(name2, (SV *)name);
1694 if (proto_after_greedy_proto)
1695 Perl_warner(aTHX_ packWARN(WARN_ILLEGALPROTO),
1696 "Prototype after '%c' for %" SVf " : %s",
1697 greedy_proto, SVfARG(name), p);
1699 Perl_warner(aTHX_ packWARN(WARN_ILLEGALPROTO),
1700 "Missing ']' in prototype for %" SVf " : %s",
1703 Perl_warner(aTHX_ packWARN(WARN_ILLEGALPROTO),
1704 "Illegal character in prototype for %" SVf " : %s",
1706 if (bad_proto_after_underscore)
1707 Perl_warner(aTHX_ packWARN(WARN_ILLEGALPROTO),
1708 "Illegal character after '_' in prototype for %" SVf " : %s",
1712 return (! (proto_after_greedy_proto || bad_proto) );
1717 * This subroutine has nothing to do with tilting, whether at windmills
1718 * or pinball tables. Its name is short for "increment line". It
1719 * increments the current line number in CopLINE(PL_curcop) and checks
1720 * to see whether the line starts with a comment of the form
1721 * # line 500 "foo.pm"
1722 * If so, it sets the current line number and file to the values in the comment.
1726 S_incline(pTHX_ const char *s, const char *end)
1734 PERL_ARGS_ASSERT_INCLINE;
1738 COPLINE_INC_WITH_HERELINES;
1739 if (!PL_rsfp && !PL_parser->filtered && PL_lex_state == LEX_NORMAL
1740 && s+1 == PL_bufend && *s == ';') {
1741 /* fake newline in string eval */
1742 CopLINE_dec(PL_curcop);
1747 while (SPACE_OR_TAB(*s))
1749 if (memBEGINs(s, (STRLEN) (end - s), "line"))
1750 s += sizeof("line") - 1;
1753 if (SPACE_OR_TAB(*s))
1757 while (SPACE_OR_TAB(*s))
1765 if (!SPACE_OR_TAB(*s) && *s != '\r' && *s != '\n' && *s != '\0')
1767 while (SPACE_OR_TAB(*s))
1769 if (*s == '"' && (t = (char *) memchr(s+1, '"', end - s))) {
1775 while (*t && !isSPACE(*t))
1779 while (SPACE_OR_TAB(*e) || *e == '\r' || *e == '\f')
1781 if (*e != '\n' && *e != '\0')
1782 return; /* false alarm */
1784 if (!grok_atoUV(n, &uv, &e))
1786 line_num = ((line_t)uv) - 1;
1789 const STRLEN len = t - s;
1791 if (!PL_rsfp && !PL_parser->filtered) {
1792 /* must copy *{"::_<(eval N)[oldfilename:L]"}
1793 * to *{"::_<newfilename"} */
1794 /* However, the long form of evals is only turned on by the
1795 debugger - usually they're "(eval %lu)" */
1796 GV * const cfgv = CopFILEGV(PL_curcop);
1799 STRLEN tmplen2 = len;
1803 if (tmplen2 + 2 <= sizeof smallbuf)
1806 Newx(tmpbuf2, tmplen2 + 2, char);
1811 memcpy(tmpbuf2 + 2, s, tmplen2);
1814 gv2 = *(GV**)hv_fetch(PL_defstash, tmpbuf2, tmplen2, TRUE);
1816 gv_init(gv2, PL_defstash, tmpbuf2, tmplen2, FALSE);
1817 /* adjust ${"::_<newfilename"} to store the new file name */
1818 GvSV(gv2) = newSVpvn(tmpbuf2 + 2, tmplen2 - 2);
1819 /* The line number may differ. If that is the case,
1820 alias the saved lines that are in the array.
1821 Otherwise alias the whole array. */
1822 if (CopLINE(PL_curcop) == line_num) {
1823 GvHV(gv2) = MUTABLE_HV(SvREFCNT_inc(GvHV(cfgv)));
1824 GvAV(gv2) = MUTABLE_AV(SvREFCNT_inc(GvAV(cfgv)));
1826 else if (GvAV(cfgv)) {
1827 AV * const av = GvAV(cfgv);
1828 const line_t start = CopLINE(PL_curcop)+1;
1829 SSize_t items = AvFILLp(av) - start;
1831 AV * const av2 = GvAVn(gv2);
1832 SV **svp = AvARRAY(av) + start;
1833 Size_t l = line_num+1;
1834 while (items-- && l < SSize_t_MAX && l == (line_t)l)
1835 av_store(av2, (SSize_t)l++, SvREFCNT_inc(*svp++));
1840 if (tmpbuf2 != smallbuf) Safefree(tmpbuf2);
1843 CopFILE_free(PL_curcop);
1844 CopFILE_setn(PL_curcop, s, len);
1846 CopLINE_set(PL_curcop, line_num);
1850 S_update_debugger_info(pTHX_ SV *orig_sv, const char *const buf, STRLEN len)
1852 AV *av = CopFILEAVx(PL_curcop);
1855 if (PL_parser->preambling == NOLINE) sv = newSV_type(SVt_PVMG);
1857 sv = *av_fetch(av, 0, 1);
1858 SvUPGRADE(sv, SVt_PVMG);
1860 if (!SvPOK(sv)) SvPVCLEAR(sv);
1862 sv_catsv(sv, orig_sv);
1864 sv_catpvn(sv, buf, len);
1869 if (PL_parser->preambling == NOLINE)
1870 av_store(av, CopLINE(PL_curcop), sv);
1876 * Called to gobble the appropriate amount and type of whitespace.
1877 * Skips comments as well.
1878 * Returns the next character after the whitespace that is skipped.
1881 * Same thing, but look ahead without incrementing line numbers or
1882 * adjusting PL_linestart.
1885 #define skipspace(s) skipspace_flags(s, 0)
1886 #define peekspace(s) skipspace_flags(s, LEX_NO_INCLINE)
1889 Perl_skipspace_flags(pTHX_ char *s, U32 flags)
1891 PERL_ARGS_ASSERT_SKIPSPACE_FLAGS;
1892 if (PL_lex_formbrack && PL_lex_brackets <= PL_lex_formbrack) {
1893 while (s < PL_bufend && (SPACE_OR_TAB(*s) || !*s))
1896 STRLEN bufptr_pos = PL_bufptr - SvPVX(PL_linestr);
1898 lex_read_space(flags | LEX_KEEP_PREVIOUS |
1899 (PL_lex_inwhat || PL_lex_state == LEX_FORMLINE ?
1900 LEX_NO_NEXT_CHUNK : 0));
1902 PL_bufptr = SvPVX(PL_linestr) + bufptr_pos;
1903 if (PL_linestart > PL_bufptr)
1904 PL_bufptr = PL_linestart;
1912 * Check the unary operators to ensure there's no ambiguity in how they're
1913 * used. An ambiguous piece of code would be:
1915 * This doesn't mean rand() + 5. Because rand() is a unary operator,
1916 * the +5 is its argument.
1924 if (PL_oldoldbufptr != PL_last_uni)
1926 while (isSPACE(*PL_last_uni))
1929 while (isWORDCHAR_lazy_if_safe(s, PL_bufend, UTF) || *s == '-')
1930 s += UTF ? UTF8SKIP(s) : 1;
1931 if (s < PL_bufptr && memchr(s, '(', PL_bufptr - s))
1934 Perl_ck_warner_d(aTHX_ packWARN(WARN_AMBIGUOUS),
1935 "Warning: Use of \"%" UTF8f "\" without parentheses is ambiguous",
1936 UTF8fARG(UTF, (int)(s - PL_last_uni), PL_last_uni));
1940 * LOP : macro to build a list operator. Its behaviour has been replaced
1941 * with a subroutine, S_lop() for which LOP is just another name.
1944 #define LOP(f,x) return lop(f,x,s)
1948 * Build a list operator (or something that might be one). The rules:
1949 * - if we have a next token, then it's a list operator (no parens) for
1950 * which the next token has already been parsed; e.g.,
1953 * - if the next thing is an opening paren, then it's a function
1954 * - else it's a list operator
1958 S_lop(pTHX_ I32 f, U8 x, char *s)
1960 PERL_ARGS_ASSERT_LOP;
1965 PL_last_lop = PL_oldbufptr;
1966 PL_last_lop_op = (OPCODE)f;
1971 return REPORT(FUNC);
1974 return REPORT(FUNC);
1977 if (!PL_lex_allbrackets && PL_lex_fakeeof > LEX_FAKEEOF_LOWLOGIC)
1978 PL_lex_fakeeof = LEX_FAKEEOF_LOWLOGIC;
1979 return REPORT(LSTOP);
1985 * When the lexer realizes it knows the next token (for instance,
1986 * it is reordering tokens for the parser) then it can call S_force_next
1987 * to know what token to return the next time the lexer is called. Caller
1988 * will need to set PL_nextval[] and possibly PL_expect to ensure
1989 * the lexer handles the token correctly.
1993 S_force_next(pTHX_ I32 type)
1997 PerlIO_printf(Perl_debug_log, "### forced token:\n");
1998 tokereport(type, &NEXTVAL_NEXTTOKE);
2001 assert(PL_nexttoke < C_ARRAY_LENGTH(PL_nexttype));
2002 PL_nexttype[PL_nexttoke] = type;
2009 * This subroutine handles postfix deref syntax after the arrow has already
2010 * been emitted. @* $* etc. are emitted as two separate tokens right here.
2011 * @[ @{ %[ %{ *{ are emitted also as two tokens, but this function emits
2012 * only the first, leaving yylex to find the next.
2016 S_postderef(pTHX_ int const funny, char const next)
2018 assert(funny == DOLSHARP || memCHRs("$@%&*", funny));
2020 PL_expect = XOPERATOR;
2021 if (PL_lex_state == LEX_INTERPNORMAL && !PL_lex_brackets) {
2022 assert('@' == funny || '$' == funny || DOLSHARP == funny);
2023 PL_lex_state = LEX_INTERPEND;
2025 force_next(POSTJOIN);
2031 if ('@' == funny && PL_lex_state == LEX_INTERPNORMAL
2032 && !PL_lex_brackets)
2034 PL_expect = XOPERATOR;
2043 int yyc = PL_parser->yychar;
2044 if (yyc != YYEMPTY) {
2046 NEXTVAL_NEXTTOKE = PL_parser->yylval;
2047 if (yyc == '{'/*}*/ || yyc == HASHBRACK || yyc == '['/*]*/) {
2048 PL_lex_allbrackets--;
2050 yyc |= (3<<24) | (PL_lex_brackstack[PL_lex_brackets] << 16);
2051 } else if (yyc == '('/*)*/) {
2052 PL_lex_allbrackets--;
2057 PL_parser->yychar = YYEMPTY;
2062 S_newSV_maybe_utf8(pTHX_ const char *const start, STRLEN len)
2064 SV * const sv = newSVpvn_utf8(start, len,
2068 && is_utf8_non_invariant_string((const U8*)start, len));
2074 * When the lexer knows the next thing is a word (for instance, it has
2075 * just seen -> and it knows that the next char is a word char, then
2076 * it calls S_force_word to stick the next word into the PL_nexttoke/val
2080 * char *start : buffer position (must be within PL_linestr)
2081 * int token : PL_next* will be this type of bare word
2082 * (e.g., METHOD,BAREWORD)
2083 * int check_keyword : if true, Perl checks to make sure the word isn't
2084 * a keyword (do this if the word is a label, e.g. goto FOO)
2085 * int allow_pack : if true, : characters will also be allowed (require,
2086 * use, etc. do this)
2090 S_force_word(pTHX_ char *start, int token, int check_keyword, int allow_pack)
2095 PERL_ARGS_ASSERT_FORCE_WORD;
2097 start = skipspace(start);
2099 if ( isIDFIRST_lazy_if_safe(s, PL_bufend, UTF)
2100 || (allow_pack && *s == ':' && s[1] == ':') )
2102 s = scan_word(s, PL_tokenbuf, sizeof PL_tokenbuf, allow_pack, &len);
2103 if (check_keyword) {
2104 char *s2 = PL_tokenbuf;
2106 if (allow_pack && memBEGINPs(s2, len, "CORE::")) {
2107 s2 += sizeof("CORE::") - 1;
2108 len2 -= sizeof("CORE::") - 1;
2110 if (keyword(s2, len2, 0))
2113 if (token == METHOD) {
2118 PL_expect = XOPERATOR;
2121 NEXTVAL_NEXTTOKE.opval
2122 = newSVOP(OP_CONST,0,
2123 S_newSV_maybe_utf8(aTHX_ PL_tokenbuf, len));
2124 NEXTVAL_NEXTTOKE.opval->op_private |= OPpCONST_BARE;
2132 * Called when the lexer wants $foo *foo &foo etc, but the program
2133 * text only contains the "foo" portion. The first argument is a pointer
2134 * to the "foo", and the second argument is the type symbol to prefix.
2135 * Forces the next token to be a "BAREWORD".
2136 * Creates the symbol if it didn't already exist (via gv_fetchpv()).
2140 S_force_ident(pTHX_ const char *s, int kind)
2142 PERL_ARGS_ASSERT_FORCE_IDENT;
2145 const STRLEN len = s[1] ? strlen(s) : 1; /* s = "\"" see yylex */
2146 OP* const o = newSVOP(OP_CONST, 0, newSVpvn_flags(s, len,
2147 UTF ? SVf_UTF8 : 0));
2148 NEXTVAL_NEXTTOKE.opval = o;
2149 force_next(BAREWORD);
2151 o->op_private = OPpCONST_ENTERED;
2152 /* XXX see note in pp_entereval() for why we forgo typo
2153 warnings if the symbol must be introduced in an eval.
2155 gv_fetchpvn_flags(s, len,
2156 (PL_in_eval ? GV_ADDMULTI
2157 : GV_ADD) | ( UTF ? SVf_UTF8 : 0 ),
2158 kind == '$' ? SVt_PV :
2159 kind == '@' ? SVt_PVAV :
2160 kind == '%' ? SVt_PVHV :
2168 S_force_ident_maybe_lex(pTHX_ char pit)
2170 NEXTVAL_NEXTTOKE.ival = pit;
2175 Perl_str_to_version(pTHX_ SV *sv)
2180 const char *start = SvPV_const(sv,len);
2181 const char * const end = start + len;
2182 const bool utf = cBOOL(SvUTF8(sv));
2184 PERL_ARGS_ASSERT_STR_TO_VERSION;
2186 while (start < end) {
2190 n = utf8n_to_uvchr((U8*)start, len, &skip, 0);
2195 retval += ((NV)n)/nshift;
2204 * Forces the next token to be a version number.
2205 * If the next token appears to be an invalid version number, (e.g. "v2b"),
2206 * and if "guessing" is TRUE, then no new token is created (and the caller
2207 * must use an alternative parsing method).
2211 S_force_version(pTHX_ char *s, int guessing)
2216 PERL_ARGS_ASSERT_FORCE_VERSION;
2224 while (isDIGIT(*d) || *d == '_' || *d == '.')
2226 if (*d == ';' || isSPACE(*d) || *d == '{' || *d == '}' || !*d) {
2228 s = scan_num(s, &pl_yylval);
2229 version = pl_yylval.opval;
2230 ver = cSVOPx(version)->op_sv;
2231 if (SvPOK(ver) && !SvNIOK(ver)) {
2232 SvUPGRADE(ver, SVt_PVNV);
2233 SvNV_set(ver, str_to_version(ver));
2234 SvNOK_on(ver); /* hint that it is a version */
2237 else if (guessing) {
2242 /* NOTE: The parser sees the package name and the VERSION swapped */
2243 NEXTVAL_NEXTTOKE.opval = version;
2244 force_next(BAREWORD);
2250 * S_force_strict_version
2251 * Forces the next token to be a version number using strict syntax rules.
2255 S_force_strict_version(pTHX_ char *s)
2258 const char *errstr = NULL;
2260 PERL_ARGS_ASSERT_FORCE_STRICT_VERSION;
2262 while (isSPACE(*s)) /* leading whitespace */
2265 if (is_STRICT_VERSION(s,&errstr)) {
2267 s = (char *)scan_version(s, ver, 0);
2268 version = newSVOP(OP_CONST, 0, ver);
2270 else if ((*s != ';' && *s != '{' && *s != '}' )
2271 && (s = skipspace(s), (*s != ';' && *s != '{' && *s != '}' )))
2275 yyerror(errstr); /* version required */
2279 /* NOTE: The parser sees the package name and the VERSION swapped */
2280 NEXTVAL_NEXTTOKE.opval = version;
2281 force_next(BAREWORD);
2288 * Turns any \\ into \ in a quoted string passed in in 'sv', returning 'sv',
2289 * modified as necessary. However, if HINT_NEW_STRING is on, 'sv' is
2290 * unchanged, and a new SV containing the modified input is returned.
2294 S_tokeq(pTHX_ SV *sv)
2301 PERL_ARGS_ASSERT_TOKEQ;
2305 assert (!SvIsCOW(sv));
2306 if (SvTYPE(sv) >= SVt_PVIV && SvIVX(sv) == -1) /* <<'heredoc' */
2310 /* This is relying on the SV being "well formed" with a trailing '\0' */
2311 while (s < send && !(*s == '\\' && s[1] == '\\'))
2316 if ( PL_hints & HINT_NEW_STRING ) {
2317 pv = newSVpvn_flags(SvPVX_const(pv), SvCUR(sv),
2318 SVs_TEMP | SvUTF8(sv));
2322 if (s + 1 < send && (s[1] == '\\'))
2323 s++; /* all that, just for this */
2328 SvCUR_set(sv, d - SvPVX_const(sv));
2330 if ( PL_hints & HINT_NEW_STRING )
2331 return new_constant(NULL, 0, "q", sv, pv, "q", 1, NULL);
2336 * Now come three functions related to double-quote context,
2337 * S_sublex_start, S_sublex_push, and S_sublex_done. They're used when
2338 * converting things like "\u\Lgnat" into ucfirst(lc("gnat")). They
2339 * interact with PL_lex_state, and create fake ( ... ) argument lists
2340 * to handle functions and concatenation.
2344 * stringify ( const[foo] concat lcfirst ( const[bar] ) )
2349 * Assumes that pl_yylval.ival is the op we're creating (e.g. OP_LCFIRST).
2351 * Pattern matching will set PL_lex_op to the pattern-matching op to
2352 * make (we return THING if pl_yylval.ival is OP_NULL, PMFUNC otherwise).
2354 * OP_CONST is easy--just make the new op and return.
2356 * Everything else becomes a FUNC.
2358 * Sets PL_lex_state to LEX_INTERPPUSH unless ival was OP_NULL or we
2359 * had an OP_CONST. This just sets us up for a
2360 * call to S_sublex_push().
2364 S_sublex_start(pTHX)
2366 const I32 op_type = pl_yylval.ival;
2368 if (op_type == OP_NULL) {
2369 pl_yylval.opval = PL_lex_op;
2373 if (op_type == OP_CONST) {
2374 SV *sv = PL_lex_stuff;
2375 PL_lex_stuff = NULL;
2378 if (SvTYPE(sv) == SVt_PVIV) {
2379 /* Overloaded constants, nothing fancy: Convert to SVt_PV: */
2381 const char * const p = SvPV_const(sv, len);
2382 SV * const nsv = newSVpvn_flags(p, len, SvUTF8(sv));
2386 pl_yylval.opval = newSVOP(op_type, 0, sv);
2390 PL_parser->lex_super_state = PL_lex_state;
2391 PL_parser->lex_sub_inwhat = (U16)op_type;
2392 PL_parser->lex_sub_op = PL_lex_op;
2393 PL_parser->sub_no_recover = FALSE;
2394 PL_parser->sub_error_count = PL_error_count;
2395 PL_lex_state = LEX_INTERPPUSH;
2399 pl_yylval.opval = PL_lex_op;
2409 * Create a new scope to save the lexing state. The scope will be
2410 * ended in S_sublex_done. Returns a '(', starting the function arguments
2411 * to the uc, lc, etc. found before.
2412 * Sets PL_lex_state to LEX_INTERPCONCAT.
2419 const bool is_heredoc = PL_multi_close == '<';
2422 PL_lex_state = PL_parser->lex_super_state;
2423 SAVEI8(PL_lex_dojoin);
2424 SAVEI32(PL_lex_brackets);
2425 SAVEI32(PL_lex_allbrackets);
2426 SAVEI32(PL_lex_formbrack);
2427 SAVEI8(PL_lex_fakeeof);
2428 SAVEI32(PL_lex_casemods);
2429 SAVEI32(PL_lex_starts);
2430 SAVEI8(PL_lex_state);
2431 SAVESPTR(PL_lex_repl);
2432 SAVEVPTR(PL_lex_inpat);
2433 SAVEI16(PL_lex_inwhat);
2436 SAVECOPLINE(PL_curcop);
2437 SAVEI32(PL_multi_end);
2438 SAVEI32(PL_parser->herelines);
2439 PL_parser->herelines = 0;
2441 SAVEIV(PL_multi_close);
2442 SAVEPPTR(PL_bufptr);
2443 SAVEPPTR(PL_bufend);
2444 SAVEPPTR(PL_oldbufptr);
2445 SAVEPPTR(PL_oldoldbufptr);
2446 SAVEPPTR(PL_last_lop);
2447 SAVEPPTR(PL_last_uni);
2448 SAVEPPTR(PL_linestart);
2449 SAVESPTR(PL_linestr);
2450 SAVEGENERICPV(PL_lex_brackstack);
2451 SAVEGENERICPV(PL_lex_casestack);
2452 SAVEGENERICPV(PL_parser->lex_shared);
2453 SAVEBOOL(PL_parser->lex_re_reparsing);
2454 SAVEI32(PL_copline);
2456 /* The here-doc parser needs to be able to peek into outer lexing
2457 scopes to find the body of the here-doc. So we put PL_linestr and
2458 PL_bufptr into lex_shared, to ‘share’ those values.
2460 PL_parser->lex_shared->ls_linestr = PL_linestr;
2461 PL_parser->lex_shared->ls_bufptr = PL_bufptr;
2463 PL_linestr = PL_lex_stuff;
2464 PL_lex_repl = PL_parser->lex_sub_repl;
2465 PL_lex_stuff = NULL;
2466 PL_parser->lex_sub_repl = NULL;
2468 /* Arrange for PL_lex_stuff to be freed on scope exit, in case it gets
2469 set for an inner quote-like operator and then an error causes scope-
2470 popping. We must not have a PL_lex_stuff value left dangling, as
2471 that breaks assumptions elsewhere. See bug #123617. */
2472 SAVEGENERICSV(PL_lex_stuff);
2473 SAVEGENERICSV(PL_parser->lex_sub_repl);
2475 PL_bufend = PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart
2476 = SvPVX(PL_linestr);
2477 PL_bufend += SvCUR(PL_linestr);
2478 PL_last_lop = PL_last_uni = NULL;
2479 SAVEFREESV(PL_linestr);
2480 if (PL_lex_repl) SAVEFREESV(PL_lex_repl);
2482 PL_lex_dojoin = FALSE;
2483 PL_lex_brackets = PL_lex_formbrack = 0;
2484 PL_lex_allbrackets = 0;
2485 PL_lex_fakeeof = LEX_FAKEEOF_NEVER;
2486 Newx(PL_lex_brackstack, 120, char);
2487 Newx(PL_lex_casestack, 12, char);
2488 PL_lex_casemods = 0;
2489 *PL_lex_casestack = '\0';
2491 PL_lex_state = LEX_INTERPCONCAT;
2493 CopLINE_set(PL_curcop, (line_t)PL_multi_start);
2494 PL_copline = NOLINE;
2496 Newxz(shared, 1, LEXSHARED);
2497 shared->ls_prev = PL_parser->lex_shared;
2498 PL_parser->lex_shared = shared;
2500 PL_lex_inwhat = PL_parser->lex_sub_inwhat;
2501 if (PL_lex_inwhat == OP_TRANSR) PL_lex_inwhat = OP_TRANS;
2502 if (PL_lex_inwhat == OP_MATCH || PL_lex_inwhat == OP_QR || PL_lex_inwhat == OP_SUBST)
2503 PL_lex_inpat = PL_parser->lex_sub_op;
2505 PL_lex_inpat = NULL;
2507 PL_parser->lex_re_reparsing = cBOOL(PL_in_eval & EVAL_RE_REPARSING);
2508 PL_in_eval &= ~EVAL_RE_REPARSING;
2515 * Restores lexer state after a S_sublex_push.
2521 if (!PL_lex_starts++) {
2522 SV * const sv = newSVpvs("");
2523 if (SvUTF8(PL_linestr))
2525 PL_expect = XOPERATOR;
2526 pl_yylval.opval = newSVOP(OP_CONST, 0, sv);
2530 if (PL_lex_casemods) { /* oops, we've got some unbalanced parens */
2531 PL_lex_state = LEX_INTERPCASEMOD;
2535 /* Is there a right-hand side to take care of? (s//RHS/ or tr//RHS/) */
2536 assert(PL_lex_inwhat != OP_TRANSR);
2538 assert (PL_lex_inwhat == OP_SUBST || PL_lex_inwhat == OP_TRANS);
2539 PL_linestr = PL_lex_repl;
2541 PL_bufend = PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
2542 PL_bufend += SvCUR(PL_linestr);
2543 PL_last_lop = PL_last_uni = NULL;
2544 PL_lex_dojoin = FALSE;
2545 PL_lex_brackets = 0;
2546 PL_lex_allbrackets = 0;
2547 PL_lex_fakeeof = LEX_FAKEEOF_NEVER;
2548 PL_lex_casemods = 0;
2549 *PL_lex_casestack = '\0';
2551 if (SvEVALED(PL_lex_repl)) {
2552 PL_lex_state = LEX_INTERPNORMAL;
2554 /* we don't clear PL_lex_repl here, so that we can check later
2555 whether this is an evalled subst; that means we rely on the
2556 logic to ensure sublex_done() is called again only via the
2557 branch (in yylex()) that clears PL_lex_repl, else we'll loop */
2560 PL_lex_state = LEX_INTERPCONCAT;
2563 if (SvTYPE(PL_linestr) >= SVt_PVNV) {
2564 CopLINE(PL_curcop) +=
2565 ((XPVNV*)SvANY(PL_linestr))->xnv_u.xnv_lines
2566 + PL_parser->herelines;
2567 PL_parser->herelines = 0;
2572 const line_t l = CopLINE(PL_curcop);
2574 if (PL_parser->sub_error_count != PL_error_count) {
2575 if (PL_parser->sub_no_recover) {
2580 if (PL_multi_close == '<')
2581 PL_parser->herelines += l - PL_multi_end;
2582 PL_bufend = SvPVX(PL_linestr);
2583 PL_bufend += SvCUR(PL_linestr);
2584 PL_expect = XOPERATOR;
2590 S_get_and_check_backslash_N_name_wrapper(pTHX_ const char* s, const char* const e)
2592 /* This justs wraps get_and_check_backslash_N_name() to output any error
2593 * message it returns. */
2595 const char * error_msg = NULL;
2598 PERL_ARGS_ASSERT_GET_AND_CHECK_BACKSLASH_N_NAME_WRAPPER;
2600 /* charnames doesn't work well if there have been errors found */
2601 if (PL_error_count > 0) {
2605 result = get_and_check_backslash_N_name(s, e, cBOOL(UTF), &error_msg);
2608 yyerror_pv(error_msg, UTF ? SVf_UTF8 : 0);
2615 Perl_get_and_check_backslash_N_name(pTHX_ const char* s,
2616 const char* const e,
2618 const char ** error_msg)
2620 /* <s> points to first character of interior of \N{}, <e> to one beyond the
2621 * interior, hence to the "}". Finds what the name resolves to, returning
2622 * an SV* containing it; NULL if no valid one found.
2624 * 'is_utf8' is TRUE if we know we want the result to be UTF-8 even if it
2625 * doesn't have to be. */
2633 const char* backslash_ptr = s - 3; /* Points to the <\> of \N{... */
2636 PERL_ARGS_ASSERT_GET_AND_CHECK_BACKSLASH_N_NAME;
2639 assert(s > (char *) 3);
2641 res = newSVpvn_flags(s, e - s, (is_utf8) ? SVf_UTF8 : 0);
2644 SvREFCNT_dec_NN(res);
2645 /* diag_listed_as: Unknown charname '%s' */
2646 *error_msg = Perl_form(aTHX_ "Unknown charname ''");
2650 res = new_constant( NULL, 0, "charnames", res, NULL, backslash_ptr,
2651 /* include the <}> */
2652 e - backslash_ptr + 1, error_msg);
2654 SvREFCNT_dec_NN(res);
2658 /* See if the charnames handler is the Perl core's, and if so, we can skip
2659 * the validation needed for a user-supplied one, as Perl's does its own
2661 table = GvHV(PL_hintgv); /* ^H */
2662 cvp = hv_fetchs(table, "charnames", FALSE);
2663 if (cvp && (cv = *cvp) && SvROK(cv) && (rv = SvRV(cv),
2664 SvTYPE(rv) == SVt_PVCV) && ((stash = CvSTASH(rv)) != NULL))
2666 const char * const name = HvNAME(stash);
2667 if (memEQs(name, HvNAMELEN(stash), "_charnames")) {
2672 /* Here, it isn't Perl's charname handler. We can't rely on a
2673 * user-supplied handler to validate the input name. For non-ut8 input,
2674 * look to see that the first character is legal. Then loop through the
2675 * rest checking that each is a continuation */
2677 /* This code makes the reasonable assumption that the only Latin1-range
2678 * characters that begin a character name alias are alphabetic, otherwise
2679 * would have to create a isCHARNAME_BEGIN macro */
2682 if (! isALPHAU(*s)) {
2687 if (! isCHARNAME_CONT(*s)) {
2690 if (*s == ' ' && *(s-1) == ' ') {
2697 /* Similarly for utf8. For invariants can check directly; for other
2698 * Latin1, can calculate their code point and check; otherwise use an
2700 if (UTF8_IS_INVARIANT(*s)) {
2701 if (! isALPHAU(*s)) {
2705 } else if (UTF8_IS_DOWNGRADEABLE_START(*s)) {
2706 if (! isALPHAU(EIGHT_BIT_UTF8_TO_NATIVE(*s, *(s+1)))) {
2712 if (! _invlist_contains_cp(PL_utf8_charname_begin,
2713 utf8_to_uvchr_buf((U8 *) s,
2723 if (UTF8_IS_INVARIANT(*s)) {
2724 if (! isCHARNAME_CONT(*s)) {
2727 if (*s == ' ' && *(s-1) == ' ') {
2732 else if (UTF8_IS_DOWNGRADEABLE_START(*s)) {
2733 if (! isCHARNAME_CONT(EIGHT_BIT_UTF8_TO_NATIVE(*s, *(s+1))))
2740 if (! _invlist_contains_cp(PL_utf8_charname_continue,
2741 utf8_to_uvchr_buf((U8 *) s,
2751 if (*(s-1) == ' ') {
2752 /* diag_listed_as: charnames alias definitions may not contain
2753 trailing white-space; marked by <-- HERE in %s
2755 *error_msg = Perl_form(aTHX_
2756 "charnames alias definitions may not contain trailing "
2757 "white-space; marked by <-- HERE in %.*s<-- HERE %.*s",
2758 (int)(s - backslash_ptr + 1), backslash_ptr,
2759 (int)(e - s + 1), s + 1);
2763 if (SvUTF8(res)) { /* Don't accept malformed charname value */
2764 const U8* first_bad_char_loc;
2766 const char* const str = SvPV_const(res, len);
2767 if (UNLIKELY(! is_utf8_string_loc((U8 *) str, len,
2768 &first_bad_char_loc)))
2770 _force_out_malformed_utf8_message(first_bad_char_loc,
2771 (U8 *) PL_parser->bufend,
2773 0 /* 0 means don't die */ );
2774 /* diag_listed_as: Malformed UTF-8 returned by \N{%s}
2775 immediately after '%s' */
2776 *error_msg = Perl_form(aTHX_
2777 "Malformed UTF-8 returned by %.*s immediately after '%.*s'",
2778 (int) (e - backslash_ptr + 1), backslash_ptr,
2779 (int) ((char *) first_bad_char_loc - str), str);
2788 /* The final %.*s makes sure that should the trailing NUL be missing
2789 * that this print won't run off the end of the string */
2790 /* diag_listed_as: Invalid character in \N{...}; marked by <-- HERE
2792 *error_msg = Perl_form(aTHX_
2793 "Invalid character in \\N{...}; marked by <-- HERE in %.*s<-- HERE %.*s",
2794 (int)(s - backslash_ptr + 1), backslash_ptr,
2795 (int)(e - s + 1), s + 1);
2800 /* diag_listed_as: charnames alias definitions may not contain a
2801 sequence of multiple spaces; marked by <-- HERE
2803 *error_msg = Perl_form(aTHX_
2804 "charnames alias definitions may not contain a sequence of "
2805 "multiple spaces; marked by <-- HERE in %.*s<-- HERE %.*s",
2806 (int)(s - backslash_ptr + 1), backslash_ptr,
2807 (int)(e - s + 1), s + 1);
2814 Extracts the next constant part of a pattern, double-quoted string,
2815 or transliteration. This is terrifying code.
2817 For example, in parsing the double-quoted string "ab\x63$d", it would
2818 stop at the '$' and return an OP_CONST containing 'abc'.
2820 It looks at PL_lex_inwhat and PL_lex_inpat to find out whether it's
2821 processing a pattern (PL_lex_inpat is true), a transliteration
2822 (PL_lex_inwhat == OP_TRANS is true), or a double-quoted string.
2824 Returns a pointer to the character scanned up to. If this is
2825 advanced from the start pointer supplied (i.e. if anything was
2826 successfully parsed), will leave an OP_CONST for the substring scanned
2827 in pl_yylval. Caller must intuit reason for not parsing further
2828 by looking at the next characters herself.
2832 \N{FOO} => \N{U+hex_for_character_FOO}
2833 (if FOO expands to multiple characters, expands to \N{U+xx.XX.yy ...})
2836 all other \-char, including \N and \N{ apart from \N{ABC}
2839 @ and $ where it appears to be a var, but not for $ as tail anchor
2843 In transliterations:
2844 characters are VERY literal, except for - not at the start or end
2845 of the string, which indicates a range. However some backslash sequences
2846 are recognized: \r, \n, and the like
2847 \007 \o{}, \x{}, \N{}
2848 If all elements in the transliteration are below 256,
2849 scan_const expands the range to the full set of intermediate
2850 characters. If the range is in utf8, the hyphen is replaced with
2851 a certain range mark which will be handled by pmtrans() in op.c.
2853 In double-quoted strings:
2855 all those recognized in transliterations
2856 deprecated backrefs: \1 (in substitution replacements)
2857 case and quoting: \U \Q \E
2860 scan_const does *not* construct ops to handle interpolated strings.
2861 It stops processing as soon as it finds an embedded $ or @ variable
2862 and leaves it to the caller to work out what's going on.
2864 embedded arrays (whether in pattern or not) could be:
2865 @foo, @::foo, @'foo, @{foo}, @$foo, @+, @-.
2867 $ in double-quoted strings must be the symbol of an embedded scalar.
2869 $ in pattern could be $foo or could be tail anchor. Assumption:
2870 it's a tail anchor if $ is the last thing in the string, or if it's
2871 followed by one of "()| \r\n\t"
2873 \1 (backreferences) are turned into $1 in substitutions
2875 The structure of the code is
2876 while (there's a character to process) {
2877 handle transliteration ranges
2878 skip regexp comments /(?#comment)/ and codes /(?{code})/
2879 skip #-initiated comments in //x patterns
2880 check for embedded arrays
2881 check for embedded scalars
2883 deprecate \1 in substitution replacements
2884 handle string-changing backslashes \l \U \Q \E, etc.
2885 switch (what was escaped) {
2886 handle \- in a transliteration (becomes a literal -)
2887 if a pattern and not \N{, go treat as regular character
2888 handle \132 (octal characters)
2889 handle \x15 and \x{1234} (hex characters)
2890 handle \N{name} (named characters, also \N{3,5} in a pattern)
2891 handle \cV (control characters)
2892 handle printf-style backslashes (\f, \r, \n, etc)
2895 } (end if backslash)
2896 handle regular character
2897 } (end while character to read)
2902 S_scan_const(pTHX_ char *start)
2904 char *send = PL_bufend; /* end of the constant */
2905 SV *sv = newSV(send - start); /* sv for the constant. See note below
2907 char *s = start; /* start of the constant */
2908 char *d = SvPVX(sv); /* destination for copies */
2909 bool dorange = FALSE; /* are we in a translit range? */
2910 bool didrange = FALSE; /* did we just finish a range? */
2911 bool in_charclass = FALSE; /* within /[...]/ */
2912 bool s_is_utf8 = cBOOL(UTF); /* Is the source string assumed to be
2913 UTF8? But, this can show as true
2914 when the source isn't utf8, as for
2915 example when it is entirely composed
2917 bool d_is_utf8 = FALSE; /* Output constant is UTF8 */
2918 STRLEN utf8_variant_count = 0; /* When not in UTF-8, this counts the
2919 number of characters found so far
2920 that will expand (into 2 bytes)
2921 should we have to convert to
2923 SV *res; /* result from charnames */
2924 STRLEN offset_to_max = 0; /* The offset in the output to where the range
2925 high-end character is temporarily placed */
2927 /* Does something require special handling in tr/// ? This avoids extra
2928 * work in a less likely case. As such, khw didn't feel it was worth
2929 * adding any branches to the more mainline code to handle this, which
2930 * means that this doesn't get set in some circumstances when things like
2931 * \x{100} get expanded out. As a result there needs to be extra testing
2932 * done in the tr code */
2933 bool has_above_latin1 = FALSE;
2935 /* Note on sizing: The scanned constant is placed into sv, which is
2936 * initialized by newSV() assuming one byte of output for every byte of
2937 * input. This routine expects newSV() to allocate an extra byte for a
2938 * trailing NUL, which this routine will append if it gets to the end of
2939 * the input. There may be more bytes of input than output (eg., \N{LATIN
2940 * CAPITAL LETTER A}), or more output than input if the constant ends up
2941 * recoded to utf8, but each time a construct is found that might increase
2942 * the needed size, SvGROW() is called. Its size parameter each time is
2943 * based on the best guess estimate at the time, namely the length used so
2944 * far, plus the length the current construct will occupy, plus room for
2945 * the trailing NUL, plus one byte for every input byte still unscanned */
2947 UV uv = UV_MAX; /* Initialize to weird value to try to catch any uses
2950 int backslash_N = 0; /* ? was the character from \N{} */
2951 int non_portable_endpoint = 0; /* ? In a range is an endpoint
2952 platform-specific like \x65 */
2955 PERL_ARGS_ASSERT_SCAN_CONST;
2957 assert(PL_lex_inwhat != OP_TRANSR);
2959 /* Protect sv from errors and fatal warnings. */
2960 ENTER_with_name("scan_const");
2963 /* A bunch of code in the loop below assumes that if s[n] exists and is not
2964 * NUL, then s[n+1] exists. This assertion makes sure that assumption is
2966 assert(*send == '\0');
2969 || dorange /* Handle tr/// range at right edge of input */
2972 /* get transliterations out of the way (they're most literal) */
2973 if (PL_lex_inwhat == OP_TRANS) {
2975 /* But there isn't any special handling necessary unless there is a
2976 * range, so for most cases we just drop down and handle the value
2977 * as any other. There are two exceptions.
2979 * 1. A hyphen indicates that we are actually going to have a
2980 * range. In this case, skip the '-', set a flag, then drop
2981 * down to handle what should be the end range value.
2982 * 2. After we've handled that value, the next time through, that
2983 * flag is set and we fix up the range.
2985 * Ranges entirely within Latin1 are expanded out entirely, in
2986 * order to make the transliteration a simple table look-up.
2987 * Ranges that extend above Latin1 have to be done differently, so
2988 * there is no advantage to expanding them here, so they are
2989 * stored here as Min, RANGE_INDICATOR, Max. 'RANGE_INDICATOR' is
2990 * a byte that can't occur in legal UTF-8, and hence can signify a
2991 * hyphen without any possible ambiguity. On EBCDIC machines, if
2992 * the range is expressed as Unicode, the Latin1 portion is
2993 * expanded out even if the range extends above Latin1. This is
2994 * because each code point in it has to be processed here
2995 * individually to get its native translation */
2999 /* Here, we don't think we're in a range. If the new character
3000 * is not a hyphen; or if it is a hyphen, but it's too close to
3001 * either edge to indicate a range, or if we haven't output any
3002 * characters yet then it's a regular character. */
3003 if (*s != '-' || s >= send - 1 || s == start || d == SvPVX(sv))
3006 /* A regular character. Process like any other, but first
3007 * clear any flags */
3011 non_portable_endpoint = 0;
3014 /* The tests here for being above Latin1 and similar ones
3015 * in the following 'else' suffice to find all such
3016 * occurences in the constant, except those added by a
3017 * backslash escape sequence, like \x{100}. Mostly, those
3018 * set 'has_above_latin1' as appropriate */
3019 if (s_is_utf8 && UTF8_IS_ABOVE_LATIN1(*s)) {
3020 has_above_latin1 = TRUE;
3023 /* Drops down to generic code to process current byte */
3025 else { /* Is a '-' in the context where it means a range */
3026 if (didrange) { /* Something like y/A-C-Z// */
3027 Perl_croak(aTHX_ "Ambiguous range in transliteration"
3033 s++; /* Skip past the hyphen */
3035 /* d now points to where the end-range character will be
3036 * placed. Drop down to get that character. We'll finish
3037 * processing the range the next time through the loop */
3039 if (s_is_utf8 && UTF8_IS_ABOVE_LATIN1(*s)) {
3040 has_above_latin1 = TRUE;
3043 /* Drops down to generic code to process current byte */
3045 } /* End of not a range */
3047 /* Here we have parsed a range. Now must handle it. At this
3049 * 'sv' is a SV* that contains the output string we are
3050 * constructing. The final two characters in that string
3051 * are the range start and range end, in order.
3052 * 'd' points to just beyond the range end in the 'sv' string,
3053 * where we would next place something
3058 IV range_max; /* last character in range */
3060 Size_t offset_to_min = 0;
3063 bool convert_unicode;
3064 IV real_range_max = 0;
3066 /* Get the code point values of the range ends. */
3067 max_ptr = (d_is_utf8) ? (char *) utf8_hop( (U8*) d, -1) : d - 1;
3068 offset_to_max = max_ptr - SvPVX_const(sv);
3070 /* We know the utf8 is valid, because we just constructed
3071 * it ourselves in previous loop iterations */
3072 min_ptr = (char*) utf8_hop( (U8*) max_ptr, -1);
3073 range_min = valid_utf8_to_uvchr( (U8*) min_ptr, NULL);
3074 range_max = valid_utf8_to_uvchr( (U8*) max_ptr, NULL);
3076 /* This compensates for not all code setting
3077 * 'has_above_latin1', so that we don't skip stuff that
3078 * should be executed */
3079 if (range_max > 255) {
3080 has_above_latin1 = TRUE;
3084 min_ptr = max_ptr - 1;
3085 range_min = * (U8*) min_ptr;
3086 range_max = * (U8*) max_ptr;
3089 /* If the range is just a single code point, like tr/a-a/.../,
3090 * that code point is already in the output, twice. We can
3091 * just back up over the second instance and avoid all the rest
3092 * of the work. But if it is a variant character, it's been
3093 * counted twice, so decrement. (This unlikely scenario is
3094 * special cased, like the one for a range of 2 code points
3095 * below, only because the main-line code below needs a range
3096 * of 3 or more to work without special casing. Might as well
3097 * get it out of the way now.) */
3098 if (UNLIKELY(range_max == range_min)) {
3100 if (! d_is_utf8 && ! UVCHR_IS_INVARIANT(range_max)) {
3101 utf8_variant_count--;
3107 /* On EBCDIC platforms, we may have to deal with portable
3108 * ranges. These happen if at least one range endpoint is a
3109 * Unicode value (\N{...}), or if the range is a subset of
3110 * [A-Z] or [a-z], and both ends are literal characters,
3111 * like 'A', and not like \x{C1} */
3113 cBOOL(backslash_N) /* \N{} forces Unicode,
3114 hence portable range */
3115 || ( ! non_portable_endpoint
3116 && (( isLOWER_A(range_min) && isLOWER_A(range_max))
3117 || (isUPPER_A(range_min) && isUPPER_A(range_max))));
3118 if (convert_unicode) {
3120 /* Special handling is needed for these portable ranges.
3121 * They are defined to be in Unicode terms, which includes
3122 * all the Unicode code points between the end points.
3123 * Convert to Unicode to get the Unicode range. Later we
3124 * will convert each code point in the range back to
3126 range_min = NATIVE_TO_UNI(range_min);
3127 range_max = NATIVE_TO_UNI(range_max);
3131 if (range_min > range_max) {
3133 if (convert_unicode) {
3134 /* Need to convert back to native for meaningful
3135 * messages for this platform */
3136 range_min = UNI_TO_NATIVE(range_min);
3137 range_max = UNI_TO_NATIVE(range_max);
3140 /* Use the characters themselves for the error message if
3141 * ASCII printables; otherwise some visible representation
3143 if (isPRINT_A(range_min) && isPRINT_A(range_max)) {
3145 "Invalid range \"%c-%c\" in transliteration operator",
3146 (char)range_min, (char)range_max);
3149 else if (convert_unicode) {
3150 /* diag_listed_as: Invalid range "%s" in transliteration operator */
3152 "Invalid range \"\\N{U+%04" UVXf "}-\\N{U+%04"
3153 UVXf "}\" in transliteration operator",
3154 range_min, range_max);
3158 /* diag_listed_as: Invalid range "%s" in transliteration operator */
3160 "Invalid range \"\\x{%04" UVXf "}-\\x{%04" UVXf "}\""
3161 " in transliteration operator",
3162 range_min, range_max);
3166 /* If the range is exactly two code points long, they are
3167 * already both in the output */
3168 if (UNLIKELY(range_min + 1 == range_max)) {
3172 /* Here the range contains at least 3 code points */
3176 /* If everything in the transliteration is below 256, we
3177 * can avoid special handling later. A translation table
3178 * for each of those bytes is created by op.c. So we
3179 * expand out all ranges to their constituent code points.
3180 * But if we've encountered something above 255, the
3181 * expanding won't help, so skip doing that. But if it's
3182 * EBCDIC, we may have to look at each character below 256
3183 * if we have to convert to/from Unicode values */
3184 if ( has_above_latin1
3186 && (range_min > 255 || ! convert_unicode)
3189 const STRLEN off = d - SvPVX(sv);
3190 const STRLEN extra = 1 + (send - s) + 1;
3193 /* Move the high character one byte to the right; then
3194 * insert between it and the range begin, an illegal
3195 * byte which serves to indicate this is a range (using
3196 * a '-' would be ambiguous). */
3198 if (off + extra > SvLEN(sv)) {
3199 d = off + SvGROW(sv, off + extra);
3200 max_ptr = d - off + offset_to_max;
3204 while (e-- > max_ptr) {
3207 *(e + 1) = (char) RANGE_INDICATOR;
3211 /* Here, we're going to expand out the range. For EBCDIC
3212 * the range can extend above 255 (not so in ASCII), so
3213 * for EBCDIC, split it into the parts above and below
3216 if (range_max > 255) {
3217 real_range_max = range_max;
3223 /* Here we need to expand out the string to contain each
3224 * character in the range. Grow the output to handle this.
3225 * For non-UTF8, we need a byte for each code point in the
3226 * range, minus the three that we've already allocated for: the
3227 * hyphen, the min, and the max. For UTF-8, we need this
3228 * plus an extra byte for each code point that occupies two
3229 * bytes (is variant) when in UTF-8 (except we've already
3230 * allocated for the end points, including if they are
3231 * variants). For ASCII platforms and Unicode ranges on EBCDIC
3232 * platforms, it's easy to calculate a precise number. To
3233 * start, we count the variants in the range, which we need
3234 * elsewhere in this function anyway. (For the case where it
3235 * isn't easy to calculate, 'extras' has been initialized to 0,
3236 * and the calculation is done in a loop further down.) */
3238 if (convert_unicode)
3241 /* This is executed unconditionally on ASCII, and for
3242 * Unicode ranges on EBCDIC. Under these conditions, all
3243 * code points above a certain value are variant; and none
3244 * under that value are. We just need to find out how much
3245 * of the range is above that value. We don't count the
3246 * end points here, as they will already have been counted
3247 * as they were parsed. */
3248 if (range_min >= UTF_CONTINUATION_MARK) {
3250 /* The whole range is made up of variants */
3251 extras = (range_max - 1) - (range_min + 1) + 1;
3253 else if (range_max >= UTF_CONTINUATION_MARK) {
3255 /* Only the higher portion of the range is variants */
3256 extras = (range_max - 1) - UTF_CONTINUATION_MARK + 1;
3259 utf8_variant_count += extras;
3262 /* The base growth is the number of code points in the range,
3263 * not including the endpoints, which have already been sized
3264 * for (and output). We don't subtract for the hyphen, as it
3265 * has been parsed but not output, and the SvGROW below is
3266 * based only on what's been output plus what's left to parse.
3268 grow = (range_max - 1) - (range_min + 1) + 1;
3272 /* In some cases in EBCDIC, we haven't yet calculated a
3273 * precise amount needed for the UTF-8 variants. Just
3274 * assume the worst case, that everything will expand by a
3276 if (! convert_unicode) {
3282 /* Otherwise we know exactly how many variants there
3283 * are in the range. */
3288 /* Grow, but position the output to overwrite the range min end
3289 * point, because in some cases we overwrite that */
3290 SvCUR_set(sv, d - SvPVX_const(sv));
3291 offset_to_min = min_ptr - SvPVX_const(sv);
3293 /* See Note on sizing above. */
3294 d = offset_to_min + SvGROW(sv, SvCUR(sv)
3297 + 1 /* Trailing NUL */ );
3299 /* Now, we can expand out the range. */
3301 if (convert_unicode) {
3304 /* Recall that the min and max are now in Unicode terms, so
3305 * we have to convert each character to its native
3308 for (i = range_min; i <= range_max; i++) {
3309 append_utf8_from_native_byte(
3310 LATIN1_TO_NATIVE((U8) i),
3315 for (i = range_min; i <= range_max; i++) {
3316 *d++ = (char)LATIN1_TO_NATIVE((U8) i);
3322 /* Always gets run for ASCII, and sometimes for EBCDIC. */
3324 /* Here, no conversions are necessary, which means that the
3325 * first character in the range is already in 'd' and
3326 * valid, so we can skip overwriting it */
3330 for (i = range_min + 1; i <= range_max; i++) {
3331 append_utf8_from_native_byte((U8) i, (U8 **) &d);
3337 assert(range_min + 1 <= range_max);
3338 for (i = range_min + 1; i < range_max; i++) {
3340 /* In this case on EBCDIC, we haven't calculated
3341 * the variants. Do it here, as we go along */
3342 if (! UVCHR_IS_INVARIANT(i)) {
3343 utf8_variant_count++;
3349 /* The range_max is done outside the loop so as to
3350 * avoid having to special case not incrementing
3351 * 'utf8_variant_count' on EBCDIC (it's already been
3352 * counted when originally parsed) */
3353 *d++ = (char) range_max;
3358 /* If the original range extended above 255, add in that
3360 if (real_range_max) {
3361 *d++ = (char) UTF8_TWO_BYTE_HI(0x100);
3362 *d++ = (char) UTF8_TWO_BYTE_LO(0x100);
3363 if (real_range_max > 0x100) {
3364 if (real_range_max > 0x101) {
3365 *d++ = (char) RANGE_INDICATOR;
3367 d = (char*)uvchr_to_utf8((U8*)d, real_range_max);
3373 /* mark the range as done, and continue */
3377 non_portable_endpoint = 0;
3381 } /* End of is a range */
3382 } /* End of transliteration. Joins main code after these else's */
3383 else if (*s == '[' && PL_lex_inpat && !in_charclass) {
3386 while (s1 >= start && *s1-- == '\\')
3389 in_charclass = TRUE;
3391 else if (*s == ']' && PL_lex_inpat && in_charclass) {
3394 while (s1 >= start && *s1-- == '\\')
3397 in_charclass = FALSE;
3399 /* skip for regexp comments /(?#comment)/, except for the last
3400 * char, which will be done separately. Stop on (?{..}) and
3402 else if (*s == '(' && PL_lex_inpat && s[1] == '?' && !in_charclass) {
3405 PERL_UINT_FAST8_T len = UTF8SKIP(s);
3407 while (s + len < send && *s != ')') {
3408 Copy(s, d, len, U8);
3411 len = UTF8_SAFE_SKIP(s, send);
3414 else while (s+1 < send && *s != ')') {
3418 else if (!PL_lex_casemods
3419 && ( s[2] == '{' /* This should match regcomp.c */
3420 || (s[2] == '?' && s[3] == '{')))
3425 /* likewise skip #-initiated comments in //x patterns */
3429 && ((PMOP*)PL_lex_inpat)->op_pmflags & RXf_PMf_EXTENDED)
3431 while (s < send && *s != '\n')
3434 /* no further processing of single-quoted regex */
3435 else if (PL_lex_inpat && SvIVX(PL_linestr) == '\'')
3436 goto default_action;
3438 /* check for embedded arrays
3439 * (@foo, @::foo, @'foo, @{foo}, @$foo, @+, @-)
3441 else if (*s == '@' && s[1]) {
3443 ? isIDFIRST_utf8_safe(s+1, send)
3444 : isWORDCHAR_A(s[1]))
3448 if (memCHRs(":'{$", s[1]))
3450 if (!PL_lex_inpat && (s[1] == '+' || s[1] == '-'))
3451 break; /* in regexp, neither @+ nor @- are interpolated */
3453 /* check for embedded scalars. only stop if we're sure it's a
3455 else if (*s == '$') {
3456 if (!PL_lex_inpat) /* not a regexp, so $ must be var */
3458 if (s + 1 < send && !memCHRs("()| \r\n\t", s[1])) {
3460 Perl_ck_warner(aTHX_ packWARN(WARN_AMBIGUOUS),
3461 "Possible unintended interpolation of $\\ in regex");
3463 break; /* in regexp, $ might be tail anchor */
3467 /* End of else if chain - OP_TRANS rejoin rest */
3469 if (UNLIKELY(s >= send)) {
3475 if (*s == '\\' && s+1 < send) {
3476 char* e; /* Can be used for ending '}', etc. */
3480 /* warn on \1 - \9 in substitution replacements, but note that \11
3481 * is an octal; and \19 is \1 followed by '9' */
3482 if (PL_lex_inwhat == OP_SUBST
3488 /* diag_listed_as: \%d better written as $%d */
3489 Perl_ck_warner(aTHX_ packWARN(WARN_SYNTAX), "\\%c better written as $%c", *s, *s);
3494 /* string-change backslash escapes */
3495 if (PL_lex_inwhat != OP_TRANS && *s && memCHRs("lLuUEQF", *s)) {
3499 /* In a pattern, process \N, but skip any other backslash escapes.
3500 * This is because we don't want to translate an escape sequence
3501 * into a meta symbol and have the regex compiler use the meta
3502 * symbol meaning, e.g. \x{2E} would be confused with a dot. But
3503 * in spite of this, we do have to process \N here while the proper
3504 * charnames handler is in scope. See bugs #56444 and #62056.
3506 * There is a complication because \N in a pattern may also stand
3507 * for 'match a non-nl', and not mean a charname, in which case its
3508 * processing should be deferred to the regex compiler. To be a
3509 * charname it must be followed immediately by a '{', and not look
3510 * like \N followed by a curly quantifier, i.e., not something like
3511 * \N{3,}. regcurly returns a boolean indicating if it is a legal
3513 else if (PL_lex_inpat
3516 || regcurly(s + 1)))
3519 goto default_action;
3525 if ((isALPHANUMERIC(*s)))
3526 Perl_ck_warner(aTHX_ packWARN(WARN_MISC),
3527 "Unrecognized escape \\%c passed through",
3529 /* default action is to copy the quoted character */
3530 goto default_action;
3533 /* eg. \132 indicates the octal constant 0132 */
3534 case '0': case '1': case '2': case '3':
3535 case '4': case '5': case '6': case '7':
3537 I32 flags = PERL_SCAN_SILENT_ILLDIGIT
3538 | PERL_SCAN_NOTIFY_ILLDIGIT;
3540 uv = grok_oct(s, &len, &flags, NULL);
3542 if ( (flags & PERL_SCAN_NOTIFY_ILLDIGIT)
3544 && isDIGIT(*s) /* like \08, \178 */
3545 && ckWARN(WARN_MISC))
3547 Perl_warner(aTHX_ packWARN(WARN_MISC), "%s",
3548 form_alien_digit_msg(8, len, s, send, UTF, FALSE));
3551 goto NUM_ESCAPE_INSERT;
3553 /* eg. \o{24} indicates the octal constant \024 */
3558 if (! grok_bslash_o(&s, send,
3561 FALSE, /* Not strict */
3562 FALSE, /* No illegal cp's */
3566 uv = 0; /* drop through to ensure range ends are set */
3568 goto NUM_ESCAPE_INSERT;
3571 /* eg. \x24 indicates the hex constant 0x24 */
3576 if (! grok_bslash_x(&s, send,
3579 FALSE, /* Not strict */
3580 FALSE, /* No illegal cp's */
3584 uv = 0; /* drop through to ensure range ends are set */
3589 /* Insert oct or hex escaped character. */
3591 /* Here uv is the ordinal of the next character being added */
3592 if (UVCHR_IS_INVARIANT(uv)) {
3596 if (!d_is_utf8 && uv > 255) {
3598 /* Here, 'uv' won't fit unless we convert to UTF-8.
3599 * If we've only seen invariants so far, all we have to
3600 * do is turn on the flag */
3601 if (utf8_variant_count == 0) {
3605 SvCUR_set(sv, d - SvPVX_const(sv));
3609 sv_utf8_upgrade_flags_grow(
3611 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3613 /* Since we're having to grow here,
3614 * make sure we have enough room for
3615 * this escape and a NUL, so the
3616 * code immediately below won't have
3617 * to actually grow again */
3619 + (STRLEN)(send - s) + 1);
3620 d = SvPVX(sv) + SvCUR(sv);
3623 has_above_latin1 = TRUE;
3629 utf8_variant_count++;
3632 /* Usually, there will already be enough room in 'sv'
3633 * since such escapes are likely longer than any UTF-8
3634 * sequence they can end up as. This isn't the case on
3635 * EBCDIC where \x{40000000} contains 12 bytes, and the
3636 * UTF-8 for it contains 14. And, we have to allow for
3637 * a trailing NUL. It probably can't happen on ASCII
3638 * platforms, but be safe. See Note on sizing above. */
3639 const STRLEN needed = d - SvPVX(sv)
3643 if (UNLIKELY(needed > SvLEN(sv))) {
3644 SvCUR_set(sv, d - SvPVX_const(sv));
3645 d = SvCUR(sv) + SvGROW(sv, needed);
3648 d = (char*) uvchr_to_utf8_flags((U8*)d, uv,
3649 (ckWARN(WARN_PORTABLE))
3650 ? UNICODE_WARN_PERL_EXTENDED
3655 non_portable_endpoint++;
3660 /* In a non-pattern \N must be like \N{U+0041}, or it can be a
3661 * named character, like \N{LATIN SMALL LETTER A}, or a named
3662 * sequence, like \N{LATIN CAPITAL LETTER A WITH MACRON AND
3663 * GRAVE} (except y/// can't handle the latter, croaking). For
3664 * convenience all three forms are referred to as "named
3665 * characters" below.
3667 * For patterns, \N also can mean to match a non-newline. Code
3668 * before this 'switch' statement should already have handled
3669 * this situation, and hence this code only has to deal with
3670 * the named character cases.
3672 * For non-patterns, the named characters are converted to
3673 * their string equivalents. In patterns, named characters are
3674 * not converted to their ultimate forms for the same reasons
3675 * that other escapes aren't (mainly that the ultimate
3676 * character could be considered a meta-symbol by the regex
3677 * compiler). Instead, they are converted to the \N{U+...}
3678 * form to get the value from the charnames that is in effect
3679 * right now, while preserving the fact that it was a named
3680 * character, so that the regex compiler knows this.
3682 * The structure of this section of code (besides checking for
3683 * errors and upgrading to utf8) is:
3684 * If the named character is of the form \N{U+...}, pass it
3685 * through if a pattern; otherwise convert the code point
3687 * Otherwise must be some \N{NAME}: convert to
3688 * \N{U+c1.c2...} if a pattern; otherwise convert to utf8
3690 * Transliteration is an exception. The conversion to utf8 is
3691 * only done if the code point requires it to be representable.
3693 * Here, 's' points to the 'N'; the test below is guaranteed to
3694 * succeed if we are being called on a pattern, as we already
3695 * know from a test above that the next character is a '{'. A
3696 * non-pattern \N must mean 'named character', which requires
3700 yyerror("Missing braces on \\N{}");
3706 /* If there is no matching '}', it is an error. */
3707 if (! (e = (char *) memchr(s, '}', send - s))) {
3708 if (! PL_lex_inpat) {
3709 yyerror("Missing right brace on \\N{}");
3711 yyerror("Missing right brace on \\N{} or unescaped left brace after \\N");
3713 yyquit(); /* Have exhausted the input. */
3716 /* Here it looks like a named character */
3718 if (*s == 'U' && s[1] == '+') { /* \N{U+...} */
3719 s += 2; /* Skip to next char after the 'U+' */
3722 /* In patterns, we can have \N{U+xxxx.yyyy.zzzz...} */
3723 /* Check the syntax. */
3726 if (!isXDIGIT(*s)) {
3729 "Invalid hexadecimal number in \\N{U+...}"
3738 else if ((*s == '.' || *s == '_')
3744 /* Pass everything through unchanged.
3745 * +1 is for the '}' */
3746 Copy(orig_s, d, e - orig_s + 1, char);
3747 d += e - orig_s + 1;
3749 else { /* Not a pattern: convert the hex to string */
3750 I32 flags = PERL_SCAN_ALLOW_UNDERSCORES
3751 | PERL_SCAN_SILENT_ILLDIGIT
3752 | PERL_SCAN_DISALLOW_PREFIX;
3754 uv = grok_hex(s, &len, &flags, NULL);
3755 if (len == 0 || (len != (STRLEN)(e - s)))
3758 /* For non-tr///, if the destination is not in utf8,
3759 * unconditionally recode it to be so. This is
3760 * because \N{} implies Unicode semantics, and scalars
3761 * have to be in utf8 to guarantee those semantics.
3762 * tr/// doesn't care about Unicode rules, so no need
3763 * there to upgrade to UTF-8 for small enough code
3765 if (! d_is_utf8 && ( uv > 0xFF
3766 || PL_lex_inwhat != OP_TRANS))
3768 /* See Note on sizing above. */
3769 const STRLEN extra = OFFUNISKIP(uv) + (send - e) + 1;
3771 SvCUR_set(sv, d - SvPVX_const(sv));
3775 if (utf8_variant_count == 0) {
3777 d = SvCUR(sv) + SvGROW(sv, SvCUR(sv) + extra);
3780 sv_utf8_upgrade_flags_grow(
3782 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3784 d = SvPVX(sv) + SvCUR(sv);
3788 has_above_latin1 = TRUE;
3791 /* Add the (Unicode) code point to the output. */
3792 if (! d_is_utf8 || OFFUNI_IS_INVARIANT(uv)) {
3793 *d++ = (char) LATIN1_TO_NATIVE(uv);
3796 d = (char*) uvoffuni_to_utf8_flags((U8*)d, uv,
3797 (ckWARN(WARN_PORTABLE))
3798 ? UNICODE_WARN_PERL_EXTENDED
3803 else /* Here is \N{NAME} but not \N{U+...}. */
3804 if (! (res = get_and_check_backslash_N_name_wrapper(s, e)))
3805 { /* Failed. We should die eventually, but for now use a NUL
3809 else { /* Successfully evaluated the name */
3811 const char *str = SvPV_const(res, len);
3814 if (! len) { /* The name resolved to an empty string */
3815 const char empty_N[] = "\\N{_}";
3816 Copy(empty_N, d, sizeof(empty_N) - 1, char);
3817 d += sizeof(empty_N) - 1;
3820 /* In order to not lose information for the regex
3821 * compiler, pass the result in the specially made
3822 * syntax: \N{U+c1.c2.c3...}, where c1 etc. are
3823 * the code points in hex of each character
3824 * returned by charnames */
3826 const char *str_end = str + len;
3827 const STRLEN off = d - SvPVX_const(sv);
3829 if (! SvUTF8(res)) {
3830 /* For the non-UTF-8 case, we can determine the
3831 * exact length needed without having to parse
3832 * through the string. Each character takes up
3833 * 2 hex digits plus either a trailing dot or
3835 const char initial_text[] = "\\N{U+";
3836 const STRLEN initial_len = sizeof(initial_text)
3838 d = off + SvGROW(sv, off
3841 /* +1 for trailing NUL */
3844 + (STRLEN)(send - e));
3845 Copy(initial_text, d, initial_len, char);
3847 while (str < str_end) {
3850 my_snprintf(hex_string,
3854 /* The regex compiler is
3855 * expecting Unicode, not
3857 NATIVE_TO_LATIN1(*str));
3858 PERL_MY_SNPRINTF_POST_GUARD(len,
3859 sizeof(hex_string));
3860 Copy(hex_string, d, 3, char);
3864 d--; /* Below, we will overwrite the final
3865 dot with a right brace */
3868 STRLEN char_length; /* cur char's byte length */
3870 /* and the number of bytes after this is
3871 * translated into hex digits */
3872 STRLEN output_length;
3874 /* 2 hex per byte; 2 chars for '\N'; 2 chars
3875 * for max('U+', '.'); and 1 for NUL */
3876 char hex_string[2 * UTF8_MAXBYTES + 5];
3878 /* Get the first character of the result. */
3879 U32 uv = utf8n_to_uvchr((U8 *) str,
3883 /* Convert first code point to Unicode hex,
3884 * including the boiler plate before it. */
3886 my_snprintf(hex_string, sizeof(hex_string),
3888 (unsigned int) NATIVE_TO_UNI(uv));
3890 /* Make sure there is enough space to hold it */
3891 d = off + SvGROW(sv, off
3893 + (STRLEN)(send - e)
3894 + 2); /* '}' + NUL */
3896 Copy(hex_string, d, output_length, char);
3899 /* For each subsequent character, append dot and
3900 * its Unicode code point in hex */
3901 while ((str += char_length) < str_end) {
3902 const STRLEN off = d - SvPVX_const(sv);
3903 U32 uv = utf8n_to_uvchr((U8 *) str,
3908 my_snprintf(hex_string,
3911 (unsigned int) NATIVE_TO_UNI(uv));
3913 d = off + SvGROW(sv, off
3915 + (STRLEN)(send - e)
3916 + 2); /* '}' + NUL */
3917 Copy(hex_string, d, output_length, char);
3922 *d++ = '}'; /* Done. Add the trailing brace */
3925 else { /* Here, not in a pattern. Convert the name to a
3928 if (PL_lex_inwhat == OP_TRANS) {
3929 str = SvPV_const(res, len);
3930 if (len > ((SvUTF8(res))
3934 yyerror(Perl_form(aTHX_
3935 "%.*s must not be a named sequence"
3936 " in transliteration operator",
3937 /* +1 to include the "}" */
3938 (int) (e + 1 - start), start));
3940 goto end_backslash_N;
3943 if (SvUTF8(res) && UTF8_IS_ABOVE_LATIN1(*str)) {
3944 has_above_latin1 = TRUE;
3948 else if (! SvUTF8(res)) {
3949 /* Make sure \N{} return is UTF-8. This is because
3950 * \N{} implies Unicode semantics, and scalars have
3951 * to be in utf8 to guarantee those semantics; but
3952 * not needed in tr/// */
3953 sv_utf8_upgrade_flags(res, 0);
3954 str = SvPV_const(res, len);
3957 /* Upgrade destination to be utf8 if this new
3959 if (! d_is_utf8 && SvUTF8(res)) {
3960 /* See Note on sizing above. */
3961 const STRLEN extra = len + (send - s) + 1;
3963 SvCUR_set(sv, d - SvPVX_const(sv));
3967 if (utf8_variant_count == 0) {
3969 d = SvCUR(sv) + SvGROW(sv, SvCUR(sv) + extra);
3972 sv_utf8_upgrade_flags_grow(sv,
3973 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
3975 d = SvPVX(sv) + SvCUR(sv);
3978 } else if (len > (STRLEN)(e - s + 4)) { /* I _guess_ 4 is \N{} --jhi */
3980 /* See Note on sizing above. (NOTE: SvCUR() is not
3981 * set correctly here). */
3982 const STRLEN extra = len + (send - e) + 1;
3983 const STRLEN off = d - SvPVX_const(sv);
3984 d = off + SvGROW(sv, off + extra);
3986 Copy(str, d, len, char);
3992 } /* End \N{NAME} */
3996 backslash_N++; /* \N{} is defined to be Unicode */
3998 s = e + 1; /* Point to just after the '}' */
4001 /* \c is a control character */
4005 const char * message;
4007 if (! grok_bslash_c(*s, (U8 *) d, &message, NULL)) {
4009 yyquit(); /* Have always immediately croaked on
4015 yyerror("Missing control char name in \\c");
4016 yyquit(); /* Are at end of input, no sense continuing */
4019 non_portable_endpoint++;
4023 /* printf-style backslashes, formfeeds, newlines, etc */
4049 } /* end if (backslash) */
4052 /* Just copy the input to the output, though we may have to convert
4055 * If the input has the same representation in UTF-8 as not, it will be
4056 * a single byte, and we don't care about UTF8ness; just copy the byte */
4057 if (NATIVE_BYTE_IS_INVARIANT((U8)(*s))) {
4060 else if (! s_is_utf8 && ! d_is_utf8) {
4061 /* If neither source nor output is UTF-8, is also a single byte,
4062 * just copy it; but this byte counts should we later have to
4063 * convert to UTF-8 */
4065 utf8_variant_count++;
4067 else if (s_is_utf8 && d_is_utf8) { /* Both UTF-8, can just copy */
4068 const STRLEN len = UTF8SKIP(s);
4070 /* We expect the source to have already been checked for
4072 assert(isUTF8_CHAR((U8 *) s, (U8 *) send));
4074 Copy(s, d, len, U8);
4078 else if (s_is_utf8) { /* UTF8ness matters: convert output to utf8 */
4079 STRLEN need = send - s + 1; /* See Note on sizing above. */
4081 SvCUR_set(sv, d - SvPVX_const(sv));
4085 if (utf8_variant_count == 0) {
4087 d = SvCUR(sv) + SvGROW(sv, SvCUR(sv) + need);
4090 sv_utf8_upgrade_flags_grow(sv,
4091 SV_GMAGIC|SV_FORCE_UTF8_UPGRADE,
4093 d = SvPVX(sv) + SvCUR(sv);
4096 goto default_action; /* Redo, having upgraded so both are UTF-8 */
4098 else { /* UTF8ness matters: convert this non-UTF8 source char to
4099 UTF-8 for output. It will occupy 2 bytes, but don't include
4100 the input byte since we haven't incremented 's' yet. See
4101 Note on sizing above. */
4102 const STRLEN off = d - SvPVX(sv);
4103 const STRLEN extra = 2 + (send - s - 1) + 1;
4104 if (off + extra > SvLEN(sv)) {
4105 d = off + SvGROW(sv, off + extra);
4107 *d++ = UTF8_EIGHT_BIT_HI(*s);
4108 *d++ = UTF8_EIGHT_BIT_LO(*s);
4111 } /* while loop to process each character */
4114 const STRLEN off = d - SvPVX(sv);
4116 /* See if room for the terminating NUL */
4117 if (UNLIKELY(off >= SvLEN(sv))) {
4121 if (off > SvLEN(sv))
4123 Perl_croak(aTHX_ "panic: constant overflowed allocated space,"
4124 " %" UVuf " >= %" UVuf, (UV)off, (UV)SvLEN(sv));
4126 /* Whew! Here we don't have room for the terminating NUL, but
4127 * everything else so far has fit. It's not too late to grow
4128 * to fit the NUL and continue on. But it is a bug, as the code
4129 * above was supposed to have made room for this, so under
4130 * DEBUGGING builds, we panic anyway. */
4131 d = off + SvGROW(sv, off + 1);
4135 /* terminate the string and set up the sv */
4137 SvCUR_set(sv, d - SvPVX_const(sv));
4144 /* shrink the sv if we allocated more than we used */
4145 if (SvCUR(sv) + 5 < SvLEN(sv)) {
4146 SvPV_shrink_to_cur(sv);
4149 /* return the substring (via pl_yylval) only if we parsed anything */
4152 for (; s2 < s; s2++) {
4154 COPLINE_INC_WITH_HERELINES;
4156 SvREFCNT_inc_simple_void_NN(sv);
4157 if ( (PL_hints & ( PL_lex_inpat ? HINT_NEW_RE : HINT_NEW_STRING ))
4158 && ! PL_parser->lex_re_reparsing)
4160 const char *const key = PL_lex_inpat ? "qr" : "q";
4161 const STRLEN keylen = PL_lex_inpat ? 2 : 1;
4165 if (PL_lex_inwhat == OP_TRANS) {
4168 } else if (PL_lex_inwhat == OP_SUBST && !PL_lex_inpat) {
4171 } else if (PL_lex_inpat && SvIVX(PL_linestr) == '\'') {
4179 sv = S_new_constant(aTHX_ start, s - start, key, keylen, sv, NULL,
4180 type, typelen, NULL);
4182 pl_yylval.opval = newSVOP(OP_CONST, 0, sv);
4184 LEAVE_with_name("scan_const");
4189 * Returns TRUE if there's more to the expression (e.g., a subscript),
4192 * It deals with "$foo[3]" and /$foo[3]/ and /$foo[0123456789$]+/
4194 * ->[ and ->{ return TRUE
4195 * ->$* ->$#* ->@* ->@[ ->@{ return TRUE if postderef_qq is enabled
4196 * { and [ outside a pattern are always subscripts, so return TRUE
4197 * if we're outside a pattern and it's not { or [, then return FALSE
4198 * if we're in a pattern and the first char is a {
4199 * {4,5} (any digits around the comma) returns FALSE
4200 * if we're in a pattern and the first char is a [
4202 * [SOMETHING] has a funky algorithm to decide whether it's a
4203 * character class or not. It has to deal with things like
4204 * /$foo[-3]/ and /$foo[$bar]/ as well as /$foo[$\d]+/
4205 * anything else returns TRUE
4208 /* This is the one truly awful dwimmer necessary to conflate C and sed. */
4211 S_intuit_more(pTHX_ char *s, char *e)
4213 PERL_ARGS_ASSERT_INTUIT_MORE;
4215 if (PL_lex_brackets)
4217 if (*s == '-' && s[1] == '>' && (s[2] == '[' || s[2] == '{'))
4219 if (*s == '-' && s[1] == '>'
4220 && FEATURE_POSTDEREF_QQ_IS_ENABLED
4221 && ( (s[2] == '$' && (s[3] == '*' || (s[3] == '#' && s[4] == '*')))
4222 ||(s[2] == '@' && memCHRs("*[{",s[3])) ))
4224 if (*s != '{' && *s != '[')
4226 PL_parser->sub_no_recover = TRUE;
4230 /* In a pattern, so maybe we have {n,m}. */
4238 /* On the other hand, maybe we have a character class */
4241 if (*s == ']' || *s == '^')
4244 /* this is terrifying, and it works */
4247 const char * const send = (char *) memchr(s, ']', e - s);
4248 unsigned char un_char, last_un_char;
4249 char tmpbuf[sizeof PL_tokenbuf * 4];
4251 if (!send) /* has to be an expression */
4253 weight = 2; /* let's weigh the evidence */
4257 else if (isDIGIT(*s)) {
4259 if (isDIGIT(s[1]) && s[2] == ']')
4265 Zero(seen,256,char);