ccc/singly__linked__list_8h_source.html

#ifndef CCC_SINGLY_LINKED_LIST_H

#define CCC_SINGLY_LINKED_LIST_H


#include <stddef.h>

#include "impl/impl_singly_linked_list.h"

#include "types.h"


typedef struct ccc_sll_ ccc_singly_linked_list;


typedef struct ccc_sll_elem_ ccc_sll_elem;


#define ccc_sll_init(list_name, struct_name, list_elem_field, alloc_fn,        \

                     cmp_fn, aux_data)                                         \

    ccc_impl_sll_init(list_name, struct_name, list_elem_field, alloc_fn,       \

                      cmp_fn, aux_data)


[[nodiscard]] void *ccc_sll_push_front(ccc_singly_linked_list *sll,

                                       ccc_sll_elem *elem);


#define ccc_sll_emplace_front(list_ptr, struct_initializer...)                 \

    ccc_impl_sll_emplace_front(list_ptr, struct_initializer)


ccc_result ccc_sll_pop_front(ccc_singly_linked_list *sll);


ccc_result ccc_sll_splice(ccc_singly_linked_list *pos_sll, ccc_sll_elem *pos,

                          ccc_singly_linked_list *splice_sll,

                          ccc_sll_elem *splice);


ccc_result ccc_sll_splice_range(ccc_singly_linked_list *pos_sll,

                                ccc_sll_elem *pos,

                                ccc_singly_linked_list *splice_sll,

                                ccc_sll_elem *begin, ccc_sll_elem *end);


void *ccc_sll_erase(ccc_singly_linked_list *sll, ccc_sll_elem *elem);


void *ccc_sll_erase_range(ccc_singly_linked_list *sll, ccc_sll_elem *begin,

                          ccc_sll_elem *end);


void *ccc_sll_extract(ccc_singly_linked_list *sll, ccc_sll_elem *elem);


void *ccc_sll_extract_range(ccc_singly_linked_list *sll, ccc_sll_elem *begin,

                            ccc_sll_elem *end);


ccc_result ccc_sll_clear(ccc_singly_linked_list *sll, ccc_destructor_fn *fn);


[[nodiscard]] void *ccc_sll_begin(ccc_singly_linked_list const *sll);


[[nodiscard]] void *ccc_sll_end(ccc_singly_linked_list const *sll);


[[nodiscard]] void *ccc_sll_next(ccc_singly_linked_list const *sll,

                                 ccc_sll_elem const *elem);


[[nodiscard]] void *ccc_sll_front(ccc_singly_linked_list const *sll);


[[nodiscard]] ccc_sll_elem *

ccc_sll_begin_elem(ccc_singly_linked_list const *sll);


[[nodiscard]] ccc_sll_elem *

ccc_sll_begin_sentinel(ccc_singly_linked_list const *sll);


[[nodiscard]] size_t ccc_sll_size(ccc_singly_linked_list const *sll);


[[nodiscard]] bool ccc_sll_is_empty(ccc_singly_linked_list const *sll);


[[nodiscard]] bool ccc_sll_validate(ccc_singly_linked_list const *sll);


#ifdef SINGLY_LINKED_LIST_USING_NAMESPACE_CCC

typedef ccc_sll_elem sll_elem;

typedef ccc_singly_linked_list singly_linked_list;

#    define sll_init(args...) ccc_sll_init(args)

#    define sll_emplace_front(args...) ccc_sll_emplace_front(args)

#    define sll_push_front(args...) ccc_sll_push_front(args)

#    define sll_front(args...) ccc_sll_front(args)

#    define sll_pop_front(args...) ccc_sll_pop_front(args)

#    define sll_splice(args...) ccc_sll_splice(args)

#    define sll_splice_range(args...) ccc_sll_splice_range(args)

#    define sll_extract(args...) ccc_sll_extract(args)

#    define sll_extract_range(args...) ccc_sll_extract_range(args)

#    define sll_erase(args...) ccc_sll_erase(args)

#    define sll_erase_range(args...) ccc_sll_erase_range(args)

#    define sll_begin(args...) ccc_sll_begin(args)

#    define sll_end(args...) ccc_sll_end(args)

#    define sll_next(args...) ccc_sll_next(args)

#    define sll_begin_elem(args...) ccc_sll_begin_elem(args)

#    define sll_begin_sentinel(args...) ccc_sll_begin_sentinel(args)

