1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
#include "config.h"
#if !defined STRING_LIST_H && defined FWD_ZONES_SUPPORT
#define STRING_LIST_H
#include <stdlib.h>
#include <string.h>
#define FOR_EACH_STRING_IN_LIST(ITER, LIST) for (struct string_entry *(ITER) = (LIST)->first; (ITER) != NULL; (ITER) = (ITER)->next)
/**
* Linked list of strings
*/
struct string_list {
/** A linked list of strings */
struct string_entry *first;
};
/**
* One node in the string list
*/
struct string_entry {
/** Next in list */
struct string_entry* next;
/** String owned by this list
* Do not use this pointer elsewhere
*/
char* string;
/** Length of the string buffer */
size_t length;
/** Heap allocated extension of this entry. It can be of any type and if not NULL
* it will be freed during the cleanup.
*/
void* extension;
};
// TODO: move somewhere else
/*
* Thin wrapper around malloc. It either gets a valid memory
* or exit the whole process.
*/
void* calloc_or_die(size_t size);
/**
* Initialize a new list of strings
* @param list: New list
*/
void string_list_init(struct string_list* list);
/**
* Clear the list and free all contained buffers
* @param list: List to be cleared. To free the structure itself is caller responsibility.
*/
void string_list_clear(struct string_list* list);
/**
* Push new string at the end of the list. The string
* is copied into the node.
* @param list: List to append to
* @param new_value: String to be appended
* @param buffer_size: Size of the buffer from which the string is copied
*/
void string_list_push_back(struct string_list* list, const char* new_value, const size_t buffer_size);
/**
* Find out whether the list contains the given value
* @param list: List to check
* @param new_value: String to be found
* @param buffer_size: Size of the string buffer
*/
int string_list_contains(const struct string_list* list, const char* value, const size_t buffer_size);
/**
* Duplicate the list
* @param original: List to copy
* @param copy: New list
*/
void string_list_duplicate(const struct string_list* original, struct string_list *copy);
/**
* Copy the second list and append it to the first one
* @param original: The list that gets extended
* @param append: The list that is copied
*/
void string_list_copy_and_append(struct string_list* original, struct string_list *append);
/**
* Find out whether the list contains the given value and remove it
* @param list: List to check
* @param new_value: String to be removed
* @param buffer_size: Size of the string buffer
*/
void string_list_remove(struct string_list* list, const char* value, const size_t buffer_size);
/**
* Find out the size of given list
* @param list: List to check
*/
size_t string_list_length(const struct string_list* list);
/**
* Compare content of two lists. Every value must be unique.
* @param l1: First list
* @param l2: Second list
*/
int string_list_is_equal(const struct string_list* l1, const struct string_list* l2);
/**
* Print list of strings onto one line without newline at the end.
* @param list: List to be printed
*/
void string_list_dbg_print(const struct string_list* list);
void string_list_dbg_eprint(const struct string_list* list);
void string_list_dbg_print_inner(const struct string_list* list, FILE *fp);
/**
* Print list into a buffer. Be careful, you have to free the buffer
* yourself.
* @param list: List to print
* @param buffer: Buffer to print the list into
* @param len: size of the buffer
* @return: success >= 0, -1 = list does not fit into the buffer
*/
int string_list_sprint(const struct string_list* list, char *buffer, size_t len);
#endif /* STRING_LIST_H */
|
