X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_container_lib.h;h=75443b6aeb5c6bc2262d5a3698dda3e18cc7c87f;hb=a6fb0db57f2a70a05bdb6ef7ccf69a044268dee6;hp=cfc7e0842c45245ac5a1b287285a9dcc503212e4;hpb=502af2167f7c218366666ca4944bd7cc54b5b19a;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_container_lib.h b/src/include/gnunet_container_lib.h index cfc7e0842..75443b6ae 100644 --- a/src/include/gnunet_container_lib.h +++ b/src/include/gnunet_container_lib.h @@ -75,13 +75,9 @@ typedef int (*GNUNET_HashCodeIterator) (void *cls, GNUNET_HashCode * next); * element (number of bits set per element in the set) * @return the bloomfilter */ -struct GNUNET_CONTAINER_BloomFilter *GNUNET_CONTAINER_bloomfilter_load (const - char - *filename, - size_t - size, - unsigned - int k); +struct GNUNET_CONTAINER_BloomFilter * +GNUNET_CONTAINER_bloomfilter_load (const char *filename, size_t size, + unsigned int k); /** @@ -97,13 +93,9 @@ struct GNUNET_CONTAINER_BloomFilter *GNUNET_CONTAINER_bloomfilter_load (const * element (number of bits set per element in the set) * @return the bloomfilter */ -struct GNUNET_CONTAINER_BloomFilter *GNUNET_CONTAINER_bloomfilter_init (const - char - *data, - size_t - size, - unsigned - int k); +struct GNUNET_CONTAINER_BloomFilter * +GNUNET_CONTAINER_bloomfilter_init (const char *data, size_t size, + unsigned int k); /** @@ -114,9 +106,10 @@ struct GNUNET_CONTAINER_BloomFilter *GNUNET_CONTAINER_bloomfilter_init (const * @param size the size of the given data array * @return GNUNET_SYSERR if the data array of the wrong size */ -int GNUNET_CONTAINER_bloomfilter_get_raw_data (const struct - GNUNET_CONTAINER_BloomFilter - *bf, char *data, size_t size); +int +GNUNET_CONTAINER_bloomfilter_get_raw_data (const struct + GNUNET_CONTAINER_BloomFilter *bf, + char *data, size_t size); /** @@ -125,8 +118,9 @@ int GNUNET_CONTAINER_bloomfilter_get_raw_data (const struct * @param bf the filter * @return GNUNET_YES if the element is in the filter, GNUNET_NO if not */ -int GNUNET_CONTAINER_bloomfilter_test (const struct GNUNET_CONTAINER_BloomFilter - *bf, const GNUNET_HashCode * e); +int +GNUNET_CONTAINER_bloomfilter_test (const struct GNUNET_CONTAINER_BloomFilter + *bf, const GNUNET_HashCode * e); /** @@ -134,8 +128,9 @@ int GNUNET_CONTAINER_bloomfilter_test (const struct GNUNET_CONTAINER_BloomFilter * @param bf the filter * @param e the element */ -void GNUNET_CONTAINER_bloomfilter_add (struct GNUNET_CONTAINER_BloomFilter - *bf, const GNUNET_HashCode * e); +void +GNUNET_CONTAINER_bloomfilter_add (struct GNUNET_CONTAINER_BloomFilter *bf, + const GNUNET_HashCode * e); /** @@ -143,8 +138,9 @@ void GNUNET_CONTAINER_bloomfilter_add (struct GNUNET_CONTAINER_BloomFilter * @param bf the filter * @param e the element to remove */ -void GNUNET_CONTAINER_bloomfilter_remove (struct GNUNET_CONTAINER_BloomFilter - *bf, const GNUNET_HashCode * e); +void +GNUNET_CONTAINER_bloomfilter_remove (struct GNUNET_CONTAINER_BloomFilter *bf, + const GNUNET_HashCode * e); /** @@ -153,10 +149,9 @@ void GNUNET_CONTAINER_bloomfilter_remove (struct GNUNET_CONTAINER_BloomFilter * @param bf the filter * @return copy of bf */ -struct GNUNET_CONTAINER_BloomFilter *GNUNET_CONTAINER_bloomfilter_copy (const - struct - GNUNET_CONTAINER_BloomFilter - *bf); +struct GNUNET_CONTAINER_BloomFilter * +GNUNET_CONTAINER_bloomfilter_copy (const struct GNUNET_CONTAINER_BloomFilter + *bf); @@ -166,8 +161,8 @@ struct GNUNET_CONTAINER_BloomFilter *GNUNET_CONTAINER_bloomfilter_copy (const * free the space on the drive) * @param bf the filter */ -void GNUNET_CONTAINER_bloomfilter_free (struct GNUNET_CONTAINER_BloomFilter - *bf); +void +GNUNET_CONTAINER_bloomfilter_free (struct GNUNET_CONTAINER_BloomFilter *bf); /** @@ -177,17 +172,6 @@ void GNUNET_CONTAINER_bloomfilter_free (struct GNUNET_CONTAINER_BloomFilter * @return number of bytes used for the data of the bloom filter */ size_t - - - - - - - - - - - GNUNET_CONTAINER_bloomfilter_get_size (const struct GNUNET_CONTAINER_BloomFilter *bf); @@ -196,8 +180,8 @@ GNUNET_CONTAINER_bloomfilter_get_size (const struct GNUNET_CONTAINER_BloomFilter * Reset a bloom filter to empty. * @param bf the filter */ -void GNUNET_CONTAINER_bloomfilter_clear (struct GNUNET_CONTAINER_BloomFilter - *bf); +void +GNUNET_CONTAINER_bloomfilter_clear (struct GNUNET_CONTAINER_BloomFilter *bf); /** * Or the entries of the given raw data array with the @@ -210,8 +194,9 @@ void GNUNET_CONTAINER_bloomfilter_clear (struct GNUNET_CONTAINER_BloomFilter * @param size size of data * @return GNUNET_OK on success */ -int GNUNET_CONTAINER_bloomfilter_or (struct GNUNET_CONTAINER_BloomFilter *bf, - const char *data, size_t size); +int +GNUNET_CONTAINER_bloomfilter_or (struct GNUNET_CONTAINER_BloomFilter *bf, + const char *data, size_t size); /** * Or the entries of the given raw data array with the @@ -239,11 +224,11 @@ GNUNET_CONTAINER_bloomfilter_or2 (struct GNUNET_CONTAINER_BloomFilter *bf, * @param size the new size for the filter * @param k the new number of GNUNET_CRYPTO_hash-function to apply per element */ -void GNUNET_CONTAINER_bloomfilter_resize (struct GNUNET_CONTAINER_BloomFilter - *bf, - GNUNET_HashCodeIterator iterator, - void *iterator_cls, - size_t size, unsigned int k); +void +GNUNET_CONTAINER_bloomfilter_resize (struct GNUNET_CONTAINER_BloomFilter *bf, + GNUNET_HashCodeIterator iterator, + void *iterator_cls, size_t size, + unsigned int k); /* ****************** metadata ******************* */ @@ -254,28 +239,29 @@ struct GNUNET_CONTAINER_MetaData; /** * Create a fresh MetaData token. - * + * * @return empty meta-data container */ -struct GNUNET_CONTAINER_MetaData *GNUNET_CONTAINER_meta_data_create (void); +struct GNUNET_CONTAINER_MetaData * +GNUNET_CONTAINER_meta_data_create (void); /** * Duplicate a MetaData token. - * + * * @param md what to duplicate * @return duplicate meta-data container */ -struct GNUNET_CONTAINER_MetaData *GNUNET_CONTAINER_meta_data_duplicate (const - struct - GNUNET_CONTAINER_MetaData - *md); +struct GNUNET_CONTAINER_MetaData * +GNUNET_CONTAINER_meta_data_duplicate (const struct GNUNET_CONTAINER_MetaData + *md); /** * Free meta data. * * @param md what to free */ -void GNUNET_CONTAINER_meta_data_destroy (struct GNUNET_CONTAINER_MetaData *md); +void +GNUNET_CONTAINER_meta_data_destroy (struct GNUNET_CONTAINER_MetaData *md); /** * Test if two MDs are equal. We consider them equal if @@ -288,10 +274,10 @@ void GNUNET_CONTAINER_meta_data_destroy (struct GNUNET_CONTAINER_MetaData *md); * @return GNUNET_YES if they are equal */ int -GNUNET_CONTAINER_meta_data_test_equal (const struct - GNUNET_CONTAINER_MetaData *md1, - const struct - GNUNET_CONTAINER_MetaData *md2); +GNUNET_CONTAINER_meta_data_test_equal (const struct GNUNET_CONTAINER_MetaData + *md1, + const struct GNUNET_CONTAINER_MetaData + *md2); /** @@ -303,7 +289,7 @@ GNUNET_CONTAINER_meta_data_test_equal (const struct * used in the main libextractor library and yielding * meta data). * @param type libextractor-type describing the meta data - * @param format basic format information about data + * @param format basic format information about data * @param data_mime_type mime-type of data (not of the original file); * can be NULL (if mime-type is not known) * @param data actual meta-data found @@ -316,8 +302,8 @@ GNUNET_CONTAINER_meta_data_insert (struct GNUNET_CONTAINER_MetaData *md, const char *plugin_name, enum EXTRACTOR_MetaType type, enum EXTRACTOR_MetaFormat format, - const char *data_mime_type, - const char *data, size_t data_len); + const char *data_mime_type, const char *data, + size_t data_len); /** @@ -353,7 +339,8 @@ GNUNET_CONTAINER_meta_data_delete (struct GNUNET_CONTAINER_MetaData *md, * * @param md metadata to manipulate */ -void GNUNET_CONTAINER_meta_data_clear (struct GNUNET_CONTAINER_MetaData *md); +void +GNUNET_CONTAINER_meta_data_clear (struct GNUNET_CONTAINER_MetaData *md); /** @@ -375,10 +362,10 @@ GNUNET_CONTAINER_meta_data_add_publication_date (struct * @param iter_cls closure for iterator * @return number of entries */ -int GNUNET_CONTAINER_meta_data_iterate (const struct - GNUNET_CONTAINER_MetaData *md, - EXTRACTOR_MetaDataProcessor - iter, void *iter_cls); +int +GNUNET_CONTAINER_meta_data_iterate (const struct GNUNET_CONTAINER_MetaData *md, + EXTRACTOR_MetaDataProcessor iter, + void *iter_cls); /** * Get the first MD entry of the given type. Caller @@ -390,9 +377,9 @@ int GNUNET_CONTAINER_meta_data_iterate (const struct * @param type type to look for * @return NULL if no entry was found */ -char *GNUNET_CONTAINER_meta_data_get_by_type (const struct - GNUNET_CONTAINER_MetaData *md, - enum EXTRACTOR_MetaType type); +char * +GNUNET_CONTAINER_meta_data_get_by_type (const struct GNUNET_CONTAINER_MetaData + *md, enum EXTRACTOR_MetaType type); /** @@ -406,9 +393,10 @@ char *GNUNET_CONTAINER_meta_data_get_by_type (const struct * @return NULL if we do not have any such entry, * otherwise client is responsible for freeing the value! */ -char *GNUNET_CONTAINER_meta_data_get_first_by_types (const struct - GNUNET_CONTAINER_MetaData - *md, ...); +char * +GNUNET_CONTAINER_meta_data_get_first_by_types (const struct + GNUNET_CONTAINER_MetaData *md, + ...); /** * Get a thumbnail from the meta-data (if present). Only matches meta @@ -420,8 +408,7 @@ char *GNUNET_CONTAINER_meta_data_get_first_by_types (const struct * @return number of bytes in thumbnail, 0 if not available */ size_t -GNUNET_CONTAINER_meta_data_get_thumbnail (const struct - GNUNET_CONTAINER_MetaData +GNUNET_CONTAINER_meta_data_get_thumbnail (const struct GNUNET_CONTAINER_MetaData *md, unsigned char **thumb); @@ -464,29 +451,8 @@ enum GNUNET_CONTAINER_MetaDataSerializationOptions * space) */ ssize_t - - - - - - - - - - - - - - - - - - - -GNUNET_CONTAINER_meta_data_serialize (const struct - GNUNET_CONTAINER_MetaData *md, - char **target, - size_t max, +GNUNET_CONTAINER_meta_data_serialize (const struct GNUNET_CONTAINER_MetaData + *md, char **target, size_t max, enum GNUNET_CONTAINER_MetaDataSerializationOptions opt); @@ -499,25 +465,6 @@ GNUNET_CONTAINER_meta_data_serialize (const struct * @return number of bytes needed for serialization, -1 on error */ ssize_t - - - - - - - - - - - - - - - - - - - GNUNET_CONTAINER_meta_data_get_serialized_size (const struct GNUNET_CONTAINER_MetaData *md); @@ -530,11 +477,8 @@ GNUNET_CONTAINER_meta_data_get_serialized_size (const struct * @return MD on success, NULL on error (i.e. * bad format) */ -struct GNUNET_CONTAINER_MetaData *GNUNET_CONTAINER_meta_data_deserialize (const - char - *input, - size_t - size); +struct GNUNET_CONTAINER_MetaData * +GNUNET_CONTAINER_meta_data_deserialize (const char *input, size_t size); /* ******************************* HashMap **************************** */ @@ -599,8 +543,8 @@ typedef int (*GNUNET_CONTAINER_HashMapIterator) (void *cls, * @param len initial size (map will grow as needed) * @return NULL on error */ -struct GNUNET_CONTAINER_MultiHashMap - *GNUNET_CONTAINER_multihashmap_create (unsigned int len); +struct GNUNET_CONTAINER_MultiHashMap * +GNUNET_CONTAINER_multihashmap_create (unsigned int len); /** @@ -609,8 +553,9 @@ struct GNUNET_CONTAINER_MultiHashMap * * @param map the map */ -void GNUNET_CONTAINER_multihashmap_destroy (struct - GNUNET_CONTAINER_MultiHashMap *map); +void +GNUNET_CONTAINER_multihashmap_destroy (struct GNUNET_CONTAINER_MultiHashMap + *map); /** @@ -623,9 +568,9 @@ void GNUNET_CONTAINER_multihashmap_destroy (struct * happen to be NULL; use "contains" to test for * key-value pairs with value NULL */ -void *GNUNET_CONTAINER_multihashmap_get (const struct - GNUNET_CONTAINER_MultiHashMap *map, - const GNUNET_HashCode * key); +void * +GNUNET_CONTAINER_multihashmap_get (const struct GNUNET_CONTAINER_MultiHashMap + *map, const GNUNET_HashCode * key); /** @@ -639,9 +584,9 @@ void *GNUNET_CONTAINER_multihashmap_get (const struct * @return GNUNET_YES on success, GNUNET_NO if the key-value pair * is not in the map */ -int GNUNET_CONTAINER_multihashmap_remove (struct GNUNET_CONTAINER_MultiHashMap - *map, const GNUNET_HashCode * key, - void *value); +int +GNUNET_CONTAINER_multihashmap_remove (struct GNUNET_CONTAINER_MultiHashMap *map, + const GNUNET_HashCode * key, void *value); /** * Remove all entries for the given key from the map. @@ -651,10 +596,9 @@ int GNUNET_CONTAINER_multihashmap_remove (struct GNUNET_CONTAINER_MultiHashMap * @param key identifies values to be removed * @return number of values removed */ -int GNUNET_CONTAINER_multihashmap_remove_all (struct - GNUNET_CONTAINER_MultiHashMap - *map, - const GNUNET_HashCode * key); +int +GNUNET_CONTAINER_multihashmap_remove_all (struct GNUNET_CONTAINER_MultiHashMap + *map, const GNUNET_HashCode * key); /** @@ -666,9 +610,10 @@ int GNUNET_CONTAINER_multihashmap_remove_all (struct * @return GNUNET_YES if such a value exists, * GNUNET_NO if not */ -int GNUNET_CONTAINER_multihashmap_contains (const struct - GNUNET_CONTAINER_MultiHashMap - *map, const GNUNET_HashCode * key); +int +GNUNET_CONTAINER_multihashmap_contains (const struct + GNUNET_CONTAINER_MultiHashMap *map, + const GNUNET_HashCode * key); /** @@ -681,11 +626,11 @@ int GNUNET_CONTAINER_multihashmap_contains (const struct * @return GNUNET_YES if such a value exists, * GNUNET_NO if not */ -int GNUNET_CONTAINER_multihashmap_contains_value (const struct - GNUNET_CONTAINER_MultiHashMap - *map, - const GNUNET_HashCode * key, - const void *value); +int +GNUNET_CONTAINER_multihashmap_contains_value (const struct + GNUNET_CONTAINER_MultiHashMap + *map, const GNUNET_HashCode * key, + const void *value); /** @@ -700,11 +645,11 @@ int GNUNET_CONTAINER_multihashmap_contains_value (const struct * GNUNET_SYSERR if UNIQUE_ONLY was the option and the * value already exists */ -int GNUNET_CONTAINER_multihashmap_put (struct GNUNET_CONTAINER_MultiHashMap - *map, const GNUNET_HashCode * key, - void *value, - enum - GNUNET_CONTAINER_MultiHashMapOption opt); +int +GNUNET_CONTAINER_multihashmap_put (struct GNUNET_CONTAINER_MultiHashMap *map, + const GNUNET_HashCode * key, void *value, + enum GNUNET_CONTAINER_MultiHashMapOption + opt); /** * Get the number of key-value pairs in the map. @@ -712,9 +657,9 @@ int GNUNET_CONTAINER_multihashmap_put (struct GNUNET_CONTAINER_MultiHashMap * @param map the map * @return the number of key value pairs */ -unsigned int GNUNET_CONTAINER_multihashmap_size (const struct - GNUNET_CONTAINER_MultiHashMap - *map); +unsigned int +GNUNET_CONTAINER_multihashmap_size (const struct GNUNET_CONTAINER_MultiHashMap + *map); /** @@ -726,10 +671,11 @@ unsigned int GNUNET_CONTAINER_multihashmap_size (const struct * @return the number of key value pairs processed, * GNUNET_SYSERR if it aborted iteration */ -int GNUNET_CONTAINER_multihashmap_iterate (const struct - GNUNET_CONTAINER_MultiHashMap *map, - GNUNET_CONTAINER_HashMapIterator - it, void *it_cls); +int +GNUNET_CONTAINER_multihashmap_iterate (const struct + GNUNET_CONTAINER_MultiHashMap *map, + GNUNET_CONTAINER_HashMapIterator it, + void *it_cls); /** @@ -742,12 +688,12 @@ int GNUNET_CONTAINER_multihashmap_iterate (const struct * @return the number of key value pairs processed, * GNUNET_SYSERR if it aborted iteration */ -int GNUNET_CONTAINER_multihashmap_get_multiple (const struct - GNUNET_CONTAINER_MultiHashMap - *map, - const GNUNET_HashCode * key, - GNUNET_CONTAINER_HashMapIterator - it, void *it_cls); +int +GNUNET_CONTAINER_multihashmap_get_multiple (const struct + GNUNET_CONTAINER_MultiHashMap *map, + const GNUNET_HashCode * key, + GNUNET_CONTAINER_HashMapIterator it, + void *it_cls); /* ******************** doubly-linked list *************** */ @@ -922,9 +868,8 @@ struct GNUNET_CONTAINER_HeapNode; * @param order how should the heap be sorted? * @return handle to the heap */ -struct GNUNET_CONTAINER_Heap *GNUNET_CONTAINER_heap_create (enum - GNUNET_CONTAINER_HeapOrder - order); +struct GNUNET_CONTAINER_Heap * +GNUNET_CONTAINER_heap_create (enum GNUNET_CONTAINER_HeapOrder order); /** @@ -933,7 +878,8 @@ struct GNUNET_CONTAINER_Heap *GNUNET_CONTAINER_heap_create (enum * * @param heap heap to destroy */ -void GNUNET_CONTAINER_heap_destroy (struct GNUNET_CONTAINER_Heap *heap); +void +GNUNET_CONTAINER_heap_destroy (struct GNUNET_CONTAINER_Heap *heap); /** @@ -942,7 +888,8 @@ void GNUNET_CONTAINER_heap_destroy (struct GNUNET_CONTAINER_Heap *heap); * @param heap heap to inspect * @return NULL if heap is empty */ -void *GNUNET_CONTAINER_heap_peek (const struct GNUNET_CONTAINER_Heap *heap); +void * +GNUNET_CONTAINER_heap_peek (const struct GNUNET_CONTAINER_Heap *heap); /** @@ -1007,8 +954,9 @@ GNUNET_CONTAINER_heap_iterate (const struct GNUNET_CONTAINER_Heap *heap, * NULL if the heap is empty. * */ -void *GNUNET_CONTAINER_heap_get_random (struct GNUNET_CONTAINER_Heap *heap, - uint32_t max); +void * +GNUNET_CONTAINER_heap_get_random (struct GNUNET_CONTAINER_Heap *heap, + uint32_t max); /** @@ -1022,7 +970,8 @@ void *GNUNET_CONTAINER_heap_get_random (struct GNUNET_CONTAINER_Heap *heap, * @return data stored at the next random node in the walk; * NULL if the tree is empty. */ -void *GNUNET_CONTAINER_heap_walk_get_next (struct GNUNET_CONTAINER_Heap *heap); +void * +GNUNET_CONTAINER_heap_walk_get_next (struct GNUNET_CONTAINER_Heap *heap); /** @@ -1033,12 +982,9 @@ void *GNUNET_CONTAINER_heap_walk_get_next (struct GNUNET_CONTAINER_Heap *heap); * @param cost cost for the element * @return node for the new element */ -struct GNUNET_CONTAINER_HeapNode *GNUNET_CONTAINER_heap_insert (struct - GNUNET_CONTAINER_Heap - *heap, - void *element, - GNUNET_CONTAINER_HeapCostType - cost); +struct GNUNET_CONTAINER_HeapNode * +GNUNET_CONTAINER_heap_insert (struct GNUNET_CONTAINER_Heap *heap, void *element, + GNUNET_CONTAINER_HeapCostType cost); /** @@ -1047,17 +993,18 @@ struct GNUNET_CONTAINER_HeapNode *GNUNET_CONTAINER_heap_insert (struct * @param heap heap to modify * @return element data stored at the root node */ -void *GNUNET_CONTAINER_heap_remove_root (struct GNUNET_CONTAINER_Heap *heap); +void * +GNUNET_CONTAINER_heap_remove_root (struct GNUNET_CONTAINER_Heap *heap); /** * Removes a node from the heap. - * + * * @param node node to remove * @return element data stored at the node, NULL if heap is empty */ -void *GNUNET_CONTAINER_heap_remove_node (struct GNUNET_CONTAINER_HeapNode - *node); +void * +GNUNET_CONTAINER_heap_remove_node (struct GNUNET_CONTAINER_HeapNode *node); /** @@ -1100,14 +1047,31 @@ enum GNUNET_CONTAINER_SListDisposition /** - * Handle to a singly linked list + * Handle to a singly linked list */ struct GNUNET_CONTAINER_SList; /** - * Handle to a singly linked list iterator + * Handle to a singly linked list iterator */ -struct GNUNET_CONTAINER_SList_Iterator; +struct GNUNET_CONTAINER_SList_Iterator +{ + /** + * Linked list that we are iterating over. + */ + struct GNUNET_CONTAINER_SList *list; + + /** + * Last element accessed. + */ + struct GNUNET_CONTAINER_SList_Elem *last; + + /** + * Current list element. + */ + struct GNUNET_CONTAINER_SList_Elem *elem; +}; + /** @@ -1117,9 +1081,10 @@ struct GNUNET_CONTAINER_SList_Iterator; * @param buf payload buffer * @param len length of the buffer */ -void GNUNET_CONTAINER_slist_add (struct GNUNET_CONTAINER_SList *l, - enum GNUNET_CONTAINER_SListDisposition disp, - const void *buf, size_t len); +void +GNUNET_CONTAINER_slist_add (struct GNUNET_CONTAINER_SList *l, + enum GNUNET_CONTAINER_SListDisposition disp, + const void *buf, size_t len); /** @@ -1129,9 +1094,10 @@ void GNUNET_CONTAINER_slist_add (struct GNUNET_CONTAINER_SList *l, * @param buf payload buffer * @param len length of the buffer */ -void GNUNET_CONTAINER_slist_add_end (struct GNUNET_CONTAINER_SList *l, - enum GNUNET_CONTAINER_SListDisposition - disp, const void *buf, size_t len); +void +GNUNET_CONTAINER_slist_add_end (struct GNUNET_CONTAINER_SList *l, + enum GNUNET_CONTAINER_SListDisposition disp, + const void *buf, size_t len); /** @@ -1148,25 +1114,28 @@ GNUNET_CONTAINER_slist_append (struct GNUNET_CONTAINER_SList *dst, * Create a new singly linked list * @return the new list */ -struct GNUNET_CONTAINER_SList *GNUNET_CONTAINER_slist_create (void); +struct GNUNET_CONTAINER_SList * +GNUNET_CONTAINER_slist_create (void); /** * Destroy a singly linked list * @param l the list to be destroyed */ -void GNUNET_CONTAINER_slist_destroy (struct GNUNET_CONTAINER_SList *l); +void +GNUNET_CONTAINER_slist_destroy (struct GNUNET_CONTAINER_SList *l); /** * Return the beginning of a list * * @param l list - * @return iterator pointing to the beginning, free using "GNUNET_free" + * @return iterator pointing to the beginning (by value! Either allocate the + * structure on the stack, or use GNUNET_malloc() yourself! All other + * functions do take pointer to this struct though) */ -struct GNUNET_CONTAINER_SList_Iterator *GNUNET_CONTAINER_slist_begin (struct - GNUNET_CONTAINER_SList - *l); +struct GNUNET_CONTAINER_SList_Iterator +GNUNET_CONTAINER_slist_begin (struct GNUNET_CONTAINER_SList *l); /** @@ -1174,7 +1143,8 @@ struct GNUNET_CONTAINER_SList_Iterator *GNUNET_CONTAINER_slist_begin (struct * * @param l list */ -void GNUNET_CONTAINER_slist_clear (struct GNUNET_CONTAINER_SList *l); +void +GNUNET_CONTAINER_slist_clear (struct GNUNET_CONTAINER_SList *l); /** @@ -1183,8 +1153,9 @@ void GNUNET_CONTAINER_slist_clear (struct GNUNET_CONTAINER_SList *l); * @param buf payload buffer to find * @param len length of the payload (number of bytes in buf) */ -int GNUNET_CONTAINER_slist_contains (const struct GNUNET_CONTAINER_SList *l, - const void *buf, size_t len); +int +GNUNET_CONTAINER_slist_contains (const struct GNUNET_CONTAINER_SList *l, + const void *buf, size_t len); /** @@ -1192,14 +1163,16 @@ int GNUNET_CONTAINER_slist_contains (const struct GNUNET_CONTAINER_SList *l, * @param l list * @return number of elements in the list */ -int GNUNET_CONTAINER_slist_count (const struct GNUNET_CONTAINER_SList *l); +int +GNUNET_CONTAINER_slist_count (const struct GNUNET_CONTAINER_SList *l); /** * Remove an element from the list * @param i iterator that points to the element to be removed */ -void GNUNET_CONTAINER_slist_erase (struct GNUNET_CONTAINER_SList_Iterator *i); +void +GNUNET_CONTAINER_slist_erase (struct GNUNET_CONTAINER_SList_Iterator *i); /** @@ -1209,10 +1182,10 @@ void GNUNET_CONTAINER_slist_erase (struct GNUNET_CONTAINER_SList_Iterator *i); * @param buf payload buffer * @param len length of the payload */ -void GNUNET_CONTAINER_slist_insert (struct GNUNET_CONTAINER_SList_Iterator - *before, - enum GNUNET_CONTAINER_SListDisposition disp, - const void *buf, size_t len); +void +GNUNET_CONTAINER_slist_insert (struct GNUNET_CONTAINER_SList_Iterator *before, + enum GNUNET_CONTAINER_SListDisposition disp, + const void *buf, size_t len); /** @@ -1220,7 +1193,8 @@ void GNUNET_CONTAINER_slist_insert (struct GNUNET_CONTAINER_SList_Iterator * @param i iterator * @return GNUNET_YES on success, GNUNET_NO if the end has been reached */ -int GNUNET_CONTAINER_slist_next (struct GNUNET_CONTAINER_SList_Iterator *i); +int +GNUNET_CONTAINER_slist_next (struct GNUNET_CONTAINER_SList_Iterator *i); /** @@ -1229,7 +1203,8 @@ int GNUNET_CONTAINER_slist_next (struct GNUNET_CONTAINER_SList_Iterator *i); * @return GNUNET_YES if the end has been reached, GNUNET_NO if the iterator * points to a valid element */ -int GNUNET_CONTAINER_slist_end (struct GNUNET_CONTAINER_SList_Iterator *i); +int +GNUNET_CONTAINER_slist_end (struct GNUNET_CONTAINER_SList_Iterator *i); /** @@ -1239,16 +1214,17 @@ int GNUNET_CONTAINER_slist_end (struct GNUNET_CONTAINER_SList_Iterator *i); * @param len set to the payload length * @return payload */ -void *GNUNET_CONTAINER_slist_get (const struct GNUNET_CONTAINER_SList_Iterator - *i, size_t * len); +void * +GNUNET_CONTAINER_slist_get (const struct GNUNET_CONTAINER_SList_Iterator *i, + size_t * len); /** * Release an iterator * @param i iterator */ -void GNUNET_CONTAINER_slist_iter_destroy (struct GNUNET_CONTAINER_SList_Iterator - *i); +void +GNUNET_CONTAINER_slist_iter_destroy (struct GNUNET_CONTAINER_SList_Iterator *i); #if 0 /* keep Emacsens' auto-indent happy */