1/*
2 * Copyright (C) 2014 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 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#pragma once
27
28#include "ConsoleTypes.h"
29#include <wtf/Forward.h>
30
31namespace Inspector {
32class ScriptArguments;
33}
34
35namespace JSC {
36
37class CallFrame;
38class JSGlobalObject;
39
40class ConsoleClient {
41public:
42 virtual ~ConsoleClient() { }
43
44 JS_EXPORT_PRIVATE static void printConsoleMessage(MessageSource, MessageType, MessageLevel, const String& message, const String& url, unsigned lineNumber, unsigned columnNumber);
45 JS_EXPORT_PRIVATE static void printConsoleMessageWithArguments(MessageSource, MessageType, MessageLevel, JSC::JSGlobalObject*, Ref<Inspector::ScriptArguments>&&);
46
47 void logWithLevel(JSGlobalObject*, Ref<Inspector::ScriptArguments>&&, MessageLevel);
48 void clear(JSGlobalObject*);
49 void dir(JSGlobalObject*, Ref<Inspector::ScriptArguments>&&);
50 void dirXML(JSGlobalObject*, Ref<Inspector::ScriptArguments>&&);
51 void table(JSGlobalObject*, Ref<Inspector::ScriptArguments>&&);
52 void trace(JSGlobalObject*, Ref<Inspector::ScriptArguments>&&);
53 void assertion(JSGlobalObject*, Ref<Inspector::ScriptArguments>&&);
54 void group(JSGlobalObject*, Ref<Inspector::ScriptArguments>&&);
55 void groupCollapsed(JSGlobalObject*, Ref<Inspector::ScriptArguments>&&);
56 void groupEnd(JSGlobalObject*, Ref<Inspector::ScriptArguments>&&);
57
58 virtual void messageWithTypeAndLevel(MessageType, MessageLevel, JSC::JSGlobalObject*, Ref<Inspector::ScriptArguments>&&) = 0;
59 virtual void count(JSGlobalObject*, const String& label) = 0;
60 virtual void countReset(JSGlobalObject*, const String& label) = 0;
61 virtual void profile(JSGlobalObject*, const String& title) = 0;
62 virtual void profileEnd(JSGlobalObject*, const String& title) = 0;
63 virtual void takeHeapSnapshot(JSGlobalObject*, const String& title) = 0;
64 virtual void time(JSGlobalObject*, const String& label) = 0;
65 virtual void timeLog(JSGlobalObject*, const String& label, Ref<Inspector::ScriptArguments>&&) = 0;
66 virtual void timeEnd(JSGlobalObject*, const String& label) = 0;
67 virtual void timeStamp(JSGlobalObject*, Ref<Inspector::ScriptArguments>&&) = 0;
68 virtual void record(JSGlobalObject*, Ref<Inspector::ScriptArguments>&&) = 0;
69 virtual void recordEnd(JSGlobalObject*, Ref<Inspector::ScriptArguments>&&) = 0;
70 virtual void screenshot(JSGlobalObject*, Ref<Inspector::ScriptArguments>&&) = 0;
71
72private:
73 enum ArgumentRequirement { ArgumentRequired, ArgumentNotRequired };
74 void internalMessageWithTypeAndLevel(MessageType, MessageLevel, JSC::JSGlobalObject*, Ref<Inspector::ScriptArguments>&&, ArgumentRequirement);
75};
76
77} // namespace JSC
78