src/third_party/WebKit/Source/core/inspector/PageDebuggerAgent.h

   1 /*
   2  * Copyright (C) 2011 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 PageDebuggerAgent_h
  32 #define PageDebuggerAgent_h
  33
  34 #include "bindings/core/v8/PageScriptDebugServer.h"
  35 #include "core/inspector/InspectorDebuggerAgent.h"
  36 #include "core/inspector/InspectorOverlayHost.h"
  37
  38 namespace blink {
  39
  40 class DocumentLoader;
  41 class InspectorOverlay;
  42 class InspectorPageAgent;
  43 class PageScriptDebugServer;
  44
  45 class PageDebuggerAgent final
  46     : public InspectorDebuggerAgent
  47     , public InspectorOverlayHost::Listener {
  48     WTF_MAKE_NONCOPYABLE(PageDebuggerAgent);
  49     WTF_MAKE_FAST_ALLOCATED_WILL_BE_REMOVED;
  50     WILL_BE_USING_GARBAGE_COLLECTED_MIXIN(PageDebuggerAgent);
  51 public:
  52     static PassOwnPtrWillBeRawPtr<PageDebuggerAgent> create(PageScriptDebugServer*, InspectorPageAgent*, InjectedScriptManager*, InspectorOverlay*);
  53     virtual ~PageDebuggerAgent();
  54     virtual void trace(Visitor*) override;
  55
  56     void didClearDocumentOfWindowObject(LocalFrame*);
  57     void didCommitLoad(LocalFrame*, DocumentLoader*);
  58
  59 protected:
  60     virtual void enable() override;
  61     virtual void disable() override;
  62
  63 private:
  64     virtual void startListeningScriptDebugServer() override;
  65     virtual void stopListeningScriptDebugServer() override;
  66     virtual PageScriptDebugServer& scriptDebugServer() override;
  67     virtual void muteConsole() override;
  68     virtual void unmuteConsole() override;
  69
  70     // InspectorOverlayHost::Listener implementation.
  71     virtual void overlayResumed() override;
  72     virtual void overlaySteppedOver() override;
  73
  74     virtual InjectedScript injectedScriptForEval(ErrorString*, const int* executionContextId) override;
  75     virtual void setOverlayMessage(ErrorString*, const String*) override;
  76
  77     PageDebuggerAgent(PageScriptDebugServer*, InspectorPageAgent*, InjectedScriptManager*, InspectorOverlay*);
  78     // FIXME: Oilpan: Move PageScriptDebugServer to heap in follow-up CL.
  79     PageScriptDebugServer* m_pageScriptDebugServer;
  80     RawPtrWillBeMember<InspectorPageAgent> m_pageAgent;
  81     InspectorOverlay* m_overlay;
  82 };
  83
  84 } // namespace blink
  85
  86
  87 #endif // !defined(PageDebuggerAgent_h)