3 * @brief Routines to maintain a sorted array of keyids.
5 * Copyright 2004 Jonathan McDowell <noodles@earth.li>
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.
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
16 * You should have received a copy of the GNU General Public License along with
17 * this program. If not, see <https://www.gnu.org/licenses/>.
20 #ifndef __KEYARRAY_H__
21 #define __KEYARRAY_H__
26 #include "keystructs.h"
29 * @brief A sorted array of fingerprints
31 * Holds a sorted list of fingerprints, with room for growth - has details of
32 * both the total size of the array as well as the current number of elements.
35 /** The array of key fingerprints */
36 struct openpgp_fingerprint *keys;
37 /** Number of fingerprints in the array */
39 /** Total size of the array */
44 * @brief Given a key array figure out of a key id is present
45 * @param array Pointer to the key array
46 * @param key The keyid to look for
48 bool array_find(struct keyarray *array, struct openpgp_fingerprint *fp);
51 * @brief Free a key array
52 * @param array Pointer to the key array to free
54 void array_free(struct keyarray *array);
57 * @brief Add a keyid to a key array
58 * @param array Pointer to the key array
59 * @param key The keyid to add
61 * Checks if the key already exists in the key array and if not adds it.
62 * Returns true if the key was added, false if it was found to be already
65 bool array_add(struct keyarray *array, struct openpgp_fingerprint *fp);
68 * @brief Compare two OpenPGP fingerprints
69 * @param a Fingerprint 1
70 * @param b Fingerprint 2
72 * Compares 2 OpenPGP fingerprints, returning an integer less than, equal to,
73 * or greater than zero depending on whether a is less than, matches, or is
76 * For the purposes of comparison shorter fingerprints sort earlier than
77 * longer fingerprints (i.e. v3 < v4 < v5) and comparison of same-length
78 * fingerprints treats them as a numberical value.
80 int fingerprint_cmp(struct openpgp_fingerprint *a,
81 struct openpgp_fingerprint *b);
83 #endif /* __KEYARRAY_H__ */