deDefs.hpp revision 93df37596ea66700965094b3aa2830cf4f2ca5aa 
1#ifndef _DEDEFS_HPP
2#define _DEDEFS_HPP
3/*-------------------------------------------------------------------------
4 * drawElements C++ Base Library
5 * -----------------------------
6 *
7 * Copyright 2014 The Android Open Source Project
8 *
9 * Licensed under the Apache License, Version 2.0 (the "License");
10 * you may not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
12 *
13 *      http://www.apache.org/licenses/LICENSE-2.0
14 *
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS,
17 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
20 *
21 *//*!
22 * \file
23 * \brief Basic definitions.
24 *//*--------------------------------------------------------------------*/
25
26#include "deDefs.h"
27
28#if !defined(__cplusplus)
29#	error "C++ is required"
30#endif
31
32namespace de
33{
34
35//!< Compute absolute value of x.
36template<typename T> inline T		abs			(T x)			{ return x < T(0) ? -x : x; }
37
38//!< Get minimum of x and y.
39template<typename T> inline T		min			(T x, T y)		{ return x <= y ? x : y; }
40
41//!< Get maximum of x and y.
42template<typename T> inline T		max			(T x, T y)		{ return x >= y ? x : y; }
43
44//!< Clamp x in range a <= x <= b.
45template<typename T> inline T		clamp		(T x, T a, T b)	{ DE_ASSERT(a <= b); return x < a ? a : (x > b ? b : x); }
46
47//!< Test if x is in bounds a <= x < b.
48template<typename T> inline bool	inBounds	(T x, T a, T b)	{ return a <= x && x < b; }
49
50//!< Test if x is in range a <= x <= b.
51template<typename T> inline bool	inRange		(T x, T a, T b)	{ return a <= x && x <= b; }
52
53//! Helper for DE_CHECK() macros.
54void throwRuntimeError (const char* message, const char* expr, const char* file, int line);
55
56//! Default deleter.
57template<typename T> struct DefaultDeleter
58{
59	inline DefaultDeleter (void) {}
60	template<typename U> inline DefaultDeleter (const DefaultDeleter<U>&) {}
61	template<typename U> inline DefaultDeleter<T>& operator= (const DefaultDeleter<U>&) { return *this; }
62	inline void operator() (T* ptr) const { delete ptr;	}
63};
64
65//! A deleter for arrays
66template<typename T> struct ArrayDeleter
67{
68	inline ArrayDeleter (void) {}
69	template<typename U> inline ArrayDeleter (const ArrayDeleter<U>&) {}
70	template<typename U> inline ArrayDeleter<T>& operator= (const ArrayDeleter<U>&) { return *this; }
71	inline void operator() (T* ptr) const { delete[] ptr; }
72};
73
74template <typename T, bool Cond>
75struct EnableIf
76{
77};
78
79
80template <typename T>
81struct EnableIf<T, true>
82{
83	typedef T Type;
84};
85
86//! Get an element of an array with a specified size.
87template <int LastElementIndex, int Size, typename Elem>
88const Elem& getSizedArrayElement (const Elem (&array)[Size], typename de::EnableIf<int, LastElementIndex==Size>::Type offset)
89{
90	DE_ASSERT(inBounds(offset, 0, Size));
91	return array[offset];
92}
93
94//! Get an element of an array with a compile-time constant size.
95template <int Size, typename Elem>
96const Elem& getArrayElement (const Elem (&array)[Size], int offset)
97{
98	DE_ASSERT(inBounds(offset, 0, Size));
99	return array[offset];
100}
101
102} // de
103
104/*--------------------------------------------------------------------*//*!
105 * \brief Throw runtime error if condition is not met.
106 * \param X		Condition to check.
107 *
108 * This macro throws std::runtime_error if condition X is not met.
109 *//*--------------------------------------------------------------------*/
110#define DE_CHECK_RUNTIME_ERR(X)				do { if ((!deGetFalse() && (X)) ? DE_FALSE : DE_TRUE) ::de::throwRuntimeError(DE_NULL, #X, __FILE__, __LINE__); } while(deGetFalse())
111
112/*--------------------------------------------------------------------*//*!
113 * \brief Throw runtime error if condition is not met.
114 * \param X		Condition to check.
115 * \param MSG	Additional message to include in the exception.
116 *
117 * This macro throws std::runtime_error with message MSG if condition X is
118 * not met.
119 *//*--------------------------------------------------------------------*/
120#define DE_CHECK_RUNTIME_ERR_MSG(X, MSG)	do { if ((!deGetFalse() && (X)) ? DE_FALSE : DE_TRUE) ::de::throwRuntimeError(MSG, #X, __FILE__, __LINE__); } while(deGetFalse())
121
122//! Get array start pointer.
123#define DE_ARRAY_BEGIN(ARR) (&(ARR)[0])
124
125//! Get array end pointer.
126#define DE_ARRAY_END(ARR)	(DE_ARRAY_BEGIN(ARR) + DE_LENGTH_OF_ARRAY(ARR))
127
128//! Empty C++ compilation unit silencing.
129#if (DE_COMPILER == DE_COMPILER_MSC)
130#	define DE_EMPTY_CPP_FILE namespace { deUint8 unused; }
131#else
132#	define DE_EMPTY_CPP_FILE
133#endif
134
135// Warn if type is constructed, but left unused
136//
137// Used in types with non-trivial ctor/dtor but with ctor-dtor pair causing no (observable)
138// side-effects.
139//
140// \todo add attribute for GCC
141#if (DE_COMPILER == DE_COMPILER_CLANG) && defined(__has_attribute)
142#	if __has_attribute(warn_unused)
143#		define DE_WARN_UNUSED_TYPE __attribute__((warn_unused))
144#	else
145#		define DE_WARN_UNUSED_TYPE
146#	endif
147#else
148#	define DE_WARN_UNUSED_TYPE
149#endif
150
151#endif // _DEDEFS_HPP
152