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

1 files changed, 45 insertions, 0 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_