[bison.git] / lib / bitset.h

/* Generic bitsets.
   Copyright (C) 2002, 2003 Free Software Foundation, Inc.
   Contributed by Michael Hayes (m.hayes@elec.canterbury.ac.nz).

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 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 General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */

#ifndef _BITSET_H
#define _BITSET_H

/* This file is the public interface to the bitset abstract data type.
   Only use the functions and macros defined in this file.  */

#include "bbitset.h"

/* obstack.h tries to be portable to K&R compilers, but its
   __INT_TO_PTR macro generates diagnostics on compilers like Tru64 cc
   that define __STDC__ to 0 when not in strict ANSI mode.  The bitset
   code assumes C89 or later, so it can avoid these glitches by
   defining __INT_TO_PTR appropriately for C89 or later.  */
#ifndef __INT_TO_PTR
# define __INT_TO_PTR(P) ((void *) ((P) + (char *) 0))
#endif
#include "obstack.h"

#include <stdio.h>

/* Attributes used to select a bitset implementation.  */
enum bitset_attr {BITSET_FIXED = 1,    /* Bitset size fixed.  */
		  BITSET_VARIABLE = 2, /* Bitset size variable.  */
		  BITSET_DENSE = 4,    /* Bitset dense.  */
		  BITSET_SPARSE = 8,   /* Bitset sparse.  */
		  BITSET_FRUGAL = 16,  /* Prefer most compact.  */
		  BITSET_GREEDY = 32}; /* Prefer fastest at memory expense.  */

typedef unsigned int bitset_attrs;

/* The contents of the union should be considered to be private.
   While I would like to make this union opaque, it needs to be
   visible for the inline bit set/test functions, and for delegation
   to the proper implementation.  */
union bitset_union
{
  /* This must be the first member of every other structure that is a
     member of this union.  */
  struct bbitset_struct b;

  struct abitset_struct
  {
    struct bbitset_struct b;
    bitset_bindex n_bits;		/* Number of bits.  */
    bitset_word words[1];		/* The array of bits.  */
  } a;

  struct ebitset_struct
  {
    struct bbitset_struct b;
    bitset_windex size;			/* Number of elements.  */
    struct ebitset_elt_struct **elts;	/* Expanding array of ptrs to elts.  */
  } e;

  struct lbitset_struct
  {
    struct bbitset_struct b;
    struct lbitset_elt_struct *head;	/* First element in linked list.  */
    struct lbitset_elt_struct *tail;	/* Last element in linked list.  */
  } l;

  struct bitset_stats_struct
  {
    struct bbitset_struct b;
    bitset bset;
  } s;
};


/* The contents of this structure should be considered private.
   It is used for iterating over set bits.  */
typedef struct
{
  bitset_bindex list[BITSET_LIST_SIZE];
  bitset_bindex next;
  bitset_bindex num;
  bitset_bindex i;
} bitset_iterator;


/* Return bytes required for bitset of desired type and size.  */
extern size_t bitset_bytes PARAMS ((enum bitset_type, bitset_bindex));

/* Initialise a bitset with desired type and size.  */
extern bitset bitset_init PARAMS ((bitset, bitset_bindex, enum bitset_type));

/* Select an implementation type based on the desired bitset size
   and attributes.  */
extern enum bitset_type bitset_type_choose PARAMS ((bitset_bindex,
						    bitset_attrs));

/* Create a bitset of desired type and size.  The bitset is zeroed.  */
extern bitset bitset_alloc PARAMS ((bitset_bindex, enum bitset_type));

/* Free bitset.  */
extern void bitset_free PARAMS ((bitset));

/* Create a bitset of desired type and size using an obstack.  The
   bitset is zeroed.  */
extern bitset bitset_obstack_alloc PARAMS ((struct obstack *bobstack,
					    bitset_bindex, enum bitset_type));

/* Free bitset allocated on obstack.  */
extern void bitset_obstack_free PARAMS ((bitset));

/* Create a bitset of desired size and attributes.  The bitset is zeroed.  */
extern bitset bitset_create PARAMS ((bitset_bindex, bitset_attrs));

/* Return bitset type.  */
extern enum bitset_type bitset_type_get PARAMS ((bitset));

/* Return bitset type name.  */
extern const char *bitset_type_name_get PARAMS ((bitset));


/* Set bit BITNO in bitset BSET.  */
static inline void
bitset_set (bitset bset, bitset_bindex bitno)
{
  bitset_windex windex = bitno / BITSET_WORD_BITS;
  bitset_windex offset = windex - bset->b.cindex;

  if (offset < bset->b.csize)
    bset->b.cdata[offset] |= ((bitset_word) 1 << (bitno % BITSET_WORD_BITS));
  else
    BITSET_SET_ (bset, bitno);
}


