1/*
2 *  Copyright 2004 The WebRTC Project Authors. All rights reserved.
3 *
4 *  Use of this source code is governed by a BSD-style license
5 *  that can be found in the LICENSE file in the root of the source
6 *  tree. An additional intellectual property rights grant can be found
7 *  in the file PATENTS.  All contributing project authors may
8 *  be found in the AUTHORS file in the root of the source tree.
9 */
10
11#ifndef WEBRTC_BASE_COMMON_H_  // NOLINT
12#define WEBRTC_BASE_COMMON_H_
13
14#include "webrtc/base/basictypes.h"
15#include "webrtc/base/constructormagic.h"
16
17#if defined(_MSC_VER)
18// warning C4355: 'this' : used in base member initializer list
19#pragma warning(disable:4355)
20#endif
21
22//////////////////////////////////////////////////////////////////////
23// General Utilities
24//////////////////////////////////////////////////////////////////////
25
26#ifndef RTC_UNUSED
27#define RTC_UNUSED(x) RtcUnused(static_cast<const void*>(&x))
28#define RTC_UNUSED2(x, y) RtcUnused(static_cast<const void*>(&x)); \
29    RtcUnused(static_cast<const void*>(&y))
30#define RTC_UNUSED3(x, y, z) RtcUnused(static_cast<const void*>(&x)); \
31    RtcUnused(static_cast<const void*>(&y)); \
32    RtcUnused(static_cast<const void*>(&z))
33#define RTC_UNUSED4(x, y, z, a) RtcUnused(static_cast<const void*>(&x)); \
34    RtcUnused(static_cast<const void*>(&y)); \
35    RtcUnused(static_cast<const void*>(&z)); \
36    RtcUnused(static_cast<const void*>(&a))
37#define RTC_UNUSED5(x, y, z, a, b) RtcUnused(static_cast<const void*>(&x)); \
38    RtcUnused(static_cast<const void*>(&y)); \
39    RtcUnused(static_cast<const void*>(&z)); \
40    RtcUnused(static_cast<const void*>(&a)); \
41    RtcUnused(static_cast<const void*>(&b))
42inline void RtcUnused(const void*) {}
43#endif  // RTC_UNUSED
44
45#if !defined(WEBRTC_WIN)
46
47#ifndef strnicmp
48#define strnicmp(x, y, n) strncasecmp(x, y, n)
49#endif
50
51#ifndef stricmp
52#define stricmp(x, y) strcasecmp(x, y)
53#endif
54
55// TODO(fbarchard): Remove this. std::max should be used everywhere in the code.
56// NOMINMAX must be defined where we include <windows.h>.
57#define stdmax(x, y) std::max(x, y)
58#else
59#define stdmax(x, y) rtc::_max(x, y)
60#endif
61
62#define ARRAY_SIZE(x) (static_cast<int>(sizeof(x) / sizeof(x[0])))
63
64/////////////////////////////////////////////////////////////////////////////
65// Assertions
66/////////////////////////////////////////////////////////////////////////////
67
68#ifndef ENABLE_DEBUG
69#define ENABLE_DEBUG _DEBUG
70#endif  // !defined(ENABLE_DEBUG)
71
72// Even for release builds, allow for the override of LogAssert. Though no
73// macro is provided, this can still be used for explicit runtime asserts
74// and allow applications to override the assert behavior.
75
76namespace rtc {
77
78
79// If a debugger is attached, triggers a debugger breakpoint. If a debugger is
80// not attached, forces program termination.
81void Break();
82
83// LogAssert writes information about an assertion to the log. It's called by
84// Assert (and from the ASSERT macro in debug mode) before any other action
85// is taken (e.g. breaking the debugger, abort()ing, etc.).
86void LogAssert(const char* function, const char* file, int line,
87               const char* expression);
88
89typedef void (*AssertLogger)(const char* function,
90                             const char* file,
91                             int line,
92                             const char* expression);
93
94// Sets a custom assert logger to be used instead of the default LogAssert
95// behavior. To clear the custom assert logger, pass NULL for |logger| and the
96// default behavior will be restored. Only one custom assert logger can be set
97// at a time, so this should generally be set during application startup and
98// only by one component.
99void SetCustomAssertLogger(AssertLogger logger);
100
101bool IsOdd(int n);
102
103bool IsEven(int n);
104
105}  // namespace rtc
106
107#if ENABLE_DEBUG
108
109namespace rtc {
110
111inline bool Assert(bool result, const char* function, const char* file,
112                   int line, const char* expression) {
113  if (!result) {
114    LogAssert(function, file, line, expression);
115    Break();
116  }
117  return result;
118}
119
120// Same as Assert above, but does not call Break().  Used in assert macros
121// that implement their own breaking.
122inline bool AssertNoBreak(bool result, const char* function, const char* file,
123                          int line, const char* expression) {
124  if (!result)
125    LogAssert(function, file, line, expression);
126  return result;
127}
128
129}  // namespace rtc
130
131#if defined(_MSC_VER) && _MSC_VER < 1300
132#define __FUNCTION__ ""
133#endif
134
135#ifndef ASSERT
136#if defined(WIN32)
137// Using debugbreak() inline on Windows directly in the ASSERT macro, has the
138// benefit of breaking exactly where the failing expression is and not two
139// calls up the stack.
140#define ASSERT(x) \
141    (rtc::AssertNoBreak((x), __FUNCTION__, __FILE__, __LINE__, #x) ? \
142     (void)(1) : __debugbreak())
143#else
144#define ASSERT(x) \
145    (void)rtc::Assert((x), __FUNCTION__, __FILE__, __LINE__, #x)
146#endif
147#endif
148
149#ifndef VERIFY
150#if defined(WIN32)
151#define VERIFY(x) \
152    (rtc::AssertNoBreak((x), __FUNCTION__, __FILE__, __LINE__, #x) ? \
153     true : (__debugbreak(), false))
154#else
155#define VERIFY(x) rtc::Assert((x), __FUNCTION__, __FILE__, __LINE__, #x)
156#endif
157#endif
158
159#else  // !ENABLE_DEBUG
160
161namespace rtc {
162
163inline bool ImplicitCastToBool(bool result) { return result; }
164
165}  // namespace rtc
166
167#ifndef ASSERT
168#define ASSERT(x) (void)0
169#endif
170
171#ifndef VERIFY
172#define VERIFY(x) rtc::ImplicitCastToBool(x)
173#endif
174
175#endif  // !ENABLE_DEBUG
176
177#define COMPILE_TIME_ASSERT(expr)       char CTA_UNIQUE_NAME[expr]
178#define CTA_UNIQUE_NAME                 CTA_MAKE_NAME(__LINE__)
179#define CTA_MAKE_NAME(line)             CTA_MAKE_NAME2(line)
180#define CTA_MAKE_NAME2(line)            constraint_ ## line
181
182// Forces compiler to inline, even against its better judgement. Use wisely.
183#if defined(__GNUC__)
184#define FORCE_INLINE __attribute__((always_inline))
185#elif defined(WEBRTC_WIN)
186#define FORCE_INLINE __forceinline
187#else
188#define FORCE_INLINE
189#endif
190
191// Borrowed from Chromium's base/compiler_specific.h.
192// Annotate a virtual method indicating it must be overriding a virtual
193// method in the parent class.
194// Use like:
195//   virtual void foo() OVERRIDE;
196#if defined(WEBRTC_WIN)
197#define OVERRIDE override
198#elif defined(__clang__)
199// Clang defaults to C++03 and warns about using override. Squelch that.
200// Intentionally no push/pop here so all users of OVERRIDE ignore the warning
201// too. This is like passing -Wno-c++11-extensions, except that GCC won't die
202// (because it won't see this pragma).
203#pragma clang diagnostic ignored "-Wc++11-extensions"
204#define OVERRIDE override
205#elif defined(__GNUC__) && __cplusplus >= 201103 && \
206    (__GNUC__ * 10000 + __GNUC_MINOR__ * 100) >= 40700
207// GCC 4.7 supports explicit virtual overrides when C++11 support is enabled.
208#define OVERRIDE override
209#else
210#define OVERRIDE
211#endif
212
213// Annotate a function indicating the caller must examine the return value.
214// Use like:
215//   int foo() WARN_UNUSED_RESULT;
216// To explicitly ignore a result, see |ignore_result()| in <base/basictypes.h>.
217// TODO(ajm): Hack to avoid multiple definitions until the base/ of webrtc and
218// libjingle are merged.
219#if !defined(WARN_UNUSED_RESULT)
220#if defined(__GNUC__)
221#define WARN_UNUSED_RESULT __attribute__((warn_unused_result))
222#else
223#define WARN_UNUSED_RESULT
224#endif
225#endif  // WARN_UNUSED_RESULT
226
227#endif  // WEBRTC_BASE_COMMON_H_    // NOLINT
228