spot 2.2.2

- 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 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 __GNUC__
35 #define SPOT_DEPRECATED __attribute__ ((deprecated))
36 #elif defined(_MSC_VER)
37 #define SPOT_DEPRECATED __declspec(deprecated)
38 #else
39 #define SPOT_DEPRECATED func
40 #endif
41
42 #if defined _WIN32 || defined __CYGWIN__
43 #define SPOT_HELPER_DLL_IMPORT __declspec(dllimport)
44 #define SPOT_HELPER_DLL_EXPORT __declspec(dllexport)
45 #define SPOT_HELPER_DLL_LOCAL
46 #else
47 #if __GNUC__ >= 4
48 #define SPOT_HELPER_DLL_IMPORT __attribute__ ((visibility ("default")))
49 #define SPOT_HELPER_DLL_EXPORT __attribute__ ((visibility ("default")))
50 #define SPOT_HELPER_DLL_LOCAL __attribute__ ((visibility ("hidden")))
51 #else
52 #define SPOT_HELPER_DLL_IMPORT
53 #define SPOT_HELPER_DLL_EXPORT
54 #define SPOT_HELPER_DLL_LOCAL
55 #endif
56 #endif
57
58 #ifdef SPOT_BUILD
59 #define SPOT_DLL
60 #endif
61
62
63 // We should not call assert() in headers. For the rare cases where
64 // we do really want to call assert(), use spot_assert__ instead.
65 // Else use SPOT_ASSERT so the assert() are removed from user's
66 // builds.
67 #define spot_assert__ assert
68 #if defined(SPOT_BUILD) or defined(SPOT_DEBUG)
69 #define SPOT_ASSERT(x) spot_assert__(x)
70 #else
71 #define SPOT_ASSERT(x) while (0)
72 #endif
73
74 // SPOT_API is used for the public API symbols. It either DLL imports
75 // or DLL exports (or does nothing for static build) SPOT_LOCAL is
76 // used for non-api symbols that may occur in header files.
77 #ifdef SPOT_DLL
78 #ifdef SPOT_BUILD
79 #define SPOT_API SPOT_HELPER_DLL_EXPORT
80 #else
81 #define SPOT_API SPOT_HELPER_DLL_IMPORT
82 #endif
83 #define SPOT_LOCAL SPOT_HELPER_DLL_LOCAL
84 #else
85 #define SPOT_API
86 #define SPOT_LOCAL
87 #endif
88 #define SPOT_API_VAR extern SPOT_API
89
90
91 // Swig 3.0.2 does not understand 'final' when used
92 // at class definition.
93 #ifdef SWIG
94 #define final
95 #endif
96
97
98 // Do not use those in code, prefer SPOT_UNREACHABLE() instead.
99 #if defined __clang__ || defined __GNU__
100 # define SPOT_UNREACHABLE_BUILTIN() __builtin_unreachable()
101 # elif defined _MSC_VER
102 # define SPOT_UNREACHABLE_BUILTIN() __assume(0)
103 # else
104 # define SPOT_UNREACHABLE_BUILTIN() abort()
105 #endif
106
107 // The extra parentheses in assert() is so that this
108 // pattern is not caught by the style checker.
109 #define SPOT_UNREACHABLE() do { \
110 SPOT_ASSERT(!("unreachable code reached")); \
111 SPOT_UNREACHABLE_BUILTIN(); \
112 } while (0)
113
114 #define SPOT_UNIMPLEMENTED() throw std::runtime_error("unimplemented");
115
116
117 // Useful when forwarding methods such as:
118 // auto func(int param) SPOT_RETURN(implem_.func(param));
119 #define SPOT_RETURN(code) -> decltype(code) { return code; }
120
121 // We hope compilers that implement -Wimplicit-fallthrough
122 // also support __has_cpp_attribute and some form of [[fallthrough]].
123 #ifdef __has_cpp_attribute
124 # if __has_cpp_attribute(fallthrough)
125 # define SPOT_FALLTHROUGH [[fallthrough]]
126 # elif __has_cpp_attribute(clang::fallthrough)
127 # define SPOT_FALLTHROUGH [[clang::fallthrough]]
128 # elif __has_cpp_attribute(gcc::fallthrough)
129 # define SPOT_FALLTHROUGH [[gcc::fallthrough]]
130 # endif
131 #endif
132 #ifndef SPOT_FALLTHROUGH
133 // Clang 3.5 does not support __has_cpp_attribute but has
134 // [[clang::fallthrough]].
135 # if __clang__
136 # define SPOT_FALLTHROUGH [[clang::fallthrough]]
137 # else
138 # define SPOT_FALLTHROUGH while (0)
139 # endif
140 #endif
141
142 namespace spot
143 {
144 struct SPOT_API parse_error: public std::runtime_error
145 {
146 parse_error(const std::string& s)
147 : std::runtime_error(s)
148 {
149 }
150 };
151 }
spot
Definition: graph.hh:32
spot::parse_error
Definition: common.hh:144

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