1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2013 Index Data
3 * See the file LICENSE for details.
16 #include <yaz/xmalloc.h>
18 #include <yaz/icu_I18N.h>
20 #include <yaz/stemmer.h>
24 #include <yaz/nmem_xml.h>
30 #include <unicode/ustring.h> /* some more string fcns*/
31 #include <unicode/uchar.h> /* char names */
33 enum icu_chain_step_type {
34 ICU_chain_step_type_none,
35 ICU_chain_step_type_display, /* convert to utf8 display format */
36 ICU_chain_step_type_casemap, /* apply utf16 charmap */
37 ICU_chain_step_type_transform, /* apply utf16 transform */
38 ICU_chain_step_type_tokenize, /* apply utf16 tokenization */
39 ICU_chain_step_type_transliterate, /* apply utf16 tokenization */
40 YAZ_chain_step_type_stemming, /* apply utf16 stemming (YAZ) */
41 ICU_chain_step_type_join
46 /* type and action object */
47 enum icu_chain_step_type type;
49 struct icu_casemap *casemap;
50 struct icu_transform *transform;
51 struct icu_tokenizer *tokenizer;
52 yaz_stemmer_p stemmer;
53 struct icu_buf_utf16 *join;
55 struct icu_chain_step *previous;
66 /* linked list of chain steps */
67 struct icu_chain_step *csteps;
70 int icu_check_status(UErrorCode status)
72 if (U_FAILURE(status))
74 yaz_log(YLOG_WARN, "ICU: %d %s\n", status, u_errorName(status));
80 static struct icu_chain_step *icu_chain_insert_step(
81 struct icu_chain *chain, enum icu_chain_step_type type,
82 const char *rule, UErrorCode *status)
84 struct icu_chain_step *step = 0;
89 step = (struct icu_chain_step *) xmalloc(sizeof(*step));
94 case ICU_chain_step_type_display:
96 case ICU_chain_step_type_casemap:
98 step->u.casemap = icu_casemap_create(rule[0], status);
100 case ICU_chain_step_type_transform:
102 /* rule omitted. Only ID used */
103 step->u.transform = icu_transform_create(rule, 'f', 0, status);
105 case ICU_chain_step_type_tokenize:
107 step->u.tokenizer = icu_tokenizer_create(chain->locale, rule[0], status);
109 case ICU_chain_step_type_transliterate:
111 /* we pass a dummy ID to utrans_openU.. */
112 step->u.transform = icu_transform_create("custom", 'f', rule, status);
114 case YAZ_chain_step_type_stemming:
116 step->u.stemmer = yaz_stemmer_create(chain->locale, rule, status);
118 case ICU_chain_step_type_join:
120 step->u.join = icu_buf_utf16_create(0);
121 icu_utf16_from_utf8_cstr(step->u.join, rule, status);
126 step->previous = chain->csteps;
127 chain->csteps = step;
133 static void icu_chain_step_destroy(struct icu_chain_step *step)
138 icu_chain_step_destroy(step->previous);
142 case ICU_chain_step_type_display:
144 case ICU_chain_step_type_casemap:
145 icu_casemap_destroy(step->u.casemap);
147 case ICU_chain_step_type_transform:
148 case ICU_chain_step_type_transliterate:
149 icu_transform_destroy(step->u.transform);
151 case ICU_chain_step_type_tokenize:
152 icu_tokenizer_destroy(step->u.tokenizer);
154 case YAZ_chain_step_type_stemming:
155 yaz_stemmer_destroy(step->u.stemmer);
157 case ICU_chain_step_type_join:
158 icu_buf_utf16_destroy(step->u.join);
166 struct icu_chain_step *icu_chain_step_clone(struct icu_chain_step *old)
168 struct icu_chain_step *step = 0;
169 struct icu_chain_step **sp = &step;
172 *sp = (struct icu_chain_step *) xmalloc(sizeof(**sp));
173 (*sp)->type = old->type;
177 case ICU_chain_step_type_display:
179 case ICU_chain_step_type_casemap:
180 (*sp)->u.casemap = icu_casemap_clone(old->u.casemap);
182 case ICU_chain_step_type_transform:
183 case ICU_chain_step_type_transliterate:
184 (*sp)->u.transform = icu_transform_clone(old->u.transform);
186 case ICU_chain_step_type_tokenize:
187 (*sp)->u.tokenizer = icu_tokenizer_clone(old->u.tokenizer);
189 case YAZ_chain_step_type_stemming:
190 (*sp)->u.stemmer = yaz_stemmer_clone(old->u.stemmer);
192 case ICU_chain_step_type_none:
194 case ICU_chain_step_type_join:
195 (*sp)->u.join = icu_buf_utf16_create(0);
196 (*sp)->u.join = icu_buf_utf16_copy((*sp)->u.join, old->u.join);
200 sp = &(*sp)->previous;
206 struct icu_chain *icu_chain_create(const char *locale, int sort,
209 struct icu_chain *chain;
210 UCollator *coll = ucol_open(locale, status);
212 if (U_FAILURE(*status))
215 chain = (struct icu_chain *) xmalloc(sizeof(*chain));
217 chain->locale = xstrdup(locale);
225 void icu_chain_destroy(struct icu_chain *chain)
230 ucol_close(chain->coll);
233 icu_iter_destroy(chain->iter);
234 icu_chain_step_destroy(chain->csteps);
235 xfree(chain->locale);
240 struct icu_chain *icu_chain_xml_config(const xmlNode *xml_node,
246 struct icu_chain *chain = 0;
249 *status = U_ZERO_ERROR;
251 if (xml_node && xml_node->type == XML_ELEMENT_NODE)
253 xmlChar *xml_locale = xmlGetProp((xmlNode *) xml_node,
254 (xmlChar *) "locale");
257 chain = icu_chain_create((const char *) xml_locale, sort, status);
265 nmem = nmem_create();
266 for (node = xml_node->children; node; node = node->next)
269 struct icu_chain_step *step = 0;
270 struct _xmlAttr *attr;
273 if (node->type != XML_ELEMENT_NODE)
276 for (attr = node->properties; attr; attr = attr->next)
278 if (!strcmp((const char *) attr->name, "rule"))
280 rule = nmem_text_node_cdata(attr->children, nmem);
284 yaz_log(YLOG_WARN, "Unsupported attribute '%s' for "
285 "element '%s'", attr->name, node->name);
289 if (!rule && node->children)
290 rule = nmem_text_node_cdata(node->children, nmem);
292 if (!rule && strcmp((const char *) node->name, "display"))
294 yaz_log(YLOG_WARN, "Missing attribute rule for element %s",
295 (const char *) node->name);
299 if (!strcmp((const char *) node->name, "casemap"))
300 step = icu_chain_insert_step(chain,
301 ICU_chain_step_type_casemap,
303 else if (!strcmp((const char *) node->name, "transform"))
304 step = icu_chain_insert_step(chain,
305 ICU_chain_step_type_transform,
307 else if (!strcmp((const char *) node->name, "transliterate"))
308 step = icu_chain_insert_step(chain,
309 ICU_chain_step_type_transliterate,
311 else if (!strcmp((const char *) node->name, "tokenize"))
312 step = icu_chain_insert_step(chain, ICU_chain_step_type_tokenize,
314 else if (!strcmp((const char *) node->name, "display"))
315 step = icu_chain_insert_step(chain, ICU_chain_step_type_display,
317 else if (!strcmp((const char *) node->name, "stemming"))
318 step = icu_chain_insert_step(chain, YAZ_chain_step_type_stemming,
320 else if (!strcmp((const char *) node->name, "join"))
321 step = icu_chain_insert_step(chain, ICU_chain_step_type_join,
323 else if (!strcmp((const char *) node->name, "normalize"))
325 yaz_log(YLOG_WARN, "Element %s is deprecated. "
326 "Use transform instead", node->name);
327 step = icu_chain_insert_step(chain, ICU_chain_step_type_transform,
330 else if (!strcmp((const char *) node->name, "index")
331 || !strcmp((const char *) node->name, "sortkey"))
333 yaz_log(YLOG_WARN, "Element %s is no longer needed. "
334 "Remove it from the configuration", node->name);
338 yaz_log(YLOG_WARN, "Unknown element %s", node->name);
344 yaz_log(YLOG_WARN, "Step not created for %s", node->name);
347 if (step && U_FAILURE(*status))
356 icu_chain_destroy(chain);
363 struct icu_chain *chain;
364 struct icu_buf_utf16 *last;
366 struct icu_buf_utf8 *display;
367 struct icu_buf_utf8 *sort8;
368 struct icu_buf_utf8 *result;
369 struct icu_buf_utf16 *input;
371 struct icu_chain_step *steps;
374 void icu_utf16_print(struct icu_buf_utf16 *src16)
376 UErrorCode status = U_ZERO_ERROR;
378 struct icu_buf_utf8 *dst8 = icu_buf_utf8_create(0);
379 icu_utf16_to_utf8(dst8, src16, &status);
381 if (U_FAILURE(status))
387 p = icu_buf_utf8_to_cstr(dst8);
390 icu_buf_utf8_destroy(dst8);
393 struct icu_buf_utf16 *icu_iter_invoke(yaz_icu_iter_t iter,
394 struct icu_chain_step *step,
395 struct icu_buf_utf16 *src)
401 struct icu_buf_utf16 *dst = icu_iter_invoke(iter, step->previous, src);
405 case ICU_chain_step_type_casemap:
408 struct icu_buf_utf16 *src = dst;
410 dst = icu_buf_utf16_create(0);
411 icu_casemap_casemap(step->u.casemap, dst, src, &iter->status,
412 iter->chain->locale);
413 icu_buf_utf16_destroy(src);
416 case ICU_chain_step_type_tokenize:
419 struct icu_buf_utf16 *src = dst;
421 icu_tokenizer_attach(step->u.tokenizer, src, &iter->status);
422 icu_buf_utf16_destroy(src);
424 dst = icu_buf_utf16_create(0);
425 iter->status = U_ZERO_ERROR;
426 if (!icu_tokenizer_next_token(step->u.tokenizer, dst, &iter->status))
428 icu_buf_utf16_destroy(dst);
432 case ICU_chain_step_type_transform:
433 case ICU_chain_step_type_transliterate:
436 struct icu_buf_utf16 *src = dst;
437 dst = icu_buf_utf16_create(0);
438 icu_transform_trans(step->u.transform, dst, src, &iter->status);
439 icu_buf_utf16_destroy(src);
442 case ICU_chain_step_type_display:
444 icu_utf16_to_utf8(iter->display, dst, &iter->status);
446 case YAZ_chain_step_type_stemming:
449 struct icu_buf_utf16 *src = dst;
450 dst = icu_buf_utf16_create(0);
451 yaz_stemmer_stem(step->u.stemmer, dst, src, &iter->status);
452 icu_buf_utf16_destroy(src);
455 case ICU_chain_step_type_join:
460 struct icu_buf_utf16 *dst1 =
461 icu_iter_invoke(iter, step->previous, 0);
465 dst = icu_buf_utf16_append(dst, step->u.join);
466 dst = icu_buf_utf16_append(dst, dst1);
467 icu_buf_utf16_destroy(dst1);
478 yaz_icu_iter_t icu_iter_create(struct icu_chain *chain)
480 yaz_icu_iter_t iter = xmalloc(sizeof(*iter));
482 iter->status = U_ZERO_ERROR;
483 iter->display = icu_buf_utf8_create(0);
484 iter->sort8 = icu_buf_utf8_create(0);
485 iter->result = icu_buf_utf8_create(0);
486 iter->last = 0; /* no last returned string (yet) */
487 iter->steps = icu_chain_step_clone(chain->csteps);
493 void icu_iter_first(yaz_icu_iter_t iter, const char *src8cstr)
496 icu_buf_utf16_destroy(iter->input);
497 iter->input = icu_buf_utf16_create(0);
498 iter->token_count = 0;
499 /* fill and assign input string.. It will be 0 after
501 icu_utf16_from_utf8_cstr(iter->input, src8cstr, &iter->status);
504 void icu_iter_destroy(yaz_icu_iter_t iter)
508 icu_buf_utf8_destroy(iter->display);
509 icu_buf_utf8_destroy(iter->sort8);
510 icu_buf_utf8_destroy(iter->result);
512 icu_buf_utf16_destroy(iter->input);
513 icu_chain_step_destroy(iter->steps);
518 int icu_iter_next(yaz_icu_iter_t iter)
520 if (!iter->input && iter->last == 0)
524 /* on first call, iter->input is the input string. Thereafter: 0. */
525 assert(iter->steps || !iter->chain->csteps);
526 iter->last = icu_iter_invoke(iter, iter->steps, iter->input);
534 if (iter->chain->sort)
536 icu_sortkey8_from_utf16(iter->chain->coll,
537 iter->sort8, iter->last,
540 icu_utf16_to_utf8(iter->result, iter->last, &iter->status);
541 icu_buf_utf16_destroy(iter->last);
547 const char *icu_iter_get_norm(yaz_icu_iter_t iter)
549 return icu_buf_utf8_to_cstr(iter->result);
552 const char *icu_iter_get_sortkey(yaz_icu_iter_t iter)
554 return icu_buf_utf8_to_cstr(iter->sort8);
557 const char *icu_iter_get_display(yaz_icu_iter_t iter)
559 return icu_buf_utf8_to_cstr(iter->display);
562 int icu_iter_get_token_number(yaz_icu_iter_t iter)
564 return iter->token_count;
567 int icu_chain_assign_cstr(struct icu_chain *chain, const char *src8cstr,
571 icu_iter_destroy(chain->iter);
572 chain->iter = icu_iter_create(chain);
573 icu_iter_first(chain->iter, src8cstr);
577 int icu_chain_next_token(struct icu_chain *chain, UErrorCode *status)
579 *status = U_ZERO_ERROR;
580 return icu_iter_next(chain->iter);
583 int icu_chain_token_number(struct icu_chain *chain)
585 if (chain && chain->iter)
586 return chain->iter->token_count;
590 const char *icu_chain_token_display(struct icu_chain *chain)
593 return icu_iter_get_display(chain->iter);
597 const char *icu_chain_token_norm(struct icu_chain *chain)
600 return icu_iter_get_norm(chain->iter);
604 const char *icu_chain_token_sortkey(struct icu_chain *chain)
607 return icu_iter_get_sortkey(chain->iter);
611 #endif /* YAZ_HAVE_ICU */
616 * c-file-style: "Stroustrup"
617 * indent-tabs-mode: nil
619 * vim: shiftwidth=4 tabstop=8 expandtab