1 /* A GNU-like <search.h>.
3 Copyright (C) 2007-2010 Free Software Foundation, Inc.
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 3 of the License, or
8 (at your option) any later version.
10 This program 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
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 /* The include_next requires a split double-inclusion guard. */
23 @PRAGMA_SYSTEM_HEADER@
25 # @INCLUDE_NEXT@ @NEXT_SEARCH_H@
32 /* The definition of _GL_ARG_NONNULL is copied here. */
34 /* The definition of _GL_WARN_ON_USE is copied here. */
43 # if @REPLACE_TSEARCH@
44 # define tsearch rpl_tsearch
45 # define tfind rpl_tfind
46 # define tdelete rpl_tdelete
47 # define twalk rpl_twalk
49 # if !@HAVE_TSEARCH@ || @REPLACE_TSEARCH@
51 /* See <http://www.opengroup.org/susv3xbd/search.h.html>,
52 <http://www.opengroup.org/susv3xsh/tsearch.html>
66 /* Searches an element in the tree *VROOTP that compares equal to KEY.
67 If one is found, it is returned. Otherwise, a new element equal to KEY
68 is inserted in the tree and is returned. */
69 extern void * tsearch (const void *key, void **vrootp,
70 int (*compar) (const void *, const void *))
71 _GL_ARG_NONNULL ((1, 2, 3));
73 /* Searches an element in the tree *VROOTP that compares equal to KEY.
74 If one is found, it is returned. Otherwise, NULL is returned. */
75 extern void * tfind (const void *key, void *const *vrootp,
76 int (*compar) (const void *, const void *))
77 _GL_ARG_NONNULL ((1, 2, 3));
79 /* Searches an element in the tree *VROOTP that compares equal to KEY.
80 If one is found, it is removed from the tree, and its parent node is
81 returned. Otherwise, NULL is returned. */
82 extern void * tdelete (const void *key, void **vrootp,
83 int (*compar) (const void *, const void *))
84 _GL_ARG_NONNULL ((1, 2, 3));
86 /* Perform a depth-first, left-to-right traversal of the tree VROOT.
87 The ACTION function is called:
88 - for non-leaf nodes: 3 times, before the left subtree traversal,
89 after the left subtree traversal but before the right subtree traversal,
90 and after the right subtree traversal,
91 - for leaf nodes: once.
92 The arguments passed to ACTION are:
93 1. the node; it can be casted to a 'const void * const *', i.e. into a
95 2. an indicator which visit of the node this is,
96 3. the level of the node in the tree (0 for the root). */
97 extern void twalk (const void *vroot,
98 void (*action) (const void *, VISIT, int))
99 _GL_ARG_NONNULL ((2));
102 #elif defined GNULIB_POSIXCHECK
104 # if HAVE_RAW_DECL_TSEARCH
105 _GL_WARN_ON_USE (tsearch, "tsearch is unportable - "
106 "use gnulib module tsearch for portability");
109 # if HAVE_RAW_DECL_TFIND
110 _GL_WARN_ON_USE (tfind, "tfind is unportable - "
111 "use gnulib module tsearch for portability");
114 # if HAVE_RAW_DECL_TDELETE
115 _GL_WARN_ON_USE (tdelete, "tdelete is unportable - "
116 "use gnulib module tsearch for portability");
119 # if HAVE_RAW_DECL_TWALK
120 _GL_WARN_ON_USE (twalk, "twalk is unportable - "
121 "use gnulib module tsearch for portability");
130 #endif /* _GL_SEARCH_H */
131 #endif /* _GL_SEARCH_H */