chiark - git - mdw - catacomb/blob - keycheck.c

   1 /* -*-c-*-
   2  *
   3  * $Id: keycheck.c,v 1.3 2004/04/08 01:36:15 mdw Exp $
   4  *
   5  * Framework for checking consistency of keys
   6  *
   7  * (c) 2001 Straylight/Edgeware
   8  */
   9
  10 /*----- Licensing notice --------------------------------------------------*
  11  *
  12  * This file is part of Catacomb.
  13  *
  14  * Catacomb is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU Library General Public License as
  16  * published by the Free Software Foundation; either version 2 of the
  17  * License, or (at your option) any later version.
  18  *
  19  * Catacomb is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Library General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU Library General Public
  25  * License along with Catacomb; if not, write to the Free
  26  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  27  * MA 02111-1307, USA.
  28  */
  29
  30 /*----- Header files ------------------------------------------------------*/
  31
  32 #include <stdarg.h>
  33
  34 #include <mLib/dstr.h>
  35
  36 #include "keycheck.h"
  37
  38 /*----- Main code ---------------------------------------------------------*/
  39
  40 /* --- @keycheck_report@ --- *
  41  *
  42  * Arguments:   @keycheck *kc@ = keycheck state
  43  *              @unsigned sev@ = severity of this report
  44  *              @const char *msg@ = message to send along
  45  *              @...@ = things to fill the message in with
  46  *
  47  * Returns:     Zero to continue, or nonzero to stop and give up.
  48  *
  49  * Use:         Reports a message to the user function.
  50  */
  51
  52 int keycheck_report(keycheck *kc, unsigned sev, const char *msg, ...)
  53 {
  54   int rc;
  55   va_list ap;
  56   dstr d = DSTR_INIT;
  57
  58   kc->sev[sev]++;
  59   va_start(ap, msg);
  60   dstr_vputf(&d, msg, &ap);
  61   va_end(ap);
  62   rc = kc->func ? kc->func(sev, d.buf, kc->p) : 0;
  63   dstr_destroy(&d);
  64   return (rc);
  65 }
  66
  67 /* --- @keycheck_init@ --- *
  68  *
  69  * Arguments:   @keycheck *kc@ = pointer to block to initialize
  70  *              @int (*func)(unsigned sev, const char *msg, void *p)@ =
  71  *                      handler function for problems
  72  *              @void *p@ = pointer to give to handler
  73  *
  74  * Returns:     ---
  75  *
  76  * Use:         Initializes a key checking context.
  77  */
  78
  79 void keycheck_init(keycheck *kc,
  80                    int (*func)(unsigned /*sev*/,
  81                                const char */*msg*/,
  82                                void */*p*/),
  83                    void *p)
  84 {
  85   unsigned i;
  86   kc->func = func;
  87   kc->p = p;
  88   for (i = 0; i < KCSEV_MAX; i++)
  89     kc->sev[i] = 0;
  90 }
  91
  92 /* --- @keycheck_allclear@ --- *
  93  *
  94  * Arguments:   @keycheck *kc@ = pointer to keycheck context
  95  *              @unsigned sev@ = minimum severity to care about
  96  *
  97  * Returns:     Nonzero if no problems of @sev@ or above were noticed.
  98  */
  99
 100 int keycheck_allclear(keycheck *kc, unsigned sev)
 101 {
 102   while (sev < KCSEV_MAX) {
 103     if (kc->sev[sev])
 104       return (0);
 105     sev++;
 106   }
 107   return (1);
 108 }
 109
 110 /*----- That's all, folks -------------------------------------------------*/