Add a console interface for logging to the JS console from a PPAPI plugin.

TEST=manual
Review URL: http://codereview.chromium.org/6667010

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@77852 0039d316-1c4b-4281-b951-d872f2087c98

10 files changed, 234 insertions, 22 deletions

diff --git a/ppapi/c/dev/ppb_console_dev.h b/ppapi/c/dev/ppb_console_dev.h
new file mode 100644
index 0000000..da51dbe
--- /dev/null
+++ b/ppapi/c/dev/ppb_console_dev.h
@@ -0,0 +1,45 @@
+/* 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 PPAPI_C_DEV_PPB_CONSOLE_DEV_H_
+#define PPAPI_C_DEV_PPB_CONSOLE_DEV_H_
+
+#include "ppapi/c/pp_instance.h"
+#include "ppapi/c/pp_var.h"
+
+#define PPB_CONSOLE_DEV_INTERFACE "PPB_Console(Dev);0.1"
+
+typedef enum {
+  PP_LOGLEVEL_TIP = 0,
+  PP_LOGLEVEL_LOG,
+  PP_LOGLEVEL_WARNING,
+  PP_LOGLEVEL_ERROR
+} PP_LogLevel_Dev;
+
+struct PPB_Console_Dev {
+  /**
+   * Logs the given message to the JavaScript console associated with the
+   * given plugin instance with the given logging level. The name of the plugin
+   * issuing the log message will be automatically prepended to the message.
+   * The value may be any type of Var.
+   */
+  void (*Log)(PP_Instance instance, PP_LogLevel_Dev level, struct PP_Var value);
+
+  /**
+   * Logs a message to the console with the given source information rather
+   * than using the internal PPAPI plugin name. The name must be a string var.
+   *
+   * The regular log function will automatically prepend the name of your
+   * plugin to the message as the "source" of the message. Some plugins may
+   * wish to override this. For example, if your plugin is a Python
+   * interpreter, you would want log messages to contain the source .py file
+   * doing the log statement rather than have "python" show up in the console.
+   */
+  void (*LogWithSource)(PP_Instance instance,
+                        PP_LogLevel_Dev level,
+                        struct PP_Var source,
+                        struct PP_Var value);
+};
+
+#endif  // PPAPI_C_DEV_PPB_CONSOLE_DEV_H_
diff --git a/ppapi/example/example.cc b/ppapi/example/example.cc
index dc0230c..5529391 100644
--- a/ppapi/example/example.cc
+++ b/ppapi/example/example.cc
@@ -11,6 +11,7 @@
 
 #include <algorithm>
 
+#include "ppapi/c/dev/ppb_console_dev.h"
 #include "ppapi/c/dev/ppp_printing_dev.h"
 #include "ppapi/c/pp_errors.h"
 #include "ppapi/c/pp_input_event.h"
@@ -175,6 +176,14 @@ class MyInstance : public pp::Instance, public MyFetcherClient {
     return true;
   }
 
