1/*
2* Copyright (C) 2014 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* 1.  Redistributions of source code must retain the above copyright
9*     notice, this list of conditions and the following disclaimer.
10* 2.  Redistributions in binary form must reproduce the above copyright
11*     notice, this list of conditions and the following disclaimer in the
12*     documentation and/or other materials provided with the distribution.
13*
14* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
15* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17* DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
21* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
23* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24*/
25
26#ifndef InspectorConsoleAgent_h
27#define InspectorConsoleAgent_h
28
29#if ENABLE(INSPECTOR)
30
31#include "InspectorJSBackendDispatchers.h"
32#include "InspectorJSFrontendDispatchers.h"
33#include "inspector/InspectorAgentBase.h"
34#include "runtime/ConsoleTypes.h"
35#include <wtf/Forward.h>
36#include <wtf/HashMap.h>
37#include <wtf/Noncopyable.h>
38#include <wtf/Vector.h>
39#include <wtf/text/StringHash.h>
40
41namespace JSC {
42class ExecState;
43}
44
45namespace Inspector {
46
47class ConsoleMessage;
48class InjectedScriptManager;
49class ScriptArguments;
50class ScriptCallStack;
51typedef String ErrorString;
52
53class JS_EXPORT_PRIVATE InspectorConsoleAgent : public InspectorAgentBase, public InspectorConsoleBackendDispatcherHandler {
54    WTF_MAKE_NONCOPYABLE(InspectorConsoleAgent);
55    WTF_MAKE_FAST_ALLOCATED;
56public:
57    InspectorConsoleAgent(InjectedScriptManager*);
58    virtual ~InspectorConsoleAgent();
59
60    virtual void didCreateFrontendAndBackend(InspectorFrontendChannel*, InspectorBackendDispatcher*) override;
61    virtual void willDestroyFrontendAndBackend(InspectorDisconnectReason) override;
62
63    virtual void enable(ErrorString*) override;
64    virtual void disable(ErrorString*) override;
65    virtual void clearMessages(ErrorString*) override;
66    virtual void setMonitoringXHREnabled(ErrorString*, bool enabled) = 0;
67    virtual void addInspectedNode(ErrorString*, int nodeId) = 0;
68
69    virtual bool isWorkerAgent() const = 0;
70
71    bool enabled() const { return m_enabled; }
72    void reset();
73
74    void addMessageToConsole(MessageSource, MessageType, MessageLevel, const String& message, JSC::ExecState*, PassRefPtr<ScriptArguments>, unsigned long requestIdentifier = 0);
75    void addMessageToConsole(MessageSource, MessageType, MessageLevel, const String& message, const String& scriptID, unsigned lineNumber, unsigned columnNumber, JSC::ExecState* = nullptr, unsigned long requestIdentifier = 0);
76    void addMessageToConsole(MessageSource, MessageType, MessageLevel, const String& message, PassRefPtr<ScriptCallStack>, unsigned long requestIdentifier = 0);
77
78    Vector<unsigned> consoleMessageArgumentCounts() const;
79
80    void startTiming(const String& title);
81    void stopTiming(const String& title, PassRefPtr<ScriptCallStack>);
82    void count(JSC::ExecState*, PassRefPtr<ScriptArguments>);
83
84protected:
85    void addConsoleMessage(std::unique_ptr<ConsoleMessage>);
86
87    InjectedScriptManager* m_injectedScriptManager;
88    std::unique_ptr<InspectorConsoleFrontendDispatcher> m_frontendDispatcher;
89    RefPtr<InspectorConsoleBackendDispatcher> m_backendDispatcher;
90    ConsoleMessage* m_previousMessage;
91    Vector<std::unique_ptr<ConsoleMessage>> m_consoleMessages;
92    int m_expiredConsoleMessageCount;
93    HashMap<String, unsigned> m_counts;
94    HashMap<String, double> m_times;
95    bool m_enabled;
96};
97
98} // namespace Inspector
99
100#endif // ENABLE(INSPECTOR)
101
102#endif // !defined(InspectorConsoleAgent_h)
103