summaryrefslogtreecommitdiff
path: root/src/include/cvc5_public.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/include/cvc5_public.h')
-rw-r--r--src/include/cvc5_public.h42
1 files changed, 42 insertions, 0 deletions
diff --git a/src/include/cvc5_public.h b/src/include/cvc5_public.h
new file mode 100644
index 000000000..ede5f5223
--- /dev/null
+++ b/src/include/cvc5_public.h
@@ -0,0 +1,42 @@
+/******************************************************************************
+ * Top contributors (to current version):
+ * Morgan Deters, Mathias Preiner
+ *
+ * This file is part of the cvc5 project.
+ *
+ * Copyright (c) 2009-2021 by the authors listed in the file AUTHORS
+ * in the top-level source directory and their institutional affiliations.
+ * All rights reserved. See the file COPYING in the top-level source
+ * directory for licensing information.
+ * ****************************************************************************
+ *
+ * Macros that should be defined everywhere during the building of
+ * the libraries and driver binary, and also exported to the user.
+ */
+
+#ifndef CVC5_PUBLIC_H
+#define CVC5_PUBLIC_H
+
+#include <stddef.h>
+#include <stdint.h>
+
+// CVC5_UNUSED is to mark something (e.g. local variable, function)
+// as being _possibly_ unused, so that the compiler generates no
+// warning about it. This might be the case for e.g. a variable
+// only used in DEBUG builds.
+
+#ifdef __GNUC__
+#define CVC5_UNUSED __attribute__((__unused__))
+#define CVC5_NORETURN __attribute__((__noreturn__))
+#define CVC5_CONST_FUNCTION __attribute__((__const__))
+#define CVC5_PURE_FUNCTION __attribute__((__pure__))
+#define CVC5_WARN_UNUSED_RESULT __attribute__((__warn_unused_result__))
+#else /* ! __GNUC__ */
+#define CVC5_UNUSED
+#define CVC5_NORETURN
+#define CVC5_CONST_FUNCTION
+#define CVC5_PURE_FUNCTION
+#define CVC5_WARN_UNUSED_RESULT
+#endif /* __GNUC__ */
+
+#endif /* CVC5_PUBLIC_H */
generated by cgit on debian on lair
contact matthew@masot.net with questions or feedback