+  void Log(PP_LogLevel_Dev level, const pp::Var& value) {
+    const PPB_Console_Dev* console = reinterpret_cast<const PPB_Console_Dev*>(
+        pp::Module::Get()->GetBrowserInterface(PPB_CONSOLE_DEV_INTERFACE));
+    if (!console)
+      return;
+    console->Log(pp_instance(), level, value.pp_var());
+  }
+
   virtual bool HandleDocumentLoad(const pp::URLLoader& loader) {
     fetcher_ = new MyFetcher();
     fetcher_->StartWithOpenedLoader(loader, this);
@@ -184,7 +193,7 @@ class MyInstance : public pp::Instance, public MyFetcherClient {
   virtual bool HandleInputEvent(const PP_InputEvent& event) {
     switch (event.type) {
       case PP_INPUTEVENT_TYPE_MOUSEDOWN:
-        //SayHello();
+        SayHello();
         return true;
       case PP_INPUTEVENT_TYPE_MOUSEMOVE:
         return true;
@@ -242,6 +251,7 @@ class MyInstance : public pp::Instance, public MyFetcherClient {
   }
 
   virtual void DidChangeView(const pp::Rect& position, const pp::Rect& clip) {
+    Log(PP_LOGLEVEL_LOG, "DidChangeView");
     if (position.size().width() == width_ &&
         position.size().height() == height_)
       return;  // We don't care about the position, only the size.
@@ -342,18 +352,6 @@ class MyInstance : public pp::Instance, public MyFetcherClient {
   }
 
  private:
-  void Log(const pp::Var& var) {
-    pp::Var doc = GetWindowObject().GetProperty("document");
-    if (console_.is_undefined()) {
-      pp::Var body = doc.GetProperty("body");
-      console_ = doc.Call("createElement", "pre");
-      console_.GetProperty("style").SetProperty("backgroundColor", "lightgray");
-      body.Call("appendChild", console_);
-    }
-    console_.Call("appendChild", doc.Call("createTextNode", var));
-    console_.Call("appendChild", doc.Call("createTextNode", "\n"));
-  }
-
   void SayHello() {
     pp::Var window = GetWindowObject();
     pp::Var doc = window.GetProperty("document");
@@ -362,20 +360,20 @@ class MyInstance : public pp::Instance, public MyFetcherClient {
     pp::Var obj(this, new MyScriptableObject(this));
 
     // Our object should have its toString method called.
-    Log("Testing MyScriptableObject::toString():");
-    Log(obj);
+    Log(PP_LOGLEVEL_LOG, "Testing MyScriptableObject::toString():");
+    Log(PP_LOGLEVEL_LOG, obj);
 
     // body.appendChild(body) should throw an exception
-    Log("\nCalling body.appendChild(body):");
+    Log(PP_LOGLEVEL_LOG, "Calling body.appendChild(body):");
     pp::Var exception;
     body.Call("appendChild", body, &exception);
-    Log(exception);
+    Log(PP_LOGLEVEL_LOG, exception);
 
-    Log("\nEnumeration of window properties:");
+    Log(PP_LOGLEVEL_LOG, "Enumeration of window properties:");
     std::vector<pp::Var> props;
     window.GetAllPropertyNames(&props);
     for (size_t i = 0; i < props.size(); ++i)
-      Log(props[i]);
+      Log(PP_LOGLEVEL_LOG, props[i]);
 
     pp::Var location = window.GetProperty("location");
     pp::Var href = location.GetProperty("href");
@@ -387,11 +385,11 @@ class MyInstance : public pp::Instance, public MyFetcherClient {
   }
 
   void DidFetch(bool success, const std::string& data) {
-    Log("\nDownloaded location.href:");
+    Log(PP_LOGLEVEL_LOG, "Downloaded location.href:");
     if (success) {
-      Log(data);
+      Log(PP_LOGLEVEL_LOG, data);
     } else {
-      Log("Failed to download.");
+      Log(PP_LOGLEVEL_ERROR, "Failed to download.");
     }
     delete fetcher_;
     fetcher_ = NULL;
diff --git a/ppapi/ppapi_cpp.gypi b/ppapi/ppapi_cpp.gypi
index 0724961..adcf01a 100644
--- a/ppapi/ppapi_cpp.gypi
+++ b/ppapi/ppapi_cpp.gypi
@@ -51,6 +51,7 @@
         'c/dev/ppb_char_set_dev.h',
         'c/dev/ppb_context_3d_dev.h',
         'c/dev/ppb_context_3d_trusted_dev.h',
+        'c/dev/ppb_console_dev.h',
         'c/dev/ppb_cursor_control_dev.h',
         'c/dev/ppb_directory_reader_dev.h',
         'c/dev/ppb_file_chooser_dev.h',
diff --git a/ppapi/ppapi_shared_proxy.gypi b/ppapi/ppapi_shared_proxy.gypi
index 8c8a047..fb823e2 100644
--- a/ppapi/ppapi_shared_proxy.gypi
+++ b/ppapi/ppapi_shared_proxy.gypi
@@ -81,6 +81,8 @@
         'proxy/ppb_buffer_proxy.h',
         'proxy/ppb_char_set_proxy.cc',
         'proxy/ppb_char_set_proxy.h',
+        'proxy/ppb_console_proxy.cc',
+        'proxy/ppb_console_proxy.h',
         'proxy/ppb_context_3d_proxy.cc',
         'proxy/ppb_context_3d_proxy.h',
         'proxy/ppb_core_proxy.cc',
diff --git a/ppapi/proxy/dispatcher.cc b/ppapi/proxy/dispatcher.cc
index 391a882..156374d 100644
--- a/ppapi/proxy/dispatcher.cc
+++ b/ppapi/proxy/dispatcher.cc
@@ -47,6 +47,7 @@
 #include "ppapi/proxy/ppb_audio_proxy.h"
 #include "ppapi/proxy/ppb_buffer_proxy.h"
 #include "ppapi/proxy/ppb_char_set_proxy.h"
+#include "ppapi/proxy/ppb_console_proxy.h"
 #include "ppapi/proxy/ppb_context_3d_proxy.h"
 #include "ppapi/proxy/ppb_core_proxy.h"
 #include "ppapi/proxy/ppb_cursor_control_proxy.h"
@@ -105,6 +106,7 @@ InterfaceList::InterfaceList() {
   AddPPB(PPB_Audio_Proxy::GetInfo());
   AddPPB(PPB_Buffer_Proxy::GetInfo());
   AddPPB(PPB_CharSet_Proxy::GetInfo());
+  AddPPB(PPB_Console_Proxy::GetInfo());
   AddPPB(PPB_Context3D_Proxy::GetInfo());
   AddPPB(PPB_Core_Proxy::GetInfo());
   AddPPB(PPB_CursorControl_Proxy::GetInfo());
diff --git a/ppapi/proxy/interface_id.h b/ppapi/proxy/interface_id.h
index 5cf4ac3..ceeb7b3 100644
--- a/ppapi/proxy/interface_id.h
+++ b/ppapi/proxy/interface_id.h
@@ -17,6 +17,7 @@ enum InterfaceID {
   INTERFACE_ID_PPB_AUDIO_CONFIG,
   INTERFACE_ID_PPB_BUFFER,
   INTERFACE_ID_PPB_CHAR_SET,
+  INTERFACE_ID_PPB_CONSOLE,
   INTERFACE_ID_PPB_CONTEXT_3D,
   INTERFACE_ID_PPB_CORE,
   INTERFACE_ID_PPB_CURSORCONTROL,
diff --git a/ppapi/proxy/ppapi_messages_internal.h b/ppapi/proxy/ppapi_messages_internal.h
index 375e7d5..a417426 100644
--- a/ppapi/proxy/ppapi_messages_internal.h
+++ b/ppapi/proxy/ppapi_messages_internal.h
@@ -216,6 +216,17 @@ IPC_SYNC_MESSAGE_ROUTED2_2(PpapiHostMsg_PPBBuffer_Create,
                            pp::proxy::HostResource /* result_resource */,
                            int32_t /* result_shm_handle */)
 
+// PPB_Console.
+IPC_MESSAGE_ROUTED3(PpapiHostMsg_PPBConsole_Log,
+                    PP_Instance /* instance */,
+                    int /* log_level */,
+                    pp::proxy::SerializedVar /* value */)
+IPC_MESSAGE_ROUTED4(PpapiHostMsg_PPBConsole_LogWithSource,
+                    PP_Instance /* instance */,
+                    int /* log_level */,
+                    pp::proxy::SerializedVar /* soruce */,
+                    pp::proxy::SerializedVar /* value */)
+
 // PPB_Context3D.
 IPC_SYNC_MESSAGE_ROUTED3_1(PpapiHostMsg_PPBContext3D_Create,
                            PP_Instance /* instance */,
diff --git a/ppapi/proxy/ppb_console_proxy.cc b/ppapi/proxy/ppb_console_proxy.cc
new file mode 100644
index 0000000..a04aacc
--- /dev/null
+++ b/ppapi/proxy/ppb_console_proxy.cc
@@ -0,0 +1,103 @@
+// 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.
+
+#include "ppapi/proxy/ppb_console_proxy.h"
+
+#include "ppapi/c/dev/ppb_console_dev.h"
+#include "ppapi/proxy/plugin_dispatcher.h"
+#include "ppapi/proxy/ppapi_messages.h"
+
+namespace pp {
+namespace proxy {
+
+namespace {
+
+void Log(PP_Instance instance, PP_LogLevel_Dev level, PP_Var value) {
+  PluginDispatcher* dispatcher = PluginDispatcher::GetForInstance(instance);
+  if (!dispatcher)
+    return;
+  dispatcher->Send(new PpapiHostMsg_PPBConsole_Log(
+      INTERFACE_ID_PPB_CONSOLE, instance, static_cast<int>(level),
+      SerializedVarSendInput(dispatcher, value)));
+}
+
+void LogWithSource(PP_Instance instance,
+                   PP_LogLevel_Dev level,
+                   const PP_Var source,
+                   const PP_Var value) {
+  PluginDispatcher* dispatcher = PluginDispatcher::GetForInstance(instance);
+  if (!dispatcher)
+    return;
+  dispatcher->Send(new PpapiHostMsg_PPBConsole_LogWithSource(
+      INTERFACE_ID_PPB_CONSOLE, instance, static_cast<int>(level),
+      SerializedVarSendInput(dispatcher, source),
+      SerializedVarSendInput(dispatcher, value)));
+}
+
+const PPB_Console_Dev console_interface = {
+  &Log,
+  &LogWithSource
+};
+
+InterfaceProxy* CreateConsoleProxy(Dispatcher* dispatcher,
+                                   const void* target_interface) {
+  return new PPB_Console_Proxy(dispatcher, target_interface);
+}
+
+}  // namespace
+
+PPB_Console_Proxy::PPB_Console_Proxy(Dispatcher* dispatcher,
+                                     const void* target_interface)
+    : InterfaceProxy(dispatcher, target_interface) {
+}
+
+PPB_Console_Proxy::~PPB_Console_Proxy() {
+}
+
+// static
+const InterfaceProxy::Info* PPB_Console_Proxy::GetInfo() {
+  static const Info info = {
+    &console_interface,
+    PPB_CONSOLE_DEV_INTERFACE,
+    INTERFACE_ID_PPB_CONSOLE,
+    false,
+    &CreateConsoleProxy,
+  };
+  return &info;
+}
+
+bool PPB_Console_Proxy::OnMessageReceived(const IPC::Message& msg) {
+  bool handled = true;
+  IPC_BEGIN_MESSAGE_MAP(PPB_Console_Proxy, msg)
+    IPC_MESSAGE_HANDLER(PpapiHostMsg_PPBConsole_Log,
+                        OnMsgLog)
+    IPC_MESSAGE_HANDLER(PpapiHostMsg_PPBConsole_LogWithSource,
+                        OnMsgLogWithSource)
+    IPC_MESSAGE_UNHANDLED(handled = false)
+  IPC_END_MESSAGE_MAP()
+  return handled;
+}
+
+void PPB_Console_Proxy::OnMsgLog(PP_Instance instance,
+                                 int log_level,
+                                 SerializedVarReceiveInput value) {
+  ppb_console_target()->Log(instance,
+                            static_cast<PP_LogLevel_Dev>(log_level),
+                            value.Get(dispatcher()));
+}
+
+void PPB_Console_Proxy::OnMsgLogWithSource(PP_Instance instance,
+                                           int log_level,
+                                           SerializedVarReceiveInput source,
+                                           SerializedVarReceiveInput value) {
+  ppb_console_target()->LogWithSource(
+      instance,
+      static_cast<PP_LogLevel_Dev>(log_level),
+      source.Get(dispatcher()),
+      value.Get(dispatcher()));
+}
+
+}  // namespace proxy
+}  // namespace pp
+
diff --git a/ppapi/proxy/ppb_console_proxy.h b/ppapi/proxy/ppb_console_proxy.h
new file mode 100644
index 0000000..af1c9e0
--- /dev/null
+++ b/ppapi/proxy/ppb_console_proxy.h
@@ -0,0 +1,48 @@
+// 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 PPAPI_PROXY_PPB_CONSOLE_PROXY_H_
+#define PPAPI_PROXY_PPB_CONSOLE_PROXY_H_
+
+#include "base/basictypes.h"
+#include "ppapi/c/pp_instance.h"
+#include "ppapi/proxy/interface_proxy.h"
+#include "ppapi/proxy/serialized_var.h"
+
+struct PPB_Console_Dev;
+
+namespace pp {
+namespace proxy {
+
+class PPB_Console_Proxy : public InterfaceProxy {
+ public:
+  PPB_Console_Proxy(Dispatcher* dispatcher, const void* target_interface);
+  virtual ~PPB_Console_Proxy();
+
+  static const Info* GetInfo();
+
+  const PPB_Console_Dev* ppb_console_target() const {
+    return static_cast<const PPB_Console_Dev*>(target_interface());
+  }
+
+  // InterfaceProxy implementation.
+  virtual bool OnMessageReceived(const IPC::Message& msg);
+
+ private:
+  // Message handlers.
+  void OnMsgLog(PP_Instance instance,
+                int log_level,
+                SerializedVarReceiveInput value);
+  void OnMsgLogWithSource(PP_Instance instance,
+                          int log_level,
+                          SerializedVarReceiveInput source,
+                          SerializedVarReceiveInput value);
+
+  DISALLOW_COPY_AND_ASSIGN(PPB_Console_Proxy);
+};
+
+}  // namespace proxy
+}  // namespace pp
+
+#endif  // PPAPI_PROXY_PPB_CONSOLE_PROXY_H_
diff --git a/ppapi/tests/all_c_includes.h b/ppapi/tests/all_c_includes.h
index 86c2925..09ca217 100644
--- a/ppapi/tests/all_c_includes.h
+++ b/ppapi/tests/all_c_includes.h
@@ -15,6 +15,7 @@
 #include "ppapi/c/dev/pp_video_dev.h"
 #include "ppapi/c/dev/ppb_buffer_dev.h"
 #include "ppapi/c/dev/ppb_char_set_dev.h"
+#include "ppapi/c/dev/ppb_console_dev.h"
 #include "ppapi/c/dev/ppb_context_3d_dev.h"
 #include "ppapi/c/dev/ppb_context_3d_trusted_dev.h"
 #include "ppapi/c/dev/ppb_cursor_control_dev.h"