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