Make rendering use PaintingNodes for increased efficiency.

sky/sdk/lib/rendering/object.dart

 // Copyright 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 import 'dart:math' as math;
 import 'dart:sky' as sky;
 import 'dart:sky' show Point, Offset, Size, Rect, Color, Paint, Path;
 
 import '../base/hit_test.dart';
 import '../base/node.dart';
 import '../base/scheduler.dart' as scheduler;
 
 export 'dart:sky' show Point, Offset, Size, Rect, Color, Paint, Path;
 export '../base/hit_test.dart' show HitTestTarget, HitTestEntry, HitTestResult;
 
 
 class ParentData {
   void detach() {
     detachSiblings();
   }
   void detachSiblings() { } // workaround for lack of inter-class mixins in Dart
   void merge(ParentData other) {
     // override this in subclasses to merge in data from other into this
     assert(other.runtimeType == this.runtimeType);
   }
   String toString() => '<none>';
 }
 
 class PaintingCanvas extends sky.Canvas {
-  PaintingCanvas(sky.PictureRecorder recorder, Size bounds) : super(recorder, bounds);
+  PaintingCanvas(sky.PictureRecorder recorder, Rect bounds) : super(recorder, bounds);
 
+  List<RenderObject> _descendentsWithPaintingCanvases = new List<RenderObject>(); // used by RenderObject._updatePaintingCanvas() to find out which RenderObjects to ask to paint
   void paintChild(RenderObject child, Point point) {
-    child.paint(this, point.toOffset());
+    if (child.createNewDisplayList) {
+      assert(!_descendentsWithPaintingCanvases.contains(child));
+      _descendentsWithPaintingCanvases.add(child);
+      drawPaintingNode(child._paintingNode, point);
+    } else {
+      child._paintOnCanvas(this, point.toOffset());
+    }
   }
 }
 
 abstract class Constraints {
   const Constraints();
   bool get isTight;
 }
 
 abstract class RenderObject extends AbstractNode implements HitTestTarget {
 
@@ skipping 88 matching lines @@
       _cleanRelayoutSubtreeRootChildren();
     }
   }
   void _cleanRelayoutSubtreeRootChildren() { } // workaround for lack of inter-class mixins in Dart
   void scheduleInitialLayout() {
     assert(attached);
     assert(parent == null);
     assert(_relayoutSubtreeRoot == null);
     _relayoutSubtreeRoot = this;
     _nodesNeedingLayout.add(this);
+    _nodesNeedingPaint.add(this);
     scheduler.ensureVisualUpdate();
   }
   static void flushLayout() {
     sky.tracing.begin('RenderObject.flushLayout');
     _debugDoingLayout = true;
     try {
       List<RenderObject> dirtyNodes = _nodesNeedingLayout;
       _nodesNeedingLayout = new List<RenderObject>();
       dirtyNodes..sort((a, b) => a.depth - b.depth)..forEach((node) {
         if (node._needsLayout && node.attached)
           node.layoutWithoutResize();
       });
     } finally {
       _debugDoingLayout = false;
       sky.tracing.end('RenderObject.flushLayout');
     }
   }
   void layoutWithoutResize() {
     try {
       assert(_relayoutSubtreeRoot == this);
       _debugCanParentUseSize = false;
       _debugDoingThisLayout = true;
       RenderObject debugPreviousActiveLayout = _debugActiveLayout;
       _debugActiveLayout = this;
       performLayout();
       _debugActiveLayout = debugPreviousActiveLayout;
       _debugDoingThisLayout = false;
       _debugCanParentUseSize = null;
-    } catch (e, stack) {
+    } catch (e) {
       print('Exception raised during layout:\n${e}\nContext:\n${this}');
-      print(stack);
       return;
     }
     _needsLayout = false;
     markNeedsPaint();
   }
   void layout(Constraints constraints, { bool parentUsesSize: false }) {
     final parent = this.parent; // TODO(ianh): Remove this once the analyzer is cleverer
     RenderObject relayoutSubtreeRoot;
     if (!parentUsesSize || sizedByParent || constraints.isTight || parent is! RenderObject)
       relayoutSubtreeRoot = this;
@@ skipping 49 matching lines @@
 
   void rotate({
     int oldAngle, // 0..3
     int newAngle, // 0..3
     Duration time
   }) { }
 
 
   // PAINTING
 
-  static bool debugDoingPaint = false;
+  static List<RenderObject> _nodesNeedingPaint = new List<RenderObject>();
+  static bool _debugDoingPaint = false;
+  static bool get debugDoingPaint => _debugDoingPaint;
+  static void set debugDoingPaint(bool debug) {
+    _debugDoingPaint = debug;
+  }
+
+  final sky.PaintingNode _paintingNode = new sky.PaintingNode();
+  sky.PaintingNode get paintingNode {
+    assert(createNewDisplayList);
+    return _paintingNode;
+  }
+  bool _needsPaint = true;
+  bool get needsPaint => _needsPaint;
+  bool get createNewDisplayList => false;
+
   void markNeedsPaint() {
     assert(!debugDoingPaint);
-    scheduler.ensureVisualUpdate();
+    if (!attached) return; // Don't try painting things that aren't in the hierarchy
+    if (_needsPaint) return;
+    if (createNewDisplayList) {
+      _needsPaint = true;
+      _nodesNeedingPaint.add(this);
+      scheduler.ensureVisualUpdate();
+    } else {
+      assert(parent != null); // parent always exists on this path because the root node is a RenderView, which sets createNewDisplayList.
+      if (parent is RenderObject) {
+        (parent as RenderObject).markNeedsPaint(); // TODO(ianh): remove the cast once the analyzer is cleverer
+      }
+    }
   }
+
+  static void flushPaint() {
+    try {
+      _debugDoingPaint = true;
+      List<RenderObject> dirtyNodes = _nodesNeedingPaint;
+      _nodesNeedingPaint = new List<RenderObject>();
+      for (RenderObject node in dirtyNodes..sort((a, b) => a.depth - b.depth)) {
+        if (node._needsPaint && node.attached)
+          node._updatePaintingCanvas();
+      };
+      assert(_nodesNeedingPaint.length == 0);
+    } catch (e) {
+      print('Exception raised during flushPaint:\n${e}');
+    } finally {
+      _debugDoingPaint = false;
+    }
+  }
+
+  void _updatePaintingCanvas() {
+    assert(!_needsLayout);
+    assert(createNewDisplayList);
+    sky.PictureRecorder recorder = new sky.PictureRecorder();
+    PaintingCanvas canvas = new PaintingCanvas(recorder, paintBounds);
+    _needsPaint = false;
+    try {
+      _paintOnCanvas(canvas, Offset.zero);
+    } catch (e) {
+      print('Exception raised during _updatePaintingCanvas:\n${e}\nContext:\n${this}');
+      return;
+    }
+    assert(!_needsLayout); // check that the paint() method didn't mark us dirty again
+    assert(!_needsPaint); // check that the paint() method didn't mark us dirty again
+    _paintingNode.setBackingDrawable(recorder.endRecordingAsDrawable());
+
+    if (canvas._descendentsWithPaintingCanvases != null) {
+      for (RenderObject node in canvas._descendentsWithPaintingCanvases) {
+        assert(node.attached == attached);
+        if (node._needsPaint)
+          node._updatePaintingCanvas();
+      };
+    }
+  }
+
+  void _paintOnCanvas(PaintingCanvas canvas, Offset offset) {
+    _needsPaint = false;
+    paint(canvas, offset);
+    assert(!_needsPaint);
+  }
+
+  Rect get paintBounds;
+
   void paint(PaintingCanvas canvas, Offset offset) { }
 
 
   // EVENTS
 
   void handleEvent(sky.Event event, HitTestEntry entry) {
     // override this if you have a client, to hand it to the client
     // override this if you want to do anything with the event
   }
 
@@ skipping 273 matching lines @@
     int count = 1;
     ChildType child = _firstChild;
     while (child != null) {
       result += '${prefix}child ${count}: ${child.toString(prefix)}';
       count += 1;
       child = child.parentData.nextSibling;
     }
     return result;
   }
 }