agar: Re-entrant Abstract Graph Algorithms
[ccan] / ccan / agar / agar.h
1 /* Licensed under LGPLv2+ - see LICENSE file for details */
2 #ifndef CCAN_AGAR_H
3 #define CCAN_AGAR_H
4 #include "config.h"
5 #include <string.h>
6 #include <stdbool.h>
7
8 #include <ccan/aga/aga.h>
9
10 struct agar_edge_info {
11         const void *to;
12 };
13
14 struct agar_graph;
15 struct agar_state;
16
17 typedef int (*agar_edge_info_fn)(const struct agar_graph *gr,
18                                  const void *nr,
19                                  const void *e,
20                                  struct agar_edge_info *ei);
21 typedef const void *(*agar_first_edge_fn)(const struct agar_graph *gr,
22                                           const void *nr);
23 typedef const void *(*agar_next_edge_fn)(const struct agar_graph *gr,
24                                          const void *nr,
25                                          const void *e);
26
27 struct agar_graph {
28         agar_edge_info_fn edge_info;
29         agar_first_edge_fn first_edge;
30         agar_next_edge_fn next_edge;
31 };
32
33 void agar_init_graph(struct agar_graph *gr,
34                      agar_first_edge_fn first_edge,
35                      agar_next_edge_fn next_edge,
36                      agar_edge_info_fn edge_info);
37 int agar_error(struct agar_state *sr);
38
39 const void *agar_first_edge(const struct agar_graph *g, const void *nr);
40 const void *agar_next_edge(const struct agar_graph *g, const void *nr,
41                            const void *e);
42 int agar_edge_info(const struct agar_graph *g, const void *nr, const void *e,
43                    struct agar_edge_info *eir);
44
45 #define agar_for_each_edge(_e, _gr, _nr)                                \
46         for ((_e) = agar_first_edge((_gr), (_nr)); (_e);                \
47              (_e) = aga_next_edge((_gr), (_nr), (_e)))
48
49 #define agar_for_each_edge_info(_e, _eir, _err, _gr, _nr)               \
50         for ((_e) = agar_first_edge((_gr), (_nr));                      \
51              (_e) && ((((_err) = agar_edge_info((_gr), (_nr), (_e), &(_eir)))) == 0); \
52              (_e) = agar_next_edge((_gr), (_nr), (_e)))                 \
53                 if ((_eir).to)
54
55 /*
56  * Depth first search
57  */
58 struct agar_state *agar_dfs_new(void *ctx, struct agar_graph *gr);
59 bool agar_dfs_explore(struct agar_state *sr, const void *nr,
60                       const void **nextr);
61 #define agar_dfs(_nr, _sr, _startr)                                     \
62         for ((_nr) = (_startr); agar_dfs_explore((_sr), (_nr), &(_nr)); )
63
64 /*
65  * Breadth first search
66  */
67 struct agar_state *agar_bfs_new(void *ctx, struct agar_graph *gr);
68 bool agar_bfs_explore(struct agar_state *sr, const void *nr,
69                       const void **nextr);
70 #define agar_bfs(_nr, _sr, _startr)                                     \
71         for ((_nr) = (_startr); agar_bfs_explore((_sr), (_nr), &(_nr)); )
72
73 #endif /* CCAN_AGAR_H */