From fdb3e194ba9f9c4b073edb324df5f177315ce6bf Mon Sep 17 00:00:00 2001 From: Konstantin Kowalski Date: Fri, 9 Aug 2013 15:35:19 +0000 Subject: [PATCH 1/5] Added INFO() debugging macro. --- testing/misc_tools.h | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/testing/misc_tools.h b/testing/misc_tools.h index 1abdb809..e50a8f7f 100644 --- a/testing/misc_tools.h +++ b/testing/misc_tools.h @@ -51,6 +51,10 @@ unsigned char * hex_string_to_bin(char hex_string[]); 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 "); \ @@ -59,6 +63,7 @@ unsigned char * hex_string_to_bin(char hex_string[]); } while (0) #else #define WARNING(...) + #define INFO(...) #undef ERROR #define ERROR(...) #endif // DEBUG From 1033d897ca4a0636a549a87ae2dce6592c66fffd Mon Sep 17 00:00:00 2001 From: Konstantin Kowalski Date: Fri, 9 Aug 2013 15:38:21 +0000 Subject: [PATCH 2/5] Added arrays. --- testing/misc_tools.h | 48 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) diff --git a/testing/misc_tools.h b/testing/misc_tools.h index e50a8f7f..cc5abeda 100644 --- a/testing/misc_tools.h +++ b/testing/misc_tools.h @@ -173,4 +173,52 @@ static inline void tox_list_remove(tox_list_t* lst) { lst->next->prev = lst->prev; } +/****************************Array*************************** + * Array to store pointers which tracks it's own size. + * TODO: Figure out if it shold store values instead of + * pointers? + ************************************************************/ + +struct tox_array { + void **data; + uint32_t size, length; +}; + + static inline void tox_array_init(struct tox_array *arr) +{ + arr->size = 1; + arr->length = 0; + arr->data = malloc(sizeof(void*)); +} + +static inline void tox_array_delete(struct tox_array *arr) +{ + free(arr->data); + arr->size = arr->length = 0; +} + +/* shrinks arr so it will not have unused space. If you want to have + * addtional space, extra species the amount of extra space. + */ +static inline void tox_array_shrink_to_fit(struct tox_array *arr, int32_t extra) +{ + arr->size = arr->length + extra; + arr->data = realloc(arr->data, arr->size * sizeof(void*)); +} + +static inline void _tox_array_push(struct tox_array *arr, void *new) +{ + if (arr->length+1 >= arr->size) + tox_array_shrink_to_fit(arr, arr->size); + arr->data[arr->length++] = new; +} +#define tox_array_push(arr, new) _tox_array_push(arr, (void*)new) + +static inline void* tox_array_pop(struct tox_array *arr) +{ + if (arr->length-1 < arr->size/4) + tox_array_shrink_to_fit(arr, arr->length*2); + return arr->data[arr->length--]; +} + #endif // MISC_TOOLS_H From 5f41c30d66f0902d5151663da67c7d6a9995c098 Mon Sep 17 00:00:00 2001 From: Konstantin Kowalski Date: Fri, 9 Aug 2013 15:44:22 +0000 Subject: [PATCH 3/5] Moved long comments to wiki. --- testing/misc_tools.h | 81 ++++---------------------------------------- 1 file changed, 7 insertions(+), 74 deletions(-) diff --git a/testing/misc_tools.h b/testing/misc_tools.h index cc5abeda..550465f4 100644 --- a/testing/misc_tools.h +++ b/testing/misc_tools.h @@ -26,15 +26,9 @@ unsigned char * hex_string_to_bin(char hex_string[]); -/* WARNING(msg) takes a printf()-styled string and prints it - * with some additional details. - * ERROR(exit_status, msg) does the same thing as WARNING(), but - * also exits the program with the given exit status. - * Examples: - * WARNING(""); - * int exit_status = 2; - * ERROR(exit_status, "exiting with status %i", exit_status); - */ +/*********************Debugging Macros******************** + * wiki.tox.im/index.php/Internal_functions_and_data_structures#Debugging + *********************************************************/ #ifdef DEBUG #include #include @@ -69,76 +63,14 @@ unsigned char * hex_string_to_bin(char hex_string[]); #endif // DEBUG /************************Linked List*********************** - * This is a simple linked list implementation, very similar - * to Linux kernel's /include/linux/list.h (which we can't - * use because Tox is GPLv3 and Linux is GPLv2.) - * - * TODO: Make the lists easier to use with some sweat pre- - * processor syntactic sugar. + * http://wiki.tox.im/index.php/Internal_functions_and_data_structures#Linked_List **********************************************************/ -/* Example usage - -This sample program makes a new struct which contains a -character and a tox_list_t. It then prompts a user for -input until he enters q or e. It then adds each character -to the list, and uses a special for loop to print them. -It then removes all the 'z' characters, and prints the list -again. - -//Notice that the data to be put in the list *contains* tox_list_t; -//usually, this is the other way around! -typedef struct tox_string { - char c; - tox_list_t tox_lst; //Notice that tox_lst is *NOT* a pointer. -} tox_string_t; - -int main() -{ - tox_list_t head; - tox_list_new(&head); //initialize head - - //input a new character, until user enters q or e - char c = '\0'; - while (c != 'q' && c != 'e') { - scanf("%c", &c); - tox_string_t* tmp = malloc(sizeof(tox_string_t)); - tmp->c = c; - tox_list_add(&head, &tmp->tox_lst); //add it to the list - } - -TOX_LIST_FOR_EACH() takes a struct tox_list and a name for a temporary pointer to use in the loop. - -TOX_LIST_GET_VALUE() uses magic to return an instance of a structure that contains tox_list_t. -You have to give it a temporary tox_string_t, name of tox_list_t member inside our structure (tox_lst), -and the type of structure to return. - - TOX_LIST_FOR_EACH(head, tmp) - printf("%c", TOX_LIST_GET_VALUE(*tmp, tox_lst, tox_string_t).c); - - TOX_LIST_FOR_EACH(head, tmp) { - if (TOX_LIST_GET_VALUE(*tmp, tox_lst, tox_string_t).c == 'z') { - //If you delete tmp, you have to quit the loop, or it will go on infinitly. - //This will be fixed later on. - tox_list_remove(tmp); - break; - } - } - - printf("\n"); - TOX_LIST_FOR_EACH(head, tmp) - printf("%c", TOX_LIST_GET_VALUE(*tmp, tox_lst, tox_string_t).c); - - - return 0; -} -*/ - #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))))) + ((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_t* tmp_name = lst.next; tmp_name != &lst; tmp_name = tmp_name->next) @@ -177,6 +109,7 @@ static inline void tox_list_remove(tox_list_t* lst) { * Array to store pointers which tracks it's own size. * TODO: Figure out if it shold store values instead of * pointers? + * TODO: Add wiki info usage. ************************************************************/ struct tox_array { @@ -184,7 +117,7 @@ struct tox_array { uint32_t size, length; }; - static inline void tox_array_init(struct tox_array *arr) +static inline void tox_array_init(struct tox_array *arr) { arr->size = 1; arr->length = 0; From 4f2ecd20e9de4305bdf37f1205966bb7db7588e7 Mon Sep 17 00:00:00 2001 From: Konstantin Kowalski Date: Fri, 9 Aug 2013 15:45:34 +0000 Subject: [PATCH 4/5] Minor style changes. --- testing/misc_tools.h | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/testing/misc_tools.h b/testing/misc_tools.h index 550465f4..27174592 100644 --- a/testing/misc_tools.h +++ b/testing/misc_tools.h @@ -24,7 +24,7 @@ #ifndef MISC_TOOLS_H #define MISC_TOOLS_H -unsigned char * hex_string_to_bin(char hex_string[]); +unsigned char* hex_string_to_bin(char hex_string[]); /*********************Debugging Macros******************** * wiki.tox.im/index.php/Internal_functions_and_data_structures#Debugging @@ -82,12 +82,14 @@ typedef struct tox_list { } tox_list_t; /* Returns a new tox_list_t. */ -static inline void tox_list_new(tox_list_t* lst) { +static inline void tox_list_new(tox_list_t* lst) +{ lst->prev = lst->next = lst; } /* Inserts a new tox_lst after lst and returns it. */ -static inline void tox_list_add(tox_list_t* lst, tox_list_t* new_lst) { +static inline void tox_list_add(tox_list_t* lst, tox_list_t* new_lst) +{ tox_list_new(new_lst); new_lst->next = lst->next; @@ -97,10 +99,8 @@ static inline void tox_list_add(tox_list_t* lst, tox_list_t* new_lst) { new_lst->prev = lst; } -static inline void tox_list_remove(tox_list_t* lst) { -#ifdef DEBUG /* TODO: check how debugging is done in Tox. */ - assert(lst->next != lst && lst->prev != lst); -#endif +static inline void tox_list_remove(tox_list_t* lst) +{ lst->prev->next = lst->next; lst->next->prev = lst->prev; } From fa6fd7566bb77f0daab7aec6e5d014860f60759a Mon Sep 17 00:00:00 2001 From: Konstantin Kowalski Date: Fri, 9 Aug 2013 15:54:14 +0000 Subject: [PATCH 5/5] Added headers to fix build errors. --- testing/misc_tools.h | 3 +++ 1 file changed, 3 insertions(+) diff --git a/testing/misc_tools.h b/testing/misc_tools.h index 27174592..b8c90fa6 100644 --- a/testing/misc_tools.h +++ b/testing/misc_tools.h @@ -24,6 +24,9 @@ #ifndef MISC_TOOLS_H #define MISC_TOOLS_H +#include +#include + unsigned char* hex_string_to_bin(char hex_string[]); /*********************Debugging Macros********************