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" |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 14 | |
commit-bot@chromium.org | 8b0e8ac | 2014-01-30 18:58:24 +0000 | [diff] [blame] | 15 | class SkReadBuffer; |
| 16 | class SkWriteBuffer; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 17 | |
caryclark@google.com | d26147a | 2011-12-15 14:16:43 +0000 | [diff] [blame] | 18 | #define SK_DEFINE_FLATTENABLE_REGISTRAR_ENTRY(flattenable) \ |
commit-bot@chromium.org | c0b7e10 | 2013-10-23 17:06:21 +0000 | [diff] [blame] | 19 | SkFlattenable::Registrar(#flattenable, flattenable::CreateProc, \ |
| 20 | flattenable::GetFlattenableType()); |
djsollen@google.com | a2ca41e | 2012-03-23 19:00:34 +0000 | [diff] [blame] | 21 | |
| 22 | #define SK_DECLARE_FLATTENABLE_REGISTRAR_GROUP() static void InitializeFlattenables(); |
| 23 | |
| 24 | #define SK_DEFINE_FLATTENABLE_REGISTRAR_GROUP_START(flattenable) \ |
| 25 | void flattenable::InitializeFlattenables() { |
| 26 | |
caryclark@google.com | d26147a | 2011-12-15 14:16:43 +0000 | [diff] [blame] | 27 | #define SK_DEFINE_FLATTENABLE_REGISTRAR_GROUP_END \ |
| 28 | } |
| 29 | |
djsollen@google.com | ba28d03 | 2012-03-26 17:57:35 +0000 | [diff] [blame] | 30 | #define SK_DECLARE_UNFLATTENABLE_OBJECT() \ |
robertphillips@google.com | c2eae47 | 2013-10-21 12:26:10 +0000 | [diff] [blame] | 31 | virtual Factory getFactory() const SK_OVERRIDE { return NULL; } |
djsollen@google.com | ba28d03 | 2012-03-26 17:57:35 +0000 | [diff] [blame] | 32 | |
| 33 | #define SK_DECLARE_PUBLIC_FLATTENABLE_DESERIALIZATION_PROCS(flattenable) \ |
robertphillips@google.com | c2eae47 | 2013-10-21 12:26:10 +0000 | [diff] [blame] | 34 | virtual Factory getFactory() const SK_OVERRIDE { return CreateProc; } \ |
commit-bot@chromium.org | 8b0e8ac | 2014-01-30 18:58:24 +0000 | [diff] [blame] | 35 | static SkFlattenable* CreateProc(SkReadBuffer& buffer) { \ |
djsollen@google.com | ba28d03 | 2012-03-26 17:57:35 +0000 | [diff] [blame] | 36 | return SkNEW_ARGS(flattenable, (buffer)); \ |
| 37 | } |
| 38 | |
commit-bot@chromium.org | c0b7e10 | 2013-10-23 17:06:21 +0000 | [diff] [blame] | 39 | /** For SkFlattenable derived objects with a valid type |
| 40 | This macro should only be used in base class objects in core |
| 41 | */ |
| 42 | #define SK_DEFINE_FLATTENABLE_TYPE(flattenable) \ |
| 43 | static Type GetFlattenableType() { \ |
| 44 | return k##flattenable##_Type; \ |
| 45 | } |
| 46 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 47 | /** \class SkFlattenable |
rmistry@google.com | fbfcd56 | 2012-08-23 18:09:54 +0000 | [diff] [blame] | 48 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 49 | SkFlattenable is the base class for objects that need to be flattened |
| 50 | into a data stream for either transport or as part of the key to the |
| 51 | font cache. |
| 52 | */ |
ctguil@chromium.org | 7ffb1b2 | 2011-03-15 21:27:08 +0000 | [diff] [blame] | 53 | class SK_API SkFlattenable : public SkRefCnt { |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 54 | public: |
commit-bot@chromium.org | c0b7e10 | 2013-10-23 17:06:21 +0000 | [diff] [blame] | 55 | enum Type { |
| 56 | kSkColorFilter_Type, |
| 57 | kSkDrawLooper_Type, |
| 58 | kSkImageFilter_Type, |
| 59 | kSkMaskFilter_Type, |
| 60 | kSkPathEffect_Type, |
| 61 | kSkPixelRef_Type, |
| 62 | kSkRasterizer_Type, |
| 63 | kSkShader_Type, |
commit-bot@chromium.org | 3339ac5 | 2014-05-22 02:55:59 +0000 | [diff] [blame^] | 64 | kSkUnitMapper_Type, |
commit-bot@chromium.org | c0b7e10 | 2013-10-23 17:06:21 +0000 | [diff] [blame] | 65 | kSkXfermode_Type, |
| 66 | }; |
| 67 | |
robertphillips@google.com | 15e9d3e | 2012-06-21 20:25:03 +0000 | [diff] [blame] | 68 | SK_DECLARE_INST_COUNT(SkFlattenable) |
| 69 | |
commit-bot@chromium.org | 8b0e8ac | 2014-01-30 18:58:24 +0000 | [diff] [blame] | 70 | typedef SkFlattenable* (*Factory)(SkReadBuffer&); |
rmistry@google.com | fbfcd56 | 2012-08-23 18:09:54 +0000 | [diff] [blame] | 71 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 72 | SkFlattenable() {} |
rmistry@google.com | fbfcd56 | 2012-08-23 18:09:54 +0000 | [diff] [blame] | 73 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 74 | /** Implement this to return a factory function pointer that can be called |
| 75 | to recreate your class given a buffer (previously written to by your |
| 76 | override of flatten(). |
| 77 | */ |
robertphillips@google.com | c2eae47 | 2013-10-21 12:26:10 +0000 | [diff] [blame] | 78 | virtual Factory getFactory() const = 0; |
rmistry@google.com | fbfcd56 | 2012-08-23 18:09:54 +0000 | [diff] [blame] | 79 | |
commit-bot@chromium.org | c0b7e10 | 2013-10-23 17:06:21 +0000 | [diff] [blame] | 80 | /** Returns the name of the object's class |
| 81 | */ |
| 82 | const char* getTypeName() const { return FactoryToName(getFactory()); } |
| 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); |
commit-bot@chromium.org | c0b7e10 | 2013-10-23 17:06:21 +0000 | [diff] [blame] | 86 | static bool NameToType(const char name[], Type* type); |
| 87 | |
| 88 | static void Register(const char name[], Factory, Type); |
djsollen@google.com | a2ca41e | 2012-03-23 19:00:34 +0000 | [diff] [blame] | 89 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 90 | class Registrar { |
| 91 | public: |
commit-bot@chromium.org | c0b7e10 | 2013-10-23 17:06:21 +0000 | [diff] [blame] | 92 | Registrar(const char name[], Factory factory, Type type) { |
| 93 | SkFlattenable::Register(name, factory, type); |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 94 | } |
| 95 | }; |
djsollen@google.com | a2ca41e | 2012-03-23 19:00:34 +0000 | [diff] [blame] | 96 | |
djsollen@google.com | 5492424 | 2012-03-29 15:18:04 +0000 | [diff] [blame] | 97 | /** Override this to write data specific to your subclass into the buffer, |
| 98 | being sure to call your super-class' version first. This data will later |
| 99 | be passed to your Factory function, returned by getFactory(). |
| 100 | */ |
commit-bot@chromium.org | 8b0e8ac | 2014-01-30 18:58:24 +0000 | [diff] [blame] | 101 | virtual void flatten(SkWriteBuffer&) const; |
| 102 | |
| 103 | protected: |
| 104 | SkFlattenable(SkReadBuffer&) {} |
caryclark@google.com | d26147a | 2011-12-15 14:16:43 +0000 | [diff] [blame] | 105 | |
| 106 | private: |
commit-bot@chromium.org | c0b7e10 | 2013-10-23 17:06:21 +0000 | [diff] [blame] | 107 | static void InitializeFlattenablesIfNeeded(); |
caryclark@google.com | 9d0c6ec | 2011-12-20 20:26:56 +0000 | [diff] [blame] | 108 | |
| 109 | friend class SkGraphics; |
robertphillips@google.com | 15e9d3e | 2012-06-21 20:25:03 +0000 | [diff] [blame] | 110 | |
| 111 | typedef SkRefCnt INHERITED; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 112 | }; |
| 113 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 114 | #endif |