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::XS    PREFIX = Method_
 242
 243 PROTOTYPES: ENABLE
 244
 245 void
 246 Method_name(obj)
 247 SV *    obj
 248 CODE:
 249 {
 250     encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj)));
 251     ST(0) = sv_2mortal(newSVpvn(enc->name[0],strlen(enc->name[0])));
 252     XSRETURN(1);
 253 }
 254
 255 void
 256 Method_decode(obj,src,check = 0)
 257 SV *    obj
 258 SV *    src
 259 int     check
 260 CODE:
 261 {
 262     encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj)));
 263     ST(0) = encode_method(aTHX_ enc, enc->t_utf8, src, check);
 264     SvUTF8_on(ST(0));
 265     XSRETURN(1);
 266 }
 267
 268 void
 269 Method_encode(obj,src,check = 0)
 270 SV *    obj
 271 SV *    src
 272 int     check
 273 CODE:
 274 {
 275     encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj)));
 276     sv_utf8_upgrade(src);
 277     ST(0) = encode_method(aTHX_ enc, enc->f_utf8, src, check);
 278     XSRETURN(1);
 279 }
 280
 281 void
 282 Method_needs_lines(obj)
 283 SV *    obj
 284 CODE:
 285 {
 286     /* encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj))); */
 287     ST(0) = &PL_sv_no;
 288     XSRETURN(1);
 289 }
 290
 291 void
 292 Method_perlio_ok(obj)
 293 SV *    obj
 294 CODE:
 295 {
 296     /* encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj))); */
 297     /* require_pv(PERLIO_FILENAME); */
 298
 299     eval_pv("require PerlIO::encoding", 0);
 300
 301     if (SvTRUE(get_sv("@", 0))) {
 302         ST(0) = &PL_sv_no;
 303     }else{
 304         ST(0) = &PL_sv_yes;
 305     }
 306     XSRETURN(1);
 307 }
 308
 309 MODULE = Encode         PACKAGE = Encode
 310
 311 PROTOTYPES: ENABLE
 312
 313 I32
 314 _bytes_to_utf8(sv, ...)
 315 SV *    sv
 316 CODE:
 317 {
 318     SV * encoding = items == 2 ? ST(1) : Nullsv;
 319
 320     if (encoding)
 321     RETVAL = _encoded_bytes_to_utf8(sv, SvPV_nolen(encoding));
 322     else {
 323         STRLEN len;
 324         U8*    s = (U8*)SvPV(sv, len);
 325         U8*    converted;
 326
 327         converted = bytes_to_utf8(s, &len); /* This allocs */
 328         sv_setpvn(sv, (char *)converted, len);
 329         SvUTF8_on(sv); /* XXX Should we? */
 330         Safefree(converted);                /* ... so free it */
 331         RETVAL = len;
 332     }
 333 }
 334 OUTPUT:
 335     RETVAL
 336
 337 I32
 338 _utf8_to_bytes(sv, ...)
 339 SV *    sv
 340 CODE:
 341 {
 342     SV * to    = items > 1 ? ST(1) : Nullsv;
 343     SV * check = items > 2 ? ST(2) : Nullsv;
 344
 345     if (to) {
 346         RETVAL = _encoded_utf8_to_bytes(sv, SvPV_nolen(to));
 347     } else {
 348         STRLEN len;
 349         U8 *s = (U8*)SvPV(sv, len);
 350
 351         RETVAL = 0;
 352         if (SvTRUE(check)) {
 353             /* Must do things the slow way */
 354             U8 *dest;
 355             /* We need a copy to pass to check() */
 356             U8 *src  = (U8*)savepv((char *)s);
 357             U8 *send = s + len;
 358
 359             New(83, dest, len, U8); /* I think */
 360
 361             while (s < send) {
 362                 if (*s < 0x80){
 363                     *dest++ = *s++;
 364                 } else {
 365                     STRLEN ulen;
 366                     UV uv = *s++;
 367
 368                     /* Have to do it all ourselves because of error routine,
 369                        aargh. */
 370                     if (!(uv & 0x40)){ goto failure; }
 371                     if      (!(uv & 0x20)) { ulen = 2;  uv &= 0x1f; }
 372                     else if (!(uv & 0x10)) { ulen = 3;  uv &= 0x0f; }
 373                     else if (!(uv & 0x08)) { ulen = 4;  uv &= 0x07; }
 374                     else if (!(uv & 0x04)) { ulen = 5;  uv &= 0x03; }
 375                     else if (!(uv & 0x02)) { ulen = 6;  uv &= 0x01; }
 376                     else if (!(uv & 0x01)) { ulen = 7;  uv = 0; }
 377                     else                   { ulen = 13; uv = 0; }
 378
 379                     /* Note change to utf8.c variable naming, for variety */
 380                     while (ulen--) {
 381                         if ((*s & 0xc0) != 0x80){
 382                             goto failure;
 383                         } else {
 384                             uv = (uv << 6) | (*s++ & 0x3f);
 385                         }
 386                   }
 387                   if (uv > 256) {
 388                   failure:
 389                       call_failure(check, s, dest, src);
 390                       /* Now what happens? */
 391                   }
 392                   *dest++ = (U8)uv;
 393                 }
 394             }
 395         } else {
 396             RETVAL = (utf8_to_bytes(s, &len) ? len : 0);
 397         }
 398     }
 399 }
 400 OUTPUT:
 401     RETVAL
 402
 403 bool
 404 is_utf8(sv, check = 0)
 405 SV *    sv
 406 int     check
 407 CODE:
 408 {
 409     if (SvGMAGICAL(sv)) /* it could be $1, for example */
 410         sv = newSVsv(sv); /* GMAGIG will be done */
 411     if (SvPOK(sv)) {
 412         RETVAL = SvUTF8(sv) ? TRUE : FALSE;
 413         if (RETVAL &&
 414             check  &&
 415             !is_utf8_string((U8*)SvPVX(sv), SvCUR(sv)))
 416             RETVAL = FALSE;
 417     } else {
 418         RETVAL = FALSE;
 419     }
 420     if (sv != ST(0))
 421         SvREFCNT_dec(sv); /* it was a temp copy */
 422 }
 423 OUTPUT:
 424     RETVAL
 425
 426 SV *
 427 _utf8_on(sv)
 428 SV *    sv
 429 CODE:
 430 {
 431     if (SvPOK(sv)) {
 432         SV *rsv = newSViv(SvUTF8(sv));
 433         RETVAL = rsv;
 434         SvUTF8_on(sv);
 435     } else {
 436         RETVAL = &PL_sv_undef;
 437     }
 438 }
 439 OUTPUT:
 440     RETVAL
 441
 442 SV *
 443 _utf8_off(sv)
 444 SV *    sv
 445 CODE:
 446 {
 447     if (SvPOK(sv)) {
 448         SV *rsv = newSViv(SvUTF8(sv));
 449         RETVAL = rsv;
 450         SvUTF8_off(sv);
 451     } else {
 452         RETVAL = &PL_sv_undef;
 453     }
 454 }
 455 OUTPUT:
 456     RETVAL
 457
 458 int
 459 DIE_ON_ERR()
 460 CODE:
 461     RETVAL = ENCODE_DIE_ON_ERR;
 462 OUTPUT:
 463     RETVAL
 464
 465 int
 466 WARN_ON_ERR()
 467 CODE:
 468     RETVAL = ENCODE_WARN_ON_ERR;
 469 OUTPUT:
 470     RETVAL
 471
 472 int
 473 LEAVE_SRC()
 474 CODE:
 475     RETVAL = ENCODE_LEAVE_SRC;
 476 OUTPUT:
 477     RETVAL
 478
 479 int
 480 RETURN_ON_ERR()
 481 CODE:
 482     RETVAL = ENCODE_RETURN_ON_ERR;
 483 OUTPUT:
 484     RETVAL
 485
 486 int
 487 PERLQQ()
 488 CODE:
 489     RETVAL = ENCODE_PERLQQ;
 490 OUTPUT:
 491     RETVAL
 492
 493 int
 494 HTMLCREF()
 495 CODE:
 496     RETVAL = ENCODE_HTMLCREF;
 497 OUTPUT:
 498     RETVAL
 499
 500 int
 501 XMLCREF()
 502 CODE:
 503     RETVAL = ENCODE_XMLCREF;
 504 OUTPUT:
 505     RETVAL
 506
 507 int
 508 FB_DEFAULT()
 509 CODE:
 510     RETVAL = ENCODE_FB_DEFAULT;
 511 OUTPUT:
 512     RETVAL
 513
 514 int
 515 FB_CROAK()
 516 CODE:
 517     RETVAL = ENCODE_FB_CROAK;
 518 OUTPUT:
 519     RETVAL
 520
 521 int
 522 FB_QUIET()
 523 CODE:
 524     RETVAL = ENCODE_FB_QUIET;
 525 OUTPUT:
 526     RETVAL
 527
 528 int
 529 FB_WARN()
 530 CODE:
 531     RETVAL = ENCODE_FB_WARN;
 532 OUTPUT:
 533     RETVAL
 534
 535 int
 536 FB_PERLQQ()
 537 CODE:
 538     RETVAL = ENCODE_FB_PERLQQ;
 539 OUTPUT:
 540     RETVAL
 541
 542 int
 543 FB_HTMLCREF()
 544 CODE:
 545     RETVAL = ENCODE_FB_HTMLCREF;
 546 OUTPUT:
 547     RETVAL
 548
 549 int
 550 FB_XMLCREF()
 551 CODE:
 552     RETVAL = ENCODE_FB_XMLCREF;
 553 OUTPUT:
 554     RETVAL
 555
 556 BOOT:
 557 {
 558 #include "def_t.h"
 559 #include "def_t.exh"
 560 }