Changes to better support possible outputs of the Connector Framework.
[pazpar2-moved-to-github.git] / src / charsets.c
index 0eefa07..f0f1af0 100644 (file)
@@ -1,5 +1,5 @@
 /* This file is part of Pazpar2.
-   Copyright (C) 2006-2010 Index Data
+   Copyright (C) 2006-2011 Index Data
 
 Pazpar2 is free software; you can redistribute it and/or modify it under
 the terms of the GNU General Public License as published by the Free
@@ -28,6 +28,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 #include <yaz/xmalloc.h>
 #include <yaz/wrbuf.h>
 #include <yaz/log.h>
+#include <yaz/yaz-version.h>
 #include <ctype.h>
 #include <assert.h>
 #include <string.h>
@@ -39,43 +40,159 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 #include <yaz/icu.h>
 #endif
 
+typedef struct pp2_charset_s *pp2_charset_t;
+static pp2_charset_t pp2_charset_create_xml(xmlNode *xml_node);
+static pp2_charset_t pp2_charset_create(struct icu_chain * icu_chn);
+static pp2_charset_t pp2_charset_create_a_to_z(void);
+static void pp2_charset_destroy(pp2_charset_t pct);
+static pp2_charset_token_t pp2_charset_tokenize(pp2_charset_t pct);
 
 /* charset handle */
 struct pp2_charset_s {
-    const char *(*token_next_handler)(pp2_relevance_token_t prt);
-    const char *(*get_sort_handler)(pp2_relevance_token_t prt);
-    int ref_count;
+    const char *(*token_next_handler)(pp2_charset_token_t prt);
+    const char *(*get_sort_handler)(pp2_charset_token_t prt);
+    const char *(*get_display_handler)(pp2_charset_token_t prt);
 #if YAZ_HAVE_ICU
     struct icu_chain * icu_chn;
     UErrorCode icu_sts;
 #endif
 };
 
-static const char *pp2_relevance_token_a_to_z(pp2_relevance_token_t prt);
-static const char *pp2_get_sort_ascii(pp2_relevance_token_t prt);
+static const char *pp2_charset_token_null(pp2_charset_token_t prt);
+static const char *pp2_charset_token_a_to_z(pp2_charset_token_t prt);
+static const char *pp2_get_sort_ascii(pp2_charset_token_t prt);
+static const char *pp2_get_display_ascii(pp2_charset_token_t prt);
 
 #if YAZ_HAVE_ICU
-static const char *pp2_relevance_token_icu(pp2_relevance_token_t prt);
-static const char *pp2_get_sort_icu(pp2_relevance_token_t prt);
+static const char *pp2_charset_token_icu(pp2_charset_token_t prt);
+static const char *pp2_get_sort_icu(pp2_charset_token_t prt);
+static const char *pp2_get_display_icu(pp2_charset_token_t prt);
 #endif
 
 /* tokenzier handle */
