ext/Encode/Encode.xs

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