annotate lib/search.in.h @ 10375:f96e845fc36d

Avoid some "gcc -pedantic" warnings.
author Bruno Haible <bruno@clisp.org>
date Sat, 30 Aug 2008 03:09:15 +0200
parents 53dc0fa4233a
children 8668b19a7032
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9258
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
1 /* A GNU-like <search.h>.
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
2
9595
53dc0fa4233a Work around OpenBSD 4.0 tdelete() bug.
Bruno Haible <bruno@clisp.org>
parents: 9309
diff changeset
3 Copyright (C) 2007-2008 Free Software Foundation, Inc.
9258
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
4
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 9258
diff changeset
5 This program is free software: you can redistribute it and/or modify
9258
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
6 it under the terms of the GNU General Public License as published by
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 9258
diff changeset
7 the Free Software Foundation; either version 3 of the License, or
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 9258
diff changeset
8 (at your option) any later version.
9258
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
9
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
10 This program is distributed in the hope that it will be useful,
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
13 GNU General Public License for more details.
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
14
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
15 You should have received a copy of the GNU General Public License
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 9258
diff changeset
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
9258
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
17
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
18 #ifndef _GL_SEARCH_H
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
19
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
20 /* The include_next requires a split double-inclusion guard. */
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
21 #if @HAVE_SEARCH_H@
10375
f96e845fc36d Avoid some "gcc -pedantic" warnings.
Bruno Haible <bruno@clisp.org>
parents: 9595
diff changeset
22 @PRAGMA_SYSTEM_HEADER@
9258
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
23 # @INCLUDE_NEXT@ @NEXT_SEARCH_H@
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
24 #endif
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
25
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
26 #ifndef _GL_SEARCH_H
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
27 #define _GL_SEARCH_H
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
28
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
29
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
30 /* The definition of GL_LINK_WARNING is copied here. */
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
31
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
32
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
33 #ifdef __cplusplus
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
34 extern "C" {
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
35 #endif
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
36
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
37
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
38 #if @GNULIB_TSEARCH@
9595
53dc0fa4233a Work around OpenBSD 4.0 tdelete() bug.
Bruno Haible <bruno@clisp.org>
parents: 9309
diff changeset
39 # if @REPLACE_TSEARCH@
53dc0fa4233a Work around OpenBSD 4.0 tdelete() bug.
Bruno Haible <bruno@clisp.org>
parents: 9309
diff changeset
40 # define tsearch rpl_tsearch
53dc0fa4233a Work around OpenBSD 4.0 tdelete() bug.
Bruno Haible <bruno@clisp.org>
parents: 9309
diff changeset
41 # define tfind rpl_tfind
53dc0fa4233a Work around OpenBSD 4.0 tdelete() bug.
Bruno Haible <bruno@clisp.org>
parents: 9309
diff changeset
42 # define tdelete rpl_tdelete
53dc0fa4233a Work around OpenBSD 4.0 tdelete() bug.
Bruno Haible <bruno@clisp.org>
parents: 9309
diff changeset
43 # define twalk rpl_twalk
53dc0fa4233a Work around OpenBSD 4.0 tdelete() bug.
Bruno Haible <bruno@clisp.org>
parents: 9309
diff changeset
44 # endif
53dc0fa4233a Work around OpenBSD 4.0 tdelete() bug.
Bruno Haible <bruno@clisp.org>
parents: 9309
diff changeset
45 # if !@HAVE_TSEARCH@ || @REPLACE_TSEARCH@
9258
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
46
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
47 /* See <http://www.opengroup.org/susv3xbd/search.h.html>,
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
48 <http://www.opengroup.org/susv3xsh/tsearch.html>
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
49 for details. */
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
50
9595
53dc0fa4233a Work around OpenBSD 4.0 tdelete() bug.
Bruno Haible <bruno@clisp.org>
parents: 9309
diff changeset
51 # if !@HAVE_TSEARCH@
9258
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
52 typedef enum
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
53 {
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
54 preorder,
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
55 postorder,
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
56 endorder,
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
57 leaf
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
58 }
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
59 VISIT;
9595
53dc0fa4233a Work around OpenBSD 4.0 tdelete() bug.
Bruno Haible <bruno@clisp.org>
parents: 9309
diff changeset
60 # endif
9258
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
61
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
62 /* Searches an element in the tree *VROOTP that compares equal to KEY.
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
63 If one is found, it is returned. Otherwise, a new element equal to KEY
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
64 is inserted in the tree and is returned. */
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
65 extern void * tsearch (const void *key, void **vrootp,
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
66 int (*compar) (const void *, const void *));
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
67
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
68 /* Searches an element in the tree *VROOTP that compares equal to KEY.
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
69 If one is found, it is returned. Otherwise, NULL is returned. */
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
70 extern void * tfind (const void *key, void *const *vrootp,
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
71 int (*compar) (const void *, const void *));
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
72
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
73 /* Searches an element in the tree *VROOTP that compares equal to KEY.
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
74 If one is found, it is removed from the tree, and its parent node is
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
75 returned. Otherwise, NULL is returned. */
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
76 extern void * tdelete (const void *key, void **vrootp,
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
77 int (*compar) (const void *, const void *));
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
78
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
79 /* Perform a depth-first, left-to-right traversal of the tree VROOT.
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
80 The ACTION function is called:
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
81 - for non-leaf nodes: 3 times, before the left subtree traversal,
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
82 after the left subtree traversal but before the right subtree traversal,
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
83 and after the right subtree traversal,
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
84 - for leaf nodes: once.
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
85 The arguments passed to ACTION are:
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
86 1. the node; it can be casted to a 'const void * const *', i.e. into a
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
87 pointer to the key,
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
88 2. an indicator which visit of the node this is,
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
89 3. the level of the node in the tree (0 for the root). */
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
90 extern void twalk (const void *vroot,
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
91 void (*action) (const void *, VISIT, int));
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
92
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
93 # endif
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
94 #elif defined GNULIB_POSIXCHECK
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
95 # undef tsearch
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
96 # define tsearch(k,v,c) \
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
97 (GL_LINK_WARNING ("tsearch is unportable - " \
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
98 "use gnulib module tsearch for portability"), \
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
99 tsearch (k, v, c))
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
100 # undef tfind
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
101 # define tfind(k,v,c) \
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
102 (GL_LINK_WARNING ("tfind is unportable - " \
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
103 "use gnulib module tsearch for portability"), \
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
104 tfind (k, v, c))
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
105 # undef tdelete
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
106 # define tdelete(k,v,c) \
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
107 (GL_LINK_WARNING ("tdelete is unportable - " \
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
108 "use gnulib module tsearch for portability"), \
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
109 tdelete (k, v, c))
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
110 # undef twalk
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
111 # define twalk(v,a) \
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
112 (GL_LINK_WARNING ("twalk is unportable - " \
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
113 "use gnulib module tsearch for portability"), \
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
114 twalk (v, a))
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
115 #endif
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
116
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
117
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
118 #ifdef __cplusplus
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
119 }
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
120 #endif
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
121
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
122 #endif /* _GL_SEARCH_H */
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
123 #endif /* _GL_SEARCH_H */