kaa_list.h

Go to the documentation of this file.

/*
 * Copyright 2014-2016 CyberVision, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef KAA_LIST_H_
#define KAA_LIST_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <stdbool.h>
#include <stddef.h>

#include "kaa_error.h"

typedef struct kaa_list_node_t kaa_list_node_t;
typedef struct kaa_list_t kaa_list_t;

typedef bool (*match_predicate)(void *data, void *context);

typedef void (*deallocate_list_data)(void *);

typedef uint64_t list_node_hash(void * item);

typedef void (*process_data)(void *data, void *context);

kaa_list_t *kaa_list_create(void);

void kaa_list_destroy(kaa_list_t *list, deallocate_list_data deallocator);

void kaa_list_clear(kaa_list_t *list, deallocate_list_data deallocator);

size_t kaa_list_get_size(kaa_list_t *list);

kaa_list_node_t *kaa_list_push_front(kaa_list_t *list, void *data);

kaa_list_node_t *kaa_list_push_back(kaa_list_t *list, void *data);

kaa_list_node_t *kaa_list_begin(kaa_list_t *list);

kaa_list_node_t *kaa_list_back(kaa_list_t *list);

kaa_list_node_t *kaa_list_next(kaa_list_node_t *it);

kaa_list_node_t *kaa_list_prev(kaa_list_node_t *it);

void *kaa_list_get_data(kaa_list_node_t *it);

void kaa_list_set_data_at(kaa_list_node_t *it, void *data, deallocate_list_data deallocator);

kaa_list_node_t *kaa_list_find_next(kaa_list_node_t *from, match_predicate pred, void *context);

kaa_list_t *kaa_lists_merge(kaa_list_t *destination, kaa_list_t *source);

kaa_list_node_t *kaa_list_remove_at(kaa_list_t *list, kaa_list_node_t *it, deallocate_list_data deallocator);

kaa_error_t kaa_list_remove_first(kaa_list_t *list, match_predicate pred, void *context, deallocate_list_data deallocator);

void kaa_list_for_each(kaa_list_node_t *first, kaa_list_node_t *last, process_data process, void *context);

void kaa_list_sort(kaa_list_t *list, match_predicate pred);

int32_t kaa_list_hash(kaa_list_t *list, list_node_hash pred);

#ifdef __cplusplus
} // extern "C"
#endif
#endif /* KAA_LIST_H_ */