src/charsets.c

   1 /* This file is part of Pazpar2.
   2    Copyright (C) 2006-2009 Index Data
   3
   4 Pazpar2 is free software; you can redistribute it and/or modify it under
   5 the terms of the GNU General Public License as published by the Free
   6 Software Foundation; either version 2, or (at your option) any later
   7 version.
   8
   9 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
  10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12 for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program; if not, write to the Free Software
  16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17
  18 */
  19
  20 /** \file charsets.c
  21     \brief Pazpar2 Character set facilities
  22 */
  23
  24 #if HAVE_CONFIG_H
  25 #include <config.h>
  26 #endif
  27
  28 #include <yaz/xmalloc.h>
  29 #include <yaz/wrbuf.h>
  30 #include <yaz/log.h>
  31 #include <ctype.h>
  32 #include <assert.h>
  33
  34 #include "charsets.h"
  35 #include "normalize7bit.h"
  36
  37 #if YAZ_HAVE_ICU
  38 #include <yaz/icu.h>
  39 #endif
  40
  41
  42 /* charset handle */
  43 struct pp2_charset_s {
  44     const char *(*token_next_handler)(pp2_relevance_token_t prt);
  45     const char *(*get_sort_handler)(pp2_relevance_token_t prt, int skip);
  46     int ref_count;
  47 #if YAZ_HAVE_ICU
  48     struct icu_chain * icu_chn;
  49     UErrorCode icu_sts;
  50 #endif
  51 };
  52
  53 static const char *pp2_relevance_token_a_to_z(pp2_relevance_token_t prt);
  54 static const char *pp2_get_sort_ascii(pp2_relevance_token_t prt, int skip_article);
  55
  56 #if YAZ_HAVE_ICU
  57 static const char *pp2_relevance_token_icu(pp2_relevance_token_t prt);
  58 static const char *pp2_get_sort_icu(pp2_relevance_token_t prt, int skip_article);
  59 #endif
  60
  61 /* tokenzier handle */
  62 struct pp2_relevance_token_s {
  63     const char *cp;     /* unnormalized buffer we're tokenizing */
  64     const char *last_cp;  /* pointer to last token we're dealing with */
  65     pp2_charset_t pct;  /* our main charset handle (type+config) */
  66     WRBUF norm_str;     /* normized string we return (temporarily) */
  67     WRBUF sort_str;     /* sort string we return (temporarily) */
  68 };
  69
  70
  71 pp2_charset_t pp2_charset_create_xml(xmlNode *xml_node)
  72 {
  73 #if YAZ_HAVE_ICU
  74     UErrorCode status = U_ZERO_ERROR;
  75     struct icu_chain *chain = 0;
  76     if (xml_node)
  77         xml_node = xml_node->children;
  78     while (xml_node && xml_node->type != XML_ELEMENT_NODE)
  79         xml_node = xml_node->next;
  80     chain = icu_chain_xml_config(xml_node, 1, &status);
  81     if (!chain || U_FAILURE(status)){
  82         //xmlDocPtr icu_doc = 0;
  83         //xmlChar *xmlstr = 0;
  84                 //int size = 0;
  85                 //xmlDocDumpMemory(icu_doc, size);
  86
  87         yaz_log(YLOG_FATAL, "Could not parse ICU chain config:\n"
  88                 "<%s>\n ... \n</%s>",
  89                 xml_node->name, xml_node->name);
  90         return 0;
  91     }
  92     return pp2_charset_create(chain);
  93 #else // YAZ_HAVE_ICU
  94     yaz_log(YLOG_FATAL, "Error: ICU support requested with element:\n"
  95             "<%s>\n ... \n</%s>",
  96             xml_node->name, xml_node->name);
  97     yaz_log(YLOG_FATAL,
  98             "But no ICU support is compiled into the YAZ library.");
  99     return 0;
 100 #endif // YAZ_HAVE_ICU
 101 }
 102
 103 void pp2_charset_incref(pp2_charset_t pct)
 104 {
 105     (pct->ref_count)++;
 106 }
 107
 108 pp2_charset_t pp2_charset_create(struct icu_chain * icu_chn)
 109 {
 110     pp2_charset_t pct = xmalloc(sizeof(*pct));
 111
 112     pct->token_next_handler = pp2_relevance_token_a_to_z;
 113     pct->get_sort_handler  = pp2_get_sort_ascii;
 114     pct->ref_count = 1;
 115 #if YAZ_HAVE_ICU
 116     pct->icu_chn = 0;
 117     if (icu_chn)
 118     {
 119         pct->icu_chn = icu_chn;
 120         pct->icu_sts = U_ZERO_ERROR;
 121         pct->token_next_handler = pp2_relevance_token_icu;
 122         pct->get_sort_handler = pp2_get_sort_icu;
 123     }
 124 #endif // YAZ_HAVE_ICU
 125     return pct;
 126 }
 127
 128 void pp2_charset_destroy(pp2_charset_t pct)
 129 {
 130     if (pct)
 131     {
 132         assert(pct->ref_count >= 1);
 133         --(pct->ref_count);
 134         if (pct->ref_count == 0)
 135         {
 136 #if YAZ_HAVE_ICU
 137             icu_chain_destroy(pct->icu_chn);
 138 #endif
 139             xfree(pct);
 140         }
 141     }
 142 }
 143
 144 pp2_relevance_token_t pp2_relevance_tokenize(pp2_charset_t pct,
 145                                              const char *buf)
 146 {
 147     pp2_relevance_token_t prt = xmalloc(sizeof(*prt));
 148
 149     assert(pct);
 150
 151     prt->norm_str = wrbuf_alloc();
 152     prt->sort_str = wrbuf_alloc();
 153     prt->cp = buf;
 154     prt->last_cp = 0;
 155     prt->pct = pct;
 156
 157 #if YAZ_HAVE_ICU
 158     if (pct->icu_chn)
 159     {
 160         int ok = 0;
 161         pct->icu_sts = U_ZERO_ERROR;
 162         ok = icu_chain_assign_cstr(pct->icu_chn, buf, &pct->icu_sts);
 163         //printf("\nfield ok: %d '%s'\n", ok, buf);
 164         prt->pct = pct;
 165     }
 166 #endif // YAZ_HAVE_ICU
 167     return prt;
 168 }
 169
 170
 171 void pp2_relevance_token_destroy(pp2_relevance_token_t prt)
 172 {
 173     assert(prt);
 174     if(prt->norm_str)
 175         wrbuf_destroy(prt->norm_str);
 176     if(prt->sort_str)
 177         wrbuf_destroy(prt->sort_str);
 178     xfree(prt);
 179 }
 180
 181 const char *pp2_relevance_token_next(pp2_relevance_token_t prt)
 182 {
 183     assert(prt);
 184     return (prt->pct->token_next_handler)(prt);
 185 }
 186
 187 const char *pp2_get_sort(pp2_relevance_token_t prt, int skip)
 188 {
 189     return prt->pct->get_sort_handler(prt, skip);
 190 }
 191
 192 #define raw_char(c) (((c) >= 'a' && (c) <= 'z') ? (c) : -1)
 193 /* original tokenizer with our tokenize interface, but we
 194    add +1 to ensure no '\0' are in our string (except for EOF)
 195 */
 196 static const char *pp2_relevance_token_a_to_z(pp2_relevance_token_t prt)
 197 {
 198     const char *cp = prt->cp;
 199     int c;
 200
 201     /* skip white space */
 202     while (*cp && (c = raw_char(tolower(*(const unsigned char *)cp))) < 0)
 203         cp++;
 204     if (*cp == '\0')
 205     {
 206         prt->cp = cp;
 207         prt->last_cp = 0;
 208         return 0;
 209     }
 210     /* now read the term itself */
 211
 212     prt->last_cp = cp;
 213     wrbuf_rewind(prt->norm_str);
 214     while (*cp && (c = raw_char(tolower(*cp))) >= 0)
 215     {
 216         wrbuf_putc(prt->norm_str, c);
 217         cp++;
 218     }
 219     prt->cp = cp;
 220     return wrbuf_cstr(prt->norm_str);
 221 }
 222
 223 static const char *pp2_get_sort_ascii(pp2_relevance_token_t prt,
 224                                     int skip_article)
 225 {
 226     if (prt->last_cp == 0)
 227         return 0;
 228     else
 229     {
 230         char *tmp = xstrdup(prt->last_cp);
 231         char *result = 0;
 232         result = normalize7bit_mergekey(tmp, skip_article);
 233
 234         wrbuf_rewind(prt->sort_str);
 235         wrbuf_puts(prt->sort_str, result);
 236         xfree(tmp);
 237         return wrbuf_cstr(prt->sort_str);
 238     }
 239 }
 240
 241
 242 #if YAZ_HAVE_ICU
 243 static const char *pp2_relevance_token_icu(pp2_relevance_token_t prt)
 244 {
 245     if (icu_chain_next_token(prt->pct->icu_chn, &prt->pct->icu_sts))
 246     {
 247         if (U_FAILURE(prt->pct->icu_sts))
 248         {
 249             return 0;
 250         }
 251         return icu_chain_token_norm(prt->pct->icu_chn);
 252     }
 253     return 0;
 254 }
 255
 256 static const char *pp2_get_sort_icu(pp2_relevance_token_t prt,
 257                                     int skip_article)
 258 {
 259     return icu_chain_token_sortkey(prt->pct->icu_chn);
 260 }
 261
 262 #endif // YAZ_HAVE_ICU
 263
 264
 265 /*
 266  * Local variables:
 267  * c-basic-offset: 4
 268  * c-file-style: "Stroustrup"
 269  * indent-tabs-mode: nil
 270  * End:
 271  * vim: shiftwidth=4 tabstop=8 expandtab
 272  */
 273