| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971 |
- /*
- * Copyright (c) 2007,2008 Mij <mij@bitchx.it>
- *
- * Permission to use, copy, modify, and distribute this software for any
- * purpose with or without fee is hereby granted, provided that the above
- * copyright notice and this permission notice appear in all copies.
- *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
- * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
- * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
- * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
- * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
- * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
- * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
- */
- /*
- * SimCList library. See http://mij.oltrelinux.com/devel/simclist
- */
- #ifndef SIMCLIST_H
- #define SIMCLIST_H
- #ifdef __cplusplus
- extern "C" {
- #endif
- #include <inttypes.h>
- #include <errno.h>
- #include <sys/types.h>
- /* Be friend of both C90 and C99 compilers */
- #if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L
- /* "inline" and "restrict" are keywords */
- #else
- # define inline /* inline */
- # define restrict /* restrict */
- #endif
- /**
- * Type representing list hashes.
- *
- * This is a signed integer value.
- */
- typedef int32_t list_hash_t;
- #ifndef SIMCLIST_NO_DUMPRESTORE
- typedef struct {
- uint16_t version; /* dump version */
- int64_t timestamp; /* when the list has been dumped, microseconds from UNIX epoch */
- uint32_t list_size;
- uint32_t list_numels;
- list_hash_t list_hash; /* hash of the list when dumped, or 0 if invalid */
- uint32_t dumpsize;
- int consistent; /* 1 if the dump is verified complete/consistent; 0 otherwise */
- } list_dump_info_t;
- #endif
- /**
- * a comparator of elements.
- *
- * A comparator of elements is a function that:
- * -# receives two references to elements a and b
- * -# returns {<0, 0, >0} if (a > b), (a == b), (a < b) respectively
- *
- * It is responsability of the function to handle possible NULL values.
- */
- typedef int (*element_comparator)(const void *a, const void *b);
- /**
- * a seeker of elements.
- *
- * An element seeker is a function that:
- * -# receives a reference to an element el
- * -# receives a reference to some indicator data
- * -# returns non-0 if the element matches the indicator, 0 otherwise
- *
- * It is responsability of the function to handle possible NULL values in any
- * argument.
- */
- typedef int (*element_seeker)(const void *el, const void *indicator);
- /**
- * an element lenght meter.
- *
- * An element meter is a function that:
- * -# receives the reference to an element el
- * -# returns its size in bytes
- *
- * It is responsability of the function to handle possible NULL values.
- */
- typedef size_t (*element_meter)(const void *el);
- /**
- * a function computing the hash of elements.
- *
- * An hash computing function is a function that:
- * -# receives the reference to an element el
- * -# returns a hash value for el
- *
- * It is responsability of the function to handle possible NULL values.
- */
- typedef list_hash_t (*element_hash_computer)(const void *el);
- /**
- * a function for serializing an element.
- *
- * A serializer function is one that gets a reference to an element,
- * and returns a reference to a buffer that contains its serialization
- * along with the length of this buffer.
- * It is responsability of the function to handle possible NULL values,
- * returning a NULL buffer and a 0 buffer length.
- *
- * These functions have 3 goals:
- * -# "freeze" and "flatten" the memory representation of the element
- * -# provide a portable (wrt byte order, or type size) representation of the element, if the dump can be used on different sw/hw combinations
- * -# possibly extract a compressed representation of the element
- *
- * @param el reference to the element data
- * @param serialize_buffer reference to fill with the length of the buffer
- * @return reference to the buffer with the serialized data
- */
- typedef void *(*element_serializer)(const void *restrict el, uint32_t *restrict serializ_len);
- /**
- * a function for un-serializing an element.
- *
- * An unserializer function accomplishes the inverse operation of the
- * serializer function. An unserializer function is one that gets a
- * serialized representation of an element and turns it backe to the original
- * element. The serialized representation is passed as a reference to a buffer
- * with its data, and the function allocates and returns the buffer containing
- * the original element, and it sets the length of this buffer into the
- * integer passed by reference.
- *
- * @param data reference to the buffer with the serialized representation of the element
- * @param data_len reference to the location where to store the length of the data in the buffer returned
- * @return reference to a buffer with the original, unserialized representation of the element
- */
- typedef void *(*element_unserializer)(const void *restrict data, uint32_t *restrict data_len);
- /* [private-use] list entry -- olds actual user datum */
- struct list_entry_s {
- void *data;
- /* doubly-linked list service references */
- struct list_entry_s *next;
- struct list_entry_s *prev;
- };
- /* [private-use] list attributes */
- struct list_attributes_s {
- /* user-set routine for comparing list elements */
- element_comparator comparator;
- /* user-set routing for seeking elements */
- element_seeker seeker;
- /* user-set routine for determining the length of an element */
- element_meter meter;
- int copy_data;
- /* user-set routine for computing the hash of an element */
- element_hash_computer hasher;
- /* user-set routine for serializing an element */
- element_serializer serializer;
- /* user-set routine for unserializing an element */
- element_unserializer unserializer;
- };
- /** list object */
- typedef struct {
- struct list_entry_s *head_sentinel;
- struct list_entry_s *tail_sentinel;
- struct list_entry_s *mid;
- unsigned int numels;
- /* array of spare elements */
- struct list_entry_s **spareels;
- unsigned int spareelsnum;
- #ifdef SIMCLIST_WITH_THREADS
- /* how many threads are currently running */
- unsigned int threadcount;
- #endif
- /* service variables for list iteration */
- int iter_active;
- unsigned int iter_pos;
- struct list_entry_s *iter_curentry;
- /* list attributes */
- struct list_attributes_s attrs;
- } list_t;
- /**
- * initialize a list object for use.
- *
- * @param l must point to a user-provided memory location
- * @return 0 for success. -1 for failure
- */
- int list_init(list_t *restrict l);
- /**
- * completely remove the list from memory.
- *
- * This function is the inverse of list_init(). It is meant to be called when
- * the list is no longer going to be used. Elements and possible memory taken
- * for internal use are freed.
- *
- * @param l list to destroy
- */
- void list_destroy(list_t *restrict l);
- /**
- * set the comparator function for list elements.
- *
- * Comparator functions are used for searching and sorting. If NULL is passed
- * as reference to the function, the comparator is disabled.
- *
- * @param l list to operate
- * @param comparator_fun pointer to the actual comparator function
- * @return 0 if the attribute was successfully set; -1 otherwise
- *
- * @see element_comparator()
- */
- int list_attributes_comparator(list_t *restrict l, element_comparator comparator_fun);
- /**
- * set a seeker function for list elements.
- *
- * Seeker functions are used for finding elements. If NULL is passed as reference
- * to the function, the seeker is disabled.
- *
- * @param l list to operate
- * @param seeker_fun pointer to the actual seeker function
- * @return 0 if the attribute was successfully set; -1 otherwise
- *
- * @see element_seeker()
- */
- int list_attributes_seeker(list_t *restrict l, element_seeker seeker_fun);
- /**
- * require to free element data when list entry is removed (default: don't free).
- *
- * [ advanced preference ]
- *
- * By default, when an element is removed from the list, it disappears from
- * the list by its actual data is not free()d. With this option, every
- * deletion causes element data to be freed.
- *
- * It is responsability of this function to correctly handle NULL values, if
- * NULL elements are inserted into the list.
- *
- * @param l list to operate
- * @param metric_fun pointer to the actual metric function
- * @param copy_data 0: do not free element data (default); non-0: do free
- * @return 0 if the attribute was successfully set; -1 otherwise
- *
- * @see element_meter()
- * @see list_meter_int8_t()
- * @see list_meter_int16_t()
- * @see list_meter_int32_t()
- * @see list_meter_int64_t()
- * @see list_meter_uint8_t()
- * @see list_meter_uint16_t()
- * @see list_meter_uint32_t()
- * @see list_meter_uint64_t()
- * @see list_meter_float()
- * @see list_meter_double()
- * @see list_meter_string()
- */
- int list_attributes_copy(list_t *restrict l, element_meter metric_fun, int copy_data);
- /**
- * set the element hash computing function for the list elements.
- *
- * [ advanced preference ]
- *
- * An hash can be requested depicting the list status at a given time. An hash
- * only depends on the elements and their order. By default, the hash of an
- * element is only computed on its reference. With this function, the user can
- * set a custom function computing the hash of an element. If such function is
- * provided, the list_hash() function automatically computes the list hash using
- * the custom function instead of simply referring to element references.
- *
- * @param l list to operate
- * @param hash_computer_fun pointer to the actual hash computing function
- * @return 0 if the attribute was successfully set; -1 otherwise
- *
- * @see element_hash_computer()
- */
- int list_attributes_hash_computer(list_t *restrict l, element_hash_computer hash_computer_fun);
- /**
- * set the element serializer function for the list elements.
- *
- * [ advanced preference ]
- *
- * Serialize functions are used for dumping the list to some persistent
- * storage. The serializer function is called for each element; it is passed
- * a reference to the element and a reference to a size_t object. It will
- * provide (and return) the buffer with the serialization of the element and
- * fill the size_t object with the length of this serialization data.
- *
- * @param l list to operate
- * @param serializer_fun pointer to the actual serializer function
- * @return 0 if the attribute was successfully set; -1 otherwise
- *
- * @see element_serializer()
- * @see list_dump_filedescriptor()
- * @see list_restore_filedescriptor()
- */
- int list_attributes_serializer(list_t *restrict l, element_serializer serializer_fun);
- /**
- * set the element unserializer function for the list elements.
- *
- * [ advanced preference ]
- *
- * Unserialize functions are used for restoring the list from some persistent
- * storage. The unserializer function is called for each element segment read
- * from the storage; it is passed the segment and a reference to an integer.
- * It shall allocate and return a buffer compiled with the resumed memory
- * representation of the element, and set the integer value to the length of
- * this buffer.
- *
- * @param l list to operate
- * @param unserializer_fun pointer to the actual unserializer function
- * @return 0 if the attribute was successfully set; -1 otherwise
- *
- * @see element_unserializer()
- * @see list_dump_filedescriptor()
- * @see list_restore_filedescriptor()
- */
- int list_attributes_unserializer(list_t *restrict l, element_unserializer unserializer_fun);
- /**
- * append data at the end of the list.
- *
- * This function is useful for adding elements with a FIFO/queue policy.
- *
- * @param l list to operate
- * @param data pointer to user data to append
- *
- * @return 1 for success. < 0 for failure
- */
- int list_append(list_t *restrict l, const void *data);
- /**
- * insert data in the head of the list.
- *
- * This function is useful for adding elements with a LIFO/Stack policy.
- *
- * @param l list to operate
- * @param data pointer to user data to append
- *
- * @return 1 for success. < 0 for failure
- */
- int list_prepend(list_t *restrict l, const void *restrict data);
- /**
- * extract the element in the top of the list.
- *
- * This function is for using a list with a FIFO/queue policy.
- *
- * @param l list to operate
- * @return reference to user datum, or NULL on errors
- */
- void *list_fetch(list_t *restrict l);
- /**
- * retrieve an element at a given position.
- *
- * @param l list to operate
- * @param pos [0,size-1] position index of the element wanted
- * @return reference to user datum, or NULL on errors
- */
- void *list_get_at(const list_t *restrict l, unsigned int pos);
- /**
- * return the maximum element of the list.
- *
- * @warning Requires a comparator function to be set for the list.
- *
- * Returns the maximum element with respect to the comparator function output.
- *
- * @see list_attributes_comparator()
- *
- * @param l list to operate
- * @return the reference to the element, or NULL
- */
- void *list_get_max(const list_t *restrict l);
- /**
- * return the minimum element of the list.
- *
- * @warning Requires a comparator function to be set for the list.
- *
- * Returns the minimum element with respect to the comparator function output.
- *
- * @see list_attributes_comparator()
- *
- * @param l list to operate
- * @return the reference to the element, or NULL
- */
- void *list_get_min(const list_t *restrict l);
- /**
- * retrieve and remove from list an element at a given position.
- *
- * @param l list to operate
- * @param pos [0,size-1] position index of the element wanted
- * @return reference to user datum, or NULL on errors
- */
- void *list_extract_at(list_t *restrict l, unsigned int pos);
- /**
- * insert an element at a given position.
- *
- * @param l list to operate
- * @param data reference to data to be inserted
- * @param pos [0,size-1] position index to insert the element at
- * @return positive value on success. Negative on failure
- */
- int list_insert_at(list_t *restrict l, const void *data, unsigned int pos);
- /**
- * expunge the first found given element from the list.
- *
- * Inspects the given list looking for the given element; if the element
- * is found, it is removed. Only the first occurence is removed.
- * If a comparator function was not set, elements are compared by reference.
- * Otherwise, the comparator is used to match the element.
- *
- * @param l list to operate
- * @param data reference of the element to search for
- * @return 0 on success. Negative value on failure
- *
- * @see list_attributes_comparator()
- * @see list_delete_at()
- */
- int list_delete(list_t *restrict l, const void *data);
- /**
- * expunge an element at a given position from the list.
- *
- * @param l list to operate
- * @param pos [0,size-1] position index of the element to be deleted
- * @return 0 on success. Negative value on failure
- */
- int list_delete_at(list_t *restrict l, unsigned int pos);
- /**
- * expunge an array of elements from the list, given their position range.
- *
- * @param l list to operate
- * @param posstart [0,size-1] position index of the first element to be deleted
- * @param posend [posstart,size-1] position of the last element to be deleted
- * @return the number of elements successfully removed
- */
- int list_delete_range(list_t *restrict l, unsigned int posstart, unsigned int posend);
- /**
- * clear all the elements off of the list.
- *
- * The element datums will not be freed.
- *
- * @see list_delete_range()
- * @see list_size()
- *
- * @param l list to operate
- * @return the number of elements in the list before cleaning
- */
- int list_clear(list_t *restrict l);
- /**
- * inspect the number of elements in the list.
- *
- * @param l list to operate
- * @return number of elements currently held by the list
- */
- unsigned int list_size(const list_t *restrict l);
- /**
- * inspect whether the list is empty.
- *
- * @param l list to operate
- * @return 0 iff the list is not empty
- *
- * @see list_size()
- */
- int list_empty(const list_t *restrict l);
- /**
- * find the position of an element in a list.
- *
- * @warning Requires a comparator function to be set for the list.
- *
- * Inspects the given list looking for the given element; if the element
- * is found, its position into the list is returned.
- * Elements are inspected comparing references if a comparator has not been
- * set. Otherwise, the comparator is used to find the element.
- *
- * @param l list to operate
- * @param data reference of the element to search for
- * @return position of element in the list, or <0 if not found
- *
- * @see list_attributes_comparator()
- * @see list_get_at()
- */
- int list_locate(const list_t *restrict l, const void *data);
- /**
- * returns an element given an indicator.
- *
- * @warning Requires a seeker function to be set for the list.
- *
- * Inspect the given list looking with the seeker if an element matches
- * an indicator. If such element is found, the reference to the element
- * is returned.
- *
- * @param l list to operate
- * @param indicator indicator data to pass to the seeker along with elements
- * @return reference to the element accepted by the seeker, or NULL if none found
- */
- void *list_seek(list_t *restrict l, const void *indicator);
- /**
- * inspect whether some data is member of the list.
- *
- * @warning Requires a comparator function to be set for the list.
- *
- * By default, a per-reference comparison is accomplished. That is,
- * the data is in list if any element of the list points to the same
- * location of data.
- * A "semantic" comparison is accomplished, otherwise, if a comparator
- * function has been set previously, with list_attributes_comparator();
- * in which case, the given data reference is believed to be in list iff
- * comparator_fun(elementdata, userdata) == 0 for any element in the list.
- *
- * @param l list to operate
- * @param data reference to the data to search
- * @return 0 iff the list does not contain data as an element
- *
- * @see list_attributes_comparator()
- */
- int list_contains(const list_t *restrict l, const void *data);
- /**
- * concatenate two lists
- *
- * Concatenates one list with another, and stores the result into a
- * user-provided list object, which must be different from both the
- * lists to concatenate. Attributes from the original lists are not
- * cloned.
- * The destination list referred is threated as virgin room: if it
- * is an existing list containing elements, memory leaks will happen.
- * It is OK to specify the same list twice as source, for "doubling"
- * it in the destination.
- *
- * @param l1 base list
- * @param l2 list to append to the base
- * @param dest reference to the destination list
- * @return 0 for success, -1 for errors
- */
- int list_concat(const list_t *l1, const list_t *l2, list_t *restrict dest);
- /**
- * sort list elements.
- *
- * @warning Requires a comparator function to be set for the list.
- *
- * Sorts the list in ascending or descending order as specified by the versus
- * flag. The algorithm chooses autonomously what algorithm is best suited for
- * sorting the list wrt its current status.
- *
- * @param l list to operate
- * @param versus positive: order small to big; negative: order big to small
- * @return 0: sorting went OK non-0: errors happened
- *
- * @see list_attributes_comparator()
- */
- int list_sort(list_t *restrict l, int versus);
- /**
- * start an iteration session.
- *
- * This function prepares the list to be iterated.
- *
- * @param l list to operate
- * @return 0 if the list cannot be currently iterated. >0 otherwise
- *
- * @see list_iterator_stop()
- */
- int list_iterator_start(list_t *restrict l);
- /**
- * return the next element in the iteration session.
- *
- * @param l list to operate
- * @return element datum, or NULL on errors
- */
- void *list_iterator_next(list_t *restrict l);
- /**
- * inspect whether more elements are available in the iteration session.
- *
- * @param l list to operate
- * @return 0 iff no more elements are available.
- */
- int list_iterator_hasnext(const list_t *restrict l);
- /**
- * end an iteration session.
- *
- * @param l list to operate
- * @return 0 iff the iteration session cannot be stopped
- */
- int list_iterator_stop(list_t *restrict l);
- /**
- * return the hash of the current status of the list.
- *
- * @param l list to operate
- * @param hash where the resulting hash is put
- *
- * @return 0 for success; <0 for failure
- */
- int list_hash(const list_t *restrict l, list_hash_t *restrict hash);
- #ifndef SIMCLIST_NO_DUMPRESTORE
- /**
- * get meta informations on a list dump on filedescriptor.
- *
- * [ advanced function ]
- *
- * Extracts the meta information from a SimCList dump located in a file
- * descriptor. The file descriptor must be open and positioned at the
- * beginning of the SimCList dump block.
- *
- * @param fd file descriptor to get metadata from
- * @param info reference to a dump metainformation structure to fill
- * @return 0 for success; <0 for failure
- *
- * @see list_dump_filedescriptor()
- */
- int list_dump_getinfo_filedescriptor(int fd, list_dump_info_t *restrict info);
- /**
- * get meta informations on a list dump on file.
- *
- * [ advanced function ]
- *
- * Extracts the meta information from a SimCList dump located in a file.
- *
- * @param filename filename of the file to fetch from
- * @param info reference to a dump metainformation structure to fill
- * @return 0 for success; <0 for failure
- *
- * @see list_dump_filedescriptor()
- */
- int list_dump_getinfo_file(const char *restrict filename, list_dump_info_t *restrict info);
- /**
- * dump the list into an open, writable file descriptor.
- *
- * This function "dumps" the list to a persistent storage so it can be
- * preserved across process terminations.
- * When called, the file descriptor must be open for writing and positioned
- * where the serialized data must begin. It writes its serialization of the
- * list in a form which is portable across different architectures. Dump can
- * be safely performed on stream-only (non seekable) descriptors. The file
- * descriptor is not closed at the end of the operations.
- *
- * To use dump functions, either of these conditions must be satisfied:
- * -# a metric function has been specified with list_attributes_copy()
- * -# a serializer function has been specified with list_attributes_serializer()
- *
- * If a metric function has been specified, each element of the list is dumped
- * as-is from memory, copying it from its pointer for its length down to the
- * file descriptor. This might have impacts on portability of the dump to
- * different architectures.
- *
- * If a serializer function has been specified, its result for each element is
- * dumped to the file descriptor.
- *
- *
- * @param l list to operate
- * @param fd file descriptor to write to
- * @param len location to store the resulting length of the dump (bytes), or NULL
- *
- * @return 0 if successful; -1 otherwise
- *
- * @see element_serializer()
- * @see list_attributes_copy()
- * @see list_attributes_serializer()
- */
- int list_dump_filedescriptor(const list_t *restrict l, int fd, size_t *restrict len);
- /**
- * dump the list to a file name.
- *
- * This function creates a filename and dumps the current content of the list
- * to it. If the file exists it is overwritten. The number of bytes written to
- * the file can be returned in a specified argument.
- *
- * @param l list to operate
- * @param filename filename to write to
- * @param len location to store the resulting length of the dump (bytes), or NULL
- *
- * @return 0 if successful; -1 otherwise
- *
- * @see list_attributes_copy()
- * @see element_serializer()
- * @see list_attributes_serializer()
- * @see list_dump_filedescriptor()
- * @see list_restore_file()
- *
- * This function stores a representation of the list
- */
- int list_dump_file(const list_t *restrict l, const char *restrict filename, size_t *restrict len);
- /**
- * restore the list from an open, readable file descriptor to memory.
- *
- * This function is the "inverse" of list_dump_filedescriptor(). It restores
- * the list content from a (open, read-ready) file descriptor to memory. An
- * unserializer might be needed to restore elements from the persistent
- * representation back into memory-consistent format. List attributes can not
- * be restored and must be set manually.
- *
- * @see list_dump_filedescriptor()
- * @see list_attributes_serializer()
- * @see list_attributes_unserializer()
- *
- * @param l list to restore to
- * @param fd file descriptor to read from.
- * @param len location to store the length of the dump read (bytes), or NULL
- * @return 0 if successful; -1 otherwise
- */
- int list_restore_filedescriptor(list_t *restrict l, int fd, size_t *restrict len);
- /**
- * restore the list from a file name.
- *
- * This function restores the content of a list from a file into memory. It is
- * the inverse of list_dump_file().
- *
- * @see element_unserializer()
- * @see list_attributes_unserializer()
- * @see list_dump_file()
- * @see list_restore_filedescriptor()
- *
- * @param l list to restore to
- * @param filename filename to read data from
- * @param len location to store the length of the dump read (bytes), or NULL
- * @return 0 if successful; -1 otherwise
- */
- int list_restore_file(list_t *restrict l, const char *restrict filename, size_t *len);
- #endif
- /* ready-made comparators, meters and hash computers */
- /* comparator functions */
- /**
- * ready-made comparator for int8_t elements.
- * @see list_attributes_comparator()
- */
- int list_comparator_int8_t(const void *a, const void *b);
- /**
- * ready-made comparator for int16_t elements.
- * @see list_attributes_comparator()
- */
- int list_comparator_int16_t(const void *a, const void *b);
- /**
- * ready-made comparator for int32_t elements.
- * @see list_attributes_comparator()
- */
- int list_comparator_int32_t(const void *a, const void *b);
- /**
- * ready-made comparator for int64_t elements.
- * @see list_attributes_comparator()
- */
- int list_comparator_int64_t(const void *a, const void *b);
- /**
- * ready-made comparator for uint8_t elements.
- * @see list_attributes_comparator()
- */
- int list_comparator_uint8_t(const void *a, const void *b);
- /**
- * ready-made comparator for uint16_t elements.
- * @see list_attributes_comparator()
- */
- int list_comparator_uint16_t(const void *a, const void *b);
- /**
- * ready-made comparator for uint32_t elements.
- * @see list_attributes_comparator()
- */
- int list_comparator_uint32_t(const void *a, const void *b);
- /**
- * ready-made comparator for uint64_t elements.
- * @see list_attributes_comparator()
- */
- int list_comparator_uint64_t(const void *a, const void *b);
- /**
- * ready-made comparator for float elements.
- * @see list_attributes_comparator()
- */
- int list_comparator_float(const void *a, const void *b);
- /**
- * ready-made comparator for double elements.
- * @see list_attributes_comparator()
- */
- int list_comparator_double(const void *a, const void *b);
- /**
- * ready-made comparator for string elements.
- * @see list_attributes_comparator()
- */
- int list_comparator_string(const void *a, const void *b);
- /* metric functions */
- /**
- * ready-made metric function for int8_t elements.
- * @see list_attributes_copy()
- */
- size_t list_meter_int8_t(const void *el);
- /**
- * ready-made metric function for int16_t elements.
- * @see list_attributes_copy()
- */
- size_t list_meter_int16_t(const void *el);
- /**
- * ready-made metric function for int32_t elements.
- * @see list_attributes_copy()
- */
- size_t list_meter_int32_t(const void *el);
- /**
- * ready-made metric function for int64_t elements.
- * @see list_attributes_copy()
- */
- size_t list_meter_int64_t(const void *el);
- /**
- * ready-made metric function for uint8_t elements.
- * @see list_attributes_copy()
- */
- size_t list_meter_uint8_t(const void *el);
- /**
- * ready-made metric function for uint16_t elements.
- * @see list_attributes_copy()
- */
- size_t list_meter_uint16_t(const void *el);
- /**
- * ready-made metric function for uint32_t elements.
- * @see list_attributes_copy()
- */
- size_t list_meter_uint32_t(const void *el);
- /**
- * ready-made metric function for uint64_t elements.
- * @see list_attributes_copy()
- */
- size_t list_meter_uint64_t(const void *el);
- /**
- * ready-made metric function for float elements.
- * @see list_attributes_copy()
- */
- size_t list_meter_float(const void *el);
- /**
- * ready-made metric function for double elements.
- * @see list_attributes_copy()
- */
- size_t list_meter_double(const void *el);
- /**
- * ready-made metric function for string elements.
- * @see list_attributes_copy()
- */
- size_t list_meter_string(const void *el);
- /* hash functions */
- /**
- * ready-made hash function for int8_t elements.
- * @see list_attributes_hash_computer()
- */
- list_hash_t list_hashcomputer_int8_t(const void *el);
- /**
- * ready-made hash function for int16_t elements.
- * @see list_attributes_hash_computer()
- */
- list_hash_t list_hashcomputer_int16_t(const void *el);
- /**
- * ready-made hash function for int32_t elements.
- * @see list_attributes_hash_computer()
- */
- list_hash_t list_hashcomputer_int32_t(const void *el);
- /**
- * ready-made hash function for int64_t elements.
- * @see list_attributes_hash_computer()
- */
- list_hash_t list_hashcomputer_int64_t(const void *el);
- /**
- * ready-made hash function for uint8_t elements.
- * @see list_attributes_hash_computer()
- */
- list_hash_t list_hashcomputer_uint8_t(const void *el);
- /**
- * ready-made hash function for uint16_t elements.
- * @see list_attributes_hash_computer()
- */
- list_hash_t list_hashcomputer_uint16_t(const void *el);
- /**
- * ready-made hash function for uint32_t elements.
- * @see list_attributes_hash_computer()
- */
- list_hash_t list_hashcomputer_uint32_t(const void *el);
- /**
- * ready-made hash function for uint64_t elements.
- * @see list_attributes_hash_computer()
- */
- list_hash_t list_hashcomputer_uint64_t(const void *el);
- /**
- * ready-made hash function for float elements.
- * @see list_attributes_hash_computer()
- */
- list_hash_t list_hashcomputer_float(const void *el);
- /**
- * ready-made hash function for double elements.
- * @see list_attributes_hash_computer()
- */
- list_hash_t list_hashcomputer_double(const void *el);
- /**
- * ready-made hash function for string elements.
- * @see list_attributes_hash_computer()
- */
- list_hash_t list_hashcomputer_string(const void *el);
- #ifdef __cplusplus
- }
- #endif
- #endif
|