gqueue.h 7.6 KB

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