/* Reset bit BITNO in bitset BSET.  */
static inline void
bitset_reset (bitset bset, bitset_bindex bitno)
{
  bitset_windex windex = bitno / BITSET_WORD_BITS;
  bitset_windex offset = windex - bset->b.cindex;

  if (offset < bset->b.csize)
    bset->b.cdata[offset] &= ~((bitset_word) 1 << (bitno % BITSET_WORD_BITS));
  else
    BITSET_RESET_ (bset, bitno);
}


/* Test bit BITNO in bitset BSET.  */
static inline bool
bitset_test (bitset bset, bitset_bindex bitno)
{
  bitset_windex windex = bitno / BITSET_WORD_BITS;
  bitset_windex offset = windex - bset->b.cindex;

  if (offset < bset->b.csize)
    return (bset->b.cdata[offset] >> (bitno % BITSET_WORD_BITS)) & 1;
  else
    return BITSET_TEST_ (bset, bitno);
}


/* Toggle bit BITNO in bitset BSET and return non-zero if now set.  */
#define bitset_toggle(bset, bitno) BITSET_TOGGLE_ (bset, bitno)

/* Return size in bits of bitset SRC.  */
#define bitset_size(SRC) BITSET_SIZE_ (SRC)

/* Return number of bits set in bitset SRC.  */
#define bitset_count(SRC) BITSET_COUNT_ (SRC)


/* Return SRC == 0.  */
#define bitset_empty_p(SRC) BITSET_EMPTY_P_ (SRC)

/* DST = ~0.  */
#define bitset_ones(DST) BITSET_ONES_ (DST)

/* DST = 0.  */
#define bitset_zero(DST) BITSET_ZERO_ (DST)


/* DST = SRC.  */
#define bitset_copy(DST, SRC) BITSET_COPY_ (DST, SRC)

/* Return DST & SRC == 0.  */
#define bitset_disjoint_p(DST, SRC) BITSET_DISJOINT_P_ (DST, SRC)

/* Return DST == SRC.  */
#define bitset_equal_p(DST, SRC) BITSET_EQUAL_P_ (DST, SRC)

/* DST = ~SRC.  */
#define bitset_not(DST, SRC) BITSET_NOT_ (DST, SRC)

/* Return DST == DST | SRC.  */
#define bitset_subset_p(DST, SRC) BITSET_SUBSET_P_ (DST, SRC)


/* DST = SRC1 & SRC2.  */
#define bitset_and(DST, SRC1, SRC2) BITSET_AND_ (DST, SRC1, SRC2)

/* DST = SRC1 & SRC2.  Return non-zero if DST != SRC1 & SRC2.  */
#define bitset_and_cmp(DST, SRC1, SRC2) BITSET_AND_CMP_ (DST, SRC1, SRC2)

/* DST = SRC1 & ~SRC2.  */
#define bitset_andn(DST, SRC1, SRC2) BITSET_ANDN_ (DST, SRC1, SRC2)

/* DST = SRC1 & ~SRC2.  Return non-zero if DST != SRC1 & ~SRC2.  */
#define bitset_andn_cmp(DST, SRC1, SRC2) BITSET_ANDN_CMP_ (DST, SRC1, SRC2)

/* DST = SRC1 | SRC2.  */
#define bitset_or(DST, SRC1, SRC2) BITSET_OR_ (DST, SRC1, SRC2)

/* DST = SRC1 | SRC2.  Return non-zero if DST != SRC1 | SRC2.  */
#define bitset_or_cmp(DST, SRC1, SRC2) BITSET_OR_CMP_ (DST, SRC1, SRC2)

/* DST = SRC1 ^ SRC2.  */
#define bitset_xor(DST, SRC1, SRC2) BITSET_XOR_ (DST, SRC1, SRC2)

/* DST = SRC1 ^ SRC2.  Return non-zero if DST != SRC1 ^ SRC2.  */
#define bitset_xor_cmp(DST, SRC1, SRC2) BITSET_XOR_CMP_ (DST, SRC1, SRC2)


/* DST = (SRC1 & SRC2) | SRC3.  */
#define bitset_and_or(DST, SRC1, SRC2, SRC3) \
 BITSET_AND_OR_ (DST, SRC1, SRC2, SRC3)

/* DST = (SRC1 & SRC2) | SRC3.  Return non-zero if
   DST != (SRC1 & SRC2) | SRC3.  */
#define bitset_and_or_cmp(DST, SRC1, SRC2, SRC3) \
 BITSET_AND_OR_CMP_ (DST, SRC1, SRC2, SRC3)

