/* 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: dk4bf.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 DK4BF_H_INCLUDED /** Avoid multiple inclusions. */ #define DK4BF_H_INCLUDED 1 #line 10 "dk4bf.ctr" /** @file dk4bf.h Bit fields. */ #ifndef DK4ERROR_H_INCLUDED #include "dk4error.h" #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
if sz is 0, - DK4_E_MEMORY_ALLOCATION_FAILED
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
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
if dptr or bfptr is NULL or bitno is outside the bit field size. */ int dk4bf_get(int *dptr, dk4_bit_field_t *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