ext/Encode/Encode.xs

   1 /*
   2  $Id: Encode.xs,v 1.39 2002/04/26 03:02:04 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 # define PERLIO_FILENAME "PerlIO/encoding.pm"
  12
  13 /* set 1 or more to profile.  t/encoding.t dumps core because of
  14    Perl_warner and PerlIO don't work well */
  15 #define ENCODE_XS_PROFILE 0
  16
  17 /* set 0 to disable floating point to calculate buffer size for
  18    encode_method().  1 is recommended. 2 restores NI-S original */
  19 #define ENCODE_XS_USEFP   1
  20
  21 #define UNIMPLEMENTED(x,y) y x (SV *sv, char *encoding) {dTHX;   \
  22                          Perl_croak(aTHX_ "panic_unimplemented"); \
  23                          return (y)0; /* fool picky compilers */ \
  24                          }
  25 /**/
  26
  27 UNIMPLEMENTED(_encoded_utf8_to_bytes, I32)
  28 UNIMPLEMENTED(_encoded_bytes_to_utf8, I32)
  29
  30 void
  31 Encode_XSEncoding(pTHX_ encode_t * enc)
  32 {
  33     dSP;
  34     HV *stash = gv_stashpv("Encode::XS", TRUE);
  35     SV *sv = sv_bless(newRV_noinc(newSViv(PTR2IV(enc))), stash);
  36     int i = 0;
  37     PUSHMARK(sp);
  38     XPUSHs(sv);
  39     while (enc->name[i]) {
  40         const char *name = enc->name[i++];
  41         XPUSHs(sv_2mortal(newSVpvn(name, strlen(name))));
  42     }
  43     PUTBACK;
  44     call_pv("Encode::define_encoding", G_DISCARD);
  45     SvREFCNT_dec(sv);
  46 }
  47
  48 void
  49 call_failure(SV * routine, U8 * done, U8 * dest, U8 * orig)
  50 {
  51     /* Exists for breakpointing */
  52 }
  53
  54
  55 static SV *
  56 encode_method(pTHX_ encode_t * enc, encpage_t * dir, SV * src,
  57               int check)
  58 {
  59     STRLEN slen;
  60     U8 *s = (U8 *) SvPV(src, slen);
  61     STRLEN tlen  = slen;
  62     STRLEN ddone = 0;
  63     STRLEN sdone = 0;
  64
  65     /* We allocate slen+1.
  66        PerlIO dumps core if this value is smaller than this. */
  67     SV *dst = sv_2mortal(newSV(slen+1));
  68     U8 *d = (U8 *)SvPVX(dst);
  69     STRLEN dlen = SvLEN(dst)-1;
  70     int code;
  71
  72     if (!slen){
  73         SvCUR_set(dst, 0);
  74         SvPOK_only(dst);
  75         goto ENCODE_END;
  76     }
  77
  78     while (code = do_encode(dir, s, &slen, d, dlen, &dlen, !check))
  79     {
  80         SvCUR_set(dst, dlen+ddone);
  81         SvPOK_only(dst);
  82
  83         if (code == ENCODE_FALLBACK || code == ENCODE_PARTIAL){
  84             break;
  85         }
  86         switch (code) {
  87         case ENCODE_NOSPACE:
  88         {
  89             STRLEN more = 0; /* make sure you initialize! */
  90             STRLEN sleft;
  91             sdone += slen;
  92             ddone += dlen;
  93             sleft = tlen - sdone;
  94 #if ENCODE_XS_PROFILE >= 2
  95             Perl_warn(aTHX_
  96                       "more=%d, sdone=%d, sleft=%d, SvLEN(dst)=%d\n",
  97                       more, sdone, sleft, SvLEN(dst));
  98 #endif
  99             if (sdone != 0) { /* has src ever been processed ? */
 100 #if   ENCODE_XS_USEFP == 2
 101                 more = (1.0*tlen*SvLEN(dst)+sdone-1)/sdone
 102                     - SvLEN(dst);
 103 #elif ENCODE_XS_USEFP
 104                 more = (1.0*SvLEN(dst)+1)/sdone * sleft;
 105 #else
 106                 /* safe until SvLEN(dst) == MAX_INT/16 */
 107                 more = (16*SvLEN(dst)+1)/sdone/16 * sleft;
 108 #endif
 109             }
 110             more += UTF8_MAXLEN; /* insurance policy */
 111             d = (U8 *) SvGROW(dst, SvLEN(dst) + more);
 112             /* dst need to grow need MORE bytes! */
 113             if (ddone >= SvLEN(dst)) {
 114                 Perl_croak(aTHX_ "Destination couldn't be grown.");
 115             }
 116             dlen = SvLEN(dst)-ddone-1;
 117             d   += ddone;
 118             s   += slen;
 119             slen = tlen-sdone;
 120             continue;
 121         }
 122         case ENCODE_NOREP:
 123             /* encoding */
 124             if (dir == enc->f_utf8) {
 125                 STRLEN clen;
 126                 UV ch =
 127                     utf8n_to_uvuni(s+slen, (SvCUR(src)-slen),
 128                                    &clen, UTF8_ALLOW_ANY|UTF8_CHECK_ONLY);
 129                 if (check & ENCODE_DIE_ON_ERR) {
 130                     Perl_croak(
 131                         aTHX_ "\"\\N{U+%" UVxf "}\" does not map to %s, %d",
 132                         ch, enc->name[0], __LINE__);
 133                 }else{
 134                     if (check & ENCODE_RETURN_ON_ERR){
 135                         if (check & ENCODE_WARN_ON_ERR){
 136                             Perl_warner(
 137                                 aTHX_ packWARN(WARN_UTF8),
 138                                 "\"\\N{U+%" UVxf "}\" does not map to %s",
 139                                 ch,enc->name[0]);
 140                         }
 141                         goto ENCODE_SET_SRC;
 142                     }else if (check & ENCODE_PERLQQ){
 143                         SV* perlqq =
 144                             sv_2mortal(newSVpvf("\\x{%04"UVxf"}", ch));
 145                         sdone += slen + clen;
 146                         ddone += dlen + SvCUR(perlqq);
 147                         sv_catsv(dst, perlqq);
 148                     }else if (check & ENCODE_HTMLCREF){
 149                         SV* htmlcref =
 150                             sv_2mortal(newSVpvf("&#%" UVuf ";", ch));
 151                         sdone += slen + clen;
 152                         ddone += dlen + SvCUR(htmlcref);
 153                         sv_catsv(dst, htmlcref);
 154                     }else if (check & ENCODE_XMLCREF){
 155                         SV* xmlcref =
 156                             sv_2mortal(newSVpvf("&#x%" UVxf ";", ch));
 157                         sdone += slen + clen;
 158                         ddone += dlen + SvCUR(xmlcref);
 159                         sv_catsv(dst, xmlcref);
 160                     } else {
 161                         /* fallback char */
 162                         sdone += slen + clen;
 163                         ddone += dlen + enc->replen;
 164                         sv_catpvn(dst, (char*)enc->rep, enc->replen);
 165                     }
 166                 }
 167             }
 168             /* decoding */
 169             else {
 170                 if (check & ENCODE_DIE_ON_ERR){
 171                     Perl_croak(
 172                         aTHX_ "%s \"\\x%02X\" does not map to Unicode (%d)",
 173                         enc->name[0], (U8) s[slen], code);
 174                 }else{
 175                     if (check & ENCODE_RETURN_ON_ERR){
 176                         if (check & ENCODE_WARN_ON_ERR){
 177                             Perl_warner(
 178                                 aTHX_ packWARN(WARN_UTF8),
 179                                 "%s \"\\x%02X\" does not map to Unicode (%d)",
 180                                 enc->name[0], (U8) s[slen], code);
 181                         }
 182                         goto ENCODE_SET_SRC;
 183                     }else if (check &
 184                               (ENCODE_PERLQQ|ENCODE_HTMLCREF|ENCODE_XMLCREF)){
 185                         SV* perlqq =
 186                             sv_2mortal(newSVpvf("\\x%02X", s[slen]));
 187                         sdone += slen + 1;
 188                         ddone += dlen + SvCUR(perlqq);
 189                         sv_catsv(dst, perlqq);
 190                     } else {
 191                         sdone += slen + 1;
 192                         ddone += dlen + strlen(FBCHAR_UTF8);
 193                         sv_catpv(dst, FBCHAR_UTF8);
 194                     }
 195                 }
 196             }
 197             /* settle variables when fallback */
 198             d    = (U8 *)SvEND(dst);
 199             dlen = SvLEN(dst) - ddone - 1;
 200             s    = (U8*)SvPVX(src) + sdone;
 201             slen = tlen - sdone;
 202             break;
 203
 204         default:
 205             Perl_croak(aTHX_ "Unexpected code %d converting %s %s",
 206                        code, (dir == enc->f_utf8) ? "to" : "from",
 207                        enc->name[0]);
 208             return &PL_sv_undef;
 209         }
 210     }
 211  ENCODE_SET_SRC:
 212     if (check && !(check & ENCODE_LEAVE_SRC)){
 213         sdone = SvCUR(src) - (slen+sdone);
 214         if (sdone) {
 215             sv_setpvn(src, (char*)s+slen, sdone);
 216         }
 217         SvCUR_set(src, sdone);
 218     }
 219     /* warn("check = 0x%X, code = 0x%d\n", check, code); */
 220     if (code && !(check & ENCODE_RETURN_ON_ERR)) {
 221         return &PL_sv_undef;
 222     }
 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     if (hv_exists(get_hv("INC", 0),
 299                   PERLIO_FILENAME, strlen(PERLIO_FILENAME)))
 300     {
 301         ST(0) = &PL_sv_yes;
 302     }else{
 303         ST(0) = &PL_sv_no;
 304     }
 305     XSRETURN(1);
 306 }
 307
 308 MODULE = Encode         PACKAGE = Encode
 309
 310 PROTOTYPES: ENABLE
 311
 312 I32
 313 _bytes_to_utf8(sv, ...)
 314 SV *    sv
 315 CODE:
 316 {
 317     SV * encoding = items == 2 ? ST(1) : Nullsv;
 318
 319     if (encoding)
 320     RETVAL = _encoded_bytes_to_utf8(sv, SvPV_nolen(encoding));
 321     else {
 322         STRLEN len;
 323         U8*    s = (U8*)SvPV(sv, len);
 324         U8*    converted;
 325
 326         converted = bytes_to_utf8(s, &len); /* This allocs */
 327         sv_setpvn(sv, (char *)converted, len);
 328         SvUTF8_on(sv); /* XXX Should we? */
 329         Safefree(converted);                /* ... so free it */
 330         RETVAL = len;
 331     }
 332 }
 333 OUTPUT:
 334     RETVAL
 335
 336 I32
 337 _utf8_to_bytes(sv, ...)
 338 SV *    sv
 339 CODE:
 340 {
 341     SV * to    = items > 1 ? ST(1) : Nullsv;
 342     SV * check = items > 2 ? ST(2) : Nullsv;
 343
 344     if (to) {
 345         RETVAL = _encoded_utf8_to_bytes(sv, SvPV_nolen(to));
 346     } else {
 347         STRLEN len;
 348         U8 *s = (U8*)SvPV(sv, len);
 349
 350         RETVAL = 0;
 351         if (SvTRUE(check)) {
 352             /* Must do things the slow way */
 353             U8 *dest;
 354             /* We need a copy to pass to check() */
 355             U8 *src  = (U8*)savepv((char *)s);
 356             U8 *send = s + len;
 357
 358             New(83, dest, len, U8); /* I think */
 359
 360             while (s < send) {
 361                 if (*s < 0x80){
 362                     *dest++ = *s++;
 363                 } else {
 364                     STRLEN ulen;
 365                     UV uv = *s++;
 366
 367                     /* Have to do it all ourselves because of error routine,
 368                        aargh. */
 369                     if (!(uv & 0x40)){ goto failure; }
 370                     if      (!(uv & 0x20)) { ulen = 2;  uv &= 0x1f; }
 371                     else if (!(uv & 0x10)) { ulen = 3;  uv &= 0x0f; }
 372                     else if (!(uv & 0x08)) { ulen = 4;  uv &= 0x07; }
 373                     else if (!(uv & 0x04)) { ulen = 5;  uv &= 0x03; }
 374                     else if (!(uv & 0x02)) { ulen = 6;  uv &= 0x01; }
 375                     else if (!(uv & 0x01)) { ulen = 7;  uv = 0; }
 376                     else                   { ulen = 13; uv = 0; }
 377
 378                     /* Note change to utf8.c variable naming, for variety */
 379                     while (ulen--) {
 380                         if ((*s & 0xc0) != 0x80){
 381                             goto failure;
 382                         } else {
 383                             uv = (uv << 6) | (*s++ & 0x3f);
 384                         }
 385                   }
 386                   if (uv > 256) {
 387                   failure:
 388                       call_failure(check, s, dest, src);
 389                       /* Now what happens? */
 390                   }
 391                   *dest++ = (U8)uv;
 392                 }
 393             }
 394         } else {
 395             RETVAL = (utf8_to_bytes(s, &len) ? len : 0);
 396         }
 397     }
 398 }
 399 OUTPUT:
 400     RETVAL
 401
 402 bool
 403 is_utf8(sv, check = 0)
 404 SV *    sv
 405 int     check
 406 CODE:
 407 {
 408     if (SvGMAGICAL(sv)) /* it could be $1, for example */
 409         sv = newSVsv(sv); /* GMAGIG will be done */
 410     if (SvPOK(sv)) {
 411         RETVAL = SvUTF8(sv) ? TRUE : FALSE;
 412         if (RETVAL &&
 413             check  &&
 414             !is_utf8_string((U8*)SvPVX(sv), SvCUR(sv)))
 415             RETVAL = FALSE;
 416     } else {
 417         RETVAL = FALSE;
 418     }
 419     if (sv != ST(0))
 420         SvREFCNT_dec(sv); /* it was a temp copy */
 421 }
 422 OUTPUT:
 423     RETVAL
 424
 425 SV *
 426 _utf8_on(sv)
 427 SV *    sv
 428 CODE:
 429 {
 430     if (SvPOK(sv)) {
 431         SV *rsv = newSViv(SvUTF8(sv));
 432         RETVAL = rsv;
 433         SvUTF8_on(sv);
 434     } else {
 435         RETVAL = &PL_sv_undef;
 436     }
 437 }
 438 OUTPUT:
 439     RETVAL
 440
 441 SV *
 442 _utf8_off(sv)
 443 SV *    sv
 444 CODE:
 445 {
 446     if (SvPOK(sv)) {
 447         SV *rsv = newSViv(SvUTF8(sv));
 448         RETVAL = rsv;
 449         SvUTF8_off(sv);
 450     } else {
 451         RETVAL = &PL_sv_undef;
 452     }
 453 }
 454 OUTPUT:
 455     RETVAL
 456
 457 int
 458 DIE_ON_ERR()
 459 CODE:
 460     RETVAL = ENCODE_DIE_ON_ERR;
 461 OUTPUT:
 462     RETVAL
 463
 464 int
 465 WARN_ON_ERR()
 466 CODE:
 467     RETVAL = ENCODE_WARN_ON_ERR;
 468 OUTPUT:
 469     RETVAL
 470
 471 int
 472 LEAVE_SRC()
 473 CODE:
 474     RETVAL = ENCODE_LEAVE_SRC;
 475 OUTPUT:
 476     RETVAL
 477
 478 int
 479 RETURN_ON_ERR()
 480 CODE:
 481     RETVAL = ENCODE_RETURN_ON_ERR;
 482 OUTPUT:
 483     RETVAL
 484
 485 int
 486 PERLQQ()
 487 CODE:
 488     RETVAL = ENCODE_PERLQQ;
 489 OUTPUT:
 490     RETVAL
 491
 492 int
 493 HTMLCREF()
 494 CODE:
 495     RETVAL = ENCODE_HTMLCREF;
 496 OUTPUT:
 497     RETVAL
 498
 499 int
 500 XMLCREF()
 501 CODE:
 502     RETVAL = ENCODE_XMLCREF;
 503 OUTPUT:
 504     RETVAL
 505
 506 int
 507 FB_DEFAULT()
 508 CODE:
 509     RETVAL = ENCODE_FB_DEFAULT;
 510 OUTPUT:
 511     RETVAL
 512
 513 int
 514 FB_CROAK()
 515 CODE:
 516     RETVAL = ENCODE_FB_CROAK;
 517 OUTPUT:
 518     RETVAL
 519
 520 int
 521 FB_QUIET()
 522 CODE:
 523     RETVAL = ENCODE_FB_QUIET;
 524 OUTPUT:
 525     RETVAL
 526
 527 int
 528 FB_WARN()
 529 CODE:
 530     RETVAL = ENCODE_FB_WARN;
 531 OUTPUT:
 532     RETVAL
 533
 534 int
 535 FB_PERLQQ()
 536 CODE:
 537     RETVAL = ENCODE_FB_PERLQQ;
 538 OUTPUT:
 539     RETVAL
 540
 541 int
 542 FB_HTMLCREF()
 543 CODE:
 544     RETVAL = ENCODE_FB_HTMLCREF;
 545 OUTPUT:
 546     RETVAL
 547
 548 int
 549 FB_XMLCREF()
 550 CODE:
 551     RETVAL = ENCODE_FB_XMLCREF;
 552 OUTPUT:
 553     RETVAL
 554
 555 BOOT:
 556 {
 557 #include "def_t.h"
 558 #include "def_t.exh"
 559 }