xref: /dports/x11-wm/wayfire/wayfire-0.7.0/src/api/wayfire/object.hpp

#ifndef OBJECT_HPP
#define OBJECT_HPP

#include <typeinfo>
#include <memory>
#include <string>

#include <wayfire/nonstd/observer_ptr.h>
#include <wayfire/nonstd/noncopyable.hpp>

namespace wf
{
/**
 * signal_data_t is the base class for all signal data.
 */
struct signal_data_t
{
    virtual ~signal_data_t()
    {}
};

using signal_callback_t = std::function<void (signal_data_t*)>;
class signal_provider_t;

/**
 * Provides an interface to connect to signal providers.
 *
 * The same signal connection object can be used to connect to multiple signal
 * providers.
 */
class signal_connection_t : public noncopyable_t
{
  public:
    /** Initialize an empty signal connection */
    signal_connection_t();
    /** Automatically disconnects from all providers */
    ~signal_connection_t();

    /** Initialize a signal connection with the given callback */
    template<class T> using convertible_to_callback_t =
        std::enable_if_t<std::is_constructible_v<wf::signal_callback_t, T>, void>;
    template<class T, class U = convertible_to_callback_t<T>>
    signal_connection_t(T callback) : signal_connection_t()
    {
        set_callback(callback);
    }

    /** Set the signal callback or override the existing signal callback. */
    void set_callback(signal_callback_t callback);

    /** Call the stored callback with the given data. */
    void emit(signal_data_t *data);

    /** Disconnect from all connected signal providers */
    void disconnect();

    class impl;
    std::unique_ptr<impl> priv;

  private:
    /* Non-movable, non-copyable */
    signal_connection_t(signal_connection_t&& other) = delete;
    signal_connection_t& operator =(signal_connection_t&& other) = delete;
};

class signal_provider_t
{
  public:
    /** Register a connection to be called when the given signal is emitted. */
    void connect_signal(std::string name, signal_connection_t *callback);
    /** Unregister a connection. */
    void disconnect_signal(signal_connection_t *callback);

    /**
     * Deprecated.
     * Register a callback to be called whenever the given signal is emitted
     */
    void connect_signal(std::string name, signal_callback_t *callback);
    /**
     * Deprecated.
     * Unregister a registered callback.
     */
    void disconnect_signal(std::string name, signal_callback_t *callback);

    /** Emit the given signal. No type checking for data is required */
    void emit_signal(std::string name, signal_data_t *data);

    virtual ~signal_provider_t();

  protected:
    signal_provider_t();

  private:
    class sprovider_impl;
    std::unique_ptr<sprovider_impl> sprovider_priv;
};

/**
 * Subclasses of custom_data_t can be stored inside an object_base_t
 */
class custom_data_t
{
  public:
    virtual ~custom_data_t()
    {}
};

/**
 * A base class for "objects". Objects provide signals and ways for plugins to
 * store custom data about the object.
 */
class object_base_t : public signal_provider_t
{
  public:
    /** Get a human-readable description of the object */
    std::string to_string() const;

    /** Get the ID of the object. Each object has a unique ID */
    uint32_t get_id() const;

    /**
     * Retrieve custom data stored with the given name. If no such data exists,
     * then it is created with the default constructor.
     *
     * REQUIRES a default constructor
     * If your type doesn't have one, use store_data + get_data
     */
    template<class T>
    nonstd::observer_ptr<T> get_data_safe(
        std::string name = typeid(T).name())
    {
        auto data = get_data<T>(name);
        if (data)
        {
            return data;
        } else
        {
            store_data<T>(std::make_unique<T>(), name);

            return get_data<T>(name);
        }
    }

    /* Retrieve custom data stored with the given name. If no such
     * data exists, NULL is returned */
    template<class T>
    nonstd::observer_ptr<T> get_data(
        std::string name = typeid(T).name())
    {
        return nonstd::make_observer(dynamic_cast<T*>(_fetch_data(name)));
    }

    /* Assigns the given data to the given name */
    template<class T>
    void store_data(std::unique_ptr<T> stored_data,
        std::string name = typeid(T).name())
    {
        _store_data(std::move(stored_data), name);
    }

    /* Returns true if there is saved data under the given name */
    template<class T>
    bool has_data()
    {
        return has_data(typeid(T).name());
    }

    /** @return true if there is saved data with the given name */
    bool has_data(std::string name);

    /** Remove the saved data under the given name */
    void erase_data(std::string name);

    /** Remove the saved data for the type T */
    template<class T>
    void erase_data()
    {
        erase_data(typeid(T).name());
    }

    /* Erase the saved data from the store and return the pointer */
    template<class T>
    std::unique_ptr<T> release_data(
        std::string name = typeid(T).name())
    {
        if (!has_data(name))
        {
            return {nullptr};
        }

        auto stored = _fetch_erase(name);

        return std::unique_ptr<T>(dynamic_cast<T*>(stored));
    }

    virtual ~object_base_t();

  protected:
    object_base_t();

    /** Clear all stored data. */
    void _clear_data();

  private:
    /** Just get the data under the given name, or nullptr, if it does not exist */
    custom_data_t *_fetch_data(std::string name);
    /** Get the data under the given name, and release the pointer, deleting
     * the entry in the map */
    custom_data_t *_fetch_erase(std::string name);

    /** Store the given data under the given name */
    void _store_data(std::unique_ptr<custom_data_t> data, std::string name);

    class obase_impl;
    std::unique_ptr<obase_impl> obase_priv;
};
}

#endif /* end of include guard: OBJECT_HPP */