ToFu ForwardList (fossil_flist_t) is a singly linked list container for fossil_tofu_t elements. It supports dynamic insertion, removal, element access, and forward/backward reversal. The container provides O(1) operations for inserting/removing at the head, and O(n) operations for indexed access or reversing. It has C and C++ interfaces with full copy/move semantics and convenient getter/setter methods. This makes it ideal for scenarios requiring sequential storage with frequent head insertions and dynamic size management.
Code reference for C and C++ APIs for the respective Fossil Logic library.
HEADER REFERENCE #
#ifndef FOSSIL_TOFU_FORWARDLIST_H
#define FOSSIL_TOFU_FORWARDLIST_H
#include "tofu.h"
#ifdef __cplusplus
extern "C"
{
#endif
// *****************************************************************************
// Type definitions
// *****************************************************************************
// Node structure for the linked list
typedef struct fossil_tofu_flist_node_t {
fossil_tofu_t data;
struct fossil_tofu_flist_node_t* next;
} fossil_tofu_flist_node_t;
// Linked list structure
typedef struct fossil_tofu_flist_t {
fossil_tofu_flist_node_t* head;
char* type;
} fossil_tofu_flist_t;
// *****************************************************************************
// Function prototypes
// *****************************************************************************
/**
* Create a new forward list with the specified data type.
*
* @param list_type The type of data the forward list will store.
* @return The created forward list.
* @complexity O(1)
*/
fossil_tofu_flist_t* fossil_tofu_flist_create_container(char* type);
/**
* Create a new forward list with default values.
*
* Time complexity: O(1)
*
* @return The created forward list.
*/
fossil_tofu_flist_t* fossil_tofu_flist_create_default(void);
/**
* Create a new forward list by copying an existing forward list.
*
* Time complexity: O(n)
*
* @param other The forward list to copy.
* @return The created forward list.
*/
fossil_tofu_flist_t* fossil_tofu_flist_create_copy(const fossil_tofu_flist_t* other);
/**
* Create a new forward list by moving an existing forward list.
*
* Time complexity: O(1)
*
* @param other The forward list to move.
* @return The created forward list.
*/
fossil_tofu_flist_t* fossil_tofu_flist_create_move(fossil_tofu_flist_t* other);
/**
* Erase the contents of the forward list and fossil_tofu_free allocated memory.
*
* @param flist The forward list to erase.
* @complexity O(n)
*/
void fossil_tofu_flist_destroy(fossil_tofu_flist_t* flist);
// *****************************************************************************
// Utility functions
// *****************************************************************************
/**
* Insert data into the forward list.
*
* @param flist The forward list to insert data into.
* @param data The data to insert.
* @return The error code indicating the success or failure of the operation.
* @complexity O(1)
*/
int32_t fossil_tofu_flist_insert(fossil_tofu_flist_t* flist, char *data);
/**
* Remove data from the forward list.
*
* @param flist The forward list to remove data from.
* @return The error code indicating the success or failure of the operation.
* @complexity O(1)
*/
int32_t fossil_tofu_flist_remove(fossil_tofu_flist_t* flist);
/**
* Reverse the forward list in the forward direction.
*
* @param flist The forward list to reverse.
* @complexity O(n)
*/
void fossil_tofu_flist_reverse_forward(fossil_tofu_flist_t* flist);
/**
* Reverse the forward list in the backward direction.
*
* @param flist The forward list to reverse.
* @complexity O(n)
*/
void fossil_tofu_flist_reverse_backward(fossil_tofu_flist_t* flist);
/**
* Get the size of the forward list.
*
* @param flist The forward list for which to get the size.
* @return The size of the forward list.
* @complexity O(n)
*/
size_t fossil_tofu_flist_size(const fossil_tofu_flist_t* flist);
/**
* Check if the forward list is not empty.
*
* @param flist The forward list to check.
* @return True if the forward list is not empty, false otherwise.
* @complexity O(1)
*/
bool fossil_tofu_flist_not_empty(const fossil_tofu_flist_t* flist);
/**
* Check if the forward list is not a null pointer.
*
* @param flist The forward list to check.
* @return True if the forward list is not a null pointer, false otherwise.
* @complexity O(1)
*/
bool fossil_tofu_flist_not_cnullptr(const fossil_tofu_flist_t* flist);
/**
* Check if the forward list is empty.
*
* @param flist The forward list to check.
* @return True if the forward list is empty, false otherwise.
* @complexity O(1)
*/
bool fossil_tofu_flist_is_empty(const fossil_tofu_flist_t* flist);
/**
* Check if the forward list is a null pointer.
*
* @param flist The forward list to check.
* @return True if the forward list is a null pointer, false otherwise.
* @complexity O(1)
*/
bool fossil_tofu_flist_is_cnullptr(const fossil_tofu_flist_t* flist);
// *****************************************************************************
// Getter and setter functions
// *****************************************************************************
/**
* Get the element at the specified index in the forward list.
*
* Time complexity: O(n)
*
* @param flist The forward list from which to get the element.
* @param index The index of the element to get.
* @return The element at the specified index.
*/
char *fossil_tofu_flist_get(const fossil_tofu_flist_t* flist, size_t index);
/**
* Get the first element in the forward list.
*
* Time complexity: O(1)
*
* @param flist The forward list from which to get the first element.
* @return The first element in the forward list.
*/
char *fossil_tofu_flist_get_front(const fossil_tofu_flist_t* flist);
/**
* Get the last element in the forward list.
*
* Time complexity: O(n)
*
* @param flist The forward list from which to get the last element.
* @return The last element in the forward list.
*/
char *fossil_tofu_flist_get_back(const fossil_tofu_flist_t* flist);
/**
* Set the element at the specified index in the forward list.
*
* Time complexity: O(n)
*
* @param flist The forward list in which to set the element.
* @param index The index at which to set the element.
* @param element The element to set.
*/
void fossil_tofu_flist_set(fossil_tofu_flist_t* flist, size_t index, char *element);
/**
* Set the first element in the forward list.
*
* Time complexity: O(1)
*
* @param flist The forward list in which to set the first element.
* @param element The element to set.
*/
void fossil_tofu_flist_set_front(fossil_tofu_flist_t* flist, char *element);
/**
* Set the last element in the forward list.
*
* Time complexity: O(n)
*
* @param flist The forward list in which to set the last element.
* @param element The element to set.
*/
void fossil_tofu_flist_set_back(fossil_tofu_flist_t* flist, char *element);
#ifdef __cplusplus
}
#include <stdexcept>
#include <string>
namespace fossil {
namespace tofu {
/**
* @class FList
* @brief A C++ wrapper for the fossil_tofu_flist_t forward list using std::string.
*/
class FList {
public:
/**
* Constructor to create a forward list with a specified data type.
*
* @param type The type of data the forward list will store.
*/
FList(const std::string& type) {
flist = fossil_tofu_flist_create_container(const_cast<char*>(type.c_str()));
}
/**
* Default constructor to create a forward list with default values.
*/
FList() {
flist = fossil_tofu_flist_create_default();
}
/**
* Copy constructor to create a forward list by copying another forward list.
*
* @param other The forward list to copy.
*/
FList(const FList& other) {
flist = fossil_tofu_flist_create_copy(other.flist);
}
/**
* Move constructor to create a forward list by moving another forward list.
*
* @param other The forward list to move.
*/
FList(FList&& other) noexcept {
flist = fossil_tofu_flist_create_move(other.flist);
other.flist = nullptr;
}
/**
* Destructor to destroy the forward list and free allocated memory.
*/
~FList() {
fossil_tofu_flist_destroy(flist);
}
/**
* Insert data into the forward list.
*
* @param data The data to insert.
*/
void insert(const std::string& data) {
fossil_tofu_flist_insert(flist, const_cast<char*>(data.c_str()));
}
/**
* Remove data from the forward list.
*/
void remove() {
fossil_tofu_flist_remove(flist);
}
/**
* Reverse the forward list in the forward direction.
*/
void reverse_forward() {
fossil_tofu_flist_reverse_forward(flist);
}
/**
* Reverse the forward list in the backward direction.
*/
void reverse_backward() {
fossil_tofu_flist_reverse_backward(flist);
}
/**
* Get the size of the forward list.
*
* @return The size of the forward list.
*/
size_t size() const {
return fossil_tofu_flist_size(flist);
}
/**
* Check if the forward list is not empty.
*
* @return True if the forward list is not empty, false otherwise.
*/
bool not_empty() const {
return fossil_tofu_flist_not_empty(flist);
}
/**
* Check if the forward list is not a null pointer.
*
* @return True if the forward list is not a null pointer, false otherwise.
*/
bool not_cnullptr() const {
return fossil_tofu_flist_not_cnullptr(flist);
}
/**
* Check if the forward list is empty.
*
* @return True if the forward list is empty, false otherwise.
*/
bool is_empty() const {
return fossil_tofu_flist_is_empty(flist);
}
/**
* Check if the forward list is a null pointer.
*
* @return True if the forward list is a null pointer, false otherwise.
*/
bool is_cnullptr() const {
return fossil_tofu_flist_is_cnullptr(flist);
}
/**
* Get the element at the specified index in the forward list.
*
* @param index The index of the element to get.
* @return The element at the specified index as a string.
*/
std::string get(size_t index) const {
return fossil_tofu_flist_get(flist, index);
}
/**
* Get the first element in the forward list.
*
* @return The first element in the forward list as a string.
*/
std::string front() const {
return fossil_tofu_flist_get_front(flist);
}
/**
* Get the last element in the forward list.
*
* @return The last element in the forward list as a string.
*/
std::string back() const {
return fossil_tofu_flist_get_back(flist);
}
/**
* Set the element at the specified index in the forward list.
*
* @param index The index at which to set the element.
* @param value The element to set.
*/
void set(size_t index, const std::string& value) {
fossil_tofu_flist_set(flist, index, const_cast<char*>(value.c_str()));
}
/**
* Set the first element in the forward list.
*
* @param value The element to set.
*/
void set_front(const std::string& value) {
fossil_tofu_flist_set_front(flist, const_cast<char*>(value.c_str()));
}
/**
* Set the last element in the forward list.
*
* @param value The element to set.
*/
void set_back(const std::string& value) {
fossil_tofu_flist_set_back(flist, const_cast<char*>(value.c_str()));
}
std::string get_front() const {
const char* front = fossil_tofu_flist_get_front(flist);
return front ? std::string(front) : "";
}
std::string get_back() const {
const char* back = fossil_tofu_flist_get_back(flist);
return back ? std::string(back) : "";
}
/**
* Copy assignment operator.
*/
FList& operator=(const FList& other) {
if (this != &other) {
fossil_tofu_flist_destroy(flist);
flist = fossil_tofu_flist_create_copy(other.flist);
}
return *this;
}
/**
* Move assignment operator.
*/
FList& operator=(FList&& other) noexcept {
if (this != &other) {
fossil_tofu_flist_destroy(flist);
flist = other.flist;
other.flist = nullptr;
}
return *this;
}
/**
* Get raw pointer to underlying fossil_tofu_flist_t.
*/
fossil_tofu_flist_t* raw() { return flist; }
/**
* Get const raw pointer to underlying fossil_tofu_flist_t.
*/
const fossil_tofu_flist_t* raw() const { return flist; }
private:
fossil_tofu_flist_t* flist = nullptr;
};
} // namespace tofu
} // namespace fossil
#endif
#endif /* FOSSIL_TOFU_FRAMEWORK_H */SAMPLE CODE C #
#include "fossil/tofu/flist.h"
#include <stdio.h>
int main() {
fossil_flist_t* list = fossil_flist_create_default();
fossil_flist_insert(list, "apple");
fossil_flist_insert(list, "banana");
printf("Front: %s\n", fossil_flist_get_front(list));
printf("Back: %s\n", fossil_flist_get_back(list));
fossil_flist_set_front(list, "orange");
printf("New Front: %s\n", fossil_flist_get_front(list));
fossil_flist_reverse_forward(list);
printf("Front after reverse: %s\n", fossil_flist_get_front(list));
fossil_flist_destroy(list);
return 0;
}
SAMPLE CODE C++ #
#include "fossil/tofu/flist.h"
#include <iostream>
using namespace fossil::tofu;
int main() {
FList list("cstr");
list.insert("apple");
list.insert("banana");
std::cout << "Front: " << list.front() << "\n";
std::cout << "Back: " << list.back() << "\n";
list.set_front("orange");
std::cout << "New Front: " << list.front() << "\n";
list.reverse_forward();
std::cout << "Front after reverse: " << list.front() << "\n";
return 0;
}
