chromium/src/third_party/blink/public/web/web_dom_activity_logger.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 THIRD_PARTY_BLINK_PUBLIC_WEB_WEB_DOM_ACTIVITY_LOGGER_H_
#define THIRD_PARTY_BLINK_PUBLIC_WEB_WEB_DOM_ACTIVITY_LOGGER_H_

#include "third_party/blink/public/platform/web_common.h"
#include "third_party/blink/public/platform/web_string.h"
#include "third_party/blink/public/platform/web_url.h"
#include "v8/include/v8.h"

namespace blink {

class WebDOMActivityLogger {
 public:
  virtual ~WebDOMActivityLogger() = default;

  virtual void LogGetter(const WebString& api_name,
                         const WebURL& url,
                         const WebString& title) {}
  virtual void LogSetter(const WebString& api_name,
                         const v8::Local<v8::Value>& new_value,
                         const WebURL& url,
                         const WebString& title) {}
  virtual void LogMethod(const WebString& api_name,
                         int argc,
                         const v8::Local<v8::Value>* argv,
                         const WebURL& url,
                         const WebString& title) {}
  virtual void LogEvent(const WebString& event_name,
                        int argc,
                        const WebString* argv,
                        const WebURL& url,
                        const WebString& title) {}
};

// Checks if a logger already exists for the world identified by worldId and
// extensionID (worldId may be 0 identifying the main world). Extension ID is
// used only in the case of main world and ignored otherwise.
BLINK_EXPORT bool HasDOMActivityLogger(int32_t world_id,
                                       const WebString& extension_id);

// Checks if the provided logger is non-null and if so associates it with the
// world identified by worldId and extension ID (worldId may be 0 identifying
// the main world). The extension ID is ignored for other worlds than the main
// one.
BLINK_EXPORT void SetDOMActivityLogger(int32_t world_id,
                                       const WebString& extension_id,
                                       WebDOMActivityLogger*);

}  // namespace blink

#endif