blob: 43182a691f8ec1218e182a39d0520070b715917b [file] [log] [blame]
// Copyright 2013 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 CONTENT_PUBLIC_RENDERER_RENDER_FRAME_OBSERVER_H_
#define CONTENT_PUBLIC_RENDERER_RENDER_FRAME_OBSERVER_H_
#include <stdint.h>
#include "base/compiler_specific.h"
#include "base/macros.h"
#include "base/strings/string16.h"
#include "content/common/content_export.h"
#include "ipc/ipc_listener.h"
#include "ipc/ipc_sender.h"
#include "third_party/WebKit/public/platform/WebVector.h"
#include "third_party/WebKit/public/web/WebMeaningfulLayout.h"
#include "v8/include/v8.h"
namespace blink {
class WebFormElement;
class WebFrame;
class WebNode;
class WebString;
struct WebURLError;
}
namespace content {
class RendererPpapiHost;
class RenderFrame;
class RenderFrameImpl;
// Base class for objects that want to filter incoming IPCs, and also get
// notified of changes to the frame.
class CONTENT_EXPORT RenderFrameObserver : public IPC::Listener,
public IPC::Sender {
public:
// By default, observers will be deleted when the RenderFrame goes away. If
// they want to outlive it, they can override this function.
virtual void OnDestruct();
// Called when a Pepper plugin is created.
virtual void DidCreatePepperPlugin(RendererPpapiHost* host) {}
// Called when a load is explicitly stopped by the user or browser.
virtual void OnStop() {}
// Called when the RenderFrame visiblity is changed.
virtual void WasHidden() {}
virtual void WasShown() {}
// Called when associated widget is about to close.
virtual void WidgetWillClose() {}
// These match the Blink API notifications
virtual void DidCreateNewDocument() {}
virtual void DidCreateDocumentElement() {}
virtual void DidCommitProvisionalLoad(bool is_new_navigation,
bool is_same_page_navigation) {}
virtual void DidStartProvisionalLoad() {}
virtual void DidFailProvisionalLoad(const blink::WebURLError& error) {}
virtual void DidFinishLoad() {}
virtual void DidFinishDocumentLoad() {}
virtual void DidCreateScriptContext(v8::Local<v8::Context> context,
int extension_group,
int world_id) {}
virtual void WillReleaseScriptContext(v8::Local<v8::Context> context,
int world_id) {}
virtual void DidClearWindowObject() {}
virtual void DidChangeManifest() {}
virtual void DidChangeScrollOffset() {}
virtual void WillSendSubmitEvent(const blink::WebFormElement& form) {}
virtual void WillSubmitForm(const blink::WebFormElement& form) {}
virtual void DidMatchCSS(
const blink::WebVector<blink::WebString>& newly_matching_selectors,
const blink::WebVector<blink::WebString>& stopped_matching_selectors) {}
// Called before FrameWillClose, when this frame has been detached from the
// view, but has not been closed yet. This *will* be called when parent frames
// are closing. Since the frame is already detached from the DOM at this time
// it should not be inspected.
virtual void FrameDetached() {}
// Called when the frame will soon be closed. This is the last opportunity to
// send messages to the host (e.g., for clean-up, shutdown, etc.). This is
// *not* called on child frames when parent frames are being closed.
virtual void FrameWillClose() {}
// Called when we receive a console message from Blink for which we requested
// extra details (like the stack trace). |message| is the error message,
// |source| is the Blink-reported source of the error (either external or
// internal), and |stack_trace| is the stack trace of the error in a
// human-readable format (each frame is formatted as
// "\n at function_name (source:line_number:column_number)").
virtual void DetailedConsoleMessageAdded(const base::string16& message,
const base::string16& source,
const base::string16& stack_trace,
int32_t line_number,
int32_t severity_level) {}
// Called when an interesting (from document lifecycle perspective),
// compositor-driven layout had happened. This is a reasonable hook to use
// to inspect the document and layout information, since it is in a clean
// state and you won't accidentally force new layouts.
// The interestingness of layouts is explained in WebMeaningfulLayout.h.
virtual void DidMeaningfulLayout(blink::WebMeaningfulLayout layout_type) {}
// Called when a compositor frame has committed.
virtual void DidCommitCompositorFrame() {}
// Notifications when |PerformanceTiming| data becomes available
virtual void DidChangePerformanceTiming() {}
// Called when the focused node has changed to |node|.
virtual void FocusedNodeChanged(const blink::WebNode& node) {}
// IPC::Listener implementation.
bool OnMessageReceived(const IPC::Message& message) override;
// IPC::Sender implementation.
bool Send(IPC::Message* message) override;
RenderFrame* render_frame() const;
int routing_id() const { return routing_id_; }
protected:
explicit RenderFrameObserver(RenderFrame* render_frame);
~RenderFrameObserver() override;
private:
friend class RenderFrameImpl;
// This is called by the RenderFrame when it's going away so that this object
// can null out its pointer.
void RenderFrameGone();
RenderFrame* render_frame_;
// The routing ID of the associated RenderFrame.
int routing_id_;
DISALLOW_COPY_AND_ASSIGN(RenderFrameObserver);
};
} // namespace content
#endif // CONTENT_PUBLIC_RENDERER_RENDER_FRAME_OBSERVER_H_