text: /*
   * Copyright (C) 2004-2008  Internet Systems Consortium, Inc. ("ISC")
   * Copyright (C) 2000, 2001  Internet Software Consortium.
   *
   * Permission to use, copy, modify, and/or distribute this software for any
   * purpose with or without fee is hereby granted, provided that the above
   * copyright notice and this permission notice appear in all copies.
   *
   * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
   * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
   * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
   * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
   * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
   * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
   * PERFORMANCE OF THIS SOFTWARE.
   */
  
  /* $Id: hex.h,v 1.13 2008-09-25 04:02:39 tbox Exp $ */
  
  #ifndef ISC_HEX_H
  #define ISC_HEX_H 1
  
  /*! \file isc/hex.h */
  
  #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);
  /*!<
   * \brief Convert data into hex encoded text.
   *
   * Notes:
   *\li	The hex encoded text in 'target' will be divided into
   *	words of at most 'wordlength' characters, separated by
   * 	the 'wordbreak' string.  No parentheses will surround
   *	the text.
   *
   * Requires:
   *\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
   *		zero or more whitespace characters
   *
   * Ensures:
   *\li	target will contain the hex encoded version of the data
   *	in source.  The 'used' pointer in target will be advanced as
   *	necessary.
   */
  
  isc_result_t
  isc_hex_decodestring(const char *cstr, isc_buffer_t *target);
  /*!<
   * \brief Decode a null-terminated hex string.
   *
   * Requires:
   *\li	'cstr' is non-null.
   *\li	'target' is a valid buffer.
   *
   * Returns:
   *\li	#ISC_R_SUCCESS	-- the entire decoded representation of 'cstring'
   *			   fit in 'target'.
   *\li	#ISC_R_BADHEX -- 'cstr' is not a valid hex encoding.
   *
   * 	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);
  /*!<
   * \brief Convert hex encoded text from a lexer context into data.
   *
   * Requires:
   *\li	'lex' is a valid lexer context
   *\li	'target' is a buffer containing binary data
   *\li	'length' is an integer
   *
   * Ensures:
   *\li	target will contain the data represented by the hex encoded
   *	string parsed by the lexer.  No more than length bytes will be read,
   *	if length is positive.  The 'used' pointer in target will be
   *	advanced as necessary.
   */
  
  
  ISC_LANG_ENDDECLS
  
  #endif /* ISC_HEX_H */
  