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