1 /* A GNU-like <search.h>.
3 Copyright (C) 2007-2008 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. */
22 @PRAGMA_SYSTEM_HEADER@
23 # @INCLUDE_NEXT@ @NEXT_SEARCH_H@
30 /* The definition of GL_LINK_WARNING is copied here. */
39 # if @REPLACE_TSEARCH@
40 # define tsearch rpl_tsearch
41 # define tfind rpl_tfind
42 # define tdelete rpl_tdelete
43 # define twalk rpl_twalk
45 # if !@HAVE_TSEARCH@ || @REPLACE_TSEARCH@
47 /* See <http://www.opengroup.org/susv3xbd/search.h.html>,
48 <http://www.opengroup.org/susv3xsh/tsearch.html>
62 /* Searches an element in the tree *VROOTP that compares equal to KEY.
63 If one is found, it is returned. Otherwise, a new element equal to KEY
64 is inserted in the tree and is returned. */
65 extern void * tsearch (const void *key, void **vrootp,
66 int (*compar) (const void *, const void *));
68 /* Searches an element in the tree *VROOTP that compares equal to KEY.
69 If one is found, it is returned. Otherwise, NULL is returned. */
70 extern void * tfind (const void *key, void *const *vrootp,
71 int (*compar) (const void *, const void *));
73 /* Searches an element in the tree *VROOTP that compares equal to KEY.
74 If one is found, it is removed from the tree, and its parent node is
75 returned. Otherwise, NULL is returned. */
76 extern void * tdelete (const void *key, void **vrootp,
77 int (*compar) (const void *, const void *));
79 /* Perform a depth-first, left-to-right traversal of the tree VROOT.
80 The ACTION function is called:
81 - for non-leaf nodes: 3 times, before the left subtree traversal,
82 after the left subtree traversal but before the right subtree traversal,
83 and after the right subtree traversal,
84 - for leaf nodes: once.
85 The arguments passed to ACTION are:
86 1. the node; it can be casted to a 'const void * const *', i.e. into a
88 2. an indicator which visit of the node this is,
89 3. the level of the node in the tree (0 for the root). */
90 extern void twalk (const void *vroot,
91 void (*action) (const void *, VISIT, int));
94 #elif defined GNULIB_POSIXCHECK
96 # define tsearch(k,v,c) \
97 (GL_LINK_WARNING ("tsearch is unportable - " \
98 "use gnulib module tsearch for portability"), \
101 # define tfind(k,v,c) \
102 (GL_LINK_WARNING ("tfind is unportable - " \
103 "use gnulib module tsearch for portability"), \
106 # define tdelete(k,v,c) \
107 (GL_LINK_WARNING ("tdelete is unportable - " \
108 "use gnulib module tsearch for portability"), \
111 # define twalk(v,a) \
112 (GL_LINK_WARNING ("twalk is unportable - " \
113 "use gnulib module tsearch for portability"), \
122 #endif /* _GL_SEARCH_H */
123 #endif /* _GL_SEARCH_H */