Further tweaks to make it easier to create regexp engine plug ins.
[perl.git] / universal.c
1 /*    universal.c
2  *
3  *    Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4  *    2005, 2006, by Larry Wall and others
5  *
6  *    You may distribute under the terms of either the GNU General Public
7  *    License or the Artistic License, as specified in the README file.
8  *
9  */
10
11 /*
12  * "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) != (GV*)&PL_sv_undef && (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) != (GV*)&PL_sv_undef && (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, FALSE);
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                                     (void*)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, FALSE);
161     }
162
163     if (stash) {
164         HV * const name_stash = gv_stashpv(name, FALSE);
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
317     if (items != 2)
318         Perl_croak(aTHX_ "Usage: UNIVERSAL::isa(reference, kind)");
319     else {
320         SV * const sv = ST(0);
321         const char *name;
322
323         SvGETMAGIC(sv);
324
325         if (!SvOK(sv) || !(SvROK(sv) || (SvPOK(sv) && SvCUR(sv))
326                     || (SvGMAGICAL(sv) && SvPOKp(sv) && SvCUR(sv))))
327             XSRETURN_UNDEF;
328
329         name = SvPV_nolen_const(ST(1));
330
331         ST(0) = boolSV(sv_derived_from(sv, name));
332         XSRETURN(1);
333     }
334 }
335
336 XS(XS_UNIVERSAL_can)
337 {
338     dVAR;
339     dXSARGS;
340     SV   *sv;
341     const char *name;
342     SV   *rv;
343     HV   *pkg = NULL;
344
345     if (items != 2)
346         Perl_croak(aTHX_ "Usage: UNIVERSAL::can(object-ref, method)");
347
348     sv = ST(0);
349
350     SvGETMAGIC(sv);
351
352     if (!SvOK(sv) || !(SvROK(sv) || (SvPOK(sv) && SvCUR(sv))
353                 || (SvGMAGICAL(sv) && SvPOKp(sv) && SvCUR(sv))))
354         XSRETURN_UNDEF;
355
356     name = SvPV_nolen_const(ST(1));
357     rv = &PL_sv_undef;
358
359     if (SvROK(sv)) {
360         sv = (SV*)SvRV(sv);
361         if (SvOBJECT(sv))
362             pkg = SvSTASH(sv);
363     }
364     else {
365         pkg = gv_stashsv(sv, FALSE);
366     }
367
368     if (pkg) {
369         GV * const gv = gv_fetchmethod_autoload(pkg, name, FALSE);
370         if (gv && isGV(gv))
371             rv = sv_2mortal(newRV((SV*)GvCV(gv)));
372     }
373
374     ST(0) = rv;
375     XSRETURN(1);
376 }
377
378 XS(XS_UNIVERSAL_DOES)
379 {
380     dVAR;
381     dXSARGS;
382
383     if (items != 2)
384         Perl_croak(aTHX_ "Usage: invocant->does(kind)");
385     else {
386         SV * const sv = ST(0);
387         const char *name;
388
389         name = SvPV_nolen_const(ST(1));
390         if (sv_does( sv, name ))
391             XSRETURN_YES;
392
393         XSRETURN_NO;
394     }
395 }
396
397 XS(XS_UNIVERSAL_VERSION)
398 {
399     dVAR;
400     dXSARGS;
401     HV *pkg;
402     GV **gvp;
403     GV *gv;
404     SV *sv;
405     const char *undef;
406
407     if (SvROK(ST(0))) {
408         sv = (SV*)SvRV(ST(0));
409         if (!SvOBJECT(sv))
410             Perl_croak(aTHX_ "Cannot find version of an unblessed reference");
411         pkg = SvSTASH(sv);
412     }
413     else {
414         pkg = gv_stashsv(ST(0), FALSE);
415     }
416
417     gvp = pkg ? (GV**)hv_fetchs(pkg, "VERSION", FALSE) : NULL;
418
419     if (gvp && isGV(gv = *gvp) && (sv = GvSV(gv)) && SvOK(sv)) {
420         SV * const nsv = sv_newmortal();
421         sv_setsv(nsv, sv);
422         sv = nsv;
423         if ( !sv_derived_from(sv, "version"))
424             upg_version(sv);
425         undef = NULL;
426     }
427     else {
428         sv = (SV*)&PL_sv_undef;
429         undef = "(undef)";
430     }
431
432     if (items > 1) {
433         SV *req = ST(1);
434
435         if (undef) {
436             if (pkg) {
437                 const char * const name = HvNAME_get(pkg);
438                 Perl_croak(aTHX_
439                            "%s does not define $%s::VERSION--version check failed",
440                            name, name);
441             } else {
442                 Perl_croak(aTHX_
443                              "%s defines neither package nor VERSION--version check failed",
444                              SvPVx_nolen_const(ST(0)) );
445              }
446         }
447
448         if ( !sv_derived_from(req, "version")) {
449             /* req may very well be R/O, so create a new object */
450             SV * const nsv = sv_newmortal();
451             sv_setsv(nsv, req);
452             req = nsv;
453             upg_version(req);
454         }
455
456         if ( vcmp( req, sv ) > 0 )
457             Perl_croak(aTHX_ "%s version %"SVf" (%"SVf") required--"
458                        "this is only version %"SVf" (%"SVf")", HvNAME_get(pkg),
459                        (void*)vnumify(req),
460                        (void*)vnormal(req),
461                        (void*)vnumify(sv),
462                        (void*)vnormal(sv));
463     }
464
465     if ( SvOK(sv) && sv_derived_from(sv, "version") ) {
466         ST(0) = vnumify(sv);
467     } else {
468         ST(0) = sv;
469     }
470
471     XSRETURN(1);
472 }
473
474 XS(XS_version_new)
475 {
476     dVAR;
477     dXSARGS;
478     if (items > 3)
479         Perl_croak(aTHX_ "Usage: version::new(class, version)");
480     SP -= items;
481     {
482         SV *vs = ST(1);
483         SV *rv;
484         const char * const classname =
485             sv_isobject(ST(0)) /* get the class if called as an object method */
486                 ? HvNAME(SvSTASH(SvRV(ST(0))))
487                 : (char *)SvPV_nolen(ST(0));
488
489         if ( items == 1 || vs == &PL_sv_undef ) { /* no param or explicit undef */
490             /* create empty object */
491             vs = sv_newmortal();
492             sv_setpvn(vs,"",0);
493         }
494         else if ( items == 3 ) {
495             vs = sv_newmortal();
496             Perl_sv_setpvf(aTHX_ vs,"v%s",SvPV_nolen_const(ST(2)));
497         }
498
499         rv = new_version(vs);
500         if ( strcmp(classname,"version") != 0 ) /* inherited new() */
501             sv_bless(rv, gv_stashpv(classname,TRUE));
502
503         PUSHs(sv_2mortal(rv));
504         PUTBACK;
505         return;
506     }
507 }
508
509 XS(XS_version_stringify)
510 {
511      dVAR;
512      dXSARGS;
513      if (items < 1)
514           Perl_croak(aTHX_ "Usage: version::stringify(lobj, ...)");
515      SP -= items;
516      {
517           SV *  lobj;
518
519           if (sv_derived_from(ST(0), "version")) {
520                lobj = SvRV(ST(0));
521           }
522           else
523                Perl_croak(aTHX_ "lobj is not of type version");
524
525           PUSHs(sv_2mortal(vstringify(lobj)));
526
527           PUTBACK;
528           return;
529      }
530 }
531
532 XS(XS_version_numify)
533 {
534      dVAR;
535      dXSARGS;
536      if (items < 1)
537           Perl_croak(aTHX_ "Usage: version::numify(lobj, ...)");
538      SP -= items;
539      {
540           SV *  lobj;
541
542           if (sv_derived_from(ST(0), "version")) {
543                lobj = SvRV(ST(0));
544           }
545           else
546                Perl_croak(aTHX_ "lobj is not of type version");
547
548           PUSHs(sv_2mortal(vnumify(lobj)));
549
550           PUTBACK;
551           return;
552      }
553 }
554
555 XS(XS_version_normal)
556 {
557      dVAR;
558      dXSARGS;
559      if (items < 1)
560           Perl_croak(aTHX_ "Usage: version::normal(lobj, ...)");
561      SP -= items;
562      {
563           SV *  lobj;
564
565           if (sv_derived_from(ST(0), "version")) {
566                lobj = SvRV(ST(0));
567           }
568           else
569                Perl_croak(aTHX_ "lobj is not of type version");
570
571           PUSHs(sv_2mortal(vnormal(lobj)));
572
573           PUTBACK;
574           return;
575      }
576 }
577
578 XS(XS_version_vcmp)
579 {
580      dVAR;
581      dXSARGS;
582      if (items < 1)
583           Perl_croak(aTHX_ "Usage: version::vcmp(lobj, ...)");
584      SP -= items;
585      {
586           SV *  lobj;
587
588           if (sv_derived_from(ST(0), "version")) {
589                lobj = SvRV(ST(0));
590           }
591           else
592                Perl_croak(aTHX_ "lobj is not of type version");
593
594           {
595                SV       *rs;
596                SV       *rvs;
597                SV * robj = ST(1);
598                const IV  swap = (IV)SvIV(ST(2));
599
600                if ( ! sv_derived_from(robj, "version") )
601                {
602                     robj = new_version(robj);
603                }
604                rvs = SvRV(robj);
605
606                if ( swap )
607                {
608                     rs = newSViv(vcmp(rvs,lobj));
609                }
610                else
611                {
612                     rs = newSViv(vcmp(lobj,rvs));
613                }
614
615                PUSHs(sv_2mortal(rs));
616           }
617
618           PUTBACK;
619           return;
620      }
621 }
622
623 XS(XS_version_boolean)
624 {
625     dVAR;
626     dXSARGS;
627     if (items < 1)
628         Perl_croak(aTHX_ "Usage: version::boolean(lobj, ...)");
629     SP -= items;
630     if (sv_derived_from(ST(0), "version")) {
631         SV * const lobj = SvRV(ST(0));
632         SV * const rs = newSViv( vcmp(lobj,new_version(newSVpvs("0"))) );
633         PUSHs(sv_2mortal(rs));
634         PUTBACK;
635         return;
636     }
637     else
638         Perl_croak(aTHX_ "lobj is not of type version");
639 }
640
641 XS(XS_version_noop)
642 {
643     dVAR;
644     dXSARGS;
645     if (items < 1)
646         Perl_croak(aTHX_ "Usage: version::noop(lobj, ...)");
647     if (sv_derived_from(ST(0), "version"))
648         Perl_croak(aTHX_ "operation not supported with version object");
649     else
650         Perl_croak(aTHX_ "lobj is not of type version");
651 #ifndef HASATTRIBUTE_NORETURN
652     XSRETURN_EMPTY;
653 #endif
654 }
655
656 XS(XS_version_is_alpha)
657 {
658     dVAR;
659     dXSARGS;
660     if (items != 1)
661         Perl_croak(aTHX_ "Usage: version::is_alpha(lobj)");
662     SP -= items;
663     if (sv_derived_from(ST(0), "version")) {
664         SV * const lobj = ST(0);
665         if ( hv_exists((HV*)SvRV(lobj), "alpha", 5 ) )
666             XSRETURN_YES;
667         else
668             XSRETURN_NO;
669         PUTBACK;
670         return;
671     }
672     else
673         Perl_croak(aTHX_ "lobj is not of type version");
674 }
675
676 XS(XS_version_qv)
677 {
678     dVAR;
679     dXSARGS;
680     if (items != 1)
681         Perl_croak(aTHX_ "Usage: version::qv(ver)");
682     SP -= items;
683     {
684         SV *    ver = ST(0);
685         if ( !SvVOK(ver) ) { /* only need to do with if not already v-string */
686             SV * const vs = sv_newmortal();
687             char *version;
688             if ( SvNOK(ver) ) /* may get too much accuracy */
689             {
690                 char tbuf[64];
691 #ifdef USE_LOCALE_NUMERIC
692                 char *loc = setlocale(LC_NUMERIC, "C");
693 #endif
694                 STRLEN len = my_snprintf(tbuf, sizeof(tbuf), "%.9"NVgf, SvNVX(ver));
695 #ifdef USE_LOCALE_NUMERIC
696                 setlocale(LC_NUMERIC, loc);
697 #endif
698                 while (tbuf[len-1] == '0' && len > 0) len--;
699                 version = savepvn(tbuf, len);
700             }
701             else
702             {
703                 version = savesvpv(ver);
704             }
705             (void)scan_version(version,vs,TRUE);
706             Safefree(version);
707
708             PUSHs(vs);
709         }
710         else
711         {
712             PUSHs(sv_2mortal(new_version(ver)));
713         }
714
715         PUTBACK;
716         return;
717     }
718 }
719
720 XS(XS_utf8_is_utf8)
721 {
722      dVAR;
723      dXSARGS;
724      if (items != 1)
725           Perl_croak(aTHX_ "Usage: utf8::is_utf8(sv)");
726      else {
727         const SV * const sv = ST(0);
728             if (SvUTF8(sv))
729                 XSRETURN_YES;
730             else
731                 XSRETURN_NO;
732      }
733      XSRETURN_EMPTY;
734 }
735
736 XS(XS_utf8_valid)
737 {
738      dVAR;
739      dXSARGS;
740      if (items != 1)
741           Perl_croak(aTHX_ "Usage: utf8::valid(sv)");
742     else {
743         SV * const sv = ST(0);
744         STRLEN len;
745         const char * const s = SvPV_const(sv,len);
746         if (!SvUTF8(sv) || is_utf8_string((const U8*)s,len))
747             XSRETURN_YES;
748         else
749             XSRETURN_NO;
750     }
751      XSRETURN_EMPTY;
752 }
753
754 XS(XS_utf8_encode)
755 {
756     dVAR;
757     dXSARGS;
758     if (items != 1)
759         Perl_croak(aTHX_ "Usage: utf8::encode(sv)");
760     sv_utf8_encode(ST(0));
761     XSRETURN_EMPTY;
762 }
763
764 XS(XS_utf8_decode)
765 {
766     dVAR;
767     dXSARGS;
768     if (items != 1)
769         Perl_croak(aTHX_ "Usage: utf8::decode(sv)");
770     else {
771         SV * const sv = ST(0);
772         const bool RETVAL = sv_utf8_decode(sv);
773         ST(0) = boolSV(RETVAL);
774         sv_2mortal(ST(0));
775     }
776     XSRETURN(1);
777 }
778
779 XS(XS_utf8_upgrade)
780 {
781     dVAR;
782     dXSARGS;
783     if (items != 1)
784         Perl_croak(aTHX_ "Usage: utf8::upgrade(sv)");
785     else {
786         SV * const sv = ST(0);
787         STRLEN  RETVAL;
788         dXSTARG;
789
790         RETVAL = sv_utf8_upgrade(sv);
791         XSprePUSH; PUSHi((IV)RETVAL);
792     }
793     XSRETURN(1);
794 }
795
796 XS(XS_utf8_downgrade)
797 {
798     dVAR;
799     dXSARGS;
800     if (items < 1 || items > 2)
801         Perl_croak(aTHX_ "Usage: utf8::downgrade(sv, failok=0)");
802     else {
803         SV * const sv = ST(0);
804         const bool failok = (items < 2) ? 0 : (int)SvIV(ST(1));
805         const bool RETVAL = sv_utf8_downgrade(sv, failok);
806
807         ST(0) = boolSV(RETVAL);
808         sv_2mortal(ST(0));
809     }
810     XSRETURN(1);
811 }
812
813 XS(XS_utf8_native_to_unicode)
814 {
815  dVAR;
816  dXSARGS;
817  const UV uv = SvUV(ST(0));
818
819  if (items > 1)
820      Perl_croak(aTHX_ "Usage: utf8::native_to_unicode(sv)");
821
822  ST(0) = sv_2mortal(newSViv(NATIVE_TO_UNI(uv)));
823  XSRETURN(1);
824 }
825
826 XS(XS_utf8_unicode_to_native)
827 {
828  dVAR;
829  dXSARGS;
830  const UV uv = SvUV(ST(0));
831
832  if (items > 1)
833      Perl_croak(aTHX_ "Usage: utf8::unicode_to_native(sv)");
834
835  ST(0) = sv_2mortal(newSViv(UNI_TO_NATIVE(uv)));
836  XSRETURN(1);
837 }
838
839 XS(XS_Internals_SvREADONLY)     /* This is dangerous stuff. */
840 {
841     dVAR;
842     dXSARGS;
843     SV * const sv = SvRV(ST(0));
844
845     if (items == 1) {
846          if (SvREADONLY(sv))
847              XSRETURN_YES;
848          else
849              XSRETURN_NO;
850     }
851     else if (items == 2) {
852         if (SvTRUE(ST(1))) {
853             SvREADONLY_on(sv);
854             XSRETURN_YES;
855         }
856         else {
857             /* I hope you really know what you are doing. */
858             SvREADONLY_off(sv);
859             XSRETURN_NO;
860         }
861     }
862     XSRETURN_UNDEF; /* Can't happen. */
863 }
864
865 XS(XS_Internals_SvREFCNT)       /* This is dangerous stuff. */
866 {
867     dVAR;
868     dXSARGS;
869     SV * const sv = SvRV(ST(0));
870
871     if (items == 1)
872          XSRETURN_IV(SvREFCNT(sv) - 1); /* Minus the ref created for us. */
873     else if (items == 2) {
874          /* I hope you really know what you are doing. */
875          SvREFCNT(sv) = SvIV(ST(1));
876          XSRETURN_IV(SvREFCNT(sv));
877     }
878     XSRETURN_UNDEF; /* Can't happen. */
879 }
880
881 XS(XS_Internals_hv_clear_placehold)
882 {
883     dVAR;
884     dXSARGS;
885
886     if (items != 1)
887         Perl_croak(aTHX_ "Usage: UNIVERSAL::hv_clear_placeholders(hv)");
888     else {
889         HV * const hv = (HV *) SvRV(ST(0));
890         hv_clear_placeholders(hv);
891         XSRETURN(0);
892     }
893 }
894
895 XS(XS_Regexp_DESTROY)
896 {
897     PERL_UNUSED_CONTEXT;
898     PERL_UNUSED_ARG(cv);
899 }
900
901 XS(XS_PerlIO_get_layers)
902 {
903     dVAR;
904     dXSARGS;
905     if (items < 1 || items % 2 == 0)
906         Perl_croak(aTHX_ "Usage: PerlIO_get_layers(filehandle[,args])");
907 #ifdef USE_PERLIO
908     {
909         SV *    sv;
910         GV *    gv;
911         IO *    io;
912         bool    input = TRUE;
913         bool    details = FALSE;
914
915         if (items > 1) {
916              SV * const *svp;
917              for (svp = MARK + 2; svp <= SP; svp += 2) {
918                   SV * const * const varp = svp;
919                   SV * const * const valp = svp + 1;
920                   STRLEN klen;
921                   const char * const key = SvPV_const(*varp, klen);
922
923                   switch (*key) {
924                   case 'i':
925                        if (klen == 5 && memEQ(key, "input", 5)) {
926                             input = SvTRUE(*valp);
927                             break;
928                        }
929                        goto fail;
930                   case 'o': 
931                        if (klen == 6 && memEQ(key, "output", 6)) {
932                             input = !SvTRUE(*valp);
933                             break;
934                        }
935                        goto fail;
936                   case 'd':
937                        if (klen == 7 && memEQ(key, "details", 7)) {
938                             details = SvTRUE(*valp);
939                             break;
940                        }
941                        goto fail;
942                   default:
943                   fail:
944                        Perl_croak(aTHX_
945                                   "get_layers: unknown argument '%s'",
946                                   key);
947                   }
948              }
949
950              SP -= (items - 1);
951         }
952
953         sv = POPs;
954         gv = (GV*)sv;
955
956         if (!isGV(sv)) {
957              if (SvROK(sv) && isGV(SvRV(sv)))
958                   gv = (GV*)SvRV(sv);
959              else if (SvPOKp(sv))
960                   gv = gv_fetchsv(sv, 0, SVt_PVIO);
961         }
962
963         if (gv && (io = GvIO(gv))) {
964              dTARGET;
965              AV* const av = PerlIO_get_layers(aTHX_ input ?
966                                         IoIFP(io) : IoOFP(io));
967              I32 i;
968              const I32 last = av_len(av);
969              I32 nitem = 0;
970              
971              for (i = last; i >= 0; i -= 3) {
972                   SV * const * const namsvp = av_fetch(av, i - 2, FALSE);
973                   SV * const * const argsvp = av_fetch(av, i - 1, FALSE);
974                   SV * const * const flgsvp = av_fetch(av, i,     FALSE);
975
976                   const bool namok = namsvp && *namsvp && SvPOK(*namsvp);
977                   const bool argok = argsvp && *argsvp && SvPOK(*argsvp);
978                   const bool flgok = flgsvp && *flgsvp && SvIOK(*flgsvp);
979
980                   if (details) {
981                        XPUSHs(namok
982                               ? newSVpvn(SvPVX_const(*namsvp), SvCUR(*namsvp))
983                               : &PL_sv_undef);
984                        XPUSHs(argok
985                               ? newSVpvn(SvPVX_const(*argsvp), SvCUR(*argsvp))
986                               : &PL_sv_undef);
987                        if (flgok)
988                             XPUSHi(SvIVX(*flgsvp));
989                        else
990                             XPUSHs(&PL_sv_undef);
991                        nitem += 3;
992                   }
993                   else {
994                        if (namok && argok)
995                             XPUSHs(Perl_newSVpvf(aTHX_ "%"SVf"(%"SVf")",
996                                                  (void*)*namsvp,
997                                                  (void*)*argsvp));
998                        else if (namok)
999                             XPUSHs(Perl_newSVpvf(aTHX_ "%"SVf,
1000                                                  (void*)*namsvp));
1001                        else
1002                             XPUSHs(&PL_sv_undef);
1003                        nitem++;
1004                        if (flgok) {
1005                             const IV flags = SvIVX(*flgsvp);
1006
1007                             if (flags & PERLIO_F_UTF8) {
1008                                  XPUSHs(newSVpvs("utf8"));
1009                                  nitem++;
1010                             }
1011                        }
1012                   }
1013              }
1014
1015              SvREFCNT_dec(av);
1016
1017              XSRETURN(nitem);
1018         }
1019     }
1020 #endif
1021
1022     XSRETURN(0);
1023 }
1024
1025 XS(XS_Internals_hash_seed)
1026 {
1027     dVAR;
1028     /* Using dXSARGS would also have dITEM and dSP,
1029      * which define 2 unused local variables.  */
1030     dAXMARK;
1031     PERL_UNUSED_ARG(cv);
1032     PERL_UNUSED_VAR(mark);
1033     XSRETURN_UV(PERL_HASH_SEED);
1034 }
1035
1036 XS(XS_Internals_rehash_seed)
1037 {
1038     dVAR;
1039     /* Using dXSARGS would also have dITEM and dSP,
1040      * which define 2 unused local variables.  */
1041     dAXMARK;
1042     PERL_UNUSED_ARG(cv);
1043     PERL_UNUSED_VAR(mark);
1044     XSRETURN_UV(PL_rehash_seed);
1045 }
1046
1047 XS(XS_Internals_HvREHASH)       /* Subject to change  */
1048 {
1049     dVAR;
1050     dXSARGS;
1051     if (SvROK(ST(0))) {
1052         const HV * const hv = (HV *) SvRV(ST(0));
1053         if (items == 1 && SvTYPE(hv) == SVt_PVHV) {
1054             if (HvREHASH(hv))
1055                 XSRETURN_YES;
1056             else
1057                 XSRETURN_NO;
1058         }
1059     }
1060     Perl_croak(aTHX_ "Internals::HvREHASH $hashref");
1061 }
1062
1063 XS(XS_Internals_inc_sub_generation)
1064 {
1065     dVAR;
1066     /* Using dXSARGS would also have dITEM and dSP,
1067      * which define 2 unused local variables.  */
1068     dAXMARK;
1069     PERL_UNUSED_ARG(cv);
1070     PERL_UNUSED_VAR(mark);
1071     ++PL_sub_generation;
1072     XSRETURN_EMPTY;
1073 }
1074
1075 /*
1076  * Local variables:
1077  * c-indentation-style: bsd
1078  * c-basic-offset: 4
1079  * indent-tabs-mode: t
1080  * End:
1081  *
1082  * ex: set ts=8 sts=4 sw=4 noet:
1083  */