SkRemote: add xfermodes

src/core/SkRemote.h

 /*
  * Copyright 2015 Google Inc.
  *
  * Use of this source code is governed by a BSD-style license that can be
  * found in the LICENSE file.
  */
 
 #ifndef SkRemote_DEFINED
 #define SkRemote_DEFINED
 
@@ skipping 27 matching lines @@
     };
 
     // TODO: document
     struct Encoder {
         virtual ~Encoder() {}
 
         virtual void define(ID, const SkMatrix&) = 0;
         virtual void define(ID, const Misc&)     = 0;
         virtual void define(ID, const SkPath&)   = 0;
         virtual void define(ID, const Stroke&)   = 0;
+        virtual void define(ID, SkXfermode*)     = 0;
 
         virtual void undefine(ID) = 0;
 
         virtual void    save() = 0;
         virtual void restore() = 0;
 
         virtual void setMatrix(ID matrix) = 0;
 
-        virtual void   clipPath(ID path, SkRegion::Op, bool aa) = 0;
-        virtual void   fillPath(ID path, ID misc)               = 0;
-        virtual void strokePath(ID path, ID misc, ID stroke)    = 0;
+        // TODO: struct CommonIDs { ID misc; ID xfermode; ... }
+        // for IDs that affect both fill + stroke?
+
+        virtual void   clipPath(ID path, SkRegion::Op, bool aa)           = 0;
+        virtual void   fillPath(ID path, ID misc, ID xfermode)            = 0;
+        virtual void strokePath(ID path, ID misc, ID xfermode, ID stroke) = 0;
     };
 
     class LookupScope;
 
-    // TODO: document
+    // The Cache interface encapsulates the caching logic of the Client.
+    //
+    // Each lookup() method must always fill ID* with a valid value,
+    // but ID may be cached.  If so, the lookup() method returns true;
+    // if not the lookup() method returns false and the Client must
+    // then define() this ID -> Thing mapping before using the ID.
+    //
+    // The Caches may also add IDs to the LookupScope's list of IDs to
+    // undefine() on destruction.  This lets the Cache purge IDs.
     struct Cache {
         virtual ~Cache() {}
 
-        static Cache* CreateNeverCache();
-        static Cache* CreateAlwaysCache();
+        static Cache* CreateNeverCache();   // Never caches anything.
+        static Cache* CreateAlwaysCache();  // Caches by value (not deep pointer equality).
+        // TODO: static Cache* CreateDeepCache();  // Caches by deep value.
 
-        virtual bool lookup(const SkMatrix&, ID*, LookupScope*) = 0;
-        virtual bool lookup(const Misc&,     ID*, LookupScope*) = 0;
-        virtual bool lookup(const SkPath&,   ID*, LookupScope*) = 0;
-        virtual bool lookup(const Stroke&,   ID*, LookupScope*) = 0;
+        virtual bool lookup(const SkMatrix&,   ID*, LookupScope*) = 0;
+        virtual bool lookup(const Misc&,       ID*, LookupScope*) = 0;
+        virtual bool lookup(const SkPath&,     ID*, LookupScope*) = 0;
+        virtual bool lookup(const Stroke&,     ID*, LookupScope*) = 0;
+        virtual bool lookup(const SkXfermode*, ID*, LookupScope*) = 0;
 
         virtual void cleanup(Encoder*) = 0;
     };
 
     // TODO: document
     class Client final : public SkCanvas {
     public:
         Client(Cache*, Encoder*);
         ~Client();
 
@@ skipping 29 matching lines @@
     // TODO: document
     class Server final : public Encoder {
     public:
         explicit Server(SkCanvas*);
 
     private:
         void define(ID, const SkMatrix&) override;
         void define(ID, const Misc&)     override;
         void define(ID, const SkPath&)   override;
         void define(ID, const Stroke&)   override;
+        void define(ID, SkXfermode*)     override;
 
         void undefine(ID) override;
 
         void    save() override;
         void restore() override;
 
         void setMatrix(ID matrix) override;
 
-        void   clipPath(ID path, SkRegion::Op, bool aa) override;
-        void   fillPath(ID path, ID misc) override;
-        void strokePath(ID path, ID misc, ID stroke) override;
+        void   clipPath(ID path, SkRegion::Op, bool aa)           override;
+        void   fillPath(ID path, ID misc, ID xfermode)            override;
+        void strokePath(ID path, ID misc, ID xfermode, ID stroke) override;
 
+        // Maps ID -> T.
         template <typename T, Type kType>
         class IDMap {
         public:
+            ~IDMap() {
+                // A well-behaved client always cleans up its definitions.
+                SkASSERT(fMap.count() == 0);
+            }
+
             void set(const ID& id, const T& val) {
                 SkASSERT(id.type() == kType);
                 fMap.set(id, val);
             }
 
             void remove(const ID& id) {
                 SkASSERT(id.type() == kType);
                 fMap.remove(id);
             }
 
             const T& find(const ID& id) const {
                 SkASSERT(id.type() == kType);
                 T* val = fMap.find(id);
                 SkASSERT(val != nullptr);
                 return *val;
             }
 
         private:
             SkTHashMap<ID, T> fMap;
         };
 
-        IDMap<SkMatrix, Type::kMatrix> fMatrix;
-        IDMap<Misc    , Type::kMisc  > fMisc;
-        IDMap<SkPath  , Type::kPath  > fPath;
-        IDMap<Stroke  , Type::kStroke> fStroke;
+        // Maps ID -> T*, and keeps the T alive by reffing it.
+        template <typename T, Type kType>
+        class ReffedIDMap {
+        public:
+            ReffedIDMap() {
+                // A null ID always maps to nullptr.
+                fMap.set(ID(kType), nullptr);
+            }
+            ~ReffedIDMap() {
+                // A well-behaved client always cleans up its definitions.
+                SkASSERT(fMap.count() == 1);
+            }
+
+            void set(const ID& id, T* val) {
+                SkASSERT(id.type() == kType && val);
+                fMap.set(id, SkRef(val));
+            }
+
+            void remove(const ID& id) {
+                SkASSERT(id.type() == kType);
+                T** val = fMap.find(id);
+                SkASSERT(val && *val);
+                (*val)->unref();
+                fMap.remove(id);
+            }
+
+            T* find(const ID& id) const {
+                SkASSERT(id.type() == kType);
+                T** val = fMap.find(id);
+                SkASSERT(val);
+                return *val;
+            }
+
+        private:
+            SkTHashMap<ID, T*> fMap;
+        };
+
+        IDMap<SkMatrix, Type::kMatrix>           fMatrix;
+        IDMap<Misc    , Type::kMisc  >           fMisc;
+        IDMap<SkPath  , Type::kPath  >           fPath;
+        IDMap<Stroke  , Type::kStroke>           fStroke;
+        ReffedIDMap<SkXfermode, Type::kXfermode> fXfermode;
 
         SkCanvas* fCanvas;
     };
 
 }  // namespace SkRemote
 
 #endif//SkRemote_DEFINED