added more or less meaningful descriptions when throwing SystemExceptions
[senf.git] / senf / Utils / senfassert.hh
1 // $Id$
2 //
3 // Copyright (C) 2008
4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 //
6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
7 // Version 1.0 (the "License"); you may not use this file except in compliance
8 // with the License. You may obtain a copy of the License at 
9 // http://senf.berlios.de/license.html
10 //
11 // The Fraunhofer FOKUS Public License Version 1.0 is based on, 
12 // but modifies the Mozilla Public License Version 1.1.
13 // See the full license text for the amendments.
14 //
15 // Software distributed under the License is distributed on an "AS IS" basis, 
16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 
17 // for the specific language governing rights and limitations under the License.
18 //
19 // The Original Code is Fraunhofer FOKUS code.
20 //
21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V. 
22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
23 // All Rights Reserved.
24 //
25 // Contributor(s):
26 //   Stefan Bund <g0dil@berlios.de>
27
28 /** \file
29     \brief senfassert public header */
30
31 #ifndef HH_SENF_Utils_senfassert_
32 #define HH_SENF_Utils_senfassert_ 1
33
34 // Custom includes
35
36 //#include "senfassert.mpp"
37 //-/////////////////////////////////////////////////////////////////////////////////////////////////
38
39 #ifndef SENF_DEBUG
40
41 #   define SENF_ASSERT(x, comment)
42 #   define SENF_ASSERT_EXPRESSION(expression, comment) expression
43
44 #else
45
46 #   include <cassert>
47 #   define SENF_ASSERT(x, comment) assert((x) && comment)
48 #   define SENF_ASSERT_EXPRESSION(expression, comment) assert((expression) && comment)
49
50 #endif
51
52
53 /* Lifted direct from:
54    Modern C++ Design: Generic Programming and Design Patterns Applied Section 2.1
55    by Andrei Alexandrescu
56 */
57 namespace senf {
58 namespace detail {
59     template<bool> class compile_time_check
60     {
61     public:
62         compile_time_check(...) {}
63     };
64
65     template<> class compile_time_check<false>
66     {
67     };
68 }}
69
70     /*
71     SENF_STATIC_ASSERT is only in operation when SENF_DEBUG is defined. It will test its first
72     argument at compile time and on failure report the error message of the second argument,
73     which must be a valid c++ classname. i.e. no spaces, punctuation or reserved keywords.
74     */
75 #ifdef SENF_DEBUG
76 #   define SENF_STATIC_ASSERT(expr, msg)                                    \
77     do {                                                                    \
78         struct STATIC_ASSERT_FAILED_##msg {};                               \
79         typedef senf::detail::compile_time_check< (expr) != 0 > tmplimpl;   \
80         tmplimpl aTemp = tmplimpl(STATIC_ASSERT_FAILED_##msg());            \
81         (void)sizeof(aTemp);                                                      \
82     } while (0)
83 #else
84 #   define SENF_STATIC_ASSERT(expr, msg)
85 #endif
86
87 //-/////////////////////////////////////////////////////////////////////////////////////////////////
88 //#include "senfassert.cci"
89 //#include "senfassert.ct"
90 //#include "senfassert.cti"
91 #endif
92
93 \f
94 // Local Variables:
95 // mode: c++
96 // fill-column: 100
97 // comment-column: 40
98 // c-file-style: "senf"
99 // indent-tabs-mode: nil
100 // ispell-local-dictionary: "american"
101 // compile-command: "scons -u test"
102 // End: