epoger@google.com | ec3ed6a | 2011-07-28 14:26:00 +0000 | [diff] [blame] | 1 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 2 | /* |
epoger@google.com | ec3ed6a | 2011-07-28 14:26:00 +0000 | [diff] [blame] | 3 | * Copyright 2006 The Android Open Source Project |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 4 | * |
epoger@google.com | ec3ed6a | 2011-07-28 14:26:00 +0000 | [diff] [blame] | 5 | * Use of this source code is governed by a BSD-style license that can be |
| 6 | * found in the LICENSE file. |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 7 | */ |
| 8 | |
epoger@google.com | ec3ed6a | 2011-07-28 14:26:00 +0000 | [diff] [blame] | 9 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 10 | #ifndef SkFlattenable_DEFINED |
| 11 | #define SkFlattenable_DEFINED |
| 12 | |
| 13 | #include "SkRefCnt.h" |
| 14 | #include "SkBitmap.h" |
| 15 | #include "SkReader32.h" |
| 16 | #include "SkTDArray.h" |
| 17 | #include "SkWriter32.h" |
| 18 | |
| 19 | class SkFlattenableReadBuffer; |
| 20 | class SkFlattenableWriteBuffer; |
| 21 | class SkString; |
| 22 | |
caryclark@google.com | d26147a | 2011-12-15 14:16:43 +0000 | [diff] [blame] | 23 | #if SK_ALLOW_STATIC_GLOBAL_INITIALIZERS |
| 24 | |
caryclark@google.com | d26147a | 2011-12-15 14:16:43 +0000 | [diff] [blame] | 25 | #define SK_DEFINE_FLATTENABLE_REGISTRAR(flattenable) \ |
| 26 | static SkFlattenable::Registrar g##flattenable##Reg(#flattenable, \ |
djsollen@google.com | a2ca41e | 2012-03-23 19:00:34 +0000 | [diff] [blame] | 27 | flattenable::CreateProc); |
caryclark@google.com | d26147a | 2011-12-15 14:16:43 +0000 | [diff] [blame] | 28 | #define SK_DEFINE_FLATTENABLE_REGISTRAR_ENTRY(flattenable) \ |
| 29 | static SkFlattenable::Registrar g##flattenable##Reg(#flattenable, \ |
djsollen@google.com | a2ca41e | 2012-03-23 19:00:34 +0000 | [diff] [blame] | 30 | flattenable::CreateProc); |
| 31 | |
| 32 | #define SK_DECLARE_FLATTENABLE_REGISTRAR_GROUP() |
| 33 | #define SK_DEFINE_FLATTENABLE_REGISTRAR_GROUP_START(flattenable) |
caryclark@google.com | d26147a | 2011-12-15 14:16:43 +0000 | [diff] [blame] | 34 | #define SK_DEFINE_FLATTENABLE_REGISTRAR_GROUP_END |
| 35 | |
| 36 | #else |
| 37 | |
djsollen@google.com | a2ca41e | 2012-03-23 19:00:34 +0000 | [diff] [blame] | 38 | #define SK_DEFINE_FLATTENABLE_REGISTRAR(flattenable) |
caryclark@google.com | d26147a | 2011-12-15 14:16:43 +0000 | [diff] [blame] | 39 | #define SK_DEFINE_FLATTENABLE_REGISTRAR_ENTRY(flattenable) \ |
| 40 | SkFlattenable::Registrar(#flattenable, flattenable::CreateProc); |
djsollen@google.com | a2ca41e | 2012-03-23 19:00:34 +0000 | [diff] [blame] | 41 | |
| 42 | #define SK_DECLARE_FLATTENABLE_REGISTRAR_GROUP() static void InitializeFlattenables(); |
| 43 | |
| 44 | #define SK_DEFINE_FLATTENABLE_REGISTRAR_GROUP_START(flattenable) \ |
| 45 | void flattenable::InitializeFlattenables() { |
| 46 | |
caryclark@google.com | d26147a | 2011-12-15 14:16:43 +0000 | [diff] [blame] | 47 | #define SK_DEFINE_FLATTENABLE_REGISTRAR_GROUP_END \ |
| 48 | } |
| 49 | |
| 50 | #endif |
| 51 | |
djsollen@google.com | ba28d03 | 2012-03-26 17:57:35 +0000 | [diff] [blame] | 52 | #define SK_DECLARE_UNFLATTENABLE_OBJECT() \ |
| 53 | virtual Factory getFactory() SK_OVERRIDE { return NULL; }; \ |
| 54 | |
| 55 | #define SK_DECLARE_PUBLIC_FLATTENABLE_DESERIALIZATION_PROCS(flattenable) \ |
| 56 | virtual Factory getFactory() SK_OVERRIDE { return CreateProc; }; \ |
| 57 | static SkFlattenable* CreateProc(SkFlattenableReadBuffer& buffer) { \ |
| 58 | return SkNEW_ARGS(flattenable, (buffer)); \ |
| 59 | } |
| 60 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 61 | /** \class SkFlattenable |
| 62 | |
| 63 | SkFlattenable is the base class for objects that need to be flattened |
| 64 | into a data stream for either transport or as part of the key to the |
| 65 | font cache. |
| 66 | */ |
ctguil@chromium.org | 7ffb1b2 | 2011-03-15 21:27:08 +0000 | [diff] [blame] | 67 | class SK_API SkFlattenable : public SkRefCnt { |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 68 | public: |
| 69 | typedef SkFlattenable* (*Factory)(SkFlattenableReadBuffer&); |
| 70 | |
| 71 | SkFlattenable() {} |
| 72 | |
| 73 | /** Implement this to return a factory function pointer that can be called |
| 74 | to recreate your class given a buffer (previously written to by your |
| 75 | override of flatten(). |
| 76 | */ |
| 77 | virtual Factory getFactory() = 0; |
| 78 | /** Override this to write data specific to your subclass into the buffer, |
| 79 | being sure to call your super-class' version first. This data will later |
| 80 | be passed to your Factory function, returned by getFactory(). |
| 81 | */ |
| 82 | virtual void flatten(SkFlattenableWriteBuffer&); |
| 83 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 84 | static Factory NameToFactory(const char name[]); |
| 85 | static const char* FactoryToName(Factory); |
| 86 | static void Register(const char name[], Factory); |
djsollen@google.com | a2ca41e | 2012-03-23 19:00:34 +0000 | [diff] [blame] | 87 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 88 | class Registrar { |
| 89 | public: |
| 90 | Registrar(const char name[], Factory factory) { |
| 91 | SkFlattenable::Register(name, factory); |
| 92 | } |
| 93 | }; |
djsollen@google.com | a2ca41e | 2012-03-23 19:00:34 +0000 | [diff] [blame] | 94 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 95 | protected: |
| 96 | SkFlattenable(SkFlattenableReadBuffer&) {} |
caryclark@google.com | d26147a | 2011-12-15 14:16:43 +0000 | [diff] [blame] | 97 | |
| 98 | private: |
| 99 | #if !SK_ALLOW_STATIC_GLOBAL_INITIALIZERS |
| 100 | static void InitializeFlattenables(); |
| 101 | #endif |
caryclark@google.com | 9d0c6ec | 2011-12-20 20:26:56 +0000 | [diff] [blame] | 102 | |
| 103 | friend class SkGraphics; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 104 | }; |
| 105 | |
reed@google.com | f2eb5ab | 2011-05-10 22:56:42 +0000 | [diff] [blame] | 106 | // helpers for matrix and region |
| 107 | |
| 108 | class SkMatrix; |
| 109 | extern void SkReadMatrix(SkReader32*, SkMatrix*); |
| 110 | extern void SkWriteMatrix(SkWriter32*, const SkMatrix&); |
| 111 | |
| 112 | class SkRegion; |
| 113 | extern void SkReadRegion(SkReader32*, SkRegion*); |
| 114 | extern void SkWriteRegion(SkWriter32*, const SkRegion&); |
| 115 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 116 | /////////////////////////////////////////////////////////////////////////////// |
| 117 | /////////////////////////////////////////////////////////////////////////////// |
| 118 | |
| 119 | class SkTypeface; |
| 120 | |
| 121 | class SkFlattenableReadBuffer : public SkReader32 { |
| 122 | public: |
| 123 | SkFlattenableReadBuffer(); |
| 124 | explicit SkFlattenableReadBuffer(const void* data); |
| 125 | SkFlattenableReadBuffer(const void* data, size_t size); |
| 126 | |
| 127 | void setRefCntArray(SkRefCnt* array[], int count) { |
| 128 | fRCArray = array; |
| 129 | fRCCount = count; |
| 130 | } |
| 131 | |
| 132 | void setTypefaceArray(SkTypeface* array[], int count) { |
| 133 | fTFArray = array; |
| 134 | fTFCount = count; |
| 135 | } |
reed@google.com | 6bac947 | 2011-06-21 19:24:00 +0000 | [diff] [blame] | 136 | |
| 137 | /** |
| 138 | * Call this with a pre-loaded array of Factories, in the same order as |
| 139 | * were created/written by the writer. SkPicture uses this. |
| 140 | */ |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 141 | void setFactoryPlayback(SkFlattenable::Factory array[], int count) { |
reed@google.com | 6bac947 | 2011-06-21 19:24:00 +0000 | [diff] [blame] | 142 | fFactoryTDArray = NULL; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 143 | fFactoryArray = array; |
| 144 | fFactoryCount = count; |
| 145 | } |
reed@google.com | 6bac947 | 2011-06-21 19:24:00 +0000 | [diff] [blame] | 146 | |
| 147 | /** |
| 148 | * Call this with an initially empty array, so the reader can cache each |
| 149 | * factory it sees by name. Used by the pipe code in conjunction with |
| 150 | * the writer's kInlineFactoryNames_Flag. |
| 151 | */ |
| 152 | void setFactoryArray(SkTDArray<SkFlattenable::Factory>* array) { |
| 153 | fFactoryTDArray = array; |
| 154 | fFactoryArray = NULL; |
| 155 | fFactoryCount = 0; |
| 156 | } |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 157 | |
| 158 | SkTypeface* readTypeface(); |
| 159 | SkRefCnt* readRefCnt(); |
| 160 | void* readFunctionPtr(); |
| 161 | SkFlattenable* readFlattenable(); |
| 162 | |
| 163 | private: |
| 164 | SkRefCnt** fRCArray; |
| 165 | int fRCCount; |
| 166 | |
| 167 | SkTypeface** fTFArray; |
| 168 | int fTFCount; |
| 169 | |
reed@google.com | 6bac947 | 2011-06-21 19:24:00 +0000 | [diff] [blame] | 170 | SkTDArray<SkFlattenable::Factory>* fFactoryTDArray; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 171 | SkFlattenable::Factory* fFactoryArray; |
| 172 | int fFactoryCount; |
| 173 | |
| 174 | typedef SkReader32 INHERITED; |
| 175 | }; |
| 176 | |
| 177 | /////////////////////////////////////////////////////////////////////////////// |
| 178 | |
| 179 | #include "SkPtrRecorder.h" |
| 180 | |
mike@reedtribe.org | e9e08cc | 2011-04-29 01:44:52 +0000 | [diff] [blame] | 181 | /** |
| 182 | * Subclass of SkTPtrSet specialed to call ref() and unref() when the |
| 183 | * base class's incPtr() and decPtr() are called. This makes it a valid owner |
| 184 | * of each ptr, which is released when the set is reset or destroyed. |
| 185 | */ |
| 186 | class SkRefCntSet : public SkTPtrSet<SkRefCnt*> { |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 187 | public: |
mike@reedtribe.org | e9e08cc | 2011-04-29 01:44:52 +0000 | [diff] [blame] | 188 | virtual ~SkRefCntSet(); |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 189 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 190 | protected: |
| 191 | // overrides |
| 192 | virtual void incPtr(void*); |
| 193 | virtual void decPtr(void*); |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 194 | }; |
| 195 | |
mike@reedtribe.org | e9e08cc | 2011-04-29 01:44:52 +0000 | [diff] [blame] | 196 | class SkFactorySet : public SkTPtrSet<SkFlattenable::Factory> {}; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 197 | |
| 198 | class SkFlattenableWriteBuffer : public SkWriter32 { |
| 199 | public: |
| 200 | SkFlattenableWriteBuffer(size_t minSize); |
| 201 | virtual ~SkFlattenableWriteBuffer(); |
| 202 | |
| 203 | void writeTypeface(SkTypeface*); |
| 204 | void writeRefCnt(SkRefCnt*); |
| 205 | void writeFunctionPtr(void*); |
| 206 | void writeFlattenable(SkFlattenable* flattenable); |
| 207 | |
mike@reedtribe.org | e9e08cc | 2011-04-29 01:44:52 +0000 | [diff] [blame] | 208 | SkRefCntSet* getTypefaceRecorder() const { return fTFSet; } |
| 209 | SkRefCntSet* setTypefaceRecorder(SkRefCntSet*); |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 210 | |
mike@reedtribe.org | e9e08cc | 2011-04-29 01:44:52 +0000 | [diff] [blame] | 211 | SkRefCntSet* getRefCntRecorder() const { return fRCSet; } |
| 212 | SkRefCntSet* setRefCntRecorder(SkRefCntSet*); |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 213 | |
mike@reedtribe.org | e9e08cc | 2011-04-29 01:44:52 +0000 | [diff] [blame] | 214 | SkFactorySet* getFactoryRecorder() const { return fFactorySet; } |
| 215 | SkFactorySet* setFactoryRecorder(SkFactorySet*); |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 216 | |
| 217 | enum Flags { |
reed@google.com | 6bac947 | 2011-06-21 19:24:00 +0000 | [diff] [blame] | 218 | kCrossProcess_Flag = 0x01, |
| 219 | /** |
| 220 | * Instructs the writer to inline Factory names as there are seen the |
| 221 | * first time (after that we store an index). The pipe code uses this. |
| 222 | */ |
| 223 | kInlineFactoryNames_Flag = 0x02, |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 224 | }; |
reed@google.com | 6bac947 | 2011-06-21 19:24:00 +0000 | [diff] [blame] | 225 | Flags getFlags() const { return (Flags)fFlags; } |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 226 | void setFlags(Flags flags) { fFlags = flags; } |
| 227 | |
reed@google.com | 6bac947 | 2011-06-21 19:24:00 +0000 | [diff] [blame] | 228 | bool isCrossProcess() const { |
| 229 | return SkToBool(fFlags & kCrossProcess_Flag); |
| 230 | } |
| 231 | bool inlineFactoryNames() const { |
| 232 | return SkToBool(fFlags & kInlineFactoryNames_Flag); |
| 233 | } |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 234 | |
| 235 | bool persistBitmapPixels() const { |
| 236 | return (fFlags & kCrossProcess_Flag) != 0; |
| 237 | } |
| 238 | |
| 239 | bool persistTypeface() const { return (fFlags & kCrossProcess_Flag) != 0; } |
| 240 | |
| 241 | private: |
reed@google.com | 6bac947 | 2011-06-21 19:24:00 +0000 | [diff] [blame] | 242 | uint32_t fFlags; |
| 243 | SkRefCntSet* fTFSet; |
| 244 | SkRefCntSet* fRCSet; |
| 245 | SkFactorySet* fFactorySet; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 246 | |
| 247 | typedef SkWriter32 INHERITED; |
| 248 | }; |
| 249 | |
| 250 | #endif |
| 251 | |