icl_list.h File Reference

dependency free linked list More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	icl_list_s

Macros
#define	icl_list_foreach(list, ptr)   for (ptr = icl_list_first(list); ptr != NULL; ptr = icl_list_next(list, ptr))

Typedefs
typedef struct icl_list_s	icl_list_t

Functions
icl_list_t *	icl_list_new ()
	Create new linked list. More...
icl_list_t *	icl_list_insert (icl_list_t *, icl_list_t *, void *)
	Insert a new node after the specified node. More...
icl_list_t *	icl_list_search (icl_list_t *, void *, int(*)(void *, void *))
	Finds a data item in the specified linked list. More...
icl_list_t *	icl_list_first (icl_list_t *)
	Get the first item in this linked list. More...
icl_list_t *	icl_list_last (icl_list_t *)
	Get the last item in this linked list. More...
icl_list_t *	icl_list_next (icl_list_t *, icl_list_t *)
	Get the node following the specified node. More...
icl_list_t *	icl_list_prev (icl_list_t *, icl_list_t *)
	Get the node preceding the specified node. More...
icl_list_t *	icl_list_concat (icl_list_t *, icl_list_t *)
	Concatenate two linked lists. More...
icl_list_t *	icl_list_prepend (icl_list_t *, void *)
	Insert a node at the beginning of this list. More...
icl_list_t *	icl_list_append (icl_list_t *, void *)
	Insert a node at the end of this list. More...
int	icl_list_delete (icl_list_t *, icl_list_t *, void(*)(void *))
	Delete the specified node. More...
int	icl_list_destroy (icl_list_t *, void(*)(void *))
	Frees the resources associated with this linked list. More...
int	icl_list_size (icl_list_t *)
	Get the number of items in this linked list. More...

Detailed Description

dependency free linked list

Author

Keith Seymour

Jakub Kurzak

PULSAR Runtime /pulsar/ Copyright (C) 2012-2013 University of Tennessee.

Definition in file icl_list.h.

Macro Definition Documentation

#define icl_list_foreach	(		list,
			ptr
	)		for (ptr = icl_list_first(list); ptr != NULL; ptr = icl_list_next(list, ptr))

Definition at line 40 of file icl_list.h.

Typedef Documentation

typedef struct icl_list_s icl_list_t

Function Documentation

icl_list_t* icl_list_append	(	icl_list_t *	head,
		void *	data
	)

Insert a node at the end of this list.

Parameters

head	– the linked list
data	– the data to be inserted

Returns

pointer to the new node. returns NULL on error.

Definition at line 297 of file icl_list.c.

References icl_list_s::blink, and icl_list_insert().

{
    return (icl_list_insert(head, head->blink, data));
}

Here is the call graph for this function:

Here is the caller graph for this function:

icl_list_t* icl_list_concat	(	icl_list_t *	head1,
		icl_list_t *	head2
	)

Concatenate two linked lists.

Parameters

head1	– the first linked list
head2	– the second linked list

Returns

pointer to the new linked list, which consists of <head1,head2>. returns NULL on error.

Definition at line 261 of file icl_list.c.

References icl_list_s::blink, and icl_list_s::flink.

{
    if (!head1 || !head2 || !head1->blink || !head2->flink)
        return NULL;

    head1->blink->flink = head2->flink;
    head2->flink->blink = head1->blink;
    head1->blink = head2->blink;

    free(head2);
    return(head1);
}

int icl_list_delete	(	icl_list_t *	head,
		icl_list_t *	pos,
		void(*)(void *)	free_function
	)

Delete the specified node.

Parameters

head	– the linked list containing the node to be deleted
pos	– the node to be deleted
free_function	– pointer to function that frees the node data

Returns

0 on success, -1 on failure.

Definition at line 83 of file icl_list.c.

References icl_list_s::blink, icl_list_s::data, and icl_list_s::flink.

{
    if (!pos || !head)
        return -1;
    if (pos == head)
        return -1;

    if (free_function && pos->data)
        (*free_function)(pos->data);

    pos->blink->flink = pos->flink;

    if (pos->flink)
        pos->flink->blink = pos->blink;
    else
        head->blink = pos->blink; /* pos at end of list */

    free(pos);
    return 0;
}

Here is the caller graph for this function:

int icl_list_destroy	(	icl_list_t *	head,
		void(*)(void *)	free_function
	)

Frees the resources associated with this linked list.

Parameters

head	– the linked list to be destroyed
free_function	– pointer to function that frees the node's data

Returns

0 on success, -1 on failure.

Definition at line 144 of file icl_list.c.

References icl_list_s::data, and icl_list_s::flink.

{
    icl_list_t *node, *tmpnode;

    if (!head)
        return -1;

    for (node = head; node != NULL;) {
        tmpnode = node->flink;

        if (free_function != NULL && node->data != NULL)
            (*free_function)(node->data);

        free(node);
        node = tmpnode;
    }
    return 0;
}

