include/qpid/dispatch/bitmask.h

#ifndef __dispatch_bitmask_h__
#define __dispatch_bitmask_h__ 1
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

/**@file
 * Large bit-sets.

 *@defgroup bitmask bitmask
 *
 *@{
 */

#include <stdbool.h>

/** A bit mask */
typedef struct qd_bitmask_t qd_bitmask_t;

/** Number of bits in a bitmask. */
int qd_bitmask_width(void);

/** Create a bitmask.
 *@param initial if non-zero set all bits, else clear all bits.
 */
qd_bitmask_t *qd_bitmask(int initial);
void qd_bitmask_free(qd_bitmask_t *b);
void qd_bitmask_set_all(qd_bitmask_t *b);
void qd_bitmask_clear_all(qd_bitmask_t *b);
int qd_bitmask_set_bit(qd_bitmask_t *b, int bitnum);
int qd_bitmask_clear_bit(qd_bitmask_t *b, int bitnum);
int qd_bitmask_value(qd_bitmask_t *b, int bitnum);
int qd_bitmask_first_set(qd_bitmask_t *b, int *bitnum);
int qd_bitmask_cardinality(const qd_bitmask_t *b);

bool qd_bitmask_valid_bit_value(int bitnum);

int _qdbm_start(qd_bitmask_t *b);
void _qdbm_next(qd_bitmask_t *b, int *v);

#define QD_BITMASK_EACH(M,V,C) C=qd_bitmask_cardinality(M),V=_qdbm_start(M);V>=0 && C;_qdbm_next(M,&V),C--

///@}

#endif