linked_list.h

Go to the documentation of this file.

// Copyright (C) 2011 CNRS - Ecole Polytechnique - INRIA.
//
// This file is part of TIFA.
//
// TIFA is free software; you can redistribute it and/or modify it under the 
// terms of the GNU Lesser General Public License as published by the Free
// Software Foundation; either version 2.1 of the License, or (at your option)
// any later version.
//
// TIFA 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 Lesser General Public License for
// more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this library; if not, write to the Free Software Foundation,
// Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA.

#if !defined(_TIFA_LINKED_LIST_H_)

#define _TIFA_LINKED_LIST_H_

#include <inttypes.h>

#ifdef __cplusplus
extern "C" {
#endif

struct struct_linked_list_node_t {
    struct struct_linked_list_node_t* next;
    void*  data;
};

struct struct_linked_list_t {
    struct struct_linked_list_node_t* head;
    struct struct_linked_list_node_t* tail;
    int    (*cmp_func) (const void* const data_a, const void* const data_b);
    uint32_t length;
};

typedef struct struct_linked_list_t linked_list_t;

typedef struct struct_linked_list_node_t linked_list_node_t;

void init_linked_list(linked_list_t* const list,
                      int (*cmp_func) (const void* const data_a,
                                       const void* const data_b) );

void clear_linked_list(linked_list_t* const list);

void append_to_linked_list(linked_list_t* const list, void* const data);

void prepend_to_linked_list(linked_list_t* const list, void* const data);


void* pop_linked_list(linked_list_t* const list);

void* push_linked_list(linked_list_t* const list);

void insert_in_linked_list(linked_list_t* const list, void* const data);

linked_list_node_t* get_node_in_linked_list(linked_list_t* const list,
                                            void* const data);

linked_list_node_t* remove_from_linked_list(linked_list_t* const list,
                                            void* const data);

void remove_node_from_linked_list(linked_list_t* const list,
                                  linked_list_node_t* const node);

void delete_in_linked_list(linked_list_t* const list, void* const data);

#ifdef __cplusplus
}
#endif

#endif

---