Mercurial > hg > octave-kai > gnulib-hg

annotate lib/search.in.h @ 9309:bbbbbf4cd1c5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Change copyright notice from GPLv2+ to GPLv3+.
author Bruno Haible <bruno@clisp.org>
date Sun, 07 Oct 2007 19:14:58 +0200
parents bee5960c276a
children 53dc0fa4233a
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
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
3 Copyright (C) 2007 Free Software Foundation, Inc.
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@
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
22 # @INCLUDE_NEXT@ @NEXT_SEARCH_H@
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
23 #endif
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
24
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
25 #ifndef _GL_SEARCH_H
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
26 #define _GL_SEARCH_H
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
27
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 /* 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
30
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 #ifdef __cplusplus
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
33 extern "C" {
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
34 #endif
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
35
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 #if @GNULIB_TSEARCH@
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
38 # if !@HAVE_TSEARCH@
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
39
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
40 /* 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
41 <http://www.opengroup.org/susv3xsh/tsearch.html>
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
42 for details. */
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
43
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
44 typedef enum
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
45 {
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
46 preorder,
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
47 postorder,
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
48 endorder,
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
49 leaf
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
50 }
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
51 VISIT;
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
52
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
53 /* 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
54 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
55 is inserted in the tree and is returned. */
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
56 extern void * tsearch (const void *key, void **vrootp,
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
57 int (*compar) (const void *, const void *));
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 /* 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
60 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
61 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
62 int (*compar) (const void *, const void *));
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
63
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
64 /* 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
65 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
66 returned. Otherwise, NULL is returned. */
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
67 extern void * tdelete (const void *key, void **vrootp,
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
68 int (*compar) (const void *, const void *));
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
69
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
70 /* 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
71 The ACTION function is called:
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
72 - 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
73 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
74 and after the right subtree traversal,
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
75 - for leaf nodes: once.
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
76 The arguments passed to ACTION are:
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
77 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
78 pointer to the key,
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
79 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
80 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
81 extern void twalk (const void *vroot,
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
82 void (*action) (const void *, VISIT, int));
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
83
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
84 # endif
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
85 #elif defined GNULIB_POSIXCHECK
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
86 # undef tsearch
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
87 # define tsearch(k,v,c) \
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
88 (GL_LINK_WARNING ("tsearch is unportable - " \
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
89 "use gnulib module tsearch for portability"), \
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
90 tsearch (k, v, c))
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
91 # undef tfind
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
92 # define tfind(k,v,c) \
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
93 (GL_LINK_WARNING ("tfind is unportable - " \
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
94 "use gnulib module tsearch for portability"), \
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
95 tfind (k, v, c))
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
96 # undef tdelete
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
97 # define tdelete(k,v,c) \
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
98 (GL_LINK_WARNING ("tdelete is unportable - " \
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
99 "use gnulib module tsearch for portability"), \
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
100 tdelete (k, v, c))
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
101 # undef twalk
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
102 # define twalk(v,a) \
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
103 (GL_LINK_WARNING ("twalk is unportable - " \
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
104 "use gnulib module tsearch for portability"), \
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
105 twalk (v, a))
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
106 #endif
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
107
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
108
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
109 #ifdef __cplusplus
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
110 }
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
111 #endif
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
112
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
113 #endif /* _GL_SEARCH_H */
bee5960c276a Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
114 #endif /* _GL_SEARCH_H */