log: add \n
[oweals/gnunet.git] / src / regex / regex_block_lib.c
index 8a1f0829061ce04aac64aca0a6aac88aef60c8c9..d545c89de0e921f162b98f85615eafae8b1d0811 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2012,2013 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2012,2013 GNUnet e.V.
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
@@ -14,8 +14,8 @@
 
      You should have received a copy of the GNU General Public License
      along with GNUnet; see the file COPYING.  If not, write to the
-     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-     Boston, MA 02111-1307, USA.
+     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+     Boston, MA 02110-1301, USA.
 */
 /**
  * @author Bartlomiej Polot
@@ -97,7 +97,7 @@ GNUNET_NETWORK_STRUCT_END
  *
  * @param block block to test
  * @param size number of bytes in block
- * @return GNUNET_YES if the block is accepting, GNUNET_NO if not
+ * @return #GNUNET_YES if the block is accepting, #GNUNET_NO if not
  */
 int
 GNUNET_BLOCK_is_accepting (const struct RegexBlock *block,
@@ -118,8 +118,7 @@ GNUNET_BLOCK_is_accepting (const struct RegexBlock *block,
  * @param proof partial regex of a state
  * @param proof_len number of bytes in 'proof'
  * @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
 REGEX_BLOCK_check_proof (const char *proof,
@@ -165,7 +164,7 @@ struct CheckEdgeContext
  * @param len Lenght of token.
  * @param key Hash of next state.
  *
- * @return GNUNET_YES, to keep iterating
+ * @return #GNUNET_YES, to keep iterating
  */
 static int
 check_edge (void *cls,
@@ -176,8 +175,11 @@ check_edge (void *cls,
   struct CheckEdgeContext *ctx = cls;
 
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-             "edge %.*s [%u]: %s->%s\n",
-              (int) len, token, len, GNUNET_h2s(key));
+             "edge %.*s [%u]: %s\n",
+              (int) len,
+              token,
+              (unsigned int) len,
+              GNUNET_h2s (key));
   if (NULL == ctx->xquery)
     return GNUNET_YES;
   if (strlen (ctx->xquery) < len)
@@ -196,10 +198,9 @@ check_edge (void *cls,
  * @param query the query for the block
  * @param xquery String describing the edge we are looking for.
  *               Can be NULL in case this is a put block.
- *
- * @return GNUNET_OK in case it's fine.
- *         GNUNET_NO in case the xquery exists and is not found (IRRELEVANT).
- *         GNUNET_SYSERR if the block is invalid.
+ * @return #GNUNET_OK in case it's fine.
+ *         #GNUNET_NO in case the xquery exists and is not found (IRRELEVANT).
+ *         #GNUNET_SYSERR if the block is invalid.
  */
 int
 REGEX_BLOCK_check (const struct RegexBlock *block,
@@ -211,7 +212,8 @@ REGEX_BLOCK_check (const struct RegexBlock *block,
   struct CheckEdgeContext ctx;
   int res;
 
-  LOG (GNUNET_ERROR_TYPE_DEBUG, "Block check\n");
+  LOG (GNUNET_ERROR_TYPE_DEBUG,
+       "Block check\n");
   if (GNUNET_OK !=
       REGEX_BLOCK_get_key (block, size,
                           &key))
@@ -231,8 +233,9 @@ REGEX_BLOCK_check (const struct RegexBlock *block,
        ( (NULL == xquery) || ('\0' == xquery[0]) ) )
   {
     LOG (GNUNET_ERROR_TYPE_DEBUG,
-       "  out! Is accepting: %u, xquery %p\n",
-       ntohs(block->is_accepting), xquery);
+         "  out! Is accepting: %u, xquery %p\n",
+         ntohs(block->is_accepting),
+         xquery);
     return GNUNET_OK;
   }
   ctx.xquery = xquery;
@@ -253,7 +256,7 @@ REGEX_BLOCK_check (const struct RegexBlock *block,
  * @param block block to get the key from
  * @param block_len number of bytes in block
  * @param key where to store the key
- * @return GNUNET_OK on success, GNUNET_SYSERR if the block is malformed
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR if the block is malformed
  */
 int
 REGEX_BLOCK_get_key (const struct RegexBlock *block,
@@ -277,7 +280,7 @@ REGEX_BLOCK_get_key (const struct RegexBlock *block,
   len = ntohs (block->proof_len);
   destinations = (const struct GNUNET_HashCode *) &block[1];
   edges = (const struct EdgeInfo *) &destinations[num_destinations];
-  total = sizeof (struct RegexBlock) + num_destinations * sizeof (struct GNUNET_HashCode) + num_edges + sizeof (struct EdgeInfo) + len;
+  total = sizeof (struct RegexBlock) + num_destinations * sizeof (struct GNUNET_HashCode) + num_edges * sizeof (struct EdgeInfo) + len;
   if (block_len < total)
   {
     GNUNET_break_op (0);
@@ -292,14 +295,13 @@ REGEX_BLOCK_get_key (const struct RegexBlock *block,
  * Iterate over all edges of a block of a regex state.
  *
  * @param block Block to iterate over.
- * @param size Size of block.
+ * @param size Size of @a block.
  * @param iterator Function to call on each edge in the block.
- * @param iter_cls Closure for the iterator.
- *
- * @return GNUNET_SYSERR if an error has been encountered.
- *         GNUNET_OK if no error has been encountered.
+ * @param iter_cls Closure for the @a iterator.
+ * @return #GNUNET_SYSERR if an error has been encountered.
+ *         #GNUNET_OK if no error has been encountered.
  *           Note that if the iterator stops the iteration by returning
- *         GNUNET_NO, the block will no longer be checked for further errors.
+ *         #GNUNET_NO, the block will no longer be checked for further errors.
  *           The return value will be GNUNET_OK meaning that no errors were
  *         found until the edge last notified to the iterator, but there might
  *         be errors in further edges.
@@ -356,7 +358,8 @@ REGEX_BLOCK_iterate (const struct RegexBlock *block,
   for (n=0;n<num_edges;n++)
   {
     LOG (GNUNET_ERROR_TYPE_DEBUG,
-        " Edge %u/%u, off %u tokenlen %u (%.*s)\n", n+1, num_edges, off,
+        "Edge %u/%u, off %u tokenlen %u (%.*s)\n",
+         n+1, num_edges, off,
         ntohs (edges[n].token_length), ntohs (edges[n].token_length),
          &aux[off]);
     if (NULL != iterator)
@@ -445,17 +448,17 @@ REGEX_BLOCK_create (const char *proof,
   block->num_edges = htons (num_edges);
   block->num_destinations = htons (unique_destinations);
   dests = (struct GNUNET_HashCode *) &block[1];
-  memcpy (dests, destinations, sizeof (struct GNUNET_HashCode) * unique_destinations);
+  GNUNET_memcpy (dests, destinations, sizeof (struct GNUNET_HashCode) * unique_destinations);
   edgeinfos = (struct EdgeInfo *) &dests[unique_destinations];
   aux = (char *) &edgeinfos[num_edges];
   off = len;
-  memcpy (aux, proof, len);
+  GNUNET_memcpy (aux, proof, len);
   for (i=0;i<num_edges;i++)
   {
     slen = strlen (edges[i].label);
     edgeinfos[i].token_length = htons ((uint16_t) slen);
     edgeinfos[i].destination_index = htons (destination_indices[i]);
-    memcpy (&aux[off],
+    GNUNET_memcpy (&aux[off],
            edges[i].label,
            slen);
     off += slen;