summaryrefslogtreecommitdiff
path: root/support/dktools/dk4c32.h
blob: 354d9a8c1ee8bdb586618c8770e0ec88a485ab3e (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
/*
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: dk4c32.ctr
*/

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


#line 10 "dk4c32.ctr"

/**	@file
	32 bit character decoding.

	CRT on Windows: Not used.
*/

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

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

/**	Decoder structure to build a 32 bit character from 4 4 4 4 bytes.
*/
typedef struct {
  dk4_c32_t	val;	/**< Value constructed from the bytes. */
  int		msb;	/**< Flag: First byte is MSB. */
  int		nb;	/**< Number of next byte. */
} dk4_c32_byte_decoder_t;

#ifdef __cplusplus
extern "C" {
#endif

/**	Initialize the decoder.
	@param	ptr	Decoder to initialize.
	@param	msb	Flag: Most significant byte first.
*/
void
dk4c32_decoder_init(dk4_c32_byte_decoder_t *ptr, int msb);

/**	Add one byte to the decoder.
	@param	ptr
	@param	inbyte
	@return	DK4_EDSTM_ACCEPT if the byte was added to the internal
	decoder state (no action necessary) or
	DK4_EDSTM_FINISHED if one output was finished (use
	dk4c32_decoder_get() to obtain the value).
*/
int
dk4c32_decoder_add(dk4_c32_byte_decoder_t *ptr, unsigned char inbyte);

/**	Retrieve output value.
	@param	ptr	Decoder to retrieve value from.
	@return	Output produced by the decoder.
*/
dk4_c32_t
dk4c32_decoder_get(dk4_c32_byte_decoder_t const *ptr);

/**	Check whether the decoder is empty (nothing is stored in the
	internal state).
	@param	ptr	Decoder to check.
	@return	1 on success (decoder empty), 0 otherwise.
*/
int
dk4c32_decoder_is_empty(dk4_c32_byte_decoder_t const *ptr);

#ifdef __cplusplus
}
#endif




#endif