NEWS.stable: log cherry-pick [8b18afa]->[c948e19] sys_select: Avoid a syntax error...

[gnulib.git] / lib / gl_oset.h

diff --git a/lib/gl_oset.h b/lib/gl_oset.h
index 0ecc611..99d0aba 100644 (file)
--- a/lib/gl_oset.h
+++ b/lib/gl_oset.h
@@ -1,5 +1,5 @@
 /* Abstract ordered set data type.
-   Copyright (C) 2006-2007 Free Software Foundation, Inc.
+   Copyright (C) 2006-2007, 2009-2011 Free Software Foundation, Inc.
    Written by Bruno Haible <bruno@clisp.org>, 2006.
 
    This program is free software: you can redistribute it and/or modify
@@ -89,9 +89,15 @@ typedef const struct gl_oset_implementation * gl_oset_implementation_t;
    IMPLEMENTATION is one of GL_ARRAY_OSET, GL_AVLTREE_OSET, GL_RBTREE_OSET.
    COMPAR_FN is an element comparison function or NULL.
    DISPOSE_FN is an element disposal function or NULL.  */
+#if 0 /* declared in gl_xoset.h */
 extern gl_oset_t gl_oset_create_empty (gl_oset_implementation_t implementation,
-                                      gl_setelement_compar_fn compar_fn,
-                                      gl_setelement_dispose_fn dispose_fn);
+                                       gl_setelement_compar_fn compar_fn,
+                                       gl_setelement_dispose_fn dispose_fn);
+#endif
+/* Likewise.  Return NULL upon out-of-memory.  */
+extern gl_oset_t gl_oset_nx_create_empty (gl_oset_implementation_t implementation,
+                                          gl_setelement_compar_fn compar_fn,
+                                          gl_setelement_dispose_fn dispose_fn);
 
 /* Return the current number of elements in an ordered set.  */
 extern size_t gl_oset_size (gl_oset_t set);
@@ -106,13 +112,21 @@ extern bool gl_oset_search (gl_oset_t set, const void *elt);
    Return true and store the found element in *ELTP if found, otherwise return
    false.  */
 extern bool gl_oset_search_atleast (gl_oset_t set,
-                                   gl_setelement_threshold_fn threshold_fn,
-                                   const void *threshold,
-                                   const void **eltp);
+                                    gl_setelement_threshold_fn threshold_fn,
+                                    const void *threshold,
+                                    const void **eltp);
 
 /* Add an element to an ordered set.
-   Return true if it was not already in the set and added.  */
+   Return true if it was not already in the set and added, false otherwise.  */
+#if 0 /* declared in gl_xoset.h */
 extern bool gl_oset_add (gl_oset_t set, const void *elt);
+#endif
+/* Likewise.  Return -1 upon out-of-memory.  */
+extern int gl_oset_nx_add (gl_oset_t set, const void *elt)
+#if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
+  __attribute__ ((__warn_unused_result__))
+#endif
+  ;
 
 /* Remove an element from an ordered set.
    Return true if it was found and removed.  */
@@ -149,7 +163,7 @@ extern gl_oset_iterator_t gl_oset_iterator (gl_oset_t set);
 /* If there is a next element, store the next element in *ELTP, advance the
    iterator and return true.  Otherwise, return false.  */
 extern bool gl_oset_iterator_next (gl_oset_iterator_t *iterator,
-                                  const void **eltp);
+                                   const void **eltp);
 
 /* Free an iterator.  */
 extern void gl_oset_iterator_free (gl_oset_iterator_t *iterator);
@@ -159,16 +173,16 @@ extern void gl_oset_iterator_free (gl_oset_iterator_t *iterator);
 struct gl_oset_implementation
 {
   /* gl_oset_t functions.  */
-  gl_oset_t (*create_empty) (gl_oset_implementation_t implementation,
-                            gl_setelement_compar_fn compar_fn,
-                            gl_setelement_dispose_fn dispose_fn);
+  gl_oset_t (*nx_create_empty) (gl_oset_implementation_t implementation,
+                                gl_setelement_compar_fn compar_fn,
+                                gl_setelement_dispose_fn dispose_fn);
   size_t (*size) (gl_oset_t set);
   bool (*search) (gl_oset_t set, const void *elt);
   bool (*search_atleast) (gl_oset_t set,
-                         gl_setelement_threshold_fn threshold_fn,
-                         const void *threshold, const void **eltp);
-  bool (*add) (gl_oset_t set, const void *elt);
-  bool (*remove) (gl_oset_t set, const void *elt);
+                          gl_setelement_threshold_fn threshold_fn,
+                          const void *threshold, const void **eltp);
+  int (*nx_add) (gl_oset_t set, const void *elt);
+  bool (*remove_elt) (gl_oset_t set, const void *elt);
   void (*oset_free) (gl_oset_t set);
   /* gl_oset_iterator_t functions.  */
   gl_oset_iterator_t (*iterator) (gl_oset_t set);
@@ -189,13 +203,14 @@ struct gl_oset_impl_base
    struct gl_oset_implementation.
    Use #define to avoid a warning because of extern vs. static.  */
 
-# define gl_oset_create_empty gl_oset_create_empty_inline
+# define gl_oset_nx_create_empty gl_oset_nx_create_empty_inline
 static inline gl_oset_t
-gl_oset_create_empty (gl_oset_implementation_t implementation,
-                     gl_setelement_compar_fn compar_fn,
-                     gl_setelement_dispose_fn dispose_fn)
+gl_oset_nx_create_empty (gl_oset_implementation_t implementation,
+                         gl_setelement_compar_fn compar_fn,
+                         gl_setelement_dispose_fn dispose_fn)
 {
-  return implementation->create_empty (implementation, compar_fn, dispose_fn);
+  return implementation->nx_create_empty (implementation, compar_fn,
+                                          dispose_fn);
 }
 
 # define gl_oset_size gl_oset_size_inline
@@ -215,25 +230,26 @@ gl_oset_search (gl_oset_t set, const void *elt)
 # define gl_oset_search_atleast gl_oset_search_atleast_inline
 static inline bool
 gl_oset_search_atleast (gl_oset_t set,
-                       gl_setelement_threshold_fn threshold_fn,
-                       const void *threshold, const void **eltp)
+                        gl_setelement_threshold_fn threshold_fn,
+                        const void *threshold, const void **eltp)
 {
   return ((const struct gl_oset_impl_base *) set)->vtable
-        ->search_atleast (set, threshold_fn, threshold, eltp);
+         ->search_atleast (set, threshold_fn, threshold, eltp);
 }
 
-# define gl_oset_add gl_oset_add_inline
-static inline bool
-gl_oset_add (gl_oset_t set, const void *elt)
+# define gl_oset_nx_add gl_oset_nx_add_inline
+static inline int
+gl_oset_nx_add (gl_oset_t set, const void *elt)
 {
-  return ((const struct gl_oset_impl_base *) set)->vtable->add (set, elt);
+  return ((const struct gl_oset_impl_base *) set)->vtable->nx_add (set, elt);
 }
 
 # define gl_oset_remove gl_oset_remove_inline
 static inline bool
 gl_oset_remove (gl_oset_t set, const void *elt)
 {
-  return ((const struct gl_oset_impl_base *) set)->vtable->remove (set, elt);
+  return ((const struct gl_oset_impl_base *) set)->vtable
+         ->remove_elt (set, elt);
 }
 
 # define gl_oset_free gl_oset_free_inline