c_list.h

Go to the documentation of this file.

/*
 *     SocialLedge.com - Copyright (C) 2013
 *
 *     This file is part of free software framework for embedded processors.
 *     You can use it and/or distribute it as long as this copyright header
 *     remains unmodified.  The code is free for personal use and requires
 *     permission to use in a commercial product.
 *
 *      THIS SOFTWARE IS PROVIDED "AS IS".  NO WARRANTIES, WHETHER EXPRESS, IMPLIED
 *      OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
 *      MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE.
 *      I SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR
 *      CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
 *
 *     You can reach the author of this software at :
 *          p r e e t . w i k i @ g m a i l . c o m
 */

#ifndef C_LIST_H_
#define C_LIST_H_


/**************/
#include <stdint.h>
#include <stdbool.h>
#ifdef __cplusplus
extern "C" {
#endif


/************/
typedef bool (*c_list_callback_t)(void *elm_ptr, void *arg1, void *arg2, void *arg3);

typedef void* c_list_ptr;

c_list_ptr c_list_create(void);

bool c_list_delete(c_list_ptr list, c_list_callback_t delete_callback);

uint32_t c_list_node_count(const c_list_ptr list);

bool c_list_insert_elm_beg(c_list_ptr list, const void *elm_ptr);
bool c_list_insert_elm_end(c_list_ptr list, const void *elm_ptr);
void* c_list_get_elm_at(c_list_ptr list, uint32_t index, void **hint);

void* c_list_find_elm(c_list_ptr list, c_list_callback_t callback,
                      void *arg1, void *arg2, void *arg3);

bool c_list_delete_elm(c_list_ptr list, const void *elm_ptr);

bool c_list_for_each_elm(const c_list_ptr list, c_list_callback_t func,
                           void *arg1, void *arg2, void *arg3);



#ifdef __cplusplus
}
#endif
#endif /* C_LIST_H_ */