chiark / gitweb /
codec/{base32,hex}.h: Include `codec.h'.
[mLib] / codec / hex.h
CommitLineData
ee393574 1/* -*-c-*-
2 *
ee393574 3 * Hexadecimal encoding and decoding
4 *
5 * (c) 2001 Straylight/Edgeware
6 */
7
d4efbcd9 8/*----- Licensing notice --------------------------------------------------*
ee393574 9 *
10 * This file is part of the mLib utilities library.
11 *
12 * mLib is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU Library General Public License as
14 * published by the Free Software Foundation; either version 2 of the
15 * License, or (at your option) any later version.
d4efbcd9 16 *
ee393574 17 * mLib is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU Library General Public License for more details.
d4efbcd9 21 *
ee393574 22 * You should have received a copy of the GNU Library General Public
23 * License along with mLib; if not, write to the Free
24 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
25 * MA 02111-1307, USA.
26 */
27
ee393574 28#ifndef MLIB_HEX_H
29#define MLIB_HEX_H
30
31#ifdef __cplusplus
32 extern "C" {
33#endif
34
35/*----- Header files ------------------------------------------------------*/
36
e39fbd14
MW
37#ifndef MLIB_CODEC_H
38# include "codec.h"
39#endif
40
dd3c57bc
MW
41#ifndef MLIB_DSTR_H
42# include "dstr.h"
43#endif
ee393574 44
45/*----- Data structures ---------------------------------------------------*/
46
47typedef struct hex_ctx {
48 unsigned long acc; /* Accumulator for output data */
49 unsigned qsz; /* Length of data queued */
50 unsigned lnlen; /* Length of the current line */
51 const char *indent; /* Newline-and-indent string */
52 unsigned maxline; /* Maximum permitted line length */
53} hex_ctx;
54
55/*----- Functions provided ------------------------------------------------*/
56
57/* --- @hex_encode@ --- *
58 *
59 * Arguments: @hex_ctx *ctx@ = pointer to a context block
60 * @const void *p@ = pointer to a source buffer
61 * @size_t sz@ = size of the source buffer
62 * @dstr *d@ = pointer to destination string
63 *
64 * Returns: ---
65 *
66 * Use: Encodes a binary string in hex.
67 */
68
69extern void hex_encode(hex_ctx */*ctx*/, const void */*p*/, size_t /*sz*/,
70 dstr */*d*/);
71
72/* --- @hex_decode@ --- *
73 *
74 * Arguments: @hex_ctx *ctx@ = pointer to a context block
75 * @const void *p@ = pointer to a source buffer
76 * @size_t sz@ = size of the source buffer
77 * @dstr *d@ = pointer to destination string
78 *
79 * Returns: ---
80 *
81 * Use: Decodes a binary string in hex. Pass in a null source
82 * pointer when you thing you've finished.
83 */
84
85extern void hex_decode(hex_ctx */*ctx*/, const void */*p*/, size_t /*sz*/,
86 dstr */*d*/);
87
88/* --- @hex_init@ --- *
89 *
90 * Arguments: @hex_ctx *ctx@ = pointer to context block to initialize
91 *
92 * Returns: ---
93 *
94 * Use: Initializes a hex context properly.
95 */
96
97extern void hex_init(hex_ctx */*ctx*/);
98
236f657b
MW
99/*----- Codec object interface --------------------------------------------*/
100
101extern const codec_class hex_class;
102
ee393574 103/*----- That's all, folks -------------------------------------------------*/
104
105#ifdef __cplusplus
106 }
107#endif
108
109#endif