core/Platform.h

Go to the documentation of this file.

/*
  This file is part of KDDockWidgets.
 
  SPDX-FileCopyrightText: 2020 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
  Author: Sérgio Martins <sergio.martins@kdab.com>
 
  SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
 
  Contact KDAB at <info@kdab.com> for commercial licensing options.
*/
 
#pragma once
 
#include "kddockwidgets/docks_export.h"
#include "View.h"
#include "kddockwidgets/KDDockWidgets.h"
#include "kddockwidgets/QtCompat_p.h"
 
#include <vector>
#include <memory.h>
 
namespace KDDockWidgets {
 
namespace Core {
class DelayedCall;
class EventFilterInterface;
struct CreateViewOptions;
class ClassicDropIndicatorOverlay;
class SegmentedDropIndicatorOverlay;
class ViewFactory;
class Window;
 
class DOCKS_EXPORT Platform
{
public:
    enum class DisplayType {
        Other = 0,
        X11 = 1,
        Wayland = 2,
        QtOffscreen = 3,
        QtEGLFS = 4,
        Windows = 5
    };
 
    virtual ~Platform();
    virtual const char *name() const = 0;
 
    static Platform *instance();
 
    // Will be false at start up right before using KDDW and at shutdown after dtor runs
    static bool hasInstance();
 
    virtual bool hasActivePopup() const;
 
    virtual std::shared_ptr<View> focusedView() const = 0;
 
    virtual Vector<std::shared_ptr<Core::Window>> windows() const = 0;
 
    virtual ViewFactory *createDefaultViewFactory() = 0;
 
    virtual std::shared_ptr<Core::Window> windowAt(Point globalPos) const = 0;
 
    virtual void sendEvent(View *, Event *) const = 0;
 
    virtual int screenNumberForView(View *) const = 0;
    virtual int screenNumberForWindow(std::shared_ptr<Core::Window>) const = 0;
 
    virtual Size screenSizeFor(View *) const = 0;
 
    virtual View *createView(Controller *, View *parent = nullptr) const = 0;
 
    bool isQtWidgets() const;
 
    bool isQtQuick() const;
 
    bool isQt() const;
 
    int startDragDistance() const;
 
    virtual bool usesFallbackMouseGrabber() const = 0;
 
    virtual bool inDisallowedDragView(Point globalPos) const = 0;
 
    virtual void ungrabMouse() = 0;
 
    virtual void runDelayed(int ms, Core::DelayedCall *c) = 0;
 
    virtual bool isProcessingAppQuitEvent() const = 0;
 
    void installGlobalEventFilter(EventFilterInterface *);
 
    void removeGlobalEventFilter(EventFilterInterface *);
 
    virtual QString applicationName() const = 0;
 
    virtual void setMouseCursor(Qt::CursorShape, bool discardLast = false) = 0;
 
    virtual void restoreMouseCursor() = 0;
 
    virtual DisplayType displayType() const = 0;
 
    virtual bool isLeftMouseButtonPressed() const = 0;
 
    virtual Vector<std::shared_ptr<Screen>> screens() const = 0;
 
    virtual std::shared_ptr<Screen> primaryScreen() const = 0;
 
    virtual void dumpManagedBacktrace()
    {
    }
 
    virtual void onFloatingWindowCreated(Core::FloatingWindow *);
 
    virtual void onFloatingWindowDestroyed(Core::FloatingWindow *);
 
    virtual void onMainWindowCreated(Core::MainWindow *);
 
    virtual void onMainWindowDestroyed(Core::MainWindow *);
 
    virtual Point cursorPos() const = 0;
 
    virtual void setCursorPos(Point) = 0;
 
    virtual QByteArray readFile(const QString &, bool &ok) const;
 
    virtual bool supportsAeroSnap() const;
 
    static std::vector<KDDockWidgets::FrontendType> frontendTypes();
 
    static bool isInitialized();
 
#if defined(DOCKS_DEVELOPER_MODE) && !defined(DARTAGNAN_BINDINGS_RUN)
#define DEFAULT_TIMEOUT 20000
 
    // Stuff required by the tests only and not used by dart bindings.
 
    virtual KDDW_QCORO_TASK tests_wait(int ms) const = 0;
 
