usr.sbin/installer/libaura/dict.h

   1 /*
   2  * Copyright (c) 2004 The DragonFly Project.  All rights reserved.
   3  *
   4  * This code is derived from software contributed to The DragonFly Project
   5  * by Chris Pressey <cpressey@catseye.mine.nu>.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the
  16  *    distribution.
  17  * 3. Neither the name of The DragonFly Project nor the names of its
  18  *    contributors may be used to endorse or promote products derived
  19  *    from this software without specific, prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  */
  34
  35 /*
  36  * dict.c
  37  * $Id: dict.h,v 1.3 2005/02/06 06:57:30 cpressey Exp $
  38  * Routines to manipulate dictionaries.
  39  */
  40
  41 #ifndef __AURA_DICT_H_
  42 #define __AURA_DICT_H_
  43
  44 #include <stdlib.h>
  45
  46 #define AURA_DICT_HASH          1
  47 #define AURA_DICT_LIST          2
  48 #define AURA_DICT_SORTED_LIST   3
  49
  50 struct aura_dict {
  51         struct aura_bucket **b;
  52         size_t num_buckets;
  53         void (*fetch)(struct aura_dict *, const void *, size_t, void **, size_t *);
  54         void (*store)(struct aura_dict *, const void *, size_t, const void *, size_t);
  55         struct aura_bucket *cursor;
  56         size_t cur_bucket;
  57 };
  58
  59 struct aura_bucket {
  60         struct aura_bucket *next;
  61         void *key;
  62         size_t key_size;
  63         void *data;
  64         size_t data_size;
  65 };
  66
  67 struct aura_dict        *aura_dict_new(size_t, int);
  68 void                     aura_dict_free(struct aura_dict *);
  69
  70 void                     aura_dict_fetch(struct aura_dict *, const void *, size_t,
  71                                          void **, size_t *);
  72 int                      aura_dict_exists(struct aura_dict *, const void *, size_t);
  73 void                     aura_dict_store(struct aura_dict *, const void *, size_t,
  74                                          const void *, size_t);
  75
  76 void                     aura_dict_rewind(struct aura_dict *);
  77 int                      aura_dict_eof(struct aura_dict *);
  78 void                     aura_dict_get_current_key(struct aura_dict *,
  79                                                    void **, size_t *);
  80 void                     aura_dict_next(struct aura_dict *);
  81 size_t                   aura_dict_size(struct aura_dict *);
  82
  83 #endif /* !__AURA_DICT_H_ */