[WIP] Add Context to SkDrawLooper.

include/core/SkDrawLooper.h

 
 /*
  * Copyright 2011 The Android Open Source Project
  *
  * Use of this source code is governed by a BSD-style license that can be
  * found in the LICENSE file.
  */
 
 
 #ifndef SkDrawLooper_DEFINED
 #define SkDrawLooper_DEFINED
 
 #include "SkFlattenable.h"
+#include "SkSmallAllocator.h"
 
 class SkCanvas;
 class SkPaint;
 struct SkRect;
 class SkString;
 
 /** \class SkDrawLooper
     Subclasses of SkDrawLooper can be attached to a SkPaint. Where they are,
     and something is drawn to a canvas with that paint, the looper subclass will
     be called, allowing it to modify the canvas and/or paint for that draw call.
     More than that, via the next() method, the looper can modify the draw to be
     invoked multiple times (hence the name loop-er), allow it to perform effects
     like shadows or frame/fills, that require more than one pass.
 */
 class SK_API SkDrawLooper : public SkFlattenable {
 public:
     SK_DECLARE_INST_COUNT(SkDrawLooper)
 
     /**
-     *  Called right before something is being drawn. This will be followed by
-     *  calls to next() until next() returns false.
+     *  Holds state during a draw. Users call next() until it returns false.
+     *  When the context is no longer needed, call cleanup() to ensure memory
+     *  is released correctly.
+     *
+     *  Subclasses of SkDrawLooper should create a subclass of this object to
+     *  hold state specific to their subclass.
      */
-    virtual void init(SkCanvas*) = 0;
+    class SK_API Context : public SkNoncopyable {
+    public:
+        Context() {}
+        virtual ~Context() {}
+
+        /**
+         *  Called in a loop (after init()). Each time true is returned, the
+         *  object is drawn (possibly with a modified canvas and/or paint). When
+         *  false is finally returned, drawing for the object stops.
+         *
+         *  On each call, the paint will be in its original state, but the
+         *  canvas will be as it was following the previous call to next() or
+         *  init().
+         *
+         *  The implementation must ensure that, when next() finally returns
+         *  false, that the canvas has been restored to the state it was
+         *  initially, before init() was first called.
+         */
+        virtual bool next(SkCanvas* canvas, SkPaint* paint) = 0;
+    };
 
     /**
-     *  Called in a loop (after init()). Each time true is returned, the object
-     *  is drawn (possibly with a modified canvas and/or paint). When false is
-     *  finally returned, drawing for the object stops.
-     *
-     *  On each call, the paint will be in its original state, but the canvas
-     *  will be as it was following the previous call to next() or init().
-     *
-     *  The implementation must ensure that, when next() finally returns false,
-     *  that the canvas has been restored to the state it was initially, before
-     *  init() was first called.
+      *  Provide enough space for largest draw looper context.
+      */
+    typedef SkSmallAllocator<1, 2 * SkAlign8(sizeof(void*) + sizeof(int))> ContextAllocator;

[Dominik Grewe, 2014/03/10 18:52:03]

This isn't particularly elegant because of the fixed maximum size for the
allocator. But I don't see another way that doesn't require exposing
SkSmallAllocator's template parameters to the user (and I think we'd have to
expose them for SkDrawLooper itself).

+
+    /**
+     *  Called right before something is being drawn. Returns a Context
+     *  whose next() method should be called until it returns false.
      */
-    virtual bool next(SkCanvas*, SkPaint* paint) = 0;
+    virtual Context* init(SkCanvas*, ContextAllocator*)
+        const = 0;
+
 
     /**
      * The fast bounds functions are used to enable the paint to be culled early
      * in the drawing pipeline. If a subclass can support this feature it must
      * return true for the canComputeFastBounds() function.  If that function
      * returns false then computeFastBounds behavior is undefined otherwise it
      * is expected to have the following behavior. Given the parent paint and
      * the parent's bounding rect the subclass must fill in and return the
      * storage rect, where the storage rect is with the union of the src rect
      * and the looper's bounding rect.
      */
     virtual bool canComputeFastBounds(const SkPaint& paint);
     virtual void computeFastBounds(const SkPaint& paint,
                                    const SkRect& src, SkRect* dst);
 
     SkDEVCODE(virtual void toString(SkString* str) const = 0;)
     SK_DEFINE_FLATTENABLE_TYPE(SkDrawLooper)
 
 protected:
     SkDrawLooper() {}
     SkDrawLooper(SkReadBuffer& buffer) : INHERITED(buffer) {}
 
 private:
     typedef SkFlattenable INHERITED;
 };
 
 #endif