cc: Add new RasterWorkerPool interface.

cc/resources/raster_worker_pool.h

 // Copyright 2013 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.
 
 #ifndef CC_RESOURCES_RASTER_WORKER_POOL_H_
 #define CC_RESOURCES_RASTER_WORKER_POOL_H_
 
+#include <vector>
+
 #include "cc/base/worker_pool.h"
+#include "cc/resources/resource_provider.h"
 
 namespace cc {
 class PicturePileImpl;
+class Resource;
+
+namespace internal {
+
+class CC_EXPORT RasterWorkerPoolTask
+    : public base::RefCounted<RasterWorkerPoolTask> {
+ public:
+  typedef std::vector<scoped_refptr<RasterWorkerPoolTask> > TaskVector;
+
+  virtual bool RunOnThread(uint8_t* buffer, unsigned thread_index) = 0;
+  virtual void DispatchCompletionCallback() = 0;
+
+  void DidRun();
+  bool HasFinishedRunning() const;
+  void DidComplete();
+  bool HasCompleted() const;
+
+  const Resource* resource() const { return resource_; }
+  const WorkerPoolTask::TaskVector& dependencies() const {
+    return dependencies_;
+  }
+
+ protected:
+  friend class base::RefCounted<RasterWorkerPoolTask>;
+
+  RasterWorkerPoolTask(const Resource* resource,
+                       WorkerPoolTask::TaskVector* dependencies);
+  virtual ~RasterWorkerPoolTask();
+
+ private:
+  bool did_run_;
+  bool did_complete_;
+  const Resource* resource_;
+  WorkerPoolTask::TaskVector dependencies_;
+};
+
+}  // namespace internal
+
+class CC_EXPORT RasterWorkerPoolClient {
+ public:
+  virtual void DidFinishDispatchingRasterWorkerPoolCompletionCallbacks() = 0;
+
+ protected:
+  virtual ~RasterWorkerPoolClient() {}
+};
 
 // A worker thread pool that runs raster tasks.
 class CC_EXPORT RasterWorkerPool : public WorkerPool {
  public:
   class Task {
    public:
-    typedef base::Callback<void(bool)> Reply;
+    class Set {
+     public:
+      typedef internal::WorkerPoolTask::TaskVector TaskVector;
 
-    // Highest priority task first. Order of execution is not guaranteed.
-    class Queue {
-     public:
-      Queue();
-      ~Queue();
+      Set();
+      ~Set();
 
-      bool empty() const { return tasks_.empty(); }
-
-      // Add task to the back of the queue.
-      void Append(const Task& task);
+      void Insert(const Task& task);
 
      private:
       friend class RasterWorkerPool;
 
-      internal::WorkerPoolTask::TaskVector tasks_;
+      TaskVector tasks_;
     };
 
     Task();
-    Task(const base::Closure& callback, const Reply& reply);
-    explicit Task(Queue* dependencies);
+    Task(const base::Closure& callback, const base::Closure& reply);
     ~Task();
 
     // Returns true if Task is null (doesn't refer to anything).
     bool is_null() const { return !internal_; }
 
     // Returns the Task into an uninitialized state.
     void Reset();
 
    protected:
     friend class RasterWorkerPool;
 
-    explicit Task(scoped_refptr<internal::WorkerPoolTask> internal);
-
     scoped_refptr<internal::WorkerPoolTask> internal_;
   };
 
-  class PictureTask : public Task {
+  class RasterTask {
    public:
-    typedef base::Callback<void(PicturePileImpl*)> Callback;
+    // Returns true if buffer was written to. False indicate that
+    // buffer is not needed to initialize the resource. A ResourceInitializer
+    // instance can use this to determine if an upload is necessary.
+    typedef base::Callback<bool(uint8_t*, PicturePileImpl*)> Callback;
 
-    PictureTask(PicturePileImpl* picture_pile,
-                const Callback& callback,
-                const Reply& reply,
-                Queue* dependencies);
+    // First callback parameter is true when task was canceled.
+    typedef base::Callback<void(bool)> Reply;
+
+    class Queue {
+     public:
+      typedef internal::RasterWorkerPoolTask::TaskVector TaskVector;
+
+      Queue();
+      ~Queue();
+
+      void Append(const RasterTask& task);
+
+     private:
+      friend class RasterWorkerPool;
+
+      TaskVector tasks_;
+    };
+
+    RasterTask();
+    RasterTask(PicturePileImpl* picture_pile,
+               const Resource* resource,
+               const Callback& callback,
+               const Reply& reply,
+               Task::Set* dependencies);
+    ~RasterTask();
+
+    // Returns true if Task is null (doesn't refer to anything).
+    bool is_null() const { return !internal_; }
+
+    // Returns the Task into an uninitialized state.
+    void Reset();
+
+   protected:
+    friend class RasterWorkerPool;
+
+    scoped_refptr<internal::RasterWorkerPoolTask> internal_;
   };
 
   virtual ~RasterWorkerPool();
 
-  static scoped_ptr<RasterWorkerPool> Create(size_t num_threads) {
-    return make_scoped_ptr(new RasterWorkerPool(num_threads));
-  }
+  void SetClient(RasterWorkerPoolClient* client);
 
   // Tells the worker pool to shutdown after canceling all previously
   // scheduled tasks. Reply callbacks are still guaranteed to run.
   virtual void Shutdown() OVERRIDE;
 
-  // Schedule running of |root| task and all its dependencies. Tasks
-  // previously scheduled but no longer needed to run |root| will be
-  // canceled unless already running. Once scheduled, reply callbacks
-  // are guaranteed to run for all tasks even if they later get
-  // canceled by another call to ScheduleTasks().
-  void ScheduleTasks(Task* root);
+  // Schedule running of raster tasks in |queue| and all dependencies.
+  // Previously scheduled tasks that are no longer needed to run
+  // raster tasks in |queue| will be canceled unless already running.
+  // Once scheduled, reply callbacks are guaranteed to run for all tasks
+  // even if they later get canceled by another call to ScheduleTasks().
+  virtual void ScheduleTasks(RasterTask::Queue* queue);
 
- private:
-  explicit RasterWorkerPool(size_t num_threads);
+  // Tells the raster worker pool to force any pending uploads for
+  // |resource_id| to complete. Returns true when successful.
+  virtual bool ForceUploadToComplete(ResourceProvider::ResourceId resource_id);
 
-  DISALLOW_COPY_AND_ASSIGN(RasterWorkerPool);
+ protected:
+  RasterWorkerPool(ResourceProvider* resource_provider, size_t num_threads);
+
+  void SetRasterTasks(RasterTask::Queue* queue);
+
+  ResourceProvider* resource_provider_;
+  RasterWorkerPoolClient* client_;
+  RasterTask::Queue::TaskVector raster_tasks_;
 };
 
 }  // namespace cc
 
 #endif  // CC_RESOURCES_RASTER_WORKER_POOL_H_