list.h

Go to the documentation of this file.

/* 
 * Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
 * Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 
 */
#ifndef __PJ_LIST_H__
#define __PJ_LIST_H__
 
#include <pj/types.h>
 
PJ_BEGIN_DECL
 
/*
 * @defgroup PJ_DS Data Structure.
 */
 
#define PJ_DECL_LIST_MEMBER(type)                       \
 \
                                   type *prev;          \
 \
                                   type *next 
 
 
struct pj_list
{
    PJ_DECL_LIST_MEMBER(void);
} PJ_ATTR_MAY_ALIAS; /* may_alias avoids warning with gcc-4.4 -Wall -O2 */
 
 
PJ_INLINE(void) pj_list_init(pj_list_type * node)
{
    ((pj_list*)node)->next = ((pj_list*)node)->prev = node;
}
 
 
PJ_INLINE(int) pj_list_empty(const pj_list_type * node)
{
    return ((pj_list*)node)->next == node;
}
 
 
PJ_IDECL(void)  pj_list_insert_before(pj_list_type *pos, pj_list_type *node);
 
 
PJ_INLINE(void) pj_list_push_back(pj_list_type *list, pj_list_type *node)
{
    pj_list_insert_before(list, node);
}
 
 
PJ_IDECL(void) pj_list_insert_nodes_before(pj_list_type *lst,
                                           pj_list_type *nodes);
 
PJ_IDECL(void) pj_list_insert_after(pj_list_type *pos, pj_list_type *node);
 
 
PJ_INLINE(void) pj_list_push_front(pj_list_type *list, pj_list_type *node)
{
    pj_list_insert_after(list, node);
}
 
 
PJ_IDECL(void) pj_list_insert_nodes_after(pj_list_type *lst,
                                          pj_list_type *nodes);
 
 
PJ_IDECL(void) pj_list_merge_first(pj_list_type *list1, pj_list_type *list2);
 
 
PJ_IDECL(void) pj_list_merge_last( pj_list_type *list1, pj_list_type *list2);
 
 
PJ_IDECL(void) pj_list_erase(pj_list_type *node);
 
 
PJ_IDECL(pj_list_type*) pj_list_find_node(pj_list_type *list, 
                                          pj_list_type *node);
 
 
PJ_IDECL(pj_list_type*) pj_list_search(pj_list_type *list, void *value,
                                       int (*comp)(void *value, 
                                                   const pj_list_type *node)
                                       );
 
 
PJ_IDECL(pj_size_t) pj_list_size(const pj_list_type *list);
 
 
#if PJ_FUNCTIONS_ARE_INLINED
#  include "list_i.h"
#endif
 
PJ_END_DECL
 
#endif  /* __PJ_LIST_H__ */