external/bsd/bind/dist/contrib/idn/idnkit-1.0-src/include/idn/mapper.h

   1 /*      $NetBSD: mapper.h,v 1.4 2014/12/10 04:37:55 christos Exp $      */
   2
   3 /* Id: mapper.h,v 1.1 2003/06/04 00:25:38 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_MAPPER_H
  47 #define IDN_MAPPER_H 1
  48
  49 #ifdef __cplusplus
  50 extern "C" {
  51 #endif
  52
  53 /*
  54  * Mapper.
  55  *
  56  * Perfom mapping the specified domain name.
  57  */
  58
  59 #include <idn/export.h>
  60 #include <idn/result.h>
  61 #include <idn/filemapper.h>
  62 #include <idn/nameprep.h>
  63
  64 /*
  65  * Map object type.
  66  */
  67 typedef struct idn_mapper *idn_mapper_t;
  68
  69 /*
  70  * Initialize module.  Must be called before any other calls of
  71  * the functions of this module.
  72  *
  73  * Returns:
  74  *      idn_success             -- ok.
  75  *      idn_nomemory            -- malloc failed.
  76  */
  77 IDN_EXPORT idn_result_t
  78 idn_mapper_initialize(void);
  79
  80 /*
  81  * Create a mapper context.
  82  *
  83  * Returns:
  84  *      idn_success             -- ok.
  85  *      idn_nomemory            -- malloc failed.
  86  */
  87 IDN_EXPORT idn_result_t
  88 idn_mapper_create(idn_mapper_t *ctxp);
  89
  90 /*
  91  * Decrement reference count of the mapper `ctx' created by
  92  * 'idn_mapper_create', if it is still refered by another object.
  93  * Otherwise, release all the memory allocated to the mapper.
  94  */
  95 IDN_EXPORT void
  96 idn_mapper_destroy(idn_mapper_t ctx);
  97
  98 /*
  99  * Increment reference count of the mapper `ctx' created by
 100  * 'idn_mapper_create'.
 101  */
 102 IDN_EXPORT void
 103 idn_mapper_incrref(idn_mapper_t ctx);
 104
 105 /*
 106  * Add mapping scheme `name' to the mapper to `ctx'.
 107  *
 108  * Returns:
 109  *      idn_success             -- ok.
 110  *      idn_invalid_name        -- the given name is not valid.
 111  *      idn_nomemory            -- malloc failed.
 112  */
 113 IDN_EXPORT idn_result_t
 114 idn_mapper_add(idn_mapper_t ctx, const char *name);
 115
 116 IDN_EXPORT idn_result_t
 117 idn_mapper_addall(idn_mapper_t ctx, const char **names, int nnames);
 118
 119 /*
 120  * Map an UCS4 string.  All mapping schemes regsitered in `ctx'
 121  * are applied in the regisration order.
 122  *
 123  * Returns:
 124  *      idn_success             -- ok.
 125  *      idn_nomemory            -- malloc failed.
 126  *      idn_buffer_overflow     -- output buffer is too small.
 127  */
 128 IDN_EXPORT idn_result_t
 129 idn_mapper_map(idn_mapper_t ctx, const unsigned long *from,
 130                unsigned long *to, size_t tolen);
 131
 132 /*
 133  * Mapping procedure type.
 134  */
 135 typedef idn_result_t (*idn_mapper_createproc_t)(const char *parameter,
 136                                                 void **ctxp);
 137 typedef void         (*idn_mapper_destroyproc_t)(void *ctxp);
 138 typedef idn_result_t (*idn_mapper_mapproc_t)(void *ctx,
 139                                              const unsigned long *from,
 140                                              unsigned long *, size_t);
 141
 142 /*
 143  * Register a new mapping scheme.
 144  *
 145  * You can override the default normalization schemes, if you want.
 146  *
 147  * Returns:
 148  *      idn_success             -- ok.
 149  *      idn_nomemory            -- malloc failed.
 150  */
 151 IDN_EXPORT idn_result_t
 152 idn_mapper_register(const char *prefix,
 153                     idn_mapper_createproc_t create,
 154                     idn_mapper_destroyproc_t destroy,
 155                     idn_mapper_mapproc_t map);
 156
 157 #ifdef __cplusplus
 158 }
 159 #endif
 160
 161 #endif /* IDN_MAPPER_H */