2 * Copyright 2006 The Android Open Source Project
4 * Use of this source code is governed by a BSD-style license that can be
5 * found in the LICENSE file.
8 #ifndef SkTypes_DEFINED
9 #define SkTypes_DEFINED
11 #include "SkPreConfig.h"
12 #include "SkUserConfig.h"
13 #include "SkPostConfig.h"
19 /** See SkGraphics::GetVersion() to retrieve these at runtime
21 #define SKIA_VERSION_MAJOR 1
22 #define SKIA_VERSION_MINOR 0
23 #define SKIA_VERSION_PATCH 0
26 memory wrappers to be implemented by the porting layer (platform)
29 /** Called internally if we run out of memory. The platform implementation must
30 not return, but should either throw an exception or otherwise exit.
32 SK_API extern void sk_out_of_memory(void);
33 /** Called internally if we hit an unrecoverable error.
34 The platform implementation must not return, but should either throw
35 an exception or otherwise exit.
37 SK_API extern void sk_throw(void);
40 SK_MALLOC_TEMP = 0x01, //!< hint to sk_malloc that the requested memory will be freed in the scope of the stack frame
41 SK_MALLOC_THROW = 0x02 //!< instructs sk_malloc to call sk_throw if the memory cannot be allocated.
43 /** Return a block of memory (at least 4-byte aligned) of at least the
44 specified size. If the requested memory cannot be returned, either
45 return null (if SK_MALLOC_TEMP bit is clear) or throw an exception
46 (if SK_MALLOC_TEMP bit is set). To free the memory, call sk_free().
48 SK_API extern void* sk_malloc_flags(size_t size, unsigned flags);
49 /** Same as sk_malloc(), but hard coded to pass SK_MALLOC_THROW as the flag
51 SK_API extern void* sk_malloc_throw(size_t size);
52 /** Same as standard realloc(), but this one never returns null on failure. It will throw
53 an exception if it fails.
55 SK_API extern void* sk_realloc_throw(void* buffer, size_t size);
56 /** Free memory returned by sk_malloc(). It is safe to pass null.
58 SK_API extern void sk_free(void*);
60 /** Much like calloc: returns a pointer to at least size zero bytes, or NULL on failure.
62 SK_API extern void* sk_calloc(size_t size);
64 /** Same as sk_calloc, but throws an exception instead of returning NULL on failure.
66 SK_API extern void* sk_calloc_throw(size_t size);
68 // bzero is safer than memset, but we can't rely on it, so... sk_bzero()
69 static inline void sk_bzero(void* buffer, size_t size) {
70 memset(buffer, 0, size);
73 ///////////////////////////////////////////////////////////////////////////////
75 #ifdef SK_OVERRIDE_GLOBAL_NEW
78 inline void* operator new(size_t size) {
79 return sk_malloc_throw(size);
82 inline void operator delete(void* p) {
87 ///////////////////////////////////////////////////////////////////////////////
89 #define SK_INIT_TO_AVOID_WARNING = 0
92 SK_API void SkDebugf(const char format[], ...);
96 #define SkASSERT(cond) SK_ALWAYSBREAK(cond)
97 #define SkDEBUGFAIL(message) SkASSERT(false && message)
98 #define SkDEBUGCODE(code) code
99 #define SkDECLAREPARAM(type, var) , type var
100 #define SkPARAM(var) , var
101 // #define SkDEBUGF(args ) SkDebugf##args
102 #define SkDEBUGF(args ) SkDebugf args
103 #define SkAssertResult(cond) SkASSERT(cond)
105 #define SkASSERT(cond)
106 #define SkDEBUGFAIL(message)
107 #define SkDEBUGCODE(code)
108 #define SkDEBUGF(args)
109 #define SkDECLAREPARAM(type, var)
112 // unlike SkASSERT, this guy executes its condition in the non-debug build
113 #define SkAssertResult(cond) cond
116 #define SkFAIL(message) SK_ALWAYSBREAK(false && message)
118 // We want to evaluate cond only once, and inside the SkASSERT somewhere so we see its string form.
119 // So we use the comma operator to make an SkDebugf that always returns false: we'll evaluate cond,
120 // and if it's true the assert passes; if it's false, we'll print the message and the assert fails.
121 #define SkASSERTF(cond, fmt, ...) SkASSERT((cond) || (SkDebugf(fmt"\n", __VA_ARGS__), false))
124 #define SkDEVCODE(code) code
126 #define SkDEVCODE(code)
129 #ifdef SK_IGNORE_TO_STRING
130 #define SK_TO_STRING_NONVIRT()
131 #define SK_TO_STRING_VIRT()
132 #define SK_TO_STRING_PUREVIRT()
133 #define SK_TO_STRING_OVERRIDE()
135 // the 'toString' helper functions convert Sk* objects to human-readable
136 // form in developer mode
137 #define SK_TO_STRING_NONVIRT() void toString(SkString* str) const;
138 #define SK_TO_STRING_VIRT() virtual void toString(SkString* str) const;
139 #define SK_TO_STRING_PUREVIRT() virtual void toString(SkString* str) const = 0;
140 #define SK_TO_STRING_OVERRIDE() virtual void toString(SkString* str) const SK_OVERRIDE;
144 struct SkCompileAssert {
147 // Uses static_cast<bool>(expr) instead of bool(expr) due to
148 // https://connect.microsoft.com/VisualStudio/feedback/details/832915
150 // The extra parentheses in SkCompileAssert<(...)> are a work around for
151 // http://gcc.gnu.org/bugzilla/show_bug.cgi?id=57771
152 // which was fixed in gcc 4.8.2.
153 #define SK_COMPILE_ASSERT(expr, msg) \
154 typedef SkCompileAssert<(static_cast<bool>(expr))> \
155 msg[static_cast<bool>(expr) ? 1 : -1] SK_UNUSED
158 * Usage: SK_MACRO_CONCAT(a, b) to construct the symbol ab
160 * SK_MACRO_CONCAT_IMPL_PRIV just exists to make this work. Do not use directly
163 #define SK_MACRO_CONCAT(X, Y) SK_MACRO_CONCAT_IMPL_PRIV(X, Y)
164 #define SK_MACRO_CONCAT_IMPL_PRIV(X, Y) X ## Y
167 * Usage: SK_MACRO_APPEND_LINE(foo) to make foo123, where 123 is the current
168 * line number. Easy way to construct
169 * unique names for local functions or
172 #define SK_MACRO_APPEND_LINE(name) SK_MACRO_CONCAT(name, __LINE__)
175 * For some classes, it's almost always an error to instantiate one without a name, e.g.
177 * SkAutoMutexAcquire(&mutex);
180 * In this case, the writer meant to hold mutex while the rest of the code in the block runs,
181 * but instead the mutex is acquired and then immediately released. The correct usage is
183 * SkAutoMutexAcquire lock(&mutex);
187 * To prevent callers from instantiating your class without a name, use SK_REQUIRE_LOCAL_VAR
192 * #define classname(...) SK_REQUIRE_LOCAL_VAR(classname)
194 * This won't work with templates, and you must inline the class' constructors and destructors.
195 * Take a look at SkAutoFree and SkAutoMalloc in this file for examples.
197 #define SK_REQUIRE_LOCAL_VAR(classname) \
198 SK_COMPILE_ASSERT(false, missing_name_for_##classname)
200 ///////////////////////////////////////////////////////////////////////
203 * Fast type for signed 8 bits. Use for parameter passing and local variables,
209 * Fast type for unsigned 8 bits. Use for parameter passing and local
210 * variables, not for storage
212 typedef unsigned U8CPU;
215 * Fast type for signed 16 bits. Use for parameter passing and local variables,
221 * Fast type for unsigned 16 bits. Use for parameter passing and local
222 * variables, not for storage
224 typedef unsigned U16CPU;
227 * Meant to be faster than bool (doesn't promise to be 0 or 1,
233 * Meant to be a small version of bool, for storage purposes. Will be 0 or 1
235 typedef uint8_t SkBool8;
238 SK_API int8_t SkToS8(intmax_t);
239 SK_API uint8_t SkToU8(uintmax_t);
240 SK_API int16_t SkToS16(intmax_t);
241 SK_API uint16_t SkToU16(uintmax_t);
242 SK_API int32_t SkToS32(intmax_t);
243 SK_API uint32_t SkToU32(uintmax_t);
244 SK_API int SkToInt(intmax_t);
245 SK_API unsigned SkToUInt(uintmax_t);
246 SK_API size_t SkToSizeT(uintmax_t);
248 #define SkToS8(x) ((int8_t)(x))
249 #define SkToU8(x) ((uint8_t)(x))
250 #define SkToS16(x) ((int16_t)(x))
251 #define SkToU16(x) ((uint16_t)(x))
252 #define SkToS32(x) ((int32_t)(x))
253 #define SkToU32(x) ((uint32_t)(x))
254 #define SkToInt(x) ((int)(x))
255 #define SkToUInt(x) ((unsigned)(x))
256 #define SkToSizeT(x) ((size_t)(x))
259 /** Returns 0 or 1 based on the condition
261 #define SkToBool(cond) ((cond) != 0)
263 #define SK_MaxS16 32767
264 #define SK_MinS16 -32767
265 #define SK_MaxU16 0xFFFF
267 #define SK_MaxS32 0x7FFFFFFF
268 #define SK_MinS32 -SK_MaxS32
269 #define SK_MaxU32 0xFFFFFFFF
271 #define SK_NaN32 (1 << 31)
273 /** Returns true if the value can be represented with signed 16bits
275 static inline bool SkIsS16(long x) {
276 return (int16_t)x == x;
279 /** Returns true if the value can be represented with unsigned 16bits
281 static inline bool SkIsU16(long x) {
282 return (uint16_t)x == x;
285 //////////////////////////////////////////////////////////////////////////////
287 #define SK_OFFSETOF(type, field) (size_t)((char*)&(((type*)1)->field) - (char*)1)
290 /** Returns the number of entries in an array (not a pointer)
292 #define SK_ARRAY_COUNT(array) (sizeof(array) / sizeof(array[0]))
294 #define SkAlign2(x) (((x) + 1) >> 1 << 1)
295 #define SkIsAlign2(x) (0 == ((x) & 1))
297 #define SkAlign4(x) (((x) + 3) >> 2 << 2)
298 #define SkIsAlign4(x) (0 == ((x) & 3))
300 #define SkAlign8(x) (((x) + 7) >> 3 << 3)
301 #define SkIsAlign8(x) (0 == ((x) & 7))
303 typedef uint32_t SkFourByteTag;
304 #define SkSetFourByteTag(a, b, c, d) (((a) << 24) | ((b) << 16) | ((c) << 8) | (d))
306 /** 32 bit integer to hold a unicode value
308 typedef int32_t SkUnichar;
309 /** 32 bit value to hold a millisecond count
311 typedef uint32_t SkMSec;
312 /** 1 second measured in milliseconds
314 #define SK_MSec1 1000
315 /** maximum representable milliseconds
317 #define SK_MSecMax 0x7FFFFFFF
318 /** Returns a < b for milliseconds, correctly handling wrap-around from 0xFFFFFFFF to 0
320 #define SkMSec_LT(a, b) ((int32_t)(a) - (int32_t)(b) < 0)
321 /** Returns a <= b for milliseconds, correctly handling wrap-around from 0xFFFFFFFF to 0
323 #define SkMSec_LE(a, b) ((int32_t)(a) - (int32_t)(b) <= 0)
325 /** The generation IDs in Skia reserve 0 has an invalid marker.
327 #define SK_InvalidGenID 0
328 /** The unique IDs in Skia reserve 0 has an invalid marker.
330 #define SK_InvalidUniqueID 0
332 /****************************************************************************
333 The rest of these only build with C++
337 /** Faster than SkToBool for integral conditions. Returns 0 or 1
339 static inline int Sk32ToBool(uint32_t n) {
340 return (n | (0-n)) >> 31;
343 /** Generic swap function. Classes with efficient swaps should specialize this function to take
344 their fast path. This function is used by SkTSort. */
345 template <typename T> inline void SkTSwap(T& a, T& b) {
351 static inline int32_t SkAbs32(int32_t value) {
358 template <typename T> inline T SkTAbs(T value) {
365 static inline int32_t SkMax32(int32_t a, int32_t b) {
371 static inline int32_t SkMin32(int32_t a, int32_t b) {
377 template <typename T> const T& SkTMin(const T& a, const T& b) {
378 return (a < b) ? a : b;
381 template <typename T> const T& SkTMax(const T& a, const T& b) {
382 return (b < a) ? a : b;
385 static inline int32_t SkSign32(int32_t a) {
386 return (a >> 31) | ((unsigned) -a >> 31);
389 static inline int32_t SkFastMin32(int32_t value, int32_t max) {
396 /** Returns signed 32 bit value pinned between min and max, inclusively
398 static inline int32_t SkPin32(int32_t value, int32_t min, int32_t max) {
408 static inline uint32_t SkSetClearShift(uint32_t bits, bool cond,
410 SkASSERT((int)cond == 0 || (int)cond == 1);
411 return (bits & ~(1 << shift)) | ((int)cond << shift);
414 static inline uint32_t SkSetClearMask(uint32_t bits, bool cond,
416 return cond ? bits | mask : bits & ~mask;
419 ///////////////////////////////////////////////////////////////////////////////
421 /** Use to combine multiple bits in a bitmask in a type safe way.
423 template <typename T>
424 T SkTBitOr(T a, T b) {
429 * Use to cast a pointer to a different type, and maintaining strict-aliasing
431 template <typename Dst> Dst SkTCast(const void* ptr) {
440 //////////////////////////////////////////////////////////////////////////////
442 /** \class SkNoncopyable
444 SkNoncopyable is the base class for objects that may do not want to
445 be copied. It hides its copy-constructor and its assignment-operator.
447 class SK_API SkNoncopyable {
452 SkNoncopyable(const SkNoncopyable&);
453 SkNoncopyable& operator=(const SkNoncopyable&);
456 class SkAutoFree : SkNoncopyable {
458 SkAutoFree() : fPtr(NULL) {}
459 explicit SkAutoFree(void* ptr) : fPtr(ptr) {}
460 ~SkAutoFree() { sk_free(fPtr); }
462 /** Return the currently allocate buffer, or null
464 void* get() const { return fPtr; }
466 /** Assign a new ptr allocated with sk_malloc (or null), and return the
467 previous ptr. Note it is the caller's responsibility to sk_free the
470 void* set(void* ptr) {
476 /** Transfer ownership of the current ptr to the caller, setting the
477 internal reference to null. Note the caller is reponsible for calling
478 sk_free on the returned address.
480 void* detach() { return this->set(NULL); }
482 /** Free the current buffer, and set the internal reference to NULL. Same
483 as calling sk_free(detach())
493 SkAutoFree(const SkAutoFree&);
494 SkAutoFree& operator=(const SkAutoFree&);
496 #define SkAutoFree(...) SK_REQUIRE_LOCAL_VAR(SkAutoFree)
499 * Manage an allocated block of heap memory. This object is the sole manager of
500 * the lifetime of the block, so the caller must not call sk_free() or delete
501 * on the block, unless detach() was called.
503 class SkAutoMalloc : SkNoncopyable {
505 explicit SkAutoMalloc(size_t size = 0) {
506 fPtr = size ? sk_malloc_throw(size) : NULL;
515 * Passed to reset to specify what happens if the requested size is smaller
516 * than the current size (and the current block was dynamically allocated).
520 * If the requested size is smaller than the current size, and the
521 * current block is dynamically allocated, free the old block and
522 * malloc a new block of the smaller size.
527 * If the requested size is smaller than the current size, and the
528 * current block is dynamically allocated, just return the old
535 * Reallocates the block to a new size. The ptr may or may not change.
537 void* reset(size_t size, OnShrink shrink = kAlloc_OnShrink, bool* didChangeAlloc = NULL) {
538 if (size == fSize || (kReuse_OnShrink == shrink && size < fSize)) {
539 if (NULL != didChangeAlloc) {
540 *didChangeAlloc = false;
546 fPtr = size ? sk_malloc_throw(size) : NULL;
548 if (NULL != didChangeAlloc) {
549 *didChangeAlloc = true;
556 * Releases the block back to the heap
563 * Return the allocated block.
565 void* get() { return fPtr; }
566 const void* get() const { return fPtr; }
568 /** Transfer ownership of the current ptr to the caller, setting the
569 internal reference to null. Note the caller is reponsible for calling
570 sk_free on the returned address.
581 size_t fSize; // can be larger than the requested size (see kReuse)
583 #define SkAutoMalloc(...) SK_REQUIRE_LOCAL_VAR(SkAutoMalloc)
586 * Manage an allocated block of memory. If the requested size is <= kSize, then
587 * the allocation will come from the stack rather than the heap. This object
588 * is the sole manager of the lifetime of the block, so the caller must not
589 * call sk_free() or delete on the block.
591 template <size_t kSize> class SkAutoSMalloc : SkNoncopyable {
594 * Creates initially empty storage. get() returns a ptr, but it is to
595 * a zero-byte allocation. Must call reset(size) to return an allocated
604 * Allocate a block of the specified size. If size <= kSize, then the
605 * allocation will come from the stack, otherwise it will be dynamically
608 explicit SkAutoSMalloc(size_t size) {
615 * Free the allocated block (if any). If the block was small enought to
616 * have been allocated on the stack (size <= kSize) then this does nothing.
619 if (fPtr != (void*)fStorage) {
625 * Return the allocated block. May return non-null even if the block is
626 * of zero size. Since this may be on the stack or dynamically allocated,
627 * the caller must not call sk_free() on it, but must rely on SkAutoSMalloc
630 void* get() const { return fPtr; }
633 * Return a new block of the requested size, freeing (as necessary) any
634 * previously allocated block. As with the constructor, if size <= kSize
635 * then the return block may be allocated locally, rather than from the
638 void* reset(size_t size,
639 SkAutoMalloc::OnShrink shrink = SkAutoMalloc::kAlloc_OnShrink,
640 bool* didChangeAlloc = NULL) {
641 size = (size < kSize) ? kSize : size;
642 bool alloc = size != fSize && (SkAutoMalloc::kAlloc_OnShrink == shrink || size > fSize);
643 if (NULL != didChangeAlloc) {
644 *didChangeAlloc = alloc;
647 if (fPtr != (void*)fStorage) {
652 SkASSERT(fPtr != fStorage); // otherwise we lied when setting didChangeAlloc.
655 fPtr = sk_malloc_flags(size, SK_MALLOC_THROW | SK_MALLOC_TEMP);
660 SkASSERT(fSize >= size && fSize >= kSize);
661 SkASSERT((fPtr == fStorage) || fSize > kSize);
667 size_t fSize; // can be larger than the requested size (see kReuse)
668 uint32_t fStorage[(kSize + 3) >> 2];
670 // Can't guard the constructor because it's a template class.