ICU rules may be specified as CDATA below the rule
[yaz-moved-to-github.git] / src / icu_chain.c
index c9c05d2..c6f21ef 100644 (file)
@@ -1,5 +1,5 @@
 /* This file is part of the YAZ toolkit.
- * Copyright (C) 1995-2009 Index Data
+ * Copyright (C) 1995-2010 Index Data
  * See the file LICENSE for details.
  */
 
@@ -18,7 +18,8 @@
 #include <yaz/icu_I18N.h>
 
 #include <yaz/log.h>
-
+#include <yaz/nmem.h>
+#include <yaz/nmem_xml.h>
 #include <string.h>
 #include <stdlib.h>
 #include <stdio.h>
@@ -41,26 +42,23 @@ struct icu_chain_step
     /* type and action object */
     enum icu_chain_step_type type;
     union {
-       struct icu_casemap * casemap;
-       struct icu_transform * transform;
-       struct icu_tokenizer * tokenizer;  
+       struct icu_casemap *casemap;
+       struct icu_transform *transform;
+       struct icu_tokenizer *tokenizer;  
     } u;
-    struct icu_chain_step * previous;
+    struct icu_chain_step *previous;
 };
 
 struct icu_chain
 {
-    struct icu_iter *iter;
+    yaz_icu_iter_t iter;
     char *locale;
     int sort;
 
-    UCollator * coll;
-    
-    /* utf8 output buffers */
-    struct icu_buf_utf8 * norm8;
+    UCollator *coll;
     
     /* linked list of chain steps */
-    struct icu_chain_step * steps;
+    struct icu_chain_step *csteps;
 };
 
 int icu_check_status(UErrorCode status)
@@ -74,16 +72,15 @@ int icu_check_status(UErrorCode status)
 }
 
 static struct icu_chain_step *icu_chain_step_create(
-    struct icu_chain * chain,  enum icu_chain_step_type type,
-    const uint8_t * rule, 
-    UErrorCode *status)
+    struct icu_chain *chain,  enum icu_chain_step_type type,
+    const uint8_t *rule, UErrorCode *status)
 {
-    struct icu_chain_step * step = 0;
+    struct icu_chain_step *step = 0;
     
-    if(!chain || !type || !rule)
+    if (!chain || !type || !rule)
         return 0;
 
-    step = (struct icu_chain_step *) xmalloc(sizeof(struct icu_chain_step));
+    step = (struct icu_chain_step *) xmalloc(sizeof(*step));
 
     step->type = type;
     /* create auxilary objects */
@@ -115,7 +112,7 @@ static struct icu_chain_step *icu_chain_step_create(
 }
 
 
-static void icu_chain_step_destroy(struct icu_chain_step * step)
+static void icu_chain_step_destroy(struct icu_chain_step *step)
 {
     if (!step)
         return;
@@ -142,11 +139,44 @@ static void icu_chain_step_destroy(struct icu_chain_step * step)
     xfree(step);
 }
 
+struct icu_chain_step *icu_chain_step_clone(struct icu_chain_step *old)
+{
+    struct icu_chain_step *step = 0;
+    struct icu_chain_step **sp = &step;
+    while (old)
+    {
+        *sp = (struct icu_chain_step *) xmalloc(sizeof(**sp));
+        (*sp)->type = old->type;
+        
+        switch ((*sp)->type)
+        {
+        case ICU_chain_step_type_display:
+            break;
+        case ICU_chain_step_type_casemap:
+            (*sp)->u.casemap = icu_casemap_clone(old->u.casemap);
+            break;
+        case ICU_chain_step_type_transform:
+        case ICU_chain_step_type_transliterate:
+            (*sp)->u.transform = icu_transform_clone(old->u.transform);
+            break;
+        case ICU_chain_step_type_tokenize:
+            (*sp)->u.tokenizer = icu_tokenizer_clone(old->u.tokenizer);
+            break;
+        case ICU_chain_step_type_none:
+            break;
+        }
+        old = old->previous;
+        sp = &(*sp)->previous;
+    }
+    *sp = 0;
+    return step;
+}
+
 struct icu_chain *icu_chain_create(const char *locale, int sort,
-                                   UErrorCode * status)
+                                   UErrorCode *status)
 {
-    struct icu_chain * chain 
-        = (struct icu_chain *) xmalloc(sizeof(struct icu_chain));
+    struct icu_chain *chain 
+        = (struct icu_chain *) xmalloc(sizeof(*chain));
 
     *status = U_ZERO_ERROR;
 
@@ -160,38 +190,38 @@ struct icu_chain *icu_chain_create(const char *locale, int sort,
     if (U_FAILURE(*status))
         return 0;
 
-    chain->norm8 = icu_buf_utf8_create(0);
-    chain->steps = 0;
+    chain->csteps = 0;
 
     return chain;
 }
 
-void icu_chain_destroy(struct icu_chain * chain)
+void icu_chain_destroy(struct icu_chain *chain)
 {
     if (chain)
     {
         if (chain->coll)
             ucol_close(chain->coll);
 
-        icu_buf_utf8_destroy(chain->norm8);
         if (chain->iter)
             icu_iter_destroy(chain->iter);
-        icu_chain_step_destroy(chain->steps);
+        icu_chain_step_destroy(chain->csteps);
         xfree(chain->locale);
         xfree(chain);
     }
 }
 
 static struct icu_chain_step *icu_chain_insert_step(
-    struct icu_chain * chain, enum icu_chain_step_type type,
-    const uint8_t * rule, UErrorCode *status);
+    struct icu_chain *chain, enum icu_chain_step_type type,
+    const uint8_t *rule, UErrorCode *status);
 
