Missing declarations

[oweals/gnunet.git] / src / include / gnunet_regex_lib.h

diff --git a/src/include/gnunet_regex_lib.h b/src/include/gnunet_regex_lib.h
index aec37c1734e6c32940e7911fd10d9e923a6788e2..599e92765e9b4ed91efd510f816ecfdaafa7969c 100644 (file)
--- a/src/include/gnunet_regex_lib.h
+++ b/src/include/gnunet_regex_lib.h
@@ -37,27 +37,42 @@ extern "C"
 #endif
 #endif
 
+
+/**
+ * Maximum regex string length for use with GNUNET_REGEX_ipv4toregex
+ */
+#define GNUNET_REGEX_IPV4_REGEXLEN 32 + 6
+
+
+/**
+ * Maximum regex string length for use with GNUNET_REGEX_ipv6toregex
+ */
+#define GNUNET_REGEX_IPV6_REGEXLEN 128 + 6
+
+
 /**
  * Automaton (NFA/DFA) representation.
  */
 struct GNUNET_REGEX_Automaton;
 
+
 /**
  * Edge representation.
  */
 struct GNUNET_REGEX_Edge
 {
   /**
-   * Label of the edge.
+   * Label of the edge.  FIXME: might want to not consume exactly multiples of 8 bits, need length?
    */
   const char *label;
 
   /**
    * Destionation of the edge.
    */
-  GNUNET_HashCode destination;
+  struct GNUNET_HashCode destination;
 };
 
+
 /**
  * Construct an NFA by parsing the regex string of length 'len'.
  *
@@ -69,6 +84,7 @@ struct GNUNET_REGEX_Edge
 struct GNUNET_REGEX_Automaton *
 GNUNET_REGEX_construct_nfa (const char *regex, const size_t len);
 
+
 /**
  * Construct DFA for the given 'regex' of length 'len'.
  *
@@ -80,6 +96,7 @@ GNUNET_REGEX_construct_nfa (const char *regex, const size_t len);
 struct GNUNET_REGEX_Automaton *
 GNUNET_REGEX_construct_dfa (const char *regex, const size_t len);
 
+
 /**
  * Free the memory allocated by constructing the GNUNET_REGEX_Automaton.
  * data structure.
@@ -89,15 +106,44 @@ GNUNET_REGEX_construct_dfa (const char *regex, const size_t len);
 void
 GNUNET_REGEX_automaton_destroy (struct GNUNET_REGEX_Automaton *a);
 
+
+/**
+ * Options for graph creation function
+ * GNUNET_REGEX_automaton_save_graph.
+ */
+enum GNUNET_REGEX_GraphSavingOptions
+{
+  /**
+   * Default. Do nothing special.
+   */
+  GNUNET_REGEX_GRAPH_DEFAULT = 0,
+
+  /**
+   * The generated graph will include extra information such as the NFA states
+   * that were used to generate the DFA state.
+   */
+  GNUNET_REGEX_GRAPH_VERBOSE = 1,
+
+  /**
+   * Enable graph coloring. Will color each SCC in a different color.
+   */
+  GNUNET_REGEX_GRAPH_COLORING = 2
+};
+
+
 /**
  * Save the given automaton as a GraphViz dot file.
  *
  * @param a the automaton to be saved.
  * @param filename where to save the file.
+ * @param options options for graph generation that include coloring or verbose
+ *                mode
  */
 void
 GNUNET_REGEX_automaton_save_graph (struct GNUNET_REGEX_Automaton *a,
-                                   const char *filename);
+                                   const char *filename,
+                                   enum GNUNET_REGEX_GraphSavingOptions options);
+
 
 /**
  * Evaluates the given 'string' against the given compiled regex.
@@ -111,9 +157,10 @@ int
 GNUNET_REGEX_eval (struct GNUNET_REGEX_Automaton *a,
                    const char *string);
 
+
 /**
  * Get the first key for the given 'input_string'. This hashes
- * the first x bits of the 'input_strings'.
+ * the first x bits of the 'input_string'.
  *
  * @param input_string string.
  * @param string_len length of the 'input_string'.
@@ -122,21 +169,23 @@ GNUNET_REGEX_eval (struct GNUNET_REGEX_Automaton *a,
  * @return number of bits of 'input_string' that have been consumed
  *         to construct the key
  */
-unsigned int
-GNUNET_REGEX_get_first_key (const char *input_string, unsigned int string_len,
-                            GNUNET_HashCode * key);
+size_t
+GNUNET_REGEX_get_first_key (const char *input_string, size_t string_len,
+                            struct GNUNET_HashCode * key);
+
 
 /**
  * Check if the given 'proof' matches the given 'key'.
  *
- * @param proof partial regex
- * @param key hash
+ * @param proof partial regex of a state.
+ * @param key hash of a state.
  *
- * @return GNUNET_OK if the proof is valid for the given key
+ * @return GNUNET_OK if the proof is valid for the given key.
  */
 int
 GNUNET_REGEX_check_proof (const char *proof,
-                          const GNUNET_HashCode *key);
+                          const struct GNUNET_HashCode *key);
+
 
 /**
  * Iterator callback function.
@@ -149,12 +198,13 @@ GNUNET_REGEX_check_proof (const char *proof,
  * @param edges edges leaving current state.
  */
 typedef void (*GNUNET_REGEX_KeyIterator)(void *cls,
-                                         const GNUNET_HashCode *key,
+                                         const struct GNUNET_HashCode *key,
                                          const char *proof,
                                          int accepting,
                                          unsigned int num_edges,
                                          const struct GNUNET_REGEX_Edge *edges);
 
+
 /**
  * Iterate over all edges starting from start state of automaton 'a'. Calling
  * iterator for each edge.
@@ -168,6 +218,33 @@ GNUNET_REGEX_iterate_all_edges (struct GNUNET_REGEX_Automaton *a,
                                 GNUNET_REGEX_KeyIterator iterator,
                                 void *iterator_cls);
 
+
+/**
+ * Create a regex in 'rxstr' from the given 'ip' and 'netmask'.
+ *
+ * @param ip IPv4 representation.
+ * @param netmask netmask for the ip.
+ * @param rxstr generated regex, must be at least GNUNET_REGEX_IPV4_REGEXLEN
+ *              bytes long.
+ */
+void
+GNUNET_REGEX_ipv4toregex (const struct in_addr *ip, const char *netmask,
+                          char *rxstr);
+
+
+/**
+ * Create a regex in 'rxstr' from the given 'ipv6' and 'prefixlen'.
+ *
+ * @param ipv6 IPv6 representation.
+ * @param prefixlen length of the ipv6 prefix.
+ * @param rxstr generated regex, must be at least GNUNET_REGEX_IPV6_REGEXLEN
+ *              bytes long.
+ */
+void
+GNUNET_REGEX_ipv6toregex (const struct in6_addr *ipv6,
+                          unsigned int prefixlen, char *rxstr);
+
+
 #if 0                           /* keep Emacsens' auto-indent happy */
 {
 #endif
@@ -177,4 +254,3 @@ GNUNET_REGEX_iterate_all_edges (struct GNUNET_REGEX_Automaton *a,
 
 /* end of gnunet_regex_lib.h */
 #endif
-