rpc_hub.hpp

Go to the documentation of this file.

#pragma once
 
#include <nui/window.hpp>
#include <nui/data_structures/selectables_registry.hpp>
#include <nui/utility/meta/pick_first.hpp>
#include <nui/shared/on_destroy.hpp>
 
#include <traits/functions.hpp>
#include <nlohmann/json.hpp>
#include <fmt/format.h>
 
#include <memory>
#include <string>
#include <tuple>
#include <utility>
#include <functional>
#include <unordered_map>
#include <mutex>
 
namespace Nui
{
    namespace Detail
    {
        template <typename ReturnType, typename ArgsTypes, typename IndexSeq>
        struct FunctionWrapperImpl
        {};
 
        template <typename ArgT>
        constexpr static auto extractJsonMember(nlohmann::json const& json) -> decltype(auto)
        {
            if constexpr (std::is_same_v<std::decay_t<ArgT>, nlohmann::json>)
                return json;
            else
                return json.get<std::decay_t<ArgT>>();
        }
 
        template <typename ReturnType>
        struct FunctionWrapperImpl<ReturnType, std::tuple<nlohmann::json>, std::index_sequence<0>>
        {
            template <typename FunctionT>
            constexpr static auto wrapFunction(FunctionT&& func)
            {
                return [func = std::forward<FunctionT>(func)](nlohmann::json const& args) mutable {
                    func(args);
                };
            }
        };
 
        template <typename ReturnType, typename... ArgsTypes, std::size_t... Is>
        struct FunctionWrapperImpl<ReturnType, std::tuple<ArgsTypes...>, std::index_sequence<Is...>>
        {
            template <typename FunctionT>
            constexpr static auto wrapFunction(FunctionT&& func)
            {
                return [func = std::forward<FunctionT>(func)](nlohmann::json const& args) mutable {
                    func(extractJsonMember<ArgsTypes>(args[Is])...);
                };
            }
        };
 
        template <typename ReturnType, typename ArgsTypes>
        struct FunctionWrapperImpl2
        {};
 
        template <typename ReturnType, typename... ArgsTypes>
        struct FunctionWrapperImpl2<ReturnType, std::tuple<ArgsTypes...>>
            : public FunctionWrapperImpl<ReturnType, std::tuple<ArgsTypes...>, std::index_sequence_for<ArgsTypes...>>
        {};
 
        template <typename FunctionT>
        struct FunctionWrapper
            : public FunctionWrapperImpl2<
                  typename Traits::FunctionTraits<std::decay_t<FunctionT>>::ReturnType,
                  typename Traits::FunctionTraits<std::decay_t<FunctionT>>::ArgsTuple>
        {};
    }
 
    class RpcHub
    {
      public:
        explicit RpcHub(Window& window);
        ~RpcHub() = default;
        RpcHub(const RpcHub&) = delete;
        RpcHub& operator=(const RpcHub&) = delete;
        RpcHub(RpcHub&&) = delete;
        RpcHub& operator=(RpcHub&&) = delete;
 
        constexpr static char const* remoteCallScript = R"(
            (function() {{
                if (globalThis.nui_rpc.frontend.hasOwnProperty("{0}")) {{
                    globalThis.nui_rpc.frontend["{0}"]({1});
                    return;
                }}
 
                globalThis.nui_rpc.errors = globalThis.nui_rpc.errors || [];
                globalThis.nui_rpc.errors.push("Function {0} does not exist.");
                if (globalThis.nui_rpc.errors.length > 100) {{
                    globalThis.nui_rpc.errors.shift();
                }}
            }})();
        )";
 
        struct AutoUnregister : public OnDestroy
        {
            AutoUnregister(RpcHub const* hub, std::string name)
                : OnDestroy{[hub, name = std::move(name)]() {
                    hub->unregisterFunction(name);
                }}
            {}
        };
 
        template <typename T>
        AutoUnregister autoRegisterFunction(std::string const& name, T&& func) const
        {
            registerFunction(name, std::forward<T>(func));
            return AutoUnregister{this, name};
        }
 
        template <typename T>
        void registerFunction(std::string const& name, T&& func) const
        {
            // window is threadsafe
            window_->bind(name, Detail::FunctionWrapper<T>::wrapFunction(std::forward<T>(func)));
        }
        void unregisterFunction(std::string const& name) const
        {
            // window is threadsafe
            window_->unbind(name);
        }
 
        Window& window() const
        {
            return *window_;
        }
 
        template <typename... Args>
        void callRemote(std::string const& name, Args&&... args) const
        {
            callRemoteImpl(name, nlohmann::json{std::forward<Args>(args)...});
        }
        template <typename Arg>
        void callRemote(std::string const& name, Arg&& arg) const
        {
            nlohmann::json json = std::forward<Arg>(arg);
            callRemoteImpl(name, json);
        }
        void callRemote(std::string const& name, nlohmann::json const& json) const
        {
            callRemoteImpl(name, json);
        }
        // I dont want to remove this overload in case there are some rvalue nlohmanns?
        // NOLINTNEXTLINE(cppcoreguidelines-rvalue-reference-param-not-moved)
        void callRemote(std::string const& name, nlohmann::json&& json) const
        {
            callRemoteImpl(name, json);
        }
        void callRemote(std::string const& name) const
        {
            callRemoteImpl(name);
        }
 
        // alias for callRemote
        template <typename... Args>
        void call(std::string const& name, Args&&... args) const
        {
            callRemote(name, std::forward<Args>(args)...);
        }
 
        void enableFileDialogs() const;
 
        void enableFile();
 
        void enableWindowFunctions() const;
 
        void enableFetch() const;
 
        void enableThrottle();
 
        void enableTimer();
 
        void enableScreen();
 
        void enableEnvironmentVariables();
 
        void enableAll();
 
        template <typename ManagerT>
        void* accessStateStore(std::string const& id)
        {
            std::scoped_lock lock{guard_};
            auto iter = stateStores_.find(id);
            if (iter == stateStores_.end())
            {
                return stateStores_
                    .insert(
                        {id,
                         std::unique_ptr<void, std::function<void(void*)>>{
                             ManagerT::create(),
                             [](void* ptr) {
                                 ManagerT::destroy(ptr);
                             }}})
                    .first->second.get();
            }
            return iter->second.get();
        }
 
      private:
        void callRemoteImpl(std::string const& name, nlohmann::json const& json) const
        {
            // window is threadsafe.
            window_->eval(fmt::format(remoteCallScript, name, json.dump()));
        }
        void callRemoteImpl(std::string const& name) const
        {
            // window is threadsafe.
            window_->eval(fmt::format(remoteCallScript, name, "undefined"));
        }
 
      private:
        std::recursive_mutex guard_;
        Window* window_;
        std::unordered_map<std::string, std::unique_ptr<void, std::function<void(void*)>>> stateStores_;
    };
}