Minor white space issues, e.g. trailing white space at end of line.

[bison.git] / lib / bbitset.h

diff --git a/lib/bbitset.h b/lib/bbitset.h
index 19a6497fb015c0f46e2d63bb2fe8c70acc15372a..04bc487d5d5abe5b66b99b168f6ccd6795dfa4e1 100644 (file)
--- a/lib/bbitset.h
+++ b/lib/bbitset.h
@@ -1,5 +1,5 @@
 /* Base bitset stuff.
 /* Base bitset stuff.

-   Copyright (C) 2002 Free Software Foundation, Inc.
+   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
    Contributed by Michael Hayes (m.hayes@elec.canterbury.ac.nz).
 
 This program is free software; you can redistribute it and/or modify


@@ -19,41 +19,35 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
 #ifndef _BBITSET_H
 #define _BBITSET_H
 
 #ifndef _BBITSET_H
 #define _BBITSET_H
 

+#include "config.h"

 #include "libiberty.h"
 
 #include "libiberty.h"
 

-#ifdef HAVE_LIMITS_H
+#include <stdbool.h>

 #include <limits.h>
 #include <limits.h>

-#endif
+#include <sys/types.h>

 
 

-/* Use the following types for function parameters where the
-   corresponding enum would be the correct type if we could use
-   prototyped function definitions.  Standard C says that one cannot
-   portably use an enum as a parameter of an old-style function
-   definition that is also declared with a prototype.  */
-
-typedef int enum_bitset_ops;
-typedef int enum_bitset_type;
-
-/* 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_ARRAY:  Array of bits (fixed size, fast for dense bitsets).

-   BITSET_LIST:   Linked list of array of bits (variable size, least storage
-                  for large very sparse sets). 
-   BITSET_TABLE:  Expandable table of pointers to array of bits 
-                  (variable size, less storage for large sparse sets). 
-
-   BITSET_STATS:  Wrapper bitset for internal use only.
+                  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 arrays of bits
+                 (variable size, less storage for large sparse sets).
+                  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[];
 
 enum bitset_alloc_type {BITSET_MALLOC, BITSET_OBALLOC};
 
 
 extern const char * const bitset_type_names[];
 
 enum bitset_alloc_type {BITSET_MALLOC, BITSET_OBALLOC};
 

-/* Non-zero to use inline functions instead of macros.  */
-#define BITSET_INLINE 0
-

 /* Data type used to store a word of bits.  */
 typedef unsigned long bitset_word;
 #define BITSET_WORD_BITS ((unsigned) (CHAR_BIT * sizeof (bitset_word)))
 /* Data type used to store a word of bits.  */
 typedef unsigned long bitset_word;
 #define BITSET_WORD_BITS ((unsigned) (CHAR_BIT * sizeof (bitset_word)))


@@ -82,19 +76,20 @@ typedef size_t bitset_windex;
 
 #define BITSET_LIST_SIZE 1024
 
 
 #define BITSET_LIST_SIZE 1024
 

