gravatar
deba@inf.elte.hu
deba@inf.elte.hu
Reworking assertions and moving to distinict file
0 5 1
default
6 files changed with 226 insertions and 284 deletions:
↑ Collapse diff ↑
Ignore white space 6 line context
... ...
@@ -17,6 +17,7 @@
17 17

	
18 18
lemon_HEADERS += \
19 19
        lemon/arg_parser.h \
20
	lemon/assert.h \
20 21
        lemon/bfs.h \
21 22
        lemon/bin_heap.h \
22 23
        lemon/dfs.h \
Ignore white space 6 line context
... ...
@@ -26,7 +26,7 @@
26 26
#include <iostream>
27 27
#include <sstream>
28 28
#include <algorithm>
29
#include <lemon/error.h>
29
#include <lemon/assert.h>
30 30

	
31 31
///\ingroup misc
32 32
///\file
Ignore white space 6 line context
modified binary file
Ignore white space 6 line context
... ...
@@ -93,7 +93,7 @@
93 93
    std::auto_ptr<_Type> ptr;
94 94
  };
95 95

	
96
  /// Exception-safe convenient "error message" class.
96
  /// Exception-safe convenient error message builder class.
97 97

	
98 98
  /// Helper class which provides a convenient ostream-like (operator <<
99 99
  /// based) interface to create a string message. Mostly useful in
... ...
@@ -413,263 +413,8 @@
413 413
    virtual ~IoParameterError() throw() {}
414 414
  };
415 415

	
416

	
417
  ///\e
418
  class AssertionFailedError : public LogicError {
419
  protected:
420
    const char *assertion;
421
    const char *file;
422
    int line;
423
    const char *function;
424
    const char *message;
425

	
426
    mutable ExceptionMember<std::string> _message_holder;
427
  public:
428
    ///\e
429
    AssertionFailedError(const char *_file, int _line, const char *func,
430
			 const char *msg, const char *_assertion = 0) :
431
      assertion(_assertion), file(_file), line(_line), function(func),
432
      message(msg) {}
433

	
434
    ///\e
435
    const char* get_assertion() const { return assertion; }
436
    ///\e
437
    const char* get_message() const { return message; }
438
    ///\e
439
    const char* get_file() const { return file; }
440
    ///\e
441
    const char* get_function() const { return function; }
442
    ///\e
443
    int get_line() const { return line; }
444

	
445

	
446
    virtual const char* what() const throw() {
447
      try {
448
	std::ostringstream ostr;
449
	ostr << file << ":" << line << ": ";
450
	if( function )
451
	  ostr << function << ": ";
452
	ostr << message;
453
	if( assertion )
454
	   ostr << " (assertion '" << assertion << "' failed)";
455
	_message_holder.set(ostr.str());
456
	return ostr.str().c_str();
457
      }
458
      catch(...) {}
459
      if( _message_holder.valid() ) return _message_holder.get().c_str();
460
      return "lemon::AssertionFailedError";
461
    }
462
   virtual ~AssertionFailedError() throw() {}
463
  };
464

	
465

	
466
  /****************  Macros  ****************/
467

	
468

	
469
  template <typename Exception>
470
  inline void assert_fail(const char *file, int line,
471
                          const char *func,
472
                          Exception exception,
473
                          const char *assertion = 0,
474
                          bool do_abort=true)
475
  {
476
    using namespace std;
477
    cerr << file << ":" << line << ": ";
478
    if (func)
479
      cerr << func << ": ";
480
    cerr << exception.what();
481
    if (assertion)
482
      cerr << " (assertion '" << assertion << "' failed)";
483
    cerr << endl;
484
    if (do_abort)
485
      abort();
486
  }
487

	
488
  template <>
489
  inline void assert_fail<const char *>(const char *file, int line,
490
                                        const char *func,
491
                                        const char *message,
492
                                        const char *assertion,
493
                                        bool do_abort)
