third_party/WebKit/Source/bindings/core/v8/V8DOMActivityLogger.h

/*
 * Copyright (C) 2009 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef V8DOMActivityLogger_h
#define V8DOMActivityLogger_h

#include "core/CoreExport.h"
#include "wtf/text/WTFString.h"
#include <memory>
#include <v8.h>

namespace blink {

class KURL;

class CORE_EXPORT V8DOMActivityLogger {
  USING_FAST_MALLOC(V8DOMActivityLogger);

 public:
  virtual ~V8DOMActivityLogger() {}

  virtual void logGetter(const String& apiName) {}
  virtual void logSetter(const String& apiName,
                         const v8::Local<v8::Value>& newValue) {}
  virtual void logMethod(const String& apiName,
                         int argc,
                         const v8::Local<v8::Value>* argv) {}
  virtual void logEvent(const String& eventName, int argc, const String* argv) {
  }

  // Associates a logger with the world identified by worldId (worlId may be 0
  // identifying the main world) and extension ID. Extension ID is used to
  // identify a logger for main world only (worldId == 0). If the world is not
  // a main world, an extension ID is ignored.
  //
  // A renderer process may host multiple extensions when the browser hits the
  // renderer process limit. In such case, we assign multiple extensions to
  // the same main world of a renderer process. In order to distinguish the
  // extensions and their activity loggers in the main world, we require an
  // extension ID. Otherwise, extension activities may be logged under
  // a wrong extension ID.
  static void setActivityLogger(int worldId,
                                const String&,
                                std::unique_ptr<V8DOMActivityLogger>);
  static V8DOMActivityLogger* activityLogger(int worldId,
                                             const String& extensionId);
  static V8DOMActivityLogger* activityLogger(int worldId, const KURL&);

  // Returns activity logger for current V8 context or 0.
  static V8DOMActivityLogger* currentActivityLogger();
  // Returns activity logger for current V8 context if the context belongs to
  // an isolated world or 0.
  static V8DOMActivityLogger* currentActivityLoggerIfIsolatedWorld();
};

}  // namespace blink

#endif  // V8DOMActivityLogger_h