ppg_bitfield.h

/* Copyright 2017 noseglasses <shinynoseglasses@gmail.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef PPG_BITFIELD_H
#define PPG_BITFIELD_H

#include "ppg_settings.h"

#include <stdint.h>
#include <stdbool.h>

typedef uint8_t PPG_Bitfield_Storage_Type;

typedef struct {
   
   // Use a bitarray to store input state
   //
   PPG_Bitfield_Storage_Type *bitarray; 
   
   uint8_t n_bits; 
   
} PPG_Bitfield;

void ppg_bitfield_init(PPG_Bitfield *bitfield);

void ppg_bitfield_resize(PPG_Bitfield *bitfield, 
                         uint8_t n_bits, 
                         bool keep_content);

PPG_Count ppg_bitfield_get_num_cells(PPG_Bitfield *bitfield);
PPG_Count ppg_bitfield_get_num_cells_from_bits(uint8_t n_bits);

void ppg_bitfield_clear(PPG_Bitfield *bitfield);

bool ppg_bitfield_get_bit(PPG_Bitfield *bitfield, 
                           PPG_Count pos);

void ppg_bitfield_set_bit(PPG_Bitfield *bitfield, 
                           PPG_Count pos, 
                           bool state);

void ppg_bitfield_copy(PPG_Bitfield *source, PPG_Bitfield *target);

void ppg_bitfield_destroy(PPG_Bitfield *bitfield);

#endif