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 <wtf/Forward.h>
35#include <wtf/HashMap.h>
36#include <wtf/PassOwnPtr.h>
37#include <wtf/Vector.h>
38#include <wtf/text/WTFString.h>
39
40namespace WebCore {
41
42class DOMWrapperWorld;
43class DocumentLoader;
44class Frame;
45class InjectedScriptManager;
46class InspectorFrontend;
47class InspectorObject;
48class InstrumentingAgents;
49class KURL;
50class Page;
51
52typedef String ErrorString;
53
54class InspectorAgent : public InspectorBaseAgent<InspectorAgent>, public InspectorBackendDispatcher::InspectorCommandHandler {
55    WTF_MAKE_NONCOPYABLE(InspectorAgent);
56public:
57    static PassOwnPtr<InspectorAgent> create(Page* page, InjectedScriptManager* injectedScriptManager, InstrumentingAgents* instrumentingAgents, InspectorCompositeState* state)
58    {
59        return adoptPtr(new InspectorAgent(page, injectedScriptManager, instrumentingAgents, state));
60    }
61
62    virtual ~InspectorAgent();
63
64    bool developerExtrasEnabled() const;
65
66    // Inspector front-end API.
67    void enable(ErrorString*);
68    void disable(ErrorString*);
69
70    KURL inspectedURL() const;
71    KURL inspectedURLWithoutFragment() const;
72
73    InspectorFrontend* frontend() const { return m_frontend; }
74
75    virtual void setFrontend(InspectorFrontend*);
76    virtual void clearFrontend();
77
78    void didClearWindowObjectInWorld(Frame*, DOMWrapperWorld*);
79
80    void didCommitLoad();
81    void domContentLoadedEventFired();
82
83    bool hasFrontend() const { return m_frontend; }
84
85    // Generic code called from custom implementations.
86    void evaluateForTestInFrontend(long testCallId, const String& script);
87
88    void setInjectedScriptForOrigin(const String& origin, const String& source);
89
90    void inspect(PassRefPtr<TypeBuilder::Runtime::RemoteObject> objectToInspect, PassRefPtr<InspectorObject> hints);
91
92private:
93    InspectorAgent(Page*, InjectedScriptManager*, InstrumentingAgents*, InspectorCompositeState*);
94
95    void unbindAllResources();
96
97#if ENABLE(JAVASCRIPT_DEBUGGER)
98    void toggleRecordButton(bool);
99#endif
100
101    bool isMainResourceLoader(DocumentLoader*, const KURL& requestUrl);
102
103    Page* m_inspectedPage;
104    InspectorFrontend* m_frontend;
105    InjectedScriptManager* m_injectedScriptManager;
106
107    Vector<pair<long, String> > m_pendingEvaluateTestCommands;
108    pair<RefPtr<TypeBuilder::Runtime::RemoteObject>, RefPtr<InspectorObject> > m_pendingInspectData;
109    typedef HashMap<String, String> InjectedScriptForOriginMap;
110    InjectedScriptForOriginMap m_injectedScriptForOrigin;
111};
112
113} // namespace WebCore
114
115#endif // !defined(InspectorAgent_h)
116