This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Integrate the API from:
[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;
144     HV *stash;
145     HV *name_stash;
146
147     stash = Nullhv;
148     type = Nullch;
149
150     if (SvGMAGICAL(sv))
151         mg_get(sv) ;
152
153     if (SvROK(sv)) {
154         sv = SvRV(sv);
155         type = sv_reftype(sv,0);
156         if (SvOBJECT(sv))
157             stash = SvSTASH(sv);
158     }
159     else {
160         stash = gv_stashsv(sv, FALSE);
161     }
162
163     name_stash = gv_stashpv(name, FALSE);
164
165     return (type && strEQ(type,name)) ||
166             (stash && isa_lookup(stash, name, name_stash, strlen(name), 0) 
167              == &PL_sv_yes)
168         ? TRUE
169         : FALSE ;
170 }
171
172 #include "XSUB.h"
173
174 void XS_UNIVERSAL_isa(pTHX_ CV *cv);
175 void XS_UNIVERSAL_can(pTHX_ CV *cv);
176 void XS_UNIVERSAL_VERSION(pTHX_ CV *cv);
177 XS(XS_utf8_is_utf8);
178 XS(XS_utf8_valid);
179 XS(XS_utf8_encode);
180 XS(XS_utf8_decode);
181 XS(XS_utf8_upgrade);
182 XS(XS_utf8_downgrade);
183 XS(XS_utf8_unicode_to_native);
184 XS(XS_utf8_native_to_unicode);
185 XS(XS_Internals_SvREADONLY);
186 XS(XS_Internals_SvREFCNT);
187 XS(XS_Internals_hv_clear_placehold);
188 XS(XS_PerlIO_get_layers);
189 XS(XS_Regexp_DESTROY);
190 XS(XS_Internals_hash_seed);
191 XS(XS_Internals_rehash_seed);
192 XS(XS_Internals_HvREHASH);
193
194 void
195 Perl_boot_core_UNIVERSAL(pTHX)
196 {
197     const char file[] = __FILE__;
198
199     newXS("UNIVERSAL::isa",             XS_UNIVERSAL_isa,         file);
200     newXS("UNIVERSAL::can",             XS_UNIVERSAL_can,         file);
201     newXS("UNIVERSAL::VERSION",         XS_UNIVERSAL_VERSION,     file);
202     newXS("utf8::is_utf8", XS_utf8_is_utf8, file);
203     newXS("utf8::valid", XS_utf8_valid, file);
204     newXS("utf8::encode", XS_utf8_encode, file);
205     newXS("utf8::decode", XS_utf8_decode, file);
206     newXS("utf8::upgrade", XS_utf8_upgrade, file);
207     newXS("utf8::downgrade", XS_utf8_downgrade, file);
208     newXS("utf8::native_to_unicode", XS_utf8_native_to_unicode, file);
209     newXS("utf8::unicode_to_native", XS_utf8_unicode_to_native, file);
210     newXSproto("Internals::SvREADONLY",XS_Internals_SvREADONLY, file, "\\[$%@];$");
211     newXSproto("Internals::SvREFCNT",XS_Internals_SvREFCNT, file, "\\[$%@];$");
212     newXSproto("Internals::hv_clear_placeholders",
213                XS_Internals_hv_clear_placehold, file, "\\%");
214     newXSproto("PerlIO::get_layers",
215                XS_PerlIO_get_layers, file, "*;@");
216     newXS("Regexp::DESTROY", XS_Regexp_DESTROY, file);
217     newXSproto("Internals::hash_seed",XS_Internals_hash_seed, file, "");
218     newXSproto("Internals::rehash_seed",XS_Internals_rehash_seed, file, "");
219     newXSproto("Internals::HvREHASH", XS_Internals_HvREHASH, file, "\\%");
220 }
221
222
223 XS(XS_UNIVERSAL_isa)
224 {
225     dXSARGS;
226     SV *sv;
227     const char *name;
228     STRLEN n_a;
229
230     if (items != 2)
231         Perl_croak(aTHX_ "Usage: UNIVERSAL::isa(reference, kind)");
232
233     sv = ST(0);
234
235     if (SvGMAGICAL(sv))
236         mg_get(sv);
237
238     if (!SvOK(sv) || !(SvROK(sv) || (SvPOK(sv) && SvCUR(sv))
239                 || (SvGMAGICAL(sv) && SvPOKp(sv) && SvCUR(sv))))
240         XSRETURN_UNDEF;
241
242     name = (const char *)SvPV(ST(1),n_a);
243
244     ST(0) = boolSV(sv_derived_from(sv, name));
245     XSRETURN(1);
246 }
247
248 XS(XS_UNIVERSAL_can)
249 {
250     dXSARGS;
251     SV   *sv;
252     const char *name;
253     SV   *rv;
254     HV   *pkg = NULL;
255     STRLEN n_a;
256
257     if (items != 2)
258         Perl_croak(aTHX_ "Usage: UNIVERSAL::can(object-ref, method)");
259
260     sv = ST(0);
261
262     if (SvGMAGICAL(sv))
263         mg_get(sv);
264
265     if (!SvOK(sv) || !(SvROK(sv) || (SvPOK(sv) && SvCUR(sv))
266                 || (SvGMAGICAL(sv) && SvPOKp(sv) && SvCUR(sv))))
267         XSRETURN_UNDEF;
268
269     name = (const char *)SvPV(ST(1),n_a);
270     rv = &PL_sv_undef;
271
272     if (SvROK(sv)) {
273         sv = (SV*)SvRV(sv);
274         if (SvOBJECT(sv))
275             pkg = SvSTASH(sv);
276     }
277     else {
278         pkg = gv_stashsv(sv, FALSE);
279     }
280
281     if (pkg) {
282         GV *gv = gv_fetchmethod_autoload(pkg, name, FALSE);
283         if (gv && isGV(gv))
284             rv = sv_2mortal(newRV((SV*)GvCV(gv)));
285     }
286
287     ST(0) = rv;
288     XSRETURN(1);
289 }
290
291 XS(XS_UNIVERSAL_VERSION)
292 {
293     dXSARGS;
294     HV *pkg;
295     GV **gvp;
296     GV *gv;
297     SV *sv;
298     const char *undef;
299
300     if (SvROK(ST(0))) {
301         sv = (SV*)SvRV(ST(0));
302         if (!SvOBJECT(sv))
303             Perl_croak(aTHX_ "Cannot find version of an unblessed reference");
304         pkg = SvSTASH(sv);
305     }
306     else {
307         pkg = gv_stashsv(ST(0), FALSE);
308     }
309
310     gvp = pkg ? (GV**)hv_fetch(pkg,"VERSION",7,FALSE) : Null(GV**);
311
312     if (gvp && isGV(gv = *gvp) && SvOK(sv = GvSV(gv))) {
313         SV *nsv = sv_newmortal();
314         sv_setsv(nsv, sv);
315         sv = nsv;
316         undef = Nullch;
317     }
318     else {
319         sv = (SV*)&PL_sv_undef;
320         undef = "(undef)";
321     }
322
323     if (items > 1) {
324         STRLEN len;
325         SV *req = ST(1);
326
327         if (undef) {
328             if (pkg) {
329                 const char *name = HvNAME_get(pkg);
330                 Perl_croak(aTHX_
331                              "%s does not define $%s::VERSION--version check failed",
332                              name, name);
333             } else {
334                   const char *str = SvPVx(ST(0), len);
335
336                   Perl_croak(aTHX_
337                              "%s defines neither package nor VERSION--version check failed", str);
338              }
339         }
340         if (!SvNIOK(sv) && SvPOK(sv)) {
341             char *str = SvPVx(sv,len);
342             while (len) {
343                 --len;
344                 /* XXX could DWIM "1.2.3" here */
345                 if (!isDIGIT(str[len]) && str[len] != '.' && str[len] != '_')
346                     break;
347             }
348             if (len) {
349                 if (SvNOK(req) && SvPOK(req)) {
350                     /* they said C<use Foo v1.2.3> and $Foo::VERSION
351                      * doesn't look like a float: do string compare */
352                     if (sv_cmp(req,sv) == 1) {
353                         Perl_croak(aTHX_ "%s v%"VDf" required--"
354                                    "this is only v%"VDf,
355                                    HvNAME(pkg), req, sv);
356                     }
357                     goto finish;
358                 }
359                 /* they said C<use Foo 1.002_003> and $Foo::VERSION
360                  * doesn't look like a float: force numeric compare */
361                 (void)SvUPGRADE(sv, SVt_PVNV);
362                 SvNVX(sv) = str_to_version(sv);
363                 SvPOK_off(sv);
364                 SvNOK_on(sv);
365             }
366         }
367         /* if we get here, we're looking for a numeric comparison,
368          * so force the required version into a float, even if they
369          * said C<use Foo v1.2.3> */
370         if (SvNOK(req) && SvPOK(req)) {
371             NV n = SvNV(req);
372             req = sv_newmortal();
373             sv_setnv(req, n);
374         }
375
376         if (SvNV(req) > SvNV(sv))
377             Perl_croak(aTHX_ "%s version %s required--this is only version %s",
378                        HvNAME_get(pkg), SvPV_nolen(req), SvPV_nolen(sv));
379     }
380
381 finish:
382     ST(0) = sv;
383
384     XSRETURN(1);
385 }
386
387 XS(XS_utf8_is_utf8)
388 {
389      dXSARGS;
390      if (items != 1)
391           Perl_croak(aTHX_ "Usage: utf8::is_utf8(sv)");
392      {
393           const SV *sv = ST(0);
394           {
395                if (SvUTF8(sv))
396                     XSRETURN_YES;
397                else
398                     XSRETURN_NO;
399           }
400      }
401      XSRETURN_EMPTY;
402 }
403
404 XS(XS_utf8_valid)
405 {
406      dXSARGS;
407      if (items != 1)
408           Perl_croak(aTHX_ "Usage: utf8::valid(sv)");
409      {
410           SV *  sv = ST(0);
411           {
412                STRLEN len;
413                const char *s = SvPV(sv,len);
414                if (!SvUTF8(sv) || is_utf8_string((const U8*)s,len))
415                     XSRETURN_YES;
416                else
417                     XSRETURN_NO;
418           }
419      }
420      XSRETURN_EMPTY;
421 }
422
423 XS(XS_utf8_encode)
424 {
425     dXSARGS;
426     if (items != 1)
427         Perl_croak(aTHX_ "Usage: utf8::encode(sv)");
428     {
429         SV *    sv = ST(0);
430
431         sv_utf8_encode(sv);
432     }
433     XSRETURN_EMPTY;
434 }
435
436 XS(XS_utf8_decode)
437 {
438     dXSARGS;
439     if (items != 1)
440         Perl_croak(aTHX_ "Usage: utf8::decode(sv)");
441     {
442         SV *    sv = ST(0);
443         const bool RETVAL = sv_utf8_decode(sv);
444         ST(0) = boolSV(RETVAL);
445         sv_2mortal(ST(0));
446     }
447     XSRETURN(1);
448 }
449
450 XS(XS_utf8_upgrade)
451 {
452     dXSARGS;
453     if (items != 1)
454         Perl_croak(aTHX_ "Usage: utf8::upgrade(sv)");
455     {
456         SV *    sv = ST(0);
457         STRLEN  RETVAL;
458         dXSTARG;
459
460         RETVAL = sv_utf8_upgrade(sv);
461         XSprePUSH; PUSHi((IV)RETVAL);
462     }
463     XSRETURN(1);
464 }
465
466 XS(XS_utf8_downgrade)
467 {
468     dXSARGS;
469     if (items < 1 || items > 2)
470         Perl_croak(aTHX_ "Usage: utf8::downgrade(sv, failok=0)");
471     {
472         SV *    sv = ST(0);
473         const bool failok = (items < 2) ? 0 : (int)SvIV(ST(1));
474         const bool RETVAL = sv_utf8_downgrade(sv, failok);
475
476         ST(0) = boolSV(RETVAL);
477         sv_2mortal(ST(0));
478     }
479     XSRETURN(1);
480 }
481
482 XS(XS_utf8_native_to_unicode)
483 {
484  dXSARGS;
485  const UV uv = SvUV(ST(0));
486
487  if (items > 1)
488      Perl_croak(aTHX_ "Usage: utf8::native_to_unicode(sv)");
489
490  ST(0) = sv_2mortal(newSViv(NATIVE_TO_UNI(uv)));
491  XSRETURN(1);
492 }
493
494 XS(XS_utf8_unicode_to_native)
495 {
496  dXSARGS;
497  const UV uv = SvUV(ST(0));
498
499  if (items > 1)
500      Perl_croak(aTHX_ "Usage: utf8::unicode_to_native(sv)");
501
502  ST(0) = sv_2mortal(newSViv(UNI_TO_NATIVE(uv)));
503  XSRETURN(1);
504 }
505
506 XS(XS_Internals_SvREADONLY)     /* This is dangerous stuff. */
507 {
508     dXSARGS;
509     SV *sv = SvRV(ST(0));
510
511     if (items == 1) {
512          if (SvREADONLY(sv))
513              XSRETURN_YES;
514          else
515              XSRETURN_NO;
516     }
517     else if (items == 2) {
518         if (SvTRUE(ST(1))) {
519             SvREADONLY_on(sv);
520             XSRETURN_YES;
521         }
522         else {
523             /* I hope you really know what you are doing. */
524             SvREADONLY_off(sv);
525             XSRETURN_NO;
526         }
527     }
528     XSRETURN_UNDEF; /* Can't happen. */
529 }
530
531 XS(XS_Internals_SvREFCNT)       /* This is dangerous stuff. */
532 {
533     dXSARGS;
534     SV *sv = SvRV(ST(0));
535
536     if (items == 1)
537          XSRETURN_IV(SvREFCNT(sv) - 1); /* Minus the ref created for us. */
538     else if (items == 2) {
539          /* I hope you really know what you are doing. */
540          SvREFCNT(sv) = SvIV(ST(1));
541          XSRETURN_IV(SvREFCNT(sv));
542     }
543     XSRETURN_UNDEF; /* Can't happen. */
544 }
545
546 XS(XS_Internals_hv_clear_placehold)
547 {
548     dXSARGS;
549     HV *hv = (HV *) SvRV(ST(0));
550
551     if (items != 1)
552         Perl_croak(aTHX_ "Usage: UNIVERSAL::hv_clear_placeholders(hv)");
553     hv_clear_placeholders(hv);
554     XSRETURN(0);
555 }
556
557 XS(XS_Regexp_DESTROY)
558 {
559 }
560
561 XS(XS_PerlIO_get_layers)
562 {
563     dXSARGS;
564     if (items < 1 || items % 2 == 0)
565         Perl_croak(aTHX_ "Usage: PerlIO_get_layers(filehandle[,args])");
566 #ifdef USE_PERLIO
567     {
568         SV *    sv;
569         GV *    gv;
570         IO *    io;
571         bool    input = TRUE;
572         bool    details = FALSE;
573
574         if (items > 1) {
575              SV **svp;
576              
577              for (svp = MARK + 2; svp <= SP; svp += 2) {
578                   SV **varp = svp;
579                   SV **valp = svp + 1;
580                   STRLEN klen;
581                   const char *key = SvPV(*varp, klen);
582
583                   switch (*key) {
584                   case 'i':
585                        if (klen == 5 && memEQ(key, "input", 5)) {
586                             input = SvTRUE(*valp);
587                             break;
588                        }
589                        goto fail;
590                   case 'o': 
591                        if (klen == 6 && memEQ(key, "output", 6)) {
592                             input = !SvTRUE(*valp);
593                             break;
594                        }
595                        goto fail;
596                   case 'd':
597                        if (klen == 7 && memEQ(key, "details", 7)) {
598                             details = SvTRUE(*valp);
599                             break;
600                        }
601                        goto fail;
602                   default:
603                   fail:
604                        Perl_croak(aTHX_
605                                   "get_layers: unknown argument '%s'",
606                                   key);
607                   }
608              }
609
610              SP -= (items - 1);
611         }
612
613         sv = POPs;
614         gv = (GV*)sv;
615
616         if (!isGV(sv)) {
617              if (SvROK(sv) && isGV(SvRV(sv)))
618                   gv = (GV*)SvRV(sv);
619              else
620                   gv = gv_fetchpv(SvPVX(sv), FALSE, SVt_PVIO);
621         }
622
623         if (gv && (io = GvIO(gv))) {
624              dTARGET;
625              AV* av = PerlIO_get_layers(aTHX_ input ?
626                                         IoIFP(io) : IoOFP(io));
627              I32 i;
628              I32 last = av_len(av);
629              I32 nitem = 0;
630              
631              for (i = last; i >= 0; i -= 3) {
632                   SV **namsvp;
633                   SV **argsvp;
634                   SV **flgsvp;
635                   bool namok, argok, flgok;
636
637                   namsvp = av_fetch(av, i - 2, FALSE);
638                   argsvp = av_fetch(av, i - 1, FALSE);
639                   flgsvp = av_fetch(av, i,     FALSE);
640
641                   namok = namsvp && *namsvp && SvPOK(*namsvp);
642                   argok = argsvp && *argsvp && SvPOK(*argsvp);
643                   flgok = flgsvp && *flgsvp && SvIOK(*flgsvp);
644
645                   if (details) {
646                        XPUSHs(namok ?
647                              newSVpv(SvPVX_const(*namsvp), 0) : &PL_sv_undef);
648                        XPUSHs(argok ?
649                              newSVpv(SvPVX_const(*argsvp), 0) : &PL_sv_undef);
650                        if (flgok)
651                             XPUSHi(SvIVX(*flgsvp));
652                        else
653                             XPUSHs(&PL_sv_undef);
654                        nitem += 3;
655                   }
656                   else {
657                        if (namok && argok)
658                             XPUSHs(Perl_newSVpvf(aTHX_ "%"SVf"(%"SVf")",
659                                                *namsvp, *argsvp));
660                        else if (namok)
661                             XPUSHs(Perl_newSVpvf(aTHX_ "%"SVf, *namsvp));
662                        else
663                             XPUSHs(&PL_sv_undef);
664                        nitem++;
665                        if (flgok) {
666                             IV flags = SvIVX(*flgsvp);
667
668                             if (flags & PERLIO_F_UTF8) {
669                                  XPUSHs(newSVpvn("utf8", 4));
670                                  nitem++;
671                             }
672                        }
673                   }
674              }
675
676              SvREFCNT_dec(av);
677
678              XSRETURN(nitem);
679         }
680     }
681 #endif
682
683     XSRETURN(0);
684 }
685
686 XS(XS_Internals_hash_seed)
687 {
688     /* Using dXSARGS would also have dITEM and dSP,
689      * which define 2 unused local variables.  */
690     dAXMARK;
691     XSRETURN_UV(PERL_HASH_SEED);
692 }
693
694 XS(XS_Internals_rehash_seed)
695 {
696     /* Using dXSARGS would also have dITEM and dSP,
697      * which define 2 unused local variables.  */
698     dAXMARK;
699     XSRETURN_UV(PL_rehash_seed);
700 }
701
702 XS(XS_Internals_HvREHASH)       /* Subject to change  */
703 {
704     dXSARGS;
705     if (SvROK(ST(0))) {
706         const HV *hv = (HV *) SvRV(ST(0));
707         if (items == 1 && SvTYPE(hv) == SVt_PVHV) {
708             if (HvREHASH(hv))
709                 XSRETURN_YES;
710             else
711                 XSRETURN_NO;
712         }
713     }
714     Perl_croak(aTHX_ "Internals::HvREHASH $hashref");
715 }
716
717 /*
718  * Local variables:
719  * c-indentation-style: bsd
720  * c-basic-offset: 4
721  * indent-tabs-mode: t
722  * End:
723  *
724  * ex: set ts=8 sts=4 sw=4 noet:
725  */