| OpenMS 2.5.0

openms/include/OpenMS/CONCEPT/Macros.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2020.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Timo Sachsenberg$
32 // $Authors: Marc Sturm $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37
38 #include <OpenMS/config.h>
39 #include <OpenMS/CONCEPT/Exception.h>
40
41 #include <string>
42 #include <cstring>
43
50 #define STRINGIFY(a) #a
51
52 #ifdef _OPENMP
53
54 // Pragma string literals are compiler-specific:
55 // gcc and clang use _Pragma while MSVS uses __pragma
56 // the MSVS pragma does not need a string token somehow.
57 #ifdef OPENMS_COMPILER_MSVC
58 #define OPENMS_THREAD_CRITICAL(name) \
59 __pragma(omp critical (name))
60 #else
61 #define OPENMS_THREAD_CRITICAL(name) \
62 _Pragma( STRINGIFY( omp critical (name) ) )
63 #endif
64
65 #else
66
67 #define OPENMS_THREAD_CRITICAL(name)
68
69 #endif
70 // end of helpers
72
73
89 #ifdef OPENMS_ASSERTIONS
90
96 #define OPENMS_PRECONDITION(condition, message) \
97 if (!(condition)) \
98 { \
99 Exception::Precondition e(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, # condition); \
100 if (std::strcmp(message, "") != 0) \
101 { \
102 ::std::string tmp(e.getMessage()); \
103 tmp += " "; \
104 tmp += ::std::string(message); \
105 e.setMessage(tmp); \
106 } \
107 throw e; \
108 } \
109
110
115 #define OPENMS_POSTCONDITION(condition, message) \
116 if (!(condition)) \
117 { \
118 Exception::Postcondition e(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, # condition); \
119 if (std::strcmp(message, "") != 0) \
120 { \
121 std::string tmp(e.getMessage()); \
122 tmp += " "; \
123 tmp += std::string(message); \
124 e.setMessage(tmp); \
125 } \
126 throw e; \
127 } \
128
129 #else
130
136 #define OPENMS_PRECONDITION(condition, message)
137
143 #define OPENMS_POSTCONDITION(condition, message)
144
145 #endif
146 // end of Conditions
148
Exception.h