Libraries: Move to Userland/Libraries/

1 files changed, 346 insertions, 0 deletions

diff --git a/Userland/Libraries/LibCore/Object.h b/Userland/Libraries/LibCore/Object.h
new file mode 100644
index 0000000000..9270d347d0
--- /dev/null
+++ b/Userland/Libraries/LibCore/Object.h
@@ -0,0 +1,346 @@
+/*
+ * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#pragma once
+
+#include <AK/Forward.h>
+#include <AK/HashMap.h>
+#include <AK/IntrusiveList.h>
+#include <AK/Noncopyable.h>
+#include <AK/NonnullRefPtrVector.h>
+#include <AK/String.h>
+#include <AK/TypeCasts.h>
+#include <AK/Weakable.h>
+#include <LibCore/Forward.h>
+#include <LibCore/Property.h>
+
+namespace Core {
+
+class RPCClient;
+
+enum class TimerShouldFireWhenNotVisible {
+    No = 0,
+    Yes
+};
+
+#define C_OBJECT(klass)                                                \
+public:                                                                \
+    virtual const char* class_name() const override { return #klass; } \
+    template<class... Args>                                            \
+    static inline NonnullRefPtr<klass> construct(Args&&... args)       \
+    {                                                                  \
+        return adopt(*new klass(forward<Args>(args)...));              \
+    }
+
+#define C_OBJECT_ABSTRACT(klass) \
+public:                          \
+    virtual const char* class_name() const override { return #klass; }
+
+class Object
+    : public RefCounted<Object>
+    , public Weakable<Object> {
+    // 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 const char* class_name() const = 0;
+    virtual void event(Core::Event&);
+
+    const String& name() const { return m_name; }
+    void set_name(const StringView& name) { m_name = name; }
+
+    NonnullRefPtrVector<Object>& children() { return m_children; }
+    const NonnullRefPtrVector<Object>& children() const { return m_children; }
+
+    template<typename Callback>
+    void for_each_child(Callback callback)
+    {
+        for (auto& child : m_children) {
+            if (callback(child) == IterationDecision::Break)
+                return;
+        }
+    }
+
+    template<typename T, typename Callback>
+    void for_each_child_of_type(Callback callback) requires IsBaseOf<Object, T>::value;
+
+    template<typename T>
+    T* find_child_of_type_named(const String&) requires IsBaseOf<Object, T>::value;
+
+    template<typename T>
+    T* find_descendant_of_type_named(const String&) requires IsBaseOf<Object, T>::value;
+
+    bool is_ancestor_of(const Object&) const;
+
+    Object* parent() { return m_parent; }
+    const Object* parent() const { return m_parent; }
+
+    void start_timer(int ms, TimerShouldFireWhenNotVisible = TimerShouldFireWhenNotVisible::No);
+    void stop_timer();
+    bool has_timer() const { return m_timer_id; }
+
+    void add_child(Object&);
+    void insert_child_before(Object& new_child, Object& before_child);
+    void remove_child(Object&);
+    void remove_all_children();
+
+    void dump_tree(int indent = 0);
+
+    void deferred_invoke(Function<void(Object&)>);
+
+    void save_to(AK::JsonObject&);
+
+    bool set_property(const StringView& name, const JsonValue& value);
+    JsonValue property(const StringView& name) const;
+    const HashMap<String, NonnullOwnPtr<Property>>& properties() const { return m_properties; }
+
+    static IntrusiveList<Object, &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<class T, class... Args>
+    inline T& add(Args&&... args)
+    {
+        auto child = T::construct(forward<Args>(args)...);
+        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<RPCClient>);
+    void decrement_inspector_count(Badge<RPCClient>);
+
+protected:
+    explicit Object(Object* parent = nullptr);
+
+    void register_property(const String& name, Function<JsonValue()> getter, Function<bool(const JsonValue&)> setter = nullptr);
+
+    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 };
+    String m_name;
+    int m_timer_id { 0 };
+    unsigned m_inspector_count { 0 };
+    HashMap<String, NonnullOwnPtr<Property>> m_properties;
+    NonnullRefPtrVector<Object> m_children;
+};
+
+}
+
+template<>
+struct AK::Formatter<Core::Object> : AK::Formatter<FormatString> {
+    void format(FormatBuilder& builder, const Core::Object& value)
+    {
+        return AK::Formatter<FormatString>::format(builder, "{}({})", value.class_name(), &value);
+    }
+};
+
+namespace Core {
+template<typename T, typename Callback>
+inline void Object::for_each_child_of_type(Callback callback) requires IsBaseOf<Object, T>::value
+{
+    for_each_child([&](auto& child) {
+        if (auto* child_as_t = dynamic_cast<T*>(&child); child_as_t)
+            return callback(*child_as_t);
+        return IterationDecision::Continue;
+    });
+}
+
+template<typename T>
+T* Object::find_child_of_type_named(const String& name) requires IsBaseOf<Object, T>::value
+{
+    T* found_child = nullptr;
+    for_each_child_of_type<T>([&](auto& child) {
+        if (child.name() == name) {
+            found_child = &child;
+            return IterationDecision::Break;
+        }
+        return IterationDecision::Continue;
+    });
+
+    return found_child;
+}
+
+template<typename T>
+T* Object::find_descendant_of_type_named(const String& name) requires IsBaseOf<Object, T>::value
+{
+    auto* this_as_t = dynamic_cast<T*>(this);
+    if (this_as_t && this->name() == name)
+        return this_as_t;
+    T* found_child = nullptr;
+    for_each_child([&](auto& child) {
+        found_child = child.template find_descendant_of_type_named<T>(name);
+        if (found_child)
+            return IterationDecision::Break;
+        return IterationDecision::Continue;
+    });
+    return found_child;
+}
+
+const LogStream& operator<<(const LogStream&, const Object&);
+
+#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;                                      \
+        });
+
+#define REGISTER_STRING_PROPERTY(property_name, getter, setter) \
+    register_property(                                          \
+        property_name,                                          \
+        [this] { return this->getter(); },                      \
+        [this](auto& value) {                                   \
+            this->setter(value.to_string());                    \
+            return true;                                        \
+        });
+
+#define REGISTER_READONLY_STRING_PROPERTY(property_name, getter) \
+    register_property(                                           \
+        property_name,                                           \
+        [this] { return this->getter(); },                       \
+        {});
+
+#define REGISTER_RECT_PROPERTY(property_name, getter, setter)          \
+    register_property(                                                 \
+        property_name,                                                 \
+        [this] {                                                       \
+            auto rect = this->getter();                                \
+            JsonObject rect_object;                                    \
+            rect_object.set("x", rect.x());                            \
+            rect_object.set("y", rect.y());                            \
+            rect_object.set("width", rect.width());                    \
+            rect_object.set("height", rect.height());                  \
+            return rect_object;                                        \
+        },                                                             \
+        [this](auto& value) {                                          \
+            if (!value.is_object())                                    \
+                return false;                                          \
+            Gfx::IntRect rect;                                         \
+            rect.set_x(value.as_object().get("x").to_i32());           \
+            rect.set_y(value.as_object().get("y").to_i32());           \
+            rect.set_width(value.as_object().get("width").to_i32());   \
+            rect.set_height(value.as_object().get("height").to_i32()); \
+            setter(rect);                                              \
+            return true;                                               \
+        });
+
+#define REGISTER_SIZE_PROPERTY(property_name, getter, setter)          \
+    register_property(                                                 \
+        property_name,                                                 \
+        [this] {                                                       \
+            auto size = this->getter();                                \
+            JsonObject size_object;                                    \
+            size_object.set("width", size.width());                    \
+            size_object.set("height", size.height());                  \
+            return size_object;                                        \
+        },                                                             \
+        [this](auto& value) {                                          \
+            if (!value.is_object())                                    \
+                return false;                                          \
+            Gfx::IntSize size;                                         \
+            size.set_width(value.as_object().get("width").to_i32());   \
+            size.set_height(value.as_object().get("height").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;                                         \
+                String 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;                                         \
+                String string_value;                                         \
+            } options[] = { __VA_ARGS__ };                                   \
+            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::TopLeft, "TopLeft" },                     \
+        { Gfx::TextAlignment::CenterLeft, "CenterLeft" },               \
+        { Gfx::TextAlignment::Center, "Center" },                       \
+        { Gfx::TextAlignment::CenterRight, "CenterRight" },             \
+        { Gfx::TextAlignment::TopRight, "TopRight" },                   \
+        { Gfx::TextAlignment::BottomRight, "BottomRight" })
+}