keyarray.h

   1 /**
   2  * @file keyarray.h
   3  * @brief Routines to maintain a sorted array of keyids.
   4  *
   5  * Copyright 2004 Jonathan McDowell <noodles@earth.li>
   6  *
   7  * This program is free software: you can redistribute it and/or modify it
   8  * under the terms of the GNU General Public License as published by the Free
   9  * Software Foundation; version 2 of the License.
  10  *
  11  * This program is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  14  * more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with
  17  * this program; if not, write to the Free Software Foundation, Inc., 51
  18  * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  */
  20
  21 #ifndef __KEYARRAY_H__
  22 #define __KEYARRAY_H__
  23
  24 #include <stdbool.h>
  25 #include <stdint.h>
  26
  27 /**
  28  * @brief A sorted array of keyids
  29  *
  30  * Holds a sorted list of keyids, with room for growth - has details of both
  31  * the total size of the array as well as the current number of elements.
  32  */
  33 struct keyarray {
  34         /** The array of key ids */
  35         uint64_t *keys;
  36         /** Number of key ids in the array */
  37         size_t count;
  38         /** Total size of the array */
  39         size_t size;
  40 };
  41
  42 /**
  43  * @brief Given a key array figure out of a key id is present
  44  * @param array Pointer to the key array
  45  * @param key The keyid to look for
  46  */
  47 bool array_find(struct keyarray *array, uint64_t key);
  48
  49 /**
  50  * @brief Free a key array
  51  * @param array Pointer to the key array to free
  52  */
  53 void array_free(struct keyarray *array);
  54
  55 /**
  56  * @brief Add a keyid to a key array
  57  * @param array Pointer to the key array
  58  * @param key The keyid to add
  59  *
  60  * Checks if the key already exists in the key array and if not adds it.
  61  * Returns true if the key was added, false if it was found to be already
  62  * present.
  63  */
  64 bool array_add(struct keyarray *array, uint64_t key);
  65
  66 #endif /* __KEYARRAY_H__ */