src/var/assoc.h

   1 /* assoc.h -- definitions for the interface exported by assoc.c that allows
   2    the rest of the shell to manipulate associative array variables. */
   3
   4 /* Copyright (C) 2008,2009-2020 Free Software Foundation, Inc.
   5
   6    This file is part of GNU Bush, the Bourne Again SHell.
   7
   8    Bush is free software: you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation, either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    Bush is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with Bush.  If not, see <http://www.gnu.org/licenses/>.
  20 */
  21
  22 #ifndef _ASSOC_H_
  23 #define _ASSOC_H_
  24
  25 #include "stdc.h"
  26 #include "hashlib.h"
  27
  28 #define ASSOC_HASH_BUCKETS      1024
  29
  30 #define assoc_empty(h)          ((h)->nentries == 0)
  31 #define assoc_num_elements(h)   ((h)->nentries)
  32
  33 #define assoc_create(n)         (hash_create((n)))
  34
  35 #define assoc_copy(h)           (hash_copy((h), 0))
  36
  37 #define assoc_walk(h, f)        (hash_walk((h), (f))
  38
  39 extern void assoc_dispose PARAMS((HASH_TABLE *));
  40 extern void assoc_flush PARAMS((HASH_TABLE *));
  41
  42 extern int assoc_insert PARAMS((HASH_TABLE *, char *, char *));
  43 extern PTR_T assoc_replace PARAMS((HASH_TABLE *, char *, char *));
  44 extern void assoc_remove PARAMS((HASH_TABLE *, char *));
  45
  46 extern char *assoc_reference PARAMS((HASH_TABLE *, char *));
  47
  48 extern char *assoc_subrange PARAMS((HASH_TABLE *, arrayind_t, arrayind_t, int, int, int));
  49 extern char *assoc_patsub PARAMS((HASH_TABLE *, char *, char *, int));
  50 extern char *assoc_modcase PARAMS((HASH_TABLE *, char *, int, int));
  51
  52 extern HASH_TABLE *assoc_quote PARAMS((HASH_TABLE *));
  53 extern HASH_TABLE *assoc_quote_escapes PARAMS((HASH_TABLE *));
  54 extern HASH_TABLE *assoc_dequote PARAMS((HASH_TABLE *));
  55 extern HASH_TABLE *assoc_dequote_escapes PARAMS((HASH_TABLE *));
  56 extern HASH_TABLE *assoc_remove_quoted_nulls PARAMS((HASH_TABLE *));
  57
  58 extern char *assoc_to_kvpair PARAMS((HASH_TABLE *, int));
  59 extern char *assoc_to_assign PARAMS((HASH_TABLE *, int));
  60
  61 extern WORD_LIST *assoc_to_word_list PARAMS((HASH_TABLE *));
  62 extern WORD_LIST *assoc_keys_to_word_list PARAMS((HASH_TABLE *));
  63
  64 extern char *assoc_to_string PARAMS((HASH_TABLE *, char *, int));
  65 #endif /* _ASSOC_H_ */