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