ext/Encode/Encode.xs

   1 /*
   2  $Id: Encode.xs,v 1.41 2002/04/27 18:59:50 dankogai Exp $
   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 static SV *
  58 encode_method(pTHX_ encode_t * enc, encpage_t * dir, SV * src,
  59               int check)
  60 {
  61     STRLEN slen;
  62     U8 *s = (U8 *) SvPV(src, slen);
  63     STRLEN tlen  = slen;
  64     STRLEN ddone = 0;
  65     STRLEN sdone = 0;
  66
  67     /* We allocate slen+1.
  68        PerlIO dumps core if this value is smaller than this. */
  69     SV *dst = sv_2mortal(newSV(slen+1));
  70     U8 *d = (U8 *)SvPVX(dst);
  71     STRLEN dlen = SvLEN(dst)-1;
  72     int code;
  73
  74     if (!slen){
  75         SvCUR_set(dst, 0);
  76         SvPOK_only(dst);
  77         goto ENCODE_END;
  78     }
  79
  80     while (code = do_encode(dir, s, &slen, d, dlen, &dlen, !check))
  81     {
  82         SvCUR_set(dst, dlen+ddone);
  83         SvPOK_only(dst);
  84
  85         if (code == ENCODE_FALLBACK || code == ENCODE_PARTIAL){
  86             break;
  87         }
  88         switch (code) {
  89         case ENCODE_NOSPACE:
  90         {
  91             STRLEN more = 0; /* make sure you initialize! */
  92             STRLEN sleft;
  93             sdone += slen;
  94             ddone += dlen;
  95             sleft = tlen - sdone;
  96 #if ENCODE_XS_PROFILE >= 2
  97             Perl_warn(aTHX_
  98                       "more=%d, sdone=%d, sleft=%d, SvLEN(dst)=%d\n",
  99                       more, sdone, sleft, SvLEN(dst));
 100 #endif
 101             if (sdone != 0) { /* has src ever been processed ? */
 102 #if   ENCODE_XS_USEFP == 2
 103                 more = (1.0*tlen*SvLEN(dst)+sdone-1)/sdone
 104                     - SvLEN(dst);
 105 #elif ENCODE_XS_USEFP
 106                 more = (1.0*SvLEN(dst)+1)/sdone * sleft;
 107 #else
 108                 /* safe until SvLEN(dst) == MAX_INT/16 */
 109                 more = (16*SvLEN(dst)+1)/sdone/16 * sleft;
 110 #endif
 111             }
 112             more += UTF8_MAXLEN; /* insurance policy */
 113             d = (U8 *) SvGROW(dst, SvLEN(dst) + more);
 114             /* dst need to grow need MORE bytes! */
 115             if (ddone >= SvLEN(dst)) {
 116                 Perl_croak(aTHX_ "Destination couldn't be grown.");
 117             }
 118             dlen = SvLEN(dst)-ddone-1;
 119             d   += ddone;
 120             s   += slen;
 121             slen = tlen-sdone;
 122             continue;
 123         }
 124         case ENCODE_NOREP:
 125             /* encoding */
 126             if (dir == enc->f_utf8) {
 127                 STRLEN clen;
 128                 UV ch =
 129                     utf8n_to_uvuni(s+slen, (SvCUR(src)-slen),
 130                                    &clen, UTF8_ALLOW_ANY|UTF8_CHECK_ONLY);
 131                 if (check & ENCODE_DIE_ON_ERR) {
 132                     Perl_croak(
 133                         aTHX_ "\"\\N{U+%" UVxf "}\" does not map to %s, %d",
 134                         ch, enc->name[0], __LINE__);
 135                 }else{
 136                     if (check & ENCODE_RETURN_ON_ERR){
 137                         if (check & ENCODE_WARN_ON_ERR){
 138                             Perl_warner(
 139                                 aTHX_ packWARN(WARN_UTF8),
 140                                 "\"\\N{U+%" UVxf "}\" does not map to %s",
 141                                 ch,enc->name[0]);
 142                         }
 143                         goto ENCODE_SET_SRC;
 144                     }else if (check & ENCODE_PERLQQ){
 145                         SV* perlqq =
 146                             sv_2mortal(newSVpvf("\\x{%04"UVxf"}", ch));
 147                         sdone += slen + clen;
 148                         ddone += dlen + SvCUR(perlqq);
 149                         sv_catsv(dst, perlqq);
 150                     }else if (check & ENCODE_HTMLCREF){
 151                         SV* htmlcref =
 152                             sv_2mortal(newSVpvf("&#%" UVuf ";", ch));
 153                         sdone += slen + clen;
 154                         ddone += dlen + SvCUR(htmlcref);
 155                         sv_catsv(dst, htmlcref);
 156                     }else if (check & ENCODE_XMLCREF){
 157                         SV* xmlcref =
 158                             sv_2mortal(newSVpvf("&#x%" UVxf ";", ch));
 159                         sdone += slen + clen;
 160                         ddone += dlen + SvCUR(xmlcref);
 161                         sv_catsv(dst, xmlcref);
 162                     } else {
 163                         /* fallback char */
 164                         sdone += slen + clen;
 165                         ddone += dlen + enc->replen;
 166                         sv_catpvn(dst, (char*)enc->rep, enc->replen);
 167                     }
 168                 }
 169             }
 170             /* decoding */
 171             else {
 172                 if (check & ENCODE_DIE_ON_ERR){
 173                     Perl_croak(
 174                         aTHX_ "%s \"\\x%02" UVXf
 175                         "\" does not map to Unicode (%d)",
 176                         enc->name[0], (U8) s[slen], code);
 177                 }else{
 178                     if (check & ENCODE_RETURN_ON_ERR){
 179                         if (check & ENCODE_WARN_ON_ERR){
 180                             Perl_warner(
 181                                 aTHX_ packWARN(WARN_UTF8),
 182                                 "%s \"\\x%02" UVXf
 183                                 "\" does not map to Unicode (%d)",
 184                                 enc->name[0], (U8) s[slen], code);
 185                         }
 186                         goto ENCODE_SET_SRC;
 187                     }else if (check &
 188                               (ENCODE_PERLQQ|ENCODE_HTMLCREF|ENCODE_XMLCREF)){
 189                         SV* perlqq =
 190                             sv_2mortal(newSVpvf("\\x%02" UVXf, 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             }
 201             /* settle variables when fallback */
 202             d    = (U8 *)SvEND(dst);
 203             dlen = SvLEN(dst) - ddone - 1;
 204             s    = (U8*)SvPVX(src) + sdone;
 205             slen = tlen - sdone;
 206             break;
 207
 208         default:
 209             Perl_croak(aTHX_ "Unexpected code %d converting %s %s",
 210                        code, (dir == enc->f_utf8) ? "to" : "from",
 211                        enc->name[0]);
 212             return &PL_sv_undef;
 213         }
 214     }
 215  ENCODE_SET_SRC:
 216     if (check && !(check & ENCODE_LEAVE_SRC)){
 217         sdone = SvCUR(src) - (slen+sdone);
 218         if (sdone) {
 219             sv_setpvn(src, (char*)s+slen, sdone);
 220         }
 221         SvCUR_set(src, sdone);
 222     }
 223     /* warn("check = 0x%X, code = 0x%d\n", check, code); */
 224
 225     SvCUR_set(dst, dlen+ddone);
 226     SvPOK_only(dst);
 227
 228 #if ENCODE_XS_PROFILE
 229     if (SvCUR(dst) > SvCUR(src)){
 230         Perl_warn(aTHX_
 231                   "SvLEN(dst)=%d, SvCUR(dst)=%d. %d bytes unused(%f %%)\n",
 232                   SvLEN(dst), SvCUR(dst), SvLEN(dst) - SvCUR(dst),
 233                   (SvLEN(dst) - SvCUR(dst))*1.0/SvLEN(dst)*100.0);
 234     }
 235 #endif
 236
 237  ENCODE_END:
 238     *SvEND(dst) = '\0';
 239     return dst;
 240 }
 241
 242 MODULE = Encode         PACKAGE = Encode::XS    PREFIX = Method_
 243
 244 PROTOTYPES: ENABLE
 245
 246 void
 247 Method_name(obj)
 248 SV *    obj
 249 CODE:
 250 {
 251     encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj)));
 252     ST(0) = sv_2mortal(newSVpvn(enc->name[0],strlen(enc->name[0])));
 253     XSRETURN(1);
 254 }
 255
 256 void
 257 Method_decode(obj,src,check = 0)
 258 SV *    obj
 259 SV *    src
 260 int     check
 261 CODE:
 262 {
 263     encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj)));
 264     ST(0) = encode_method(aTHX_ enc, enc->t_utf8, src, check);
 265     SvUTF8_on(ST(0));
 266     XSRETURN(1);
 267 }
 268
 269 void
 270 Method_encode(obj,src,check = 0)
 271 SV *    obj
 272 SV *    src
 273 int     check
 274 CODE:
 275 {
 276     encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj)));
 277     sv_utf8_upgrade(src);
 278     ST(0) = encode_method(aTHX_ enc, enc->f_utf8, src, check);
 279     XSRETURN(1);
 280 }
 281
 282 void
 283 Method_needs_lines(obj)
 284 SV *    obj
 285 CODE:
 286 {
 287     encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj)));
 288     ST(0) = &PL_sv_no;
 289     XSRETURN(1);
 290 }
 291
 292 void
 293 Method_perlio_ok(obj)
 294 SV *    obj
 295 CODE:
 296 {
 297     encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj)));
 298     /* require_pv(PERLIO_FILENAME); */
 299
 300     eval_pv("require PerlIO::encoding", 0);
 301
 302     if (SvTRUE(get_sv("@", 0))) {
 303         ST(0) = &PL_sv_no;
 304     }else{
 305         ST(0) = &PL_sv_yes;
 306     }
 307     XSRETURN(1);
 308 }
 309
 310 MODULE = Encode         PACKAGE = Encode
 311
 312 PROTOTYPES: ENABLE
 313
 314 I32
 315 _bytes_to_utf8(sv, ...)
 316 SV *    sv
 317 CODE:
 318 {
 319     SV * encoding = items == 2 ? ST(1) : Nullsv;
 320
 321     if (encoding)
 322     RETVAL = _encoded_bytes_to_utf8(sv, SvPV_nolen(encoding));
 323     else {
 324         STRLEN len;
 325         U8*    s = (U8*)SvPV(sv, len);
 326         U8*    converted;
 327
 328         converted = bytes_to_utf8(s, &len); /* This allocs */
 329         sv_setpvn(sv, (char *)converted, len);
 330         SvUTF8_on(sv); /* XXX Should we? */
 331         Safefree(converted);                /* ... so free it */
 332         RETVAL = len;
 333     }
 334 }
 335 OUTPUT:
 336     RETVAL
 337
 338 I32
 339 _utf8_to_bytes(sv, ...)
 340 SV *    sv
 341 CODE:
 342 {
 343     SV * to    = items > 1 ? ST(1) : Nullsv;
 344     SV * check = items > 2 ? ST(2) : Nullsv;
 345
 346     if (to) {
 347         RETVAL = _encoded_utf8_to_bytes(sv, SvPV_nolen(to));
 348     } else {
 349         STRLEN len;
 350         U8 *s = (U8*)SvPV(sv, len);
 351
 352         RETVAL = 0;
 353         if (SvTRUE(check)) {
 354             /* Must do things the slow way */
 355             U8 *dest;
 356             /* We need a copy to pass to check() */
 357             U8 *src  = (U8*)savepv((char *)s);
 358             U8 *send = s + len;
 359
 360             New(83, dest, len, U8); /* I think */
 361
 362             while (s < send) {
 363                 if (*s < 0x80){
 364                     *dest++ = *s++;
 365                 } else {
 366                     STRLEN ulen;
 367                     UV uv = *s++;
 368
 369                     /* Have to do it all ourselves because of error routine,
 370                        aargh. */
 371                     if (!(uv & 0x40)){ goto failure; }
 372                     if      (!(uv & 0x20)) { ulen = 2;  uv &= 0x1f; }
 373                     else if (!(uv & 0x10)) { ulen = 3;  uv &= 0x0f; }
 374                     else if (!(uv & 0x08)) { ulen = 4;  uv &= 0x07; }
 375                     else if (!(uv & 0x04)) { ulen = 5;  uv &= 0x03; }
 376                     else if (!(uv & 0x02)) { ulen = 6;  uv &= 0x01; }
 377                     else if (!(uv & 0x01)) { ulen = 7;  uv = 0; }
 378                     else                   { ulen = 13; uv = 0; }
 379
 380                     /* Note change to utf8.c variable naming, for variety */
 381                     while (ulen--) {
 382                         if ((*s & 0xc0) != 0x80){
 383                             goto failure;
 384                         } else {
 385                             uv = (uv << 6) | (*s++ & 0x3f);
 386                         }
 387                   }
 388                   if (uv > 256) {
 389                   failure:
 390                       call_failure(check, s, dest, src);
 391                       /* Now what happens? */
 392                   }
 393                   *dest++ = (U8)uv;
 394                 }
 395             }
 396         } else {
 397             RETVAL = (utf8_to_bytes(s, &len) ? len : 0);
 398         }
 399     }
 400 }
 401 OUTPUT:
 402     RETVAL
 403
 404 bool
 405 is_utf8(sv, check = 0)
 406 SV *    sv
 407 int     check
 408 CODE:
 409 {
 410     if (SvGMAGICAL(sv)) /* it could be $1, for example */
 411         sv = newSVsv(sv); /* GMAGIG will be done */
 412     if (SvPOK(sv)) {
 413         RETVAL = SvUTF8(sv) ? TRUE : FALSE;
 414         if (RETVAL &&
 415             check  &&
 416             !is_utf8_string((U8*)SvPVX(sv), SvCUR(sv)))
 417             RETVAL = FALSE;
 418     } else {
 419         RETVAL = FALSE;
 420     }
 421     if (sv != ST(0))
 422         SvREFCNT_dec(sv); /* it was a temp copy */
 423 }
 424 OUTPUT:
 425     RETVAL
 426
 427 SV *
 428 _utf8_on(sv)
 429 SV *    sv
 430 CODE:
 431 {
 432     if (SvPOK(sv)) {
 433         SV *rsv = newSViv(SvUTF8(sv));
 434         RETVAL = rsv;
 435         SvUTF8_on(sv);
 436     } else {
 437         RETVAL = &PL_sv_undef;
 438     }
 439 }
 440 OUTPUT:
 441     RETVAL
 442
 443 SV *
 444 _utf8_off(sv)
 445 SV *    sv
 446 CODE:
 447 {
 448     if (SvPOK(sv)) {
 449         SV *rsv = newSViv(SvUTF8(sv));
 450         RETVAL = rsv;
 451         SvUTF8_off(sv);
 452     } else {
 453         RETVAL = &PL_sv_undef;
 454     }
 455 }
 456 OUTPUT:
 457     RETVAL
 458
 459 int
 460 DIE_ON_ERR()
 461 CODE:
 462     RETVAL = ENCODE_DIE_ON_ERR;
 463 OUTPUT:
 464     RETVAL
 465
 466 int
 467 WARN_ON_ERR()
 468 CODE:
 469     RETVAL = ENCODE_WARN_ON_ERR;
 470 OUTPUT:
 471     RETVAL
 472
 473 int
 474 LEAVE_SRC()
 475 CODE:
 476     RETVAL = ENCODE_LEAVE_SRC;
 477 OUTPUT:
 478     RETVAL
 479
 480 int
 481 RETURN_ON_ERR()
 482 CODE:
 483     RETVAL = ENCODE_RETURN_ON_ERR;
 484 OUTPUT:
 485     RETVAL
 486
 487 int
 488 PERLQQ()
 489 CODE:
 490     RETVAL = ENCODE_PERLQQ;
 491 OUTPUT:
 492     RETVAL
 493
 494 int
 495 HTMLCREF()
 496 CODE:
 497     RETVAL = ENCODE_HTMLCREF;
 498 OUTPUT:
 499     RETVAL
 500
 501 int
 502 XMLCREF()
 503 CODE:
 504     RETVAL = ENCODE_XMLCREF;
 505 OUTPUT:
 506     RETVAL
 507
 508 int
 509 FB_DEFAULT()
 510 CODE:
 511     RETVAL = ENCODE_FB_DEFAULT;
 512 OUTPUT:
 513     RETVAL
 514
 515 int
 516 FB_CROAK()
 517 CODE:
 518     RETVAL = ENCODE_FB_CROAK;
 519 OUTPUT:
 520     RETVAL
 521
 522 int
 523 FB_QUIET()
 524 CODE:
 525     RETVAL = ENCODE_FB_QUIET;
 526 OUTPUT:
 527     RETVAL
 528
 529 int
 530 FB_WARN()
 531 CODE:
 532     RETVAL = ENCODE_FB_WARN;
 533 OUTPUT:
 534     RETVAL
 535
 536 int
 537 FB_PERLQQ()
 538 CODE:
 539     RETVAL = ENCODE_FB_PERLQQ;
 540 OUTPUT:
 541     RETVAL
 542
 543 int
 544 FB_HTMLCREF()
 545 CODE:
 546     RETVAL = ENCODE_FB_HTMLCREF;
 547 OUTPUT:
 548     RETVAL
 549
 550 int
 551 FB_XMLCREF()
 552 CODE:
 553     RETVAL = ENCODE_FB_XMLCREF;
 554 OUTPUT:
 555     RETVAL
 556
 557 BOOT:
 558 {
 559 #include "def_t.h"
 560 #include "def_t.exh"
 561 }