3 * $Id: hex.h,v 1.2 2004/04/08 01:36:11 mdw Exp $
5 * Hexadecimal encoding and decoding
7 * (c) 2001 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of the mLib utilities library.
14 * mLib is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU Library General Public License as
16 * published by the Free Software Foundation; either version 2 of the
17 * License, or (at your option) any later version.
19 * mLib is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU Library General Public License for more details.
24 * You should have received a copy of the GNU Library General Public
25 * License along with mLib; if not, write to the Free
26 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
37 /*----- Header files ------------------------------------------------------*/
41 /*----- Data structures ---------------------------------------------------*/
43 typedef struct hex_ctx {
44 unsigned long acc; /* Accumulator for output data */
45 unsigned qsz; /* Length of data queued */
46 unsigned lnlen; /* Length of the current line */
47 const char *indent; /* Newline-and-indent string */
48 unsigned maxline; /* Maximum permitted line length */
51 /*----- Functions provided ------------------------------------------------*/
53 /* --- @hex_encode@ --- *
55 * Arguments: @hex_ctx *ctx@ = pointer to a context block
56 * @const void *p@ = pointer to a source buffer
57 * @size_t sz@ = size of the source buffer
58 * @dstr *d@ = pointer to destination string
62 * Use: Encodes a binary string in hex.
65 extern void hex_encode(hex_ctx */*ctx*/, const void */*p*/, size_t /*sz*/,
68 /* --- @hex_decode@ --- *
70 * Arguments: @hex_ctx *ctx@ = pointer to a context block
71 * @const void *p@ = pointer to a source buffer
72 * @size_t sz@ = size of the source buffer
73 * @dstr *d@ = pointer to destination string
77 * Use: Decodes a binary string in hex. Pass in a null source
78 * pointer when you thing you've finished.
81 extern void hex_decode(hex_ctx */*ctx*/, const void */*p*/, size_t /*sz*/,
84 /* --- @hex_init@ --- *
86 * Arguments: @hex_ctx *ctx@ = pointer to context block to initialize
90 * Use: Initializes a hex context properly.
93 extern void hex_init(hex_ctx */*ctx*/);
95 /*----- That's all, folks -------------------------------------------------*/