spot 2.3.3

- Main Page
- Related Pages
- Modules
- Classes
- Files

- File List

All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
common.hh
1 // -*- coding: utf-8 -*-
2 // Copyright (C) 2013, 2014, 2015, 2016, 2017 Laboratoire de Recherche et
3 // Développement de l'Epita (LRDE).
4 //
5 // This file is part of Spot, a model checking library.
6 //
7 // Spot is free software; you can redistribute it and/or modify it
8 // under the terms of the GNU General Public License as published by
9 // the Free Software Foundation; either version 3 of the License, or
10 // (at your option) any later version.
11 //
12 // Spot is distributed in the hope that it will be useful, but WITHOUT
13 // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
14 // or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
15 // License for more details.
16 //
17 // You should have received a copy of the GNU General Public License
18 // along with this program. If not, see <http://www.gnu.org/licenses/>.
19
20 #include <cstdlib>
21 #include <stdexcept>
22 #include <cassert>
23
24 #pragma once
25
26 #ifdef __GNUC__
27 #define SPOT_LIKELY(expr) __builtin_expect(!!(expr), 1)
28 #define SPOT_UNLIKELY(expr) __builtin_expect(!!(expr), 0)
29 #else
30 #define SPOT_LIKELY(expr) (expr)
31 #define SPOT_UNLIKELY(expr) (expr)
32 #endif
33
34 #ifdef __has_cpp_attribute
35 # if __has_cpp_attribute(deprecated) && __cplusplus >= 201402L
36 # define SPOT_DEPRECATED(msg) [[deprecated(msg)]]
37 # elif __has_cpp_attribute(gnu::deprecated)
38 # define SPOT_DEPRECATED(msg) [[gnu::deprecated(msg)]]
39 # elif __has_cpp_attribute(clang::deprecated)
40 # define SPOT_DEPRECATED(msg) [[clang::deprecated(msg)]]
41 # endif
42 #endif
43 #ifndef SPOT_DEPRECATED
44 # ifdef __GNUC__
45 # define SPOT_DEPRECATED(msg) __attribute__ ((deprecated))
46 # elif defined(_MSC_VER)
47 # define SPOT_DEPRECATED(msg) __declspec(deprecated)
48 # else
49 # define SPOT_DEPRECATED(msg)
50 # endif
51 #endif
52
53 #if defined _WIN32 || defined __CYGWIN__
54 #define SPOT_HELPER_DLL_IMPORT __declspec(dllimport)
55 #define SPOT_HELPER_DLL_EXPORT __declspec(dllexport)
56 #define SPOT_HELPER_DLL_LOCAL
57 #else
58 #if __GNUC__ >= 4
59 #define SPOT_HELPER_DLL_IMPORT __attribute__ ((visibility ("default")))
60 #define SPOT_HELPER_DLL_EXPORT __attribute__ ((visibility ("default")))
61 #define SPOT_HELPER_DLL_LOCAL __attribute__ ((visibility ("hidden")))
62 #else
63 #define SPOT_HELPER_DLL_IMPORT
64 #define SPOT_HELPER_DLL_EXPORT
65 #define SPOT_HELPER_DLL_LOCAL
66 #endif
67 #endif
68
69 #ifdef SPOT_BUILD
70 #define SPOT_DLL
71 #endif
72
73
74 // We should not call assert() in headers. For the rare cases where
75 // we do really want to call assert(), use spot_assert__ instead.
76 // Else use SPOT_ASSERT so the assert() are removed from user's
77 // builds.
78 #define spot_assert__ assert
79 #if defined(SPOT_BUILD) or defined(SPOT_DEBUG)
80 #define SPOT_ASSERT(x) spot_assert__(x)
81 #else
82 #define SPOT_ASSERT(x) while (0)
83 #endif
84
85 // SPOT_API is used for the public API symbols. It either DLL imports
86 // or DLL exports (or does nothing for static build) SPOT_LOCAL is
87 // used for non-api symbols that may occur in header files.
88 #ifdef SPOT_DLL
89 #ifdef SPOT_BUILD
90 #define SPOT_API SPOT_HELPER_DLL_EXPORT
91 #else
92 #define SPOT_API SPOT_HELPER_DLL_IMPORT
93 #endif
94 #define SPOT_LOCAL SPOT_HELPER_DLL_LOCAL
95 #else
96 #define SPOT_API
97 #define SPOT_LOCAL
98 #endif
99 #define SPOT_API_VAR extern SPOT_API
100
101
102 // Swig 3.0.2 does not understand 'final' when used
103 // at class definition.
104 #ifdef SWIG
105 #define final
106 #endif
107
108
109 // Do not use those in code, prefer SPOT_UNREACHABLE() instead.
110 #if defined __clang__ || defined __GNU__
111 # define SPOT_UNREACHABLE_BUILTIN() __builtin_unreachable()
112 # elif defined _MSC_VER
113 # define SPOT_UNREACHABLE_BUILTIN() __assume(0)
114 # else
115 # define SPOT_UNREACHABLE_BUILTIN() abort()
116 #endif
117
118 // The extra parentheses in assert() is so that this
119 // pattern is not caught by the style checker.
120 #define SPOT_UNREACHABLE() do { \
121 SPOT_ASSERT(!("unreachable code reached")); \
122 SPOT_UNREACHABLE_BUILTIN(); \
123 } while (0)
124
125 #define SPOT_UNIMPLEMENTED() throw std::runtime_error("unimplemented");
126
127
128 // Useful when forwarding methods such as:
129 // auto func(int param) SPOT_RETURN(implem_.func(param));
130 #define SPOT_RETURN(code) -> decltype(code) { return code; }
131
132 // We hope compilers that implement -Wimplicit-fallthrough also
133 // support __has_cpp_attribute and some form of [[fallthrough]]. Do
134 // not use [[fallthough]] if the code is compiled in a pre-C++17
135 // standard since clang's -Wpedantic would complain that we are using
136 // a feature from the future.
137 #ifdef __has_cpp_attribute
138 # if __has_cpp_attribute(fallthrough) && __cplusplus > 201402L
139 # define SPOT_FALLTHROUGH [[fallthrough]]
140 # elif __has_cpp_attribute(clang::fallthrough)
141 # define SPOT_FALLTHROUGH [[clang::fallthrough]]
142 # elif __has_cpp_attribute(gnu::fallthrough)
143 # define SPOT_FALLTHROUGH [[gnu::fallthrough]]
144 # endif
145 #endif
146 #ifndef SPOT_FALLTHROUGH
147 // Clang 3.5 does not support __has_cpp_attribute but has
148 // [[clang::fallthrough]].
149 # if __clang__
150 # define SPOT_FALLTHROUGH [[clang::fallthrough]]
151 # else
152 # define SPOT_FALLTHROUGH while (0)
153 # endif
154 #endif
155
156 namespace spot
157 {
158 struct SPOT_API parse_error: public std::runtime_error
159 {
160 parse_error(const std::string& s)
161 : std::runtime_error(s)
162 {
163 }
164 };
165 }
spot
Definition: graph.hh:33
spot::parse_error
Definition: common.hh:158

Please direct any question, comment, or bug report to the Spot mailing list at spot@lrde.epita.fr.