4cbda94cf4035742d4c3468719eedeb85c084adc
[p5sagit/p5-mst-13.2.git] / universal.c
1 /*    universal.c
2  *
3  *    Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4  *    2005, 2006, 2007 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 bool
35 S_isa_lookup(pTHX_ HV *stash, const char *name, const HV* const name_stash,
36              int len, int level)
37 {
38     dVAR;
39     AV* av;
40     GV* gv;
41     GV** gvp;
42     HV* hv = NULL;
43     SV* subgen = NULL;
44     const char *hvname;
45
46     /* A stash/class can go by many names (ie. User == main::User), so 
47        we compare the stash itself just in case */
48     if (name_stash && ((const HV *)stash == name_stash))
49         return TRUE;
50
51     hvname = HvNAME_get(stash);
52
53     if (strEQ(hvname, name))
54         return TRUE;
55
56     if (strEQ(name, "UNIVERSAL"))
57         return TRUE;
58
59     if (level > 100)
60         Perl_croak(aTHX_ "Recursive inheritance detected in package '%s'",
61                    hvname);
62
63     gvp = (GV**)hv_fetchs(stash, "::ISA::CACHE::", FALSE);
64
65     if (gvp && (gv = *gvp) && isGV_with_GP(gv) && (subgen = GvSV(gv))
66         && (hv = GvHV(gv)))
67     {
68         if (SvIV(subgen) == (IV)PL_sub_generation) {
69             SV** const svp = (SV**)hv_fetch(hv, name, len, FALSE);
70             if (svp) {
71                 SV * const sv = *svp;
72 #ifdef DEBUGGING
73                 if (sv != &PL_sv_undef)
74                     DEBUG_o( Perl_deb(aTHX_ "Using cached ISA %s for package %s\n",
75                                     name, hvname) );
76 #endif
77                 return (sv == &PL_sv_yes);
78             }
79         }
80         else {
81             DEBUG_o( Perl_deb(aTHX_ "ISA Cache in package %s is stale\n",
82                               hvname) );
83             hv_clear(hv);
84             sv_setiv(subgen, PL_sub_generation);
85         }
86     }
87
88     gvp = (GV**)hv_fetchs(stash, "ISA", FALSE);
89
90     if (gvp && (gv = *gvp) && isGV_with_GP(gv) && (av = GvAV(gv))) {
91         if (!hv || !subgen) {
92             gvp = (GV**)hv_fetchs(stash, "::ISA::CACHE::", TRUE);
93
94             gv = *gvp;
95
96             if (SvTYPE(gv) != SVt_PVGV)
97                 gv_init(gv, stash, "::ISA::CACHE::", 14, TRUE);
98
99             if (!hv)
100                 hv = GvHVn(gv);
101             if (!subgen) {
102                 subgen = newSViv(PL_sub_generation);
103                 GvSV(gv) = subgen;
104             }
105         }
106         if (hv) {
107             SV** svp = AvARRAY(av);
108             /* NOTE: No support for tied ISA */
109             I32 items = AvFILLp(av) + 1;
110             while (items--) {
111                 SV* const sv = *svp++;
112                 HV* const basestash = gv_stashsv(sv, 0);
113                 if (!basestash) {
114                     if (ckWARN(WARN_MISC))
115                         Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
116                                     "Can't locate package %"SVf" for @%s::ISA",
117                                     SVfARG(sv), hvname);
118                     continue;
119                 }
120                 if (isa_lookup(basestash, name, name_stash, len, level + 1)) {
121                     (void)hv_store(hv,name,len,&PL_sv_yes,0);
122                     return TRUE;
123                 }
124             }
125             (void)hv_store(hv,name,len,&PL_sv_no,0);
126         }
127     }
128     return FALSE;
129 }
130
131 /*
132 =head1 SV Manipulation Functions
133
134 =for apidoc sv_derived_from
135
136 Returns a boolean indicating whether the SV is derived from the specified class
137 I<at the C level>.  To check derivation at the Perl level, call C<isa()> as a
138 normal Perl method.
139
140 =cut
141 */
142
143 bool
144 Perl_sv_derived_from(pTHX_ SV *sv, const char *name)
145 {
146     dVAR;
147     HV *stash;
148
149     SvGETMAGIC(sv);
150
151     if (SvROK(sv)) {
152         const char *type;
153         sv = SvRV(sv);
154         type = sv_reftype(sv,0);
155         if (type && strEQ(type,name))
156             return TRUE;
157         stash = SvOBJECT(sv) ? SvSTASH(sv) : NULL;
158     }
159     else {
160         stash = gv_stashsv(sv, 0);
161     }
162
163     if (stash) {
164         HV * const name_stash = gv_stashpv(name, 0);
165         return isa_lookup(stash, name, name_stash, strlen(name), 0);
166     }
167     else
168         return FALSE;
169
170 }
171
172 /*
173 =for apidoc sv_does
174
175 Returns a boolean indicating whether the SV performs a specific, named role.
176 The SV can be a Perl object or the name of a Perl class.
177
178 =cut
179 */
180
181 #include "XSUB.h"
182
183 bool
184 Perl_sv_does(pTHX_ SV *sv, const char *name)
185 {
186     const char *classname;
187     bool does_it;
188
189     dSP;
190     ENTER;
191     SAVETMPS;
192
193     SvGETMAGIC(sv);
194
195     if (!SvOK(sv) || !(SvROK(sv) || (SvPOK(sv) && SvCUR(sv))
196                 || (SvGMAGICAL(sv) && SvPOKp(sv) && SvCUR(sv))))
197         return FALSE;
198
199     if (sv_isobject(sv)) {
200         classname = sv_reftype(SvRV(sv),TRUE);
201     } else {
202         classname = SvPV(sv,PL_na);
203     }
204
205     if (strEQ(name,classname))
206         return TRUE;
207
208     PUSHMARK(SP);
209     XPUSHs(sv);
210     XPUSHs(sv_2mortal(newSVpv(name, 0)));
211     PUTBACK;
212
213     call_method("isa", G_SCALAR);
214     SPAGAIN;
215
216     does_it = SvTRUE( TOPs );
217     FREETMPS;
218     LEAVE;
219
220     return does_it;
221 }
222
223 PERL_XS_EXPORT_C void XS_UNIVERSAL_isa(pTHX_ CV *cv);
224 PERL_XS_EXPORT_C void XS_UNIVERSAL_can(pTHX_ CV *cv);
225 PERL_XS_EXPORT_C void XS_UNIVERSAL_DOES(pTHX_ CV *cv);
226 PERL_XS_EXPORT_C void XS_UNIVERSAL_VERSION(pTHX_ CV *cv);
227 XS(XS_version_new);
228 XS(XS_version_stringify);
229 XS(XS_version_numify);
230 XS(XS_version_normal);
231 XS(XS_version_vcmp);
232 XS(XS_version_boolean);
233 #ifdef HASATTRIBUTE_NORETURN
234 XS(XS_version_noop) __attribute__noreturn__;
235 #else
236 XS(XS_version_noop);
237 #endif
238 XS(XS_version_is_alpha);
239 XS(XS_version_qv);
240 XS(XS_utf8_is_utf8);
241 XS(XS_utf8_valid);
242 XS(XS_utf8_encode);
243 XS(XS_utf8_decode);
244 XS(XS_utf8_upgrade);
245 XS(XS_utf8_downgrade);
246 XS(XS_utf8_unicode_to_native);
247 XS(XS_utf8_native_to_unicode);
248 XS(XS_Internals_SvREADONLY);
249 XS(XS_Internals_SvREFCNT);
250 XS(XS_Internals_hv_clear_placehold);
251 XS(XS_PerlIO_get_layers);
252 XS(XS_Regexp_DESTROY);
253 XS(XS_Internals_hash_seed);
254 XS(XS_Internals_rehash_seed);
255 XS(XS_Internals_HvREHASH);
256 XS(XS_Internals_inc_sub_generation);
257
258 void
259 Perl_boot_core_UNIVERSAL(pTHX)
260 {
261     dVAR;
262     static const char file[] = __FILE__;
263
264     newXS("UNIVERSAL::isa",             XS_UNIVERSAL_isa,         file);
265     newXS("UNIVERSAL::can",             XS_UNIVERSAL_can,         file);
266     newXS("UNIVERSAL::DOES",            XS_UNIVERSAL_DOES,        file);
267     newXS("UNIVERSAL::VERSION",         XS_UNIVERSAL_VERSION,     file);
268     {
269         /* register the overloading (type 'A') magic */
270         PL_amagic_generation++;
271         /* Make it findable via fetchmethod */
272         newXS("version::()", XS_version_noop, file);
273         newXS("version::new", XS_version_new, file);
274         newXS("version::(\"\"", XS_version_stringify, file);
275         newXS("version::stringify", XS_version_stringify, file);
276         newXS("version::(0+", XS_version_numify, file);
277         newXS("version::numify", XS_version_numify, file);
278         newXS("version::normal", XS_version_normal, file);
279         newXS("version::(cmp", XS_version_vcmp, file);
280         newXS("version::(<=>", XS_version_vcmp, file);
281         newXS("version::vcmp", XS_version_vcmp, file);
282         newXS("version::(bool", XS_version_boolean, file);
283         newXS("version::boolean", XS_version_boolean, file);
284         newXS("version::(nomethod", XS_version_noop, file);
285         newXS("version::noop", XS_version_noop, file);
286         newXS("version::is_alpha", XS_version_is_alpha, file);
287         newXS("version::qv", XS_version_qv, file);
288     }
289     newXS("utf8::is_utf8", XS_utf8_is_utf8, file);
290     newXS("utf8::valid", XS_utf8_valid, file);
291     newXS("utf8::encode", XS_utf8_encode, file);
292     newXS("utf8::decode", XS_utf8_decode, file);
293     newXS("utf8::upgrade", XS_utf8_upgrade, file);
294     newXS("utf8::downgrade", XS_utf8_downgrade, file);
295     newXS("utf8::native_to_unicode", XS_utf8_native_to_unicode, file);
296     newXS("utf8::unicode_to_native", XS_utf8_unicode_to_native, file);
297     newXSproto("Internals::SvREADONLY",XS_Internals_SvREADONLY, file, "\\[$%@];$");
298     newXSproto("Internals::SvREFCNT",XS_Internals_SvREFCNT, file, "\\[$%@];$");
299     newXSproto("Internals::hv_clear_placeholders",
300                XS_Internals_hv_clear_placehold, file, "\\%");
301     newXSproto("PerlIO::get_layers",
302                XS_PerlIO_get_layers, file, "*;@");
303     newXS("Regexp::DESTROY", XS_Regexp_DESTROY, file);
304     newXSproto("Internals::hash_seed",XS_Internals_hash_seed, file, "");
305     newXSproto("Internals::rehash_seed",XS_Internals_rehash_seed, file, "");
306     newXSproto("Internals::HvREHASH", XS_Internals_HvREHASH, file, "\\%");
307     newXSproto("Internals::inc_sub_generation",XS_Internals_inc_sub_generation,
308                file, "");
309 }
310
311
312 XS(XS_UNIVERSAL_isa)
313 {
314     dVAR;
315     dXSARGS;
316     PERL_UNUSED_ARG(cv);
317
318     if (items != 2)
319         Perl_croak(aTHX_ "Usage: UNIVERSAL::isa(reference, kind)");
320     else {
321         SV * const sv = ST(0);
322         const char *name;
323
324         SvGETMAGIC(sv);
325
326         if (!SvOK(sv) || !(SvROK(sv) || (SvPOK(sv) && SvCUR(sv))
327                     || (SvGMAGICAL(sv) && SvPOKp(sv) && SvCUR(sv))))
328             XSRETURN_UNDEF;
329
330         name = SvPV_nolen_const(ST(1));
331
332         ST(0) = boolSV(sv_derived_from(sv, name));
333         XSRETURN(1);
334     }
335 }
336
337 XS(XS_UNIVERSAL_can)
338 {
339     dVAR;
340     dXSARGS;
341     SV   *sv;
342     const char *name;
343     SV   *rv;
344     HV   *pkg = NULL;
345     PERL_UNUSED_ARG(cv);
346
347     if (items != 2)
348         Perl_croak(aTHX_ "Usage: UNIVERSAL::can(object-ref, method)");
349
350     sv = ST(0);
351
352     SvGETMAGIC(sv);
353
354     if (!SvOK(sv) || !(SvROK(sv) || (SvPOK(sv) && SvCUR(sv))
355                 || (SvGMAGICAL(sv) && SvPOKp(sv) && SvCUR(sv))))
356         XSRETURN_UNDEF;
357
358     name = SvPV_nolen_const(ST(1));
359     rv = &PL_sv_undef;
360
361     if (SvROK(sv)) {
362         sv = (SV*)SvRV(sv);
363         if (SvOBJECT(sv))
364             pkg = SvSTASH(sv);
365     }
366     else {
367         pkg = gv_stashsv(sv, 0);
368     }
369
370     if (pkg) {
371         GV * const gv = gv_fetchmethod_autoload(pkg, name, FALSE);
372         if (gv && isGV(gv))
373             rv = sv_2mortal(newRV((SV*)GvCV(gv)));
374     }
375
376     ST(0) = rv;
377     XSRETURN(1);
378 }
379
380 XS(XS_UNIVERSAL_DOES)
381 {
382     dVAR;
383     dXSARGS;
384     PERL_UNUSED_ARG(cv);
385
386     if (items != 2)
387         Perl_croak(aTHX_ "Usage: invocant->does(kind)");
388     else {
389         SV * const sv = ST(0);
390         const char *name;
391
392         name = SvPV_nolen_const(ST(1));
393         if (sv_does( sv, name ))
394             XSRETURN_YES;
395
396         XSRETURN_NO;
397     }
398 }
399
400 XS(XS_UNIVERSAL_VERSION)
401 {
402     dVAR;
403     dXSARGS;
404     HV *pkg;
405     GV **gvp;
406     GV *gv;
407     SV *sv;
408     const char *undef;
409     PERL_UNUSED_ARG(cv);
410
411     if (SvROK(ST(0))) {
412         sv = (SV*)SvRV(ST(0));
413         if (!SvOBJECT(sv))
414             Perl_croak(aTHX_ "Cannot find version of an unblessed reference");
415         pkg = SvSTASH(sv);
416     }
417     else {
418         pkg = gv_stashsv(ST(0), 0);
419     }
420
421     gvp = pkg ? (GV**)hv_fetchs(pkg, "VERSION", FALSE) : NULL;
422
423     if (gvp && isGV(gv = *gvp) && (sv = GvSV(gv)) && SvOK(sv)) {
424         SV * const nsv = sv_newmortal();
425         sv_setsv(nsv, sv);
426         sv = nsv;
427         if ( !sv_derived_from(sv, "version"))
428             upg_version(sv);
429         undef = NULL;
430     }
431     else {
432         sv = (SV*)&PL_sv_undef;
433         undef = "(undef)";
434     }
435
436     if (items > 1) {
437         SV *req = ST(1);
438
439         if (undef) {
440             if (pkg) {
441                 const char * const name = HvNAME_get(pkg);
442                 Perl_croak(aTHX_
443                            "%s does not define $%s::VERSION--version check failed",
444                            name, name);
445             } else {
446                 Perl_croak(aTHX_
447                              "%s defines neither package nor VERSION--version check failed",
448                              SvPVx_nolen_const(ST(0)) );
449              }
450         }
451
452         if ( !sv_derived_from(req, "version")) {
453             /* req may very well be R/O, so create a new object */
454             SV * const nsv = sv_newmortal();
455             sv_setsv(nsv, req);
456             req = nsv;
457             upg_version(req);
458         }
459
460         if ( vcmp( req, sv ) > 0 )
461             Perl_croak(aTHX_ "%s version %"SVf" (%"SVf") required--"
462                        "this is only version %"SVf" (%"SVf")", HvNAME_get(pkg),
463                        SVfARG(vnumify(req)),
464                        SVfARG(vnormal(req)),
465                        SVfARG(vnumify(sv)),
466                        SVfARG(vnormal(sv)));
467     }
468
469     if ( SvOK(sv) && sv_derived_from(sv, "version") ) {
470         ST(0) = vnumify(sv);
471     } else {
472         ST(0) = sv;
473     }
474
475     XSRETURN(1);
476 }
477
478 XS(XS_version_new)
479 {
480     dVAR;
481     dXSARGS;
482     PERL_UNUSED_ARG(cv);
483     if (items > 3)
484         Perl_croak(aTHX_ "Usage: version::new(class, version)");
485     SP -= items;
486     {
487         SV *vs = ST(1);
488         SV *rv;
489         const char * const classname =
490             sv_isobject(ST(0)) /* get the class if called as an object method */
491                 ? HvNAME(SvSTASH(SvRV(ST(0))))
492                 : (char *)SvPV_nolen(ST(0));
493
494         if ( items == 1 || vs == &PL_sv_undef ) { /* no param or explicit undef */
495             /* create empty object */
496             vs = sv_newmortal();
497             sv_setpvn(vs,"",0);
498         }
499         else if ( items == 3 ) {
500             vs = sv_newmortal();
501             Perl_sv_setpvf(aTHX_ vs,"v%s",SvPV_nolen_const(ST(2)));
502         }
503
504         rv = new_version(vs);
505         if ( strcmp(classname,"version") != 0 ) /* inherited new() */
506             sv_bless(rv, gv_stashpv(classname, GV_ADD));
507
508         PUSHs(sv_2mortal(rv));
509         PUTBACK;
510         return;
511     }
512 }
513
514 XS(XS_version_stringify)
515 {
516      dVAR;
517      dXSARGS;
518      PERL_UNUSED_ARG(cv);
519      if (items < 1)
520           Perl_croak(aTHX_ "Usage: version::stringify(lobj, ...)");
521      SP -= items;
522      {
523           SV *  lobj;
524
525           if (sv_derived_from(ST(0), "version")) {
526                lobj = SvRV(ST(0));
527           }
528           else
529                Perl_croak(aTHX_ "lobj is not of type version");
530
531           PUSHs(sv_2mortal(vstringify(lobj)));
532
533           PUTBACK;
534           return;
535      }
536 }
537
538 XS(XS_version_numify)
539 {
540      dVAR;
541      dXSARGS;
542      PERL_UNUSED_ARG(cv);
543      if (items < 1)
544           Perl_croak(aTHX_ "Usage: version::numify(lobj, ...)");
545      SP -= items;
546      {
547           SV *  lobj;
548
549           if (sv_derived_from(ST(0), "version")) {
550                lobj = SvRV(ST(0));
551           }
552           else
553                Perl_croak(aTHX_ "lobj is not of type version");
554
555           PUSHs(sv_2mortal(vnumify(lobj)));
556
557           PUTBACK;
558           return;
559      }
560 }
561
562 XS(XS_version_normal)
563 {
564      dVAR;
565      dXSARGS;
566      PERL_UNUSED_ARG(cv);
567      if (items < 1)
568           Perl_croak(aTHX_ "Usage: version::normal(lobj, ...)");
569      SP -= items;
570      {
571           SV *  lobj;
572
573           if (sv_derived_from(ST(0), "version")) {
574                lobj = SvRV(ST(0));
575           }
576           else
577                Perl_croak(aTHX_ "lobj is not of type version");
578
579           PUSHs(sv_2mortal(vnormal(lobj)));
580
581           PUTBACK;
582           return;
583      }
584 }
585
586 XS(XS_version_vcmp)
587 {
588      dVAR;
589      dXSARGS;
590      PERL_UNUSED_ARG(cv);
591      if (items < 1)
592           Perl_croak(aTHX_ "Usage: version::vcmp(lobj, ...)");
593      SP -= items;
594      {
595           SV *  lobj;
596
597           if (sv_derived_from(ST(0), "version")) {
598                lobj = SvRV(ST(0));
599           }
600           else
601                Perl_croak(aTHX_ "lobj is not of type version");
602
603           {
604                SV       *rs;
605                SV       *rvs;
606                SV * robj = ST(1);
607                const IV  swap = (IV)SvIV(ST(2));
608
609                if ( ! sv_derived_from(robj, "version") )
610                {
611                     robj = new_version(robj);
612                }
613                rvs = SvRV(robj);
614
615                if ( swap )
616                {
617                     rs = newSViv(vcmp(rvs,lobj));
618                }
619                else
620                {
621                     rs = newSViv(vcmp(lobj,rvs));
622                }
623
624                PUSHs(sv_2mortal(rs));
625           }
626
627           PUTBACK;
628           return;
629      }
630 }
631
632 XS(XS_version_boolean)
633 {
634     dVAR;
635     dXSARGS;
636     PERL_UNUSED_ARG(cv);
637     if (items < 1)
638         Perl_croak(aTHX_ "Usage: version::boolean(lobj, ...)");
639     SP -= items;
640     if (sv_derived_from(ST(0), "version")) {
641         SV * const lobj = SvRV(ST(0));
642         SV * const rs = newSViv( vcmp(lobj,new_version(newSVpvs("0"))) );
643         PUSHs(sv_2mortal(rs));
644         PUTBACK;
645         return;
646     }
647     else
648         Perl_croak(aTHX_ "lobj is not of type version");
649 }
650
651 XS(XS_version_noop)
652 {
653     dVAR;
654     dXSARGS;
655     PERL_UNUSED_ARG(cv);
656     if (items < 1)
657         Perl_croak(aTHX_ "Usage: version::noop(lobj, ...)");
658     if (sv_derived_from(ST(0), "version"))
659         Perl_croak(aTHX_ "operation not supported with version object");
660     else
661         Perl_croak(aTHX_ "lobj is not of type version");
662 #ifndef HASATTRIBUTE_NORETURN
663     XSRETURN_EMPTY;
664 #endif
665 }
666
667 XS(XS_version_is_alpha)
668 {
669     dVAR;
670     dXSARGS;
671     PERL_UNUSED_ARG(cv);
672     if (items != 1)
673         Perl_croak(aTHX_ "Usage: version::is_alpha(lobj)");
674     SP -= items;
675     if (sv_derived_from(ST(0), "version")) {
676         SV * const lobj = ST(0);
677         if ( hv_exists((HV*)SvRV(lobj), "alpha", 5 ) )
678             XSRETURN_YES;
679         else
680             XSRETURN_NO;
681         PUTBACK;
682         return;
683     }
684     else
685         Perl_croak(aTHX_ "lobj is not of type version");
686 }
687
688 XS(XS_version_qv)
689 {
690     dVAR;
691     dXSARGS;
692     PERL_UNUSED_ARG(cv);
693     if (items != 1)
694         Perl_croak(aTHX_ "Usage: version::qv(ver)");
695     SP -= items;
696     {
697         SV *    ver = ST(0);
698         if ( !SvVOK(ver) ) { /* only need to do with if not already v-string */
699             SV * const vs = sv_newmortal();
700             char *version;
701             if ( SvNOK(ver) ) /* may get too much accuracy */
702             {
703                 char tbuf[64];
704 #ifdef USE_LOCALE_NUMERIC
705                 char *loc = setlocale(LC_NUMERIC, "C");
706 #endif
707                 STRLEN len = my_snprintf(tbuf, sizeof(tbuf), "%.9"NVgf, SvNVX(ver));
708 #ifdef USE_LOCALE_NUMERIC
709                 setlocale(LC_NUMERIC, loc);
710 #endif
711                 while (tbuf[len-1] == '0' && len > 0) len--;
712                 version = savepvn(tbuf, len);
713             }
714             else
715             {
716                 version = savesvpv(ver);
717             }
718             (void)scan_version(version,vs,TRUE);
719             Safefree(version);
720
721             PUSHs(vs);
722         }
723         else
724         {
725             PUSHs(sv_2mortal(new_version(ver)));
726         }
727
728         PUTBACK;
729         return;
730     }
731 }
732
733 XS(XS_utf8_is_utf8)
734 {
735      dVAR;
736      dXSARGS;
737      PERL_UNUSED_ARG(cv);
738      if (items != 1)
739           Perl_croak(aTHX_ "Usage: utf8::is_utf8(sv)");
740      else {
741         const SV * const sv = ST(0);
742             if (SvUTF8(sv))
743                 XSRETURN_YES;
744             else
745                 XSRETURN_NO;
746      }
747      XSRETURN_EMPTY;
748 }
749
750 XS(XS_utf8_valid)
751 {
752      dVAR;
753      dXSARGS;
754      PERL_UNUSED_ARG(cv);
755      if (items != 1)
756           Perl_croak(aTHX_ "Usage: utf8::valid(sv)");
757     else {
758         SV * const sv = ST(0);
759         STRLEN len;
760         const char * const s = SvPV_const(sv,len);
761         if (!SvUTF8(sv) || is_utf8_string((const U8*)s,len))
762             XSRETURN_YES;
763         else
764             XSRETURN_NO;
765     }
766      XSRETURN_EMPTY;
767 }
768
769 XS(XS_utf8_encode)
770 {
771     dVAR;
772     dXSARGS;
773     PERL_UNUSED_ARG(cv);
774     if (items != 1)
775         Perl_croak(aTHX_ "Usage: utf8::encode(sv)");
776     sv_utf8_encode(ST(0));
777     XSRETURN_EMPTY;
778 }
779
780 XS(XS_utf8_decode)
781 {
782     dVAR;
783     dXSARGS;
784     PERL_UNUSED_ARG(cv);
785     if (items != 1)
786         Perl_croak(aTHX_ "Usage: utf8::decode(sv)");
787     else {
788         SV * const sv = ST(0);
789         const bool RETVAL = sv_utf8_decode(sv);
790         ST(0) = boolSV(RETVAL);
791         sv_2mortal(ST(0));
792     }
793     XSRETURN(1);
794 }
795
796 XS(XS_utf8_upgrade)
797 {
798     dVAR;
799     dXSARGS;
800     PERL_UNUSED_ARG(cv);
801     if (items != 1)
802         Perl_croak(aTHX_ "Usage: utf8::upgrade(sv)");
803     else {
804         SV * const sv = ST(0);
805         STRLEN  RETVAL;
806         dXSTARG;
807
808         RETVAL = sv_utf8_upgrade(sv);
809         XSprePUSH; PUSHi((IV)RETVAL);
810     }
811     XSRETURN(1);
812 }
813
814 XS(XS_utf8_downgrade)
815 {
816     dVAR;
817     dXSARGS;
818     PERL_UNUSED_ARG(cv);
819     if (items < 1 || items > 2)
820         Perl_croak(aTHX_ "Usage: utf8::downgrade(sv, failok=0)");
821     else {
822         SV * const sv = ST(0);
823         const bool failok = (items < 2) ? 0 : (int)SvIV(ST(1));
824         const bool RETVAL = sv_utf8_downgrade(sv, failok);
825
826         ST(0) = boolSV(RETVAL);
827         sv_2mortal(ST(0));
828     }
829     XSRETURN(1);
830 }
831
832 XS(XS_utf8_native_to_unicode)
833 {
834  dVAR;
835  dXSARGS;
836  const UV uv = SvUV(ST(0));
837  PERL_UNUSED_ARG(cv);
838
839  if (items > 1)
840      Perl_croak(aTHX_ "Usage: utf8::native_to_unicode(sv)");
841
842  ST(0) = sv_2mortal(newSViv(NATIVE_TO_UNI(uv)));
843  XSRETURN(1);
844 }
845
846 XS(XS_utf8_unicode_to_native)
847 {
848  dVAR;
849  dXSARGS;
850  const UV uv = SvUV(ST(0));
851  PERL_UNUSED_ARG(cv);
852
853  if (items > 1)
854      Perl_croak(aTHX_ "Usage: utf8::unicode_to_native(sv)");
855
856  ST(0) = sv_2mortal(newSViv(UNI_TO_NATIVE(uv)));
857  XSRETURN(1);
858 }
859
860 XS(XS_Internals_SvREADONLY)     /* This is dangerous stuff. */
861 {
862     dVAR;
863     dXSARGS;
864     SV * const sv = SvRV(ST(0));
865     PERL_UNUSED_ARG(cv);
866
867     if (items == 1) {
868          if (SvREADONLY(sv))
869              XSRETURN_YES;
870          else
871              XSRETURN_NO;
872     }
873     else if (items == 2) {
874         if (SvTRUE(ST(1))) {
875             SvREADONLY_on(sv);
876             XSRETURN_YES;
877         }
878         else {
879             /* I hope you really know what you are doing. */
880             SvREADONLY_off(sv);
881             XSRETURN_NO;
882         }
883     }
884     XSRETURN_UNDEF; /* Can't happen. */
885 }
886
887 XS(XS_Internals_SvREFCNT)       /* This is dangerous stuff. */
888 {
889     dVAR;
890     dXSARGS;
891     SV * const sv = SvRV(ST(0));
892     PERL_UNUSED_ARG(cv);
893
894     if (items == 1)
895          XSRETURN_IV(SvREFCNT(sv) - 1); /* Minus the ref created for us. */
896     else if (items == 2) {
897          /* I hope you really know what you are doing. */
898          SvREFCNT(sv) = SvIV(ST(1));
899          XSRETURN_IV(SvREFCNT(sv));
900     }
901     XSRETURN_UNDEF; /* Can't happen. */
902 }
903
904 XS(XS_Internals_hv_clear_placehold)
905 {
906     dVAR;
907     dXSARGS;
908     PERL_UNUSED_ARG(cv);
909
910     if (items != 1)
911         Perl_croak(aTHX_ "Usage: UNIVERSAL::hv_clear_placeholders(hv)");
912     else {
913         HV * const hv = (HV *) SvRV(ST(0));
914         hv_clear_placeholders(hv);
915         XSRETURN(0);
916     }
917 }
918
919 XS(XS_Regexp_DESTROY)
920 {
921     PERL_UNUSED_CONTEXT;
922     PERL_UNUSED_ARG(cv);
923 }
924
925 XS(XS_PerlIO_get_layers)
926 {
927     dVAR;
928     dXSARGS;
929     PERL_UNUSED_ARG(cv);
930     if (items < 1 || items % 2 == 0)
931         Perl_croak(aTHX_ "Usage: PerlIO_get_layers(filehandle[,args])");
932 #ifdef USE_PERLIO
933     {
934         SV *    sv;
935         GV *    gv;
936         IO *    io;
937         bool    input = TRUE;
938         bool    details = FALSE;
939
940         if (items > 1) {
941              SV * const *svp;
942              for (svp = MARK + 2; svp <= SP; svp += 2) {
943                   SV * const * const varp = svp;
944                   SV * const * const valp = svp + 1;
945                   STRLEN klen;
946                   const char * const key = SvPV_const(*varp, klen);
947
948                   switch (*key) {
949                   case 'i':
950                        if (klen == 5 && memEQ(key, "input", 5)) {
951                             input = SvTRUE(*valp);
952                             break;
953                        }
954                        goto fail;
955                   case 'o': 
956                        if (klen == 6 && memEQ(key, "output", 6)) {
957                             input = !SvTRUE(*valp);
958                             break;
959                        }
960                        goto fail;
961                   case 'd':
962                        if (klen == 7 && memEQ(key, "details", 7)) {
963                             details = SvTRUE(*valp);
964                             break;
965                        }
966                        goto fail;
967                   default:
968                   fail:
969                        Perl_croak(aTHX_
970                                   "get_layers: unknown argument '%s'",
971                                   key);
972                   }
973              }
974
975              SP -= (items - 1);
976         }
977
978         sv = POPs;
979         gv = (GV*)sv;
980
981         if (!isGV(sv)) {
982              if (SvROK(sv) && isGV(SvRV(sv)))
983                   gv = (GV*)SvRV(sv);
984              else if (SvPOKp(sv))
985                   gv = gv_fetchsv(sv, 0, SVt_PVIO);
986         }
987
988         if (gv && (io = GvIO(gv))) {
989              dTARGET;
990              AV* const av = PerlIO_get_layers(aTHX_ input ?
991                                         IoIFP(io) : IoOFP(io));
992              I32 i;
993              const I32 last = av_len(av);
994              I32 nitem = 0;
995              
996              for (i = last; i >= 0; i -= 3) {
997                   SV * const * const namsvp = av_fetch(av, i - 2, FALSE);
998                   SV * const * const argsvp = av_fetch(av, i - 1, FALSE);
999                   SV * const * const flgsvp = av_fetch(av, i,     FALSE);
1000
1001                   const bool namok = namsvp && *namsvp && SvPOK(*namsvp);
1002                   const bool argok = argsvp && *argsvp && SvPOK(*argsvp);
1003                   const bool flgok = flgsvp && *flgsvp && SvIOK(*flgsvp);
1004
1005                   if (details) {
1006                        XPUSHs(namok
1007                               ? newSVpvn(SvPVX_const(*namsvp), SvCUR(*namsvp))
1008                               : &PL_sv_undef);
1009                        XPUSHs(argok
1010                               ? newSVpvn(SvPVX_const(*argsvp), SvCUR(*argsvp))
1011                               : &PL_sv_undef);
1012                        if (flgok)
1013                             XPUSHi(SvIVX(*flgsvp));
1014                        else
1015                             XPUSHs(&PL_sv_undef);
1016                        nitem += 3;
1017                   }
1018                   else {
1019                        if (namok && argok)
1020                             XPUSHs(Perl_newSVpvf(aTHX_ "%"SVf"(%"SVf")",
1021                                                  SVfARG(*namsvp),
1022                                                  SVfARG(*argsvp)));
1023                        else if (namok)
1024                             XPUSHs(Perl_newSVpvf(aTHX_ "%"SVf,
1025                                                  SVfARG(*namsvp)));
1026                        else
1027                             XPUSHs(&PL_sv_undef);
1028                        nitem++;
1029                        if (flgok) {
1030                             const IV flags = SvIVX(*flgsvp);
1031
1032                             if (flags & PERLIO_F_UTF8) {
1033                                  XPUSHs(newSVpvs("utf8"));
1034                                  nitem++;
1035                             }
1036                        }
1037                   }
1038              }
1039
1040              SvREFCNT_dec(av);
1041
1042              XSRETURN(nitem);
1043         }
1044     }
1045 #endif
1046
1047     XSRETURN(0);
1048 }
1049
1050 XS(XS_Internals_hash_seed)
1051 {
1052     dVAR;
1053     /* Using dXSARGS would also have dITEM and dSP,
1054      * which define 2 unused local variables.  */
1055     dAXMARK;
1056     PERL_UNUSED_ARG(cv);
1057     PERL_UNUSED_VAR(mark);
1058     XSRETURN_UV(PERL_HASH_SEED);
1059 }
1060
1061 XS(XS_Internals_rehash_seed)
1062 {
1063     dVAR;
1064     /* Using dXSARGS would also have dITEM and dSP,
1065      * which define 2 unused local variables.  */
1066     dAXMARK;
1067     PERL_UNUSED_ARG(cv);
1068     PERL_UNUSED_VAR(mark);
1069     XSRETURN_UV(PL_rehash_seed);
1070 }
1071
1072 XS(XS_Internals_HvREHASH)       /* Subject to change  */
1073 {
1074     dVAR;
1075     dXSARGS;
1076     PERL_UNUSED_ARG(cv);
1077     if (SvROK(ST(0))) {
1078         const HV * const hv = (HV *) SvRV(ST(0));
1079         if (items == 1 && SvTYPE(hv) == SVt_PVHV) {
1080             if (HvREHASH(hv))
1081                 XSRETURN_YES;
1082             else
1083                 XSRETURN_NO;
1084         }
1085     }
1086     Perl_croak(aTHX_ "Internals::HvREHASH $hashref");
1087 }
1088
1089 XS(XS_Internals_inc_sub_generation)
1090 {
1091     dVAR;
1092     /* Using dXSARGS would also have dITEM and dSP,
1093      * which define 2 unused local variables.  */
1094     dAXMARK;
1095     PERL_UNUSED_ARG(cv);
1096     PERL_UNUSED_VAR(mark);
1097     ++PL_sub_generation;
1098     XSRETURN_EMPTY;
1099 }
1100
1101 /*
1102  * Local variables:
1103  * c-indentation-style: bsd
1104  * c-basic-offset: 4
1105  * indent-tabs-mode: t
1106  * End:
1107  *
1108  * ex: set ts=8 sts=4 sw=4 noet:
1109  */