list.h revision 46060a4bc5ef66ad6fb489730c6cfc34a414cfbf
/** @file
* IPRT - Generic Doubly Linked List.
*/
/*
* Copyright (C) 2010 Sun Microsystems, Inc.
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
* Clara, CA 95054 USA or visit http://www.sun.com if you need
* additional information or have any questions.
*/
#ifndef ___iprt_list_h
#define ___iprt_list_h
/** @defgroup grp_rt_list RTList - Generic Doubly Linked List
* @ingroup grp_rt
*
* The list implementation is circular without any type wise distintion between
* the list and its nodes. This can be confusing since the list head usually
* resides in a different structure than the nodes, so care must be taken when
* walking the list.
*
* @{
*/
/**
* A list node of a doubly linked list.
*/
typedef struct RTLISTNODE
{
/** Pointer to the next list node. */
struct RTLISTNODE *pNext;
/** Pointer to the previous list node. */
struct RTLISTNODE *pPrev;
} RTLISTNODE;
/** Pointer to a list node. */
typedef RTLISTNODE *PRTLISTNODE;
/** Pointer to a list node pointer. */
typedef PRTLISTNODE *PPRTLISTNODE;
/**
* Initialize a list.
*
* @param pList Pointer to an unitialised list.
*/
{
}
/**
* Append a node to the end of the list.
*
* @param pList The list to append the node to.
* @param pNode The node to append.
*/
{
}
/**
* Add a node as the first element of the list.
*
* @param pList The list to prepend the node to.
* @param pNode The node to prepend.
*/
{
}
/**
* Remove a node from a list.
*
* @param pNode The node to remove.
*/
{
/* poison */
}
/**
* Checks if a node is the last element in the list.
*
* @retval @c true if the node is the last element in the list.
* @retval @c false otherwise
*
* @param pList The list.
* @param pNode The node to check.
*/
/**
* Checks if a node is the first element in the list.
*
* @retval @c true if the node is the first element in the list.
* @retval @c false otherwise.
*
* @param pList The list.
* @param pNode The node to check.
*/
/**
* Checks if a list is empty.
*
* @retval @c true if the list is empty.
* @retval @c false otherwise.
*
* @param pList The list to check.
*/
/**
* Returns the next node in the list.
*
* @returns The next node.
*
* @param pCurNode The current node.
* @param Type Structure the list node is a member of.
* @param Member The list node member.
*/
/**
* Returns the previous node in the list.
*
* @returns The previous node.
*
* @param pCurNode The current node.
* @param Type Structure the list node is a member of.
* @param Member The list node member.
*/
/**
* Returns the first element in the list (checks for empty list).
*
* @retval Pointer to the first list element.
* @retval NULL if the list is empty.
*
* @param pList List to get the first element from.
* @param Type Structure the list node is a member of.
* @param Member The list node member.
*/
/**
* Returns the last element in the list (checks for empty list).
*
* @retval Pointer to the last list element.
* @retval NULL if the list is empty.
*
* @param pList List to get the last element from.
* @param Type Structure the list node is a member of.
* @param Member The list node member.
*/
/** @} */
#endif