summaryrefslogtreecommitdiffstats
path: root/include/zix/attributes.h
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2021-09-10 20:11:45 -0400
committerDavid Robillard <d@drobilla.net>2021-09-10 20:54:28 -0400
commit1f8c8118f2d42f495dbe6e3adb2a95c87a92e8e0 (patch)
tree917f42d6b9dae4884330e950d8beb3d115ce4bd5 /include/zix/attributes.h
parentf522f8e480e8ef95ecb5e597ff3a22700d9ac9cf (diff)
downloadzix-1f8c8118f2d42f495dbe6e3adb2a95c87a92e8e0.tar.gz
zix-1f8c8118f2d42f495dbe6e3adb2a95c87a92e8e0.tar.bz2
zix-1f8c8118f2d42f495dbe6e3adb2a95c87a92e8e0.zip
Move attribute definitions to a separate header
Diffstat (limited to 'include/zix/attributes.h')
-rw-r--r--include/zix/attributes.h81
1 files changed, 81 insertions, 0 deletions
diff --git a/include/zix/attributes.h b/include/zix/attributes.h
new file mode 100644
index 0000000..c8f77c4
--- /dev/null
+++ b/include/zix/attributes.h
@@ -0,0 +1,81 @@
+/*
+ Copyright 2021 David Robillard <d@drobilla.net>
+
+ Permission to use, copy, modify, and/or distribute this software for any
+ purpose with or without fee is hereby granted, provided that the above
+ copyright notice and this permission notice appear in all copies.
+
+ THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+
+#ifndef ZIX_ATTRIBUTES_H
+#define ZIX_ATTRIBUTES_H
+
+/**
+ @addtogroup zix
+ @{
+*/
+
+// ZIX_API must be used to decorate things in the public API
+#ifndef ZIX_API
+# if defined(_WIN32) && !defined(ZIX_STATIC) && defined(ZIX_INTERNAL)
+# define ZIX_API __declspec(dllexport)
+# elif defined(_WIN32) && !defined(ZIX_STATIC)
+# define ZIX_API __declspec(dllimport)
+# elif defined(__GNUC__)
+# define ZIX_API __attribute__((visibility("default")))
+# else
+# define ZIX_API
+# endif
+#endif
+
+// GCC pure/const/malloc attributes
+#ifdef __GNUC__
+# define ZIX_PURE_FUNC __attribute__((pure))
+# define ZIX_CONST_FUNC __attribute__((const))
+# define ZIX_MALLOC_FUNC __attribute__((malloc))
+#else
+# define ZIX_PURE_FUNC
+# define ZIX_CONST_FUNC
+# define ZIX_MALLOC_FUNC
+#endif
+
+#define ZIX_PURE_API \
+ ZIX_API \
+ ZIX_PURE_FUNC
+
+#define ZIX_CONST_API \
+ ZIX_API \
+ ZIX_CONST_FUNC
+
+#define ZIX_MALLOC_API \
+ ZIX_API \
+ ZIX_MALLOC_FUNC
+
+// Printf-like format functions
+#ifdef __GNUC__
+# define ZIX_LOG_FUNC(fmt, arg1) __attribute__((format(printf, fmt, arg1)))
+#else
+# define ZIX_LOG_FUNC(fmt, arg1)
+#endif
+
+// Unused parameter macro to suppresses warnings and make it impossible to use
+#if defined(__cplusplus)
+# define ZIX_UNUSED(name)
+#elif defined(__GNUC__)
+# define ZIX_UNUSED(name) name##_unused __attribute__((__unused__))
+#else
+# define ZIX_UNUSED(name) name
+#endif
+
+/**
+ @}
+*/
+
+#endif /* ZIX_ATTRIBUTES_H */