-struct icu_chain * icu_chain_xml_config(const xmlNode *xml_node, 
-                                        int sort,
-                                        UErrorCode * status)
+struct icu_chain *icu_chain_xml_config(const xmlNode *xml_node, 
+                                       int sort,
+                                       UErrorCode *status)
 {
     xmlNode *node = 0;
-    struct icu_chain * chain = 0;
+    int no_errors = 0;
+    struct icu_chain *chain = 0;
+    NMEM nmem = 0;
    
     *status = U_ZERO_ERROR;
 
@@ -199,8 +229,8 @@ struct icu_chain * icu_chain_xml_config(const xmlNode *xml_node,
         return 0;
     
     {
-        xmlChar * xml_locale = xmlGetProp((xmlNode *) xml_node, 
-                                          (xmlChar *) "locale");
+        xmlChar *xml_locale = xmlGetProp((xmlNode *) xml_node, 
+                                         (xmlChar *) "locale");
         
         if (xml_locale)
         {
@@ -212,28 +242,53 @@ struct icu_chain * icu_chain_xml_config(const xmlNode *xml_node,
     if (!chain)
         return 0;
 
+    nmem = nmem_create();
     for (node = xml_node->children; node; node = node->next)
     {
-        xmlChar *xml_rule;
-        struct icu_chain_step * step = 0;
+        char *rule = 0;
+        struct icu_chain_step *step = 0;
+        struct _xmlAttr *attr;
 
+        nmem_reset(nmem);
         if (node->type != XML_ELEMENT_NODE)
             continue;
 
-        xml_rule = xmlGetProp(node, (xmlChar *) "rule");
-
+        for (attr = node->properties; attr; attr = attr->next)
+        {
+            if (!strcmp((const char *) attr->name, "rule"))
+            {
+                rule = nmem_text_node_cdata(attr->children, nmem);
+            }
+            else
+            {
+                yaz_log(YLOG_WARN, "Unsupported attribute '%s' for "
+                        "element '%s'", attr->name, node->name);
+                no_errors++;
+                continue;
+            }
+        }
+        if (!rule && node->children)
+            rule = nmem_text_node_cdata(node->children, nmem);
+        
+        if (!rule || !*rule)
+        {
+            yaz_log(YLOG_WARN, "Missing rule for element '%s'", node->name);
+            no_errors++;
+            continue;
+        }
+            
         if (!strcmp((const char *) node->name, "casemap"))
             step = icu_chain_insert_step(chain, ICU_chain_step_type_casemap, 
-                                         (const uint8_t *) xml_rule, status);
+                                         (const uint8_t *) rule, status);
         else if (!strcmp((const char *) node->name, "transform"))
             step = icu_chain_insert_step(chain, ICU_chain_step_type_transform, 
-                                         (const uint8_t *) xml_rule, status);
+                                         (const uint8_t *) rule, status);
         else if (!strcmp((const char *) node->name, "transliterate"))
             step = icu_chain_insert_step(chain, ICU_chain_step_type_transliterate, 
-                                         (const uint8_t *) xml_rule, status);
+                                         (const uint8_t *) rule, status);
         else if (!strcmp((const char *) node->name, "tokenize"))
             step = icu_chain_insert_step(chain, ICU_chain_step_type_tokenize, 
-                                         (const uint8_t *) xml_rule, status);
+                                         (const uint8_t *) rule, status);
         else if (!strcmp((const char *) node->name, "display"))
             step = icu_chain_insert_step(chain, ICU_chain_step_type_display, 
                                          (const uint8_t *) "", status);
@@ -242,7 +297,7 @@ struct icu_chain * icu_chain_xml_config(const xmlNode *xml_node,
             yaz_log(YLOG_WARN, "Element %s is deprecated. "
                     "Use transform instead", node->name);
             step = icu_chain_insert_step(chain, ICU_chain_step_type_transform, 
-                                         (const uint8_t *) xml_rule, status);
+                                         (const uint8_t *) rule, status);
         }
         else if (!strcmp((const char *) node->name, "index")
                  || !strcmp((const char *) node->name, "sortkey"))
@@ -253,24 +308,30 @@ struct icu_chain * icu_chain_xml_config(const xmlNode *xml_node,
         else
         {
             yaz_log(YLOG_WARN, "Unknown element %s", node->name);
-            icu_chain_destroy(chain);
-            return 0;
+            no_errors++;
+            continue;
         }
-        xmlFree(xml_rule);
         if (step && U_FAILURE(*status))
         {
-            icu_chain_destroy(chain);
-            return 0;
+            no_errors++;
+            break;
         }
     }
+    nmem_destroy(nmem);
+    if (no_errors)
+    {
+        icu_chain_destroy(chain);
+        return 0;
+    }
     return chain;
 }
 
