include/search.h

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