hex.h 2.74 KB
Newer Older
Brian Wellington's avatar
Brian Wellington committed
1
/*
2
 * Copyright (C) Internet Systems Consortium, Inc. ("ISC")
Brian Wellington's avatar
Brian Wellington committed
3
 *
4 5 6
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
7 8 9
 *
 * See the COPYRIGHT file distributed with this work for additional
 * information regarding copyright ownership.
Brian Wellington's avatar
Brian Wellington committed
10 11 12
 */


13 14 15
#ifndef ISC_HEX_H
#define ISC_HEX_H 1

16
/*! \file isc/hex.h */
17

18 19 20 21 22 23 24 25 26 27 28 29
#include <isc/lang.h>
#include <isc/types.h>

ISC_LANG_BEGINDECLS

/***
 *** Functions
 ***/

isc_result_t
isc_hex_totext(isc_region_t *source, int wordlength,
	       const char *wordbreak, isc_buffer_t *target);
30 31
/*!<
 * \brief Convert data into hex encoded text.
32 33
 *
 * Notes:
34
 *\li	The hex encoded text in 'target' will be divided into
35 36 37 38 39
 *	words of at most 'wordlength' characters, separated by
 * 	the 'wordbreak' string.  No parentheses will surround
 *	the text.
 *
 * Requires:
40 41 42
 *\li	'source' is a region containing binary data
 *\li	'target' is a text buffer containing available space
 *\li	'wordbreak' points to a null-terminated string of
43 44 45
 *		zero or more whitespace characters
 *
 * Ensures:
46
 *\li	target will contain the hex encoded version of the data
47 48 49 50 51
 *	in source.  The 'used' pointer in target will be advanced as
 *	necessary.
 */

isc_result_t
52
isc_hex_decodestring(const char *cstr, isc_buffer_t *target);
53 54
/*!<
 * \brief Decode a null-terminated hex string.
55 56
 *
 * Requires:
57 58
 *\li	'cstr' is non-null.
 *\li	'target' is a valid buffer.
59 60
 *
 * Returns:
61
 *\li	#ISC_R_SUCCESS	-- the entire decoded representation of 'cstring'
62
 *			   fit in 'target'.
63
 *\li	#ISC_R_BADHEX -- 'cstr' is not a valid hex encoding.
64 65 66 67 68 69 70 71 72
 *
 * 	Other error returns are any possible error code from:
 *		isc_lex_create(),
 *		isc_lex_openbuffer(),
 *		isc_hex_tobuffer().
 */

isc_result_t
isc_hex_tobuffer(isc_lex_t *lexer, isc_buffer_t *target, int length);
73
/*!<
74 75 76 77 78 79 80 81 82 83 84
 * \brief Convert hex-encoded text from a lexer context into
 * `target`. If 'length' is non-negative, it is the expected number of
 * encoded octets to convert.
 *
 * If 'length' is -1 then 0 or more encoded octets are expected.
 * If 'length' is -2 then 1 or more encoded octets are expected.
 *
 * Returns:
 *\li	#ISC_R_BADHEX -- invalid hex encoding
 *\li	#ISC_R_UNEXPECTEDEND: the text does not contain the expected
 *			      number of encoded octets.
85 86
 *
 * Requires:
87
 *\li	'lexer' is a valid lexer context
88
 *\li	'target' is a buffer containing binary data
89
 *\li	'length' is -2, -1, or non-negative
90 91
 *
 * Ensures:
92
 *\li	target will contain the data represented by the hex encoded
93 94 95
 *	string parsed by the lexer.  No more than `length` octets will
 *	be read, if `length` is non-negative.  The 'used' pointer in
 *	'target' will be advanced as necessary.
96 97 98 99 100
 */

ISC_LANG_ENDDECLS

#endif /* ISC_HEX_H */