/* DST = (SRC1 & ~SRC2) | SRC3.  */
#define bitset_andn_or(DST, SRC1, SRC2, SRC3) \
 BITSET_ANDN_OR_ (DST, SRC1, SRC2, SRC3)

/* DST = (SRC1 & ~SRC2) | SRC3.  Return non-zero if
   DST != (SRC1 & ~SRC2) | SRC3.  */
#define bitset_andn_or_cmp(DST, SRC1, SRC2, SRC3) \
 BITSET_ANDN_OR_CMP_ (DST, SRC1, SRC2, SRC3)

/* DST = (SRC1 | SRC2) & SRC3.  */
#define bitset_or_and(DST, SRC1, SRC2, SRC3)\
 BITSET_OR_AND_ (DST, SRC1, SRC2, SRC3)

/* DST = (SRC1 | SRC2) & SRC3.  Return non-zero if
   DST != (SRC1 | SRC2) & SRC3.  */
#define bitset_or_and_cmp(DST, SRC1, SRC2, SRC3)\
 BITSET_OR_AND_CMP_ (DST, SRC1, SRC2, SRC3)

/* Find list of up to NUM bits set in BSET starting from and including
   *NEXT.  Return with actual number of bits found and with *NEXT
   indicating where search stopped.  */
#define bitset_list(BSET, LIST, NUM, NEXT) \
 BITSET_LIST_ (BSET, LIST, NUM, NEXT)

/* Find reverse list of up to NUM bits set in BSET starting from and
   including NEXT.  Return with actual number of bits found and with
   *NEXT indicating where search stopped.  */
#define bitset_list_reverse(BSET, LIST, NUM, NEXT) \
 BITSET_LIST_REVERSE_ (BSET, LIST, NUM, NEXT)


/* Find next set bit.  */
extern bitset_bindex bitset_next PARAMS ((bitset, bitset_bindex));

/* Find previous set bit.  */
extern bitset_bindex bitset_prev PARAMS ((bitset, bitset_bindex));

/* Find first set bit.  */
extern bitset_bindex bitset_first PARAMS ((bitset));

/* Find last set bit.  */
extern bitset_bindex bitset_last PARAMS ((bitset));

/* Return nonzero if this is the only set bit.  */
extern bool bitset_only_set_p PARAMS ((bitset, bitset_bindex));

/* Dump bitset.  */
extern void bitset_dump PARAMS ((FILE *, bitset));

/* Loop over all elements of BSET, starting with MIN, setting BIT
   to the index of each set bit.  For example, the following will print
   the bits set in a bitset:

   bitset_bindex i;
   bitset_iterator iter;

   BITSET_FOR_EACH (iter, src, i, 0)
   {
      printf ("%ld ", i);
   };
*/
#define BITSET_FOR_EACH(ITER, BSET, BIT, MIN)				      \
  for (ITER.next = (MIN), ITER.num = BITSET_LIST_SIZE;			      \
       (ITER.num == BITSET_LIST_SIZE) 					      \
       && (ITER.num = bitset_list (BSET, ITER.list, 			      \
				   BITSET_LIST_SIZE, &ITER.next));)	      \
    for (ITER.i = 0;							      \
	 ITER.i < ITER.num && ((BIT) = ITER.list[ITER.i], 1);		      \
	 ITER.i++)


/* Loop over all elements of BSET, in reverse order starting with
   MIN,  setting BIT to the index of each set bit. For example, the
   following will print the bits set in a bitset in reverse order:

   bitset_bindex i;
   bitset_iterator iter;

   BITSET_FOR_EACH_REVERSE (iter, src, i, 0)
   {
      printf ("%ld ", i);
   };
*/
#define BITSET_FOR_EACH_REVERSE(ITER, BSET, BIT, MIN)			      \
  for (ITER.next = (MIN), ITER.num = BITSET_LIST_SIZE;			      \
       (ITER.num == BITSET_LIST_SIZE) 					      \
       && (ITER.num = bitset_list_reverse (BSET, ITER.list,		      \
					  BITSET_LIST_SIZE, &ITER.next));)    \
    for (ITER.i = 0;							      \
	 ITER.i < ITER.num && ((BIT) = ITER.list[ITER.i], 1);		      \
	 ITER.i++)


/* Define set operations in terms of logical operations.  */

#define bitset_diff(DST, SRC1, SRC2) bitset_andn (DST, SRC1, SRC2)
#define bitset_diff_cmp(DST, SRC1, SRC2) bitset_andn_cmp (DST, SRC1, SRC2)

#define bitset_intersection(DST, SRC1, SRC2) bitset_and (DST, SRC1, SRC2)
#define bitset_intersection_cmp(DST, SRC1, SRC2) bitset_and_cmp (DST, SRC1, SRC2)

