doubly_linked_list.h

Go to the documentation of this file.

 
#ifndef CCC_DOUBLY_LINKED_LIST_H
#define CCC_DOUBLY_LINKED_LIST_H
 
#include <stddef.h>
#include "private/private_doubly_linked_list.h"
#include "types.h" /* IWYU pragma: export */
 
typedef struct CCC_Doubly_linked_list CCC_Doubly_linked_list;
 
typedef struct CCC_Doubly_linked_list_node CCC_Doubly_linked_list_node;
 
#define CCC_doubly_linked_list_default(type_name, type_intruder_field)         \
    CCC_private_doubly_linked_list_for(type_name, type_intruder_field)
 
#define CCC_doubly_linked_list_for(type_name, type_intruder_field)             \
    CCC_private_doubly_linked_list_for(type_name, type_intruder_field)
 
#define CCC_doubly_linked_list_from(                                           \
    type_intruder_field, allocator, destructor, compound_literal_array...      \
)                                                                              \
    CCC_private_doubly_linked_list_from(                                       \
        type_intruder_field, allocator, destructor, compound_literal_array     \
    )
 
#define CCC_doubly_linked_list_emplace_back(                                   \
    list_pointer, allocator_pointer, type_compound_literal...                  \
)                                                                              \
    CCC_private_doubly_linked_list_emplace_back(                               \
        list_pointer, allocator_pointer, type_compound_literal                 \
    )
 
#define CCC_doubly_linked_list_emplace_front(                                  \
    list_pointer, allocator_pointer, type_compound_literal...                  \
)                                                                              \
    CCC_private_doubly_linked_list_emplace_front(                              \
        list_pointer, allocator_pointer, type_compound_literal                 \
    )
 
[[nodiscard]] void *CCC_doubly_linked_list_push_front(
    CCC_Doubly_linked_list *list,
    CCC_Doubly_linked_list_node *type_intruder,
    CCC_Allocator const *allocator
);
 
[[nodiscard]] void *CCC_doubly_linked_list_push_back(
    CCC_Doubly_linked_list *list,
    CCC_Doubly_linked_list_node *type_intruder,
    CCC_Allocator const *allocator
);
 
[[nodiscard]] void *CCC_doubly_linked_list_insert(
    CCC_Doubly_linked_list *list,
    CCC_Doubly_linked_list_node *position_node,
    CCC_Doubly_linked_list_node *type_intruder,
    CCC_Allocator const *allocator
);
 
CCC_Result CCC_doubly_linked_list_pop_front(
    CCC_Doubly_linked_list *list, CCC_Allocator const *allocator
);
 
CCC_Result CCC_doubly_linked_list_pop_back(
    CCC_Doubly_linked_list *list, CCC_Allocator const *allocator
);
 
void *CCC_doubly_linked_list_extract(
    CCC_Doubly_linked_list *list, CCC_Doubly_linked_list_node *type_intruder
);
 
void *CCC_doubly_linked_list_erase(
    CCC_Doubly_linked_list *list,
    CCC_Doubly_linked_list_node *type_intruder,
    CCC_Allocator const *allocator
);
 
void *CCC_doubly_linked_list_erase_range(
    CCC_Doubly_linked_list *list,
    CCC_Doubly_linked_list_node *type_intruder_begin,
    CCC_Doubly_linked_list_node *type_intruder_end,
    CCC_Allocator const *allocator
);
 
void *CCC_doubly_linked_list_extract_range(
    CCC_Doubly_linked_list *list,
    CCC_Doubly_linked_list_node *type_intruder_begin,
    CCC_Doubly_linked_list_node *type_intruder_end
);
 
CCC_Result CCC_doubly_linked_list_splice(
    CCC_Doubly_linked_list *position_doubly_linked_list,
    CCC_Doubly_linked_list_node *type_intruder_position,
    CCC_Doubly_linked_list *to_cut_doubly_linked_list,
    CCC_Doubly_linked_list_node *type_intruder_to_cut
);
 
CCC_Result CCC_doubly_linked_list_splice_range(
    CCC_Doubly_linked_list *position_doubly_linked_list,
    CCC_Doubly_linked_list_node *type_intruder_position,
    CCC_Doubly_linked_list *to_cut_doubly_linked_list,
    CCC_Doubly_linked_list_node *type_intruder_to_cut_begin,
    CCC_Doubly_linked_list_node *type_intruder_to_cut_exclusive_end
);
 
void *CCC_doubly_linked_list_insert_sorted(
    CCC_Doubly_linked_list *doubly_linked_list,
    CCC_Doubly_linked_list_node *type_intruder,
    CCC_Order order,
    CCC_Comparator const *comparator,
    CCC_Allocator const *allocator
);
 
CCC_Tribool CCC_doubly_linked_list_is_sorted(
    CCC_Doubly_linked_list const *doubly_linked_list,
    CCC_Order order,
    CCC_Comparator const *comparator
);
 
CCC_Result CCC_doubly_linked_list_clear(
    CCC_Doubly_linked_list *list,
    CCC_Destructor const *destructor,
    CCC_Allocator const *allocator
);
 
[[nodiscard]] void *
CCC_doubly_linked_list_begin(CCC_Doubly_linked_list const *list);
 
[[nodiscard]] void *
CCC_doubly_linked_list_reverse_begin(CCC_Doubly_linked_list const *list);
 
[[nodiscard]] void *CCC_doubly_linked_list_next(
    CCC_Doubly_linked_list const *list,
    CCC_Doubly_linked_list_node const *type_intruder
);
 
