1 /* A GNU-like <search.h>.
3 Copyright (C) 2007 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 2, or (at your option)
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, write to the Free Software Foundation,
17 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
21 /* The include_next requires a split double-inclusion guard. */
23 # if @HAVE_INCLUDE_NEXT@
24 # include_next <search.h>
26 # include @ABSOLUTE_SEARCH_H@
34 /* The definition of GL_LINK_WARNING is copied here. */
45 /* See <http://www.opengroup.org/susv3xbd/search.h.html>,
46 <http://www.opengroup.org/susv3xsh/tsearch.html>
58 /* Searches an element in the tree *VROOTP that compares equal to KEY.
59 If one is found, it is returned. Otherwise, a new element equal to KEY
60 is inserted in the tree and is returned. */
61 extern void * tsearch (const void *key, void **vrootp,
62 int (*compar) (const void *, const void *));
64 /* Searches an element in the tree *VROOTP that compares equal to KEY.
65 If one is found, it is returned. Otherwise, NULL is returned. */
66 extern void * tfind (const void *key, void *const *vrootp,
67 int (*compar) (const void *, const void *));
69 /* Searches an element in the tree *VROOTP that compares equal to KEY.
70 If one is found, it is removed from the tree, and its parent node is
71 returned. Otherwise, NULL is returned. */
72 extern void * tdelete (const void *key, void **vrootp,
73 int (*compar) (const void *, const void *));
75 /* Perform a depth-first, left-to-right traversal of the tree VROOT.
76 The ACTION function is called:
77 - for non-leaf nodes: 3 times, before the left subtree traversal,
78 after the left subtree traversal but before the right subtree traversal,
79 and after the right subtree traversal,
80 - for leaf nodes: once.
81 The arguments passed to ACTION are:
82 1. the node; it can be casted to a 'const void * const *', i.e. into a
84 2. an indicator which visit of the node this is,
85 3. the level of the node in the tree (0 for the root). */
86 extern void twalk (const void *vroot,
87 void (*action) (const void *, VISIT, int));
90 #elif defined GNULIB_POSIXCHECK
92 # define tsearch(k,v,c) \
93 (GL_LINK_WARNING ("tsearch is unportable - " \
94 "use gnulib module tsearch for portability"), \
97 # define tfind(k,v,c) \
98 (GL_LINK_WARNING ("tfind is unportable - " \
99 "use gnulib module tsearch for portability"), \
102 # define tdelete(k,v,c) \
103 (GL_LINK_WARNING ("tdelete is unportable - " \
104 "use gnulib module tsearch for portability"), \
107 # define twalk(v,a) \
108 (GL_LINK_WARNING ("twalk is unportable - " \
109 "use gnulib module tsearch for portability"), \
118 #endif /* _GL_SEARCH_H */
119 #endif /* _GL_SEARCH_H */