#define bitset_union(DST, SRC1, SRC2) bitset_or (DST, SRC1, SRC2)
#define bitset_union_cmp(DST, SRC1, SRC2) bitset_or_cmp (DST, SRC1, SRC2)

/* Symmetrical difference.  */
#define bitset_symdiff(DST, SRC1, SRC2) bitset_xor (DST, SRC1, SRC2)
#define bitset_symdiff_cmp(DST, SRC1, SRC2) bitset_xor_cmp (DST, SRC1, SRC2)

/* Union of difference.  */
#define bitset_diff_union(DST, SRC1, SRC2, SRC3) \
  bitset_andn_or (DST, SRC1, SRC2, SRC3)
#define bitset_diff_union_cmp(DST, SRC1, SRC2, SRC3) \
  bitset_andn_or_cmp (DST, SRC1, SRC2, SRC3)


/* Release any memory tied up with bitsets.  */
extern void bitset_release_memory PARAMS ((void));

/* Enable bitset stats gathering.  */
extern void bitset_stats_enable PARAMS ((void));

/* Disable bitset stats gathering.  */
extern void bitset_stats_disable PARAMS ((void));

/* Read bitset stats file of accummulated stats.  */
void bitset_stats_read PARAMS ((const char *filename));

/* Write bitset stats file of accummulated stats.  */
void bitset_stats_write PARAMS ((const char *filename));

/* Dump bitset stats.  */
extern void bitset_stats_dump PARAMS ((FILE *));

/* Function to debug bitset from debugger.  */
extern void debug_bitset PARAMS ((bitset));

/* Function to debug bitset stats from debugger.  */
extern void debug_bitset_stats PARAMS ((void));

#endif /* _BITSET_H  */
Commit	Line	Data
7086e707	1	/* Generic bitsets.
2175bfbd	2	Copyright (C) 2002, 2003 Free Software Foundation, Inc.
7086e707 AD	3	Contributed by Michael Hayes (m.hayes@elec.canterbury.ac.nz).
	4
	5	This program is free software; you can redistribute it and/or modify
	6	it under the terms of the GNU General Public License as published by
	7	the Free Software Foundation; either version 2 of the License, or
	8	(at your option) any later version.
	9
	10	This program is distributed in the hope that it will be useful,
	11	but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	13	GNU General Public License for more details.
	14
	15	You should have received a copy of the GNU General Public License
	16	along with this program; if not, write to the Free Software
	17	Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
	18
	19	#ifndef _BITSET_H
04af9e52	20	#define _BITSET_H
7086e707	21
ef017502 AD	22	/* This file is the public interface to the bitset abstract data type.
ef017502 AD	23	Only use the functions and macros defined in this file. */
7086e707	24
ef017502	25	#include "bbitset.h"
cfbb7304 PE	26
	27	/* obstack.h tries to be portable to K&R compilers, but its
	28	__INT_TO_PTR macro generates diagnostics on compilers like Tru64 cc
	29	that define __STDC__ to 0 when not in strict ANSI mode. The bitset
	30	code assumes C89 or later, so it can avoid these glitches by
	31	defining __INT_TO_PTR appropriately for C89 or later. */
	32	#ifndef __INT_TO_PTR
	33	# define __INT_TO_PTR(P) ((void ) ((P) + (char ) 0))
	34	#endif
7086e707	35	#include "obstack.h"
cfbb7304	36
7086e707	37	#include <stdio.h>
7086e707	38
ef017502	39	/* Attributes used to select a bitset implementation. */
7086e707 AD	40	enum bitset_attr {BITSET_FIXED = 1, /* Bitset size fixed. */
	41	BITSET_VARIABLE = 2, /* Bitset size variable. */
	42	BITSET_DENSE = 4, /* Bitset dense. */
	43	BITSET_SPARSE = 8, /* Bitset sparse. */
	44	BITSET_FRUGAL = 16, /* Prefer most compact. */
6aa452a6	45	BITSET_GREEDY = 32}; /* Prefer fastest at memory expense. */
7086e707 AD	46
	47	typedef unsigned int bitset_attrs;
	48
47c8386f PE	49	/* The contents of the union should be considered to be private.
	50	While I would like to make this union opaque, it needs to be
	51	visible for the inline bit set/test functions, and for delegation
	52	to the proper implementation. */
	53	union bitset_union
