/* * Copyright (c) 2018-2021, Andreas Kling * Copyright (c) 2022, the SerenityOS developers. * * SPDX-License-Identifier: BSD-2-Clause */ #pragma once #include #include #include #include #include #include #include #include #include #include #include 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>()> 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> construct() const { return m_factory(); } bool is_derived_from(ObjectClassRegistration const& base_class) const; static void for_each(Function); static ObjectClassRegistration const* find(StringView class_name); private: StringView m_class_name; Function>()> m_factory; ObjectClassRegistration* m_parent_class { nullptr }; }; class InspectorServerConnection; enum class TimerShouldFireWhenNotVisible { No = 0, Yes }; #define C_OBJECT(klass) \ public: \ virtual StringView class_name() const override \ { \ return #klass##sv; \ } \ template \ static NonnullRefPtr construct(Args&&... args) \ { \ return adopt_ref(*new Klass(::forward(args)...)); \ } \ template \ static ErrorOr> try_create(Args&&... args) \ { \ return adopt_nonnull_ref_or_enomem(new (nothrow) Klass(::forward(args)...)); \ } #define C_OBJECT_ABSTRACT(klass) \ public: \ virtual StringView class_name() const override \ { \ return #klass##sv; \ } class Object : public RefCounted , public Weakable { // NOTE: No C_OBJECT macro for Core::Object itself. AK_MAKE_NONCOPYABLE(Object); AK_MAKE_NONMOVABLE(Object); IntrusiveListNode m_all_objects_list_node; public: virtual ~Object(); virtual StringView class_name() const = 0; template bool fast_is() const = delete; virtual bool is_widget() const { return false; } DeprecatedString const& name() const { return m_name; } void set_name(DeprecatedString name) { m_name = move(name); } Vector>& children() { return m_children; } Vector> const& children() const { return m_children; } template void for_each_child(Callback callback) { for (auto& child : m_children) { if (callback(*child) == IterationDecision::Break) return; } } template void for_each_child_of_type(Callback callback) requires IsBaseOf; template T* find_child_of_type_named(DeprecatedString const&) requires IsBaseOf; template T* find_descendant_of_type_named(DeprecatedString const&) requires IsBaseOf; bool is_ancestor_of(Object const&) const; Object* parent() { return m_parent; } Object const* parent() const { return m_parent; } void start_timer(int ms, TimerShouldFireWhenNotVisible = TimerShouldFireWhenNotVisible::No); void stop_timer(); bool has_timer() const { return m_timer_id; } ErrorOr try_add_child(Object&); void add_child(Object&); void insert_child_before(Object& new_child, Object& before_child); void remove_child(Object&); void remove_all_children(); void set_event_filter(Function); void dump_tree(int indent = 0); void deferred_invoke(Function); void save_to(JsonObject&); bool set_property(DeprecatedString const& name, JsonValue const& value); JsonValue property(DeprecatedString const& name) const; HashMap> 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); void remove_from_parent() { if (m_parent) m_parent->remove_child(*this); } template inline T& add(Args&&... args) { auto child = T::construct(forward(args)...); add_child(*child); return child; } template inline ErrorOr> try_add(Args&&... args) { auto child = TRY(T::try_create(forward(args)...)); TRY(try_add_child(*child)); return child; } virtual bool is_visible_for_timer_purposes() const; bool is_being_inspected() const { return m_inspector_count; } void increment_inspector_count(Badge); void decrement_inspector_count(Badge); protected: explicit Object(Object* parent = nullptr); void register_property(DeprecatedString const& name, Function getter, Function setter = nullptr); virtual void event(Core::Event&); virtual void timer_event(TimerEvent&); virtual void custom_event(CustomEvent&); // NOTE: You may get child events for children that are not yet fully constructed! virtual void child_event(ChildEvent&); virtual void did_begin_inspection() { } virtual void did_end_inspection() { } private: Object* m_parent { nullptr }; DeprecatedString m_name; int m_timer_id { 0 }; unsigned m_inspector_count { 0 }; HashMap> m_properties; Vector> m_children; Function m_event_filter; }; } template<> struct AK::Formatter : AK::Formatter { ErrorOr format(FormatBuilder& builder, Core::Object const& value) { return AK::Formatter::format(builder, "{}({})"sv, value.class_name(), &value); } }; namespace Core { template inline void Object::for_each_child_of_type(Callback callback) requires IsBaseOf { for_each_child([&](auto& child) { if (is(child)) return callback(static_cast(child)); return IterationDecision::Continue; }); } template T* Object::find_child_of_type_named(DeprecatedString const& name) requires IsBaseOf { T* found_child = nullptr; for_each_child_of_type([&](auto& child) { if (child.name() == name) { found_child = &child; return IterationDecision::Break; } return IterationDecision::Continue; }); return found_child; } template T* Object::find_descendant_of_type_named(DeprecatedString const& name) requires IsBaseOf { if (is(*this) && this->name() == name) { return static_cast(this); } T* found_child = nullptr; for_each_child([&](auto& child) { found_child = child.template find_descendant_of_type_named(name); if (found_child) return IterationDecision::Break; return IterationDecision::Continue; }); 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()); \ 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" }) }