summaryrefslogtreecommitdiff
path: root/support/dktools/dk4bf.h
blob: 4847cb60a7078ba418dbb611ed618570f38fccd2 (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
/*
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: dk4bf.ctr
*/

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


#line 10 "dk4bf.ctr"

/**	@file	dk4bf.h	Bit fields.
*/

#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 field structure.
*/
typedef struct {
  unsigned char	*d;	/**< Data buffer. */
  size_t	 s;	/**< Number of bits in the array. */
} dk4_bit_field_t;

#ifdef __cplusplus
extern "C" {
#endif

/**	Open bit field.
	@param	sz	Size of the bit field (number of bits).
	@param	erp	Error report, may be NULL.
	@return	Pointer to new bit field on success, NULL on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if sz is 0,
	- DK4_E_MEMORY_ALLOCATION_FAILED<br>
	  if not enough memory was available.
*/
dk4_bit_field_t *
dk4bf_open(size_t sz, dk4_er_t *erp);

/**	Set one bit in a bit field.
	@param	dptr	Bit field.
	@param	bitno	Index of bit to modify.
	@param	val	Bit value.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if dptr is 0 or bitno is outside the bit field size.
*/
int
dk4bf_set(dk4_bit_field_t *dptr, size_t bitno, int val, dk4_er_t *erp);

/**	Retrieve one value from bit field.
	@param	dptr	Address of result variable.
	@param	bfptr	Bit field.
	@param	bitno	Number of bit to obtain.
	@param	erp	Error report, may be NULL.
	@return	1 on success (dptr set), 0 on error (dptr unchanged).

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if dptr or bfptr is NULL or bitno is outside the bit field size.
*/
int
dk4bf_get(int *dptr, dk4_bit_field_t const *bfptr, size_t bitno, dk4_er_t *erp);

/**	Close bit field.
	@param	ptr	Pointer to bit field previously opened using
			dk4bf_open().
*/
void
dk4bf_close(dk4_bit_field_t *ptr);

#ifdef __cplusplus
}
#endif




#endif