mdw@git.distorted.org.uk Git - mLib/blob - testrig.h

   1 /* -*-c-*-
   2  *
   3  * $Id: testrig.h,v 1.5 1999/11/16 15:03:31 mdw Exp $
   4  *
   5  * Generic test driver
   6  *
   7  * (c) 1998 Straylight/Edgeware
   8  */
   9
  10 /*----- Licensing notice --------------------------------------------------*
  11  *
  12  * This file is part of the mLib utilities library.
  13  *
  14  * mLib 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  * mLib 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 mLib; if not, write to the Free
  26  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  27  * MA 02111-1307, USA.
  28  */
  29
  30 /*----- Revision history --------------------------------------------------*
  31  *
  32  * $Log: testrig.h,v $
  33  * Revision 1.5  1999/11/16 15:03:31  mdw
  34  * Mark test types as constant.
  35  *
  36  * Revision 1.4  1999/07/06 19:15:28  mdw
  37  * Comment out argument in structure definition.
  38  *
  39  * Revision 1.3  1999/05/06 19:51:35  mdw
  40  * Reformatted the LGPL notice a little bit.
  41  *
  42  * Revision 1.2  1999/05/05 18:50:31  mdw
  43  * Change licensing conditions to LGPL.
  44  *
  45  * Revision 1.1.1.1  1998/06/17 23:44:42  mdw
  46  * Initial version of mLib
  47  *
  48  */
  49
  50 #ifndef TESTER_H
  51 #define TESTER_H
  52
  53 #ifdef __cplusplus
  54   extern "C" {
  55 #endif
  56
  57 /*----- Header files ------------------------------------------------------*/
  58
  59 #include <stddef.h>
  60
  61 #include "dstr.h"
  62
  63 /*----- Magical numbers ---------------------------------------------------*/
  64
  65 #define TEST_FIELDMAX 16                /* Maximum fields in a line */
  66
  67 /*----- Data structures ---------------------------------------------------*/
  68
  69 /* --- Test field definition --- */
  70
  71 typedef struct test_type {
  72   void (*cvt)(const char *buf, dstr *d); /* Conversion function */
  73   void (*dump)(dstr *d, FILE *fp);      /* Dump function */
  74 } test_type;
  75
  76 /* --- Test chunk definition --- */
  77
  78 typedef struct test_chunk {
  79   const char *name;                     /* Name of this chunk */
  80   int (*test)(dstr /*dv*/[]);           /* Test verification function */
  81   const test_type *f[TEST_FIELDMAX];    /* Field definitions */
  82 } test_chunk;
  83
  84 /*----- Predefined data types ---------------------------------------------*/
  85
  86 extern const test_type type_hex;
  87 extern const test_type type_string;
  88 extern const test_type type_int;
  89
  90 /*----- Functions provided ------------------------------------------------*/
  91
  92 /* --- @test_run@ --- *
  93  *
  94  * Arguments:   @int argc@ = number of command line arguments
  95  *              @char *argv[]@ = pointer to command line arguments
  96  *              @const test_chunk chunk[]@ = pointer to chunk definitions
  97  *              @const char *def@ = name of default test vector file
  98  *
  99  * Returns:     Doesn't.
 100  *
 101  * Use:         Runs a set of test vectors to ensure that a component is
 102  *              working properly.
 103  */
 104
 105 extern void test_run(int /*argc*/, char */*argv*/[],
 106                      const test_chunk /*chunk*/[],
 107                      const char */*def*/);
 108
 109 /*----- That's all, folks -------------------------------------------------*/
 110
 111 #ifdef __cplusplus
 112   }
 113 #endif
 114
 115 #endif