X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_container_lib.h;h=75443b6aeb5c6bc2262d5a3698dda3e18cc7c87f;hb=a6fb0db57f2a70a05bdb6ef7ccf69a044268dee6;hp=908657d6bdd62bafdcdd9df6fef3c90587506eb7;hpb=54440ebeed80d95185531c4725bd80e3bed161e5;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_container_lib.h b/src/include/gnunet_container_lib.h index 908657d6b..75443b6ae 100644 --- a/src/include/gnunet_container_lib.h +++ b/src/include/gnunet_container_lib.h @@ -62,8 +62,7 @@ struct GNUNET_CONTAINER_BloomFilter; * @return GNUNET_YES if next was updated * GNUNET_NO if there are no more entries */ -typedef int (*GNUNET_HashCodeIterator) (void *cls, - GNUNET_HashCode * next); +typedef int (*GNUNET_HashCodeIterator) (void *cls, GNUNET_HashCode * next); /** @@ -77,14 +76,8 @@ typedef int (*GNUNET_HashCodeIterator) (void *cls, * @return the bloomfilter */ struct GNUNET_CONTAINER_BloomFilter * -GNUNET_CONTAINER_bloomfilter_load (const - char - *filename, - size_t - size, - unsigned - int - k); +GNUNET_CONTAINER_bloomfilter_load (const char *filename, size_t size, + unsigned int k); /** @@ -101,14 +94,8 @@ GNUNET_CONTAINER_bloomfilter_load (const * @return the bloomfilter */ struct GNUNET_CONTAINER_BloomFilter * -GNUNET_CONTAINER_bloomfilter_init (const - char - *data, - size_t - size, - unsigned - int - k); +GNUNET_CONTAINER_bloomfilter_init (const char *data, size_t size, + unsigned int k); /** @@ -119,10 +106,10 @@ 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); /** @@ -131,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); /** @@ -140,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); /** @@ -149,18 +138,20 @@ 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); /** - * Free the space associcated with a filter - * in memory, flush to drive if needed (do not - * free the space on the drive) + * Create a copy of a bloomfilter. + * * @param bf the filter + * @return copy of bf */ struct GNUNET_CONTAINER_BloomFilter * -GNUNET_CONTAINER_bloomfilter_copy (const struct GNUNET_CONTAINER_BloomFilter *bf); +GNUNET_CONTAINER_bloomfilter_copy (const struct GNUNET_CONTAINER_BloomFilter + *bf); @@ -170,8 +161,8 @@ GNUNET_CONTAINER_bloomfilter_copy (const struct GNUNET_CONTAINER_BloomFilter *bf * 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); /** @@ -180,17 +171,17 @@ void GNUNET_CONTAINER_bloomfilter_free (struct GNUNET_CONTAINER_BloomFilter * @param bf the filter * @return number of bytes used for the data of the bloom filter */ -size_t +size_t GNUNET_CONTAINER_bloomfilter_get_size (const struct GNUNET_CONTAINER_BloomFilter - *bf); + *bf); /** * 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 @@ -203,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 @@ -218,8 +210,8 @@ int GNUNET_CONTAINER_bloomfilter_or (struct GNUNET_CONTAINER_BloomFilter *bf, */ int GNUNET_CONTAINER_bloomfilter_or2 (struct GNUNET_CONTAINER_BloomFilter *bf, - const struct GNUNET_CONTAINER_BloomFilter *to_or, - size_t size); + const struct GNUNET_CONTAINER_BloomFilter + *to_or, size_t size); /** * Resize a bloom filter. Note that this operation @@ -232,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 ******************* */ @@ -247,7 +239,7 @@ struct GNUNET_CONTAINER_MetaData; /** * Create a fresh MetaData token. - * + * * @return empty meta-data container */ struct GNUNET_CONTAINER_MetaData * @@ -255,20 +247,20 @@ 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); +GNUNET_CONTAINER_meta_data_duplicate (const struct GNUNET_CONTAINER_MetaData + *md); /** * Free meta data. * * @param md what to free */ -void +void GNUNET_CONTAINER_meta_data_destroy (struct GNUNET_CONTAINER_MetaData *md); /** @@ -281,11 +273,11 @@ GNUNET_CONTAINER_meta_data_destroy (struct GNUNET_CONTAINER_MetaData *md); * @param md2 other value to check * @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); +int +GNUNET_CONTAINER_meta_data_test_equal (const struct GNUNET_CONTAINER_MetaData + *md1, + const struct GNUNET_CONTAINER_MetaData + *md2); /** @@ -297,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 @@ -305,14 +297,13 @@ GNUNET_CONTAINER_meta_data_test_equal (const struct * @return GNUNET_OK on success, GNUNET_SYSERR if this entry already exists * data_mime_type and plugin_name are not considered for "exists" checks */ -int +int 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 *plugin_name, + enum EXTRACTOR_MetaType type, + enum EXTRACTOR_MetaFormat format, + const char *data_mime_type, const char *data, + size_t data_len); /** @@ -322,9 +313,9 @@ GNUNET_CONTAINER_meta_data_insert (struct GNUNET_CONTAINER_MetaData *md, * @param md metadata to extend * @param in metadata to merge */ -void +void GNUNET_CONTAINER_meta_data_merge (struct GNUNET_CONTAINER_MetaData *md, - const struct GNUNET_CONTAINER_MetaData *in); + const struct GNUNET_CONTAINER_MetaData *in); /** @@ -337,11 +328,10 @@ GNUNET_CONTAINER_meta_data_merge (struct GNUNET_CONTAINER_MetaData *md, * @param data_len number of bytes in data * @return GNUNET_OK on success, GNUNET_SYSERR if the item does not exist in md */ -int +int GNUNET_CONTAINER_meta_data_delete (struct GNUNET_CONTAINER_MetaData *md, - enum EXTRACTOR_MetaType type, - const char *data, - size_t data_len); + enum EXTRACTOR_MetaType type, + const char *data, size_t data_len); /** @@ -349,7 +339,7 @@ GNUNET_CONTAINER_meta_data_delete (struct GNUNET_CONTAINER_MetaData *md, * * @param md metadata to manipulate */ -void +void GNUNET_CONTAINER_meta_data_clear (struct GNUNET_CONTAINER_MetaData *md); @@ -359,10 +349,9 @@ GNUNET_CONTAINER_meta_data_clear (struct GNUNET_CONTAINER_MetaData *md); * * @param md metadata to modify */ -void +void GNUNET_CONTAINER_meta_data_add_publication_date (struct - GNUNET_CONTAINER_MetaData - *md); + GNUNET_CONTAINER_MetaData *md); /** @@ -373,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 @@ -389,9 +378,8 @@ int GNUNET_CONTAINER_meta_data_iterate (const struct * @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); +GNUNET_CONTAINER_meta_data_get_by_type (const struct GNUNET_CONTAINER_MetaData + *md, enum EXTRACTOR_MetaType type); /** @@ -407,8 +395,8 @@ GNUNET_CONTAINER_meta_data_get_by_type (const struct */ char * GNUNET_CONTAINER_meta_data_get_first_by_types (const struct - GNUNET_CONTAINER_MetaData - *md, ...); + GNUNET_CONTAINER_MetaData *md, + ...); /** * Get a thumbnail from the meta-data (if present). Only matches meta @@ -419,10 +407,9 @@ GNUNET_CONTAINER_meta_data_get_first_by_types (const struct * freed by the caller! * @return number of bytes in thumbnail, 0 if not available */ -size_t -GNUNET_CONTAINER_meta_data_get_thumbnail (const struct - GNUNET_CONTAINER_MetaData - *md, unsigned char **thumb); +size_t +GNUNET_CONTAINER_meta_data_get_thumbnail (const struct GNUNET_CONTAINER_MetaData + *md, unsigned char **thumb); @@ -463,14 +450,12 @@ enum GNUNET_CONTAINER_MetaDataSerializationOptions * -1 on error (typically: not enough * space) */ -ssize_t -GNUNET_CONTAINER_meta_data_serialize (const struct - GNUNET_CONTAINER_MetaData *md, - char **target, - size_t max, - enum - GNUNET_CONTAINER_MetaDataSerializationOptions - opt); +ssize_t +GNUNET_CONTAINER_meta_data_serialize (const struct GNUNET_CONTAINER_MetaData + *md, char **target, size_t max, + enum + GNUNET_CONTAINER_MetaDataSerializationOptions + opt); /** @@ -479,10 +464,9 @@ GNUNET_CONTAINER_meta_data_serialize (const struct * @param md metadata to inspect * @return number of bytes needed for serialization, -1 on error */ -ssize_t +ssize_t GNUNET_CONTAINER_meta_data_get_serialized_size (const struct - GNUNET_CONTAINER_MetaData - *md); + GNUNET_CONTAINER_MetaData *md); /** @@ -494,8 +478,7 @@ GNUNET_CONTAINER_meta_data_get_serialized_size (const struct * bad format) */ struct GNUNET_CONTAINER_MetaData * -GNUNET_CONTAINER_meta_data_deserialize (const char *input, - size_t size); +GNUNET_CONTAINER_meta_data_deserialize (const char *input, size_t size); /* ******************************* HashMap **************************** */ @@ -560,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); /** @@ -570,9 +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); /** @@ -585,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); /** @@ -601,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. @@ -613,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); /** @@ -628,10 +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); /** @@ -644,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); /** @@ -663,12 +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. @@ -676,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); /** @@ -690,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); /** @@ -706,15 +688,16 @@ 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 *************** */ +/* To avoid mistakes: head->prev == tail->next == NULL */ /** * Insert an element at the head of a DLL. Assumes that head, tail and @@ -895,7 +878,8 @@ GNUNET_CONTAINER_heap_create (enum GNUNET_CONTAINER_HeapOrder order); * * @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); /** @@ -918,6 +902,16 @@ unsigned int GNUNET_CONTAINER_heap_get_size (const struct GNUNET_CONTAINER_Heap *heap); +/** + * Get the current cost of the node + * + * @param node the node to get the cost of + * @return cost of the node + */ +GNUNET_CONTAINER_HeapCostType +GNUNET_CONTAINER_heap_node_get_cost (const struct GNUNET_CONTAINER_HeapNode + *node); + /** * Iterator for heap * @@ -929,9 +923,10 @@ GNUNET_CONTAINER_heap_get_size (const struct GNUNET_CONTAINER_Heap *heap); * GNUNET_NO if not. */ typedef int (*GNUNET_CONTAINER_HeapIterator) (void *cls, - struct GNUNET_CONTAINER_HeapNode *node, - void *element, - GNUNET_CONTAINER_HeapCostType cost); + struct GNUNET_CONTAINER_HeapNode * + node, void *element, + GNUNET_CONTAINER_HeapCostType + cost); /** @@ -943,8 +938,8 @@ typedef int (*GNUNET_CONTAINER_HeapIterator) (void *cls, */ void GNUNET_CONTAINER_heap_iterate (const struct GNUNET_CONTAINER_Heap *heap, - GNUNET_CONTAINER_HeapIterator iterator, - void *iterator_cls); + GNUNET_CONTAINER_HeapIterator iterator, + void *iterator_cls); /** @@ -960,8 +955,8 @@ GNUNET_CONTAINER_heap_iterate (const struct GNUNET_CONTAINER_Heap *heap, * */ void * -GNUNET_CONTAINER_heap_get_random (struct GNUNET_CONTAINER_Heap *heap, - uint32_t max); +GNUNET_CONTAINER_heap_get_random (struct GNUNET_CONTAINER_Heap *heap, + uint32_t max); /** @@ -988,9 +983,8 @@ GNUNET_CONTAINER_heap_walk_get_next (struct GNUNET_CONTAINER_Heap *heap); * @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); +GNUNET_CONTAINER_heap_insert (struct GNUNET_CONTAINER_Heap *heap, void *element, + GNUNET_CONTAINER_HeapCostType cost); /** @@ -1005,14 +999,12 @@ GNUNET_CONTAINER_heap_remove_root (struct GNUNET_CONTAINER_Heap *heap); /** * Removes a node from the heap. - * - * @param heap heap to modify + * * @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_Heap *heap, - struct GNUNET_CONTAINER_HeapNode *node); +GNUNET_CONTAINER_heap_remove_node (struct GNUNET_CONTAINER_HeapNode *node); /** @@ -1024,8 +1016,8 @@ GNUNET_CONTAINER_heap_remove_node (struct GNUNET_CONTAINER_Heap *heap, */ void GNUNET_CONTAINER_heap_update_cost (struct GNUNET_CONTAINER_Heap *heap, - struct GNUNET_CONTAINER_HeapNode *node, - GNUNET_CONTAINER_HeapCostType new_cost); + struct GNUNET_CONTAINER_HeapNode *node, + GNUNET_CONTAINER_HeapCostType new_cost); /* ******************** Singly linked list *************** */ @@ -1033,36 +1025,53 @@ GNUNET_CONTAINER_heap_update_cost (struct GNUNET_CONTAINER_Heap *heap, /** * Possible ways for how data stored in the linked list * might be allocated. - */ + */ enum GNUNET_CONTAINER_SListDisposition - { +{ /** * Single-linked list must copy the buffer. */ - GNUNET_CONTAINER_SLIST_DISPOSITION_TRANSIENT = 0, + GNUNET_CONTAINER_SLIST_DISPOSITION_TRANSIENT = 0, /** * Data is static, no need to copy or free. */ - GNUNET_CONTAINER_SLIST_DISPOSITION_STATIC = 2, + GNUNET_CONTAINER_SLIST_DISPOSITION_STATIC = 2, /** * Data is dynamic, do not copy but free when done. */ - GNUNET_CONTAINER_SLIST_DISPOSITION_DYNAMIC = 4 - }; + GNUNET_CONTAINER_SLIST_DISPOSITION_DYNAMIC = 4 +}; /** - * 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; +}; + /** @@ -1072,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); /** @@ -1084,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); /** @@ -1095,31 +1106,36 @@ void GNUNET_CONTAINER_slist_add_end (struct GNUNET_CONTAINER_SList *l, * @param src source */ void -GNUNET_CONTAINER_slist_append (struct GNUNET_CONTAINER_SList *dst, struct GNUNET_CONTAINER_SList *src); +GNUNET_CONTAINER_slist_append (struct GNUNET_CONTAINER_SList *dst, + struct GNUNET_CONTAINER_SList *src); /** * 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); /** @@ -1127,7 +1143,8 @@ GNUNET_CONTAINER_slist_begin(struct GNUNET_CONTAINER_SList *l); * * @param l list */ -void GNUNET_CONTAINER_slist_clear (struct GNUNET_CONTAINER_SList *l); +void +GNUNET_CONTAINER_slist_clear (struct GNUNET_CONTAINER_SList *l); /** @@ -1136,7 +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); /** @@ -1144,14 +1163,16 @@ int GNUNET_CONTAINER_slist_contains (const struct GNUNET_CONTAINER_SList *l, con * @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); /** @@ -1161,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); /** @@ -1172,7 +1193,8 @@ void GNUNET_CONTAINER_slist_insert (struct GNUNET_CONTAINER_SList_Iterator *befo * @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); /** @@ -1181,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); /** @@ -1191,16 +1214,17 @@ int GNUNET_CONTAINER_slist_end (struct GNUNET_CONTAINER_SList_Iterator *i); * @param len set to the payload length * @return payload */ -const 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 */