1 /* $NetBSD: mapselector.h,v 1.4 2014/12/10 04:37:55 christos Exp $ */ 2 3 /* Id: mapselector.h,v 1.1 2003/06/04 00:25:39 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_MAPSELECTOR_H 47 #define IDN_MAPSELECTOR_H 1 48 49 #ifdef __cplusplus 50 extern "C" { 51 #endif 52 53 /* 54 * Map selector. 55 * 56 * Perfom mapping the specified domain name according with the TLD 57 * of the donmain name. 58 */ 59 60 #include <idn/export.h> 61 #include <idn/result.h> 62 #include <idn/mapper.h> 63 64 /* 65 * Special TLDs for map selection. 66 */ 67 #define IDN_MAPSELECTOR_NOTLD "-" 68 #define IDN_MAPSELECTOR_DEFAULTTLD "." 69 70 IDN_EXPORT const unsigned long * 71 idn_mapselector_getnotld(void); 72 73 IDN_EXPORT const unsigned long * 74 idn_mapselector_getdefaulttld(void); 75 76 /* 77 * Mapselector object type. 78 */ 79 typedef struct idn_mapselector *idn_mapselector_t; 80 81 /* 82 * Initialize module. Must be called before any other calls of 83 * the functions of this module. 84 * 85 * Returns: 86 * idn_success -- ok. 87 * idn_nomemory -- malloc failed. 88 */ 89 IDN_EXPORT idn_result_t 90 idn_mapselector_initialize(void); 91 92 /* 93 * Create a mapselector context. 94 * 95 * Returns: 96 * idn_success -- ok. 97 * idn_nomemory -- malloc failed. 98 */ 99 IDN_EXPORT idn_result_t 100 idn_mapselector_create(idn_mapselector_t *ctxp); 101 102 /* 103 * Decrement reference count of the mapselector `ctx' created by 104 * 'idn_mapselector_create', if it is still refered by another object. 105 * Otherwise, release all the memory allocated to the mapselector. 106 */ 107 IDN_EXPORT void 108 idn_mapselector_destroy(idn_mapselector_t ctx); 109 110 /* 111 * Increment reference count of the mapselector `ctx' created by 112 * 'idn_mapselector_create'. 113 */ 114 IDN_EXPORT void 115 idn_mapselector_incrref(idn_mapselector_t ctx); 116 117 /* 118 * Return the mapper for `tld' registered in `ctx', or return NULL if 119 * mapper for `tld' is not registered. 120 */ 121 IDN_EXPORT idn_mapper_t 122 idn_mapselector_mapper(idn_mapselector_t ctx, const char *tld); 123 124 /* 125 * Add mapping scheme `name' to the mapper for `tld' to the mapselector 126 * context `ctx'. If no mapper for `TLD' has not been registered, the 127 * function creates a new mapper for `tld', and then adds the given mapping 128 * scheme to the mapper. Otherwise, it adds the scheme to the mapper for 129 * TLD registered in `ctx'. 130 * 131 * Returns: 132 * idn_success -- ok. 133 * idn_invalid_name -- the given tld or name is not valid. 134 * idn_nomemory -- malloc failed. 135 */ 136 IDN_EXPORT idn_result_t 137 idn_mapselector_add(idn_mapselector_t ctx, const char *tld, const char *name); 138 139 IDN_EXPORT idn_result_t 140 idn_mapselector_addall(idn_mapselector_t ctx, const char *tld, 141 const char **names, int nnames); 142 143 /* 144 * Map an UCS4 string with the mapper for TLD of the domain name. 145 * If there is no mapper suitable for the domain name, the function 146 * simply copies the doman name. 147 * 148 * Returns: 149 * idn_success -- ok. 150 * idn_nomemory -- malloc failed. 151 * idn_buffer_overflow -- output buffer is too small. 152 * idn_invalid_name -- the given tld is not valid. 153 */ 154 IDN_EXPORT idn_result_t 155 idn_mapselector_map(idn_mapselector_t ctx, const unsigned long *from, 156 const char *tld, unsigned long *to, size_t tolen); 157 158 IDN_EXPORT idn_result_t 159 idn_mapselector_map2(idn_mapselector_t ctx, const unsigned long *from, 160 const unsigned long *tld, unsigned long *to, 161 size_t tolen); 162 163 #ifdef __cplusplus 164 } 165 #endif 166 167 #endif /* IDN_MAPSELECTOR_H */ 168