spot  1.99.4
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
common.hh
1 // -*- coding: utf-8 -*-
2 // Copyright (C) 2013, 2014, 2015 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 
23 #pragma once
24 
25 #ifdef __GNUC__
26 #define SPOT_LIKELY(expr) __builtin_expect(!!(expr), 1)
27 #define SPOT_UNLIKELY(expr) __builtin_expect(!!(expr), 0)
28 #else
29 #define SPOT_LIKELY(expr) (expr)
30 #define SPOT_UNLIKELY(expr) (expr)
31 #endif
32 
33 #ifdef __GNUC__
34 #define SPOT_DEPRECATED __attribute__ ((deprecated))
35 #elif defined(_MSC_VER)
36 #define SPOT_DEPRECATED __declspec(deprecated)
37 #else
38 #define SPOT_DEPRECATED func
39 #endif
40 
41 #if defined _WIN32 || defined __CYGWIN__
42  #define SPOT_HELPER_DLL_IMPORT __declspec(dllimport)
43  #define SPOT_HELPER_DLL_EXPORT __declspec(dllexport)
44  #define SPOT_HELPER_DLL_LOCAL
45 #else
46  #if __GNUC__ >= 4
47  #define SPOT_HELPER_DLL_IMPORT __attribute__ ((visibility ("default")))
48  #define SPOT_HELPER_DLL_EXPORT __attribute__ ((visibility ("default")))
49  #define SPOT_HELPER_DLL_LOCAL __attribute__ ((visibility ("hidden")))
50  #else
51  #define SPOT_HELPER_DLL_IMPORT
52  #define SPOT_HELPER_DLL_EXPORT
53  #define SPOT_HELPER_DLL_LOCAL
54  #endif
55 #endif
56 
57 #ifdef SPOT_BUILD
58  #define SPOT_DLL
59 #endif
60 
61 // SPOT_API is used for the public API symbols. It either DLL imports
62 // or DLL exports (or does nothing for static build) SPOT_LOCAL is
63 // used for non-api symbols that may occur in header files.
64 #ifdef SPOT_DLL
65  #ifdef SPOT_BUILD
66  #define SPOT_API SPOT_HELPER_DLL_EXPORT
67  #else
68  #define SPOT_API SPOT_HELPER_DLL_IMPORT
69  #endif
70  #define SPOT_LOCAL SPOT_HELPER_DLL_LOCAL
71 #else
72  #define SPOT_API
73  #define SPOT_LOCAL
74 #endif
75 #define SPOT_API_VAR extern SPOT_API
76 
77 
78 // Swig 2.0 does not understand '= delete'. This already
79 // works with the development version of Swig 3.
80 // Swig 3.0.2 still does not understand 'final' when used
81 // at class definition.
82 #ifdef SWIG
83  #define SPOT_DELETED
84  #define final
85 #else
86  #define SPOT_DELETED = delete
87 #endif
88 
89 
90 // Do not use those in code, prefer SPOT_UNREACHABLE() instead.
91 #if defined __clang__ || defined __GNU__
92 # define SPOT_UNREACHABLE_BUILTIN() __builtin_unreachable()
93 # elif defined _MSC_VER
94 # define SPOT_UNREACHABLE_BUILTIN() __assume(0)
95 # else
96 # define SPOT_UNREACHABLE_BUILTIN() abort()
97 #endif
98 
99 // The extra parentheses in assert() is so that this
100 // pattern is not caught by the style checker.
101 #define SPOT_UNREACHABLE() do { \
102  assert(!("unreachable code reached")); \
103  SPOT_UNREACHABLE_BUILTIN(); \
104  } while (0)
105 
106 #define SPOT_UNIMPLEMENTED() throw std::runtime_error("unimplemented");
107 
108 
109 // Useful when forwarding methods such as:
110 // auto func(int param) SPOT_RETURN(implem_.func(param));
111 #define SPOT_RETURN(code) -> decltype(code) { return code; }
112 
113 
114 namespace spot
115 {
116  struct SPOT_API parse_error: public std::runtime_error
117  {
118  parse_error(const std::string& s)
119  : std::runtime_error(s)
120  {
121  }
122  };
123 }
Definition: graph.hh:31
Definition: common.hh:116

Please direct any question, comment, or bug report to the Spot mailing list at spot@lrde.epita.fr.
Generated on Thu Oct 1 2015 05:49:14 for spot by doxygen 1.8.8