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