sources/internal_includes/list.h

Go to the documentation of this file.

/*
** Copyright 2009-2011, helixis.org
** All rights reserved.
**
** Redistribution and use in source and binary forms, with or without modification, are permitted provided
** that the following conditions are met:
**
** Redistributions of source code must retain the above copyright notice, this list of conditions and the
** following disclaimer.
**
** 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.
**
** Neither the name of the helixis.org nor the names of its contributors may be used to endorse or promote
** products derived from this software without specific prior written permission.
**
** 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 HOLDER 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.
*/

#ifndef __HLX_LIST_H__
# define __HLX_LIST_H__

#ifdef __cplusplus
extern "C"      {
#endif

/*
** TYPES
*/
typedef struct                _hlx_list_node
{
        void*                     data;
        struct _hlx_list_node*    parent;
        struct _hlx_list_node*    next;
}                             hlx_list_node;

typedef struct
{
        hlx_list_node*            first;
        hlx_list_node*            last;
        atom_t                    size;
}                             hlx_list;

/*
** FUNCTIONS
*/
void             hlx_list_construct(hlx_list*);
void             hlx_list_destruct(hlx_list*);
hlx_list_node*   hlx_list_push_front(hlx_list*, void*);
hlx_list_node*   hlx_list_push_back(hlx_list*, void*);
hlx_list_node*   hlx_list_find(const hlx_list*, void*);
hlx_list_node*   hlx_list_get(const hlx_list*, unsigned int);
void             hlx_list_erase(hlx_list*, hlx_list_node*);
void             hlx_list_clear(hlx_list*);
void             hlx_list_clear_data(hlx_list*);
unsigned int     hlx_list_empty(const hlx_list*);

#ifdef __cplusplus
}
#endif

#endif /* !__HLX_LIST_H__ */

/*
** END OF FILE
*/