gqueue.h 7.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203
  1. /* GLIB - Library of useful routines for C programming
  2. * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
  3. *
  4. * This library is free software; you can redistribute it and/or
  5. * modify it under the terms of the GNU Lesser General Public
  6. * License as published by the Free Software Foundation; either
  7. * version 2.1 of the License, or (at your option) any later version.
  8. *
  9. * This library is distributed in the hope that it will be useful,
  10. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  12. * Lesser General Public License for more details.
  13. *
  14. * You should have received a copy of the GNU Lesser General Public
  15. * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  16. */
  17. /*
  18. * Modified by the GLib Team and others 1997-2000. See the AUTHORS
  19. * file for a list of people on the GLib Team. See the ChangeLog
  20. * files for a list of changes. These files are distributed with
  21. * GLib at ftp://ftp.gtk.org/pub/gtk/.
  22. */
  23. #ifndef __G_QUEUE_H__
  24. #define __G_QUEUE_H__
  25. #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  26. #error "Only <glib.h> can be included directly."
  27. #endif
  28. #include <glib/glist.h>
  29. G_BEGIN_DECLS
  30. typedef struct _GQueue GQueue;
  31. /**
  32. * GQueue:
  33. * @head: a pointer to the first element of the queue
  34. * @tail: a pointer to the last element of the queue
  35. * @length: the number of elements in the queue
  36. *
  37. * Contains the public fields of a
  38. * [Queue][glib-Double-ended-Queues].
  39. */
  40. struct _GQueue
  41. {
  42. GList *head;
  43. GList *tail;
  44. guint length;
  45. };
  46. /**
  47. * G_QUEUE_INIT:
  48. *
  49. * A statically-allocated #GQueue must be initialized with this
  50. * macro before it can be used. This macro can be used to initialize
  51. * a variable, but it cannot be assigned to a variable. In that case
  52. * you have to use g_queue_init().
  53. *
  54. * |[
  55. * GQueue my_queue = G_QUEUE_INIT;
  56. * ]|
  57. *
  58. * Since: 2.14
  59. */
  60. #define G_QUEUE_INIT { NULL, NULL, 0 }
  61. /* Queues
  62. */
  63. GLIB_AVAILABLE_IN_ALL
  64. GQueue* g_queue_new (void);
  65. GLIB_AVAILABLE_IN_ALL
  66. void g_queue_free (GQueue *queue);
  67. GLIB_AVAILABLE_IN_ALL
  68. void g_queue_free_full (GQueue *queue,
  69. GDestroyNotify free_func);
  70. GLIB_AVAILABLE_IN_ALL
  71. void g_queue_init (GQueue *queue);
  72. GLIB_AVAILABLE_IN_ALL
  73. void g_queue_clear (GQueue *queue);
  74. GLIB_AVAILABLE_IN_ALL
  75. gboolean g_queue_is_empty (GQueue *queue);
  76. GLIB_AVAILABLE_IN_2_60
  77. void g_queue_clear_full (GQueue *queue,
  78. GDestroyNotify free_func);
  79. GLIB_AVAILABLE_IN_ALL
  80. guint g_queue_get_length (GQueue *queue);
  81. GLIB_AVAILABLE_IN_ALL
  82. void g_queue_reverse (GQueue *queue);
  83. GLIB_AVAILABLE_IN_ALL
  84. GQueue * g_queue_copy (GQueue *queue);
  85. GLIB_AVAILABLE_IN_ALL
  86. void g_queue_foreach (GQueue *queue,
  87. GFunc func,
  88. gpointer user_data);
  89. GLIB_AVAILABLE_IN_ALL
  90. GList * g_queue_find (GQueue *queue,
  91. gconstpointer data);
  92. GLIB_AVAILABLE_IN_ALL
  93. GList * g_queue_find_custom (GQueue *queue,
  94. gconstpointer data,
  95. GCompareFunc func);
  96. GLIB_AVAILABLE_IN_ALL
  97. void g_queue_sort (GQueue *queue,
  98. GCompareDataFunc compare_func,
  99. gpointer user_data);
  100. GLIB_AVAILABLE_IN_ALL
  101. void g_queue_push_head (GQueue *queue,
  102. gpointer data);
  103. GLIB_AVAILABLE_IN_ALL
  104. void g_queue_push_tail (GQueue *queue,
  105. gpointer data);
  106. GLIB_AVAILABLE_IN_ALL
  107. void g_queue_push_nth (GQueue *queue,
  108. gpointer data,
  109. gint n);
  110. GLIB_AVAILABLE_IN_ALL
  111. gpointer g_queue_pop_head (GQueue *queue);
  112. GLIB_AVAILABLE_IN_ALL
  113. gpointer g_queue_pop_tail (GQueue *queue);
  114. GLIB_AVAILABLE_IN_ALL
  115. gpointer g_queue_pop_nth (GQueue *queue,
  116. guint n);
  117. GLIB_AVAILABLE_IN_ALL
  118. gpointer g_queue_peek_head (GQueue *queue);
  119. GLIB_AVAILABLE_IN_ALL
  120. gpointer g_queue_peek_tail (GQueue *queue);
  121. GLIB_AVAILABLE_IN_ALL
  122. gpointer g_queue_peek_nth (GQueue *queue,
  123. guint n);
  124. GLIB_AVAILABLE_IN_ALL
  125. gint g_queue_index (GQueue *queue,
  126. gconstpointer data);
  127. GLIB_AVAILABLE_IN_ALL
  128. gboolean g_queue_remove (GQueue *queue,
  129. gconstpointer data);
  130. GLIB_AVAILABLE_IN_ALL
  131. guint g_queue_remove_all (GQueue *queue,
  132. gconstpointer data);
  133. GLIB_AVAILABLE_IN_ALL
  134. void g_queue_insert_before (GQueue *queue,
  135. GList *sibling,
  136. gpointer data);
  137. GLIB_AVAILABLE_IN_2_62
  138. void g_queue_insert_before_link
  139. (GQueue *queue,
  140. GList *sibling,
  141. GList *link_);
  142. GLIB_AVAILABLE_IN_ALL
  143. void g_queue_insert_after (GQueue *queue,
  144. GList *sibling,
  145. gpointer data);
  146. GLIB_AVAILABLE_IN_2_62
  147. void g_queue_insert_after_link
  148. (GQueue *queue,
  149. GList *sibling,
  150. GList *link_);
  151. GLIB_AVAILABLE_IN_ALL
  152. void g_queue_insert_sorted (GQueue *queue,
  153. gpointer data,
  154. GCompareDataFunc func,
  155. gpointer user_data);
  156. GLIB_AVAILABLE_IN_ALL
  157. void g_queue_push_head_link (GQueue *queue,
  158. GList *link_);
  159. GLIB_AVAILABLE_IN_ALL
  160. void g_queue_push_tail_link (GQueue *queue,
  161. GList *link_);
  162. GLIB_AVAILABLE_IN_ALL
  163. void g_queue_push_nth_link (GQueue *queue,
  164. gint n,
  165. GList *link_);
  166. GLIB_AVAILABLE_IN_ALL
  167. GList* g_queue_pop_head_link (GQueue *queue);
  168. GLIB_AVAILABLE_IN_ALL
  169. GList* g_queue_pop_tail_link (GQueue *queue);
  170. GLIB_AVAILABLE_IN_ALL
  171. GList* g_queue_pop_nth_link (GQueue *queue,
  172. guint n);
  173. GLIB_AVAILABLE_IN_ALL
  174. GList* g_queue_peek_head_link (GQueue *queue);
  175. GLIB_AVAILABLE_IN_ALL
  176. GList* g_queue_peek_tail_link (GQueue *queue);
  177. GLIB_AVAILABLE_IN_ALL
  178. GList* g_queue_peek_nth_link (GQueue *queue,
  179. guint n);
  180. GLIB_AVAILABLE_IN_ALL
  181. gint g_queue_link_index (GQueue *queue,
  182. GList *link_);
  183. GLIB_AVAILABLE_IN_ALL
  184. void g_queue_unlink (GQueue *queue,
  185. GList *link_);
  186. GLIB_AVAILABLE_IN_ALL
  187. void g_queue_delete_link (GQueue *queue,
  188. GList *link_);
  189. G_END_DECLS
  190. #endif /* __G_QUEUE_H__ */