7086e707	54	{
47c8386f PE	55	/* This must be the first member of every other structure that is a
47c8386f PE	56	member of this union. */
ef017502	57	struct bbitset_struct b;
47c8386f PE	58
	59	struct abitset_struct
	60	{
	61	struct bbitset_struct b;
	62	bitset_bindex n_bits; /* Number of bits. */
	63	bitset_word words[1]; /* The array of bits. */
	64	} a;
	65
	66	struct ebitset_struct
	67	{
	68	struct bbitset_struct b;
	69	bitset_windex size; /* Number of elements. */
	70	struct ebitset_elt_struct *elts; / Expanding array of ptrs to elts. */
	71	} e;
	72
	73	struct lbitset_struct
	74	{
	75	struct bbitset_struct b;
	76	struct lbitset_elt_struct head; / First element in linked list. */
	77	struct lbitset_elt_struct tail; / Last element in linked list. */
	78	} l;
	79
	80	struct bitset_stats_struct
	81	{
	82	struct bbitset_struct b;
	83	bitset bset;
	84	} s;
7086e707 AD	85	};
7086e707 AD	86
613f5e1a AD	87
	88	/* The contents of this structure should be considered private.
	89	It is used for iterating over set bits. */
	90	typedef struct
	91	{
	92	bitset_bindex list[BITSET_LIST_SIZE];
	93	bitset_bindex next;
808a5918 PE	94	bitset_bindex num;
808a5918 PE	95	bitset_bindex i;
613f5e1a AD	96	} bitset_iterator;
	97
	98
7086e707	99	/* Return bytes required for bitset of desired type and size. */
04af9e52	100	extern size_t bitset_bytes PARAMS ((enum bitset_type, bitset_bindex));
7086e707 AD	101
7086e707 AD	102	/* Initialise a bitset with desired type and size. */
04af9e52	103	extern bitset bitset_init PARAMS ((bitset, bitset_bindex, enum bitset_type));
7086e707	104
ef017502 AD	105	/* Select an implementation type based on the desired bitset size
ef017502 AD	106	and attributes. */
7086e707 AD	107	extern enum bitset_type bitset_type_choose PARAMS ((bitset_bindex,
	108	bitset_attrs));
	109
ef017502	110	/* Create a bitset of desired type and size. The bitset is zeroed. */
04af9e52	111	extern bitset bitset_alloc PARAMS ((bitset_bindex, enum bitset_type));
7086e707 AD	112
	113	/* Free bitset. */
	114	extern void bitset_free PARAMS ((bitset));
	115
ef017502 AD	116	/* Create a bitset of desired type and size using an obstack. The
ef017502 AD	117	bitset is zeroed. */
7086e707	118	extern bitset bitset_obstack_alloc PARAMS ((struct obstack *bobstack,
04af9e52	119	bitset_bindex, enum bitset_type));
7086e707 AD	120
	121	/* Free bitset allocated on obstack. */
	122	extern void bitset_obstack_free PARAMS ((bitset));
	123
ef017502	124	/* Create a bitset of desired size and attributes. The bitset is zeroed. */
7086e707 AD	125	extern bitset bitset_create PARAMS ((bitset_bindex, bitset_attrs));
7086e707 AD	126
613f5e1a AD	127	/* Return bitset type. */
	128	extern enum bitset_type bitset_type_get PARAMS ((bitset));
	129
6aa452a6 AD	130	/* Return bitset type name. */
	131	extern const char *bitset_type_name_get PARAMS ((bitset));
	132
7086e707 AD	133
7086e707 AD	134	/* Set bit BITNO in bitset BSET. */
04af9e52 PE	135	static inline void
04af9e52 PE	136	bitset_set (bitset bset, bitset_bindex bitno)
7086e707	137	{
dbba6a3b PE	138	bitset_windex windex = bitno / BITSET_WORD_BITS;
dbba6a3b PE	139	bitset_windex offset = windex - bset->b.cindex;
04af9e52	140
ef017502	141	if (offset < bset->b.csize)
e601ff27	142	bset->b.cdata[offset] \|= ((bitset_word) 1 << (bitno % BITSET_WORD_BITS));
7086e707	143	else
ef017502	144	BITSET_SET_ (bset, bitno);
7086e707 AD	145	}
	146
	147
	148	/* Reset bit BITNO in bitset BSET. */
04af9e52 PE	149	static inline void
04af9e52 PE	150	bitset_reset (bitset bset, bitset_bindex bitno)
7086e707	151	{
dbba6a3b PE	152	bitset_windex windex = bitno / BITSET_WORD_BITS;
dbba6a3b PE	153	bitset_windex offset = windex - bset->b.cindex;
04af9e52	154
ef017502	155	if (offset < bset->b.csize)
e601ff27	156	bset->b.cdata[offset] &= ~((bitset_word) 1 << (bitno % BITSET_WORD_BITS));
7086e707	157	else
ef017502	158	BITSET_RESET_ (bset, bitno);
7086e707 AD	159	}
	160
	161
	162	/* Test bit BITNO in bitset BSET. */
