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
|
/* SPDX-License-Identifier: GPL-3.0-or-later
* Copyright © 2016-2018 The TokTok team.
* Copyright © 2014 Tox project.
*/
/**
* Simple struct with functions to create a list which associates ids with data
* -Allows for finding ids associated with data such as IPs or public keys in a short time
* -Should only be used if there are relatively few add/remove calls to the list
*/
#ifndef C_TOXCORE_TOXCORE_LIST_H
#define C_TOXCORE_TOXCORE_LIST_H
#include <stdbool.h>
#include <stddef.h> // size_t
#include <stdint.h>
#include "attributes.h"
#ifdef __cplusplus
extern "C" {
#endif
typedef int bs_list_cmp_cb(const void *a, const void *b, size_t size);
typedef struct BS_List {
uint32_t n; // number of elements
uint32_t capacity; // number of elements memory is allocated for
uint32_t element_size; // size of the elements
uint8_t *data; // array of elements
int *ids; // array of element ids
bs_list_cmp_cb *cmp_callback;
} BS_List;
/** @brief Initialize a list.
*
* @param element_size is the size of the elements in the list.
* @param initial_capacity is the number of elements the memory will be initially allocated for.
*
* @retval 1 success
* @retval 0 failure
*/
non_null()
int bs_list_init(BS_List *list, uint32_t element_size, uint32_t initial_capacity, bs_list_cmp_cb *cmp_callback);
/** Free a list initiated with list_init */
nullable(1)
void bs_list_free(BS_List *list);
/** @brief Retrieve the id of an element in the list
*
* @retval >=0 id associated with data
* @retval -1 failure
*/
non_null()
int bs_list_find(const BS_List *list, const uint8_t *data);
/** @brief Add an element with associated id to the list
*
* @retval true success
* @retval false failure (data already in list)
*/
non_null()
bool bs_list_add(BS_List *list, const uint8_t *data, int id);
/** @brief Remove element from the list
*
* @retval true success
* @retval false failure (element not found or id does not match)
*/
non_null()
bool bs_list_remove(BS_List *list, const uint8_t *data, int id);
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif /* C_TOXCORE_TOXCORE_LIST_H */
|
