vcl/inc/unx/gtk/gtkinst.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #pragma once
  21
  22 #include <sal/config.h>
  23
  24 #include <stack>
  25
  26 #include <unx/salinst.h>
  27 #include <unx/gensys.h>
  28 #include <headless/svpinst.hxx>
  29 #include <com/sun/star/datatransfer/DataFlavor.hpp>
  30 #include <com/sun/star/datatransfer/dnd/XDragSource.hpp>
  31 #include <com/sun/star/datatransfer/dnd/XDropTarget.hpp>
  32 #include <com/sun/star/lang/XInitialization.hpp>
  33 #include <com/sun/star/lang/XServiceInfo.hpp>
  34 #include <com/sun/star/awt/XWindow.hpp>
  35 #include <cppuhelper/compbase.hxx>
  36 #include <vcl/weld.hxx>
  37 #include <vcl/weldutils.hxx>
  38 #include <gtk/gtk.h>
  39
  40 vcl::Font pango_to_vcl(const PangoFontDescription* font, const css::lang::Locale& rLocale);
  41
  42 class GenPspGraphics;
  43 class GtkYieldMutex final : public SalYieldMutex
  44 {
  45     thread_local static std::stack<sal_uInt32> yieldCounts;
  46
  47 public:
  48          GtkYieldMutex() {}
  49     void ThreadsEnter();
  50     void ThreadsLeave();
  51 };
  52
  53 class GtkSalFrame;
  54
  55 #if GTK_CHECK_VERSION(4, 0, 0)
  56 gint gtk_dialog_run(GtkDialog *dialog);
  57
  58 struct read_transfer_result
  59 {
  60     enum { BlockSize = 8192 };
  61     size_t nRead = 0;
  62     bool bDone = false;
  63
  64     std::vector<sal_Int8> aVector;
  65
  66     static void read_block_async_completed(GObject* source, GAsyncResult* res, gpointer user_data);
  67
  68     OUString get_as_string() const;
  69     css::uno::Sequence<sal_Int8> get_as_sequence() const;
  70 };
  71
  72 #endif
  73
  74 struct VclToGtkHelper
  75 {
  76     std::vector<css::datatransfer::DataFlavor> aInfoToFlavor;
  77 #if GTK_CHECK_VERSION(4, 0, 0)
  78     std::vector<OString> FormatsToGtk(const css::uno::Sequence<css::datatransfer::DataFlavor> &rFormats);
  79 #else
  80     std::vector<GtkTargetEntry> FormatsToGtk(const css::uno::Sequence<css::datatransfer::DataFlavor> &rFormats);
  81 #endif
  82 #if GTK_CHECK_VERSION(4, 0, 0)
  83     void setSelectionData(const css::uno::Reference<css::datatransfer::XTransferable> &rTrans,
  84                           GdkContentProvider* provider,
  85                           const char* mime_type,
  86                           GOutputStream* stream,
  87                           int io_priority,
  88                           GCancellable* cancellable,
  89                           GAsyncReadyCallback callback,
  90                           gpointer user_data);
  91 #else
  92     void setSelectionData(const css::uno::Reference<css::datatransfer::XTransferable> &rTrans,
  93                           GtkSelectionData *selection_data, guint info);
  94 #endif
  95 private:
  96 #if GTK_CHECK_VERSION(4, 0, 0)
  97     OString makeGtkTargetEntry(const css::datatransfer::DataFlavor& rFlavor);
  98 #else
  99     GtkTargetEntry makeGtkTargetEntry(const css::datatransfer::DataFlavor& rFlavor);
 100 #endif
 101 };
 102
 103 class GtkTransferable : public cppu::WeakImplHelper<css::datatransfer::XTransferable>
 104 {
 105 protected:
 106 #if GTK_CHECK_VERSION(4, 0, 0)
 107     std::map<OUString, OString> m_aMimeTypeToGtkType;
 108 #else
 109     std::map<OUString, GdkAtom> m_aMimeTypeToGtkType;
 110 #endif
 111
 112 #if GTK_CHECK_VERSION(4, 0, 0)
 113     std::vector<css::datatransfer::DataFlavor> getTransferDataFlavorsAsVector(const char * const *targets, gint n_targets);
 114 #else
 115     std::vector<css::datatransfer::DataFlavor> getTransferDataFlavorsAsVector(GdkAtom *targets, gint n_targets);
 116 #endif
 117
 118 public:
 119     virtual css::uno::Any SAL_CALL getTransferData(const css::datatransfer::DataFlavor& rFlavor) override = 0;
 120     virtual std::vector<css::datatransfer::DataFlavor> getTransferDataFlavorsAsVector() = 0;
 121     virtual css::uno::Sequence<css::datatransfer::DataFlavor> SAL_CALL getTransferDataFlavors() override;
 122     virtual sal_Bool SAL_CALL isDataFlavorSupported(const css::datatransfer::DataFlavor& rFlavor) override;
 123 };
 124
 125 class GtkDnDTransferable;
 126
 127 class GtkInstDropTarget final : public cppu::WeakComponentImplHelper<css::datatransfer::dnd::XDropTarget,
 128                                                            css::lang::XInitialization,
 129                                                            css::lang::XServiceInfo>
 130 {
 131     osl::Mutex m_aMutex;
 132     GtkSalFrame* m_pFrame;
 133     GtkDnDTransferable* m_pFormatConversionRequest;
 134     bool m_bActive;
 135     bool m_bInDrag;
 136     sal_Int8 m_nDefaultActions;
 137     std::vector<css::uno::Reference<css::datatransfer::dnd::XDropTargetListener>> m_aListeners;
 138 public:
 139     GtkInstDropTarget();
 140     virtual ~GtkInstDropTarget() override;
 141
 142     // XInitialization
 143     virtual void        SAL_CALL initialize(const css::uno::Sequence<css::uno::Any>& rArgs) override;
 144             void        deinitialize();
 145
 146     // XDropTarget
 147     virtual void        SAL_CALL addDropTargetListener(const css::uno::Reference<css::datatransfer::dnd::XDropTargetListener>&) override;
 148     virtual void        SAL_CALL removeDropTargetListener(const css::uno::Reference<css::datatransfer::dnd::XDropTargetListener>&) override;
 149     virtual sal_Bool    SAL_CALL isActive() override;
 150     virtual void        SAL_CALL setActive(sal_Bool active) override;
 151     virtual sal_Int8    SAL_CALL getDefaultActions() override;
 152     virtual void        SAL_CALL setDefaultActions(sal_Int8 actions) override;
 153
 154     OUString SAL_CALL getImplementationName() override;
 155
 156     sal_Bool SAL_CALL supportsService(OUString const & ServiceName) override;
 157
 158     css::uno::Sequence<OUString> SAL_CALL getSupportedServiceNames() override;
 159
 160     void fire_dragEnter(const css::datatransfer::dnd::DropTargetDragEnterEvent& dtdee);
 161     void fire_dragOver(const css::datatransfer::dnd::DropTargetDragEvent& dtde);
 162     void fire_drop(const css::datatransfer::dnd::DropTargetDropEvent& dtde);
 163     void fire_dragExit(const css::datatransfer::dnd::DropTargetEvent& dte);
 164
 165     void SetFormatConversionRequest(GtkDnDTransferable *pRequest)
 166     {
 167         m_pFormatConversionRequest = pRequest;
 168     }
 169
 170 #if !GTK_CHECK_VERSION(4, 0, 0)
 171     gboolean signalDragMotion(GtkWidget* pWidget, GdkDragContext* context, gint x, gint y, guint time);
 172     gboolean signalDragDrop(GtkWidget* pWidget, GdkDragContext* context, gint x, gint y, guint time);
 173 #else
 174     GdkDragAction signalDragMotion(GtkDropTargetAsync *context, GdkDrop *drop, double x, double y);
 175     gboolean signalDragDrop(GtkDropTargetAsync *context, GdkDrop *drop, double x, double y);
 176 #endif
 177
 178     void signalDragLeave(GtkWidget* pWidget);
 179
 180 #if !GTK_CHECK_VERSION(4, 0, 0)
 181     void signalDragDropReceived(GtkWidget* pWidget, GdkDragContext* context, gint x, gint y, GtkSelectionData* data, guint ttype, guint time);
 182 #endif
 183 };
 184
 185 class GtkInstDragSource final : public cppu::WeakComponentImplHelper<css::datatransfer::dnd::XDragSource,
 186                                                            css::lang::XInitialization,
 187                                                            css::lang::XServiceInfo>
 188 {
 189     osl::Mutex m_aMutex;
 190     GtkSalFrame* m_pFrame;
 191     css::uno::Reference<css::datatransfer::dnd::XDragSourceListener> m_xListener;
 192     css::uno::Reference<css::datatransfer::XTransferable> m_xTrans;
 193     VclToGtkHelper m_aConversionHelper;
 194 public:
 195     GtkInstDragSource()
 196         : WeakComponentImplHelper(m_aMutex)
 197         , m_pFrame(nullptr)
 198     {
 199     }
 200
 201     void set_datatransfer(const css::uno::Reference<css::datatransfer::XTransferable>& rTrans,
 202                           const css::uno::Reference<css::datatransfer::dnd::XDragSourceListener>& rListener);
 203
 204 #if !GTK_CHECK_VERSION(4, 0, 0)
 205     std::vector<GtkTargetEntry> FormatsToGtk(const css::uno::Sequence<css::datatransfer::DataFlavor> &rFormats);
 206 #endif
 207
 208     void setActiveDragSource();
 209
 210     virtual ~GtkInstDragSource() override;
 211
 212     // XDragSource
 213     virtual sal_Bool    SAL_CALL isDragImageSupported() override;
 214     virtual sal_Int32   SAL_CALL getDefaultCursor(sal_Int8 dragAction) override;
 215     virtual void        SAL_CALL startDrag(
 216         const css::datatransfer::dnd::DragGestureEvent& trigger, sal_Int8 sourceActions, sal_Int32 cursor, sal_Int32 image,
 217         const css::uno::Reference< css::datatransfer::XTransferable >& transferable,
 218         const css::uno::Reference< css::datatransfer::dnd::XDragSourceListener >& listener) override;
 219
 220     // XInitialization
 221     virtual void        SAL_CALL initialize(const css::uno::Sequence<css::uno::Any >& rArguments) override;
 222             void        deinitialize();
 223
 224     OUString SAL_CALL getImplementationName() override;
 225
 226     sal_Bool SAL_CALL supportsService(OUString const & ServiceName) override;
 227
 228     css::uno::Sequence<OUString> SAL_CALL getSupportedServiceNames() override;
 229
 230     void dragFailed();
 231     void dragDelete();
 232 #if GTK_CHECK_VERSION(4, 0, 0)
 233     void dragEnd(GdkDrag* drag);
 234 #else
 235     void dragEnd(GdkDragContext* context);
 236     void dragDataGet(GtkSelectionData *data, guint info);
 237 #endif
 238
 239     // For LibreOffice internal D&D we provide the Transferable without Gtk
 240     // intermediaries as a shortcut, see tdf#100097 for how dbaccess depends on this
 241     static GtkInstDragSource* g_ActiveDragSource;
 242     css::uno::Reference<css::datatransfer::XTransferable> const & GetTransferable() const { return m_xTrans; }
 243 };
 244
 245 enum SelectionType { SELECTION_CLIPBOARD = 0, SELECTION_PRIMARY = 1 };
 246
 247 class GtkSalTimer;
 248 class GtkInstance final : public SvpSalInstance
 249 {
 250 public:
 251             GtkInstance( std::unique_ptr<SalYieldMutex> pMutex );
 252     virtual ~GtkInstance() override;
 253     void    EnsureInit();
 254     virtual void AfterAppInit() override;
 255
 256     virtual SalFrame*           CreateFrame( SalFrame* pParent, SalFrameStyleFlags nStyle ) override;
 257     virtual SalFrame*           CreateChildFrame( SystemParentData* pParent, SalFrameStyleFlags nStyle ) override;
 258     virtual SalObject*          CreateObject( SalFrame* pParent, SystemWindowData* pWindowData, bool bShow ) override;
 259     virtual SalSystem*          CreateSalSystem() override;
 260     virtual SalInfoPrinter*     CreateInfoPrinter(SalPrinterQueueInfo* pPrinterQueueInfo, ImplJobSetup* pJobSetup) override;
 261     virtual std::unique_ptr<SalPrinter> CreatePrinter( SalInfoPrinter* pInfoPrinter ) override;
 262     virtual std::unique_ptr<SalMenu>     CreateMenu( bool, Menu* ) override;
 263     virtual std::unique_ptr<SalMenuItem> CreateMenuItem( const SalItemParams& ) override;
 264     virtual SalTimer*           CreateSalTimer() override;
 265     virtual void                AddToRecentDocumentList(const OUString& rFileUrl, const OUString& rMimeType, const OUString& rDocumentService) override;
 266     virtual std::unique_ptr<SalVirtualDevice>
 267                                 CreateVirtualDevice( SalGraphics&,
 268                                                      tools::Long &nDX, tools::Long &nDY,
 269                                                      DeviceFormat eFormat,
 270                                                      const SystemGraphicsData* = nullptr ) override;
 271     virtual std::shared_ptr<SalBitmap> CreateSalBitmap() override;
 272
 273     virtual bool                DoYield(bool bWait, bool bHandleAllCurrentEvents) override;
 274     virtual bool                AnyInput( VclInputFlags nType ) override;
 275     // impossible to handle correctly, as "main thread" depends on the dispatch mutex
 276     virtual bool                IsMainThread() const override { return false; }
 277
 278     virtual std::unique_ptr<GenPspGraphics> CreatePrintGraphics() override;
 279
 280     virtual bool hasNativeFileSelection() const override { return true; }
 281
 282     virtual css::uno::Reference< css::ui::dialogs::XFilePicker2 >
 283         createFilePicker( const css::uno::Reference< css::uno::XComponentContext >& ) override;
 284     virtual css::uno::Reference< css::ui::dialogs::XFolderPicker2 >
 285         createFolderPicker( const css::uno::Reference< css::uno::XComponentContext >& ) override;
 286
 287     virtual css::uno::Reference< css::uno::XInterface > CreateClipboard( const css::uno::Sequence< css::uno::Any >& i_rArguments ) override;
 288     virtual css::uno::Reference<css::uno::XInterface> ImplCreateDragSource(const SystemEnvData*) override;
 289     virtual css::uno::Reference<css::uno::XInterface> ImplCreateDropTarget(const SystemEnvData*) override;
 290     virtual OpenGLContext* CreateOpenGLContext() override;
 291     virtual std::unique_ptr<weld::Builder> CreateBuilder(weld::Widget* pParent, const OUString& rUIRoot, const OUString& rUIFile) override;
 292     virtual std::unique_ptr<weld::Builder> CreateInterimBuilder(vcl::Window* pParent, const OUString& rUIRoot, const OUString& rUIFile,
 293                                                 bool bAllowCycleFocusOut, sal_uInt64 nLOKWindowId = 0) override;
 294     virtual weld::MessageDialog* CreateMessageDialog(weld::Widget* pParent, VclMessageType eMessageType, VclButtonsType eButtonType, const OUString &rPrimaryMessage) override;
 295     virtual weld::Window* GetFrameWeld(const css::uno::Reference<css::awt::XWindow>& rWindow) override;
 296
 297     virtual const cairo_font_options_t* GetCairoFontOptions() override;
 298             const cairo_font_options_t* GetLastSeenCairoFontOptions() const;
 299                                    void ResetLastSeenCairoFontOptions(const cairo_font_options_t* pOptions);
 300
 301     void                        RemoveTimer ();
 302
 303     void* CreateGStreamerSink(const SystemChildWindow*) override;
 304
 305 private:
 306     GtkSalTimer *m_pTimer;
 307     css::uno::Reference<css::uno::XInterface> m_aClipboards[2];
 308     bool                        IsTimerExpired();
 309     bool                        bNeedsInit;
 310     cairo_font_options_t*       m_pLastCairoFontOptions;
 311 };
 312
 313 inline GtkInstance* GetGtkInstance() { return static_cast<GtkInstance*>(GetSalInstance()); }
 314
 315 class SalGtkXWindow final : public weld::TransportAsXWindow
 316 {
 317 private:
 318     weld::Window* m_pWeldWidget;
 319     GtkWidget* m_pWidget;
 320 public:
 321
 322     SalGtkXWindow(weld::Window* pWeldWidget, GtkWidget* pWidget)
 323         : TransportAsXWindow(pWeldWidget)
 324         , m_pWeldWidget(pWeldWidget)
 325         , m_pWidget(pWidget)
 326     {
 327     }
 328
 329     virtual void clear() override
 330     {
 331         m_pWeldWidget = nullptr;
 332         m_pWidget = nullptr;
 333         TransportAsXWindow::clear();
 334     }
 335
 336     GtkWidget* getGtkWidget() const
 337     {
 338         return m_pWidget;
 339     }
 340
 341     weld::Window* getFrameWeld() const
 342     {
 343         return m_pWeldWidget;
 344     }
 345 };
 346
 347 GdkPixbuf* load_icon_by_name(const OUString& rIconName);
 348
 349 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */