Import of 2003-06-08 libbitset <http://mail.gnu.org/archive/html/bison-patches/2003...

[bison.git] / lib / bbitset.h

diff --git a/lib/bbitset.h b/lib/bbitset.h
index e1b69e074f18db27c5d7be5f6c53df8b07056044..04bc487d5d5abe5b66b99b168f6ccd6795dfa4e1 100644 (file)
--- a/lib/bbitset.h
+++ b/lib/bbitset.h
@@ -19,22 +19,30 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
 #ifndef _BBITSET_H
 #define _BBITSET_H
 
+#include "config.h"
 #include "libiberty.h"
 
+#include <stdbool.h>
 #include <limits.h>
+#include <sys/types.h>
 
-/* Currently we support three flavours of bitsets:
+/* Currently we support five flavours of bitsets:
    BITSET_ARRAY:  Array of bits (fixed size, fast for dense bitsets).
-   BITSET_LIST:   Linked list of array of bits (variable size, least storage
+                  Memory for bit array and bitset structure allocated
+                  contiguously.
+   BITSET_LIST:   Linked list of arrays of bits (variable size, least storage
                  for large very sparse sets).
-   BITSET_TABLE:  Expandable table of pointers to array of bits
+   BITSET_TABLE:  Expandable table of pointers to arrays of bits
                  (variable size, less storage for large sparse sets).
-
-   BITSET_STATS:  Wrapper bitset for internal use only.
+                  Faster than BITSET_LIST for random access.
+   BITSET_VARRAY: Variable array of bits (variable size, fast for 
+                  dense bitsets).
+   BITSET_STATS:  Wrapper bitset for internal use only.  Used for gathering
+                  statistics and/or better run-time checking.
 */
-enum bitset_type {BITSET_ARRAY, BITSET_LIST, BITSET_TABLE, BITSET_TYPE_NUM,
-                 BITSET_STATS};
-#define BITSET_TYPE_NAMES {"abitset", "lbitset", "ebitset"}
+enum bitset_type {BITSET_ARRAY, BITSET_LIST, BITSET_TABLE, BITSET_VARRAY,
+                 BITSET_TYPE_NUM, BITSET_STATS};
+#define BITSET_TYPE_NAMES {"abitset", "lbitset", "ebitset", "vbitset"}
 
 extern const char * const bitset_type_names[];
 