494
  {
495
    using namespace std;
496
    cerr << file << ":" << line << ": ";
497
    if (func)
498
      cerr << func << ": ";
499
    cerr << message;
500
    if (assertion)
501
      cerr << " (assertion '" << assertion << "' failed)";
502
    cerr << endl;
503
    if (do_abort)
504
      abort();
505
  }
506

	
507
  template <>
508
  inline void assert_fail<std::string>(const char *file, int line,
509
                                       const char *func,
510
                                       std::string message,
511
                                       const char *assertion,
512
                                       bool do_abort)
513
  {
514
    assert_fail(file, line, func, message.c_str(), assertion, do_abort);
515
  }
516

	
517
  template <typename Exception>
518
  inline void assert_fail_failure(const char *file, int line, const char *func,
519
			   Exception exception,
520
			   const char *assertion = 0,
521
			   bool = true)
522
  {
523
    throw AssertionFailedError(file, line, func, exception.what(), assertion);
524
  }
525

	
526
  template <>
527
  inline void assert_fail_failure<const char *>(const char *file, int line,
528
                                                const char *func,
529
                                                const char *message,
530
                                                const char *assertion,
531
                                                bool)
532
  {
533
    throw AssertionFailedError(file, line, func, message, assertion);
534
  }
535

	
536
  template <>
537
  inline void assert_fail_failure<std::string>(const char *file, int line,
538
                                               const char *func,
539
                                               std::string message,
540
                                               const char *assertion,
541
                                               bool)
542
  {
543
    assert_fail_failure(file, line, func, message.c_str(), assertion, true);
544
  }
545

	
546
  template <typename Exception>
547
  inline void assert_fail_exception(const char *file, int line, const char *func,
548
			     Exception exception,
549
			     const char *assertion = 0, bool = true)
550
  {
551
    throw exception;
552
  }
553

	
554
  template <>
555
  inline void assert_fail_exception<const char *>(const char *file, int line,
556
					   const char *func,
557
					   const char *message,
558
					   const char *assertion,
559
					   bool)
560
  {
561
    throw AssertionFailedError(file, line, func, message, assertion);
562
  }
563

	
564
  template <>
565
  inline void assert_fail_exception<std::string>(const char *file, int line,
566
                                                 const char *func,
567
                                                 std::string message,
568
                                                 const char *assertion,
569
                                                 bool)
570
  {
571
    assert_fail_exception(file, line, func, message.c_str(), assertion, true);
572
  }
573

	
574
/// @}
416
  /// @}
