1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
/* ws_attributes.h
*
* Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
*
* SPDX-License-Identifier: GPL-2.0-or-later
*/
#ifndef __WS_ATTRIBUTES_H__
#define __WS_ATTRIBUTES_H__
#include "ws_compiler_tests.h"
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/*
* If we're running GCC or clang define _U_ to be "__attribute__((unused))"
* so we can use _U_ to flag unused function parameters and not get warnings
* about them. Otherwise, define _U_ to be an empty string so that _U_ used
* to flag an unused function parameters will compile with other compilers.
*
* XXX - similar hints for other compilers?
*/
#if defined(__GNUC__)
/* This includes clang */
#define _U_ __attribute__((unused))
#elif defined(_MSC_VER)
#define _U_ __pragma(warning(suppress:4100 4189))
#else
#define _U_
#endif
/*
* WS_NORETURN, before a function declaration, means "this function
* never returns". (It must go before the function declaration, e.g.
* "extern WS_NORETURN func(...)" rather than after the function
* declaration, as the MSVC version has to go before the declaration.)
*/
#ifndef __cplusplus
#define WS_NORETURN _Noreturn
#else /* __cplusplus */
#if __has_attribute(noreturn) \
|| WS_IS_AT_LEAST_GNUC_VERSION(2,5) \
|| WS_IS_AT_LEAST_SUNC_VERSION(5,9) \
|| WS_IS_AT_LEAST_XL_C_VERSION(10,1) \
|| WS_IS_AT_LEAST_HP_C_VERSION(6,10)
/*
* Compiler with support for __attribute__((noreturn)), or GCC 2.5 and
* later, or Solaris Studio 12 (Sun C 5.9) and later, or IBM XL C 10.1
* and later (do any earlier versions of XL C support this?), or
* HP aCC A.06.10 and later.
*/
#define WS_NORETURN __attribute__((noreturn))
#elif defined(_MSC_VER)
/*
* MSVC.
*/
#define WS_NORETURN __declspec(noreturn)
#else
#define WS_NORETURN
#endif
#endif /* __cplusplus */
/*
* WS_RETNONNULL, before a function declaration, means "this function
* always returns a non-null pointer".
*/
#if __has_attribute(returns_nonnull) \
|| WS_IS_AT_LEAST_GNUC_VERSION(4,9)
#define WS_RETNONNULL __attribute__((returns_nonnull))
#else
#define WS_RETNONNULL
#endif
/*
* WS_DEPRECATED, before a function declaration, means "this function
* should not be used anymore and will be removed in a future version".
* WS_DEPRECATED_X() optionally takes a message saying what should be done
* instead (strongly recommended).
*
* This is not implemented on purpose with MSVC because that compiler has no
* equivalent to -Wno-error=deprecated-declarations, making it impossible
* to build with -Werror and deprecated declarations. The Microsoft developer
* team seems to not understand the requirement.
* https://developercommunity.visualstudio.com/t/cant-treat-deprecated-warning-as-warning-with-wx/786502
* https://developercommunity.visualstudio.com/t/impossible-to-treat-warning-as-error-except-specif/473936
*/
#if __has_attribute(deprecated)
#define WS_DEPRECATED __attribute__((deprecated))
#define WS_DEPRECATED_X(msg) __attribute__((deprecated(msg)))
#else
#define WS_DEPRECATED
#define WS_DEPRECATED_X(msg)
#endif
/*
* WS_THREAD_LOCAL means "this variable should go in thread-local
* storage.
*
* Based on
*
* https://en.wikipedia.org/w/index.php?title=Thread-local_storage&oldid=1064900318#C_and_C++
*
* the major UN*X C compilers support __thread and the major Windows C
* compilers support __declspec(thread).
*/
#ifdef _MSC_VER
#define WS_THREAD_LOCAL __declspec(thread)
#else
#define WS_THREAD_LOCAL __thread
#endif
/*
* The warn_unused_result attribute causes a warning to be emitted if a caller
* of the function with this attribute does not use its return value. This is
* useful for functions where not checking the result is either a security
* problem or always a bug, such as realloc.
*/
#if defined(__GNUC__)
/* This includes clang */
#define WS_WARN_UNUSED __attribute__((warn_unused_result))
#else
#define WS_WARN_UNUSED
#endif
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* __WS_ATTRIBUTES_H__ */
|
