OpenSpace/modules/webbrowser/include/browserclient.h

/*****************************************************************************************
 *                                                                                       *
 * OpenSpace                                                                             *
 *                                                                                       *
 * Copyright (c) 2014-2025                                                               *
 *                                                                                       *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this  *
 * software and associated documentation files (the "Software"), to deal in the Software *
 * without restriction, including without limitation the rights to use, copy, modify,    *
 * merge, publish, distribute, sublicense, and/or sell copies of the Software, and to    *
 * permit persons to whom the Software is furnished to do so, subject to the following   *
 * conditions:                                                                           *
 *                                                                                       *
 * The above copyright notice and this permission notice shall be included in all copies *
 * or substantial portions of the Software.                                              *
 *                                                                                       *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,   *
 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A         *
 * PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT    *
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF  *
 * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE  *
 * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                                         *
 ****************************************************************************************/

#ifndef __OPENSPACE_MODULE_WEBBROWSER___BROWSER_CLIENT___H__
#define __OPENSPACE_MODULE_WEBBROWSER___BROWSER_CLIENT___H__

#ifdef _MSC_VER
#pragma warning (push)
#pragma warning (disable : 4100)
#endif // _MSC_VER

#include <include/cef_client.h>

#ifdef _MSC_VER
#pragma warning (pop)
#endif // _MSC_VER

namespace openspace {

class WebRenderHandler;
class WebKeyboardHandler;

class BrowserClient : public CefClient {
public:
    class NoContextMenuHandler : public CefContextMenuHandler {
        bool RunContextMenu(CefRefPtr<CefBrowser>, CefRefPtr<CefFrame>,
            CefRefPtr<CefContextMenuParams>, CefRefPtr<CefMenuModel>,
            CefRefPtr<CefRunContextMenuCallback>) override;

        IMPLEMENT_REFCOUNTING(NoContextMenuHandler);
    };

    class DisplayHandler : public CefDisplayHandler {
        bool OnCursorChange(CefRefPtr<CefBrowser>,
            CefCursorHandle,
            cef_cursor_type_t type,
            const CefCursorInfo&) override;
        IMPLEMENT_REFCOUNTING(DisplayHandler);
    };

    // This is a fallback to fix a bug with the focus that CEF has. The browser can lose
    // the focus and this is a hacky way to recover it. Solution from this post:
    // https://magpcss.org/ceforum/viewtopic.php?f=6&t=20161&p=56949&hilit=css+focus#
    // TODO (ylvse 2025-02-18): Update CEF when they have fixed this issue
    // https://github.com/chromiumembedded/cef/issues/3870
    class FocusHandler : public CefFocusHandler {
        void OnTakeFocus(CefRefPtr<CefBrowser>, bool) override; 
        bool OnSetFocus(CefRefPtr<CefBrowser>, FocusSource) override;

        IMPLEMENT_REFCOUNTING(FocusHandler);
    };

    class LoadHandler : public CefLoadHandler {
        void OnLoadEnd(CefRefPtr<CefBrowser> browser, CefRefPtr<CefFrame>, int) override;
     
        IMPLEMENT_REFCOUNTING(LoadHandler);
    };

    BrowserClient(WebRenderHandler* handler, WebKeyboardHandler* keyboardHandler);

    CefRefPtr<CefRenderHandler> GetRenderHandler() override;
    CefRefPtr<CefLifeSpanHandler> GetLifeSpanHandler() override;
    CefRefPtr<CefRequestHandler> GetRequestHandler() override;
    CefRefPtr<CefKeyboardHandler> GetKeyboardHandler() override;
    CefRefPtr<CefContextMenuHandler> GetContextMenuHandler() override;
    CefRefPtr<CefDisplayHandler> GetDisplayHandler() override;
    CefRefPtr<CefLoadHandler> GetLoadHandler() override;
    CefRefPtr<CefFocusHandler> GetFocusHandler() override;

protected:
    static bool _hasFocus;

private:
    CefRefPtr<CefRenderHandler> _renderHandler;
    CefRefPtr<CefKeyboardHandler> _keyboardHandler;
    CefRefPtr<CefLifeSpanHandler> _lifeSpanHandler;
    CefRefPtr<CefRequestHandler> _requestHandler;
    CefRefPtr<CefContextMenuHandler> _contextMenuHandler;
    CefRefPtr<CefDisplayHandler> _displayHandler;

    // Try to fix the focus bug
    CefRefPtr<CefLoadHandler> _loadHandler;
    CefRefPtr<CefFocusHandler> _focusHandler;

    IMPLEMENT_REFCOUNTING(BrowserClient);
};

} // namespace openspace

#endif // __OPENSPACE_MODULE_WEBBROWSER___BROWSER_CLIENT___H__