blob: e264f4850f32d3506053f3215453a475084a54f4 [file] [log] [blame]
reed@android.com8a1c16f2008-12-17 15:59:43 +00001/*
epoger@google.comec3ed6a2011-07-28 14:26:00 +00002 * Copyright 2006 The Android Open Source Project
reed@android.com8a1c16f2008-12-17 15:59:43 +00003 *
epoger@google.comec3ed6a2011-07-28 14:26:00 +00004 * Use of this source code is governed by a BSD-style license that can be
5 * found in the LICENSE file.
reed@android.com8a1c16f2008-12-17 15:59:43 +00006 */
7
8#ifndef SkTypes_DEFINED
9#define SkTypes_DEFINED
10
11#include "SkPreConfig.h"
12#include "SkUserConfig.h"
13#include "SkPostConfig.h"
bungeman@google.comfab44db2013-10-11 18:50:45 +000014#include <stdint.h>
reed@android.com8a1c16f2008-12-17 15:59:43 +000015
16/** \file SkTypes.h
17*/
18
reed@android.com9aa8b322010-04-13 13:22:54 +000019/** See SkGraphics::GetVersion() to retrieve these at runtime
20 */
21#define SKIA_VERSION_MAJOR 1
22#define SKIA_VERSION_MINOR 0
23#define SKIA_VERSION_PATCH 0
24
reed@android.com8a1c16f2008-12-17 15:59:43 +000025/*
26 memory wrappers to be implemented by the porting layer (platform)
27*/
28
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.
31*/
reed@google.comde916c82011-10-19 19:50:48 +000032SK_API extern void sk_out_of_memory(void);
reed@android.com8a1c16f2008-12-17 15:59:43 +000033/** 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.
36*/
reed@google.comde916c82011-10-19 19:50:48 +000037SK_API extern void sk_throw(void);
reed@android.com8a1c16f2008-12-17 15:59:43 +000038
39enum {
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.
42};
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
mtklein@google.com519f9672013-09-20 14:31:45 +000045 return null (if SK_MALLOC_TEMP bit is clear) or throw an exception
reed@android.com8a1c16f2008-12-17 15:59:43 +000046 (if SK_MALLOC_TEMP bit is set). To free the memory, call sk_free().
47*/
ctguil@chromium.org7ffb1b22011-03-15 21:27:08 +000048SK_API extern void* sk_malloc_flags(size_t size, unsigned flags);
reed@android.com8a1c16f2008-12-17 15:59:43 +000049/** Same as sk_malloc(), but hard coded to pass SK_MALLOC_THROW as the flag
50*/
reed@google.comde916c82011-10-19 19:50:48 +000051SK_API extern void* sk_malloc_throw(size_t size);
reed@android.com8a1c16f2008-12-17 15:59:43 +000052/** Same as standard realloc(), but this one never returns null on failure. It will throw
53 an exception if it fails.
54*/
reed@google.comde916c82011-10-19 19:50:48 +000055SK_API extern void* sk_realloc_throw(void* buffer, size_t size);
reed@android.com8a1c16f2008-12-17 15:59:43 +000056/** Free memory returned by sk_malloc(). It is safe to pass null.
57*/
reed@google.comde916c82011-10-19 19:50:48 +000058SK_API extern void sk_free(void*);
reed@android.com8a1c16f2008-12-17 15:59:43 +000059
mtklein@google.com519f9672013-09-20 14:31:45 +000060/** Much like calloc: returns a pointer to at least size zero bytes, or NULL on failure.
61 */
62SK_API extern void* sk_calloc(size_t size);
63
64/** Same as sk_calloc, but throws an exception instead of returning NULL on failure.
65 */
66SK_API extern void* sk_calloc_throw(size_t size);
67
reed@android.com4516f472009-06-29 16:25:36 +000068// bzero is safer than memset, but we can't rely on it, so... sk_bzero()
69static inline void sk_bzero(void* buffer, size_t size) {
70 memset(buffer, 0, size);
71}
72
reed@google.combdf73612011-09-06 14:56:20 +000073///////////////////////////////////////////////////////////////////////////////
74
75#ifdef SK_OVERRIDE_GLOBAL_NEW
76#include <new>
77
78inline void* operator new(size_t size) {
79 return sk_malloc_throw(size);
80}
81
82inline void operator delete(void* p) {
83 sk_free(p);
84}
85#endif
86
87///////////////////////////////////////////////////////////////////////////////
reed@android.com8a1c16f2008-12-17 15:59:43 +000088
89#define SK_INIT_TO_AVOID_WARNING = 0
90
91#ifndef SkDebugf
92 void SkDebugf(const char format[], ...);
93#endif
94
95#ifdef SK_DEBUG
commit-bot@chromium.org45d1d1d2014-04-30 18:24:16 +000096 #define SkASSERT(cond) SK_ALWAYSBREAK(cond)
tomhudson@google.com0c00f212011-12-28 14:59:50 +000097 #define SkDEBUGFAIL(message) SkASSERT(false && message)
reed@android.com8a1c16f2008-12-17 15:59:43 +000098 #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)
104#else
105 #define SkASSERT(cond)
tomhudson@google.com0c00f212011-12-28 14:59:50 +0000106 #define SkDEBUGFAIL(message)
reed@android.com8a1c16f2008-12-17 15:59:43 +0000107 #define SkDEBUGCODE(code)
108 #define SkDEBUGF(args)
109 #define SkDECLAREPARAM(type, var)
110 #define SkPARAM(var)
111
112 // unlike SkASSERT, this guy executes its condition in the non-debug build
113 #define SkAssertResult(cond) cond
114#endif
115
commit-bot@chromium.org45d1d1d2014-04-30 18:24:16 +0000116#define SkFAIL(message) SK_ALWAYSBREAK(false && message)
commit-bot@chromium.org88cb22b2014-04-30 14:17:00 +0000117
mtkleinb59161f2014-06-18 07:54:47 -0700118// 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))
122
robertphillips@google.com76f9e932013-01-15 20:17:47 +0000123#ifdef SK_DEVELOPER
124 #define SkDEVCODE(code) code
robertphillips@google.com76f9e932013-01-15 20:17:47 +0000125#else
126 #define SkDEVCODE(code)
commit-bot@chromium.org0f10f7b2014-03-13 18:02:17 +0000127#endif
128
129#ifdef SK_IGNORE_TO_STRING
skia.committer@gmail.combc3d92a2014-03-14 03:02:26 +0000130 #define SK_TO_STRING_NONVIRT()
131 #define SK_TO_STRING_VIRT()
commit-bot@chromium.org0f10f7b2014-03-13 18:02:17 +0000132 #define SK_TO_STRING_PUREVIRT()
133 #define SK_TO_STRING_OVERRIDE()
134#else
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;
robertphillips@google.com76f9e932013-01-15 20:17:47 +0000141#endif
142
vandebo@chromium.org28be72b2010-11-11 21:37:00 +0000143template <bool>
144struct SkCompileAssert {
145};
146
bungeman@google.com562b2e62014-03-12 21:41:06 +0000147// Uses static_cast<bool>(expr) instead of bool(expr) due to
148// https://connect.microsoft.com/VisualStudio/feedback/details/832915
bungeman@google.com9c28fa52014-03-13 17:51:05 +0000149
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.
vandebo@chromium.org28be72b2010-11-11 21:37:00 +0000153#define SK_COMPILE_ASSERT(expr, msg) \
bungeman@google.com2f582092014-03-12 21:56:23 +0000154 typedef SkCompileAssert<(static_cast<bool>(expr))> \
bungeman@google.com562b2e62014-03-12 21:41:06 +0000155 msg[static_cast<bool>(expr) ? 1 : -1] SK_UNUSED
vandebo@chromium.org28be72b2010-11-11 21:37:00 +0000156
reed@google.com49a5b192012-10-25 17:31:39 +0000157/*
158 * Usage: SK_MACRO_CONCAT(a, b) to construct the symbol ab
159 *
160 * SK_MACRO_CONCAT_IMPL_PRIV just exists to make this work. Do not use directly
161 *
162 */
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
165
166/*
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
170 * variables.
171 */
172#define SK_MACRO_APPEND_LINE(name) SK_MACRO_CONCAT(name, __LINE__)
173
commit-bot@chromium.orge61a86c2013-11-18 16:03:59 +0000174/**
175 * For some classes, it's almost always an error to instantiate one without a name, e.g.
176 * {
177 * SkAutoMutexAcquire(&mutex);
178 * <some code>
179 * }
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
182 * {
183 * SkAutoMutexAcquire lock(&mutex);
184 * <some code>
185 * }
186 *
187 * To prevent callers from instantiating your class without a name, use SK_REQUIRE_LOCAL_VAR
188 * like this:
189 * class classname {
190 * <your class>
191 * };
192 * #define classname(...) SK_REQUIRE_LOCAL_VAR(classname)
193 *
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.
196 */
197#define SK_REQUIRE_LOCAL_VAR(classname) \
198 SK_COMPILE_ASSERT(false, missing_name_for_##classname)
199
reed@android.com8a1c16f2008-12-17 15:59:43 +0000200///////////////////////////////////////////////////////////////////////
201
reed@google.com37a31332011-01-25 14:55:42 +0000202/**
203 * Fast type for signed 8 bits. Use for parameter passing and local variables,
204 * not for storage.
205 */
206typedef int S8CPU;
reed@android.com8a1c16f2008-12-17 15:59:43 +0000207
reed@google.com37a31332011-01-25 14:55:42 +0000208/**
209 * Fast type for unsigned 8 bits. Use for parameter passing and local
210 * variables, not for storage
211 */
212typedef unsigned U8CPU;
213
214/**
215 * Fast type for signed 16 bits. Use for parameter passing and local variables,
216 * not for storage
217 */
218typedef int S16CPU;
219
220/**
221 * Fast type for unsigned 16 bits. Use for parameter passing and local
222 * variables, not for storage
223 */
224typedef unsigned U16CPU;
225
226/**
227 * Meant to be faster than bool (doesn't promise to be 0 or 1,
228 * just 0 or non-zero
229 */
230typedef int SkBool;
231
232/**
233 * Meant to be a small version of bool, for storage purposes. Will be 0 or 1
234 */
235typedef uint8_t SkBool8;
reed@android.com8a1c16f2008-12-17 15:59:43 +0000236
237#ifdef SK_DEBUG
bungeman@google.com777ded02013-07-19 22:30:11 +0000238 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);
commit-bot@chromium.orga8c7f772014-01-24 21:46:29 +0000244 SK_API int SkToInt(intmax_t);
reed@google.com7fa2a652014-01-27 13:42:58 +0000245 SK_API unsigned SkToUInt(uintmax_t);
commit-bot@chromium.org490fb6b2014-03-06 17:16:26 +0000246 SK_API size_t SkToSizeT(uintmax_t);
reed@android.com8a1c16f2008-12-17 15:59:43 +0000247#else
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))
commit-bot@chromium.orga8c7f772014-01-24 21:46:29 +0000254 #define SkToInt(x) ((int)(x))
reed@google.com7fa2a652014-01-27 13:42:58 +0000255 #define SkToUInt(x) ((unsigned)(x))
commit-bot@chromium.org490fb6b2014-03-06 17:16:26 +0000256 #define SkToSizeT(x) ((size_t)(x))
reed@android.com8a1c16f2008-12-17 15:59:43 +0000257#endif
258
259/** Returns 0 or 1 based on the condition
260*/
261#define SkToBool(cond) ((cond) != 0)
262
263#define SK_MaxS16 32767
264#define SK_MinS16 -32767
265#define SK_MaxU16 0xFFFF
266#define SK_MinU16 0
267#define SK_MaxS32 0x7FFFFFFF
caryclark@google.com594dd3c2012-09-24 19:33:57 +0000268#define SK_MinS32 -SK_MaxS32
reed@android.com8a1c16f2008-12-17 15:59:43 +0000269#define SK_MaxU32 0xFFFFFFFF
270#define SK_MinU32 0
humper@google.com0e515772013-01-07 19:54:40 +0000271#define SK_NaN32 (1 << 31)
reed@android.com8a1c16f2008-12-17 15:59:43 +0000272
reed@android.comd4577752009-11-21 02:48:11 +0000273/** Returns true if the value can be represented with signed 16bits
274 */
reed@android.com90209ca2009-11-21 19:58:04 +0000275static inline bool SkIsS16(long x) {
reed@android.comd4577752009-11-21 02:48:11 +0000276 return (int16_t)x == x;
277}
278
279/** Returns true if the value can be represented with unsigned 16bits
280 */
reed@android.com90209ca2009-11-21 19:58:04 +0000281static inline bool SkIsU16(long x) {
reed@android.comd4577752009-11-21 02:48:11 +0000282 return (uint16_t)x == x;
283}
284
285//////////////////////////////////////////////////////////////////////////////
reed@android.com8a1c16f2008-12-17 15:59:43 +0000286#ifndef SK_OFFSETOF
reed@google.com56d3a232012-03-21 12:25:48 +0000287 #define SK_OFFSETOF(type, field) (size_t)((char*)&(((type*)1)->field) - (char*)1)
reed@android.com8a1c16f2008-12-17 15:59:43 +0000288#endif
289
290/** Returns the number of entries in an array (not a pointer)
291*/
292#define SK_ARRAY_COUNT(array) (sizeof(array) / sizeof(array[0]))
293
reed@android.com8a1c16f2008-12-17 15:59:43 +0000294#define SkAlign2(x) (((x) + 1) >> 1 << 1)
reed@google.comc6faa5a2012-06-27 15:07:11 +0000295#define SkIsAlign2(x) (0 == ((x) & 1))
reed@android.com8a1c16f2008-12-17 15:59:43 +0000296
reed@google.comc6faa5a2012-06-27 15:07:11 +0000297#define SkAlign4(x) (((x) + 3) >> 2 << 2)
298#define SkIsAlign4(x) (0 == ((x) & 3))
299
300#define SkAlign8(x) (((x) + 7) >> 3 << 3)
301#define SkIsAlign8(x) (0 == ((x) & 7))
tomhudson@google.com01224d52011-11-28 18:22:01 +0000302
reed@android.com8a1c16f2008-12-17 15:59:43 +0000303typedef uint32_t SkFourByteTag;
304#define SkSetFourByteTag(a, b, c, d) (((a) << 24) | ((b) << 16) | ((c) << 8) | (d))
305
306/** 32 bit integer to hold a unicode value
307*/
308typedef int32_t SkUnichar;
309/** 32 bit value to hold a millisecond count
310*/
311typedef uint32_t SkMSec;
312/** 1 second measured in milliseconds
313*/
314#define SK_MSec1 1000
315/** maximum representable milliseconds
316*/
317#define SK_MSecMax 0x7FFFFFFF
318/** Returns a < b for milliseconds, correctly handling wrap-around from 0xFFFFFFFF to 0
319*/
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
322*/
323#define SkMSec_LE(a, b) ((int32_t)(a) - (int32_t)(b) <= 0)
324
commit-bot@chromium.org2b4e3702014-04-07 18:26:22 +0000325/** The generation IDs in Skia reserve 0 has an invalid marker.
326 */
327#define SK_InvalidGenID 0
bsalomon1c63bf62014-07-22 13:09:46 -0700328/** The unique IDs in Skia reserve 0 has an invalid marker.
329 */
330#define SK_InvalidUniqueID 0
commit-bot@chromium.org2b4e3702014-04-07 18:26:22 +0000331
reed@android.com8a1c16f2008-12-17 15:59:43 +0000332/****************************************************************************
333 The rest of these only build with C++
334*/
335#ifdef __cplusplus
336
337/** Faster than SkToBool for integral conditions. Returns 0 or 1
338*/
reed@android.comd4577752009-11-21 02:48:11 +0000339static inline int Sk32ToBool(uint32_t n) {
reed@android.com8a1c16f2008-12-17 15:59:43 +0000340 return (n | (0-n)) >> 31;
341}
342
bsalomon@google.comff436612013-02-27 19:07:32 +0000343/** Generic swap function. Classes with efficient swaps should specialize this function to take
344 their fast path. This function is used by SkTSort. */
reed@android.comd4577752009-11-21 02:48:11 +0000345template <typename T> inline void SkTSwap(T& a, T& b) {
reed@android.com8a1c16f2008-12-17 15:59:43 +0000346 T c(a);
347 a = b;
348 b = c;
349}
350
reed@android.comd4577752009-11-21 02:48:11 +0000351static inline int32_t SkAbs32(int32_t value) {
commit-bot@chromium.org38bad322013-07-30 13:16:29 +0000352 if (value < 0) {
reed@android.com8a1c16f2008-12-17 15:59:43 +0000353 value = -value;
commit-bot@chromium.org38bad322013-07-30 13:16:29 +0000354 }
reed@android.com8a1c16f2008-12-17 15:59:43 +0000355 return value;
reed@android.com8a1c16f2008-12-17 15:59:43 +0000356}
357
reed@google.com2b57dc62013-01-08 13:23:32 +0000358template <typename T> inline T SkTAbs(T value) {
359 if (value < 0) {
360 value = -value;
361 }
362 return value;
363}
364
reed@android.comd4577752009-11-21 02:48:11 +0000365static inline int32_t SkMax32(int32_t a, int32_t b) {
reed@android.com8a1c16f2008-12-17 15:59:43 +0000366 if (a < b)
367 a = b;
368 return a;
369}
370
reed@android.comd4577752009-11-21 02:48:11 +0000371static inline int32_t SkMin32(int32_t a, int32_t b) {
reed@android.com8a1c16f2008-12-17 15:59:43 +0000372 if (a > b)
373 a = b;
374 return a;
375}
376
caryclark@google.com3b97af52013-04-23 11:56:44 +0000377template <typename T> const T& SkTMin(const T& a, const T& b) {
378 return (a < b) ? a : b;
379}
380
381template <typename T> const T& SkTMax(const T& a, const T& b) {
382 return (b < a) ? a : b;
383}
384
reed@android.comd4577752009-11-21 02:48:11 +0000385static inline int32_t SkSign32(int32_t a) {
reed@android.com8a1c16f2008-12-17 15:59:43 +0000386 return (a >> 31) | ((unsigned) -a >> 31);
387}
388
reed@android.comd4577752009-11-21 02:48:11 +0000389static inline int32_t SkFastMin32(int32_t value, int32_t max) {
commit-bot@chromium.org38bad322013-07-30 13:16:29 +0000390 if (value > max) {
reed@android.com8a1c16f2008-12-17 15:59:43 +0000391 value = max;
commit-bot@chromium.org38bad322013-07-30 13:16:29 +0000392 }
reed@android.com8a1c16f2008-12-17 15:59:43 +0000393 return value;
reed@android.com8a1c16f2008-12-17 15:59:43 +0000394}
395
396/** Returns signed 32 bit value pinned between min and max, inclusively
397*/
reed@android.comd4577752009-11-21 02:48:11 +0000398static inline int32_t SkPin32(int32_t value, int32_t min, int32_t max) {
commit-bot@chromium.org38bad322013-07-30 13:16:29 +0000399 if (value < min) {
reed@android.com8a1c16f2008-12-17 15:59:43 +0000400 value = min;
commit-bot@chromium.org38bad322013-07-30 13:16:29 +0000401 }
402 if (value > max) {
reed@android.com8a1c16f2008-12-17 15:59:43 +0000403 value = max;
commit-bot@chromium.org38bad322013-07-30 13:16:29 +0000404 }
reed@android.com8a1c16f2008-12-17 15:59:43 +0000405 return value;
406}
407
reed@android.comd4577752009-11-21 02:48:11 +0000408static inline uint32_t SkSetClearShift(uint32_t bits, bool cond,
409 unsigned shift) {
reed@android.com8a1c16f2008-12-17 15:59:43 +0000410 SkASSERT((int)cond == 0 || (int)cond == 1);
411 return (bits & ~(1 << shift)) | ((int)cond << shift);
412}
413
reed@android.comd4577752009-11-21 02:48:11 +0000414static inline uint32_t SkSetClearMask(uint32_t bits, bool cond,
415 uint32_t mask) {
reed@android.com8a1c16f2008-12-17 15:59:43 +0000416 return cond ? bits | mask : bits & ~mask;
417}
418
reed@google.com1fcd51e2011-01-05 15:50:27 +0000419///////////////////////////////////////////////////////////////////////////////
420
vandebo@chromium.org325cb9a2011-03-30 18:36:29 +0000421/** Use to combine multiple bits in a bitmask in a type safe way.
422 */
423template <typename T>
424T SkTBitOr(T a, T b) {
425 return (T)(a | b);
426}
427
reed@google.com1fcd51e2011-01-05 15:50:27 +0000428/**
429 * Use to cast a pointer to a different type, and maintaining strict-aliasing
430 */
431template <typename Dst> Dst SkTCast(const void* ptr) {
432 union {
433 const void* src;
434 Dst dst;
435 } data;
436 data.src = ptr;
437 return data.dst;
438}
439
reed@android.com8a1c16f2008-12-17 15:59:43 +0000440//////////////////////////////////////////////////////////////////////////////
441
442/** \class SkNoncopyable
443
444SkNoncopyable is the base class for objects that may do not want to
445be copied. It hides its copy-constructor and its assignment-operator.
446*/
ctguil@chromium.org7ffb1b22011-03-15 21:27:08 +0000447class SK_API SkNoncopyable {
reed@android.com8a1c16f2008-12-17 15:59:43 +0000448public:
449 SkNoncopyable() {}
reed@google.com1fcd51e2011-01-05 15:50:27 +0000450
reed@android.com8a1c16f2008-12-17 15:59:43 +0000451private:
452 SkNoncopyable(const SkNoncopyable&);
453 SkNoncopyable& operator=(const SkNoncopyable&);
454};
455
456class SkAutoFree : SkNoncopyable {
457public:
458 SkAutoFree() : fPtr(NULL) {}
459 explicit SkAutoFree(void* ptr) : fPtr(ptr) {}
460 ~SkAutoFree() { sk_free(fPtr); }
reed@google.com1fcd51e2011-01-05 15:50:27 +0000461
reed@android.com8a1c16f2008-12-17 15:59:43 +0000462 /** Return the currently allocate buffer, or null
463 */
464 void* get() const { return fPtr; }
465
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
468 returned ptr.
469 */
470 void* set(void* ptr) {
471 void* prev = fPtr;
472 fPtr = ptr;
473 return prev;
474 }
reed@google.com1fcd51e2011-01-05 15:50:27 +0000475
reed@android.com8a1c16f2008-12-17 15:59:43 +0000476 /** 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.
479 */
480 void* detach() { return this->set(NULL); }
481
482 /** Free the current buffer, and set the internal reference to NULL. Same
483 as calling sk_free(detach())
484 */
485 void free() {
486 sk_free(fPtr);
487 fPtr = NULL;
488 }
489
490private:
491 void* fPtr;
492 // illegal
493 SkAutoFree(const SkAutoFree&);
494 SkAutoFree& operator=(const SkAutoFree&);
495};
commit-bot@chromium.orge61a86c2013-11-18 16:03:59 +0000496#define SkAutoFree(...) SK_REQUIRE_LOCAL_VAR(SkAutoFree)
reed@android.com8a1c16f2008-12-17 15:59:43 +0000497
bsalomon@google.com7d4679a2011-09-02 22:06:24 +0000498/**
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
reed@google.com1c401d82011-10-18 18:52:03 +0000501 * on the block, unless detach() was called.
bsalomon@google.com7d4679a2011-09-02 22:06:24 +0000502 */
commit-bot@chromium.orge3beb6b2014-04-07 19:34:38 +0000503class SkAutoMalloc : SkNoncopyable {
reed@android.com8a1c16f2008-12-17 15:59:43 +0000504public:
reed@google.com3ab41952011-10-18 18:32:46 +0000505 explicit SkAutoMalloc(size_t size = 0) {
506 fPtr = size ? sk_malloc_throw(size) : NULL;
bsalomon@google.com7d4679a2011-09-02 22:06:24 +0000507 fSize = size;
reed@android.com8a1c16f2008-12-17 15:59:43 +0000508 }
bsalomon@google.com7d4679a2011-09-02 22:06:24 +0000509
510 ~SkAutoMalloc() {
511 sk_free(fPtr);
512 }
513
514 /**
reed@google.com1c401d82011-10-18 18:52:03 +0000515 * 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).
517 */
518 enum OnShrink {
519 /**
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.
523 */
524 kAlloc_OnShrink,
rmistry@google.comfbfcd562012-08-23 18:09:54 +0000525
reed@google.com1c401d82011-10-18 18:52:03 +0000526 /**
527 * If the requested size is smaller than the current size, and the
528 * current block is dynamically allocated, just return the old
529 * block.
530 */
tomhudson@google.com1f902872012-06-01 13:15:47 +0000531 kReuse_OnShrink
reed@google.com1c401d82011-10-18 18:52:03 +0000532 };
533
534 /**
bsalomon@google.com7d4679a2011-09-02 22:06:24 +0000535 * Reallocates the block to a new size. The ptr may or may not change.
536 */
bsalomon@google.com9eb66452013-05-22 13:35:37 +0000537 void* reset(size_t size, OnShrink shrink = kAlloc_OnShrink, bool* didChangeAlloc = NULL) {
reed@google.com1c401d82011-10-18 18:52:03 +0000538 if (size == fSize || (kReuse_OnShrink == shrink && size < fSize)) {
bsalomon@google.com9eb66452013-05-22 13:35:37 +0000539 if (NULL != didChangeAlloc) {
540 *didChangeAlloc = false;
541 }
reed@google.com1c401d82011-10-18 18:52:03 +0000542 return fPtr;
bsalomon@google.com7d4679a2011-09-02 22:06:24 +0000543 }
reed@google.com1c401d82011-10-18 18:52:03 +0000544
545 sk_free(fPtr);
546 fPtr = size ? sk_malloc_throw(size) : NULL;
547 fSize = size;
bsalomon@google.com9eb66452013-05-22 13:35:37 +0000548 if (NULL != didChangeAlloc) {
549 *didChangeAlloc = true;
550 }
reed@google.com1c401d82011-10-18 18:52:03 +0000551
bsalomon@google.com7d4679a2011-09-02 22:06:24 +0000552 return fPtr;
553 }
554
555 /**
556 * Releases the block back to the heap
557 */
558 void free() {
559 this->reset(0);
560 }
561
562 /**
563 * Return the allocated block.
564 */
565 void* get() { return fPtr; }
566 const void* get() const { return fPtr; }
567
bsalomon@google.com6dcd27c2011-09-06 15:02:33 +0000568 /** 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.
571 */
572 void* detach() {
573 void* ptr = fPtr;
574 fPtr = NULL;
575 fSize = 0;
576 return ptr;
577 }
578
bsalomon@google.com7d4679a2011-09-02 22:06:24 +0000579private:
580 void* fPtr;
reed@google.com1c401d82011-10-18 18:52:03 +0000581 size_t fSize; // can be larger than the requested size (see kReuse)
reed@android.com8a1c16f2008-12-17 15:59:43 +0000582};
commit-bot@chromium.orge61a86c2013-11-18 16:03:59 +0000583#define SkAutoMalloc(...) SK_REQUIRE_LOCAL_VAR(SkAutoMalloc)
reed@android.com8a1c16f2008-12-17 15:59:43 +0000584
reed@google.com63a60602011-03-10 13:07:35 +0000585/**
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.
590 */
reed@android.com8a1c16f2008-12-17 15:59:43 +0000591template <size_t kSize> class SkAutoSMalloc : SkNoncopyable {
592public:
reed@google.com63a60602011-03-10 13:07:35 +0000593 /**
594 * Creates initially empty storage. get() returns a ptr, but it is to
bsalomon@google.com7d4679a2011-09-02 22:06:24 +0000595 * a zero-byte allocation. Must call reset(size) to return an allocated
reed@google.com63a60602011-03-10 13:07:35 +0000596 * block.
597 */
598 SkAutoSMalloc() {
599 fPtr = fStorage;
bsalomon@google.com9eb66452013-05-22 13:35:37 +0000600 fSize = kSize;
reed@android.com8a1c16f2008-12-17 15:59:43 +0000601 }
reed@google.com63a60602011-03-10 13:07:35 +0000602
603 /**
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
606 * allocated.
607 */
608 explicit SkAutoSMalloc(size_t size) {
609 fPtr = fStorage;
bsalomon@google.com9eb66452013-05-22 13:35:37 +0000610 fSize = kSize;
bsalomon@google.com7d4679a2011-09-02 22:06:24 +0000611 this->reset(size);
reed@google.com63a60602011-03-10 13:07:35 +0000612 }
613
614 /**
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.
617 */
618 ~SkAutoSMalloc() {
619 if (fPtr != (void*)fStorage) {
reed@android.com8a1c16f2008-12-17 15:59:43 +0000620 sk_free(fPtr);
reed@google.com63a60602011-03-10 13:07:35 +0000621 }
reed@android.com8a1c16f2008-12-17 15:59:43 +0000622 }
reed@google.com63a60602011-03-10 13:07:35 +0000623
624 /**
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
628 * to manage it.
629 */
reed@android.com8a1c16f2008-12-17 15:59:43 +0000630 void* get() const { return fPtr; }
reed@google.com63a60602011-03-10 13:07:35 +0000631
632 /**
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
636 * heap.
637 */
reed@google.com1c401d82011-10-18 18:52:03 +0000638 void* reset(size_t size,
bsalomon@google.com9eb66452013-05-22 13:35:37 +0000639 SkAutoMalloc::OnShrink shrink = SkAutoMalloc::kAlloc_OnShrink,
640 bool* didChangeAlloc = NULL) {
641 size = (size < kSize) ? kSize : size;
robertphillips@google.com0f2b1952013-05-23 14:59:40 +0000642 bool alloc = size != fSize && (SkAutoMalloc::kAlloc_OnShrink == shrink || size > fSize);
bsalomon@google.com9eb66452013-05-22 13:35:37 +0000643 if (NULL != didChangeAlloc) {
644 *didChangeAlloc = alloc;
reed@google.com1c401d82011-10-18 18:52:03 +0000645 }
bsalomon@google.com9eb66452013-05-22 13:35:37 +0000646 if (alloc) {
647 if (fPtr != (void*)fStorage) {
648 sk_free(fPtr);
649 }
reed@google.com1c401d82011-10-18 18:52:03 +0000650
bsalomon@google.com9eb66452013-05-22 13:35:37 +0000651 if (size == kSize) {
652 SkASSERT(fPtr != fStorage); // otherwise we lied when setting didChangeAlloc.
653 fPtr = fStorage;
654 } else {
655 fPtr = sk_malloc_flags(size, SK_MALLOC_THROW | SK_MALLOC_TEMP);
656 }
reed@google.com63a60602011-03-10 13:07:35 +0000657
bsalomon@google.com9eb66452013-05-22 13:35:37 +0000658 fSize = size;
reed@google.com63a60602011-03-10 13:07:35 +0000659 }
bsalomon@google.com9eb66452013-05-22 13:35:37 +0000660 SkASSERT(fSize >= size && fSize >= kSize);
661 SkASSERT((fPtr == fStorage) || fSize > kSize);
reed@google.com63a60602011-03-10 13:07:35 +0000662 return fPtr;
663 }
664
reed@android.com8a1c16f2008-12-17 15:59:43 +0000665private:
666 void* fPtr;
reed@google.com1c401d82011-10-18 18:52:03 +0000667 size_t fSize; // can be larger than the requested size (see kReuse)
reed@android.com8a1c16f2008-12-17 15:59:43 +0000668 uint32_t fStorage[(kSize + 3) >> 2];
reed@android.com8a1c16f2008-12-17 15:59:43 +0000669};
commit-bot@chromium.orge61a86c2013-11-18 16:03:59 +0000670// Can't guard the constructor because it's a template class.
reed@android.com8a1c16f2008-12-17 15:59:43 +0000671
672#endif /* C++ */
673
674#endif