make it possible to disable single-file includes by defining
[platform/upstream/glib.git] / glib / glist.h
index 7b3e977..4a5dd65 100644 (file)
  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  * file for a list of people on the GLib Team.  See the ChangeLog
  * files for a list of changes.  These files are distributed with
- * GLib at ftp://ftp.gtk.org/pub/gtk/. 
+ * GLib at ftp://ftp.gtk.org/pub/gtk/.
  */
 
+#if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__G_LIB_H__) && !defined (GLIB_COMPILATION)
+#error "Only <glib.h> can be included directly."
+#endif
+
 #ifndef __G_LIST_H__
 #define __G_LIST_H__
 
-#include <gmem.h>
+#include <glib/gmem.h>
 
 G_BEGIN_DECLS
 
-typedef struct _GList          GList;
+typedef struct _GList GList;
 
 struct _GList
 {
@@ -42,60 +46,75 @@ struct _GList
 
 /* Doubly linked lists
  */
-void     g_list_push_allocator (GAllocator       *allocator);
-void     g_list_pop_allocator  (void);
-GList*   g_list_alloc          (void);
-void     g_list_free           (GList            *list);
-void     g_list_free_1         (GList            *list);
-GList*   g_list_append         (GList            *list,
-                               gpointer          data);
-GList*   g_list_prepend        (GList            *list,
-                               gpointer          data);
-GList*   g_list_insert         (GList            *list,
-                               gpointer          data,
-                               gint              position);
-GList*   g_list_insert_sorted  (GList            *list,
-                               gpointer          data,
-                               GCompareFunc      func);
-GList*   g_list_concat         (GList            *list1,
-                               GList            *list2);
-GList*   g_list_remove         (GList            *list,
-                               gconstpointer     data);
-GList*   g_list_remove_link    (GList            *list,
-                               GList            *llink);
-GList*   g_list_delete_link    (GList            *list,
-                               GList            *link);
-GList*   g_list_reverse        (GList            *list);
-GList*   g_list_copy           (GList            *list);
-GList*   g_list_nth            (GList            *list,
-                               guint             n);
-GList*   g_list_find           (GList            *list,
-                               gconstpointer     data);
-GList*   g_list_find_custom    (GList            *list,
-                               gconstpointer     data,
-                               GCompareFunc      func);
-gint     g_list_position       (GList            *list,
-                               GList            *llink);
-gint     g_list_index          (GList            *list,
-                               gconstpointer     data);
-GList*   g_list_last           (GList            *list);
-GList*   g_list_first          (GList            *list);
-guint    g_list_length         (GList            *list);
-void     g_list_foreach        (GList            *list,
-                               GFunc             func,
-                               gpointer          user_data);
-GList*   g_list_sort           (GList            *list,
-                               GCompareFunc      compare_func);
-GList*   g_list_sort_with_data (GList            *list,
-                               GCompareDataFunc  compare_func,
-                               gpointer          user_data);
-gpointer g_list_nth_data       (GList            *list,
-                               guint             n);
+GList*   g_list_alloc                   (void) G_GNUC_WARN_UNUSED_RESULT;
+void     g_list_free                    (GList            *list);
+void     g_list_free_1                  (GList            *list);
+#define  g_list_free1                   g_list_free_1
+GList*   g_list_append                  (GList            *list,
+                                        gpointer          data) G_GNUC_WARN_UNUSED_RESULT;
+GList*   g_list_prepend                 (GList            *list,
+                                        gpointer          data) G_GNUC_WARN_UNUSED_RESULT;
+GList*   g_list_insert                  (GList            *list,
+                                        gpointer          data,
+                                        gint              position) G_GNUC_WARN_UNUSED_RESULT;
+GList*   g_list_insert_sorted           (GList            *list,
+                                        gpointer          data,
+                                        GCompareFunc      func) G_GNUC_WARN_UNUSED_RESULT;
+GList*   g_list_insert_sorted_with_data (GList            *list,
+                                        gpointer          data,
+                                        GCompareDataFunc  func,
+                                        gpointer          user_data) G_GNUC_WARN_UNUSED_RESULT;
+GList*   g_list_insert_before           (GList            *list,
+                                        GList            *sibling,
+                                        gpointer          data) G_GNUC_WARN_UNUSED_RESULT;
+GList*   g_list_concat                  (GList            *list1,
+                                        GList            *list2) G_GNUC_WARN_UNUSED_RESULT;
+GList*   g_list_remove                  (GList            *list,
+                                        gconstpointer     data) G_GNUC_WARN_UNUSED_RESULT;
+GList*   g_list_remove_all              (GList            *list,
+                                        gconstpointer     data) G_GNUC_WARN_UNUSED_RESULT;
+GList*   g_list_remove_link             (GList            *list,
+                                        GList            *llink) G_GNUC_WARN_UNUSED_RESULT;
+GList*   g_list_delete_link             (GList            *list,
+                                        GList            *link_) G_GNUC_WARN_UNUSED_RESULT;
+GList*   g_list_reverse                 (GList            *list) G_GNUC_WARN_UNUSED_RESULT;
+GList*   g_list_copy                    (GList            *list) G_GNUC_WARN_UNUSED_RESULT;
+GList*   g_list_nth                     (GList            *list,
+                                        guint             n);
+GList*   g_list_nth_prev                (GList            *list,
+                                        guint             n);
+GList*   g_list_find                    (GList            *list,
+                                        gconstpointer     data);
+GList*   g_list_find_custom             (GList            *list,
+                                        gconstpointer     data,
+                                        GCompareFunc      func);
+gint     g_list_position                (GList            *list,
+                                        GList            *llink);
+gint     g_list_index                   (GList            *list,
+                                        gconstpointer     data);
+GList*   g_list_last                    (GList            *list);
+GList*   g_list_first                   (GList            *list);
+guint    g_list_length                  (GList            *list);
+void     g_list_foreach                 (GList            *list,
+                                        GFunc             func,
+                                        gpointer          user_data);
+GList*   g_list_sort                    (GList            *list,
+                                        GCompareFunc      compare_func) G_GNUC_WARN_UNUSED_RESULT;
+GList*   g_list_sort_with_data          (GList            *list,
+                                        GCompareDataFunc  compare_func,
+                                        gpointer          user_data)  G_GNUC_WARN_UNUSED_RESULT;
+gpointer g_list_nth_data                (GList            *list,
+                                        guint             n);
+
 
-#define g_list_previous(list)  ((list) ? (((GList *)(list))->prev) : NULL)
-#define g_list_next(list)      ((list) ? (((GList *)(list))->next) : NULL)
+#define g_list_previous(list)          ((list) ? (((GList *)(list))->prev) : NULL)
+#define g_list_next(list)              ((list) ? (((GList *)(list))->next) : NULL)
+
+#ifndef G_DISABLE_DEPRECATED
+void     g_list_push_allocator          (gpointer          allocator);
+void     g_list_pop_allocator           (void);
+#endif
 
 G_END_DECLS
 
 #endif /* __G_LIST_H__ */
-