Happy new year
[yaz-moved-to-github.git] / include / yaz / icu.h
1 /* This file is part of the YAZ toolkit.
2  * Copyright (C) 1995-2009 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 /** \file
29     \brief ICU utilities
30 */
31
32
33 #ifndef YAZ_ICU_H
34 #define YAZ_ICU_H
35
36 #include <yaz/yconfig.h>
37
38 #include <yaz/xmltypes.h>
39
40 #include <unicode/utypes.h>
41
42 YAZ_BEGIN_CDECL
43
44 typedef struct icu_chain *yaz_icu_chain_t;
45
46 YAZ_EXPORT yaz_icu_chain_t icu_chain_create(const char * locale,
47                                  int sort,
48                                  UErrorCode * status);
49
50 YAZ_EXPORT void icu_chain_destroy(yaz_icu_chain_t chain);
51
52 YAZ_EXPORT yaz_icu_chain_t icu_chain_xml_config(const xmlNode *xml_node,
53                                      int sort,
54                                      UErrorCode * status);
55
56 YAZ_EXPORT int icu_chain_assign_cstr(yaz_icu_chain_t chain,
57                           const char * src8cstr, 
58                           UErrorCode *status);
59
60 YAZ_EXPORT int icu_chain_next_token(yaz_icu_chain_t chain,
61                          UErrorCode *status);
62
63 YAZ_EXPORT int icu_chain_token_number(yaz_icu_chain_t chain);
64
65 YAZ_EXPORT const char * icu_chain_token_display(yaz_icu_chain_t chain);
66
67 YAZ_EXPORT const char * icu_chain_token_norm(yaz_icu_chain_t chain);
68
69 YAZ_EXPORT const char * icu_chain_token_sortkey(yaz_icu_chain_t chain);
70
71 YAZ_END_CDECL
72
73 #endif /* YAZ_ICU_H */
74
75 /*
76  * Local variables:
77  * c-basic-offset: 4
78  * indent-tabs-mode: nil
79  * End:
80  * vim: shiftwidth=4 tabstop=8 expandtab
81  */