    virtual KDDW_QCORO_TASK tests_waitForResize(View *, int timeout = DEFAULT_TIMEOUT) const = 0;
    virtual KDDW_QCORO_TASK tests_waitForResize(Controller *, int timeout = DEFAULT_TIMEOUT) const = 0;
    virtual KDDW_QCORO_TASK tests_waitForDeleted(View *, int timeout = DEFAULT_TIMEOUT) const = 0;
    virtual KDDW_QCORO_TASK tests_waitForDeleted(Controller *, int timeout = DEFAULT_TIMEOUT) const = 0;
 
    virtual KDDW_QCORO_TASK tests_waitForWindowActive(std::shared_ptr<Core::Window>, int timeout = DEFAULT_TIMEOUT) const = 0;
 
    virtual KDDW_QCORO_TASK tests_waitForEvent(Core::Object *w, Event::Type type, int timeout = DEFAULT_TIMEOUT) const = 0;
    virtual KDDW_QCORO_TASK tests_waitForEvent(View *, Event::Type type, int timeout = DEFAULT_TIMEOUT) const = 0;
    virtual KDDW_QCORO_TASK tests_waitForEvent(std::shared_ptr<Core::Window>, Event::Type type,
                                               int timeout = DEFAULT_TIMEOUT) const = 0;
 
    virtual void tests_doubleClickOn(Point globalPos, View *receiver) = 0;
    virtual void tests_doubleClickOn(Point globalPos, std::shared_ptr<Core::Window> receiver) = 0;
    virtual void tests_pressOn(Point globalPos, View *receiver) = 0;
    virtual void tests_pressOn(Point globalPos, std::shared_ptr<Core::Window> receiver) = 0;
    virtual KDDW_QCORO_TASK tests_releaseOn(Point globalPos, View *receiver) = 0;
    virtual KDDW_QCORO_TASK tests_mouseMove(Point globalPos, View *receiver) = 0;
 
    virtual std::shared_ptr<Core::Window> tests_createWindow() = 0;
 
    static void tests_initPlatform(int &argc, char *argv[], KDDockWidgets::FrontendType, bool defaultToOffscreenQPA = true);
 
    static void tests_deinitPlatform();
 
    std::string m_expectedWarning;
#endif
 
#ifdef DOCKS_TESTING_METHODS
 
    class WarningObserver
    {
        KDDW_DELETE_COPY_CTOR(WarningObserver)
    public:
        WarningObserver() = default;
        virtual ~WarningObserver();
        virtual void onFatal() = 0;
    };
 
    virtual View *tests_createView(CreateViewOptions, View *parent = nullptr) = 0;
 
    virtual View *tests_createFocusableView(CreateViewOptions, View *parent = nullptr) = 0;
 
    virtual View *tests_createNonClosableView(View *parent = nullptr) = 0;
 
    virtual void installMessageHandler() = 0;
    virtual void uninstallMessageHandler() = 0;
 
    virtual Core::MainWindow *
    createMainWindow(const QString &uniqueName, CreateViewOptions,
                     MainWindowOptions options = MainWindowOption_HasCentralFrame,
                     View *parent = nullptr, Qt::WindowFlags = {}) const = 0;
 
    virtual void pauseForDebugger();
 
protected:
    virtual void tests_initPlatform_impl()
    {
    }
 
    virtual void tests_deinitPlatform_impl()
    {
    }
 
#endif
 
public:
    class Private;
    Private *const d;
 
protected:
    virtual int startDragDistance_impl() const;
    Platform();
 
    Platform(const Platform &) = delete;
    Platform &operator=(const Platform &) = delete;
};
 
#if defined(DOCKS_DEVELOPER_MODE)
 
#if !defined(DARTAGNAN_BINDINGS_RUN)
 
struct SetExpectedWarning
{
    explicit SetExpectedWarning(const std::string &s)
    {
        if (!s.empty())
            Platform::instance()->m_expectedWarning = s;
    }
 
    ~SetExpectedWarning()
    {
        Platform::instance()->m_expectedWarning.clear();
    }
 
    KDDW_DELETE_COPY_CTOR(SetExpectedWarning)
};
 
#endif // bindings
 
#endif // dev-mode
 
#if defined(DOCKS_TESTING_METHODS)
 
struct CreateViewOptions
{
    bool isVisible = false;
    Size sizeHint = {};
    Size minSize = { 0, 0 };
    Size maxSize = Size(16777215, 16777215);
    Size size = { 1000, 1000 };
    bool createWindow = false;
 
    Size getMinSize() const
    {
        return minSize;
    }
 
    Size getMaxSize() const
    {
        return maxSize;
    }
 
    Size getSize() const
    {
        return size;
    }
};
 
#endif
 
} // Core
 
} // KDDockWidgets