1 /* $NetBSD: ucsmap.h,v 1.4 2014/12/10 04:37:55 christos Exp $ */ 2 3 /* Id: ucsmap.h,v 1.1 2003/06/04 00:25:42 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_UCSMAP_H 47 #define IDN_UCSMAP_H 1 48 49 #ifdef __cplusplus 50 extern "C" { 51 #endif 52 53 /* 54 * Perform UCS character mapping. 55 * This module support one-to-N mapping (N may be zero, one or more). 56 */ 57 58 #include <idn/export.h> 59 #include <idn/result.h> 60 61 /* 62 * Mapper type (opaque). 63 */ 64 typedef struct idn_ucsmap *idn_ucsmap_t; 65 66 /* 67 * Create an empty mapping. The reference count is set to 1. 68 * 69 * Returns: 70 * idn_success -- ok. 71 * idn_nomemory -- malloc failed. 72 */ 73 IDN_EXPORT idn_result_t 74 idn_ucsmap_create(idn_ucsmap_t *ctxp); 75 76 /* 77 * Decrement the reference count of the given set, and if it reaches zero, 78 * release all the memory allocated for it. 79 */ 80 IDN_EXPORT void 81 idn_ucsmap_destroy(idn_ucsmap_t ctx); 82 83 /* 84 * Increment the reference count of the given set by one, so that 85 * the map can be shared. 86 */ 87 IDN_EXPORT void 88 idn_ucsmap_incrref(idn_ucsmap_t ctx); 89 90 /* 91 * Add a mapping. 92 * 'ucs' is the character to be mapped, 'map' points an array of mapped 93 * characters of length 'maplen'. 'map' may be NULL if 'maplen' is zero, 94 * meaning one-to-none mapping. 95 * 96 * Returns: 97 * idn_success -- ok. 98 * idn_nomemory -- malloc failed. 99 * idn_failure -- already fixed by 'idn_ucsmap_fix', 100 * or too large maplen. 101 */ 102 IDN_EXPORT idn_result_t 103 idn_ucsmap_add(idn_ucsmap_t ctx, unsigned long ucs, unsigned long *map, 104 size_t maplen); 105 106 /* 107 * Perform internal arrangement of the map for lookup. 108 * Once it is fixed, 'idn_ucsmap_add' cannot be permitted to the map. 109 */ 110 IDN_EXPORT void 111 idn_ucsmap_fix(idn_ucsmap_t ctx); 112 113 /* 114 * Find the mapping for the given character. 115 * 'idn_ucsmap_fix' must be performed before calling this function. 116 * Find the mapping for 'v' and store the result to 'to'. The length 117 * of the mapped sequence is stored in '*maplenp'. 'tolen' specifies 118 * the length allocated for 'to'. 119 * 120 * Returns: 121 * idn_success -- ok. 122 * idn_nomapping -- specified character has no mapping. 123 * idn_failure -- not fixed by 'idn_ucsmap_fix' yet. 124 */ 125 IDN_EXPORT idn_result_t 126 idn_ucsmap_map(idn_ucsmap_t ctx, unsigned long v, unsigned long *to, 127 size_t tolen, size_t *maplenp); 128 129 #ifdef __cplusplus 130 } 131 #endif 132 133 #endif /* IDN_UCSMAP_H */ 134