-struct pp2_relevance_token_s {
+struct pp2_charset_token_s {
     const char *cp;     /* unnormalized buffer we're tokenizing */
     const char *last_cp;  /* pointer to last token we're dealing with */
     pp2_charset_t pct;  /* our main charset handle (type+config) */
     WRBUF norm_str;     /* normized string we return (temporarily) */
     WRBUF sort_str;     /* sort string we return (temporarily) */
+#if YAZ_HAVE_ICU
+    yaz_icu_iter_t iter;
+#endif
+};
+
+struct pp2_charset_fact_s {
+    struct pp2_charset_entry *list;
+    int ref_count;
 };
 
+struct pp2_charset_entry {
+    struct pp2_charset_entry *next;
+    pp2_charset_t pct;
+    char *name;
+};
+
+
+static int pp2_charset_fact_add(pp2_charset_fact_t pft,
+                                pp2_charset_t pct, const char *default_id);
+
+pp2_charset_fact_t pp2_charset_fact_create(void)
+{
+    pp2_charset_fact_t pft = xmalloc(sizeof(*pft));
+    pft->list = 0;
+    pft->ref_count = 1;
+
+    pp2_charset_fact_add(pft, pp2_charset_create_a_to_z(), "relevance");
+    pp2_charset_fact_add(pft, pp2_charset_create_a_to_z(), "sort");
+    pp2_charset_fact_add(pft, pp2_charset_create_a_to_z(), "mergekey");
+    pp2_charset_fact_add(pft, pp2_charset_create(0), "facet");
+    return pft;
+}
+
+void pp2_charset_fact_destroy(pp2_charset_fact_t pft)
+{
+    if (pft)
+    {
+        assert(pft->ref_count >= 1);
+        --(pft->ref_count);
+        if (pft->ref_count == 0)
+        {
+            struct pp2_charset_entry *pce = pft->list;
+            while (pce)
+            {
+                struct pp2_charset_entry *next = pce->next;
+                pp2_charset_destroy(pce->pct);
+                xfree(pce->name);
+                xfree(pce);
+                pce = next;
+            }
+            xfree(pft);
+        }
+    }
+}
+
+int pp2_charset_fact_add(pp2_charset_fact_t pft,
+                         pp2_charset_t pct, const char *default_id)
+{
+    struct pp2_charset_entry *pce;
+
+    for (pce = pft->list; pce; pce = pce->next)
+        if (!strcmp(default_id, pce->name))
+            break;
+
+    if (!pce)
+    {
+        pce = xmalloc(sizeof(*pce));
+        pce->name = xstrdup(default_id);
+        pce->next = pft->list;
+        pft->list = pce;
+    }
+    else
+    {
+        pp2_charset_destroy(pce->pct);
+    }
+    pce->pct = pct;
+    return 0;
+}
+
+int pp2_charset_fact_define(pp2_charset_fact_t pft,
+                            xmlNode *xml_node, const char *default_id)
+{
+    int r;
+    pp2_charset_t pct;
+    xmlChar *id = 0;
+
+    assert(xml_node);
+    pct = pp2_charset_create_xml(xml_node);
+    if (!pct)
+        return -1;
+    if (!default_id)
+    {
+        id = xmlGetProp(xml_node, (xmlChar*) "id");
+        if (!id)
+        {
+            yaz_log(YLOG_WARN, "Missing id for icu_chain");
+            pp2_charset_destroy(pct);
+            return -1;
+        }
+        default_id = (const char *) id;
+    }
+    r = pp2_charset_fact_add(pft, pct, default_id);
+    if (id)
+        xmlFree(id);
+    return r;
+}
+
+void pp2_charset_fact_incref(pp2_charset_fact_t pft)
+{
+    (pft->ref_count)++;
+}
 
 pp2_charset_t pp2_charset_create_xml(xmlNode *xml_node)
 {
 #if YAZ_HAVE_ICU
     UErrorCode status = U_ZERO_ERROR;
     struct icu_chain *chain = 0;
-    if (xml_node)
-        xml_node = xml_node->children;
     while (xml_node && xml_node->type != XML_ELEMENT_NODE)
         xml_node = xml_node->next;
     chain = icu_chain_xml_config(xml_node, 1, &status);
@@ -101,26 +218,29 @@ pp2_charset_t pp2_charset_create_xml(xmlNode *xml_node)
 #endif // YAZ_HAVE_ICU
 }
 
-void pp2_charset_incref(pp2_charset_t pct)
+pp2_charset_t pp2_charset_create_a_to_z(void)
 {
-    (pct->ref_count)++;
+    pp2_charset_t pct = pp2_charset_create(0);
+    pct->token_next_handler = pp2_charset_token_a_to_z;
+    return pct;
 }
 
-pp2_charset_t pp2_charset_create(struct icu_chain * icu_chn)
+pp2_charset_t pp2_charset_create(struct icu_chain *icu_chn)
 {
     pp2_charset_t pct = xmalloc(sizeof(*pct));
 
-    pct->token_next_handler = pp2_relevance_token_a_to_z;
+    pct->token_next_handler = pp2_charset_token_null;
     pct->get_sort_handler  = pp2_get_sort_ascii;
-    pct->ref_count = 1;
+    pct->get_display_handler  = pp2_get_display_ascii;
 #if YAZ_HAVE_ICU
     pct->icu_chn = 0;
     if (icu_chn)
     {
         pct->icu_chn = icu_chn;
         pct->icu_sts = U_ZERO_ERROR;
-        pct->token_next_handler = pp2_relevance_token_icu;
+        pct->token_next_handler = pp2_charset_token_icu;
         pct->get_sort_handler = pp2_get_sort_icu;
+        pct->get_display_handler = pp2_get_display_icu;
     }
 #endif // YAZ_HAVE_ICU
     return pct;
@@ -128,28 +248,45 @@ pp2_charset_t pp2_charset_create(struct icu_chain * icu_chn)
 
 void pp2_charset_destroy(pp2_charset_t pct)
 {
-    if (pct)
-    {
-        assert(pct->ref_count >= 1);
-        --(pct->ref_count);
-        if (pct->ref_count == 0)
-        {
 #if YAZ_HAVE_ICU
-            icu_chain_destroy(pct->icu_chn);
+    icu_chain_destroy(pct->icu_chn);
 #endif
-            xfree(pct);
-        }
-    }
+    xfree(pct);
+}
+
+pp2_charset_token_t pp2_charset_token_create(pp2_charset_fact_t pft,
+                                               const char *id)
+{
+    struct pp2_charset_entry *pce;
+    for (pce = pft->list; pce; pce = pce->next)
+        if (!strcmp(id, pce->name))
+            return pp2_charset_tokenize(pce->pct);
+    return 0;
 }
 
-pp2_relevance_token_t pp2_relevance_tokenize(pp2_charset_t pct,
-                                             const char *buf,
-                                             int skip_article)
+pp2_charset_token_t pp2_charset_tokenize(pp2_charset_t pct)
 {
-    pp2_relevance_token_t prt = xmalloc(sizeof(*prt));
+    pp2_charset_token_t prt = xmalloc(sizeof(*prt));
 
     assert(pct);
 
+    prt->norm_str = wrbuf_alloc();
+    prt->sort_str = wrbuf_alloc();
+    prt->cp = 0;
+    prt->last_cp = 0;
+    prt->pct = pct;
+
+#if YAZ_HAVE_ICU
+    prt->iter = 0;
+    if (pct->icu_chn)
+        prt->iter = icu_iter_create(pct->icu_chn);
+#endif
+    return prt;
+}
+
+void pp2_charset_token_first(pp2_charset_token_t prt,
+                             const char *buf, int skip_article)
+{ 
     if (skip_article)
     {
         const char *p = buf;
@@ -157,8 +294,6 @@ pp2_relevance_token_t pp2_relevance_tokenize(pp2_charset_t pct,
         char *pout = firstword;
         char articles[] = "the den der die des an a "; // must end in space
         
-        while (*p && !isalnum(*(unsigned char *)p))
-            p++;
         for (; *p && *p != ' ' && pout - firstword < (sizeof(firstword)-2); p++)
             *pout++ = tolower(*(unsigned char *)p);
         *pout++ = ' ';
@@ -167,29 +302,26 @@ pp2_relevance_token_t pp2_relevance_tokenize(pp2_charset_t pct,
             buf = p;
     }
 
-    prt->norm_str = wrbuf_alloc();
-    prt->sort_str = wrbuf_alloc();
+    wrbuf_rewind(prt->norm_str);
+    wrbuf_rewind(prt->sort_str);
     prt->cp = buf;
     prt->last_cp = 0;
-    prt->pct = pct;
 
 #if YAZ_HAVE_ICU
-    if (pct->icu_chn)
+    if (prt->iter)
     {
-        int ok = 0;
-        pct->icu_sts = U_ZERO_ERROR;
-        ok = icu_chain_assign_cstr(pct->icu_chn, buf, &pct->icu_sts);
-        //printf("\nfield ok: %d '%s'\n", ok, buf);
-        prt->pct = pct;
+        icu_iter_first(prt->iter, buf);
     }
 #endif // YAZ_HAVE_ICU
-    return prt;
 }
 
-
-void pp2_relevance_token_destroy(pp2_relevance_token_t prt)
+void pp2_charset_token_destroy(pp2_charset_token_t prt)
 {
     assert(prt);
+#if YAZ_HAVE_ICU
+    if (prt->iter)
+        icu_iter_destroy(prt->iter);
+#endif
     if(prt->norm_str) 
         wrbuf_destroy(prt->norm_str);
     if(prt->sort_str) 
@@ -197,22 +329,27 @@ void pp2_relevance_token_destroy(pp2_relevance_token_t prt)
     xfree(prt);
 }
 
-const char *pp2_relevance_token_next(pp2_relevance_token_t prt)
+const char *pp2_charset_token_next(pp2_charset_token_t prt)
 {
     assert(prt);
     return (prt->pct->token_next_handler)(prt);
 }
 
-const char *pp2_get_sort(pp2_relevance_token_t prt)
+const char *pp2_get_sort(pp2_charset_token_t prt)
 {
     return prt->pct->get_sort_handler(prt);
 }
 
+const char *pp2_get_display(pp2_charset_token_t prt)
+{
+    return prt->pct->get_display_handler(prt);
+}
+
 #define raw_char(c) (((c) >= 'a' && (c) <= 'z') ? (c) : -1)
 /* original tokenizer with our tokenize interface, but we
    add +1 to ensure no '\0' are in our string (except for EOF)
 */
-static const char *pp2_relevance_token_a_to_z(pp2_relevance_token_t prt)
+static const char *pp2_charset_token_a_to_z(pp2_charset_token_t prt)
 {
     const char *cp = prt->cp;
     int c;
@@ -239,7 +376,7 @@ static const char *pp2_relevance_token_a_to_z(pp2_relevance_token_t prt)
     return wrbuf_cstr(prt->norm_str);
 }
 
-static const char *pp2_get_sort_ascii(pp2_relevance_token_t prt)
+static const char *pp2_get_sort_ascii(pp2_charset_token_t prt)
 {
     if (prt->last_cp == 0)
         return 0;
@@ -256,24 +393,45 @@ static const char *pp2_get_sort_ascii(pp2_relevance_token_t prt)
     }
 }
 
+static const char *pp2_get_display_ascii(pp2_charset_token_t prt)
+{
+    if (prt->last_cp == 0)
+        return 0;
+    else
+    {
+        return wrbuf_cstr(prt->norm_str);
+    }
+}
+
+static const char *pp2_charset_token_null(pp2_charset_token_t prt)
+{
+    const char *cp = prt->cp;
+
+    prt->last_cp = *cp ? cp : 0;
+    while (*cp)
+        cp++;
+    prt->cp = cp;
+    return prt->last_cp;
+}
 
 #if YAZ_HAVE_ICU
-static const char *pp2_relevance_token_icu(pp2_relevance_token_t prt)
+static const char *pp2_charset_token_icu(pp2_charset_token_t prt)
 {
-    if (icu_chain_next_token(prt->pct->icu_chn, &prt->pct->icu_sts))
+    if (icu_iter_next(prt->iter))
     {
-        if (U_FAILURE(prt->pct->icu_sts))
-        {
-            return 0;
-        }
-        return icu_chain_token_norm(prt->pct->icu_chn);
+        return icu_iter_get_norm(prt->iter);
     }
     return 0;
 }
 
-static const char *pp2_get_sort_icu(pp2_relevance_token_t prt)
+static const char *pp2_get_sort_icu(pp2_charset_token_t prt)
+{
+    return icu_iter_get_sortkey(prt->iter);
+}
+
+static const char *pp2_get_display_icu(pp2_charset_token_t prt)
 {
-    return icu_chain_token_sortkey(prt->pct->icu_chn);
+    return icu_iter_get_display(prt->iter);
 }
 
 #endif // YAZ_HAVE_ICU