mirror of
https://github.com/RGBCube/serenity
synced 2025-05-28 07:35:08 +00:00
7a2da4cabf
...and the other Console methods. This lets you apply styling to a log message or any other text that passes through the Console `Formatter` operation. We store the CSS on the ConsoleClient instead of passing it along with the rest of the message, since I couldn't figure out a nice way of doing that, as Formatter has to return JS::Values. This way isn't nice, and has a risk of forgetting to clear the style and having it apply to subsequent messages, but it works. This is only supported in the Browser for now. REPL support would require parsing the CSS and figuring out the relevant ANSI codes. We also don't filter this styling at all, so you can `position: absolute` and `transform: translate(...)` all you want, which is less than ideal.
122 lines
3 KiB
C++
122 lines
3 KiB
C++
/*
|
|
* Copyright (c) 2020, Emanuele Torre <torreemanuele6@gmail.com>
|
|
* Copyright (c) 2021, Sam Atkins <atkinssj@serenityos.org>
|
|
*
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <AK/Function.h>
|
|
#include <AK/HashMap.h>
|
|
#include <AK/Noncopyable.h>
|
|
#include <AK/Vector.h>
|
|
#include <LibCore/ElapsedTimer.h>
|
|
#include <LibJS/Forward.h>
|
|
#include <LibJS/Runtime/Value.h>
|
|
|
|
namespace JS {
|
|
|
|
class ConsoleClient;
|
|
|
|
// https://console.spec.whatwg.org
|
|
class Console {
|
|
AK_MAKE_NONCOPYABLE(Console);
|
|
AK_MAKE_NONMOVABLE(Console);
|
|
|
|
public:
|
|
// These are not really levels, but that's the term used in the spec.
|
|
enum class LogLevel {
|
|
Assert,
|
|
Count,
|
|
CountReset,
|
|
Debug,
|
|
Dir,
|
|
DirXML,
|
|
Error,
|
|
Group,
|
|
GroupCollapsed,
|
|
Info,
|
|
Log,
|
|
TimeEnd,
|
|
TimeLog,
|
|
Trace,
|
|
Warn,
|
|
};
|
|
|
|
struct Group {
|
|
String label;
|
|
};
|
|
|
|
struct Trace {
|
|
String label;
|
|
Vector<String> stack;
|
|
};
|
|
|
|
explicit Console(VM&);
|
|
|
|
void set_client(ConsoleClient& client) { m_client = &client; }
|
|
|
|
VM& vm() const { return m_vm; }
|
|
|
|
MarkedVector<Value> vm_arguments();
|
|
|
|
HashMap<String, unsigned>& counters() { return m_counters; }
|
|
HashMap<String, unsigned> const& counters() const { return m_counters; }
|
|
|
|
ThrowCompletionOr<Value> debug();
|
|
ThrowCompletionOr<Value> error();
|
|
ThrowCompletionOr<Value> info();
|
|
ThrowCompletionOr<Value> log();
|
|
ThrowCompletionOr<Value> warn();
|
|
Value clear();
|
|
ThrowCompletionOr<Value> trace();
|
|
ThrowCompletionOr<Value> count();
|
|
ThrowCompletionOr<Value> count_reset();
|
|
ThrowCompletionOr<Value> assert_();
|
|
ThrowCompletionOr<Value> group();
|
|
ThrowCompletionOr<Value> group_collapsed();
|
|
ThrowCompletionOr<Value> group_end();
|
|
ThrowCompletionOr<Value> time();
|
|
ThrowCompletionOr<Value> time_log();
|
|
ThrowCompletionOr<Value> time_end();
|
|
|
|
void output_debug_message(LogLevel log_level, String output) const;
|
|
|
|
private:
|
|
ThrowCompletionOr<String> value_vector_to_string(MarkedVector<Value> const&);
|
|
ThrowCompletionOr<String> format_time_since(Core::ElapsedTimer timer);
|
|
|
|
VM& m_vm;
|
|
ConsoleClient* m_client { nullptr };
|
|
|
|
HashMap<String, unsigned> m_counters;
|
|
HashMap<String, Core::ElapsedTimer> m_timer_table;
|
|
Vector<Group> m_group_stack;
|
|
};
|
|
|
|
class ConsoleClient {
|
|
public:
|
|
explicit ConsoleClient(Console& console)
|
|
: m_console(console)
|
|
{
|
|
}
|
|
|
|
using PrinterArguments = Variant<Console::Group, Console::Trace, MarkedVector<Value>>;
|
|
|
|
ThrowCompletionOr<Value> logger(Console::LogLevel log_level, MarkedVector<Value> const& args);
|
|
ThrowCompletionOr<MarkedVector<Value>> formatter(MarkedVector<Value> const& args);
|
|
virtual ThrowCompletionOr<Value> printer(Console::LogLevel log_level, PrinterArguments) = 0;
|
|
|
|
virtual void add_css_style_to_current_message(StringView) {};
|
|
|
|
virtual void clear() = 0;
|
|
virtual void end_group() = 0;
|
|
|
|
protected:
|
|
virtual ~ConsoleClient() = default;
|
|
|
|
Console& m_console;
|
|
};
|
|
|
|
}
|