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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
|
/* misc_tools.h
*
* Miscellaneous functions and data structures for doing random things.
*
* Copyright (C) 2013 Tox project All Rights Reserved.
*
* This file is part of Tox.
*
* Tox is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Tox is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Tox. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef MISC_TOOLS_H
#define MISC_TOOLS_H
#include <stdlib.h>
#include <stdint.h>
#include <string.h> /* for memcpy() */
/*********************Debugging Macros********************
* wiki.tox.im/index.php/Internal_functions_and_data_structures#Debugging
*********************************************************/
#ifdef DEBUG
#include <assert.h>
#include <stdio.h>
#include <string.h>
#define DEBUG_PRINT(str, ...) do { \
char msg[1000]; \
sprintf(msg, "%s(): line %d (file %s): %s%%c\n", __FUNCTION__, __LINE__, __FILE__, str); \
fprintf(stderr, msg, __VA_ARGS__); \
} while (0)
#define WARNING(...) do { \
fprintf(stderr, "warning in "); \
DEBUG_PRINT(__VA_ARGS__, ' '); \
} while (0)
#define INFO(...) do { \
DEBUG_PRINT(__VA_ARGS__, ' '); \
} while (0)
#undef ERROR
#define ERROR(exit_status, ...) do { \
fprintf(stderr, "error in "); \
DEBUG_PRINT(__VA_ARGS__, ' '); \
exit(exit_status); \
} while (0)
#else
#define WARNING(...)
#define INFO(...)
#undef ERROR
#define ERROR(...)
#endif // DEBUG
/************************Linked List***********************
* http://wiki.tox.im/index.php/Internal_functions_and_data_structures#Linked_List
* TODO: Update wiki.
**********************************************************/
#define MEMBER_OFFSET(var_name_in_parent, parent_type) \
(&(((parent_type*)0)->var_name_in_parent))
#define GET_PARENT(var, var_name_in_parent, parent_type) \
((parent_type*)((uint64_t)(&(var)) - (uint64_t)(MEMBER_OFFSET(var_name_in_parent, parent_type))))
#define TOX_LIST_FOR_EACH(lst, tmp_name) \
for (tox_list* tmp_name = lst.next; tmp_name != &lst; tmp_name = tmp_name->next)
#define TOX_LIST_GET_VALUE(tmp_name, name_in_parent, parent_type) GET_PARENT(tmp_name, name_in_parent, parent_type)
typedef struct tox_list {
struct tox_list *prev, *next;
} tox_list;
/* return new tox_list_t. */
static inline void tox_list_new(tox_list *lst)
{
lst->prev = lst->next = lst;
}
/* Inserts a new tox_lst after lst and returns it. */
static inline void tox_list_add(tox_list *lst, tox_list *new_lst)
{
tox_list_new(new_lst);
new_lst->next = lst->next;
new_lst->next->prev = new_lst;
lst->next = new_lst;
new_lst->prev = lst;
}
static inline void tox_list_remove(tox_list *lst)
{
lst->prev->next = lst->next;
lst->next->prev = lst->prev;
}
/****************************Array***************************
* Array which manages its own memory allocation.
* It stores copy of data (not pointers).
* TODO: Add wiki info usage.
************************************************************/
typedef struct tox_array {
uint8_t *data; /* last elem is data[len-1] */
uint32_t len;
size_t elem_size; /* in bytes */
} tox_array;
static inline void tox_array_init(tox_array *arr, size_t elem_size)
{
arr->len = 0;
arr->elem_size = elem_size;
arr->data = NULL;
}
static inline void tox_array_delete(tox_array *arr)
{
free(arr->data);
arr->len = arr->elem_size = 0;
}
static inline uint8_t tox_array_push_ptr(tox_array *arr, uint8_t *item)
{
uint8_t *temp = realloc(arr->data, arr->elem_size * (arr->len + 1));
if (temp == NULL)
return 0;
arr->data = temp;
if (item != NULL)
memcpy(arr->data + arr->elem_size * arr->len, item, arr->elem_size);
arr->len++;
return 1;
}
#define tox_array_push(arr, item) tox_array_push_ptr(arr, (uint8_t*)(&(item)))
/* Deletes num items from array.
* Not same as pop in stacks, because to access elements you use data.
*/
static inline void tox_array_pop(tox_array *arr, uint32_t num)
{
if (num == 0)
return;
if (num > arr->len)
return;
if (arr->len == num) {
free(arr->data);
arr->data = NULL;
arr->len = 0;
return;
}
uint8_t *temp = realloc(arr->data, arr->elem_size * (arr->len - num));
if (temp == NULL)
return;
arr->len -= num;
arr->data = temp;
}
/* TODO: return ptr and do not take type */
#define tox_array_get(arr, i, type) (((type*)(arr)->data)[i])
#define tox_array_for_each(arr, type, tmp_name) \
type *tmp_name = &tox_array_get(arr, 0, type); uint32_t tmp_name ## _i = 0; \
for (; tmp_name ## _i < (arr)->len; tmp_name = &tox_array_get(arr, ++ tmp_name ## _i, type))
/****************************Algorithms***************************
* Macro/generic definitions for useful algorithms
*****************************************************************/
/* Creates a new quick_sort implementation for arrays of the specified type.
* For a type T (eg: int, char), creates a function named T_quick_sort.
*
* Quick Sort: Complexity O(nlogn)
* arr - the array to sort
* n - the sort index (should be called with n = length(arr))
* cmpfn - a function that compares two values of type type.
* Must return -1, 0, 1 for a < b, a == b, and a > b respectively.
*/
/* Must be called in the header file. */
#define declare_quick_sort(type) \
void type##_quick_sort(type *arr, int n, int (*cmpfn)(type, type));
/* Must be called in the C file. */
#define make_quick_sort(type) \
void type##_quick_sort(type *arr, int n, int (*cmpfn)(type, type)) \
{ \
if ((n) < 2) \
return; \
type _p_ = (arr)[(n) / 2]; \
type *_l_ = (arr); \
type *_r_ = (arr) + n - 1; \
while (_l_ <= _r_) { \
if (cmpfn(*_l_, _p_) == -1) { \
++_l_; \
continue; \
} \
if (cmpfn(*_r_, _p_) == 1) { \
--_r_; \
continue; \
} \
type _t_ = *_l_; \
*_l_++ = *_r_; \
*_r_-- = _t_; \
} \
type##_quick_sort((arr), _r_ - (arr) + 1, cmpfn); \
type##_quick_sort(_l_, (arr) + n - _l_, cmpfn); \
}
#endif // MISC_TOOLS_H
|