@@ -77,10 +85,11 @@ enum bitset_ops {BITSET_OP_ZERO, BITSET_OP_ONES,
 
 struct bbitset_struct
 {
-  const struct bitset_vtable * vtable;
+  const struct bitset_vtable *vtable;
   bitset_windex cindex;                /* Cache word index.  */
   bitset_windex csize;         /* Cache size in words.  */
   bitset_word *cdata;          /* Cache data pointer.  */
+  bitset_bindex n_bits;                /* Number of bits.  */
   /* Perhaps we could sacrifice another word to indicate
      that the bitset is known to be zero, that a bit has been set
      in the cache, and that a bit has been cleared in the cache.
@@ -92,41 +101,50 @@ struct bbitset_struct
 typedef union bitset_union *bitset;
 
 
+/* Private accessor macros to bitset structure.  */
+#define BITSET_VTABLE_(SRC) (SRC)->b.vtable
+#define BITSET_CINDEX_(SRC) (SRC)->b.cindex
+#define BITSET_CDATA_(SRC) (SRC)->b.cdata
+#define BITSET_CSIZE_(SRC) (SRC)->b.csize
+#define BITSET_NBITS_(SRC) (SRC)->b.n_bits
+
+
 /* The contents of this structure should be considered private.  */
 struct bitset_vtable
 {
   void (*set) PARAMS ((bitset, bitset_bindex));
   void (*reset) PARAMS ((bitset, bitset_bindex));
-  int (*toggle) PARAMS ((bitset, bitset_bindex));
-  int (*test) PARAMS ((bitset, bitset_bindex));
+  bool (*toggle) PARAMS ((bitset, bitset_bindex));
+  bool (*test) PARAMS ((bitset, bitset_bindex));
+  bitset_bindex (*resize) PARAMS ((bitset, bitset_bindex));
   bitset_bindex (*size) PARAMS ((bitset));
   bitset_bindex (*count) PARAMS ((bitset));
 
-  int (*empty_p) PARAMS ((bitset));
+  bool (*empty_p) PARAMS ((bitset));
   void (*ones) PARAMS ((bitset));
   void (*zero) PARAMS ((bitset));
 
   void (*copy) PARAMS ((bitset, bitset));
-  int (*disjoint_p) PARAMS ((bitset, bitset));
-  int (*equal_p) PARAMS ((bitset, bitset));
+  bool (*disjoint_p) PARAMS ((bitset, bitset));
+  bool (*equal_p) PARAMS ((bitset, bitset));
   void (*not) PARAMS ((bitset, bitset));
-  int (*subset_p) PARAMS ((bitset, bitset));
+  bool (*subset_p) PARAMS ((bitset, bitset));
 
   void (*and) PARAMS ((bitset, bitset, bitset));
-  int (*and_cmp) PARAMS ((bitset, bitset, bitset));
+  bool (*and_cmp) PARAMS ((bitset, bitset, bitset));
   void (*andn) PARAMS ((bitset, bitset, bitset));
-  int (*andn_cmp) PARAMS ((bitset, bitset, bitset));
+  bool (*andn_cmp) PARAMS ((bitset, bitset, bitset));
   void (*or) PARAMS ((bitset, bitset, bitset));
-  int (*or_cmp) PARAMS ((bitset, bitset, bitset));
+  bool (*or_cmp) PARAMS ((bitset, bitset, bitset));
   void (*xor) PARAMS ((bitset, bitset, bitset));
-  int (*xor_cmp) PARAMS ((bitset, bitset, bitset));
+  bool (*xor_cmp) PARAMS ((bitset, bitset, bitset));
 
   void (*and_or) PARAMS ((bitset, bitset, bitset, bitset));
-  int (*and_or_cmp) PARAMS ((bitset, bitset, bitset, bitset));
+  bool (*and_or_cmp) PARAMS ((bitset, bitset, bitset, bitset));
   void (*andn_or) PARAMS ((bitset, bitset, bitset, bitset));
-  int (*andn_or_cmp) PARAMS ((bitset, bitset, bitset, bitset));
+  bool (*andn_or_cmp) PARAMS ((bitset, bitset, bitset, bitset));
   void (*or_and) PARAMS ((bitset, bitset, bitset, bitset));
-  int (*or_and_cmp) PARAMS ((bitset, bitset, bitset, bitset));
+  bool (*or_and_cmp) PARAMS ((bitset, bitset, bitset, bitset));
 
   bitset_bindex (*list) PARAMS ((bitset, bitset_bindex *,
                                 bitset_bindex, bitset_bindex *));
@@ -137,7 +155,8 @@ struct bitset_vtable
   enum bitset_type type;
 };
 
-#define BITSET_COMPATIBLE_(BSET1, BSET2) ((BSET1)->b.vtable == (BSET2)->b.vtable)
+#define BITSET_COMPATIBLE_(BSET1, BSET2) \
+((BSET1)->b.vtable == (BSET2)->b.vtable)
 
 #define BITSET_CHECK2_(DST, SRC) \
 if (!BITSET_COMPATIBLE_ (DST, SRC)) abort ();
@@ -151,6 +170,9 @@ if (!BITSET_COMPATIBLE_ (DST, SRC1) || !BITSET_COMPATIBLE_ (DST, SRC2) \
     || !BITSET_COMPATIBLE_ (DST, SRC3)) abort ();
 
 
+/* Redefine number of bits in bitset DST.  */
+#define BITSET_RESIZE_(DST, SIZE) (DST)->b.vtable->resize (DST, SIZE)
+
 /* Return size in bits of bitset SRC.  */
 #define BITSET_SIZE_(SRC) (SRC)->b.vtable->size (SRC)
 
@@ -259,22 +281,24 @@ if (!BITSET_COMPATIBLE_ (DST, SRC1) || !BITSET_COMPATIBLE_ (DST, SRC2) \
 
 /* Private functions for bitset implementations.  */
 
-extern int bitset_toggle_ PARAMS ((bitset, bitset_bindex));
+extern bool bitset_toggle_ PARAMS ((bitset, bitset_bindex));
 
 extern bitset_bindex bitset_count_ PARAMS ((bitset));
 
-extern int bitset_copy_ PARAMS ((bitset, bitset));
+extern bitset_bindex bitset_size_ PARAMS ((bitset));
+
+extern bool bitset_copy_ PARAMS ((bitset, bitset));
 
 extern void bitset_and_or_ PARAMS ((bitset, bitset, bitset, bitset));
 
-extern int bitset_and_or_cmp_ PARAMS ((bitset, bitset, bitset, bitset));
+extern bool bitset_and_or_cmp_ PARAMS ((bitset, bitset, bitset, bitset));
 
 extern void bitset_andn_or_ PARAMS ((bitset, bitset, bitset, bitset));
 
-extern int bitset_andn_or_cmp_ PARAMS ((bitset, bitset, bitset, bitset));
+extern bool bitset_andn_or_cmp_ PARAMS ((bitset, bitset, bitset, bitset));
 
 extern void bitset_or_and_ PARAMS ((bitset, bitset, bitset, bitset));
 
-extern int bitset_or_and_cmp_ PARAMS ((bitset, bitset, bitset, bitset));
+extern bool bitset_or_and_cmp_ PARAMS ((bitset, bitset, bitset, bitset));
 
 #endif /* _BBITSET_H  */