-enum bitset_ops {BITSET_OP_ZERO, BITSET_OP_ONES, 
-                BITSET_OP_COPY, BITSET_OP_NOT, 
+enum bitset_ops {BITSET_OP_ZERO, BITSET_OP_ONES,
+                BITSET_OP_COPY, BITSET_OP_NOT,

                 BITSET_OP_EMPTY_P, BITSET_OP_EQUAL_P,
                 BITSET_OP_SUBSET_P, BITSET_OP_DISJOINT_P,
                 BITSET_OP_EMPTY_P, BITSET_OP_EQUAL_P,
                 BITSET_OP_SUBSET_P, BITSET_OP_DISJOINT_P,

-                BITSET_OP_AND, BITSET_OP_OR, BITSET_OP_XOR, BITSET_OP_ANDN, 
+                BITSET_OP_AND, BITSET_OP_OR, BITSET_OP_XOR, BITSET_OP_ANDN,

                 BITSET_OP_OR_AND, BITSET_OP_AND_OR, BITSET_OP_ANDN_OR};
 
 struct bbitset_struct
 {
                 BITSET_OP_OR_AND, BITSET_OP_AND_OR, BITSET_OP_ANDN_OR};
 
 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_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.
   /* 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.


@@ -106,41 +101,50 @@ struct bbitset_struct
 typedef union bitset_union *bitset;
 
 
 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));
 /* 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));
 
   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));
   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));
   void (*not) PARAMS ((bitset, bitset));

-  int (*subset_p) PARAMS ((bitset, bitset));
+  bool (*subset_p) PARAMS ((bitset, bitset));

 
   void (*and) PARAMS ((bitset, 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));
   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));
   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));
   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));
 
   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));
   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));
   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 *));
 
   bitset_bindex (*list) PARAMS ((bitset, bitset_bindex *,
                                 bitset_bindex, bitset_bindex *));


@@ -151,7 +155,8 @@ struct bitset_vtable
   enum bitset_type type;
 };
 
   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 ();
 
 #define BITSET_CHECK2_(DST, SRC) \
 if (!BITSET_COMPATIBLE_ (DST, SRC)) abort ();


@@ -165,26 +170,29 @@ if (!BITSET_COMPATIBLE_ (DST, SRC1) || !BITSET_COMPATIBLE_ (DST, SRC2) \
     || !BITSET_COMPATIBLE_ (DST, SRC3)) abort ();
 
 
     || !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.  */
 /* Return size in bits of bitset SRC.  */

-#define BITSET_SIZE_(SRC) (SRC)->b.vtable->size (SRC) 
+#define BITSET_SIZE_(SRC) (SRC)->b.vtable->size (SRC)

 
 /* Return number of bits set in bitset SRC.  */
 
 /* Return number of bits set in bitset SRC.  */

-#define BITSET_COUNT_(SRC) (SRC)->b.vtable->count (SRC) 
+#define BITSET_COUNT_(SRC) (SRC)->b.vtable->count (SRC)

 
 /* Return type of bitset SRC.  */
 
 /* Return type of bitset SRC.  */

-#define BITSET_TYPE_(DST) (DST)->b.vtable->type 
+#define BITSET_TYPE_(DST) (DST)->b.vtable->type

 
 /* Set bit BITNO in bitset DST.  */
 
 /* Set bit BITNO in bitset DST.  */

-#define BITSET_SET_(DST, BITNO) (DST)->b.vtable->set (DST, BITNO) 
+#define BITSET_SET_(DST, BITNO) (DST)->b.vtable->set (DST, BITNO)

 
 /* Reset bit BITNO in bitset DST.  */
 
 /* Reset bit BITNO in bitset DST.  */

-#define BITSET_RESET_(DST, BITNO) (DST)->b.vtable->reset (DST, BITNO) 
+#define BITSET_RESET_(DST, BITNO) (DST)->b.vtable->reset (DST, BITNO)

 
 /* Toggle bit BITNO in bitset DST.  */
 
 /* Toggle bit BITNO in bitset DST.  */

-#define BITSET_TOGGLE_(DST, BITNO) (DST)->b.vtable->toggle (DST, BITNO) 
+#define BITSET_TOGGLE_(DST, BITNO) (DST)->b.vtable->toggle (DST, BITNO)

 
 /* Return non-zero if bit BITNO in bitset SRC is set.  */
 
 /* Return non-zero if bit BITNO in bitset SRC is set.  */

-#define BITSET_TEST_(SRC, BITNO) (SRC)->b.vtable->test (SRC, BITNO) 
+#define BITSET_TEST_(SRC, BITNO) (SRC)->b.vtable->test (SRC, BITNO)

 
 /* Free bitset SRC.  */
 #define BITSET_FREE_(SRC)\
 
 /* Free bitset SRC.  */
 #define BITSET_FREE_(SRC)\


@@ -258,37 +266,39 @@ if (!BITSET_COMPATIBLE_ (DST, SRC1) || !BITSET_COMPATIBLE_ (DST, SRC2) \
  (SRC1)->b.vtable->or_and_cmp (DST, SRC1, SRC2, SRC3)
 
 
  (SRC1)->b.vtable->or_and_cmp (DST, SRC1, SRC2, SRC3)
 
 

-/* Find list of up to NUM bits set in BSET starting from and including 
+/* 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) \
    *NEXT.  Return with actual number of bits found and with *NEXT
    indicating where search stopped.  */
 #define BITSET_LIST_(BSET, LIST, NUM, NEXT) \

- (BSET)->b.vtable->list (BSET, LIST, NUM, NEXT) 
+ (BSET)->b.vtable->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) \
 
 /* 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) \

- (BSET)->b.vtable->list_reverse (BSET, LIST, NUM, NEXT) 
+ (BSET)->b.vtable->list_reverse (BSET, LIST, NUM, NEXT)

 
 
 /* Private functions for bitset implementations.  */
 
 
 /* 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 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 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 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 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  */
 
 #endif /* _BBITSET_H  */