osip_list.h

Go to the documentation of this file.

/*
  The oSIP library implements the Session Initiation Protocol (SIP -rfc3261-)
  Copyright (C) 2001,2002,2003,2004,2005,2006,2007 Aymeric MOIZARD jack@atosc.org
  
  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.
  
  This library 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
  Lesser General Public License for more details.
  
  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/


#ifndef _LIST_H_
#define _LIST_H_

#ifdef ENABLE_MPATROL
#include <mpatrol.h>
#endif

#ifdef __cplusplus
extern "C" {
#endif

#ifndef DOXYGEN

        typedef struct __node __node_t;

        struct __node {
                __node_t *next;                         
                void *element;                  
        };
#endif

        typedef struct osip_list osip_list_t;

        typedef struct {
                __node_t *actual;
                __node_t **prev;
                osip_list_t *li;
                int pos;
        } osip_list_iterator_t;

        struct osip_list {

                int nb_elt;             
                __node_t *node; 
        };

        int osip_list_init(osip_list_t * li);
        void osip_list_special_free(osip_list_t * li, void (*free_func) (void *));
        int osip_list_clone(const osip_list_t * src, osip_list_t * dst,
                                                int (*clone_func) (void *, void **));
        void osip_list_ofchar_free(osip_list_t * li);
        int osip_list_size(const osip_list_t * li);
        int osip_list_eol(const osip_list_t * li, int pos);
        int osip_list_add(osip_list_t * li, void *element, int pos);
        void *osip_list_get(const osip_list_t * li, int pos);
        int osip_list_remove(osip_list_t * li, int pos);

#define osip_list_iterator_has_elem( it ) ( 0 != (it).actual && (it).pos < (it).li->nb_elt )

        void *osip_list_get_first(osip_list_t * li, osip_list_iterator_t * it);
        void *osip_list_get_next(osip_list_iterator_t * it);
        void *osip_list_iterator_remove(osip_list_iterator_t * it);

#ifdef __cplusplus
}
#endif

#endif