Update source headers for 2008. Omit CVS ID keyword subst.
[yaz-moved-to-github.git] / include / yaz / test.h
1 /* This file is part of the YAZ toolkit.
2  * Copyright (C) 1995-2008 Index Data.
3  * All rights reserved.
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  *     * Redistributions of source code must retain the above copyright
8  *       notice, this list of conditions and the following disclaimer.
9  *     * Redistributions in binary form must reproduce the above copyright
10  *       notice, this list of conditions and the following disclaimer in the
11  *       documentation and/or other materials provided with the distribution.
12  *     * Neither the name of Index Data nor the names of its contributors
13  *       may be used to endorse or promote products derived from this
14  *       software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 /* $Id: test.h,v 1.13 2007-01-03 08:42:14 adam Exp $ */
28
29 /** \file test.h
30     \brief Unit Test for YAZ
31 */
32
33 #ifndef YAZ_TEST_H
34 #define YAZ_TEST_H
35
36 #include <yaz/yconfig.h>
37 #include <stdio.h>
38
39 /** \brief Get the verbosity level */
40 int yaz_test_get_verbosity(void);
41
42 /** \brief Test OK */
43 #define YAZ_TEST_TYPE_OK 1
44 /** \brief Test failed */
45 #define YAZ_TEST_TYPE_FAIL 2
46
47 /** \brief boolean test. as only evaluated once */
48 #define YAZ_CHECK(as) { \
49   if (as) { \
50     yaz_check_print1(YAZ_TEST_TYPE_OK, __FILE__, __LINE__, #as); \
51   } else { \
52     yaz_check_print1(YAZ_TEST_TYPE_FAIL, __FILE__, __LINE__, #as); \
53   } \
54 }
55
56 /** \brief a test we know will fail at this time. 
57  *
58  * Later, when the bug is fixed, this test will suddenly pass,
59  * which will be reported as an error, to remind you to go and fix 
60  * your tests.
61  */
62
63 #define YAZ_CHECK_TODO(as) { \
64   yaz_check_inc_todo(); \
65   if (!as) { \
66     yaz_check_print1(YAZ_TEST_TYPE_OK, __FILE__, __LINE__, "TODO: " #as); \
67   } else { \
68     yaz_check_print1(YAZ_TEST_TYPE_FAIL, __FILE__, __LINE__, "TODO: "#as); \
69   } \
70 }
71
72 /** \brief equality test. left, right only evaluated once */
73 #define YAZ_CHECK_EQ(left, right) { \
74   int lval = left; \
75   int rval = right; \
76   if (lval == rval) { \
77     yaz_check_eq1(YAZ_TEST_TYPE_OK, __FILE__, __LINE__, \
78      #left, #right, lval, rval); \
79   } else { \
80     yaz_check_eq1(YAZ_TEST_TYPE_FAIL, __FILE__, __LINE__, \
81      #left, #right, lval, rval); \
82   } \
83 }
84
85 /** \brief Macro to initialize the system (in start of main typically) */
86 #define YAZ_CHECK_INIT(argc, argv) yaz_check_init1(&argc, &argv)
87 /** \brief Macro to terminate the system (end of main, normally) */
88 #define YAZ_CHECK_TERM yaz_check_term1(); return 0
89
90 /** \brief Macro to enable and initialize the yaz_log(start of main) */
91 #define YAZ_CHECK_LOG() yaz_check_init_log(argv[0])
92
93 YAZ_BEGIN_CDECL
94
95 /** \brief used by macro. Should not be called directly */
96 YAZ_EXPORT void yaz_check_init1(int *argc, char ***argv);
97
98 /** \brief used by macro. Should not be called directly */
99 YAZ_EXPORT void yaz_check_term1(void);
100
101 /** \brief used by macro. Should not be called directly */
102 YAZ_EXPORT void yaz_check_init_log(const char *argv0);
103
104 /** \brief used by macro. Should not be called directly */
105 YAZ_EXPORT void yaz_check_print1(int type, const char *file, int line,
106                                  const char *expr);
107 /** \brief used by macro. Should not be called directly */
108 YAZ_EXPORT void yaz_check_eq1(int type, const char *file, int line,
109                               const char *left, const char *right,
110                               int lval, int rval);
111 /** \brief used by macro. Should not be called directly */
112 YAZ_EXPORT void  yaz_check_inc_todo(void);
113 YAZ_END_CDECL
114
115 #endif
116 /*
117  * Local variables:
118  * c-basic-offset: 4
119  * indent-tabs-mode: nil
120  * End:
121  * vim: shiftwidth=4 tabstop=8 expandtab
122  */
123