Chrome Extensions chrome.experimental.offscreenTabs.* API implementation, docs, and test.

chrome/browser/extensions/extension_offscreen_tabs_module.h

+// Copyright (c) 2011 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 CHROME_BROWSER_EXTENSIONS_EXTENSION_OFFSCREEN_TABS_MODULE_H__
+#define CHROME_BROWSER_EXTENSIONS_EXTENSION_OFFSCREEN_TABS_MODULE_H__
+#pragma once
+
+#include <string>
+
+#include "chrome/browser/extensions/extension_function.h"
+#include "content/browser/tab_contents/tab_contents_observer.h"
+#include "content/common/notification_observer.h"
+#include "content/common/notification_registrar.h"
+
+class BackingStore;
+class Browser;
+class SkBitmap;
+class TabContents;
+class TabContentsWrapper;
+class TabStripModel;
+
+namespace base {
+class DictionaryValue;
+class ListValue;
+}
+
+class TabsEventManager : public NotificationObserver {

[jstritar, 2011/09/08 16:58:20]

Can you put a little comment above TabsEventManager and
OffscreenTabsEventManager describing what they do?

[jstritar, 2011/09/08 16:58:20]

It's a little difficult to follow the life cycle of an offscreen tab, since it's
spread throughout the whole file. What do you think of having an OffscreenTab
class that manages the life cycle of an offscreen tab?

 - creates the new TabContents, and configures it to be offscreen
 - registers for notifications of the TabContents during construction
 - unregisters for notifications during deconstruction
 - holds pointers to its TabContents* and the extension that created it

You should also be able to get rid of some of those maps then, like
TabIdToTabMap and TabIdToExtensionidMap, since each OffscreenTab can hold the
relevant data.

[alexbost, 2011/09/10 04:47:53]

Done.

[alexbost, 2011/09/10 04:47:53]

Done.

+ public:
+  TabsEventManager();
+  virtual ~TabsEventManager();
+  void RegisterForTabNotifications(const TabContents* contents);
+  void UnregisterForTabNotifications(const TabContents* contents);
+ private:
+  virtual void Observe(const int type,
+                       const NotificationSource& source,
+                       const NotificationDetails& details);

[sky, 2011/09/08 18:12:26]

Use OVERRIDE where appropriate.

[alexbost, 2011/09/10 04:47:53]

Done.

+  NotificationRegistrar registrar_;
+};
+class OffscreenTabsEventManager : public NotificationObserver {

[sky, 2011/09/08 18:12:26]

newlines between each class, DISALLOW_COPY_AND_ASSIGN for each class, and
newline between sections (33/34 above).

[alexbost, 2011/09/10 04:47:53]

Done.

+ public:
+  OffscreenTabsEventManager();
+  virtual ~OffscreenTabsEventManager();
+  void RegisterForTabNotifications(const TabContents* contents);
+  void UnregisterForTabNotifications(const TabContents* contents);
+ private:
+  virtual void Observe(const int type,
+                       const NotificationSource& source,
+                       const NotificationDetails& details);
+  NotificationRegistrar registrar_;
+};
+class CreateOffscreenTabFunction : public SyncExtensionFunction {
+ public:
+  CreateOffscreenTabFunction();
+  virtual ~CreateOffscreenTabFunction();
+  virtual bool RunImpl();
+  DECLARE_EXTENSION_FUNCTION_NAME("experimental.offscreenTabs.create")

[sky, 2011/09/08 18:12:26]

Should the DECLARE macro be in the private section?

[alexbost, 2011/09/10 04:47:53]

Done.

+};
+class GetOffscreenTabFunction : public SyncExtensionFunction {
+ public:
+  GetOffscreenTabFunction();
+  virtual ~GetOffscreenTabFunction();
+  virtual bool RunImpl();
+  DECLARE_EXTENSION_FUNCTION_NAME("experimental.offscreenTabs.get")
+};
+class GetAllOffscreenTabFunction : public SyncExtensionFunction {
+ public:
+  GetAllOffscreenTabFunction();
+  virtual ~GetAllOffscreenTabFunction();
+  virtual bool RunImpl();
+  DECLARE_EXTENSION_FUNCTION_NAME("experimental.offscreenTabs.getAll")
+};
+class RemoveOffscreenTabFunction : public SyncExtensionFunction {
+ public:
+  RemoveOffscreenTabFunction();
+  virtual ~RemoveOffscreenTabFunction();
+  virtual bool RunImpl();
+  DECLARE_EXTENSION_FUNCTION_NAME("experimental.offscreenTabs.remove")
+};
+class SendKeyboardEventOffscreenTabFunction : public SyncExtensionFunction {
+ public:
+  SendKeyboardEventOffscreenTabFunction();
+  virtual ~SendKeyboardEventOffscreenTabFunction();
+  virtual bool RunImpl();
+  DECLARE_EXTENSION_FUNCTION_NAME(
+    "experimental.offscreenTabs.sendKeyboardEvent")
+};
+class SendMouseEventOffscreenTabFunction : public SyncExtensionFunction {
+ public:
+  SendMouseEventOffscreenTabFunction();
+  virtual ~SendMouseEventOffscreenTabFunction();
+  virtual bool RunImpl();
+  DECLARE_EXTENSION_FUNCTION_NAME("experimental.offscreenTabs.sendMouseEvent")
+};
+class ToDataUrlOffscreenTabFunction : public AsyncExtensionFunction,
+                                      public NotificationObserver {
+ public:
+  ToDataUrlOffscreenTabFunction();
+  virtual ~ToDataUrlOffscreenTabFunction();
+  virtual bool RunImpl();
+  DECLARE_EXTENSION_FUNCTION_NAME("experimental.offscreenTabs.toDataUrl")
+ private:
+  enum ImageFormat {
+    FORMAT_JPEG,
+    FORMAT_PNG
+  };
+
+  // The default quality setting used when encoding jpegs.
+  static const int kDefaultQuality;
+  virtual bool CaptureSnapshotFromBackingStore(BackingStore* backing_store);
+  virtual void Observe(const int type,
+                       const NotificationSource& source,
+                       const NotificationDetails& details);
+  virtual void SendResultFromBitmap(const SkBitmap& screen_capture);
+
+  NotificationRegistrar registrar_;
+
+  // The format (JPEG vs PNG) of the resulting image.  Set in RunImpl().
+  ImageFormat image_format_;
+
+  // Quality setting to use when encoding jpegs.  Set in RunImpl().
+  int image_quality_;
+};
+class UpdateOffscreenTabFunction : public AsyncExtensionFunction,
+                                   public TabContentsObserver {
+ public:
+  UpdateOffscreenTabFunction();
+  virtual ~UpdateOffscreenTabFunction();
+  virtual bool RunImpl();
+  DECLARE_EXTENSION_FUNCTION_NAME("experimental.offscreenTabs.update")
+ private:
+  virtual bool OnMessageReceived(const IPC::Message& message);
+  void OnExecuteCodeFinished(int request_id,
+                             bool success,
+                             const std::string& error);
+};
+
+#endif  // CHROME_BROWSER_EXTENSIONS_EXTENSION_OFFSCREEN_TABS_MODULE_H__
+