For ICU, locale, is a char ptr rather than uint8_t ptr.
[yaz-moved-to-github.git] / src / icu_I18N.c
1 /*
2  * Copyright (C) 1995-2007, Index Data ApS
3  * See the file LICENSE for details.
4  *
5  * $Id: icu_I18N.c,v 1.11 2007-11-06 10:27:30 adam Exp $
6  */
7
8 #if HAVE_CONFIG_H
9 #include "config.h"
10 #endif
11
12 #define USE_TIMING 0
13 #if USE_TIMING
14 #include <yaz/timing.h>
15 #endif
16
17
18 #if HAVE_ICU
19 #include <yaz/icu_I18N.h>
20
21 #include <yaz/log.h>
22
23 #include <string.h>
24 #include <stdlib.h>
25 #include <stdio.h>
26
27 #include <unicode/ustring.h>  /* some more string fcns*/
28 #include <unicode/uchar.h>    /* char names           */
29
30
31 #include <unicode/ucol.h> 
32
33
34 int icu_check_status (UErrorCode status)
35 {
36     if(U_FAILURE(status)){
37         yaz_log(YLOG_WARN, 
38                 "ICU: %d %s\n", status, u_errorName(status));
39         return 0;   
40     }
41     return 1;
42     
43 }
44
45
46
47 struct icu_buf_utf16 * icu_buf_utf16_create(size_t capacity)
48 {
49     struct icu_buf_utf16 * buf16 
50         = (struct icu_buf_utf16 *) malloc(sizeof(struct icu_buf_utf16));
51
52     buf16->utf16 = 0;
53     buf16->utf16_len = 0;
54     buf16->utf16_cap = 0;
55
56     if (capacity > 0){
57         buf16->utf16 = (UChar *) malloc(sizeof(UChar) * capacity);
58         buf16->utf16[0] = (UChar) 0;
59         buf16->utf16_cap = capacity;
60     }
61     return buf16;
62 }
63
64 struct icu_buf_utf16 * icu_buf_utf16_clear(struct icu_buf_utf16 * buf16)
65 {
66     if (buf16){
67         if (buf16->utf16)
68             buf16->utf16[0] = (UChar) 0;
69         buf16->utf16_len = 0;
70     }
71     return buf16;
72 }
73
74 struct icu_buf_utf16 * icu_buf_utf16_resize(struct icu_buf_utf16 * buf16,
75                                             size_t capacity)
76 {
77     if (!buf16)
78         return 0;
79     
80     if (capacity >  0){
81         if (0 == buf16->utf16)
82             buf16->utf16 = (UChar *) malloc(sizeof(UChar) * capacity);
83         else
84             buf16->utf16 
85                 = (UChar *) realloc(buf16->utf16, sizeof(UChar) * capacity);
86
87         icu_buf_utf16_clear(buf16);
88         buf16->utf16_cap = capacity;
89     } 
90     else { 
91         if (buf16->utf16)
92             free(buf16->utf16);
93         buf16->utf16 = 0;
94         buf16->utf16_len = 0;
95         buf16->utf16_cap = 0;
96     }
97
98     return buf16;
99 }
100
101
102 struct icu_buf_utf16 * icu_buf_utf16_copy(struct icu_buf_utf16 * dest16,
103                                           struct icu_buf_utf16 * src16)
104 {
105     if(!dest16 || !src16
106        || dest16 == src16)
107         return 0;
108
109     if (dest16->utf16_cap < src16->utf16_len)
110         icu_buf_utf16_resize(dest16, src16->utf16_len * 2);
111
112     u_strncpy(dest16->utf16, src16->utf16, src16->utf16_len);
113     dest16->utf16_len = src16->utf16_len;
114
115     return dest16;
116 }
117
118
119 void icu_buf_utf16_destroy(struct icu_buf_utf16 * buf16)
120 {
121     if (buf16){
122         if (buf16->utf16)
123             free(buf16->utf16);
124         free(buf16);
125     }
126 }
127
128
129
130
131
132
133 struct icu_buf_utf8 * icu_buf_utf8_create(size_t capacity)
134 {
135     struct icu_buf_utf8 * buf8 
136         = (struct icu_buf_utf8 *) malloc(sizeof(struct icu_buf_utf8));
137
138     buf8->utf8 = 0;
139     buf8->utf8_len = 0;
140     buf8->utf8_cap = 0;
141
142     if (capacity > 0){
143         buf8->utf8 = (uint8_t *) malloc(sizeof(uint8_t) * capacity);
144         buf8->utf8[0] = (uint8_t) 0;
145         buf8->utf8_cap = capacity;
146     }
147     return buf8;
148 }
149
150
151 struct icu_buf_utf8 * icu_buf_utf8_clear(struct icu_buf_utf8 * buf8)
152 {
153     if (buf8){
154         if (buf8->utf8)
155             buf8->utf8[0] = (uint8_t) 0;
156         buf8->utf8_len = 0;
157     }
158     return buf8;
159 }
160
161
162 struct icu_buf_utf8 * icu_buf_utf8_resize(struct icu_buf_utf8 * buf8,
163                                           size_t capacity)
164 {
165     if (!buf8)
166         return 0;
167
168     if (capacity >  0){
169         if (0 == buf8->utf8)
170             buf8->utf8 = (uint8_t *) malloc(sizeof(uint8_t) * capacity);
171         else
172             buf8->utf8 
173                 = (uint8_t *) realloc(buf8->utf8, sizeof(uint8_t) * capacity);
174
175         icu_buf_utf8_clear(buf8);
176         buf8->utf8_cap = capacity;
177     } 
178     else { 
179         if (buf8->utf8)
180             free(buf8->utf8);
181         buf8->utf8 = 0;
182         buf8->utf8_len = 0;
183         buf8->utf8_cap = 0;
184     }
185     
186     return buf8;
187 }
188
189
190 struct icu_buf_utf8 * icu_buf_utf8_copy(struct icu_buf_utf8 * dest8,
191                                           struct icu_buf_utf8 * src8)
192 {
193     if(!dest8 || !src8
194        || dest8 == src8)
195         return 0;
196     
197
198     if (dest8->utf8_cap < src8->utf8_len)
199         icu_buf_utf8_resize(dest8, src8->utf8_len * 2);
200
201     strncpy((char*) dest8->utf8, (char*) src8->utf8, src8->utf8_len);
202
203     return dest8;
204 }
205
206
207 const char *icu_buf_utf8_to_cstr(struct icu_buf_utf8 *src8)
208 {
209     if (!src8 || src8->utf8_len == 0)
210         return "";
211
212     if (src8->utf8_len == src8->utf8_cap)
213         src8 = icu_buf_utf8_resize(src8, src8->utf8_len * 2 + 1);
214
215     src8->utf8[src8->utf8_len] = '\0';
216
217     return (const char *) src8->utf8;
218 }
219
220
221 void icu_buf_utf8_destroy(struct icu_buf_utf8 * buf8)
222 {
223     if (buf8){
224         if (buf8->utf8)
225             free(buf8->utf8);
226         free(buf8);
227     }
228 }
229
230
231
232 UErrorCode icu_utf16_from_utf8(struct icu_buf_utf16 * dest16,
233                                struct icu_buf_utf8 * src8,
234                                UErrorCode * status)
235 {
236     int32_t utf16_len = 0;
237   
238     u_strFromUTF8(dest16->utf16, dest16->utf16_cap,
239                   &utf16_len,
240                   (const char *) src8->utf8, src8->utf8_len, status);
241   
242     /* check for buffer overflow, resize and retry */
243     if (*status == U_BUFFER_OVERFLOW_ERROR)
244     {
245         icu_buf_utf16_resize(dest16, utf16_len * 2);
246         *status = U_ZERO_ERROR;
247         u_strFromUTF8(dest16->utf16, dest16->utf16_cap,
248                       &utf16_len,
249                       (const char *) src8->utf8, src8->utf8_len, status);
250     }
251
252     if (U_SUCCESS(*status)  
253         && utf16_len <= dest16->utf16_cap)
254         dest16->utf16_len = utf16_len;
255     else 
256         icu_buf_utf16_clear(dest16);
257   
258     return *status;
259 }
260
261  
262
263 UErrorCode icu_utf16_from_utf8_cstr(struct icu_buf_utf16 * dest16,
264                                     const char * src8cstr,
265                                     UErrorCode * status)
266 {
267     size_t src8cstr_len = 0;
268     int32_t utf16_len = 0;
269
270     src8cstr_len = strlen(src8cstr);
271   
272     u_strFromUTF8(dest16->utf16, dest16->utf16_cap,
273                   &utf16_len,
274                   src8cstr, src8cstr_len, status);
275   
276     /* check for buffer overflow, resize and retry */
277     if (*status == U_BUFFER_OVERFLOW_ERROR)
278     {
279         icu_buf_utf16_resize(dest16, utf16_len * 2);
280         *status = U_ZERO_ERROR;
281         u_strFromUTF8(dest16->utf16, dest16->utf16_cap,
282                       &utf16_len,
283                       src8cstr, src8cstr_len, status);
284     }
285
286     if (U_SUCCESS(*status)  
287         && utf16_len <= dest16->utf16_cap)
288         dest16->utf16_len = utf16_len;
289     else 
290         icu_buf_utf16_clear(dest16);
291   
292     return *status;
293 }
294
295
296
297
298 UErrorCode icu_utf16_to_utf8(struct icu_buf_utf8 * dest8,
299                              struct icu_buf_utf16 * src16,
300                              UErrorCode * status)
301 {
302     int32_t utf8_len = 0;
303   
304     u_strToUTF8((char *) dest8->utf8, dest8->utf8_cap,
305                 &utf8_len,
306                 src16->utf16, src16->utf16_len, status);
307   
308     /* check for buffer overflow, resize and retry */
309     if (*status == U_BUFFER_OVERFLOW_ERROR)
310     {
311         icu_buf_utf8_resize(dest8, utf8_len * 2);
312         *status = U_ZERO_ERROR;
313         u_strToUTF8((char *) dest8->utf8, dest8->utf8_cap,
314                     &utf8_len,
315                     src16->utf16, src16->utf16_len, status);
316
317     }
318
319     if (U_SUCCESS(*status)  
320         && utf8_len <= dest8->utf8_cap)
321         dest8->utf8_len = utf8_len;
322     else 
323         icu_buf_utf8_clear(dest8);
324   
325     return *status;
326 }
327
328
329
330 struct icu_casemap * icu_casemap_create(const char *locale, char action,
331                                         UErrorCode *status)
332 {    
333     struct icu_casemap * casemap
334         = (struct icu_casemap *) malloc(sizeof(struct icu_casemap));
335     strcpy(casemap->locale, locale);
336     casemap->action = action;
337
338     switch(casemap->action) {    
339     case 'l':   
340     case 'L':   
341     case 'u':   
342     case 'U':   
343     case 't':  
344     case 'T':  
345     case 'f':  
346     case 'F':  
347         break;
348     default:
349         icu_casemap_destroy(casemap);
350         return 0;
351     }
352
353     return casemap;
354 }
355
356 void icu_casemap_destroy(struct icu_casemap * casemap)
357 {
358     if (casemap) 
359         free(casemap);
360 }
361
362
363 int icu_casemap_casemap(struct icu_casemap * casemap,
364                         struct icu_buf_utf16 * dest16,
365                         struct icu_buf_utf16 * src16,
366                         UErrorCode *status)
367 {
368     if(!casemap)
369         return 0;
370     
371     return icu_utf16_casemap(dest16, src16,
372                              casemap->locale, casemap->action, status);
373 }
374
375
376 int icu_utf16_casemap(struct icu_buf_utf16 * dest16,
377                       struct icu_buf_utf16 * src16,
378                       const char *locale, char action,
379                       UErrorCode *status)
380 {
381     int32_t dest16_len = 0;
382
383
384     if (!src16->utf16_len){           //guarding for empty source string
385         if (dest16->utf16)
386             dest16->utf16[0] = (UChar) 0;
387         dest16->utf16_len = 0;
388         return U_ZERO_ERROR;
389     }
390
391     
392     switch(action) {    
393     case 'l':    
394     case 'L':    
395         dest16_len = u_strToLower(dest16->utf16, dest16->utf16_cap,
396                                   src16->utf16, src16->utf16_len, 
397                                   locale, status);
398         break;
399     case 'u':    
400     case 'U':    
401         dest16_len = u_strToUpper(dest16->utf16, dest16->utf16_cap,
402                                   src16->utf16, src16->utf16_len, 
403                                   locale, status);
404         break;
405     case 't':    
406     case 'T':    
407         dest16_len = u_strToTitle(dest16->utf16, dest16->utf16_cap,
408                                   src16->utf16, src16->utf16_len,
409                                   0, locale, status);
410         break;
411     case 'f':    
412     case 'F':    
413         dest16_len = u_strFoldCase(dest16->utf16, dest16->utf16_cap,
414                                    src16->utf16, src16->utf16_len,
415                                    U_FOLD_CASE_DEFAULT, status);
416         break;
417         
418     default:
419         return U_UNSUPPORTED_ERROR;
420         break;
421     }
422
423     /* check for buffer overflow, resize and retry */
424     if (*status == U_BUFFER_OVERFLOW_ERROR
425         && dest16 != src16        /* do not resize if in-place conversion */
426         ){
427         icu_buf_utf16_resize(dest16, dest16_len * 2);
428         *status = U_ZERO_ERROR;
429
430     
431         switch(action) {    
432         case 'l':    
433         case 'L':    
434             dest16_len = u_strToLower(dest16->utf16, dest16->utf16_cap,
435                                       src16->utf16, src16->utf16_len, 
436                                       locale, status);
437             break;
438         case 'u':    
439         case 'U':    
440             dest16_len = u_strToUpper(dest16->utf16, dest16->utf16_cap,
441                                       src16->utf16, src16->utf16_len, 
442                                       locale, status);
443             break;
444         case 't':    
445         case 'T':    
446             dest16_len = u_strToTitle(dest16->utf16, dest16->utf16_cap,
447                                       src16->utf16, src16->utf16_len,
448                                       0, locale, status);
449             break;
450         case 'f':    
451         case 'F':    
452             dest16_len = u_strFoldCase(dest16->utf16, dest16->utf16_cap,
453                                        src16->utf16, src16->utf16_len,
454                                        U_FOLD_CASE_DEFAULT, status);
455             break;
456         
457         default:
458             return U_UNSUPPORTED_ERROR;
459             break;
460         }
461     }
462     
463     if (U_SUCCESS(*status)
464         && dest16_len <= dest16->utf16_cap)
465         dest16->utf16_len = dest16_len;
466     else {
467         if (dest16->utf16)
468             dest16->utf16[0] = (UChar) 0;
469         dest16->utf16_len = 0;
470     }
471   
472     return *status;
473 }
474
475
476
477 UErrorCode icu_sortkey8_from_utf16(UCollator *coll,
478                                    struct icu_buf_utf8 * dest8, 
479                                    struct icu_buf_utf16 * src16,
480                                    UErrorCode * status)
481
482   
483     int32_t sortkey_len = 0;
484
485     sortkey_len = ucol_getSortKey(coll, src16->utf16, src16->utf16_len,
486                                   dest8->utf8, dest8->utf8_cap);
487
488     /* check for buffer overflow, resize and retry */
489     if (sortkey_len > dest8->utf8_cap) {
490         icu_buf_utf8_resize(dest8, sortkey_len * 2);
491         sortkey_len = ucol_getSortKey(coll, src16->utf16, src16->utf16_len,
492                                       dest8->utf8, dest8->utf8_cap);
493     }
494
495     if (U_SUCCESS(*status)
496         && sortkey_len > 0)
497         dest8->utf8_len = sortkey_len;
498     else 
499         icu_buf_utf8_clear(dest8);
500     
501     return sortkey_len;
502 }
503
504
505
506 struct icu_tokenizer * icu_tokenizer_create(const char *locale, char action,
507                                             UErrorCode *status)
508 {
509     struct icu_tokenizer * tokenizer
510         = (struct icu_tokenizer *) malloc(sizeof(struct icu_tokenizer));
511
512     strcpy(tokenizer->locale, locale);
513     tokenizer->action = action;
514     tokenizer->bi = 0;
515     tokenizer->buf16 = 0;
516     tokenizer->token_count = 0;
517     tokenizer->token_id = 0;
518     tokenizer->token_start = 0;
519     tokenizer->token_end = 0;
520
521
522     switch(tokenizer->action) {    
523     case 'l':
524     case 'L':
525         tokenizer->bi
526             = ubrk_open(UBRK_LINE, tokenizer->locale,
527                         0, 0, status);
528         break;
529     case 's':
530     case 'S':
531         tokenizer->bi
532             = ubrk_open(UBRK_SENTENCE, tokenizer->locale,
533                         0, 0, status);
534         break;
535     case 'w':
536     case 'W':
537         tokenizer->bi 
538             = ubrk_open(UBRK_WORD, tokenizer->locale,
539                         0, 0, status);
540         break;
541     case 'c':
542     case 'C':
543         tokenizer->bi 
544             = ubrk_open(UBRK_CHARACTER, tokenizer->locale,
545                         0, 0, status);
546         break;
547     case 't':
548     case 'T':
549         tokenizer->bi 
550             = ubrk_open(UBRK_TITLE, tokenizer->locale,
551                         0, 0, status);
552         break;
553     default:
554         *status = U_UNSUPPORTED_ERROR;
555         return 0;
556         break;
557     }
558     
559     /* ICU error stuff is a very  funny business */
560     if (U_SUCCESS(*status))
561         return tokenizer;
562
563     /* freeing if failed */
564     icu_tokenizer_destroy(tokenizer);
565     return 0;
566 }
567
568 void icu_tokenizer_destroy(struct icu_tokenizer * tokenizer)
569 {
570     if (tokenizer) {
571         if (tokenizer->bi)
572             ubrk_close(tokenizer->bi);
573         free(tokenizer);
574     }
575 }
576
577 int icu_tokenizer_attach(struct icu_tokenizer * tokenizer, 
578                          struct icu_buf_utf16 * src16, 
579                          UErrorCode *status)
580 {
581     if (!tokenizer || !tokenizer->bi || !src16)
582         return 0;
583
584
585     tokenizer->buf16 = src16;
586     tokenizer->token_count = 0;
587     tokenizer->token_id = 0;
588     tokenizer->token_start = 0;
589     tokenizer->token_end = 0;
590
591     ubrk_setText(tokenizer->bi, src16->utf16, src16->utf16_len, status);
592     
593  
594     if (U_FAILURE(*status))
595         return 0;
596
597     return 1;
598 };
599
600 int32_t icu_tokenizer_next_token(struct icu_tokenizer * tokenizer, 
601                          struct icu_buf_utf16 * tkn16, 
602                          UErrorCode *status)
603 {
604     int32_t tkn_start = 0;
605     int32_t tkn_end = 0;
606     int32_t tkn_len = 0;
607     
608
609     if (!tokenizer || !tokenizer->bi
610         || !tokenizer->buf16 || !tokenizer->buf16->utf16_len)
611         return 0;
612
613     /*
614     never change tokenizer->buf16 and keep always invariant
615     0 <= tokenizer->token_start 
616        <= tokenizer->token_end 
617        <= tokenizer->buf16->utf16_len
618     returns length of token
619     */
620
621     if (0 == tokenizer->token_end) /* first call */
622         tkn_start = ubrk_first(tokenizer->bi);
623     else /* successive calls */
624         tkn_start = tokenizer->token_end;
625
626     /* get next position */
627     tkn_end = ubrk_next(tokenizer->bi);
628
629     /* repairing invariant at end of ubrk, which is UBRK_DONE = -1 */
630     if (UBRK_DONE == tkn_end)
631         tkn_end = tokenizer->buf16->utf16_len;
632
633     /* copy out if everything is well */
634     if(U_FAILURE(*status))
635         return 0;        
636     
637     /* everything OK, now update internal state */
638     tkn_len = tkn_end - tkn_start;
639
640     if (0 < tkn_len){
641         tokenizer->token_count++;
642         tokenizer->token_id++;
643     } else {
644         tokenizer->token_id = 0;    
645     }
646     tokenizer->token_start = tkn_start;
647     tokenizer->token_end = tkn_end;
648     
649
650     /* copying into token buffer if it exists */
651     if (tkn16){
652         if (tkn16->utf16_cap < tkn_len)
653             icu_buf_utf16_resize(tkn16, (size_t) tkn_len * 2);
654
655         u_strncpy(tkn16->utf16, &(tokenizer->buf16->utf16)[tkn_start], 
656                   tkn_len);
657
658         tkn16->utf16_len = tkn_len;
659     }
660
661     return tkn_len;
662 }
663
664
665 int32_t icu_tokenizer_token_id(struct icu_tokenizer * tokenizer)
666 {
667     return tokenizer->token_id;
668 }
669
670 int32_t icu_tokenizer_token_start(struct icu_tokenizer * tokenizer)
671 {
672     return tokenizer->token_start;
673 }
674
675 int32_t icu_tokenizer_token_end(struct icu_tokenizer * tokenizer)
676 {
677     return tokenizer->token_end;
678 }
679
680 int32_t icu_tokenizer_token_length(struct icu_tokenizer * tokenizer)
681 {
682     return (tokenizer->token_end - tokenizer->token_start);
683 }
684
685 int32_t icu_tokenizer_token_count(struct icu_tokenizer * tokenizer)
686 {
687     return tokenizer->token_count;
688 }
689
690
691
692 struct icu_normalizer * icu_normalizer_create(const char *rules, char action,
693                                               UErrorCode *status)
694 {
695
696     struct icu_normalizer * normalizer
697         = (struct icu_normalizer *) malloc(sizeof(struct icu_normalizer));
698
699     normalizer->action = action;
700     normalizer->trans = 0;
701     normalizer->rules16 =  icu_buf_utf16_create(0);
702     icu_utf16_from_utf8_cstr(normalizer->rules16, rules, status);
703      
704     switch(normalizer->action) {    
705     case 'f':
706     case 'F':
707         normalizer->trans
708             = utrans_openU(normalizer->rules16->utf16, 
709                            normalizer->rules16->utf16_len,
710                            UTRANS_FORWARD,
711                            0, 0, 
712                            normalizer->parse_error, status);
713         break;
714     case 'r':
715     case 'R':
716         normalizer->trans
717             = utrans_openU(normalizer->rules16->utf16,
718                            normalizer->rules16->utf16_len,
719                            UTRANS_REVERSE ,
720                            0, 0,
721                            normalizer->parse_error, status);
722         break;
723     default:
724         *status = U_UNSUPPORTED_ERROR;
725         return 0;
726         break;
727     }
728     
729     if (U_SUCCESS(*status))
730         return normalizer;
731
732     /* freeing if failed */
733     icu_normalizer_destroy(normalizer);
734     return 0;
735 }
736
737
738 void icu_normalizer_destroy(struct icu_normalizer * normalizer){
739     if (normalizer) {
740         if (normalizer->rules16) 
741             icu_buf_utf16_destroy(normalizer->rules16);
742         if (normalizer->trans)
743             utrans_close(normalizer->trans);
744         free(normalizer);
745     }
746 }
747
748
749
750 int icu_normalizer_normalize(struct icu_normalizer * normalizer,
751                              struct icu_buf_utf16 * dest16,
752                              struct icu_buf_utf16 * src16,
753                              UErrorCode *status)
754 {
755     if (!normalizer || !normalizer->trans 
756         || !src16
757         || !dest16)
758         return 0;
759
760     if (!src16->utf16_len){           //guarding for empty source string
761         icu_buf_utf16_clear(dest16);
762         return 0;
763     }
764
765     if (!icu_buf_utf16_copy(dest16, src16))
766         return 0;
767
768    
769     utrans_transUChars (normalizer->trans, 
770                         dest16->utf16, &(dest16->utf16_len),
771                         dest16->utf16_cap,
772                         0, &(src16->utf16_len), status);
773
774     if (U_FAILURE(*status))
775         icu_buf_utf16_clear(dest16);
776     
777     return dest16->utf16_len;
778 }
779
780
781
782
783 struct icu_chain_step * icu_chain_step_create(struct icu_chain * chain,
784                                               enum icu_chain_step_type type,
785                                               const uint8_t * rule,
786                                               struct icu_buf_utf16 * buf16,
787                                               UErrorCode *status)
788 {
789     struct icu_chain_step * step = 0;
790     
791     if(!chain || !type || !rule)
792         return 0;
793
794     step = (struct icu_chain_step *) malloc(sizeof(struct icu_chain_step));
795
796     step->type = type;
797
798     step->buf16 = buf16;
799
800     /* create auxilary objects */
801     switch(step->type) {
802     case ICU_chain_step_type_display:
803         break;
804     case ICU_chain_step_type_casemap:
805         step->u.casemap = icu_casemap_create((char *) chain->locale, 
806                                              (char) rule[0], status);
807         break;
808     case ICU_chain_step_type_normalize:
809         step->u.normalizer = icu_normalizer_create((char *) rule, 'f', status);
810         break;
811     case ICU_chain_step_type_tokenize:
812         step->u.tokenizer = icu_tokenizer_create((char *) chain->locale, 
813                                                  (char) rule[0], status);
814         break;
815     default:
816         break;
817     }
818
819     return step;
820 }
821
822
823 void icu_chain_step_destroy(struct icu_chain_step * step){
824     
825     if (!step)
826         return;
827
828     icu_chain_step_destroy(step->previous);
829
830     switch(step->type) {
831     case ICU_chain_step_type_display:
832         break;
833     case ICU_chain_step_type_casemap:
834         icu_casemap_destroy(step->u.casemap);
835         icu_buf_utf16_destroy(step->buf16);
836         break;
837     case ICU_chain_step_type_normalize:
838         icu_normalizer_destroy(step->u.normalizer);
839         icu_buf_utf16_destroy(step->buf16);
840         break;
841     case ICU_chain_step_type_tokenize:
842         icu_tokenizer_destroy(step->u.tokenizer);
843         icu_buf_utf16_destroy(step->buf16);
844         break;
845     default:
846         break;
847     }
848     free(step);
849 }
850
851
852
853 struct icu_chain * icu_chain_create(const char *locale, 
854                                     int sort,
855                                     UErrorCode * status)
856 {
857
858     struct icu_chain * chain 
859         = (struct icu_chain *) malloc(sizeof(struct icu_chain));
860
861     strncpy((char *) chain->locale, (const char *) locale, 16);    
862     chain->locale[16 - 1] = '\0';
863
864     chain->sort = sort;
865
866     chain->coll = ucol_open((const char *) chain->locale, status);
867
868     if (U_FAILURE(*status))
869         return 0;
870
871
872     chain->token_count = 0;
873
874     chain->src8cstr = 0;
875
876     chain->display8 = icu_buf_utf8_create(0);
877     chain->norm8 = icu_buf_utf8_create(0);
878     chain->sort8 = icu_buf_utf8_create(0);
879
880     chain->src16 = icu_buf_utf16_create(0);
881
882     chain->steps = 0;
883
884     return chain;
885 }
886
887
888 void icu_chain_destroy(struct icu_chain * chain)
889 {
890     if (chain){
891
892         if (chain->coll)
893             ucol_close(chain->coll);
894
895         icu_buf_utf8_destroy(chain->display8);
896         icu_buf_utf8_destroy(chain->norm8);
897         icu_buf_utf8_destroy(chain->sort8);
898         
899         icu_buf_utf16_destroy(chain->src16);
900     
901         icu_chain_step_destroy(chain->steps);
902         free(chain);
903     }
904 }
905
906
907
908 struct icu_chain * icu_chain_xml_config(const xmlNode *xml_node, 
909                                         const char *locale, 
910                                         int sort,
911                                         UErrorCode * status){
912
913     xmlNode *node = 0;
914     struct icu_chain * chain = 0;
915    
916     if (!xml_node 
917         ||xml_node->type != XML_ELEMENT_NODE 
918         // || strcmp((const char *) xml_node->name, "icu_chain")
919         )
920
921         return 0;
922
923         chain = icu_chain_create(locale, sort, status);
924
925     if (!chain)
926         return 0;
927
928         
929     for (node = xml_node->children; node; node = node->next)
930     {
931         xmlChar *xml_rule;
932         struct icu_chain_step * step = 0;
933
934         if (node->type != XML_ELEMENT_NODE)
935             continue;
936
937         xml_rule = xmlGetProp(node, (xmlChar *) "rule");
938
939         if (!strcmp((const char *) node->name, 
940                     (const char *) "casemap")){
941             step = icu_chain_insert_step(chain, ICU_chain_step_type_casemap, 
942                                          (const uint8_t *) xml_rule, status);
943         }
944         else if (!strcmp((const char *) node->name,
945                          (const char *) "normalize")){
946             step = icu_chain_insert_step(chain, ICU_chain_step_type_normalize, 
947                                          (const uint8_t *) xml_rule, status);
948         }
949         else if (!strcmp((const char *) node->name,
950                          (const char *) "tokenize")){
951             step = icu_chain_insert_step(chain, ICU_chain_step_type_tokenize, 
952                                          (const uint8_t *) xml_rule, status);
953         }
954         else if (!strcmp((const char *) node->name,
955                          (const char *) "display")){
956             step = icu_chain_insert_step(chain, ICU_chain_step_type_display, 
957                                          (const uint8_t *) "", status);
958         }
959         xmlFree(xml_rule);
960         if (!step || U_FAILURE(*status)){
961             icu_chain_destroy(chain);
962             return 0;
963         }
964         
965
966     }
967
968     return chain;
969 }
970
971
972
973 struct icu_chain_step * icu_chain_insert_step(struct icu_chain * chain,
974                                               enum icu_chain_step_type type,
975                                               const uint8_t * rule,
976                                               UErrorCode *status)
977 {    
978     struct icu_chain_step * step = 0;
979     struct icu_buf_utf16 * src16 = 0;
980     struct icu_buf_utf16 * buf16 = 0;
981
982     if (!chain || !type || !rule)
983         return 0;
984
985     /* assign utf16 src buffers as needed */
986     if (chain->steps && chain->steps->buf16)
987         src16 = chain->steps->buf16;
988     else if (chain->src16)
989         src16 = chain->src16;
990     else
991         return 0;
992
993     
994     /* create utf16 destination buffers as needed, or */
995     switch(type) {
996     case ICU_chain_step_type_display:
997         buf16 = src16;
998         break;
999     case ICU_chain_step_type_casemap:
1000         buf16 = icu_buf_utf16_create(0);
1001         break;
1002     case ICU_chain_step_type_normalize:
1003         buf16 = icu_buf_utf16_create(0);
1004         break;
1005     case ICU_chain_step_type_tokenize:
1006         buf16 = icu_buf_utf16_create(0);
1007         break;
1008     default:
1009         break;
1010     }
1011
1012     /* create actual chain step with this buffer */
1013     step = icu_chain_step_create(chain, type, rule, buf16, status);
1014
1015     step->previous = chain->steps;
1016     chain->steps = step;
1017
1018     return step;
1019 }
1020
1021
1022 int icu_chain_step_next_token(struct icu_chain * chain,
1023                               struct icu_chain_step * step,
1024                               UErrorCode *status)
1025 {
1026     struct icu_buf_utf16 * src16 = 0;
1027     int got_new_token = 0;
1028
1029     if (!chain || !chain->src16 || !step || !step->more_tokens)
1030         return 0;
1031
1032     /* assign utf16 src buffers as neeed, advance in previous steps
1033        tokens until non-zero token met, and setting stop condition */
1034
1035     if (step->previous){
1036         src16 = step->previous->buf16;
1037         /* tokens might be killed in previous steps, therefore looping */
1038
1039         while (step->need_new_token 
1040                && step->previous->more_tokens
1041                && !got_new_token)
1042             got_new_token
1043                 = icu_chain_step_next_token(chain, step->previous, status);
1044     }
1045     else { /* first step can only work once on chain->src16 input buffer */
1046         src16 = chain->src16;
1047         step->more_tokens = 0;
1048         got_new_token = 1;
1049     }
1050
1051     if (!src16)
1052         return 0;
1053
1054     /* stop if nothing to process */
1055     if (step->need_new_token && !got_new_token){
1056         step->more_tokens = 0;
1057         return 0;
1058     }
1059
1060     /* either an old token not finished yet, or a new token, thus
1061        perform the work, eventually put this steps output in 
1062        step->buf16 or the chains UTF8 output buffers  */
1063
1064     switch(step->type) {
1065     case ICU_chain_step_type_display:
1066         icu_utf16_to_utf8(chain->display8, src16, status);
1067         break;
1068     case ICU_chain_step_type_casemap:
1069         icu_casemap_casemap(step->u.casemap,
1070                             step->buf16, src16, status);
1071         break;
1072     case ICU_chain_step_type_normalize:
1073         icu_normalizer_normalize(step->u.normalizer,
1074                                  step->buf16, src16, status);
1075         break;
1076     case ICU_chain_step_type_tokenize:
1077         /* attach to new src16 token only first time during splitting */
1078         if (step->need_new_token){
1079             icu_tokenizer_attach(step->u.tokenizer, src16, status);
1080             step->need_new_token = 0;
1081         }
1082
1083
1084         /* splitting one src16 token into multiple buf16 tokens */
1085         step->more_tokens
1086             = icu_tokenizer_next_token(step->u.tokenizer,
1087                                        step->buf16, status);
1088
1089         /* make sure to get new previous token if this one had been used up
1090            by recursive call to _same_ step */
1091
1092         if (!step->more_tokens){
1093             step->more_tokens = icu_chain_step_next_token(chain, step, status);
1094             return step->more_tokens;  // avoid one token count too much!
1095         }
1096
1097         break;
1098     default:
1099         return 0;
1100         break;
1101     }
1102
1103     if (U_FAILURE(*status))
1104         return 0;
1105
1106     /* if token disappered into thin air, tell caller */
1107     /* if (!step->buf16->utf16_len && !step->more_tokens) */ 
1108     /*    return 0; */ 
1109
1110     return 1;
1111 }
1112
1113
1114 int icu_chain_assign_cstr(struct icu_chain * chain,
1115                           const char * src8cstr, 
1116                           UErrorCode *status)
1117 {
1118     struct icu_chain_step * stp = 0; 
1119
1120     if (!chain || !src8cstr)
1121         return 0;
1122
1123     chain->src8cstr = src8cstr;
1124
1125     stp = chain->steps;
1126     
1127     /* clear token count */
1128     chain->token_count = 0;
1129
1130     /* clear all steps stop states */
1131     while (stp){
1132         stp->more_tokens = 1;
1133         stp->need_new_token = 1;
1134         stp = stp->previous;
1135     }
1136     
1137     /* finally convert UTF8 to UTF16 string if needed */
1138     if (chain->steps || chain->sort)
1139         icu_utf16_from_utf8_cstr(chain->src16, chain->src8cstr, status);
1140             
1141     if (U_FAILURE(*status))
1142         return 0;
1143
1144     return 1;
1145 }
1146
1147
1148
1149 int icu_chain_next_token(struct icu_chain * chain,
1150                          UErrorCode *status)
1151 {
1152     int got_token = 0;
1153     
1154     if (!chain)
1155         return 0;
1156
1157     /* special case with no steps - same as index type binary */
1158     if (!chain->steps){
1159         if (chain->token_count)
1160             return 0;
1161         else {
1162             chain->token_count++;
1163             
1164             if (chain->sort)
1165                 icu_sortkey8_from_utf16(chain->coll,
1166                                         chain->sort8, chain->steps->buf16,
1167                                         status);
1168             return chain->token_count;
1169         }
1170     }
1171     /* usual case, one or more icu chain steps existing */
1172     else {
1173
1174         while(!got_token && chain->steps && chain->steps->more_tokens)
1175             got_token = icu_chain_step_next_token(chain, chain->steps, status);
1176
1177         if (got_token){
1178             chain->token_count++;
1179
1180             icu_utf16_to_utf8(chain->norm8, chain->steps->buf16, status);
1181             
1182             if (chain->sort)
1183                 icu_sortkey8_from_utf16(chain->coll,
1184                                         chain->sort8, chain->steps->buf16,
1185                                         status);
1186             
1187             return chain->token_count;
1188         }
1189     }
1190         
1191     return 0;
1192 }
1193
1194 int icu_chain_token_number(struct icu_chain * chain)
1195 {
1196     if (!chain)
1197         return 0;
1198     
1199     return chain->token_count;
1200 }
1201
1202
1203 const char * icu_chain_token_display(struct icu_chain * chain)
1204 {
1205     if (chain->display8)
1206         return icu_buf_utf8_to_cstr(chain->display8);
1207     
1208     return 0;
1209 }
1210
1211 const char * icu_chain_token_norm(struct icu_chain * chain)
1212 {
1213     if (!chain->steps)
1214         return chain->src8cstr;
1215
1216     if (chain->norm8)
1217         return icu_buf_utf8_to_cstr(chain->norm8);
1218     
1219     return 0;
1220 }
1221
1222 const char * icu_chain_token_sortkey(struct icu_chain * chain)
1223 {
1224     if (chain->sort8)
1225         return icu_buf_utf8_to_cstr(chain->sort8);
1226     
1227     return 0;
1228 }
1229
1230 const UCollator * icu_chain_get_coll(struct icu_chain * chain)
1231 {
1232     return chain->coll;
1233 }
1234
1235
1236
1237
1238 #endif /* HAVE_ICU */
1239
1240
1241
1242
1243 /*
1244  * Local variables:
1245  * c-basic-offset: 4
1246  * indent-tabs-mode: nil
1247  * End:
1248  * vim: shiftwidth=4 tabstop=8 expandtab
1249  */