Switch debian build system to dh

[onak.git] / stats.h

diff --git a/stats.h b/stats.h
index af9f79fcbf7d4975bb063098c2b2f7493e0713c4..08e2abea0152c22384d73e5072ec6f844c68b96b 100644 (file)
--- a/stats.h
+++ b/stats.h
@@ -1,9 +1,20 @@
 /*
  * stats.c - various routines to do stats on the key graph
  *
- * Jonathan McDowell <noodles@earth.li>
+ * Copyright 2000-2004,2007-2009 Jonathan McDowell <noodles@earth.li>
  *
- * Copyright 2002 Project Purple
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation; version 2 of the License.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program; if not, write to the Free Software Foundation, Inc., 51
+ * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  */
 
 /* MOSTSIGNED
@@ -19,26 +30,31 @@ key_getsigns - get the keys a key signs. */
 #ifndef __STATS_H__
 #define __STATS_H__
 
-#include <stdbool.h>
-// #include <stdint.h>
 #include <inttypes.h>
+#include <stdbool.h>
 
 #include "ll.h"
 
 /**
- *     struct stats_key - holds key details suitable for doing stats on.
- *     @keyid: The keyid.
- *     @colour: Used for marking during DFS/BFS.
- *     @parent: The key that lead us to this one for DFS/BFS.
- *     @sigs: A linked list of the signatures on this key.
- *     @gotsigs: A bool indicating if we've initialized the sigs element yet.
+ * @brief Holds key details suitable for doing stats on.
  */
 struct stats_key {
+       /** The keyid. */
        uint64_t keyid;
+       /** Used for marking during DFS/BFS. */
        int colour;
+       /** The key that lead us to this one for DFS/BFS. */
        uint64_t parent;
+       /** A linked list of the signatures on this key. */
        struct ll *sigs;
+       /** A linked list of the keys this key signs. */
+       struct ll *signs;
+       /** A bool indicating if we've initialized the sigs element yet. */
        bool gotsigs;
+       /** If we shouldn't consider the key in calculations. */
+       bool disabled;
+       /** If the key is revoked (and shouldn't be considered). */
+       bool revoked;
 };
 
 /**
@@ -61,6 +77,18 @@ void initcolour(bool parent);
  */
 unsigned long findpath(struct stats_key *have, struct stats_key *want);
 
+/**
+ *     dofindpath - Given 2 keys displays a path between them.
+ *     @have: The key we have.
+ *     @want: The key we want to get to.
+ *     @html: Should we output in html.
+ *     @count: How many paths we should look for at most.
+ *
+ *     This does a breadth first search on the key tree, starting with the
+ *     key we have. It returns as soon as a path is found or when we run out
+ *     of keys; whichever comes sooner.
+ */
+void dofindpath(uint64_t have, uint64_t want, bool html, int count);
 
 struct stats_key *furthestkey(struct stats_key *have);