---

frdi_list.h File Reference

function headers for frdi_list.c More...

Go to the source code of this file.

Functions
frdi_list *	frdiListNew ()
void	frdiListSetStringHandler (frdi_list *list, frdi_handler *handler)
void	frdiListFree (frdi_list *list)
void	frdiListSetException (frdi_list *list, frdi_exception *eh)
frdi_list_node *	frdiListAdd (frdi_list *list, void *value)
frdi_list_node *	frdiListSet (frdi_list *list, int idx, void *value)
frdi_list_node *	frdiListInsert (frdi_list *list, int idx, void *value)
void	frdiListRemove (frdi_list *list, int idx)
void *	frdiListGet (frdi_list *list, int idx)
frdi_list_node *	frdiListGetNode (frdi_list *list, int idx)
void *	frdiListPop (frdi_list *list)
void	frdiListPush (frdi_list *list, void *value)
frdi_list *	frdiListIterate (frdi_list *list, frdi_handler *handler)
frdi_list *	frdiListMap (frdi_list *list, frdi_handler *handler)
int	frdiListGetSize (frdi_list *list)
char *	frdiListDisplay (frdi_list *list)
int	frdiListFind (frdi_list *list, void *value)
char *	frdiListString (frdi_list *list, void *value)

---

Detailed Description

function headers for frdi_list.c

Author:

Douglas Reay <douglas-legal@reay.org>

Warning:

• This is OSI Certified Open Source Software. Part of Project Fairdice <http://fairdice.sourceforge.net/>
• Copyright (c) Original Author, 2004. All rights reserved.
• Permission is hereby granted to use, modify and redistribute the contents of this file under the terms of either LGPL 2.1 or MPL 1.1 licenses as published at gnu.org mozilla.org or opensource.org.
• Disclaimer: This code is distributed WITHOUT ANY WARRANTY. ALL WARRANTIES, EXPRESS OR IMPLIED ARE HEREBY DISCLAMED. This includes but is not limited to warranties of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

---

Function Documentation

frdi_list* frdiListNew (    )

Create Object

void frdiListSetStringHandler (  frdi_list *    list, frdi_handler *    handler )

what type is this list? takes a method that casts the type to a string

void frdiListFree (  frdi_list *    list )

Releases the list and all the node, but not their values

void frdiListSetException (  frdi_list *    list, frdi_exception *    eh )

Set the exception handler

frdi_list_node* frdiListAdd (  frdi_list *    list, void *    value )

Creates a new node holding the value, and adds it to the end of the list

frdi_list_node* frdiListSet (  frdi_list *    list, int    idx, void *    value )

Set the value of an existing node in the list

frdi_list_node* frdiListInsert (  frdi_list *    list, int    idx, void *    value )

Insert the value as a new node in the list

void frdiListRemove (  frdi_list *    list, int    idx )

Remove a node from the list

void* frdiListGet (  frdi_list *    list, int    idx )

Get the value held in a node of the list

frdi_list_node* frdiListGetNode (  frdi_list *    list, int    idx )

Get a node of the list

void* frdiListPop (  frdi_list *    list )

Remove the last node and return its value

void frdiListPush (  frdi_list *    list, void *    value )

see frdiListAdd()

frdi_list* frdiListIterate (  frdi_list *    list, frdi_handler *    handler )

Calls the function 'handler' with the values, one by one

frdi_list* frdiListMap (  frdi_list *    list, frdi_handler *    handler )

Calls the function 'handler' with the nodes, one by one It expects back node objects and links the non-NULL ones into a new list.

int frdiListGetSize (  frdi_list *    list )

how many nodes are there in the list?

char* frdiListDisplay (  frdi_list *    list )

Return a string representation of the list

int frdiListFind (  frdi_list *    list, void *    value )

Return the index of the first node whose value matches value

char* frdiListString (  frdi_list *    list, void *    value )

return a string representation of a void*

---