mirror of
https://github.com/RGBCube/serenity
synced 2025-07-27 22:57:44 +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:
Andreas Kling
parent
9f6ceff7cf
commit
405187993a
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" })
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,19 +0,0 @@
|
|||
/*
|
||||
* Copyright (c) 2020, Andreas Kling <kling@serenityos.org>
|
||||
* Copyright (c) 2022, the SerenityOS developers.
|
||||
*
|
||||
* SPDX-License-Identifier: BSD-2-Clause
|
||||
*/
|
||||
|
||||
#include <LibCore/Property.h>
|
||||
|
||||
namespace Core {
|
||||
|
||||
Property::Property(DeprecatedString name, Function<JsonValue()> getter, Function<bool(JsonValue const&)> setter)
|
||||
: m_name(move(name))
|
||||
, m_getter(move(getter))
|
||||
, m_setter(move(setter))
|
||||
{
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -1,45 +0,0 @@
|
|||
/*
|
||||
* Copyright (c) 2020, Andreas Kling <kling@serenityos.org>
|
||||
* Copyright (c) 2022, the SerenityOS developers.
|
||||
*
|
||||
* SPDX-License-Identifier: BSD-2-Clause
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <AK/Function.h>
|
||||
#include <AK/JsonValue.h>
|
||||
|
||||
namespace Core {
|
||||
|
||||
class Property {
|
||||
AK_MAKE_NONCOPYABLE(Property);
|
||||
|
||||
public:
|
||||
Property(DeprecatedString name, Function<JsonValue()> getter, Function<bool(JsonValue const&)> setter = nullptr);
|
||||
~Property() = default;
|
||||
|
||||
bool set(JsonValue const& value)
|
||||
{
|
||||
if (!m_setter)
|
||||
return false;
|
||||
return m_setter(value);
|
||||
}
|
||||
|
||||
JsonValue get() const
|
||||
{
|
||||
if (!m_getter)
|
||||
return {};
|
||||
return m_getter();
|
||||
}
|
||||
|
||||
DeprecatedString const& name() const { return m_name; }
|
||||
bool is_readonly() const { return !m_setter; }
|
||||
|
||||
private:
|
||||
DeprecatedString m_name;
|
||||
Function<JsonValue()> m_getter;
|
||||
Function<bool(JsonValue const&)> m_setter;
|
||||
};
|
||||
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue