summaryrefslogtreecommitdiff
path: root/support/dktools/dk4binenc.h
blob: 8adaad3774d3f0db95a40160c60d7537d20fb265 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
/*
Copyright (C) 2015-2020, Dirk Krause
SPDX-License-Identifier: BSD-3-Clause
*/

/*
	WARNING: This file was generated by the dkct program (see
	http://dktools.sourceforge.net/ for details).
	Changes you make here will be lost if dkct is run again!
	You should modify the original source and run dkct on it.
	Original source: dk4binenc.ctr
*/

#ifndef DK4BINENC_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK4BINENC_H_INCLUDED 1


#line 10 "dk4binenc.ctr"

/**	@file	dk4binenc.h	Encode binary data to text.
*/

#ifndef	DK4CONF_H_INCLUDED
#if	DK4_BUILDING_DKTOOLS4
#include "dk4conf.h"
#else
#include <dktools-4/dk4conf.h>
#endif
#endif

#ifndef	DK4ERROR_H_INCLUDED
#if	DK4_BUILDING_DKTOOLS4
#include "dk4error.h"
#else
#include <dktools-4/dk4error.h>
#endif
#endif


#ifdef __cplusplus
extern "C" {
#endif

/**	Encode binary data to text.
	Data is saved as text string including finalizing 0 byte
	except for DK4_BINARY_TO_TEXT_ENCODING_NONE.
	@param	dptr	Destination buffer address.
	@param	szdptr	Destination buffer size.
	@param	sptr	Source buffer address.
	@param	szsptr	Source buffer size.
	@param	enc	Encoding, one from
	DK4_BINARY_TO_TEXT_ENCODING_NONE,
	DK4_BINARY_TO_TEXT_ENCODING_HEX,
	or DK4_BINARY_TO_TEXT_ENCODING_A85.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if dptr or sptr is NULL or szdptr or szsptr is 0 or an illegal
	  enc value was specified,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if the provided destination buffer is too small,
	- DK4_E_MATH_OVERFLOW<br>
	  if a mathematical overflow occured in size calculation
	  (required destination buffer size too large),
	- DK4_E_ENCODING_FAILED<br>
	  if encoding failed for a byte.
*/
int
dk4binenc(
  char		*dptr,
  size_t	 szdptr,
  const void	*sptr,
  size_t	 szsptr,
  int		 enc,
  dk4_er_t	*erp
);

/**	Find numeric encoding type for an encoding name.
	@param	name	String containing encoding name.
	@param	erp	Error report, may be NULL.
	@return	Non-negative numeric encoding type on success, -1 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if name is NULL,
	- DK4_E_SYNTAX<br>
	  if name is not a valid encoding name.
*/
int
dk4binenc_choose_encoding(const dkChar *name, dk4_er_t *erp);

#ifdef __cplusplus
}
#endif

/**	Message digest encodings.
*/
enum {
					/**	No encoding, use binary
						data directly.
					*/
  DK4_BINARY_TO_TEXT_ENCODING_NONE	= 0,

					/**	ASCII-Hex encoding.
					*/
  DK4_BINARY_TO_TEXT_ENCODING_HEX ,

					/**	ASCII-85 encoding.
					*/
  DK4_BINARY_TO_TEXT_ENCODING_A85
};




#endif