[[nodiscard]] void *CCC_doubly_linked_list_reverse_next(
    CCC_Doubly_linked_list const *list,
    CCC_Doubly_linked_list_node const *type_intruder
);
 
[[nodiscard]] void *
CCC_doubly_linked_list_end(CCC_Doubly_linked_list const *list);
 
[[nodiscard]] void *
CCC_doubly_linked_list_reverse_end(CCC_Doubly_linked_list const *list);
 
[[nodiscard]] void *
CCC_doubly_linked_list_front(CCC_Doubly_linked_list const *list);
 
[[nodiscard]] void *
CCC_doubly_linked_list_back(CCC_Doubly_linked_list const *list);
 
[[nodiscard]] CCC_Doubly_linked_list_node *
CCC_doubly_linked_list_node_begin(CCC_Doubly_linked_list const *list);
 
[[nodiscard]] CCC_Count
CCC_doubly_linked_list_count(CCC_Doubly_linked_list const *list);
 
[[nodiscard]] CCC_Tribool
CCC_doubly_linked_list_is_empty(CCC_Doubly_linked_list const *list);
 
[[nodiscard]] CCC_Tribool
CCC_doubly_linked_list_validate(CCC_Doubly_linked_list const *list);
 
#ifdef DOUBLY_LINKED_LIST_USING_NAMESPACE_CCC
/* NOLINTBEGIN(readability-identifier-naming) */
typedef CCC_Doubly_linked_list_node Doubly_linked_list_node;
typedef CCC_Doubly_linked_list Doubly_linked_list;
#    define doubly_linked_list_default(arguments...)                           \
        CCC_doubly_linked_list_default(arguments)
#    define doubly_linked_list_for(arguments...)                               \
        CCC_doubly_linked_list_for(arguments)
#    define doubly_linked_list_from(arguments...)                              \
        CCC_doubly_linked_list_from(arguments)
#    define doubly_linked_list_emplace_back(arguments...)                      \
        CCC_doubly_linked_list_emplace_back(arguments)
#    define doubly_linked_list_emplace_front(arguments...)                     \
        CCC_doubly_linked_list_emplace_front(arguments)
#    define doubly_linked_list_push_front(arguments...)                        \
        CCC_doubly_linked_list_push_front(arguments)
#    define doubly_linked_list_push_back(arguments...)                         \
        CCC_doubly_linked_list_push_back(arguments)
#    define doubly_linked_list_front(arguments...)                             \
        CCC_doubly_linked_list_front(arguments)
#    define doubly_linked_list_back(arguments...)                              \
        CCC_doubly_linked_list_back(arguments)
#    define doubly_linked_list_pop_front(arguments...)                         \
        CCC_doubly_linked_list_pop_front(arguments)
#    define doubly_linked_list_pop_back(arguments...)                          \
        CCC_doubly_linked_list_pop_back(arguments)
#    define doubly_linked_list_extract(arguments...)                           \
        CCC_doubly_linked_list_extract(arguments)
#    define doubly_linked_list_extract_range(arguments...)                     \
        CCC_doubly_linked_list_extract_range(arguments)
#    define doubly_linked_list_erase(arguments...)                             \
        CCC_doubly_linked_list_erase(arguments)
#    define doubly_linked_list_erase_range(arguments...)                       \
        CCC_doubly_linked_list_erase_range(arguments)
#    define doubly_linked_list_splice(arguments...)                            \
        CCC_doubly_linked_list_splice(arguments)
#    define doubly_linked_list_splice_range(arguments...)                      \
        CCC_doubly_linked_list_splice_range(arguments)
#    define doubly_linked_list_sort(arguments...)                              \
        CCC_doubly_linked_list_sort(arguments)
#    define doubly_linked_list_insert_sorted(arguments...)                     \
        CCC_doubly_linked_list_insert_sorted(arguments)
#    define doubly_linked_list_is_sorted(arguments...)                         \
        CCC_doubly_linked_list_is_sorted(arguments)
#    define doubly_linked_list_begin(arguments...)                             \
        CCC_doubly_linked_list_begin(arguments)
#    define doubly_linked_list_next(arguments...)                              \
        CCC_doubly_linked_list_next(arguments)
#    define doubly_linked_list_reverse_begin(arguments...)                     \
        CCC_doubly_linked_list_reverse_begin(arguments)
#    define doubly_linked_list_reverse_next(arguments...)                      \
        CCC_doubly_linked_list_reverse_next(arguments)
#    define doubly_linked_list_end(arguments...)                               \
        CCC_doubly_linked_list_end(arguments)
#    define doubly_linked_list_reverse_end(arguments...)                       \
        CCC_doubly_linked_list_reverse_end(arguments)
#    define doubly_linked_list_node_begin(arguments...)                        \
        CCC_doubly_linked_list_node_begin(arguments)
#    define doubly_linked_list_count(arguments...)                             \
        CCC_doubly_linked_list_count(arguments)
#    define doubly_linked_list_is_empty(arguments...)                          \
        CCC_doubly_linked_list_is_empty(arguments)
#    define doubly_linked_list_clear(arguments...)                             \
        CCC_doubly_linked_list_clear(arguments)
#    define doubly_linked_list_validate(arguments...)                          \
        CCC_doubly_linked_list_validate(arguments)
/* NOLINTEND(readability-identifier-naming) */
#endif /* DOUBLY_LINKED_LIST_USING_NAMESPACE_CCC */
 
#endif /* CCC_LIST_H */