]>
Commit | Line | Data |
---|---|---|
a6826fbc WD |
1 | /* |
2 | * Declarations for System V style searching functions. | |
3 | * Copyright (C) 1995-1999, 2000 Free Software Foundation, Inc. | |
4 | * This file is part of the GNU C Library. | |
5 | * | |
eee479cf | 6 | * SPDX-License-Identifier: LGPL-2.1+ |
a6826fbc WD |
7 | */ |
8 | ||
9 | /* | |
10 | * Based on code from uClibc-0.9.30.3 | |
11 | * Extensions for use within U-Boot | |
ea009d47 | 12 | * Copyright (C) 2010-2013 Wolfgang Denk <[email protected]> |
a6826fbc WD |
13 | */ |
14 | ||
36266435 RD |
15 | #ifndef _SEARCH_H_ |
16 | #define _SEARCH_H_ | |
a6826fbc WD |
17 | |
18 | #include <stddef.h> | |
19 | ||
20 | #define __set_errno(val) do { errno = val; } while (0) | |
21 | ||
7afcf3a5 JH |
22 | enum env_op { |
23 | env_op_create, | |
24 | env_op_delete, | |
25 | env_op_overwrite, | |
26 | }; | |
27 | ||
36266435 | 28 | /* Action which shall be performed in the call to hsearch. */ |
a6826fbc WD |
29 | typedef enum { |
30 | FIND, | |
31 | ENTER | |
32 | } ACTION; | |
33 | ||
34 | typedef struct entry { | |
84b5e802 | 35 | const char *key; |
a6826fbc | 36 | char *data; |
170ab110 JH |
37 | int (*callback)(const char *name, const char *value, enum env_op op, |
38 | int flags); | |
2598090b | 39 | int flags; |
a6826fbc WD |
40 | } ENTRY; |
41 | ||
42 | /* Opaque type for internal use. */ | |
43 | struct _ENTRY; | |
44 | ||
45 | /* | |
46 | * Family of hash table handling functions. The functions also | |
47 | * have reentrant counterparts ending with _r. The non-reentrant | |
36266435 | 48 | * functions all work on a single internal hash table. |
a6826fbc WD |
49 | */ |
50 | ||
51 | /* Data type for reentrant functions. */ | |
52 | struct hsearch_data { | |
53 | struct _ENTRY *table; | |
54 | unsigned int size; | |
55 | unsigned int filled; | |
c5983592 GF |
56 | /* |
57 | * Callback function which will check whether the given change for variable | |
36266435 | 58 | * "__item" to "newval" may be applied or not, and possibly apply such change. |
c5983592 GF |
59 | * When (flag & H_FORCE) is set, it shall not print out any error message and |
60 | * shall force overwriting of write-once variables. | |
36266435 | 61 | * Must return 0 for approval, 1 for denial. |
c5983592 | 62 | */ |
7afcf3a5 JH |
63 | int (*change_ok)(const ENTRY *__item, const char *newval, enum env_op, |
64 | int flag); | |
a6826fbc WD |
65 | }; |
66 | ||
36266435 | 67 | /* Create a new hash table which will contain at most "__nel" elements. */ |
a6826fbc WD |
68 | extern int hcreate_r(size_t __nel, struct hsearch_data *__htab); |
69 | ||
36266435 | 70 | /* Destroy current internal hash table. */ |
c4e0057f | 71 | extern void hdestroy_r(struct hsearch_data *__htab); |
a6826fbc WD |
72 | |
73 | /* | |
36266435 | 74 | * Search for entry matching __item.key in internal hash table. If |
a6826fbc WD |
75 | * ACTION is `FIND' return found entry or signal error by returning |
76 | * NULL. If ACTION is `ENTER' replace existing data (if any) with | |
36266435 | 77 | * __item.data. |
a6826fbc | 78 | * */ |
a6826fbc | 79 | extern int hsearch_r(ENTRY __item, ACTION __action, ENTRY ** __retval, |
c4e0057f | 80 | struct hsearch_data *__htab, int __flag); |
a6826fbc | 81 | |
560d424b | 82 | /* |
36266435 | 83 | * Search for an entry matching "__match". Otherwise, Same semantics |
560d424b MF |
84 | * as hsearch_r(). |
85 | */ | |
86 | extern int hmatch_r(const char *__match, int __last_idx, ENTRY ** __retval, | |
87 | struct hsearch_data *__htab); | |
88 | ||
36266435 | 89 | /* Search and delete entry matching "__key" in internal hash table. */ |
152874b6 | 90 | extern int hdelete_r(const char *__key, struct hsearch_data *__htab, |
c4e0057f | 91 | int __flag); |
a6826fbc | 92 | |
a6826fbc | 93 | extern ssize_t hexport_r(struct hsearch_data *__htab, |
be11235a | 94 | const char __sep, int __flag, char **__resp, size_t __size, |
37f2fe74 | 95 | int argc, char * const argv[]); |
a6826fbc | 96 | |
348b1f1c GF |
97 | /* |
98 | * nvars: length of vars array | |
99 | * vars: array of strings (variable names) to import (nvars == 0 means all) | |
100 | */ | |
a6826fbc WD |
101 | extern int himport_r(struct hsearch_data *__htab, |
102 | const char *__env, size_t __size, const char __sep, | |
ecd1446f AH |
103 | int __flag, int __crlf_is_lf, int nvars, |
104 | char * const vars[]); | |
a6826fbc | 105 | |
170ab110 JH |
106 | /* Walk the whole table calling the callback on each element */ |
107 | extern int hwalk_r(struct hsearch_data *__htab, int (*callback)(ENTRY *)); | |
108 | ||
be11235a | 109 | /* Flags for himport_r(), hexport_r(), hdelete_r(), and hsearch_r() */ |
c4e0057f JH |
110 | #define H_NOCLEAR (1 << 0) /* do not clear hash table before importing */ |
111 | #define H_FORCE (1 << 1) /* overwrite read-only/write-once variables */ | |
112 | #define H_INTERACTIVE (1 << 2) /* indicate that an import is user directed */ | |
be11235a | 113 | #define H_HIDE_DOT (1 << 3) /* don't print env vars that begin with '.' */ |
ea009d47 WD |
114 | #define H_MATCH_KEY (1 << 4) /* search/grep key = variable names */ |
115 | #define H_MATCH_DATA (1 << 5) /* search/grep data = variable values */ | |
116 | #define H_MATCH_BOTH (H_MATCH_KEY | H_MATCH_DATA) /* search/grep both */ | |
117 | #define H_MATCH_IDENT (1 << 6) /* search for indentical strings */ | |
be29df6a WD |
118 | #define H_MATCH_SUBSTR (1 << 7) /* search for substring matches */ |
119 | #define H_MATCH_REGEX (1 << 8) /* search for regular expression matches */ | |
120 | #define H_MATCH_METHOD (H_MATCH_IDENT | H_MATCH_SUBSTR | H_MATCH_REGEX) | |
94b467b1 JH |
121 | #define H_PROGRAMMATIC (1 << 9) /* indicate that an import is from setenv() */ |
122 | #define H_ORIGIN_FLAGS (H_INTERACTIVE | H_PROGRAMMATIC) | |
a6826fbc | 123 | |
36266435 | 124 | #endif /* _SEARCH_H_ */ |