575 417

	
576 418
}
419

	
577 420
#endif // LEMON_ERROR_H
578

	
579
#undef LEMON_ASSERT
580
#undef LEMON_FIXME
581

	
582
#ifdef LEMON_ENABLE_ASSERTS
583
#  define LEMON_ASSERT_ABORT
584
#endif
585

	
586
#ifndef LEMON_ASSERT_DO_ABORT
587
#  define LEMON_ASSERT_DO_ABORT 1
588
#endif
589

	
590
#ifndef LEMON_ASSERT_HANDLER
591
#  if defined LEMON_ASSERT_EXCEPTION
592
#    define LEMON_ASSERT_HANDLER ::lemon::assert_fail_exception
593
#  elif defined LEMON_ASSERT_FAILURE
594
#    define LEMON_ASSERT_HANDLER ::lemon::assert_fail_failure
595
#  elif defined LEMON_ASSERT_ABORT
596
#    define LEMON_ASSERT_HANDLER ::lemon::assert_fail
597
#  else
598
#    define LEMON_DISABLE_ASSERTS
599
#  endif
600
#endif
601

	
602
#ifdef DOXYGEN
603

	
604
/// \brief Macro for assertions with customizable message
605
///
606
/// Macro for assertions with customizable message.
607
///
608
/// The assertions are disabled in the default behaviour. You can
609
/// enable the assertions with the
610
/// \code
611
/// #define LEMON_ENABLE_ASSERTS
612
/// \endcode
613
/// Then an assert
614
/// provides a log on the standard error about the assertion and aborts
615
/// the program if LEMON_ASSERT_DO_ABORT is also defined (otherwise the
616
/// program keeps on running).
617
/// By defining LEMON_ASSERT_FAILURE or
618
/// LEMON_ASSERT_EXCEPTION, you can set other behaviour to the
619
/// assertions. In case LEMON_ASSERT_FAILURE is given, LEMON_ASSERT
620
/// will always throw an \c AssertionFailedError exception with
621
/// the \c msg error message. By using
622
/// LEMON_ASSERT_EXCEPTION, one can define an arbitrary exception to be thrown.
623
///
624
/// The LEMON_ASSERT macro should be called with the \c exp parameter
625
/// which should be an expression convertible to bool. If the given
626
/// parameter is false the assertion is raised and one of the assertion
627
/// behaviour will be activated. The \c msg should be either a const
628
/// char* message or an exception. When the \c msg is an exception the
629
/// \ref lemon::Exception::what() "what()" function is called to retrieve and
630
/// display the error message.
631
///
632
/// \todo We should provide some way to reset to the default behaviour,
633
/// shouldn't we?
634
///
635
/// \todo This whole 'assert' business should be placed in a separate
636
/// include file. The boost assert is not guarded by header sentries
637
/// which may help to change the behaviour of the assertions in
638
/// the files.
639
///
640
/// \todo __PRETTY_FUNCTION__ should be replaced by something
641
/// compiler-independent, like BOOST_CURRENT_FUNCTION
642

	
643
#  define LEMON_ASSERT(exp, msg)                 \
644
     (static_cast<void> (!!(exp) ? 0 : (         \
645
       LEMON_ASSERT_HANDLER(__FILE__, __LINE__,  \
646
                            __PRETTY_FUNCTION__, \
647
                            msg, #exp, LEMON_ASSERT_DO_ABORT), 0)))
648

	
649
#else
650
#  if defined LEMON_DISABLE_ASSERTS
651

	
652
#    define LEMON_ASSERT(exp, msg)  (static_cast<void> (0))
653

	
654
#  else
655
#    define LEMON_ASSERT(exp, msg)                 \
656
       (static_cast<void> (!!(exp) ? 0 : (         \
657
         LEMON_ASSERT_HANDLER(__FILE__, __LINE__,  \
658
                              __PRETTY_FUNCTION__, \
659
                              msg, #exp, LEMON_ASSERT_DO_ABORT), 0)))
660
#  endif
661
#endif
662

	
663
/**
664
 * \brief Macro for mark not yet implemented features.
665
 *
666
 * \todo Is this the right place for this? It should be used only in
667
 * modules under development.
668
 *
669
 * \todo __PRETTY_FUNCTION__ should be replaced by something
670
 * compiler-independent, like BOOST_CURRENT_FUNCTION
671
 */
672

	
673
#define LEMON_FIXME(msg) \
674
    (LEMON_ASSERT_HANDLER(__FILE__, __LINE__, __PRETTY_FUNCTION__, \
675
			  "FIXME: " msg))
Ignore white space 6 line context
... ...
@@ -12,6 +12,7 @@
12 12
	test/dfs_test \
13 13
	test/digraph_test \
14 14
        test/dim_test \
15
	test/error_test \
15 16
	test/graph_test \
16 17
	test/kruskal_test \
17 18
        test/maps_test \
... ...
@@ -28,7 +29,7 @@
28 29
test_dfs_test_SOURCES = test/dfs_test.cc
29 30
test_digraph_test_SOURCES = test/digraph_test.cc
30 31
test_dim_test_SOURCES = test/dim_test.cc
31
#test_error_test_SOURCES = test/error_test.cc
32
test_error_test_SOURCES = test/error_test.cc
32 33
test_graph_test_SOURCES = test/graph_test.cc
33 34
# test_heap_test_SOURCES = test/heap_test.cc
34 35
test_kruskal_test_SOURCES = test/kruskal_test.cc
Ignore white space 6 line context
... ...
@@ -22,47 +22,242 @@
22 22
#include "test_tools.h"
23 23

	
24 24
using namespace lemon;
25
using std::cout;
26
using std::endl;
27 25

	
28
void faulty_fn() {
29
  fault("This is a fault message");
26
#ifdef LEMON_ENABLE_ASSERTS
27
#undef LEMON_ENABLE_ASSERTS
28
#endif
29

	
30
#ifdef LEMON_DISABLE_ASSERTS
31
#undef LEMON_DISABLE_ASSERTS
32
#endif
33

	
34
//checking disabled asserts
35
#define LEMON_DISABLE_ASSERTS
36
#include <lemon/assert.h>
37

	
38
void no_assertion_text_disable() {
39
  LEMON_ASSERT(true, "This is a fault message");
30 40
}
31 41

	
32
void exception_fn() {
33
  throw Exception("This is a function throwing exception with some args: ")
34
    << 5 << ", " << 18;
42
void no_assertion_exception_disable() {
43
  LEMON_ASSERT(true, Exception());
35 44
}
36 45

	
37
void unfinished_fn() {
38
  LEMON_FIXME("unfinished_fn() is unfinished!");
46
void assertion_text_disable() {
47
  LEMON_ASSERT(false, "This is a fault message");
39 48
}
40 49

	
50
void assertion_exception_disable() {
51
  LEMON_ASSERT(false, Exception());
52
}
41 53

	
42
int main() {
54
void fixme_disable() {
55
  LEMON_FIXME("fixme_disable() is fixme!");
56
}
57

	
58
void check_assertion_disable() {
59
  no_assertion_text_disable();
60
  no_assertion_exception_disable();
61
  assertion_exception_disable();
62
  assertion_text_disable();
63
  fixme_disable();
64
}
65
#undef LEMON_DISABLE_ASSERTS
66

	
67

	
68
#define LEMON_ASSERT_ERROR
69
#include <lemon/assert.h>
70

	
71
void no_assertion_text_error() {
72
  LEMON_ASSERT(true, "This is a fault message");
73
}
74

	
75
void no_assertion_exception_error() {
76
  LEMON_ASSERT(true, Exception());
77
}
78

	
79
void assertion_text_error() {
80
  LEMON_ASSERT(false, "This is a fault message");
81
}
82

	
83
void assertion_exception_error() {
84
  LEMON_ASSERT(false, Exception());
85
}
86

	
87
void fixme_error() {
88
  LEMON_FIXME("fixme_error() is fixme!");
89
}
90

	
91
void check_assertion_error() {
92
  no_assertion_text_error();
93
  no_assertion_exception_error();
43 94
  try {
44
    faulty_fn();
45
    check(false, "A faulty function did not fail.");
46
  }
47
  catch(const Exception &e) {
48
    cout << "Exeption = \"" << e.what() << "\" (Right behaviour)" << endl;
95
    assertion_exception_error();
96
    check(false, "Assertion error");
97
  } catch (const AssertionFailedError& e) {
49 98
  }
50 99

	
51 100
  try {
52
    exception_fn();
53
    check(false, "The function did not throw Exception.");
54
  }
55
  catch(const Exception &e) {
56
    cout << "Exeption = \"" << e.what() << "\" (Right behaviour)" << endl;
101
    assertion_text_error();
102
    check(false, "Assertion error");
103
  } catch (const AssertionFailedError& e) {
57 104
  }
58 105

	
59 106
  try {
60
    unfinished_fn();
61
    check(false, "FIXME macro does not work.");
107
    fixme_error();
108
    check(false, "Assertion error");
109
  } catch (const AssertionFailedError& e) {
62 110
  }
63
  catch(const Exception &e) {
64
    cout << "Exeption = \"" << e.what() << "\" (Right behaviour)" << endl;
111
}
112
#undef LEMON_ASSERT_ERROR
113

	
114
#define LEMON_ASSERT_EXCEPTION
115
#include <lemon/assert.h>
116

	
117
void no_assertion_text_exception() {
118
  LEMON_ASSERT(true, "This is a fault message");
119
}
120

	
121
void no_assertion_exception_exception() {
122
  LEMON_ASSERT(true, Exception());
123
}
124

	
125
void assertion_text_exception() {
126
  LEMON_ASSERT(false, "This is a fault message");
127
}
128

	
129
void assertion_exception_exception() {
130
  LEMON_ASSERT(false, Exception());
131
}
132

	
133
void fixme_exception() {
134
  LEMON_FIXME("fixme_exception() is fixme!");
135
}
136

	
137
void check_assertion_exception() {
138
  no_assertion_text_exception();
139
  no_assertion_exception_exception();
140
  try {
141
    assertion_exception_exception();
142
    check(false, "Assertion error");
143
  } catch (const Exception& e) {
65 144
  }
66 145

	
146
  try {
147
    assertion_text_exception();
148
    check(false, "Assertion error");
149
  } catch (const AssertionFailedError& e) {
150
  }
151

	
152
  try {
153
    assertion_text_exception();
154
    check(false, "Assertion error");
155
  } catch (const AssertionFailedError& e) {
156
  }
157

	
158
  try {
159
    fixme_exception();
160
    check(false, "Assertion error");
161
  } catch (const AssertionFailedError& e) {
162
  }
163
}
164
#undef LEMON_ASSERT_EXCEPTION
165

	
166
#define LEMON_ASSERT_LOG
167

	
168
#include <lemon/assert.h>
169

	
170
void no_assertion_text_log() {
171
  LEMON_ASSERT(true, "This is a fault message");
172
}
173

	
174
void no_assertion_exception_log() {
175
  LEMON_ASSERT(true, Exception());
176
}
177

	
178
void assertion_text_log() {
179
  LEMON_ASSERT(false, "This is a fault message");
180
}
181

	
182
void assertion_exception_log() {
183
  LEMON_ASSERT(false, Exception());
184
}
185

	
186
void fixme_log() {
187
  LEMON_FIXME("fixme_log() is fixme!");
188
}
189

	
190
void check_assertion_log() {
191
  no_assertion_text_log();
192
  no_assertion_exception_log();
193
  std::cerr << "The next 3 failure messages are expected: " << std::endl;
194
  assertion_exception_log();
195
  assertion_text_log();
196
  fixme_log();
197
  std::cerr << "End of expected error messages" << std::endl;
198
}
199
#undef LEMON_ASSERT_LOG
200

	
201
#define LEMON_ASSERT_CUSTOM
202

	
203
static int cnt = 0;
204
void my_assert_handler(const char*, int, const char*, 
205
		       const char*, const char*) {
206
  ++cnt;
207
}
208

	
209
void my_assert_handler(const char*, int, const char*, 
210
		       const std::exception&, const char*) {
211
  ++cnt;
212
}
213

	
214
void my_assert_handler(const char*, int, const char*, 
215
		       const std::string&, const char*) {
216
  ++cnt;
217
}
218

	
219

	
220
#define LEMON_CUSTOM_ASSERT_HANDLER my_assert_handler
221
#include <lemon/assert.h>
222

	
223
void no_assertion_text_custom() {
224
  LEMON_ASSERT(true, "This is a fault message");
225
}
226

	
227
void no_assertion_exception_custom() {
228
  LEMON_ASSERT(true, Exception());
229
}
230

	
231
void assertion_text_custom() {
232
  LEMON_ASSERT(false, "This is a fault message");
233
}
234

	
235
void assertion_exception_custom() {
236
  LEMON_ASSERT(false, Exception());
237
}
238

	
239
void fixme_custom() {
240
  LEMON_FIXME("fixme_custom() is fixme!");
241
}
242

	
243
void check_assertion_custom() {
244
  no_assertion_text_custom();
245
  no_assertion_exception_custom();
246
  assertion_exception_custom();
247
  assertion_text_custom();
248
  fixme_custom();
249
  check(cnt == 3, "The custom assert handler does not work");
250
}
251

	
252
#undef LEMON_ASSERT_CUSTOM
253

	
254

	
255
int main() {
256
  check_assertion_disable();
257
  check_assertion_error();
258
  check_assertion_exception();
259
  check_assertion_log();
260
  check_assertion_custom();
261

	
67 262
  return 0;
68 263
}
0 comments (0 inline)