gsequence.h 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173
  1. /* GLIB - Library of useful routines for C programming
  2. * Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007
  3. * Soeren Sandmann (sandmann@daimi.au.dk)
  4. *
  5. * This library is free software; you can redistribute it and/or
  6. * modify it under the terms of the GNU Lesser General Public
  7. * License as published by the Free Software Foundation; either
  8. * version 2 of the License, or (at your option) any later version.
  9. *
  10. * This library is distributed in the hope that it will be useful,
  11. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  13. * Lesser General Public License for more details.
  14. *
  15. * You should have received a copy of the GNU Lesser General Public
  16. * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  17. */
  18. #ifndef __G_SEQUENCE_H__
  19. #define __G_SEQUENCE_H__
  20. #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  21. #error "Only <glib.h> can be included directly."
  22. #endif
  23. #include <glib/gtypes.h>
  24. G_BEGIN_DECLS
  25. typedef struct _GSequence GSequence;
  26. typedef struct _GSequenceNode GSequenceIter;
  27. typedef gint (* GSequenceIterCompareFunc) (GSequenceIter *a,
  28. GSequenceIter *b,
  29. gpointer data);
  30. /* GSequence */
  31. GLIB_AVAILABLE_IN_ALL
  32. GSequence * g_sequence_new (GDestroyNotify data_destroy);
  33. GLIB_AVAILABLE_IN_ALL
  34. void g_sequence_free (GSequence *seq);
  35. GLIB_AVAILABLE_IN_ALL
  36. gint g_sequence_get_length (GSequence *seq);
  37. GLIB_AVAILABLE_IN_ALL
  38. void g_sequence_foreach (GSequence *seq,
  39. GFunc func,
  40. gpointer user_data);
  41. GLIB_AVAILABLE_IN_ALL
  42. void g_sequence_foreach_range (GSequenceIter *begin,
  43. GSequenceIter *end,
  44. GFunc func,
  45. gpointer user_data);
  46. GLIB_AVAILABLE_IN_ALL
  47. void g_sequence_sort (GSequence *seq,
  48. GCompareDataFunc cmp_func,
  49. gpointer cmp_data);
  50. GLIB_AVAILABLE_IN_ALL
  51. void g_sequence_sort_iter (GSequence *seq,
  52. GSequenceIterCompareFunc cmp_func,
  53. gpointer cmp_data);
  54. GLIB_AVAILABLE_IN_2_48
  55. gboolean g_sequence_is_empty (GSequence *seq);
  56. /* Getting iters */
  57. GLIB_AVAILABLE_IN_ALL
  58. GSequenceIter *g_sequence_get_begin_iter (GSequence *seq);
  59. GLIB_AVAILABLE_IN_ALL
  60. GSequenceIter *g_sequence_get_end_iter (GSequence *seq);
  61. GLIB_AVAILABLE_IN_ALL
  62. GSequenceIter *g_sequence_get_iter_at_pos (GSequence *seq,
  63. gint pos);
  64. GLIB_AVAILABLE_IN_ALL
  65. GSequenceIter *g_sequence_append (GSequence *seq,
  66. gpointer data);
  67. GLIB_AVAILABLE_IN_ALL
  68. GSequenceIter *g_sequence_prepend (GSequence *seq,
  69. gpointer data);
  70. GLIB_AVAILABLE_IN_ALL
  71. GSequenceIter *g_sequence_insert_before (GSequenceIter *iter,
  72. gpointer data);
  73. GLIB_AVAILABLE_IN_ALL
  74. void g_sequence_move (GSequenceIter *src,
  75. GSequenceIter *dest);
  76. GLIB_AVAILABLE_IN_ALL
  77. void g_sequence_swap (GSequenceIter *a,
  78. GSequenceIter *b);
  79. GLIB_AVAILABLE_IN_ALL
  80. GSequenceIter *g_sequence_insert_sorted (GSequence *seq,
  81. gpointer data,
  82. GCompareDataFunc cmp_func,
  83. gpointer cmp_data);
  84. GLIB_AVAILABLE_IN_ALL
  85. GSequenceIter *g_sequence_insert_sorted_iter (GSequence *seq,
  86. gpointer data,
  87. GSequenceIterCompareFunc iter_cmp,
  88. gpointer cmp_data);
  89. GLIB_AVAILABLE_IN_ALL
  90. void g_sequence_sort_changed (GSequenceIter *iter,
  91. GCompareDataFunc cmp_func,
  92. gpointer cmp_data);
  93. GLIB_AVAILABLE_IN_ALL
  94. void g_sequence_sort_changed_iter (GSequenceIter *iter,
  95. GSequenceIterCompareFunc iter_cmp,
  96. gpointer cmp_data);
  97. GLIB_AVAILABLE_IN_ALL
  98. void g_sequence_remove (GSequenceIter *iter);
  99. GLIB_AVAILABLE_IN_ALL
  100. void g_sequence_remove_range (GSequenceIter *begin,
  101. GSequenceIter *end);
  102. GLIB_AVAILABLE_IN_ALL
  103. void g_sequence_move_range (GSequenceIter *dest,
  104. GSequenceIter *begin,
  105. GSequenceIter *end);
  106. GLIB_AVAILABLE_IN_ALL
  107. GSequenceIter *g_sequence_search (GSequence *seq,
  108. gpointer data,
  109. GCompareDataFunc cmp_func,
  110. gpointer cmp_data);
  111. GLIB_AVAILABLE_IN_ALL
  112. GSequenceIter *g_sequence_search_iter (GSequence *seq,
  113. gpointer data,
  114. GSequenceIterCompareFunc iter_cmp,
  115. gpointer cmp_data);
  116. GLIB_AVAILABLE_IN_ALL
  117. GSequenceIter *g_sequence_lookup (GSequence *seq,
  118. gpointer data,
  119. GCompareDataFunc cmp_func,
  120. gpointer cmp_data);
  121. GLIB_AVAILABLE_IN_ALL
  122. GSequenceIter *g_sequence_lookup_iter (GSequence *seq,
  123. gpointer data,
  124. GSequenceIterCompareFunc iter_cmp,
  125. gpointer cmp_data);
  126. /* Dereferencing */
  127. GLIB_AVAILABLE_IN_ALL
  128. gpointer g_sequence_get (GSequenceIter *iter);
  129. GLIB_AVAILABLE_IN_ALL
  130. void g_sequence_set (GSequenceIter *iter,
  131. gpointer data);
  132. /* Operations on GSequenceIter * */
  133. GLIB_AVAILABLE_IN_ALL
  134. gboolean g_sequence_iter_is_begin (GSequenceIter *iter);
  135. GLIB_AVAILABLE_IN_ALL
  136. gboolean g_sequence_iter_is_end (GSequenceIter *iter);
  137. GLIB_AVAILABLE_IN_ALL
  138. GSequenceIter *g_sequence_iter_next (GSequenceIter *iter);
  139. GLIB_AVAILABLE_IN_ALL
  140. GSequenceIter *g_sequence_iter_prev (GSequenceIter *iter);
  141. GLIB_AVAILABLE_IN_ALL
  142. gint g_sequence_iter_get_position (GSequenceIter *iter);
  143. GLIB_AVAILABLE_IN_ALL
  144. GSequenceIter *g_sequence_iter_move (GSequenceIter *iter,
  145. gint delta);
  146. GLIB_AVAILABLE_IN_ALL
  147. GSequence * g_sequence_iter_get_sequence (GSequenceIter *iter);
  148. /* Search */
  149. GLIB_AVAILABLE_IN_ALL
  150. gint g_sequence_iter_compare (GSequenceIter *a,
  151. GSequenceIter *b);
  152. GLIB_AVAILABLE_IN_ALL
  153. GSequenceIter *g_sequence_range_get_midpoint (GSequenceIter *begin,
  154. GSequenceIter *end);
  155. G_END_DECLS
  156. #endif /* __G_SEQUENCE_H__ */