+
 static struct icu_chain_step *icu_chain_insert_step(
-    struct icu_chain * chain, enum icu_chain_step_type type,
-    const uint8_t * rule, UErrorCode *status)
+    struct icu_chain *chain, enum icu_chain_step_type type,
+    const uint8_t *rule, UErrorCode *status)
 {    
-    struct icu_chain_step * step = 0;
+    struct icu_chain_step *step = 0;
     if (!chain || !type || !rule)
         return 0;
 
@@ -278,8 +339,8 @@ static struct icu_chain_step *icu_chain_insert_step(
     step = icu_chain_step_create(chain, type, rule,
                                  status);
 
-    step->previous = chain->steps;
-    chain->steps = step;
+    step->previous = chain->csteps;
+    chain->csteps = step;
 
     return step;
 }
@@ -290,8 +351,10 @@ struct icu_iter {
     UErrorCode status;
     struct icu_buf_utf8 *display;
     struct icu_buf_utf8 *sort8;
+    struct icu_buf_utf8 *result;
     struct icu_buf_utf16 *input;
     int token_count;
+    struct icu_chain_step *steps;
 };
 
 void icu_utf16_print(struct icu_buf_utf16 *src16)
@@ -314,7 +377,7 @@ void icu_utf16_print(struct icu_buf_utf16 *src16)
     icu_buf_utf8_destroy(dst8);
 }
 
