mirror of
https://github.com/LadybirdBrowser/ladybird.git
synced 2024-11-25 00:50:22 +00:00
LibGUI+LibCore: Move GML property system from LibCore to LibGUI
Since Core::Object properties are really only used by GML now that the Inspector is long gone, there's no need for these to pollute Core::Object. This patch adds a new GUI::Object class to hold properties, and makes it the new base class of GUI::Window, GUI::Widget and GUI::Layout. The "instantiate an object by name" mechanism that GML uses is also hoisted into GUI::Object as well.
This commit is contained in:
parent
9f6ceff7cf
commit
405187993a
Notes:
sideshowbarker
2024-07-17 02:08:15 +09:00
Author: https://github.com/awesomekling Commit: https://github.com/SerenityOS/serenity/commit/405187993a Pull-request: https://github.com/SerenityOS/serenity/pull/20397
19 changed files with 376 additions and 335 deletions
|
@ -21,7 +21,6 @@ set(SOURCES
|
|||
Object.cpp
|
||||
Process.cpp
|
||||
ProcessStatisticsReader.cpp
|
||||
Property.cpp
|
||||
SecretString.cpp
|
||||
SessionManagement.cpp
|
||||
Socket.cpp
|
||||
|
|
|
@ -27,17 +27,6 @@ Object::Object(Object* parent)
|
|||
all_objects().append(*this);
|
||||
if (m_parent)
|
||||
m_parent->add_child(*this);
|
||||
|
||||
REGISTER_READONLY_STRING_PROPERTY("class_name", class_name);
|
||||
REGISTER_DEPRECATED_STRING_PROPERTY("name", name, set_name);
|
||||
|
||||
register_property(
|
||||
"address", [this] { return FlatPtr(this); },
|
||||
[](auto&) { return false; });
|
||||
|
||||
register_property(
|
||||
"parent", [this] { return FlatPtr(this->parent()); },
|
||||
[](auto&) { return false; });
|
||||
}
|
||||
|
||||
Object::~Object()
|
||||
|
@ -176,22 +165,6 @@ void Object::deferred_invoke(Function<void()> invokee)
|
|||
Core::deferred_invoke([invokee = move(invokee), strong_this = NonnullRefPtr(*this)] { invokee(); });
|
||||
}
|
||||
|
||||
JsonValue Object::property(DeprecatedString const& name) const
|
||||
{
|
||||
auto it = m_properties.find(name);
|
||||
if (it == m_properties.end())
|
||||
return JsonValue();
|
||||
return it->value->get();
|
||||
}
|
||||
|
||||
bool Object::set_property(DeprecatedString const& name, JsonValue const& value)
|
||||
{
|
||||
auto it = m_properties.find(name);
|
||||
if (it == m_properties.end())
|
||||
return false;
|
||||
return it->value->set(value);
|
||||
}
|
||||
|
||||
bool Object::is_ancestor_of(Object const& other) const
|
||||
{
|
||||
if (&other == this)
|
||||
|
@ -241,48 +214,9 @@ void Object::decrement_inspector_count(Badge<InspectorServerConnection>)
|
|||
did_end_inspection();
|
||||
}
|
||||
|
||||
void Object::register_property(DeprecatedString const& name, Function<JsonValue()> getter, Function<bool(JsonValue const&)> setter)
|
||||
{
|
||||
m_properties.set(name, make<Property>(name, move(getter), move(setter)));
|
||||
}
|
||||
|
||||
void Object::set_event_filter(Function<bool(Core::Event&)> filter)
|
||||
{
|
||||
m_event_filter = move(filter);
|
||||
}
|
||||
|
||||
static HashMap<StringView, ObjectClassRegistration*>& object_classes()
|
||||
{
|
||||
static HashMap<StringView, ObjectClassRegistration*> s_map;
|
||||
return s_map;
|
||||
}
|
||||
|
||||
ObjectClassRegistration::ObjectClassRegistration(StringView class_name, Function<ErrorOr<NonnullRefPtr<Object>>()> factory, ObjectClassRegistration* parent_class)
|
||||
: m_class_name(class_name)
|
||||
, m_factory(move(factory))
|
||||
, m_parent_class(parent_class)
|
||||
{
|
||||
object_classes().set(class_name, this);
|
||||
}
|
||||
|
||||
bool ObjectClassRegistration::is_derived_from(ObjectClassRegistration const& base_class) const
|
||||
{
|
||||
if (&base_class == this)
|
||||
return true;
|
||||
if (!m_parent_class)
|
||||
return false;
|
||||
return m_parent_class->is_derived_from(base_class);
|
||||
}
|
||||
|
||||
void ObjectClassRegistration::for_each(Function<void(ObjectClassRegistration const&)> callback)
|
||||
{
|
||||
for (auto& it : object_classes()) {
|
||||
callback(*it.value);
|
||||
}
|
||||
}
|
||||
|
||||
ObjectClassRegistration const* ObjectClassRegistration::find(StringView class_name)
|
||||
{
|
||||
return object_classes().get(class_name).value_or(nullptr);
|
||||
}
|
||||
}
|
||||
|
|
|
@ -9,6 +9,7 @@
|
|||
|
||||
#include <AK/DeprecatedString.h>
|
||||
#include <AK/Forward.h>
|
||||
#include <AK/Function.h>
|
||||
#include <AK/HashMap.h>
|
||||
#include <AK/IntrusiveList.h>
|
||||
#include <AK/Noncopyable.h>
|
||||
|
@ -17,46 +18,9 @@
|
|||
#include <AK/TypeCasts.h>
|
||||
#include <AK/Weakable.h>
|
||||
#include <LibCore/Forward.h>
|
||||
#include <LibCore/Property.h>
|
||||
|
||||
namespace Core {
|
||||
|
||||
#define REGISTER_ABSTRACT_CORE_OBJECT(namespace_, class_name) \
|
||||
namespace Core { \
|
||||
namespace Registration { \
|
||||
Core::ObjectClassRegistration registration_##class_name(#namespace_ "::" #class_name##sv, []() { return Error::from_string_literal("Attempted to construct an abstract object."); }); \
|
||||
} \
|
||||
}
|
||||
|
||||
#define REGISTER_CORE_OBJECT(namespace_, class_name) \
|
||||
namespace Core { \
|
||||
namespace Registration { \
|
||||
Core::ObjectClassRegistration registration_##class_name(#namespace_ "::" #class_name##sv, []() { return namespace_::class_name::try_create(); }); \
|
||||
} \
|
||||
}
|
||||
|
||||
class ObjectClassRegistration {
|
||||
AK_MAKE_NONCOPYABLE(ObjectClassRegistration);
|
||||
AK_MAKE_NONMOVABLE(ObjectClassRegistration);
|
||||
|
||||
public:
|
||||
ObjectClassRegistration(StringView class_name, Function<ErrorOr<NonnullRefPtr<Object>>()> factory, ObjectClassRegistration* parent_class = nullptr);
|
||||
~ObjectClassRegistration() = default;
|
||||
|
||||
StringView class_name() const { return m_class_name; }
|
||||
ObjectClassRegistration const* parent_class() const { return m_parent_class; }
|
||||
ErrorOr<NonnullRefPtr<Object>> construct() const { return m_factory(); }
|
||||
bool is_derived_from(ObjectClassRegistration const& base_class) const;
|
||||
|
||||
static void for_each(Function<void(ObjectClassRegistration const&)>);
|
||||
static ObjectClassRegistration const* find(StringView class_name);
|
||||
|
||||
private:
|
||||
StringView m_class_name;
|
||||
Function<ErrorOr<NonnullRefPtr<Object>>()> m_factory;
|
||||
ObjectClassRegistration* m_parent_class { nullptr };
|
||||
};
|
||||
|
||||
class InspectorServerConnection;
|
||||
|
||||
enum class TimerShouldFireWhenNotVisible {
|
||||
|
@ -171,10 +135,6 @@ public:
|
|||
|
||||
void deferred_invoke(Function<void()>);
|
||||
|
||||
bool set_property(DeprecatedString const& name, JsonValue const& value);
|
||||
JsonValue property(DeprecatedString const& name) const;
|
||||
HashMap<DeprecatedString, NonnullOwnPtr<Property>> const& properties() const { return m_properties; }
|
||||
|
||||
static IntrusiveList<&Object::m_all_objects_list_node>& all_objects();
|
||||
|
||||
void dispatch_event(Core::Event&, Object* stay_within = nullptr);
|
||||
|
@ -211,8 +171,6 @@ public:
|
|||
protected:
|
||||
explicit Object(Object* parent = nullptr);
|
||||
|
||||
void register_property(DeprecatedString const& name, Function<JsonValue()> getter, Function<bool(JsonValue const&)> setter = nullptr);
|
||||
|
||||
virtual void event(Core::Event&);
|
||||
|
||||
virtual void timer_event(TimerEvent&);
|
||||
|
@ -229,7 +187,6 @@ private:
|
|||
DeprecatedString m_name;
|
||||
int m_timer_id { 0 };
|
||||
unsigned m_inspector_count { 0 };
|
||||
HashMap<DeprecatedString, NonnullOwnPtr<Property>> m_properties;
|
||||
Vector<NonnullRefPtr<Object>> m_children;
|
||||
Function<bool(Core::Event&)> m_event_filter;
|
||||
};
|
||||
|
@ -289,186 +246,4 @@ requires IsBaseOf<Object, T>
|
|||
return found_child;
|
||||
}
|
||||
|
||||
#define REGISTER_INT_PROPERTY(property_name, getter, setter) \
|
||||
register_property( \
|
||||
property_name, \
|
||||
[this] { return this->getter(); }, \
|
||||
[this](auto& value) { \
|
||||
this->setter(value.template to_number<int>()); \
|
||||
return true; \
|
||||
});
|
||||
|
||||
#define REGISTER_BOOL_PROPERTY(property_name, getter, setter) \
|
||||
register_property( \
|
||||
property_name, \
|
||||
[this] { return this->getter(); }, \
|
||||
[this](auto& value) { \
|
||||
this->setter(value.to_bool()); \
|
||||
return true; \
|
||||
});
|
||||
|
||||
// FIXME: Port JsonValue to the new String class.
|
||||
#define REGISTER_STRING_PROPERTY(property_name, getter, setter) \
|
||||
register_property( \
|
||||
property_name, \
|
||||
[this]() { return this->getter().to_deprecated_string(); }, \
|
||||
[this](auto& value) { \
|
||||
this->setter(String::from_deprecated_string(value.to_deprecated_string()).release_value_but_fixme_should_propagate_errors()); \
|
||||
return true; \
|
||||
});
|
||||
|
||||
#define REGISTER_DEPRECATED_STRING_PROPERTY(property_name, getter, setter) \
|
||||
register_property( \
|
||||
property_name, \
|
||||
[this] { return this->getter(); }, \
|
||||
[this](auto& value) { \
|
||||
this->setter(value.to_deprecated_string()); \
|
||||
return true; \
|
||||
});
|
||||
|
||||
#define REGISTER_READONLY_STRING_PROPERTY(property_name, getter) \
|
||||
register_property( \
|
||||
property_name, \
|
||||
[this] { return this->getter(); }, \
|
||||
{});
|
||||
|
||||
#define REGISTER_WRITE_ONLY_STRING_PROPERTY(property_name, setter) \
|
||||
register_property( \
|
||||
property_name, \
|
||||
{}, \
|
||||
[this](auto& value) { \
|
||||
this->setter(value.to_deprecated_string()); \
|
||||
return true; \
|
||||
});
|
||||
|
||||
#define REGISTER_READONLY_SIZE_PROPERTY(property_name, getter) \
|
||||
register_property( \
|
||||
property_name, \
|
||||
[this] { \
|
||||
auto size = this->getter(); \
|
||||
JsonArray size_array; \
|
||||
size_array.must_append(size.width()); \
|
||||
size_array.must_append(size.height()); \
|
||||
return size_array; \
|
||||
}, \
|
||||
{});
|
||||
|
||||
#define REGISTER_RECT_PROPERTY(property_name, getter, setter) \
|
||||
register_property( \
|
||||
property_name, \
|
||||
[this] { \
|
||||
auto rect = this->getter(); \
|
||||
JsonObject rect_object; \
|
||||
rect_object.set("x"sv, rect.x()); \
|
||||
rect_object.set("y"sv, rect.y()); \
|
||||
rect_object.set("width"sv, rect.width()); \
|
||||
rect_object.set("height"sv, rect.height()); \
|
||||
return rect_object; \
|
||||
}, \
|
||||
[this](auto& value) { \
|
||||
Gfx::IntRect rect; \
|
||||
if (value.is_object()) { \
|
||||
rect.set_x(value.as_object().get_i32("x"sv).value_or(0)); \
|
||||
rect.set_y(value.as_object().get_i32("y"sv).value_or(0)); \
|
||||
rect.set_width(value.as_object().get_i32("width"sv).value_or(0)); \
|
||||
rect.set_height(value.as_object().get_i32("height"sv).value_or(0)); \
|
||||
} else if (value.is_array() && value.as_array().size() == 4) { \
|
||||
rect.set_x(value.as_array()[0].to_i32()); \
|
||||
rect.set_y(value.as_array()[1].to_i32()); \
|
||||
rect.set_width(value.as_array()[2].to_i32()); \
|
||||
rect.set_height(value.as_array()[3].to_i32()); \
|
||||
} else { \
|
||||
return false; \
|
||||
} \
|
||||
setter(rect); \
|
||||
\
|
||||
return true; \
|
||||
});
|
||||
|
||||
#define REGISTER_SIZE_PROPERTY(property_name, getter, setter) \
|
||||
register_property( \
|
||||
property_name, \
|
||||
[this] { \
|
||||
auto size = this->getter(); \
|
||||
JsonArray size_array; \
|
||||
size_array.must_append(size.width()); \
|
||||
size_array.must_append(size.height()); \
|
||||
return size_array; \
|
||||
}, \
|
||||
[this](auto& value) { \
|
||||
if (!value.is_array()) \
|
||||
return false; \
|
||||
Gfx::IntSize size; \
|
||||
size.set_width(value.as_array()[0].to_i32()); \
|
||||
size.set_height(value.as_array()[1].to_i32()); \
|
||||
setter(size); \
|
||||
return true; \
|
||||
});
|
||||
|
||||
#define REGISTER_ENUM_PROPERTY(property_name, getter, setter, EnumType, ...) \
|
||||
register_property( \
|
||||
property_name, \
|
||||
[this]() -> JsonValue { \
|
||||
struct { \
|
||||
EnumType enum_value; \
|
||||
DeprecatedString string_value; \
|
||||
} options[] = { __VA_ARGS__ }; \
|
||||
auto enum_value = getter(); \
|
||||
for (size_t i = 0; i < array_size(options); ++i) { \
|
||||
auto& option = options[i]; \
|
||||
if (enum_value == option.enum_value) \
|
||||
return option.string_value; \
|
||||
} \
|
||||
return JsonValue(); \
|
||||
}, \
|
||||
[this](auto& value) { \
|
||||
struct { \
|
||||
EnumType enum_value; \
|
||||
DeprecatedString string_value; \
|
||||
} options[] = { __VA_ARGS__ }; \
|
||||
if (!value.is_string()) \
|
||||
return false; \
|
||||
auto string_value = value.as_string(); \
|
||||
for (size_t i = 0; i < array_size(options); ++i) { \
|
||||
auto& option = options[i]; \
|
||||
if (string_value == option.string_value) { \
|
||||
setter(option.enum_value); \
|
||||
return true; \
|
||||
} \
|
||||
} \
|
||||
return false; \
|
||||
})
|
||||
|
||||
#define REGISTER_TEXT_ALIGNMENT_PROPERTY(property_name, getter, setter) \
|
||||
REGISTER_ENUM_PROPERTY( \
|
||||
property_name, getter, setter, Gfx::TextAlignment, \
|
||||
{ Gfx::TextAlignment::Center, "Center" }, \
|
||||
{ Gfx::TextAlignment::CenterLeft, "CenterLeft" }, \
|
||||
{ Gfx::TextAlignment::CenterRight, "CenterRight" }, \
|
||||
{ Gfx::TextAlignment::TopCenter, "TopCenter" }, \
|
||||
{ Gfx::TextAlignment::TopLeft, "TopLeft" }, \
|
||||
{ Gfx::TextAlignment::TopRight, "TopRight" }, \
|
||||
{ Gfx::TextAlignment::BottomCenter, "BottomCenter" }, \
|
||||
{ Gfx::TextAlignment::BottomLeft, "BottomLeft" }, \
|
||||
{ Gfx::TextAlignment::BottomRight, "BottomRight" })
|
||||
|
||||
#define REGISTER_FONT_WEIGHT_PROPERTY(property_name, getter, setter) \
|
||||
REGISTER_ENUM_PROPERTY( \
|
||||
property_name, getter, setter, unsigned, \
|
||||
{ Gfx::FontWeight::Thin, "Thin" }, \
|
||||
{ Gfx::FontWeight::ExtraLight, "ExtraLight" }, \
|
||||
{ Gfx::FontWeight::Light, "Light" }, \
|
||||
{ Gfx::FontWeight::Regular, "Regular" }, \
|
||||
{ Gfx::FontWeight::Medium, "Medium" }, \
|
||||
{ Gfx::FontWeight::SemiBold, "SemiBold" }, \
|
||||
{ Gfx::FontWeight::Bold, "Bold" }, \
|
||||
{ Gfx::FontWeight::ExtraBold, "ExtraBold" }, \
|
||||
{ Gfx::FontWeight::Black, "Black" }, \
|
||||
{ Gfx::FontWeight::ExtraBlack, "ExtraBlack" })
|
||||
|
||||
#define REGISTER_TEXT_WRAPPING_PROPERTY(property_name, getter, setter) \
|
||||
REGISTER_ENUM_PROPERTY( \
|
||||
property_name, getter, setter, Gfx::TextWrapping, \
|
||||
{ Gfx::TextWrapping::Wrap, "Wrap" }, \
|
||||
{ Gfx::TextWrapping::DontWrap, "DontWrap" })
|
||||
}
|
||||
|
|
|
@ -79,6 +79,7 @@ set(SOURCES
|
|||
MouseTracker.cpp
|
||||
MultiView.cpp
|
||||
Notification.cpp
|
||||
Object.cpp
|
||||
OpacitySlider.cpp
|
||||
Painter.cpp
|
||||
PasswordInputDialog.cpp
|
||||
|
@ -87,6 +88,7 @@ set(SOURCES
|
|||
Process.cpp
|
||||
ProcessChooser.cpp
|
||||
Progressbar.cpp
|
||||
Property.cpp
|
||||
RadioButton.cpp
|
||||
RangeSlider.cpp
|
||||
RegularEditingEngine.cpp
|
||||
|
|
|
@ -54,6 +54,7 @@ class ModelIndex;
|
|||
class MouseEvent;
|
||||
class MultiPaintEvent;
|
||||
class MultiView;
|
||||
class Object;
|
||||
class OpacitySlider;
|
||||
class PaintEvent;
|
||||
class Painter;
|
||||
|
|
|
@ -107,8 +107,8 @@ void AutocompleteProvider::provide_completions(Function<void(Vector<CodeComprehe
|
|||
state = previous_states.take_last();
|
||||
}
|
||||
|
||||
auto& widget_class = *Core::ObjectClassRegistration::find("GUI::Widget"sv);
|
||||
auto& layout_class = *Core::ObjectClassRegistration::find("GUI::Layout"sv);
|
||||
auto& widget_class = *GUI::ObjectClassRegistration::find("GUI::Widget"sv);
|
||||
auto& layout_class = *GUI::ObjectClassRegistration::find("GUI::Layout"sv);
|
||||
|
||||
// FIXME: Can this be done without a StringBuilder?
|
||||
auto make_fuzzy = [](StringView str) {
|
||||
|
@ -124,14 +124,14 @@ void AutocompleteProvider::provide_completions(Function<void(Vector<CodeComprehe
|
|||
Vector<CodeComprehension::AutocompleteResultEntry> class_entries, identifier_entries;
|
||||
|
||||
auto register_layouts_matching_pattern = [&](DeprecatedString pattern, size_t partial_input_length) {
|
||||
Core::ObjectClassRegistration::for_each([&](const Core::ObjectClassRegistration& registration) {
|
||||
GUI::ObjectClassRegistration::for_each([&](const GUI::ObjectClassRegistration& registration) {
|
||||
if (registration.is_derived_from(layout_class) && ®istration != &layout_class && registration.class_name().matches(pattern))
|
||||
class_entries.empend(DeprecatedString::formatted("@{}", registration.class_name()), partial_input_length);
|
||||
});
|
||||
};
|
||||
|
||||
auto register_widgets_matching_pattern = [&](DeprecatedString pattern, size_t partial_input_length) {
|
||||
Core::ObjectClassRegistration::for_each([&](const Core::ObjectClassRegistration& registration) {
|
||||
GUI::ObjectClassRegistration::for_each([&](const GUI::ObjectClassRegistration& registration) {
|
||||
if (registration.is_derived_from(widget_class) && registration.class_name().matches(pattern))
|
||||
class_entries.empend(DeprecatedString::formatted("@{}", registration.class_name()), partial_input_length);
|
||||
});
|
||||
|
@ -141,7 +141,7 @@ void AutocompleteProvider::provide_completions(Function<void(Vector<CodeComprehe
|
|||
auto class_name = class_names.last();
|
||||
|
||||
// FIXME: Don't show properties that are already specified in the scope.
|
||||
auto registration = Core::ObjectClassRegistration::find(class_name);
|
||||
auto registration = GUI::ObjectClassRegistration::find(class_name);
|
||||
if (registration && (registration->is_derived_from(widget_class) || registration->is_derived_from(layout_class))) {
|
||||
if (auto instance = registration->construct(); !instance.is_error()) {
|
||||
for (auto& it : instance.value()->properties()) {
|
||||
|
@ -161,7 +161,7 @@ void AutocompleteProvider::provide_completions(Function<void(Vector<CodeComprehe
|
|||
if (!class_names.is_empty()) {
|
||||
register_class_properties_matching_pattern(pattern, partial_input_length);
|
||||
|
||||
auto parent_registration = Core::ObjectClassRegistration::find(class_names.last());
|
||||
auto parent_registration = GUI::ObjectClassRegistration::find(class_names.last());
|
||||
if (parent_registration && parent_registration->is_derived_from(layout_class)) {
|
||||
// Layouts can't have child classes, so why suggest them?
|
||||
return;
|
||||
|
|
|
@ -10,7 +10,7 @@
|
|||
#include <LibGUI/Layout.h>
|
||||
#include <LibGUI/Widget.h>
|
||||
|
||||
REGISTER_ABSTRACT_CORE_OBJECT(GUI, Layout)
|
||||
REGISTER_ABSTRACT_GUI_OBJECT(GUI, Layout)
|
||||
|
||||
namespace GUI {
|
||||
|
||||
|
|
|
@ -9,25 +9,25 @@
|
|||
#include <AK/OwnPtr.h>
|
||||
#include <AK/Vector.h>
|
||||
#include <AK/WeakPtr.h>
|
||||
#include <LibCore/Object.h>
|
||||
#include <LibGUI/Forward.h>
|
||||
#include <LibGUI/Margins.h>
|
||||
#include <LibGUI/Object.h>
|
||||
#include <LibGUI/UIDimensions.h>
|
||||
#include <LibGfx/Forward.h>
|
||||
|
||||
namespace Core::Registration {
|
||||
extern Core::ObjectClassRegistration registration_Layout;
|
||||
namespace GUI::Registration {
|
||||
extern GUI::ObjectClassRegistration registration_Layout;
|
||||
}
|
||||
|
||||
#define REGISTER_LAYOUT(namespace_, class_name) \
|
||||
namespace Core::Registration { \
|
||||
Core::ObjectClassRegistration registration_##class_name( \
|
||||
#namespace_ "::" #class_name##sv, []() { return static_ptr_cast<Core::Object>(namespace_::class_name::construct()); }, ®istration_Layout); \
|
||||
#define REGISTER_LAYOUT(namespace_, class_name) \
|
||||
namespace GUI::Registration { \
|
||||
::GUI::ObjectClassRegistration registration_##class_name( \
|
||||
#namespace_ "::" #class_name##sv, []() { return static_ptr_cast<GUI::Object>(namespace_::class_name::construct()); }, ®istration_Layout); \
|
||||
}
|
||||
|
||||
namespace GUI {
|
||||
|
||||
class Layout : public Core::Object {
|
||||
class Layout : public GUI::Object {
|
||||
C_OBJECT_ABSTRACT(Layout);
|
||||
|
||||
public:
|
||||
|
|
74
Userland/Libraries/LibGUI/Object.cpp
Normal file
74
Userland/Libraries/LibGUI/Object.cpp
Normal file
|
@ -0,0 +1,74 @@
|
|||
/*
|
||||
* Copyright (c) 2023, Andreas Kling <kling@serenityos.org>
|
||||
*
|
||||
* SPDX-License-Identifier: BSD-2-Clause
|
||||
*/
|
||||
|
||||
#include <LibGUI/Object.h>
|
||||
|
||||
namespace GUI {
|
||||
|
||||
Object::Object(Core::Object* parent)
|
||||
: Core::Object(parent)
|
||||
{
|
||||
}
|
||||
|
||||
Object::~Object() = default;
|
||||
|
||||
void Object::register_property(DeprecatedString const& name, Function<JsonValue()> getter, Function<bool(JsonValue const&)> setter)
|
||||
{
|
||||
m_properties.set(name, make<Property>(name, move(getter), move(setter)));
|
||||
}
|
||||
|
||||
JsonValue Object::property(DeprecatedString const& name) const
|
||||
{
|
||||
auto it = m_properties.find(name);
|
||||
if (it == m_properties.end())
|
||||
return JsonValue();
|
||||
return it->value->get();
|
||||
}
|
||||
|
||||
bool Object::set_property(DeprecatedString const& name, JsonValue const& value)
|
||||
{
|
||||
auto it = m_properties.find(name);
|
||||
if (it == m_properties.end())
|
||||
return false;
|
||||
return it->value->set(value);
|
||||
}
|
||||
|
||||
static HashMap<StringView, ObjectClassRegistration*>& object_classes()
|
||||
{
|
||||
static HashMap<StringView, ObjectClassRegistration*> s_map;
|
||||
return s_map;
|
||||
}
|
||||
|
||||
ObjectClassRegistration::ObjectClassRegistration(StringView class_name, Function<ErrorOr<NonnullRefPtr<Object>>()> factory, ObjectClassRegistration* parent_class)
|
||||
: m_class_name(class_name)
|
||||
, m_factory(move(factory))
|
||||
, m_parent_class(parent_class)
|
||||
{
|
||||
object_classes().set(class_name, this);
|
||||
}
|
||||
|
||||
bool ObjectClassRegistration::is_derived_from(ObjectClassRegistration const& base_class) const
|
||||
{
|
||||
if (&base_class == this)
|
||||
return true;
|
||||
if (!m_parent_class)
|
||||
return false;
|
||||
return m_parent_class->is_derived_from(base_class);
|
||||
}
|
||||
|
||||
void ObjectClassRegistration::for_each(Function<void(ObjectClassRegistration const&)> callback)
|
||||
{
|
||||
for (auto& it : object_classes()) {
|
||||
callback(*it.value);
|
||||
}
|
||||
}
|
||||
|
||||
ObjectClassRegistration const* ObjectClassRegistration::find(StringView class_name)
|
||||
{
|
||||
return object_classes().get(class_name).value_or(nullptr);
|
||||
}
|
||||
|
||||
}
|
249
Userland/Libraries/LibGUI/Object.h
Normal file
249
Userland/Libraries/LibGUI/Object.h
Normal file
|
@ -0,0 +1,249 @@
|
|||
/*
|
||||
* Copyright (c) 2023, Andreas Kling <kling@serenityos.org>
|
||||
*
|
||||
* SPDX-License-Identifier: BSD-2-Clause
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <LibCore/Object.h>
|
||||
#include <LibGUI/Forward.h>
|
||||
#include <LibGUI/Property.h>
|
||||
|
||||
namespace GUI {
|
||||
|
||||
#define REGISTER_ABSTRACT_GUI_OBJECT(namespace_, class_name) \
|
||||
namespace GUI::Registration { \
|
||||
::GUI::ObjectClassRegistration registration_##class_name(#namespace_ "::" #class_name##sv, []() { return Error::from_string_literal("Attempted to construct an abstract object."); }); \
|
||||
}
|
||||
|
||||
#define REGISTER_GUI_OBJECT(namespace_, class_name) \
|
||||
namespace GUI::Registration { \
|
||||
::GUI::ObjectClassRegistration registration_##class_name(#namespace_ "::" #class_name##sv, []() { return namespace_::class_name::try_create(); }); \
|
||||
}
|
||||
|
||||
class ObjectClassRegistration {
|
||||
AK_MAKE_NONCOPYABLE(ObjectClassRegistration);
|
||||
AK_MAKE_NONMOVABLE(ObjectClassRegistration);
|
||||
|
||||
public:
|
||||
ObjectClassRegistration(StringView class_name, Function<ErrorOr<NonnullRefPtr<Object>>()> factory, ObjectClassRegistration* parent_class = nullptr);
|
||||
~ObjectClassRegistration() = default;
|
||||
|
||||
StringView class_name() const { return m_class_name; }
|
||||
ObjectClassRegistration const* parent_class() const { return m_parent_class; }
|
||||
ErrorOr<NonnullRefPtr<Object>> construct() const { return m_factory(); }
|
||||
bool is_derived_from(ObjectClassRegistration const& base_class) const;
|
||||
|
||||
static void for_each(Function<void(ObjectClassRegistration const&)>);
|
||||
static ObjectClassRegistration const* find(StringView class_name);
|
||||
|
||||
private:
|
||||
StringView m_class_name;
|
||||
Function<ErrorOr<NonnullRefPtr<Object>>()> m_factory;
|
||||
ObjectClassRegistration* m_parent_class { nullptr };
|
||||
};
|
||||
|
||||
class Object : public Core::Object {
|
||||
C_OBJECT_ABSTRACT(Object);
|
||||
|
||||
public:
|
||||
virtual ~Object() override;
|
||||
|
||||
bool set_property(DeprecatedString const& name, JsonValue const& value);
|
||||
JsonValue property(DeprecatedString const& name) const;
|
||||
HashMap<DeprecatedString, NonnullOwnPtr<Property>> const& properties() const { return m_properties; }
|
||||
|
||||
protected:
|
||||
explicit Object(Core::Object* parent = nullptr);
|
||||
|
||||
void register_property(DeprecatedString const& name, Function<JsonValue()> getter, Function<bool(JsonValue const&)> setter = nullptr);
|
||||
|
||||
private:
|
||||
HashMap<DeprecatedString, NonnullOwnPtr<Property>> m_properties;
|
||||
};
|
||||
|
||||
}
|
||||
|
||||
#define REGISTER_INT_PROPERTY(property_name, getter, setter) \
|
||||
register_property( \
|
||||
property_name, \
|
||||
[this] { return this->getter(); }, \
|
||||
[this](auto& value) { \
|
||||
this->setter(value.template to_number<int>()); \
|
||||
return true; \
|
||||
});
|
||||
|
||||
#define REGISTER_BOOL_PROPERTY(property_name, getter, setter) \
|
||||
register_property( \
|
||||
property_name, \
|
||||
[this] { return this->getter(); }, \
|
||||
[this](auto& value) { \
|
||||
this->setter(value.to_bool()); \
|
||||
return true; \
|
||||
});
|
||||
|
||||
// FIXME: Port JsonValue to the new String class.
|
||||
#define REGISTER_STRING_PROPERTY(property_name, getter, setter) \
|
||||
register_property( \
|
||||
property_name, \
|
||||
[this]() { return this->getter().to_deprecated_string(); }, \
|
||||
[this](auto& value) { \
|
||||
this->setter(String::from_deprecated_string(value.to_deprecated_string()).release_value_but_fixme_should_propagate_errors()); \
|
||||
return true; \
|
||||
});
|
||||
|
||||
#define REGISTER_DEPRECATED_STRING_PROPERTY(property_name, getter, setter) \
|
||||
register_property( \
|
||||
property_name, \
|
||||
[this] { return this->getter(); }, \
|
||||
[this](auto& value) { \
|
||||
this->setter(value.to_deprecated_string()); \
|
||||
return true; \
|
||||
});
|
||||
|
||||
#define REGISTER_READONLY_STRING_PROPERTY(property_name, getter) \
|
||||
register_property( \
|
||||
property_name, \
|
||||
[this] { return this->getter(); }, \
|
||||
{});
|
||||
|
||||
#define REGISTER_WRITE_ONLY_STRING_PROPERTY(property_name, setter) \
|
||||
register_property( \
|
||||
property_name, \
|
||||
{}, \
|
||||
[this](auto& value) { \
|
||||
this->setter(value.to_deprecated_string()); \
|
||||
return true; \
|
||||
});
|
||||
|
||||
#define REGISTER_READONLY_SIZE_PROPERTY(property_name, getter) \
|
||||
register_property( \
|
||||
property_name, \
|
||||
[this] { \
|
||||
auto size = this->getter(); \
|
||||
JsonArray size_array; \
|
||||
size_array.must_append(size.width()); \
|
||||
size_array.must_append(size.height()); \
|
||||
return size_array; \
|
||||
}, \
|
||||
{});
|
||||
|
||||
#define REGISTER_RECT_PROPERTY(property_name, getter, setter) \
|
||||
register_property( \
|
||||
property_name, \
|
||||
[this] { \
|
||||
auto rect = this->getter(); \
|
||||
JsonObject rect_object; \
|
||||
rect_object.set("x"sv, rect.x()); \
|
||||
rect_object.set("y"sv, rect.y()); \
|
||||
rect_object.set("width"sv, rect.width()); \
|
||||
rect_object.set("height"sv, rect.height()); \
|
||||
return rect_object; \
|
||||
}, \
|
||||
[this](auto& value) { \
|
||||
Gfx::IntRect rect; \
|
||||
if (value.is_object()) { \
|
||||
rect.set_x(value.as_object().get_i32("x"sv).value_or(0)); \
|
||||
rect.set_y(value.as_object().get_i32("y"sv).value_or(0)); \
|
||||
rect.set_width(value.as_object().get_i32("width"sv).value_or(0)); \
|
||||
rect.set_height(value.as_object().get_i32("height"sv).value_or(0)); \
|
||||
} else if (value.is_array() && value.as_array().size() == 4) { \
|
||||
rect.set_x(value.as_array()[0].to_i32()); \
|
||||
rect.set_y(value.as_array()[1].to_i32()); \
|
||||
rect.set_width(value.as_array()[2].to_i32()); \
|
||||
rect.set_height(value.as_array()[3].to_i32()); \
|
||||
} else { \
|
||||
return false; \
|
||||
} \
|
||||
setter(rect); \
|
||||
\
|
||||
return true; \
|
||||
});
|
||||
|
||||
#define REGISTER_SIZE_PROPERTY(property_name, getter, setter) \
|
||||
register_property( \
|
||||
property_name, \
|
||||
[this] { \
|
||||
auto size = this->getter(); \
|
||||
JsonArray size_array; \
|
||||
size_array.must_append(size.width()); \
|
||||
size_array.must_append(size.height()); \
|
||||
return size_array; \
|
||||
}, \
|
||||
[this](auto& value) { \
|
||||
if (!value.is_array()) \
|
||||
return false; \
|
||||
Gfx::IntSize size; \
|
||||
size.set_width(value.as_array()[0].to_i32()); \
|
||||
size.set_height(value.as_array()[1].to_i32()); \
|
||||
setter(size); \
|
||||
return true; \
|
||||
});
|
||||
|
||||
#define REGISTER_ENUM_PROPERTY(property_name, getter, setter, EnumType, ...) \
|
||||
register_property( \
|
||||
property_name, \
|
||||
[this]() -> JsonValue { \
|
||||
struct { \
|
||||
EnumType enum_value; \
|
||||
DeprecatedString string_value; \
|
||||
} options[] = { __VA_ARGS__ }; \
|
||||
auto enum_value = getter(); \
|
||||
for (size_t i = 0; i < array_size(options); ++i) { \
|
||||
auto& option = options[i]; \
|
||||
if (enum_value == option.enum_value) \
|
||||
return option.string_value; \
|
||||
} \
|
||||
return JsonValue(); \
|
||||
}, \
|
||||
[this](auto& value) { \
|
||||
struct { \
|
||||
EnumType enum_value; \
|
||||
DeprecatedString string_value; \
|
||||
} options[] = { __VA_ARGS__ }; \
|
||||
if (!value.is_string()) \
|
||||
return false; \
|
||||
auto string_value = value.as_string(); \
|
||||
for (size_t i = 0; i < array_size(options); ++i) { \
|
||||
auto& option = options[i]; \
|
||||
if (string_value == option.string_value) { \
|
||||
setter(option.enum_value); \
|
||||
return true; \
|
||||
} \
|
||||
} \
|
||||
return false; \
|
||||
})
|
||||
|
||||
#define REGISTER_TEXT_ALIGNMENT_PROPERTY(property_name, getter, setter) \
|
||||
REGISTER_ENUM_PROPERTY( \
|
||||
property_name, getter, setter, Gfx::TextAlignment, \
|
||||
{ Gfx::TextAlignment::Center, "Center" }, \
|
||||
{ Gfx::TextAlignment::CenterLeft, "CenterLeft" }, \
|
||||
{ Gfx::TextAlignment::CenterRight, "CenterRight" }, \
|
||||
{ Gfx::TextAlignment::TopCenter, "TopCenter" }, \
|
||||
{ Gfx::TextAlignment::TopLeft, "TopLeft" }, \
|
||||
{ Gfx::TextAlignment::TopRight, "TopRight" }, \
|
||||
{ Gfx::TextAlignment::BottomCenter, "BottomCenter" }, \
|
||||
{ Gfx::TextAlignment::BottomLeft, "BottomLeft" }, \
|
||||
{ Gfx::TextAlignment::BottomRight, "BottomRight" })
|
||||
|
||||
#define REGISTER_FONT_WEIGHT_PROPERTY(property_name, getter, setter) \
|
||||
REGISTER_ENUM_PROPERTY( \
|
||||
property_name, getter, setter, unsigned, \
|
||||
{ Gfx::FontWeight::Thin, "Thin" }, \
|
||||
{ Gfx::FontWeight::ExtraLight, "ExtraLight" }, \
|
||||
{ Gfx::FontWeight::Light, "Light" }, \
|
||||
{ Gfx::FontWeight::Regular, "Regular" }, \
|
||||
{ Gfx::FontWeight::Medium, "Medium" }, \
|
||||
{ Gfx::FontWeight::SemiBold, "SemiBold" }, \
|
||||
{ Gfx::FontWeight::Bold, "Bold" }, \
|
||||
{ Gfx::FontWeight::ExtraBold, "ExtraBold" }, \
|
||||
{ Gfx::FontWeight::Black, "Black" }, \
|
||||
{ Gfx::FontWeight::ExtraBlack, "ExtraBlack" })
|
||||
|
||||
#define REGISTER_TEXT_WRAPPING_PROPERTY(property_name, getter, setter) \
|
||||
REGISTER_ENUM_PROPERTY( \
|
||||
property_name, getter, setter, Gfx::TextWrapping, \
|
||||
{ Gfx::TextWrapping::Wrap, "Wrap" }, \
|
||||
{ Gfx::TextWrapping::DontWrap, "DontWrap" })
|
|
@ -5,9 +5,9 @@
|
|||
* SPDX-License-Identifier: BSD-2-Clause
|
||||
*/
|
||||
|
||||
#include <LibCore/Property.h>
|
||||
#include <LibGUI/Property.h>
|
||||
|
||||
namespace Core {
|
||||
namespace GUI {
|
||||
|
||||
Property::Property(DeprecatedString name, Function<JsonValue()> getter, Function<bool(JsonValue const&)> setter)
|
||||
: m_name(move(name))
|
|
@ -10,7 +10,7 @@
|
|||
#include <AK/Function.h>
|
||||
#include <AK/JsonValue.h>
|
||||
|
||||
namespace Core {
|
||||
namespace GUI {
|
||||
|
||||
class Property {
|
||||
AK_MAKE_NONCOPYABLE(Property);
|
|
@ -130,7 +130,7 @@ ErrorOr<void> ScrollableContainerWidget::load_from_gml_ast(NonnullRefPtr<GUI::GM
|
|||
auto class_name = content_widget.name();
|
||||
|
||||
RefPtr<Core::Object> child;
|
||||
if (auto* registration = Core::ObjectClassRegistration::find(class_name)) {
|
||||
if (auto* registration = GUI::ObjectClassRegistration::find(class_name)) {
|
||||
child = TRY(registration->construct());
|
||||
} else {
|
||||
child = TRY(unregistered_child_handler(class_name));
|
||||
|
|
|
@ -31,17 +31,27 @@
|
|||
#include <LibGfx/SystemTheme.h>
|
||||
#include <unistd.h>
|
||||
|
||||
REGISTER_CORE_OBJECT(GUI, Widget)
|
||||
REGISTER_GUI_OBJECT(GUI, Widget)
|
||||
|
||||
namespace GUI {
|
||||
|
||||
Widget::Widget()
|
||||
: Core::Object(nullptr)
|
||||
, m_background_role(Gfx::ColorRole::Window)
|
||||
: m_background_role(Gfx::ColorRole::Window)
|
||||
, m_foreground_role(Gfx::ColorRole::WindowText)
|
||||
, m_font(Gfx::FontDatabase::default_font())
|
||||
, m_palette(Application::the()->palette().impl())
|
||||
{
|
||||
REGISTER_READONLY_STRING_PROPERTY("class_name", class_name);
|
||||
REGISTER_DEPRECATED_STRING_PROPERTY("name", name, set_name);
|
||||
|
||||
register_property(
|
||||
"address", [this] { return FlatPtr(this); },
|
||||
[](auto&) { return false; });
|
||||
|
||||
register_property(
|
||||
"parent", [this] { return FlatPtr(this->parent()); },
|
||||
[](auto&) { return false; });
|
||||
|
||||
REGISTER_RECT_PROPERTY("relative_rect", relative_rect, set_relative_rect);
|
||||
REGISTER_BOOL_PROPERTY("fill_with_background_color", fill_with_background_color, set_fill_with_background_color);
|
||||
REGISTER_BOOL_PROPERTY("visible", is_visible, set_visible);
|
||||
|
@ -1170,8 +1180,8 @@ ErrorOr<void> Widget::load_from_gml_ast(NonnullRefPtr<GUI::GML::Node const> ast,
|
|||
return Error::from_string_literal("Invalid layout class name");
|
||||
}
|
||||
|
||||
auto& layout_class = *Core::ObjectClassRegistration::find("GUI::Layout"sv);
|
||||
if (auto* registration = Core::ObjectClassRegistration::find(class_name)) {
|
||||
auto& layout_class = *GUI::ObjectClassRegistration::find("GUI::Layout"sv);
|
||||
if (auto* registration = GUI::ObjectClassRegistration::find(class_name)) {
|
||||
auto layout = TRY(registration->construct());
|
||||
if (!registration->is_derived_from(layout_class)) {
|
||||
dbgln("Invalid layout class: '{}'", class_name.to_deprecated_string());
|
||||
|
@ -1188,7 +1198,7 @@ ErrorOr<void> Widget::load_from_gml_ast(NonnullRefPtr<GUI::GML::Node const> ast,
|
|||
});
|
||||
}
|
||||
|
||||
auto& widget_class = *Core::ObjectClassRegistration::find("GUI::Widget"sv);
|
||||
auto& widget_class = *GUI::ObjectClassRegistration::find("GUI::Widget"sv);
|
||||
bool is_tab_widget = is<TabWidget>(*this);
|
||||
TRY(object.try_for_each_child_object([&](auto const& child_data) -> ErrorOr<void> {
|
||||
auto class_name = child_data.name();
|
||||
|
@ -1201,7 +1211,7 @@ ErrorOr<void> Widget::load_from_gml_ast(NonnullRefPtr<GUI::GML::Node const> ast,
|
|||
this->layout()->add_spacer();
|
||||
} else {
|
||||
RefPtr<Core::Object> child;
|
||||
if (auto* registration = Core::ObjectClassRegistration::find(class_name)) {
|
||||
if (auto* registration = GUI::ObjectClassRegistration::find(class_name)) {
|
||||
child = TRY(registration->construct());
|
||||
if (!registration->is_derived_from(widget_class)) {
|
||||
dbgln("Invalid widget class: '{}'", class_name);
|
||||
|
|
|
@ -13,13 +13,14 @@
|
|||
#include <AK/Optional.h>
|
||||
#include <AK/String.h>
|
||||
#include <AK/Variant.h>
|
||||
#include <LibCore/Object.h>
|
||||
#include <LibCore/Timer.h>
|
||||
#include <LibGUI/Event.h>
|
||||
#include <LibGUI/FocusPolicy.h>
|
||||
#include <LibGUI/Forward.h>
|
||||
#include <LibGUI/GML/AST.h>
|
||||
#include <LibGUI/Margins.h>
|
||||
#include <LibGUI/Object.h>
|
||||
#include <LibGUI/Property.h>
|
||||
#include <LibGUI/UIDimensions.h>
|
||||
#include <LibGfx/Color.h>
|
||||
#include <LibGfx/Forward.h>
|
||||
|
@ -27,14 +28,14 @@
|
|||
#include <LibGfx/Rect.h>
|
||||
#include <LibGfx/StandardCursor.h>
|
||||
|
||||
namespace Core::Registration {
|
||||
extern Core::ObjectClassRegistration registration_Widget;
|
||||
namespace GUI::Registration {
|
||||
extern GUI::ObjectClassRegistration registration_Widget;
|
||||
}
|
||||
|
||||
#define REGISTER_WIDGET(namespace_, class_name) \
|
||||
namespace Core::Registration { \
|
||||
Core::ObjectClassRegistration registration_##class_name( \
|
||||
#namespace_ "::" #class_name##sv, []() -> ErrorOr<NonnullRefPtr<Core::Object>> { return static_ptr_cast<Core::Object>(TRY(namespace_::class_name::try_create())); }, ®istration_Widget); \
|
||||
#define REGISTER_WIDGET(namespace_, class_name) \
|
||||
namespace GUI::Registration { \
|
||||
GUI::ObjectClassRegistration registration_##class_name( \
|
||||
#namespace_ "::" #class_name##sv, []() -> ErrorOr<NonnullRefPtr<GUI::Object>> { return static_ptr_cast<GUI::Object>(TRY(namespace_::class_name::try_create())); }, ®istration_Widget); \
|
||||
}
|
||||
|
||||
namespace GUI {
|
||||
|
@ -70,7 +71,7 @@ enum class AllowCallback {
|
|||
Yes
|
||||
};
|
||||
|
||||
class Widget : public Core::Object {
|
||||
class Widget : public GUI::Object {
|
||||
C_OBJECT(Widget)
|
||||
public:
|
||||
virtual ~Widget() override;
|
||||
|
|
|
@ -72,7 +72,7 @@ Window* Window::from_window_id(int window_id)
|
|||
}
|
||||
|
||||
Window::Window(Core::Object* parent)
|
||||
: Core::Object(parent)
|
||||
: GUI::Object(parent)
|
||||
, m_menubar(Menubar::construct())
|
||||
{
|
||||
if (parent)
|
||||
|
|
|
@ -13,9 +13,9 @@
|
|||
#include <AK/OwnPtr.h>
|
||||
#include <AK/Variant.h>
|
||||
#include <AK/WeakPtr.h>
|
||||
#include <LibCore/Object.h>
|
||||
#include <LibGUI/FocusSource.h>
|
||||
#include <LibGUI/Forward.h>
|
||||
#include <LibGUI/Object.h>
|
||||
#include <LibGUI/ResizeDirection.h>
|
||||
#include <LibGUI/WindowMode.h>
|
||||
#include <LibGUI/WindowType.h>
|
||||
|
@ -27,7 +27,7 @@ namespace GUI {
|
|||
|
||||
class WindowBackingStore;
|
||||
|
||||
class Window : public Core::Object {
|
||||
class Window : public GUI::Object {
|
||||
C_OBJECT(Window)
|
||||
public:
|
||||
virtual ~Window() override;
|
||||
|
|
|
@ -16,11 +16,6 @@ Thread::Thread(Function<intptr_t()> action, StringView thread_name)
|
|||
, m_action(move(action))
|
||||
, m_thread_name(thread_name.is_null() ? ""sv : thread_name)
|
||||
{
|
||||
register_property("thread_name", [&] { return JsonValue { m_thread_name }; });
|
||||
#if defined(AK_OS_SERENITY) || defined(AK_OS_LINUX)
|
||||
// FIXME: Print out a pretty TID for BSD and macOS platforms, too
|
||||
register_property("tid", [&] { return JsonValue { m_tid }; });
|
||||
#endif
|
||||
}
|
||||
|
||||
Thread::~Thread()
|
||||
|
|
|
@ -6,6 +6,7 @@
|
|||
* SPDX-License-Identifier: BSD-2-Clause
|
||||
*/
|
||||
|
||||
#include <AK/JsonValue.h>
|
||||
#include <LibCore/ArgsParser.h>
|
||||
#include <LibCore/ConfigFile.h>
|
||||
#include <LibCore/StandardPaths.h>
|
||||
|
|
Loading…
Reference in a new issue