src/protocols/icq/list.h

   1 /* -*- Mode: C; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2
   3 /*
   4  * $Id: list.h 2096 2001-07-31 01:00:39Z warmenhoven $
   5  *
   6  * Copyright (C) 1998-2001, Denis V. Dmitrienko <denis@null.net> and
   7  *                          Bill Soudan <soudan@kde.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  22  *
  23  */
  24
  25 #ifndef _LIST_H
  26 #define _LIST_H
  27
  28 #ifdef HAVE_CONFIG_H
  29 #include <config.h>
  30 #endif
  31
  32 #include <stdarg.h>
  33
  34 #define icq_ListEnqueue(plist, p) \
  35    icq_ListInsert(plist, 0, p)
  36
  37 #define icq_ListDequeue(plist) \
  38   icq_ListRemoveNode(plist, plist->head)
  39
  40 typedef struct icq_ListNode_s icq_ListNode;
  41 typedef struct icq_List_s icq_List;
  42 typedef int (*icq_ListCompareFunc)(void *o1, void *o2);
  43
  44 struct icq_ListNode_s
  45 {
  46   icq_ListNode *next;
  47   icq_ListNode *previous;
  48   void *item;
  49 };
  50
  51 struct icq_List_s
  52 {
  53   icq_ListNode *head;
  54   icq_ListNode *tail;
  55   int count;
  56   icq_ListCompareFunc compare_function;
  57 };
  58
  59 icq_List *icq_ListNew(void);
  60 void icq_ListDelete(icq_List *plist, void (*item_free_f)(void *));
  61 void icq_ListFree(icq_List *plist, void (*item_free_f)(void *));
  62 void icq_ListInsertSorted(icq_List *plist, void *pitem);
  63 void icq_ListInsert(icq_List *plist, icq_ListNode *pnode, void *pitem);
  64 void *icq_ListRemove(icq_List *plist, void *pitem);
  65 void *icq_ListTraverse(icq_List *plist, int (*item_f)(void *, va_list), ...);
  66 int icq_ListDump(icq_List *plist);
  67 void *icq_ListFirst(icq_List *plist);
  68 void *icq_ListLast(icq_List *plist);
  69 void *icq_ListAt(icq_List *plist, int num);
  70 icq_ListNode *icq_ListFind(icq_List *plist, void *pitem);
  71 void *icq_ListRemoveNode(icq_List *plist, icq_ListNode *p);
  72
  73 #endif /* _LIST_H */