ppapi/c/ppb_console.h

   1 /* Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2  * Use of this source code is governed by a BSD-style license that can be
   3  * found in the LICENSE file.
   4  */
   5
   6 /* From ppb_console.idl modified Fri Nov 16 15:28:43 2012. */
   7
   8 #ifndef PPAPI_C_PPB_CONSOLE_H_
   9 #define PPAPI_C_PPB_CONSOLE_H_
  10
  11 #include "ppapi/c/pp_bool.h"
  12 #include "ppapi/c/pp_instance.h"
  13 #include "ppapi/c/pp_macros.h"
  14 #include "ppapi/c/pp_stdint.h"
  15 #include "ppapi/c/pp_var.h"
  16
  17 #define PPB_CONSOLE_INTERFACE_1_0 "PPB_Console;1.0"
  18 #define PPB_CONSOLE_INTERFACE PPB_CONSOLE_INTERFACE_1_0
  19
  20 /**
  21  * @file
  22  * This file defines the <code>PPB_Console</code> interface.
  23  */
  24
  25
  26 /**
  27  * @addtogroup Enums
  28  * @{
  29  */
  30 typedef enum {
  31   PP_LOGLEVEL_TIP = 0,
  32   PP_LOGLEVEL_LOG = 1,
  33   PP_LOGLEVEL_WARNING = 2,
  34   PP_LOGLEVEL_ERROR = 3
  35 } PP_LogLevel;
  36 PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_LogLevel, 4);
  37 /**
  38  * @}
  39  */
  40
  41 /**
  42  * @addtogroup Interfaces
  43  * @{
  44  */
  45 struct PPB_Console_1_0 {
  46   /**
  47    * Logs the given message to the JavaScript console associated with the
  48    * given plugin instance with the given logging level. The name of the plugin
  49    * issuing the log message will be automatically prepended to the message.
  50    * The value may be any type of Var.
  51    */
  52   void (*Log)(PP_Instance instance, PP_LogLevel level, struct PP_Var value);
  53   /**
  54    * Logs a message to the console with the given source information rather
  55    * than using the internal PPAPI plugin name. The name must be a string var.
  56    *
  57    * The regular log function will automatically prepend the name of your
  58    * plugin to the message as the "source" of the message. Some plugins may
  59    * wish to override this. For example, if your plugin is a Python
  60    * interpreter, you would want log messages to contain the source .py file
  61    * doing the log statement rather than have "python" show up in the console.
  62    */
  63   void (*LogWithSource)(PP_Instance instance,
  64                         PP_LogLevel level,
  65                         struct PP_Var source,
  66                         struct PP_Var value);
  67 };
  68
  69 typedef struct PPB_Console_1_0 PPB_Console;
  70 /**
  71  * @}
  72  */
  73
  74 #endif  /* PPAPI_C_PPB_CONSOLE_H_ */
  75