This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Update Encode to CPAN version 2.54
[perl5.git] / cpan / Encode / Encode.xs
1 /*
2  $Id: Encode.xs,v 2.24 2013/08/29 16:47:39 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 #ifdef UTF8_DISALLOW_ILLEGAL_INTERCHANGE
33 #   define UTF8_ALLOW_STRICT UTF8_DISALLOW_ILLEGAL_INTERCHANGE
34 #else
35 #   define UTF8_ALLOW_STRICT 0
36 #endif
37
38 #define UTF8_ALLOW_NONSTRICT (UTF8_ALLOW_ANY &                    \
39                               ~(UTF8_ALLOW_CONTINUATION |         \
40                                 UTF8_ALLOW_NON_CONTINUATION |     \
41                                 UTF8_ALLOW_LONG))
42
43 void
44 Encode_XSEncoding(pTHX_ encode_t * enc)
45 {
46     dSP;
47     HV *stash = gv_stashpv("Encode::XS", TRUE);
48     SV *sv = sv_bless(newRV_noinc(newSViv(PTR2IV(enc))), stash);
49     int i = 0;
50     PUSHMARK(sp);
51     XPUSHs(sv);
52     while (enc->name[i]) {
53     const char *name = enc->name[i++];
54     XPUSHs(sv_2mortal(newSVpvn(name, strlen(name))));
55     }
56     PUTBACK;
57     call_pv("Encode::define_encoding", G_DISCARD);
58     SvREFCNT_dec(sv);
59 }
60
61 void
62 call_failure(SV * routine, U8 * done, U8 * dest, U8 * orig)
63 {
64     /* Exists for breakpointing */
65 }
66
67
68 #define ERR_ENCODE_NOMAP "\"\\x{%04" UVxf "}\" does not map to %s"
69 #define ERR_DECODE_NOMAP "%s \"\\x%02" UVXf "\" does not map to Unicode"
70
71 static SV *
72 do_fallback_cb(pTHX_ UV ch, SV *fallback_cb)
73 {
74     dSP;
75     int argc;
76     SV *retval = newSVpv("",0);
77     ENTER;
78     SAVETMPS;
79     PUSHMARK(sp);
80     XPUSHs(sv_2mortal(newSVnv((UV)ch)));
81     PUTBACK;
82     argc = call_sv(fallback_cb, G_SCALAR);
83     SPAGAIN;
84     if (argc != 1){
85         croak("fallback sub must return scalar!");
86     }
87     sv_catsv(retval, POPs);
88     PUTBACK;
89     FREETMPS;
90     LEAVE;
91     return retval;
92 }
93
94 static SV *
95 encode_method(pTHX_ const encode_t * enc, const encpage_t * dir, SV * src,
96               int check, STRLEN * offset, SV * term, int * retcode, 
97               SV *fallback_cb)
98 {
99     STRLEN slen;
100     U8 *s = (U8 *) SvPV(src, slen);
101     STRLEN tlen  = slen;
102     STRLEN ddone = 0;
103     STRLEN sdone = 0;
104     /* We allocate slen+1.
105        PerlIO dumps core if this value is smaller than this. */
106     SV *dst = sv_2mortal(newSV(slen+1));
107     U8 *d = (U8 *)SvPVX(dst);
108     STRLEN dlen = SvLEN(dst)-1;
109     int code = 0;
110     STRLEN trmlen = 0;
111     U8 *trm = term ? (U8*) SvPV(term, trmlen) : NULL;
112
113     if (SvTAINTED(src)) SvTAINTED_on(dst); /* propagate taintedness */
114
115     if (offset) {
116       s += *offset;
117       if (slen > *offset){ /* safeguard against slen overflow */
118       slen -= *offset;
119       }else{
120       slen = 0;
121       }
122       tlen = slen;
123     }
124
125     if (slen == 0){
126     SvCUR_set(dst, 0);
127     SvPOK_only(dst);
128     goto ENCODE_END;
129     }
130
131     while( (code = do_encode(dir, s, &slen, d, dlen, &dlen, !check,
132                  trm, trmlen)) ) 
133     {
134     SvCUR_set(dst, dlen+ddone);
135     SvPOK_only(dst);
136     
137     if (code == ENCODE_FALLBACK || code == ENCODE_PARTIAL ||
138         code == ENCODE_FOUND_TERM) {
139         break;
140     }
141     switch (code) {
142     case ENCODE_NOSPACE:
143     {   
144         STRLEN more = 0; /* make sure you initialize! */
145         STRLEN sleft;
146         sdone += slen;
147         ddone += dlen;
148         sleft = tlen - sdone;
149 #if ENCODE_XS_PROFILE >= 2
150         Perl_warn(aTHX_
151               "more=%d, sdone=%d, sleft=%d, SvLEN(dst)=%d\n",
152               more, sdone, sleft, SvLEN(dst));
153 #endif
154         if (sdone != 0) { /* has src ever been processed ? */
155 #if   ENCODE_XS_USEFP == 2
156         more = (1.0*tlen*SvLEN(dst)+sdone-1)/sdone
157             - SvLEN(dst);
158 #elif ENCODE_XS_USEFP
159         more = (STRLEN)((1.0*SvLEN(dst)+1)/sdone * sleft);
160 #else
161         /* safe until SvLEN(dst) == MAX_INT/16 */
162         more = (16*SvLEN(dst)+1)/sdone/16 * sleft;
163 #endif
164         }
165         more += UTF8_MAXLEN; /* insurance policy */
166         d = (U8 *) SvGROW(dst, SvLEN(dst) + more);
167         /* dst need to grow need MORE bytes! */
168         if (ddone >= SvLEN(dst)) {
169         Perl_croak(aTHX_ "Destination couldn't be grown.");
170         }
171         dlen = SvLEN(dst)-ddone-1;
172         d   += ddone;
173         s   += slen;
174         slen = tlen-sdone;
175         continue;
176     }
177     case ENCODE_NOREP:
178         /* encoding */  
179         if (dir == enc->f_utf8) {
180         STRLEN clen;
181         UV ch =
182             utf8n_to_uvuni(s+slen, (SvCUR(src)-slen),
183                    &clen, UTF8_ALLOW_ANY|UTF8_CHECK_ONLY);
184         /* if non-representable multibyte prefix at end of current buffer - break*/
185         if (clen > tlen - sdone) break;
186         if (check & ENCODE_DIE_ON_ERR) {
187             Perl_croak(aTHX_ ERR_ENCODE_NOMAP,
188                    (UV)ch, enc->name[0]);
189             return &PL_sv_undef; /* never reaches but be safe */
190         }
191         if (check & ENCODE_WARN_ON_ERR){
192             Perl_warner(aTHX_ packWARN(WARN_UTF8),
193                 ERR_ENCODE_NOMAP, (UV)ch, enc->name[0]);
194         }
195         if (check & ENCODE_RETURN_ON_ERR){
196             goto ENCODE_SET_SRC;
197         }
198         if (check & (ENCODE_PERLQQ|ENCODE_HTMLCREF|ENCODE_XMLCREF)){
199             SV* subchar = 
200             (fallback_cb != &PL_sv_undef)
201                 ? do_fallback_cb(aTHX_ ch, fallback_cb)
202                 : newSVpvf(check & ENCODE_PERLQQ ? "\\x{%04"UVxf"}" :
203                  check & ENCODE_HTMLCREF ? "&#%" UVuf ";" :
204                  "&#x%" UVxf ";", (UV)ch);
205             SvUTF8_off(subchar); /* make sure no decoded string gets in */
206             sdone += slen + clen;
207             ddone += dlen + SvCUR(subchar);
208             sv_catsv(dst, subchar);
209             SvREFCNT_dec(subchar);
210         } else {
211             /* fallback char */
212             sdone += slen + clen;
213             ddone += dlen + enc->replen;
214             sv_catpvn(dst, (char*)enc->rep, enc->replen);
215         }
216         }
217         /* decoding */
218         else {
219         if (check & ENCODE_DIE_ON_ERR){
220             Perl_croak(aTHX_ ERR_DECODE_NOMAP,
221                               enc->name[0], (UV)s[slen]);
222             return &PL_sv_undef; /* never reaches but be safe */
223         }
224         if (check & ENCODE_WARN_ON_ERR){
225             Perl_warner(
226             aTHX_ packWARN(WARN_UTF8),
227             ERR_DECODE_NOMAP,
228                         enc->name[0], (UV)s[slen]);
229         }
230         if (check & ENCODE_RETURN_ON_ERR){
231             goto ENCODE_SET_SRC;
232         }
233         if (check &
234             (ENCODE_PERLQQ|ENCODE_HTMLCREF|ENCODE_XMLCREF)){
235             SV* subchar = 
236             (fallback_cb != &PL_sv_undef)
237                 ? do_fallback_cb(aTHX_ (UV)s[slen], fallback_cb) 
238                 : newSVpvf("\\x%02" UVXf, (UV)s[slen]);
239             sdone += slen + 1;
240             ddone += dlen + SvCUR(subchar);
241             sv_catsv(dst, subchar);
242             SvREFCNT_dec(subchar);
243         } else {
244             sdone += slen + 1;
245             ddone += dlen + strlen(FBCHAR_UTF8);
246             sv_catpv(dst, FBCHAR_UTF8);
247         }
248         }
249         /* settle variables when fallback */
250         d    = (U8 *)SvEND(dst);
251             dlen = SvLEN(dst) - ddone - 1;
252         s    = (U8*)SvPVX(src) + sdone;
253         slen = tlen - sdone;
254         break;
255
256     default:
257         Perl_croak(aTHX_ "Unexpected code %d converting %s %s",
258                code, (dir == enc->f_utf8) ? "to" : "from",
259                enc->name[0]);
260         return &PL_sv_undef;
261     }
262     }
263  ENCODE_SET_SRC:
264     if (check && !(check & ENCODE_LEAVE_SRC)){
265     sdone = SvCUR(src) - (slen+sdone);
266     if (sdone) {
267         sv_setpvn(src, (char*)s+slen, sdone);
268     }
269     SvCUR_set(src, sdone);
270     }
271     /* warn("check = 0x%X, code = 0x%d\n", check, code); */
272
273     SvCUR_set(dst, dlen+ddone);
274     SvPOK_only(dst);
275
276 #if ENCODE_XS_PROFILE
277     if (SvCUR(dst) > SvCUR(src)){
278     Perl_warn(aTHX_
279           "SvLEN(dst)=%d, SvCUR(dst)=%d. %d bytes unused(%f %%)\n",
280           SvLEN(dst), SvCUR(dst), SvLEN(dst) - SvCUR(dst),
281           (SvLEN(dst) - SvCUR(dst))*1.0/SvLEN(dst)*100.0);
282     }
283 #endif
284
285     if (offset) 
286       *offset += sdone + slen;
287
288  ENCODE_END:
289     *SvEND(dst) = '\0';
290     if (retcode) *retcode = code;
291     return dst;
292 }
293
294 static bool
295 strict_utf8(pTHX_ SV* sv)
296 {
297     HV* hv;
298     SV** svp;
299     sv = SvRV(sv);
300     if (!sv || SvTYPE(sv) != SVt_PVHV)
301         return 0;
302     hv = (HV*)sv;
303     svp = hv_fetch(hv, "strict_utf8", 11, 0);
304     if (!svp)
305         return 0;
306     return SvTRUE(*svp);
307 }
308
309 static U8*
310 process_utf8(pTHX_ SV* dst, U8* s, U8* e, SV *check_sv,
311              bool encode, bool strict, bool stop_at_partial)
312 {
313     UV uv;
314     STRLEN ulen;
315     SV *fallback_cb;
316     int check;
317
318     if (SvROK(check_sv)) {
319         /* croak("UTF-8 decoder doesn't support callback CHECK"); */
320         fallback_cb = check_sv;
321         check = ENCODE_PERLQQ|ENCODE_LEAVE_SRC; /* same as perlqq */
322     }
323     else {
324         fallback_cb = &PL_sv_undef;
325         check = SvIV(check_sv);
326     }
327
328     SvPOK_only(dst);
329     SvCUR_set(dst,0);
330
331     while (s < e) {
332         if (UTF8_IS_INVARIANT(*s)) {
333             sv_catpvn(dst, (char *)s, 1);
334             s++;
335             continue;
336         }
337
338         if (UTF8_IS_START(*s)) {
339             U8 skip = UTF8SKIP(s);
340             if ((s + skip) > e) {
341                 /* Partial character */
342                 /* XXX could check that rest of bytes are UTF8_IS_CONTINUATION(ch) */
343                 if (stop_at_partial || (check & ENCODE_STOP_AT_PARTIAL))
344                     break;
345
346                 goto malformed_byte;
347             }
348
349             uv = utf8n_to_uvuni(s, e - s, &ulen,
350                                 UTF8_CHECK_ONLY | (strict ? UTF8_ALLOW_STRICT :
351                                                             UTF8_ALLOW_NONSTRICT)
352                                );
353 #if 1 /* perl-5.8.6 and older do not check UTF8_ALLOW_LONG */
354         if (strict && uv > PERL_UNICODE_MAX)
355         ulen = (STRLEN) -1;
356 #endif
357             if (ulen == -1) {
358                 if (strict) {
359                     uv = utf8n_to_uvuni(s, e - s, &ulen,
360                                         UTF8_CHECK_ONLY | UTF8_ALLOW_NONSTRICT);
361                     if (ulen == -1)
362                         goto malformed_byte;
363                     goto malformed;
364                 }
365                 goto malformed_byte;
366             }
367
368
369              /* Whole char is good */
370              sv_catpvn(dst,(char *)s,skip);
371              s += skip;
372              continue;
373         }
374
375         /* If we get here there is something wrong with alleged UTF-8 */
376     malformed_byte:
377         uv = (UV)*s;
378         ulen = 1;
379
380     malformed:
381         if (check & ENCODE_DIE_ON_ERR){
382             if (encode)
383                 Perl_croak(aTHX_ ERR_ENCODE_NOMAP, uv, "utf8");
384             else
385                 Perl_croak(aTHX_ ERR_DECODE_NOMAP, "utf8", uv);
386         }
387         if (check & ENCODE_WARN_ON_ERR){
388             if (encode)
389                 Perl_warner(aTHX_ packWARN(WARN_UTF8),
390                             ERR_ENCODE_NOMAP, uv, "utf8");
391             else
392                 Perl_warner(aTHX_ packWARN(WARN_UTF8),
393                             ERR_DECODE_NOMAP, "utf8", uv);
394         }
395         if (check & ENCODE_RETURN_ON_ERR) {
396                 break;
397         }
398         if (check & (ENCODE_PERLQQ|ENCODE_HTMLCREF|ENCODE_XMLCREF)){
399             SV* subchar =
400                 (fallback_cb != &PL_sv_undef)
401                 ? do_fallback_cb(aTHX_ uv, fallback_cb)
402                 : newSVpvf(check & ENCODE_PERLQQ 
403                            ? (ulen == 1 ? "\\x%02" UVXf : "\\x{%04" UVXf "}")
404                            :  check & ENCODE_HTMLCREF ? "&#%" UVuf ";" 
405                            : "&#x%" UVxf ";", uv);
406             if (encode){
407                 SvUTF8_off(subchar); /* make sure no decoded string gets in */
408             }
409             sv_catsv(dst, subchar);
410             SvREFCNT_dec(subchar);
411         } else {
412             sv_catpv(dst, FBCHAR_UTF8);
413         }
414         s += ulen;
415     }
416     *SvEND(dst) = '\0';
417
418     return s;
419 }
420
421
422 MODULE = Encode         PACKAGE = Encode::utf8  PREFIX = Method_
423
424 PROTOTYPES: DISABLE
425
426 void
427 Method_decode_xs(obj,src,check_sv = &PL_sv_no)
428 SV *    obj
429 SV *    src
430 SV *    check_sv
431 PREINIT:
432     STRLEN slen;
433     U8 *s;
434     U8 *e;
435     SV *dst;
436     bool renewed = 0;
437     int check;
438 CODE:
439 {
440     dSP; ENTER; SAVETMPS;
441     if (src == &PL_sv_undef || SvROK(src)) src = sv_2mortal(newSV(0));
442     s = (U8 *) SvPV(src, slen);
443     e = (U8 *) SvEND(src);
444     check = SvROK(check_sv) ? ENCODE_PERLQQ|ENCODE_LEAVE_SRC : SvIV(check_sv);
445     /* 
446      * PerlIO check -- we assume the object is of PerlIO if renewed
447      */
448     PUSHMARK(sp);
449     XPUSHs(obj);
450     PUTBACK;
451     if (call_method("renewed",G_SCALAR) == 1) {
452     SPAGAIN;
453     renewed = (bool)POPi;
454     PUTBACK; 
455 #if 0
456     fprintf(stderr, "renewed == %d\n", renewed);
457 #endif
458     }
459     FREETMPS; LEAVE;
460     /* end PerlIO check */
461
462     if (SvUTF8(src)) {
463     s = utf8_to_bytes(s,&slen);
464     if (s) {
465         SvCUR_set(src,slen);
466         SvUTF8_off(src);
467         e = s+slen;
468     }
469     else {
470         croak("Cannot decode string with wide characters");
471     }
472     }
473
474     dst = sv_2mortal(newSV(slen>0?slen:1)); /* newSV() abhors 0 -- inaba */
475     s = process_utf8(aTHX_ dst, s, e, check_sv, 0, strict_utf8(aTHX_ obj), renewed);
476
477     /* Clear out translated part of source unless asked not to */
478     if (check && !(check & ENCODE_LEAVE_SRC)){
479     slen = e-s;
480     if (slen) {
481         sv_setpvn(src, (char*)s, slen);
482     }
483     SvCUR_set(src, slen);
484     }
485     SvUTF8_on(dst);
486     if (SvTAINTED(src)) SvTAINTED_on(dst); /* propagate taintedness */
487     ST(0) = dst;
488     XSRETURN(1);
489 }
490
491 void
492 Method_encode_xs(obj,src,check_sv = &PL_sv_no)
493 SV *    obj
494 SV *    src
495 SV *    check_sv
496 PREINIT:
497     STRLEN slen;
498     U8 *s;
499     U8 *e;
500     SV *dst;
501     bool renewed = 0;
502     int check;
503 CODE:
504 {
505     check = SvROK(check_sv) ? ENCODE_PERLQQ|ENCODE_LEAVE_SRC : SvIV(check_sv);
506     if (src == &PL_sv_undef || SvROK(src)) src = sv_2mortal(newSV(0));
507     s = (U8 *) SvPV(src, slen);
508     e = (U8 *) SvEND(src);
509     dst = sv_2mortal(newSV(slen>0?slen:1)); /* newSV() abhors 0 -- inaba */
510     if (SvUTF8(src)) {
511     /* Already encoded */
512     if (strict_utf8(aTHX_ obj)) {
513         s = process_utf8(aTHX_ dst, s, e, check_sv, 1, 1, 0);
514     }
515         else {
516             /* trust it and just copy the octets */
517             sv_setpvn(dst,(char *)s,(e-s));
518         s = e;
519         }
520     }
521     else {
522         /* Native bytes - can always encode */
523     U8 *d = (U8 *) SvGROW(dst, 2*slen+1); /* +1 or assertion will botch */
524         while (s < e) {
525             UV uv = NATIVE_TO_UNI((UV) *s);
526             s++; /* Above expansion of NATIVE_TO_UNI() is safer this way. */
527             if (UNI_IS_INVARIANT(uv))
528                 *d++ = (U8)UTF_TO_NATIVE(uv);
529             else {
530                 *d++ = (U8)UTF8_EIGHT_BIT_HI(uv);
531                 *d++ = (U8)UTF8_EIGHT_BIT_LO(uv);
532             }
533     }
534         SvCUR_set(dst, d- (U8 *)SvPVX(dst));
535         *SvEND(dst) = '\0';
536     }
537
538     /* Clear out translated part of source unless asked not to */
539     if (check && !(check & ENCODE_LEAVE_SRC)){
540     slen = e-s;
541     if (slen) {
542         sv_setpvn(src, (char*)s, slen);
543     }
544     SvCUR_set(src, slen);
545     }
546     SvPOK_only(dst);
547     SvUTF8_off(dst);
548     if (SvTAINTED(src)) SvTAINTED_on(dst); /* propagate taintedness */
549     ST(0) = dst;
550     XSRETURN(1);
551 }
552
553 MODULE = Encode         PACKAGE = Encode::XS    PREFIX = Method_
554
555 PROTOTYPES: ENABLE
556
557 void
558 Method_renew(obj)
559 SV *    obj
560 CODE:
561 {
562     XSRETURN(1);
563 }
564
565 int
566 Method_renewed(obj)
567 SV *    obj
568 CODE:
569     RETVAL = 0;
570 OUTPUT:
571     RETVAL
572
573 void
574 Method_name(obj)
575 SV *    obj
576 CODE:
577 {
578     encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj)));
579     ST(0) = sv_2mortal(newSVpvn(enc->name[0],strlen(enc->name[0])));
580     XSRETURN(1);
581 }
582
583 void
584 Method_cat_decode(obj, dst, src, off, term, check_sv = &PL_sv_no)
585 SV *    obj
586 SV *    dst
587 SV *    src
588 SV *    off
589 SV *    term
590 SV *    check_sv
591 CODE:
592 {
593     int check;
594     SV *fallback_cb = &PL_sv_undef;
595     encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj)));
596     STRLEN offset = (STRLEN)SvIV(off);
597     int code = 0;
598     if (SvUTF8(src)) {
599         sv_utf8_downgrade(src, FALSE);
600     }
601     if (SvROK(check_sv)){
602         fallback_cb = check_sv;
603         check = ENCODE_PERLQQ|ENCODE_LEAVE_SRC; /* same as FB_PERLQQ */
604     }else{
605         check = SvIV(check_sv);
606     }
607     sv_catsv(dst, encode_method(aTHX_ enc, enc->t_utf8, src, check,
608                 &offset, term, &code, fallback_cb));
609     SvIV_set(off, (IV)offset);
610     if (code == ENCODE_FOUND_TERM) {
611     ST(0) = &PL_sv_yes;
612     }else{
613     ST(0) = &PL_sv_no;
614     }
615     XSRETURN(1);
616 }
617
618 void
619 Method_decode(obj,src,check_sv = &PL_sv_no)
620 SV *    obj
621 SV *    src
622 SV *    check_sv
623 CODE:
624 {
625     int check;
626     SV *fallback_cb = &PL_sv_undef;
627     encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj)));
628     if (SvUTF8(src)) {
629         sv_utf8_downgrade(src, FALSE);
630     }
631     if (SvROK(check_sv)){
632         fallback_cb = check_sv;
633         check = ENCODE_PERLQQ|ENCODE_LEAVE_SRC; /* same as FB_PERLQQ */
634     }else{
635         check = SvIV(check_sv);
636     }
637     ST(0) = encode_method(aTHX_ enc, enc->t_utf8, src, check,
638               NULL, Nullsv, NULL, fallback_cb);
639     SvUTF8_on(ST(0));
640     XSRETURN(1);
641 }
642
643 void
644 Method_encode(obj,src,check_sv = &PL_sv_no)
645 SV *    obj
646 SV *    src
647 SV *    check_sv
648 CODE:
649 {
650     int check;
651     SV *fallback_cb = &PL_sv_undef;
652     encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj)));
653     sv_utf8_upgrade(src);
654     if (SvROK(check_sv)){
655         fallback_cb = check_sv;
656         check = ENCODE_PERLQQ|ENCODE_LEAVE_SRC; /* same as FB_PERLQQ */
657     }else{
658         check = SvIV(check_sv);
659     }
660     ST(0) = encode_method(aTHX_ enc, enc->f_utf8, src, check,
661               NULL, Nullsv, NULL, fallback_cb);
662     XSRETURN(1);
663 }
664
665 void
666 Method_needs_lines(obj)
667 SV *    obj
668 CODE:
669 {
670     /* encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj))); */
671     ST(0) = &PL_sv_no;
672     XSRETURN(1);
673 }
674
675 void
676 Method_perlio_ok(obj)
677 SV *    obj
678 CODE:
679 {
680     /* encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj))); */
681     /* require_pv(PERLIO_FILENAME); */
682
683     eval_pv("require PerlIO::encoding", 0);
684
685     if (SvTRUE(get_sv("@", 0))) {
686     ST(0) = &PL_sv_no;
687     }else{
688     ST(0) = &PL_sv_yes;
689     }
690     XSRETURN(1);
691 }
692
693 void
694 Method_mime_name(obj)
695 SV *    obj
696 CODE:
697 {
698     encode_t *enc = INT2PTR(encode_t *, SvIV(SvRV(obj)));
699     SV *retval;
700     eval_pv("require Encode::MIME::Name", 0);
701
702     if (SvTRUE(get_sv("@", 0))) {
703         ST(0) = &PL_sv_undef;
704     }else{
705         ENTER;
706         SAVETMPS;
707         PUSHMARK(sp);
708         XPUSHs(sv_2mortal(newSVpvn(enc->name[0], strlen(enc->name[0]))));
709         PUTBACK;
710         call_pv("Encode::MIME::Name::get_mime_name", G_SCALAR);
711         SPAGAIN;
712         retval = newSVsv(POPs);
713         PUTBACK;
714         FREETMPS;
715         LEAVE;
716         /* enc->name[0] */
717         ST(0) = retval;
718     }
719     XSRETURN(1);
720 }
721
722 MODULE = Encode         PACKAGE = Encode
723
724 PROTOTYPES: ENABLE
725
726 I32
727 _bytes_to_utf8(sv, ...)
728 SV *    sv
729 CODE:
730 {
731     SV * encoding = items == 2 ? ST(1) : Nullsv;
732
733     if (encoding)
734     RETVAL = _encoded_bytes_to_utf8(sv, SvPV_nolen(encoding));
735     else {
736     STRLEN len;
737     U8*    s = (U8*)SvPV(sv, len);
738     U8*    converted;
739
740     converted = bytes_to_utf8(s, &len); /* This allocs */
741     sv_setpvn(sv, (char *)converted, len);
742     SvUTF8_on(sv); /* XXX Should we? */
743     Safefree(converted);                /* ... so free it */
744     RETVAL = len;
745     }
746 }
747 OUTPUT:
748     RETVAL
749
750 I32
751 _utf8_to_bytes(sv, ...)
752 SV *    sv
753 CODE:
754 {
755     SV * to    = items > 1 ? ST(1) : Nullsv;
756     SV * check = items > 2 ? ST(2) : Nullsv;
757
758     if (to) {
759     RETVAL = _encoded_utf8_to_bytes(sv, SvPV_nolen(to));
760     } else {
761     STRLEN len;
762     U8 *s = (U8*)SvPV(sv, len);
763
764     RETVAL = 0;
765     if (SvTRUE(check)) {
766         /* Must do things the slow way */
767         U8 *dest;
768             /* We need a copy to pass to check() */
769         U8 *src  = s;
770         U8 *send = s + len;
771         U8 *d0;
772
773         New(83, dest, len, U8); /* I think */
774         d0 = dest;
775
776         while (s < send) {
777                 if (*s < 0x80){
778             *dest++ = *s++;
779                 } else {
780             STRLEN ulen;
781             UV uv = *s++;
782
783             /* Have to do it all ourselves because of error routine,
784                aargh. */
785             if (!(uv & 0x40)){ goto failure; }
786             if      (!(uv & 0x20)) { ulen = 2;  uv &= 0x1f; }
787             else if (!(uv & 0x10)) { ulen = 3;  uv &= 0x0f; }
788             else if (!(uv & 0x08)) { ulen = 4;  uv &= 0x07; }
789             else if (!(uv & 0x04)) { ulen = 5;  uv &= 0x03; }
790             else if (!(uv & 0x02)) { ulen = 6;  uv &= 0x01; }
791             else if (!(uv & 0x01)) { ulen = 7;  uv = 0; }
792             else                   { ulen = 13; uv = 0; }
793         
794             /* Note change to utf8.c variable naming, for variety */
795             while (ulen--) {
796             if ((*s & 0xc0) != 0x80){
797                 goto failure;
798             } else {
799                 uv = (uv << 6) | (*s++ & 0x3f);
800             }
801           }
802           if (uv > 256) {
803           failure:
804               call_failure(check, s, dest, src);
805               /* Now what happens? */
806           }
807           *dest++ = (U8)uv;
808         }
809         }
810         RETVAL = dest - d0;
811         sv_usepvn(sv, (char *)dest, RETVAL);
812         SvUTF8_off(sv);
813     } else {
814         RETVAL = (utf8_to_bytes(s, &len) ? len : 0);
815     }
816     }
817 }
818 OUTPUT:
819     RETVAL
820
821 bool
822 is_utf8(sv, check = 0)
823 SV *    sv
824 int     check
825 CODE:
826 {
827     if (SvGMAGICAL(sv)) /* it could be $1, for example */
828     sv = newSVsv(sv); /* GMAGIG will be done */
829     RETVAL = SvUTF8(sv) ? TRUE : FALSE;
830     if (RETVAL &&
831         check  &&
832         !is_utf8_string((U8*)SvPVX(sv), SvCUR(sv)))
833         RETVAL = FALSE;
834     if (sv != ST(0))
835     SvREFCNT_dec(sv); /* it was a temp copy */
836 }
837 OUTPUT:
838     RETVAL
839
840 #ifndef SvIsCOW
841 # define SvIsCOW (SvREADONLY(sv) && SvFAKE(sv))
842 #endif
843
844 SV *
845 _utf8_on(sv)
846 SV *    sv
847 CODE:
848 {
849     if (SvPOK(sv)) {
850     SV *rsv = newSViv(SvUTF8(sv));
851     RETVAL = rsv;
852     if (SvIsCOW(sv)) sv_force_normal(sv);
853     SvUTF8_on(sv);
854     } else {
855     RETVAL = &PL_sv_undef;
856     }
857 }
858 OUTPUT:
859     RETVAL
860
861 SV *
862 _utf8_off(sv)
863 SV *    sv
864 CODE:
865 {
866     if (SvPOK(sv)) {
867     SV *rsv = newSViv(SvUTF8(sv));
868     RETVAL = rsv;
869     if (SvIsCOW(sv)) sv_force_normal(sv);
870     SvUTF8_off(sv);
871     } else {
872     RETVAL = &PL_sv_undef;
873     }
874 }
875 OUTPUT:
876     RETVAL
877
878 int
879 DIE_ON_ERR()
880 CODE:
881     RETVAL = ENCODE_DIE_ON_ERR;
882 OUTPUT:
883     RETVAL
884
885 int
886 WARN_ON_ERR()
887 CODE:
888     RETVAL = ENCODE_WARN_ON_ERR;
889 OUTPUT:
890     RETVAL
891
892 int
893 LEAVE_SRC()
894 CODE:
895     RETVAL = ENCODE_LEAVE_SRC;
896 OUTPUT:
897     RETVAL
898
899 int
900 RETURN_ON_ERR()
901 CODE:
902     RETVAL = ENCODE_RETURN_ON_ERR;
903 OUTPUT:
904     RETVAL
905
906 int
907 PERLQQ()
908 CODE:
909     RETVAL = ENCODE_PERLQQ;
910 OUTPUT:
911     RETVAL
912
913 int
914 HTMLCREF()
915 CODE:
916     RETVAL = ENCODE_HTMLCREF;
917 OUTPUT:
918     RETVAL
919
920 int
921 XMLCREF()
922 CODE:
923     RETVAL = ENCODE_XMLCREF;
924 OUTPUT:
925     RETVAL
926
927 int
928 STOP_AT_PARTIAL()
929 CODE:
930     RETVAL = ENCODE_STOP_AT_PARTIAL;
931 OUTPUT:
932     RETVAL
933
934 int
935 FB_DEFAULT()
936 CODE:
937     RETVAL = ENCODE_FB_DEFAULT;
938 OUTPUT:
939     RETVAL
940
941 int
942 FB_CROAK()
943 CODE:
944     RETVAL = ENCODE_FB_CROAK;
945 OUTPUT:
946     RETVAL
947
948 int
949 FB_QUIET()
950 CODE:
951     RETVAL = ENCODE_FB_QUIET;
952 OUTPUT:
953     RETVAL
954
955 int
956 FB_WARN()
957 CODE:
958     RETVAL = ENCODE_FB_WARN;
959 OUTPUT:
960     RETVAL
961
962 int
963 FB_PERLQQ()
964 CODE:
965     RETVAL = ENCODE_FB_PERLQQ;
966 OUTPUT:
967     RETVAL
968
969 int
970 FB_HTMLCREF()
971 CODE:
972     RETVAL = ENCODE_FB_HTMLCREF;
973 OUTPUT:
974     RETVAL
975
976 int
977 FB_XMLCREF()
978 CODE:
979     RETVAL = ENCODE_FB_XMLCREF;
980 OUTPUT:
981     RETVAL
982
983 BOOT:
984 {
985 #include "def_t.h"
986 #include "def_t.exh"
987 }