1 /*	$NetBSD: delimitermap.h,v 1.4 2014/12/10 04:37:55 christos Exp $	*/
2 
3 /* Id: delimitermap.h,v 1.1 2003/06/04 00:25:37 marka Exp  */
4 /*
5  * Copyright (c) 2001 Japan Network Information Center.  All rights reserved.
6  *
7  * By using this file, you agree to the terms and conditions set forth bellow.
8  *
9  * 			LICENSE TERMS AND CONDITIONS
10  *
11  * The following License Terms and Conditions apply, unless a different
12  * license is obtained from Japan Network Information Center ("JPNIC"),
13  * a Japanese association, Kokusai-Kougyou-Kanda Bldg 6F, 2-3-4 Uchi-Kanda,
14  * Chiyoda-ku, Tokyo 101-0047, Japan.
15  *
16  * 1. Use, Modification and Redistribution (including distribution of any
17  *    modified or derived work) in source and/or binary forms is permitted
18  *    under this License Terms and Conditions.
19  *
20  * 2. Redistribution of source code must retain the copyright notices as they
21  *    appear in each source code file, this License Terms and Conditions.
22  *
23  * 3. Redistribution in binary form must reproduce the Copyright Notice,
24  *    this License Terms and Conditions, in the documentation and/or other
25  *    materials provided with the distribution.  For the purposes of binary
26  *    distribution the "Copyright Notice" refers to the following language:
27  *    "Copyright (c) 2000-2002 Japan Network Information Center.  All rights reserved."
28  *
29  * 4. The name of JPNIC may not be used to endorse or promote products
30  *    derived from this Software without specific prior written approval of
31  *    JPNIC.
32  *
33  * 5. Disclaimer/Limitation of Liability: THIS SOFTWARE IS PROVIDED BY JPNIC
34  *    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
35  *    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
36  *    PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL JPNIC BE LIABLE
37  *    FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
38  *    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
39  *    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
40  *    BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
41  *    WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
42  *    OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
43  *    ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
44  */
45 
46 #ifndef IDN_DELIMITERMAP_H
47 #define IDN_DELIMITERMAP_H 1
48 
49 #ifdef __cplusplus
50 extern "C" {
51 #endif
52 
53 /*
54  * Mapper.
55  *
56  * Perfom mapping local delimiters to `.'.
57  */
58 
59 #include <idn/export.h>
60 #include <idn/result.h>
61 
62 /*
63  * Map object type.
64  */
65 typedef struct idn_delimitermap *idn_delimitermap_t;
66 
67 /*
68  * Create a delimitermap context.
69  *
70  * Returns:
71  *      idn_success             -- ok.
72  *      idn_nomemory            -- malloc failed.
73  */
74 IDN_EXPORT idn_result_t
75 idn_delimitermap_create(idn_delimitermap_t *ctxp);
76 
77 /*
78  * Decrement reference count of the delimitermap `ctx' created by
79  * 'idn_delimitermap_create', if it is still refered by another object.
80  * Otherwise, release all the memory allocated to the delimitermap.
81  */
82 IDN_EXPORT void
83 idn_delimitermap_destroy(idn_delimitermap_t ctx);
84 
85 /*
86  * Increment reference count of the delimitermap `ctx' created by
87  * 'idn_delimitermap_create'.
88  */
89 IDN_EXPORT void
90 idn_delimitermap_incrref(idn_delimitermap_t ctx);
91 
92 /*
93  * Add a local delimiter.
94  *
95  * Returns:
96  *      idn_success             -- ok.
97  *      idn_nomemory            -- malloc failed.
98  *      idn_invalid_codepoint   -- delimiter is not valid UCS4 character.
99  */
100 IDN_EXPORT idn_result_t
101 idn_delimitermap_add(idn_delimitermap_t ctx, unsigned long delimiter);
102 
103 IDN_EXPORT idn_result_t
104 idn_delimitermap_addall(idn_delimitermap_t ctx, unsigned long *delimiters,
105 			int ndelimiters);
106 
107 /*
108  * Map local delimiters in `from' to `.'.
109  *
110  * Note that if no delimiter is added to the context, the function copies
111  * the string.
112  *
113  * Returns:
114  *      idn_success             -- ok.
115  *      idn_buffer_overflow     -- output buffer is too small.
116  */
117 IDN_EXPORT idn_result_t
118 idn_delimitermap_map(idn_delimitermap_t ctx, const unsigned long *from,
119 		     unsigned long *to, size_t tolen);
120 
121 #ifdef __cplusplus
122 }
123 #endif
124 
125 #endif /* IDN_DELIMITERMAP_H */
126