summaryrefslogtreecommitdiff
path: root/support/dktools/dk4c32.h
blob: 90b6223a84b285a0a7bc1ef90dabda7486df574d (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
/*
	WARNING: This file was generated by dkct.
	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
*/

/*
Copyright (C) 2015-2017, Dirk Krause

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above opyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
* Neither the name of the author nor the names of contributors may be used
  to endorse or promote products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#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
#include "dk4conf.h"
#endif

#ifndef DK4TYPES_H_INCLUDED
#include "dk4types.h"
#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 *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 *ptr);

#ifdef __cplusplus
}
#endif




#endif