This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Digital UNIX and 3_28
[perl5.git] / gv.c
1 /*    gv.c
2  *
3  *    Copyright (c) 1991-1994, Larry Wall
4  *
5  *    You may distribute under the terms of either the GNU General Public
6  *    License or the Artistic License, as specified in the README file.
7  *
8  */
9
10 /*
11  *   'Mercy!' cried Gandalf.  'If the giving of information is to be the cure
12  * of your inquisitiveness, I shall spend all the rest of my days answering
13  * you.  What more do you want to know?'
14  *   'The names of all the stars, and of all living things, and the whole
15  * history of Middle-earth and Over-heaven and of the Sundering Seas,'
16  * laughed Pippin.
17  */
18
19 #include "EXTERN.h"
20 #include "perl.h"
21
22 EXT char rcsid[];
23
24 GV *
25 gv_AVadd(gv)
26 register GV *gv;
27 {
28     if (!gv || SvTYPE((SV*)gv) != SVt_PVGV)
29         croak("Bad symbol for array");
30     if (!GvAV(gv))
31         GvAV(gv) = newAV();
32     return gv;
33 }
34
35 GV *
36 gv_HVadd(gv)
37 register GV *gv;
38 {
39     if (!gv || SvTYPE((SV*)gv) != SVt_PVGV)
40         croak("Bad symbol for hash");
41     if (!GvHV(gv))
42         GvHV(gv) = newHV();
43     return gv;
44 }
45
46 GV *
47 gv_IOadd(gv)
48 register GV *gv;
49 {
50     if (!gv || SvTYPE((SV*)gv) != SVt_PVGV)
51         croak("Bad symbol for filehandle");
52     if (!GvIOp(gv))
53         GvIOp(gv) = newIO();
54     return gv;
55 }
56
57 GV *
58 gv_fetchfile(name)
59 char *name;
60 {
61     char tmpbuf[1200];
62     STRLEN tmplen;
63     GV *gv;
64
65     sprintf(tmpbuf, "_<%s", name);
66     tmplen = strlen(tmpbuf);
67     gv = *(GV**)hv_fetch(defstash, tmpbuf, tmplen, TRUE);
68     if (!isGV(gv))
69         gv_init(gv, defstash, tmpbuf, tmplen, FALSE);
70     sv_setpv(GvSV(gv), name);
71     if (*name == '/' && (instr(name, "/lib/") || instr(name, ".pm")))
72         GvMULTI_on(gv);
73     if (perldb)
74         hv_magic(GvHVn(gv_AVadd(gv)), gv, 'L');
75     return gv;
76 }
77
78 void
79 gv_init(gv, stash, name, len, multi)
80 GV *gv;
81 HV *stash;
82 char *name;
83 STRLEN len;
84 int multi;
85 {
86     register GP *gp;
87
88     sv_upgrade((SV*)gv, SVt_PVGV);
89     if (SvLEN(gv))
90         Safefree(SvPVX(gv));
91     Newz(602, gp, 1, GP);
92     GvGP(gv) = gp_ref(gp);
93     GvSV(gv) = NEWSV(72,0);
94     GvLINE(gv) = curcop->cop_line;
95     GvFILEGV(gv) = curcop->cop_filegv;
96     GvEGV(gv) = gv;
97     sv_magic((SV*)gv, (SV*)gv, '*', name, len);
98     GvSTASH(gv) = stash;
99     GvNAME(gv) = savepvn(name, len);
100     GvNAMELEN(gv) = len;
101     if (multi)
102         GvMULTI_on(gv);
103 }
104
105 static void
106 gv_init_sv(gv, sv_type)
107 GV* gv;
108 I32 sv_type;
109 {
110     switch (sv_type) {
111     case SVt_PVIO:
112         (void)GvIOn(gv);
113         break;
114     case SVt_PVAV:
115         (void)GvAVn(gv);
116         break;
117     case SVt_PVHV:
118         (void)GvHVn(gv);
119         break;
120     }
121 }
122
123 GV *
124 gv_fetchmeth(stash, name, len, level)
125 HV* stash;
126 char* name;
127 STRLEN len;
128 I32 level;
129 {
130     AV* av;
131     GV* topgv;
132     GV* gv;
133     GV** gvp;
134     HV* lastchance;
135     CV* cv;
136
137     if (!stash)
138         return 0;
139     if ((level > 100) || (level < -100))
140         croak("Recursive inheritance detected");
141
142     DEBUG_o( deb("Looking for method %s in package %s\n",name,HvNAME(stash)) );
143
144     gvp = (GV**)hv_fetch(stash, name, len, (level >= 0));
145     if (!gvp)
146         topgv = Nullgv;
147     else {
148         topgv = *gvp;
149         if (SvTYPE(topgv) != SVt_PVGV)
150             gv_init(topgv, stash, name, len, TRUE);
151         if (cv = GvCV(topgv)) {
152             /* If genuine method or valid cache entry, use it */
153             if (!GvCVGEN(topgv) || GvCVGEN(topgv) >= sub_generation)
154                 return topgv;
155             /* Stale cached entry: junk it */
156             SvREFCNT_dec(cv);
157             GvCV(topgv) = cv = Nullcv;
158             GvCVGEN(topgv) = 0;
159         }
160     }
161
162     gvp = (GV**)hv_fetch(stash,"ISA",3,FALSE);
163     if (gvp && (gv = *gvp) != (GV*)&sv_undef && (av = GvAV(gv))) {
164         SV** svp = AvARRAY(av);
165         I32 items = AvFILL(av) + 1;
166         while (items--) {
167             SV* sv = *svp++;
168             HV* basestash = gv_stashsv(sv, FALSE);
169             if (!basestash) {
170                 if (dowarn)
171                     warn("Can't locate package %s for @%s::ISA",
172                         SvPVX(sv), HvNAME(stash));
173                 continue;
174             }
175             gv = gv_fetchmeth(basestash, name, len,
176                               (level >= 0) ? level + 1 : level - 1);
177             if (gv)
178                 goto gotcha;
179         }
180     }
181
182     if (level == 0 || level == -1) {
183         if (lastchance = gv_stashpvn("UNIVERSAL", 9, FALSE)) {
184             if (gv = gv_fetchmeth(lastchance, name, len,
185                                   (level >= 0) ? level + 1 : level - 1)) {
186           gotcha:
187                 /* Use topgv for cache only if it has no synonyms */
188                 if (topgv && GvREFCNT(topgv) == 1) {
189                     if (cv = GvCV(topgv))
190                         SvREFCNT_dec(cv);
191                     GvCV(topgv) = (CV*)SvREFCNT_inc(GvCV(gv));
192                     GvCVGEN(topgv) = sub_generation;
193                 }
194                 return gv;
195             }
196         }
197     }
198
199     return 0;
200 }
201
202 GV *
203 gv_fetchmethod(stash, name)
204 HV* stash;
205 char* name;
206 {
207     register char *nend;
208     char *nsplit = 0;
209     GV* gv;
210     
211     for (nend = name; *nend; nend++) {
212         if (*nend == ':' || *nend == '\'')
213             nsplit = nend;
214     }
215     if (nsplit) {
216         char ch;
217         char *origname = name;
218         name = nsplit + 1;
219         ch = *nsplit;
220         if (*nsplit == ':')
221             --nsplit;
222         *nsplit = '\0';
223         if (strEQ(origname,"SUPER")) {
224             /* Degenerate case ->SUPER::method should really lookup in original stash */
225             SV *tmpstr = sv_2mortal(newSVpv(HvNAME(curcop->cop_stash),0));
226             sv_catpvn(tmpstr, "::SUPER", 7);
227             stash = gv_stashpvn(SvPVX(tmpstr),SvCUR(tmpstr),TRUE);
228             *nsplit = ch;
229             DEBUG_o( deb("Treating %s as %s::%s\n",origname,HvNAME(stash),name) );
230         } else {
231             stash = gv_stashpvn(origname, nsplit - origname, TRUE);
232             *nsplit = ch;
233         }
234     }
235     gv = gv_fetchmeth(stash, name, nend - name, 0);
236
237     if (!gv) {
238         /* Failed obvious case - look for SUPER as last element of stash's name */
239         char *packname = HvNAME(stash);
240         STRLEN len     = strlen(packname);
241         if (len >= 7 && strEQ(packname+len-7,"::SUPER")) {
242             /* Now look for @.*::SUPER::ISA */
243             GV** gvp = (GV**)hv_fetch(stash,"ISA",3,FALSE);
244             len -= 7;
245             if (!gvp || (gv = *gvp) == (GV*)&sv_undef || !GvAV(gv)) {
246                 /* No @ISA in package ending in ::SUPER - drop suffix
247                    and see if there is an @ISA there
248                  */
249                 HV *basestash;
250                 char ch = packname[len];
251                 AV *av;
252                 packname[len] = '\0';
253                 basestash = gv_stashpvn(packname, len, TRUE);
254                 packname[len] = ch;
255                 gvp = (GV**)hv_fetch(basestash,"ISA",3,FALSE);
256                 if (gvp && (gv = *gvp) != (GV*)&sv_undef && (av = GvAV(gv))) {
257                      /* Okay found @ISA after dropping the SUPER, alias it */
258                      SV *tmpstr = sv_2mortal(newSVpv(HvNAME(stash),0));
259                      sv_catpvn(tmpstr, "::ISA", 5);
260                      gv  = gv_fetchpv(SvPV(tmpstr,na),TRUE,SVt_PVGV);
261                      if (gv) {
262                         GvAV(gv) = (AV*)SvREFCNT_inc(av);
263                         /* ... and re-try lookup */
264                         gv = gv_fetchmeth(stash, name, nend - name, 0);
265                      } else {
266                         croak("Cannot create %s::ISA",HvNAME(stash));
267                      }
268                 }
269             }
270         }     
271     }
272
273     if (!gv) {
274         if (strEQ(name,"import"))
275             gv = (GV*)&sv_yes;
276         else
277             gv = gv_autoload(stash, name, nend - name);
278     }
279
280     return gv;
281 }
282
283 GV*
284 gv_autoload(stash, name, len)
285 HV* stash;
286 char* name;
287 STRLEN len;
288 {
289     static char autoload[] = "AUTOLOAD";
290     static STRLEN autolen = 8;
291     GV* gv;
292     CV* cv;
293     HV* varstash;
294     GV* vargv;
295     SV* varsv;
296
297     if (len == autolen && strnEQ(name, autoload, autolen))
298         return Nullgv;
299     if (!(gv = gv_fetchmeth(stash, autoload, autolen, 0)))
300         return Nullgv;
301     cv = GvCV(gv);
302
303     /*
304      * Given &FOO::AUTOLOAD, set $FOO::AUTOLOAD to desired function name.
305      * The subroutine's original name may not be "AUTOLOAD", so we don't
306      * use that, but for lack of anything better we will use the sub's
307      * original package to look up $AUTOLOAD.
308      */
309     varstash = GvSTASH(CvGV(cv));
310     vargv = *(GV**)hv_fetch(varstash, autoload, autolen, TRUE);
311     if (!isGV(vargv))
312         gv_init(vargv, varstash, autoload, autolen, FALSE);
313     varsv = GvSV(vargv);
314     sv_setpv(varsv, HvNAME(stash));
315     sv_catpvn(varsv, "::", 2);
316     sv_catpvn(varsv, name, len);
317     SvTAINTED_off(varsv);
318     return gv;
319 }
320
321 HV*
322 gv_stashpv(name,create)
323 char *name;
324 I32 create;
325 {
326     return gv_stashpvn(name, strlen(name), create);
327 }
328
329 HV*
330 gv_stashpvn(name,namelen,create)
331 char *name;
332 U32 namelen;
333 I32 create;
334 {
335     char tmpbuf[1203];
336     HV *stash;
337     GV *tmpgv;
338
339     if (namelen > 1200) {
340         namelen = 1200;
341 #ifdef VMS
342         warn("Weird package name \"%s\" truncated", name);
343 #else
344         warn("Weird package name \"%.*s...\" truncated", (int)namelen, name);
345 #endif
346     }
347     Copy(name,tmpbuf,namelen,char);
348     tmpbuf[namelen++] = ':';
349     tmpbuf[namelen++] = ':';
350     tmpbuf[namelen] = '\0';
351     tmpgv = gv_fetchpv(tmpbuf,create, SVt_PVHV);
352     if (!tmpgv)
353         return 0;
354     if (!GvHV(tmpgv))
355         GvHV(tmpgv) = newHV();
356     stash = GvHV(tmpgv);
357     if (!HvNAME(stash))
358         HvNAME(stash) = savepv(name);
359     return stash;
360 }
361
362 HV*
363 gv_stashsv(sv,create)
364 SV *sv;
365 I32 create;
366 {
367     register char *ptr;
368     STRLEN len;
369     ptr = SvPV(sv,len);
370     return gv_stashpvn(ptr, len, create);
371 }
372
373
374 GV *
375 gv_fetchpv(nambeg,add,sv_type)
376 char *nambeg;
377 I32 add;
378 I32 sv_type;
379 {
380     register char *name = nambeg;
381     register GV *gv = 0;
382     GV**gvp;
383     I32 len;
384     register char *namend;
385     HV *stash = 0;
386     bool global = FALSE;
387     char *tmpbuf;
388
389     if (*name == '*' && isALPHA(name[1])) /* accidental stringify on a GV? */
390         name++;
391
392     for (namend = name; *namend; namend++) {
393         if ((*namend == '\'' && namend[1]) ||
394             (*namend == ':' && namend[1] == ':'))
395         {
396             if (!stash)
397                 stash = defstash;
398             if (!stash || !SvREFCNT(stash)) /* symbol table under destruction */
399                 return Nullgv;
400
401             len = namend - name;
402             if (len > 0) {
403                 New(601, tmpbuf, len+3, char);
404                 Copy(name, tmpbuf, len, char);
405                 tmpbuf[len++] = ':';
406                 tmpbuf[len++] = ':';
407                 tmpbuf[len] = '\0';
408                 gvp = (GV**)hv_fetch(stash,tmpbuf,len,add);
409                 Safefree(tmpbuf);
410                 if (!gvp || *gvp == (GV*)&sv_undef)
411                     return Nullgv;
412                 gv = *gvp;
413
414                 if (SvTYPE(gv) == SVt_PVGV)
415                     GvMULTI_on(gv);
416                 else if (!add)
417                     return Nullgv;
418                 else
419                     gv_init(gv, stash, nambeg, namend - nambeg, (add & 2));
420
421                 if (!(stash = GvHV(gv)))
422                     stash = GvHV(gv) = newHV();
423
424                 if (!HvNAME(stash))
425                     HvNAME(stash) = savepvn(nambeg, namend - nambeg);
426             }
427
428             if (*namend == ':')
429                 namend++;
430             namend++;
431             name = namend;
432             if (!*name)
433                 return gv ? gv : (GV*)*hv_fetch(defstash, "main::", 6, TRUE);
434         }
435     }
436     len = namend - name;
437     if (!len)
438         len = 1;
439
440     /* No stash in name, so see how we can default */
441
442     if (!stash) {
443         if (isIDFIRST(*name)) {
444             if (isUPPER(*name)) {
445                 if (*name > 'I') {
446                     if (*name == 'S' && (
447                       strEQ(name, "SIG") ||
448                       strEQ(name, "STDIN") ||
449                       strEQ(name, "STDOUT") ||
450                       strEQ(name, "STDERR") ))
451                         global = TRUE;
452                 }
453                 else if (*name > 'E') {
454                     if (*name == 'I' && strEQ(name, "INC"))
455                         global = TRUE;
456                 }
457                 else if (*name > 'A') {
458                     if (*name == 'E' && strEQ(name, "ENV"))
459                         global = TRUE;
460                 }
461                 else if (*name == 'A' && (
462                   strEQ(name, "ARGV") ||
463                   strEQ(name, "ARGVOUT") ))
464                     global = TRUE;
465             }
466             else if (*name == '_' && !name[1])
467                 global = TRUE;
468             if (global)
469                 stash = defstash;
470             else if ((COP*)curcop == &compiling) {
471                 stash = curstash;
472                 if (add && (hints & HINT_STRICT_VARS) &&
473                     sv_type != SVt_PVCV &&
474                     sv_type != SVt_PVGV &&
475                     sv_type != SVt_PVFM &&
476                     sv_type != SVt_PVIO &&
477                     !(len == 1 && sv_type == SVt_PV && strchr("ab",*name)) )
478                 {
479                     gvp = (GV**)hv_fetch(stash,name,len,0);
480                     if (!gvp ||
481                         *gvp == (GV*)&sv_undef ||
482                         SvTYPE(*gvp) != SVt_PVGV)
483                     {
484                         stash = 0;
485                     }
486                     else if (sv_type == SVt_PV   && !GvIMPORTED_SV(*gvp) ||
487                              sv_type == SVt_PVAV && !GvIMPORTED_AV(*gvp) ||
488                              sv_type == SVt_PVHV && !GvIMPORTED_HV(*gvp) )
489                     {
490                         warn("Variable \"%c%s\" is not imported",
491                             sv_type == SVt_PVAV ? '@' :
492                             sv_type == SVt_PVHV ? '%' : '$',
493                             name);
494                         if (GvCVu(*gvp))
495                             warn("(Did you mean &%s instead?)\n", name);
496                         stash = 0;
497                     }
498                 }
499             }
500             else
501                 stash = curcop->cop_stash;
502         }
503         else
504             stash = defstash;
505     }
506
507     /* By this point we should have a stash and a name */
508
509     if (!stash) {
510         if (add) {
511             warn("Global symbol \"%s\" requires explicit package name", name);
512             ++error_count;
513             stash = curstash ? curstash : defstash;     /* avoid core dumps */
514         }
515         else
516             return Nullgv;
517     }
518
519     if (!SvREFCNT(stash))       /* symbol table under destruction */
520         return Nullgv;
521
522     gvp = (GV**)hv_fetch(stash,name,len,add);
523     if (!gvp || *gvp == (GV*)&sv_undef)
524         return Nullgv;
525     gv = *gvp;
526     if (SvTYPE(gv) == SVt_PVGV) {
527         if (add) {
528             GvMULTI_on(gv);
529             gv_init_sv(gv, sv_type);
530         }
531         return gv;
532     }
533
534     /* Adding a new symbol */
535
536     if (add & 4)
537         warn("Had to create %s unexpectedly", nambeg);
538     gv_init(gv, stash, name, len, add & 2);
539     gv_init_sv(gv, sv_type);
540
541     /* set up magic where warranted */
542     switch (*name) {
543     case 'A':
544         if (strEQ(name, "ARGV")) {
545             IoFLAGS(GvIOn(gv)) |= IOf_ARGV|IOf_START;
546         }
547         break;
548
549     case 'a':
550     case 'b':
551         if (len == 1)
552             GvMULTI_on(gv);
553         break;
554     case 'E':
555         if (strnEQ(name, "EXPORT", 6))
556             GvMULTI_on(gv);
557         break;
558     case 'I':
559         if (strEQ(name, "ISA")) {
560             AV* av = GvAVn(gv);
561             GvMULTI_on(gv);
562             sv_magic((SV*)av, (SV*)gv, 'I', Nullch, 0);
563             if (add & 2 && strEQ(nambeg,"AnyDBM_File::ISA") && AvFILL(av) == -1)
564             {
565                 char *pname;
566                 av_push(av, newSVpv(pname = "NDBM_File",0));
567                 gv_stashpvn(pname, 9, TRUE);
568                 av_push(av, newSVpv(pname = "DB_File",0));
569                 gv_stashpvn(pname, 7, TRUE);
570                 av_push(av, newSVpv(pname = "GDBM_File",0));
571                 gv_stashpvn(pname, 9, TRUE);
572                 av_push(av, newSVpv(pname = "SDBM_File",0));
573                 gv_stashpvn(pname, 9, TRUE);
574                 av_push(av, newSVpv(pname = "ODBM_File",0));
575                 gv_stashpvn(pname, 9, TRUE);
576             }
577         }
578         break;
579 #ifdef OVERLOAD
580     case 'O':
581         if (strEQ(name, "OVERLOAD")) {
582             HV* hv = GvHVn(gv);
583             GvMULTI_on(gv);
584             sv_magic((SV*)hv, (SV*)gv, 'A', 0, 0);
585         }
586         break;
587 #endif /* OVERLOAD */
588     case 'S':
589         if (strEQ(name, "SIG")) {
590             HV *hv;
591             I32 i;
592             siggv = gv;
593             GvMULTI_on(siggv);
594             hv = GvHVn(siggv);
595             hv_magic(hv, siggv, 'S');
596             for(i=1;sig_name[i];i++) {
597                 SV ** init;
598                 init=hv_fetch(hv,sig_name[i],strlen(sig_name[i]),1);
599                 if(init)
600                         sv_setsv(*init,&sv_undef);
601                 psig_ptr[i] = 0;
602                 psig_name[i] = 0;
603             }
604             /* initialize signal stack */
605             signalstack = newAV();
606             AvREAL_off(signalstack);
607             av_extend(signalstack, 30);
608             av_fill(signalstack, 0);
609         }
610         break;
611
612     case '&':
613         if (len > 1)
614             break;
615         ampergv = gv;
616         sawampersand = TRUE;
617         goto ro_magicalize;
618
619     case '`':
620         if (len > 1)
621             break;
622         leftgv = gv;
623         sawampersand = TRUE;
624         goto ro_magicalize;
625
626     case '\'':
627         if (len > 1)
628             break;
629         rightgv = gv;
630         sawampersand = TRUE;
631         goto ro_magicalize;
632
633     case ':':
634         if (len > 1)
635             break;
636         sv_setpv(GvSV(gv),chopset);
637         goto magicalize;
638
639     case '?':
640         if (len > 1)
641             break;
642 #ifdef COMPLEX_STATUS
643         sv_upgrade(GvSV(gv), SVt_PVLV);
644 #endif
645         goto magicalize;
646
647     case '#':
648     case '*':
649         if (dowarn && len == 1 && sv_type == SVt_PV)
650             warn("Use of $%s is deprecated", name);
651         /* FALL THROUGH */
652     case '[':
653     case '!':
654     case '^':
655     case '~':
656     case '=':
657     case '-':
658     case '%':
659     case '.':
660     case '(':
661     case ')':
662     case '<':
663     case '>':
664     case ',':
665     case '\\':
666     case '/':
667     case '|':
668     case '\001':
669     case '\004':
670     case '\005':
671     case '\006':
672     case '\010':
673     case '\017':
674     case '\t':
675     case '\020':
676     case '\024':
677     case '\027':
678         if (len > 1)
679             break;
680         goto magicalize;
681
682     case '+':
683     case '1':
684     case '2':
685     case '3':
686     case '4':
687     case '5':
688     case '6':
689     case '7':
690     case '8':
691     case '9':
692       ro_magicalize:
693         SvREADONLY_on(GvSV(gv));
694       magicalize:
695         sv_magic(GvSV(gv), (SV*)gv, 0, name, len);
696         break;
697
698     case '\014':
699         if (len > 1)
700             break;
701         sv_setpv(GvSV(gv),"\f");
702         formfeed = GvSV(gv);
703         break;
704     case ';':
705         if (len > 1)
706             break;
707         sv_setpv(GvSV(gv),"\034");
708         break;
709     case ']':
710         if (len == 1) {
711             SV *sv = GvSV(gv);
712             sv_upgrade(sv, SVt_PVNV);
713             sv_setpv(sv, patchlevel);
714             (void)sv_2nv(sv);
715             SvREADONLY_on(sv);
716         }
717         break;
718     }
719     return gv;
720 }
721
722 void
723 gv_fullname3(sv, gv, prefix)
724 SV *sv;
725 GV *gv;
726 char *prefix;
727 {
728     HV *hv = GvSTASH(gv);
729     if (!hv) {
730         SvOK_off(sv);
731         return;
732     }
733     sv_setpv(sv, prefix ? prefix : "");
734     sv_catpv(sv,HvNAME(hv));
735     sv_catpvn(sv,"::", 2);
736     sv_catpvn(sv,GvNAME(gv),GvNAMELEN(gv));
737 }
738
739 void
740 gv_efullname3(sv, gv, prefix)
741 SV *sv;
742 GV *gv;
743 char *prefix;
744 {
745     GV *egv = GvEGV(gv);
746     if (!egv)
747         egv = gv;
748     gv_fullname3(sv, egv, prefix);
749 }
750
751 /* XXX compatibility with versions <= 5.003. */
752 void
753 gv_fullname(sv,gv)
754 SV *sv;
755 GV *gv;
756 {
757     gv_fullname3(sv, gv, sv == (SV*)gv ? "*" : "");
758 }
759
760 /* XXX compatibility with versions <= 5.003. */
761 void
762 gv_efullname(sv,gv)
763 SV *sv;
764 GV *gv;
765 {
766     gv_efullname3(sv, gv, sv == (SV*)gv ? "*" : "");
767 }
768
769 IO *
770 newIO()
771 {
772     IO *io;
773     GV *iogv;
774
775     io = (IO*)NEWSV(0,0);
776     sv_upgrade((SV *)io,SVt_PVIO);
777     SvREFCNT(io) = 1;
778     SvOBJECT_on(io);
779     iogv = gv_fetchpv("IO::Handle::", TRUE, SVt_PVHV);
780     SvSTASH(io) = (HV*)SvREFCNT_inc(GvHV(iogv));
781     return io;
782 }
783
784 void
785 gv_check(stash)
786 HV* stash;
787 {
788     register HE *entry;
789     register I32 i;
790     register GV *gv;
791     HV *hv;
792     GV *filegv;
793
794     if (!HvARRAY(stash))
795         return;
796     for (i = 0; i <= (I32) HvMAX(stash); i++) {
797         for (entry = HvARRAY(stash)[i]; entry; entry = HeNEXT(entry)) {
798             if (HeKEY(entry)[HeKLEN(entry)-1] == ':' &&
799                 (gv = (GV*)HeVAL(entry)) && (hv = GvHV(gv)) && HvNAME(hv))
800             {
801                 if (hv != defstash)
802                      gv_check(hv);              /* nested package */
803             }
804             else if (isALPHA(*HeKEY(entry))) {
805                 gv = (GV*)HeVAL(entry);
806                 if (GvMULTI(gv))
807                     continue;
808                 curcop->cop_line = GvLINE(gv);
809                 filegv = GvFILEGV(gv);
810                 curcop->cop_filegv = filegv;
811                 if (filegv && GvMULTI(filegv))  /* Filename began with slash */
812                     continue;
813                 warn("Name \"%s::%s\" used only once: possible typo",
814                         HvNAME(stash), GvNAME(gv));
815             }
816         }
817     }
818 }
819
820 GV *
821 newGVgen(pack)
822 char *pack;
823 {
824     (void)sprintf(tokenbuf,"%s::_GEN_%ld",pack,(long)gensym++);
825     return gv_fetchpv(tokenbuf,TRUE, SVt_PVGV);
826 }
827
828 /* hopefully this is only called on local symbol table entries */
829
830 GP*
831 gp_ref(gp)
832 GP* gp;
833 {
834     gp->gp_refcnt++;
835     if (gp->gp_cv) {
836         if (gp->gp_cvgen) {
837             /* multi-named GPs cannot be used for method cache */
838             SvREFCNT_dec(gp->gp_cv);
839             gp->gp_cv = Nullcv;
840             gp->gp_cvgen = 0;
841         }
842         else {
843             /* Adding a new name to a subroutine invalidates method cache */
844             sub_generation++;
845         }
846     }
847     return gp;
848 }
849
850 void
851 gp_free(gv)
852 GV* gv;
853 {
854     GP* gp;
855     CV* cv;
856
857     if (!gv || !(gp = GvGP(gv)))
858         return;
859     if (gp->gp_refcnt == 0) {
860         warn("Attempt to free unreferenced glob pointers");
861         return;
862     }
863     if (gp->gp_cv) {
864         /* Deleting the name of a subroutine invalidates method cache */
865         sub_generation++;
866     }
867     if (--gp->gp_refcnt > 0) {
868         if (gp->gp_egv == gv)
869             gp->gp_egv = 0;
870         return;
871     }
872
873     SvREFCNT_dec(gp->gp_sv);
874     SvREFCNT_dec(gp->gp_av);
875     SvREFCNT_dec(gp->gp_hv);
876     SvREFCNT_dec(gp->gp_io);
877     SvREFCNT_dec(gp->gp_cv);
878     SvREFCNT_dec(gp->gp_form);
879
880     Safefree(gp);
881     GvGP(gv) = 0;
882 }
883
884 #if defined(CRIPPLED_CC) && (defined(iAPX286) || defined(M_I286) || defined(I80286))
885 #define MICROPORT
886 #endif
887
888 #ifdef  MICROPORT       /* Microport 2.4 hack */
889 AV *GvAVn(gv)
890 register GV *gv;
891 {
892     if (GvGP(gv)->gp_av) 
893         return GvGP(gv)->gp_av;
894     else
895         return GvGP(gv_AVadd(gv))->gp_av;
896 }
897
898 HV *GvHVn(gv)
899 register GV *gv;
900 {
901     if (GvGP(gv)->gp_hv)
902         return GvGP(gv)->gp_hv;
903     else
904         return GvGP(gv_HVadd(gv))->gp_hv;
905 }
906 #endif                  /* Microport 2.4 hack */
907
908 #ifdef OVERLOAD
909 /* Updates and caches the CV's */
910
911 bool
912 Gv_AMupdate(stash)
913 HV* stash;
914 {
915   GV** gvp;
916   HV* hv;
917   GV* gv;
918   CV* cv;
919   MAGIC* mg=mg_find((SV*)stash,'c');
920   AMT *amtp=mg ? (AMT*)mg->mg_ptr: NULL;
921   AMT amt;
922
923   if (mg && amtp->was_ok_am == amagic_generation
924       && amtp->was_ok_sub == sub_generation)
925       return AMT_AMAGIC(amtp);
926   if (amtp && AMT_AMAGIC(amtp)) {       /* Have table. */
927     int i;
928     for (i=1; i<NofAMmeth; i++) {
929       if (amtp->table[i]) {
930         SvREFCNT_dec(amtp->table[i]);
931       }
932     }
933   }
934   sv_unmagic((SV*)stash, 'c');
935
936   DEBUG_o( deb("Recalcing overload magic in package %s\n",HvNAME(stash)) );
937
938   amt.was_ok_am = amagic_generation;
939   amt.was_ok_sub = sub_generation;
940   amt.fallback = AMGfallNO;
941   amt.flags = 0;
942
943 #ifdef OVERLOAD_VIA_HASH
944   gvp=(GV**)hv_fetch(stash,"OVERLOAD",8,FALSE); /* A shortcut */
945   if (gvp && ((gv = *gvp) != (GV*)&sv_undef && (hv = GvHV(gv)))) {
946     int filled=0;
947     int i;
948     char *cp;
949     SV* sv;
950     SV** svp;
951
952     /* Work with "fallback" key, which we assume to be first in AMG_names */
953
954     if (( cp = (char *)AMG_names[0] ) &&
955         (svp = (SV**)hv_fetch(hv,cp,strlen(cp),FALSE)) && (sv = *svp)) {
956       if (SvTRUE(sv)) amt.fallback=AMGfallYES;
957       else if (SvOK(sv)) amt.fallback=AMGfallNEVER;
958     }
959     for (i = 1; i < NofAMmeth; i++) {
960       cv = 0;
961       cp = (char *)AMG_names[i];
962       
963         svp = (SV**)hv_fetch(hv, cp, strlen(cp), FALSE);
964         if (svp && ((sv = *svp) != &sv_undef)) {
965           switch (SvTYPE(sv)) {
966             default:
967               if (!SvROK(sv)) {
968                 if (!SvOK(sv)) break;
969                 gv = gv_fetchmethod(stash, SvPV(sv, na));
970                 if (gv) cv = GvCV(gv);
971                 break;
972               }
973               cv = (CV*)SvRV(sv);
974               if (SvTYPE(cv) == SVt_PVCV)
975                   break;
976                 /* FALL THROUGH */
977             case SVt_PVHV:
978             case SVt_PVAV:
979               croak("Not a subroutine reference in overload table");
980               return FALSE;
981             case SVt_PVCV:
982               cv = (CV*)sv;
983               break;
984             case SVt_PVGV:
985               if (!(cv = GvCVu((GV*)sv)))
986                 cv = sv_2cv(sv, &stash, &gv, TRUE);
987               break;
988           }
989           if (cv) filled=1;
990           else {
991             croak("Method for operation %s not found in package %.256s during blessing\n",
992                 cp,HvNAME(stash));
993             return FALSE;
994           }
995         }
996 #else
997   {
998     int filled = 0;
999     int i;
1000     char *cp;
1001     SV* sv = NULL;
1002     SV** svp;
1003
1004     /* Work with "fallback" key, which we assume to be first in AMG_names */
1005
1006     if ( cp = (char *)AMG_names[0] ) {
1007         /* Try to find via inheritance. */
1008         gv = gv_fetchmeth(stash, "()", 2, -1); /* A cookie: "()". */
1009         if (gv) sv = GvSV(gv);
1010
1011         if (!gv) goto no_table;
1012         else if (SvTRUE(sv)) amt.fallback=AMGfallYES;
1013         else if (SvOK(sv)) amt.fallback=AMGfallNEVER;
1014     }
1015
1016     for (i = 1; i < NofAMmeth; i++) {
1017         cv = 0;
1018         cp = (char *)AMG_names[i];
1019       
1020         *buf = '(';                     /* A cookie: "(". */
1021         strcpy(buf + 1, cp);
1022         DEBUG_o( deb("Checking overloading of `%s' in package `%.256s'\n",
1023                      cp, HvNAME(stash)) );
1024         gv = gv_fetchmeth(stash, buf, strlen(buf), -1); /* no filling stash! */
1025         if(gv && (cv = GvCV(gv))) {
1026             char *name = buf;
1027             if (GvNAMELEN(CvGV(cv)) == 3 && strEQ(GvNAME(CvGV(cv)), "nil")
1028                 && strEQ(HvNAME(GvSTASH(CvGV(cv))), "overload")) {
1029                 /* GvSV contains the name of the method. */
1030                 GV *ngv;
1031                 
1032                 DEBUG_o( deb("Resolving method `%.256s' for overloaded `%s' in package `%.256s'\n", 
1033                              SvPV(GvSV(gv), na), cp, HvNAME(stash)) );
1034                 if (SvPOK(GvSV(gv)) 
1035                     && (ngv = gv_fetchmethod(stash, SvPVX(GvSV(gv))))) {
1036                     name = SvPVX(GvSV(gv));
1037                     cv = GvCV(gv = ngv);
1038                 } else {
1039                     /* Can be an import stub (created by `can'). */
1040                     if (GvCVGEN(gv)) {
1041                         croak("Stub found while resolving method `%.256s' overloading `%s' in package `%.256s'", 
1042                               (SvPOK(GvSV(gv)) ?  SvPVX(GvSV(gv)) : "???" ),
1043                               cp, HvNAME(stash));
1044                     } else
1045                         croak("Cannot resolve method `%.256s' overloading `%s' in package `%.256s'", 
1046                               (SvPOK(GvSV(gv)) ?  SvPVX(GvSV(gv)) : "???" ),
1047                               cp, HvNAME(stash));
1048                 }
1049                 /* If the sub is only a stub then we may have a gv to AUTOLOAD */
1050                 gv = (GV*)*hv_fetch(GvSTASH(gv), name, strlen(name), TRUE);
1051                 cv = GvCV(gv);
1052             }
1053             DEBUG_o( deb("Overloading `%s' in package `%.256s' via `%.256s::%.256s' \n",
1054                          cp, HvNAME(stash), HvNAME(GvSTASH(CvGV(cv))),
1055                          GvNAME(CvGV(cv))) );
1056             filled = 1;
1057         }
1058 #endif 
1059         amt.table[i]=(CV*)SvREFCNT_inc(cv);
1060     }
1061     if (filled) {
1062       AMT_AMAGIC_on(&amt);
1063       sv_magic((SV*)stash, 0, 'c', (char*)&amt, sizeof(AMT));
1064       return TRUE;
1065     }
1066   }
1067   /* Here we have no table: */
1068  no_table:
1069   AMT_AMAGIC_off(&amt);
1070   sv_magic((SV*)stash, 0, 'c', (char*)&amt, sizeof(AMTS));
1071   return FALSE;
1072 }
1073
1074 /* During call to this subroutine stack can be reallocated. It is
1075  * advised to call SPAGAIN macro in your code after call */
1076
1077 SV*
1078 amagic_call(left,right,method,flags)
1079 SV* left;
1080 SV* right;
1081 int method;
1082 int flags; 
1083 {
1084   MAGIC *mg; 
1085   CV *cv; 
1086   CV **cvp=NULL, **ocvp=NULL;
1087   AMT *amtp, *oamtp;
1088   int fl=0, off, off1, lr=0, assign=AMGf_assign & flags, notfound=0;
1089   int postpr=0, inc_dec_ass=0, assignshift=assign?1:0;
1090   HV* stash;
1091   if (!(AMGf_noleft & flags) && SvAMAGIC(left)
1092       && (mg = mg_find((SV*)(stash=SvSTASH(SvRV(left))),'c'))
1093       && (ocvp = cvp = (AMT_AMAGIC((AMT*)mg->mg_ptr) 
1094                         ? (oamtp = amtp = (AMT*)mg->mg_ptr)->table
1095                         : NULL))
1096       && ((cv = cvp[off=method+assignshift]) 
1097           || (assign && amtp->fallback > AMGfallNEVER && /* fallback to
1098                                                           * usual method */
1099                   (fl = 1, cv = cvp[off=method])))) {
1100     lr = -1;                    /* Call method for left argument */
1101   } else {
1102     if (cvp && amtp->fallback > AMGfallNEVER && flags & AMGf_unary) {
1103       int logic;
1104
1105       /* look for substituted methods */
1106          switch (method) {
1107          case inc_amg:
1108            if (((cv = cvp[off=add_ass_amg]) && (inc_dec_ass=1))
1109                || ((cv = cvp[off=add_amg]) && (postpr=1))) {
1110              right = &sv_yes; lr = -1; assign = 1;
1111            }
1112            break;
1113          case dec_amg:
1114            if (((cv = cvp[off=subtr_ass_amg])  && (inc_dec_ass=1))
1115                || ((cv = cvp[off=subtr_amg]) && (postpr=1))) {
1116              right = &sv_yes; lr = -1; assign = 1;
1117            }
1118            break;
1119          case bool__amg:
1120            (void)((cv = cvp[off=numer_amg]) || (cv = cvp[off=string_amg]));
1121            break;
1122          case numer_amg:
1123            (void)((cv = cvp[off=string_amg]) || (cv = cvp[off=bool__amg]));
1124            break;
1125          case string_amg:
1126            (void)((cv = cvp[off=numer_amg]) || (cv = cvp[off=bool__amg]));
1127            break;
1128  case not_amg:
1129    (void)((cv = cvp[off=bool__amg]) 
1130           || (cv = cvp[off=numer_amg])
1131           || (cv = cvp[off=string_amg]));
1132    postpr = 1;
1133    break;
1134          case copy_amg:
1135            {
1136              SV* ref=SvRV(left);
1137              if (!SvROK(ref) && SvTYPE(ref) <= SVt_PVMG) { /* Just to be
1138                                                       * extra
1139                                                       * causious,
1140                                                       * maybe in some
1141                                                       * additional
1142                                                       * cases sv_setsv
1143                                                       * is safe too */
1144                 SV* newref = newSVsv(ref);
1145                 SvOBJECT_on(newref);
1146                 SvSTASH(newref) = (HV*)SvREFCNT_inc(SvSTASH(ref));
1147                 return newref;
1148              }
1149            }
1150            break;
1151          case abs_amg:
1152            if ((cvp[off1=lt_amg] || cvp[off1=ncmp_amg]) 
1153                && ((cv = cvp[off=neg_amg]) || (cv = cvp[off=subtr_amg]))) {
1154              SV* nullsv=sv_2mortal(newSViv(0));
1155              if (off1==lt_amg) {
1156                SV* lessp = amagic_call(left,nullsv,
1157                                        lt_amg,AMGf_noright);
1158                logic = SvTRUE(lessp);
1159              } else {
1160                SV* lessp = amagic_call(left,nullsv,
1161                                        ncmp_amg,AMGf_noright);
1162                logic = (SvNV(lessp) < 0);
1163              }
1164              if (logic) {
1165                if (off==subtr_amg) {
1166                  right = left;
1167                  left = nullsv;
1168                  lr = 1;
1169                }
1170              } else {
1171                return left;
1172              }
1173            }
1174            break;
1175          case neg_amg:
1176            if (cv = cvp[off=subtr_amg]) {
1177              right = left;
1178              left = sv_2mortal(newSViv(0));
1179              lr = 1;
1180            }
1181            break;
1182          default:
1183            goto not_found;
1184          }
1185          if (!cv) goto not_found;
1186     } else if (!(AMGf_noright & flags) && SvAMAGIC(right)
1187                && (mg = mg_find((SV*)(stash=SvSTASH(SvRV(right))),'c'))
1188                && (cvp = (AMT_AMAGIC((AMT*)mg->mg_ptr) 
1189                           ? (amtp = (AMT*)mg->mg_ptr)->table
1190                           : NULL))
1191                && (cv = cvp[off=method])) { /* Method for right
1192                                              * argument found */
1193       lr=1;
1194     } else if (((ocvp && oamtp->fallback > AMGfallNEVER 
1195                  && (cvp=ocvp) && (lr = -1)) 
1196                 || (cvp && amtp->fallback > AMGfallNEVER && (lr=1)))
1197                && !(flags & AMGf_unary)) {
1198                                 /* We look for substitution for
1199                                  * comparison operations and
1200                                  * concatendation */
1201       if (method==concat_amg || method==concat_ass_amg
1202           || method==repeat_amg || method==repeat_ass_amg) {
1203         return NULL;            /* Delegate operation to string conversion */
1204       }
1205       off = -1;
1206       switch (method) {
1207          case lt_amg:
1208          case le_amg:
1209          case gt_amg:
1210          case ge_amg:
1211          case eq_amg:
1212          case ne_amg:
1213            postpr = 1; off=ncmp_amg; break;
1214          case slt_amg:
1215          case sle_amg:
1216          case sgt_amg:
1217          case sge_amg:
1218          case seq_amg:
1219          case sne_amg:
1220            postpr = 1; off=scmp_amg; break;
1221          }
1222       if (off != -1) cv = cvp[off];
1223       if (!cv) {
1224         goto not_found;
1225       }
1226     } else {
1227     not_found:                  /* No method found, either report or croak */
1228       if (ocvp && (cv=ocvp[nomethod_amg])) { /* Call report method */
1229         notfound = 1; lr = -1;
1230       } else if (cvp && (cv=cvp[nomethod_amg])) {
1231         notfound = 1; lr = 1;
1232       } else {
1233         if (off==-1) off=method;
1234         sprintf(buf,
1235                 "Operation `%s': no method found,%sargument %s%.256s%s%.256s",
1236                       AMG_names[method + assignshift],
1237                       (flags & AMGf_unary ? " " : "\n\tleft "),
1238                       SvAMAGIC(left)? 
1239                         "in overloaded package ":
1240                         "has no overloaded magic",
1241                       SvAMAGIC(left)? 
1242                         HvNAME(SvSTASH(SvRV(left))):
1243                         "",
1244                       SvAMAGIC(right)? 
1245                         ",\n\tright argument in overloaded package ":
1246                         (flags & AMGf_unary 
1247                          ? ""
1248                          : ",\n\tright argument has no overloaded magic"),
1249                       SvAMAGIC(right)? 
1250                         HvNAME(SvSTASH(SvRV(right))):
1251                         "");
1252         if (amtp && amtp->fallback >= AMGfallYES) {
1253           DEBUG_o( deb(buf) );
1254         } else {
1255           croak(buf);
1256         }
1257         return NULL;
1258       }
1259     }
1260   }
1261   if (!notfound) {
1262     DEBUG_o( deb(
1263   "Overloaded operator `%s'%s%s%s:\n\tmethod%s found%s in package %.256s%s\n",
1264                  AMG_names[off],
1265                  method+assignshift==off? "" :
1266                              " (initially `",
1267                  method+assignshift==off? "" :
1268                              AMG_names[method+assignshift],
1269                  method+assignshift==off? "" : "')",
1270                  flags & AMGf_unary? "" :
1271                    lr==1 ? " for right argument": " for left argument",
1272                  flags & AMGf_unary? " for argument" : "",
1273                  HvNAME(stash), 
1274                  fl? ",\n\tassignment variant used": "") );
1275     /* Since we use shallow copy during assignment, we need
1276      * to dublicate the contents, probably calling user-supplied
1277      * version of copy operator
1278      */
1279     if ((method + assignshift==off 
1280          && (assign || method==inc_amg || method==dec_amg))
1281         || inc_dec_ass) RvDEEPCP(left);
1282   }
1283   {
1284     dSP;
1285     BINOP myop;
1286     SV* res;
1287
1288     Zero(&myop, 1, BINOP);
1289     myop.op_last = (OP *) &myop;
1290     myop.op_next = Nullop;
1291     myop.op_flags = OPf_KNOW|OPf_STACKED;
1292
1293     ENTER;
1294     SAVESPTR(op);
1295     op = (OP *) &myop;
1296     if (perldb && curstash != debstash)
1297         op->op_private |= OPpENTERSUB_DB;
1298     PUTBACK;
1299     pp_pushmark();
1300
1301     EXTEND(sp, notfound + 5);
1302     PUSHs(lr>0? right: left);
1303     PUSHs(lr>0? left: right);
1304     PUSHs( assign ? &sv_undef : (lr>0? &sv_yes: &sv_no));
1305     if (notfound) {
1306       PUSHs( sv_2mortal(newSVpv((char *)AMG_names[method + assignshift],0)) );
1307     }
1308     PUSHs((SV*)cv);
1309     PUTBACK;
1310
1311     if (op = pp_entersub())
1312       runops();
1313     LEAVE;
1314     SPAGAIN;
1315
1316     res=POPs;
1317     PUTBACK;
1318
1319     if (postpr) {
1320       int ans;
1321       switch (method) {
1322       case le_amg:
1323       case sle_amg:
1324         ans=SvIV(res)<=0; break;
1325       case lt_amg:
1326       case slt_amg:
1327         ans=SvIV(res)<0; break;
1328       case ge_amg:
1329       case sge_amg:
1330         ans=SvIV(res)>=0; break;
1331       case gt_amg:
1332       case sgt_amg:
1333         ans=SvIV(res)>0; break;
1334       case eq_amg:
1335       case seq_amg:
1336         ans=SvIV(res)==0; break;
1337       case ne_amg:
1338       case sne_amg:
1339         ans=SvIV(res)!=0; break;
1340       case inc_amg:
1341       case dec_amg:
1342         SvSetSV(left,res); return left;
1343       case not_amg:
1344         ans=!SvOK(res); break;
1345       }
1346       return ans? &sv_yes: &sv_no;
1347     } else if (method==copy_amg) {
1348       if (!SvROK(res)) {
1349         croak("Copy method did not return a reference");
1350       }
1351       return SvREFCNT_inc(SvRV(res));
1352     } else {
1353       return res;
1354     }
1355   }
1356 }
1357 #endif /* OVERLOAD */