d0829076	163	static inline bool
04af9e52	164	bitset_test (bitset bset, bitset_bindex bitno)
7086e707	165	{
dbba6a3b PE	166	bitset_windex windex = bitno / BITSET_WORD_BITS;
dbba6a3b PE	167	bitset_windex offset = windex - bset->b.cindex;
04af9e52	168
ef017502 AD	169	if (offset < bset->b.csize)
ef017502 AD	170	return (bset->b.cdata[offset] >> (bitno % BITSET_WORD_BITS)) & 1;
7086e707	171	else
ef017502	172	return BITSET_TEST_ (bset, bitno);
7086e707	173	}
7086e707	174
7086e707	175
345cea78	176	/* Toggle bit BITNO in bitset BSET and return non-zero if now set. */
6aa452a6	177	#define bitset_toggle(bset, bitno) BITSET_TOGGLE_ (bset, bitno)
345cea78	178
6aa452a6 AD	179	/* Return size in bits of bitset SRC. */
	180	#define bitset_size(SRC) BITSET_SIZE_ (SRC)
	181
	182	/* Return number of bits set in bitset SRC. */
	183	#define bitset_count(SRC) BITSET_COUNT_ (SRC)
	184
	185
	186	/* Return SRC == 0. */
	187	#define bitset_empty_p(SRC) BITSET_EMPTY_P_ (SRC)
7086e707 AD	188
7086e707 AD	189	/* DST = ~0. */
6aa452a6	190	#define bitset_ones(DST) BITSET_ONES_ (DST)
7086e707	191
6aa452a6 AD	192	/* DST = 0. */
6aa452a6 AD	193	#define bitset_zero(DST) BITSET_ZERO_ (DST)
7086e707	194
7086e707	195
6aa452a6 AD	196
	197	/* DST = SRC. */
	198	#define bitset_copy(DST, SRC) BITSET_COPY_ (DST, SRC)
7086e707	199
ef017502	200	/* Return DST & SRC == 0. */
6aa452a6	201	#define bitset_disjoint_p(DST, SRC) BITSET_DISJOINT_P_ (DST, SRC)
ef017502	202
6aa452a6 AD	203	/* Return DST == SRC. */
6aa452a6 AD	204	#define bitset_equal_p(DST, SRC) BITSET_EQUAL_P_ (DST, SRC)
7086e707 AD	205
7086e707 AD	206	/* DST = ~SRC. */
6aa452a6 AD	207	#define bitset_not(DST, SRC) BITSET_NOT_ (DST, SRC)
	208
	209	/* Return DST == DST \| SRC. */
	210	#define bitset_subset_p(DST, SRC) BITSET_SUBSET_P_ (DST, SRC)
7086e707	211
6aa452a6 AD	212
	213
	214	/* DST = SRC1 & SRC2. */
	215	#define bitset_and(DST, SRC1, SRC2) BITSET_AND_ (DST, SRC1, SRC2)
7086e707 AD	216
7086e707 AD	217	/* DST = SRC1 & SRC2. Return non-zero if DST != SRC1 & SRC2. */
6aa452a6	218	#define bitset_and_cmp(DST, SRC1, SRC2) BITSET_AND_CMP_ (DST, SRC1, SRC2)
7086e707	219
6aa452a6 AD	220	/* DST = SRC1 & ~SRC2. */
6aa452a6 AD	221	#define bitset_andn(DST, SRC1, SRC2) BITSET_ANDN_ (DST, SRC1, SRC2)
7086e707 AD	222
7086e707 AD	223	/* DST = SRC1 & ~SRC2. Return non-zero if DST != SRC1 & ~SRC2. */
6aa452a6	224	#define bitset_andn_cmp(DST, SRC1, SRC2) BITSET_ANDN_CMP_ (DST, SRC1, SRC2)
7086e707	225
6aa452a6 AD	226	/* DST = SRC1 \| SRC2. */
	227	#define bitset_or(DST, SRC1, SRC2) BITSET_OR_ (DST, SRC1, SRC2)
	228
	229	/* DST = SRC1 \| SRC2. Return non-zero if DST != SRC1 \| SRC2. */
	230	#define bitset_or_cmp(DST, SRC1, SRC2) BITSET_OR_CMP_ (DST, SRC1, SRC2)
	231
	232	/* DST = SRC1 ^ SRC2. */
	233	#define bitset_xor(DST, SRC1, SRC2) BITSET_XOR_ (DST, SRC1, SRC2)
	234
	235	/* DST = SRC1 ^ SRC2. Return non-zero if DST != SRC1 ^ SRC2. */
	236	#define bitset_xor_cmp(DST, SRC1, SRC2) BITSET_XOR_CMP_ (DST, SRC1, SRC2)
	237
	238
	239
	240	/* DST = (SRC1 & SRC2) \| SRC3. */
	241	#define bitset_and_or(DST, SRC1, SRC2, SRC3) \
	242	BITSET_AND_OR_ (DST, SRC1, SRC2, SRC3)