Here is the caller graph for this function:

icl_list_t* icl_list_first

(

icl_list_t *

head

)

Get the first item in this linked list.

Parameters

head	– the linked list

Returns

pointer to the first item. returns NULL on error.

Definition at line 192 of file icl_list.c.

References icl_list_s::flink.

{
    if (head)
        return head->flink;

    return NULL;
}

Here is the caller graph for this function:

icl_list_t* icl_list_insert	(	icl_list_t *	head,
		icl_list_t *	pos,
		void *	data
	)

Insert a new node after the specified node.

Parameters

head	– the linked list
pos	– points to the position of the new node (it will be inserted after this node)
data	– pointer to the data that is to be inserted

Returns

pointer to the new node. returns NULL on error.

Definition at line 49 of file icl_list.c.

References icl_list_s::blink, icl_list_s::data, and icl_list_s::flink.

{
    icl_list_t *node;

    if(!head || !pos)
        return NULL;

    node = (icl_list_t*)malloc(sizeof(icl_list_t));
    if (!node)
        return NULL;

    node->blink = pos;
    node->flink = pos->flink;
    node->data = data;

    if (pos->flink)
        pos->flink->blink = node;
    else
        head->blink = node; /* node at end of list */

    pos->flink = node;
    return node;
}

Here is the caller graph for this function:

icl_list_t* icl_list_last

(

icl_list_t *

head

)

Get the last item in this linked list.

Parameters

head	– the linked list

Returns

pointer to the last item. returns NULL on error.

Definition at line 208 of file icl_list.c.

References icl_list_s::blink.

{
    if (head)
        return head->blink;

    return NULL;
}

icl_list_t* icl_list_new

(

)

Create new linked list.

Returns

pointer to new linked list. returns NULL on error.

Definition at line 23 of file icl_list.c.

References icl_list_s::blink, icl_list_s::data, and icl_list_s::flink.

{
    icl_list_t *node;

    node = (icl_list_t*)malloc(sizeof(icl_list_t));
    if (!node)
        return NULL;

    node->flink = NULL;
    node->blink = node;
    node->data = NULL;

    return(node);
}

Here is the caller graph for this function:

icl_list_t* icl_list_next	(	icl_list_t *	head,
		icl_list_t *	pos
	)

Get the node following the specified node.

Parameters

head	– the list containing the specified node
pos	– the node whose successor should be returned

Returns

pointer to the next node. returns NULL on error.

Definition at line 225 of file icl_list.c.

References icl_list_s::flink.

{
    if(pos)
        return pos->flink;

    return NULL;
}

Here is the caller graph for this function:

icl_list_t* icl_list_prepend	(	icl_list_t *	head,
		void *	data
	)

Insert a node at the beginning of this list.

Parameters

head	– the linked list
data	– the data to be inserted

Returns

pointer to the new node. returns NULL on error.

Definition at line 283 of file icl_list.c.

References icl_list_insert().

{
    return (icl_list_insert(head, head, data));
}

Here is the call graph for this function:

Here is the caller graph for this function:

icl_list_t* icl_list_prev	(	icl_list_t *	head,
		icl_list_t *	pos
	)

Get the node preceding the specified node.

Parameters

head	– the list containing the specified node
pos	– the node whose predecessor should be returned

Returns

pointer to the previous node. returns NULL on error.

Definition at line 242 of file icl_list.c.

References icl_list_s::blink.

{
    if (pos && pos->blink != NULL && pos != head &&
        pos->blink != head && pos->blink != pos)
        return pos->blink;

    return NULL;
}

icl_list_t* icl_list_search	(	icl_list_t *	head,
		void *	data,
		int(*)(void *, void *)	compare
	)

Finds a data item in the specified linked list.

Parameters

head	– the linked list
data	– the data to be found
compare	– function that compares the data items

Returns

pointer to the node, if found. otherwise returns NULL.

Definition at line 115 of file icl_list.c.

References icl_list_s::data, and icl_list_s::flink.

{
    icl_list_t *node;

    if (!head)
        return NULL;

    for (node = head->flink; node != NULL; node = node->flink) {
        if (!node->data)
            continue;
        if ((compare && (*compare)(node->data, data) == 0))
            break;
        else if (node->data == data)
            break; /* compare == NULL, then direct comparison of pointers */
    }
    return(node);
}

Here is the caller graph for this function:

int icl_list_size

(

icl_list_t *

head

)

Get the number of items in this linked list.

Parameters

head	– the linked list

Returns

the number of items in the list. returns -1 on error.

Definition at line 171 of file icl_list.c.

References icl_list_s::flink.

{
    int size = 0;

    if (!head)
        return -1;

    while ((head=head->flink))
        size++;

    return size;
}

Here is the caller graph for this function: