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
32 namespace de
33 {
34
35 //! Compute absolute value of x.
abs(T x)36 template<typename T> inline T abs (T x) { return x < T(0) ? -x : x; }
37
38 //! Get minimum of x and y.
min(T x,T y)39 template<typename T> inline T min (T x, T y) { return x <= y ? x : y; }
40
41 //! Get maximum of x and y.
max(T x,T y)42 template<typename T> inline T max (T x, T y) { return x >= y ? x : y; }
43
44 //! Clamp x in range a <= x <= b.
clamp(T x,T a,T b)45 template<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.
inBounds(T x,T a,T b)48 template<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.
inRange(T x,T a,T b)51 template<typename T> inline bool inRange (T x, T a, T b) { return a <= x && x <= b; }
52
53 //! Return T with low n bits set
rightSetMask(T n)54 template<typename T> inline T rightSetMask (T n) { DE_ASSERT(n < T(sizeof(T) * 8)); T one = T(1); return T((one << n) - one); }
55
56 //! Return T with low n bits reset
rightZeroMask(T n)57 template<typename T> inline T rightZeroMask (T n) { return T(~rightSetMask(n)); }
58
59 //! Return T with high n bits set
leftSetMask(T n)60 template<typename T> inline T leftSetMask (T n) { const T tlen = T(sizeof(T) * 8); return T(~rightSetMask(tlen >= n ? tlen - n : T(0))); }
61
62 //! Return T with high n bits reset
leftZeroMask(T n)63 template<typename T> inline T leftZeroMask (T n) { return T(~leftSetMask(n)); }
64
65 //! Round x up to a multiple of y.
roundUp(T x,T y)66 template<typename T> inline T roundUp (T x, T y) { DE_ASSERT(y != T(0)); const T mod = x % y; return x + ((mod == T(0)) ? T(0) : (y - mod)); }
67
68 //! Round x down to a multiple of y.
roundDown(T x,T y)69 template<typename T> inline T roundDown (T x, T y) { DE_ASSERT(y != T(0)); return (x / y) * y; }
70
71 //! Helper for DE_CHECK() macros.
72 void throwRuntimeError (const char* message, const char* expr, const char* file, int line);
73
74 //! Default deleter.
75 template<typename T> struct DefaultDeleter
76 {
DefaultDeleterde::DefaultDeleter77 inline DefaultDeleter (void) {}
DefaultDeleterde::DefaultDeleter78 template<typename U> inline DefaultDeleter (const DefaultDeleter<U>&) {}
operator =de::DefaultDeleter79 template<typename U> inline DefaultDeleter<T>& operator= (const DefaultDeleter<U>&) { return *this; }
operator ()de::DefaultDeleter80 inline void operator() (T* ptr) const { delete ptr; }
81 };
82
83 //! A deleter for arrays
84 template<typename T> struct ArrayDeleter
85 {
ArrayDeleterde::ArrayDeleter86 inline ArrayDeleter (void) {}
ArrayDeleterde::ArrayDeleter87 template<typename U> inline ArrayDeleter (const ArrayDeleter<U>&) {}
operator =de::ArrayDeleter88 template<typename U> inline ArrayDeleter<T>& operator= (const ArrayDeleter<U>&) { return *this; }
operator ()de::ArrayDeleter89 inline void operator() (T* ptr) const { delete[] ptr; }
90 };
91
92 //! Get required memory alignment for type
93 template<typename T>
alignOf(void)94 size_t alignOf (void)
95 {
96 struct PaddingCheck { deUint8 b; T t; };
97 return (size_t)DE_OFFSET_OF(PaddingCheck, t);
98 }
99
100 } // de
101
102 /*--------------------------------------------------------------------*//*!
103 * \brief Throw runtime error if condition is not met.
104 * \param X Condition to check.
105 *
106 * This macro throws std::runtime_error if condition X is not met.
107 *//*--------------------------------------------------------------------*/
108 #define DE_CHECK_RUNTIME_ERR(X) do { if ((!deGetFalse() && (X)) ? DE_FALSE : DE_TRUE) ::de::throwRuntimeError(DE_NULL, #X, __FILE__, __LINE__); } while(deGetFalse())
109
110 /*--------------------------------------------------------------------*//*!
111 * \brief Throw runtime error if condition is not met.
112 * \param X Condition to check.
113 * \param MSG Additional message to include in the exception.
114 *
115 * This macro throws std::runtime_error with message MSG if condition X is
116 * not met.
117 *//*--------------------------------------------------------------------*/
118 #define DE_CHECK_RUNTIME_ERR_MSG(X, MSG) do { if ((!deGetFalse() && (X)) ? DE_FALSE : DE_TRUE) ::de::throwRuntimeError(MSG, #X, __FILE__, __LINE__); } while(deGetFalse())
119
120 //! Get array start pointer.
121 #define DE_ARRAY_BEGIN(ARR) (&(ARR)[0])
122
123 //! Get array end pointer.
124 #define DE_ARRAY_END(ARR) (DE_ARRAY_BEGIN(ARR) + DE_LENGTH_OF_ARRAY(ARR))
125
126 //! Empty C++ compilation unit silencing.
127 #if (DE_COMPILER == DE_COMPILER_MSC)
128 # define DE_EMPTY_CPP_FILE namespace { deUint8 unused; }
129 #else
130 # define DE_EMPTY_CPP_FILE
131 #endif
132
133 // Warn if type is constructed, but left unused
134 //
135 // Used in types with non-trivial ctor/dtor but with ctor-dtor pair causing no (observable)
136 // side-effects.
137 //
138 // \todo add attribute for GCC
139 #if (DE_COMPILER == DE_COMPILER_CLANG) && defined(__has_attribute)
140 # if __has_attribute(warn_unused)
141 # define DE_WARN_UNUSED_TYPE __attribute__((warn_unused))
142 # else
143 # define DE_WARN_UNUSED_TYPE
144 # endif
145 #else
146 # define DE_WARN_UNUSED_TYPE
147 #endif
148
149 #endif // _DEDEFS_HPP
150