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 #define scan_ident(a,b,c,d,e)   S_scan_ident(aTHX_ a,b,c,d,e)
  28
  29 STATIC void     S_incline(pTHX_ char *s);
  30 STATIC char*    S_skipspace(pTHX_ char *s);
  31 STATIC char *   S_filter_gets(pTHX_ SV *sv, PerlIO *fp, STRLEN append);
  32 STATIC char*    S_scan_str(pTHX_ char *start, int keep_quoted, int keep_delims);
  33 STATIC char*    S_scan_word(pTHX_ char *s, char *dest, STRLEN destlen, int allow_package, STRLEN *slp);
  34
  35 #define DPTR2FPTR(t,p) ((t)PTR2nat(p))  /* data pointer to function pointer */
  36 #define FPTR2DPTR(t,p) ((t)PTR2nat(p))  /* function pointer to data pointer */
  37 #define PTR2nat(p)       (PTRV)(p)       /* pointer to integer of PTRSIZE */
  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 #ifndef MEM_WRAP_CHECK_
  48 #define MEM_WRAP_CHECK_(n,t) MEM_WRAP_CHECK(n,t),
  49 #endif
  50
  51 #define SvPV_renew(sv,n) \
  52   STMT_START { SvLEN_set(sv, n); \
  53     SvPV_set((sv), (MEM_WRAP_CHECK_(n,char)     \
  54         (char*)saferealloc((Malloc_t)SvPVX(sv), \
  55                (MEM_SIZE)((n)))));  \
  56      } STMT_END
  57
  58 #define isCONTROLVAR(x) (isUPPER(x) || strchr("[\\]^_?", (x)))
  59
  60 /* On MacOS, respect nonbreaking spaces */
  61 #ifdef MACOS_TRADITIONAL
  62 #define SPACE_OR_TAB(c) ((c)==' '||(c)=='\312'||(c)=='\t')
  63 #else
  64 #define SPACE_OR_TAB(c) ((c)==' '||(c)=='\t')
  65 #endif
  66
  67 #define CLINE (PL_copline = (CopLINE(PL_curcop) < PL_copline ? CopLINE(PL_curcop) : PL_copline))
  68
  69 #define LEX_NORMAL    10 /* normal code (ie not within "...")     */
  70 #define LEX_INTERPNORMAL   9 /* code within a string, eg "$foo[$x+1]" */
  71 #define LEX_INTERPCASEMOD  8 /* expecting a \U, \Q or \E etc          */
  72 #define LEX_INTERPPUSH     7 /* starting a new sublex parse level     */
  73 #define LEX_INTERPSTART    6 /* expecting the start of a $var         */
  74
  75            /* at end of code, eg "$x" followed by:  */
  76 #define LEX_INTERPEND    5 /* ... eg not one of [, { or ->          */
  77 #define LEX_INTERPENDMAYBE   4 /* ... eg one of [, { or ->              */
  78
  79 #define LEX_INTERPCONCAT   3 /* expecting anything, eg at start of
  80                 string or after \E, $foo, etc       */
  81 #define LEX_INTERPCONST    2 /* NOT USED */
  82 #define LEX_FORMLINE     1 /* expecting a format line               */
  83 #define LEX_KNOWNEXT     0 /* next token known; just return it      */
  84
  85 /* and these two are my own madness (mst) */
  86
  87 #if PERL_REVISION == 5 && PERL_VERSION == 8 && PERL_SUBVERSION >= 8
  88 #define PERL_5_8_8_PLUS
  89 #endif
  90
  91 #if PERL_REVISION == 5 && PERL_VERSION > 8
  92 #define PERL_5_9_PLUS
  93 #endif
  94
  95 #ifdef PERL_5_9_PLUS
  96 /* 5.9+ moves a bunch of things to a PL_parser struct so we need to
  97    declare the backcompat macros for things to still work (mst) */
  98
  99 /* XXX temporary backwards compatibility */
 100 #define PL_lex_brackets         (PL_parser->lex_brackets)
 101 #define PL_lex_brackstack       (PL_parser->lex_brackstack)
 102 #define PL_lex_casemods         (PL_parser->lex_casemods)
 103 #define PL_lex_casestack        (PL_parser->lex_casestack)
 104 #define PL_lex_defer            (PL_parser->lex_defer)
 105 #define PL_lex_dojoin           (PL_parser->lex_dojoin)
 106 #define PL_lex_expect           (PL_parser->lex_expect)
 107 #define PL_lex_formbrack        (PL_parser->lex_formbrack)
 108 #define PL_lex_inpat            (PL_parser->lex_inpat)
 109 #define PL_lex_inwhat           (PL_parser->lex_inwhat)
 110 #define PL_lex_op               (PL_parser->lex_op)
 111 #define PL_lex_repl             (PL_parser->lex_repl)
 112 #define PL_lex_starts           (PL_parser->lex_starts)
 113 #define PL_lex_stuff            (PL_parser->lex_stuff)
 114 #define PL_multi_start          (PL_parser->multi_start)
 115 #define PL_multi_open           (PL_parser->multi_open)
 116 #define PL_multi_close          (PL_parser->multi_close)
 117 #define PL_pending_ident        (PL_parser->pending_ident)
 118 #define PL_preambled            (PL_parser->preambled)
 119 #define PL_sublex_info          (PL_parser->sublex_info)
 120 #define PL_linestr              (PL_parser->linestr)
 121 #define PL_sublex_info          (PL_parser->sublex_info)
 122 #define PL_linestr              (PL_parser->linestr)
 123 #define PL_expect               (PL_parser->expect)
 124 #define PL_copline              (PL_parser->copline)
 125 #define PL_bufptr               (PL_parser->bufptr)
 126 #define PL_oldbufptr            (PL_parser->oldbufptr)
 127 #define PL_oldoldbufptr         (PL_parser->oldoldbufptr)
 128 #define PL_linestart            (PL_parser->linestart)
 129 #define PL_bufend               (PL_parser->bufend)
 130 #define PL_last_uni             (PL_parser->last_uni)
 131 #define PL_last_lop             (PL_parser->last_lop)
 132 #define PL_last_lop_op          (PL_parser->last_lop_op)
 133 #define PL_lex_state            (PL_parser->lex_state)
 134 #define PL_rsfp                 (PL_parser->rsfp)
 135 #define PL_rsfp_filters         (PL_parser->rsfp_filters)
 136 #define PL_in_my                (PL_parser->in_my)
 137 #define PL_in_my_stash          (PL_parser->in_my_stash)
 138 #define PL_tokenbuf             (PL_parser->tokenbuf)
 139 #define PL_multi_end            (PL_parser->multi_end)
 140 #define PL_error_count          (PL_parser->error_count)
 141 /* these three are from the non-PERL_MAD path but I don't -think- I need
 142    the PERL_MAD stuff since my code isn't really populating things (mst) */
 143 #  define PL_nexttoke           (PL_parser->nexttoke)
 144 #  define PL_nexttype           (PL_parser->nexttype)
 145 #  define PL_nextval            (PL_parser->nextval)
 146 /* end of backcompat macros form 5.9 toke.c (mst) */
 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             /* In perl versions previous to p4-rawid: //depot/perl@32954 -P
 315              * preprocessors were supported here. We don't support -P at all, even
 316              * on perls that support it, and use the following chunk from blead
 317              * perl. (rafl)
 318              */
 319
 320             /* Close the filehandle.  Could be from
 321              * STDIN, or a regular file.  If we were reading code from
 322              * STDIN (because the commandline held no -e or filename)
 323              * then we don't close it, we reset it so the code can
 324              * read from STDIN too.
 325              */
 326
 327             if ((PerlIO*)PL_rsfp == PerlIO_stdin())
 328                 PerlIO_clearerr(PL_rsfp);
 329             else
 330                 (void)PerlIO_close(PL_rsfp);
 331             PL_rsfp = Nullfp;
 332             return s;
 333         }
 334
 335         /* not at end of file, so we only read another line */
 336         /* make corresponding updates to old pointers, for yyerror() */
 337         oldprevlen = PL_oldbufptr - PL_bufend;
 338         oldoldprevlen = PL_oldoldbufptr - PL_bufend;
 339         if (PL_last_uni)
 340             oldunilen = PL_last_uni - PL_bufend;
 341         if (PL_last_lop)
 342             oldloplen = PL_last_lop - PL_bufend;
 343         PL_linestart = PL_bufptr = s + prevlen;
 344         PL_bufend = s + SvCUR(PL_linestr);
 345         s = PL_bufptr;
 346         PL_oldbufptr = s + oldprevlen;
 347         PL_oldoldbufptr = s + oldoldprevlen;
 348         if (PL_last_uni)
 349             PL_last_uni = s + oldunilen;
 350         if (PL_last_lop)
 351             PL_last_lop = s + oldloplen;
 352         incline(s);
 353
 354         /* debugger active and we're not compiling the debugger code,
 355          * so store the line into the debugger's array of lines
 356          */
 357         if (PERLDB_LINE && PL_curstash != PL_debstash) {
 358             SV * const sv = NEWSV(85,0);
 359
 360             sv_upgrade(sv, SVt_PVMG);
 361             sv_setpvn(sv,PL_bufptr,PL_bufend-PL_bufptr);
 362             (void)SvIOK_on(sv);
 363             SvIV_set(sv, 0);
 364             av_store(CopFILEAV(PL_curcop),(I32)CopLINE(PL_curcop),sv);
 365         }
 366     }
 367 }
 368
 369 STATIC char *
 370 S_scan_word(pTHX_ register char *s, char *dest, STRLEN destlen, int allow_package, STRLEN *slp)
 371 {
 372     register char *d = dest;
 373     register char * const e = d + destlen - 3;  /* two-character token, ending NUL */
 374     for (;;) {
 375         if (d >= e)
 376             Perl_croak(aTHX_ ident_too_long);
 377         if (isALNUM(*s))        /* UTF handled below */
 378             *d++ = *s++;
 379         else if (*s == '\'' && allow_package && isIDFIRST_lazy_if(s+1,UTF)) {
 380             *d++ = ':';
 381             *d++ = ':';
 382             s++;
 383         }
 384         else if (*s == ':' && s[1] == ':' && allow_package && s[2] != '$') {
 385             *d++ = *s++;
 386             *d++ = *s++;
 387         }
 388         else if (UTF && UTF8_IS_START(*s) && isALNUM_utf8((U8*)s)) {
 389             char *t = s + UTF8SKIP(s);
 390             while (UTF8_IS_CONTINUED(*t) && is_utf8_mark((U8*)t))
 391                 t += UTF8SKIP(t);
 392             if (d + (t - s) > e)
 393                 Perl_croak(aTHX_ ident_too_long);
 394             Copy(s, d, t - s, char);
 395             d += t - s;
 396             s = t;
 397         }
 398         else {
 399             *d = '\0';
 400             *slp = d - dest;
 401             return s;
 402         }
 403     }
 404 }
 405
 406 /*
 407  * S_incline
 408  * This subroutine has nothing to do with tilting, whether at windmills
 409  * or pinball tables.  Its name is short for "increment line".  It
 410  * increments the current line number in CopLINE(PL_curcop) and checks
 411  * to see whether the line starts with a comment of the form
 412  *    # line 500 "foo.pm"
 413  * If so, it sets the current line number and file to the values in the comment.
 414  */
 415
 416 STATIC void
 417 S_incline(pTHX_ char *s)
 418 {
 419     char *t;
 420     char *n;
 421     char *e;
 422     char ch;
 423
 424     CopLINE_inc(PL_curcop);
 425     if (*s++ != '#')
 426         return;
 427     while (SPACE_OR_TAB(*s)) s++;
 428     if (strnEQ(s, "line", 4))
 429         s += 4;
 430     else
 431         return;
 432     if (SPACE_OR_TAB(*s))
 433         s++;
 434     else
 435         return;
 436     while (SPACE_OR_TAB(*s)) s++;
 437     if (!isDIGIT(*s))
 438         return;
 439     n = s;
 440     while (isDIGIT(*s))
 441         s++;
 442     while (SPACE_OR_TAB(*s))
 443         s++;
 444     if (*s == '"' && (t = strchr(s+1, '"'))) {
 445         s++;
 446         e = t + 1;
 447     }
 448     else {
 449         for (t = s; !isSPACE(*t); t++) ;
 450         e = t;
 451     }
 452     while (SPACE_OR_TAB(*e) || *e == '\r' || *e == '\f')
 453         e++;
 454     if (*e != '\n' && *e != '\0')
 455         return;         /* false alarm */
 456
 457     ch = *t;
 458     *t = '\0';
 459     if (t - s > 0) {
 460 /* this chunk was added to S_incline during 5.8.8. I don't know why but I don't
 461    honestly care since I probably want to be bug-compatible anyway (mst) */
 462
 463 /* ... my kingdom for a perl parser in perl ... (mst) */
 464
 465 #ifdef PERL_5_8_8_PLUS
 466 #ifndef USE_ITHREADS
 467         const char *cf = CopFILE(PL_curcop);
 468         if (cf && strlen(cf) > 7 && strnEQ(cf, "(eval ", 6)) {
 469             /* must copy *{"::_<(eval N)[oldfilename:L]"}
 470              * to *{"::_<newfilename"} */
 471             char smallbuf[256], smallbuf2[256];
 472             char *tmpbuf, *tmpbuf2;
 473             GV **gvp, *gv2;
 474             STRLEN tmplen = strlen(cf);
 475             STRLEN tmplen2 = strlen(s);
 476             if (tmplen + 3 < sizeof smallbuf)
 477                 tmpbuf = smallbuf;
 478             else
 479                 Newx(tmpbuf, tmplen + 3, char);
 480             if (tmplen2 + 3 < sizeof smallbuf2)
 481                 tmpbuf2 = smallbuf2;
 482             else
 483                 Newx(tmpbuf2, tmplen2 + 3, char);
 484             tmpbuf[0] = tmpbuf2[0] = '_';
 485             tmpbuf[1] = tmpbuf2[1] = '<';
 486             memcpy(tmpbuf + 2, cf, ++tmplen);
 487             memcpy(tmpbuf2 + 2, s, ++tmplen2);
 488             ++tmplen; ++tmplen2;
 489             gvp = (GV**)hv_fetch(PL_defstash, tmpbuf, tmplen, FALSE);
 490             if (gvp) {
 491                 gv2 = *(GV**)hv_fetch(PL_defstash, tmpbuf2, tmplen2, TRUE);
 492                 if (!isGV(gv2))
 493                     gv_init(gv2, PL_defstash, tmpbuf2, tmplen2, FALSE);
 494                 /* adjust ${"::_<newfilename"} to store the new file name */
 495                 GvSV(gv2) = newSVpvn(tmpbuf2 + 2, tmplen2 - 2);
 496                 GvHV(gv2) = (HV*)SvREFCNT_inc(GvHV(*gvp));
 497                 GvAV(gv2) = (AV*)SvREFCNT_inc(GvAV(*gvp));
 498             }
 499             if (tmpbuf != smallbuf) Safefree(tmpbuf);
 500             if (tmpbuf2 != smallbuf2) Safefree(tmpbuf2);
 501         }
 502 #endif
 503 #endif
 504 /* second endif closes out the "are we 5.8.(8+)" conditional */
 505         CopFILE_free(PL_curcop);
 506         CopFILE_set(PL_curcop, s);
 507     }
 508     *t = ch;
 509     CopLINE_set(PL_curcop, atoi(n)-1);
 510 }
 511
 512 /* scan_str
 513    takes: start position in buffer
 514           keep_quoted preserve \ on the embedded delimiter(s)
 515           keep_delims preserve the delimiters around the string
 516    returns: position to continue reading from buffer
 517    side-effects: multi_start, multi_close, lex_repl or lex_stuff, and
 518         updates the read buffer.
 519
 520    This subroutine pulls a string out of the input.  It is called for:
 521         q               single quotes           q(literal text)
 522         '               single quotes           'literal text'
 523         qq              double quotes           qq(interpolate $here please)
 524         "               double quotes           "interpolate $here please"
 525         qx              backticks               qx(/bin/ls -l)
 526         `               backticks               `/bin/ls -l`
 527         qw              quote words             @EXPORT_OK = qw( func() $spam )
 528         m//             regexp match            m/this/
 529         s///            regexp substitute       s/this/that/
 530         tr///           string transliterate    tr/this/that/
 531         y///            string transliterate    y/this/that/
 532         ($*@)           sub prototypes          sub foo ($)
 533         (stuff)         sub attr parameters     sub foo : attr(stuff)
 534         <>              readline or globs       <FOO>, <>, <$fh>, or <*.c>
 535
 536    In most of these cases (all but <>, patterns and transliterate)
 537    yylex() calls scan_str().  m// makes yylex() call scan_pat() which
 538    calls scan_str().  s/// makes yylex() call scan_subst() which calls
 539    scan_str().  tr/// and y/// make yylex() call scan_trans() which
 540    calls scan_str().
 541
 542    It skips whitespace before the string starts, and treats the first
 543    character as the delimiter.  If the delimiter is one of ([{< then
 544    the corresponding "close" character )]}> is used as the closing
 545    delimiter.  It allows quoting of delimiters, and if the string has
 546    balanced delimiters ([{<>}]) it allows nesting.
 547
 548    On success, the SV with the resulting string is put into lex_stuff or,
 549    if that is already non-NULL, into lex_repl. The second case occurs only
 550    when parsing the RHS of the special constructs s/// and tr/// (y///).
 551    For convenience, the terminating delimiter character is stuffed into
 552    SvIVX of the SV.
 553 */
 554
 555 STATIC char *
 556 S_scan_str(pTHX_ char *start, int keep_quoted, int keep_delims)
 557 {
 558     SV *sv;                             /* scalar value: string */
 559     char *tmps;                         /* temp string, used for delimiter matching */
 560     register char *s = start;           /* current position in the buffer */
 561     register char term;                 /* terminating character */
 562     register char *to;                  /* current position in the sv's data */
 563     I32 brackets = 1;                   /* bracket nesting level */
 564     bool has_utf8 = FALSE;              /* is there any utf8 content? */
 565     I32 termcode;                       /* terminating char. code */
 566     /* 5.8.7+ uses UTF8_MAXBYTES but also its utf8.h defs _MAXLEN to it so
 567        I'm reasonably hopeful this won't destroy anything (mst) */
 568     U8 termstr[UTF8_MAXLEN];            /* terminating string */
 569     STRLEN termlen;                     /* length of terminating string */
 570     char *last = NULL;                  /* last position for nesting bracket */
 571
 572     /* skip space before the delimiter */
 573     if (isSPACE(*s))
 574         s = skipspace(s);
 575
 576     /* mark where we are, in case we need to report errors */
 577     CLINE;
 578
 579     /* after skipping whitespace, the next character is the terminator */
 580     term = *s;
 581     if (!UTF) {
 582         termcode = termstr[0] = term;
 583         termlen = 1;
 584     }
 585     else {
 586         termcode = utf8_to_uvchr((U8*)s, &termlen);
 587         Copy(s, termstr, termlen, U8);
 588         if (!UTF8_IS_INVARIANT(term))
 589             has_utf8 = TRUE;
 590     }
 591
 592     /* mark where we are */
 593     PL_multi_start = CopLINE(PL_curcop);
 594     PL_multi_open = term;
 595
 596     /* find corresponding closing delimiter */
 597     if (term && (tmps = strchr("([{< )]}> )]}>",term)))
 598         termcode = termstr[0] = term = tmps[5];
 599
 600     PL_multi_close = term;
 601
 602     /* create a new SV to hold the contents.  87 is leak category, I'm
 603        assuming.  79 is the SV's initial length.  What a random number. */
 604     sv = NEWSV(87,79);
 605     sv_upgrade(sv, SVt_PVIV);
 606     SvIV_set(sv, termcode);
 607     (void)SvPOK_only(sv);               /* validate pointer */
 608
 609     /* move past delimiter and try to read a complete string */
 610     if (keep_delims)
 611         sv_catpvn(sv, s, termlen);
 612     s += termlen;
 613     for (;;) {
 614         if (PL_encoding && !UTF) {
 615             bool cont = TRUE;
 616
 617             while (cont) {
 618                 int offset = s - SvPVX_const(PL_linestr);
 619                 const bool found = sv_cat_decode(sv, PL_encoding, PL_linestr,
 620                                            &offset, (char*)termstr, termlen);
 621                 const char *ns = SvPVX_const(PL_linestr) + offset;
 622                 char *svlast = SvEND(sv) - 1;
 623
 624                 for (; s < ns; s++) {
 625                     if (*s == '\n' && !PL_rsfp)
 626                         CopLINE_inc(PL_curcop);
 627                 }
 628                 if (!found)
 629                     goto read_more_line;
 630                 else {
 631                     /* handle quoted delimiters */
 632                     if (SvCUR(sv) > 1 && *(svlast-1) == '\\') {
 633                         const char *t;
 634                         for (t = svlast-2; t >= SvPVX_const(sv) && *t == '\\';)
 635                             t--;
 636                         if ((svlast-1 - t) % 2) {
 637                             if (!keep_quoted) {
 638                                 *(svlast-1) = term;
 639                                 *svlast = '\0';
 640                                 SvCUR_set(sv, SvCUR(sv) - 1);
 641                             }
 642                             continue;
 643                         }
 644                     }
 645                     if (PL_multi_open == PL_multi_close) {
 646                         cont = FALSE;
 647                     }
 648                     else {
 649                         const char *t;
 650                         char *w;
 651                         if (!last)
 652                             last = SvPVX(sv);
 653                         for (t = w = last; t < svlast; w++, t++) {
 654                             /* At here, all closes are "was quoted" one,
 655                                so we don't check PL_multi_close. */
 656                             if (*t == '\\') {
 657                                 if (!keep_quoted && *(t+1) == PL_multi_open)
 658                                     t++;
 659                                 else
 660                                     *w++ = *t++;
 661                             }
 662                             else if (*t == PL_multi_open)
 663                                 brackets++;
 664
 665                             *w = *t;
 666                         }
 667                         if (w < t) {
 668                             *w++ = term;
 669                             *w = '\0';
 670                             SvCUR_set(sv, w - SvPVX_const(sv));
 671                         }
 672                         last = w;
 673                         if (--brackets <= 0)
 674                             cont = FALSE;
 675                     }
 676                 }
 677             }
 678             if (!keep_delims) {
 679                 SvCUR_set(sv, SvCUR(sv) - 1);
 680                 *SvEND(sv) = '\0';
 681             }
 682             break;
 683         }
 684
 685         /* extend sv if need be */
 686         SvGROW(sv, SvCUR(sv) + (PL_bufend - s) + 1);
 687         /* set 'to' to the next character in the sv's string */
 688         to = SvPVX(sv)+SvCUR(sv);
 689
 690         /* if open delimiter is the close delimiter read unbridle */
 691         if (PL_multi_open == PL_multi_close) {
 692             for (; s < PL_bufend; s++,to++) {
 693                 /* embedded newlines increment the current line number */
 694                 if (*s == '\n' && !PL_rsfp)
 695                     CopLINE_inc(PL_curcop);
 696                 /* handle quoted delimiters */
 697                 if (*s == '\\' && s+1 < PL_bufend && term != '\\') {
 698                     if (!keep_quoted && s[1] == term)
 699                         s++;
 700                 /* any other quotes are simply copied straight through */
 701                     else
 702                         *to++ = *s++;
 703                 }
 704                 /* terminate when run out of buffer (the for() condition), or
 705                    have found the terminator */
 706                 else if (*s == term) {
 707                     if (termlen == 1)
 708                         break;
 709                     if (s+termlen <= PL_bufend && memEQ(s, (char*)termstr, termlen))
 710                         break;
 711                 }
 712                 else if (!has_utf8 && !UTF8_IS_INVARIANT((U8)*s) && UTF)
 713                     has_utf8 = TRUE;
 714                 *to = *s;
 715             }
 716         }
 717
 718         /* if the terminator isn't the same as the start character (e.g.,
 719            matched brackets), we have to allow more in the quoting, and
 720            be prepared for nested brackets.
 721         */
 722         else {
 723             /* read until we run out of string, or we find the terminator */
 724             for (; s < PL_bufend; s++,to++) {
 725                 /* embedded newlines increment the line count */
 726                 if (*s == '\n' && !PL_rsfp)
 727                     CopLINE_inc(PL_curcop);
 728                 /* backslashes can escape the open or closing characters */
 729                 if (*s == '\\' && s+1 < PL_bufend) {
 730                     if (!keep_quoted &&
 731                         ((s[1] == PL_multi_open) || (s[1] == PL_multi_close)))
 732                         s++;
 733                     else
 734                         *to++ = *s++;
 735                 }
 736                 /* allow nested opens and closes */
 737                 else if (*s == PL_multi_close && --brackets <= 0)
 738                     break;
 739                 else if (*s == PL_multi_open)
 740                     brackets++;
 741                 else if (!has_utf8 && !UTF8_IS_INVARIANT((U8)*s) && UTF)
 742                     has_utf8 = TRUE;
 743                 *to = *s;
 744             }
 745         }
 746         /* terminate the copied string and update the sv's end-of-string */
 747         *to = '\0';
 748         SvCUR_set(sv, to - SvPVX_const(sv));
 749
 750         /*
 751          * this next chunk reads more into the buffer if we're not done yet
 752          */
 753
 754         if (s < PL_bufend)
 755             break;              /* handle case where we are done yet :-) */
 756
 757 #ifndef PERL_STRICT_CR
 758         if (to - SvPVX_const(sv) >= 2) {
 759             if ((to[-2] == '\r' && to[-1] == '\n') ||
 760                 (to[-2] == '\n' && to[-1] == '\r'))
 761             {
 762                 to[-2] = '\n';
 763                 to--;
 764                 SvCUR_set(sv, to - SvPVX_const(sv));
 765             }
 766             else if (to[-1] == '\r')
 767                 to[-1] = '\n';
 768         }
 769         else if (to - SvPVX_const(sv) == 1 && to[-1] == '\r')
 770             to[-1] = '\n';
 771 #endif
 772
 773      read_more_line:
 774         /* if we're out of file, or a read fails, bail and reset the current
 775            line marker so we can report where the unterminated string began
 776         */
 777         if (!PL_rsfp ||
 778          !(PL_oldoldbufptr = PL_oldbufptr = s = PL_linestart = filter_gets(PL_linestr, PL_rsfp, 0))) {
 779             sv_free(sv);
 780             CopLINE_set(PL_curcop, (line_t)PL_multi_start);
 781             return Nullch;
 782         }
 783         /* we read a line, so increment our line counter */
 784         CopLINE_inc(PL_curcop);
 785
 786         /* update debugger info */
 787         if (PERLDB_LINE && PL_curstash != PL_debstash) {
 788             SV *sv = NEWSV(88,0);
 789
 790             sv_upgrade(sv, SVt_PVMG);
 791             sv_setsv(sv,PL_linestr);
 792             (void)SvIOK_on(sv);
 793             SvIV_set(sv, 0);
 794             av_store(CopFILEAV(PL_curcop), (I32)CopLINE(PL_curcop), sv);
 795         }
 796
 797         /* having changed the buffer, we must update PL_bufend */
 798         PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
 799         PL_last_lop = PL_last_uni = Nullch;
 800     }
 801
 802     /* at this point, we have successfully read the delimited string */
 803
 804     if (!PL_encoding || UTF) {
 805         if (keep_delims)
 806             sv_catpvn(sv, s, termlen);
 807         s += termlen;
 808     }
 809     if (has_utf8 || PL_encoding)
 810         SvUTF8_on(sv);
 811
 812     PL_multi_end = CopLINE(PL_curcop);
 813
 814     /* if we allocated too much space, give some back */
 815     if (SvCUR(sv) + 5 < SvLEN(sv)) {
 816         SvLEN_set(sv, SvCUR(sv) + 1);
 817 /* 5.8.8 uses SvPV_renew, no prior version actually has the damn thing (mst) */
 818 #ifdef PERL_5_8_8_PLUS
 819         SvPV_renew(sv, SvLEN(sv));
 820 #else
 821         Renew(SvPVX(sv), SvLEN(sv), char);
 822 #endif
 823     }
 824
 825     /* decide whether this is the first or second quoted string we've read
 826        for this op
 827     */
 828
 829     if (PL_lex_stuff)
 830         PL_lex_repl = sv;
 831     else
 832         PL_lex_stuff = sv;
 833     return s;
 834 }
 835
 836 /*
 837  * S_force_next
 838  * When the lexer realizes it knows the next token (for instance,
 839  * it is reordering tokens for the parser) then it can call S_force_next
 840  * to know what token to return the next time the lexer is called.  Caller
 841  * will need to set PL_nextval[], and possibly PL_expect to ensure the lexer
 842  * handles the token correctly.
 843  */
 844
 845 STATIC void
 846 S_force_next(pTHX_ I32 type)
 847 {
 848     PL_nexttype[PL_nexttoke] = type;
 849     PL_nexttoke++;
 850     if (PL_lex_state != LEX_KNOWNEXT) {
 851   PL_lex_defer = PL_lex_state;
 852   PL_lex_expect = PL_expect;
 853   PL_lex_state = LEX_KNOWNEXT;
 854     }
 855 }
 856
 857 #define XFAKEBRACK 128
 858
 859 STATIC char *
 860 S_scan_ident(pTHX_ register char *s, register const char *send, char *dest, STRLEN destlen, I32 ck_uni)
 861 {
 862     register char *d;
 863     register char *e;
 864     char *bracket = Nullch;
 865     char funny = *s++;
 866
 867     if (isSPACE(*s))
 868         s = skipspace(s);
 869     d = dest;
 870     e = d + destlen - 3;        /* two-character token, ending NUL */
 871     if (isDIGIT(*s)) {
 872         while (isDIGIT(*s)) {
 873             if (d >= e)
 874                 Perl_croak(aTHX_ ident_too_long);
 875             *d++ = *s++;
 876         }
 877     }
 878     else {
 879         for (;;) {
 880             if (d >= e)
 881                 Perl_croak(aTHX_ ident_too_long);
 882             if (isALNUM(*s))    /* UTF handled below */
 883                 *d++ = *s++;
 884             else if (*s == '\'' && isIDFIRST_lazy_if(s+1,UTF)) {
 885                 *d++ = ':';
 886                 *d++ = ':';
 887                 s++;
 888             }
 889             else if (*s == ':' && s[1] == ':') {
 890                 *d++ = *s++;
 891                 *d++ = *s++;
 892             }
 893             else if (UTF && UTF8_IS_START(*s) && isALNUM_utf8((U8*)s)) {
 894                 char *t = s + UTF8SKIP(s);
 895                 while (UTF8_IS_CONTINUED(*t) && is_utf8_mark((U8*)t))
 896                     t += UTF8SKIP(t);
 897                 if (d + (t - s) > e)
 898                     Perl_croak(aTHX_ ident_too_long);
 899                 Copy(s, d, t - s, char);
 900                 d += t - s;
 901                 s = t;
 902             }
 903             else
 904                 break;
 905         }
 906     }
 907     *d = '\0';
 908     d = dest;
 909     if (*d) {
 910         if (PL_lex_state != LEX_NORMAL)
 911             PL_lex_state = LEX_INTERPENDMAYBE;
 912         return s;
 913     }
 914     if (*s == '$' && s[1] &&
 915         (isALNUM_lazy_if(s+1,UTF) || s[1] == '$' || s[1] == '{' || strnEQ(s+1,"::",2)) )
 916     {
 917         return s;
 918     }
 919     if (*s == '{') {
 920         bracket = s;
 921         s++;
 922     }
 923     /* we always call this with ck_uni == 0 (rafl) */
 924     /*
 925     else if (ck_uni)
 926         check_uni();
 927     */
 928     if (s < send)
 929         *d = *s++;
 930     d[1] = '\0';
 931     if (*d == '^' && *s && isCONTROLVAR(*s)) {
 932         *d = toCTRL(*s);
 933         s++;
 934     }
 935     if (bracket) {
 936         if (isSPACE(s[-1])) {
 937             while (s < send) {
 938                 const char ch = *s++;
 939                 if (!SPACE_OR_TAB(ch)) {
 940                     *d = ch;
 941                     break;
 942                 }
 943             }
 944         }
 945         if (isIDFIRST_lazy_if(d,UTF)) {
 946             d++;
 947             if (UTF) {
 948                 e = s;
 949                 while ((e < send && isALNUM_lazy_if(e,UTF)) || *e == ':') {
 950                     e += UTF8SKIP(e);
 951                     while (e < send && UTF8_IS_CONTINUED(*e) && is_utf8_mark((U8*)e))
 952                         e += UTF8SKIP(e);
 953                 }
 954                 Copy(s, d, e - s, char);
 955                 d += e - s;
 956                 s = e;
 957             }
 958             else {
 959                 while ((isALNUM(*s) || *s == ':') && d < e)
 960                     *d++ = *s++;
 961                 if (d >= e)
 962                     Perl_croak(aTHX_ ident_too_long);
 963             }
 964             *d = '\0';
 965             while (s < send && SPACE_OR_TAB(*s)) s++;
 966             if ((*s == '[' || (*s == '{' && strNE(dest, "sub")))) {
 967                 /* we don't want perl to guess what is meant. the keyword
 968                  * parser decides that later. (rafl)
 969                  */
 970                 /*
 971                 if (ckWARN(WARN_AMBIGUOUS) && keyword(dest, d - dest)) {
 972                     const char *brack = *s == '[' ? "[...]" : "{...}";
 973                     Perl_warner(aTHX_ packWARN(WARN_AMBIGUOUS),
 974                         "Ambiguous use of %c{%s%s} resolved to %c%s%s",
 975                         funny, dest, brack, funny, dest, brack);
 976                 }
 977                 */
 978                 bracket++;
 979                 PL_lex_brackstack[PL_lex_brackets++] = (char)(XOPERATOR | XFAKEBRACK);
 980                 return s;
 981             }
 982         }
 983         /* Handle extended ${^Foo} variables
 984          * 1999-02-27 mjd-perl-patch@plover.com */
 985         else if (!isALNUM(*d) && !isPRINT(*d) /* isCTRL(d) */
 986                  && isALNUM(*s))
 987         {
 988             d++;
 989             while (isALNUM(*s) && d < e) {
 990                 *d++ = *s++;
 991             }
 992             if (d >= e)
 993                 Perl_croak(aTHX_ ident_too_long);
 994             *d = '\0';
 995         }
 996         if (*s == '}') {
 997             s++;
 998             if (PL_lex_state == LEX_INTERPNORMAL && !PL_lex_brackets) {
 999                 PL_lex_state = LEX_INTERPEND;
1000                 PL_expect = XREF;
1001             }
1002             if (funny == '#')
1003                 funny = '@';
1004             /* we don't want perl to guess what is meant. the keyword
1005              * parser decides that later. (rafl)
1006              */
1007             /*
1008             if (PL_lex_state == LEX_NORMAL) {
1009                 if (ckWARN(WARN_AMBIGUOUS) &&
1010                     (keyword(dest, d - dest) || get_cv(dest, FALSE)))
1011                 {
1012                     Perl_warner(aTHX_ packWARN(WARN_AMBIGUOUS),
1013                         "Ambiguous use of %c{%s} resolved to %c%s",
1014                         funny, dest, funny, dest);
1015                 }
1016             }
1017             */
1018         }
1019         else {
1020             s = bracket;                /* let the parser handle it */
1021             *dest = '\0';
1022         }
1023     }
1024     /* don't intuit. we really just want the string. (rafl) */
1025     /*
1026     else if (PL_lex_state == LEX_INTERPNORMAL && !PL_lex_brackets && !intuit_more(s))
1027         PL_lex_state = LEX_INTERPEND;
1028     */
1029     return s;
1030 }