SkTypes.h revision 519f9677a41239808f41a7c13ef1f6e05eb1ed50
1ec3ed6a5ebf6f2c406d7bcf94b6bc34fcaeb976eepoger@google.com 28a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com/* 3ec3ed6a5ebf6f2c406d7bcf94b6bc34fcaeb976eepoger@google.com * Copyright 2006 The Android Open Source Project 48a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com * 5ec3ed6a5ebf6f2c406d7bcf94b6bc34fcaeb976eepoger@google.com * Use of this source code is governed by a BSD-style license that can be 6ec3ed6a5ebf6f2c406d7bcf94b6bc34fcaeb976eepoger@google.com * found in the LICENSE file. 78a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 88a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 9ec3ed6a5ebf6f2c406d7bcf94b6bc34fcaeb976eepoger@google.com 108a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#ifndef SkTypes_DEFINED 118a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#define SkTypes_DEFINED 128a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 138a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#include "SkPreConfig.h" 148a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#include "SkUserConfig.h" 158a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#include "SkPostConfig.h" 168a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 178a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#ifndef SK_IGNORE_STDINT_DOT_H 188a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com #include <stdint.h> 198a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#endif 208a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 218a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#include <stdio.h> 228a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 238a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com/** \file SkTypes.h 248a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com*/ 258a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 269aa8b32233702b19b97bebdc2c702e0c53407d45reed@android.com/** See SkGraphics::GetVersion() to retrieve these at runtime 279aa8b32233702b19b97bebdc2c702e0c53407d45reed@android.com */ 289aa8b32233702b19b97bebdc2c702e0c53407d45reed@android.com#define SKIA_VERSION_MAJOR 1 299aa8b32233702b19b97bebdc2c702e0c53407d45reed@android.com#define SKIA_VERSION_MINOR 0 309aa8b32233702b19b97bebdc2c702e0c53407d45reed@android.com#define SKIA_VERSION_PATCH 0 319aa8b32233702b19b97bebdc2c702e0c53407d45reed@android.com 328a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com/* 338a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com memory wrappers to be implemented by the porting layer (platform) 348a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com*/ 358a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 368a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com/** Called internally if we run out of memory. The platform implementation must 378a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com not return, but should either throw an exception or otherwise exit. 388a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com*/ 39de916c8ac866378cee9af2bf161c79f528d9ccd5reed@google.comSK_API extern void sk_out_of_memory(void); 408a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com/** Called internally if we hit an unrecoverable error. 418a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com The platform implementation must not return, but should either throw 428a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com an exception or otherwise exit. 438a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com*/ 44de916c8ac866378cee9af2bf161c79f528d9ccd5reed@google.comSK_API extern void sk_throw(void); 458a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 468a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.comenum { 478a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SK_MALLOC_TEMP = 0x01, //!< hint to sk_malloc that the requested memory will be freed in the scope of the stack frame 488a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SK_MALLOC_THROW = 0x02 //!< instructs sk_malloc to call sk_throw if the memory cannot be allocated. 498a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com}; 508a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com/** Return a block of memory (at least 4-byte aligned) of at least the 518a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com specified size. If the requested memory cannot be returned, either 52519f9677a41239808f41a7c13ef1f6e05eb1ed50mtklein@google.com return null (if SK_MALLOC_TEMP bit is clear) or throw an exception 538a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com (if SK_MALLOC_TEMP bit is set). To free the memory, call sk_free(). 548a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com*/ 557ffb1b21abcc7bbed5a0fc711f6dd7b9dbb4f577ctguil@chromium.orgSK_API extern void* sk_malloc_flags(size_t size, unsigned flags); 568a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com/** Same as sk_malloc(), but hard coded to pass SK_MALLOC_THROW as the flag 578a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com*/ 58de916c8ac866378cee9af2bf161c79f528d9ccd5reed@google.comSK_API extern void* sk_malloc_throw(size_t size); 598a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com/** Same as standard realloc(), but this one never returns null on failure. It will throw 608a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com an exception if it fails. 618a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com*/ 62de916c8ac866378cee9af2bf161c79f528d9ccd5reed@google.comSK_API extern void* sk_realloc_throw(void* buffer, size_t size); 638a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com/** Free memory returned by sk_malloc(). It is safe to pass null. 648a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com*/ 65de916c8ac866378cee9af2bf161c79f528d9ccd5reed@google.comSK_API extern void sk_free(void*); 668a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 67519f9677a41239808f41a7c13ef1f6e05eb1ed50mtklein@google.com/** Much like calloc: returns a pointer to at least size zero bytes, or NULL on failure. 68519f9677a41239808f41a7c13ef1f6e05eb1ed50mtklein@google.com */ 69519f9677a41239808f41a7c13ef1f6e05eb1ed50mtklein@google.comSK_API extern void* sk_calloc(size_t size); 70519f9677a41239808f41a7c13ef1f6e05eb1ed50mtklein@google.com 71519f9677a41239808f41a7c13ef1f6e05eb1ed50mtklein@google.com/** Same as sk_calloc, but throws an exception instead of returning NULL on failure. 72519f9677a41239808f41a7c13ef1f6e05eb1ed50mtklein@google.com */ 73519f9677a41239808f41a7c13ef1f6e05eb1ed50mtklein@google.comSK_API extern void* sk_calloc_throw(size_t size); 74519f9677a41239808f41a7c13ef1f6e05eb1ed50mtklein@google.com 754516f4786f5dda1b86a8f825b9e8e910d9c2363creed@android.com// bzero is safer than memset, but we can't rely on it, so... sk_bzero() 764516f4786f5dda1b86a8f825b9e8e910d9c2363creed@android.comstatic inline void sk_bzero(void* buffer, size_t size) { 774516f4786f5dda1b86a8f825b9e8e910d9c2363creed@android.com memset(buffer, 0, size); 784516f4786f5dda1b86a8f825b9e8e910d9c2363creed@android.com} 794516f4786f5dda1b86a8f825b9e8e910d9c2363creed@android.com 80bdf736133b513bb13f7c66e01c8c37ac526ce8d4reed@google.com/////////////////////////////////////////////////////////////////////////////// 81bdf736133b513bb13f7c66e01c8c37ac526ce8d4reed@google.com 82bdf736133b513bb13f7c66e01c8c37ac526ce8d4reed@google.com#ifdef SK_OVERRIDE_GLOBAL_NEW 83bdf736133b513bb13f7c66e01c8c37ac526ce8d4reed@google.com#include <new> 84bdf736133b513bb13f7c66e01c8c37ac526ce8d4reed@google.com 85bdf736133b513bb13f7c66e01c8c37ac526ce8d4reed@google.cominline void* operator new(size_t size) { 86bdf736133b513bb13f7c66e01c8c37ac526ce8d4reed@google.com return sk_malloc_throw(size); 87bdf736133b513bb13f7c66e01c8c37ac526ce8d4reed@google.com} 88bdf736133b513bb13f7c66e01c8c37ac526ce8d4reed@google.com 89bdf736133b513bb13f7c66e01c8c37ac526ce8d4reed@google.cominline void operator delete(void* p) { 90bdf736133b513bb13f7c66e01c8c37ac526ce8d4reed@google.com sk_free(p); 91bdf736133b513bb13f7c66e01c8c37ac526ce8d4reed@google.com} 92bdf736133b513bb13f7c66e01c8c37ac526ce8d4reed@google.com#endif 93bdf736133b513bb13f7c66e01c8c37ac526ce8d4reed@google.com 94bdf736133b513bb13f7c66e01c8c37ac526ce8d4reed@google.com/////////////////////////////////////////////////////////////////////////////// 958a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 968a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#define SK_INIT_TO_AVOID_WARNING = 0 978a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 988a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#ifndef SkDebugf 998a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com void SkDebugf(const char format[], ...); 1008a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#endif 1018a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 1028a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#ifdef SK_DEBUG 1038a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com #define SkASSERT(cond) SK_DEBUGBREAK(cond) 1040c00f21fee3f5cfa3aa7e5d46ff94cb8cf340451tomhudson@google.com #define SkDEBUGFAIL(message) SkASSERT(false && message) 1058a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com #define SkDEBUGCODE(code) code 1068a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com #define SkDECLAREPARAM(type, var) , type var 1078a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com #define SkPARAM(var) , var 1088a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com// #define SkDEBUGF(args ) SkDebugf##args 1098a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com #define SkDEBUGF(args ) SkDebugf args 1108a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com #define SkAssertResult(cond) SkASSERT(cond) 1118a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#else 1128a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com #define SkASSERT(cond) 1130c00f21fee3f5cfa3aa7e5d46ff94cb8cf340451tomhudson@google.com #define SkDEBUGFAIL(message) 1148a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com #define SkDEBUGCODE(code) 1158a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com #define SkDEBUGF(args) 1168a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com #define SkDECLAREPARAM(type, var) 1178a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com #define SkPARAM(var) 1188a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 1198a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com // unlike SkASSERT, this guy executes its condition in the non-debug build 1208a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com #define SkAssertResult(cond) cond 1218a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#endif 1228a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 12376f9e938df0b5826fd4c80b854ceafaf385cfbe1robertphillips@google.com#ifdef SK_DEVELOPER 12476f9e938df0b5826fd4c80b854ceafaf385cfbe1robertphillips@google.com #define SkDEVCODE(code) code 12576f9e938df0b5826fd4c80b854ceafaf385cfbe1robertphillips@google.com // the 'toString' helper functions convert Sk* objects to human-readable 12676f9e938df0b5826fd4c80b854ceafaf385cfbe1robertphillips@google.com // form in developer mode 12776f9e938df0b5826fd4c80b854ceafaf385cfbe1robertphillips@google.com #define SK_DEVELOPER_TO_STRING() virtual void toString(SkString* str) const SK_OVERRIDE; 12876f9e938df0b5826fd4c80b854ceafaf385cfbe1robertphillips@google.com#else 12976f9e938df0b5826fd4c80b854ceafaf385cfbe1robertphillips@google.com #define SkDEVCODE(code) 13076f9e938df0b5826fd4c80b854ceafaf385cfbe1robertphillips@google.com #define SK_DEVELOPER_TO_STRING() 13176f9e938df0b5826fd4c80b854ceafaf385cfbe1robertphillips@google.com#endif 13276f9e938df0b5826fd4c80b854ceafaf385cfbe1robertphillips@google.com 13328be72b63e457c680c192a34fb9f58e1c693363fvandebo@chromium.orgtemplate <bool> 13428be72b63e457c680c192a34fb9f58e1c693363fvandebo@chromium.orgstruct SkCompileAssert { 13528be72b63e457c680c192a34fb9f58e1c693363fvandebo@chromium.org}; 13628be72b63e457c680c192a34fb9f58e1c693363fvandebo@chromium.org 13728be72b63e457c680c192a34fb9f58e1c693363fvandebo@chromium.org#define SK_COMPILE_ASSERT(expr, msg) \ 1385ebbbe53779cfe93741dc66f433107d04da74486bungeman@google.com typedef SkCompileAssert<(bool(expr))> msg[bool(expr) ? 1 : -1] SK_UNUSED 13928be72b63e457c680c192a34fb9f58e1c693363fvandebo@chromium.org 14049a5b1967ac5bbc6699bee9a2c66088c42aef6fdreed@google.com/* 14149a5b1967ac5bbc6699bee9a2c66088c42aef6fdreed@google.com * Usage: SK_MACRO_CONCAT(a, b) to construct the symbol ab 14249a5b1967ac5bbc6699bee9a2c66088c42aef6fdreed@google.com * 14349a5b1967ac5bbc6699bee9a2c66088c42aef6fdreed@google.com * SK_MACRO_CONCAT_IMPL_PRIV just exists to make this work. Do not use directly 14449a5b1967ac5bbc6699bee9a2c66088c42aef6fdreed@google.com * 14549a5b1967ac5bbc6699bee9a2c66088c42aef6fdreed@google.com */ 14649a5b1967ac5bbc6699bee9a2c66088c42aef6fdreed@google.com#define SK_MACRO_CONCAT(X, Y) SK_MACRO_CONCAT_IMPL_PRIV(X, Y) 14749a5b1967ac5bbc6699bee9a2c66088c42aef6fdreed@google.com#define SK_MACRO_CONCAT_IMPL_PRIV(X, Y) X ## Y 14849a5b1967ac5bbc6699bee9a2c66088c42aef6fdreed@google.com 14949a5b1967ac5bbc6699bee9a2c66088c42aef6fdreed@google.com/* 15049a5b1967ac5bbc6699bee9a2c66088c42aef6fdreed@google.com * Usage: SK_MACRO_APPEND_LINE(foo) to make foo123, where 123 is the current 15149a5b1967ac5bbc6699bee9a2c66088c42aef6fdreed@google.com * line number. Easy way to construct 15249a5b1967ac5bbc6699bee9a2c66088c42aef6fdreed@google.com * unique names for local functions or 15349a5b1967ac5bbc6699bee9a2c66088c42aef6fdreed@google.com * variables. 15449a5b1967ac5bbc6699bee9a2c66088c42aef6fdreed@google.com */ 15549a5b1967ac5bbc6699bee9a2c66088c42aef6fdreed@google.com#define SK_MACRO_APPEND_LINE(name) SK_MACRO_CONCAT(name, __LINE__) 15649a5b1967ac5bbc6699bee9a2c66088c42aef6fdreed@google.com 1578a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com/////////////////////////////////////////////////////////////////////// 1588a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 15937a3133d2009b276f2126ccb61be1f69074cacb9reed@google.com/** 16037a3133d2009b276f2126ccb61be1f69074cacb9reed@google.com * Fast type for signed 8 bits. Use for parameter passing and local variables, 16137a3133d2009b276f2126ccb61be1f69074cacb9reed@google.com * not for storage. 16237a3133d2009b276f2126ccb61be1f69074cacb9reed@google.com */ 16337a3133d2009b276f2126ccb61be1f69074cacb9reed@google.comtypedef int S8CPU; 1648a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 16537a3133d2009b276f2126ccb61be1f69074cacb9reed@google.com/** 16637a3133d2009b276f2126ccb61be1f69074cacb9reed@google.com * Fast type for unsigned 8 bits. Use for parameter passing and local 16737a3133d2009b276f2126ccb61be1f69074cacb9reed@google.com * variables, not for storage 16837a3133d2009b276f2126ccb61be1f69074cacb9reed@google.com */ 16937a3133d2009b276f2126ccb61be1f69074cacb9reed@google.comtypedef unsigned U8CPU; 17037a3133d2009b276f2126ccb61be1f69074cacb9reed@google.com 17137a3133d2009b276f2126ccb61be1f69074cacb9reed@google.com/** 17237a3133d2009b276f2126ccb61be1f69074cacb9reed@google.com * Fast type for signed 16 bits. Use for parameter passing and local variables, 17337a3133d2009b276f2126ccb61be1f69074cacb9reed@google.com * not for storage 17437a3133d2009b276f2126ccb61be1f69074cacb9reed@google.com */ 17537a3133d2009b276f2126ccb61be1f69074cacb9reed@google.comtypedef int S16CPU; 17637a3133d2009b276f2126ccb61be1f69074cacb9reed@google.com 17737a3133d2009b276f2126ccb61be1f69074cacb9reed@google.com/** 17837a3133d2009b276f2126ccb61be1f69074cacb9reed@google.com * Fast type for unsigned 16 bits. Use for parameter passing and local 17937a3133d2009b276f2126ccb61be1f69074cacb9reed@google.com * variables, not for storage 18037a3133d2009b276f2126ccb61be1f69074cacb9reed@google.com */ 18137a3133d2009b276f2126ccb61be1f69074cacb9reed@google.comtypedef unsigned U16CPU; 18237a3133d2009b276f2126ccb61be1f69074cacb9reed@google.com 18337a3133d2009b276f2126ccb61be1f69074cacb9reed@google.com/** 18437a3133d2009b276f2126ccb61be1f69074cacb9reed@google.com * Meant to be faster than bool (doesn't promise to be 0 or 1, 18537a3133d2009b276f2126ccb61be1f69074cacb9reed@google.com * just 0 or non-zero 18637a3133d2009b276f2126ccb61be1f69074cacb9reed@google.com */ 18737a3133d2009b276f2126ccb61be1f69074cacb9reed@google.comtypedef int SkBool; 18837a3133d2009b276f2126ccb61be1f69074cacb9reed@google.com 18937a3133d2009b276f2126ccb61be1f69074cacb9reed@google.com/** 19037a3133d2009b276f2126ccb61be1f69074cacb9reed@google.com * Meant to be a small version of bool, for storage purposes. Will be 0 or 1 19137a3133d2009b276f2126ccb61be1f69074cacb9reed@google.com */ 19237a3133d2009b276f2126ccb61be1f69074cacb9reed@google.comtypedef uint8_t SkBool8; 1938a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 1948a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#ifdef SK_DEBUG 195777ded06fd655aad3f8d8ce1eb434374f153f234bungeman@google.com SK_API int8_t SkToS8(intmax_t); 196777ded06fd655aad3f8d8ce1eb434374f153f234bungeman@google.com SK_API uint8_t SkToU8(uintmax_t); 197777ded06fd655aad3f8d8ce1eb434374f153f234bungeman@google.com SK_API int16_t SkToS16(intmax_t); 198777ded06fd655aad3f8d8ce1eb434374f153f234bungeman@google.com SK_API uint16_t SkToU16(uintmax_t); 199777ded06fd655aad3f8d8ce1eb434374f153f234bungeman@google.com SK_API int32_t SkToS32(intmax_t); 200777ded06fd655aad3f8d8ce1eb434374f153f234bungeman@google.com SK_API uint32_t SkToU32(uintmax_t); 2018a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#else 2028a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com #define SkToS8(x) ((int8_t)(x)) 2038a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com #define SkToU8(x) ((uint8_t)(x)) 2048a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com #define SkToS16(x) ((int16_t)(x)) 2058a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com #define SkToU16(x) ((uint16_t)(x)) 2068a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com #define SkToS32(x) ((int32_t)(x)) 2078a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com #define SkToU32(x) ((uint32_t)(x)) 2088a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#endif 2098a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 2108a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com/** Returns 0 or 1 based on the condition 2118a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com*/ 2128a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#define SkToBool(cond) ((cond) != 0) 2138a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 2148a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#define SK_MaxS16 32767 2158a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#define SK_MinS16 -32767 2168a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#define SK_MaxU16 0xFFFF 2178a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#define SK_MinU16 0 2188a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#define SK_MaxS32 0x7FFFFFFF 219594dd3cd78e2f970d53bb0934fbbb63b41e1d40ccaryclark@google.com#define SK_MinS32 -SK_MaxS32 2208a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#define SK_MaxU32 0xFFFFFFFF 2218a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#define SK_MinU32 0 2220e51577a14f903ffeafa117a75954baeb173ffb9humper@google.com#define SK_NaN32 (1 << 31) 2238a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 224d4577757874d1dda1a3bffa3f2347c251859c27ereed@android.com/** Returns true if the value can be represented with signed 16bits 225d4577757874d1dda1a3bffa3f2347c251859c27ereed@android.com */ 22690209caa686464cad70dd9d60b53c3d967eb57dareed@android.comstatic inline bool SkIsS16(long x) { 227d4577757874d1dda1a3bffa3f2347c251859c27ereed@android.com return (int16_t)x == x; 228d4577757874d1dda1a3bffa3f2347c251859c27ereed@android.com} 229d4577757874d1dda1a3bffa3f2347c251859c27ereed@android.com 230d4577757874d1dda1a3bffa3f2347c251859c27ereed@android.com/** Returns true if the value can be represented with unsigned 16bits 231d4577757874d1dda1a3bffa3f2347c251859c27ereed@android.com */ 23290209caa686464cad70dd9d60b53c3d967eb57dareed@android.comstatic inline bool SkIsU16(long x) { 233d4577757874d1dda1a3bffa3f2347c251859c27ereed@android.com return (uint16_t)x == x; 234d4577757874d1dda1a3bffa3f2347c251859c27ereed@android.com} 235d4577757874d1dda1a3bffa3f2347c251859c27ereed@android.com 236d4577757874d1dda1a3bffa3f2347c251859c27ereed@android.com////////////////////////////////////////////////////////////////////////////// 2378a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#ifndef SK_OFFSETOF 23856d3a23c3e0a53777fb25898951718d44dd9c027reed@google.com #define SK_OFFSETOF(type, field) (size_t)((char*)&(((type*)1)->field) - (char*)1) 2398a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#endif 2408a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 2418a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com/** Returns the number of entries in an array (not a pointer) 2428a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com*/ 2438a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#define SK_ARRAY_COUNT(array) (sizeof(array) / sizeof(array[0])) 2448a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 2458a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#define SkAlign2(x) (((x) + 1) >> 1 << 1) 246c6faa5a0c46004115739cf34e29f4a3aa56a2adcreed@google.com#define SkIsAlign2(x) (0 == ((x) & 1)) 247c6faa5a0c46004115739cf34e29f4a3aa56a2adcreed@google.com 2488a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#define SkAlign4(x) (((x) + 3) >> 2 << 2) 249c6faa5a0c46004115739cf34e29f4a3aa56a2adcreed@google.com#define SkIsAlign4(x) (0 == ((x) & 3)) 2508a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 251c6faa5a0c46004115739cf34e29f4a3aa56a2adcreed@google.com#define SkAlign8(x) (((x) + 7) >> 3 << 3) 252c6faa5a0c46004115739cf34e29f4a3aa56a2adcreed@google.com#define SkIsAlign8(x) (0 == ((x) & 7)) 25301224d5d0a3228fe47e63d8346e0e433a87563a8tomhudson@google.com 2548a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.comtypedef uint32_t SkFourByteTag; 2558a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#define SkSetFourByteTag(a, b, c, d) (((a) << 24) | ((b) << 16) | ((c) << 8) | (d)) 2568a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 2578a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com/** 32 bit integer to hold a unicode value 2588a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com*/ 2598a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.comtypedef int32_t SkUnichar; 2608a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com/** 32 bit value to hold a millisecond count 2618a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com*/ 2628a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.comtypedef uint32_t SkMSec; 2638a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com/** 1 second measured in milliseconds 2648a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com*/ 2658a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#define SK_MSec1 1000 2668a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com/** maximum representable milliseconds 2678a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com*/ 2688a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#define SK_MSecMax 0x7FFFFFFF 2698a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com/** Returns a < b for milliseconds, correctly handling wrap-around from 0xFFFFFFFF to 0 2708a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com*/ 2718a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#define SkMSec_LT(a, b) ((int32_t)(a) - (int32_t)(b) < 0) 2728a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com/** Returns a <= b for milliseconds, correctly handling wrap-around from 0xFFFFFFFF to 0 2738a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com*/ 2748a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#define SkMSec_LE(a, b) ((int32_t)(a) - (int32_t)(b) <= 0) 2758a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 2768a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com/**************************************************************************** 2778a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com The rest of these only build with C++ 2788a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com*/ 2798a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#ifdef __cplusplus 2808a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 2818a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com/** Faster than SkToBool for integral conditions. Returns 0 or 1 2828a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com*/ 283d4577757874d1dda1a3bffa3f2347c251859c27ereed@android.comstatic inline int Sk32ToBool(uint32_t n) { 2848a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com return (n | (0-n)) >> 31; 2858a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com} 2868a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 287ff436617d8f11297f0eff93ddd49fb9022d0843bbsalomon@google.com/** Generic swap function. Classes with efficient swaps should specialize this function to take 288ff436617d8f11297f0eff93ddd49fb9022d0843bbsalomon@google.com their fast path. This function is used by SkTSort. */ 289d4577757874d1dda1a3bffa3f2347c251859c27ereed@android.comtemplate <typename T> inline void SkTSwap(T& a, T& b) { 2908a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com T c(a); 2918a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com a = b; 2928a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com b = c; 2938a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com} 2948a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 295d4577757874d1dda1a3bffa3f2347c251859c27ereed@android.comstatic inline int32_t SkAbs32(int32_t value) { 29638bad32cf5297ec6908620fd174cd08c937d331acommit-bot@chromium.org if (value < 0) { 2978a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com value = -value; 29838bad32cf5297ec6908620fd174cd08c937d331acommit-bot@chromium.org } 2998a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com return value; 3008a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com} 3018a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 3022b57dc6bb241a6627c4375ee54b73039983d03dareed@google.comtemplate <typename T> inline T SkTAbs(T value) { 3032b57dc6bb241a6627c4375ee54b73039983d03dareed@google.com if (value < 0) { 3042b57dc6bb241a6627c4375ee54b73039983d03dareed@google.com value = -value; 3052b57dc6bb241a6627c4375ee54b73039983d03dareed@google.com } 3062b57dc6bb241a6627c4375ee54b73039983d03dareed@google.com return value; 3072b57dc6bb241a6627c4375ee54b73039983d03dareed@google.com} 3082b57dc6bb241a6627c4375ee54b73039983d03dareed@google.com 309d4577757874d1dda1a3bffa3f2347c251859c27ereed@android.comstatic inline int32_t SkMax32(int32_t a, int32_t b) { 3108a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com if (a < b) 3118a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com a = b; 3128a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com return a; 3138a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com} 3148a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 315d4577757874d1dda1a3bffa3f2347c251859c27ereed@android.comstatic inline int32_t SkMin32(int32_t a, int32_t b) { 3168a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com if (a > b) 3178a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com a = b; 3188a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com return a; 3198a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com} 3208a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 3213b97af5add04489d57c7926ba6dc6f0013daf40fcaryclark@google.comtemplate <typename T> const T& SkTMin(const T& a, const T& b) { 3223b97af5add04489d57c7926ba6dc6f0013daf40fcaryclark@google.com return (a < b) ? a : b; 3233b97af5add04489d57c7926ba6dc6f0013daf40fcaryclark@google.com} 3243b97af5add04489d57c7926ba6dc6f0013daf40fcaryclark@google.com 3253b97af5add04489d57c7926ba6dc6f0013daf40fcaryclark@google.comtemplate <typename T> const T& SkTMax(const T& a, const T& b) { 3263b97af5add04489d57c7926ba6dc6f0013daf40fcaryclark@google.com return (b < a) ? a : b; 3273b97af5add04489d57c7926ba6dc6f0013daf40fcaryclark@google.com} 3283b97af5add04489d57c7926ba6dc6f0013daf40fcaryclark@google.com 329d4577757874d1dda1a3bffa3f2347c251859c27ereed@android.comstatic inline int32_t SkSign32(int32_t a) { 3308a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com return (a >> 31) | ((unsigned) -a >> 31); 3318a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com} 3328a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 333d4577757874d1dda1a3bffa3f2347c251859c27ereed@android.comstatic inline int32_t SkFastMin32(int32_t value, int32_t max) { 33438bad32cf5297ec6908620fd174cd08c937d331acommit-bot@chromium.org if (value > max) { 3358a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com value = max; 33638bad32cf5297ec6908620fd174cd08c937d331acommit-bot@chromium.org } 3378a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com return value; 3388a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com} 3398a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 3408a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com/** Returns signed 32 bit value pinned between min and max, inclusively 3418a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com*/ 342d4577757874d1dda1a3bffa3f2347c251859c27ereed@android.comstatic inline int32_t SkPin32(int32_t value, int32_t min, int32_t max) { 34338bad32cf5297ec6908620fd174cd08c937d331acommit-bot@chromium.org if (value < min) { 3448a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com value = min; 34538bad32cf5297ec6908620fd174cd08c937d331acommit-bot@chromium.org } 34638bad32cf5297ec6908620fd174cd08c937d331acommit-bot@chromium.org if (value > max) { 3478a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com value = max; 34838bad32cf5297ec6908620fd174cd08c937d331acommit-bot@chromium.org } 3498a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com return value; 3508a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com} 3518a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 352d4577757874d1dda1a3bffa3f2347c251859c27ereed@android.comstatic inline uint32_t SkSetClearShift(uint32_t bits, bool cond, 353d4577757874d1dda1a3bffa3f2347c251859c27ereed@android.com unsigned shift) { 3548a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SkASSERT((int)cond == 0 || (int)cond == 1); 3558a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com return (bits & ~(1 << shift)) | ((int)cond << shift); 3568a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com} 3578a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 358d4577757874d1dda1a3bffa3f2347c251859c27ereed@android.comstatic inline uint32_t SkSetClearMask(uint32_t bits, bool cond, 359d4577757874d1dda1a3bffa3f2347c251859c27ereed@android.com uint32_t mask) { 3608a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com return cond ? bits | mask : bits & ~mask; 3618a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com} 3628a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 3631fcd51e6b2a210a37b9b9c2cfb82e1be7196e42areed@google.com/////////////////////////////////////////////////////////////////////////////// 3641fcd51e6b2a210a37b9b9c2cfb82e1be7196e42areed@google.com 365325cb9aa17b94258b362082eb3a799524f4345f3vandebo@chromium.org/** Use to combine multiple bits in a bitmask in a type safe way. 366325cb9aa17b94258b362082eb3a799524f4345f3vandebo@chromium.org */ 367325cb9aa17b94258b362082eb3a799524f4345f3vandebo@chromium.orgtemplate <typename T> 368325cb9aa17b94258b362082eb3a799524f4345f3vandebo@chromium.orgT SkTBitOr(T a, T b) { 369325cb9aa17b94258b362082eb3a799524f4345f3vandebo@chromium.org return (T)(a | b); 370325cb9aa17b94258b362082eb3a799524f4345f3vandebo@chromium.org} 371325cb9aa17b94258b362082eb3a799524f4345f3vandebo@chromium.org 3721fcd51e6b2a210a37b9b9c2cfb82e1be7196e42areed@google.com/** 3731fcd51e6b2a210a37b9b9c2cfb82e1be7196e42areed@google.com * Use to cast a pointer to a different type, and maintaining strict-aliasing 3741fcd51e6b2a210a37b9b9c2cfb82e1be7196e42areed@google.com */ 3751fcd51e6b2a210a37b9b9c2cfb82e1be7196e42areed@google.comtemplate <typename Dst> Dst SkTCast(const void* ptr) { 3761fcd51e6b2a210a37b9b9c2cfb82e1be7196e42areed@google.com union { 3771fcd51e6b2a210a37b9b9c2cfb82e1be7196e42areed@google.com const void* src; 3781fcd51e6b2a210a37b9b9c2cfb82e1be7196e42areed@google.com Dst dst; 3791fcd51e6b2a210a37b9b9c2cfb82e1be7196e42areed@google.com } data; 3801fcd51e6b2a210a37b9b9c2cfb82e1be7196e42areed@google.com data.src = ptr; 3811fcd51e6b2a210a37b9b9c2cfb82e1be7196e42areed@google.com return data.dst; 3821fcd51e6b2a210a37b9b9c2cfb82e1be7196e42areed@google.com} 3831fcd51e6b2a210a37b9b9c2cfb82e1be7196e42areed@google.com 3848a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com////////////////////////////////////////////////////////////////////////////// 3858a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 3868a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com/** \class SkNoncopyable 3878a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 3888a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.comSkNoncopyable is the base class for objects that may do not want to 3898a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.combe copied. It hides its copy-constructor and its assignment-operator. 3908a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com*/ 3917ffb1b21abcc7bbed5a0fc711f6dd7b9dbb4f577ctguil@chromium.orgclass SK_API SkNoncopyable { 3928a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.compublic: 3938a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SkNoncopyable() {} 3941fcd51e6b2a210a37b9b9c2cfb82e1be7196e42areed@google.com 3958a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.comprivate: 3968a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SkNoncopyable(const SkNoncopyable&); 3978a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SkNoncopyable& operator=(const SkNoncopyable&); 3988a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com}; 3998a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 4008a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.comclass SkAutoFree : SkNoncopyable { 4018a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.compublic: 4028a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SkAutoFree() : fPtr(NULL) {} 4038a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com explicit SkAutoFree(void* ptr) : fPtr(ptr) {} 4048a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com ~SkAutoFree() { sk_free(fPtr); } 4051fcd51e6b2a210a37b9b9c2cfb82e1be7196e42areed@google.com 4068a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Return the currently allocate buffer, or null 4078a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 4088a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com void* get() const { return fPtr; } 4098a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 4108a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Assign a new ptr allocated with sk_malloc (or null), and return the 4118a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com previous ptr. Note it is the caller's responsibility to sk_free the 4128a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com returned ptr. 4138a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 4148a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com void* set(void* ptr) { 4158a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com void* prev = fPtr; 4168a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com fPtr = ptr; 4178a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com return prev; 4188a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com } 4191fcd51e6b2a210a37b9b9c2cfb82e1be7196e42areed@google.com 4208a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Transfer ownership of the current ptr to the caller, setting the 4218a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com internal reference to null. Note the caller is reponsible for calling 4228a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com sk_free on the returned address. 4238a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 4248a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com void* detach() { return this->set(NULL); } 4258a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 4268a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com /** Free the current buffer, and set the internal reference to NULL. Same 4278a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com as calling sk_free(detach()) 4288a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com */ 4298a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com void free() { 4308a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com sk_free(fPtr); 4318a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com fPtr = NULL; 4328a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com } 4338a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 4348a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.comprivate: 4358a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com void* fPtr; 4368a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com // illegal 4378a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SkAutoFree(const SkAutoFree&); 4388a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com SkAutoFree& operator=(const SkAutoFree&); 4398a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com}; 4408a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 4417d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com/** 4427d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com * Manage an allocated block of heap memory. This object is the sole manager of 4437d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com * the lifetime of the block, so the caller must not call sk_free() or delete 4441c401d8f42dbb3d2fd8f249a2acbe4bac829ff00reed@google.com * on the block, unless detach() was called. 4457d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com */ 4467d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.comclass SkAutoMalloc : public SkNoncopyable { 4478a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.compublic: 4483ab4195445d8541b2950bd30ccaefe1e345afa25reed@google.com explicit SkAutoMalloc(size_t size = 0) { 4493ab4195445d8541b2950bd30ccaefe1e345afa25reed@google.com fPtr = size ? sk_malloc_throw(size) : NULL; 4507d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com fSize = size; 4517d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com } 4528a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 4537d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com ~SkAutoMalloc() { 4547d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com sk_free(fPtr); 4557d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com } 4568a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 4577d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com /** 4581c401d8f42dbb3d2fd8f249a2acbe4bac829ff00reed@google.com * Passed to reset to specify what happens if the requested size is smaller 4591c401d8f42dbb3d2fd8f249a2acbe4bac829ff00reed@google.com * than the current size (and the current block was dynamically allocated). 4601c401d8f42dbb3d2fd8f249a2acbe4bac829ff00reed@google.com */ 4611c401d8f42dbb3d2fd8f249a2acbe4bac829ff00reed@google.com enum OnShrink { 4621c401d8f42dbb3d2fd8f249a2acbe4bac829ff00reed@google.com /** 4631c401d8f42dbb3d2fd8f249a2acbe4bac829ff00reed@google.com * If the requested size is smaller than the current size, and the 4641c401d8f42dbb3d2fd8f249a2acbe4bac829ff00reed@google.com * current block is dynamically allocated, free the old block and 4651c401d8f42dbb3d2fd8f249a2acbe4bac829ff00reed@google.com * malloc a new block of the smaller size. 4661c401d8f42dbb3d2fd8f249a2acbe4bac829ff00reed@google.com */ 4671c401d8f42dbb3d2fd8f249a2acbe4bac829ff00reed@google.com kAlloc_OnShrink, 468fbfcd5602128ec010c82cb733c9cdc0a3254f9f3rmistry@google.com 4691c401d8f42dbb3d2fd8f249a2acbe4bac829ff00reed@google.com /** 4701c401d8f42dbb3d2fd8f249a2acbe4bac829ff00reed@google.com * If the requested size is smaller than the current size, and the 4711c401d8f42dbb3d2fd8f249a2acbe4bac829ff00reed@google.com * current block is dynamically allocated, just return the old 4721c401d8f42dbb3d2fd8f249a2acbe4bac829ff00reed@google.com * block. 4731c401d8f42dbb3d2fd8f249a2acbe4bac829ff00reed@google.com */ 4741f90287df3129cb267422e482c52ebeca6a8990ftomhudson@google.com kReuse_OnShrink 4751c401d8f42dbb3d2fd8f249a2acbe4bac829ff00reed@google.com }; 4761c401d8f42dbb3d2fd8f249a2acbe4bac829ff00reed@google.com 4771c401d8f42dbb3d2fd8f249a2acbe4bac829ff00reed@google.com /** 4787d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com * Reallocates the block to a new size. The ptr may or may not change. 4797d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com */ 4809eb6645956a46e81336a2ed9e705a5360163c4f9bsalomon@google.com void* reset(size_t size, OnShrink shrink = kAlloc_OnShrink, bool* didChangeAlloc = NULL) { 4811c401d8f42dbb3d2fd8f249a2acbe4bac829ff00reed@google.com if (size == fSize || (kReuse_OnShrink == shrink && size < fSize)) { 4829eb6645956a46e81336a2ed9e705a5360163c4f9bsalomon@google.com if (NULL != didChangeAlloc) { 4839eb6645956a46e81336a2ed9e705a5360163c4f9bsalomon@google.com *didChangeAlloc = false; 4849eb6645956a46e81336a2ed9e705a5360163c4f9bsalomon@google.com } 4851c401d8f42dbb3d2fd8f249a2acbe4bac829ff00reed@google.com return fPtr; 4867d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com } 4871c401d8f42dbb3d2fd8f249a2acbe4bac829ff00reed@google.com 4881c401d8f42dbb3d2fd8f249a2acbe4bac829ff00reed@google.com sk_free(fPtr); 4891c401d8f42dbb3d2fd8f249a2acbe4bac829ff00reed@google.com fPtr = size ? sk_malloc_throw(size) : NULL; 4901c401d8f42dbb3d2fd8f249a2acbe4bac829ff00reed@google.com fSize = size; 4919eb6645956a46e81336a2ed9e705a5360163c4f9bsalomon@google.com if (NULL != didChangeAlloc) { 4929eb6645956a46e81336a2ed9e705a5360163c4f9bsalomon@google.com *didChangeAlloc = true; 4939eb6645956a46e81336a2ed9e705a5360163c4f9bsalomon@google.com } 4941c401d8f42dbb3d2fd8f249a2acbe4bac829ff00reed@google.com 4957d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com return fPtr; 4968a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com } 4977d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com 4987d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com /** 4997d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com * Releases the block back to the heap 5007d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com */ 5017d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com void free() { 5027d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com this->reset(0); 5037d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com } 5047d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com 5057d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com /** 5067d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com * Return the allocated block. 5077d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com */ 5087d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com void* get() { return fPtr; } 5097d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com const void* get() const { return fPtr; } 5107d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com 5116dcd27cd5e2e1f7a1f4d85bd546586a4d2bd4f41bsalomon@google.com /** Transfer ownership of the current ptr to the caller, setting the 5126dcd27cd5e2e1f7a1f4d85bd546586a4d2bd4f41bsalomon@google.com internal reference to null. Note the caller is reponsible for calling 5136dcd27cd5e2e1f7a1f4d85bd546586a4d2bd4f41bsalomon@google.com sk_free on the returned address. 5146dcd27cd5e2e1f7a1f4d85bd546586a4d2bd4f41bsalomon@google.com */ 5156dcd27cd5e2e1f7a1f4d85bd546586a4d2bd4f41bsalomon@google.com void* detach() { 5166dcd27cd5e2e1f7a1f4d85bd546586a4d2bd4f41bsalomon@google.com void* ptr = fPtr; 5176dcd27cd5e2e1f7a1f4d85bd546586a4d2bd4f41bsalomon@google.com fPtr = NULL; 5186dcd27cd5e2e1f7a1f4d85bd546586a4d2bd4f41bsalomon@google.com fSize = 0; 5196dcd27cd5e2e1f7a1f4d85bd546586a4d2bd4f41bsalomon@google.com return ptr; 5206dcd27cd5e2e1f7a1f4d85bd546586a4d2bd4f41bsalomon@google.com } 5216dcd27cd5e2e1f7a1f4d85bd546586a4d2bd4f41bsalomon@google.com 5227d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.comprivate: 5237d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com void* fPtr; 5241c401d8f42dbb3d2fd8f249a2acbe4bac829ff00reed@google.com size_t fSize; // can be larger than the requested size (see kReuse) 5258a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com}; 5268a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 52763a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com/** 52863a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com * Manage an allocated block of memory. If the requested size is <= kSize, then 52963a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com * the allocation will come from the stack rather than the heap. This object 53063a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com * is the sole manager of the lifetime of the block, so the caller must not 53163a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com * call sk_free() or delete on the block. 53263a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com */ 5338a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.comtemplate <size_t kSize> class SkAutoSMalloc : SkNoncopyable { 5348a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.compublic: 53563a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com /** 53663a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com * Creates initially empty storage. get() returns a ptr, but it is to 5377d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com * a zero-byte allocation. Must call reset(size) to return an allocated 53863a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com * block. 53963a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com */ 54063a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com SkAutoSMalloc() { 54163a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com fPtr = fStorage; 5429eb6645956a46e81336a2ed9e705a5360163c4f9bsalomon@google.com fSize = kSize; 5438a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com } 54463a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com 54563a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com /** 54663a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com * Allocate a block of the specified size. If size <= kSize, then the 54763a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com * allocation will come from the stack, otherwise it will be dynamically 54863a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com * allocated. 54963a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com */ 55063a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com explicit SkAutoSMalloc(size_t size) { 55163a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com fPtr = fStorage; 5529eb6645956a46e81336a2ed9e705a5360163c4f9bsalomon@google.com fSize = kSize; 5537d4679a2e1aaa1953bc20d668135c517ee488c11bsalomon@google.com this->reset(size); 55463a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com } 55563a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com 55663a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com /** 55763a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com * Free the allocated block (if any). If the block was small enought to 55863a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com * have been allocated on the stack (size <= kSize) then this does nothing. 55963a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com */ 56063a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com ~SkAutoSMalloc() { 56163a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com if (fPtr != (void*)fStorage) { 5628a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com sk_free(fPtr); 56363a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com } 5648a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com } 56563a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com 56663a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com /** 56763a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com * Return the allocated block. May return non-null even if the block is 56863a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com * of zero size. Since this may be on the stack or dynamically allocated, 56963a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com * the caller must not call sk_free() on it, but must rely on SkAutoSMalloc 57063a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com * to manage it. 57163a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com */ 5728a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com void* get() const { return fPtr; } 57363a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com 57463a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com /** 57563a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com * Return a new block of the requested size, freeing (as necessary) any 57663a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com * previously allocated block. As with the constructor, if size <= kSize 57763a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com * then the return block may be allocated locally, rather than from the 57863a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com * heap. 57963a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com */ 5801c401d8f42dbb3d2fd8f249a2acbe4bac829ff00reed@google.com void* reset(size_t size, 5819eb6645956a46e81336a2ed9e705a5360163c4f9bsalomon@google.com SkAutoMalloc::OnShrink shrink = SkAutoMalloc::kAlloc_OnShrink, 5829eb6645956a46e81336a2ed9e705a5360163c4f9bsalomon@google.com bool* didChangeAlloc = NULL) { 5839eb6645956a46e81336a2ed9e705a5360163c4f9bsalomon@google.com size = (size < kSize) ? kSize : size; 5840f2b1953c7a8f8bb5a25d573dd9e215eaa10a2f8robertphillips@google.com bool alloc = size != fSize && (SkAutoMalloc::kAlloc_OnShrink == shrink || size > fSize); 5859eb6645956a46e81336a2ed9e705a5360163c4f9bsalomon@google.com if (NULL != didChangeAlloc) { 5869eb6645956a46e81336a2ed9e705a5360163c4f9bsalomon@google.com *didChangeAlloc = alloc; 5871c401d8f42dbb3d2fd8f249a2acbe4bac829ff00reed@google.com } 5889eb6645956a46e81336a2ed9e705a5360163c4f9bsalomon@google.com if (alloc) { 5899eb6645956a46e81336a2ed9e705a5360163c4f9bsalomon@google.com if (fPtr != (void*)fStorage) { 5909eb6645956a46e81336a2ed9e705a5360163c4f9bsalomon@google.com sk_free(fPtr); 5919eb6645956a46e81336a2ed9e705a5360163c4f9bsalomon@google.com } 5929eb6645956a46e81336a2ed9e705a5360163c4f9bsalomon@google.com 5939eb6645956a46e81336a2ed9e705a5360163c4f9bsalomon@google.com if (size == kSize) { 5949eb6645956a46e81336a2ed9e705a5360163c4f9bsalomon@google.com SkASSERT(fPtr != fStorage); // otherwise we lied when setting didChangeAlloc. 5959eb6645956a46e81336a2ed9e705a5360163c4f9bsalomon@google.com fPtr = fStorage; 5969eb6645956a46e81336a2ed9e705a5360163c4f9bsalomon@google.com } else { 5979eb6645956a46e81336a2ed9e705a5360163c4f9bsalomon@google.com fPtr = sk_malloc_flags(size, SK_MALLOC_THROW | SK_MALLOC_TEMP); 5989eb6645956a46e81336a2ed9e705a5360163c4f9bsalomon@google.com } 5999eb6645956a46e81336a2ed9e705a5360163c4f9bsalomon@google.com 6009eb6645956a46e81336a2ed9e705a5360163c4f9bsalomon@google.com fSize = size; 60163a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com } 6029eb6645956a46e81336a2ed9e705a5360163c4f9bsalomon@google.com SkASSERT(fSize >= size && fSize >= kSize); 6039eb6645956a46e81336a2ed9e705a5360163c4f9bsalomon@google.com SkASSERT((fPtr == fStorage) || fSize > kSize); 60463a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com return fPtr; 60563a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com } 60663a6060fcdc16245ea3958e7fd88ae32c5e631a3reed@google.com 6078a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.comprivate: 6088a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com void* fPtr; 6091c401d8f42dbb3d2fd8f249a2acbe4bac829ff00reed@google.com size_t fSize; // can be larger than the requested size (see kReuse) 6108a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com uint32_t fStorage[(kSize + 3) >> 2]; 6118a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com}; 6128a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 6138a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#endif /* C++ */ 6148a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com 6158a1c16ff38322f0210116fa7293eb8817c7e477ereed@android.com#endif 616