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