2 $Id: Encode.xs,v 2.16 2009/09/06 14:32:21 dankogai Exp dankogai $
5 #define PERL_NO_GET_CONTEXT
12 # define PERLIO_MODNAME "PerlIO::encoding"
13 # define PERLIO_FILENAME "PerlIO/encoding.pm"
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
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
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 */ \
29 UNIMPLEMENTED(_encoded_utf8_to_bytes, I32)
30 UNIMPLEMENTED(_encoded_bytes_to_utf8, I32)
32 #define UTF8_ALLOW_STRICT 0
33 #define UTF8_ALLOW_NONSTRICT (UTF8_ALLOW_ANY & \
34 ~(UTF8_ALLOW_CONTINUATION | \
35 UTF8_ALLOW_NON_CONTINUATION | \
39 Encode_XSEncoding(pTHX_ encode_t * enc)
42 HV *stash = gv_stashpv("Encode::XS", TRUE);
43 SV *sv = sv_bless(newRV_noinc(newSViv(PTR2IV(enc))), stash);
47 while (enc->name[i]) {
48 const char *name = enc->name[i++];
49 XPUSHs(sv_2mortal(newSVpvn(name, strlen(name))));
52 call_pv("Encode::define_encoding", G_DISCARD);
57 call_failure(SV * routine, U8 * done, U8 * dest, U8 * orig)
59 /* Exists for breakpointing */
63 #define ERR_ENCODE_NOMAP "\"\\x{%04" UVxf "}\" does not map to %s"
64 #define ERR_DECODE_NOMAP "%s \"\\x%02" UVXf "\" does not map to Unicode"
67 do_fallback_cb(pTHX_ UV ch, SV *fallback_cb)
75 XPUSHs(sv_2mortal(newSVnv((UV)ch)));
77 argc = call_sv(fallback_cb, G_SCALAR);
80 croak("fallback sub must return scalar!");
86 retval = newSVpv("",0);
87 sv_catsv(retval, temp);
93 encode_method(pTHX_ const encode_t * enc, const encpage_t * dir, SV * src,
94 int check, STRLEN * offset, SV * term, int * retcode,
98 U8 *s = (U8 *) SvPV(src, slen);
103 /* We allocate slen+1.
104 PerlIO dumps core if this value is smaller than this. */
105 SV *dst = sv_2mortal(newSV(slen+1));
106 U8 *d = (U8 *)SvPVX(dst);
107 STRLEN dlen = SvLEN(dst)-1;
110 U8 *trm = term ? (U8*) SvPV(term, trmlen) : NULL;
114 if (slen > *offset){ /* safeguard against slen overflow */
128 while( (code = do_encode(dir, s, &slen, d, dlen, &dlen, !check,
131 SvCUR_set(dst, dlen+ddone);
134 if (code == ENCODE_FALLBACK || code == ENCODE_PARTIAL ||
135 code == ENCODE_FOUND_TERM) {
141 STRLEN more = 0; /* make sure you initialize! */
145 sleft = tlen - sdone;
146 #if ENCODE_XS_PROFILE >= 2
148 "more=%d, sdone=%d, sleft=%d, SvLEN(dst)=%d\n",
149 more, sdone, sleft, SvLEN(dst));
151 if (sdone != 0) { /* has src ever been processed ? */
152 #if ENCODE_XS_USEFP == 2
153 more = (1.0*tlen*SvLEN(dst)+sdone-1)/sdone
155 #elif ENCODE_XS_USEFP
156 more = (STRLEN)((1.0*SvLEN(dst)+1)/sdone * sleft);
158 /* safe until SvLEN(dst) == MAX_INT/16 */
159 more = (16*SvLEN(dst)+1)/sdone/16 * sleft;
162 more += UTF8_MAXLEN; /* insurance policy */
163 d = (U8 *) SvGROW(dst, SvLEN(dst) + more);
164 /* dst need to grow need MORE bytes! */
165 if (ddone >= SvLEN(dst)) {
166 Perl_croak(aTHX_ "Destination couldn't be grown.");
168 dlen = SvLEN(dst)-ddone-1;
176 if (dir == enc->f_utf8) {
179 utf8n_to_uvuni(s+slen, (SvCUR(src)-slen),
180 &clen, UTF8_ALLOW_ANY|UTF8_CHECK_ONLY);
181 /* if non-representable multibyte prefix at end of current buffer - break*/
182 if (clen > tlen - sdone) break;
183 if (check & ENCODE_DIE_ON_ERR) {
184 Perl_croak(aTHX_ ERR_ENCODE_NOMAP,
185 (UV)ch, enc->name[0]);
186 return &PL_sv_undef; /* never reaches but be safe */
188 if (check & ENCODE_WARN_ON_ERR){
189 Perl_warner(aTHX_ packWARN(WARN_UTF8),
190 ERR_ENCODE_NOMAP, (UV)ch, enc->name[0]);
192 if (check & ENCODE_RETURN_ON_ERR){
195 if (check & (ENCODE_PERLQQ|ENCODE_HTMLCREF|ENCODE_XMLCREF)){
197 (fallback_cb != &PL_sv_undef)
198 ? do_fallback_cb(aTHX_ ch, fallback_cb)
199 : newSVpvf(check & ENCODE_PERLQQ ? "\\x{%04"UVxf"}" :
200 check & ENCODE_HTMLCREF ? "&#%" UVuf ";" :
201 "&#x%" UVxf ";", (UV)ch);
202 sdone += slen + clen;
203 ddone += dlen + SvCUR(subchar);
204 sv_catsv(dst, subchar);
205 SvREFCNT_dec(subchar);
208 sdone += slen + clen;
209 ddone += dlen + enc->replen;
210 sv_catpvn(dst, (char*)enc->rep, enc->replen);
215 if (check & ENCODE_DIE_ON_ERR){
216 Perl_croak(aTHX_ ERR_DECODE_NOMAP,
217 enc->name[0], (UV)s[slen]);
218 return &PL_sv_undef; /* never reaches but be safe */
220 if (check & ENCODE_WARN_ON_ERR){
222 aTHX_ packWARN(WARN_UTF8),
224 enc->name[0], (UV)s[slen]);
226 if (check & ENCODE_RETURN_ON_ERR){
230 (ENCODE_PERLQQ|ENCODE_HTMLCREF|ENCODE_XMLCREF)){
232 (fallback_cb != &PL_sv_undef)
233 ? do_fallback_cb(aTHX_ (UV)s[slen], fallback_cb)
234 : newSVpvf("\\x%02" UVXf, (UV)s[slen]);
236 ddone += dlen + SvCUR(subchar);
237 sv_catsv(dst, subchar);
238 SvREFCNT_dec(subchar);
241 ddone += dlen + strlen(FBCHAR_UTF8);
242 sv_catpv(dst, FBCHAR_UTF8);
245 /* settle variables when fallback */
246 d = (U8 *)SvEND(dst);
247 dlen = SvLEN(dst) - ddone - 1;
248 s = (U8*)SvPVX(src) + sdone;
253 Perl_croak(aTHX_ "Unexpected code %d converting %s %s",
254 code, (dir == enc->f_utf8) ? "to" : "from",
260 if (check && !(check & ENCODE_LEAVE_SRC)){
261 sdone = SvCUR(src) - (slen+sdone);
263 sv_setpvn(src, (char*)s+slen, sdone);
265 SvCUR_set(src, sdone);
267 /* warn("check = 0x%X, code = 0x%d\n", check, code); */
269 SvCUR_set(dst, dlen+ddone);
272 #if ENCODE_XS_PROFILE
273 if (SvCUR(dst) > SvCUR(src)){
275 "SvLEN(dst)=%d, SvCUR(dst)=%d. %d bytes unused(%f %%)\n",
276 SvLEN(dst), SvCUR(dst), SvLEN(dst) - SvCUR(dst),
277 (SvLEN(dst) - SvCUR(dst))*1.0/SvLEN(dst)*100.0);
282 *offset += sdone + slen;
286 if (retcode) *retcode = code;
291 strict_utf8(pTHX_ SV* sv)
296 if (!sv || SvTYPE(sv) != SVt_PVHV)
299 svp = hv_fetch(hv, "strict_utf8", 11, 0);
306 process_utf8(pTHX_ SV* dst, U8* s, U8* e, int check,
307 bool encode, bool strict, bool stop_at_partial)
316 if (UTF8_IS_INVARIANT(*s)) {
317 sv_catpvn(dst, (char *)s, 1);
322 if (UTF8_IS_START(*s)) {
323 U8 skip = UTF8SKIP(s);
324 if ((s + skip) > e) {
325 /* Partial character */
326 /* XXX could check that rest of bytes are UTF8_IS_CONTINUATION(ch) */
327 if (stop_at_partial || (check & ENCODE_STOP_AT_PARTIAL))
333 uv = utf8n_to_uvuni(s, e - s, &ulen,
334 UTF8_CHECK_ONLY | (strict ? UTF8_ALLOW_STRICT :
335 UTF8_ALLOW_NONSTRICT)
337 #if 1 /* perl-5.8.6 and older do not check UTF8_ALLOW_LONG */
338 if (strict && uv > PERL_UNICODE_MAX)
343 uv = utf8n_to_uvuni(s, e - s, &ulen,
344 UTF8_CHECK_ONLY | UTF8_ALLOW_NONSTRICT);
353 /* Whole char is good */
354 sv_catpvn(dst,(char *)s,skip);
359 /* If we get here there is something wrong with alleged UTF-8 */
365 if (check & ENCODE_DIE_ON_ERR){
367 Perl_croak(aTHX_ ERR_ENCODE_NOMAP, uv, "utf8");
369 Perl_croak(aTHX_ ERR_DECODE_NOMAP, "utf8", uv);
371 if (check & ENCODE_WARN_ON_ERR){
373 Perl_warner(aTHX_ packWARN(WARN_UTF8),
374 ERR_ENCODE_NOMAP, uv, "utf8");
376 Perl_warner(aTHX_ packWARN(WARN_UTF8),
377 ERR_DECODE_NOMAP, "utf8", uv);
379 if (check & ENCODE_RETURN_ON_ERR) {
382 if (check & (ENCODE_PERLQQ|ENCODE_HTMLCREF|ENCODE_XMLCREF)){
383 SV* subchar = newSVpvf(check & ENCODE_PERLQQ ? (ulen == 1 ? "\\x%02" UVXf : "\\x{%04" UVXf "}"):
384 check & ENCODE_HTMLCREF ? "&#%" UVuf ";" :
385 "&#x%" UVxf ";", uv);
386 sv_catsv(dst, subchar);
387 SvREFCNT_dec(subchar);
389 sv_catpv(dst, FBCHAR_UTF8);
399 MODULE = Encode PACKAGE = Encode::utf8 PREFIX = Method_
404 Method_decode_xs(obj,src,check = 0)
416 dSP; ENTER; SAVETMPS;
417 if (src == &PL_sv_undef) src = newSV(0);
418 s = (U8 *) SvPV(src, slen);
419 e = (U8 *) SvEND(src);
420 dst = newSV(slen>0?slen:1); /* newSV() abhors 0 -- inaba */
423 * PerlIO check -- we assume the object is of PerlIO if renewed
428 if (call_method("renewed",G_SCALAR) == 1) {
430 renewed = (bool)POPi;
433 fprintf(stderr, "renewed == %d\n", renewed);
437 /* end PerlIO check */
440 s = utf8_to_bytes(s,&slen);
447 croak("Cannot decode string with wide characters");
451 s = process_utf8(aTHX_ dst, s, e, check, 0, strict_utf8(aTHX_ obj), renewed);
453 /* Clear out translated part of source unless asked not to */
454 if (check && !(check & ENCODE_LEAVE_SRC)){
457 sv_setpvn(src, (char*)s, slen);
459 SvCUR_set(src, slen);
462 ST(0) = sv_2mortal(dst);
467 Method_encode_xs(obj,src,check = 0)
479 if (src == &PL_sv_undef) src = newSV(0);
480 s = (U8 *) SvPV(src, slen);
481 e = (U8 *) SvEND(src);
482 dst = newSV(slen>0?slen:1); /* newSV() abhors 0 -- inaba */
484 /* Already encoded */
485 if (strict_utf8(aTHX_ obj)) {
486 s = process_utf8(aTHX_ dst, s, e, check, 1, 1, 0);
489 /* trust it and just copy the octets */
490 sv_setpvn(dst,(char *)s,(e-s));
495 /* Native bytes - can always encode */
496 U8 *d = (U8 *) SvGROW(dst, 2*slen+1); /* +1 or assertion will botch */
498 UV uv = NATIVE_TO_UNI((UV) *s);
499 s++; /* Above expansion of NATIVE_TO_UNI() is safer this way. */
500 if (UNI_IS_INVARIANT(uv))
501 *d++ = (U8)UTF_TO_NATIVE(uv);
503 *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
504 *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
507 SvCUR_set(dst, d- (U8 *)SvPVX(dst));
511 /* Clear out translated part of source unless asked not to */
512 if (check && !(check & ENCODE_LEAVE_SRC)){
515 sv_setpvn(src, (char*)s, slen);
517 SvCUR_set(src, slen);
521 ST(0) = sv_2mortal(dst);
525 MODULE = Encode PACKAGE = Encode::XS PREFIX = Method_
550 encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj)));
551 ST(0) = sv_2mortal(newSVpvn(enc->name[0],strlen(enc->name[0])));
556 Method_cat_decode(obj, dst, src, off, term, check_sv = &PL_sv_no)
566 SV *fallback_cb = &PL_sv_undef;
567 encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj)));
568 STRLEN offset = (STRLEN)SvIV(off);
571 sv_utf8_downgrade(src, FALSE);
573 if (SvROK(check_sv)){
574 fallback_cb = check_sv;
575 check = ENCODE_PERLQQ|ENCODE_LEAVE_SRC; /* same as FB_PERLQQ */
577 check = SvIV(check_sv);
579 sv_catsv(dst, encode_method(aTHX_ enc, enc->t_utf8, src, check,
580 &offset, term, &code, fallback_cb));
581 SvIV_set(off, (IV)offset);
582 if (code == ENCODE_FOUND_TERM) {
591 Method_decode(obj,src,check_sv = &PL_sv_no)
598 SV *fallback_cb = &PL_sv_undef;
599 encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj)));
601 sv_utf8_downgrade(src, FALSE);
603 if (SvROK(check_sv)){
604 fallback_cb = check_sv;
605 check = ENCODE_PERLQQ|ENCODE_LEAVE_SRC; /* same as FB_PERLQQ */
607 check = SvIV(check_sv);
609 ST(0) = encode_method(aTHX_ enc, enc->t_utf8, src, check,
610 NULL, Nullsv, NULL, fallback_cb);
616 Method_encode(obj,src,check_sv = &PL_sv_no)
623 SV *fallback_cb = &PL_sv_undef;
624 encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj)));
625 sv_utf8_upgrade(src);
626 if (SvROK(check_sv)){
627 fallback_cb = check_sv;
628 check = ENCODE_PERLQQ|ENCODE_LEAVE_SRC; /* same as FB_PERLQQ */
630 check = SvIV(check_sv);
632 ST(0) = encode_method(aTHX_ enc, enc->f_utf8, src, check,
633 NULL, Nullsv, NULL, fallback_cb);
638 Method_needs_lines(obj)
642 /* encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj))); */
648 Method_perlio_ok(obj)
652 /* encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj))); */
653 /* require_pv(PERLIO_FILENAME); */
655 eval_pv("require PerlIO::encoding", 0);
657 if (SvTRUE(get_sv("@", 0))) {
666 Method_mime_name(obj)
670 encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj)));
672 eval_pv("require Encode::MIME::Name", 0);
674 if (SvTRUE(get_sv("@", 0))) {
675 ST(0) = &PL_sv_undef;
680 XPUSHs(sv_2mortal(newSVpvn(enc->name[0], strlen(enc->name[0]))));
682 call_pv("Encode::MIME::Name::get_mime_name", G_SCALAR);
684 retval = newSVsv(POPs);
694 MODULE = Encode PACKAGE = Encode
699 _bytes_to_utf8(sv, ...)
703 SV * encoding = items == 2 ? ST(1) : Nullsv;
706 RETVAL = _encoded_bytes_to_utf8(sv, SvPV_nolen(encoding));
709 U8* s = (U8*)SvPV(sv, len);
712 converted = bytes_to_utf8(s, &len); /* This allocs */
713 sv_setpvn(sv, (char *)converted, len);
714 SvUTF8_on(sv); /* XXX Should we? */
715 Safefree(converted); /* ... so free it */
723 _utf8_to_bytes(sv, ...)
727 SV * to = items > 1 ? ST(1) : Nullsv;
728 SV * check = items > 2 ? ST(2) : Nullsv;
731 RETVAL = _encoded_utf8_to_bytes(sv, SvPV_nolen(to));
734 U8 *s = (U8*)SvPV(sv, len);
738 /* Must do things the slow way */
740 /* We need a copy to pass to check() */
745 New(83, dest, len, U8); /* I think */
755 /* Have to do it all ourselves because of error routine,
757 if (!(uv & 0x40)){ goto failure; }
758 if (!(uv & 0x20)) { ulen = 2; uv &= 0x1f; }
759 else if (!(uv & 0x10)) { ulen = 3; uv &= 0x0f; }
760 else if (!(uv & 0x08)) { ulen = 4; uv &= 0x07; }
761 else if (!(uv & 0x04)) { ulen = 5; uv &= 0x03; }
762 else if (!(uv & 0x02)) { ulen = 6; uv &= 0x01; }
763 else if (!(uv & 0x01)) { ulen = 7; uv = 0; }
764 else { ulen = 13; uv = 0; }
766 /* Note change to utf8.c variable naming, for variety */
768 if ((*s & 0xc0) != 0x80){
771 uv = (uv << 6) | (*s++ & 0x3f);
776 call_failure(check, s, dest, src);
777 /* Now what happens? */
783 sv_usepvn(sv, (char *)dest, RETVAL);
786 RETVAL = (utf8_to_bytes(s, &len) ? len : 0);
794 is_utf8(sv, check = 0)
799 if (SvGMAGICAL(sv)) /* it could be $1, for example */
800 sv = newSVsv(sv); /* GMAGIG will be done */
801 RETVAL = SvUTF8(sv) ? TRUE : FALSE;
804 !is_utf8_string((U8*)SvPVX(sv), SvCUR(sv)))
807 SvREFCNT_dec(sv); /* it was a temp copy */
818 SV *rsv = newSViv(SvUTF8(sv));
822 RETVAL = &PL_sv_undef;
834 SV *rsv = newSViv(SvUTF8(sv));
838 RETVAL = &PL_sv_undef;
847 RETVAL = ENCODE_DIE_ON_ERR;
854 RETVAL = ENCODE_WARN_ON_ERR;
861 RETVAL = ENCODE_LEAVE_SRC;
868 RETVAL = ENCODE_RETURN_ON_ERR;
875 RETVAL = ENCODE_PERLQQ;
882 RETVAL = ENCODE_HTMLCREF;
889 RETVAL = ENCODE_XMLCREF;
896 RETVAL = ENCODE_STOP_AT_PARTIAL;
903 RETVAL = ENCODE_FB_DEFAULT;
910 RETVAL = ENCODE_FB_CROAK;
917 RETVAL = ENCODE_FB_QUIET;
924 RETVAL = ENCODE_FB_WARN;
931 RETVAL = ENCODE_FB_PERLQQ;
938 RETVAL = ENCODE_FB_HTMLCREF;
945 RETVAL = ENCODE_FB_XMLCREF;