third_party/WebKit/public/web/WebDOMActivityLogger.h

   1 /*
   2  * Copyright (C) 2009 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef WebDOMActivityLogger_h
  32 #define WebDOMActivityLogger_h
  33
  34 #include "../platform/WebCommon.h"
  35 #include "../platform/WebString.h"
  36 #include "../platform/WebURL.h"
  37 #include <v8.h>
  38
  39 namespace blink {
  40
  41 class WebDOMActivityLogger {
  42 public:
  43     virtual ~WebDOMActivityLogger() { }
  44
  45     virtual void logGetter(const WebString& apiName, const WebURL& url, const WebString& title) { }
  46     virtual void logSetter(const WebString& apiName, const v8::Local<v8::Value>& newValue, const WebURL& url, const WebString& title) { }
  47     virtual void logMethod(const WebString& apiName, int argc, const v8::Local<v8::Value>* argv, const WebURL& url, const WebString& title) { }
  48     virtual void logEvent(const WebString& eventName, int argc, const WebString* argv, const WebURL& url, const WebString& title) { }
  49 };
  50
  51 // Checks if a logger already exists for the world identified by worldId and
  52 // extensionID (worldId may be 0 identifying the main world). Extension ID is
  53 // used only in the case of main world and ignored otherwise.
  54 BLINK_EXPORT bool hasDOMActivityLogger(int worldId, const WebString& extensionId);
  55
  56 // Checks if the provided logger is non-null and if so associates it with the
  57 // world identified by worldId and extension ID (worldId may be 0 identifying
  58 // the main world). The extension ID is ignored for other worlds than the main
  59 // one.
  60 BLINK_EXPORT void setDOMActivityLogger(int worldId, const WebString& extensionId, WebDOMActivityLogger*);
  61
  62 } // namespace blink
  63
  64 #endif