code/list_8h_source.html

#ifndef MUTT_MUTT_LIST_H

#define MUTT_MUTT_LIST_H


#include <stdbool.h>

#include <stddef.h>

#include "buffer.h"

#include "queue.h"


struct ListNode

{

  char *data;

  STAILQ_ENTRY(ListNode) entries;

};

STAILQ_HEAD(ListHead, ListNode);


typedef void (*list_free_t)(void **ptr);


void             mutt_list_clear       (struct ListHead *h);

void             mutt_list_copy_tail   (struct ListHead *dst, const struct ListHead *src);

bool             mutt_list_equal       (const struct ListHead *ah, const struct ListHead *bh);

struct ListNode *mutt_list_find        (const struct ListHead *h, const char *data);

void             mutt_list_free        (struct ListHead *h);

void             mutt_list_free_type   (struct ListHead *h, list_free_t fn);

struct ListNode *mutt_list_insert_after(struct ListHead *h, struct ListNode *n, char *s);

struct ListNode *mutt_list_insert_head (struct ListHead *h, char *s);

struct ListNode *mutt_list_insert_tail (struct ListHead *h, char *s);

bool             mutt_list_match       (const char *s, struct ListHead *h);

size_t           mutt_list_str_split   (struct ListHead *head, const char *src, char sep);

size_t           mutt_list_write       (const struct ListHead *h, struct Buffer *buf);


#endif /* MUTT_MUTT_LIST_H */

buffer.h
General purpose object for storing and parsing strings.

mutt_list_copy_tail
void mutt_list_copy_tail(struct ListHead *dst, const struct ListHead *src)
Copy a list into another list.
Definition: list.c:275

mutt_list_insert_tail
struct ListNode * mutt_list_insert_tail(struct ListHead *h, char *s)
Append a string to the end of a List.
Definition: list.c:65

mutt_list_find
struct ListNode * mutt_list_find(const struct ListHead *h, const char *data)
Find a string in a List.
Definition: list.c:103

mutt_list_insert_head
struct ListNode * mutt_list_insert_head(struct ListHead *h, char *s)
Insert a string at the beginning of a List.
Definition: list.c:46

mutt_list_write
size_t mutt_list_write(const struct ListHead *h, struct Buffer *buf)
Write a list to a buffer.
Definition: list.c:293

mutt_list_clear
void mutt_list_clear(struct ListHead *h)
Free a list, but NOT its strings.
Definition: list.c:166

mutt_list_str_split
size_t mutt_list_str_split(struct ListHead *head, const char *src, char sep)
Split a string into a list using a separator char.
Definition: list.c:246

list_free_t
void(* list_free_t)(void **ptr)
Definition: list.h:49

mutt_list_equal
bool mutt_list_equal(const struct ListHead *ah, const struct ListHead *bh)
Compare two string lists.
Definition: list.c:217

mutt_list_free
void mutt_list_free(struct ListHead *h)
Free a List AND its strings.
Definition: list.c:123

mutt_list_free_type
void mutt_list_free_type(struct ListHead *h, list_free_t fn)
Free a List of type.
Definition: list.c:144

mutt_list_match
bool mutt_list_match(const char *s, struct ListHead *h)
Is the string in the list (see notes)
Definition: list.c:194

mutt_list_insert_after
struct ListNode * mutt_list_insert_after(struct ListHead *h, struct ListNode *n, char *s)
Insert a string after a given ListNode.
Definition: list.c:85

queue.h

STAILQ_HEAD
#define STAILQ_HEAD(name, type)
Definition: queue.h:312

Buffer
String manipulation buffer.
Definition: buffer.h:36

ListNode
A List node for strings.
Definition: list.h:36

ListNode::data
char * data
String.
Definition: list.h:37

ListNode::STAILQ_ENTRY
STAILQ_ENTRY(ListNode) entries
Linked list.