chiark / gitweb /
Document hex encoding.
[mLib] / testrig.h
1 /* -*-c-*-
2  *
3  * $Id: testrig.h,v 1.6 1999/12/10 23:41:37 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.6  1999/12/10 23:41:37  mdw
34  * Support for different sizes and types of integers.
35  *
36  * Revision 1.5  1999/11/16 15:03:31  mdw
37  * Mark test types as constant.
38  *
39  * Revision 1.4  1999/07/06 19:15:28  mdw
40  * Comment out argument in structure definition.
41  *
42  * Revision 1.3  1999/05/06 19:51:35  mdw
43  * Reformatted the LGPL notice a little bit.
44  *
45  * Revision 1.2  1999/05/05 18:50:31  mdw
46  * Change licensing conditions to LGPL.
47  *
48  * Revision 1.1.1.1  1998/06/17 23:44:42  mdw
49  * Initial version of mLib
50  *
51  */
52
53 #ifndef MLIB_TESTER_H
54 #define MLIB_TESTER_H
55
56 #ifdef __cplusplus
57   extern "C" {
58 #endif
59
60 /*----- Header files ------------------------------------------------------*/
61
62 #include <stddef.h>
63
64 #include "bits.h"
65 #include "dstr.h"
66
67 /*----- Magical numbers ---------------------------------------------------*/
68
69 #define TEST_FIELDMAX 16                /* Maximum fields in a line */
70
71 /*----- Data structures ---------------------------------------------------*/
72
73 /* --- Test field definition --- */
74
75 typedef struct test_type {
76   void (*cvt)(const char *buf, dstr *d); /* Conversion function */
77   void (*dump)(dstr *d, FILE *fp);      /* Dump function */
78 } test_type;
79
80 /* --- Test chunk definition --- */
81
82 typedef struct test_chunk {
83   const char *name;                     /* Name of this chunk */
84   int (*test)(dstr /*dv*/[]);           /* Test verification function */
85   const test_type *f[TEST_FIELDMAX];    /* Field definitions */
86 } test_chunk;
87
88 /*----- Predefined data types ---------------------------------------------*/
89
90 extern const test_type type_hex;
91 extern const test_type type_string;
92 extern const test_type type_int;
93 extern const test_type type_long;
94 extern const test_type type_ulong;
95 extern const test_type type_uint32;
96
97 /*----- Functions provided ------------------------------------------------*/
98
99 /* --- @test_run@ --- *
100  *
101  * Arguments:   @int argc@ = number of command line arguments
102  *              @char *argv[]@ = pointer to command line arguments
103  *              @const test_chunk chunk[]@ = pointer to chunk definitions
104  *              @const char *def@ = name of default test vector file
105  *
106  * Returns:     Doesn't.
107  *
108  * Use:         Runs a set of test vectors to ensure that a component is
109  *              working properly.
110  */
111
112 extern void test_run(int /*argc*/, char */*argv*/[],
113                      const test_chunk /*chunk*/[],
114                      const char */*def*/);
115
116 /*----- That's all, folks -------------------------------------------------*/
117
118 #ifdef __cplusplus
119   }
120 #endif
121
122 #endif