summaryrefslogtreecommitdiff
path: root/support/dktools/dk4a85e.h
blob: f35feaea27299865cb4905dbb45482e5ac2ba969 (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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
/*
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: dk4a85e.ctr
*/

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


#line 10 "dk4a85e.ctr"

/**	@file	dk4a85e.h	ASCII-85 encoder.

First initialize the encoder using the dk4a85_enc_init().

Now add the binary bytes one by one using the dk4a85_enc_add() function, as
long as you have bytes available and the function returns DK4_EDSTM_ACCEPT
or DK4_EDSTM_FINISHED.

If the function returns DK4_EDSTM_ACCEPT, no further action is required,
the byte was successfully stored in the internal data structures.

If dk4a85_enc_add() returns DK4_EDSTM_FINISHED, a sequence of 4 binary
bytes was processed successfully, a 1 character or 5 character sequence
was produced. Use dk4a85_enc_output() to obtain the characters.

Input data length is not necessarily a multiple of 4, so after feeding
all binary bytes some values might still be stored in the encoder.
Use dk4a85_enc_finish() to check whether an incomplete final sequence
is available. If the function returns DK4_EDSTM_FINISHED, use
dk4a85_enc_output() to obtain the text characters for the final bytes.

*/

#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

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



/**	ASCII 85 encoder.
*/
typedef struct {
  char		ob[6];		/**< Output bytes, 5 + finalizer */
  unsigned char	ib[4];		/**< Input bytes to process. */
  size_t	ci;		/**< Index of current input byte. */
  size_t	os;		/**< Number of outupt bytes available */
  short		az;		/**< Allow z encoding */
} dk4_a85_enc_t;


#ifdef __cplusplus
extern "C" {
#endif

/**	Initialize ASCII 85 encoder before adding data.
	@param	enc	Encoder to initialize.
	@param	az	Flag: Allow 'z' output character.
	@param	erp	Error report, may be NULL.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS	if enc is NULL.
*/
void
dk4a85_enc_init(dk4_a85_enc_t *enc, int az, dk4_er_t *erp);

/**	Add one byte to encoder.
	@param	enc	Encoder to use.
	@param	input	Input byte to add.
	@param	erp	Error report, may be NULL.
	@return	Action to take, one from:
	- DK4_EDSTM_ACCEPT<br>
	  if input was accepted, no further action necessary at the moment.
	- DK4_EDSTM_FINISHED<br>
	  if a sequence of 4 input bytes was completed, use
	  dk4a85_enc_output() to obtain the text characters.
	- DK4_EDSTM_ERROR<br>
	  if an error occured.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS	if enc is NULL.
*/
int
dk4a85_enc_add(dk4_a85_enc_t *enc, unsigned char input, dk4_er_t *erp);

/**	Check for incomplete sequence in state machine after processing
	all input bytes.
	@param	enc	Encoder to use.
	@param	erp	Error report, may be NULL.
	@return	Action to take, one from:
	- DK4_EDSTM_ACCEPT<br>
	  if there is no incomplete sequence in the state machine,
	  no further action necessary.
	- DK4_EDSTM_FINISHED<br>
	  if an incomplete final sequence is available, use
	  dk4a85_enc_output() to obtain the text characters.
	- DK4_EDSTM_ERROR<br>
	  if an error occured.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS	if enc is NULL.
*/
int
dk4a85_enc_finish(dk4_a85_enc_t *enc, dk4_er_t *erp);

/**	Retrieve text sequence.
	@param	dptr	Address of destination pointer to set, should be
			initialized to NULL.
	@param	szptr	Address of size variable to set, should be
			initialized to 0.
	@param	enc	Encoder to use.
	@param	erp	Error report, may be NULL.
	@return	1 on success (text available), 0 otherwise.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS	if enc, dptr, or szptr is NULL.
*/
int
dk4a85_enc_output(
  const char		**dptr,
  size_t		 *szptr,
  dk4_a85_enc_t	const	 *enc,
  dk4_er_t		 *erp
);

#ifdef __cplusplus
}
#endif


#endif