Mercurial > hg > octave-kai > gnulib-hg
annotate lib/search.in.h @ 9258:bee5960c276a
Rename search_.h to search.in.h.
author | Bruno Haible <bruno@clisp.org> |
---|---|
date | Tue, 02 Oct 2007 00:24:48 +0200 |
parents | |
children | bbbbbf4cd1c5 |
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 |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
5 This program is free software; you can redistribute it and/or modify |
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 |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
7 the Free Software Foundation; either version 2, or (at your option) |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
8 any later version. |
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 |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
16 along with this program; if not, write to the Free Software Foundation, |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
17 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
18 |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
19 #ifndef _GL_SEARCH_H |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
20 |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
21 /* 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
|
22 #if @HAVE_SEARCH_H@ |
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@ |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
39 # if !@HAVE_TSEARCH@ |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
40 |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
41 /* 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
|
42 <http://www.opengroup.org/susv3xsh/tsearch.html> |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
43 for details. */ |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
44 |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
45 typedef enum |
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 preorder, |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
48 postorder, |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
49 endorder, |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
50 leaf |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
51 } |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
52 VISIT; |
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 /* 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
|
55 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
|
56 is inserted in the tree and is returned. */ |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
57 extern void * tsearch (const void *key, void **vrootp, |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
58 int (*compar) (const void *, const void *)); |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
59 |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
60 /* 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
|
61 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
|
62 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
|
63 int (*compar) (const void *, const void *)); |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
64 |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
65 /* 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
|
66 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
|
67 returned. Otherwise, NULL is returned. */ |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
68 extern void * tdelete (const void *key, void **vrootp, |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
69 int (*compar) (const void *, const void *)); |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
70 |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
71 /* 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
|
72 The ACTION function is called: |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
73 - 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
|
74 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
|
75 and after the right subtree traversal, |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
76 - for leaf nodes: once. |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
77 The arguments passed to ACTION are: |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
78 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
|
79 pointer to the key, |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
80 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
|
81 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
|
82 extern void twalk (const void *vroot, |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
83 void (*action) (const void *, VISIT, int)); |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
84 |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
85 # endif |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
86 #elif defined GNULIB_POSIXCHECK |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
87 # undef tsearch |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
88 # define tsearch(k,v,c) \ |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
89 (GL_LINK_WARNING ("tsearch is unportable - " \ |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
90 "use gnulib module tsearch for portability"), \ |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
91 tsearch (k, v, c)) |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
92 # undef tfind |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
93 # define tfind(k,v,c) \ |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
94 (GL_LINK_WARNING ("tfind is unportable - " \ |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
95 "use gnulib module tsearch for portability"), \ |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
96 tfind (k, v, c)) |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
97 # undef tdelete |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
98 # define tdelete(k,v,c) \ |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
99 (GL_LINK_WARNING ("tdelete is unportable - " \ |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
100 "use gnulib module tsearch for portability"), \ |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
101 tdelete (k, v, c)) |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
102 # undef twalk |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
103 # define twalk(v,a) \ |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
104 (GL_LINK_WARNING ("twalk is unportable - " \ |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
105 "use gnulib module tsearch for portability"), \ |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
106 twalk (v, a)) |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
107 #endif |
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 |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
110 #ifdef __cplusplus |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
111 } |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
112 #endif |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
113 |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
114 #endif /* _GL_SEARCH_H */ |
bee5960c276a
Rename search_.h to search.in.h.
Bruno Haible <bruno@clisp.org>
parents:
diff
changeset
|
115 #endif /* _GL_SEARCH_H */ |