#    define sll_size(args...) ccc_sll_size(args)

#    define sll_is_empty(args...) ccc_sll_is_empty(args)

#    define sll_validate(args...) ccc_sll_validate(args)

#    define sll_clear(args...) ccc_sll_clear(args)

#endif /* SINGLY_LINKED_LIST_USING_NAMESPACE_CCC */


#endif /* CCC_FORWARD_LIST_H */

ccc_sll_splice_range
ccc_result ccc_sll_splice_range(ccc_singly_linked_list *pos_sll, ccc_sll_elem *pos, ccc_singly_linked_list *splice_sll, ccc_sll_elem *begin, ccc_sll_elem *end)
Inserts the range of spliced elements before pos. O(N).

ccc_sll_push_front
void * ccc_sll_push_front(ccc_singly_linked_list *sll, ccc_sll_elem *elem)
Push the type wrapping elem to the front of the list. O(1).

ccc_sll_erase
void * ccc_sll_erase(ccc_singly_linked_list *sll, ccc_sll_elem *elem)
Erases elem from the list returning the following element. O(N).

ccc_sll_pop_front
ccc_result ccc_sll_pop_front(ccc_singly_linked_list *sll)
Pop the front element from the list. O(1).

ccc_sll_end
void * ccc_sll_end(ccc_singly_linked_list const *sll)
Return the sentinel at the end of the list. Do not access sentinel. O(1).

ccc_sll_validate
bool ccc_sll_validate(ccc_singly_linked_list const *sll)
Returns true if the invariants of the list hold.

ccc_sll_extract
void * ccc_sll_extract(ccc_singly_linked_list *sll, ccc_sll_elem *elem)
Extracts an element from the list without freeing it. O(N).

ccc_sll_is_empty
bool ccc_sll_is_empty(ccc_singly_linked_list const *sll)
Return true if the list is empty. O(1).

ccc_sll_size
size_t ccc_sll_size(ccc_singly_linked_list const *sll)
Return the size of the list. O(1).

ccc_sll_begin_sentinel
ccc_sll_elem * ccc_sll_begin_sentinel(ccc_singly_linked_list const *sll)
Return a pointer to the first list element in the list. O(1).

ccc_sll_erase_range
void * ccc_sll_erase_range(ccc_singly_linked_list *sll, ccc_sll_elem *begin, ccc_sll_elem *end)
Erases a range from the list returning the element after end. O(N).

ccc_singly_linked_list
struct ccc_sll_ ccc_singly_linked_list
A low overhead front tracking container with efficient push and pop.
Definition: singly_linked_list.h:45

ccc_sll_begin_elem
ccc_sll_elem * ccc_sll_begin_elem(ccc_singly_linked_list const *sll)
Return a pointer to the first intrusive handle in the list. O(1).

ccc_sll_front
void * ccc_sll_front(ccc_singly_linked_list const *sll)
Return a pointer to the element at the front of the list. O(1).

ccc_sll_clear
ccc_result ccc_sll_clear(ccc_singly_linked_list *sll, ccc_destructor_fn *fn)
Clears the list freeing memory if needed. O(N).

ccc_sll_next
void * ccc_sll_next(ccc_singly_linked_list const *sll, ccc_sll_elem const *elem)
Return the user type following elem in the list. O(1).

ccc_sll_begin
void * ccc_sll_begin(ccc_singly_linked_list const *sll)
Return the user type at the front of the list. O(1).

ccc_sll_elem
struct ccc_sll_elem_ ccc_sll_elem
A singly linked list intrusive element to embedded in a user type.
Definition: singly_linked_list.h:55

ccc_sll_extract_range
void * ccc_sll_extract_range(ccc_singly_linked_list *sll, ccc_sll_elem *begin, ccc_sll_elem *end)
Extracts a range of elements from the list without freeing them. O(N).

ccc_sll_splice
ccc_result ccc_sll_splice(ccc_singly_linked_list *pos_sll, ccc_sll_elem *pos, ccc_singly_linked_list *splice_sll, ccc_sll_elem *splice)
Inserts splice element before pos. O(N).

types.h
The C Container Collection Fundamental Types.

ccc_result
ccc_result
A result of actions on containers.
Definition: types.h:65

ccc_destructor_fn
void ccc_destructor_fn(ccc_user_type)
A callback function for destroying an element in the container.
Definition: types.h:234