File: debug.h

package info (click to toggle)
fflas-ffpack 1.6.0-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 3,128 kB
  • ctags: 1,369
  • sloc: sh: 10,959; cpp: 7,935; makefile: 263; perl: 11; csh: 5
file content (220 lines) | stat: -rw-r--r-- 6,777 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
/* -*- mode: C++; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
// vim:sts=8:sw=8:ts=8:noet:sr:cino=>s,f0,{0,g0,(0,\:0,t0,+0,=s
/* utils/debug.h
 *
 * Copyright (C) 2011 Fflas-ffpack
 * Modified by BB, from LinBox
 * ========LICENCE========
 * This file is part of the library FFLAS-FFPACK.
 *
 * FFLAS-FFPACK is free software: you can redistribute it and/or modify
 * it under the terms of the  GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 * ========LICENCE========
 *
 */

/*! @file utils/debug.h
 * @ingroup util
 * Various utilities for debugging.
 * @todo we should put vector printing elsewhere.
 */

#ifndef __FFLASFFPACK_util_debug_H
#define __FFLASFFPACK_util_debug_H

#include <sstream>

#include "fflas-ffpack/fflas-ffpack-configuration.h"


#ifdef __FFLASFFPACK_HAVE_STDINT_H
#ifndef __STDC_LIMIT_MACROS
#define __STDC_LIMIT_MACROS
#endif
#include <stdint.h>

#ifndef INT64_MAX
#warning "somebody nasty previously included <stdint.h> without __STDC_LIMIT_MACROS :)"
#include <limits>
#define INT64_MAX std::numeric_limits<int64_t>::max()
#endif

#ifndef UINT64_MAX
#warning "somebody nasty previously included <stdint.h> without __STDC_LIMIT_MACROS :)"
#include <limits>
#define UINT64_MAX std::numeric_limits<uint64_t>::max()
#endif

#ifndef INT32_MAX
#warning "somebody nasty previously included <stdint.h> without __STDC_LIMIT_MACROS :)"
#include <limits>
#define INT32_MAX std::numeric_limits<int32_t>::max()
#endif

#ifndef UINT32_MAX
#warning "somebody nasty previously included <stdint.h> without __STDC_LIMIT_MACROS :)"
#include <limits>
#define UINT32_MAX std::numeric_limits<uint32_t>::max()
#endif

#ifndef INT16_MAX
#warning "somebody nasty previously included <stdint.h> without __STDC_LIMIT_MACROS :)"
#include <limits>
#define INT16_MAX std::numeric_limits<int16_t>::max()
#endif

#ifndef UINT16_MAX
#warning "somebody nasty previously included <stdint.h> without __STDC_LIMIT_MACROS :)"
#include <limits>
#define UINT16_MAX std::numeric_limits<uint16_t>::max()
#endif

#ifndef INT8_MAX
#warning "somebody nasty previously included <stdint.h> without __STDC_LIMIT_MACROS :)"
#include <limits>
#define INT8_MAX std::numeric_limits<int8_t>::max()
#endif

#ifndef UINT8_MAX
#warning "somebody nasty previously included <stdint.h> without __STDC_LIMIT_MACROS :)"
#include <limits>
#define UINT8_MAX std::numeric_limits<uint8_t>::max()
#endif

#else
#error "you need intXX_t types"
#endif

#ifndef DEBUG
#define FFLASFFPACK_check(check) ((void) 0)
#else
#define FFLASFFPACK_check(check) \
if (!(check)) {\
throw FFPACK::Failure (__func__, __FILE__, __LINE__, #check); /*BB : should work on non gnu compilers too */ \
}
#endif



namespace FFPACK {


	/*!  A precondtion failed.
	 * @ingroup util
	 * The \c throw mechanism is usually used here as in
	 \code
	 if (!check)
	 throw(Failure(__func__,__LINE__,"this check just failed");
	 \endcode
	 * The parameters of the constructor help debugging.
	 */
	class Failure {
	protected:
		static std::ostream *_errorStream;

	public:
		/*! @internal
		 * A precondtion failed.
		 * @param function usually \c __func__, the function that threw the error
		 * @param line     usually \c __LINE__, the line where it happened
		 * @param check    a string telling what failed.
		 */
		Failure (const char *function, int line, const char *check)
		{
			if (_errorStream == (std::ostream *) 0)
				_errorStream = &std::cerr;

			(*_errorStream) << std::endl << std::endl;
			(*_errorStream) << "ERROR (" << function << ":" << line << "): ";
			(*_errorStream) << "Precondition not met:" << check << std::endl;
		}

		/*! @internal
		 * A precondtion failed.
		 * The parameter help debugging. This is not much different from the previous
		 * except we can digg faster in the file where the exception was triggered.
		 * @param function usually \c __func__, the function that threw the error
		 * @param file     usually \c __FILE__, the file where this function is
		 * @param line     usually \c __LINE__, the line where it happened
		 * @param check    a string telling what failed.
		 */
		Failure (const char* function, const char *file, int line, const char *check)
		{
			if (_errorStream == (std::ostream *) 0)
				_errorStream = &std::cerr;

			(*_errorStream) << std::endl << std::endl;
			(*_errorStream) << "ERROR (at " << function << " in " << file << ':' <<  line << "): " << std::endl;
			(*_errorStream) << "Precondition not met:" << check << std::endl;
		}

		static void setErrorStream (std::ostream &stream);

		/*! @internal overload the virtual print of LinboxError.
		 * @param o output stream
		 */
		std::ostream &print (std::ostream &o) const
		{
			if (std::ostringstream * str = dynamic_cast<std::ostringstream*>(_errorStream))
				return o << str->str() ;
			else
				throw "FFLAS-FFPACK ERROR: Failure exception is not initialized correctly";
		}
	};

#if 0
	/*! @internal A function is "not implemented yet(tm)".
	 * where, why ?
	 */
	class NotImplementedYet {
	protected:
		static std::ostream *_errorStream;

	public:
		/*! @internal
		 * A precondtion failed.
		 * The parameter help debugging. This is not much different from the previous
		 * except we can digg faster in the file where the exception was triggered.
		 * @param function usually \c __func__, the function that threw the error
		 * @param file     usually \c __FILE__, the file where this function is
		 * @param line     usually \c __LINE__, the line where it happened
		 * @param why      by default, lazy people don't provide an explanation.
		 */
		NotImplementedYet() {}

		NotImplementedYet(const char * function,
				  const char* file,
				  int line,
				  const char * why='\0')
		{
			if (_errorStream == (std::ostream *) 0)
				_errorStream = &std::cerr;

			(*_errorStream) << std::endl << std::endl;
			(*_errorStream) << "ERROR (at " << function << " in " << file << ':' <<  line << "): " << std::endl;
			(*_errorStream) << " This function is not implemented yet" ;
			if (why)
				(*_errorStream)	<< " (" << why << ")" <<std::endl;
			else
				(*_errorStream)	<<  "." << std::endl;

		}
	};

#endif

	std::ostream *Failure::_errorStream;
} // FFPACK

#endif // __FFLASFFPACK_util_debug_H