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 Free Software Foundation, Inc.
   5
   6    This file is part of GNU Bash, the Bourne Again SHell.
   7
   8    Bash 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    Bash 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 Bash.  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_empty(h)          ((h)->nentries == 0)
  29 #define assoc_num_elements(h)   ((h)->nentries)
  30
  31 #define assoc_create(n)         (hash_create((n)))
  32
  33 #define assoc_copy(h)           (hash_copy((h), 0))
  34
  35 #define assoc_walk(h, f)        (hash_walk((h), (f))
  36
  37 extern void assoc_dispose __P((HASH_TABLE *));
  38 extern void assoc_flush __P((HASH_TABLE *));
  39
  40 extern int assoc_insert __P((HASH_TABLE *, char *, char *));
  41 extern void assoc_remove __P((HASH_TABLE *, char *));
  42
  43 extern char *assoc_reference __P((HASH_TABLE *, char *));
  44
  45 extern char *assoc_subrange __P((HASH_TABLE *, arrayind_t, arrayind_t, int, int));
  46 extern char *assoc_patsub __P((HASH_TABLE *, char *, char *, int));
  47 extern char *assoc_modcase __P((HASH_TABLE *, char *, int, int));
  48
  49 extern HASH_TABLE *assoc_quote __P((HASH_TABLE *));
  50 extern HASH_TABLE *assoc_quote_escapes __P((HASH_TABLE *));
  51 extern HASH_TABLE *assoc_dequote __P((HASH_TABLE *));
  52 extern HASH_TABLE *assoc_dequote_escapes __P((HASH_TABLE *));
  53 extern HASH_TABLE *assoc_remove_quoted_nulls __P((HASH_TABLE *));
  54
  55 extern char *assoc_to_assign __P((HASH_TABLE *, int));
  56
  57 extern WORD_LIST *assoc_to_word_list __P((HASH_TABLE *));
  58 extern WORD_LIST *assoc_keys_to_word_list __P((HASH_TABLE *));
  59
  60 extern char *assoc_to_string __P((HASH_TABLE *, char *, int));
  61 #endif /* _ASSOC_H_ */