7086e707 AD	243
	244	/* DST = (SRC1 & SRC2) \| SRC3. Return non-zero if
	245	DST != (SRC1 & SRC2) \| SRC3. */
6aa452a6 AD	246	#define bitset_and_or_cmp(DST, SRC1, SRC2, SRC3) \
	247	BITSET_AND_OR_CMP_ (DST, SRC1, SRC2, SRC3)
	248
	249	/* DST = (SRC1 & ~SRC2) \| SRC3. */
	250	#define bitset_andn_or(DST, SRC1, SRC2, SRC3) \
	251	BITSET_ANDN_OR_ (DST, SRC1, SRC2, SRC3)
7086e707 AD	252
	253	/* DST = (SRC1 & ~SRC2) \| SRC3. Return non-zero if
	254	DST != (SRC1 & ~SRC2) \| SRC3. */
6aa452a6 AD	255	#define bitset_andn_or_cmp(DST, SRC1, SRC2, SRC3) \
6aa452a6 AD	256	BITSET_ANDN_OR_CMP_ (DST, SRC1, SRC2, SRC3)
7086e707	257
6aa452a6 AD	258	/* DST = (SRC1 \| SRC2) & SRC3. */
	259	#define bitset_or_and(DST, SRC1, SRC2, SRC3)\
	260	BITSET_OR_AND_ (DST, SRC1, SRC2, SRC3)
7086e707	261
6aa452a6 AD	262	/* DST = (SRC1 \| SRC2) & SRC3. Return non-zero if
	263	DST != (SRC1 \| SRC2) & SRC3. */
	264	#define bitset_or_and_cmp(DST, SRC1, SRC2, SRC3)\
	265	BITSET_OR_AND_CMP_ (DST, SRC1, SRC2, SRC3)
345cea78	266
04af9e52	267	/* Find list of up to NUM bits set in BSET starting from and including
7086e707 AD	268	NEXT. Return with actual number of bits found and with NEXT
7086e707 AD	269	indicating where search stopped. */
7086e707	270	#define bitset_list(BSET, LIST, NUM, NEXT) \
04af9e52	271	BITSET_LIST_ (BSET, LIST, NUM, NEXT)
7086e707 AD	272
	273	/* Find reverse list of up to NUM bits set in BSET starting from and
	274	including NEXT. Return with actual number of bits found and with
	275	NEXT indicating where search stopped. /
6aa452a6	276	#define bitset_list_reverse(BSET, LIST, NUM, NEXT) \
04af9e52	277	BITSET_LIST_REVERSE_ (BSET, LIST, NUM, NEXT)
6aa452a6	278
7086e707	279
47c8386f PE	280	/* Find next set bit. */
	281	extern bitset_bindex bitset_next PARAMS ((bitset, bitset_bindex));
	282
	283	/* Find previous set bit. */
	284	extern bitset_bindex bitset_prev PARAMS ((bitset, bitset_bindex));
	285
7086e707	286	/* Find first set bit. */
808a5918	287	extern bitset_bindex bitset_first PARAMS ((bitset));
7086e707 AD	288
7086e707 AD	289	/* Find last set bit. */
808a5918	290	extern bitset_bindex bitset_last PARAMS ((bitset));
7086e707	291
47c8386f	292	/* Return nonzero if this is the only set bit. */
d0829076	293	extern bool bitset_only_set_p PARAMS ((bitset, bitset_bindex));
47c8386f	294
7086e707 AD	295	/* Dump bitset. */
	296	extern void bitset_dump PARAMS ((FILE *, bitset));
	297
613f5e1a	298	/* Loop over all elements of BSET, starting with MIN, setting BIT
6aa452a6 AD	299	to the index of each set bit. For example, the following will print
	300	the bits set in a bitset:
	301
	302	bitset_bindex i;
	303	bitset_iterator iter;
	304
6aa452a6 AD	305	BITSET_FOR_EACH (iter, src, i, 0)
	306	{
	307	printf ("%ld ", i);
	308	};
	309	*/