-struct icu_buf_utf16 *icu_iter_invoke(struct icu_iter *iter,
+struct icu_buf_utf16 *icu_iter_invoke(yaz_icu_iter_t iter,
                                       struct icu_chain_step *step,
                                       struct icu_buf_utf16 *src)
 {
@@ -374,50 +437,56 @@ struct icu_buf_utf16 *icu_iter_invoke(struct icu_iter *iter,
     }
 }
 
-struct icu_iter *icu_iter_create(struct icu_chain *chain,
-                                 const char *src8cstr)
+yaz_icu_iter_t icu_iter_create(struct icu_chain *chain)
 {
-    if (!src8cstr)
-        return 0;
-    else
-    {
-        struct icu_iter *iter = xmalloc(sizeof(*iter));
-        iter->chain = chain;
-        iter->status = U_ZERO_ERROR;
-        iter->display = icu_buf_utf8_create(0);
-        iter->sort8 = icu_buf_utf8_create(0);
-        iter->token_count = 0;
-        iter->last = 0; /* no last returned string (yet) */
-
-        /* fill and assign input string.. It will be 0 after
-           first iteration */
-        iter->input =  icu_buf_utf16_create(0);
-        icu_utf16_from_utf8_cstr(iter->input, src8cstr, &iter->status);
-        return iter;
+    yaz_icu_iter_t iter = xmalloc(sizeof(*iter));
+    iter->chain = chain;
+    iter->status = U_ZERO_ERROR;
+    iter->display = icu_buf_utf8_create(0);
+    iter->sort8 = icu_buf_utf8_create(0);
+    iter->result = icu_buf_utf8_create(0);
+    iter->last = 0; /* no last returned string (yet) */
+    iter->steps = icu_chain_step_clone(chain->csteps);
+    iter->input = 0;
+
+    return iter;
+}
 
-    }
+void icu_iter_first(yaz_icu_iter_t iter, const char *src8cstr)
+{
+    if (iter->input)
+        icu_buf_utf16_destroy(iter->input);
+    iter->input = icu_buf_utf16_create(0);
+    iter->token_count = 0;
+    /* fill and assign input string.. It will be 0 after
+       first iteration */
+    icu_utf16_from_utf8_cstr(iter->input, src8cstr, &iter->status);
 }
 
-void icu_iter_destroy(struct icu_iter *iter)
+void icu_iter_destroy(yaz_icu_iter_t iter)
 {
     if (iter)
     {
         icu_buf_utf8_destroy(iter->display);
         icu_buf_utf8_destroy(iter->sort8);
+        icu_buf_utf8_destroy(iter->result);
         if (iter->input)
             icu_buf_utf16_destroy(iter->input);
+        icu_chain_step_destroy(iter->steps);
         xfree(iter);
     }
 }
 
-int icu_iter_next(struct icu_iter *iter, struct icu_buf_utf8 *result)
+int icu_iter_next(yaz_icu_iter_t iter)
 {
     if (!iter->input && iter->last == 0)
         return 0;
     else
     {
         /* on first call, iter->input is the input string. Thereafter: 0. */
-        iter->last = icu_iter_invoke(iter, iter->chain->steps, iter->input);
+        iter->last = icu_iter_invoke(iter, iter->steps ?
+                                     iter->steps : iter->chain->csteps,
+                                     iter->input);
         iter->input = 0;
         
         if (!iter->last)
@@ -431,60 +500,71 @@ int icu_iter_next(struct icu_iter *iter, struct icu_buf_utf8 *result)
                                     iter->sort8, iter->last,
                                     &iter->status);
         }
-        icu_utf16_to_utf8(result, iter->last, &iter->status);
+        icu_utf16_to_utf8(iter->result, iter->last, &iter->status);
         icu_buf_utf16_destroy(iter->last);
 
         return 1;
     }
 }
 
-const char *icu_iter_get_sortkey(struct icu_iter *iter)
+const char *icu_iter_get_norm(yaz_icu_iter_t iter)
+{
+    return icu_buf_utf8_to_cstr(iter->result);
+}
+
+const char *icu_iter_get_sortkey(yaz_icu_iter_t iter)
 {
     return icu_buf_utf8_to_cstr(iter->sort8);
 }
 
-const char *icu_iter_get_display(struct icu_iter *iter)
+const char *icu_iter_get_display(yaz_icu_iter_t iter)
 { 
     return icu_buf_utf8_to_cstr(iter->display);   
 }
 
-int icu_chain_assign_cstr(struct icu_chain * chain, const char * src8cstr, 
+int icu_iter_get_token_number(yaz_icu_iter_t iter)
+{ 
+    return iter->token_count;
+}
+
+int icu_chain_assign_cstr(struct icu_chain *chain, const char *src8cstr, 
                           UErrorCode *status)
 {
     if (chain->iter)
         icu_iter_destroy(chain->iter);
-    chain->iter = icu_iter_create(chain, src8cstr);
+    chain->iter = icu_iter_create(chain);
+    icu_iter_first(chain->iter, src8cstr);
     return 1;
 }
 
-int icu_chain_next_token(struct icu_chain * chain, UErrorCode *status)
+int icu_chain_next_token(struct icu_chain *chain, UErrorCode *status)
 {
     *status = U_ZERO_ERROR;
-    return icu_iter_next(chain->iter, chain->norm8);
+    return icu_iter_next(chain->iter);
 }
 
-int icu_chain_token_number(struct icu_chain * chain)
+int icu_chain_token_number(struct icu_chain *chain)
 {
     if (chain && chain->iter)
         return chain->iter->token_count;
     return 0;
 }
 
-const char * icu_chain_token_display(struct icu_chain * chain)
+const char *icu_chain_token_display(struct icu_chain *chain)
 {
     if (chain->iter)
         return icu_iter_get_display(chain->iter);
     return 0;
 }
 
-const char * icu_chain_token_norm(struct icu_chain * chain)
+const char *icu_chain_token_norm(struct icu_chain *chain)
 {
-    if (chain->norm8)
-        return icu_buf_utf8_to_cstr(chain->norm8);
+    if (chain->iter)
+        return icu_iter_get_norm(chain->iter);
     return 0;
 }
 
-const char * icu_chain_token_sortkey(struct icu_chain * chain)
+const char *icu_chain_token_sortkey(struct icu_chain *chain)
 {
     if (chain->iter)
         return icu_iter_get_sortkey(chain->iter);