typo fix in comment.
[gpgme.git] / gpgme / signers.c
index 95d8a22..2465434 100644 (file)
@@ -1,6 +1,6 @@
 /* signers.c - maintain signer sets
  *     Copyright (C) 2001 Werner Koch (dd9jn)
- *      Copyright (C) 2001 g10 Code GmbH
+ *      Copyright (C) 2001, 2002 g10 Code GmbH
  *
  * This file is part of GPGME.
  *
  */
 
 
+/**
+ * gpgme_signers_clear:
+ * @c: context to clear from signers
+ *
+ * Remove the list of signers from the context and release the
+ * references to the signers keys.
+ *
+ * Return value: The version string or NULL
+ **/
 void
-gpgme_signers_clear (GpgmeCtx c)
+gpgme_signers_clear (GpgmeCtx ctx)
 {
-    int i;
+  int i;
 
-    return_if_fail (c);
+  return_if_fail (ctx);
 
-    if (!c->signers)
-        return;
-    for (i=0; i < c->signers_size; i++ ) {
-        if (!c->signers[i])
-            break;
-        gpgme_key_unref (c->signers[i]);
-        c->signers[i] = NULL;
+  if (!ctx->signers)
+    return;
+  for (i = 0; i < ctx->signers_len; i++)
+    {
+      assert (ctx->signers[i]);
+      gpgme_key_unref (ctx->signers[i]);
+      ctx->signers[i] = NULL;
     }
+  ctx->signers_len = 0;
 }
 
-
+/**
+ * gpgme_signers_add:
+ * @c: context to add signer to
+ * @key: key to add
+ *
+ * Add the key as a signer to the context.  Acquires a reference to
+ * the key.
+ *
+ * Return value: NULL on success, or an error code.
+ **/
 GpgmeError
-gpgme_signers_add (GpgmeCtx c, const GpgmeKey key)
+gpgme_signers_add (GpgmeCtx ctx, const GpgmeKey key)
 {
-    int i = 0;
-
-    if (!c || !key)
-        return mk_error (Invalid_Value);
-
-    if (!c->signers)
-        c->signers_size = 0;
-
-    for (i=0; i < c->signers_size && c->signers[i]; i++ )
-        ;
-    if ( !(i < c->signers_size) ) {
-        GpgmeKey *newarr;
-        int j;
-        int n = c->signers_size + 5;
-
-        newarr = xtrycalloc ( n, sizeof *newarr );
-        if ( !newarr )
-            return mk_error (Out_Of_Core);
-        for (j=0; j < c->signers_size; j++ )
-            newarr[j] = c->signers[j];
-        c->signers_size = n;
-        xfree (c->signers);
-        c->signers = newarr;
+  if (!ctx || !key)
+    return mk_error (Invalid_Value);
+
+  if (ctx->signers_len == ctx->signers_size)
+    {
+      GpgmeKey *newarr;
+      int n = ctx->signers_size + 5;
+      int j;
+
+      newarr = xtryrealloc (ctx->signers, n * sizeof (*newarr));
+      if (!newarr)
+       return mk_error (Out_Of_Core);
+      for (j = ctx->signers_size; j < n; j++)
+       newarr[j] = NULL;
+      ctx->signers = newarr;
+      ctx->signers_size = n;
     }
-    gpgme_key_ref (key);
-    c->signers[i] = key;
-    return 0;
-}
 
+  gpgme_key_ref (key);
+  ctx->signers[ctx->signers_len++] = key;
+  return 0;
+}
 
+/**
+ * gpgme_signers_enum:
+ * @c: context to retrieve signer from
+ * @seq: index of key to retrieve
+ *
+ * Acquire a reference to the signers key with the specified index
+ * number in the context and return it to the caller.
+ *
+ * Return value: A GpgmeKey or NULL on failure.
+ **/
 GpgmeKey
-gpgme_signers_enum (const GpgmeCtx c, int seq )
+gpgme_signers_enum (const GpgmeCtx ctx, int seq)
 {
-    int i;
+  return_null_if_fail (ctx);
+  return_null_if_fail (seq >= 0);
 
-    return_null_if_fail (c);
-    return_null_if_fail (seq>=0);
-
-    if (!c->signers)
-        c->signers_size = 0;
-    for (i=0; i < c->signers_size && c->signers[i]; i++ ) {
-        if (i==seq) {
-            gpgme_key_ref (c->signers[i]);
-            return c->signers[i];
-        }
-    }
+  if (seq >= ctx->signers_len)
     return NULL;
-}
-
-
-
 
+  gpgme_key_ref (ctx->signers[seq]);
+  return ctx->signers[seq];
+}