This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Integrate:
[perl5.git] / universal.c
1 /*    universal.c
2  *
3  *    Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4  *    2005, 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  * "The roots of those mountains must be roots indeed; there must be
13  * great secrets buried there which have not been discovered since the
14  * beginning." --Gandalf, relating Gollum's story
15  */
16
17 /* This file contains the code that implements the functions in Perl's
18  * UNIVERSAL package, such as UNIVERSAL->can().
19  */
20
21 #include "EXTERN.h"
22 #define PERL_IN_UNIVERSAL_C
23 #include "perl.h"
24
25 #ifdef USE_PERLIO
26 #include "perliol.h" /* For the PERLIO_F_XXX */
27 #endif
28
29 /*
30  * Contributed by Graham Barr  <Graham.Barr@tiuk.ti.com>
31  * The main guts of traverse_isa was actually copied from gv_fetchmeth
32  */
33
34 STATIC SV *
35 S_isa_lookup(pTHX_ HV *stash, const char *name, HV* name_stash,
36              int len, int level)
37 {
38     AV* av;
39     GV* gv;
40     GV** gvp;
41     HV* hv = Nullhv;
42     SV* subgen = Nullsv;
43     const char *hvname;
44
45     /* A stash/class can go by many names (ie. User == main::User), so 
46        we compare the stash itself just in case */
47     if (name_stash && (stash == name_stash))
48         return &PL_sv_yes;
49
50     hvname = HvNAME_get(stash);
51
52     if (strEQ(hvname, name))
53         return &PL_sv_yes;
54
55     if (strEQ(name, "UNIVERSAL"))
56         return &PL_sv_yes;
57
58     if (level > 100)
59         Perl_croak(aTHX_ "Recursive inheritance detected in package '%s'",
60                    hvname);
61
62     gvp = (GV**)hv_fetch(stash, "::ISA::CACHE::", 14, FALSE);
63
64     if (gvp && (gv = *gvp) != (GV*)&PL_sv_undef && (subgen = GvSV(gv))
65         && (hv = GvHV(gv)))
66     {
67         if (SvIV(subgen) == (IV)PL_sub_generation) {
68             SV* sv;
69             SV** svp = (SV**)hv_fetch(hv, name, len, FALSE);
70             if (svp && (sv = *svp) != (SV*)&PL_sv_undef) {
71                 DEBUG_o( Perl_deb(aTHX_ "Using cached ISA %s for package %s\n",
72                                   name, hvname) );
73                 return sv;
74             }
75         }
76         else {
77             DEBUG_o( Perl_deb(aTHX_ "ISA Cache in package %s is stale\n",
78                               hvname) );
79             hv_clear(hv);
80             sv_setiv(subgen, PL_sub_generation);
81         }
82     }
83
84     gvp = (GV**)hv_fetch(stash,"ISA",3,FALSE);
85
86     if (gvp && (gv = *gvp) != (GV*)&PL_sv_undef && (av = GvAV(gv))) {
87         if (!hv || !subgen) {
88             gvp = (GV**)hv_fetch(stash, "::ISA::CACHE::", 14, TRUE);
89
90             gv = *gvp;
91
92             if (SvTYPE(gv) != SVt_PVGV)
93                 gv_init(gv, stash, "::ISA::CACHE::", 14, TRUE);
94
95             if (!hv)
96                 hv = GvHVn(gv);
97             if (!subgen) {
98                 subgen = newSViv(PL_sub_generation);
99                 GvSV(gv) = subgen;
100             }
101         }
102         if (hv) {
103             SV** svp = AvARRAY(av);
104             /* NOTE: No support for tied ISA */
105             I32 items = AvFILLp(av) + 1;
106             while (items--) {
107                 SV* sv = *svp++;
108                 HV* basestash = gv_stashsv(sv, FALSE);
109                 if (!basestash) {
110                     if (ckWARN(WARN_MISC))
111                         Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
112                                     "Can't locate package %"SVf" for @%s::ISA",
113                                     sv, hvname);
114                     continue;
115                 }
116                 if (&PL_sv_yes == isa_lookup(basestash, name, name_stash, 
117                                              len, level + 1)) {
118                     (void)hv_store(hv,name,len,&PL_sv_yes,0);
119                     return &PL_sv_yes;
120                 }
121             }
122             (void)hv_store(hv,name,len,&PL_sv_no,0);
123         }
124     }
125     return &PL_sv_no;
126 }
127
128 /*
129 =head1 SV Manipulation Functions
130
131 =for apidoc sv_derived_from
132
133 Returns a boolean indicating whether the SV is derived from the specified
134 class.  This is the function that implements C<UNIVERSAL::isa>.  It works
135 for class names as well as for objects.
136
137 =cut
138 */
139
140 bool
141 Perl_sv_derived_from(pTHX_ SV *sv, const char *name)
142 {
143     const char *type = Nullch;
144     HV *stash = Nullhv;
145     HV *name_stash;
146
147     if (SvGMAGICAL(sv))
148         mg_get(sv) ;
149
150     if (SvROK(sv)) {
151         sv = SvRV(sv);
152         type = sv_reftype(sv,0);
153         if (SvOBJECT(sv))
154             stash = SvSTASH(sv);
155     }
156     else {
157         stash = gv_stashsv(sv, FALSE);
158     }
159
160     name_stash = gv_stashpv(name, FALSE);
161
162     return (type && strEQ(type,name)) ||
163             (stash && isa_lookup(stash, name, name_stash, strlen(name), 0) 
164              == &PL_sv_yes)
165         ? TRUE
166         : FALSE ;
167 }
168
169 #include "XSUB.h"
170
171 void XS_UNIVERSAL_isa(pTHX_ CV *cv);
172 void XS_UNIVERSAL_can(pTHX_ CV *cv);
173 void XS_UNIVERSAL_VERSION(pTHX_ CV *cv);
174 XS(XS_utf8_is_utf8);
175 XS(XS_utf8_valid);
176 XS(XS_utf8_encode);
177 XS(XS_utf8_decode);
178 XS(XS_utf8_upgrade);
179 XS(XS_utf8_downgrade);
180 XS(XS_utf8_unicode_to_native);
181 XS(XS_utf8_native_to_unicode);
182 XS(XS_Internals_SvREADONLY);
183 XS(XS_Internals_SvREFCNT);
184 XS(XS_Internals_hv_clear_placehold);
185 XS(XS_PerlIO_get_layers);
186 XS(XS_Regexp_DESTROY);
187 XS(XS_Internals_hash_seed);
188 XS(XS_Internals_rehash_seed);
189 XS(XS_Internals_HvREHASH);
190
191 void
192 Perl_boot_core_UNIVERSAL(pTHX)
193 {
194     const char file[] = __FILE__;
195
196     newXS("UNIVERSAL::isa",             XS_UNIVERSAL_isa,         file);
197     newXS("UNIVERSAL::can",             XS_UNIVERSAL_can,         file);
198     newXS("UNIVERSAL::VERSION",         XS_UNIVERSAL_VERSION,     file);
199     newXS("utf8::is_utf8", XS_utf8_is_utf8, file);
200     newXS("utf8::valid", XS_utf8_valid, file);
201     newXS("utf8::encode", XS_utf8_encode, file);
202     newXS("utf8::decode", XS_utf8_decode, file);
203     newXS("utf8::upgrade", XS_utf8_upgrade, file);
204     newXS("utf8::downgrade", XS_utf8_downgrade, file);
205     newXS("utf8::native_to_unicode", XS_utf8_native_to_unicode, file);
206     newXS("utf8::unicode_to_native", XS_utf8_unicode_to_native, file);
207     newXSproto("Internals::SvREADONLY",XS_Internals_SvREADONLY, file, "\\[$%@];$");
208     newXSproto("Internals::SvREFCNT",XS_Internals_SvREFCNT, file, "\\[$%@];$");
209     newXSproto("Internals::hv_clear_placeholders",
210                XS_Internals_hv_clear_placehold, file, "\\%");
211     newXSproto("PerlIO::get_layers",
212                XS_PerlIO_get_layers, file, "*;@");
213     newXS("Regexp::DESTROY", XS_Regexp_DESTROY, file);
214     newXSproto("Internals::hash_seed",XS_Internals_hash_seed, file, "");
215     newXSproto("Internals::rehash_seed",XS_Internals_rehash_seed, file, "");
216     newXSproto("Internals::HvREHASH", XS_Internals_HvREHASH, file, "\\%");
217 }
218
219
220 XS(XS_UNIVERSAL_isa)
221 {
222     dXSARGS;
223     SV *sv;
224     const char *name;
225     STRLEN n_a;
226
227     if (items != 2)
228         Perl_croak(aTHX_ "Usage: UNIVERSAL::isa(reference, kind)");
229
230     sv = ST(0);
231
232     if (SvGMAGICAL(sv))
233         mg_get(sv);
234
235     if (!SvOK(sv) || !(SvROK(sv) || (SvPOK(sv) && SvCUR(sv))
236                 || (SvGMAGICAL(sv) && SvPOKp(sv) && SvCUR(sv))))
237         XSRETURN_UNDEF;
238
239     name = (const char *)SvPV(ST(1),n_a);
240
241     ST(0) = boolSV(sv_derived_from(sv, name));
242     XSRETURN(1);
243 }
244
245 XS(XS_UNIVERSAL_can)
246 {
247     dXSARGS;
248     SV   *sv;
249     const char *name;
250     SV   *rv;
251     HV   *pkg = NULL;
252     STRLEN n_a;
253
254     if (items != 2)
255         Perl_croak(aTHX_ "Usage: UNIVERSAL::can(object-ref, method)");
256
257     sv = ST(0);
258
259     if (SvGMAGICAL(sv))
260         mg_get(sv);
261
262     if (!SvOK(sv) || !(SvROK(sv) || (SvPOK(sv) && SvCUR(sv))
263                 || (SvGMAGICAL(sv) && SvPOKp(sv) && SvCUR(sv))))
264         XSRETURN_UNDEF;
265
266     name = (const char *)SvPV(ST(1),n_a);
267     rv = &PL_sv_undef;
268
269     if (SvROK(sv)) {
270         sv = (SV*)SvRV(sv);
271         if (SvOBJECT(sv))
272             pkg = SvSTASH(sv);
273     }
274     else {
275         pkg = gv_stashsv(sv, FALSE);
276     }
277
278     if (pkg) {
279         GV *gv = gv_fetchmethod_autoload(pkg, name, FALSE);
280         if (gv && isGV(gv))
281             rv = sv_2mortal(newRV((SV*)GvCV(gv)));
282     }
283
284     ST(0) = rv;
285     XSRETURN(1);
286 }
287
288 XS(XS_UNIVERSAL_VERSION)
289 {
290     dXSARGS;
291     HV *pkg;
292     GV **gvp;
293     GV *gv;
294     SV *sv;
295     const char *undef;
296
297     if (SvROK(ST(0))) {
298         sv = (SV*)SvRV(ST(0));
299         if (!SvOBJECT(sv))
300             Perl_croak(aTHX_ "Cannot find version of an unblessed reference");
301         pkg = SvSTASH(sv);
302     }
303     else {
304         pkg = gv_stashsv(ST(0), FALSE);
305     }
306
307     gvp = pkg ? (GV**)hv_fetch(pkg,"VERSION",7,FALSE) : Null(GV**);
308
309     if (gvp && isGV(gv = *gvp) && SvOK(sv = GvSV(gv))) {
310         SV *nsv = sv_newmortal();
311         sv_setsv(nsv, sv);
312         sv = nsv;
313         undef = Nullch;
314     }
315     else {
316         sv = (SV*)&PL_sv_undef;
317         undef = "(undef)";
318     }
319
320     if (items > 1) {
321         SV *req = ST(1);
322
323         if (undef) {
324             if (pkg) {
325                 const char *name = HvNAME_get(pkg);
326                 Perl_croak(aTHX_
327                              "%s does not define $%s::VERSION--version check failed",
328                              name, name);
329             } else {
330                 STRLEN n_a;
331                 const char *str = SvPVx(ST(0), n_a);
332                 Perl_croak(aTHX_
333                            "%s defines neither package nor VERSION--version check failed", str);
334              }
335         }
336         if (!SvNIOK(sv) && SvPOK(sv)) {
337             STRLEN len;
338             char *str = SvPVx(sv,len);
339             while (len) {
340                 --len;
341                 /* XXX could DWIM "1.2.3" here */
342                 if (!isDIGIT(str[len]) && str[len] != '.' && str[len] != '_')
343                     break;
344             }
345             if (len) {
346                 if (SvNOK(req) && SvPOK(req)) {
347                     /* they said C<use Foo v1.2.3> and $Foo::VERSION
348                      * doesn't look like a float: do string compare */
349                     if (sv_cmp(req,sv) == 1) {
350                         Perl_croak(aTHX_ "%s v%"VDf" required--"
351                                    "this is only v%"VDf,
352                                    HvNAME(pkg), req, sv);
353                     }
354                     goto finish;
355                 }
356                 /* they said C<use Foo 1.002_003> and $Foo::VERSION
357                  * doesn't look like a float: force numeric compare */
358                 (void)SvUPGRADE(sv, SVt_PVNV);
359                 SvNVX(sv) = str_to_version(sv);
360                 SvPOK_off(sv);
361                 SvNOK_on(sv);
362             }
363         }
364         /* if we get here, we're looking for a numeric comparison,
365          * so force the required version into a float, even if they
366          * said C<use Foo v1.2.3> */
367         if (SvNOK(req) && SvPOK(req)) {
368             NV n = SvNV(req);
369             req = sv_newmortal();
370             sv_setnv(req, n);
371         }
372
373         if (SvNV(req) > SvNV(sv))
374             Perl_croak(aTHX_ "%s version %s required--this is only version %s",
375                        HvNAME_get(pkg), SvPV_nolen(req), SvPV_nolen(sv));
376     }
377
378 finish:
379     ST(0) = sv;
380
381     XSRETURN(1);
382 }
383
384 XS(XS_utf8_is_utf8)
385 {
386      dXSARGS;
387      if (items != 1)
388           Perl_croak(aTHX_ "Usage: utf8::is_utf8(sv)");
389      {
390           const SV *sv = ST(0);
391           {
392                if (SvUTF8(sv))
393                     XSRETURN_YES;
394                else
395                     XSRETURN_NO;
396           }
397      }
398      XSRETURN_EMPTY;
399 }
400
401 XS(XS_utf8_valid)
402 {
403      dXSARGS;
404      if (items != 1)
405           Perl_croak(aTHX_ "Usage: utf8::valid(sv)");
406      {
407           SV *  sv = ST(0);
408           {
409                STRLEN len;
410                const char *s = SvPV(sv,len);
411                if (!SvUTF8(sv) || is_utf8_string((const U8*)s,len))
412                     XSRETURN_YES;
413                else
414                     XSRETURN_NO;
415           }
416      }
417      XSRETURN_EMPTY;
418 }
419
420 XS(XS_utf8_encode)
421 {
422     dXSARGS;
423     if (items != 1)
424         Perl_croak(aTHX_ "Usage: utf8::encode(sv)");
425     {
426         SV *    sv = ST(0);
427
428         sv_utf8_encode(sv);
429     }
430     XSRETURN_EMPTY;
431 }
432
433 XS(XS_utf8_decode)
434 {
435     dXSARGS;
436     if (items != 1)
437         Perl_croak(aTHX_ "Usage: utf8::decode(sv)");
438     {
439         SV *    sv = ST(0);
440         const bool RETVAL = sv_utf8_decode(sv);
441         ST(0) = boolSV(RETVAL);
442         sv_2mortal(ST(0));
443     }
444     XSRETURN(1);
445 }
446
447 XS(XS_utf8_upgrade)
448 {
449     dXSARGS;
450     if (items != 1)
451         Perl_croak(aTHX_ "Usage: utf8::upgrade(sv)");
452     {
453         SV *    sv = ST(0);
454         STRLEN  RETVAL;
455         dXSTARG;
456
457         RETVAL = sv_utf8_upgrade(sv);
458         XSprePUSH; PUSHi((IV)RETVAL);
459     }
460     XSRETURN(1);
461 }
462
463 XS(XS_utf8_downgrade)
464 {
465     dXSARGS;
466     if (items < 1 || items > 2)
467         Perl_croak(aTHX_ "Usage: utf8::downgrade(sv, failok=0)");
468     {
469         SV *    sv = ST(0);
470         const bool failok = (items < 2) ? 0 : (int)SvIV(ST(1));
471         const bool RETVAL = sv_utf8_downgrade(sv, failok);
472
473         ST(0) = boolSV(RETVAL);
474         sv_2mortal(ST(0));
475     }
476     XSRETURN(1);
477 }
478
479 XS(XS_utf8_native_to_unicode)
480 {
481  dXSARGS;
482  const UV uv = SvUV(ST(0));
483
484  if (items > 1)
485      Perl_croak(aTHX_ "Usage: utf8::native_to_unicode(sv)");
486
487  ST(0) = sv_2mortal(newSViv(NATIVE_TO_UNI(uv)));
488  XSRETURN(1);
489 }
490
491 XS(XS_utf8_unicode_to_native)
492 {
493  dXSARGS;
494  const UV uv = SvUV(ST(0));
495
496  if (items > 1)
497      Perl_croak(aTHX_ "Usage: utf8::unicode_to_native(sv)");
498
499  ST(0) = sv_2mortal(newSViv(UNI_TO_NATIVE(uv)));
500  XSRETURN(1);
501 }
502
503 XS(XS_Internals_SvREADONLY)     /* This is dangerous stuff. */
504 {
505     dXSARGS;
506     SV *sv = SvRV(ST(0));
507
508     if (items == 1) {
509          if (SvREADONLY(sv))
510              XSRETURN_YES;
511          else
512              XSRETURN_NO;
513     }
514     else if (items == 2) {
515         if (SvTRUE(ST(1))) {
516             SvREADONLY_on(sv);
517             XSRETURN_YES;
518         }
519         else {
520             /* I hope you really know what you are doing. */
521             SvREADONLY_off(sv);
522             XSRETURN_NO;
523         }
524     }
525     XSRETURN_UNDEF; /* Can't happen. */
526 }
527
528 XS(XS_Internals_SvREFCNT)       /* This is dangerous stuff. */
529 {
530     dXSARGS;
531     SV *sv = SvRV(ST(0));
532
533     if (items == 1)
534          XSRETURN_IV(SvREFCNT(sv) - 1); /* Minus the ref created for us. */
535     else if (items == 2) {
536          /* I hope you really know what you are doing. */
537          SvREFCNT(sv) = SvIV(ST(1));
538          XSRETURN_IV(SvREFCNT(sv));
539     }
540     XSRETURN_UNDEF; /* Can't happen. */
541 }
542
543 XS(XS_Internals_hv_clear_placehold)
544 {
545     dXSARGS;
546     HV *hv = (HV *) SvRV(ST(0));
547
548     if (items != 1)
549         Perl_croak(aTHX_ "Usage: UNIVERSAL::hv_clear_placeholders(hv)");
550     hv_clear_placeholders(hv);
551     XSRETURN(0);
552 }
553
554 XS(XS_Regexp_DESTROY)
555 {
556 }
557
558 XS(XS_PerlIO_get_layers)
559 {
560     dXSARGS;
561     if (items < 1 || items % 2 == 0)
562         Perl_croak(aTHX_ "Usage: PerlIO_get_layers(filehandle[,args])");
563 #ifdef USE_PERLIO
564     {
565         SV *    sv;
566         GV *    gv;
567         IO *    io;
568         bool    input = TRUE;
569         bool    details = FALSE;
570
571         if (items > 1) {
572              SV **svp;
573              
574              for (svp = MARK + 2; svp <= SP; svp += 2) {
575                   SV **varp = svp;
576                   SV **valp = svp + 1;
577                   STRLEN klen;
578                   const char *key = SvPV(*varp, klen);
579
580                   switch (*key) {
581                   case 'i':
582                        if (klen == 5 && memEQ(key, "input", 5)) {
583                             input = SvTRUE(*valp);
584                             break;
585                        }
586                        goto fail;
587                   case 'o': 
588                        if (klen == 6 && memEQ(key, "output", 6)) {
589                             input = !SvTRUE(*valp);
590                             break;
591                        }
592                        goto fail;
593                   case 'd':
594                        if (klen == 7 && memEQ(key, "details", 7)) {
595                             details = SvTRUE(*valp);
596                             break;
597                        }
598                        goto fail;
599                   default:
600                   fail:
601                        Perl_croak(aTHX_
602                                   "get_layers: unknown argument '%s'",
603                                   key);
604                   }
605              }
606
607              SP -= (items - 1);
608         }
609
610         sv = POPs;
611         gv = (GV*)sv;
612
613         if (!isGV(sv)) {
614              if (SvROK(sv) && isGV(SvRV(sv)))
615                   gv = (GV*)SvRV(sv);
616              else
617                   gv = gv_fetchpv(SvPVX(sv), FALSE, SVt_PVIO);
618         }
619
620         if (gv && (io = GvIO(gv))) {
621              dTARGET;
622              AV* av = PerlIO_get_layers(aTHX_ input ?
623                                         IoIFP(io) : IoOFP(io));
624              I32 i;
625              I32 last = av_len(av);
626              I32 nitem = 0;
627              
628              for (i = last; i >= 0; i -= 3) {
629                   SV **namsvp;
630                   SV **argsvp;
631                   SV **flgsvp;
632                   bool namok, argok, flgok;
633
634                   namsvp = av_fetch(av, i - 2, FALSE);
635                   argsvp = av_fetch(av, i - 1, FALSE);
636                   flgsvp = av_fetch(av, i,     FALSE);
637
638                   namok = namsvp && *namsvp && SvPOK(*namsvp);
639                   argok = argsvp && *argsvp && SvPOK(*argsvp);
640                   flgok = flgsvp && *flgsvp && SvIOK(*flgsvp);
641
642                   if (details) {
643                        XPUSHs(namok ?
644                              newSVpv(SvPVX_const(*namsvp), 0) : &PL_sv_undef);
645                        XPUSHs(argok ?
646                              newSVpv(SvPVX_const(*argsvp), 0) : &PL_sv_undef);
647                        if (flgok)
648                             XPUSHi(SvIVX(*flgsvp));
649                        else
650                             XPUSHs(&PL_sv_undef);
651                        nitem += 3;
652                   }
653                   else {
654                        if (namok && argok)
655                             XPUSHs(Perl_newSVpvf(aTHX_ "%"SVf"(%"SVf")",
656                                                *namsvp, *argsvp));
657                        else if (namok)
658                             XPUSHs(Perl_newSVpvf(aTHX_ "%"SVf, *namsvp));
659                        else
660                             XPUSHs(&PL_sv_undef);
661                        nitem++;
662                        if (flgok) {
663                             IV flags = SvIVX(*flgsvp);
664
665                             if (flags & PERLIO_F_UTF8) {
666                                  XPUSHs(newSVpvn("utf8", 4));
667                                  nitem++;
668                             }
669                        }
670                   }
671              }
672
673              SvREFCNT_dec(av);
674
675              XSRETURN(nitem);
676         }
677     }
678 #endif
679
680     XSRETURN(0);
681 }
682
683 XS(XS_Internals_hash_seed)
684 {
685     /* Using dXSARGS would also have dITEM and dSP,
686      * which define 2 unused local variables.  */
687     dAXMARK;
688     XSRETURN_UV(PERL_HASH_SEED);
689 }
690
691 XS(XS_Internals_rehash_seed)
692 {
693     /* Using dXSARGS would also have dITEM and dSP,
694      * which define 2 unused local variables.  */
695     dAXMARK;
696     XSRETURN_UV(PL_rehash_seed);
697 }
698
699 XS(XS_Internals_HvREHASH)       /* Subject to change  */
700 {
701     dXSARGS;
702     if (SvROK(ST(0))) {
703         const HV *hv = (HV *) SvRV(ST(0));
704         if (items == 1 && SvTYPE(hv) == SVt_PVHV) {
705             if (HvREHASH(hv))
706                 XSRETURN_YES;
707             else
708                 XSRETURN_NO;
709         }
710     }
711     Perl_croak(aTHX_ "Internals::HvREHASH $hashref");
712 }
713
714 /*
715  * Local variables:
716  * c-indentation-style: bsd
717  * c-basic-offset: 4
718  * indent-tabs-mode: t
719  * End:
720  *
721  * ex: set ts=8 sts=4 sw=4 noet:
722  */