linked_list.h

Go to the documentation of this file.

/*
** Copyright 2014-2016 The Earlham Institute
** 
** 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 LINKED_LIST_H
#define LINKED_LIST_H
 
#include "typedefs.h"
#include "grassroots_util_library.h"
 
 
 
/******** FORWARD DECLARATION ******/
typedef struct ListItem ListItem;
 
struct ListItem
{
  ListItem *ln_prev_p;    
  ListItem *ln_next_p;    
};
 
 
typedef struct LinkedList
{
  ListItem *ll_head_p;
 
  ListItem *ll_tail_p;
 
  uint32 ll_size;
 
  void (*ll_free_node_fn_p) (ListItem * node_p);
 
} LinkedList;
 
#ifdef __cplusplus
extern "C" 
{
#endif
 
GRASSROOTS_UTIL_API LinkedList *AllocateLinkedList (void (*free_node_fn_p) (ListItem * const node_p));
 
 
GRASSROOTS_UTIL_API void FreeLinkedList (LinkedList * const list_p);
 
 
GRASSROOTS_UTIL_API void InitLinkedList (LinkedList * const list_p);
 
 
GRASSROOTS_UTIL_API void LinkedListAddHead (LinkedList * const list_p, ListItem * const node_p);
 
 
GRASSROOTS_UTIL_API void LinkedListAddTail (LinkedList * const list_p, ListItem * const node_p);
 
 
GRASSROOTS_UTIL_API ListItem *LinkedListRemHead (LinkedList * const list_p);
 
 
GRASSROOTS_UTIL_API ListItem *LinkedListRemTail (LinkedList * const list_p);
 
 
GRASSROOTS_UTIL_API void LinkedListRemove (LinkedList * const list_p, ListItem * const node_p);
 
 
GRASSROOTS_UTIL_API bool LinkedListSort (LinkedList * const list_p, int (*compare_nodes_fn) (const void *v1_p, const void *v2_p));
 
 
GRASSROOTS_UTIL_API void SetLinkedListFreeNodeFunction (LinkedList * const list_p, void (*free_node_fn) (ListItem * const node_p));
 
 
GRASSROOTS_UTIL_API void LinkedListPrioritisedInsert (LinkedList * const list_p, ListItem * const node_p, int (*compare_nodes_fn) (const void *v1_p, const void *v2_p));
 
 
GRASSROOTS_UTIL_API void LinkedListInsert (LinkedList * const list_p, ListItem * const prev_node_p, ListItem * const node_to_insert_p);
 
 
GRASSROOTS_UTIL_API ListItem *LinkedListBinarySearch (const LinkedList * const list_p, const ListItem * const node_p, int (*compare_nodes_fn) (const void *v1_p, const void *v2_p), int * const index_p);
 
 
GRASSROOTS_UTIL_API void MoveListContents (LinkedList * const src_list_p, LinkedList * const dest_list_p);
 
 
GRASSROOTS_UTIL_API LinkedList *SplitList (LinkedList * const list_p, const uint32 split_list_head_index);
 
 
GRASSROOTS_UTIL_API void ClearLinkedList (LinkedList * const list_p);
 
 
GRASSROOTS_UTIL_API void InitListItem (ListItem * const item_p);
 
 
 
#ifdef __cplusplus
}
#endif
 
#endif  /* LINKED_LIST_H */