613f5e1a AD	310	#define BITSET_FOR_EACH(ITER, BSET, BIT, MIN) \
	311	for (ITER.next = (MIN), ITER.num = BITSET_LIST_SIZE; \
	312	(ITER.num == BITSET_LIST_SIZE) \
	313	&& (ITER.num = bitset_list (BSET, ITER.list, \
04af9e52	314	BITSET_LIST_SIZE, &ITER.next));) \
2175bfbd PE	315	for (ITER.i = 0; \
	316	ITER.i < ITER.num && ((BIT) = ITER.list[ITER.i], 1); \
	317	ITER.i++)
7086e707 AD	318
	319
	320	/* Loop over all elements of BSET, in reverse order starting with
04af9e52	321	MIN, setting BIT to the index of each set bit. For example, the
6aa452a6 AD	322	following will print the bits set in a bitset in reverse order:
	323
	324	bitset_bindex i;
	325	bitset_iterator iter;
	326
6aa452a6 AD	327	BITSET_FOR_EACH_REVERSE (iter, src, i, 0)
	328	{
	329	printf ("%ld ", i);
	330	};
	331	*/
613f5e1a AD	332	#define BITSET_FOR_EACH_REVERSE(ITER, BSET, BIT, MIN) \
	333	for (ITER.next = (MIN), ITER.num = BITSET_LIST_SIZE; \
	334	(ITER.num == BITSET_LIST_SIZE) \
	335	&& (ITER.num = bitset_list_reverse (BSET, ITER.list, \
04af9e52	336	BITSET_LIST_SIZE, &ITER.next));) \
2175bfbd PE	337	for (ITER.i = 0; \
	338	ITER.i < ITER.num && ((BIT) = ITER.list[ITER.i], 1); \
	339	ITER.i++)
7086e707 AD	340
7086e707 AD	341
ef017502	342	/* Define set operations in terms of logical operations. */
7086e707	343
04af9e52 PE	344	#define bitset_diff(DST, SRC1, SRC2) bitset_andn (DST, SRC1, SRC2)
04af9e52 PE	345	#define bitset_diff_cmp(DST, SRC1, SRC2) bitset_andn_cmp (DST, SRC1, SRC2)
7086e707	346
04af9e52 PE	347	#define bitset_intersection(DST, SRC1, SRC2) bitset_and (DST, SRC1, SRC2)
04af9e52 PE	348	#define bitset_intersection_cmp(DST, SRC1, SRC2) bitset_and_cmp (DST, SRC1, SRC2)
7086e707	349
04af9e52 PE	350	#define bitset_union(DST, SRC1, SRC2) bitset_or (DST, SRC1, SRC2)
04af9e52 PE	351	#define bitset_union_cmp(DST, SRC1, SRC2) bitset_or_cmp (DST, SRC1, SRC2)
7086e707	352
6aa452a6	353	/* Symmetrical difference. */
04af9e52 PE	354	#define bitset_symdiff(DST, SRC1, SRC2) bitset_xor (DST, SRC1, SRC2)
04af9e52 PE	355	#define bitset_symdiff_cmp(DST, SRC1, SRC2) bitset_xor_cmp (DST, SRC1, SRC2)
6aa452a6 AD	356
6aa452a6 AD	357	/* Union of difference. */
7086e707	358	#define bitset_diff_union(DST, SRC1, SRC2, SRC3) \
04af9e52	359	bitset_andn_or (DST, SRC1, SRC2, SRC3)
6aa452a6	360	#define bitset_diff_union_cmp(DST, SRC1, SRC2, SRC3) \
04af9e52	361	bitset_andn_or_cmp (DST, SRC1, SRC2, SRC3)
6aa452a6	362
ef017502	363
7086e707 AD	364
	365	/* Release any memory tied up with bitsets. */
	366	extern void bitset_release_memory PARAMS ((void));
	367
613f5e1a AD	368	/* Enable bitset stats gathering. */
	369	extern void bitset_stats_enable PARAMS ((void));
	370
	371	/* Disable bitset stats gathering. */
	372	extern void bitset_stats_disable PARAMS ((void));
	373
	374	/* Read bitset stats file of accummulated stats. */
	375	void bitset_stats_read PARAMS ((const char *filename));
	376
	377	/* Write bitset stats file of accummulated stats. */
	378	void bitset_stats_write PARAMS ((const char *filename));
7086e707 AD	379
	380	/* Dump bitset stats. */
	381	extern void bitset_stats_dump PARAMS ((FILE *));
	382
	383	/* Function to debug bitset from debugger. */
	384	extern void debug_bitset PARAMS ((bitset));
	385
	386	/* Function to debug bitset stats from debugger. */
	387	extern void debug_bitset_stats PARAMS ((void));
	388
7086e707	389	#endif /* _BITSET_H */
613f5e1a	390