Web Inspector: We should have a way to capture heap snapshots programatically.
[WebKit-https.git] / Source / WebCore / page / PageConsoleClient.h
1 /*
2  * Copyright (C) 2013 Apple 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
6  * are met:
7  *
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  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef PageConsoleClient_h
30 #define PageConsoleClient_h
31
32 #include <inspector/ScriptCallStack.h>
33 #include <profiler/Profile.h>
34 #include <runtime/ConsoleClient.h>
35 #include <wtf/Forward.h>
36
37 namespace JSC {
38 class ExecState;
39 }
40
41 namespace WebCore {
42
43 class Document;
44 class Page;
45
46 typedef Vector<RefPtr<JSC::Profile>> ProfilesArray;
47
48 class WEBCORE_EXPORT PageConsoleClient final : public JSC::ConsoleClient {
49     WTF_MAKE_FAST_ALLOCATED;
50 public:
51     explicit PageConsoleClient(Page&);
52     virtual ~PageConsoleClient();
53
54     static bool shouldPrintExceptions();
55     static void setShouldPrintExceptions(bool);
56
57     static void mute();
58     static void unmute();
59
60     void addMessage(MessageSource, MessageLevel, const String& message, const String& sourceURL, unsigned lineNumber, unsigned columnNumber, RefPtr<Inspector::ScriptCallStack>&& = nullptr, JSC::ExecState* = nullptr, unsigned long requestIdentifier = 0);
61     void addMessage(MessageSource, MessageLevel, const String& message, RefPtr<Inspector::ScriptCallStack>&&);
62     void addMessage(MessageSource, MessageLevel, const String& message, unsigned long requestIdentifier = 0, Document* = nullptr);
63
64     const ProfilesArray& profiles() const { return m_profiles; }
65     void clearProfiles();
66
67 protected:
68     void messageWithTypeAndLevel(MessageType, MessageLevel, JSC::ExecState*, RefPtr<Inspector::ScriptArguments>&&) override;
69     void count(JSC::ExecState*, RefPtr<Inspector::ScriptArguments>&&) override;
70     void profile(JSC::ExecState*, const String& title) override;
71     void profileEnd(JSC::ExecState*, const String& title) override;
72     void takeHeapSnapshot(JSC::ExecState*, const String& title) override;
73     void time(JSC::ExecState*, const String& title) override;
74     void timeEnd(JSC::ExecState*, const String& title) override;
75     void timeStamp(JSC::ExecState*, RefPtr<Inspector::ScriptArguments>&&) override;
76
77 private:
78     Page& m_page;
79     ProfilesArray m_profiles;
80 };
81
82 } // namespace WebCore
83
84 #endif // PageConsoleClient_h