1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
|
/* $Id: checker.h,v 1.5 2001/10/31 08:51:28 m-kasahr Exp $ */
/*
* Copyright (c) 2001 Japan Network Information Center. All rights reserved.
*
* By using this file, you agree to the terms and conditions set forth bellow.
*
* LICENSE TERMS AND CONDITIONS
*
* The following License Terms and Conditions apply, unless a different
* license is obtained from Japan Network Information Center ("JPNIC"),
* a Japanese association, Kokusai-Kougyou-Kanda Bldg 6F, 2-3-4 Uchi-Kanda,
* Chiyoda-ku, Tokyo 101-0047, Japan.
*
* 1. Use, Modification and Redistribution (including distribution of any
* modified or derived work) in source and/or binary forms is permitted
* under this License Terms and Conditions.
*
* 2. Redistribution of source code must retain the copyright notices as they
* appear in each source code file, this License Terms and Conditions.
*
* 3. Redistribution in binary form must reproduce the Copyright Notice,
* this License Terms and Conditions, in the documentation and/or other
* materials provided with the distribution. For the purposes of binary
* distribution the "Copyright Notice" refers to the following language:
* "Copyright (c) Japan Network Information Center. All rights reserved."
*
* 4. Neither the name of JPNIC may be used to endorse or promote products
* derived from this Software without specific prior written approval of
* JPNIC.
*
* 5. Disclaimer/Limitation of Liability: THIS SOFTWARE IS PROVIDED BY JPNIC
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
* PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JPNIC BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
*
* 6. Indemnification by Licensee
* Any person or entities using and/or redistributing this Software under
* this License Terms and Conditions shall defend indemnify and hold
* harmless JPNIC from and against any and all judgements damages,
* expenses, settlement liabilities, cost and other liabilities of any
* kind as a result of use and redistribution of this Software or any
* claim, suite, action, litigation or proceeding by any third party
* arising out of or relates to this License Terms and Conditions.
*
* 7. Governing Law, Jurisdiction and Venue
* This License Terms and Conditions shall be governed by and and
* construed in accordance with the law of Japan. Any person or entities
* using and/or redistributing this Software under this License Terms and
* Conditions hereby agrees and consent to the personal and exclusive
* jurisdiction and venue of Tokyo District Court of Japan.
*/
#ifndef MDN_CHECKER_H
#define MDN_CHECKER_H 1
/*
* Character Checker.
*
* Perfom checking characters in the specified domain name.
*/
#include <mdn/result.h>
#include <mdn/filechecker.h>
#include <mdn/nameprep.h>
/*
* Schems name prefixes for the standard nameprep prohibit/unassigned
* checks.
*
* If you'd like to add the unassigned check scheme of "nameprep-XX"
* to a checker context, MDN_CHECKER_UNASSIGNED_PREFIX + "nameprep-XX"
* (i.e. "unassigned#nameprep-XX") is the scheme name passed to
* mdn_checker_add().
*/
#define MDN_CHECKER_PROHIBIT_PREFIX "prohibit#"
#define MDN_CHECKER_UNASSIGNED_PREFIX "unassigned#"
/*
* Checker object type.
*/
typedef struct mdn_checker *mdn_checker_t;
/*
* Initialize module. Must be called before any other calls of
* the functions of this module.
*
* Returns:
* mdn_success -- ok.
* mdn_nomemory -- malloc failed.
*/
extern mdn_result_t
mdn_checker_initialize(void);
/*
* Create a checker context.
*
* Returns:
* mdn_success -- ok.
* mdn_nomemory -- malloc failed.
*/
extern mdn_result_t
mdn_checker_create(mdn_checker_t *ctxp);
/*
* Decrement reference count of the checker `ctx' created by
* 'mdn_checker_create', if it is still refered by another object.
* Otherwise, release all the memory allocated to the checker.
*/
extern void
mdn_checker_destroy(mdn_checker_t ctx);
/*
* Increment reference count of the checker `ctx' created by
* 'mdn_checker_create'.
*/
extern void
mdn_checker_incrref(mdn_checker_t ctx);
/*
* Add checking scheme `name' to the checker to `ctx'.
*
* Returns:
* mdn_success -- ok.
* mdn_invalid_name -- the given name is not valid.
* mdn_nomemory -- malloc failed.
*/
extern mdn_result_t
mdn_checker_add(mdn_checker_t ctx, const char *name);
extern mdn_result_t
mdn_checker_addall(mdn_checker_t ctx, const char **names, int nnames);
/*
* Check an UTF-8 name. All checking schemes regsitered in `ctx'
* are applied in the regisration order.
*
* Returns:
* mdn_success -- ok.
* mdn_nomemory -- malloc failed.
* mdn_buffer_overflow -- output buffer is too small.
* mdn_invalid_encoding -- the input string has invalid/illegal
* UTF-8 sequence.
*/
extern mdn_result_t
mdn_checker_lookup(mdn_checker_t ctx, const char *utf8, const char **found);
/*
* Checking procedure type.
*/
typedef mdn_result_t (*mdn_checker_createproc_t)(const char *parameter,
void **ctxp);
typedef void (*mdn_checker_destroyproc_t)(void *ctx);
typedef mdn_result_t (*mdn_checker_lookupproc_t)(void *ctx, const char *utf8,
const char **found);
/*
* Register a new checking scheme.
*
* You can override the default normalization schemes, if you want.
*
* Returns:
* mdn_success -- ok.
* mdn_nomemory -- malloc failed.
*/
extern mdn_result_t
mdn_checker_register(const char *prefix,
mdn_checker_createproc_t create,
mdn_checker_destroyproc_t destroy,
mdn_checker_lookupproc_t lookup);
#endif /* MDN_CHECKER_H */
|