the_Foundation 1.0
Loading...
Searching...
No Matches
Data Structures | Macros | Typedefs | Functions
list.h File Reference
#include "defs.h"

Data Structures

struct  iListNode
 
struct  iList
 
struct  iListReverseIterator
 
struct  iListReverseConstIterator
 

Macros

#define begin_List(d)   (&(d)->root.next)
 
#define end_List(d)   (&(d)->root)
 
#define isEmpty_List(d)   (size_List(d) == 0)
 

Typedefs

typedef int(* iListCompareFunc) (const iAny *, const iAny *)
 

Functions

iList * new_List (void)
 
void delete_List (iList *)
 
void init_List (iList *)
 
void deinit_List (iList *)
 
size_t size_List (const iList *)
 
iAny * front_List (const iList *)
 
iAny * back_List (const iList *)
 
void clear_List (iList *)
 
iAny * pushBack_List (iList *, iAny *node)
 
iAny * pushFront_List (iList *, iAny *node)
 
iAny * insertAfter_List (iList *, iAny *after, iAny *node)
 
iAny * insertBefore_List (iList *, iAny *before, iAny *node)
 
iAny * remove_List (iList *, iAny *node)
 
iAny * popFront_List (iList *)
 
iAny * popBack_List (iList *)
 
void sort_List (iList *, iListCompareFunc cmp)
 
Iterators
void init_ListIterator (iListIterator *, iList *)
 
void next_ListIterator (iListIterator *)
 
void init_ListReverseIterator (iListReverseIterator *, iList *)
 
void next_ListReverseIterator (iListReverseIterator *)
 
void init_ListConstIterator (iListConstIterator *, const iList *)
 
void next_ListConstIterator (iListConstIterator *)
 
void init_ListReverseConstIterator (iListReverseConstIterator *, const iList *)
 
void next_ListReverseConstIterator (iListReverseConstIterator *)
 

Detailed Description

Doubly linked list.

List is doubly-linked, and uses a sentinel node representing the start/end of the list.

Sentinel <--> Node
   ʌ           ʌ
   |           |
   v           v
  Node <----> Node

List does not have ownership of the nodes. This means the nodes can be any type of object as long as they are derived from ListNode.

Authors
Copyright (c) 2017 Jaakko Keränen jaakk.nosp@m.o.ke.nosp@m.ranen.nosp@m.@iki.nosp@m..fi
License

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.