Fix yaz URL
[yaz-moved-to-github.git] / include / yaz / test.h
1 /* This file is part of the YAZ toolkit.
2  * Copyright (C) 1995-2010 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
28 /** \file test.h
29     \brief Unit Test for YAZ
30 */
31
32 #ifndef YAZ_TEST_H
33 #define YAZ_TEST_H
34
35 #include <yaz/yconfig.h>
36 #include <stdio.h>
37
38 /** \brief Get the verbosity level */
39 int yaz_test_get_verbosity(void);
40
41 /** \brief Test OK */
42 #define YAZ_TEST_TYPE_OK 1
43 /** \brief Test failed */
44 #define YAZ_TEST_TYPE_FAIL 2
45
46 /** \brief boolean test. as only evaluated once */
47 #define YAZ_CHECK(as) { \
48   if (as) { \
49     yaz_check_print1(YAZ_TEST_TYPE_OK, __FILE__, __LINE__, #as); \
50   } else { \
51     yaz_check_print1(YAZ_TEST_TYPE_FAIL, __FILE__, __LINE__, #as); \
52   } \
53 }
54
55 /** \brief a test we know will fail at this time. 
56  *
57  * Later, when the bug is fixed, this test will suddenly pass,
58  * which will be reported as an error, to remind you to go and fix 
59  * your tests.
60  */
61
62 #define YAZ_CHECK_TODO(as) { \
63   yaz_check_inc_todo(); \
64   if (!as) { \
65     yaz_check_print1(YAZ_TEST_TYPE_OK, __FILE__, __LINE__, "TODO: " #as); \
66   } else { \
67     yaz_check_print1(YAZ_TEST_TYPE_FAIL, __FILE__, __LINE__, "TODO: "#as); \
68   } \
69 }
70
71 /** \brief equality test. left, right only evaluated once */
72 #define YAZ_CHECK_EQ(left, right) { \
73   int lval = left; \
74   int rval = right; \
75   if (lval == rval) { \
76     yaz_check_eq1(YAZ_TEST_TYPE_OK, __FILE__, __LINE__, \
77      #left, #right, lval, rval); \
78   } else { \
79     yaz_check_eq1(YAZ_TEST_TYPE_FAIL, __FILE__, __LINE__, \
80      #left, #right, lval, rval); \
81   } \
82 }
83
84 /** \brief Macro to initialize the system (in start of main typically) */
85 #define YAZ_CHECK_INIT(argc, argv) yaz_check_init1(&argc, &argv)
86 /** \brief Macro to terminate the system (end of main, normally) */
87 #define YAZ_CHECK_TERM yaz_check_term1(); return 0
88
89 /** \brief Macro to enable and initialize the yaz_log(start of main) */
90 #define YAZ_CHECK_LOG() yaz_check_init_log(argv[0])
91
92 YAZ_BEGIN_CDECL
93
94 /** \brief used by macro. Should not be called directly */
95 YAZ_EXPORT void yaz_check_init1(int *argc, char ***argv);
96
97 /** \brief used by macro. Should not be called directly */
98 YAZ_EXPORT void yaz_check_term1(void);
99
100 /** \brief used by macro. Should not be called directly */
101 YAZ_EXPORT void yaz_check_init_log(const char *argv0);
102
103 /** \brief used by macro. Should not be called directly */
104 YAZ_EXPORT void yaz_check_print1(int type, const char *file, int line,
105                                  const char *expr);
106 /** \brief used by macro. Should not be called directly */
107 YAZ_EXPORT void yaz_check_eq1(int type, const char *file, int line,
108                               const char *left, const char *right,
109                               int lval, int rval);
110 /** \brief used by macro. Should not be called directly */
111 YAZ_EXPORT void  yaz_check_inc_todo(void);
112 YAZ_END_CDECL
113
114 #endif
115 /*
116  * Local variables:
117  * c-basic-offset: 4
118  * c-file-style: "Stroustrup"
119  * indent-tabs-mode: nil
120  * End:
121  * vim: shiftwidth=4 tabstop=8 expandtab
122  */
123