stolen_chunk_of_toke.c

   1 /*    stolen_chunk_of_toke.c - from perl 5.8.8 toke.c
   2  *
   3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
   4  *    2000, 2001, 2002, 2003, 2004, 2005, 2006, by Larry Wall and others
   5  *
   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.
   8  *
   9  */
  10
  11 /*
  12  *   "It all comes from here, the stench and the peril."  --Frodo
  13  */
  14
  15 /*
  16  *   this is all blatantly stolen. I sincerely hopes it doesn't fuck anything
  17  *   up but if it does blame me (Matt S Trout), not the poor original authors
  18  */
  19
  20 /* the following #defines are stolen from assorted headers, not toke.c (mst) */
  21
  22 #define skipspace(a)            S_skipspace(aTHX_ a)
  23 #define incline(a)              S_incline(aTHX_ a)
  24 #define filter_gets(a,b,c)      S_filter_gets(aTHX_ a,b,c)
  25 #define scan_str(a,b,c)         S_scan_str(aTHX_ a,b,c)
  26 #define scan_word(a,b,c,d,e)    S_scan_word(aTHX_ a,b,c,d,e)
  27
  28 STATIC void     S_incline(pTHX_ char *s);
  29 STATIC char*    S_skipspace(pTHX_ char *s);
  30 STATIC char *   S_filter_gets(pTHX_ SV *sv, PerlIO *fp, STRLEN append);
  31 STATIC char*    S_scan_str(pTHX_ char *start, int keep_quoted, int keep_delims);
  32 STATIC char*    S_scan_word(pTHX_ char *s, char *dest, STRLEN destlen, int allow_package, STRLEN *slp);
  33
  34 #define DPTR2FPTR(t,p) ((t)PTR2nat(p))  /* data pointer to function pointer */
  35 #define FPTR2DPTR(t,p) ((t)PTR2nat(p))  /* function pointer to data pointer */
  36 #define PTR2nat(p)       (PTRV)(p)       /* pointer to integer of PTRSIZE */
  37 #define MEM_WRAP_CHECK_(n,t) MEM_WRAP_CHECK(n,t),
  38
  39 /* conditionalise these two because as of 5.9.5 we already get them from
  40    the headers (mst) */
  41 #ifndef Newx
  42 #define Newx(v,n,t) (v = (MEM_WRAP_CHECK_(n,t) (t*)safemalloc((MEM_SIZE)((n)*sizeof(t)))))
  43 #endif
  44 #ifndef SvPVX_const
  45 #define SvPVX_const(sv) ((const char*) (0 + SvPVX(sv)))
  46 #endif
  47
  48 #define SvPV_renew(sv,n) \
  49   STMT_START { SvLEN_set(sv, n); \
  50     SvPV_set((sv), (MEM_WRAP_CHECK_(n,char)     \
  51         (char*)saferealloc((Malloc_t)SvPVX(sv), \
  52                (MEM_SIZE)((n)))));  \
  53      } STMT_END
  54
  55 /* On MacOS, respect nonbreaking spaces */
  56 #ifdef MACOS_TRADITIONAL
  57 #define SPACE_OR_TAB(c) ((c)==' '||(c)=='\312'||(c)=='\t')
  58 #else
  59 #define SPACE_OR_TAB(c) ((c)==' '||(c)=='\t')
  60 #endif
  61
  62 #define CLINE (PL_copline = (CopLINE(PL_curcop) < PL_copline ? CopLINE(PL_curcop) : PL_copline))
  63
  64 #define LEX_NORMAL    10 /* normal code (ie not within "...")     */
  65 #define LEX_INTERPNORMAL   9 /* code within a string, eg "$foo[$x+1]" */
  66 #define LEX_INTERPCASEMOD  8 /* expecting a \U, \Q or \E etc          */
  67 #define LEX_INTERPPUSH     7 /* starting a new sublex parse level     */
  68 #define LEX_INTERPSTART    6 /* expecting the start of a $var         */
  69
  70            /* at end of code, eg "$x" followed by:  */
  71 #define LEX_INTERPEND    5 /* ... eg not one of [, { or ->          */
  72 #define LEX_INTERPENDMAYBE   4 /* ... eg one of [, { or ->              */
  73
  74 #define LEX_INTERPCONCAT   3 /* expecting anything, eg at start of
  75                 string or after \E, $foo, etc       */
  76 #define LEX_INTERPCONST    2 /* NOT USED */
  77 #define LEX_FORMLINE     1 /* expecting a format line               */
  78 #define LEX_KNOWNEXT     0 /* next token known; just return it      */
  79
  80 /* and these two are my own madness (mst) */
  81
  82 #if PERL_REVISION == 5 && PERL_VERSION == 8 && PERL_SUBVERSION >= 8
  83 #define PERL_5_8_8_PLUS
  84 #endif
  85
  86 #if PERL_REVISION == 5 && PERL_VERSION > 8
  87 #define PERL_5_9_PLUS
  88 #endif
  89
  90 #ifdef PERL_5_9_PLUS
  91 /* 5.9+ moves a bunch of things to a PL_parser struct so we need to
  92    declare the backcompat macros for things to still work (mst) */
  93
  94 /* XXX temporary backwards compatibility */
  95 #define PL_lex_brackets         (PL_parser->lex_brackets)
  96 #define PL_lex_brackstack       (PL_parser->lex_brackstack)
  97 #define PL_lex_casemods         (PL_parser->lex_casemods)
  98 #define PL_lex_casestack        (PL_parser->lex_casestack)
  99 #define PL_lex_defer            (PL_parser->lex_defer)
 100 #define PL_lex_dojoin           (PL_parser->lex_dojoin)
 101 #define PL_lex_expect           (PL_parser->lex_expect)
 102 #define PL_lex_formbrack        (PL_parser->lex_formbrack)
 103 #define PL_lex_inpat            (PL_parser->lex_inpat)
 104 #define PL_lex_inwhat           (PL_parser->lex_inwhat)
 105 #define PL_lex_op               (PL_parser->lex_op)
 106 #define PL_lex_repl             (PL_parser->lex_repl)
 107 #define PL_lex_starts           (PL_parser->lex_starts)
 108 #define PL_lex_stuff            (PL_parser->lex_stuff)
 109 #define PL_multi_start          (PL_parser->multi_start)
 110 #define PL_multi_open           (PL_parser->multi_open)
 111 #define PL_multi_close          (PL_parser->multi_close)
 112 #define PL_pending_ident        (PL_parser->pending_ident)
 113 #define PL_preambled            (PL_parser->preambled)
 114 #define PL_sublex_info          (PL_parser->sublex_info)
 115 #define PL_linestr              (PL_parser->linestr)
 116 #define PL_sublex_info          (PL_parser->sublex_info)
 117 #define PL_linestr              (PL_parser->linestr)
 118 #define PL_expect               (PL_parser->expect)
 119 #define PL_copline              (PL_parser->copline)
 120 #define PL_bufptr               (PL_parser->bufptr)
 121 #define PL_oldbufptr            (PL_parser->oldbufptr)
 122 #define PL_oldoldbufptr         (PL_parser->oldoldbufptr)
 123 #define PL_linestart            (PL_parser->linestart)
 124 #define PL_bufend               (PL_parser->bufend)
 125 #define PL_last_uni             (PL_parser->last_uni)
 126 #define PL_last_lop             (PL_parser->last_lop)
 127 #define PL_last_lop_op          (PL_parser->last_lop_op)
 128 #define PL_lex_state            (PL_parser->lex_state)
 129 #define PL_rsfp                 (PL_parser->rsfp)
 130 #define PL_rsfp_filters         (PL_parser->rsfp_filters)
 131 #define PL_in_my                (PL_parser->in_my)
 132 #define PL_in_my_stash          (PL_parser->in_my_stash)
 133 #define PL_tokenbuf             (PL_parser->tokenbuf)
 134 #define PL_multi_end            (PL_parser->multi_end)
 135 #define PL_error_count          (PL_parser->error_count)
 136 /* these three are from the non-PERL_MAD path but I don't -think- I need
 137    the PERL_MAD stuff since my code isn't really populating things (mst) */
 138 #  define PL_nexttoke           (PL_parser->nexttoke)
 139 #  define PL_nexttype           (PL_parser->nexttype)
 140 #  define PL_nextval            (PL_parser->nextval)
 141 /* end of backcompat macros form 5.9 toke.c (mst) */
 142 #endif
 143 /* we also need this because we define PERL_CORE so handy.h doesn't provide
 144    it for us (mst) */
 145 #ifndef NEWSV
 146 #define NEWSV(x,len)    newSV(len)
 147 #endif
 148
 149 /* when ccflags include -DDEBUGGING we need this for earlier 5.8 perls */
 150 #ifndef SvPV_nolen_const
 151 #define SvPV_nolen_const SvPV_nolen
 152 #endif
 153
 154 /* and now we're back to the toke.c stuff again (mst) */
 155
 156 static const char ident_too_long[] =
 157   "Identifier too long";
 158 static const char c_without_g[] =
 159   "Use of /c modifier is meaningless without /g";
 160 static const char c_in_subst[] =
 161   "Use of /c modifier is meaningless in s///";
 162
 163 #ifdef USE_UTF8_SCRIPTS
 164 #   define UTF (!IN_BYTES)
 165 #else
 166 #   define UTF ((PL_linestr && DO_UTF8(PL_linestr)) || (PL_hints & HINT_UTF8))
 167 #endif
 168
 169 /* Invoke the idxth filter function for the current rsfp.        */
 170 /* maxlen 0 = read one text line */
 171 I32
 172 Perl_filter_read(pTHX_ int idx, SV *buf_sv, int maxlen)
 173 {
 174     filter_t funcp;
 175     SV *datasv = NULL;
 176
 177     if (!PL_rsfp_filters)
 178         return -1;
 179     if (idx > AvFILLp(PL_rsfp_filters)) {       /* Any more filters?    */
 180         /* Provide a default input filter to make life easy.    */
 181         /* Note that we append to the line. This is handy.      */
 182         DEBUG_P(PerlIO_printf(Perl_debug_log,
 183                               "filter_read %d: from rsfp\n", idx));
 184         if (maxlen) {
 185             /* Want a block */
 186             int len ;
 187             const int old_len = SvCUR(buf_sv);
 188
 189             /* ensure buf_sv is large enough */
 190             SvGROW(buf_sv, (STRLEN)(old_len + maxlen)) ;
 191             if ((len = PerlIO_read(PL_rsfp, SvPVX(buf_sv) + old_len, maxlen)) <= 0){
 192                 if (PerlIO_error(PL_rsfp))
 193                     return -1;          /* error */
 194                 else
 195                     return 0 ;          /* end of file */
 196             }
 197             SvCUR_set(buf_sv, old_len + len) ;
 198         } else {
 199             /* Want a line */
 200             if (sv_gets(buf_sv, PL_rsfp, SvCUR(buf_sv)) == NULL) {
 201                 if (PerlIO_error(PL_rsfp))
 202                     return -1;          /* error */
 203                 else
 204                     return 0 ;          /* end of file */
 205             }
 206         }
 207         return SvCUR(buf_sv);
 208     }
 209     /* Skip this filter slot if filter has been deleted */
 210     if ( (datasv = FILTER_DATA(idx)) == &PL_sv_undef) {
 211         DEBUG_P(PerlIO_printf(Perl_debug_log,
 212                               "filter_read %d: skipped (filter deleted)\n",
 213                               idx));
 214         return FILTER_READ(idx+1, buf_sv, maxlen); /* recurse */
 215     }
 216     /* Get function pointer hidden within datasv        */
 217     funcp = DPTR2FPTR(filter_t, IoANY(datasv));
 218     DEBUG_P(PerlIO_printf(Perl_debug_log,
 219                           "filter_read %d: via function %p (%s)\n",
 220                           idx, datasv, SvPV_nolen_const(datasv)));
 221     /* Call function. The function is expected to       */
 222     /* call "FILTER_READ(idx+1, buf_sv)" first.         */
 223     /* Return: <0:error, =0:eof, >0:not eof             */
 224     return (*funcp)(aTHX_ idx, buf_sv, maxlen);
 225 }
 226
 227 STATIC char *
 228 S_filter_gets(pTHX_ register SV *sv, register PerlIO *fp, STRLEN append)
 229 {
 230 #ifdef PERL_CR_FILTER
 231     if (!PL_rsfp_filters) {
 232         filter_add(S_cr_textfilter,NULL);
 233     }
 234 #endif
 235     if (PL_rsfp_filters) {
 236         if (!append)
 237             SvCUR_set(sv, 0);   /* start with empty line        */
 238         if (FILTER_READ(0, sv, 0) > 0)
 239             return ( SvPVX(sv) ) ;
 240         else
 241             return Nullch ;
 242     }
 243     else
 244         return (sv_gets(sv, fp, append));
 245 }
 246
 247 /*
 248  * S_skipspace
 249  * Called to gobble the appropriate amount and type of whitespace.
 250  * Skips comments as well.
 251  */
 252
 253 STATIC char *
 254 S_skipspace(pTHX_ register char *s)
 255 {
 256     if (PL_lex_formbrack && PL_lex_brackets <= PL_lex_formbrack) {
 257         while (s < PL_bufend && SPACE_OR_TAB(*s))
 258             s++;
 259         return s;
 260     }
 261     for (;;) {
 262         STRLEN prevlen;
 263         SSize_t oldprevlen, oldoldprevlen;
 264         SSize_t oldloplen = 0, oldunilen = 0;
 265         while (s < PL_bufend && isSPACE(*s)) {
 266             if (*s++ == '\n' && PL_in_eval && !PL_rsfp)
 267                 incline(s);
 268         }
 269
 270         /* comment */
 271         if (s < PL_bufend && *s == '#') {
 272             while (s < PL_bufend && *s != '\n')
 273                 s++;
 274             if (s < PL_bufend) {
 275                 s++;
 276                 if (PL_in_eval && !PL_rsfp) {
 277                     incline(s);
 278                     continue;
 279                 }
 280             }
 281         }
 282
 283         /* only continue to recharge the buffer if we're at the end
 284          * of the buffer, we're not reading from a source filter, and
 285          * we're in normal lexing mode
 286          */
 287         if (s < PL_bufend || !PL_rsfp || PL_sublex_info.sub_inwhat ||
 288                 PL_lex_state == LEX_FORMLINE)
 289             return s;
 290
 291         /* try to recharge the buffer */
 292         if ((s = filter_gets(PL_linestr, PL_rsfp,
 293                              (prevlen = SvCUR(PL_linestr)))) == Nullch)
 294         {
 295             /* end of file.  Add on the -p or -n magic */
 296             if (PL_minus_p) {
 297                 sv_setpv(PL_linestr,
 298                          ";}continue{print or die qq(-p destination: $!\\n);}");
 299                 PL_minus_n = PL_minus_p = 0;
 300             }
 301             else if (PL_minus_n) {
 302                 sv_setpvn(PL_linestr, ";}", 2);
 303                 PL_minus_n = 0;
 304             }
 305             else
 306                 sv_setpvn(PL_linestr,";", 1);
 307
 308             /* reset variables for next time we lex */
 309             PL_oldoldbufptr = PL_oldbufptr = PL_bufptr = s = PL_linestart
 310                 = SvPVX(PL_linestr);
 311             PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
 312             PL_last_lop = PL_last_uni = Nullch;
 313
 314             /* Close the filehandle.  Could be from -P preprocessor,
 315              * STDIN, or a regular file.  If we were reading code from
 316              * STDIN (because the commandline held no -e or filename)
 317              * then we don't close it, we reset it so the code can
 318              * read from STDIN too.
 319              */
 320
 321             if (PL_preprocess && !PL_in_eval)
 322                 (void)PerlProc_pclose(PL_rsfp);
 323             else if ((PerlIO*)PL_rsfp == PerlIO_stdin())
 324                 PerlIO_clearerr(PL_rsfp);
 325             else
 326                 (void)PerlIO_close(PL_rsfp);
 327             PL_rsfp = Nullfp;
 328             return s;
 329         }
 330
 331         /* not at end of file, so we only read another line */
 332         /* make corresponding updates to old pointers, for yyerror() */
 333         oldprevlen = PL_oldbufptr - PL_bufend;
 334         oldoldprevlen = PL_oldoldbufptr - PL_bufend;
 335         if (PL_last_uni)
 336             oldunilen = PL_last_uni - PL_bufend;
 337         if (PL_last_lop)
 338             oldloplen = PL_last_lop - PL_bufend;
 339         PL_linestart = PL_bufptr = s + prevlen;
 340         PL_bufend = s + SvCUR(PL_linestr);
 341         s = PL_bufptr;
 342         PL_oldbufptr = s + oldprevlen;
 343         PL_oldoldbufptr = s + oldoldprevlen;
 344         if (PL_last_uni)
 345             PL_last_uni = s + oldunilen;
 346         if (PL_last_lop)
 347             PL_last_lop = s + oldloplen;
 348         incline(s);
 349
 350         /* debugger active and we're not compiling the debugger code,
 351          * so store the line into the debugger's array of lines
 352          */
 353         if (PERLDB_LINE && PL_curstash != PL_debstash) {
 354             SV * const sv = NEWSV(85,0);
 355
 356             sv_upgrade(sv, SVt_PVMG);
 357             sv_setpvn(sv,PL_bufptr,PL_bufend-PL_bufptr);
 358             (void)SvIOK_on(sv);
 359             SvIV_set(sv, 0);
 360             av_store(CopFILEAV(PL_curcop),(I32)CopLINE(PL_curcop),sv);
 361         }
 362     }
 363 }
 364
 365 STATIC char *
 366 S_scan_word(pTHX_ register char *s, char *dest, STRLEN destlen, int allow_package, STRLEN *slp)
 367 {
 368     register char *d = dest;
 369     register char * const e = d + destlen - 3;  /* two-character token, ending NUL */
 370     for (;;) {
 371         if (d >= e)
 372             Perl_croak(aTHX_ ident_too_long);
 373         if (isALNUM(*s))        /* UTF handled below */
 374             *d++ = *s++;
 375         else if (*s == '\'' && allow_package && isIDFIRST_lazy_if(s+1,UTF)) {
 376             *d++ = ':';
 377             *d++ = ':';
 378             s++;
 379         }
 380         else if (*s == ':' && s[1] == ':' && allow_package && s[2] != '$') {
 381             *d++ = *s++;
 382             *d++ = *s++;
 383         }
 384         else if (UTF && UTF8_IS_START(*s) && isALNUM_utf8((U8*)s)) {
 385             char *t = s + UTF8SKIP(s);
 386             while (UTF8_IS_CONTINUED(*t) && is_utf8_mark((U8*)t))
 387                 t += UTF8SKIP(t);
 388             if (d + (t - s) > e)
 389                 Perl_croak(aTHX_ ident_too_long);
 390             Copy(s, d, t - s, char);
 391             d += t - s;
 392             s = t;
 393         }
 394         else {
 395             *d = '\0';
 396             *slp = d - dest;
 397             return s;
 398         }
 399     }
 400 }
 401
 402 /*
 403  * S_incline
 404  * This subroutine has nothing to do with tilting, whether at windmills
 405  * or pinball tables.  Its name is short for "increment line".  It
 406  * increments the current line number in CopLINE(PL_curcop) and checks
 407  * to see whether the line starts with a comment of the form
 408  *    # line 500 "foo.pm"
 409  * If so, it sets the current line number and file to the values in the comment.
 410  */
 411
 412 STATIC void
 413 S_incline(pTHX_ char *s)
 414 {
 415     char *t;
 416     char *n;
 417     char *e;
 418     char ch;
 419
 420     CopLINE_inc(PL_curcop);
 421     if (*s++ != '#')
 422         return;
 423     while (SPACE_OR_TAB(*s)) s++;
 424     if (strnEQ(s, "line", 4))
 425         s += 4;
 426     else
 427         return;
 428     if (SPACE_OR_TAB(*s))
 429         s++;
 430     else
 431         return;
 432     while (SPACE_OR_TAB(*s)) s++;
 433     if (!isDIGIT(*s))
 434         return;
 435     n = s;
 436     while (isDIGIT(*s))
 437         s++;
 438     while (SPACE_OR_TAB(*s))
 439         s++;
 440     if (*s == '"' && (t = strchr(s+1, '"'))) {
 441         s++;
 442         e = t + 1;
 443     }
 444     else {
 445         for (t = s; !isSPACE(*t); t++) ;
 446         e = t;
 447     }
 448     while (SPACE_OR_TAB(*e) || *e == '\r' || *e == '\f')
 449         e++;
 450     if (*e != '\n' && *e != '\0')
 451         return;         /* false alarm */
 452
 453     ch = *t;
 454     *t = '\0';
 455     if (t - s > 0) {
 456 /* this chunk was added to S_incline during 5.8.8. I don't know why but I don't
 457    honestly care since I probably want to be bug-compatible anyway (mst) */
 458
 459 /* ... my kingdom for a perl parser in perl ... (mst) */
 460
 461 #ifdef PERL_5_8_8_PLUS
 462 #ifndef USE_ITHREADS
 463         const char *cf = CopFILE(PL_curcop);
 464         if (cf && strlen(cf) > 7 && strnEQ(cf, "(eval ", 6)) {
 465             /* must copy *{"::_<(eval N)[oldfilename:L]"}
 466              * to *{"::_<newfilename"} */
 467             char smallbuf[256], smallbuf2[256];
 468             char *tmpbuf, *tmpbuf2;
 469             GV **gvp, *gv2;
 470             STRLEN tmplen = strlen(cf);
 471             STRLEN tmplen2 = strlen(s);
 472             if (tmplen + 3 < sizeof smallbuf)
 473                 tmpbuf = smallbuf;
 474             else
 475                 Newx(tmpbuf, tmplen + 3, char);
 476             if (tmplen2 + 3 < sizeof smallbuf2)
 477                 tmpbuf2 = smallbuf2;
 478             else
 479                 Newx(tmpbuf2, tmplen2 + 3, char);
 480             tmpbuf[0] = tmpbuf2[0] = '_';
 481             tmpbuf[1] = tmpbuf2[1] = '<';
 482             memcpy(tmpbuf + 2, cf, ++tmplen);
 483             memcpy(tmpbuf2 + 2, s, ++tmplen2);
 484             ++tmplen; ++tmplen2;
 485             gvp = (GV**)hv_fetch(PL_defstash, tmpbuf, tmplen, FALSE);
 486             if (gvp) {
 487                 gv2 = *(GV**)hv_fetch(PL_defstash, tmpbuf2, tmplen2, TRUE);
 488                 if (!isGV(gv2))
 489                     gv_init(gv2, PL_defstash, tmpbuf2, tmplen2, FALSE);
 490                 /* adjust ${"::_<newfilename"} to store the new file name */
 491                 GvSV(gv2) = newSVpvn(tmpbuf2 + 2, tmplen2 - 2);
 492                 GvHV(gv2) = (HV*)SvREFCNT_inc(GvHV(*gvp));
 493                 GvAV(gv2) = (AV*)SvREFCNT_inc(GvAV(*gvp));
 494             }
 495             if (tmpbuf != smallbuf) Safefree(tmpbuf);
 496             if (tmpbuf2 != smallbuf2) Safefree(tmpbuf2);
 497         }
 498 #endif
 499 #endif
 500 /* second endif closes out the "are we 5.8.(8+)" conditional */
 501         CopFILE_free(PL_curcop);
 502         CopFILE_set(PL_curcop, s);
 503     }
 504     *t = ch;
 505     CopLINE_set(PL_curcop, atoi(n)-1);
 506 }
 507
 508 /* scan_str
 509    takes: start position in buffer
 510           keep_quoted preserve \ on the embedded delimiter(s)
 511           keep_delims preserve the delimiters around the string
 512    returns: position to continue reading from buffer
 513    side-effects: multi_start, multi_close, lex_repl or lex_stuff, and
 514         updates the read buffer.
 515
 516    This subroutine pulls a string out of the input.  It is called for:
 517         q               single quotes           q(literal text)
 518         '               single quotes           'literal text'
 519         qq              double quotes           qq(interpolate $here please)
 520         "               double quotes           "interpolate $here please"
 521         qx              backticks               qx(/bin/ls -l)
 522         `               backticks               `/bin/ls -l`
 523         qw              quote words             @EXPORT_OK = qw( func() $spam )
 524         m//             regexp match            m/this/
 525         s///            regexp substitute       s/this/that/
 526         tr///           string transliterate    tr/this/that/
 527         y///            string transliterate    y/this/that/
 528         ($*@)           sub prototypes          sub foo ($)
 529         (stuff)         sub attr parameters     sub foo : attr(stuff)
 530         <>              readline or globs       <FOO>, <>, <$fh>, or <*.c>
 531
 532    In most of these cases (all but <>, patterns and transliterate)
 533    yylex() calls scan_str().  m// makes yylex() call scan_pat() which
 534    calls scan_str().  s/// makes yylex() call scan_subst() which calls
 535    scan_str().  tr/// and y/// make yylex() call scan_trans() which
 536    calls scan_str().
 537
 538    It skips whitespace before the string starts, and treats the first
 539    character as the delimiter.  If the delimiter is one of ([{< then
 540    the corresponding "close" character )]}> is used as the closing
 541    delimiter.  It allows quoting of delimiters, and if the string has
 542    balanced delimiters ([{<>}]) it allows nesting.
 543
 544    On success, the SV with the resulting string is put into lex_stuff or,
 545    if that is already non-NULL, into lex_repl. The second case occurs only
 546    when parsing the RHS of the special constructs s/// and tr/// (y///).
 547    For convenience, the terminating delimiter character is stuffed into
 548    SvIVX of the SV.
 549 */
 550
 551 STATIC char *
 552 S_scan_str(pTHX_ char *start, int keep_quoted, int keep_delims)
 553 {
 554     SV *sv;                             /* scalar value: string */
 555     char *tmps;                         /* temp string, used for delimiter matching */
 556     register char *s = start;           /* current position in the buffer */
 557     register char term;                 /* terminating character */
 558     register char *to;                  /* current position in the sv's data */
 559     I32 brackets = 1;                   /* bracket nesting level */
 560     bool has_utf8 = FALSE;              /* is there any utf8 content? */
 561     I32 termcode;                       /* terminating char. code */
 562     /* 5.8.7+ uses UTF8_MAXBYTES but also its utf8.h defs _MAXLEN to it so
 563        I'm reasonably hopeful this won't destroy anything (mst) */
 564     U8 termstr[UTF8_MAXLEN];            /* terminating string */
 565     STRLEN termlen;                     /* length of terminating string */
 566     char *last = NULL;                  /* last position for nesting bracket */
 567
 568     /* skip space before the delimiter */
 569     if (isSPACE(*s))
 570         s = skipspace(s);
 571
 572     /* mark where we are, in case we need to report errors */
 573     CLINE;
 574
 575     /* after skipping whitespace, the next character is the terminator */
 576     term = *s;
 577     if (!UTF) {
 578         termcode = termstr[0] = term;
 579         termlen = 1;
 580     }
 581     else {
 582         termcode = utf8_to_uvchr((U8*)s, &termlen);
 583         Copy(s, termstr, termlen, U8);
 584         if (!UTF8_IS_INVARIANT(term))
 585             has_utf8 = TRUE;
 586     }
 587
 588     /* mark where we are */
 589     PL_multi_start = CopLINE(PL_curcop);
 590     PL_multi_open = term;
 591
 592     /* find corresponding closing delimiter */
 593     if (term && (tmps = strchr("([{< )]}> )]}>",term)))
 594         termcode = termstr[0] = term = tmps[5];
 595
 596     PL_multi_close = term;
 597
 598     /* create a new SV to hold the contents.  87 is leak category, I'm
 599        assuming.  79 is the SV's initial length.  What a random number. */
 600     sv = NEWSV(87,79);
 601     sv_upgrade(sv, SVt_PVIV);
 602     SvIV_set(sv, termcode);
 603     (void)SvPOK_only(sv);               /* validate pointer */
 604
 605     /* move past delimiter and try to read a complete string */
 606     if (keep_delims)
 607         sv_catpvn(sv, s, termlen);
 608     s += termlen;
 609     for (;;) {
 610         if (PL_encoding && !UTF) {
 611             bool cont = TRUE;
 612
 613             while (cont) {
 614                 int offset = s - SvPVX_const(PL_linestr);
 615                 const bool found = sv_cat_decode(sv, PL_encoding, PL_linestr,
 616                                            &offset, (char*)termstr, termlen);
 617                 const char *ns = SvPVX_const(PL_linestr) + offset;
 618                 char *svlast = SvEND(sv) - 1;
 619
 620                 for (; s < ns; s++) {
 621                     if (*s == '\n' && !PL_rsfp)
 622                         CopLINE_inc(PL_curcop);
 623                 }
 624                 if (!found)
 625                     goto read_more_line;
 626                 else {
 627                     /* handle quoted delimiters */
 628                     if (SvCUR(sv) > 1 && *(svlast-1) == '\\') {
 629                         const char *t;
 630                         for (t = svlast-2; t >= SvPVX_const(sv) && *t == '\\';)
 631                             t--;
 632                         if ((svlast-1 - t) % 2) {
 633                             if (!keep_quoted) {
 634                                 *(svlast-1) = term;
 635                                 *svlast = '\0';
 636                                 SvCUR_set(sv, SvCUR(sv) - 1);
 637                             }
 638                             continue;
 639                         }
 640                     }
 641                     if (PL_multi_open == PL_multi_close) {
 642                         cont = FALSE;
 643                     }
 644                     else {
 645                         const char *t;
 646                         char *w;
 647                         if (!last)
 648                             last = SvPVX(sv);
 649                         for (t = w = last; t < svlast; w++, t++) {
 650                             /* At here, all closes are "was quoted" one,
 651                                so we don't check PL_multi_close. */
 652                             if (*t == '\\') {
 653                                 if (!keep_quoted && *(t+1) == PL_multi_open)
 654                                     t++;
 655                                 else
 656                                     *w++ = *t++;
 657                             }
 658                             else if (*t == PL_multi_open)
 659                                 brackets++;
 660
 661                             *w = *t;
 662                         }
 663                         if (w < t) {
 664                             *w++ = term;
 665                             *w = '\0';
 666                             SvCUR_set(sv, w - SvPVX_const(sv));
 667                         }
 668                         last = w;
 669                         if (--brackets <= 0)
 670                             cont = FALSE;
 671                     }
 672                 }
 673             }
 674             if (!keep_delims) {
 675                 SvCUR_set(sv, SvCUR(sv) - 1);
 676                 *SvEND(sv) = '\0';
 677             }
 678             break;
 679         }
 680
 681         /* extend sv if need be */
 682         SvGROW(sv, SvCUR(sv) + (PL_bufend - s) + 1);
 683         /* set 'to' to the next character in the sv's string */
 684         to = SvPVX(sv)+SvCUR(sv);
 685
 686         /* if open delimiter is the close delimiter read unbridle */
 687         if (PL_multi_open == PL_multi_close) {
 688             for (; s < PL_bufend; s++,to++) {
 689                 /* embedded newlines increment the current line number */
 690                 if (*s == '\n' && !PL_rsfp)
 691                     CopLINE_inc(PL_curcop);
 692                 /* handle quoted delimiters */
 693                 if (*s == '\\' && s+1 < PL_bufend && term != '\\') {
 694                     if (!keep_quoted && s[1] == term)
 695                         s++;
 696                 /* any other quotes are simply copied straight through */
 697                     else
 698                         *to++ = *s++;
 699                 }
 700                 /* terminate when run out of buffer (the for() condition), or
 701                    have found the terminator */
 702                 else if (*s == term) {
 703                     if (termlen == 1)
 704                         break;
 705                     if (s+termlen <= PL_bufend && memEQ(s, (char*)termstr, termlen))
 706                         break;
 707                 }
 708                 else if (!has_utf8 && !UTF8_IS_INVARIANT((U8)*s) && UTF)
 709                     has_utf8 = TRUE;
 710                 *to = *s;
 711             }
 712         }
 713
 714         /* if the terminator isn't the same as the start character (e.g.,
 715            matched brackets), we have to allow more in the quoting, and
 716            be prepared for nested brackets.
 717         */
 718         else {
 719             /* read until we run out of string, or we find the terminator */
 720             for (; s < PL_bufend; s++,to++) {
 721                 /* embedded newlines increment the line count */
 722                 if (*s == '\n' && !PL_rsfp)
 723                     CopLINE_inc(PL_curcop);
 724                 /* backslashes can escape the open or closing characters */
 725                 if (*s == '\\' && s+1 < PL_bufend) {
 726                     if (!keep_quoted &&
 727                         ((s[1] == PL_multi_open) || (s[1] == PL_multi_close)))
 728                         s++;
 729                     else
 730                         *to++ = *s++;
 731                 }
 732                 /* allow nested opens and closes */
 733                 else if (*s == PL_multi_close && --brackets <= 0)
 734                     break;
 735                 else if (*s == PL_multi_open)
 736                     brackets++;
 737                 else if (!has_utf8 && !UTF8_IS_INVARIANT((U8)*s) && UTF)
 738                     has_utf8 = TRUE;
 739                 *to = *s;
 740             }
 741         }
 742         /* terminate the copied string and update the sv's end-of-string */
 743         *to = '\0';
 744         SvCUR_set(sv, to - SvPVX_const(sv));
 745
 746         /*
 747          * this next chunk reads more into the buffer if we're not done yet
 748          */
 749
 750         if (s < PL_bufend)
 751             break;              /* handle case where we are done yet :-) */
 752
 753 #ifndef PERL_STRICT_CR
 754         if (to - SvPVX_const(sv) >= 2) {
 755             if ((to[-2] == '\r' && to[-1] == '\n') ||
 756                 (to[-2] == '\n' && to[-1] == '\r'))
 757             {
 758                 to[-2] = '\n';
 759                 to--;
 760                 SvCUR_set(sv, to - SvPVX_const(sv));
 761             }
 762             else if (to[-1] == '\r')
 763                 to[-1] = '\n';
 764         }
 765         else if (to - SvPVX_const(sv) == 1 && to[-1] == '\r')
 766             to[-1] = '\n';
 767 #endif
 768
 769      read_more_line:
 770         /* if we're out of file, or a read fails, bail and reset the current
 771            line marker so we can report where the unterminated string began
 772         */
 773         if (!PL_rsfp ||
 774          !(PL_oldoldbufptr = PL_oldbufptr = s = PL_linestart = filter_gets(PL_linestr, PL_rsfp, 0))) {
 775             sv_free(sv);
 776             CopLINE_set(PL_curcop, (line_t)PL_multi_start);
 777             return Nullch;
 778         }
 779         /* we read a line, so increment our line counter */
 780         CopLINE_inc(PL_curcop);
 781
 782         /* update debugger info */
 783         if (PERLDB_LINE && PL_curstash != PL_debstash) {
 784             SV *sv = NEWSV(88,0);
 785
 786             sv_upgrade(sv, SVt_PVMG);
 787             sv_setsv(sv,PL_linestr);
 788             (void)SvIOK_on(sv);
 789             SvIV_set(sv, 0);
 790             av_store(CopFILEAV(PL_curcop), (I32)CopLINE(PL_curcop), sv);
 791         }
 792
 793         /* having changed the buffer, we must update PL_bufend */
 794         PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
 795         PL_last_lop = PL_last_uni = Nullch;
 796     }
 797
 798     /* at this point, we have successfully read the delimited string */
 799
 800     if (!PL_encoding || UTF) {
 801         if (keep_delims)
 802             sv_catpvn(sv, s, termlen);
 803         s += termlen;
 804     }
 805     if (has_utf8 || PL_encoding)
 806         SvUTF8_on(sv);
 807
 808     PL_multi_end = CopLINE(PL_curcop);
 809
 810     /* if we allocated too much space, give some back */
 811     if (SvCUR(sv) + 5 < SvLEN(sv)) {
 812         SvLEN_set(sv, SvCUR(sv) + 1);
 813 /* 5.8.8 uses SvPV_renew, no prior version actually has the damn thing (mst) */
 814 #ifdef PERL_5_8_8_PLUS
 815         SvPV_renew(sv, SvLEN(sv));
 816 #else
 817         Renew(SvPVX(sv), SvLEN(sv), char);
 818 #endif
 819     }
 820
 821     /* decide whether this is the first or second quoted string we've read
 822        for this op
 823     */
 824
 825     if (PL_lex_stuff)
 826         PL_lex_repl = sv;
 827     else
 828         PL_lex_stuff = sv;
 829     return s;
 830 }
 831
 832 /*
 833  * S_force_next
 834  * When the lexer realizes it knows the next token (for instance,
 835  * it is reordering tokens for the parser) then it can call S_force_next
 836  * to know what token to return the next time the lexer is called.  Caller
 837  * will need to set PL_nextval[], and possibly PL_expect to ensure the lexer
 838  * handles the token correctly.
 839  */
 840
 841 STATIC void
 842 S_force_next(pTHX_ I32 type)
 843 {
 844     PL_nexttype[PL_nexttoke] = type;
 845     PL_nexttoke++;
 846     if (PL_lex_state != LEX_KNOWNEXT) {
 847   PL_lex_defer = PL_lex_state;
 848   PL_lex_expect = PL_expect;
 849   PL_lex_state = LEX_KNOWNEXT;
 850     }
 851 }