mirror of
https://github.com/irungentoo/toxcore.git
synced 2024-03-22 13:30:51 +08:00
86 lines
2.4 KiB
C
86 lines
2.4 KiB
C
/* list.h
|
|
*
|
|
* 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
|
|
*
|
|
* Copyright (C) 2014 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 LIST_H
|
|
#define LIST_H
|
|
|
|
#include <stdlib.h>
|
|
#include <stdint.h>
|
|
#include <string.h>
|
|
|
|
typedef struct {
|
|
uint32_t n; //number of elements
|
|
uint32_t capacity; //number of elements memory is allocated for
|
|
uint32_t element_size; //size of the elements
|
|
void *data; //array of elements
|
|
int *ids; //array of element ids
|
|
} BS_LIST;
|
|
|
|
/* Initialize a list, element_size is the size of the elements in the list and
|
|
* initial_capacity is the number of elements the memory will be initially allocated for
|
|
*
|
|
* return value:
|
|
* 1 : success
|
|
* 0 : failure
|
|
*/
|
|
int bs_list_init(BS_LIST *list, uint32_t element_size, uint32_t initial_capacity);
|
|
|
|
/* Free a list initiated with list_init */
|
|
void bs_list_free(BS_LIST *list);
|
|
|
|
/* Retrieve the id of an element in the list
|
|
*
|
|
* return value:
|
|
* >= 0 : id associated with data
|
|
* -1 : failure
|
|
*/
|
|
int bs_list_find(const BS_LIST *list, const void *data);
|
|
|
|
/* Add an element with associated id to the list
|
|
*
|
|
* return value:
|
|
* 1 : success
|
|
* 0 : failure (data already in list)
|
|
*/
|
|
int bs_list_add(BS_LIST *list, const void *data, int id);
|
|
|
|
/* Remove element from the list
|
|
*
|
|
* return value:
|
|
* 1 : success
|
|
* 0 : failure (element not found or id does not match)
|
|
*/
|
|
int bs_list_remove(BS_LIST *list, const void *data, int id);
|
|
|
|
/* Removes the memory overhead
|
|
*
|
|
* return value:
|
|
* 1 : success
|
|
* 0 : failure
|
|
*/
|
|
int bs_list_trim(BS_LIST *list);
|
|
|
|
#endif
|