Source/WebCore/inspector/InspectorAgent.h

   1 /*
   2  * Copyright (C) 2007, 2008, 2009, 2010 Apple Inc. All rights reserved.
   3  * Copyright (C) 2011 Google Inc. All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * 1.  Redistributions of source code must retain the above copyright
  10  *     notice, this list of conditions and the following disclaimer.
  11  * 2.  Redistributions in binary form must reproduce the above copyright
  12  *     notice, this list of conditions and the following disclaimer in the
  13  *     documentation and/or other materials provided with the distribution.
  14  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  15  *     its contributors may be used to endorse or promote products derived
  16  *     from this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #ifndef InspectorAgent_h
  31 #define InspectorAgent_h
  32
  33 #include "InspectorBaseAgent.h"
  34 #include "PlatformString.h"
  35 #include <wtf/Forward.h>
  36 #include <wtf/HashMap.h>
  37 #include <wtf/PassOwnPtr.h>
  38 #include <wtf/Vector.h>
  39
  40 namespace WebCore {
  41
  42 class DOMWrapperWorld;
  43 class DocumentLoader;
  44 class Frame;
  45 class InjectedScriptManager;
  46 class InspectorFrontend;
  47 class InspectorObject;
  48 class InspectorWorkerResource;
  49 class InstrumentingAgents;
  50 class KURL;
  51 class Page;
  52
  53 typedef String ErrorString;
  54
  55 class InspectorAgent : public InspectorBaseAgent<InspectorAgent> {
  56     WTF_MAKE_NONCOPYABLE(InspectorAgent);
  57 public:
  58     static PassOwnPtr<InspectorAgent> create(Page* page, InjectedScriptManager* injectedScriptManager, InstrumentingAgents* instrumentingAgents, InspectorState* state)
  59     {
  60         return adoptPtr(new InspectorAgent(page, injectedScriptManager, instrumentingAgents, state));
  61     }
  62
  63     virtual ~InspectorAgent();
  64
  65     bool developerExtrasEnabled() const;
  66
  67     // Inspector front-end API.
  68     void enable(ErrorString*);
  69     void disable(ErrorString*);
  70
  71     KURL inspectedURL() const;
  72     KURL inspectedURLWithoutFragment() const;
  73
  74     InspectorFrontend* frontend() const { return m_frontend; }
  75
  76     virtual void setFrontend(InspectorFrontend*);
  77     virtual void clearFrontend();
  78
  79     void didClearWindowObjectInWorld(Frame*, DOMWrapperWorld*);
  80
  81     void didCommitLoad();
  82     void domContentLoadedEventFired();
  83     void emitCommitLoadIfNeeded();
  84
  85 #if ENABLE(WORKERS)
  86     enum WorkerAction { WorkerCreated, WorkerDestroyed };
  87
  88     void postWorkerNotificationToFrontend(const InspectorWorkerResource&, WorkerAction);
  89     void didCreateWorker(intptr_t, const String& url, bool isSharedWorker);
  90     void didDestroyWorker(intptr_t);
  91 #endif
  92
  93     bool hasFrontend() const { return m_frontend; }
  94
  95     // Generic code called from custom implementations.
  96     void evaluateForTestInFrontend(long testCallId, const String& script);
  97
  98     void setInspectorExtensionAPI(const String& source);
  99
 100     void inspect(PassRefPtr<InspectorObject> objectToInspect, PassRefPtr<InspectorObject> hints);
 101
 102 private:
 103     InspectorAgent(Page*, InjectedScriptManager*, InstrumentingAgents*, InspectorState*);
 104
 105     void unbindAllResources();
 106
 107 #if ENABLE(JAVASCRIPT_DEBUGGER)
 108     void toggleRecordButton(bool);
 109 #endif
 110
 111     bool isMainResourceLoader(DocumentLoader*, const KURL& requestUrl);
 112
 113     Page* m_inspectedPage;
 114     InspectorFrontend* m_frontend;
 115     InjectedScriptManager* m_injectedScriptManager;
 116
 117     Vector<pair<long, String> > m_pendingEvaluateTestCommands;
 118     pair<RefPtr<InspectorObject>, RefPtr<InspectorObject> > m_pendingInspectData;
 119     String m_inspectorExtensionAPI;
 120 #if ENABLE(WORKERS)
 121     typedef HashMap<intptr_t, RefPtr<InspectorWorkerResource> > WorkersMap;
 122     WorkersMap m_workers;
 123 #endif
 124     bool m_didCommitLoadFired;
 125 };
 126
 127 } // namespace WebCore
 128
 129 #endif // !defined(InspectorAgent_h)