window.hpp

Go to the documentation of this file.

#pragma once
 
#include <nui/core.hpp>
#ifdef NUI_BACKEND
#    include <nlohmann/json.hpp>
#    include <boost/asio/any_io_executor.hpp>
#    include <nui/backend/url.hpp>
#    include <filesystem>
#endif
 
#include <memory>
#include <optional>
#include <string>
#include <functional>
#include <unordered_map>
 
namespace Nui
{
    enum class WebViewHint : int
    {
        WEBVIEW_HINT_NONE,
        WEBVIEW_HINT_MIN,
        WEBVIEW_HINT_MAX,
        WEBVIEW_HINT_FIXED
    };
 
    // https://learn.microsoft.com/en-us/microsoft-edge/webview2/reference/win32/icorewebview2?view=webview2-1.0.1370.28#corewebview2_host_resource_access_kind
    enum class HostResourceAccessKind
    {
        Deny,
        Allow,
        DenyCors
    };
 
    enum class NuiCoreWebView2WebResourceContext
    {
        All,
        Document,
        Stylesheet,
        Image,
        Media,
        Font,
        Script,
        XmlHttpRequest,
        Fetch,
        TextTrack,
        EventSource,
        WebSocket,
        Manifest,
        SignedExchange,
        Ping,
        CspViolationReport,
        Other,
    };
 
#ifdef NUI_BACKEND
    struct CustomSchemeRequest
    {
        std::string scheme{};
        std::function<std::string const&()> getContent{};
        std::unordered_multimap<std::string, std::string> headers{};
        std::string uri{};
        std::string method{};
 
        std::optional<Url> parseUrl() const;
 
        NuiCoreWebView2WebResourceContext resourceContext = NuiCoreWebView2WebResourceContext::All;
    };
 
    struct CustomSchemeResponse
    {
        int statusCode;
        std::string reasonPhrase{};
        std::unordered_multimap<std::string, std::string> headers{};
        std::string body{};
    };
 
    struct CustomScheme
    {
        std::string scheme;
        std::vector<std::string> allowedOrigins = {};
 
        std::function<CustomSchemeResponse(CustomSchemeRequest const&)> onRequest = {};
 
        NuiCoreWebView2WebResourceContext resourceContext = NuiCoreWebView2WebResourceContext::All;
 
        bool treatAsSecure = true;
 
        bool hasAuthorityComponent = false;
    };
 
    struct WindowOptions
    {
        std::optional<std::string> title = std::nullopt;
 
        bool debug = false;
 
        std::vector<CustomScheme> customSchemes = {};
 
        std::optional<std::string> browserArguments = std::nullopt;
 
        bool enableTrackingPrevention = true;
 
        std::optional<std::string> language = std::nullopt;
 
        std::optional<std::string> folderMappingScheme = std::string{"assets"};
 
        // Called when a message from the view cannot be parsed or references an invalid function or has no id.
        std::function<void(std::string_view)> onRpcError = {};
    };
#else
    struct WindowOptions
    {};
#endif
 
    class Window
    {
      public:
        // Warning! app.example is intentional to avoid timeout issues.
        // https://github.com/MicrosoftEdge/WebView2Feedback/issues/2381
        constexpr static std::string_view windowsServeAuthority = "app.example";
 
        Window();
 
        explicit Window(WindowOptions const& options);
 
        [[deprecated]] explicit Window(bool debug);
 
        [[deprecated]] explicit Window(std::string const& title, bool debug = false);
 
        [[deprecated]] explicit Window(char const* title, bool debug = false);
        ~Window();
        Window(const Window&) = delete;
        Window& operator=(const Window&) = delete;
        Window(Window&&);
        Window& operator=(Window&&);
 
        void setTitle(std::string const& title);
 
        void setSize(int width, int height, WebViewHint hint = WebViewHint::WEBVIEW_HINT_NONE);
 
        void setPosition(int x, int y, bool useFrameOrigin = true);
 
        void centerOnPrimaryDisplay();
 
        void navigate(const std::string& url);
 
        void navigate(char const* url);
 
#ifdef NUI_BACKEND
        void navigate(const std::filesystem::path& file);
#endif
 
        void terminate();
 
#ifndef APPLE
        void openDevTools();
#endif
 
#ifdef NUI_BACKEND
        void bind(std::string const& name, std::function<void(nlohmann::json const&)> const& callback);
 
        void unbind(std::string const& name);
 
        boost::asio::any_io_executor getExecutor() const;
 
        void setVirtualHostNameToFolderMapping(
            std::string const& hostName,
            std::filesystem::path const& folderPath,
            HostResourceAccessKind accessKind = HostResourceAccessKind::Allow);
 
        void run();
 
        void dispatch(std::function<void()> func);
 
        void setHtml(
            std::string_view html,
            std::optional<std::string> windowsServeThroughAuthority = std::string{windowsServeAuthority});
 
        void setHtmlThroughFilesystem(std::string_view html);
 
        void eval(std::string const& js);
 
        void eval(char const* js);
 
        void eval(std::filesystem::path const& file);
 
        void init(std::string const& js);
 
        void init(std::filesystem::path const& file);
 
        void* getNativeWebView();
 
        void* getNativeWindow();
 
        void setConsoleOutput(bool active);
#endif
 
        void runInJavascriptThread(std::function<void()>&& func);
 
      public:
        struct Implementation;
        struct WindowsImplementation;
        struct LinuxImplementation;
        struct MacOsImplementation;
 
      private:
        std::shared_ptr<Implementation> impl_;
    };
}