ext/Encode/Encode.xs

   1 /*
   2  $Id: Encode.xs,v 1.46 2002/05/20 15:25:44 dankogai Exp dankogai $
   3  */
   4
   5 #define PERL_NO_GET_CONTEXT
   6 #include "EXTERN.h"
   7 #include "perl.h"
   8 #include "XSUB.h"
   9 #define U8 U8
  10 #include "encode.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) y x (SV *sv, char *encoding) {dTHX;   \
  24                          Perl_croak(aTHX_ "panic_unimplemented"); \
  25                          return (y)0; /* fool picky compilers */ \
  26                          }
  27 /**/
  28
  29 UNIMPLEMENTED(_encoded_utf8_to_bytes, I32)
  30 UNIMPLEMENTED(_encoded_bytes_to_utf8, I32)
  31
  32 void
  33 Encode_XSEncoding(pTHX_ encode_t * enc)
  34 {
  35     dSP;
  36     HV *stash = gv_stashpv("Encode::XS", TRUE);
  37     SV *sv = sv_bless(newRV_noinc(newSViv(PTR2IV(enc))), stash);
  38     int i = 0;
  39     PUSHMARK(sp);
  40     XPUSHs(sv);
  41     while (enc->name[i]) {
  42         const char *name = enc->name[i++];
  43         XPUSHs(sv_2mortal(newSVpvn(name, strlen(name))));
  44     }
  45     PUTBACK;
  46     call_pv("Encode::define_encoding", G_DISCARD);
  47     SvREFCNT_dec(sv);
  48 }
  49
  50 void
  51 call_failure(SV * routine, U8 * done, U8 * dest, U8 * orig)
  52 {
  53     /* Exists for breakpointing */
  54 }
  55
  56
  57 #define ERR_ENCODE_NOMAP "\"\\x{%04" UVxf "}\" does not map to %s"
  58 #define ERR_DECODE_NOMAP "%s \"\\x%02" UVXf "\" does not map to Unicode"
  59
  60 static SV *
  61 encode_method(pTHX_ encode_t * enc, encpage_t * dir, SV * src,
  62               int check)
  63 {
  64     STRLEN slen;
  65     U8 *s = (U8 *) SvPV(src, slen);
  66     STRLEN tlen  = slen;
  67     STRLEN ddone = 0;
  68     STRLEN sdone = 0;
  69
  70     /* We allocate slen+1.
  71        PerlIO dumps core if this value is smaller than this. */
  72     SV *dst = sv_2mortal(newSV(slen+1));
  73     U8 *d = (U8 *)SvPVX(dst);
  74     STRLEN dlen = SvLEN(dst)-1;
  75     int code;
  76
  77     if (!slen){
  78         SvCUR_set(dst, 0);
  79         SvPOK_only(dst);
  80         goto ENCODE_END;
  81     }
  82
  83     while( (code = do_encode(dir, s, &slen, d, dlen, &dlen, !check)) )
  84     {
  85         SvCUR_set(dst, dlen+ddone);
  86         SvPOK_only(dst);
  87
  88         if (code == ENCODE_FALLBACK || code == ENCODE_PARTIAL){
  89             break;
  90         }
  91         switch (code) {
  92         case ENCODE_NOSPACE:
  93         {
  94             STRLEN more = 0; /* make sure you initialize! */
  95             STRLEN sleft;
  96             sdone += slen;
  97             ddone += dlen;
  98             sleft = tlen - sdone;
  99 #if ENCODE_XS_PROFILE >= 2
 100             Perl_warn(aTHX_
 101                       "more=%d, sdone=%d, sleft=%d, SvLEN(dst)=%d\n",
 102                       more, sdone, sleft, SvLEN(dst));
 103 #endif
 104             if (sdone != 0) { /* has src ever been processed ? */
 105 #if   ENCODE_XS_USEFP == 2
 106                 more = (1.0*tlen*SvLEN(dst)+sdone-1)/sdone
 107                     - SvLEN(dst);
 108 #elif ENCODE_XS_USEFP
 109                 more = (STRLEN)((1.0*SvLEN(dst)+1)/sdone * sleft);
 110 #else
 111                 /* safe until SvLEN(dst) == MAX_INT/16 */
 112                 more = (16*SvLEN(dst)+1)/sdone/16 * sleft;
 113 #endif
 114             }
 115             more += UTF8_MAXLEN; /* insurance policy */
 116             d = (U8 *) SvGROW(dst, SvLEN(dst) + more);
 117             /* dst need to grow need MORE bytes! */
 118             if (ddone >= SvLEN(dst)) {
 119                 Perl_croak(aTHX_ "Destination couldn't be grown.");
 120             }
 121             dlen = SvLEN(dst)-ddone-1;
 122             d   += ddone;
 123             s   += slen;
 124             slen = tlen-sdone;
 125             continue;
 126         }
 127         case ENCODE_NOREP:
 128             /* encoding */
 129             if (dir == enc->f_utf8) {
 130                 STRLEN clen;
 131                 UV ch =
 132                     utf8n_to_uvuni(s+slen, (SvCUR(src)-slen),
 133                                    &clen, UTF8_ALLOW_ANY|UTF8_CHECK_ONLY);
 134                 if (check & ENCODE_DIE_ON_ERR) {
 135                     Perl_croak(aTHX_ ERR_ENCODE_NOMAP,
 136                                (UV)ch, enc->name[0]);
 137                     return &PL_sv_undef; /* never reaches but be safe */
 138                 }
 139                 if (check & ENCODE_WARN_ON_ERR){
 140                     Perl_warner(aTHX_ packWARN(WARN_UTF8),
 141                                 ERR_ENCODE_NOMAP, (UV)ch, enc->name[0]);
 142                 }
 143                 if (check & ENCODE_RETURN_ON_ERR){
 144                     goto ENCODE_SET_SRC;
 145                 }
 146                 if (check & ENCODE_PERLQQ){
 147                     SV* perlqq =
 148                         sv_2mortal(newSVpvf("\\x{%04"UVxf"}", (UV)ch));
 149                     sdone += slen + clen;
 150                     ddone += dlen + SvCUR(perlqq);
 151                     sv_catsv(dst, perlqq);
 152                 }else if (check & ENCODE_HTMLCREF){
 153                     SV* htmlcref =
 154                         sv_2mortal(newSVpvf("&#%" UVuf ";", (UV)ch));
 155                     sdone += slen + clen;
 156                     ddone += dlen + SvCUR(htmlcref);
 157                     sv_catsv(dst, htmlcref);
 158                 }else if (check & ENCODE_XMLCREF){
 159                     SV* xmlcref =
 160                         sv_2mortal(newSVpvf("&#x%" UVxf ";", (UV)ch));
 161                     sdone += slen + clen;
 162                     ddone += dlen + SvCUR(xmlcref);
 163                     sv_catsv(dst, xmlcref);
 164                 } else {
 165                     /* fallback char */
 166                     sdone += slen + clen;
 167                     ddone += dlen + enc->replen;
 168                     sv_catpvn(dst, (char*)enc->rep, enc->replen);
 169                 }
 170             }
 171             /* decoding */
 172             else {
 173                 if (check & ENCODE_DIE_ON_ERR){
 174                     Perl_croak(aTHX_ ERR_DECODE_NOMAP,
 175                               enc->name[0], (UV)s[slen]);
 176                     return &PL_sv_undef; /* never reaches but be safe */
 177                 }
 178                 if (check & ENCODE_WARN_ON_ERR){
 179                     Perl_warner(
 180                         aTHX_ packWARN(WARN_UTF8),
 181                         ERR_DECODE_NOMAP,
 182                         enc->name[0], (UV)s[slen]);
 183                 }
 184                 if (check & ENCODE_RETURN_ON_ERR){
 185                     goto ENCODE_SET_SRC;
 186                 }
 187                 if (check &
 188                     (ENCODE_PERLQQ|ENCODE_HTMLCREF|ENCODE_XMLCREF)){
 189                     SV* perlqq =
 190                         sv_2mortal(newSVpvf("\\x%02" UVXf, (UV)s[slen]));
 191                     sdone += slen + 1;
 192                     ddone += dlen + SvCUR(perlqq);
 193                     sv_catsv(dst, perlqq);
 194                 } else {
 195                     sdone += slen + 1;
 196                     ddone += dlen + strlen(FBCHAR_UTF8);
 197                     sv_catpv(dst, FBCHAR_UTF8);
 198                 }
 199             }
 200             /* settle variables when fallback */
 201             d    = (U8 *)SvEND(dst);
 202             dlen = SvLEN(dst) - ddone - 1;
 203             s    = (U8*)SvPVX(src) + sdone;
 204             slen = tlen - sdone;
 205             break;
 206
 207         default:
 208             Perl_croak(aTHX_ "Unexpected code %d converting %s %s",
 209                        code, (dir == enc->f_utf8) ? "to" : "from",
 210                        enc->name[0]);
 211             return &PL_sv_undef;
 212         }
 213     }
 214  ENCODE_SET_SRC:
 215     if (check && !(check & ENCODE_LEAVE_SRC)){
 216         sdone = SvCUR(src) - (slen+sdone);
 217         if (sdone) {
 218             sv_setpvn(src, (char*)s+slen, sdone);
 219         }
 220         SvCUR_set(src, sdone);
 221     }
 222     /* warn("check = 0x%X, code = 0x%d\n", check, code); */
 223
 224     SvCUR_set(dst, dlen+ddone);
 225     SvPOK_only(dst);
 226
 227 #if ENCODE_XS_PROFILE
 228     if (SvCUR(dst) > SvCUR(src)){
 229         Perl_warn(aTHX_
 230                   "SvLEN(dst)=%d, SvCUR(dst)=%d. %d bytes unused(%f %%)\n",
 231                   SvLEN(dst), SvCUR(dst), SvLEN(dst) - SvCUR(dst),
 232                   (SvLEN(dst) - SvCUR(dst))*1.0/SvLEN(dst)*100.0);
 233     }
 234 #endif
 235
 236  ENCODE_END:
 237     *SvEND(dst) = '\0';
 238     return dst;
 239 }
 240
 241 MODULE = Encode         PACKAGE = Encode::utf8  PREFIX = Method_
 242
 243 void
 244 Method_decode(obj,src,check = 0)
 245 SV *    obj
 246 SV *    src
 247 int     check
 248 CODE:
 249 {
 250     STRLEN slen;
 251     U8 *s = (U8 *) SvPV(src, slen);
 252     U8 *e = (U8 *) SvEND(src);
 253     SV *dst = newSV(slen);
 254     SvPOK_only(dst);
 255     SvCUR_set(dst,0);
 256     while (s < e) {
 257         if (UTF8_IS_INVARIANT(*s) || UTF8_IS_START(*s)) {
 258             U8 skip = UTF8SKIP(s);
 259             if ((s + skip) > e) {
 260                 /* Partial character - done */
 261                 break;
 262             }
 263             else if (is_utf8_char(s)) {
 264                 /* Whole char is good */
 265                 sv_catpvn(dst,(char *)s,skip);
 266                 s += skip;
 267                 continue;
 268             }
 269             else {
 270                 /* starts ok but isn't "good" */
 271             }
 272         }
 273         else {
 274             /* Invalid start byte */
 275         }
 276         /* If we get here there is something wrong with alleged UTF-8 */
 277         if (check & ENCODE_DIE_ON_ERR){
 278             Perl_croak(aTHX_ ERR_DECODE_NOMAP, "utf8", (UV)*s);
 279             XSRETURN(0);
 280         }
 281         if (check & ENCODE_WARN_ON_ERR){
 282             Perl_warner(aTHX_ packWARN(WARN_UTF8),
 283                         ERR_DECODE_NOMAP, "utf8", (UV)*s);
 284         }
 285         if (check & ENCODE_RETURN_ON_ERR) {
 286                 break;
 287         }
 288         if (check & (ENCODE_PERLQQ|ENCODE_HTMLCREF|ENCODE_XMLCREF)){
 289             SV* perlqq = newSVpvf("\\x%02" UVXf, (UV)*s);
 290             sv_catsv(dst, perlqq);
 291             SvREFCNT_dec(perlqq);
 292         } else {
 293             sv_catpv(dst, FBCHAR_UTF8);
 294         }
 295         s++;
 296     }
 297     *SvEND(dst) = '\0';
 298
 299     /* Clear out translated part of source unless asked not to */
 300     if (check && !(check & ENCODE_LEAVE_SRC)){
 301         slen = e-s;
 302         if (slen) {
 303             sv_setpvn(src, (char*)s, slen);
 304         }
 305         SvCUR_set(src, slen);
 306     }
 307     SvUTF8_on(dst);
 308     ST(0) = sv_2mortal(dst);
 309     XSRETURN(1);
 310 }
 311
 312 void
 313 Method_encode(obj,src,check = 0)
 314 SV *    obj
 315 SV *    src
 316 int     check
 317 CODE:
 318 {
 319     STRLEN slen;
 320     U8 *s = (U8 *) SvPV(src, slen);
 321     U8 *e = (U8 *) SvEND(src);
 322     SV *dst = newSV(slen);
 323     if (SvUTF8(src)) {
 324         /* Already encoded - trust it and just copy the octets */
 325         sv_setpvn(dst,(char *)s,(e-s));
 326         s = e;
 327     }
 328     else {
 329         /* Native bytes - can always encode */
 330         U8 *d = (U8 *) SvGROW(dst,2*slen);
 331         while (s < e) {
 332             UV uv = NATIVE_TO_UNI((UV) *s++);
 333             if (UNI_IS_INVARIANT(uv))
 334                 *d++ = (U8)UTF_TO_NATIVE(uv);
 335             else {
 336                 *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
 337                 *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
 338             }
 339         }
 340         SvCUR_set(dst, d- (U8 *)SvPVX(dst));
 341         *SvEND(dst) = '\0';
 342     }
 343
 344     /* Clear out translated part of source unless asked not to */
 345     if (check && !(check & ENCODE_LEAVE_SRC)){
 346         slen = e-s;
 347         if (slen) {
 348             sv_setpvn(src, (char*)s, slen);
 349         }
 350         SvCUR_set(src, slen);
 351     }
 352     SvPOK_only(dst);
 353     SvUTF8_off(dst);
 354     ST(0) = sv_2mortal(dst);
 355     XSRETURN(1);
 356 }
 357
 358 MODULE = Encode         PACKAGE = Encode::XS    PREFIX = Method_
 359
 360 PROTOTYPES: ENABLE
 361
 362 void
 363 Method_name(obj)
 364 SV *    obj
 365 CODE:
 366 {
 367     encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj)));
 368     ST(0) = sv_2mortal(newSVpvn(enc->name[0],strlen(enc->name[0])));
 369     XSRETURN(1);
 370 }
 371
 372 void
 373 Method_decode(obj,src,check = 0)
 374 SV *    obj
 375 SV *    src
 376 int     check
 377 CODE:
 378 {
 379     encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj)));
 380     ST(0) = encode_method(aTHX_ enc, enc->t_utf8, src, check);
 381     SvUTF8_on(ST(0));
 382     XSRETURN(1);
 383 }
 384
 385 void
 386 Method_encode(obj,src,check = 0)
 387 SV *    obj
 388 SV *    src
 389 int     check
 390 CODE:
 391 {
 392     encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj)));
 393     sv_utf8_upgrade(src);
 394     ST(0) = encode_method(aTHX_ enc, enc->f_utf8, src, check);
 395     XSRETURN(1);
 396 }
 397
 398 void
 399 Method_needs_lines(obj)
 400 SV *    obj
 401 CODE:
 402 {
 403     /* encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj))); */
 404     ST(0) = &PL_sv_no;
 405     XSRETURN(1);
 406 }
 407
 408 void
 409 Method_perlio_ok(obj)
 410 SV *    obj
 411 CODE:
 412 {
 413     /* encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj))); */
 414     /* require_pv(PERLIO_FILENAME); */
 415
 416     eval_pv("require PerlIO::encoding", 0);
 417
 418     if (SvTRUE(get_sv("@", 0))) {
 419         ST(0) = &PL_sv_no;
 420     }else{
 421         ST(0) = &PL_sv_yes;
 422     }
 423     XSRETURN(1);
 424 }
 425
 426 MODULE = Encode         PACKAGE = Encode
 427
 428 PROTOTYPES: ENABLE
 429
 430 I32
 431 _bytes_to_utf8(sv, ...)
 432 SV *    sv
 433 CODE:
 434 {
 435     SV * encoding = items == 2 ? ST(1) : Nullsv;
 436
 437     if (encoding)
 438     RETVAL = _encoded_bytes_to_utf8(sv, SvPV_nolen(encoding));
 439     else {
 440         STRLEN len;
 441         U8*    s = (U8*)SvPV(sv, len);
 442         U8*    converted;
 443
 444         converted = bytes_to_utf8(s, &len); /* This allocs */
 445         sv_setpvn(sv, (char *)converted, len);
 446         SvUTF8_on(sv); /* XXX Should we? */
 447         Safefree(converted);                /* ... so free it */
 448         RETVAL = len;
 449     }
 450 }
 451 OUTPUT:
 452     RETVAL
 453
 454 I32
 455 _utf8_to_bytes(sv, ...)
 456 SV *    sv
 457 CODE:
 458 {
 459     SV * to    = items > 1 ? ST(1) : Nullsv;
 460     SV * check = items > 2 ? ST(2) : Nullsv;
 461
 462     if (to) {
 463         RETVAL = _encoded_utf8_to_bytes(sv, SvPV_nolen(to));
 464     } else {
 465         STRLEN len;
 466         U8 *s = (U8*)SvPV(sv, len);
 467
 468         RETVAL = 0;
 469         if (SvTRUE(check)) {
 470             /* Must do things the slow way */
 471             U8 *dest;
 472             /* We need a copy to pass to check() */
 473             U8 *src  = (U8*)savepv((char *)s);
 474             U8 *send = s + len;
 475
 476             New(83, dest, len, U8); /* I think */
 477
 478             while (s < send) {
 479                 if (*s < 0x80){
 480                     *dest++ = *s++;
 481                 } else {
 482                     STRLEN ulen;
 483                     UV uv = *s++;
 484
 485                     /* Have to do it all ourselves because of error routine,
 486                        aargh. */
 487                     if (!(uv & 0x40)){ goto failure; }
 488                     if      (!(uv & 0x20)) { ulen = 2;  uv &= 0x1f; }
 489                     else if (!(uv & 0x10)) { ulen = 3;  uv &= 0x0f; }
 490                     else if (!(uv & 0x08)) { ulen = 4;  uv &= 0x07; }
 491                     else if (!(uv & 0x04)) { ulen = 5;  uv &= 0x03; }
 492                     else if (!(uv & 0x02)) { ulen = 6;  uv &= 0x01; }
 493                     else if (!(uv & 0x01)) { ulen = 7;  uv = 0; }
 494                     else                   { ulen = 13; uv = 0; }
 495
 496                     /* Note change to utf8.c variable naming, for variety */
 497                     while (ulen--) {
 498                         if ((*s & 0xc0) != 0x80){
 499                             goto failure;
 500                         } else {
 501                             uv = (uv << 6) | (*s++ & 0x3f);
 502                         }
 503                   }
 504                   if (uv > 256) {
 505                   failure:
 506                       call_failure(check, s, dest, src);
 507                       /* Now what happens? */
 508                   }
 509                   *dest++ = (U8)uv;
 510                 }
 511             }
 512         } else {
 513             RETVAL = (utf8_to_bytes(s, &len) ? len : 0);
 514         }
 515     }
 516 }
 517 OUTPUT:
 518     RETVAL
 519
 520 bool
 521 is_utf8(sv, check = 0)
 522 SV *    sv
 523 int     check
 524 CODE:
 525 {
 526     if (SvGMAGICAL(sv)) /* it could be $1, for example */
 527         sv = newSVsv(sv); /* GMAGIG will be done */
 528     if (SvPOK(sv)) {
 529         RETVAL = SvUTF8(sv) ? TRUE : FALSE;
 530         if (RETVAL &&
 531             check  &&
 532             !is_utf8_string((U8*)SvPVX(sv), SvCUR(sv)))
 533             RETVAL = FALSE;
 534     } else {
 535         RETVAL = FALSE;
 536     }
 537     if (sv != ST(0))
 538         SvREFCNT_dec(sv); /* it was a temp copy */
 539 }
 540 OUTPUT:
 541     RETVAL
 542
 543 SV *
 544 _utf8_on(sv)
 545 SV *    sv
 546 CODE:
 547 {
 548     if (SvPOK(sv)) {
 549         SV *rsv = newSViv(SvUTF8(sv));
 550         RETVAL = rsv;
 551         SvUTF8_on(sv);
 552     } else {
 553         RETVAL = &PL_sv_undef;
 554     }
 555 }
 556 OUTPUT:
 557     RETVAL
 558
 559 SV *
 560 _utf8_off(sv)
 561 SV *    sv
 562 CODE:
 563 {
 564     if (SvPOK(sv)) {
 565         SV *rsv = newSViv(SvUTF8(sv));
 566         RETVAL = rsv;
 567         SvUTF8_off(sv);
 568     } else {
 569         RETVAL = &PL_sv_undef;
 570     }
 571 }
 572 OUTPUT:
 573     RETVAL
 574
 575 int
 576 DIE_ON_ERR()
 577 CODE:
 578     RETVAL = ENCODE_DIE_ON_ERR;
 579 OUTPUT:
 580     RETVAL
 581
 582 int
 583 WARN_ON_ERR()
 584 CODE:
 585     RETVAL = ENCODE_WARN_ON_ERR;
 586 OUTPUT:
 587     RETVAL
 588
 589 int
 590 LEAVE_SRC()
 591 CODE:
 592     RETVAL = ENCODE_LEAVE_SRC;
 593 OUTPUT:
 594     RETVAL
 595
 596 int
 597 RETURN_ON_ERR()
 598 CODE:
 599     RETVAL = ENCODE_RETURN_ON_ERR;
 600 OUTPUT:
 601     RETVAL
 602
 603 int
 604 PERLQQ()
 605 CODE:
 606     RETVAL = ENCODE_PERLQQ;
 607 OUTPUT:
 608     RETVAL
 609
 610 int
 611 HTMLCREF()
 612 CODE:
 613     RETVAL = ENCODE_HTMLCREF;
 614 OUTPUT:
 615     RETVAL
 616
 617 int
 618 XMLCREF()
 619 CODE:
 620     RETVAL = ENCODE_XMLCREF;
 621 OUTPUT:
 622     RETVAL
 623
 624 int
 625 FB_DEFAULT()
 626 CODE:
 627     RETVAL = ENCODE_FB_DEFAULT;
 628 OUTPUT:
 629     RETVAL
 630
 631 int
 632 FB_CROAK()
 633 CODE:
 634     RETVAL = ENCODE_FB_CROAK;
 635 OUTPUT:
 636     RETVAL
 637
 638 int
 639 FB_QUIET()
 640 CODE:
 641     RETVAL = ENCODE_FB_QUIET;
 642 OUTPUT:
 643     RETVAL
 644
 645 int
 646 FB_WARN()
 647 CODE:
 648     RETVAL = ENCODE_FB_WARN;
 649 OUTPUT:
 650     RETVAL
 651
 652 int
 653 FB_PERLQQ()
 654 CODE:
 655     RETVAL = ENCODE_FB_PERLQQ;
 656 OUTPUT:
 657     RETVAL
 658
 659 int
 660 FB_HTMLCREF()
 661 CODE:
 662     RETVAL = ENCODE_FB_HTMLCREF;
 663 OUTPUT:
 664     RETVAL
 665
 666 int
 667 FB_XMLCREF()
 668 CODE:
 669     RETVAL = ENCODE_FB_XMLCREF;
 670 OUTPUT:
 671     RETVAL
 672
 673 BOOT:
 674 {
 675 #include "def_t.h"
 676 #include "def_t.exh"
 677 }