cpan/Encode/Encode.xs

   1 /*
   2  $Id: Encode.xs,v 2.39 2016/11/29 23:29:23 dankogai Exp dankogai $
   3  */
   4
   5 #define PERL_NO_GET_CONTEXT
   6 #include "EXTERN.h"
   7 #include "perl.h"
   8 #include "XSUB.h"
   9 #include "encode.h"
  10 #include "def_t.h"
  11
  12 # define PERLIO_MODNAME  "PerlIO::encoding"
  13 # define PERLIO_FILENAME "PerlIO/encoding.pm"
  14
  15 /* set 1 or more to profile.  t/encoding.t dumps core because of
  16    Perl_warner and PerlIO don't work well */
  17 #define ENCODE_XS_PROFILE 0
  18
  19 /* set 0 to disable floating point to calculate buffer size for
  20    encode_method().  1 is recommended. 2 restores NI-S original */
  21 #define ENCODE_XS_USEFP   1
  22
  23 #define UNIMPLEMENTED(x,y) static y x (SV *sv, char *encoding) {        \
  24                         Perl_croak_nocontext("panic_unimplemented");    \
  25                         PERL_UNUSED_VAR(sv); \
  26                         PERL_UNUSED_VAR(encoding); \
  27              return (y)0; /* fool picky compilers */ \
  28                          }
  29 /**/
  30
  31 UNIMPLEMENTED(_encoded_utf8_to_bytes, I32)
  32 UNIMPLEMENTED(_encoded_bytes_to_utf8, I32)
  33
  34 #ifndef SvIV_nomg
  35 #define SvIV_nomg SvIV
  36 #endif
  37
  38 #ifdef UTF8_DISALLOW_ILLEGAL_INTERCHANGE
  39 #   define UTF8_ALLOW_STRICT UTF8_DISALLOW_ILLEGAL_INTERCHANGE
  40 #else
  41 #   define UTF8_ALLOW_STRICT 0
  42 #endif
  43
  44 #define UTF8_ALLOW_NONSTRICT (UTF8_ALLOW_ANY &                    \
  45                               ~(UTF8_ALLOW_CONTINUATION |         \
  46                                 UTF8_ALLOW_NON_CONTINUATION |     \
  47                                 UTF8_ALLOW_LONG))
  48
  49 static void
  50 Encode_XSEncoding(pTHX_ encode_t * enc)
  51 {
  52     dSP;
  53     HV *stash = gv_stashpv("Encode::XS", TRUE);
  54     SV *iv    = newSViv(PTR2IV(enc));
  55     SV *sv    = sv_bless(newRV_noinc(iv),stash);
  56     int i = 0;
  57     /* with the SvLEN() == 0 hack, PVX won't be freed. We cast away name's
  58     constness, in the hope that perl won't mess with it. */
  59     assert(SvTYPE(iv) >= SVt_PV); assert(SvLEN(iv) == 0);
  60     SvFLAGS(iv) |= SVp_POK;
  61     SvPVX(iv) = (char*) enc->name[0];
  62     PUSHMARK(sp);
  63     XPUSHs(sv);
  64     while (enc->name[i]) {
  65     const char *name = enc->name[i++];
  66     XPUSHs(sv_2mortal(newSVpvn(name, strlen(name))));
  67     }
  68     PUTBACK;
  69     call_pv("Encode::define_encoding", G_DISCARD);
  70     SvREFCNT_dec(sv);
  71 }
  72
  73 static void
  74 call_failure(SV * routine, U8 * done, U8 * dest, U8 * orig)
  75 {
  76     /* Exists for breakpointing */
  77     PERL_UNUSED_VAR(routine);
  78     PERL_UNUSED_VAR(done);
  79     PERL_UNUSED_VAR(dest);
  80     PERL_UNUSED_VAR(orig);
  81 }
  82
  83 static void
  84 utf8_safe_downgrade(pTHX_ SV ** src, U8 ** s, STRLEN * slen, bool modify)
  85 {
  86     if (!modify) {
  87         SV *tmp = sv_2mortal(newSVpvn((char *)*s, *slen));
  88         SvUTF8_on(tmp);
  89         if (SvTAINTED(*src))
  90             SvTAINTED_on(tmp);
  91         *src = tmp;
  92         *s = (U8 *)SvPVX(*src);
  93     }
  94     if (*slen) {
  95         if (!utf8_to_bytes(*s, slen))
  96             croak("Wide character");
  97         SvCUR_set(*src, *slen);
  98     }
  99     SvUTF8_off(*src);
 100 }
 101
 102 static void
 103 utf8_safe_upgrade(pTHX_ SV ** src, U8 ** s, STRLEN * slen, bool modify)
 104 {
 105     if (!modify) {
 106         SV *tmp = sv_2mortal(newSVpvn((char *)*s, *slen));
 107         if (SvTAINTED(*src))
 108             SvTAINTED_on(tmp);
 109         *src = tmp;
 110     }
 111     sv_utf8_upgrade_nomg(*src);
 112     *s = (U8 *)SvPV_nomg(*src, *slen);
 113 }
 114
 115 #define ERR_ENCODE_NOMAP "\"\\x{%04" UVxf "}\" does not map to %s"
 116 #define ERR_DECODE_NOMAP "%s \"\\x%02" UVXf "\" does not map to Unicode"
 117
 118 static SV *
 119 do_fallback_cb(pTHX_ UV ch, SV *fallback_cb)
 120 {
 121     dSP;
 122     int argc;
 123     SV *retval = newSVpv("",0);
 124     ENTER;
 125     SAVETMPS;
 126     PUSHMARK(sp);
 127     XPUSHs(sv_2mortal(newSVnv((UV)ch)));
 128     PUTBACK;
 129     argc = call_sv(fallback_cb, G_SCALAR);
 130     SPAGAIN;
 131     if (argc != 1){
 132         croak("fallback sub must return scalar!");
 133     }
 134     sv_catsv(retval, POPs);
 135     PUTBACK;
 136     FREETMPS;
 137     LEAVE;
 138     return retval;
 139 }
 140
 141 static SV *
 142 encode_method(pTHX_ const encode_t * enc, const encpage_t * dir, SV * src, U8 * s, STRLEN slen,
 143               int check, STRLEN * offset, SV * term, int * retcode,
 144               SV *fallback_cb)
 145 {
 146     STRLEN tlen  = slen;
 147     STRLEN ddone = 0;
 148     STRLEN sdone = 0;
 149     /* We allocate slen+1.
 150        PerlIO dumps core if this value is smaller than this. */
 151     SV *dst = newSV(slen+1);
 152     U8 *d = (U8 *)SvPVX(dst);
 153     STRLEN dlen = SvLEN(dst)-1;
 154     int code = 0;
 155     STRLEN trmlen = 0;
 156     U8 *trm = term ? (U8*) SvPV(term, trmlen) : NULL;
 157
 158     if (SvTAINTED(src)) SvTAINTED_on(dst); /* propagate taintedness */
 159
 160     if (offset) {
 161       s += *offset;
 162       if (slen > *offset){ /* safeguard against slen overflow */
 163       slen -= *offset;
 164       }else{
 165       slen = 0;
 166       }
 167       tlen = slen;
 168     }
 169
 170     if (slen == 0){
 171     SvCUR_set(dst, 0);
 172     SvPOK_only(dst);
 173     goto ENCODE_END;
 174     }
 175
 176     while( (code = do_encode(dir, s, &slen, d, dlen, &dlen, !check,
 177                  trm, trmlen)) )
 178     {
 179     SvCUR_set(dst, dlen+ddone);
 180     SvPOK_only(dst);
 181
 182     if (code == ENCODE_FALLBACK || code == ENCODE_PARTIAL ||
 183         code == ENCODE_FOUND_TERM) {
 184         break;
 185     }
 186     switch (code) {
 187     case ENCODE_NOSPACE:
 188     {
 189         STRLEN more = 0; /* make sure you initialize! */
 190         STRLEN sleft;
 191         sdone += slen;
 192         ddone += dlen;
 193         sleft = tlen - sdone;
 194 #if ENCODE_XS_PROFILE >= 2
 195         Perl_warn(aTHX_
 196               "more=%d, sdone=%d, sleft=%d, SvLEN(dst)=%d\n",
 197               more, sdone, sleft, SvLEN(dst));
 198 #endif
 199         if (sdone != 0) { /* has src ever been processed ? */
 200 #if   ENCODE_XS_USEFP == 2
 201         more = (1.0*tlen*SvLEN(dst)+sdone-1)/sdone
 202             - SvLEN(dst);
 203 #elif ENCODE_XS_USEFP
 204         more = (STRLEN)((1.0*SvLEN(dst)+1)/sdone * sleft);
 205 #else
 206         /* safe until SvLEN(dst) == MAX_INT/16 */
 207         more = (16*SvLEN(dst)+1)/sdone/16 * sleft;
 208 #endif
 209         }
 210         more += UTF8_MAXLEN; /* insurance policy */
 211         d = (U8 *) SvGROW(dst, SvLEN(dst) + more);
 212         /* dst need to grow need MORE bytes! */
 213         if (ddone >= SvLEN(dst)) {
 214         Perl_croak(aTHX_ "Destination couldn't be grown.");
 215         }
 216         dlen = SvLEN(dst)-ddone-1;
 217         d   += ddone;
 218         s   += slen;
 219         slen = tlen-sdone;
 220         continue;
 221     }
 222     case ENCODE_NOREP:
 223         /* encoding */
 224         if (dir == enc->f_utf8) {
 225         STRLEN clen;
 226         UV ch =
 227             utf8n_to_uvuni(s+slen, (tlen-sdone-slen),
 228                    &clen, UTF8_ALLOW_ANY|UTF8_CHECK_ONLY);
 229         /* if non-representable multibyte prefix at end of current buffer - break*/
 230         if (clen > tlen - sdone - slen) break;
 231         if (check & ENCODE_DIE_ON_ERR) {
 232             Perl_croak(aTHX_ ERR_ENCODE_NOMAP,
 233                    (UV)ch, enc->name[0]);
 234             return &PL_sv_undef; /* never reaches but be safe */
 235         }
 236         if (check & ENCODE_WARN_ON_ERR){
 237             Perl_warner(aTHX_ packWARN(WARN_UTF8),
 238                 ERR_ENCODE_NOMAP, (UV)ch, enc->name[0]);
 239         }
 240         if (check & ENCODE_RETURN_ON_ERR){
 241             goto ENCODE_SET_SRC;
 242         }
 243         if (check & (ENCODE_PERLQQ|ENCODE_HTMLCREF|ENCODE_XMLCREF)){
 244             SV* subchar =
 245             (fallback_cb != &PL_sv_undef)
 246                 ? do_fallback_cb(aTHX_ ch, fallback_cb)
 247                 : newSVpvf(check & ENCODE_PERLQQ ? "\\x{%04" UVxf "}" :
 248                  check & ENCODE_HTMLCREF ? "&#%" UVuf ";" :
 249                  "&#x%" UVxf ";", (UV)ch);
 250             SvUTF8_off(subchar); /* make sure no decoded string gets in */
 251             sdone += slen + clen;
 252             ddone += dlen + SvCUR(subchar);
 253             sv_catsv(dst, subchar);
 254             SvREFCNT_dec(subchar);
 255         } else {
 256             /* fallback char */
 257             sdone += slen + clen;
 258             ddone += dlen + enc->replen;
 259             sv_catpvn(dst, (char*)enc->rep, enc->replen);
 260         }
 261         }
 262         /* decoding */
 263         else {
 264         if (check & ENCODE_DIE_ON_ERR){
 265             Perl_croak(aTHX_ ERR_DECODE_NOMAP,
 266                               enc->name[0], (UV)s[slen]);
 267             return &PL_sv_undef; /* never reaches but be safe */
 268         }
 269         if (check & ENCODE_WARN_ON_ERR){
 270             Perl_warner(
 271             aTHX_ packWARN(WARN_UTF8),
 272             ERR_DECODE_NOMAP,
 273                         enc->name[0], (UV)s[slen]);
 274         }
 275         if (check & ENCODE_RETURN_ON_ERR){
 276             goto ENCODE_SET_SRC;
 277         }
 278         if (check &
 279             (ENCODE_PERLQQ|ENCODE_HTMLCREF|ENCODE_XMLCREF)){
 280             SV* subchar =
 281             (fallback_cb != &PL_sv_undef)
 282                 ? do_fallback_cb(aTHX_ (UV)s[slen], fallback_cb)
 283                 : newSVpvf("\\x%02" UVXf, (UV)s[slen]);
 284             sdone += slen + 1;
 285             ddone += dlen + SvCUR(subchar);
 286             sv_catsv(dst, subchar);
 287             SvREFCNT_dec(subchar);
 288         } else {
 289             sdone += slen + 1;
 290             ddone += dlen + strlen(FBCHAR_UTF8);
 291             sv_catpv(dst, FBCHAR_UTF8);
 292         }
 293         }
 294         /* settle variables when fallback */
 295         d    = (U8 *)SvEND(dst);
 296             dlen = SvLEN(dst) - ddone - 1;
 297         s    = (U8*)SvPVX(src) + sdone;
 298         slen = tlen - sdone;
 299         break;
 300
 301     default:
 302         Perl_croak(aTHX_ "Unexpected code %d converting %s %s",
 303                code, (dir == enc->f_utf8) ? "to" : "from",
 304                enc->name[0]);
 305         return &PL_sv_undef;
 306     }
 307     }
 308  ENCODE_SET_SRC:
 309     if (check && !(check & ENCODE_LEAVE_SRC)){
 310     sdone = SvCUR(src) - (slen+sdone);
 311     if (sdone) {
 312         sv_setpvn(src, (char*)s+slen, sdone);
 313     }
 314     SvCUR_set(src, sdone);
 315     SvSETMAGIC(src);
 316     }
 317     /* warn("check = 0x%X, code = 0x%d\n", check, code); */
 318
 319     SvCUR_set(dst, dlen+ddone);
 320     SvPOK_only(dst);
 321
 322 #if ENCODE_XS_PROFILE
 323     if (SvCUR(dst) > SvCUR(src)){
 324     Perl_warn(aTHX_
 325           "SvLEN(dst)=%d, SvCUR(dst)=%d. %d bytes unused(%f %%)\n",
 326           SvLEN(dst), SvCUR(dst), SvLEN(dst) - SvCUR(dst),
 327           (SvLEN(dst) - SvCUR(dst))*1.0/SvLEN(dst)*100.0);
 328     }
 329 #endif
 330
 331     if (offset)
 332       *offset += sdone + slen;
 333
 334  ENCODE_END:
 335     *SvEND(dst) = '\0';
 336     if (retcode) *retcode = code;
 337     return dst;
 338 }
 339
 340 static bool
 341 strict_utf8(pTHX_ SV* sv)
 342 {
 343     HV* hv;
 344     SV** svp;
 345     sv = SvRV(sv);
 346     if (!sv || SvTYPE(sv) != SVt_PVHV)
 347         return 0;
 348     hv = (HV*)sv;
 349     svp = hv_fetch(hv, "strict_utf8", 11, 0);
 350     if (!svp)
 351         return 0;
 352     return SvTRUE(*svp);
 353 }
 354
 355 /*
 356  * https://github.com/dankogai/p5-encode/pull/56#issuecomment-231959126
 357  */
 358 #ifndef UNICODE_IS_NONCHAR
 359 #define UNICODE_IS_NONCHAR(c) ((c >= 0xFDD0 && c <= 0xFDEF) || (c & 0xFFFE) == 0xFFFE)
 360 #endif
 361
 362 #ifndef UNICODE_IS_SUPER
 363 #define UNICODE_IS_SUPER(c) (c > PERL_UNICODE_MAX)
 364 #endif
 365
 366 #define UNICODE_IS_STRICT(c) (!UNICODE_IS_SURROGATE(c) && !UNICODE_IS_NONCHAR(c) && !UNICODE_IS_SUPER(c))
 367
 368 #ifndef UTF_ACCUMULATION_OVERFLOW_MASK
 369 #ifndef CHARBITS
 370 #define CHARBITS CHAR_BIT
 371 #endif
 372 #define UTF_ACCUMULATION_OVERFLOW_MASK (((UV) UTF_CONTINUATION_MASK) << ((sizeof(UV) * CHARBITS) - UTF_ACCUMULATION_SHIFT))
 373 #endif
 374
 375 /*
 376  * Convert non strict utf8 sequence of len >= 2 to unicode codepoint
 377  */
 378 static UV
 379 convert_utf8_multi_seq(U8* s, STRLEN len, STRLEN *rlen)
 380 {
 381     UV uv;
 382     U8 *ptr = s;
 383     bool overflowed = 0;
 384
 385     uv = NATIVE_TO_UTF(*s) & UTF_START_MASK(len);
 386
 387     len--;
 388     s++;
 389
 390     while (len--) {
 391         if (!UTF8_IS_CONTINUATION(*s)) {
 392             *rlen = s-ptr;
 393             return 0;
 394         }
 395         if (uv & UTF_ACCUMULATION_OVERFLOW_MASK)
 396             overflowed = 1;
 397         uv = UTF8_ACCUMULATE(uv, *s);
 398         s++;
 399     }
 400
 401     *rlen = s-ptr;
 402
 403     if (overflowed || *rlen > (STRLEN)UNISKIP(uv)) {
 404         *rlen = 1;
 405         return 0;
 406     }
 407
 408     return uv;
 409 }
 410
 411 static U8*
 412 process_utf8(pTHX_ SV* dst, U8* s, U8* e, SV *check_sv,
 413              bool encode, bool strict, bool stop_at_partial)
 414 {
 415     UV uv;
 416     STRLEN ulen;
 417     SV *fallback_cb;
 418     int check;
 419     U8 *d;
 420     STRLEN dlen;
 421
 422     if (SvROK(check_sv)) {
 423         /* croak("UTF-8 decoder doesn't support callback CHECK"); */
 424         fallback_cb = check_sv;
 425         check = ENCODE_PERLQQ|ENCODE_LEAVE_SRC; /* same as perlqq */
 426     }
 427     else {
 428         fallback_cb = &PL_sv_undef;
 429         check = SvIV_nomg(check_sv);
 430     }
 431
 432     SvPOK_only(dst);
 433     SvCUR_set(dst,0);
 434
 435     dlen = (s && e && s < e) ? e-s+1 : 1;
 436     d = (U8 *) SvGROW(dst, dlen);
 437
 438     while (s < e) {
 439         if (UTF8_IS_INVARIANT(*s)) {
 440             *d++ = *s++;
 441             continue;
 442         }
 443
 444         ulen = 1;
 445         if (UTF8_IS_START(*s)) {
 446             U8 skip = UTF8SKIP(s);
 447             if ((s + skip) > e) {
 448                 if (stop_at_partial || (check & ENCODE_STOP_AT_PARTIAL)) {
 449                     const U8 *p = s + 1;
 450                     for (; p < e; p++) {
 451                         if (!UTF8_IS_CONTINUATION(*p)) {
 452                             ulen = p-s;
 453                             goto malformed_byte;
 454                         }
 455                     }
 456                     break;
 457                 }
 458
 459                 ulen = e-s;
 460                 goto malformed_byte;
 461             }
 462
 463             uv = convert_utf8_multi_seq(s, skip, &ulen);
 464             if (uv == 0)
 465                 goto malformed_byte;
 466             else if (strict && !UNICODE_IS_STRICT(uv))
 467                 goto malformed;
 468
 469
 470              /* Whole char is good */
 471              memcpy(d, s, skip);
 472              d += skip;
 473              s += skip;
 474              continue;
 475         }
 476
 477         /* If we get here there is something wrong with alleged UTF-8 */
 478     malformed_byte:
 479         uv = (UV)*s;
 480         if (ulen == 0)
 481             ulen = 1;
 482
 483     malformed:
 484         if (check & ENCODE_DIE_ON_ERR){
 485             if (encode)
 486                 Perl_croak(aTHX_ ERR_ENCODE_NOMAP, uv, "utf8");
 487             else
 488                 Perl_croak(aTHX_ ERR_DECODE_NOMAP, "utf8", uv);
 489         }
 490         if (check & ENCODE_WARN_ON_ERR){
 491             if (encode)
 492                 Perl_warner(aTHX_ packWARN(WARN_UTF8),
 493                             ERR_ENCODE_NOMAP, uv, "utf8");
 494             else
 495                 Perl_warner(aTHX_ packWARN(WARN_UTF8),
 496                             ERR_DECODE_NOMAP, "utf8", uv);
 497         }
 498         if (check & ENCODE_RETURN_ON_ERR) {
 499                 break;
 500         }
 501         if (check & (ENCODE_PERLQQ|ENCODE_HTMLCREF|ENCODE_XMLCREF)){
 502             SV* subchar =
 503                 (fallback_cb != &PL_sv_undef)
 504                 ? do_fallback_cb(aTHX_ uv, fallback_cb)
 505                 : newSVpvf(check & ENCODE_PERLQQ
 506                            ? (ulen == 1 ? "\\x%02" UVXf : "\\x{%04" UVXf "}")
 507                            :  check & ENCODE_HTMLCREF ? "&#%" UVuf ";"
 508                            : "&#x%" UVxf ";", uv);
 509             if (encode){
 510                 SvUTF8_off(subchar); /* make sure no decoded string gets in */
 511             }
 512             dlen += SvCUR(subchar) - ulen;
 513             SvCUR_set(dst, d-(U8 *)SvPVX(dst));
 514             *SvEND(dst) = '\0';
 515             sv_catsv(dst, subchar);
 516             SvREFCNT_dec(subchar);
 517             d = (U8 *) SvGROW(dst, dlen) + SvCUR(dst);
 518         } else {
 519             STRLEN fbcharlen = strlen(FBCHAR_UTF8);
 520             dlen += fbcharlen - ulen;
 521             if (SvLEN(dst) < dlen) {
 522                 SvCUR_set(dst, d-(U8 *)SvPVX(dst));
 523                 d = (U8 *) sv_grow(dst, dlen) + SvCUR(dst);
 524             }
 525             memcpy(d, FBCHAR_UTF8, fbcharlen);
 526             d += fbcharlen;
 527         }
 528         s += ulen;
 529     }
 530     SvCUR_set(dst, d-(U8 *)SvPVX(dst));
 531     *SvEND(dst) = '\0';
 532
 533     return s;
 534 }
 535
 536
 537 MODULE = Encode         PACKAGE = Encode::utf8  PREFIX = Method_
 538
 539 PROTOTYPES: DISABLE
 540
 541 void
 542 Method_decode_xs(obj,src,check_sv = &PL_sv_no)
 543 SV *    obj
 544 SV *    src
 545 SV *    check_sv
 546 PREINIT:
 547     STRLEN slen;
 548     U8 *s;
 549     U8 *e;
 550     SV *dst;
 551     bool renewed = 0;
 552     int check;
 553     bool modify;
 554 INIT:
 555     SvGETMAGIC(src);
 556     SvGETMAGIC(check_sv);
 557     check = SvROK(check_sv) ? ENCODE_PERLQQ|ENCODE_LEAVE_SRC : SvIV_nomg(check_sv);
 558     modify = (check && !(check & ENCODE_LEAVE_SRC));
 559 CODE:
 560 {
 561     dSP;
 562     if (!SvOK(src))
 563         XSRETURN_UNDEF;
 564     s = modify ? (U8 *)SvPV_force_nomg(src, slen) : (U8 *)SvPV_nomg(src, slen);
 565     if (SvUTF8(src))
 566         utf8_safe_downgrade(aTHX_ &src, &s, &slen, modify);
 567     e = s+slen;
 568
 569     /*
 570      * PerlIO check -- we assume the object is of PerlIO if renewed
 571      */
 572     ENTER; SAVETMPS;
 573     PUSHMARK(sp);
 574     XPUSHs(obj);
 575     PUTBACK;
 576     if (call_method("renewed",G_SCALAR) == 1) {
 577     SPAGAIN;
 578     renewed = (bool)POPi;
 579     PUTBACK;
 580 #if 0
 581     fprintf(stderr, "renewed == %d\n", renewed);
 582 #endif
 583     }
 584     FREETMPS; LEAVE;
 585     /* end PerlIO check */
 586
 587     dst = sv_2mortal(newSV(slen>0?slen:1)); /* newSV() abhors 0 -- inaba */
 588     s = process_utf8(aTHX_ dst, s, e, check_sv, 0, strict_utf8(aTHX_ obj), renewed);
 589
 590     /* Clear out translated part of source unless asked not to */
 591     if (modify) {
 592     slen = e-s;
 593     if (slen) {
 594         sv_setpvn(src, (char*)s, slen);
 595     }
 596     SvCUR_set(src, slen);
 597     SvSETMAGIC(src);
 598     }
 599     SvUTF8_on(dst);
 600     if (SvTAINTED(src)) SvTAINTED_on(dst); /* propagate taintedness */
 601     ST(0) = dst;
 602     XSRETURN(1);
 603 }
 604
 605 void
 606 Method_encode_xs(obj,src,check_sv = &PL_sv_no)
 607 SV *    obj
 608 SV *    src
 609 SV *    check_sv
 610 PREINIT:
 611     STRLEN slen;
 612     U8 *s;
 613     U8 *e;
 614     SV *dst;
 615     int check;
 616     bool modify;
 617 INIT:
 618     SvGETMAGIC(src);
 619     SvGETMAGIC(check_sv);
 620     check = SvROK(check_sv) ? ENCODE_PERLQQ|ENCODE_LEAVE_SRC : SvIV_nomg(check_sv);
 621     modify = (check && !(check & ENCODE_LEAVE_SRC));
 622 CODE:
 623 {
 624     if (!SvOK(src))
 625         XSRETURN_UNDEF;
 626     s = modify ? (U8 *)SvPV_force_nomg(src, slen) : (U8 *)SvPV_nomg(src, slen);
 627     e = s+slen;
 628     dst = sv_2mortal(newSV(slen>0?slen:1)); /* newSV() abhors 0 -- inaba */
 629     if (SvUTF8(src)) {
 630     /* Already encoded */
 631     if (strict_utf8(aTHX_ obj)) {
 632         s = process_utf8(aTHX_ dst, s, e, check_sv, 1, 1, 0);
 633     }
 634         else {
 635             /* trust it and just copy the octets */
 636             sv_setpvn(dst,(char *)s,(e-s));
 637         s = e;
 638         }
 639     }
 640     else {
 641         /* Native bytes - can always encode */
 642         U8 *d = (U8 *) SvGROW(dst, 2*slen+1); /* +1 or assertion will botch */
 643         while (s < e) {
 644 #ifdef append_utf8_from_native_byte
 645             append_utf8_from_native_byte(*s, &d);
 646             s++;
 647 #else
 648             UV uv = NATIVE_TO_UNI((UV) *s);
 649             s++; /* Above expansion of NATIVE_TO_UNI() is safer this way. */
 650             if (UNI_IS_INVARIANT(uv))
 651                 *d++ = (U8)UTF_TO_NATIVE(uv);
 652             else {
 653                 *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
 654                 *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
 655             }
 656 #endif
 657         }
 658         SvCUR_set(dst, d- (U8 *)SvPVX(dst));
 659         *SvEND(dst) = '\0';
 660     }
 661
 662     /* Clear out translated part of source unless asked not to */
 663     if (modify) {
 664     slen = e-s;
 665     if (slen) {
 666         sv_setpvn(src, (char*)s, slen);
 667     }
 668     SvCUR_set(src, slen);
 669     SvSETMAGIC(src);
 670     }
 671     SvPOK_only(dst);
 672     SvUTF8_off(dst);
 673     if (SvTAINTED(src)) SvTAINTED_on(dst); /* propagate taintedness */
 674     ST(0) = dst;
 675     XSRETURN(1);
 676 }
 677
 678 MODULE = Encode         PACKAGE = Encode::XS    PREFIX = Method_
 679
 680 PROTOTYPES: ENABLE
 681
 682 void
 683 Method_renew(obj)
 684 SV *    obj
 685 CODE:
 686 {
 687     PERL_UNUSED_VAR(obj);
 688     XSRETURN(1);
 689 }
 690
 691 int
 692 Method_renewed(obj)
 693 SV *    obj
 694 CODE:
 695     RETVAL = 0;
 696     PERL_UNUSED_VAR(obj);
 697 OUTPUT:
 698     RETVAL
 699
 700 void
 701 Method_name(obj)
 702 SV *    obj
 703 CODE:
 704 {
 705     encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj)));
 706     ST(0) = sv_2mortal(newSVpvn(enc->name[0],strlen(enc->name[0])));
 707     XSRETURN(1);
 708 }
 709
 710 void
 711 Method_cat_decode(obj, dst, src, off, term, check_sv = &PL_sv_no)
 712 SV *    obj
 713 SV *    dst
 714 SV *    src
 715 SV *    off
 716 SV *    term
 717 SV *    check_sv
 718 PREINIT:
 719     int check;
 720     SV *fallback_cb;
 721     bool modify;
 722     encode_t *enc;
 723     STRLEN offset;
 724     int code = 0;
 725     U8 *s;
 726     STRLEN slen;
 727     SV *tmp;
 728 INIT:
 729     SvGETMAGIC(src);
 730     SvGETMAGIC(check_sv);
 731     check = SvROK(check_sv) ? ENCODE_PERLQQ|ENCODE_LEAVE_SRC : SvIV_nomg(check_sv);
 732     fallback_cb = SvROK(check_sv) ? check_sv : &PL_sv_undef;
 733     modify = (check && !(check & ENCODE_LEAVE_SRC));
 734     enc = INT2PTR(encode_t *, SvIV(SvRV(obj)));
 735     offset = (STRLEN)SvIV(off);
 736 CODE:
 737 {
 738     if (!SvOK(src))
 739         XSRETURN_NO;
 740     s = modify ? (U8 *)SvPV_force_nomg(src, slen) : (U8 *)SvPV_nomg(src, slen);
 741     if (SvUTF8(src))
 742         utf8_safe_downgrade(aTHX_ &src, &s, &slen, modify);
 743     tmp = encode_method(aTHX_ enc, enc->t_utf8, src, s, slen, check,
 744                 &offset, term, &code, fallback_cb);
 745     sv_catsv(dst, tmp);
 746     SvREFCNT_dec(tmp);
 747     SvIV_set(off, (IV)offset);
 748     if (code == ENCODE_FOUND_TERM) {
 749     ST(0) = &PL_sv_yes;
 750     }else{
 751     ST(0) = &PL_sv_no;
 752     }
 753     XSRETURN(1);
 754 }
 755
 756 SV *
 757 Method_decode(obj,src,check_sv = &PL_sv_no)
 758 SV *    obj
 759 SV *    src
 760 SV *    check_sv
 761 PREINIT:
 762     int check;
 763     SV *fallback_cb;
 764     bool modify;
 765     encode_t *enc;
 766     U8 *s;
 767     STRLEN slen;
 768 INIT:
 769     SvGETMAGIC(src);
 770     SvGETMAGIC(check_sv);
 771     check = SvROK(check_sv) ? ENCODE_PERLQQ|ENCODE_LEAVE_SRC : SvIV_nomg(check_sv);
 772     fallback_cb = SvROK(check_sv) ? check_sv : &PL_sv_undef;
 773     modify = (check && !(check & ENCODE_LEAVE_SRC));
 774     enc = INT2PTR(encode_t *, SvIV(SvRV(obj)));
 775 CODE:
 776 {
 777     if (!SvOK(src))
 778         XSRETURN_UNDEF;
 779     s = modify ? (U8 *)SvPV_force_nomg(src, slen) : (U8 *)SvPV_nomg(src, slen);
 780     if (SvUTF8(src))
 781         utf8_safe_downgrade(aTHX_ &src, &s, &slen, modify);
 782     RETVAL = encode_method(aTHX_ enc, enc->t_utf8, src, s, slen, check,
 783               NULL, Nullsv, NULL, fallback_cb);
 784     SvUTF8_on(RETVAL);
 785 }
 786 OUTPUT:
 787     RETVAL
 788
 789 SV *
 790 Method_encode(obj,src,check_sv = &PL_sv_no)
 791 SV *    obj
 792 SV *    src
 793 SV *    check_sv
 794 PREINIT:
 795     int check;
 796     SV *fallback_cb;
 797     bool modify;
 798     encode_t *enc;
 799     U8 *s;
 800     STRLEN slen;
 801 INIT:
 802     SvGETMAGIC(src);
 803     SvGETMAGIC(check_sv);
 804     check = SvROK(check_sv) ? ENCODE_PERLQQ|ENCODE_LEAVE_SRC : SvIV_nomg(check_sv);
 805     fallback_cb = SvROK(check_sv) ? check_sv : &PL_sv_undef;
 806     modify = (check && !(check & ENCODE_LEAVE_SRC));
 807     enc = INT2PTR(encode_t *, SvIV(SvRV(obj)));
 808 CODE:
 809 {
 810     if (!SvOK(src))
 811         XSRETURN_UNDEF;
 812     s = modify ? (U8 *)SvPV_force_nomg(src, slen) : (U8 *)SvPV_nomg(src, slen);
 813     if (!SvUTF8(src))
 814         utf8_safe_upgrade(aTHX_ &src, &s, &slen, modify);
 815     RETVAL = encode_method(aTHX_ enc, enc->f_utf8, src, s, slen, check,
 816               NULL, Nullsv, NULL, fallback_cb);
 817 }
 818 OUTPUT:
 819     RETVAL
 820
 821 void
 822 Method_needs_lines(obj)
 823 SV *    obj
 824 CODE:
 825 {
 826     /* encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj))); */
 827     PERL_UNUSED_VAR(obj);
 828     ST(0) = &PL_sv_no;
 829     XSRETURN(1);
 830 }
 831
 832 void
 833 Method_perlio_ok(obj)
 834 SV *    obj
 835 PREINIT:
 836     SV *sv;
 837 CODE:
 838 {
 839     /* encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj))); */
 840     /* require_pv(PERLIO_FILENAME); */
 841
 842     PERL_UNUSED_VAR(obj);
 843     eval_pv("require PerlIO::encoding", 0);
 844     SPAGAIN;
 845
 846     sv = get_sv("@", 0);
 847     if (SvTRUE(sv)) {
 848     ST(0) = &PL_sv_no;
 849     }else{
 850     ST(0) = &PL_sv_yes;
 851     }
 852     XSRETURN(1);
 853 }
 854
 855 void
 856 Method_mime_name(obj)
 857 SV *    obj
 858 PREINIT:
 859     SV *sv;
 860 CODE:
 861 {
 862     encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj)));
 863     SV *retval;
 864     eval_pv("require Encode::MIME::Name", 0);
 865     SPAGAIN;
 866
 867     sv = get_sv("@", 0);
 868     if (SvTRUE(sv)) {
 869         ST(0) = &PL_sv_undef;
 870     }else{
 871         ENTER;
 872         SAVETMPS;
 873         PUSHMARK(sp);
 874         XPUSHs(sv_2mortal(newSVpvn(enc->name[0], strlen(enc->name[0]))));
 875         PUTBACK;
 876         call_pv("Encode::MIME::Name::get_mime_name", G_SCALAR);
 877         SPAGAIN;
 878         retval = newSVsv(POPs);
 879         PUTBACK;
 880         FREETMPS;
 881         LEAVE;
 882         /* enc->name[0] */
 883         ST(0) = retval;
 884     }
 885     XSRETURN(1);
 886 }
 887
 888 MODULE = Encode         PACKAGE = Encode
 889
 890 PROTOTYPES: ENABLE
 891
 892 I32
 893 _bytes_to_utf8(sv, ...)
 894 SV *    sv
 895 CODE:
 896 {
 897     SV * encoding = items == 2 ? ST(1) : Nullsv;
 898
 899     if (encoding)
 900     RETVAL = _encoded_bytes_to_utf8(sv, SvPV_nolen(encoding));
 901     else {
 902     STRLEN len;
 903     U8*    s = (U8*)SvPV(sv, len);
 904     U8*    converted;
 905
 906     converted = bytes_to_utf8(s, &len); /* This allocs */
 907     sv_setpvn(sv, (char *)converted, len);
 908     SvUTF8_on(sv); /* XXX Should we? */
 909     Safefree(converted);                /* ... so free it */
 910     RETVAL = len;
 911     }
 912 }
 913 OUTPUT:
 914     RETVAL
 915
 916 I32
 917 _utf8_to_bytes(sv, ...)
 918 SV *    sv
 919 CODE:
 920 {
 921     SV * to    = items > 1 ? ST(1) : Nullsv;
 922     SV * check = items > 2 ? ST(2) : Nullsv;
 923
 924     if (to) {
 925     RETVAL = _encoded_utf8_to_bytes(sv, SvPV_nolen(to));
 926     } else {
 927     STRLEN len;
 928     U8 *s = (U8*)SvPV(sv, len);
 929
 930     RETVAL = 0;
 931     if (SvTRUE(check)) {
 932         /* Must do things the slow way */
 933         U8 *dest;
 934             /* We need a copy to pass to check() */
 935         U8 *src  = s;
 936         U8 *send = s + len;
 937         U8 *d0;
 938
 939         New(83, dest, len, U8); /* I think */
 940         d0 = dest;
 941
 942         while (s < send) {
 943                 if (*s < 0x80){
 944             *dest++ = *s++;
 945                 } else {
 946             STRLEN ulen;
 947             UV uv = *s++;
 948
 949             /* Have to do it all ourselves because of error routine,
 950                aargh. */
 951             if (!(uv & 0x40)){ goto failure; }
 952             if      (!(uv & 0x20)) { ulen = 2;  uv &= 0x1f; }
 953             else if (!(uv & 0x10)) { ulen = 3;  uv &= 0x0f; }
 954             else if (!(uv & 0x08)) { ulen = 4;  uv &= 0x07; }
 955             else if (!(uv & 0x04)) { ulen = 5;  uv &= 0x03; }
 956             else if (!(uv & 0x02)) { ulen = 6;  uv &= 0x01; }
 957             else if (!(uv & 0x01)) { ulen = 7;  uv = 0; }
 958             else                   { ulen = 13; uv = 0; }
 959
 960             /* Note change to utf8.c variable naming, for variety */
 961             while (ulen--) {
 962             if ((*s & 0xc0) != 0x80){
 963                 goto failure;
 964             } else {
 965                 uv = (uv << 6) | (*s++ & 0x3f);
 966             }
 967           }
 968           if (uv > 256) {
 969           failure:
 970               call_failure(check, s, dest, src);
 971               /* Now what happens? */
 972           }
 973           *dest++ = (U8)uv;
 974         }
 975         }
 976         RETVAL = dest - d0;
 977         sv_usepvn(sv, (char *)dest, RETVAL);
 978         SvUTF8_off(sv);
 979     } else {
 980         RETVAL = (utf8_to_bytes(s, &len) ? len : 0);
 981     }
 982     }
 983 }
 984 OUTPUT:
 985     RETVAL
 986
 987 bool
 988 is_utf8(sv, check = 0)
 989 SV *    sv
 990 int     check
 991 PREINIT:
 992     char *str;
 993     STRLEN len;
 994 CODE:
 995 {
 996     SvGETMAGIC(sv); /* SvGETMAGIC() can modify SvOK flag */
 997     str = SvOK(sv) ? SvPV_nomg(sv, len) : NULL; /* SvPV() can modify SvUTF8 flag */
 998     RETVAL = SvUTF8(sv) ? TRUE : FALSE;
 999     if (RETVAL && check && (!str || !is_utf8_string((U8 *)str, len)))
1000         RETVAL = FALSE;
1001 }
1002 OUTPUT:
1003     RETVAL
1004
1005 SV *
1006 _utf8_on(sv)
1007 SV *    sv
1008 CODE:
1009 {
1010     SvGETMAGIC(sv);
1011     if (!SvTAINTED(sv) && SvPOKp(sv)) {
1012         if (SvTHINKFIRST(sv)) sv_force_normal(sv);
1013         RETVAL = newSViv(SvUTF8(sv));
1014         SvUTF8_on(sv);
1015         SvSETMAGIC(sv);
1016     } else {
1017         RETVAL = &PL_sv_undef;
1018     }
1019 }
1020 OUTPUT:
1021     RETVAL
1022
1023 SV *
1024 _utf8_off(sv)
1025 SV *    sv
1026 CODE:
1027 {
1028     SvGETMAGIC(sv);
1029     if (!SvTAINTED(sv) && SvPOKp(sv)) {
1030         if (SvTHINKFIRST(sv)) sv_force_normal(sv);
1031         RETVAL = newSViv(SvUTF8(sv));
1032         SvUTF8_off(sv);
1033         SvSETMAGIC(sv);
1034     } else {
1035         RETVAL = &PL_sv_undef;
1036     }
1037 }
1038 OUTPUT:
1039     RETVAL
1040
1041 BOOT:
1042 {
1043     HV *stash = gv_stashpvn("Encode", strlen("Encode"), GV_ADD);
1044     newCONSTSUB(stash, "DIE_ON_ERR", newSViv(ENCODE_DIE_ON_ERR));
1045     newCONSTSUB(stash, "WARN_ON_ERR", newSViv(ENCODE_WARN_ON_ERR));
1046     newCONSTSUB(stash, "RETURN_ON_ERR", newSViv(ENCODE_RETURN_ON_ERR));
1047     newCONSTSUB(stash, "LEAVE_SRC", newSViv(ENCODE_LEAVE_SRC));
1048     newCONSTSUB(stash, "PERLQQ", newSViv(ENCODE_PERLQQ));
1049     newCONSTSUB(stash, "HTMLCREF", newSViv(ENCODE_HTMLCREF));
1050     newCONSTSUB(stash, "XMLCREF", newSViv(ENCODE_XMLCREF));
1051     newCONSTSUB(stash, "STOP_AT_PARTIAL", newSViv(ENCODE_STOP_AT_PARTIAL));
1052     newCONSTSUB(stash, "FB_DEFAULT", newSViv(ENCODE_FB_DEFAULT));
1053     newCONSTSUB(stash, "FB_CROAK", newSViv(ENCODE_FB_CROAK));
1054     newCONSTSUB(stash, "FB_QUIET", newSViv(ENCODE_FB_QUIET));
1055     newCONSTSUB(stash, "FB_WARN", newSViv(ENCODE_FB_WARN));
1056     newCONSTSUB(stash, "FB_PERLQQ", newSViv(ENCODE_FB_PERLQQ));
1057     newCONSTSUB(stash, "FB_HTMLCREF", newSViv(ENCODE_FB_HTMLCREF));
1058     newCONSTSUB(stash, "FB_XMLCREF", newSViv(ENCODE_FB_XMLCREF));
1059 }
1060 {
1061 #include "def_t.exh"
1062 }