smatch.h: introduce sm_pedantic()
[smatch.git] / avl.h
blob219600102b7828c82a317e33bf7ed66c03a31895
1 /*
2 * Copyright (C) 2010 Joseph Adams <joeyadams3.14159@gmail.com>
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20 * THE SOFTWARE.
23 #ifndef CCAN_AVL_H
24 #define CCAN_AVL_H
26 #include <stdbool.h>
27 #include <stddef.h>
29 struct sm_state;
31 typedef struct AvlNode AvlNode;
32 typedef struct AvlIter AvlIter;
34 struct stree {
35 AvlNode *root;
36 struct stree *base_stree;
37 char *has_states;
38 size_t count;
39 int stree_id;
40 int references;
43 void free_stree(struct stree **avl);
44 /* Free an stree tree. */
46 struct sm_state *avl_lookup(const struct stree *avl, const struct sm_state *sm);
47 /* O(log n). Lookup a sm. Return NULL if the sm is not present. */
49 #define avl_member(avl, sm) (!!avl_lookup_node(avl, sm))
50 /* O(log n). See if a sm is present. */
52 size_t stree_count(const struct stree *avl);
53 /* O(1). Return the number of elements in the tree. */
55 bool avl_insert(struct stree **avl, const struct sm_state *sm);
57 * O(log n). Insert an sm or replace it if already present.
59 * Return false if the insertion replaced an existing sm.
62 bool avl_remove(struct stree **avl, const struct sm_state *sm);
64 * O(log n). Remove an sm (if present).
66 * Return true if it was removed.
69 bool avl_check_invariants(struct stree *avl);
70 /* For testing purposes. This function will always return true :-) */
73 /************************* Traversal *************************/
75 #define avl_foreach(iter, avl) avl_traverse(iter, avl, FORWARD)
77 * O(n). Traverse an stree tree in order.
79 * Example:
81 * AvlIter i;
83 * avl_foreach(i, avl)
84 * printf("%s -> %s\n", i.sm->name, i.sm->state->name);
87 #define FOR_EACH_SM(avl, _sm) { \
88 AvlIter _i; \
89 avl_foreach(_i, avl) { \
90 _sm = _i.sm;
92 #define END_FOR_EACH_SM(_sm) }}
94 #define FOR_EACH_MY_SM(_owner, avl, _sm) { \
95 bool __has_state = has_states(avl, _owner); \
96 AvlIter _i; \
97 avl_foreach(_i, avl) { \
98 if (!__has_state) \
99 break; \
100 _sm = _i.sm; \
101 if (_sm->owner != _owner) \
102 continue; \
104 #define avl_foreach_reverse(iter, avl) avl_traverse(iter, avl, BACKWARD)
105 /* O(n). Traverse an stree tree in reverse order. */
107 typedef enum AvlDirection {FORWARD = 0, BACKWARD = 1} AvlDirection;
109 struct AvlIter {
110 struct sm_state *sm;
111 AvlNode *node;
113 /* private */
114 AvlNode *stack[100];
115 int stack_index;
116 AvlDirection direction;
119 void avl_iter_begin(AvlIter *iter, struct stree *avl, AvlDirection dir);
120 void avl_iter_next(AvlIter *iter);
121 #define avl_traverse(iter, avl, direction) \
122 for (avl_iter_begin(&(iter), avl, direction); \
123 (iter).node != NULL; \
124 avl_iter_next(&iter))
127 /***************** Internal data structures ******************/
129 struct AvlNode {
130 const struct sm_state *sm;
132 AvlNode *lr[2];
133 int balance; /* -1, 0, or 1 */
136 AvlNode *avl_lookup_node(const struct stree *avl, const struct sm_state *sm);
137 /* O(log n). Lookup an stree node by sm. Return NULL if not present. */
139 struct stree *clone_stree(struct stree *orig);
141 void set_stree_id(struct stree **stree, int id);
142 int get_stree_id(struct stree *stree);
144 #endif