Replaced set_irn_n(*, -1, *) and get_irn_n(*, -1) by new get_nodes_block()/set_nodes_...

[libfirm] / ir / ir / irnodeset.h

diff --git a/ir/ir/irnodeset.h b/ir/ir/irnodeset.h
index 71e48fb..d60bf5f 100644 (file)
--- a/ir/ir/irnodeset.h
+++ b/ir/ir/irnodeset.h
@@ -1,3 +1,22 @@
+/*
+ * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ *
+ * This file is part of libFirm.
+ *
+ * This file may be distributed and/or modified under the terms of the
+ * GNU General Public License version 2 as published by the Free Software
+ * Foundation and appearing in the file LICENSE.GPL included in the
+ * packaging of this file.
+ *
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
+ *
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
+ */
+
 /**
  * @file
  * @author    Matthias Braun
@@ -5,23 +24,44 @@
  * @brief     A nodeset. This should be prefered over a simple pset, because it
  *            tries to guarantee deterministic behavior. (and is faster)
  * @version   $Id$
+ * @note      Actually the bits to make the behaviour deterministic are not
+ *            implemented yet...
  */
 #ifndef _FIRM_IRNODESET_H_
 #define _FIRM_IRNODESET_H_
 
-#include "irnode.h"
+#include "firm_types.h"
 #include "xmalloc.h"
 
+/*
+ * sebastian experimental:
+ * use ordered arrays as node sets.
+ * the guys here have made good experiences with that.
+ * Internally we use normal Firm arrays and binary
+ * search for locating the elements. Using arrays should
+ * give the sets a small footprint.
+ */
+#undef  IR_NODESET_USE_ORDERED_SETS
+
 #define HashSet          ir_nodeset_t
 #define HashSetIterator  ir_nodeset_iterator_t
 #define ValueType        ir_node*
 #define DO_REHASH
+
+#ifdef IR_NODESET_USE_ORDERED_SETS
+#include "arrayset.h"
+#else
 #include "hashset.h"
+#endif
+
 #undef DO_REHASH
 #undef ValueType
 #undef HashSetIterator
 #undef HashSet
 
+typedef struct ir_nodeset_t          ir_nodeset_t;
+typedef struct ir_nodeset_iterator_t ir_nodeset_iterator_t;
+
 /**
  * Initializes a nodeset with default size.
  *
@@ -75,6 +115,7 @@ static INLINE void ir_nodeset_del(ir_nodeset_t *nodeset) {
  */
 int ir_nodeset_insert(ir_nodeset_t *nodeset, ir_node *node);
 
+
 /**
  * Removes a node from a nodeset. Does nothing if the nodeset doesn't contain
  * the node.
@@ -136,4 +177,46 @@ void ir_nodeset_remove_iterator(ir_nodeset_t *nodeset,
         irn = ir_nodeset_iterator_next(&iter);    \
                irn != NULL; irn = ir_nodeset_iterator_next(&iter))
 
+
+#ifdef IR_NODESET_USE_ORDERED_SETS
+
+/**
+ * Insert an element quickly into from the set.
+ * This method may destroy internal invariats of the set (think of sorted arrays).
+ * All calls to other routines but
+ * - iteration
+ * - get the number of elements in the set
+ * will not work until ir_nodeset_fixup() was called.
+ * @param nodeset The nodeset.
+ * @param node    The node to insert.
+ */
+void ir_nodeset_insert_quick(ir_nodeset_t *nodeset, ir_node *node);
+
+/**
+ * Remove an element quickly from the set.
+ * This method may destroy internal invariats of the set (think of sorted arrays).
+ * All calls to other routines but
+ * - iteration
+ * - get the number of elements in the set
+ * will not work until ir_nodeset_fixup() was called.
+ * @param nodeset The nodeset.
+ * @param node    The node to delete.
+ */
+void ir_nodeset_remove_quick(ir_nodeset_t *nodeset, const ir_node *node);
+
+/**
+ * Fixes up internal state of the set.
+ * Is needed when one of the _quick functions was called.
+ * @param nodeset The nodeset.
+ */
+void ir_nodeset_fixup(ir_nodeset_t *nodeset);
+
+#else
+
+#define ir_nodeset_remove_quick ir_nodeset_remove
+#define ir_nodeset_insert_quick ir_nodeset_insert
+#define ir_nodeset_fixup(set)
+
+#endif /* IR_NODESET_USE_ORDERED_SETS */
+
 #endif