2 * Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC")
3 * Copyright (C) 2000, 2001 Internet Software Consortium.
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
9 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
10 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11 * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15 * PERFORMANCE OF THIS SOFTWARE.
18 /* $Id: hex.h,v 1.4.206.1 2004/03/06 08:14:41 marka Exp $ */
24 #include <isc/types.h>
33 isc_hex_totext(isc_region_t *source, int wordlength,
34 const char *wordbreak, isc_buffer_t *target);
36 * Convert data into hex encoded text.
39 * The hex encoded text in 'target' will be divided into
40 * words of at most 'wordlength' characters, separated by
41 * the 'wordbreak' string. No parentheses will surround
45 * 'source' is a region containing binary data
46 * 'target' is a text buffer containing available space
47 * 'wordbreak' points to a null-terminated string of
48 * zero or more whitespace characters
51 * target will contain the hex encoded version of the data
52 * in source. The 'used' pointer in target will be advanced as
57 isc_hex_decodestring(char *cstr, isc_buffer_t *target);
59 * Decode a null-terminated hex string.
63 * 'target' is a valid buffer.
66 * ISC_R_SUCCESS -- the entire decoded representation of 'cstring'
68 * ISC_R_BADHEX -- 'cstr' is not a valid hex encoding.
70 * Other error returns are any possible error code from:
72 * isc_lex_openbuffer(),
77 isc_hex_tobuffer(isc_lex_t *lexer, isc_buffer_t *target, int length);
79 * Convert hex encoded text from a lexer context into data.
82 * 'lex' is a valid lexer context
83 * 'target' is a buffer containing binary data
84 * 'length' is an integer
87 * target will contain the data represented by the hex encoded
88 * string parsed by the lexer. No more than length bytes will be read,
89 * if length is positive. The 'used' pointer in target will be
90 * advanced as necessary.
96 #endif /* ISC_HEX_H */