include/yaz/stemmer.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) Index Data.
   3  * All rights reserved.
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of Index Data nor the names of its contributors
  13  *       may be used to endorse or promote products derived from this
  14  *       software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 /**
  29  * \file stemmer.h
  30  * \brief Header for the stemming API.
  31  *
  32  * Simple wrapper to hide underlying implementation.
  33  */
  34
  35 #ifndef YAZ_STEMMER_H
  36 #define YAZ_STEMMER_H
  37
  38 #include <yaz/yconfig.h>
  39 #include <yaz/xmltypes.h>
  40 #include <yaz/icu_I18N.h>
  41 #include <yaz/log.h>
  42
  43 #include <unicode/ustring.h>  /* some more string fcns*/
  44 #include <unicode/uchar.h>    /* char names           */
  45
  46
  47 YAZ_BEGIN_CDECL
  48
  49 typedef struct yaz_stemmer_t *yaz_stemmer_p;
  50
  51 YAZ_EXPORT
  52 yaz_stemmer_p yaz_stemmer_create(const char *locale, const char *rule, UErrorCode *status);
  53
  54 YAZ_EXPORT
  55 yaz_stemmer_p yaz_stemmer_clone(yaz_stemmer_p stemmer);
  56
  57 YAZ_EXPORT
  58 void yaz_stemmer_stem(yaz_stemmer_p stemmer, struct icu_buf_utf16 *dst, struct icu_buf_utf16* src, UErrorCode *status);
  59
  60 YAZ_EXPORT
  61 void yaz_stemmer_destroy(yaz_stemmer_p stemmer);
  62
  63 #endif