dbus/dbus-list.h

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-list.h Generic linked list utility (internal to D-BUS implementation)
   3  *
   4  * Copyright (C) 2002, 2003 Red Hat, Inc.
   5  *
   6  * Licensed under the Academic Free License version 2.0
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  */
  23
  24 #ifndef DBUS_LIST_H
  25 #define DBUS_LIST_H
  26
  27 #include <dbus/dbus-internals.h>
  28 #include <dbus/dbus-memory.h>
  29 #include <dbus/dbus-types.h>
  30
  31 DBUS_BEGIN_DECLS;
  32
  33 typedef struct DBusList DBusList;
  34
  35 struct DBusList
  36 {
  37   DBusList *prev; /**< Previous list node. */
  38   DBusList *next; /**< Next list node. */
  39   void     *data; /**< Data stored at this element. */
  40 };
  41 dbus_bool_t _dbus_list_append             (DBusList **list,
  42                                            void      *data);
  43 dbus_bool_t _dbus_list_prepend            (DBusList **list,
  44                                            void      *data);
  45 dbus_bool_t _dbus_list_insert_before      (DBusList **list,
  46                                            DBusList  *before_this_link,
  47                                            void      *data);
  48 dbus_bool_t _dbus_list_insert_after       (DBusList **list,
  49                                            DBusList  *after_this_link,
  50                                            void      *data);
  51 void        _dbus_list_insert_before_link (DBusList **list,
  52                                            DBusList  *before_this_link,
  53                                            DBusList  *link);
  54 void        _dbus_list_insert_after_link  (DBusList **list,
  55                                            DBusList  *after_this_link,
  56                                            DBusList  *link);
  57 dbus_bool_t _dbus_list_remove             (DBusList **list,
  58                                            void      *data);
  59 dbus_bool_t _dbus_list_remove_last        (DBusList **list,
  60                                            void      *data);
  61 void        _dbus_list_remove_link        (DBusList **list,
  62                                            DBusList  *link);
  63 DBusList*   _dbus_list_find_last          (DBusList **list,
  64                                            void      *data);
  65 void        _dbus_list_clear              (DBusList **list);
  66 DBusList*   _dbus_list_get_first_link     (DBusList **list);
  67 DBusList*   _dbus_list_get_last_link      (DBusList **list);
  68 void*       _dbus_list_get_last           (DBusList **list);
  69 void*       _dbus_list_get_first          (DBusList **list);
  70 void*       _dbus_list_pop_first          (DBusList **list);
  71 void*       _dbus_list_pop_last           (DBusList **list);
  72 DBusList*   _dbus_list_pop_first_link     (DBusList **list);
  73 DBusList*   _dbus_list_pop_last_link      (DBusList **list);
  74 dbus_bool_t _dbus_list_copy               (DBusList **list,
  75                                            DBusList **dest);
  76 int         _dbus_list_get_length         (DBusList **list);
  77 DBusList*   _dbus_list_alloc_link         (void      *data);
  78 void        _dbus_list_free_link          (DBusList  *link);
  79 void        _dbus_list_unlink             (DBusList **list,
  80                                            DBusList  *link);
  81 void        _dbus_list_append_link        (DBusList **list,
  82                                            DBusList  *link);
  83 void        _dbus_list_prepend_link       (DBusList **list,
  84                                            DBusList  *link);
  85 dbus_bool_t _dbus_list_length_is_one      (DBusList **list);
  86
  87
  88
  89
  90 void _dbus_list_foreach (DBusList            **list,
  91                          DBusForeachFunction   function,
  92                          void                 *data);
  93
  94 #define _dbus_list_get_next_link(list, link) ((link)->next == *(list) ? NULL : (link)->next)
  95 #define _dbus_list_get_prev_link(list, link) ((link) == *(list) ? NULL : (link)->prev)
  96
  97 DBUS_END_DECLS;
  98
  99 #endif /* DBUS_LIST_H */