Do not crash if key is NULL.
[oweals/gnunet.git] / src / fs / fs_tree.h
index 5cd4d0afecef817f0b2a6fbd04a05b2f67677ac9..cd25a6dd14ecf900758d78cdea27c2c16c05cb1d 100644 (file)
 #ifndef GNUNET_FS_TREE_H
 #define GNUNET_FS_TREE_H
 
-#include "fs.h"
+#include "fs_api.h"
 
 /**
- * Compute the depth of the CHK tree.  
+ * Compute the depth of the CHK tree.
  *
  * @param flen file length for which to compute the depth
  * @return depth of the tree, always > 0.  A depth of 1 means only a DBLOCK.
@@ -69,9 +69,8 @@ GNUNET_FS_tree_compute_tree_size (unsigned int depth);
  * @return number of bytes stored in this node
  */
 size_t
-GNUNET_FS_tree_calculate_block_size (uint64_t fsize,
-                                    uint64_t offset,
-                                    unsigned int depth);
+GNUNET_FS_tree_calculate_block_size (uint64_t fsize, uint64_t offset,
+                                     unsigned int depth);
 
 
 /**
@@ -95,14 +94,14 @@ struct GNUNET_FS_TreeEncoder;
  * @param block the (encrypted) block
  * @param block_size size of block (in bytes)
  */
-typedef void (*GNUNET_FS_TreeBlockProcessor)(void *cls,
-                                            const struct ContentHashKey *chk,
-                                            uint64_t offset,
-                                            unsigned int depth,
-                                            enum GNUNET_BLOCK_Type type,
-                                            const void *block,
-                                            uint16_t block_size);
-                                            
+typedef void (*GNUNET_FS_TreeBlockProcessor) (void *cls,
+                                              const struct ContentHashKey * chk,
+                                              uint64_t offset,
+                                              unsigned int depth,
+                                              enum GNUNET_BLOCK_Type type,
+                                              const void *block,
+                                              uint16_t block_size);
+
 
 /**
  * Function called with information about our
@@ -114,12 +113,11 @@ typedef void (*GNUNET_FS_TreeBlockProcessor)(void *cls,
  * @param pt_size size of pt_block
  * @param depth depth of the block in the tree, 0 for DBLOCKS
  */
-typedef void (*GNUNET_FS_TreeProgressCallback)(void *cls,
-                                              uint64_t offset,
-                                              const void *pt_block,
-                                              size_t pt_size,
-                                              unsigned int depth);
-                                              
+typedef void (*GNUNET_FS_TreeProgressCallback) (void *cls, uint64_t offset,
+                                                const void *pt_block,
+                                                size_t pt_size,
+                                                unsigned int depth);
+
 
 /**
  * Initialize a tree encoder.  This function will call "proc" and
@@ -135,45 +133,53 @@ typedef void (*GNUNET_FS_TreeProgressCallback)(void *cls,
  * @param cls closure for reader, proc, progress and cont
  * @param reader function to call to read plaintext data
  * @param proc function to call on each encrypted block
- * @param progress function to call with progress information 
+ * @param progress function to call with progress information
  * @param cont function to call when done
  * @return tree encoder context
  */
 struct GNUNET_FS_TreeEncoder *
-GNUNET_FS_tree_encoder_create (struct GNUNET_FS_Handle *h,
-                              uint64_t size,
-                              void *cls,
-                              GNUNET_FS_DataReader reader,
-                              GNUNET_FS_TreeBlockProcessor proc,
-                              GNUNET_FS_TreeProgressCallback progress,
-                              GNUNET_SCHEDULER_Task cont);
+GNUNET_FS_tree_encoder_create (struct GNUNET_FS_Handle *h, uint64_t size,
+                               void *cls, GNUNET_FS_DataReader reader,
+                               GNUNET_FS_TreeBlockProcessor proc,
+                               GNUNET_FS_TreeProgressCallback progress,
+                               GNUNET_SCHEDULER_Task cont);
 
 
 /**
- * Encrypt the next block of the file (and 
- * call proc and progress accordingly; or 
+ * Encrypt the next block of the file (and
+ * call proc and progress accordingly; or
  * of course "cont" if we have already completed
  * encoding of the entire file).
  *
  * @param te tree encoder to use
  */
-void GNUNET_FS_tree_encoder_next (struct GNUNET_FS_TreeEncoder * te);
+void
+GNUNET_FS_tree_encoder_next (struct GNUNET_FS_TreeEncoder *te);
+
+
+/**
+ * Get the resulting URI from the encoding.
+ *
+ * @param te the tree encoder to clean up
+ * @return uri set to the resulting URI (if encoding finished), NULL otherwise
+ */
+struct GNUNET_FS_Uri *
+GNUNET_FS_tree_encoder_get_uri (struct GNUNET_FS_TreeEncoder *te);
 
 
 /**
  * Clean up a tree encoder and return information
- * about the resulting URI or an error message.
- * 
+ * about possible errors.
+ *
  * @param te the tree encoder to clean up
- * @param uri set to the resulting URI (if encoding finished)
  * @param emsg set to an error message (if an error occured
  *        within the tree encoder; if this function is called
  *        prior to completion and prior to an internal error,
- *        both "*uri" and "*emsg" will be set to NULL).
+ *        both "*emsg" will be set to NULL).
  */
-void GNUNET_FS_tree_encoder_finish (struct GNUNET_FS_TreeEncoder *te,
-                                   struct GNUNET_FS_Uri **uri,
-                                   char **emsg);
+void
+GNUNET_FS_tree_encoder_finish (struct GNUNET_FS_TreeEncoder *te,
+                               char **emsg);
 
 
 #if 0
@@ -182,27 +188,28 @@ void GNUNET_FS_tree_encoder_finish (struct GNUNET_FS_TreeEncoder *te,
 /**
  * Get data that would be needed to resume
  * the encoding later.
- * 
+ *
  * @param te encoding to resume
  * @param data set to the resume data
  * @param size set to the size of the resume data
  */
-void GNUNET_FS_tree_encoder_resume_get_data (const struct GNUNET_FS_TreeEncoder *te,
-                                            void **data,
-                                            size_t *size);
+void
+GNUNET_FS_tree_encoder_resume_get_data (const struct GNUNET_FS_TreeEncoder *te,
+                                        void **data, size_t * size);
 
 
 /**
  * Reset tree encoder to point previously
  * obtained for resuming.
- * 
+ *
  * @param te encoding to resume
  * @param data the resume data
  * @param size the size of the resume data
  */
-void GNUNET_FS_tree_encoder_resume (struct GNUNET_FS_TreeEncoder *te,
-                                   const void *data,
-                                   size_t size);
+void
+GNUNET_FS_tree_encoder_resume (struct GNUNET_FS_TreeEncoder *te,
+                               const void *data, size_t size);
+
 #endif
 
 #endif