#include "rt.h"
- /** A linked list node. */
- typedef struct list_node_t
- {
- /** Pointer to the contents the node */
- void* contents;
- /** Pointer to next node in the list */
- struct list_node_t* next;
- /** pointer to prev node in the list */
- struct list_node_t* prev;
- } list_node_t;
-
- /** A doubly linked list */
- typedef struct list_t
- {
- /** Pointer to the first element in the list */
- list_node_t* head;
- /** Pointer to the last element in the list */
- list_node_t* tail;
- } list_t;
-
- /**
- * @brief Creates a new empty linked list.
- *
- * @return A pointer to the newly created list.
- **/
- list_t* list_new(void);
-
- /**
- * @brief Creates a new node with given contents.
- *
- * @param contents Pointer to the contents of this node.
- *
- * @return Pointer to newly created node.
- */
- list_node_t* list_new_node(void* contents);
-
- /**
- * @brief Returns pointer to first node in the list
- *
- * @param list The list from which to retrieve elements.
- *
- * @return Pointer to the first element in the list.
- */
- list_node_t* list_front( list_t* list );
-
- /**
- * @brief Returns pointer to the last element in the list.
- *
- * @param The list from which to retrieve elements.
- *
- * @return Pointer to the last element in the list.
- */
- list_node_t* list_back( list_t* list );
-
- /**
- * @brief Returns the number of elements in the list.
- *
- * This function loops through the supplied list and returns a count of the
- * number of elements contained in the list.
- *
- * @param list The list to be counted.
- *
- * @return The number of elements in the list.
- **/
- size_t list_size(list_t* list);
-
- /**
- * @brief Returns whether the list is empty or not.
- *
- * @param list The list to operate on.
- *
- * @return Whether the list is empty, 1 for true and 0 for false.
- */
- bool list_empty(list_t* list);
-
- /** !!this function is unnecessary now that list is doubly linked.
- * @brief Find the node before the given one in the specified list.
- *
- * @param list The list to search thru
- * @param node The node to search for
- *
- * @return Pointer to the node before the given node or
- * NULL if given node is NULL, is the head of list
- */
- list_node_t* list_prev(list_t* list, list_node_t* node);
-
- /**
- * @brief Return the node at the specified index in a linked list.
- *
- * This function loops through the linked list and returns the node in the list
- * at the specified index. Returns NULL if the index is out of range.
- *
- * @param list The list to search for the supplied index.
- * @param index The index of the node to return.
- *
- * @return A pointer to the node at the supplied index, NULL if out of range.
- **/
- list_node_t* list_at(list_t* list, size_t index);
-
- /**
- * @brief Return the index of the specified node in a linked list.
- *
- * This function loops through the linked list and returns the index in the list
- * that matches the specified node. Returns -1 if the node is not found.
- * Note: since NULL is implicitly at the end of every list, calling this
- * with NULL for the node is equivalent to list_size
- *
- * @param list The list to search thru
- * @param node The node to look for
- *
- * @return The int index of the supplied node, -1 if not found.
- **/
- int list_index_of(list_t* list, list_node_t* node);
-
- /**
- * @brief Adds a new node to the front of an existing linked list.
- *
- * This function creates a new node and pushes it to the beginning of the given
- * list. The newly created node becomes the new head of the list.
- *
- * @param list The list to operate on.
- * @param contents The contents of the new node.
- *
- * @return Pointer to the newly added node.
- **/
- list_node_t* list_push_front( list_t* list, void* contents );
-
- /**
- * @brief Adds a new node to the end of an existing linked list.
- *
- * This function creates a new node and pushes it to the end of the given list.
- * The newly created node becomes the new tail of the list.
- *
- * @param list The list to operate on.
- * @param contents The contents of the new node.
- *
- * @return Pointer to the newly added node.
- **/
- list_node_t* list_push_back( list_t* list, void* contents );
-
- /**
- * @brief Removes and returns a pointer to the first element of the list.
- *
- * This function removes the first node from the list and frees it's associated
- * memory.
- *
- * @param list The lsit to operate on.
- *
- * @return Pointer to the newly added node.
- **/
- list_node_t* list_pop_front( list_t* list );
-
- /**
- * @brief Removes and returns a pointer to the last element of the list.
- *
- * This function removes the last node from the list and frees it's associated
- * memory.
- *
- * @param list The list to operate on.
- *
- * @return Pointer to the newly added node.
- **/
- list_node_t* list_pop_back( list_t* list );
-
- /**
- * @brief Inserts a new node in a linked list at the specified index.
- *
- * This function traverses the list to the desired index and inserts a new node
- * with the given contents at that position. The node previously at the desired
- * index becomes the child of the new node.
- *
- * @param list The list to operate on.
- * @param index The index where the new node will be inserted.
- * @param contents The contents of the new node.
- *
- * @return Pointer to the newly inserted node, NULL if index is out of range.
- **/
- list_node_t* list_insert( list_t* list, size_t index, void* contents);
-
- /**
- * @brief Inserts a new node in a linked list after the specified node
- *
- * @param list The list to operate on.
- * @param node The node after which the item should be inserted.
- * if node is NULL, will insert at the beginning of the list
- * @param contents The contents of the new node.
- *
- * @return Pointer to the newly inserted node
- **/
- list_node_t* list_insert_after( list_t* list, list_node_t* node, void* contents);
-
- /**
- * @brief Deletes a node from the supplied list.
- *
- * This function traverses the list to the desired index and frees the memory
- * allocated for that node. If the deleted node has a child then the child is
- * reattached to the deleted node's parent.
- *
- * @param list The list to operate on.
- * @param index The index of the node to delete.
- **/
- void list_delete(list_t* list, size_t index);
-
- /**
- * @brief Delete a node from the supplied list.
- *
- * This function differs from the above list_delete in that it is given a
- * pointer to a node to be deleted instead of an index.
- *
- * @param list The list to operate on.
- * @param node A pointer to the node to delete.
- */
- void list_delete_node(list_t* list, list_node_t* node);
-
- /**
- * @brief Deletes all elements in the provided list
- *
- * @param list The list to be cleared
- */
- void list_clear(list_t* list);
+/** A linked list node. */
+typedef struct list_node_t
+{
+ /** Pointer to the contents the node */
+ void* contents;
+ /** Pointer to next node in the list */
+ struct list_node_t* next;
+ /** pointer to prev node in the list */
+ struct list_node_t* prev;
+} list_node_t;
+
+/** A doubly linked list */
+typedef struct list_t
+{
+ /** Pointer to the first element in the list */
+ list_node_t* head;
+ /** Pointer to the last element in the list */
+ list_node_t* tail;
+} list_t;
+
+/**
+ * @brief Creates a new empty linked list.
+ *
+ * @return A pointer to the newly created list.
+ **/
+list_t* list_new(void);
+
+/**
+ * @brief Creates a new node with given contents.
+ *
+ * @param contents Pointer to the contents of this node.
+ *
+ * @return Pointer to newly created node.
+ */
+list_node_t* list_new_node(void* contents);
+
+/**
+ * @brief Returns pointer to first node in the list
+ *
+ * @param list The list from which to retrieve elements.
+ *
+ * @return Pointer to the first element in the list.
+ */
+list_node_t* list_front( list_t* list );
+
+/**
+ * @brief Returns pointer to the last element in the list.
+ *
+ * @param The list from which to retrieve elements.
+ *
+ * @return Pointer to the last element in the list.
+ */
+list_node_t* list_back( list_t* list );
+
+/**
+ * @brief Returns the number of elements in the list.
+ *
+ * This function loops through the supplied list and returns a count of the
+ * number of elements contained in the list.
+ *
+ * @param list The list to be counted.
+ *
+ * @return The number of elements in the list.
+ **/
+size_t list_size(list_t* list);
+
+/**
+ * @brief Returns whether the list is empty or not.
+ *
+ * @param list The list to operate on.
+ *
+ * @return Whether the list is empty, 1 for true and 0 for false.
+ */
+bool list_empty(list_t* list);
+
+/** !!this function is unnecessary now that list is doubly linked.
+ * @brief Find the node before the given one in the specified list.
+ *
+ * @param list The list to search thru
+ * @param node The node to search for
+ *
+ * @return Pointer to the node before the given node or
+ * NULL if given node is NULL, is the head of list
+ */
+list_node_t* list_prev(list_t* list, list_node_t* node);
+
+/**
+ * @brief Return the node at the specified index in a linked list.
+ *
+ * This function loops through the linked list and returns the node in the list
+ * at the specified index. Returns NULL if the index is out of range.
+ *
+ * @param list The list to search for the supplied index.
+ * @param index The index of the node to return.
+ *
+ * @return A pointer to the node at the supplied index, NULL if out of range.
+ **/
+list_node_t* list_at(list_t* list, size_t index);
+
+/**
+ * @brief Return the index of the specified node in a linked list.
+ *
+ * This function loops through the linked list and returns the index in the list
+ * that matches the specified node. Returns -1 if the node is not found.
+ * Note: since NULL is implicitly at the end of every list, calling this
+ * with NULL for the node is equivalent to list_size
+ *
+ * @param list The list to search thru
+ * @param node The node to look for
+ *
+ * @return The int index of the supplied node, -1 if not found.
+ **/
+int list_index_of(list_t* list, list_node_t* node);
+
+/**
+ * @brief Adds a new node to the front of an existing linked list.
+ *
+ * This function creates a new node and pushes it to the beginning of the given
+ * list. The newly created node becomes the new head of the list.
+ *
+ * @param list The list to operate on.
+ * @param contents The contents of the new node.
+ *
+ * @return Pointer to the newly added node.
+ **/
+list_node_t* list_push_front( list_t* list, void* contents );
+
+/**
+ * @brief Adds a new node to the end of an existing linked list.
+ *
+ * This function creates a new node and pushes it to the end of the given list.
+ * The newly created node becomes the new tail of the list.
+ *
+ * @param list The list to operate on.
+ * @param contents The contents of the new node.
+ *
+ * @return Pointer to the newly added node.
+ **/
+list_node_t* list_push_back( list_t* list, void* contents );
+
+/**
+ * @brief Removes and returns a pointer to the first element of the list.
+ *
+ * This function removes the first node from the list and frees it's associated
+ * memory.
+ *
+ * @param list The lsit to operate on.
+ *
+ * @return Pointer to the newly added node.
+ **/
+list_node_t* list_pop_front( list_t* list );
+
+/**
+ * @brief Removes and returns a pointer to the last element of the list.
+ *
+ * This function removes the last node from the list and frees it's associated
+ * memory.
+ *
+ * @param list The list to operate on.
+ *
+ * @return Pointer to the newly added node.
+ **/
+list_node_t* list_pop_back( list_t* list );
+
+/**
+ * @brief Inserts a new node in a linked list at the specified index.
+ *
+ * This function traverses the list to the desired index and inserts a new node
+ * with the given contents at that position. The node previously at the desired
+ * index becomes the child of the new node.
+ *
+ * @param list The list to operate on.
+ * @param index The index where the new node will be inserted.
+ * @param contents The contents of the new node.
+ *
+ * @return Pointer to the newly inserted node, NULL if index is out of range.
+ **/
+list_node_t* list_insert( list_t* list, size_t index, void* contents);
+
+/**
+ * @brief Inserts a new node in a linked list after the specified node
+ *
+ * @param list The list to operate on.
+ * @param node The node after which the item should be inserted.
+ * if node is NULL, will insert at the beginning of the list
+ * @param contents The contents of the new node.
+ *
+ * @return Pointer to the newly inserted node
+ **/
+list_node_t* list_insert_after( list_t* list, list_node_t* node, void* contents);
+
+/**
+ * @brief Deletes a node from the supplied list.
+ *
+ * This function traverses the list to the desired index and frees the memory
+ * allocated for that node. If the deleted node has a child then the child is
+ * reattached to the deleted node's parent.
+ *
+ * @param list The list to operate on.
+ * @param index The index of the node to delete.
+ **/
+void list_delete(list_t* list, size_t index);
+
+/**
+ * @brief Delete a node from the supplied list.
+ *
+ * This function differs from the above list_delete in that it is given a
+ * pointer to a node to be deleted instead of an index.
+ *
+ * @param list The list to operate on.
+ * @param node A pointer to the node to delete.
+ */
+void list_delete_node(list_t* list, list_node_t* node);
+
+/**
+ * @brief Deletes all elements in the provided list
+ *
+ * @param list The list to be cleared
+ */
+void list_clear(list_t* list);
#ifdef __cplusplus
}
projects / projs / libcds.git / commitdiff