summaryrefslogtreecommitdiff
path: root/support/dktools/dk4bitsh.ctr
blob: 31305d257ce43aa2be1f21abb1f6991dced95e88 (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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
%%	options

copyright owner	=	Dirk Krause
copyright year	=	2015-xxxx
SPDX-License-Identifier:	BSD-3-Clause



%%	header

/**	@file	dk4bitsh.h	Bit shifting.
*/

#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


/**	Bit shifter.
*/
typedef struct {
  int			pos;	/**< Current bit position. */
  unsigned char		obyte;	/**< Output byte. */
} dk4_bit_shift_t;

#ifdef __cplusplus
extern "C" {
#endif

/**	Initialize a bit shifter before using it.
	@param	bs	Bit shifter to initialize.
	@param	erp	Error report, may be NULL.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS	if bs is NULL.
*/
void
dk4bit_shift_init(dk4_bit_shift_t *bs, dk4_er_t *erp);

/**	Add one byte.
	@param	bs	Bit shifter.
	@param	bit	Bit value, 0 or non-0.
	@param	erp	Error report, may be NULL.
	@return	Action to take, one from:
	- DK4_EDSTM_ACCEPT<br>
	  if the bit was stored in the bit shifter. No action necessary.
	- DK4_EDSTM_FINISHED<br>
	  if one byte was completed by adding the bit.
	  Use dk4bit_shift_output() to retrieve the finished byte.
	- DK4_EDSTM_ERROR<br>
	  if an error occured.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if bs is NULL.
*/
int
dk4bit_shift_add(dk4_bit_shift_t *bs, int bit, dk4_er_t *erp);

/**	Check for unused content in the bit shifter after adding all bits.
	@param	bs	Bit shifter.
	@param	erp	Error report, may be NULL.
	@return	Action to take, one from:
	- DK4_EDSTM_ACCEPT<br>
	  if no action is required.
	- DK4_EDSTM_FINISHED<br>
	  if significant bits are available for a byte.
	  Use dk4bit_shift_output() to retrieve the byte value.
	- DK4_EDSTM_ERROR<br>
	  if an error occured.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if bs is NULL.
*/
int
dk4bit_shift_finish(dk4_bit_shift_t *bs, dk4_er_t *erp);

/**	Retrieve previous completed byte or final incomplete byte.
	@param	bs	Bit shifter.
	@param	erp	Error report, may be NULL.
	@return	Byte value consisting of the last bits added.
*/
unsigned char
dk4bit_shift_output(dk4_bit_shift_t const *bs, dk4_er_t *erp);

#ifdef __cplusplus
}
#endif

%%	module

#include "dk4conf.h"

#if	DK4_HAVE_ASSERT_H
#ifndef	ASSERT_H_INCLUDED
#include <assert.h>
#define	ASSERT_H_INCLUDED 1
#endif
#endif

#include "dk4bitsh.h"
#include "dk4edstm.h"
#include "dk4mem.h"



$!trace-include




void
dk4bit_shift_init(dk4_bit_shift_t *bs, dk4_er_t *erp)
{
  $? "+ dk4bit_shift_init bs=%d", TR_IPTR(bs)
#if	DK4_USE_ASSERT
  assert(NULL != bs);
#endif
  if (NULL != bs) {
    DK4_MEMRES(bs, sizeof(dk4_bit_shift_t));
    bs->pos = 0;
    bs->obyte = 0x00;
  } else {
    dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
  }
  $? "- dk4bit_shift_init"
}



int
dk4bit_shift_add(dk4_bit_shift_t *bs, int bit, dk4_er_t *erp)
{
  int		 back	=	DK4_EDSTM_ERROR;
  $? "+ dk4bit_shift_add bs=%d bit=%d pos=%d", TR_IPTR(bs), bit, (int)(bs->pos)
#if	DK4_USE_ASSERT
  assert(NULL != bs);
#endif
  if (NULL != bs) {
    back = DK4_EDSTM_ACCEPT;
    switch (bs->pos) {
      case 0: {
        if (0 != bit) { bs->obyte = 0x80; } else { bs->obyte = 0x00; }
	bs->pos = 1;
      } break;
      case 1: {
        if (0 != bit) { bs->obyte |= 0x40; }
	bs->pos = 2;
      } break;
      case 2: {
        if (0 != bit) { bs->obyte |= 0x20; }
	bs->pos = 3;
      } break;
      case 3: {
        if (0 != bit) { bs->obyte |= 0x10; }
	bs->pos = 4;
      } break;
      case 4: {
        if (0 != bit) { bs->obyte |= 0x08; }
	bs->pos = 5;
      } break;
      case 5: {
        if (0 != bit) { bs->obyte |= 0x04; }
	bs->pos = 6;
      } break;
      case 6: {
        if (0 != bit) { bs->obyte |= 0x02; }
	bs->pos = 7;
      } break;
      case 7: {
        if (0 != bit) { bs->obyte |= 0x01; }
	bs->pos = 0;
	back = DK4_EDSTM_FINISHED; $? ". byte finished %d", (int)(bs->obyte)
      } break;
    }
  } else {
    dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
  }
  $? "- dk4bit_shift_add %d", back
  return back;
}



int
dk4bit_shift_finish(dk4_bit_shift_t *bs, dk4_er_t *erp)
{
  int		 back	=	DK4_EDSTM_ERROR;
  $? "+ dk4bit_shift_finish bs=%d", TR_IPTR(bs)
#if	DK4_USE_ASSERT
  assert(NULL != bs);
#endif
  if (NULL != bs) {
    if (0 != bs->pos) {
      back = DK4_EDSTM_FINISHED;
    } else {
      back = DK4_EDSTM_ACCEPT;	$? ". final byte available"
    }
  } else {
    dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
  }
  $? "- dk4bit_shift_finish %d", back
  return back;
}



unsigned char
dk4bit_shift_output(dk4_bit_shift_t const *bs, dk4_er_t *erp)
{
  unsigned char	 back;
  $? "+ dk4bit_shift_output bs=%d", TR_IPTR(bs)
#if	DK4_USE_ASSERT
  assert(NULL != bs);
#endif
  if (NULL != bs) {
    back = bs->obyte;
  } else {
    back = 0x00;
    dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
  }
  $? "- dk4bit_shift_output %d", (int)back
  return back;
}